shaba/virt-manager
1
0
Fork 0
mirror of https://github.com/virt-manager/virt-manager.git synced 2025-01-08 21:18:04 +03:00
Code Issues Projects Releases Wiki Activity

xmleditor: Add the shared code

Browse Source 
The XML editor ui is a two tabbed notebook, one 'Details' tab
and one 'XML' tab. The latter has a gtksourceview and allows editing
the raw libvirt XML for whatever the selected object is.

API users will programmatically insert the xmleditor notebook into
their UI, with the existing UI under the details tab.
This commit is contained in:
Cole Robinson 2019-04-14 17:31:41 -04:00
parent c88e492331
commit 18af72212b
4 changed files with 289 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
ui/xmleditor.ui Normal file
View File

@ -0,0 +1,85 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Generated with glade 3.22.1 -->
<interface>
<requires lib="gtk+" version="3.22"/>
<object class="GtkNotebook" id="xml-notebook">
<property name="visible">True</property>
<property name="can_focus">True</property>
<property name="border_width">0</property>
<property name="show_border">False</property>
<child>
<object class="GtkBox" id="xml-details-box">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="margin_left">6</property>
<property name="margin_top">6</property>
<property name="orientation">vertical</property>
<child>
<placeholder/>
</child>
</object>
</child>
<child type="tab">
<object class="GtkLabel">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="label" translatable="yes">_Details</property>
<property name="use_underline">True</property>
<child internal-child="accessible">
<object class="AtkObject">
<property name="AtkObject::accessible-name">Details tab</property>
</object>
</child>
</object>
<packing>
<property name="tab_fill">False</property>
</packing>
</child>
<child>
<object class="GtkBox" id="xml-box">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="margin_left">6</property>
<property name="margin_top">6</property>
<property name="orientation">vertical</property>
<property name="spacing">6</property>
<child>
<object class="GtkScrolledWindow" id="xml-scroll">
<property name="visible">True</property>
<property name="can_focus">True</property>
<property name="shadow_type">in</property>
<child>
<placeholder/>
</child>
</object>
<packing>
<property name="expand">True</property>
<property name="fill">True</property>
<property name="position">0</property>
</packing>
</child>
</object>
<packing>
<property name="position">1</property>
</packing>
</child>
<child type="tab">
<object class="GtkLabel">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="tooltip_text">Edit libvirt XML</property>
<property name="label" translatable="yes">_XML</property>
<property name="use_underline">True</property>
<child internal-child="accessible">
<object class="AtkObject">
<property name="AtkObject::accessible-name">XML tab</property>
</object>
</child>
</object>
<packing>
<property name="position">1</property>
<property name="tab_fill">False</property>
</packing>
</child>
</object>
</interface>

20
virtManager/libvirtobject.py
View File

@ -347,6 +347,23 @@ class vmmLibvirtObject(vmmGObject):
def xmlobj(self):
return self.get_xmlobj()
def get_xml_to_define(self):
"""
Return the raw inactive XML we would use to alter/define an
object. Used by the xmleditor UI
"""
return self._make_xmlobj_to_define().get_xml()
def define_xml(self, xml):
"""
Define the passed in XML, and log a diff against the current XML.
Generally subclasses should use _redefine_xmlobj with higher
level wrappers, but this is needed for the XML editor
"""
origxml = self.get_xml_to_define()
newxml = xml
self._redefine_xml_internal(origxml, newxml)
#########################
# Internal XML routines #
@ -372,9 +389,6 @@ class vmmLibvirtObject(vmmGObject):
return self.get_xmlobj(inactive=True)
def _redefine_xml_internal(self, origxml, newxml):
"""
Define the passed newxml. Log a diff against the handed in origxml
"""
self.log_redefine_xml_diff(self, origxml, newxml)
if origxml != newxml:

180
virtManager/xmleditor.py Normal file
View File

