zfc@sdZddlZddlmZddlZddlZddlZddlZddlZddlZyddl Z Wne k re Z nXe dZ dZdZdfdYZd ejfd YZd ejefd YZd efdYZdefdYZedkrdGHeddfZejeejddejejndS(s; Simple XML-RPC Server. This module can be used to create simple XML-RPC servers by creating a server and either installing functions, a class instance, or by extending the SimpleXMLRPCServer class. It can also be used to handle XML-RPC requests in a CGI environment using CGIXMLRPCRequestHandler. A list of possible usage patterns follows: 1. Install functions: server = SimpleXMLRPCServer(("localhost", 8000)) server.register_function(pow) server.register_function(lambda x,y: x+y, 'add') server.serve_forever() 2. Install an instance: class MyFuncs: def __init__(self): # make all of the string functions available through # string.func_name import string self.string = string def _listMethods(self): # implement this method so that system.listMethods # knows to advertise the strings methods return list_public_methods(self) + \ ['string.' + method for method in list_public_methods(self.string)] def pow(self, x, y): return pow(x, y) def add(self, x, y) : return x + y server = SimpleXMLRPCServer(("localhost", 8000)) server.register_introspection_functions() server.register_instance(MyFuncs()) server.serve_forever() 3. Install an instance with custom dispatch method: class Math: def _listMethods(self): # this method must be present for system.listMethods # to work return ['add', 'pow'] def _methodHelp(self, method): # this method must be present for system.methodHelp # to work if method == 'add': return "add(2,3) => 5" elif method == 'pow': return "pow(x, y[, z]) => number" else: # By convention, return empty # string if no help is available return "" def _dispatch(self, method, params): if method == 'pow': return pow(*params) elif method == 'add': return params[0] + params[1] else: raise 'bad method' server = SimpleXMLRPCServer(("localhost", 8000)) server.register_introspection_functions() server.register_instance(Math()) server.serve_forever() 4. Subclass SimpleXMLRPCServer: class MathServer(SimpleXMLRPCServer): def _dispatch(self, method, params): try: # We are forcing the 'export_' prefix on methods that are # callable through XML-RPC to prevent potential security # problems func = getattr(self, 'export_' + method) except AttributeError: raise Exception('method "%s" is not supported' % method) else: return func(*params) def export_add(self, x, y): return x + y server = MathServer(("localhost", 8000)) server.serve_forever() 5. CGI script: server = CGIXMLRPCRequestHandler() server.register_function(pow) server.handle_request() iN(tFaultcCsg|r|jd}n |g}x?|D]7}|jdrPtd|q(t||}q(W|S(sGresolve_dotted_attribute(a, 'b.c.d') => a.b.c.d Resolves a dotted attribute name to an object. Raises an AttributeError if any attribute in the chain starts with a '_'. If the optional allow_dotted_names argument is false, dots are not supported and this function operates similar to getattr(obj, attr). t.t_s(attempt to access private attribute "%s"(tsplitt startswithtAttributeErrortgetattr(tobjtattrtallow_dotted_namestattrsti((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pytresolve_dotted_attributess   cCsEgt|D]4}|jd r tt||dr |^q S(skReturns a list of attribute strings, found in the specified object, which represent callable attributesRt__call__(tdirRthasattrR(Rtmember((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pytlist_public_methodsscCs+i}x|D]}d|| [3,1,2] Returns a copy of a list without duplicates. Every list item must be hashable and the order of the items in the resulting list is not defined. i(tkeys(tlsttutx((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pytremove_duplicatess tSimpleXMLRPCDispatchercBseZdZed dZedZd dZdZdZ d d dZ dZ dZ d Z d Zd ZRS( s'Mix-in class that dispatches XML-RPC requests. This class is used to register XML-RPC method handlers and then to dispatch them. This class doesn't need to be instanced directly when used by SimpleXMLRPCServer but it can be instanced when used by the MultiPathXMLRPCServer. cCs(i|_d|_||_||_dS(N(tfuncstNonetinstancet allow_nonetencoding(tselfRR((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyt__init__s   cCs||_||_dS(sRegisters an instance to respond to XML-RPC requests. Only one instance can be installed at a time. If the registered instance has a _dispatch method then that method will be called with the name of the XML-RPC method and its parameters as a tuple e.g. instance._dispatch('add',(2,3)) If the registered instance does not have a _dispatch method then the instance will be searched to find a matching method and, if found, will be called. Methods beginning with an '_' are considered private and will not be called by SimpleXMLRPCServer. If a registered function matches an XML-RPC request, then it will be called instead of the registered instance. If the optional allow_dotted_names argument is true and the instance does not have a _dispatch method, method names containing dots are supported and resolved, as long as none of the name segments start with an '_'. *** SECURITY WARNING: *** Enabling the allow_dotted_names options allows intruders to access your module's global variables and may allow intruders to execute arbitrary code on your machine. Only use this option on a secure, closed network. N(RR (RRR ((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pytregister_instances! cCs)|dkr|j}n||j| ['add', 'subtract', 'multiple'] Returns a list of the methods supported by the server.t _listMethodsR.N( RRRRRRR=Rtsort(Rtmethods((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyR%s cCsdS(s#system.methodSignature('add') => [double, int, int] Returns a list describing the signature of the method. In the above example, the add method takes two integers as arguments and returns a double result. This server does NOT support system.methodSignature.ssignatures not supported((Rt method_name((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyR&-s cCsd}||jkr%|j|}ny|jdk rt|jdrV|jj|St|jdsyt|j||j}Wqtk rqXqn|dkrdSddl}|j |SdS(ssystem.methodHelp('add') => "Adds two integers together" Returns a string containing documentation for the specified method.t _methodHelpR.tiN( RRRRRAR R Rtpydoctgetdoc(RR@R6RC((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyR':s$    c Csg}x|D]}|d}|d}y |j|j||gWq tk r}}|ji|jd6|jd6q tj\}}} |jidd6d||fd6q Xq W|S(ssystem.multicall([{'methodName': 'add', 'params': [2, 2]}, ...]) => [[4], ...] Allows the caller to package multiple XML-RPC calls into a single request. See http://www.xmlrpc.com/discuss/msgReader$1208 t methodNameR5t faultCodet faultStringis%s:%s(tappendR.RRFRGR0R1( Rt call_listtresultstcallR@R5R8R9R:R;((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyR)Zs       cCsd}y|j|}Wnxtk r|jdk rt|jdr[|jj||Syt|j||j}Wqtk rqXqnX|dk r||St d|dS(sDispatches the XML-RPC method. XML-RPC calls are forwarded to a registered function that matches the called XML-RPC method name. If no such function exists then the call is forwarded to the registered instance, if available. If the registered instance has a _dispatch method then that method will be called with the name of the XML-RPC method and its parameters as a tuple e.g. instance._dispatch('add',(2,3)) If the registered instance does not have a _dispatch method then the instance will be searched to find a matching method and, if found, will be called. Methods beginning with an '_' are considered private and will not be called. R.smethod "%s" is not supportedN( RRtKeyErrorRRR.R R Rt Exception(RR6R5tfunc((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyR.zs"     N(R t __module__t__doc__tFalseRRRR#R(R*R<R%R&R'R)R.(((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyRs $ %  tSimpleXMLRPCRequestHandlercBs~eZdZd ZdZdZeZej dej ej BZ dZ dZdZd Zd Zd d d ZRS(sSimple XML-RPC request handler class. Handles all HTTP POST requests and attempts to decode them as XML-RPC requests. t/s/RPC2ixis \s* ([^\s;]+) \s* #content-coding (;\s* q \s*=\s* ([0-9\.]+))? #q cCsi}|jjdd}xl|jdD][}|jj|}|r+|jd}|rjt|nd}|||jdtj|||||||i|_||_||_dS(N(RRt dispatchersRR(RRRRRRR((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyRcs    cCs||j|<|S(N(R(RR4t dispatcher((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pytadd_dispatcherls cCs |j|S(N(R(RR4((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pytget_dispatcherpscCs{y |j|j|||}WnTtjd \}}tjtjdd||fd|jd|j}nX|S(Niis%s:%sRR( RR<R0R1R,R/RRR(RR2R3R4R7R9R:((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyR<ss N( R RORPRRRaRQRRRRR<(((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyR[s   tCGIXMLRPCRequestHandlercBs;eZdZeddZdZdZddZRS(s3Simple handler for XML-RPC data passed through CGI.cCstj|||dS(N(RR(RRR((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyRscCs8|j|}dGHdt|GHHtjj|dS(sHandle a single XML-RPC requestsContent-Type: text/xmlsContent-Length: %dN(R<RkR0tstdoutRy(Rt request_textR7((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyt handle_xmlrpcs cCs}d}tjj|\}}tji|d6|d6|d6}d||fGHdtjGHdt|GHHtjj|dS( sHandle a single HTTP GET request. Default implementation indicates an error because XML-RPC uses the POST method. iRtmessagetexplains Status: %d %ssContent-Type: %ssContent-Length: %dN( RRt responsestDEFAULT_ERROR_MESSAGEtDEFAULT_ERROR_CONTENT_TYPERkR0RRy(RRRRR7((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyt handle_gets  cCs|dkr4tjjdddkr4|jnmyttjjdd}Wnttfk rrd}nX|dkrtj j |}n|j |dS(sHandle a single XML-RPC request passed through a CGI post method. If no XML data is given then it is read from stdin. The resulting XML-RPC response is printed to stdout along with the correct HTTP headers. tREQUEST_METHODtGETtCONTENT_LENGTHiN( RtostenvironRVRRgt TypeErrorRR0tstdinRjR(RRtlength((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pythandle_requests    N( R RORPRQRRRRR(((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pyRs  t__main__s#Running XML-RPC server on port 8000t localhosti@cCs||S(N((Rty((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pytRBtadd(RPR,RRRR0RRrRRt ImportErrorRRaR RRRRRRRRRRR RnR#tpowR*t serve_forever(((s*/usr/lib64/python2.7/SimpleXMLRPCServer.pytas:              !&=