home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 June / PCWorld_2005-06_cd.bin / software / vyzkuste / firewally / firewally.exe / framework-2.3.exe / saxutils.py < prev    next >
Text File  |  2003-12-30  |  9KB  |  282 lines
  1. """\
  2. A library of useful helper classes to the SAX classes, for the
  3. convenience of application and driver writers.
  4. """
  5.  
  6. import os, urlparse, urllib, types
  7. import handler
  8. import xmlreader
  9.  
  10. try:
  11.     _StringTypes = [types.StringType, types.UnicodeType]
  12. except AttributeError:
  13.     _StringTypes = [types.StringType]
  14.  
  15. def __dict_replace(s, d):
  16.     """Replace substrings of a string using a dictionary."""
  17.     for key, value in d.items():
  18.         s = s.replace(key, value)
  19.     return s
  20.  
  21. def escape(data, entities={}):
  22.     """Escape &, <, and > in a string of data.
  23.  
  24.     You can escape other strings of data by passing a dictionary as
  25.     the optional entities parameter.  The keys and values must all be
  26.     strings; each key will be replaced with its corresponding value.
  27.     """
  28.  
  29.     # must do ampersand first
  30.     data = data.replace("&", "&")
  31.     data = data.replace(">", ">")
  32.     data = data.replace("<", "<")
  33.     if entities:
  34.         data = __dict_replace(data, entities)
  35.     return data
  36.  
  37. def unescape(data, entities={}):
  38.     """Unescape &, <, and > in a string of data.
  39.  
  40.     You can unescape other strings of data by passing a dictionary as
  41.     the optional entities parameter.  The keys and values must all be
  42.     strings; each key will be replaced with its corresponding value.
  43.     """
  44.     data = data.replace("<", "<")
  45.     data = data.replace(">", ">")
  46.     if entities:
  47.         data = __dict_replace(data, entities)
  48.     # must do ampersand last
  49.     return data.replace("&", "&")
  50.  
  51. def quoteattr(data, entities={}):
  52.     """Escape and quote an attribute value.
  53.  
  54.     Escape &, <, and > in a string of data, then quote it for use as
  55.     an attribute value.  The \" character will be escaped as well, if
  56.     necessary.
  57.  
  58.     You can escape other strings of data by passing a dictionary as
  59.     the optional entities parameter.  The keys and values must all be
  60.     strings; each key will be replaced with its corresponding value.
  61.     """
  62.     data = escape(data, entities)
  63.     if '"' in data:
  64.         if "'" in data:
  65.             data = '"%s"' % data.replace('"', """)
  66.         else:
  67.             data = "'%s'" % data
  68.     else:
  69.         data = '"%s"' % data
  70.     return data
  71.  
  72.  
  73. class XMLGenerator(handler.ContentHandler):
  74.  
  75.     def __init__(self, out=None, encoding="iso-8859-1"):
  76.         if out is None:
  77.             import sys
  78.             out = sys.stdout
  79.         handler.ContentHandler.__init__(self)
  80.         self._out = out
  81.         self._ns_contexts = [{}] # contains uri -> prefix dicts
  82.         self._current_context = self._ns_contexts[-1]
  83.         self._undeclared_ns_maps = []
  84.         self._encoding = encoding
  85.  
  86.     # ContentHandler methods
  87.  
  88.     def startDocument(self):
  89.         self._out.write('<?xml version="1.0" encoding="%s"?>\n' %
  90.                         self._encoding)
  91.  
  92.     def startPrefixMapping(self, prefix, uri):
  93.         self._ns_contexts.append(self._current_context.copy())
  94.         self._current_context[uri] = prefix
  95.         self._undeclared_ns_maps.append((prefix, uri))
  96.  
  97.     def endPrefixMapping(self, prefix):
  98.         self._current_context = self._ns_contexts[-1]
  99.         del self._ns_contexts[-1]
  100.  
  101.     def startElement(self, name, attrs):
  102.         self._out.write('<' + name)
  103.         for (name, value) in attrs.items():
  104.             self._out.write(' %s=%s' % (name, quoteattr(value)))
  105.         self._out.write('>')
  106.  
  107.     def endElement(self, name):
  108.         self._out.write('</%s>' % name)
  109.  
  110.     def startElementNS(self, name, qname, attrs):
  111.         if name[0] is None:
  112.             # if the name was not namespace-scoped, use the unqualified part
  113.             name = name[1]
  114.         else:
  115.             # else try to restore the original prefix from the namespace
  116.             name = self._current_context[name[0]] + ":" + name[1]
  117.         self._out.write('<' + name)
  118.  
  119.         for pair in self._undeclared_ns_maps:
  120.             self._out.write(' xmlns:%s="%s"' % pair)
  121.         self._undeclared_ns_maps = []
  122.  
  123.         for (name, value) in attrs.items():
  124.             name = self._current_context[name[0]] + ":" + name[1]
  125.             self._out.write(' %s=%s' % (name, quoteattr(value)))
  126.         self._out.write('>')
  127.  
  128.     def endElementNS(self, name, qname):
  129.         if name[0] is None:
  130.             name = name[1]
  131.         else:
  132.             name = self._current_context[name[0]] + ":" + name[1]
  133.         self._out.write('</%s>' % name)
  134.  
  135.     def characters(self, content):
  136.         self._out.write(escape(content))
  137.  
  138.     def ignorableWhitespace(self, content):
  139.         self._out.write(content)
  140.  
  141.     def processingInstruction(self, target, data):
  142.         self._out.write('<?%s %s?>' % (target, data))
  143.  
  144.  
  145. class XMLFilterBase(xmlreader.XMLReader):
  146.     """This class is designed to sit between an XMLReader and the
  147.     client application's event handlers.  By default, it does nothing
  148.     but pass requests up to the reader and events on to the handlers
  149.     unmodified, but subclasses can override specific methods to modify
  150.     the event stream or the configuration requests as they pass
  151.     through."""
  152.  
  153.     def __init__(self, parent = None):
  154.         xmlreader.XMLReader.__init__(self)
  155.         self._parent = parent
  156.  
  157.     # ErrorHandler methods
  158.  
  159.     def error(self, exception):
  160.         self._err_handler.error(exception)
  161.  
  162.     def fatalError(self, exception):
  163.         self._err_handler.fatalError(exception)
  164.  
  165.     def warning(self, exception):
  166.         self._err_handler.warning(exception)
  167.  
  168.     # ContentHandler methods
  169.  
  170.     def setDocumentLocator(self, locator):
  171.         self._cont_handler.setDocumentLocator(locator)
  172.  
  173.     def startDocument(self):
  174.         self._cont_handler.startDocument()
  175.  
  176.     def endDocument(self):
  177.         self._cont_handler.endDocument()
  178.  
  179.     def startPrefixMapping(self, prefix, uri):
  180.         self._cont_handler.startPrefixMapping(prefix, uri)
  181.  
  182.     def endPrefixMapping(self, prefix):
  183.         self._cont_handler.endPrefixMapping(prefix)
  184.  
  185.     def startElement(self, name, attrs):
  186.         self._cont_handler.startElement(name, attrs)
  187.  
  188.     def endElement(self, name):
  189.         self._cont_handler.endElement(name)
  190.  
  191.     def startElementNS(self, name, qname, attrs):
  192.         self._cont_handler.startElement(name, attrs)
  193.  
  194.     def endElementNS(self, name, qname):
  195.         self._cont_handler.endElementNS(name, qname)
  196.  
  197.     def characters(self, content):
  198.         self._cont_handler.characters(content)
  199.  
  200.     def ignorableWhitespace(self, chars):
  201.         self._cont_handler.ignorableWhitespace(chars)
  202.  
  203.     def processingInstruction(self, target, data):
  204.         self._cont_handler.processingInstruction(target, data)
  205.  
  206.     def skippedEntity(self, name):
  207.         self._cont_handler.skippedEntity(name)
  208.  
  209.     # DTDHandler methods
  210.  
  211.     def notationDecl(self, name, publicId, systemId):
  212.         self._dtd_handler.notationDecl(name, publicId, systemId)
  213.  
  214.     def unparsedEntityDecl(self, name, publicId, systemId, ndata):
  215.         self._dtd_handler.unparsedEntityDecl(name, publicId, systemId, ndata)
  216.  
  217.     # EntityResolver methods
  218.  
  219.     def resolveEntity(self, publicId, systemId):
  220.         self._ent_handler.resolveEntity(publicId, systemId)
  221.  
  222.     # XMLReader methods
  223.  
  224.     def parse(self, source):
  225.         self._parent.setContentHandler(self)
  226.         self._parent.setErrorHandler(self)
  227.         self._parent.setEntityResolver(self)
  228.         self._parent.setDTDHandler(self)
  229.         self._parent.parse(source)
  230.  
  231.     def setLocale(self, locale):
  232.         self._parent.setLocale(locale)
  233.  
  234.     def getFeature(self, name):
  235.         return self._parent.getFeature(name)
  236.  
  237.     def setFeature(self, name, state):
  238.         self._parent.setFeature(name, state)
  239.  
  240.     def getProperty(self, name):
  241.         return self._parent.getProperty(name)
  242.  
  243.     def setProperty(self, name, value):
  244.         self._parent.setProperty(name, value)
  245.  
  246.     # XMLFilter methods
  247.  
  248.     def getParent(self):
  249.         return self._parent
  250.  
  251.     def setParent(self, parent):
  252.         self._parent = parent
  253.  
  254. # --- Utility functions
  255.  
  256. def prepare_input_source(source, base = ""):
  257.     """This function takes an InputSource and an optional base URL and
  258.     returns a fully resolved InputSource object ready for reading."""
  259.  
  260.     if type(source) in _StringTypes:
  261.         source = xmlreader.InputSource(source)
  262.     elif hasattr(source, "read"):
  263.         f = source
  264.         source = xmlreader.InputSource()
  265.         source.setByteStream(f)
  266.         if hasattr(f, "name"):
  267.             source.setSystemId(f.name)
  268.  
  269.     if source.getByteStream() is None:
  270.         sysid = source.getSystemId()
  271.         if os.path.isfile(sysid):
  272.             basehead = os.path.split(os.path.normpath(base))[0]
  273.             source.setSystemId(os.path.join(basehead, sysid))
  274.             f = open(sysid, "rb")
  275.         else:
  276.             source.setSystemId(urlparse.urljoin(base, sysid))
  277.             f = urllib.urlopen(source.getSystemId())
  278.  
  279.         source.setByteStream(f)
  280.  
  281.     return source
  282.