← Back
Editing: xmlrpc.cpython-38.pyc
U ��W[�N � @ s\ d Z ddlmZmZ ddlmZmZmZmZ ddlm Z ddl Z erRddl m Z nddl Z ddlmZmZmZ ddlmZmZmZ ddlmZmZ dd lmZ d Zd Z e j Z e j Z e j Z e j Z d d � Z!G dd� de �Z"G dd� d�Z#G dd� dej$�Z%G dd� de%�Z&dd� Z'G dd� dej(�Z)dZ*G dd � d ej+�Z,G d d � d �Z-dddd d d d!d"gZ.dS )#z� A generic resource for publishing objects via XML-RPC. Maintainer: Itamar Shtull-Trauring @var Fault: See L{xmlrpclib.Fault} @type Fault: L{xmlrpclib.Fault} � )�division�absolute_import)�_PY3� intToBytes� nativeString� urllib_parse)�unicodeN)�resource�server�http)�defer�protocol�reactor)�reflect�failure)�Logger�A �B c C s d| _ | S )a\ Decorator to cause the request to be passed as the first argument to the method. If an I{xmlrpc_} method is wrapped with C{withRequest}, the request object is passed as the first argument to that method. For example:: @withRequest def xmlrpc_echo(self, request, s): return s @since: 10.2 T)� withRequest)�f� r �4/usr/lib/python3/dist-packages/twisted/web/xmlrpc.pyr , s r c @ s e Zd ZdZdS )�NoSuchFunctionz1 There is no function by the given name. N)�__name__� __module__� __qualname__�__doc__r r r r r @ s r c @ s e Zd ZdZdd� Zdd� ZdS )�HandleraP Handle a XML-RPC request and store the state for a request in progress. Override the run() method and return result using self.result, a Deferred. We require this class since we're not using threads, so we can't encapsulate state in a running function if we're going to have to wait for results. For example, lets say we want to authenticate against twisted.cred, run a LDAP query and then pass its result to a database query, all as a result of a single XML-RPC command. We'd use a Handler instance to store the state of the running command. c G s || _ t�� | _| j|� d S �N)r r �Deferred�result�run)�selfr �argsr r r �__init__W s zHandler.__init__c G s | j �td�� d S )Nz Implement run() in subclasses)r �errback�NotImplementedError)r" r# r r r r! \ s �z Handler.runN)r r r r r$ r! r r r r r F s r c @ s~ e Zd ZdZdZdZdZdZdZe � Z d dd �Z d d � Z d d � Z dd� Zdd� Zdd� Zd dd�Zdd� Zdd� Zdd � ZdS ) �XMLRPCa� A resource that implements XML-RPC. You probably want to connect this to '/RPC2'. Methods published can return XML-RPC serializable results, Faults, Binary, Boolean, DateTime, Deferreds, or Handler instances. By default methods beginning with 'xmlrpc_' are published. Sub-handlers for prefixed methods (e.g., system.listMethods) can be added with putSubHandler. By default, prefixes are separated with a '.'. Override self.separator to change this. @ivar allowNone: Permit XML translating of Python constant None. @type allowNone: C{bool} @ivar useDateTime: Present C{datetime} values as C{datetime.datetime} objects? @type useDateTime: C{bool} r r � �.)� POSTFc C s" t j�| � i | _|| _|| _d S r )r �Resourcer$ � subHandlers� allowNone� useDateTime)r" r- r. r r r r$ � s zXMLRPC.__init__c C s || j |< d S r )�__dict__)r" �name�valuer r r � __setattr__� s zXMLRPC.__setattr__c C s || j |< d S r )r, )r" �prefix�handlerr r r � putSubHandler� s zXMLRPC.putSubHandlerc C s | j �|d �S r )r, �get)r" r3 r r r � getSubHandler� s zXMLRPC.getSubHandlerc C s t | j�� �S r )�listr, �keys�r" r r r �getSubHandlerPrefixes� s z XMLRPC.getSubHandlerPrefixesc C s |j �dd� |�dd� z tj|j �� | jd�\}}W n@ tk rx } z"t| j d|f �}| � ||� W 5 d }~X Y n�X z| � |�}W n. tk r� } z| � ||� W 5 d }~X Y nbX g }|� � � |j� t|dd�r�tj||f|�� }ntj|f|�� }|� | j� |�| j ||� tjS )Nr s content-type� text/xml; charset=utf-8�Z use_datetimezCan't deserialize input: %sr F)�content�seek� setHeader� xmlrpclib�loads�readr. � Exception�Fault�FAILURE� _cbRender�lookupProcedureZ notifyFinishZ addErrback�append�getattrr Z maybeDeferred� _ebRenderZ addCallbackr Z NOT_DONE_YET) r" �requestr# Z functionPath�er Zfunction�responseFailed�dr r r � render_POST� s* � zXMLRPC.render_POSTNc C s� |rd S t |t�r|j}t |t�s(|f}z�ztj|d| jd�}W nF tk r� } z(t| jd|f �}tj|d| jd�}W 5 d }~X Y nX t |t �r�|� d�}|� dt t |��� |�|� W n | j�d� Y nX |�� d S )NT)Zmethodresponse� allow_nonezCan't serialize output: %s�utf8s content-length� )� isinstancer r rE rA �dumpsr- rD rF r �encoder@ r �len�write�_logr Zfinish)r" r rL rN r> rM r r r r rG � s8 � � �zXMLRPC._cbRenderc C s, t |jt�r|jS | j�d|� t| jd�S )NrS �error)rT r1 rE rY r rF )r" r r r r rK � s zXMLRPC._ebRenderc C s� |� | j�dkrN|�| jd�\}}| �|�}|dkrDt| jd| ��|�|�S t| d| d�}|stt| jd| ��n t|�s�t| jd| ��n|S dS )aN Given a string naming a procedure, return a callable object for that procedure or raise NoSuchFunction. The returned object will be called, and should return the result of the procedure, a Deferred, or a Fault instance. Override in subclasses if you want your own policy. The base implementation that given C{'foo'}, C{self.xmlrpc_foo} will be returned. If C{procedurePath} contains C{self.separator}, the sub-handler for the initial prefix is used to search for the remaining path. If you override C{lookupProcedure}, you may also want to override C{listProcedures} to accurately report the procedures supported by your resource, so that clients using the I{system.listMethods} procedure receive accurate results. @since: 11.1 ���r( Nzno such subHandler %sz xmlrpc_%szprocedure %s not foundzprocedure %s not callable) �find� separator�splitr7 r � NOT_FOUNDrH rJ �callable)r" Z procedurePathr3 r4 r r r r rH � s$ � ��zXMLRPC.lookupProcedurec C s t �| jd�S )z\ Return a list of the names of all xmlrpc procedures. @since: 11.1 Zxmlrpc_)r ZprefixedMethodNames� __class__r: r r r �listProcedures� s zXMLRPC.listProcedures)FF)N)r r r r r_ rF ZisLeafr] ZallowedMethodsr rY r$ r2 r5 r7 r; rP rG rK rH rb r r r r r' b s" &r' c @ sX e Zd ZdZdd� Zdd� Zdgge_dd� Zd d gge_d d � Zdd gd d gge_d S ) �XMLRPCIntrospectiona� Implement the XML-RPC Introspection API. By default, the methodHelp method returns the 'help' method attribute, if it exists, otherwise the __doc__ method attribute, if it exists, otherwise the empty string. To enable the methodSignature method, add a 'signature' method attribute containing a list of lists. See methodSignature's documentation for the format. Note the type strings should be XML-RPC types, not Python types. c C s t �| � || _dS )z� Implement Introspection support for an XMLRPC server. @param parent: the XMLRPC server to add Introspection support to. @type parent: L{XMLRPC} N)r' r$ �_xmlrpc_parent)r" �parentr r r r$ s z XMLRPCIntrospection.__init__c sb g }| j dfg}|r^|�d�\� �|��fdd�� �� D �� |�� �fdd�� �� D �� q|S )zO Return a list of the method names implemented by this server. rS r c s g | ] }� | �qS r r ��.0r0 )r3 r r � <listcomp>% s z:XMLRPCIntrospection.xmlrpc_listMethods.<locals>.<listcomp>c s$ g | ] }� � |��| � j f�qS r )r7 r] rf ��objr3 r r rh & s � �)rd �pop�extendrb r; )r" Z functionsZtodor ri r �xmlrpc_listMethods s � z&XMLRPCIntrospection.xmlrpc_listMethodsZarrayc C s( | j �|�}t|dd�p&t|dd�p&dS )zW Return a documentation string describing the use of the given method. �helpNr rS �rd rH rJ �r" �methodr r r �xmlrpc_methodHelp- s ��z%XMLRPCIntrospection.xmlrpc_methodHelp�stringc C s | j �|�}t|dd�pdS )a+ Return a list of type signatures. Each type signature is a list of the form [rtype, type1, type2, ...] where rtype is the return type and typeN is the type of the Nth argument. If no signature information is available, the empty string is returned. � signatureNrS ro rp r r r �xmlrpc_methodSignature7 s z*XMLRPCIntrospection.xmlrpc_methodSignatureN) r r r r r$ rm rt rr ru r r r r rc s �rc c C s | � dt| �� dS )z� Add Introspection support to an XMLRPC server. @param parent: the XMLRPC server to add Introspection support to. @type parent: L{XMLRPC} �systemN)r5 rc )Zxmlrpcr r r �addIntrospectionG s rw c @ s, e Zd Zdd� Zdd� Zdd� Zdd� Zd S ) � QueryProtocolc C s� d | _ | �d| jj� | �dd� | �d| jj� | �dd� | jj}| �dtt|��� | jj r�d� | jj | jj g�}d � d t � |�g�}| �d |� | �� | j�|� d S ) Nr* s User-Agents Twisted/XMLRPClibs Hosts Content-typer< s Content-length� :� s Basic s Authorization)� _responseZ sendCommand�factory�pathZ sendHeader�host�payloadr rW �user�join�password�base64Z b64encodeZ endHeaders� transportrX )r" r ZauthZ authHeaderr r r �connectionMadeR s z QueryProtocol.connectionMadec C s |dkr| j �||� d S )Ns 200)r| � badStatus)r" �version�status�messager r r � handleStatusb s zQueryProtocol.handleStatusc C s | j �� || _dS )z� Handle the XML-RPC response received from the server. Specifically, disconnect from the server and store the XML-RPC response so that it can be properly handled when the disconnect is finished. N)r� ZloseConnectionr{ )r" �contentsr r r �handleResponsef s z QueryProtocol.handleResponsec C s6 t j�| |� | jdk r2| jd }| _| j�|� dS )z� The connection to the server has been lost. If we have a full response from the server, then parse it and fired a Deferred with the return value or C{Fault} that the server gave us. N)r � HTTPClient�connectionLostr{ r| � parseResponse)r" �reason�responser r r r� q s z QueryProtocol.connectionLostN)r r r r� r� r� r� r r r r rx Q s rx zP<?xml version="1.0"?> <methodCall> <methodName>%s</methodName> %s </methodCall> c @ s> e Zd ZdZdZeZd dd�Zdd� Zd d � Z e Z d d � Z dS )� _QueryFactorya� XML-RPC Client Factory @ivar path: The path portion of the URL to which to post method calls. @type path: L{bytes} @ivar host: The value to use for the Host HTTP header. @type host: L{bytes} @ivar user: The username with which to authenticate with the server when making calls. @type user: L{bytes} or L{None} @ivar password: The password with which to authenticate with the server when making calls. @type password: L{bytes} or L{None} @ivar useDateTime: Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to C{False}. @type useDateTime: C{bool} NFr c C sd || | _ | _|| | _| _t|tj||d�f | _t| jt �rN| j� d�| _t � |�| _ | | _dS )a* @param method: The name of the method to call. @type method: C{str} @param allowNone: allow the use of None values in parameters. It's passed to the underlying xmlrpclib implementation. Defaults to C{False}. @type allowNone: C{bool} or L{None} @param args: the arguments to pass to the method. @type args: C{tuple} @param canceller: A 1-argument callable passed to the deferred as the canceller callback. @type canceller: callable or L{None} )rQ rR N)r} r~ r� r� �payloadTemplaterA rU r rT r rV r r �deferredr. ) r" r} r~ rq r� r� r- r# Z cancellerr. r r r r$ � s � z_QueryFactory.__init__c C sl | j s d S z tj|| jd�d d }W n( | j d }| _ |�t�� � Y nX | j d }| _ |�|� d S )Nr= r )r� rA rB r. r% r ZFailure�callback)r" r� r� r� r r r r� � s ���z_QueryFactory.parseResponsec C s& | j d k r"| j d }| _ |�|� d S r )r� r% )r" �_r� r� r r r �clientConnectionLost� s z"_QueryFactory.clientConnectionLostc C s" | j d }| _ |�t||�� d S r )r� r% � ValueError)r" r� r� r� r r r r� � s z_QueryFactory.badStatus)NNFr NF) r r r r r� rx r r$ r� r� ZclientConnectionFailedr� r r r r r� � s � r� c @ s2 e Zd ZdZeZdddddefdd�Zdd� ZdS ) �Proxya1 A Proxy for making remote XML-RPC calls. Pass the URL of the remote XML-RPC server to the constructor. Use C{proxy.callRemote('foobar', *args)} to call remote method 'foobar' with *args. @ivar user: The username with which to authenticate with the server when making calls. If specified, overrides any username information embedded in C{url}. If not specified, a value may be taken from C{url} if present. @type user: L{bytes} or L{None} @ivar password: The password with which to authenticate with the server when making calls. If specified, overrides any password information embedded in C{url}. If not specified, a value may be taken from C{url} if present. @type password: L{bytes} or L{None} @ivar allowNone: allow the use of None values in parameters. It's passed to the underlying L{xmlrpclib} implementation. Defaults to C{False}. @type allowNone: C{bool} or L{None} @ivar useDateTime: Accept datetime values as datetime.datetime objects. also passed to the underlying L{xmlrpclib} implementation. Defaults to C{False}. @type useDateTime: C{bool} @ivar connectTimeout: Number of seconds to wait before assuming the connection has failed. @type connectTimeout: C{float} @ivar _reactor: The reactor used to create connections. @type _reactor: Object providing L{twisted.internet.interfaces.IReactorTCP} @ivar queryFactory: Object returning a factory for XML-RPC protocol. Mainly useful for tests. NFg >@c C s t �|�\}} } } } } | �d�}t|�dkrn|�d��d�}|�d�| _z|�d�| _W qz d| _Y qzX n d | _| _|d �d�}|�d�| _zt|�d��| _ W n d| _ Y nX | | _ | j dkr�d| _ |dk| _ |dk r�|| _|dk r�|| _|| _ || _ || _|| _dS ) aX @param url: The URL to which to post method calls. Calls will be made over SSL if the scheme is HTTPS. If netloc contains username or password information, these will be used to authenticate, as long as the C{user} and C{password} arguments are not specified. @type url: L{bytes} � @� r ry N)rz N� /s https)r Zurlparser^ rW rk r� r� r~ �int�portr} �securer- r. �connectTimeout�_reactor)r" Zurlr� r� r- r. r� r ZschemeZnetlocr} ZparamsZqueryZfragmentZ netlocPartsZuserpassZhostportr r r r$ s< � zProxy.__init__c s� � �fdd�}| � | j| j|| j| j| j||| j� �| jrpddlm } | j j t | j�| j p\d�|�� | jd�� n"| j jt | j�| j p�d�| jd�� �jS )a Call remote XML-RPC C{method} with given arguments. @return: a L{defer.Deferred} that will fire with the method response, or a failure if the method failed. Generally, the failure type will be L{Fault}, but you can also have an C{IndexError} on some buggy servers giving empty responses. If the deferred is cancelled before the request completes, the connection is closed and the deferred will fire with a L{defer.CancelledError}. c s d �_ � �� d S r )r� Z disconnect)rO �Z connectorr| r r �cancel8 s z Proxy.callRemote.<locals>.cancelr )�ssli� )Ztimeout�P )� queryFactoryr} r~ r� r� r- r. r� �twisted.internetr� r� Z connectSSLr r� ZClientContextFactoryr� Z connectTCPr� )r" rq r# r� r� r r� r � callRemote+ s8 � � �zProxy.callRemote) r r r r r� r� r r$ r� r r r r r� � s ( � *r� rE �Binary�Boolean�DateTime)/r Z __future__r r Ztwisted.python.compatr r r r r r� Z xmlrpc.clientZclientrA Z twisted.webr r r r� r r r Ztwisted.pythonr r Ztwisted.loggerr r_ rF rE r� r� r� r r r r+ r' rc rw r� rx r� Z ClientFactoryr� r� �__all__r r r r �<module> sJ %A -Pw �
Save File
Cancel