3 /fK@sdZddlmZmZmZmZmZddlmZddl Z ddlZ ddl Z ddl Z ddl Z ddlZddlZddlZddlZy ddlZWnek rdZYnXd*ddZdd ZGd d d ZGd d d eZGddde jeZGdddeZGdddeZGdddejZGdddZGdddeZGdddeeZ GdddeeZ!e"dkrddl#Z#Gdd d Z$ed+~Z%e%j&e'e%j&d#d$d%e%j(e$dd&e%j)e*d'e*d(y e%j+Wn(e,k re*d)e j-dYnXWdQRXdS),a 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() )Faultdumpsloads gzip_encode gzip_decode)BaseHTTPRequestHandlerNTcCsJ|r|jd}n|g}x.|D]&}|jdr8td|qt||}qW|S)aGresolve_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). ._z(attempt to access private attribute "%s")split startswithAttributeErrorgetattr)objattrallow_dotted_namesZattrsir/usr/lib64/python3.6/server.pyresolve_dotted_attribute{s     rcsfddtDS)zkReturns a list of attribute strings, found in the specified object, which represent callable attributescs*g|]"}|jd rtt|r|qS)r )r callabler ).0member)rrr s z'list_public_methods..)dir)rr)rrlist_public_methodssrc@speZdZdZdddZdddZddd Zd d Zd d ZdddZ ddZ ddZ ddZ ddZ ddZdS)SimpleXMLRPCDispatchera&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 FNcCs&i|_d|_||_|pd|_||_dS)Nzutf-8)funcsinstance allow_noneencodinguse_builtin_types)selfrrr rrr__init__s  zSimpleXMLRPCDispatcher.__init__cCs||_||_dS)aRegisters 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)r!rrrrrregister_instances!z(SimpleXMLRPCDispatcher.register_instancecCs|dkr|j}||j|<dS)zRegisters a function to respond to XML-RPC requests. The optional name argument can be used to set a Unicode name for the function. N)__name__r)r!Zfunctionnamerrrregister_functionsz(SimpleXMLRPCDispatcher.register_functioncCs|jj|j|j|jddS)zRegisters the XML-RPC introspection methods in the system namespace. see http://xmlrpc.usefulinc.com/doc/reserved.html )zsystem.listMethodszsystem.methodSignaturezsystem.methodHelpN)rupdatesystem_listMethodssystem_methodSignaturesystem_methodHelp)r!rrr register_introspection_functionss z7SimpleXMLRPCDispatcher.register_introspection_functionscCs|jjd|jidS)zRegisters the XML-RPC multicall method in the system namespace. see http://www.xmlrpc.com/discuss/msgReader$1208zsystem.multicallN)rr'system_multicall)r!rrrregister_multicall_functionssz3SimpleXMLRPCDispatcher.register_multicall_functionsc CsyPt||jd\}}|dk r(|||}n |j||}|f}t|d|j|jd}Wntk r}zt||j|jd}WYdd}~XnNtj\}} } z$ttdd|| f|j|jd}Wdd}} } XYnX|j |jdS) aDispatches an XML-RPC method from marshalled (XML) data. XML-RPC methods are dispatched from the marshalled (XML) data using the _dispatch method and the result is returned as marshalled data. For backwards compatibility, a dispatch function can be provided as an argument (see comment in SimpleXMLRPCRequestHandler.do_POST) but overriding the existing method through subclassing is the preferred means of changing method dispatch behavior. )r N)Zmethodresponserr)rrz%s:%s)rrxmlcharrefreplace) rr _dispatchrrrrsysexc_infoencode) r!datadispatch_methodpathparamsmethodresponsefaultexc_type exc_valueexc_tbrrr_marshaled_dispatchs&   z*SimpleXMLRPCDispatcher._marshaled_dispatchcCs^t|jj}|jdk rVt|jdr8|t|jjO}nt|jdsV|tt|jO}t|S)zwsystem.listMethods() => ['add', 'subtract', 'multiple'] Returns a list of the methods supported by the server.N _listMethodsr0)setrkeysrhasattrr?rsorted)r!methodsrrrr(s   z)SimpleXMLRPCDispatcher.system_listMethodscCsdS)a#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.zsignatures not supportedr)r! method_namerrrr))s z-SimpleXMLRPCDispatcher.system_methodSignaturec Csd}||jkr|j|}nX|jdk rrt|jdr<|jj|St|jdsryt|j||j}Wntk rpYnX|dkr~dStj|SdS)zsystem.methodHelp('add') => "Adds two integers together" Returns a string containing documentation for the specified method.N _methodHelpr0) rrrBrFrrr pydocgetdoc)r!rEr8rrrr*6s"       z(SimpleXMLRPCDispatcher.system_methodHelpc Csg}x|D]}|d}|d}y|j|j||gWq tk rl}z|j|j|jdWYdd}~Xq tj\}}} z|jdd||fdWdd}}} XYq Xq W|S)zsystem.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 Z methodNamer7) faultCode faultStringNr.z%s:%s)appendr0rrJrKr1r2) r!Z call_listresultsZcallrEr7r:r;r<r=rrrr,Us$  z'SimpleXMLRPCDispatcher.system_multicallcCsy|j|}Wntk r"YnX|dk r4||Std||jdk rt|jdrd|jj||Syt|j||j}Wntk rYnX|dk r||Std|dS)aDispatches 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. Nzmethod "%s" is not supportedr0) rKeyError ExceptionrrBr0rrr )r!r8r7funcrrrr0ys(    z SimpleXMLRPCDispatcher._dispatch)FNF)F)N)NN)r$ __module__ __qualname____doc__r"r#r&r+r-r>r(r)r*r,r0rrrrrs  $   ) $rc@sfeZdZdZdZdZdZdZej dej ej BZ dd Z d d Zd d ZddZddZdddZdS)SimpleXMLRPCRequestHandlerzSimple XML-RPC request handler class. Handles all HTTP POST requests and attempts to decode them as XML-RPC requests. //RPC2ixr.Tz \s* ([^\s;]+) \s* #content-coding (;\s* q \s*=\s* ([0-9\.]+))? #q cCsbi}|jjdd}xJ|jdD]<}|jj|}|r|jd}|rHt|nd}|||jd<qW|S)NzAccept-EncodingrG,g?r.)headersgetr aepatternmatchgroupfloat)r!rZaeer\vrrraccept_encodingss  z+SimpleXMLRPCRequestHandler.accept_encodingscCs|jr|j|jkSdSdS)NT) rpc_pathsr6)r!rrris_rpc_path_valids z,SimpleXMLRPCRequestHandler.is_rpc_path_validc Cs|js|jdSyd}t|jd}g}x>|rjt||}|jj|}|sNP|j||t|d8}q.Wdj |}|j |}|dkrdS|j j |t |dd|j}Wntk r6}zp|jdt|j d o|j jr|jd t|tj} t| jd d d } |jd | |jdd|jWYdd}~XnX|jd|jdd|jdk rt||jkr|jjdd} | ryt|}|jddWntk rYnX|jdtt||j|jj|dS)zHandles 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. N izcontent-lengthr.r0i_send_traceback_headerz X-exceptionASCIIbackslashreplacez X-tracebackzContent-length0z Content-typeztext/xmlgziprzContent-Encodingi(i) rd report_404intrYminZrfilereadrLlenjoindecode_request_contentserverr>r r6rO send_responserBrg send_headerstr traceback format_excr3 end_headersencode_thresholdrbrZrNotImplementedErrorwfilewrite) r!Zmax_chunk_sizeZsize_remainingLZ chunk_sizechunkr4r9r`Ztraceqrrrdo_POSTsX             z"SimpleXMLRPCRequestHandler.do_POSTc Cs|jjddj}|dkr|S|dkrtyt|Stk rR|jdd|Yqtk rp|jddYqXn|jdd||jdd |jdS) Nzcontent-encodingZidentityrlizencoding %r not supportedizerror decoding gzip contentzContent-lengthrj) rYrZlowerrr}rv ValueErrorrwr{)r!r4rrrrrts z1SimpleXMLRPCRequestHandler.decode_request_contentcCsF|jdd}|jdd|jdtt||j|jj|dS)Nis No such pagez Content-typez text/plainzContent-length)rvrwrxrrr{r~r)r!r9rrrrn/s   z%SimpleXMLRPCRequestHandler.report_404-cCs|jjrtj|||dS)z$Selectively log an accepted request.N)ru logRequestsr log_request)r!codesizerrrr8sz&SimpleXMLRPCRequestHandler.log_requestN)rUrVrm)rr)r$rQrRrSrcr|ZwbufsizeZdisable_nagle_algorithmrecompileVERBOSE IGNORECASEr[rbrdrrtrnrrrrrrTs G rTc@s.eZdZdZdZdZedddddfddZdS)SimpleXMLRPCServeragSimple 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 inherited from SimpleXMLRPCDispatcher to change this behavior. TFNcCs,||_tj||||tjj||||dS)N)rrr" socketserver TCPServer)r!addrrequestHandlerrrrbind_and_activater rrrr"QszSimpleXMLRPCServer.__init__)r$rQrRrSZallow_reuse_addressrgrTr"rrrrr>s  rc@s@eZdZdZedddddfddZddZd d Zd d d ZdS)MultiPathXMLRPCServera\Multipath XML-RPC Server This specialization of SimpleXMLRPCServer allows the user to create multiple Dispatcher instances and assign them to different HTTP request paths. This makes it possible to run two or more 'virtual XML-RPC servers' at the same port. Make sure that the requestHandler accepts the paths in question. TFNc Cs2tj||||||||i|_||_|p*d|_dS)Nzutf-8)rr" dispatchersrr)r!rrrrrrr rrrr"bs  zMultiPathXMLRPCServer.__init__cCs||j|<|S)N)r)r!r6Z dispatcherrrradd_dispatcherls z$MultiPathXMLRPCServer.add_dispatchercCs |j|S)N)r)r!r6rrrget_dispatcherpsz$MultiPathXMLRPCServer.get_dispatchercCs|y|j|j|||}Wn^tjdd\}}z2ttdd||f|j|jd}|j|jd}Wdd}}XYnX|S)Nr.z%s:%s)rrr/) rr>r1r2rrrrr3)r!r4r5r6r9r;r<rrrr>ss z)MultiPathXMLRPCServer._marshaled_dispatch)NN) r$rQrRrSrTr"rrr>rrrrrZsrc@s4eZdZdZd ddZddZdd Zd d d ZdS)CGIXMLRPCRequestHandlerz3Simple handler for XML-RPC data passed through CGI.FNcCstj||||dS)N)rr")r!rrr rrrr"sz CGIXMLRPCRequestHandler.__init__cCsP|j|}tdtdt|ttjjtjjj|tjjjdS)zHandle a single XML-RPC requestzContent-Type: text/xmlzContent-Length: %dN)r>printrrr1stdoutflushbufferr)r! request_textr9rrr handle_xmlrpcs  z%CGIXMLRPCRequestHandler.handle_xmlrpccCsd}tj|\}}tjj|||d}|jd}td||ftdtjjtdt|tt j j t j j j |t j j j dS)zHandle a single HTTP GET request. Default implementation indicates an error because XML-RPC uses the POST method. i)rmessageexplainzutf-8z Status: %d %szContent-Type: %szContent-Length: %dN)rZ responseshttpruZDEFAULT_ERROR_MESSAGEr3rZDEFAULT_ERROR_CONTENT_TYPErrr1rrrr)r!rrrr9rrr handle_gets   z"CGIXMLRPCRequestHandler.handle_getc Csz|dkr$tjjdddkr$|jnRyttjjdd}Wnttfk rVd}YnX|dkrltjj |}|j |dS)zHandle 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. NZREQUEST_METHODZGETZCONTENT_LENGTHr.rm) osenvironrZrror TypeErrorr1stdinrqr)r!rZlengthrrrhandle_requests   z&CGIXMLRPCRequestHandler.handle_request)FNF)N)r$rQrRrSr"rrrrrrrrs   rc@s>eZdZdZdiiifddZdiiidfddZddZdS) ServerHTMLDocz7Class used to generate pydoc HTML document for a serverNcCs^|p|j}g}d}tjd}x|j||} | s2P| j\} } |j|||| | j\} } }}}}| r|| jdd}|jd||fn|rdt|}|jd||| fn~|rdt|}|jd||| fnV|| | dd kr|j|j ||||n(|r$|jd |n|j|j ||| }q W|j|||d d j |S) zMark up some plain text, given a context of symbols to look for. Each context dictionary maps object names to anchor names.rzM\b((http|ftp)://\S+[\w/]|RFC[- ]?(\d+)|PEP[- ]?(\d+)|(self\.)?((?:\w|\.)+))\b"z"z%sz'http://www.rfc-editor.org/rfc/rfc%d.txtz(http://www.python.org/dev/peps/pep-%04d/r.(zself.%sNrG) escaperrsearchspanrLgroupsreplaceroZnamelinkrs)r!textrrclassesrDrMherepatternr\startendallschemeZrfcZpepZselfdotr%Zurlrrrmarkups8      zServerHTMLDoc.markupcCs$|r |jp dd|}d} d|j||j|f} tj|rrtj|} tj| jdd| j| j| j | j |j d} n%sr.N) annotations formatvaluez(...)rz'%sz
%s
z
%s
%s
)r$rinspectZismethodZgetfullargspecZ formatargspecargsZvarargsZvarkwZdefaultsrrZ isfunction isinstancetuplerHrIZgreyr preformat)r!objectr%modrrrDZclZanchorZnotetitlerZargspecZ docstringZdecldocrrr docroutines<           zServerHTMLDoc.docroutinec Csi}x,|jD] \}}d|||<||||<qW|j|}d|}|j|dd}|j||j|} | old| } |d| }g} t|j} x&| D]\}}| j|j|||dqW||jddd d j | }|S) z1Produce HTML documentation for an XML-RPC server.z#-z)%sz#ffffffz#7799eez %sz

