154 lines
4.7 KiB
Python
154 lines
4.7 KiB
Python
#
|
|
# Copyright (C) 2010 Red Hat, Inc.
|
|
# Copyright (C) 2010 Cole Robinson <crobinso@redhat.com>
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
# MA 02110-1301 USA.
|
|
#
|
|
|
|
from gi.repository import GObject
|
|
|
|
import difflib
|
|
import logging
|
|
|
|
import libxml2
|
|
|
|
from virtManager.baseclass import vmmGObject
|
|
|
|
def _sanitize_xml(xml):
|
|
xml = libxml2.parseDoc(xml).serialize()
|
|
# Strip starting <?...> line
|
|
if xml.startswith("<?"):
|
|
ignore, xml = xml.split("\n", 1)
|
|
if not xml.endswith("\n") and xml.count("\n"):
|
|
xml += "\n"
|
|
return xml
|
|
|
|
class vmmLibvirtObject(vmmGObject):
|
|
__gsignals__ = {
|
|
"config-changed": (GObject.SignalFlags.RUN_FIRST, None, []),
|
|
}
|
|
|
|
def __init__(self, conn):
|
|
vmmGObject.__init__(self)
|
|
self._conn = conn
|
|
|
|
self._xml = None
|
|
self._is_xml_valid = False
|
|
|
|
# These should be set by the child classes if necessary
|
|
self._inactive_xml_flags = 0
|
|
self._active_xml_flags = 0
|
|
|
|
def _cleanup(self):
|
|
pass
|
|
|
|
def _get_conn(self):
|
|
return self._conn
|
|
conn = property(_get_conn)
|
|
|
|
#############################################################
|
|
# Functions that should probably be overridden in sub class #
|
|
#############################################################
|
|
|
|
def get_name(self):
|
|
raise NotImplementedError()
|
|
|
|
def _XMLDesc(self, flags):
|
|
raise NotImplementedError()
|
|
|
|
def _define(self, xml):
|
|
ignore = xml
|
|
return
|
|
|
|
def tick(self, now):
|
|
ignore = now
|
|
|
|
##################
|
|
# Public XML API #
|
|
##################
|
|
|
|
def get_xml(self, inactive=False, refresh_if_necc=True):
|
|
"""
|
|
Get domain xml. If cached xml is invalid, update.
|
|
|
|
@param inactive: Return persistent XML, not the running config.
|
|
No effect if domain is not running. Use this flag
|
|
if the XML will be used for redefining a guest
|
|
@param refresh_if_necc: Check if XML is out of date, and if so,
|
|
refresh it (default behavior). Skipping a refresh is
|
|
useful to prevent updating xml in the tick loop when
|
|
it's not that important (disk/net stats)
|
|
"""
|
|
if inactive:
|
|
return self._XMLDesc(self._inactive_xml_flags)
|
|
|
|
if self._xml is None:
|
|
self.refresh_xml()
|
|
elif refresh_if_necc and not self._is_xml_valid:
|
|
self.refresh_xml()
|
|
|
|
return self._xml
|
|
|
|
def refresh_xml(self, forcesignal=False):
|
|
# Force an xml update. Signal 'config-changed' if domain xml has
|
|
# changed since last refresh
|
|
|
|
origxml = self._xml
|
|
self._invalidate_xml()
|
|
self._xml = self._XMLDesc(self._active_xml_flags)
|
|
self._is_xml_valid = True
|
|
|
|
if origxml != self._xml or forcesignal:
|
|
self.idle_emit("config-changed")
|
|
|
|
######################################
|
|
# Internal XML cache/update routines #
|
|
######################################
|
|
|
|
def _invalidate_xml(self):
|
|
# Mark cached xml as invalid
|
|
self._is_xml_valid = False
|
|
|
|
##########################
|
|
# Internal API functions #
|
|
##########################
|
|
|
|
def _xml_to_redefine(self):
|
|
return _sanitize_xml(self.get_xml(inactive=True))
|
|
|
|
def _redefine_helper(self, origxml, newxml):
|
|
origxml = _sanitize_xml(origxml)
|
|
newxml = _sanitize_xml(newxml)
|
|
if origxml != newxml:
|
|
diff = "".join(difflib.unified_diff(origxml.splitlines(1),
|
|
newxml.splitlines(1),
|
|
fromfile="Original XML",
|
|
tofile="New XML"))
|
|
logging.debug("Redefining '%s' with XML diff:\n%s",
|
|
self.get_name(), diff)
|
|
|
|
self._define(newxml)
|
|
else:
|
|
logging.debug("Redefine requested, but XML didn't change!")
|
|
|
|
# Make sure we have latest XML
|
|
self.refresh_xml(forcesignal=True)
|
|
return
|
|
|
|
def _redefine_xml(self, newxml):
|
|
origxml = self._xml_to_redefine()
|
|
return self._redefine_helper(origxml, newxml)
|