xmlrpc.py
上传用户:gyjinxi
上传日期:2007-01-04
资源大小:159k
文件大小:8k
源码类别:

WEB邮件程序

开发平台:

Python

  1. ##############################################################################
  2. # Zope Public License (ZPL) Version 1.0
  3. # -------------------------------------
  4. # Copyright (c) Digital Creations.  All rights reserved.
  5. # This license has been certified as Open Source(tm).
  6. # Redistribution and use in source and binary forms, with or without
  7. # modification, are permitted provided that the following conditions are
  8. # met:
  9. # 1. Redistributions in source code must retain the above copyright
  10. #    notice, this list of conditions, and the following disclaimer.
  11. # 2. Redistributions in binary form must reproduce the above copyright
  12. #    notice, this list of conditions, and the following disclaimer in
  13. #    the documentation and/or other materials provided with the
  14. #    distribution.
  15. # 3. Digital Creations requests that attribution be given to Zope
  16. #    in any manner possible. Zope includes a "Powered by Zope"
  17. #    button that is installed by default. While it is not a license
  18. #    violation to remove this button, it is requested that the
  19. #    attribution remain. A significant investment has been put
  20. #    into Zope, and this effort will continue if the Zope community
  21. #    continues to grow. This is one way to assure that growth.
  22. # 4. All advertising materials and documentation mentioning
  23. #    features derived from or use of this software must display
  24. #    the following acknowledgement:
  25. #      "This product includes software developed by Digital Creations
  26. #      for use in the Z Object Publishing Environment
  27. #      (http://www.zope.org/)."
  28. #    In the event that the product being advertised includes an
  29. #    intact Zope distribution (with copyright and license included)
  30. #    then this clause is waived.
  31. # 5. Names associated with Zope or Digital Creations must not be used to
  32. #    endorse or promote products derived from this software without
  33. #    prior written permission from Digital Creations.
  34. # 6. Modified redistributions of any form whatsoever must retain
  35. #    the following acknowledgment:
  36. #      "This product includes software developed by Digital Creations
  37. #      for use in the Z Object Publishing Environment
  38. #      (http://www.zope.org/)."
  39. #    Intact (re-)distributions of any official Zope release do not
  40. #    require an external acknowledgement.
  41. # 7. Modifications are encouraged but must be packaged separately as
  42. #    patches to official Zope releases.  Distributions that do not
  43. #    clearly separate the patches from the original work must be clearly
  44. #    labeled as unofficial distributions.  Modifications which do not
  45. #    carry the name Zope may be packaged in any form, as long as they
  46. #    conform to all of the clauses above.
  47. # Disclaimer
  48. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  49. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  51. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  52. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  53. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  54. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  55. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  56. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  57. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  58. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59. #   SUCH DAMAGE.
  60. # This software consists of contributions made by Digital Creations and
  61. # many individuals on behalf of Digital Creations.  Specific
  62. # attributions are listed in the accompanying credits file.
  63. ##############################################################################
  64. """XML-RPC support module
  65. Written by Eric Kidd at UserLand software, with much help from Jim Fulton
  66. at DC. This code hooks Zope up to Fredrik Lundh's Python XML-RPC library.
  67. See http://www.xmlrpc.com/ and http://linux.userland.com/ for more
  68. information about XML-RPC and Zope.
  69. """
  70. import sys
  71. from string import replace
  72. from HTTPResponse import HTTPResponse
  73. import xmlrpclib
  74. def parse_input(data):
  75.     """Parse input data and return a method path and argument tuple
  76.     The data is a string.
  77.     """
  78.     # 
  79.     # For example, with the input:
  80.     #     
  81.     #   <?xml version="1.0"?>
  82.     #   <methodCall>
  83.     #      <methodName>examples.getStateName</methodName>
  84.     #      <params>
  85.     #         <param>
  86.     #            <value><i4>41</i4></value>
  87.     #            </param>
  88.     #         </params>
  89.     #      </methodCall>
  90.     # 
  91.     # the function should return:
  92.     # 
  93.     #     ('examples.getStateName', (41,))
  94.     params, method = xmlrpclib.loads(data)
  95.     # Translate '.' to '/' in meth to represent object traversal.
  96.     method = replace(method, '.', '/')
  97.     return method, params
  98. # See below
  99. #
  100. # def response(anHTTPResponse):
  101. #     """Return a valid ZPublisher response object
  102. #     Use data already gathered by the existing response.
  103. #     The new response will replace the existing response.
  104. #     """
  105. #     # As a first cut, lets just clone the response and
  106. #     # put all of the logic in our refined response class below.
  107. #     r=Response()
  108. #     r.__dict__.update(anHTTPResponse.__dict__)
  109. #     return r
  110.     
  111.     
  112. ########################################################################
  113. # Possible implementation helpers:
  114. class Response:
  115.     """Customized Response that handles XML-RPC-specific details.
  116.     We override setBody to marhsall Python objects into XML-RPC. We
  117.     also override exception to convert errors to XML-RPC faults.
  118.     If these methods stop getting called, make sure that ZPublisher is
  119.     using the xmlrpc.Response object created above and not the original
  120.     HTTPResponse object from which it was cloned.
  121.     It's probably possible to improve the 'exception' method quite a bit.
  122.     The current implementation, however, should suffice for now.
  123.     """
  124.     # Because we can't predict what kind of thing we're customizing,
  125.     # we have to use delegation, rather than inheritence to do the
  126.     # customization.
  127.     def __init__(self, real): self.__dict__['_real']=real
  128.     def __getattr__(self, name): return getattr(self._real, name)
  129.     def __setattr__(self, name, v): return setattr(self._real, name, v)
  130.     def __delattr__(self, name): return delattr(self._real, name)
  131.     
  132.     def setBody(self, body, title='', is_error=0, bogus_str_search=None):
  133.         if isinstance(body, xmlrpclib.Fault):
  134.             # Convert Fault object to XML-RPC response.
  135.             body=xmlrpclib.dumps(body, methodresponse=1)
  136.         else:
  137.             # Marshall our body as an XML-RPC response. Strings will be sent
  138.             # strings, integers as integers, etc. We do *not* convert
  139.             # everything to a string first.
  140.             body = xmlrpclib.dumps((body,), methodresponse=1)
  141.         # Set our body to the XML-RPC message, and fix our MIME type.
  142.         self._real.setBody(body)
  143.         self._real.setHeader('content-type', 'text/xml')
  144.         return self
  145.     def exception(self, fatal=0, info=None,
  146.                   absuri_match=None, tag_search=None):
  147.         # Fetch our exception info. t is type, v is value and tb is the
  148.         # traceback object.
  149.         if type(info) is type(()) and len(info)==3: t,v,tb = info
  150.         else: t,v,tb = sys.exc_info()
  151.         # Abort running transaction, if any:
  152.         try: get_transaction().abort()
  153.         except: pass
  154.         # Create an appropriate Fault object. Unfortunately, we throw away
  155.         # most of the debugging information. More useful error reporting is
  156.         # left as an exercise for the reader.
  157.         Fault=xmlrpclib.Fault
  158.         f=None
  159.         try:
  160.             if isinstance(v, Fault):
  161.                 f=v
  162.             elif isinstance(v, Exception):
  163.                 f=Fault(-1, "Unexpected Zope exception: " + str(v))
  164.             else:
  165.                 f=Fault(-2, "Unexpected Zope error value: " + str(v))
  166.         except:
  167.             f=Fault(-3, "Unknown Zope fault type")
  168.         # Do the damage.
  169.         self.setBody(f)
  170.         self._real.setStatus(200)
  171.         return tb
  172. response=Response