%s

)rZMethodsz#eeaa77rG) itemsrZheadingrrrCrLrZ bigsectionrs) r! server_nameZpackage_documentationrDZfdictkeyvalueheadresultrcontentsZ method_itemsrrr docserver$s"     zServerHTMLDoc.docserver)r$rQrRrSrrrrrrrrs ),rc@s8eZdZdZddZddZddZdd Zd d Zd S) XMLRPCDocGeneratorzGenerates documentation for an XML-RPC server. This class is designed as mix-in and should not be constructed directly. cCsd|_d|_d|_dS)NzXML-RPC Server DocumentationzGThis server exports the following methods through the XML-RPC protocol.)rserver_documentation server_title)r!rrrr"DszXMLRPCDocGenerator.__init__cCs ||_dS)z8Set the HTML title of the generated server documentationN)r)r!rrrrset_server_titleLsz#XMLRPCDocGenerator.set_server_titlecCs ||_dS)z7Set the name of the generated HTML server documentationN)r)r!rrrrset_server_nameQsz"XMLRPCDocGenerator.set_server_namecCs ||_dS)z3Set the documentation string for the entire server.N)r)r!rrrrset_server_documentationVsz+XMLRPCDocGenerator.set_server_documentationc Csi}x|jD]}||jkr(|j|}n|jdk rddg}t|jdrV|jj||d<t|jdrr|jj||d<t|}|dkr|}qt|jdsyt|j|}Wqtk r|}YqXq|}n|||<qWt }|j |j |j |}|j tj|j|S)agenerate_html_documentation() => 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.N_get_method_argstringrrFr.r0)NN)r(rrrBrrFrrr rrrrZpagehtmlrr)r!rDrEr8Z method_infoZ documenterZ documentationrrrgenerate_html_documentation[s8          z.XMLRPCDocGenerator.generate_html_documentationN) r$rQrRrSr"rrrrrrrrr=s rc@seZdZdZddZdS)DocXMLRPCRequestHandlerzXML-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. cCsf|js|jdS|jjjd}|jd|jdd|jdtt||j |j j |dS)z}Handles the HTTP GET request. Interpret all HTTP GET requests as requests for server documentation. Nzutf-8rkz Content-typez text/htmlzContent-length) rdrnrurr3rvrwrxrrr{r~r)r!r9rrrdo_GETs  zDocXMLRPCRequestHandler.do_GETN)r$rQrRrSrrrrrrsrc@s&eZdZdZedddddfddZdS)DocXMLRPCServerzXML-RPC and HTML documentation server. Adds the ability to serve server documentation to the capabilities of SimpleXMLRPCServer. TFNc Cs&tj||||||||tj|dS)N)rr"r)r!rrrrrrr rrrr"s zDocXMLRPCServer.__init__)r$rQrRrSrr"rrrrrsrc@s eZdZdZddZddZdS)DocCGIXMLRPCRequestHandlerzJHandler for XML-RPC data and documentation requests passed through CGIcCsT|jjd}tdtdt|ttjjtjjj|tjjjdS)z}Handles the HTTP GET request. Interpret all HTTP GET requests as requests for server documentation. zutf-8zContent-Type: text/htmlzContent-Length: %dN) rr3rrrr1rrrr)r!r9rrrrs z%DocCGIXMLRPCRequestHandler.handle_getcCstj|tj|dS)N)rr"r)r!rrrr"s z#DocCGIXMLRPCRequestHandler.__init__N)r$rQrRrSrr"rrrrrsr__main__c@s"eZdZddZGdddZdS)ExampleServicecCsdS)NZ42r)r!rrrgetDataszExampleService.getDatac@seZdZeddZdS)zExampleService.currentTimecCs tjjS)N)datetimeZnowrrrrgetCurrentTimesz)ExampleService.currentTime.getCurrentTimeN)r$rQrR staticmethodrrrrr currentTimesrN)r$rQrRrrrrrrrsr localhost@cCs||S)Nr)xyrrrsradd)rz&Serving XML-RPC on localhost port 8000zKIt is advisable to run this example server within a secure, closed network.z& Keyboard interrupt received, exiting.)T)rr).rSZ xmlrpc.clientrrrrrZ http.serverrrrrr1rrrHrryZfcntl ImportErrorrrrrTrrrrZHTMLDocrrrrrr$rrrur&powr#r-rZ serve_foreverKeyboardInterruptexitrrrrfs`    ,ErQ