validator.py

   1 import os
   2 from zeroinstall.injector import model, namespaces
   3 from zeroinstall.injector.reader import InvalidInterface, update
   4 from xml.dom import minidom, Node, XMLNS_NAMESPACE
   5 import tempfile
   6 from logging import warn, info
   7
   8 group_impl_attribs = ['version', 'version-modifier', 'released', 'main', 'stability', 'arch', 'license', 'doc-dir', 'self-test']
   9
  10 known_elements = {
  11         'interface' : ['uri', 'min-injector-version', 'main'],  # (main is deprecated)
  12         'name' : [],
  13         'summary' : [],
  14         'description' : [],
  15         'needs-terminal' : [],
  16         'homepage' : [],
  17         'category' : ['type'],
  18         'icon' : ['type', 'href'],
  19         'feed' : ['src', 'arch'],
  20         'feed-for' : ['interface'],
  21
  22         'group' : group_impl_attribs,
  23         'implementation' : ['id'] + group_impl_attribs,
  24         'package-implementation' : ['package', 'main'],
  25         'manifest-digest' : ['sha1new', 'sha256'],
  26
  27         'archive' : ['href', 'size', 'extract', 'type', 'start-offset'],
  28         'recipe' : [],
  29         'requires' : ['interface', 'use'],
  30         'version' : ['not-before', 'before'],
  31         'environment' : ['name', 'insert', 'default', 'mode'],
  32         'overlay' : ['src', 'mount-point'],
  33 }
  34
  35 def checkElement(elem):
  36         if elem.namespaceURI != namespaces.XMLNS_IFACE:
  37                 info("Note: Skipping unknown (but namespaced) element <%s>", elem.localName)
  38                 return  # Namespaces elements are OK
  39
  40         if elem.localName not in known_elements:
  41                 warn("Unknown Zero Install element <%s>.\nNon Zero-Install elements should be namespaced.", elem.localName)
  42                 return
  43
  44         known_attrs = known_elements[elem.localName]
  45
  46         for (uri, name), value in elem.attributes.itemsNS():
  47                 if uri == XMLNS_NAMESPACE:
  48                         continue        # Namespace declarations are fine
  49
  50                 if uri:
  51                         info("Note: Skipping unknown (but namespaced) attribute '%s'", name)
  52                         continue
  53
  54                 if name not in known_attrs:
  55                         warn("Unknown Zero Install attribute '%s' on <%s>.\nNon Zero-Install attributes should be namespaced.",
  56                                         name, elem.localName)
  57
  58         for child in elem.childNodes:
  59                 if child.nodeType == Node.ELEMENT_NODE:
  60                         checkElement(child)
  61
  62 def check(data, warnings = True):
  63         fd, tmp_name = tempfile.mkstemp(prefix = '0publish-validate-')
  64         os.close(fd)
  65         tmp_iface = model.Interface(tmp_name)
  66         try:
  67                 tmp_file = file(tmp_name, 'w')
  68                 tmp_file.write(data)
  69                 tmp_file.close()
  70                 try:
  71                         update(tmp_iface, tmp_name, local = True)
  72                 except InvalidInterface, ex:
  73                         raise
  74                 except Exception, ex:
  75                         warn("Internal error: %s", ex)
  76                         raise InvalidInterface(str(ex))
  77         finally:
  78                 os.unlink(tmp_name)
  79
  80         if warnings:
  81                 doc = minidom.parseString(data)
  82                 checkElement(doc.documentElement)