@ -0,0 +1,180 @@
# This work is licensed under the GNU GPLv2 or later.
# See the COPYING file in the top-level directory.
import gi
gi.require_version('GtkSource', '4')
from gi.repository import GtkSource
from .baseclass import vmmGObjectUI
_PAGE_DETAILS = 0
_PAGE_XML = 1
class vmmXMLEditor(vmmGObjectUI):
__gsignals__ = {
"changed": (vmmGObjectUI.RUN_FIRST, None, []),
"xml-requested": (vmmGObjectUI.RUN_FIRST, None, []),
"xml-reset": (vmmGObjectUI.RUN_FIRST, None, []),
}
def __init__(self, builder, topwin, parent_container, details_widget):
super().__init__("xmleditor.ui", None,
builder=builder, topwin=topwin)
parent_container.remove(details_widget)
parent_container.add(self.widget("xml-notebook"))
self.widget("xml-details-box").add(details_widget)
self._curpage = _PAGE_DETAILS
self._srcxml = ""
self._srcview = None
self._srcbuf = None
self._init_ui()
def _cleanup(self):
pass
###########
# UI init #
###########
def _init_ui(self):
self._srcview = GtkSource.View()
self._srcbuff = self._srcview.get_buffer()
lang = GtkSource.LanguageManager.get_default().get_language("xml")
self._srcbuff.set_language(lang)
self._srcview.set_monospace(True)
self._srcview.set_auto_indent(True)
self._srcview.get_accessible().set_name("XML editor")
self._srcbuff.set_highlight_syntax(True)
self._srcbuff.connect("changed", self._buffer_changed_cb)
self.widget("xml-notebook").connect("switch-page",
self._before_page_changed_cb)
self.widget("xml-notebook").connect("notify::page",
self._after_page_changed_cb)
self._srcview.show_all()
self.widget("xml-scroll").add(self._srcview)
####################
# Internal helpers #
####################
def _reselect_xml_page(self):
# Setting _curpage first will shortcircuit our page changed callback
self._curpage = _PAGE_XML
self.widget("xml-notebook").set_current_page(_PAGE_XML)
def _reset_xml(self):
self.set_xml("")
self.emit("xml-reset")
def _reset_cursor(self):
# Put cursor at the start of the second line. Starting on the
# first means XML open/close tags are highlighted which is weird
# starting visual
startiter = self._srcbuff.get_start_iter()
startiter.forward_line()
self._srcbuff.place_cursor(startiter)
##############
# Public API #
##############
def reset_state(self):
"""
Clear XML and select the details page. Used when callers do
their own reset_state
"""
self._reset_xml()
return self.widget("xml-notebook").set_current_page(_PAGE_DETAILS)
def get_xml(self):
"""
Return the XML from the editor UI
"""
return self._srcbuff.get_property("text")
def set_xml(self, xml):
"""
Set the editor UI XML to the passed string
"""
try:
self._srcbuff.disconnect_by_func(self._buffer_changed_cb)
self._srcxml = xml or ""
self._srcbuff.set_text(self._srcxml)
self._reset_cursor()
finally:
self._srcbuff.connect("changed", self._buffer_changed_cb)
def set_xml_from_libvirtobject(self, libvirtobject):
"""
Set the editor UI XML to the inactive XML from the passed
vmmLibvirtObject. If the XML UI isn't visible, we don't set
anything, which lets callers use this on every page refresh
"""
if not self.is_xml_selected():
return
xml = ""
if libvirtobject:
xml = libvirtobject.get_xml_to_define()
self.set_xml(xml)
def is_xml_selected(self):
"""
Return True if the XML page is selected
"""
return self._curpage == _PAGE_XML
#############
# Listeners #
#############
def _buffer_changed_cb(self, buf):
self.emit("changed")
def _before_page_changed_cb(self, notebook, widget, pagenum):
if self._curpage == pagenum:
return
self._curpage = pagenum
# If the XML page is clicked, emit xml-requested signal which
# expects the user to call set_xml/set_libvirtobject. This saves
# having to fetch inactive XML up front, and gives users like
# a hook to actually serialize the final XML to return
if pagenum == _PAGE_XML:
self.emit("xml-requested")
return
# If the details page is selected from the XML page, and the user
# edited the XML, we need to warn that leaving this screen will
# invalidate the changes.
if self._srcxml == self.get_xml():
return
ret = self.err.yes_no(
_("There are unapplied changes."),
_("Your XML changes will be lost if you leave this tab. "
"Really leave this tab?"))
if ret:
self._reset_xml()
return
# I can't find anyway to make the notebook stay on the current page
# So set an idle callback to switch back to the XML page. It causes
# a visual UI blip unfortunately
self.idle_add(self._reselect_xml_page)
def _after_page_changed_cb(self, notebook, gparam):
self._curpage = notebook.get_current_page()

7
virtinst/xmlapi.py
View File

@ -279,6 +279,13 @@ def node_is_text(n):
class _Libxml2API(_XMLBase):
def __init__(self, xml):
_XMLBase.__init__(self)
# Use of gtksourceview in virt-manager changes this libxml
# global setting which messes up whitespace after parsing.
# We can probably get away with calling this less but it
# would take some investigation
libxml2.keepBlanksDefault(1)
self._doc = libxml2.parseDoc(xml)
self._ctx = self._doc.xpathNewContext()
self._ctx.setContextNode(self._doc.children)