Yfv @ s d Z d d l m Z m Z m Z m Z m Z d d l m Z d d l Z d d l Z
d d l Z d d l Z d d l
Z
d d l Z d d l Z d d l Z d d l Z y d d l Z Wn e k
r d Z Yn Xd d d Z d d Z Gd
d d Z Gd d
d
e Z Gd d d e j e Z Gd d d e Z Gd d d e Z Gd d d e j Z Gd d d Z Gd d d e Z Gd d d e e Z Gd d d e e Z! e" d k rd d l# Z# Gd d d Z$ e d! d" f Z% e% j& e' e% j& d# d$ d% e% j( e$ d& d e% j) e* d' e* d( y e% j+ Wn3 e, k
re* d) e% j- e j. d Yn Xd S)*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)BaseHTTPRequestHandlerNTc C sg | r | j d } n | g } x? | D]7 } | j d rP t d | q( t | | } q( W| 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 2/opt/alt/python35/lib64/python3.5/xmlrpc/server.pyresolve_dotted_attribute{ s
r c s f d d t D S)zkReturns a list of attribute strings, found in the specified
object, which represent callable attributesc s; g | ]1 } | j d r t t | r | q S)r )r callabler
).0Zmember)r r r
s z'list_public_methods..)dir)r r )r r list_public_methods s r c @ s e Z d Z d Z d d d d d Z d d d Z d d d Z d
d Z d d
Z d d d d Z d d Z
d d Z d d Z d d Z
d d Z d S)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 s7 i | _ d | _ | | _ | p$ d | _ | | _ d S)Nzutf-8)funcsinstance
allow_noneencodinguse_builtin_types)selfr r r r r r __init__ s
z SimpleXMLRPCDispatcher.__init__c C s | | _ | | _ d S)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 s& | d k r | j } | | j | ['add', 'subtract', 'multiple']
Returns a list of the methods supported by the server.N _listMethodsr/ )setr keysr hasattrr> r sorted)r methodsr r r r' s z)SimpleXMLRPCDispatcher.system_listMethodsc C s d S)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 k r% | j | } nt | j d k r t | j d rV | j j | St | j d s y t | j | | j } Wn t k
r Yn X| d k r d St j | Sd S)zsystem.methodHelp('add') => "Adds two integers together"
Returns a string containing documentation for the specified method.N _methodHelpr/ ) r r rA rE r r r pydocgetdoc)r rD r7 r r r r) 2 s"
z(SimpleXMLRPCDispatcher.system_methodHelpc
C s g } x | D] } | d } | d } y | j | j | | g Wq
t k
r } z$ | j d | j d | j i WYd d } ~ Xq
t j \ } } } | j d d d d | | f i Yq
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
methodNamer6 faultCode faultStringNr- z%s:%s)appendr/ r rI rJ r0 r1 )
r Z call_listresultsZcallrD r6 r9 r: r; r< r r r r+ Q s
" z'SimpleXMLRPCDispatcher.system_multicallc C s y | j | } Wn t k
r% Yn' X| d k r< | | St d | | j d k r t | j d r | j j | | Sy t | j | | j } Wn t k
r Yn X| d k r | | St d | d S)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 supportedr/ ) r KeyError Exceptionr rA r/ r r r )r r7 r6 funcr r r r/ q s(
z SimpleXMLRPCDispatcher._dispatch)r#
__module__ __qualname____doc__r! r" r% r* r, r= r' r( r) r+ r/ r r r r r s $ %
r c @ s e Z d Z d Z d Z d Z d Z d Z e j d e j
e j B Z d d Z
d
d Z d d
Z d d Z d d Z d d d d Z d S)SimpleXMLRPCRequestHandlerzSimple XML-RPC request handler class.
Handles all HTTP POST requests and attempts to decode them as
XML-RPC requests.
//RPC2ix r- Tz
\s* ([^\s;]+) \s* #content-coding
(;\s* q \s*=\s* ([0-9\.]+))? #q
c C s i } | j j d d } xi | j d D]X } | j j | } | r+ | j d } | rj t | n d } | | | j d %sz'http://www.rfc-editor.org/rfc/rfc%d.txtz(http://www.python.org/dev/peps/pep-%04d/r- (zself.%sNrF ) escaper r searchspanrK groupsreplacern Znamelinkrr )r textr r classesrC rL herepatternr[ startendallschemeZrfcZpepZselfdotr$ Zurlr r r markup s8 "
zServerHTMLDoc.markupc C s | r | j p d d | } d } d | j | | j | f }
t j | r t j | } t j | j d d | j | j | j d | j
d | j } n] t j | r t j | } t j | j | j | j | j d | j
d | j } n d } t
| t r5| d p | } | d p/d }
n t j | }
|
| | oa| j d
| } | j |
| j | | | } | od | } d | | f S)
z;Produce HTML documentation for a function or method object.rF r z$%sr- N annotations formatvaluez(...)r z'%sz%sz- %s
%s
)r# r inspectZismethodZgetfullargspecZ
formatargspecargsZvarargsZvarkwZdefaultsr r Z
isfunction
isinstancetuplerG rH Zgreyr preformat)r objectr$ modr r rC ZclZanchorZnotetitler ZargspecZ docstringZdecldocr r r
docroutine s< zServerHTMLDoc.docroutinec C s i } x6 | j D]( \ } } d | | | <| | | | %sz#ffffffz#7799eez %sz
%s
r ZMethodsz#eeaa77rF )
itemsr Zheadingr r rB rK r Z
bigsectionrr ) r server_nameZpackage_documentationrC Zfdictkeyvalueheadresultr contentsZ method_itemsr r r docserver s"
# zServerHTMLDoc.docserver)r# rP rQ rR r r r r r r r r s
),r c @ sR e Z d Z d Z d d Z d d Z d d Z d d Z d
d Z d 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_title)r r r r r! 8 s zXMLRPCDocGenerator.__init__c C s
| | _ d S)z8Set the HTML title of the generated server documentationN)r )r r r r r set_server_title@ s z#XMLRPCDocGenerator.set_server_titlec C s
| | _ d S)z7Set the name of the generated HTML server documentationN)r )r r r r r set_server_nameE s z"XMLRPCDocGenerator.set_server_namec C s
| | _ d S)z3Set the documentation string for the entire server.N)r )r r r r r set_server_documentationJ s z+XMLRPCDocGenerator.set_server_documentationc C sa i } x| j D]
} | | j k r8 | j | } n | j d k rd d g } t | j d r{ | j j | | 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.N_get_method_argstringr rE r- r/ )NN)r' r r rA r rE r r r r r r r Zpagehtmlr r )r rC rD r7 Z method_infoZ
documenterZ
documentationr r r generate_html_documentationO s8
z.XMLRPCDocGenerator.generate_html_documentationN) r# rP rQ rR r! r r r r r r r r r 1 s r c @ s" e Z d Z d Z d d Z d S)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 s | j s | j d S| j j j d } | j d | j d d | j d t t | | j | j
j | d S)z}Handles the HTTP GET request.
Interpret all HTTP GET requests as requests for server
documentation.
Nzutf-8rj z Content-typez text/htmlzContent-length) rc rm rt r r2 ru rv rw rq rz r} r~ )r r8 r r r do_GET s
z DocXMLRPCRequestHandler.do_GETN)r# rP rQ rR r r r r r r s r c @ s4 e Z d Z d Z e d d d d d d d Z d S)DocXMLRPCServerzXML-RPC and HTML documentation server.
Adds the ability to serve server documentation to the capabilities
of SimpleXMLRPCServer.
TFNc C s3 t j | | | | | | | | t j | d S)N)r r! r )r r r r r r r r r r r r! s zDocXMLRPCServer.__init__)r# rP rQ rR r r! r r r r r s r c @ s. e Z d Z d Z d d Z d d Z d S)DocCGIXMLRPCRequestHandlerzJHandler for XML-RPC data and documentation requests passed through
CGIc C sn | j j d } t d t d t | t t j j t j j j | t j j j d S)z}Handles the HTTP GET request.
Interpret all HTTP GET requests as requests for server
documentation.
zutf-8zContent-Type: text/htmlzContent-Length: %dN) r r2 r rq r0 r r r r~ )r r8 r r r r s
z%DocCGIXMLRPCRequestHandler.handle_getc C s t j | t j | d S)N)r r! r )r r r r r! s
z#DocCGIXMLRPCRequestHandler.__init__N)r# rP rQ rR r r! r r r r r s r __main__c @ s/ e Z d Z d d Z Gd d d Z d S)ExampleServicec C s d S)NZ42r )r r r r getData s zExampleService.getDatac @ s" e Z d Z e d d Z d S)zExampleService.currentTimec C s
t j j S)N)datetimeZnowr r r r getCurrentTime s z)ExampleService.currentTime.getCurrentTimeN)r# rP rQ staticmethodr r r r r currentTime s r N)r# rP rQ r r r r r r r s r Z localhosti@ c C s | | S)Nr )xyr r r s r addr 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.)/rR Z
xmlrpc.clientr r r r r Z http.serverr r r r r0 r r rG r rx Zfcntl ImportErrorr r r rS r r r r ZHTMLDocr r r r r r# r r rt r% powr" r, r Z
serve_foreverKeyboardInterruptZ server_closeexitr r r r f s^ (
(ErQ