3 \]'@sfddlZddlZddlZddlmZddlmZddlmZddlmZejdZ Gdd d e Z dS) N) base_manager) exceptions) namespace)packetzsocketio.serverc@s.eZdZdZdGddZddZdHd d Zd d Zd dZdIddZ dJddZ dKddZ dLddZ dMddZ dNddZdOddZdPddZdQd d!ZdRd"d#ZdSd$d%Zd&d'Zd(d)Zd*d+ZdTd-d.ZdUd/d0Zd1d2Zd3d4Zd5d6Zd7d8Zd9d:Zd;d<Zd=d>Zd?d@Z dAdBZ!dCdDZ"dEdFZ#dS)VServeraA Socket.IO server. This class implements a fully compliant Socket.IO web server with support for websocket and long-polling transports. :param client_manager: The client manager instance that will manage the client list. When this is omitted, the client list is stored in an in-memory structure, so the use of multiple connected servers is not possible. :param logger: To enable logging set to ``True`` or pass a logger object to use. To disable logging set to ``False``. The default is ``False``. :param binary: ``True`` to support binary payloads, ``False`` to treat all payloads as text. On Python 2, if this is set to ``True``, ``unicode`` values are treated as text, and ``str`` and ``bytes`` values are treated as binary. This option has no effect on Python 3, where text and binary payloads are always automatically discovered. :param json: An alternative json module to use for encoding and decoding packets. Custom json modules must have ``dumps`` and ``loads`` functions that are compatible with the standard library versions. :param async_handlers: If set to ``True``, event handlers for a client are executed in separate threads. To run handlers for a client synchronously, set to ``False``. The default is ``True``. :param always_connect: When set to ``False``, new connections are provisory until the connect handler returns something other than ``False``, at which point they are accepted. When set to ``True``, connections are immediately accepted, and then if the connect handler returns ``False`` a disconnect is issued. Set to ``True`` if you need to emit events from the connect handler and your client is confused when it receives events before the connection acceptance. In any other case use the default of ``False``. :param kwargs: Connection parameters for the underlying Engine.IO server. The Engine.IO configuration supports the following settings: :param async_mode: The asynchronous model to use. See the Deployment section in the documentation for a description of the available options. Valid async modes are "threading", "eventlet", "gevent" and "gevent_uwsgi". If this argument is not given, "eventlet" is tried first, then "gevent_uwsgi", then "gevent", and finally "threading". The first async mode that has all its dependencies installed is then one that is chosen. :param ping_timeout: The time in seconds that the client waits for the server to respond before disconnecting. The default is 60 seconds. :param ping_interval: The interval in seconds at which the client pings the server. The default is 25 seconds. :param max_http_buffer_size: The maximum size of a message when using the polling transport. The default is 100,000,000 bytes. :param allow_upgrades: Whether to allow transport upgrades or not. The default is ``True``. :param http_compression: Whether to compress packages when using the polling transport. The default is ``True``. :param compression_threshold: Only compress messages when their byte size is greater than this value. The default is 1024 bytes. :param cookie: Name of the HTTP cookie that contains the client session id. If set to ``None``, a cookie is not sent to the client. The default is ``'io'``. :param cors_allowed_origins: Origin or list of origins that are allowed to connect to this server. Only the same origin is allowed by default. Set this argument to ``'*'`` to allow all origins, or to ``[]`` to disable CORS handling. :param cors_credentials: Whether credentials (cookies, authentication) are allowed in requests to this server. The default is ``True``. :param monitor_clients: If set to ``True``, a background task will ensure inactive clients are closed. Set to ``False`` to disable the monitoring task (not recommended). The default is ``True``. :param engineio_logger: To enable Engine.IO logging set to ``True`` or pass a logger object to use. To disable logging set to ``False``. The default is ``False``. NFTc KsF|}|jdd} | dk r | |d<|dk r8|tj_||d<d|d<|jf||_|jjd|j|jjd|j|jjd|j ||_ i|_ i|_ i|_ i|_t|ts||_nRt|_tjj o|jjtjkr|r|jjtjn|jjtj|jjtj|dkrtj}||_|jj|d|_ ||_!||_"|jj#|_#dS) Nengineio_loggerloggerjsonFasync_handlersconnectmessage disconnect)$poprPacketr _engineio_server_classeioon_handle_eio_connect_handle_eio_message_handle_eio_disconnectbinaryenvironhandlersnamespace_handlers_binary_packet isinstanceboolr default_loggerloggingrootlevelNOTSETsetLevelINFOERROR addHandler StreamHandlerrZ BaseManagermanagerZ set_servermanager_initializedr always_connectZ async_mode) selfZclient_managerr rr r r*kwargsZengineio_optionsrr-:/tmp/pip-build-mqc4i71p/python-socketio/socketio/server.py__init__asD     zServer.__init__cCsdS)NFr-)r+r-r-r.is_asyncio_basedszServer.is_asyncio_basedcs0pdfdd}|dkr$|S||dS)aRegister an event handler. :param event: The event name. It can be any string. The event names ``'connect'``, ``'message'`` and ``'disconnect'`` are reserved and should not be used. :param handler: The function that should be invoked to handle the event. When this parameter is not given, the method acts as a decorator for the handler function. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the handler is associated with the default namespace. Example usage:: # as a decorator: @socket_io.on('connect', namespace='/chat') def connect_handler(sid, environ): print('Connection request') if environ['REMOTE_ADDR'] in blacklisted: return False # reject # as a method: def message_handler(sid, msg): print('Received message: ', msg) eio.send(sid, 'response') socket_io.on('message', namespace='/chat', message_handler) The handler function receives the ``sid`` (session ID) for the client as first argument. The ``'connect'`` event handler receives the WSGI environment as a second argument, and can return ``False`` to reject the connection. The ``'message'`` handler and handlers for custom event names receive the message payload as a second argument. Any values returned from a message handler will be passed to the client's acknowledgement callback function if it exists. The ``'disconnect'`` handler does not take a second argument. /cs&jkrij<|j<|S)N)r)handler)eventrr+r-r. set_handlers  zServer.on..set_handlerNr-)r+r3r2rr4r-)r3rr+r.rs %z Server.oncsTtdkr.set_handlerN)lencallablerr5)r+r6r,r4r-)r6r,r+r.r3s$z Server.eventcCsFt|tjstd|j|jkr,td|j|||j|j<dS)zRegister a namespace handler object. :param namespace_handler: An instance of a :class:`Namespace` subclass that handles all the event traffic for a namespace. zNot a namespace instancez+Not a valid namespace class for this serverN)rr Namespace ValueErrorr0Z _set_serverr)r+namespace_handlerr-r-r.register_namespaces   zServer.register_namespacec KsJ|pd}|p|}|jjd||p d||jj|||f|||d|dS)aEmit a custom event to one or more connected clients. :param event: The event name. It can be any string. The event names ``'connect'``, ``'message'`` and ``'disconnect'`` are reserved and should not be used. :param data: The data to send to the client or clients. Data can be of type ``str``, ``bytes``, ``list`` or ``dict``. If a ``list`` or ``dict``, the data will be serialized as JSON. :param to: The recipient of the message. This can be set to the session ID of a client to address only that client, or to to any custom room created by the application to address all the clients in that room, If this argument is omitted the event is broadcasted to all connected clients. :param room: Alias for the ``to`` parameter. :param skip_sid: The session ID of a client to skip when broadcasting to a room or to all clients. This can be used to prevent a message from being sent to the sender. To skip multiple sids, pass a list. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the event is emitted to the default namespace. :param callback: If given, this function will be called to acknowledge the the client has received the message. The arguments that will be passed to the function are those provided by the client. Callback functions can only be used when addressing an individual client. :param ignore_queue: Only used when a message queue is configured. If set to ``True``, the event is emitted to the clients directly, without going through the queue. This is more efficient, but only works when a single server process is used. It is recommended to always leave this parameter with its default value of ``False``. r1zemitting event "%s" to %s [%s]all)roomskip_sidcallbackN)r infor(emit) r+r3datator>r?rr@r,r-r-r.rBs $  z Server.emitc Ks"|jd||||||d|dS)aSend a message to one or more connected clients. This function emits an event with the name ``'message'``. Use :func:`emit` to issue custom event names. :param data: The data to send to the client or clients. Data can be of type ``str``, ``bytes``, ``list`` or ``dict``. If a ``list`` or ``dict``, the data will be serialized as JSON. :param to: The recipient of the message. This can be set to the session ID of a client to address only that client, or to to any custom room created by the application to address all the clients in that room, If this argument is omitted the event is broadcasted to all connected clients. :param room: Alias for the ``to`` parameter. :param skip_sid: The session ID of a client to skip when broadcasting to a room or to all clients. This can be used to prevent a message from being sent to the sender. To skip multiple sids, pass a list. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the event is emitted to the default namespace. :param callback: If given, this function will be called to acknowledge the the client has received the message. The arguments that will be passed to the function are those provided by the client. Callback functions can only be used when addressing an individual client. :param ignore_queue: Only used when a message queue is configured. If set to ``True``, the event is emitted to the clients directly, without going through the queue. This is more efficient, but only works when a single server process is used. It is recommended to always leave this parameter with its default value of ``False``. r )rCrDr>r?rr@N)r )rB)r+rCrDr>r?rr@r,r-r-r.send s$z Server.send<c  s|jstd|jjgfdd}|j|f||p:|||d|j|ds^tjtddkrvdStddkrddSdS) aEmit a custom event to a client and wait for the response. :param event: The event name. It can be any string. The event names ``'connect'``, ``'message'`` and ``'disconnect'`` are reserved and should not be used. :param data: The data to send to the client or clients. Data can be of type ``str``, ``bytes``, ``list`` or ``dict``. If a ``list`` or ``dict``, the data will be serialized as JSON. :param to: The session ID of the recipient client. :param sid: Alias for the ``to`` parameter. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the event is emitted to the default namespace. :param timeout: The waiting timeout. If the timeout is reached before the client acknowledges the event, then a ``TimeoutError`` exception is raised. :param ignore_queue: Only used when a message queue is configured. If set to ``True``, the event is emitted to the client directly, without going through the queue. This is more efficient, but only works when a single server process is used. It is recommended to always leave this parameter with its default value of ``False``. z/Cannot use call() when async_handlers is False.csj|jdS)N)appendset)r6) callback_argscallback_eventr-r.event_callbackgs z#Server.call..event_callback)rCr>rr@)timeoutrrN) r RuntimeErrorrZ create_eventrBwaitr TimeoutErrorr7) r+r3rCrDsidrrLr,rKr-)rIrJr.callGs  z Server.callcCs.|pd}|jjd||||jj|||dS)aEnter a room. This function adds the client to a room. The :func:`emit` and :func:`send` functions can optionally broadcast events to all the clients in a room. :param sid: Session ID of the client. :param room: Room name. If the room does not exist it is created. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the default namespace is used. r1z%s is entering room %s [%s]N)r rAr( enter_room)r+rPr>rr-r-r.rRss zServer.enter_roomcCs.|pd}|jjd||||jj|||dS)a2Leave a room. This function removes the client from a room. :param sid: Session ID of the client. :param room: Room name. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the default namespace is used. r1z%s is leaving room %s [%s]N)r rAr( leave_room)r+rPr>rr-r-r.rSs zServer.leave_roomcCs*|pd}|jjd|||jj||dS)aClose a room. This function removes all the clients from the given room. :param room: Room name. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the default namespace is used. r1zroom %s is closing [%s]N)r rAr( close_room)r+r>rr-r-r.rTs zServer.close_roomcCs|pd}|jj||S)zReturn the rooms a client is in. :param sid: Session ID of the client. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the default namespace is used. r1)r(Z get_rooms)r+rPrr-r-r.roomssz Server.roomscCs |pd}|jj|}|j|iS)aReturn the user session for a client. :param sid: The session id of the client. :param namespace: The Socket.IO namespace. If this argument is omitted the default namespace is used. The return value is a dictionary. Modifications made to this dictionary are not guaranteed to be preserved unless ``save_session()`` is called, or when the ``session`` context manager is used. r1)r get_session setdefault)r+rPr eio_sessionr-r-r.rVs  zServer.get_sessioncCs |pd}|jj|}|||<dS)aStore the user session for a client. :param sid: The session id of the client. :param session: The session dictionary. :param namespace: The Socket.IO namespace. If this argument is omitted the default namespace is used. r1N)rrV)r+rPsessionrrXr-r-r. save_sessions zServer.save_sessioncs"Gfdddt}||S)aNReturn the user session for a client with context manager syntax. :param sid: The session id of the client. This is a context manager that returns the user session dictionary for the client. Any changes that are made to this dictionary inside the context manager block are saved back to the session. Example usage:: @sio.on('connect') def on_connect(sid, environ): username = authenticate_user(environ) if not username: return False with sio.session(sid) as session: session['username'] = username @sio.on('message') def on_message(sid, msg): with sio.session(sid) as session: print('received message from ', session['username']) cs0eZdZddZfddZfddZdS)z0Server.session.._session_context_managercSs||_||_||_d|_dS)N)serverrPrrY)r+r[rPrr-r-r.r/sz9Server.session.._session_context_manager.__init__cs|jjd|_|jS)N)r)r[rVrY)r+)rrPr-r. __enter__s z:Server.session.._session_context_manager.__enter__cs|jj|jddS)N)r)r[rZrY)r+r6)rrPr-r.__exit__s z9Server.session.._session_context_manager.__exit__N)r5 __module__ __qualname__r/r\r]r-)rrPr-r._session_context_managersr`)object)r+rPrr`r-)rrPr.rYszServer.sessioncCs|pd}|jj||dr|jjd|||jj||d|j|tjtj|d|j d|||jj ||d|dkr|j j |dS)zDisconnect a client. :param sid: Session ID of the client. :param namespace: The Socket.IO namespace to disconnect. If this argument is omitted the default namespace is used. r1)rzDisconnecting %s [%s]rN) r( is_connectedr rApre_disconnect _send_packetrr DISCONNECT_trigger_eventrr)r+rPrr-r-r.rs zServer.disconnectcCs |jj|S)zReturn the name of the transport used by the client. The two possible values returned by this function are ``'polling'`` and ``'websocket'``. :param sid: The session of the client. )r transport)r+rPr-r-r.rgszServer.transportcCs|jj||S)a+Handle an HTTP request from the client. This is the entry point of the Socket.IO application, using the same interface as a WSGI application. For the typical usage, this function is invoked by the :class:`Middleware` instance, but it can be invoked directly when the middleware is not used. :param environ: The WSGI environment. :param start_response: The WSGI ``start_response`` function. This function returns the HTTP response body to deliver to the client as a byte sequence. )rhandle_request)r+rZstart_responser-r-r.rhszServer.handle_requestcOs|jj|f||S)adStart a background task using the appropriate async model. This is a utility function that applications can use to start a background task using the method that is compatible with the selected async mode. :param target: the target function to execute. :param args: arguments to pass to the function. :param kwargs: keyword arguments to pass to the function. This function returns an object compatible with the `Thread` class in the Python standard library. The `start()` method on this object is already called by this function. )rstart_background_task)r+targetr6r,r-r-r.riszServer.start_background_taskrcCs |jj|S)aSleep for the requested amount of time using the appropriate async model. This is a utility function that applications can use to put a task to sleep without having to worry about using the correct call for the selected async mode. )rsleep)r+secondsr-r-r.rk)sz Server.sleepc CsZtjr|j rd}nd}t|tr,t|}n|g}|j|tjtj ||g|||ddS)zSend a message to a client.FN)rrCidr) sixPY2rrtuplelistrdrrEVENT)r+rPr3rCrrmrr-r-r._emit_internal3s   zServer._emit_internalcCsR|j}t|tr|D]6}|dkr,|jj||r,|jd|||jj||q,W|dkr|jj||r|jdd||jj|ddS)zHandle a client disconnect.r1rN)rqr(Zget_namespacesrbrfr)r+rPrZnamespace_listnr-r-r._handle_disconnectls zServer._handle_disconnectcCst|pd}|jjd|d|||jj||s@|jjd||dS|jr^|j|j|||||n|j|||||dS)z Handle an incoming client event.r1z received event "%s" from %s [%s]rz#%s is not connected to namespace %sN)r rAr(rbwarningr ri_handle_event_internal)r+rPrrmrCr-r-r. _handle_event{s  zServer._handle_eventc Cs|j|d||f|dd}|dk r|dkr6g}nt|trJt|}n|g}tjrd|j rdd}nd}|j|tj tj ||||ddS)NrrF)rrmrCr) rfrrprqrnrorrdrrACK)r+r[rPrCrrmrrr-r-r.rs   zServer._handle_event_internalcCs.|pd}|jjd|||jj||||dS)z#Handle ACK packets from the client.r1zreceived ack from %s [%s]N)r rAr(Ztrigger_callback)r+rPrrmrCr-r-r. _handle_ackszServer._handle_ackcGsN||jkr*||j|kr*|j|||S||jkrJ|j|j|f|SdS)z$Invoke an application event handler.N)rrZ trigger_event)r+r3rr6r-r-r.rfs   zServer._trigger_eventcCs,|jsd|_|jj||j|<|j|dS)z&Handle the Engine.IO connection event.Tr1)r)r(Z initializerr|)r+rPrr-r-r.rs   zServer._handle_eio_connectcCs:||jkrb|j|}|j|r`|j|=|jtjkrJ|j||j|j|jn|j ||j|j|jntj |d}|jtj kr|j ||jn|jtj kr|j||jn|jtjkr|j||j|j|jnl|jtjkr|j ||j|j|jnH|jtjks |jtjkr||j|<n |jtjkr.tdntddS)zDispatch Engine.IO messages.)rvzUnexpected ERROR packet.zUnknown packet type.N)radd_attachmentZ packet_typerZ BINARY_EVENTrrrmrCrrrxr|rer~rrrZ BINARY_ACKr%r:)r+rPrCrur-r-r.rs,           zServer._handle_eio_messagecCs"|j|d||jkr|j|=dS)z"Handle Engine.IO disconnect event.r1N)r~r)r+rPr-r-r.rs  zServer._handle_eio_disconnectcCstjS)N)engineior)r+r-r-r.rszServer._engineio_server_class)NFFNTF)NN)NNNNNN)NNNNN)NNNNrF)N)N)N)N)N)N)N)N)r)NN)$r5r^r___doc__r/r0rr3r<rBrErQrRrSrTrUrVrZrYrrgrhrirkrsrdr|r~rrrrfrrrrr-r-r-r.rsJR - 1# * & +    (     r) rrrnrrrr getLoggerrrarr-r-r-r.s