; "Ic@sdZddlmZmZmZddlmZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZyddlZWnek oeZYnXedZdZGddZGd d eZGd d ejeZGd deZGdde jZGddZGddeZGddeeZGddeeZe dkoJe!deddfZ"e"j#e$e"j#dde"j%ndS(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 '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(uFaultudumpsuloads(uBaseHTTPRequestHandlerNcCsk|o|jd}n |g}xA|D]9}|jdotd|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((u*/mit/python/lib/python3.0/xmlrpc/server.pyuresolve_dotted_attributezs  csfdtDS(ukReturns a list of attribute strings, found in the specified object, which represent callable attributescsIg}|];}|jd o$tt|do ||q q S(u_u__call__(u startswithuhasattrugetattr(u.0u_[1]umember(uobj(u*/mit/python/lib/python3.0/xmlrpc/server.pyu s (udir(uobj((uobju*/mit/python/lib/python3.0/xmlrpc/server.pyulist_public_methodsscBs|EeZdZdZd dZd dZdZdZ d dZ dZ dZ d Z d Zd Zd S(uMix-in class that dispatches XML-RPC requests. This class is used to register XML-RPC method handlers and then to dispatch them. There should never be any reason to instantiate this class directly. cCs(i|_d|_||_||_dS(N(ufuncsuNoneuinstanceu allow_noneuencoding(uselfu allow_noneuencoding((u*/mit/python/lib/python3.0/xmlrpc/server.pyu__init__s   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((u*/mit/python/lib/python3.0/xmlrpc/server.pyuregister_instances! cCs+|dko |j}n||j| ['add', 'subtract', 'multiple'] Returns a list of the methods supported by the server.u _listMethodsu _dispatchN( usetufuncsukeysuinstanceuNoneuhasattru _listMethodsulist_public_methodsusorted(uselfumethods((u*/mit/python/lib/python3.0/xmlrpc/server.pyusystem_listMethodss!cCsdS(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((u*/mit/python/lib/python3.0/xmlrpc/server.pyusystem_methodSignature!s c Csd}||jko|j|}n|jdk ort|jdo|jj|St|jdp7yt|j||j}Wqtk oYqXqn|dkodSddl}|j |SdS(usystem.methodHelp('add') => "Adds two integers together" Returns a string containing documentation for the specified method.u _methodHelpu _dispatchuiN( uNoneufuncsuinstanceuhasattru _methodHelpuresolve_dotted_attributeuallow_dotted_namesuAttributeErrorupydocugetdoc(uselfu method_nameumethodupydoc((u*/mit/python/lib/python3.0/xmlrpc/server.pyusystem_methodHelp.s$  c Csg}x|D]}|d}|d}y |j|j||gWq tk o<}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((u*/mit/python/lib/python3.0/xmlrpc/server.pyusystem_multicallNs"     ! c Csd}y|j|}Wntk ov|jdk o^t|jdo|jj||Syt|j||j}Wqtk oYqXnYnX|dk o ||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((u*/mit/python/lib/python3.0/xmlrpc/server.pyu _dispatchns"  NF(u__name__u __module__u__doc__u__init__uFalseuregister_instanceuNoneuregister_functionu register_introspection_functionsuregister_multicall_functionsu_marshaled_dispatchusystem_listMethodsusystem_methodSignatureusystem_methodHelpusystem_multicallu _dispatch(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyuSimpleXMLRPCDispatchers   $  %  uSimpleXMLRPCDispatchercBsD|EeZdZd ZdZdZdZdddZdS( uSimple XML-RPC request handler class. Handles all HTTP POST requests and attempts to decode them as XML-RPC requests. u/u/RPC2cCs#|jo|j|jkSdSdS(NT(u rpc_pathsupathuTrue(uself((u*/mit/python/lib/python3.0/xmlrpc/server.pyuis_rpc_path_valids c Cs|jp|jdSyd}t|jd}g}xH|o@t||}|j|jj||t|d8}qAWdj |}|j j |t |dd}Wntk o}zl|jdt|j d o=|j jo0|jd t||jd tjn|jWYdd}~XnX|jd }|jd |jdd|jdtt||j|jj||jj|jjddS(uHandles the HTTP POST request. Attempts to interpret all HTTP POST requests as XML-RPC calls, which are forwarded to the server's _dispatch method for handling. Ni iucontent-lengthisu _dispatchiu_send_traceback_headeru X-exceptionu X-tracebackuutf-8iu Content-typeutext/xmluContent-lengthii(i(uis_rpc_path_validu report_404uintuheadersuminuappendurfileureadulenujoinuserveru_marshaled_dispatchugetattruNoneu Exceptionu send_responseuhasattru_send_traceback_headeru send_headerustru tracebacku format_excu end_headersuencodeuwfileuwriteuflushu connectionushutdown(uselfumax_chunk_sizeusize_remaininguLu chunk_sizeudatauresponseue((u*/mit/python/lib/python3.0/xmlrpc/server.pyudo_POSTs<        cCsz|jdd}|jdd|jdtt||j|jj||jj|jj ddS(Nis No such pageu Content-typeu text/plainuContent-lengthi( u send_responseu send_headerustrulenu end_headersuwfileuwriteuflushu connectionushutdown(uselfuresponse((u*/mit/python/lib/python3.0/xmlrpc/server.pyu report_404s   u-cCs(|jjotj|||ndS(u$Selectively log an accepted request.N(userveru logRequestsuBaseHTTPRequestHandleru log_request(uselfucodeusize((u*/mit/python/lib/python3.0/xmlrpc/server.pyu log_requests N(u/u/RPC2(u__name__u __module__u__doc__u rpc_pathsuis_rpc_path_validudo_POSTu report_404u log_request(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyuSimpleXMLRPCRequestHandlers   : uSimpleXMLRPCRequestHandlercBs8|EeZdZdZdZedddddZ dS(ugSimple XML-RPC server. Simple XML-RPC server that allows functions and a single instance to be installed to handle requests. The default implementation attempts to dispatch XML-RPC calls to the functions or instance installed in the server. Override the _dispatch method inhereted from SimpleXMLRPCDispatcher to change this behavior. cCs||_tj|||tjj||||tdk oXttdoHtj|jtj }|tj O}tj|jtj |ndS(Nu FD_CLOEXEC( u logRequestsuSimpleXMLRPCDispatcheru__init__u socketserveru TCPServerufcntluNoneuhasattrufilenouF_GETFDu FD_CLOEXECuF_SETFD(uselfuaddrurequestHandleru logRequestsu allow_noneuencodingubind_and_activateuflags((u*/mit/python/lib/python3.0/xmlrpc/server.pyu__init__ s  NTF( u__name__u __module__u__doc__uTrueuallow_reuse_addressuFalseu_send_traceback_headeruSimpleXMLRPCRequestHandleruNoneu__init__(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyuSimpleXMLRPCServers uSimpleXMLRPCServercBsA|EeZdZdddZdZdZddZdS(u3Simple handler for XML-RPC data passed through CGI.cCstj|||dS(N(uSimpleXMLRPCDispatcheru__init__(uselfu allow_noneuencoding((u*/mit/python/lib/python3.0/xmlrpc/server.pyu__init__scCsH|j|}tdtdt|ttjj|dS(uHandle a single XML-RPC requestuContent-Type: text/xmluContent-Length: %dN(u_marshaled_dispatchuprintulenusysustdoutuwrite(uselfu request_texturesponse((u*/mit/python/lib/python3.0/xmlrpc/server.pyu handle_xmlrpc"s  cCsd}tj|\}}tjji|d6|d6|d6}td||ftdtdt|ttjj |dS( uHandle a single HTTP GET request. Default implementation indicates an error because XML-RPC uses the POST method. iucodeumessageuexplainu Status: %d %suContent-Type: text/htmluContent-Length: %dN( uBaseHTTPRequestHandleru responsesuhttpuserveruDEFAULT_ERROR_MESSAGEuprintulenusysustdoutuwrite(uselfucodeumessageuexplainuresponse((u*/mit/python/lib/python3.0/xmlrpc/server.pyu handle_get,s   cCsh|dko*tjjdddko|jn.|dkotjj}n|j|dS(uHandle 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. uREQUEST_METHODuGETN( uNoneuosuenvironugetu handle_getusysustdinureadu handle_xmlrpc(uselfu request_text((u*/mit/python/lib/python3.0/xmlrpc/server.pyuhandle_requestBs   NF( u__name__u __module__u__doc__uFalseuNoneu__init__u handle_xmlrpcu handle_getuhandle_request(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyuCGIXMLRPCRequestHandlers  uCGIXMLRPCRequestHandlercBsJ|EeZdZdiiidZdiiiddZdZdS(u7Class used to generate pydoc HTML document for a servercCs|p|j}g}d}tjd}x|j||} | pPn| j\} } |j|||| | j\} } }}}}| o3|| jdd}|jd||fn|o1dt|}|jd||| fn|o1dt|}|jd||| fnt|| | dd ko#|j|j ||||n6|o|jd |n|j|j ||| }q.|j|||d d j |S( uMark up some plain text, given a context of symbols to look for. Each context dictionary maps object names to anchor names.iuM\b((http|ftp)://\S+[\w/]|RFC[- ]?(\d+)|PEP[- ]?(\d+)|(self\.)?((?:\w|\.)+))\bu"u"u%su'http://www.rfc-editor.org/rfc/rfc%d.txtu(http://www.python.org/dev/peps/pep-%04d/iu(uself.%sNu( uescapeureucompileusearchuspanuappendugroupsureplaceuintunamelinkujoin(uselfutextuescapeufuncsuclassesumethodsuresultsuhereupatternumatchustartuendualluschemeurfcupepuselfdotunameuurl((u*/mit/python/lib/python3.0/xmlrpc/server.pyumarkup[s8!!# cCs|o |jpdd|}d} d|j||j|f} tj|oJtj|\} } } }tj| dd| | |d|j}nWtj|o@tj|\} } } }tj| | | |d|j}nd}t|t o&|dp|}|dpd}nt j |}| || o|j d | }|j ||j|||}|od |}d ||fS( u;Produce HTML documentation for a function or method object.uu-u$%siNu formatvalueu(...)iu'%su
%s
u
%s
%s
(u__name__uescapeuinspectuismethodu getargspecu formatargspecu formatvalueu isfunctionu isinstanceutupleupydocugetdocugreyumarkupu preformat(uselfuobjectunameumodufuncsuclassesumethodsucluanchorunoteutitleuargsuvarargsuvarkwudefaultsuargspecu docstringudecludoc((u*/mit/python/lib/python3.0/xmlrpc/server.pyu docroutines6 c Csi}x6|jD](\}}d|||<||||%su#ffffffu#7799eeu %su

%s

ufuncsuMethodsu#eeaa77u( uitemsuescapeuheadingumarkupu preformatusorteduappendu docroutineu bigsectionujoin( uselfu server_nameupackage_documentationumethodsufdictukeyuvalueuheaduresultudocucontentsu method_items((u*/mit/python/lib/python3.0/xmlrpc/server.pyu docservers&   # N(u__name__u __module__u__doc__uNoneumarkupu docroutineu docserver(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyu ServerHTMLDocXs ))u ServerHTMLDoccBsA|EeZdZdZdZdZdZdZdS(uGenerates 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((u*/mit/python/lib/python3.0/xmlrpc/server.pyu__init__s  cCs ||_dS(u8Set the HTML title of the generated server documentationN(u server_title(uselfu server_title((u*/mit/python/lib/python3.0/xmlrpc/server.pyuset_server_titlescCs ||_dS(u7Set the name of the generated HTML server documentationN(u server_name(uselfu server_name((u*/mit/python/lib/python3.0/xmlrpc/server.pyuset_server_namescCs ||_dS(u3Set the documentation string for the entire server.N(userver_documentation(uselfuserver_documentation((u*/mit/python/lib/python3.0/xmlrpc/server.pyuset_server_documentationsc Csli}x,|jD]}||jko|j|}n|jdk oddg}t|jdo|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 _dispatchN(NN(usystem_listMethodsufuncsuinstanceuNoneuhasattru_get_method_argstringu _methodHelputupleuresolve_dotted_attributeuAttributeErroru ServerHTMLDocu docserveru server_nameuserver_documentationupageu server_title(uselfumethodsu method_nameumethodu method_infou documenteru documentation((u*/mit/python/lib/python3.0/xmlrpc/server.pyugenerate_html_documentations:          N(u__name__u __module__u__doc__u__init__uset_server_titleuset_server_nameuset_server_documentationugenerate_html_documentation(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyuXMLRPCDocGenerators     uXMLRPCDocGeneratorcBs|EeZdZdZdS(uXML-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|jp|jdS|jj}|jd|jdd|jdtt||j|j j |j |j j |j jddS(u}Handles the HTTP GET request. Interpret all HTTP GET requests as requests for server documentation. Niu Content-typeu text/htmluContent-lengthi(uis_rpc_path_validu report_404userverugenerate_html_documentationu send_responseu send_headerustrulenu end_headersuwfileuwriteuencodeuflushu connectionushutdown(uselfuresponse((u*/mit/python/lib/python3.0/xmlrpc/server.pyudo_GET"s     N(u__name__u __module__u__doc__udo_GET(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyuDocXMLRPCRequestHandlers uDocXMLRPCRequestHandlercBs,|EeZdZedddddZdS(uXML-RPC and HTML documentation server. Adds the ability to serve server documentation to the capabilities of SimpleXMLRPCServer. icCs0tj|||||||tj|dS(N(uSimpleXMLRPCServeru__init__uXMLRPCDocGenerator(uselfuaddrurequestHandleru logRequestsu allow_noneuencodingubind_and_activate((u*/mit/python/lib/python3.0/xmlrpc/server.pyu__init__@s NFT(u__name__u __module__u__doc__uDocXMLRPCRequestHandleruFalseuNoneuTrueu__init__(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyuDocXMLRPCServer8s  uDocXMLRPCServercBs&|EeZdZdZdZdS(uJHandler for XML-RPC data and documentation requests passed through CGIcCsE|j}tdtdt|ttjj|dS(u}Handles the HTTP GET request. Interpret all HTTP GET requests as requests for server documentation. uContent-Type: text/htmluContent-Length: %dN(ugenerate_html_documentationuprintulenusysustdoutuwrite(uselfuresponse((u*/mit/python/lib/python3.0/xmlrpc/server.pyu handle_getLs   cCstj|tj|dS(N(uCGIXMLRPCRequestHandleru__init__uXMLRPCDocGenerator(uself((u*/mit/python/lib/python3.0/xmlrpc/server.pyu__init__Zs N(u__name__u __module__u__doc__u handle_getu__init__(u __locals__((u*/mit/python/lib/python3.0/xmlrpc/server.pyuDocCGIXMLRPCRequestHandlerGs  uDocCGIXMLRPCRequestHandleru__main__u#Running XML-RPC server on port 8000u localhosti@cCs||S(((uxuy((u*/mit/python/lib/python3.0/xmlrpc/server.pyucsuadd(&u__doc__u xmlrpc.clientuFaultudumpsuloadsu http.serveruBaseHTTPRequestHandleruhttpu socketserverusysuosureupydocuinspectu tracebackufcntlu ImportErroruNoneuTrueuresolve_dotted_attributeulist_public_methodsuSimpleXMLRPCDispatcheruSimpleXMLRPCRequestHandleru TCPServeruSimpleXMLRPCServeruCGIXMLRPCRequestHandleruHTMLDocu ServerHTMLDocuXMLRPCDocGeneratoruDocXMLRPCRequestHandleruDocXMLRPCServeruDocCGIXMLRPCRequestHandleru__name__uprintuserveruregister_functionupowu serve_forever(((u*/mit/python/lib/python3.0/xmlrpc/server.pyufsF           ^ !<oQ