allow xinclude files to be missing if xi:fallback is provided

Conflicts:

	src/lib/Server/Lint/Comments.py
	src/lib/Server/Plugin.py

5 files changed, 53 insertions, 14 deletions

diff --git a/src/lib/Server/Lint/Comments.py b/src/lib/Server/Lint/Comments.py
index 19fae1b08..10eb8da51 100644
--- a/src/lib/Server/Lint/Comments.py
+++ b/src/lib/Server/Lint/Comments.py
@@ -1,6 +1,7 @@
-import os.path
+import os
 import lxml.etree
 import Bcfg2.Server.Lint
+from Bcfg2.Server import XI, XI_NAMESPACE
 
 class Comments(Bcfg2.Server.Lint.ServerPlugin):
     """ check files for various required headers """
@@ -177,7 +178,7 @@ class Comments(Bcfg2.Server.Lint.ServerPlugin):
             path = os.path.join(self.metadata.data, mfile)
             if path in self.files:
                 xdata = lxml.etree.parse(path)
-                for el in xdata.findall('./{http://www.w3.org/2001/XInclude}include'):
+                for el in xdata.findall('./%sinclude' % XI_NAMESPACE):
                     if not self.has_all_xincludes(el.get('href')):
                         self.LintError("broken-xinclude-chain",
                                        "Broken XInclude chain: could not include %s" % path)
diff --git a/src/lib/Server/Lint/Duplicates.py b/src/lib/Server/Lint/Duplicates.py
index 75f620603..b8fbefd9a 100644
--- a/src/lib/Server/Lint/Duplicates.py
+++ b/src/lib/Server/Lint/Duplicates.py
@@ -1,6 +1,7 @@
-import os.path
+import os
 import lxml.etree
 import Bcfg2.Server.Lint
+from Bcfg2.Server import XI, XI_NAMESPACE
 
 class Duplicates(Bcfg2.Server.Lint.ServerPlugin):
     """ Find duplicate clients, groups, etc. """
@@ -72,7 +73,7 @@ class Duplicates(Bcfg2.Server.Lint.ServerPlugin):
             path = os.path.join(self.metadata.data, mfile)
             if path in self.files:
                 xdata = lxml.etree.parse(path)
-                for el in xdata.findall('./{http://www.w3.org/2001/XInclude}include'):
+                for el in xdata.findall('./%sinclude' % XI_NAMESPACE):
                     if not self.has_all_xincludes(el.get('href')):
                         self.LintError("broken-xinclude-chain",
                                        "Broken XInclude chain: could not include %s" % path)
diff --git a/src/lib/Server/Lint/Validate.py b/src/lib/Server/Lint/Validate.py
index 952a65365..a95161dce 100644
--- a/src/lib/Server/Lint/Validate.py
+++ b/src/lib/Server/Lint/Validate.py
@@ -1,10 +1,10 @@
-import fnmatch
+import os
+import sys
 import glob
+import fnmatch
 import lxml.etree
-import os
 from subprocess import Popen, PIPE, STDOUT
-import sys
-
+from Bcfg2.Server import XI, XI_NAMESPACE
 import Bcfg2.Server.Lint
 
 class Validate(Bcfg2.Server.Lint.ServerlessPlugin):
@@ -177,23 +177,29 @@ class Validate(Bcfg2.Server.Lint.ServerlessPlugin):
     def follow_xinclude(self, xfile):
         """ follow xincludes in the given file """
         xdata = lxml.etree.parse(xfile)
-        included = set([ent.get('href') for ent in
-                        xdata.findall('./{http://www.w3.org/2001/XInclude}include')])
+        included = set([el
+                        for el in xdata.findall('./%sinclude' % XI_NAMESPACE)])
         rv = []
         
         while included:
             try:
-                filename = included.pop()
+                el = included.pop()
             except KeyError:
                 continue
+            filename = el.get("href")
 
             path = os.path.join(os.path.dirname(xfile), filename)
-            if self.HandlesFile(path):
+            if not os.path.exists(path):
+                if not el.findall('./%sfallback' % XI_NAMESPACE):
+                    self.LintError("broken-xinclude-chain",
+                                   "XInclude %s does not exist in %s: %s" %
+                                   (filename, xfile, self.RenderXML(el)))
+            elif self.HandlesFile(path):
                 rv.append(path)
                 groupdata = lxml.etree.parse(path)
                 [included.add(el.get('href'))
                  for el in
-                 groupdata.findall('./{http://www.w3.org/2001/XInclude}include')]
+                 groupdata.findall('./%sinclude' % XI_NAMESPACE)]
                 included.discard(filename)
 
         return rv
diff --git a/src/lib/Server/Plugin.py b/src/lib/Server/Plugin.py
index 28299d8c7..9889e5be6 100644
--- a/src/lib/Server/Plugin.py
+++ b/src/lib/Server/Plugin.py
@@ -609,6 +609,32 @@ class SingleXMLFileBacked(XMLFileBacked):
         self.fam = fam
         self.fam.AddMonitor(filename, self)
 
+    def _follow_xincludes(self, fname=None, xdata=None):
+        ''' follow xincludes, adding included files to self.extras '''
+        if xdata is None:
+            if fname is None:
+                xdata = self.xdata.getroottree()
+            else:
+                xdata = lxml.etree.parse(fname)
+        included = [el for el in xdata.findall('//%sinclude' %
+                                               Bcfg2.Server.XI_NAMESPACE)]
+        for el in included:
+            name = el.get("href")
+            if name not in self.extras:
+                if name.startswith("/"):
+                    fpath = name
+                else:
+                    fpath = os.path.join(os.path.dirname(self.name), name)
+                if os.path.exists(fpath):
+                    self._follow_xincludes(fname=fpath)
+                    self.add_monitor(fpath, name)
+                else:
+                    msg = "%s: %s does not exist, skipping" % (self.name, name)
+                    if el.findall('./%sfallback' % Bcfg2.Server.XI_NAMESPACE):
+                        self.logger.debug(msg)
+                    else:
+                        self.logger.warning(msg)
+
     def Index(self):
         """Build local data structures."""
         try:
diff --git a/src/lib/Server/__init__.py b/src/lib/Server/__init__.py
index bca73ded7..0564b6447 100644
--- a/src/lib/Server/__init__.py
+++ b/src/lib/Server/__init__.py
@@ -5,6 +5,11 @@ import lxml.etree
 
 __revision__ = '$Revision$'
 __all__ = ["Admin", "Core", "FileMonitor", "Plugin", "Plugins",
-           "Hostbase", "Reports", "Snapshots", "XMLParser"]
+           "Hostbase", "Reports", "Snapshots", "XMLParser",
+           "XI", "XI_NAMESPACE"]
 
 XMLParser = lxml.etree.XMLParser(remove_blank_text=True)
+
+XI = 'http://www.w3.org/2001/XInclude'
+XI_NAMESPACE = '{%s}' % XI
+