f^c@sSdZdZddlZddlZddlZddlZddlZyddlZWnek rxddl ZYnXdddddd d d d d dg Z e edre j ddddgnddZ GdddZGdddeZGdddeZGdddZGdd d ZGdddeeZGdddeeZGdddeeZGdd d eeZe edrGd ddeZGd!ddeZGd"ddeeZGd#ddeeZnGd$d d ZGd%d d eZGd&d d eZdS('uGeneric socket server classes. This module tries to capture the various aspects of defining a server: For socket-based servers: - address family: - AF_INET{,6}: IP (Internet Protocol) sockets (default) - AF_UNIX: Unix domain sockets - others, e.g. AF_DECNET are conceivable (see - socket type: - SOCK_STREAM (reliable stream, e.g. TCP) - SOCK_DGRAM (datagrams, e.g. UDP) For request-based servers (including socket-based): - client address verification before further looking at the request (This is actually a hook for any processing that needs to look at the request before anything else, e.g. logging) - how to handle multiple requests: - synchronous (one request is handled at a time) - forking (each request is handled by a new process) - threading (each request is handled by a new thread) The classes in this module favor the server type that is simplest to write: a synchronous TCP/IP server. This is bad class design, but save some typing. (There's also the issue that a deep class hierarchy slows down method lookups.) There are five classes in an inheritance diagram, four of which represent synchronous servers of four types: +------------+ | BaseServer | +------------+ | v +-----------+ +------------------+ | TCPServer |------->| UnixStreamServer | +-----------+ +------------------+ | v +-----------+ +--------------------+ | UDPServer |------->| UnixDatagramServer | +-----------+ +--------------------+ Note that UnixDatagramServer derives from UDPServer, not from UnixStreamServer -- the only difference between an IP and a Unix stream server is the address family, which is simply repeated in both unix server classes. Forking and threading versions of each type of server can be created using the ForkingMixIn and ThreadingMixIn mix-in classes. For instance, a threading UDP server class is created as follows: class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass The Mix-in class must come first, since it overrides a method defined in UDPServer! Setting the various member variables also changes the behavior of the underlying server mechanism. To implement a service, you must derive a class from BaseRequestHandler and redefine its handle() method. You can then run various versions of the service by combining one of the server classes with your request handler class. The request handler class must be different for datagram or stream services. This can be hidden by using the request handler subclasses StreamRequestHandler or DatagramRequestHandler. Of course, you still have to use your head! For instance, it makes no sense to use a forking server if the service contains state in memory that can be modified by requests (since the modifications in the child process would never reach the initial state kept in the parent process and passed to each child). In this case, you can use a threading server, but you will probably have to use locks to avoid two requests that come in nearly simultaneous to apply conflicting changes to the server state. On the other hand, if you are building e.g. an HTTP server, where all data is stored externally (e.g. in the file system), a synchronous class will essentially render the service "deaf" while one request is being handled -- which may be for a very long time if a client is slow to read all the data it has requested. Here a threading or forking server is appropriate. In some cases, it may be appropriate to process part of a request synchronously, but to finish processing in a forked child depending on the request data. This can be implemented by using a synchronous server and doing an explicit fork in the request handler class handle() method. Another approach to handling multiple simultaneous requests in an environment that supports neither threads nor fork (or where these are too expensive or inappropriate for the service) is to maintain an explicit table of partially finished requests and to use select() to decide which request to work on next (or whether to handle a new incoming request). This is particularly important for stream services where each client can potentially be connected for a long time (if threads or subprocesses cannot be used). Future work: - Standard classes for Sun RPC (which uses either UDP or TCP) - Standard mix-in classes to implement various authentication and encryption schemes - Standard framework for select-based multiplexing XXX Open problems: - What to do with out-of-band data? BaseServer: - split generic "request" functionality out into BaseServer class. Copyright (C) 2000 Luke Kenneth Casson Leighton example: read entries from a SQL database (requires overriding get_request() to return a table entry from the database). entry is processed by a RequestHandlerClass. u0.4iNu TCPServeru UDPServeruForkingUDPServeruForkingTCPServeruThreadingUDPServeruThreadingTCPServeruBaseRequestHandleruStreamRequestHandleruDatagramRequestHandleruThreadingMixInu ForkingMixInuAF_UNIXuUnixStreamServeruUnixDatagramServeruThreadingUnixStreamServeruThreadingUnixDatagramServercGsXxQy||SWqtk rP}z|jtjkr>nWYdd}~XqXqdS(u*restart a system call interrupted by EINTRN(uOSErroruerrnouEINTR(ufuncuargsue((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu _eintr_retrys u _eintr_retrycBs|EeZdZdZd!ZddZddZdddZd d Z d d Z d dZ ddZ ddZ ddZddZddZddZddZddZdd Zd!S("u BaseServeruBase class for server classes. Methods for the caller: - __init__(server_address, RequestHandlerClass) - serve_forever(poll_interval=0.5) - shutdown() - handle_request() # if you do not use serve_forever() - fileno() -> int # for select() Methods that may be overridden: - server_bind() - server_activate() - get_request() -> request, client_address - handle_timeout() - verify_request(request, client_address) - server_close() - process_request(request, client_address) - shutdown_request(request) - close_request(request) - service_actions() - handle_error() Methods for derived classes: - finish_request(request, client_address) Class variables that may be overridden by derived classes or instances: - timeout - address_family - socket_type - allow_reuse_address Instance variables: - RequestHandlerClass - socket cCs.||_||_tj|_d|_dS(u/Constructor. May be extended, do not override.NF(userver_addressuRequestHandlerClassu threadinguEventu_BaseServer__is_shut_downuFalseu_BaseServer__shutdown_request(uselfuserver_addressuRequestHandlerClass((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu__init__s  uBaseServer.__init__cCsdS(uSCalled by constructor to activate the server. May be overridden. N((uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuserver_activatesuBaseServer.server_activateg?c Cs|jjz^xW|jsittj|ggg|\}}}||kr\|jn|jqWWdd|_|jjXdS(uHandle one request at a time until shutdown. Polls for shutdown every poll_interval seconds. Ignores self.timeout. If you need to do periodic tasks, do them in another thread. NF( u_BaseServer__is_shut_downuclearu_BaseServer__shutdown_requestu _eintr_retryuselectu_handle_request_noblockuservice_actionsuFalseuset(uselfu poll_intervaluruwue((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu serve_forevers     uBaseServer.serve_forevercCsd|_|jjdS(uStops the serve_forever loop. Blocks until the loop has finished. This must be called while serve_forever() is running in another thread, or it will deadlock. NT(uTrueu_BaseServer__shutdown_requestu_BaseServer__is_shut_downuwait(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyushutdowns uBaseServer.shutdowncCsdS(uCalled by the serve_forever() loop. May be overridden by a subclass / Mixin to implement any code that needs to be run during the loop. N((uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuservice_actionssuBaseServer.service_actionscCs|jj}|dkr'|j}n$|jdk rKt||j}nttj|ggg|}|ds|jdS|jdS(uOHandle one request, possibly blocking. Respects self.timeout. iN( usocketu gettimeoutuNoneutimeoutuminu _eintr_retryuselectuhandle_timeoutu_handle_request_noblock(uselfutimeoutufd_sets((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuhandle_requests    uBaseServer.handle_requestcCsy|j\}}Wntjk r1dSYnX|j||ry|j||Wq|j|||j|YqXndS(uHandle one request, without blocking. I assume that select.select has returned that the socket is readable before this function was called, so there should be no risk of blocking in get_request(). N(u get_requestusocketuerroruverify_requestuprocess_requestu handle_errorushutdown_request(uselfurequestuclient_address((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu_handle_request_noblock%s u"BaseServer._handle_request_noblockcCsdS(ucCalled if no new request arrives within self.timeout. Overridden by ForkingMixIn. N((uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuhandle_timeout7suBaseServer.handle_timeoutcCsdS(unVerify the request. May be overridden. Return True if we should proceed with this request. T(uTrue(uselfurequestuclient_address((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuverify_request>suBaseServer.verify_requestcCs!|j|||j|dS(uVCall finish_request. Overridden by ForkingMixIn and ThreadingMixIn. N(ufinish_requestushutdown_request(uselfurequestuclient_address((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuprocess_requestFsuBaseServer.process_requestcCsdS(uDCalled to clean-up the server. May be overridden. N((uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu server_closeOsuBaseServer.server_closecCs|j|||dS(u8Finish one request by instantiating RequestHandlerClass.N(uRequestHandlerClass(uselfurequestuclient_address((u1/opt/alt/python33/lib64/python3.3/socketserver.pyufinish_requestWsuBaseServer.finish_requestcCs|j|dS(u3Called to shutdown and close an individual request.N(u close_request(uselfurequest((u1/opt/alt/python33/lib64/python3.3/socketserver.pyushutdown_request[suBaseServer.shutdown_requestcCsdS(u)Called to clean up an individual request.N((uselfurequest((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu close_request_suBaseServer.close_requestcCsPtddtdddt|ddl}|jtdddS(utHandle an error gracefully. May be overridden. The default is to print a traceback and continue. u-i(u4Exception happened during processing of request fromuendu iN(uprintu tracebacku print_exc(uselfurequestuclient_addressu traceback((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu handle_errorcs    uBaseServer.handle_errorN(u__name__u __module__u __qualname__u__doc__uNoneutimeoutu__init__userver_activateu serve_foreverushutdownuservice_actionsuhandle_requestu_handle_request_noblockuhandle_timeoutuverify_requestuprocess_requestu server_closeufinish_requestushutdown_requestu close_requestu handle_error(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu BaseServers"+           u BaseServercBs|EeZdZdZejZejZdZ dZ dddZ ddZddZd d Zd d Zd dZddZddZdS(u TCPServeru3Base class for various socket-based server classes. Defaults to synchronous IP stream (i.e., TCP). Methods for the caller: - __init__(server_address, RequestHandlerClass, bind_and_activate=True) - serve_forever(poll_interval=0.5) - shutdown() - handle_request() # if you don't use serve_forever() - fileno() -> int # for select() Methods that may be overridden: - server_bind() - server_activate() - get_request() -> request, client_address - handle_timeout() - verify_request(request, client_address) - process_request(request, client_address) - shutdown_request(request) - close_request(request) - handle_error() Methods for derived classes: - finish_request(request, client_address) Class variables that may be overridden by derived classes or instances: - timeout - address_family - socket_type - request_queue_size (only for stream sockets) - allow_reuse_address Instance variables: - server_address - RequestHandlerClass - socket icCsOtj|||tj|j|j|_|rK|j|jndS(u/Constructor. May be extended, do not override.N(u BaseServeru__init__usocketuaddress_familyu socket_typeu server_binduserver_activate(uselfuserver_addressuRequestHandlerClassubind_and_activate((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu__init__s   uTCPServer.__init__cCsQ|jr(|jjtjtjdn|jj|j|jj|_dS(uOCalled by constructor to bind the socket. May be overridden. iN(uallow_reuse_addressusocketu setsockoptu SOL_SOCKETu SO_REUSEADDRubinduserver_addressu getsockname(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu server_binds uTCPServer.server_bindcCs|jj|jdS(uSCalled by constructor to activate the server. May be overridden. N(usocketulistenurequest_queue_size(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuserver_activatesuTCPServer.server_activatecCs|jjdS(uDCalled to clean-up the server. May be overridden. N(usocketuclose(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu server_closesuTCPServer.server_closecCs |jjS(uMReturn socket file number. Interface required by select(). (usocketufileno(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyufilenosuTCPServer.filenocCs |jjS(uYGet the request and client address from the socket. May be overridden. (usocketuaccept(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu get_requestsuTCPServer.get_requestc Cs=y|jtjWntjk r+YnX|j|dS(u3Called to shutdown and close an individual request.N(ushutdownusocketuSHUT_WRuerroru close_request(uselfurequest((u1/opt/alt/python33/lib64/python3.3/socketserver.pyushutdown_requests uTCPServer.shutdown_requestcCs|jdS(u)Called to clean up an individual request.N(uclose(uselfurequest((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu close_requestsuTCPServer.close_requestNFT(u__name__u __module__u __qualname__u__doc__usocketuAF_INETuaddress_familyu SOCK_STREAMu socket_typeurequest_queue_sizeuFalseuallow_reuse_addressuTrueu__init__u server_binduserver_activateu server_closeufilenou get_requestushutdown_requestu close_request(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu TCPServerqs-       cBs_|EeZdZdZd ZejZdZ ddZ ddZ ddZ d d Z d S( u UDPServeruUDP server class.i cCs.|jj|j\}}||jf|fS(N(usocketurecvfromumax_packet_size(uselfudatau client_addr((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu get_requestsuUDPServer.get_requestcCsdS(N((uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuserver_activatesuUDPServer.server_activatecCs|j|dS(N(u close_request(uselfurequest((u1/opt/alt/python33/lib64/python3.3/socketserver.pyushutdown_requestsuUDPServer.shutdown_requestcCsdS(N((uselfurequest((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu close_requestsuUDPServer.close_requestNF(u__name__u __module__u __qualname__u__doc__uFalseuallow_reuse_addressusocketu SOCK_DGRAMu socket_typeumax_packet_sizeu get_requestuserver_activateushutdown_requestu close_request(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu UDPServers    cBs\|EeZdZdZdZd ZdZddZddZ dd Z d d Z d S( u ForkingMixInu5Mix-in class to handle each request in a new process.i,i(cCsM|jdkrdSx{t|j|jkrytjdd\}}Wntjk rgd}YnX||jkr}qn|jj|qWx|jD]}ytj|tj\}}Wntjk rd}YnX|sqny|jj|Wqt k rD}z$t d|j ||jfWYdd}~XqXqWdS(u7Internal routine to wait for children that have exited.Niu%s. x=%d and list=%r( uactive_childrenuNoneulenu max_childrenuosuwaitpiduerroruremoveuWNOHANGu ValueErrorumessage(uselfupidustatusuchildue((u1/opt/alt/python33/lib64/python3.3/socketserver.pyucollect_children s,  uForkingMixIn.collect_childrencCs|jdS(unWait for zombies after self.timeout seconds of inactivity. May be extended, do not override. N(ucollect_children(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuhandle_timeout-suForkingMixIn.handle_timeoutcCs|jdS(uCollect the zombie child processes regularly in the ForkingMixIn. service_actions is called in the BaseServer's serve_forver loop. N(ucollect_children(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuservice_actions4suForkingMixIn.service_actionscCstj}|rN|jdkr-g|_n|jj||j|dSy.|j|||j|tjdWn:z!|j |||j|WdtjdXYnXdS(u-Fork a new subprocess to process the request.Nii( uosuforkuactive_childrenuNoneuappendu close_requestufinish_requestushutdown_requestu_exitu handle_error(uselfurequestuclient_addressupid((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuprocess_request;s     uForkingMixIn.process_requestN( u__name__u __module__u __qualname__u__doc__utimeoutuNoneuactive_childrenu max_childrenucollect_childrenuhandle_timeoutuservice_actionsuprocess_request(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu ForkingMixIns  cBs8|EeZdZdZdZddZddZdS(uThreadingMixInu4Mix-in class to handle each request in a new thread.c CsMy!|j|||j|Wn%|j|||j|YnXdS(ugSame as in BaseServer but as a thread. In addition, exception handling is done here. N(ufinish_requestushutdown_requestu handle_error(uselfurequestuclient_address((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuprocess_request_thread[s u%ThreadingMixIn.process_request_threadcCs;tjd|jd||f}|j|_|jdS(u*Start a new thread to process the request.utargetuargsN(u threadinguThreaduprocess_request_threadudaemon_threadsudaemonustart(uselfurequestuclient_addressut((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuprocess_requesths uThreadingMixIn.process_requestNF(u__name__u __module__u __qualname__u__doc__uFalseudaemon_threadsuprocess_request_threaduprocess_request(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuThreadingMixInTs cBs|EeZdZdS(uForkingUDPServerN(u__name__u __module__u __qualname__(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuForkingUDPServerpscBs|EeZdZdS(uForkingTCPServerN(u__name__u __module__u __qualname__(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuForkingTCPServerqscBs|EeZdZdS(uThreadingUDPServerN(u__name__u __module__u __qualname__(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuThreadingUDPServersscBs|EeZdZdS(uThreadingTCPServerN(u__name__u __module__u __qualname__(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuThreadingTCPServertscBs|EeZdZejZdS(uUnixStreamServerN(u__name__u __module__u __qualname__usocketuAF_UNIXuaddress_family(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuUnixStreamServerxscBs|EeZdZejZdS(uUnixDatagramServerN(u__name__u __module__u __qualname__usocketuAF_UNIXuaddress_family(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuUnixDatagramServer{scBs|EeZdZdS(uThreadingUnixStreamServerN(u__name__u __module__u __qualname__(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuThreadingUnixStreamServer~scBs|EeZdZdS(uThreadingUnixDatagramServerN(u__name__u __module__u __qualname__(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuThreadingUnixDatagramServerscBsJ|EeZdZdZddZddZddZdd Zd S( uBaseRequestHandleruBase class for request handler classes. This class is instantiated for each request to be handled. The constructor sets the instance variables request, client_address and server, and then calls the handle() method. To implement a specific service, all you need to do is to derive a class which defines a handle() method. The handle() method can find the request as self.request, the client address as self.client_address, and the server (in case it needs access to per-server information) as self.server. Since a separate instance is created for each request, the handle() method can define arbitrary other instance variariables. c CsE||_||_||_|jz|jWd|jXdS(N(urequestuclient_addressuserverusetupuhandleufinish(uselfurequestuclient_addressuserver((u1/opt/alt/python33/lib64/python3.3/socketserver.pyu__init__s    uBaseRequestHandler.__init__cCsdS(N((uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyusetupsuBaseRequestHandler.setupcCsdS(N((uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuhandlesuBaseRequestHandler.handlecCsdS(N((uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyufinishsuBaseRequestHandler.finishN(u__name__u __module__u __qualname__u__doc__u__init__usetupuhandleufinish(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuBaseRequestHandlers   cBsJ|EeZdZdZd ZdZdZd Z ddZ ddZ dS( uStreamRequestHandleru4Define self.rfile and self.wfile for stream sockets.iicCs|j|_|jdk r1|jj|jn|jrY|jjtjtj dn|jj d|j |_ |jj d|j|_dS(NurbuwbT(urequestu connectionutimeoutuNoneu settimeoutudisable_nagle_algorithmu setsockoptusocketu IPPROTO_TCPu TCP_NODELAYuTrueumakefileurbufsizeurfileuwbufsizeuwfile(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyusetups  uStreamRequestHandler.setupc CsV|jjs8y|jjWq8tjk r4Yq8Xn|jj|jjdS(N(uwfileucloseduflushusocketuerrorucloseurfile(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyufinishs  uStreamRequestHandler.finishNiF( u__name__u __module__u __qualname__u__doc__urbufsizeuwbufsizeuNoneutimeoutuFalseudisable_nagle_algorithmusetupufinish(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuStreamRequestHandlers  cBs2|EeZdZdZddZddZdS(uDatagramRequestHandleru6Define self.rfile and self.wfile for datagram sockets.cCsGddlm}|j\|_|_||j|_||_dS(Ni(uBytesIO(uiouBytesIOurequestupacketusocketurfileuwfile(uselfuBytesIO((u1/opt/alt/python33/lib64/python3.3/socketserver.pyusetupsuDatagramRequestHandler.setupcCs#|jj|jj|jdS(N(usocketusendtouwfileugetvalueuclient_address(uself((u1/opt/alt/python33/lib64/python3.3/socketserver.pyufinishsuDatagramRequestHandler.finishN(u__name__u __module__u __qualname__u__doc__usetupufinish(u __locals__((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuDatagramRequestHandlers (u__doc__u __version__usocketuselectusysuosuerrnou threadingu ImportErrorudummy_threadingu__all__uhasattruextendu _eintr_retryu BaseServeru TCPServeru UDPServeru ForkingMixInuThreadingMixInuForkingUDPServeruForkingTCPServeruThreadingUDPServeruThreadingTCPServeruUnixStreamServeruUnixDatagramServeruThreadingUnixStreamServeruThreadingUnixDatagramServeruBaseRequestHandleruStreamRequestHandleruDatagramRequestHandler(((u1/opt/alt/python33/lib64/python3.3/socketserver.pyuxsH             zO.+