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