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, debug
   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'],
  25
  26         'archive' : ['href', 'size', 'extract', 'type', 'start-offset'],
  27         'recipe' : [],
  28         'requires' : ['interface'],
  29         'version' : ['not-before', 'before'],
  30         'environment' : ['name', 'insert', 'default', 'mode'],
  31 }
  32
  33 def checkElement(elem):
  34         if elem.namespaceURI != namespaces.XMLNS_IFACE:
  35                 info("Note: Skipping unknown (but namespaced) element <%s>", elem.localName)
  36                 return  # Namespaces elements are OK
  37
  38         if elem.localName not in known_elements:
  39                 warn("Unknown Zero Install element <%s>.\nNon Zero-Install elements should be namespaced.", elem.localName)
  40                 return
  41
  42         known_attrs = known_elements[elem.localName]
  43
  44         for (uri, name), value in elem.attributes.itemsNS():
  45                 if uri == XMLNS_NAMESPACE:
  46                         continue        # Namespace declarations are fine
  47
  48                 if uri:
  49                         info("Note: Skipping unknown (but namespaced) attribute '%s'", name)
  50                         continue
  51
  52                 if name not in known_attrs:
  53                         warn("Unknown Zero Install attribute '%s' on <%s>.\nNon Zero-Install attributes should be namespaced.",
  54                                         name, elem.localName)
  55
  56         for child in elem.childNodes:
  57                 if child.nodeType == Node.ELEMENT_NODE:
  58                         checkElement(child)
  59
  60 def check(data, warnings = True):
  61         fd, tmp_name = tempfile.mkstemp(prefix = '0publish-validate-')
  62         os.close(fd)
  63         tmp_iface = model.Interface(tmp_name)
  64         try:
  65                 tmp_file = file(tmp_name, 'w')
  66                 tmp_file.write(data)
  67                 tmp_file.close()
  68                 try:
  69                         update(tmp_iface, tmp_name, local = True)
  70                 except InvalidInterface, ex:
  71                         raise
  72                 except Exception, ex:
  73                         warn("Internal error: %s", ex)
  74                         raise InvalidInterface(str(ex))
  75         finally:
  76                 os.unlink(tmp_name)
  77
  78         if warnings:
  79                 doc = minidom.parseString(data)
  80                 checkElement(doc.documentElement)