3 \]tq@sddlZddlZddlZddlZddlZddlZddlmZddlm Z ddlm Z ddlm Z ddlm Z ej dZGd d d eZdS) N)urllib) exceptions)packet)payload)socketzengineio.serverc@s$eZdZdZddgZdddgZdZdLddZddZddZ dMddZ dNddZ ddZ ddZ ddZdOdd Zd!d"Zd#d$Zd%d&ZdPd(d)Zd*d+Zd,d-Zd.d/Zd0d1ZdQd2d3Zd4d5Zd6d7Zd8d9ZdRd:d;Zdd?Zd@dAZdBdCZ dDdEZ!dFdGZ"dHdIZ#dJdKZ$dS)SServeraCAn Engine.IO server. This class implements a fully compliant Engine.IO web server with support for websocket and long-polling transports. :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 the 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. For advanced control, a two element tuple can be given, where the first number is the ping interval and the second is a grace period added by the server. The default grace period is 5 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 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 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``, run message event handlers in non-blocking threads. To run handlers synchronously, set to ``False``. 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 kwargs: Reserved for future extensions, any additional parameters given as keyword arguments will be silently ignored. gzipdeflateconnect disconnectmessageTN<ioFc Ks||_t|tr&|d|_|d|_n ||_d|_||_||_||_||_||_ | |_ | |_ | |_ i|_ i|_|dk rz|n|j|_| dk r| tj_t| ts| |_nPt|_tjj r|jjtjkr| r|jjtjn|jjtj|jjtj|j }|dk r||kr|gng}d|_!d|_"xp|D]h}yJt#j$d|j!|_!d|j!krZ|j!dnd}||j%krpw,||_"PWnt&k rYnXq,W|j"dkrt'd|j%rd|j!ks|j!d rt'd|j% rd|j!kr|j!drt'd |jj(d |j"dS) Nrrzengineio.async_drivers.ZasyncioFzInvalid async_mode specifiedz1The selected async_mode is not asyncio compatiblezKThe selected async_mode requires asyncio and must use the AsyncServer classzServer initialized for %s.)) ping_timeout isinstancetuple ping_intervalZping_interval_grace_periodmax_http_buffer_sizeallow_upgradeshttp_compressioncompression_thresholdcookiecors_allowed_originscors_credentialsasync_handlerssocketshandlers_default_monitor_clientsstart_service_taskrPacketjsonboolloggerdefault_loggerloggingrootlevelNOTSETsetLevelINFOERROR addHandler StreamHandler async_modes_async async_mode importlib import_moduleis_asyncio_based ImportError ValueErrorinfo)selfr4rrrrrrrrrr'r%rZmonitor_clientskwargsmodesmodeZ asyncio_basedr?:/tmp/pip-build-mqc4i71p/python-engineio/engineio/server.py__init__Ssl            zServer.__init__cCsdS)NFr?)r;r?r?r@r7szServer.is_asyncio_basedcCs ddddgS)NZeventletZ gevent_uwsgiZgevent threadingr?)r;r?r?r@r2szServer.async_modescs8jkrtdfdd}|dkr,|S||dS)aRegister an event handler. :param event: The event name. Can be ``'connect'``, ``'message'`` or ``'disconnect'``. :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. Example usage:: # as a decorator: @eio.on('connect') 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') eio.on('message', 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 receives the message payload as a second argument. The ``'disconnect'`` handler does not take a second argument. z Invalid eventcs|j<|S)N)r!)handler)eventr;r?r@ set_handlers zServer.on..set_handlerN) event_namesr9)r;rDrCrEr?)rDr;r@ons  z Server.oncCsNy|j|}Wn"tk r0|jjd|dSX|jtjtj||ddS)aZSend a message to a client. :param sid: The session id of the recipient client. :param data: The data to send to the client. Data can be of type ``str``, ``bytes``, ``list`` or ``dict``. If a ``list`` or ``dict``, the data will be serialized as JSON. :param binary: ``True`` to send packet as binary, ``False`` to send as text. If not given, unicode (Python 2) and str (Python 3) are sent as text, and str (Python 2) and bytes (Python 3) are sent as binary. zCannot send to sid %sN)databinary) _get_socketKeyErrorr'warningsendrr$ZMESSAGE)r;sidrHrIrr?r?r@rMs z Server.sendcCs|j|}|jS)aCReturn the user session for a client. :param sid: The session id of the client. 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. )rJsession)r;rNrr?r?r@ get_sessions zServer.get_sessioncCs|j|}||_dS)zStore the user session for a client. :param sid: The session id of the client. :param session: The session dictionary. N)rJrO)r;rNrOrr?r?r@ save_sessions zServer.save_sessioncsGfdddt}||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:: @eio.on('connect') def on_connect(sid, environ): username = authenticate_user(environ) if not username: return False with eio.session(sid) as session: session['username'] = username @eio.on('message') def on_message(sid, msg): with eio.session(sid) as session: print('received message from ', session['username']) cs,eZdZddZfddZfddZdS)z0Server.session.._session_context_managercSs||_||_d|_dS)N)serverrNrO)r;rRrNr?r?r@rAsz9Server.session.._session_context_manager.__init__cs|jj|_|jS)N)rRrPrO)r;)rNr?r@ __enter__ sz:Server.session.._session_context_manager.__enter__cs|jj|jdS)N)rRrQrO)r;args)rNr?r@__exit__sz9Server.session.._session_context_manager.__exit__N)__name__ __module__ __qualname__rArSrUr?)rNr?r@_session_context_managers rY)object)r;rNrYr?)rNr@rOs zServer.sessionc Csp|dk rHy|j|}Wntk r*YqlX|j||jkrl|j|=n$xtj|jD] }|jqVWi|_dS)zDisconnect a client. :param sid: The session id of the client to close. If this parameter is not given, then all clients are closed. N)rJrKcloser six itervalues)r;rNrclientr?r?r@r s   zServer.disconnectcCs|j|jrdSdS)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. websocketpolling)rJupgraded)r;rNr?r?r@ transport+szServer.transportcCs|jgkrf|jd}|rf|j|}|dk rf||krf|jj|d|j}||d|d|dgS|d}tjj|jdd }d |kr|d d nd}d } d } d} d |kr|d d dks|d d j dkrd} d|krd} yt |dd } Wnt t t fk rYnX| r>| dkr>|jjd|j}n|dkr`|dkr|jddgd } | dkr| dkr|jjd| |j}n|j||| | | }n||jkr|jjd||j}n|j|} y2| j||}t|tr|j|| | d}n|}Wn6tjk r:||jkr.|j||j}YnX||jkrB|j|jrB|j|=n|dkr|dks||jkr|jjd||j}n~|j|} y| j||j| d}WnXtjk r||jkr|j||j}Yn$|jjd|j| d}YnXn*|dkr,|j}n|jjd||j}t|tsX|pVgS|jrt|d|j krdd |jd!d j!d"D}xL|D]D}||j"krt#|d#||d|d<|dd$|fg7<PqW|j$|}||d|d||dgS)%a+Handle an HTTP request from the client. This is the entry point of the Engine.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. HTTP_ORIGINNz is not an accepted origin.statusheadersresponseREQUEST_METHOD QUERY_STRINGrNrFb641trueTjzInvalid JSONP index numberGETrbr`r_zInvalid transport %szInvalid session %s)rj jsonp_indexPOST)rozpost request handler errorOPTIONSzMethod %s not supportedcSsg|]}|jddjqS);r)splitstrip).0er?r?r@ sz)Server.handle_request..ZHTTP_ACCEPT_ENCODING,_zContent-Encoding)%rget_cors_allowed_originsr'r: _bad_requestrparseparse_qslowerintr9rK IndexErrorrL_handle_connectr rJhandle_get_requestrlist_okrZ EngineIOErrorr closedZhandle_post_request exception_method_not_founddictrlenrrscompression_methodsgetattr _cors_headers)r;environstart_responseoriginallowed_originsrmethodqueryrNrjZjsonprorbrpackets encodingsencodingZ cors_headersr?r?r@handle_request5s     $                              zServer.handle_requestcOs |jd|||d}|j|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. thread)targetrTr<)r3start)r;rrTr<thr?r?r@start_background_taskszServer.start_background_taskrcCs|jd|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. sleep)r3)r;secondsr?r?r@rsz Server.sleepcOs|jd||S)zCreate a queue object using the appropriate async model. This is a utility function that applications can use to create a queue without having to worry about using the correct call for the selected async mode. queue)r3)r;rTr<r?r?r@ create_queueszServer.create_queuecCs |jdS)zReturn the queue empty exception for the appropriate async model. This is a utility function that applications can use to work with a queue without having to worry about using the correct call for the selected async mode. Z queue_empty)r3)r;r?r?r@get_queue_empty_exceptionsz Server.get_queue_empty_exceptioncOs|jd||S)zCreate an event object using the appropriate async model. This is a utility function that applications can use to create an event without having to worry about using the correct call for the selected async mode. rD)r3)r;rTr<r?r?r@ create_eventszServer.create_eventcCs tjjS)zGenerate a unique session id.)uuiduuid4hex)r;r?r?r@ _generate_idszServer._generate_idc Cs,|jrd|_|j|j|j}tj||}||j|<tjtj ||j ||t |j dt |j dd}|j||jd||dd} | dkr|j|=|jjd|jS|dkr|j||} |jr|j|=| Sd|_d } |jrd |jd |fg} y|j|j| ||d Stjk r&|jSXd S) z#Handle a client connection request.Fi)rNZupgradesZ pingTimeoutZ pingIntervalr ) run_asynczApplication rejected connectionr_TNz Set-Cookie=)rerjro)r#r _service_taskrrZSocketr rr$ZOPEN _upgradesrrrrM_trigger_eventr'rL _unauthorizedrr connectedrrpollrZ QueueEmptyr|) r;rrrbrjrorNsZpktretrer?r?r@rs>        zServer._handle_connectcCs4|j s*|j|js*|jddks*|dkr.gSdgS)z=Return the list of possible upgrades for a client connection.r_N)rrJrar3)r;rNrbr?r?r@rszServer._upgradesc Osl|jdd}||jkrh|r0|j|j|f|Sy|j||S|jj|d|dkrbdSYnXdS)zInvoke an event handler.rFz handler errorr N)popr!rr'r)r;rDrTr<rr?r?r@rs  zServer._trigger_eventc CsFy|j|}Wntk r*tdYnX|jrB|j|=td|S)z-Return the socket object for a given session.zSession not foundzSession is disconnected)r rKr)r;rNrr?r?r@rJ)szServer._get_socketcCs^|dk rL|dkrg}|r$|d g7}n |d g7}d|tj|dj||ddSdd gd dSdS)z$Generate a successful HTTP response.N Content-Typetext/plain; charset=UTF-8application/octet-streamz200 OK)r)rjro)rdrerf text/plainsOK)rr)rr)rr)rZPayloadencode)r;rrerjror?r?r@r4s   z Server._okcCsddgddS)z+Generate a bad request HTTP error response.z400 BAD REQUEST Content-Type text/plains Bad Request)rdrerf)rrr?)r;r?r?r@r|FszServer._bad_requestcCsddgddS)z0Generate a method not found HTTP error response.z405 METHOD NOT FOUND Content-Type text/plainsMethod Not Found)rdrerf)rrr?)r;r?r?r@rLszServer._method_not_foundcCsddgddS)z,Generate a unauthorized HTTP error response.z401 UNAUTHORIZED Content-Type text/plains Unauthorized)rdrerf)rrr?)r;r?r?r@rRszServer._unauthorizedcCsg}d|kr|d|kr||jdj|d|ddd|kr||jd|djddj}|jdj||djddjd|jdkr|}n.|jd krd}nt|jtjr|jg}n|j}|S) Nzwsgi.url_schemeZ HTTP_HOSTz{scheme}://{host})schemehostZHTTP_X_FORWARDED_HOSTZHTTP_X_FORWARDED_PROTOrxr*) appendformatrzrsrtrrr\ string_types)r;rZdefault_originsrrr?r?r@r{Xs&    zServer._cors_allowed_originscCs|jgkrgSg}|j|}d|krF|dks8|d|krFd|dfg}|ddkr\|d g7}d|krv|d |dfg7}|jr|d g7}|S)z1Return the cross-origin-resource-sharing headers.rcNzAccess-Control-Allow-OriginrgrqAccess-Control-Allow-MethodsOPTIONS, GET, POSTZ#HTTP_ACCESS_CONTROL_REQUEST_HEADERSzAccess-Control-Allow-Headers Access-Control-Allow-Credentialsrl)rr)rrl)rr{r)r;rrerr?r?r@rns      zServer._cors_headersc Cs4tj}tj|dd}|j|WdQRX|jS)z%Apply gzip compression to a response.w)fileobjr>N)r\BytesIOr GzipFilewritegetvalue)r;rfZbytesiogzr?r?r@_gzipsz Server._gzipcCs tj|S)z(Apply deflate compression to a response.)zlibcompress)r;rfr?r?r@_deflateszServer._deflatec Csxt|jdkr|j|jqt|jt|j}y>x8|jjjD]&}|j r`|j r`|j |j|qDWWqt t fk r|j j dPYq|j jdYqXqWdS)z;Monitor connected clients and clean up those that time out.rzservice task canceledzservice task exceptionN)rr rrfloatcopyvaluesclosingrZcheck_ping_timeout SystemExitKeyboardInterruptr'r:r)r;Zsleep_intervalrr?r?r@rs  zServer._service_task)NrrrTTrrNTFNTN)N)N)N)r)FN)NNFN)%rVrWrX__doc__rrFr"rAr7r2rGrMrPrQrOr rbrrrrrrrrrrrJrr|rrr{rrrrr?r?r?r@rsP<  ? *   %  w     ) r)r r5r)rrr\Z six.movesrrirrrr getLoggerr(rZrr?r?r?r@s