qyMac@sdZddlmZmZmZmZmZddlmZddlZ ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZyddlZWnek reZYnXeddZddZGd d d ZGd d d eZGd dde jeZGdddeZGdddeZGdddejZGdddZGdddeZ GdddeeZ!GdddeeZ"e#dkrddl$Z$GdddZ%ed d!fZ&e&j'e(e&j'd"d#d$e&j)e%d%ee&j*e+d&e+d'ye&j,Wn3e-k re+d(e&j.e j/dYnXndS()u XML-RPC Servers. 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. The Doc* classes can be used to create XML-RPC servers that serve pydoc-style documentation in response to HTTP GET requests. This documentation is dynamically generated based on the functions and methods registered with the server. 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 sys functions available through sys.func_name import sys self.sys = sys def _listMethods(self): # implement this method so that system.listMethods # knows to advertise the sys methods return list_public_methods(self) + \ ['sys.' + method for method in list_public_methods(self.sys)] 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 ValueError('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() i(uFaultudumpsuloadsu gzip_encodeu gzip_decode(uBaseHTTPRequestHandlerNcCsg|r|jd}n |g}x?|D]7}|jdrPtd|q(t||}q(W|S(uGresolve_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). u.u_u(attempt to access private attribute "%s"(usplitu startswithuAttributeErrorugetattr(uobjuattruallow_dotted_namesuattrsui((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuresolve_dotted_attributezs   uresolve_dotted_attributecsfddtDS(ukReturns a list of attribute strings, found in the specified object, which represent callable attributescs;g|]1}|jd rtt|r|qS(u_(u startswithucallableugetattr(u.0umember(uobj(u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu s u'list_public_methods..(udir(uobj((uobju2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyulist_public_methodssulist_public_methodscBs|EeZdZdZdddddZdddZdddZdd Z d d Z ddd d Z ddZ ddZ ddZddZddZdS(uSimpleXMLRPCDispatcheru&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 cCs7i|_d|_||_|p$d|_||_dS(Nuutf-8(ufuncsuNoneuinstanceu allow_noneuencodinguuse_builtin_types(uselfu allow_noneuencodinguuse_builtin_types((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu__init__s    uSimpleXMLRPCDispatcher.__init__cCs||_||_dS(uRegisters 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 a 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(uinstanceuallow_dotted_names(uselfuinstanceuallow_dotted_names((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuregister_instances! u(SimpleXMLRPCDispatcher.register_instancecCs)|dkr|j}n||j| ['add', 'subtract', 'multiple'] Returns a list of the methods supported by the server.u _listMethodsu _dispatchN( usetufuncsukeysuinstanceuNoneuhasattru _listMethodsulist_public_methodsusorted(uselfumethods((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyusystem_listMethodssu)SimpleXMLRPCDispatcher.system_listMethodscCsdS(u#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.usignatures not supported((uselfu method_name((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyusystem_methodSignature$s u-SimpleXMLRPCDispatcher.system_methodSignaturec Csd}||jkr%|j|}nz|jdk rt|jdrV|jj|St|jdsyt|j||j}Wqtk rYqXqn|dkrdStj |SdS(usystem.methodHelp('add') => "Adds two integers together" Returns a string containing documentation for the specified method.u _methodHelpu _dispatchuN( uNoneufuncsuinstanceuhasattru _methodHelpuresolve_dotted_attributeuallow_dotted_namesuAttributeErrorupydocugetdoc(uselfu method_nameumethod((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyusystem_methodHelp1s"   u(SimpleXMLRPCDispatcher.system_methodHelpc Csg}x|D]}|d}|d}y |j|j||gWq tk r}z&|ji|jd6|jd6WYdd}~Xq tj\}}} |jidd6d||fd6Yq Xq W|S(usystem.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 u methodNameuparamsu faultCodeu faultStringNiu%s:%s(uappendu _dispatchuFaultu faultCodeu faultStringusysuexc_info( uselfu call_listuresultsucallu method_nameuparamsufaultuexc_typeu exc_valueuexc_tb((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyusystem_multicallPs        u'SimpleXMLRPCDispatcher.system_multicallcCsd}y|j|}Wnztk r|jdk rt|jdr[|jj||Syt|j||j}Wqtk rYqXnYnX|dk r||St d|dS(uDispatches 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. u _dispatchumethod "%s" is not supportedN( uNoneufuncsuKeyErroruinstanceuhasattru _dispatchuresolve_dotted_attributeuallow_dotted_namesuAttributeErroru Exception(uselfumethoduparamsufunc((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu _dispatchps"     u SimpleXMLRPCDispatcher._dispatchNF(u__name__u __module__u __qualname__u__doc__uFalseuNoneu__init__uregister_instanceuregister_functionu register_introspection_functionsuregister_multicall_functionsu_marshaled_dispatchusystem_listMethodsusystem_methodSignatureusystem_methodHelpusystem_multicallu _dispatch(u __locals__((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuSimpleXMLRPCDispatchers$ %   uSimpleXMLRPCDispatchercBs|EeZdZdZdZdZdZdZe j de j e j BZ ddZd d Zd d Zd dZddZddddZdS(uSimpleXMLRPCRequestHandleruSimple XML-RPC request handler class. Handles all HTTP POST requests and attempts to decode them as XML-RPC requests. u/u/RPC2ixiu \s* ([^\s;]+) \s* #content-coding (;\s* q \s*=\s* ([0-9\.]+))? #q cCsi}|jjdd}xl|jdD][}|jj|}|r+|jd}|rjt|nd}|||jd%su'http://www.rfc-editor.org/rfc/rfc%d.txtu(http://www.python.org/dev/peps/pep-%04d/iu(uself.%sNu( uescapeureucompileusearchuspanuappendugroupsureplaceuintunamelinkujoin(uselfutextuescapeufuncsuclassesumethodsuresultsuhereupatternumatchustartuendualluschemeurfcupepuselfdotunameuurl((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyumarkups8  " uServerHTMLDoc.markupc Cs|r|jpdd|}d} d|j||j|f} tj|rtj|} tj| jdd| j| j| j d| j d|j } n]tj |rtj|} tj| j| j| j| j d| j d|j } nd} t |tr5|d p| } |dp/d} ntj|} | | | oa|jd | }|j| |j|||}|od |}d ||fS( u;Produce HTML documentation for a function or method object.uu-u$%siNu annotationsu formatvalueu(...)iu'%su
%s
u
%s
%s
(u__name__uescapeuinspectuismethodugetfullargspecu formatargspecuargsuvarargsuvarkwudefaultsu annotationsu formatvalueu isfunctionu isinstanceutupleupydocugetdocugreyumarkupu preformat(uselfuobjectunameumodufuncsuclassesumethodsucluanchorunoteutitleuargsuargspecu docstringudecludoc((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu docroutines<   uServerHTMLDoc.docroutinec Csi}x6|jD](\}}d|||<||||%su#ffffffu#7799eeu %su

%s

ufuncsuMethodsu#eeaa77u( uitemsuescapeuheadingumarkupu preformatusorteduappendu docroutineu bigsectionujoin( uselfu server_nameupackage_documentationumethodsufdictukeyuvalueuheaduresultudocucontentsu method_items((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu docservers" # uServerHTMLDoc.docserverN(u__name__u __module__u __qualname__u__doc__uNoneumarkupu docroutineu docserver(u __locals__((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu ServerHTMLDocs ),u ServerHTMLDoccBsV|EeZdZdZddZddZddZdd Zd d Zd S( uXMLRPCDocGeneratoruGenerates documentation for an XML-RPC server. This class is designed as mix-in and should not be constructed directly. cCsd|_d|_d|_dS(NuXML-RPC Server DocumentationuGThis server exports the following methods through the XML-RPC protocol.(u server_nameuserver_documentationu server_title(uself((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu__init__9s  uXMLRPCDocGenerator.__init__cCs ||_dS(u8Set the HTML title of the generated server documentationN(u server_title(uselfu server_title((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuset_server_titleAsu#XMLRPCDocGenerator.set_server_titlecCs ||_dS(u7Set the name of the generated HTML server documentationN(u server_name(uselfu server_name((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuset_server_nameFsu"XMLRPCDocGenerator.set_server_namecCs ||_dS(u3Set the documentation string for the entire server.N(userver_documentation(uselfuserver_documentation((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuset_server_documentationKsu+XMLRPCDocGenerator.set_server_documentationc Cspi}x0|jD]"}||jkr8|j|}n|jdk rddg}t|jdr~|jj||d html documentation for the server Generates HTML documentation for the server using introspection for installed functions and instances that do not implement the _dispatch method. Alternatively, instances can choose to implement the _get_method_argstring(method_name) method to provide the argument string used in the documentation and the _methodHelp(method_name) method to provide the help text used in the documentation.u_get_method_argstringiu _methodHelpiu _dispatchuACould not find method in self.functions and no instance installedN(NN(usystem_listMethodsufuncsuinstanceuNoneuhasattru_get_method_argstringu _methodHelputupleuresolve_dotted_attributeuAttributeErroruAssertionErroru ServerHTMLDocu docserveru server_nameuserver_documentationupageu server_title(uselfumethodsu method_nameumethodu method_infou documenteru documentation((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyugenerate_html_documentationPs:          u.XMLRPCDocGenerator.generate_html_documentationN( u__name__u __module__u __qualname__u__doc__u__init__uset_server_titleuset_server_nameuset_server_documentationugenerate_html_documentation(u __locals__((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuXMLRPCDocGenerator2s     uXMLRPCDocGeneratorcBs&|EeZdZdZddZdS(uDocXMLRPCRequestHandleruXML-RPC and documentation request handler class. Handles all HTTP POST requests and attempts to decode them as XML-RPC requests. Handles all HTTP GET requests and interprets them as requests for documentation. cCs|js|jdS|jjjd}|jd|jdd|jdtt||j |j j |dS(u}Handles the HTTP GET request. Interpret all HTTP GET requests as requests for server documentation. Nuutf-8iu Content-typeu text/htmluContent-length( uis_rpc_path_validu report_404userverugenerate_html_documentationuencodeu send_responseu send_headerustrulenu end_headersuwfileuwrite(uselfuresponse((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyudo_GETs    uDocXMLRPCRequestHandler.do_GETN(u__name__u __module__u __qualname__u__doc__udo_GET(u __locals__((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuDocXMLRPCRequestHandlersuDocXMLRPCRequestHandlercBs8|EeZdZdZedddddddZdS(uDocXMLRPCServeruXML-RPC and HTML documentation server. Adds the ability to serve server documentation to the capabilities of SimpleXMLRPCServer. c Cs3tj||||||||tj|dS(N(uSimpleXMLRPCServeru__init__uXMLRPCDocGenerator(uselfuaddrurequestHandleru logRequestsu allow_noneuencodingubind_and_activateuuse_builtin_types((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu__init__s uDocXMLRPCServer.__init__NTF( u__name__u __module__u __qualname__u__doc__uDocXMLRPCRequestHandleruTrueuFalseuNoneu__init__(u __locals__((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuDocXMLRPCServers uDocXMLRPCServercBs2|EeZdZdZddZddZdS(uDocCGIXMLRPCRequestHandleruJHandler for XML-RPC data and documentation requests passed through CGIcCsn|jjd}tdtdt|ttjjtjjj|tjjjdS(u}Handles the HTTP GET request. Interpret all HTTP GET requests as requests for server documentation. uutf-8uContent-Type: text/htmluContent-Length: %dN( ugenerate_html_documentationuencodeuprintulenusysustdoutuflushubufferuwrite(uselfuresponse((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu handle_gets  u%DocCGIXMLRPCRequestHandler.handle_getcCstj|tj|dS(N(uCGIXMLRPCRequestHandleru__init__uXMLRPCDocGenerator(uself((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu__init__s u#DocCGIXMLRPCRequestHandler.__init__N(u__name__u __module__u __qualname__u__doc__u handle_getu__init__(u __locals__((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuDocCGIXMLRPCRequestHandlers uDocCGIXMLRPCRequestHandleru__main__cBs3|EeZdZddZGdddZdS(uExampleServicecCsdS(Nu42((uself((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyugetDatasuExampleService.getDatacBs&|EeZdZeddZdS(uExampleService.currentTimecCs tjjS(N(udatetimeunow(((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyugetCurrentTimesu)ExampleService.currentTime.getCurrentTimeN(u__name__u __module__u __qualname__u staticmethodugetCurrentTime(u __locals__((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu currentTimesu currentTimeN(u__name__u __module__u __qualname__ugetDatau currentTime(u __locals__((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyuExampleServices uExampleServiceu localhosti@cCs||S(N((uxuy((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyusuuadduallow_dotted_namesu&Serving XML-RPC on localhost port 8000uKIt is advisable to run this example server within a secure, closed network.u& Keyboard interrupt received, exiting.(0u__doc__u xmlrpc.clientuFaultudumpsuloadsu gzip_encodeu gzip_decodeu http.serveruBaseHTTPRequestHandleruhttpu socketserverusysuosureupydocuinspectu tracebackufcntlu ImportErroruNoneuTrueuresolve_dotted_attributeulist_public_methodsuSimpleXMLRPCDispatcheruSimpleXMLRPCRequestHandleru TCPServeruSimpleXMLRPCServeruMultiPathXMLRPCServeruCGIXMLRPCRequestHandleruHTMLDocu ServerHTMLDocuXMLRPCDocGeneratoruDocXMLRPCRequestHandleruDocXMLRPCServeruDocCGIXMLRPCRequestHandleru__name__udatetimeuExampleServiceuserveruregister_functionupowuregister_instanceuregister_multicall_functionsuprintu serve_foreveruKeyboardInterruptu server_closeuexit(((u2/opt/alt/python33/lib64/python3.3/xmlrpc/server.pyufs\(            "(ErQ