Plan 9 from Bell Labs’s /usr/web/sources/contrib/stallion/root/sys/lib/python2.7/SimpleXMLRPCServer.pyo

Copyright © 2021 Plan 9 Foundation.
Distributed under the MIT License.
Download the Plan 9 distribution.


�`^c@s�dZddlZddlmZddlZddlZddlZddlZddlZddlZyddl	Z	Wne
k
r�eZ	nXed�Z
d�Zd�Zdfd��YZd	ejfd
��YZdejefd��YZd
efd��YZdefd��YZedkr�dGHeddf�Zeje�ejd�d�ej�ej�ndS(s;Simple XML-RPC Server.

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.

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 string functions available through
        # string.func_name
        import string
        self.string = string
    def _listMethods(self):
        # implement this method so that system.listMethods
        # knows to advertise the strings methods
        return list_public_methods(self) + \
                ['string.' + method for method in list_public_methods(self.string)]
    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�N(tFaultcCsg|r|jd�}n	|g}x?|D]7}|jd�rPtd|��q(t||�}q(W|S(sGresolve_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).
    t.t_s(attempt to access private attribute "%s"(tsplitt
startswithtAttributeErrortgetattr(tobjtattrtallow_dotted_namestattrsti((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytresolve_dotted_attributess
	
cCsEgt|�D]4}|jd�r
tt||�d�r
|^q
S(skReturns a list of attribute strings, found in the specified
    object, which represent callable attributesRt__call__(tdirRthasattrR(Rtmember((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytlist_public_methods�scCs+i}x|D]}d||<q
W|j�S(s�remove_duplicates([2,2,2,1,3,3]) => [3,1,2]

    Returns a copy of a list without duplicates. Every list
    item must be hashable and the order of the items in the
    resulting list is not defined.
    i(tkeys(tlsttutx((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytremove_duplicates�s
tSimpleXMLRPCDispatchercBs�eZdZedd�Zed�Zdd�Zd�Zd�Z	ddd�Z
d�Zd�Zd	�Z
d
�Zd�ZRS(
s'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.
    cCs(i|_d|_||_||_dS(N(tfuncstNonetinstancet
allow_nonetencoding(tselfRR((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyt__init__�s			cCs||_||_dS(sRegisters 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(RR	(RRR	((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytregister_instance�s!	cCs)|dkr|j}n||j|<dS(s�Registers a function to respond to XML-RPC requests.

        The optional name argument can be used to set a Unicode name
        for the function.
        N(Rt__name__R(Rtfunctiontname((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytregister_function�scCs2|jji|jd6|jd6|jd6�dS(s�Registers the XML-RPC introspection methods in the system
        namespace.

        see http://xmlrpc.usefulinc.com/doc/reserved.html
        ssystem.listMethodsssystem.methodSignaturessystem.methodHelpN(Rtupdatetsystem_listMethodstsystem_methodSignaturetsystem_methodHelp(R((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyt register_introspection_functions�s
cCs|jji|jd6�dS(s�Registers the XML-RPC multicall method in the system
        namespace.

        see http://www.xmlrpc.com/discuss/msgReader$1208ssystem.multicallN(RR$tsystem_multicall(R((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytregister_multicall_functions�scCsyytj|�\}}|dk	r6|||�}n|j||�}|f}tj|ddd|jd|j�}Wn�tk
r�}tj|d|jd|j�}nStj	�\}}	}
tjtjdd||	f�d|jd|j�}nX|S(s�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.
        tmethodresponseiRRs%s:%sN(
t	xmlrpclibtloadsRt	_dispatchtdumpsRRRtsystexc_info(Rtdatatdispatch_methodtpathtparamstmethodtresponsetfaulttexc_typet	exc_valuetexc_tb((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyt_marshaled_dispatch�s"	cCs�|jj�}|jdk	r}t|jd�rLt||jj��}q}t|jd�s}t|t|j��}q}n|j�|S(swsystem.listMethods() => ['add', 'subtract', 'multiple']

        Returns a list of the methods supported by the server.t_listMethodsR.N(	RRRRRRR=Rtsort(Rtmethods((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR%s
cCsdS(s#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.ssignatures not supported((Rtmethod_name((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR&-scCs�d}||jkr%|j|}ny|jdk	r�t|jd�rV|jj|�St|jd�s�yt|j||j�}Wq�tk
r�q�Xq�n|dkr�dSddl}|j	|�SdS(s�system.methodHelp('add') => "Adds two integers together"

        Returns a string containing documentation for the specified method.t_methodHelpR.ti�N(
RRRRRARR	Rtpydoctgetdoc(RR@R6RC((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR':s$

c
Cs�g}x�|D]�}|d}|d}y |j|j||�g�Wq
tk
r}}|ji|jd6|jd6�q
tj�\}}}	|jidd6d||fd6�q
Xq
W|S(s�system.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
        t
methodNameR5t	faultCodetfaultStringis%s:%s(tappendR.RRFRGR0R1(
Rt	call_listtresultstcallR@R5R8R9R:R;((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR)Zs 



 

cCs�d}y|j|}Wnxtk
r�|jdk	r�t|jd�r[|jj||�Syt|j||j�}Wq�tk
r�q�Xq�nX|dk	r�||�St	d|��dS(s�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.
        R.smethod "%s" is not supportedN(
RRtKeyErrorRRR.RR	Rt	Exception(RR6R5tfunc((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR.zs"


N(R t
__module__t__doc__tFalseRRRR#R(R*R<R%R&R'R)R.(((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR�s$		%		
	 	 tSimpleXMLRPCRequestHandlercBs~eZdZd
ZdZdZeZej	dej
ejB�Zd�Z
d�Zd�Zd	�Zd
�Zddd�ZRS(s�Simple XML-RPC request handler class.

    Handles all HTTP POST requests and attempts to decode them as
    XML-RPC requests.
    t/s/RPC2ixi�s�
                            \s* ([^\s;]+) \s*            #content-coding
                            (;\s* q \s*=\s* ([0-9\.]+))? #q
                            cCs�i}|jjdd�}xl|jd�D][}|jj|�}|r+|jd�}|rjt|�nd}|||jd�<q+q+W|S(NsAccept-EncodingRBt,ig�(theaderstgetRt	aepatterntmatchtgrouptfloat(RtrtaeteRXtv((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytaccept_encodings�scCs!|jr|j|jkStSdS(N(t	rpc_pathsR4tTrue(R((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytis_rpc_path_valid�s	c
CsN|j�s|j�dSy�d}t|jd�}g}xV|r�t||�}|jj|�}|spPn|j|�|t|d�8}q?Wdj	|�}|j
|�}|dkr�dS|jj
|t|dd�|j�}Wn�tk
rt}|jd�t|jd	�rW|jjrW|jd
t|��|jdtj��n|jdd
�|j�n�X|jd�|jdd�|jdk	rt|�|jkr|j�jdd�}	|	ry#tj|�}|jdd�Wqtk
r
qXqqn|jdtt|���|j�|jj |�dS(s�Handles 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
iscontent-lengthi�RBR.i�t_send_traceback_headersX-exceptionsX-tracebacksContent-lengtht0i�sContent-typestext/xmltgzipisContent-Encodingi(i�(!Rbt
report_404tintRUtmintrfiletreadRHtlentjointdecode_request_contentRtserverR<RR4RMt
send_responseRRctsend_headertstrt	tracebackt
format_exctend_headerstencode_thresholdR_RVR,tgzip_encodetNotImplementedErrortwfiletwrite(
Rtmax_chunk_sizetsize_remainingtLt
chunk_sizetchunkR2R7R]tq((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytdo_POST�sT
	
	"




cCs�|jjdd�j�}|dkr+|S|dkr�ytj|�SWq�tk
ro|jdd|�q�tk
r�|jdd�q�Xn|jdd|�|jdd	�|j	�dS(
Nscontent-encodingtidentityRei�sencoding %r not supportedi�serror decoding gzip contentsContent-lengthRd(
RURVtlowerR,tgzip_decodeRwRot
ValueErrorRpRt(RR2R((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyRms

cCs]|jd�d}|jdd�|jdtt|���|j�|jj|�dS(Ni�sNo such pagesContent-types
text/plainsContent-length(RoRpRqRkRtRxRy(RR7((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyRf*s

t-cCs)|jjr%tjj|||�ndS(s$Selectively log an accepted request.N(RntlogRequeststBaseHTTPServertBaseHTTPRequestHandlertlog_request(Rtcodetsize((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR�3s(RSs/RPC2(R RORPR`RutwbufsizeRatdisable_nagle_algorithmtretcompiletVERBOSEt
IGNORECASERWR_RbR�RmRfR�(((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyRR�s			F			tSimpleXMLRPCServercBs2eZdZeZeZeeeded�Z	RS(sgSimple 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	r�ttd�r�tj|j�tj	�}|tj
O}tj|j�tj|�ndS(Nt
FD_CLOEXEC(R�RRtSocketServert	TCPServertfcntlRRtfilenotF_GETFDR�tF_SETFD(RtaddrtrequestHandlerR�RRtbind_and_activatetflags((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyRLs	
N(
R RORPRatallow_reuse_addressRQRcRRRR(((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR�9s
	tMultiPathXMLRPCServercBsGeZdZeeeded�Zd�Zd�Z	ddd�Z
RS(s\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.
    cCs>tj|||||||�i|_||_||_dS(N(R�RtdispatchersRR(RR�R�R�RRR�((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyRcs

		cCs||j|<|S(N(R�(RR4t
dispatcher((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytadd_dispatcherls
cCs|j|S(N(R�(RR4((s(/sys/lib/python2.7/SimpleXMLRPCServer.pytget_dispatcherpscCs{y |j|j|||�}WnTtj�d \}}tjtjdd||f�d|jd|j�}nX|S(Niis%s:%sRR(	R�R<R0R1R,R/RRR(RR2R3R4R7R9R:((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR<ss
N(R RORPRRRaRQRRR�R�R<(((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR�[s		tCGIXMLRPCRequestHandlercBs;eZdZedd�Zd�Zd�Zdd�ZRS(s3Simple handler for XML-RPC data passed through CGI.cCstj|||�dS(N(RR(RRR((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR�scCs8|j|�}dGHdt|�GHHtjj|�dS(sHandle a single XML-RPC requestsContent-Type: text/xmlsContent-Length: %dN(R<RkR0tstdoutRy(Rtrequest_textR7((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyt
handle_xmlrpc�s
cCs}d}tjj|\}}tji|d6|d6|d6}d||fGHdtjGHdt|�GHHtjj|�dS(	s�Handle a single HTTP GET request.

        Default implementation indicates an error because
        XML-RPC uses the POST method.
        i�R�tmessagetexplains
Status: %d %ssContent-Type: %ssContent-Length: %dN(	R�R�t	responsestDEFAULT_ERROR_MESSAGEtDEFAULT_ERROR_CONTENT_TYPERkR0R�Ry(RR�R�R�R7((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyt
handle_get�scCs�|dkr4tjjdd�dkr4|j�nmyttjjdd��}Wnttfk
rrd}nX|dkr�tj	j
|�}n|j|�dS(s�Handle 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.
        tREQUEST_METHODtGETtCONTENT_LENGTHi�N(RtostenvironRVR�Rgt	TypeErrorR�R0tstdinRjR�(RR�tlength((s(/sys/lib/python2.7/SimpleXMLRPCServer.pythandle_request�s

N(	R RORPRQRRR�R�R�(((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyR��s
	
	t__main__s#Running XML-RPC server on port 8000t	localhosti@cCs||S(N((Rty((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyt<lambda>�stadd(RPR,RR�R�R0R�RrR�R�tImportErrorRRaRRRRR�RRR�R�R�R�R RnR#tpowR*t
serve_forever(((s(/sys/lib/python2.7/SimpleXMLRPCServer.pyt<module>as:

		
��!&=



Bell Labs OSI certified Powered by Plan 9

(Return to Plan 9 Home Page)

Copyright © 2021 Plan 9 Foundation. All Rights Reserved.
Comments to [email protected].