U
e5d9 @ s d Z ddlmZmZmZmZmZ ddlmZ ddl m
Z
ddl m Z ddl
Z
ddlZddlZddlZddlZddlZddlZddlZz ddlZW n ek
r dZY nX d+dd Zd
d ZG d d
d
ZG dd deZG dd dejeZ G dd de Z G dd deZ G dd dej Z G dd dZ!G dd deZ"G d d d e e!Z#G d d d e e!Z$e%d krddl&Z&G d!d" d"Z'e d#~Z(e()e* e()d$d% d& e(j+e' dd' e(, e-d( e-d) z e(. W n( e/k
r e-d* e0d Y nX W 5 Q R X dS ),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)BaseHTTPRequestHandler)partial) signatureNTc C sF |r| d}n|g}|D ]&}|dr6td| qt| |} q| S )aG resolve_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_namesZattrsi r %/usr/lib64/python3.8/xmlrpc/server.pyresolve_dotted_attribute| s
r c s fddt D S )zkReturns a list of attribute strings, found in the specified
object, which represent callable attributesc s( g | ] }| d stt |r|qS )r )r
callabler ).0memberr r r
s
z'list_public_methods..)dirr r r r list_public_methods s r c @ sp e Zd ZdZdddZdddZd dd Zd
d Zd d
Zd ddZ dd Z
dd Z dd Z dd Z
dd ZdS ) 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
FNc C s& i | _ d | _|| _|pd| _|| _d S Nutf-8)funcsinstance
allow_noneencodinguse_builtin_typesselfr# r$ r% r r r __init__ s
z SimpleXMLRPCDispatcher.__init__c C s || _ || _dS )a Registers 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)r" r )r' r" r r r r register_instance s !z(SimpleXMLRPCDispatcher.register_instancec C s2 |dkrt | j|dS |dkr$|j}|| j|< |S )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 register_function__name__r! )r' Zfunctionr* r r r r+ s
z(SimpleXMLRPCDispatcher.register_functionc C s | j | j| j| jd dS )zRegisters the XML-RPC introspection methods in the system
namespace.
see http://xmlrpc.usefulinc.com/doc/reserved.html
)zsystem.listMethodszsystem.methodSignaturezsystem.methodHelpN)r! updatesystem_listMethodssystem_methodSignaturesystem_methodHelpr' r r r register_introspection_functions s
z7SimpleXMLRPCDispatcher.register_introspection_functionsc C s | j d| ji dS )zRegisters the XML-RPC multicall method in the system
namespace.
see http://www.xmlrpc.com/discuss/msgReader$1208zsystem.multicallN)r! r- system_multicallr1 r r r register_multicall_functions s z3SimpleXMLRPCDispatcher.register_multicall_functionsc C s zPt || jd\}}|dk r(|||}n | ||}|f}t|d| j| jd}W n tk
r } zt|| j| jd}W 5 d}~X Y nN t \}} }
z$ttdd|| f | j| jd}W 5 d } } }
X Y nX | | jdS ) a Dispatches 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 )Zmethodresponser# r$ )r# r$ %s:%sr$ r# xmlcharrefreplace)
r r% _dispatchr r# r$ r sysexc_infoencode) r' datadispatch_methodpathparamsmethodresponsefaultexc_type exc_valueexc_tbr r r _marshaled_dispatch s0
z*SimpleXMLRPCDispatcher._marshaled_dispatchc C s^ t | j }| jdk rVt| jdr8|t | j O }n t| jdsV|t t| jO }t|S )zwsystem.listMethods() => ['add', 'subtract', 'multiple']
Returns a list of the methods supported by the server.N _listMethodsr9 )setr! keysr" hasattrrH r sorted)r' methodsr r r r. s
z)SimpleXMLRPCDispatcher.system_listMethodsc C s dS )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_namer r r r/ / s z-SimpleXMLRPCDispatcher.system_methodSignaturec C s d}|| j kr| j | }nX| jdk rrt| jdr<| j|S t| jdsrzt| j|| j}W n tk
rp Y nX |dkr~dS t|S dS )zsystem.methodHelp('add') => "Adds two integers together"
Returns a string containing documentation for the specified method.N _methodHelpr9 ) r! r" rK rO r r r pydocgetdoc)r' rN rA r r r r0 < s$
z(SimpleXMLRPCDispatcher.system_methodHelpc
C s g }|D ]}|d }|d }z| | ||g W q tk
rj } z| |j|jd W 5 d}~X Y q t \}}} z | dd||f d W 5 d } }} X Y qX q|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
methodNamer@ ) faultCode faultStringNr5 r6 )appendr9 r rS rT r: r; )
r' Z call_listresultsZcallrN r@ rC rD rE rF r r r r3 [ s,
z'SimpleXMLRPCDispatcher.system_multicallc C s z| j | }W n tk
r" Y n X |dk r4|| S td| | jdk rt| jdrd| j||S zt| j|| j}W n tk
r Y nX |dk r|| S td| dS )a Dispatches 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.
Nz method "%s" is not supportedr9 ) r! KeyError Exceptionr" rK r9 r r r )r' rA r@ funcr r r r9 s*
z SimpleXMLRPCDispatcher._dispatch)FNF)F)NN)NN)r,
__module__ __qualname____doc__r( r) r+ r2 r4 rG r. r/ r0 r3 r9 r r r r r s
$
)
$r c @ sf e Zd ZdZdZdZdZdZe dej
ej B Z dd Z
d d
Zd d Zd
d Zdd ZdddZdS )SimpleXMLRPCRequestHandlerzSimple XML-RPC request handler class.
Handles all HTTP POST requests and attempts to decode them as
XML-RPC requests.
)/z/RPC2ix Tz
\s* ([^\s;]+) \s* #content-coding
(;\s* q \s*=\s* ([0-9\.]+))? #q
c C s^ i }| j dd}|dD ]<}| j|}|r |d}|rFt|nd}|||d< q |S )NzAccept-EncodingrP , g ?r5 )headersgetr aepatternmatchgroupfloat)r' rZaeere vr r r accept_encodings s
z+SimpleXMLRPCRequestHandler.accept_encodingsc C s | j r| j| j kS dS d S )NT) rpc_pathsr? r1 r r r is_rpc_path_valid s z,SimpleXMLRPCRequestHandler.is_rpc_path_validc
C s | s| dS zd}t| jd }g }|rht||}| j|}|sLqh|| |t|d 8 }q,d |}|
|}|dkrW dS | j |t
| dd| j}W n tk
r6 } zp| d t| j dr| j jr| d t| t } t| d
d d
} | d | | d
d | W 5 d}~X Y nX | d | dd | jdk rt|| jkr| dd}
|
rzt |}| dd W n t k
r Y nX | d
tt| | | j | 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.
Ni zcontent-lengthr_ r9 i _send_traceback_headerz X-exceptionASCIIbackslashreplacez X-tracebackContent-length0 Content-typeztext/xmlgzipr zContent-Encoding) rm
report_404intrb minZrfilereadrU lenjoindecode_request_contentserverrG r r? rX
send_responserK ro send_headerstr traceback
format_excr< end_headersencode_thresholdrk rc r NotImplementedErrorwfilewrite) r' Zmax_chunk_sizeZsize_remainingLZ
chunk_sizechunkr= rB ri Ztraceqr r r do_POST s`
z"SimpleXMLRPCRequestHandler.do_POSTc C s | j dd }|dkr |S |dkrvz
t|W S tk
rT | dd| Y q tk
rr | dd Y qX n| dd| | dd | d S )
Nzcontent-encodingZidentityrv i zencoding %r not supported zerror decoding gzip contentrr rs ) rb rc lowerr r r
ValueErrorr r )r' r= r$ r r r r} $ s
z1SimpleXMLRPCRequestHandler.decode_request_contentc C sF | d d}| dd | dtt| | | j| d S )Ni s No such pageru z
text/plainrr )r r r r{ r r r r' rB r r r rw 5 s
z%SimpleXMLRPCRequestHandler.report_404-c C s | j jrt| || dS )z$Selectively log an accepted request.N)r~ logRequestsr log_request)r' codesizer r r r > s z&SimpleXMLRPCRequestHandler.log_requestN)r r )r, rZ r[ r\ rl r ZwbufsizeZdisable_nagle_algorithmrecompileVERBOSE
IGNORECASErd rk rm r r} rw r r r r r r] s
G r] c @ s. e Zd ZdZdZdZedddddfddZdS )SimpleXMLRPCServerag Simple 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.
TFNc C s, || _ t| ||| tj| ||| d S N)r r r( socketserver TCPServerr' ZaddrZrequestHandlerr r# r$ Zbind_and_activater% r r r r( W s zSimpleXMLRPCServer.__init__)r, rZ r[ r\ Zallow_reuse_addressro r] r( r r r r r D s r c @ s@ e Zd ZdZedddddfddZdd Zd 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
C s2 t | ||||||| i | _|| _|p*d| _d S r )r r( dispatchersr# r$ r r r r r( h s z MultiPathXMLRPCServer.__init__c C s || j |< |S r r )r' r?
dispatcherr r r add_dispatcherr s
z$MultiPathXMLRPCServer.add_dispatcherc C s
| j | S r r )r' r? r r r get_dispatcherv s z$MultiPathXMLRPCServer.get_dispatcherc C s| z| j | |||}W n^ t d d \}}z2ttdd||f | j| jd}|| jd}W 5 d }}X Y nX |S )N r5 r6 r7 r8 ) r rG r: r; r r r$ r# r< )r' r= r> r? rB rD rE r r r rG y s"
z)MultiPathXMLRPCServer._marshaled_dispatch)NN) r, rZ r[ r\ r] r( r r rG r r r r r ` s
r c @ s4 e Zd ZdZd ddZdd Zdd Zd
d
d ZdS )CGIXMLRPCRequestHandlerz3Simple handler for XML-RPC data passed through CGI.FNc C s t | ||| d S r )r r( r& r r r r( s z CGIXMLRPCRequestHandler.__init__c C sP | |}td tdt| t tj tjj| tjj dS )z Handle a single XML-RPC requestzContent-Type: text/xmlContent-Length: %dN)rG printr{ r: stdoutflushbufferr )r' request_textrB r r r
handle_xmlrpc s
z%CGIXMLRPCRequestHandler.handle_xmlrpcc C s d}t j| \}}tjj|||d }|d}td||f tdtjj tdt| t t j
t j
j
| t j
j dS )zHandle a single HTTP GET request.
Default implementation indicates an error because
XML-RPC uses the POST method.
r )r messageexplainr z
Status: %d %szContent-Type: %sr N)r Z responseshttpr~ ZDEFAULT_ERROR_MESSAGEr< r ZDEFAULT_ERROR_CONTENT_TYPEr{ r: r r r r )r' r r r rB r r r
handle_get s
z"CGIXMLRPCRequestHandler.handle_getc C sz |dkr$t jdddkr$| nRztt jdd}W n ttfk
rV d}Y nX |dkrltj |}|
| 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_ ) osenvironrc r rx r TypeErrorr: stdinrz r )r' r Zlengthr r r handle_request s
z&CGIXMLRPCRequestHandler.handle_request)FNF)N)r, rZ r[ r\ r( r r r r r r r r s
r c @ s> e Zd ZdZdi i i fddZdi i i dfddZdd ZdS )
ServerHTMLDocz7Class used to generate pydoc HTML document for a serverNc C sZ |p| j }g }d}td}|||} | s0q:| \}
} |||||
| \} }
}}}}|
r|| dd}|d||f n|rdt| }|d||| f n~|rdt| }|d||| f nV|| | d d kr || |||| n(|r"|d
| n|| || | }q ||||d d
|S )
zMark up some plain text, given a context of symbols to look for.
Each context dictionary maps object names to anchor names.r zM\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/r5 (zself.%sNrP ) escaper r searchspanrU groupsreplacerx Znamelinkr| )r' textr r! classesrM rV herepatternre startendallZschemeZrfcZpepZselfdotr* Zurlr r r markup s6
zServerHTMLDoc.markupc C s |r
|j p dd | }d} d| || |f }
t|rHtt|} nd} t|trp|d p`| } |d pld} n
t|} |
| | o| d| }
|
| | j |||}|od| }d |
|f S )
z;Produce HTML documentation for a function or method object.rP r z$%sz(...)r r5 z'%sz%sz- %s
%s
) r, r r r r
isinstancetuplerQ rR Zgreyr preformat)r' objectr* modr! r rM ZclZanchorZnotetitleZargspecZ docstringZdecldocr r r
docroutine s2
zServerHTMLDoc.docroutinec C s i }| D ] \}}d| ||< || ||< q | |}d| }| |dd}| || j|} | ohd| } |d| }g }
t| } | D ] \}}|
| j|||d q|| ddd d
|
}|S ) z1Produce HTML documentation for an XML-RPC server.z#-z)%sz#ffffffz#7799eez %sz
%s
)r! ZMethodsz#eeaa77rP )
itemsr Zheadingr r rL rU r Z
bigsectionr| ) r' server_nameZpackage_documentationrM Zfdictkeyvalueheadresultr contentsZ method_itemsr r r docserver s*
zServerHTMLDoc.docserver)r, rZ r[ r\ r r r r r r r r s )
r c @ s8 e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd S )
XMLRPCDocGeneratorzGenerates documentation for an XML-RPC server.
This class is designed as mix-in and should not
be constructed directly.
c C s d| _ d| _d| _d S )Nz XML-RPC Server DocumentationzGThis server exports the following methods through the XML-RPC protocol.)r server_documentation server_titler1 r r r r( : s zXMLRPCDocGenerator.__init__c C s
|| _ dS )z8Set the HTML title of the generated server documentationN)r )r' r r r r set_server_titleB s z#XMLRPCDocGenerator.set_server_titlec C s
|| _ dS )z7Set the name of the generated HTML server documentationN)r )r' r r r r set_server_nameG s z"XMLRPCDocGenerator.set_server_namec C s
|| _ dS )z3Set the documentation string for the entire server.N)r )r' r r r r set_server_documentationL s z+XMLRPCDocGenerator.set_server_documentationc C s i }| D ]}|| jkr&| j| }n| jdk rddg}t| jdrT| j||d< t| jdrp| j||d< t|}|dkr|}qt| jdszt| j|}W q tk
r |}Y qX q|}n |||< q t }|
| j | j |}|
t| j|S )a generate_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_argstringr rO r5 )NNr9 )r. r! r" rK r rO r r r r r r r Zpagehtmlr r )r' rM rN rA Z method_infoZ
documenterZ
documentationr r r generate_html_documentationQ s<
z.XMLRPCDocGenerator.generate_html_documentationN) r, rZ r[ r\ r( r r r r r r r r r 3 s r c @ s e Zd ZdZdd ZdS )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.
c C sf | s| dS | j d}| d | dd | dtt| | | j
| dS )}Handles the HTTP GET request.
Interpret all HTTP GET requests as requests for server
documentation.
Nr rt ru z text/htmlrr ) rm rw r~ r r< r r r r{ r r r r r r r do_GET s
z DocXMLRPCRequestHandler.do_GETN)r, rZ r[ r\ r r r r r r s r c @ s& e Zd ZdZedddddfddZdS )DocXMLRPCServerzXML-RPC and HTML documentation server.
Adds the ability to serve server documentation to the capabilities
of SimpleXMLRPCServer.
TFNc
C s& t | ||||||| t| d S r )r r( r r r r r r( s zDocXMLRPCServer.__init__)r, rZ r[ r\ r r( r r r r r s r c @ s e Zd ZdZdd Zdd ZdS )DocCGIXMLRPCRequestHandlerzJHandler for XML-RPC data and documentation requests passed through
CGIc C sT | d}td tdt| t tj tjj| tjj dS )r r zContent-Type: text/htmlr N) r r< r r{ r: r r r r r r r r r s
z%DocCGIXMLRPCRequestHandler.handle_getc C s t | t| d S r )r r( r r1 r r r r( s
z#DocCGIXMLRPCRequestHandler.__init__N)r, rZ r[ r\ r r( r r r r r s r __main__c @ s" e Zd Zdd ZG dd dZdS )ExampleServicec C s dS )NZ42r r1 r r r getData s zExampleService.getDatac @ s e Zd Zedd ZdS )zExampleService.currentTimec C s
t j S r )datetimeZnowr r r r getCurrentTime s z)ExampleService.currentTime.getCurrentTimeN)r, rZ r[ staticmethodr r r r r currentTime s r N)r, rZ r[ r r r r r r r s r )Z localhosti@ c C s | | S r r )xyr r r rn r add)r z&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)1r\ Z
xmlrpc.clientr r r r r Z http.serverr functoolsr inspectr r r r r: r r rQ r Zfcntl ImportErrorr r r r] r r r r ZHTMLDocr r r r r r, r r r~ r+ powr) r4 r Z
serve_foreverKeyboardInterruptexitr r r r sh j
,EbQ