File: //opt/saltstack/salt/lib/python3.10/site-packages/tornado/__pycache__/web.cpython-310.pyc
o
;jPA � @ s d Z ddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z ddl m
Z
ddlmZ ddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddl m!Z!m"Z" ddlm#Z# ddlm$Z$ dd l%m&Z& dd
lm'Z' dd lm(Z( dd lm)Z) dd
l*m+Z+m,Z,m-Z- ddlm.Z. ddl/m0Z0m1Z1 ddl2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z: ddl;m<Z<m=Z=m>Z> e9Z?ddl@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZHmIZImJZJmKZKmLZLmMZMmNZN ddl mOZO ddl@Z@e@jP�rddl@mQZQ eCeRe=eSejTejf ZUeCeVeReAeSeVf eAeSeRf f ZWdZX dZY dZZ dZ[ G dd� d�Z\e\� Z]G dd� d�Z^eLde^d �Z_d eKe_ d eKe_ fd d �Z`d eKe^ d eafd!d"�Zbd#eHd$eDeEd f d eHd$eDeEd f fd%d&�Zcd#eHd$eDeEd f d eHd$eDeEd f fd'd(�ZdG d)d*� d*e8�ZeG d+d,� d,e6�ZfG d-d.� d.e'jg�ZhG d/d0� d0ei�ZjG d1d2� d2ei�ZkG d3d4� d4ej�ZlG d5d6� d6e^�ZmG d7d8� d8e^�ZnG d9d:� d:e^�ZoG d;d<� d<e^�ZpG d=d>� d>�ZqG d?d@� d@eq�Zrd#eHd$eDeEd f d eHd$eDeEd f fdAdB�ZsG dCdD� dD�ZtG dEdF� dFet�ZuG dGdH� dHet�ZvG dIdJ� dJet�ZwG dKdL� dL�Zx dndMeWdNeVdOeCeVeRf dPeDeS dQeDeHg eyf dReDeS d eRfdSdT�Zze�{dU�Z|dOeRd eSfdVdW�Z} X dodMeWdNeVdOeCdeVeRf dYeydQeDeHg eyf dZeDeS d eDeR fd[d\�Z~dMeCeVeRf dNeVdOeRdYeydQeHg eyf d eDeR f d]d^�ZdOeRd eFeSeReReReRf fd_d`�Z�dMeWdNeVdOeRdYeydQeHg eyf d eDeR f dadb�Z�dOeCeVeRf d eDeS fdcdd�Z�dMeCeVeRf deeCeVeRf d eRfdfdg�Z�dMeCeVeRf dheRd eRfdidj�Z�dkeVd eafdldm�Z�dS )pa4 ``tornado.web`` provides a simple web framework with asynchronous
features that allow it to scale to large numbers of open connections,
making it ideal for `long polling
<http://en.wikipedia.org/wiki/Push_technology#Long_polling>`_.
Here is a simple "Hello, world" example app:
.. testcode::
import asyncio
import tornado
class MainHandler(tornado.web.RequestHandler):
def get(self):
self.write("Hello, world")
async def main():
application = tornado.web.Application([
(r"/", MainHandler),
])
application.listen(8888)
await asyncio.Event().wait()
if __name__ == "__main__":
asyncio.run(main())
See the :doc:`guide` for additional information.
Thread-safety notes
-------------------
In general, methods on `RequestHandler` and elsewhere in Tornado are
not thread-safe. In particular, methods such as
`~RequestHandler.write()`, `~RequestHandler.finish()`, and
`~RequestHandler.flush()` must only be called from the main thread. If
you use multiple threads it is important to use `.IOLoop.add_callback`
to transfer control back to the main thread before finishing the
request, or to limit your use of other threads to
`.IOLoop.run_in_executor` and ensure that your callbacks running in
the executor do not refer to Tornado objects.
� N)�isclass)�BytesIO)� urlencode)�Future�"future_set_result_unless_cancelled)�escape)�gen)�
HTTPServer)�httputil)�iostream)�locale)�
access_log�app_log�gen_log)�template)�utf8�_unicode)�
AnyMatches�DefaultHostMatches� HostMatches�ReversibleRouter�Rule�ReversibleRuleRouter�URLSpec� _RuleList)�
ObjectDict� unicode_type�_websocket_mask)�Dict�Any�Union�Optional� Awaitable�Tuple�List�Callable�Iterable� Generator�Type�TypeVar�cast�overload)�
TracebackType)�Set� � c @ s e Zd ZdS )�_ArgDefaultMarkerN)�__name__�
__module__� __qualname__� r4 r4 �?/opt/saltstack/salt/lib/python3.10/site-packages/tornado/web.pyr0 � s r0 c s� e Zd ZU dZdZeedf ed< i Ze �
� Z e �
d�ZdZdZdZdZdd d
ejd ed df� fd
d� Zd�dd�ZeZ ed eeef fdd��Zded ed dfdd�Z e Z e Z e Z e Z e Z!e Z"e Z#d e$e%d fdd�Z&d�dd�Z'd�dd�Z(d�d d �Z)d�d d �Z*d�d e+d!e$e d dfd"d#�Z,d e+fd$d%�Z-d&ed'e.d dfd(d)�Z/d&ed'e.d dfd*d+�Z0d&ed dfd,d-�Z1e �
d.�Z2d'e.d efd/d0�Z3e4d�d&ed2ed3e5d efd4d5��Z6e4e7d1fd&ed2e8d3e5d efd6d5��Z6e4 1d�d&ed2dd3e5d e$e fd7d5��Z6e7d1fd&ed2e9dee8f d3e5d e$e fd8d5�Z6d�d&ed3e5d e:e fd9d:�Z;e4d�d&ed2ed3e5d efd;d<��Z<e4e7d1fd&ed2e8d3e5d efd=d<��Z<e4 1d�d&ed2dd3e5d e$e fd>d<��Z<e7d1fd&ed2e9dee8f d3e5d e$e fd?d<�Z<d�d&ed3e5d e:e fd@dA�Z=e4d�d&ed2ed3e5d efdBdC��Z>e4e7d1fd&ed2e8d3e5d efdDdC��Z>e4 1d�d&ed2dd3e5d e$e fdEdC��Z>e7d1fd&ed2e9dee8f d3e5d e$e fdFdC�Z>d�d&ed3e5d e:e fdGdH�Z? 1d�d&ed2e9dee8f dIeee:e@ f d3e5d e$e f
dJdK�ZA 1d�d&edIeee:e@ f d3e5d e:e fdLdM�ZBd�d'e@d&e$e d efdNdO�ZCed eeeDjEjFf fdPdQ��ZEe4d&ed2ed efdRdS��ZGe4d�d&ed2dd e$e fdTdS��ZGd�d&ed2e$e d e$e fdUdS�ZG V d�dddddW�d&ed'e9ee@f dXe$e dYe$e9eHeeIjIf dZed[e$eH d\e$e+ d]e5d^e5d_e$e d ed dfd`da�ZJd&ed ed dfdbdc�ZKd ed dfddde�ZL f d�d&ed'e9ee@f d[e$eH dge$e+ d ed df dhdi�ZMeMZN d�d&ed'e9ee@f dge$e+ d e@fdjdk�ZO l d�d&ed'e$e dmeHdne$e+ d e$e@ f
dodp�ZPePZQ d�d&ed'e$e d e$e+ fdqdr�ZReRZS d�dsedte5due$e+ d dfdvdw�ZTdxe9ee@eUf d dfdydz�ZVd{ed ed d|fd}d~�ZWdeXe d efd�d��ZYd�eXe@ d e@fd�d��ZZd�eXe d efd�d��Z[d�eXe@ d e@fd�d��Z\d{ed ed e@fd�d��Z]d eeef fd�d��Z^d�ed e_j`fd�d��Zad�d�e5d d|fd�d��Zbd�dxe$e9ee@eUf d d|fd�d��Zcd edjefd�d��Zfd�d�d��Zgd�d e+d ed dfd�d��Zhd e+d ed dfd�d��Zied ejjkjlfd�d���Zkekjmd'ejjkjld dfd�d���Zkd e$ejjkjl fd�d��Znd�d2ed ejjkjlfd�d��Zoed efd�d���Zpepjmd'ed dfd�d���Zpd efd�d��Zqd efd�d��Zrd e$e fd�d��Zsed e@fd�d���Ztd ee$e+ e@eHf fd�d��Zud�ed ee$e+ e$e@ e$eH f fd�d��Zvd�d�d��Zwd efd�d��Zx d�dZed�e$e5 d ed efd�d��Zyd�d&ed�ed dfd�dZzd&eded efd�dĄZ{d e$e fd�dƄZ|d�d�dȄZ}d e5fd�dʄZ~d�e:d� de@d e@d dfd�d΄Zdxe@d e$e%d fd�dЄZ�d�d�d҄Z�d efd�dԄZ�d�e�d dfd�dׄZ�d�d�d'e$e� d�e$e� d dfd�d܄Z�d&ed�e�d� d e�def fd�d�Z�d�e�def d e�def fd�d�Z�d�d�d�Z�� Z�S )��RequestHandleraF Base class for HTTP request handlers.
Subclasses must define at least one of the methods defined in the
"Entry points" section below.
Applications should not construct `RequestHandler` objects
directly and subclasses should not override ``__init__`` (override
`~RequestHandler.initialize` instead).
)�GET�HEAD�POSTZDELETE�PATCH�PUT�OPTIONS.�SUPPORTED_METHODSz[\x00-\x08\x0e-\x1f]FN� application� Application�request�kwargs�returnc s� t � �� |� _|� _d� _d� _d� _d � _t� fdd�|j �
� D ��� _ t � |j
�� j d< � j d � j d< � �� � jjd usCJ �� jj�� j� � jdi |�� d S )NFTc 3 s" � | ] \}}|� � |�fV qd S �N)�
_ui_method)�.0�n�m��selfr4 r5 � <genexpr>� s �
�z*RequestHandler.__init__.<locals>.<genexpr>Z _tt_modules�modulesr4 )�super�__init__r> r@ �_headers_written� _finished� _auto_finish�_prepared_futurer �
ui_methods�items�ui�_UIModuleNamespace�
ui_modules�clear�
connection�set_close_callback�on_connection_close�
initialize)rI r> r@ rA �� __class__rH r5 rM � s$
��zRequestHandler.__init__c C � d S rC r4 rH r4 r4 r5 � _initialize� � zRequestHandler._initializec C � | j jS )z@An alias for `self.application.settings <Application.settings>`.)r> �settingsrH r4 r4 r5 rb s zRequestHandler.settings�argsc O s t d��)N� )� HTTPError�rI rc rA r4 r4 r5 �_unimplemented_method s z$RequestHandler._unimplemented_methodc C � dS )aX Called at the beginning of a request before `get`/`post`/etc.
Override this method to perform common initialization regardless
of the request method. There is no guarantee that ``prepare`` will
be called if an error occurs that is handled by the framework.
Asynchronous support: Use ``async def`` or decorate this method with
`.gen.coroutine` to make it asynchronous.
If this method returns an ``Awaitable`` execution will not proceed
until the ``Awaitable`` is done.
.. versionadded:: 3.1
Asynchronous support.
Nr4 rH r4 r4 r5 �prepare s zRequestHandler.preparec C rh )aI Called after the end of a request.
Override this method to perform cleanup, logging, etc. This method is primarily intended as
a counterpart to `prepare`. However, there are a few error cases where ``on_finish`` may be
called when ``prepare`` has not. (These are considered bugs and may be fixed in the future,
but for now you may need to check to see if the initialization work done in ``prepare`` has
occurred)
``on_finish`` may not produce any output, as it is called after the response has been sent
to the client.
Nr4 rH r4 r4 r5 � on_finish, s zRequestHandler.on_finishc C s@ t | j�r | jj�� s | jj�t�� � | jj�� dS dS dS )aF Called in async handlers if the client closed the connection.
Override this to clean up resources associated with
long-lived connections. Note that this method is called only if
the connection was closed during asynchronous processing; if you
need to do cleanup after every request override `on_finish`
instead.
Proxies may keep a connection open for a time (perhaps
indefinitely) after the client has gone away, so this method
may not be called promptly after the end user closes their
connection.
N) �_has_stream_request_bodyr] r@ � _body_future�doneZ
set_exceptionr �StreamClosedError� exceptionrH r4 r4 r5 rZ : s
�z"RequestHandler.on_connection_closec C sH t �dtj dt �t�� �d��| _| �� g | _d| _ t j
d | _ dS )z1Resets all headers and content for this response.zTornadoServer/%sztext/html; charset=UTF-8)ZServer� Content-TypeZDate�� N) r
� HTTPHeaders�tornado�version�format_timestamp�time�_headers�set_default_headers�
_write_buffer� _status_code� responses�_reasonrH r4 r4 r5 rW M s ��zRequestHandler.clearc C rh )aB Override this to set HTTP headers at the beginning of the request.
For example, this is the place to set a custom ``Server`` header.
Note that setting such headers in the normal flow of request
processing may not do what you want, since headers may be reset
during error handling.
Nr4 rH r4 r4 r5 rx [ � z"RequestHandler.set_default_headers� status_code�reasonc C sL || _ |dur d|v stjj�|�sd}t�|�| _dS tj� |d�| _dS )a6 Sets the status code for our response.
:arg int status_code: Response status code.
:arg str reason: Human-readable reason phrase describing the status
code (for example, the "Not Found" in ``HTTP/1.1 404 Not Found``).
Normally determined automatically from `http.client.responses`; this
argument should only be used if you need to use a non-standard
status code.
.. versionchanged:: 5.0
No longer validates that the response code is in
`http.client.responses`.
N�<�Unknown)
rz r
Z_ABNFZ
reason_phrase� fullmatchr �
native_strr| r{ �get)rI r~ r r4 r4 r5 �
set_statuse s zRequestHandler.set_statusc C s | j S )z)Returns the status code for our response.)rz rH r4 r4 r5 �
get_status� � zRequestHandler.get_status�name�valuec C s | � |�| j|< dS )z�Sets the given response header name and value.
All header values are converted to strings (`datetime` objects
are formatted according to the HTTP specification for the
``Date`` header).
N)�_convert_header_valuerw �rI r� r� r4 r4 r5 �
set_header� s zRequestHandler.set_headerc C s | j �|| �|�� dS )z�Adds the given response header and value.
Unlike `set_header`, `add_header` may be called multiple times
to return multiple values for the same header.
N)rw �addr� r� r4 r4 r5 �
add_header� s zRequestHandler.add_headerc C s || j v r | j |= dS dS )z�Clears an outgoing header, undoing a previous `set_header` call.
Note that this method does not apply to multi-valued headers
set by `add_header`.
N)rw )rI r� r4 r4 r5 � clear_header� s
�zRequestHandler.clear_headerz[\x09\x20-\x7e\x80-\xff]*c C sz t |t�r|}n&t |t�r|�d�}nt |tj�r t|�S t |tj�r(t�|�S t d| ��t
j � |�d u r;t
d|��|S )N�latin1zUnsupported header value %rzUnsafe header value %r)�
isinstance�str�bytes�decode�numbers�Integral�datetimer
ru � TypeErrorr6 �_VALID_HEADER_CHARSr� �
ValueError)rI r� �retvalr4 r4 r5 r� � s
z$RequestHandler._convert_header_valueT�default�stripc C r^ rC r4 �rI r� r� r� r4 r4 r5 � get_argument� � zRequestHandler.get_argumentc C r^ rC r4 r� r4 r4 r5 r� � � c C r^ rC r4 r� r4 r4 r5 r� � r� c C � | � ||| jj|�S )ar Returns the value of the argument with the given name.
If default is not provided, the argument is considered to be
required, and we raise a `MissingArgumentError` if it is missing.
If the argument appears in the request more than once, we return the
last value.
This method searches both the query and body arguments.
)�
_get_argumentr@ � argumentsr� r4 r4 r5 r� � s c C s t |t�sJ �| �|| jj|�S )z�Returns a list of the arguments with the given name.
If the argument is not present, returns an empty list.
This method searches both the query and body arguments.
)r� �bool�_get_argumentsr@ r� �rI r� r� r4 r4 r5 �
get_arguments� s z RequestHandler.get_argumentsc C r^ rC r4 r� r4 r4 r5 �get_body_argument� r� z RequestHandler.get_body_argumentc C r^ rC r4 r� r4 r4 r5 r� � r� c C r^ rC r4 r� r4 r4 r5 r� � r� c C r� )aj Returns the value of the argument with the given name
from the request body.
If default is not provided, the argument is considered to be
required, and we raise a `MissingArgumentError` if it is missing.
If the argument appears in the url more than once, we return the
last value.
.. versionadded:: 3.2
)r� r@ �body_argumentsr� r4 r4 r5 r� � � c C � | � || jj|�S )z�Returns a list of the body arguments with the given name.
If the argument is not present, returns an empty list.
.. versionadded:: 3.2
)r� r@ r� r� r4 r4 r5 �get_body_arguments � z!RequestHandler.get_body_argumentsc C r^ rC r4 r� r4 r4 r5 �get_query_argument r� z!RequestHandler.get_query_argumentc C r^ rC r4 r� r4 r4 r5 r� r� c C r^ rC r4 r� r4 r4 r5 r� # r� c C r� )ar Returns the value of the argument with the given name
from the request query string.
If default is not provided, the argument is considered to be
required, and we raise a `MissingArgumentError` if it is missing.
If the argument appears in the url more than once, we return the
last value.
.. versionadded:: 3.2
)r� r@ �query_argumentsr� r4 r4 r5 r� ) r� c C r� )z�Returns a list of the query arguments with the given name.
If the argument is not present, returns an empty list.
.. versionadded:: 3.2
)r� r@ r� r� r4 r4 r5 �get_query_arguments< r� z"RequestHandler.get_query_arguments�sourcec C s2 | j |||d�}|st|t�rt|��|S |d S )N)r� ���)r� r� r0 �MissingArgumentError)rI r� r� r� r� rc r4 r4 r5 r� E s
z RequestHandler._get_argumentc C sV g }|� |g �D ] }| j||d�}t|t�r tj�d|�}|r#|�� }|�|� q|S )N�r� � ) r� �decode_argumentr� r r6 �_remove_control_chars_regex�subr� �append)rI r� r� r� �values�v�sr4 r4 r5 r� S s
z RequestHandler._get_argumentsc C s8 zt |�W S ty tdd�|pd|dd� ���w )a Decodes an argument from the request.
The argument has been percent-decoded and is now a byte string.
By default, this method decodes the argument as utf-8 and returns
a unicode string, but this may be overridden in subclasses.
This method is used as a filter for both `get_argument()` and for
values extracted from the url and passed to `get()`/`post()`/etc.
The name of the argument is provided if known, but may be None
(e.g. for unnamed groups in the url regex).
� zInvalid unicode in {}: {!r}�urlN�( )r �UnicodeDecodeErrorre �format)rI r� r� r4 r4 r5 r� b s
��z RequestHandler.decode_argumentc C ra )zRAn alias for
`self.request.cookies <.httputil.HTTPServerRequest.cookies>`.)r@ �cookiesrH r4 r4 r5 r� v s zRequestHandler.cookiesc C r^ rC r4 �rI r� r� r4 r4 r5 �
get_cookie| r� zRequestHandler.get_cookiec C r^ rC r4 r� r4 r4 r5 r� � r� c C s* | j jdur|| j jv r| j j| jS |S )a- Returns the value of the request cookie with the given name.
If the named cookie is not present, returns ``default``.
This method only returns cookies that were present in the request.
It does not see the outgoing cookies set by `set_cookie` in this
handler.
N)r@ r� r� r� r4 r4 r5 r� � s �/)�max_age�httponly�secure�samesite�domain�expires�path� expires_daysr� r� r� r� c K s� t �|�}t �|�}t�d|�rtd|�d|����d|fd|fd|fd|
ffD ] \} }
|
durEt�d |
�rEtj�d
| � d |
�d |����q(t| d
�sQtj� � | _
|| j
v rZ| j
|= || j
|< | j
| }|rj||d< |dur~|s~t j � t j
j�t j|d� }|r�t�|�|d< |r�||d< |r�t|�|d< |r�d|d< | r�d|d< |
r�|
|d< | r�| �� D ]\}}|||< q�t�dt| �� �� d�t� dS dS )a} Sets an outgoing cookie name/value with the given options.
Newly-set cookies are not immediately visible via `get_cookie`;
they are not present until the next request.
Most arguments are passed directly to `http.cookies.Morsel` directly.
See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie
for more information.
``expires`` may be a numeric timestamp as returned by `time.time`,
a time tuple as returned by `time.gmtime`, or a
`datetime.datetime` object. ``expires_days`` is provided as a convenience
to set an expiration time in days from today (if both are set, ``expires``
is used).
.. deprecated:: 6.3
Keyword arguments are currently accepted case-insensitively.
In Tornado 7.0 this will be changed to only accept lowercase
arguments.
z [\x00-\x20]zInvalid cookie z: r� r� r� r� Nz[\x00-\x20\x3b\x7f]zInvalid cookie attribute �=z for cookie � _new_cookie��daysr� zmax-ageTr� r� z$Deprecated arguments to set_cookie: z (should be lowercase))r r� �re�searchr� �httpr� Z CookieError�hasattrZ SimpleCookier� r� �now�timezone�utc� timedeltar
ru r� rS �warnings�warn�set�keys�DeprecationWarning)rI r� r� r� r� r� r� r� r� r� r� rA Z attr_nameZ
attr_valueZmorsel�kr� r4 r4 r5 �
set_cookie� s^
%
���
�
�
��zRequestHandler.set_cookiec K sZ dD ]}||v rt d|� d���qtj�tjj�tjdd� }| j|fd|d�|�� dS ) a� Deletes the cookie with the given name.
This method accepts the same arguments as `set_cookie`, except for
``expires`` and ``max_age``. Clearing a cookie requires the same
``domain`` and ``path`` arguments as when it was set. In some cases the
``samesite`` and ``secure`` arguments are also required to match. Other
arguments are ignored.
Similar to `set_cookie`, the effect of this method will not be
seen until the following request.
.. versionchanged:: 6.3
Now accepts all keyword arguments that ``set_cookie`` does.
The ``samesite`` and ``secure`` flags have recently become
required for clearing ``samesite="none"`` cookies.
)r� r� z3clear_cookie() got an unexpected keyword argument '�'im r� � )r� r� N)r� r� r� r� r� r� r� )rI r� rA Z excluded_argr� r4 r4 r5 � clear_cookie� s
��� zRequestHandler.clear_cookiec K s$ | j jD ] }| j|fi |�� qdS )ac Attempt to delete all the cookies the user sent with this request.
See `clear_cookie` for more information on keyword arguments. Due to
limitations of the cookie protocol, it is impossible to determine on the
server side which values are necessary for the ``domain``, ``path``,
``samesite``, or ``secure`` arguments, this method can only be
successful if you consistently use the same values for these arguments
when setting cookies.
Similar to `set_cookie`, the effect of this method will not be seen
until the following request.
.. versionchanged:: 3.2
Added the ``path`` and ``domain`` parameters.
.. versionchanged:: 6.3
Now accepts all keyword arguments that ``set_cookie`` does.
.. deprecated:: 6.3
The increasingly complex rules governing cookies have made it
impossible for a ``clear_all_cookies`` method to work reliably
since all we know about cookies are their names. Applications
should generally use ``clear_cookie`` one at a time instead.
N)r@ r� r� )rI rA r� r4 r4 r5 �clear_all_cookies s �z RequestHandler.clear_all_cookies� rt c K s( | j || j|||d�fd|i|�� dS )a� Signs and timestamps a cookie so it cannot be forged.
You must specify the ``cookie_secret`` setting in your Application
to use this method. It should be a long, random sequence of bytes
to be used as the HMAC secret for the signature.
To read a cookie set with this method, use `get_signed_cookie()`.
Note that the ``expires_days`` parameter sets the lifetime of the
cookie in the browser, but is independent of the ``max_age_days``
parameter to `get_signed_cookie`.
A value of None limits the lifetime to the current browser session.
Secure cookies may contain arbitrary byte values, not just unicode
strings (unlike regular cookies)
Similar to `set_cookie`, the effect of this method will not be
seen until the following request.
.. versionchanged:: 3.2.1
Added the ``version`` argument. Introduced cookie version 2
and made it the default.
.. versionchanged:: 6.3
Renamed from ``set_secure_cookie`` to ``set_signed_cookie`` to
avoid confusion with other uses of "secure" in cookie attributes
and prefixes. The old name remains as an alias.
)rt r� N)r� �create_signed_value)rI r� r� r� rt rA r4 r4 r5 �set_signed_cookie4 s &��
�z RequestHandler.set_signed_cookiec C s^ | � dd� | jjd }d}t|t�r&| jj�d�du r td��| jjd }t|||||d�S )a� Signs and timestamps a string so it cannot be forged.
Normally used via set_signed_cookie, but provided as a separate
method for non-cookie uses. To decode a value not stored
as a cookie use the optional value argument to get_signed_cookie.
.. versionchanged:: 3.2.1
Added the ``version`` argument. Introduced cookie version 2
and made it the default.
�
cookie_secret�secure cookiesN� key_versionz5key_version setting must be used for secret_key dicts)rt r� )�require_settingr> rb r� �dictr� � Exceptionr� )rI r� r� rt �secretr� r4 r4 r5 r� c s
�z"RequestHandler.create_signed_value� � max_age_days� min_versionc C s8 | � dd� |du r| �|�}t| jjd ||||d�S )a Returns the given signed cookie if it validates, or None.
The decoded cookie value is returned as a byte string (unlike
`get_cookie`).
Similar to `get_cookie`, this method only returns cookies that
were present in the request. It does not see outgoing cookies set by
`set_signed_cookie` in this handler.
.. versionchanged:: 3.2.1
Added the ``min_version`` argument. Introduced cookie version 2;
both versions 1 and 2 are accepted by default.
.. versionchanged:: 6.3
Renamed from ``get_secure_cookie`` to ``get_signed_cookie`` to
avoid confusion with other uses of "secure" in cookie attributes
and prefixes. The old name remains as an alias.
r� r� N)r� r� )r� r� �decode_signed_valuer> rb )rI r� r� r� r� r4 r4 r5 �get_signed_cookie} s
�z RequestHandler.get_signed_cookiec C s2 | � dd� |du r| �|�}|du rdS t|�S )a~ Returns the signing key version of the secure cookie.
The version is returned as int.
.. versionchanged:: 6.3
Renamed from ``get_secure_cookie_key_version`` to
``set_signed_cookie_key_version`` to avoid confusion with other
uses of "secure" in cookie attributes and prefixes. The old name
remains as an alias.
r� r� N)r� r� �get_signature_key_versionr� r4 r4 r5 � get_signed_cookie_key_version� s
z,RequestHandler.get_signed_cookie_key_versionr� � permanent�statusc C sp | j rtd��|du r|rdnd}nt|t�r#d| kr"dks%J � J �| �|� | �dt|�� | �� dS )a: Sends a redirect to the given (optionally relative) URL.
If the ``status`` argument is specified, that value is used as the
HTTP status code; otherwise either 301 (permanent) or 302
(temporary) is chosen based on the ``permanent`` argument.
The default is 302 (temporary).
z/Cannot redirect after headers have been writtenNi- i. i, i� ZLocation)rN r� r� �intr� r� r �finish)rI r� r� r� r4 r4 r5 �redirect� s
&
zRequestHandler.redirect�chunkc C st | j rtd��t|tttf�s d}t|t�r|d7 }t|��t|t�r.t� |�}| �
dd� t |�}| j �
|� dS )a� Writes the given chunk to the output buffer.
To write the output to the network, use the `flush()` method below.
If the given chunk is a dictionary, we write it as JSON and set
the Content-Type of the response to be ``application/json``.
(if you want to send JSON as a different ``Content-Type``, call
``set_header`` *after* calling ``write()``).
Note that lists are not converted to JSON because of a potential
cross-site security vulnerability. All JSON output should be
wrapped in a dictionary. More details at
http://haacked.com/archive/2009/06/25/json-hijacking.aspx/ and
https://github.com/facebook/tornado/issues/1009
z Cannot write() after finish()z5write() only accepts bytes, unicode, and dict objectsz|. Lists not accepted for security reasons; see http://www.tornadoweb.org/en/stable/web.html#tornado.web.RequestHandler.writerp z application/json; charset=UTF-8N)rO � RuntimeErrorr� r� r r� �listr� r Z json_encoder� r ry r� )rI r� �messager4 r4 r5 �write� s
�
zRequestHandler.write�
template_namez Future[None]c K s~ | j rtd��| j|fi |��}g }g }g }g }g }g } t| di ��� D ]j}
|
�� } | r3|�t| �� |
�� } | rMt | t
t f�rH|�t | �� n|�
| � |
�� } | rZ|�t| �� |
�� } | rtt | t
t f�ro|�t | �� n|�
| � |
�� }
|
r�|�t|
�� |
�� }|r�| �t|�� q$|r�| �|�}|�d�}|d|� t|� d ||d� }|r�| �|�}|�d�}|d|� | d ||d� }|r�| �|�}|�d�}|d|� t|� d ||d� }|�r| �|�}|�d�}|d|� | d ||d� }|�r |�d�}|d|� d�|� d ||d� }| �r:|�d�}|d|� d�| � d ||d� }| �|�S )a� Renders the template with the given arguments as the response.
``render()`` calls ``finish()``, so no other output methods can be called
after it.
Returns a `.Future` with the same semantics as the one returned by `finish`.
Awaiting this `.Future` is optional.
.. versionchanged:: 5.1
Now returns a `.Future` instead of ``None``.
z Cannot render() after finish()�_active_moduless </body>N�
s </head>� )rO r� �
render_string�getattrr� �embedded_javascriptr� r �javascript_filesr� r r� r �extend� embedded_css� css_files� html_head� html_body�render_linked_js�rindex�render_embed_js�render_linked_css�index�render_embed_css�joinr� )rI r rA �html�js_embed�js_files� css_embedr Z
html_headsZ html_bodies�moduleZ
embed_partZ file_partZ head_partZ body_partZjsZslocZjs_bytes�cssZhlocZ css_bytesr4 r4 r5 �render� sp
�
$
$
&
&
zRequestHandler.renderr c C �V g }t � }|D ]}t|�s| �|�}||vr |�|� |�|� qd�dd� |D ��S )z�Default method used to render the final js links for the
rendered webpage.
Override this method in a sub-classed controller to change the output.
r� c s �" � | ] }d t �|� d V qdS )z
<script src="z"" type="text/javascript"></script>N�r � xhtml_escape�rE �pr4 r4 r5 rJ M s � ���
�z2RequestHandler.render_linked_js.<locals>.<genexpr>�r� � is_absolute�
static_urlr� r� r )rI r �paths� unique_pathsr� r4 r4 r5 r = s
�
�z RequestHandler.render_linked_jsr c C � dd� |� d S )z�Default method used to render the final embedded js for the
rendered webpage.
Override this method in a sub-classed controller to change the output.
s, <script type="text/javascript">
//<![CDATA[
r s
//]]>
</script>�r )rI r r4 r4 r5 r T s ���z RequestHandler.render_embed_jsr c C r )z�Default method used to render the final css links for the
rendered webpage.
Override this method in a sub-classed controller to change the output.
r� c s r )z <link href="z$" type="text/css" rel="stylesheet"/>Nr r r4 r4 r5 rJ p s
� �
�z3RequestHandler.render_linked_css.<locals>.<genexpr>r" )rI r r% r& r� r4 r4 r5 r ` s
�
�z RequestHandler.render_linked_cssr c C r' )z�Default method used to render the final embedded css for the
rendered webpage.
Override this method in a sub-classed controller to change the output.
s <style type="text/css">
r s
</style>r( )rI r r4 r4 r5 r v s z RequestHandler.render_embed_cssc K s� | � � }|s8t�d�}|jj}|jj|kr(|jdur(|j}|jj|kr(|jdus|jjdus0J �tj�|jj�}t j
� |t j vrL| � |�}|t j |< nt j | }W d � n1 s[w Y |�
|�}| �� }|�|� |jdi |��S )z�Generate the given template with the given arguments.
We return the generated byte string (in utf8). To generate and
write a template as a response, use render() above.
r Nr4 )�get_template_path�sys� _getframe�f_code� co_filename�f_back�osr� �dirnamer6 �_template_loader_lock�_template_loaders�create_template_loader�load�get_template_namespace�updateZgenerate) rI r rA �
template_path�frameZweb_file�loader�t� namespacer4 r4 r5 r ~ s(
�
� �
z RequestHandler.render_stringc C s> t | | j| j| j| jj| jj| j| j| jd� }|� | j
� |S )aB Returns a dictionary to be used as the default template namespace.
May be overridden by subclasses to add or modify values.
The results of this method will be combined with additional
defaults in the `tornado.template` module and keyword arguments
to `render` or `render_string`.
) �handlerr@ � current_userr �_�pgettextr$ �xsrf_form_html� reverse_url) r� r@ r= r � translater? r$ r@ rA r6 rT )rI r; r4 r4 r5 r5 � s � z%RequestHandler.get_template_namespacer7 c C sV | j j}d|v r |d S i }d|v r|d |d< d|v r"|d |d< tj|fi |��S )a] Returns a new template loader for the given path.
May be overridden by subclasses. By default returns a
directory-based loader on the given path, using the
``autoescape`` and ``template_whitespace`` application
settings. If a ``template_loader`` application setting is
supplied, uses that instead.
Ztemplate_loaderZ
autoescapeZtemplate_whitespace�
whitespace)r> rb r �Loader)rI r7 rb rA r4 r4 r5 r3 � s z%RequestHandler.create_template_loader�include_footersc C s | j jdusJ �d�| j�}g | _| jscd| _| jD ]}|dus"J �|�| j| j||�\| _| _}q| j j dkr:d}t
| d�rP| j � � D ] }| �
d|�d�� qDt�d| j| j�}| j j�|| j|�S | jD ]}|�||�}qf| j j dkr|| j j�|�S t� }|�d� |S )z�Flushes the current output buffer to the network.
.. versionchanged:: 4.0
Now returns a `.Future` if no callback is given.
.. versionchanged:: 6.0
The ``callback`` argument was removed.
Nr Tr8 r� z
Set-Cookier� )r@ rX r ry rN � _transforms�transform_first_chunkrz rw �methodr� r� r� r� Z OutputStringr
�ResponseStartLiner| Z
write_headers�transform_chunkr r �
set_result)rI rE r� Z transform�cookie�
start_line�futurer4 r4 r5 �flush� s<
��
�
zRequestHandler.flushc C s* | j rtd��|dur| �|� | jsi| jdkr3| jjdv r3d| jvr3| �� | � � r3g | _
| � d� | jdv sEd| j krCdk rTn n| j
rOJ d | j ��| � � nd
| jvrit
d d � | j
D ��}| �d
|� | jjdusqJ �| jj�d� | jd
d�}| jj�� | �� d
| _ | �� | �� |S )aD Finishes this response, ending the HTTP request.
Passing a ``chunk`` to ``finish()`` is equivalent to passing that
chunk to ``write()`` and then calling ``finish()`` with no arguments.
Returns a `.Future` which may optionally be awaited to track the sending
of the response to the client. This `.Future` resolves when all the response
data has been sent, and raises an error if the connection is closed before all
data can be sent.
.. versionchanged:: 5.1
Now returns a `.Future` instead of ``None``.
zfinish() called twiceNrq �r7 r8 �Etag�0 )�� rR �d zCannot send body with %s�Content-Lengthc s s � | ]}t |�V qd S rC )�len)rE �partr4 r4 r5 rJ s � z(RequestHandler.finish.<locals>.<genexpr>T)rE )rO r� r rN rz r@ rH rw �set_etag_header�check_etag_headerry r� � _clear_representation_headers�sumr� rX rY rO r� �_logrj �
_break_cycles)rI r� �content_lengthrN r4 r4 r5 r� � s:
$�
zRequestHandler.finishc C s d| _ | jj�� S )aN Take control of the underlying stream.
Returns the underlying `.IOStream` object and stops all
further HTTP processing. Intended for implementing protocols
like websockets that tunnel over an HTTP handshake.
This method is only supported when HTTP/1.1 is used.
.. versionadded:: 5.1
T)rO r@ rX �detachrH r4 r4 r5 r_ / s zRequestHandler.detachc C s
d | _ d S rC )rT rH r4 r4 r5 r] > �
z RequestHandler._break_cycles�� c K s� | j r&t�d� | js$z| �� W dS ty# tjddd� Y dS w dS | �� |�d�}d|v rD|d d }t|t �rD|j
rD|j
}| j ||d � z|d
krY| j |fi |�� W n tyj t
jd dd� Y nw | jst| �� dS dS ) a� Sends the given HTTP error code to the browser.
If `flush()` has already been called, it is not possible to send
an error, so this method will simply terminate the response.
If output has been written but not yet flushed, it will be discarded
and replaced with the error page.
Override `write_error()` to customize the error page that is returned.
Additional keyword arguments are passed through to `write_error`.
z0Cannot send error response after headers writtenz Failed to flush partial responseT��exc_infoNr rc r. )r rR z!Uncaught exception in write_error)rN r �errorrO r� r� rW r� r� re r r� � write_errorr )rI r~ rA r ro r4 r4 r5 �
send_errorC s8
��
� � �zRequestHandler.send_errorc K sj | j �d�r%d|v r%| �dd� tj|d � D ]}| �|� q| �� dS | �d|t�| j �d� � dS )a� Override to implement custom error pages.
``write_error`` may call `write`, `render`, `set_header`, etc
to produce output as usual.
If this error was caused by an uncaught exception (including
HTTPError), an ``exc_info`` triple will be available as
``kwargs["exc_info"]``. Note that this exception may not be
the "current" exception for purposes of methods like
``sys.exc_info()`` or ``traceback.format_exc``.
�serve_tracebackrc rp �
text/plainzS<html><title>%(code)d: %(message)s</title><body>%(code)d: %(message)s</body></html>)�coder� N)
rb r� r� � traceback�format_exceptionr r� r r r| )rI r~ rA �liner4 r4 r5 re j s ��zRequestHandler.write_errorc C s@ t | d�s | �� }|dur|| _| jS | �� | _| js J �| jS )a^ The locale for the current session.
Determined by either `get_user_locale`, which you can override to
set the locale based on, e.g., a user preference stored in a
database, or `get_browser_locale`, which uses the ``Accept-Language``
header.
.. versionchanged: 4.1
Added a property setter.
�_localeN)r� �get_user_localerm �get_browser_locale)rI �locr4 r4 r5 r � s
�
zRequestHandler.localec C �
|| _ d S rC )rm �rI r� r4 r4 r5 r � �
c C rh )a Override to determine the locale from the authenticated user.
If None is returned, we fall back to `get_browser_locale()`.
This method should return a `tornado.locale.Locale` object,
most likely obtained via a call like ``tornado.locale.get("en")``
Nr4 rH r4 r4 r5 rn � r} z RequestHandler.get_user_locale�en_USc
C s� d| j jv ru| j jd �d�}g }|D ]J}|�� �d�}t|�dkrN|d �� �d�rNzt|d �� dd� �}|dk r?t� �W n ttfyM d }Y nw d
}|dkr]|� |d |f� q|ru|j
d d � d
d� dd� |D �}t j |� S t � |�S )z�Determines the user's locale from ``Accept-Language`` header.
See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
zAccept-Language�,�;r. zq=r/ Nr g g �?c S s | d S )Nr. r4 )�pairr4 r4 r5 �<lambda>� � z3RequestHandler.get_browser_locale.<locals>.<lambda>T)�key�reversec S s g | ]}|d �qS )r r4 )rE rp r4 r4 r5 �
<listcomp>� s z5RequestHandler.get_browser_locale.<locals>.<listcomp>)
r@ �headers�splitr� rV �
startswith�floatr� r� r� �sortr r� )rI r� � languagesZlocales�language�partsZscoreZcodesr4 r4 r5 ro � s. ���
z!RequestHandler.get_browser_localec C s t | d�s
| �� | _| jS )a� The authenticated user for this request.
This is set in one of two ways:
* A subclass may override `get_current_user()`, which will be called
automatically the first time ``self.current_user`` is accessed.
`get_current_user()` will only be called once per request,
and is cached for future access::
def get_current_user(self):
user_cookie = self.get_signed_cookie("user")
if user_cookie:
return json.loads(user_cookie)
return None
* It may be set as a normal variable, typically from an overridden
`prepare()`::
@gen.coroutine
def prepare(self):
user_id_cookie = self.get_signed_cookie("user_id")
if user_id_cookie:
self.current_user = yield load_user(user_id_cookie)
Note that `prepare()` may be a coroutine while `get_current_user()`
may not, so the latter form is necessary if loading the user requires
asynchronous operations.
The user object may be any type of the application's choosing.
�
_current_user)r� �get_current_userr� rH r4 r4 r5 r= � s
zRequestHandler.current_userc C rq rC )r� rr r4 r4 r5 r= � rs c C rh )zrOverride to determine the current user from, e.g., a cookie.
This method may not be a coroutine.
Nr4 rH r4 r4 r5 r� � s z RequestHandler.get_current_userc C s | � dd� | jjd S )z�Override to customize the login URL based on the request.
By default, we use the ``login_url`` application setting.
Z login_urlz@tornado.web.authenticated)r� r> rb rH r4 r4 r5 �
get_login_url� s z RequestHandler.get_login_urlc C s | j j�d�S )z�Override to customize template path for each handler.
By default, we use the ``template_path`` application setting.
Return None to load templates relative to the calling file.
r7 )r> rb r� rH r4 r4 r5 r) � s z RequestHandler.get_template_pathc C s� t | d�sn| �� \}}}| j�dd�}| j�di �}|dkr%t�|�| _n(|dkrHt�d�}d� dt�|�t�t
||��t t t
|���g�| _ntd |��|d
u rn| jr\d |vr\d |d < | j�d
d�}| j|| jfi |�� | jS )a� The XSRF-prevention token for the current user/session.
To prevent cross-site request forgery, we set an '_xsrf' cookie
and include the same '_xsrf' value as an argument with all POST
requests. If the two do not match, we reject the form submission
as a potential forgery.
See http://en.wikipedia.org/wiki/Cross-site_request_forgery
This property is of type `bytes`, but it contains only ASCII
characters. If a character string is required, there is no
need to base64-encode it; just decode the byte string as
UTF-8.
.. versionchanged:: 3.2.2
The xsrf token will now be have a random mask applied in every
request, which makes it safe to include the token in pages
that are compressed. See http://breachattack.com for more
information on the issue fixed by this change. Old (version 1)
cookies will be converted to version 2 when this method is called
unless the ``xsrf_cookie_version`` `Application` setting is
set to 1.
.. versionchanged:: 4.3
The ``xsrf_cookie_kwargs`` `Application` setting may be
used to supply additional cookie options (which will be
passed directly to `set_cookie`). For example,
``xsrf_cookie_kwargs=dict(httponly=True, secure=True)``
will set the ``secure`` and ``httponly`` flags on the
``_xsrf`` cookie.
� _xsrf_tokenZxsrf_cookie_versionr/ Zxsrf_cookie_kwargsr. � � |� 2z unknown xsrf cookie version %dNr� r� �xsrf_cookie_name�_xsrf)r� �_get_raw_xsrf_tokenrb r� �binascii�b2a_hexr� r/ �urandomr r r r� r� r� r= r� )rI rt �token� timestampZoutput_versionZ
cookie_kwargs�mask� cookie_namer4 r4 r5 �
xsrf_token s,
!
��
zRequestHandler.xsrf_tokenc C s� t | d�sB| j�dd�}| �|�}|r | �|�\}}}nd\}}}|du r0d}t�d�}t�� }|dus6J �|dus<J �|||f| _| jS )a� Read or generate the xsrf token in its raw form.
The raw_xsrf_token is a tuple containing:
* version: the version of the cookie from which this token was read,
or None if we generated a new token in this request.
* token: the raw token data; random (non-ascii) bytes.
* timestamp: the time this token was generated (will not be accurate
for version 1 cookies)
�_raw_xsrf_tokenr� r� �NNNN� ) r� rb r� r� �_decode_xsrf_tokenr/ r� rv r� )rI r� rL rt r� r� r4 r4 r5 r� : s
z"RequestHandler._get_raw_xsrf_tokenrL c C s� zdt �t|��}|r=t|�d��}|dkr9|�d�\}}}}t�t|��}t|t�t|���} t|�}
|| |
fW S t d��d}z t�t|��} W n tj
t fyX t|�} Y nw tt � � �}
|| |
fW S t yu t
jddd� Y dS w ) z_Convert a cookie string into a the tuple form returned by
_get_raw_xsrf_token.
r. r/ �|zUnknown xsrf cookie versionz(Uncaught exception in _decode_xsrf_tokenTrb r� )�_signed_value_version_re�matchr r� �groupr~ r� �a2b_hexr r� �Errorr� rv r �debug) rI rL rG rt r> Zmask_strZ masked_tokenZ
timestamp_strr� r� r� r4 r4 r5 r� U s. � �z!RequestHandler._decode_xsrf_tokenc C s� | � dd�p| jj�d�p| jj�d�}|stdd��| �|�\}}}| �� \}}}|s1tdd��t�t |�t |��s@tdd��dS ) a� Verifies that the ``_xsrf`` cookie matches the ``_xsrf`` argument.
To prevent cross-site request forgery, we set an ``_xsrf``
cookie and include the same value as a non-cookie
field with all ``POST`` requests. If the two do not match, we
reject the form submission as a potential forgery.
The ``_xsrf`` value may be set as either a form field named ``_xsrf``
or in a custom HTTP header named ``X-XSRFToken`` or ``X-CSRFToken``
(the latter is accepted for compatibility with Django).
See http://en.wikipedia.org/wiki/Cross-site_request_forgery
.. versionchanged:: 3.2.2
Added support for cookie version 2. Both versions 1 and 2 are
supported.
r� Nz X-Xsrftokenz X-Csrftoken� z"'_xsrf' argument missing from POSTz#'_xsrf' argument has invalid formatz(XSRF cookie does not match POST argument)
r� r@ r} r� re r� r� �hmac�compare_digestr )rI Z input_tokenr> r� Zexpected_tokenr4 r4 r5 �check_xsrf_cookiey s � �
�z RequestHandler.check_xsrf_cookiec C s dt �| j� d S )a� An HTML ``<input/>`` element to be included with all POST forms.
It defines the ``_xsrf`` input value, which we check on all POST
requests to prevent cross-site request forgery. If you have set
the ``xsrf_cookies`` application setting, you must include this
HTML within all of your HTML forms.
In a template, this method should be called with ``{% module
xsrf_form_html() %}``
See `check_xsrf_cookie()` above for more information.
z)<input type="hidden" name="_xsrf" value="z"/>)r r r� rH r4 r4 r5 r@ � s
���z RequestHandler.xsrf_form_html� include_hostc K sf | � dd� | j�dt�j}|du rt| dd�}|r%| jjd | jj }nd}||| j|fi |�� S ) a� Returns a static URL for the given relative static file path.
This method requires you set the ``static_path`` setting in your
application (which specifies the root directory of your static
files).
This method returns a versioned url (by default appending
``?v=<signature>``), which allows the static files to be
cached indefinitely. This can be disabled by passing
``include_version=False`` (in the default implementation;
other static file implementations are not required to support
this, but they may support other options).
By default this method returns URLs relative to the current
host, but if ``include_host`` is true the URL returned will be
absolute. If this handler has an ``include_host`` attribute,
that value will be used as the default for all `static_url`
calls that do not pass ``include_host`` as a keyword argument.
� static_pathr$ �static_handler_classNr� Fz://r� ) r� rb r� �StaticFileHandler�make_static_urlr r@ �protocol�host)rI r� r� rA Zget_url�baser4 r4 r5 r$ � s �� zRequestHandler.static_url� this feature�featurec C s" | j j�|�std||f ��dS )z<Raises an exception if the given app setting is not defined.z>You must define the '%s' setting in your application to use %sN)r> rb r� r� )rI r� r� r4 r4 r5 r� � s ���z RequestHandler.require_settingc G s | j j|g|�R � S )z$Alias for `Application.reverse_url`.)r> rA )rI r� rc r4 r4 r5 rA � � zRequestHandler.reverse_urlc C s* t �� }| jD ]}|�|� qd|�� S )a Computes the etag header to be used for this request.
By default uses a hash of the content written so far.
May be overridden to provide custom etag implementations,
or may return None to disable tornado's default etag support.
z"%s")�hashlib�sha1ry r6 � hexdigest)rI �hasherrW r4 r4 r5 � compute_etag� s
zRequestHandler.compute_etagc C s$ | � � }|dur| �d|� dS dS )z�Sets the response's Etag header using ``self.compute_etag()``.
Note: no header will be set if ``compute_etag()`` returns ``None``.
This method is called automatically when the request is finished.
NrQ )r� r� )rI �etagr4 r4 r5 rX � s �z RequestHandler.set_etag_headerc C s� t | j�dd��}t�dt | jj�dd���}|r|s dS d}|d dkr)d}|S d td
tfd d �}|D ]}||�||�krCd} |S q4|S )
a� Checks the ``Etag`` header against requests's ``If-None-Match``.
Returns ``True`` if the request's Etag matches and a 304 should be
returned. For example::
self.set_etag_header()
if self.check_etag_header():
self.set_status(304)
return
This method is called automatically when the request is finished,
but may be called earlier for applications that override
`compute_etag` and want to do an early check for ``If-None-Match``
before completing the request. The ``Etag`` header should be set
(perhaps with `set_etag_header`) before calling this method.
rQ r� s \*|(?:W/)?"[^"]*"�
If-None-MatchFr � *T�xrB c S s | � d�r | dd � S | S )Ns W/r/ �r )r� r4 r4 r5 �val s z-RequestHandler.check_etag_header.<locals>.val)r rw r� r� �findallr@ r} r� )rI Z
computed_etagZetagsr� r� r� r4 r4 r5 rY � s$ �
��z RequestHandler.check_etag_header�
transforms�OutputTransformc � s( �|� _ z�� jj� jvrtd��t� j�s2z� j�� W n tj y1 } ztdd| �|�d}~ww � fdd�|D �� _
� fdd�|� � D �� _ � jjd vrY� j
j�d
�rY� �� � �� }|durf|I dH }� jdurqt� jd� � jrwW dS t� j�r�z � jjI dH W n tjy� Y W dS w t� � jj�� �}|� j
i � j ��}|dur�|I dH }� jr�� js�� �� W dS W dS W dS t �y } zGz z� � |� W n t y� t j d d d
� Y nw W d}nd}w � jdu�r� j� � �s� j�!d� W Y d}~dS W Y d}~dS W Y d}~dS d}~ww )z7Executes this request with the given output transforms.rd r� zInvalid body: %sNc s g | ]}� � |��qS r4 �r� )rE �argrH r4 r5 r| 4 � z+RequestHandler._execute.<locals>.<listcomp>c s i | ] \}}|� j ||d ��qS )r� r� )rE r� r� rH r4 r5 �
<dictcomp>5 s �z+RequestHandler._execute.<locals>.<dictcomp>)r7 r8 r< Z xsrf_cookiesz Exception in exception handlerTrb )"rF r@ rH r= re rk r] Z _parse_bodyr
ZHTTPInputError� path_argsrS � path_kwargsr> rb r� r� ri rQ r rO rl r rn r �lowerrP r� r� �_handle_request_exceptionr rd rm rK )rI r� rc rA �e�resultrH r4 rH r5 �_execute$ sj �
��
� �
�
� �� ���zRequestHandler._executec C � t � �)z�Implement this method to handle streamed request data.
Requires the `.stream_request_body` decorator.
May be a coroutine for flow control.
��NotImplementedError)rI r� r4 r4 r5 �
data_receivedi s z RequestHandler.data_receivedc C s | j �| � dS )z�Logs the current request.
Sort of deprecated since this functionality was moved to the
Application, but left in place for the benefit of existing apps
that have overridden this method.
N)r> � log_requestrH r4 r4 r5 r\ r s zRequestHandler._logc C s d� | jj| jj| jj�S )Nz
{} {} ({}))r� r@ rH �uriZ remote_iprH r4 r4 r5 �_request_summary{ s
�z RequestHandler._request_summaryr� c C s� t |t�r| js| j|j� d S z | jt�� � W n ty) t j
ddd� Y nw | jr/d S t |t �r@| j |j
t�� d� d S | j dt�� d� d S )NzError in exception loggerTrb ra )r� �FinishrO r� rc �
log_exceptionr* rc r� r rd re rf r~ )rI r� r4 r4 r5 r� � s
�
z(RequestHandler._handle_request_exception�typz Optional[Type[BaseException]]�tbc C sf t |t�r"|�� }|r d}|j| �� |g}tj|g|�R � dS dS tjd| �� | j |||fd� dS )aK Override to customize logging of uncaught exceptions.
By default logs instances of `HTTPError` as warnings without
stack traces (on the ``tornado.general`` logger), and all
other exceptions as errors with stack traces (on the
``tornado.application`` logger).
.. versionadded:: 3.1
z %d %s: %szUncaught exception %s
%rrb N)
r� re � get_messager~ r� r �warningr rd r@ )rI r� r� r� � log_messager� rc r4 r4 r5 r� � s
�
�z RequestHandler.log_exceptionr �UIModulec s dt f� ��fdd� }|S )NrB c sF t �d�si �_��jvr� ���j�< �j� j| i |��}t|�S )Nr )r� r r r )rc rA Zrendered�r r� rI r4 r5 r � s
z)RequestHandler._ui_module.<locals>.render)r� )rI r� r r r4 r� r5 �
_ui_module� s zRequestHandler._ui_modulerH c s � �fdd�S )Nc s � �g| �R i |��S rC r4 )rc rA �rH rI r4 r5 rx � r� z+RequestHandler._ui_method.<locals>.<lambda>r4 )rI rH r4 r� r5 rD � � zRequestHandler._ui_methodc C s g d�}|D ]}| � |� qd S )N)�Content-EncodingzContent-Languagerp )r� )rI r} �hr4 r4 r5 rZ � s �z,RequestHandler._clear_representation_headers�rB NrC �T)NNr� N)r� N)Nr� N)FN)F)ra )rt )r� )�r1 r2 r3 �__doc__r= r# r� �__annotations__r2 � threading�Lockr1 r� �compiler� �_stream_request_bodyrF r� r� r
�HTTPServerRequestr rM r_ r[ �propertyr rb rg �headr� Zpost�deleteZpatch�put�optionsr! r" ri rj rZ rW rx r� r� r� � _HeaderTypesr� r� r� r� r� r+ r� r� � _ARG_DEFAULTr0 r r$ r� r� r� r� r� r� r� r� r� r� r� ZMorselr� r� r� r� r� r� r� Zset_secure_cookier� r� Zget_secure_cookier� Z get_secure_cookie_key_versionr� r� r r r& r r r r r r5 r Z
BaseLoaderr3 rO r� r ZIOStreamr_ r] rf re rs r ZLocale�setterrn ro r= r� r� r) r� r� r� r� r@ r$ r� rA r� rX rY r� r� r\ r� �
BaseExceptionr� r, r� r( r% r� rD rZ �
__classcell__r4 r4 r\ r5 r6 � s�
����
���� ����� ��� ��
� ���� ����� ��� ��
� ���� ����� ��� ��
� �� ���
�����
� �
��
�����
� � �
��
�h #��
����
�-��
��
� �����
�'���
�����
� K "29
'
# 9�
�
$&����
�&
(���
�E
���
�" " r6 �_RequestHandlerType)�bound�clsrB c C s t | t�s
td| ��d| _| S )a Apply to `RequestHandler` subclasses to enable streaming body support.
This decorator implies the following changes:
* `.HTTPServerRequest.body` is undefined, and body arguments will not
be included in `RequestHandler.get_argument`.
* `RequestHandler.prepare` is called when the request headers have been
read instead of after the entire body has been read.
* The subclass must define a method ``data_received(self, data):``, which
will be called zero or more times as data is available. Note that
if the request has an empty body, ``data_received`` may not be called.
* ``prepare`` and ``data_received`` may return Futures (such as via
``@gen.coroutine``, in which case the next method will not be called
until those futures have completed.
* The regular HTTP method (``post``, ``put``, etc) will be called after
the entire body has been read.
See the `file receiver demo <https://github.com/tornadoweb/tornado/tree/stable/demos/file_upload/>`_
for example usage.
�+expected subclass of RequestHandler, got %rT��
issubclassr6 r� r� �r� r4 r4 r5 �stream_request_body� s
r� c C s t | t�s
td| ��| jS )Nr� r� r� r4 r4 r5 rk � s
rk rH .c �, t �� �dtdttd f� fdd� �}|S )a# Use this decorator to remove trailing slashes from the request path.
For example, a request to ``/foo/`` would redirect to ``/foo`` with this
decorator. Your request handler mapping should use a regular expression
like ``r'/foo/*'`` in conjunction with using the decorator.
rI rB Nc sv | j j�d�r0| j jdv r,| j j�d�}|r+| j jr"|d| j j 7 }| j|dd� d S ntd��� | g|�R i |��S �Nr� rP �?T�r� � )r@ r� �endswithrH �rstrip�queryr� re �rI rc rA r� �rH r4 r5 �wrapper� s �z removeslash.<locals>.wrapper�� functools�wrapsr6 r! r" �rH r r4 r r5 � removeslash� s
�
�r c r� )a& Use this decorator to add a missing trailing slash to the request path.
For example, a request to ``/foo`` would redirect to ``/foo/`` with this
decorator. Your request handler mapping should use a regular expression
like ``r'/foo/?'`` in conjunction with using the decorator.
rI rB Nc sn | j j�d�s,| j jdv r(| j jd }| j jr |d| j j 7 }| j|dd� d S td��� | g|�R i |��S r� )r@ r� r� rH r r� re r r r4 r5 r s zaddslash.<locals>.wrapperr r r4 r r5 �addslash s
�
�
r
c sr e Zd ZdZ ddddee ddf� fdd�
Zd edef� fd
d � Zd e d
e
j de dee
j f� fdd� Z
� ZS )�_ApplicationRoutera� Routing implementation used internally by `Application`.
Provides a binding between `Application` and `RequestHandler`.
This implementation extends `~.routing.ReversibleRuleRouter` in a couple of ways:
* it allows to use `RequestHandler` subclasses as `~.routing.Rule` target and
* it allows to use a list/tuple of rules as `~.routing.Rule` target.
``process_rule`` implementation will substitute this list with an appropriate
`_ApplicationRouter` instance.
Nr> r? �rulesrB c s$ t |t�sJ �|| _t� �|� d S rC )r� r? r> rL rM )rI r> r r\ r4 r5 rM 5 s z_ApplicationRouter.__init__�rulec s0 t � �|�}t|jttf�rt| j|j�|_|S rC )rL � process_ruler� �targetr� �tupler r> )rI r
r\ r4 r5 r < s �z _ApplicationRouter.process_ruler r@ �
target_paramsc s> t |�rt|t�r| jj||fi |��S t� j||fi |��S rC )r r� r6 r> �get_handler_delegaterL �get_target_delegate)rI r r@ r r\ r4 r5 r F s ��z&_ApplicationRouter.get_target_delegaterC )r1 r2 r3 r� r! r rM r r r r
r� �HTTPMessageDelegater r� r4 r4 r\ r5 r * s( ����
����r c @ s� e Zd ZdZ d6dee dee deeed de ddf
d d
�Z
d7e j e
jjdd d �d
edee de jdedee dede defdd�Zdededdfdd�Zded ddfdd �Zd e ddfd d �Zd e ddfd!d"�Zd#ejdeed fd$d%�Z d#ejde dd&fd'd(�Z d6d#ejd)ee d*ee ee f d+eee d,ee ee f dd&f d-d.�Z!d/ed0e defd1d2�Z"d3e ddfd4d5�Z#dS )8r? a�
A collection of request handlers that make up a web application.
Instances of this class are callable and can be passed directly to
HTTPServer to serve the application::
application = web.Application([
(r"/", MainPageHandler),
])
http_server = httpserver.HTTPServer(application)
http_server.listen(8080)
The constructor for this class takes in a list of `~.routing.Rule`
objects or tuples of values corresponding to the arguments of
`~.routing.Rule` constructor: ``(matcher, target, [target_kwargs], [name])``,
the values in square brackets being optional. The default matcher is
`~.routing.PathMatches`, so ``(regexp, target)`` tuples can also be used
instead of ``(PathMatches(regexp), target)``.
A common routing target is a `RequestHandler` subclass, but you can also
use lists of rules as a target, which create a nested routing configuration::
application = web.Application([
(HostMatches("example.com"), [
(r"/", MainPageHandler),
(r"/feed", FeedHandler),
]),
])
In addition to this you can use nested `~.routing.Router` instances,
`~.httputil.HTTPMessageDelegate` subclasses and callables as routing targets
(see `~.routing` module docs for more information).
When we receive requests, we iterate over the list in order and
instantiate an instance of the first request class whose regexp
matches the request path. The request class can be specified as
either a class object or a (fully-qualified) name.
A dictionary may be passed as the third element (``target_kwargs``)
of the tuple, which will be used as keyword arguments to the handler's
constructor and `~RequestHandler.initialize` method. This pattern
is used for the `StaticFileHandler` in this example (note that a
`StaticFileHandler` can be installed automatically with the
static_path setting described below)::
application = web.Application([
(r"/static/(.*)", web.StaticFileHandler, {"path": "/var/www"}),
])
We support virtual hosts with the `add_handlers` method, which takes in
a host regular expression as the first argument::
application.add_handlers(r"www\.myhost\.com", [
(r"/article/([0-9]+)", ArticleHandler),
])
If there's no match for the current request's host, then ``default_host``
parameter value is matched against host regular expressions.
.. warning::
Applications that do not use TLS may be vulnerable to :ref:`DNS
rebinding <dnsrebinding>` attacks. This attack is especially
relevant to applications that only listen on ``127.0.0.1`` or
other private networks. Appropriate host patterns must be used
(instead of the default of ``r'.*'``) to prevent this risk. The
``default_host`` argument must not be used in applications that
may be vulnerable to DNS rebinding.
You can serve static files by sending the ``static_path`` setting
as a keyword argument. We will serve those files from the
``/static/`` URI (this is configurable with the
``static_url_prefix`` setting), and we will serve ``/favicon.ico``
and ``/robots.txt`` from the same directory. A custom subclass of
`StaticFileHandler` can be specified with the
``static_handler_class`` setting.
.. versionchanged:: 4.5
Integration with the new `tornado.routing` module.
N�handlers� default_hostr� r� rb rB c K s� |d u rg | _ |�d�s|�d�r| j �t� n|| _ || _|| _tttd�| _ i | _
| � |�di �� | � |�di �� | j�d�rz| jd }t
|pLg �}|�dd�}|�d t�}|�d
i �}||d < t�|�d d
dfD ] } |�d| ||f� qn| j�d�r�| j�dd� | j�dd� | j�dd� | j�dd� t| |�| _t| tt� | j�g�| _| j�d�r�ddlm}
|
�� d S d S )NZcompress_response�gzip)�linkifyr@ �TemplaterV rR r� �static_url_prefix�/static/r� �static_handler_argsr� z(.*)z/(favicon\.ico)z/(robots\.txt)r r� �
autoreloadT�compiled_template_cacheF�static_hash_cacherg )r )r� r� r� �GZipContentEncodingr rb �_linkify�_xsrf_form_html�TemplateModulerV rR �_load_ui_modules�_load_ui_methodsr� r� r� r �insert�
setdefaultr �wildcard_routerr r �default_routerrs r �start) rI r r r� rb r� r r� r �patternr r4 r4 r5 rM � sT ��
� � � �zApplication.__init__F)�family�backlog�flags�
reuse_port�port�addressr, r- r. r/ rA c K s* t | fi |��}|j||||||d� |S )a� Starts an HTTP server for this application on the given port.
This is a convenience alias for creating an `.HTTPServer` object and
calling its listen method. Keyword arguments not supported by
`HTTPServer.listen <.TCPServer.listen>` are passed to the `.HTTPServer`
constructor. For advanced uses (e.g. multi-process mode), do not use
this method; create an `.HTTPServer` and call its
`.TCPServer.bind`/`.TCPServer.start` methods directly.
Note that after calling this method you still need to call
``IOLoop.current().start()`` (or run within ``asyncio.run``) to start
the server.
Returns the `.HTTPServer` object.
.. versionchanged:: 4.3
Now returns the `.HTTPServer` object.
.. versionchanged:: 6.2
Added support for new keyword arguments in `.TCPServer.listen`,
including ``reuse_port``.
)r1 r, r- r. r/ )r �listen) rI r0 r1 r, r- r. r/ rA Zserverr4 r4 r5 r2 � s !�zApplication.listen� host_pattern�
host_handlersc C sT t |�}t|t| |��}| jj�d|� | jdur(| j�t | |j
�|fg� dS dS )z�Appends the given handlers to our handler list.
Host patterns are processed sequentially in the order they were
added. All matching patterns will be considered.
r� N) r r r r) r r& r r( Z add_rulesr r3 )rI r3 r4 Z host_matcherr
r4 r4 r5 � add_handlers s
��zApplication.add_handlers�transform_classc C s | j �|� d S rC )r� r� )rI r6 r4 r4 r5 �
add_transform � zApplication.add_transform�methodsc s� t � tj�r| �� fdd�t� �D �� d S t � t�r'� D ]}| �|� q d S � �� D ] \}}|�d�sHt|d�rH|d � � |d krH|| j
|< q+d S )Nc � i | ]}|t � |��qS r4 �r �rE rF �r9 r4 r5 r� � z0Application._load_ui_methods.<locals>.<dictcomp>r> �__call__r ) r� �types�
ModuleTyper% �dirr� rS r r� r� rR )rI r9 rG r� �fnr4 r= r5 r% s
���
��z Application._load_ui_methodsrK c s� t � tj�r| �� fdd�t� �D �� d S t � t�r'� D ]}| �|� q d S t � t�s.J �� �� D ]\}}z t|t �rA|| j
|< W q2 t yK Y q2w d S )Nc r: r4 r; r< �rK r4 r5 r� , r> z0Application._load_ui_modules.<locals>.<dictcomp>) r� r@ rA r$ rB r� r� rS r� r� rV r� )rI rK rG r� r� r4 rD r5 r$ * s
�
� ��z Application._load_ui_modulesr@ c C s | � |�}|�� S rC )� find_handler�execute)rI r@ �
dispatcherr4 r4 r5 r? 9 s
zApplication.__call__�_HandlerDelegatec K sZ | j �|�}|d urtd|�S | j�d�r$| �|| jd | j�di ��S | �|tddi�S )NrH Zdefault_handler_classZdefault_handler_argsr~ r� )r) rE r* rb r� r � ErrorHandler)rI r@ rA Zrouter4 r4 r5 rE @ s
�zApplication.find_handler� target_class�
target_kwargsr� r� c C s t | |||||�S )ae Returns `~.httputil.HTTPMessageDelegate` that can serve a request
for application and `RequestHandler` subclass.
:arg httputil.HTTPServerRequest request: current HTTP request.
:arg RequestHandler target_class: a `RequestHandler` class.
:arg dict target_kwargs: keyword arguments for ``target_class`` constructor.
:arg list path_args: positional arguments for ``target_class`` HTTP method that
will be executed while handling a request (``get``, ``post`` or any other).
:arg dict path_kwargs: keyword arguments for ``target_class`` HTTP method.
)rH )rI r@ rJ rK r� r� r4 r4 r5 r P s �z Application.get_handler_delegater� rc c G s, | j j|g|�R � }|dur|S td| ��)a3 Returns a URL path for handler named ``name``
The handler must be added to the application as a named `URLSpec`.
Args will be substituted for capturing groups in the `URLSpec` regex.
They will be converted to strings if necessary, encoded as utf8,
and url-escaped.
Nz%s not found in named urls)r) rA �KeyError)rI r� rc Z reversed_urlr4 r4 r5 rA f s zApplication.reverse_urlr< c C sr d| j v r| j d |� dS |�� dk rtj}n
|�� dk r"tj}ntj}d|j�� }|d|�� |�� |� dS )a! Writes a completed HTTP request to the logs.
By default writes to the python root logger. To change
this behavior either subclass Application and override this method,
or pass a function in the application settings dictionary as
``log_function``.
Z log_functionNr� ra g @�@z %d %s %.2fms) rb r� r
�infor� rd r@ � request_timer� )rI r< Z
log_methodrN r4 r4 r5 r� u s
�zApplication.log_requestr� rC )$r1 r2 r3 r� r! r r� r$ r( r rM �socket� AF_UNSPECrs ZnetutilZ_DEFAULT_BACKLOGr� �
AddressFamilyr� r r2 r5 r7 r% r$ r
r� r" r? rE r6 r r� r rA r� r4 r4 r4 r5 r? Q s� T�����
�;�������� �
�,�
���
�����
��
�r? c @ s� e Zd Zdedejdee dee e
e f dee e
dee e
e
f ddfd d
�Zd eejejf d ejdeed fd
d�Zde
deed fdd�Zddd�Zddd�Zdeed fdd�ZdS )rH r> r@ �
handler_class�handler_kwargsr� r� rB Nc C sN || _ |j| _|| _|| _|pi | _|pg | _|pi | _g | _t| j�| _ d S rC )
r> rX r@ rR rS r� r� �chunksrk r� )rI r> r@ rR rS r� r� r4 r4 r5 rM � s
z_HandlerDelegate.__init__rM r} c C s | j r t� | j_| �� S d S rC )r� r r@ rl rF )rI rM r} r4 r4 r5 �headers_received� s
z!_HandlerDelegate.headers_received�datac C s" | j r | j�|�S | j�|� d S rC )r� r< r� rT r� )rI rV r4 r4 r5 r� � s z _HandlerDelegate.data_receivedc C s4 | j r t| jjd � d S d�| j�| j_| �� d S )Nr )r� r r@ rl r rT �bodyrF rH r4 r4 r5 r� � s z_HandlerDelegate.finishc C s | j r
| j�� d S d | _d S rC )r� r< rZ rT rH r4 r4 r5 rZ � s
z$_HandlerDelegate.on_connection_closec s� � j j�dd�s'tj� tj�� D ]}|�� qW d � n1 s"w Y � j j�dd�s;� j j�dt�}|�� � j � j � j
fi � j ��� _ � fdd�� j j
D �}� jr\t� � j _t�� j j|g� j�R i � j���}|�dd� � � j jS ) Nr Tr r� c s g | ]}|� j ��qS r4 )r@ )rE r: rH r4 r5 r| � r� z,_HandlerDelegate.execute.<locals>.<listcomp>c S s | � � S rC )r� )�fr4 r4 r5 rx � ry z*_HandlerDelegate.execute.<locals>.<lambda>)r> rb r� r6 r1 r2 r� �resetr� rR r@ rS r< r� r� r rQ r Zconvert_yieldedr� r� r� Zadd_done_callback)rI r9 r� r� Zfutr4 rH r5 rF � s0
� ����
�z_HandlerDelegate.executer� )r1 r2 r3 r? r
r� r( r6 r! r r� r r$ r� rM r ZRequestStartLinerI rr r" rU r� r� rZ rF r4 r4 r4 r5 rH � s6 ����
��
���
�
rH c @ sn e Zd ZdZ ddedee dededdf
d d
�Ze dee fd d ��Z
dee fd
d�Z defdd�Z dS )re av An exception that will turn into an HTTP error response.
Raising an `HTTPError` is a convenient alternative to calling
`RequestHandler.send_error` since it automatically ends the
current function.
To customize the response sent with an `HTTPError`, override
`RequestHandler.write_error`.
:arg int status_code: HTTP status code. Must be listed in
`httplib.responses <http.client.responses>` unless the ``reason``
keyword argument is given.
:arg str log_message: Message to be written to the log for this error
(will not be shown to the user unless the `Application` is in debug
mode). May contain ``%s``-style placeholders, which will be filled
in with remaining positional parameters.
:arg str reason: Keyword-only argument. The HTTP "reason" phrase
to pass in the status line along with ``status_code`` (for example,
the "Not Found" in ``HTTP/1.1 404 Not Found``). Normally
determined automatically from ``status_code``, but can be used
to use a non-standard numeric code. This is not a general-purpose
error message.
ra Nr~ r� rc rA rB c O s$ || _ || _|| _|�dd �| _d S )Nr )r~ � _log_messagerc r� r )rI r~ r� rc rA r4 r4 r5 rM
s zHTTPError.__init__c C s | j r
| js
| j �dd�S | j S )zF
A backwards compatible way of accessing log_message.
�%z%%)rZ rc �replacerH r4 r4 r5 r�
s zHTTPError.log_messagec C s | j r | jr | j | j S | j S rC )rZ rc rH r4 r4 r5 r�
s zHTTPError.get_messagec C s@ d| j | jp
tj�| j d�f }| �� }|r |d | d S |S )Nz HTTP %d: %sr� z (�))r~ r r
r{ r� r� )rI r� r� r4 r4 r5 �__str__
s �zHTTPError.__str__)ra N)
r1 r2 r3 r� r� r! r� r rM r� r� r� r^ r4 r4 r4 r5 re � s& �����
� re c @ s e Zd ZdZdS )r� a� An exception that ends the request without producing an error response.
When `Finish` is raised in a `RequestHandler`, the request will
end (calling `RequestHandler.finish` if it hasn't already been
called), but the error-handling methods (including
`RequestHandler.write_error`) will not be called.
If `Finish()` was created with no arguments, the pending response
will be sent as-is. If `Finish()` was given an argument, that
argument will be passed to `RequestHandler.finish()`.
This can be a more convenient way to implement custom error pages
than overriding ``write_error`` (especially in library code)::
if self.current_user is None:
self.set_status(401)
self.set_header('WWW-Authenticate', 'Basic realm="something"')
raise Finish()
.. versionchanged:: 4.3
Arguments passed to ``Finish()`` will be passed on to
`RequestHandler.finish`.
N)r1 r2 r3 r� r4 r4 r4 r5 r� (
s r� c s* e Zd ZdZdeddf� fdd� Z� ZS )r� z�Exception raised by `RequestHandler.get_argument`.
This is a subclass of `HTTPError`, so if it is uncaught a 400 response
code will be used instead of 500 (and a stack trace will not be logged).
.. versionadded:: 3.1
�arg_namerB Nc s t � �dd| � || _d S )Nr� zMissing argument %s)rL rM r_ )rI r_ r\ r4 r5 rM M
s
z MissingArgumentError.__init__)r1 r2 r3 r� r� rM r� r4 r4 r\ r5 r� D
s r� c @ s6 e Zd ZdZdeddfdd�Zd dd�Zd d d
�ZdS ) rI zBGenerates an error response with ``status_code`` for all requests.r~ rB Nc C s | � |� d S rC )r� )rI r~ r4 r4 r5 r[ U
r� zErrorHandler.initializec C s
t | j��rC )re rz rH r4 r4 r5 ri X
�
zErrorHandler.preparec C r^ rC r4 rH r4 r4 r5 r� [
r� z ErrorHandler.check_xsrf_cookier� )r1 r2 r3 r� r� r[ ri r� r4 r4 r4 r5 rI R
s
rI c @ s> e Zd ZdZd
dededdfdd�Zd ed
eddfd d �ZdS )�RedirectHandlera_ Redirects the client to the given URL for all GET requests.
You should provide the keyword argument ``url`` to the handler, e.g.::
application = web.Application([
(r"/oldpath", web.RedirectHandler, {"url": "/newpath"}),
])
`RedirectHandler` supports regular expression substitutions. E.g., to
swap the first and second parts of a path while preserving the remainder::
application = web.Application([
(r"/(.*?)/(.*?)/(.*)", web.RedirectHandler, {"url": "/{1}/{0}/{2}"}),
])
The final URL is formatted with `str.format` and the substrings that match
the capturing groups. In the above example, a request to "/a/b/c" would be
formatted like::
str.format("/{1}/{0}/{2}", "a", "b", "c") # -> "/b/a/c"
Use Python's :ref:`format string syntax <formatstrings>` to customize how
values are substituted.
.. versionchanged:: 4.5
Added support for substitutions into the destination URL.
.. versionchanged:: 5.0
If any query arguments are present, they will be copied to the
destination URL.
Tr� r� rB Nc C � || _ || _d S rC )�_url�
_permanent)rI r� r� r4 r4 r5 r[ �
�
zRedirectHandler.initializerc rA c O sH | j j|i |��}| jjrt�|tt�| jj���}| j|| j d� d S )Nr� )
rc r� r@ r� r
Z
url_concatr� Z qs_to_qslr� rd )rI rc rA Zto_urlr4 r4 r5 r� �
s �zRedirectHandler.getr� ) r1 r2 r3 r� r� r� r[ r r� r4 r4 r4 r5 ra b
s ra c
@ s e Zd ZdZdZi Ze�� Zd>de de
e ddfdd�Z e d?d d
��Z
de ded fd d �Zd@de deddfdd�Zde
e fdd�Zd?dd�Zdefdd�Ze de de de fdd��Zde de de
e fdd �Ze dAd e d e
e d e
e deeddf fd d!��Ze d e de fd"d#��Zde j fd$d%�Z defd&d'�Z de
e j fd(d)�Z!de fd*d+�Z"de ddfd,d-�Z#de d.e
e j d/e defd0d1�Z$e
d@d2e%e e&f de d3ede fd4d5��Z'd6e de fd7d8�Z(e d2e%e e&f de de
e fd9d:��Z)e d;e de
e fd<d=��Z*dS )Br� aM A simple handler that can serve static content from a directory.
A `StaticFileHandler` is configured automatically if you pass the
``static_path`` keyword argument to `Application`. This handler
can be customized with the ``static_url_prefix``, ``static_handler_class``,
and ``static_handler_args`` settings.
To map an additional path to this handler for a static data directory
you would add a line to your application like::
application = web.Application([
(r"/content/(.*)", web.StaticFileHandler, {"path": "/var/www"}),
])
The handler constructor requires a ``path`` argument, which specifies the
local root directory of the content to be served.
Note that a capture group in the regex is required to parse the value for
the ``path`` argument to the get() method (different than the constructor
argument above); see `URLSpec` for details.
To serve a file like ``index.html`` automatically when a directory is
requested, set ``static_handler_args=dict(default_filename="index.html")``
in your application settings, or add ``default_filename`` as an initializer
argument for your ``StaticFileHandler``.
To maximize the effectiveness of browser caching, this class supports
versioned urls (by default using the argument ``?v=``). If a version
is given, we instruct the browser to cache this file indefinitely.
`make_static_url` (also available as `RequestHandler.static_url`) can
be used to construct a versioned url.
This handler is intended primarily for use in development and light-duty
file serving; for heavy traffic it will be more efficient to use
a dedicated static file server (such as nginx or Apache). We support
the HTTP ``Accept-Ranges`` mechanism to return partial content (because
some browsers require this functionality to be present to seek in
HTML5 audio or video).
**Subclassing notes**
This class is designed to be extensible by subclassing, but because
of the way static urls are generated with class methods rather than
instance methods, the inheritance patterns are somewhat unusual.
Be sure to use the ``@classmethod`` decorator when overriding a
class method. Instance methods may use the attributes ``self.path``
``self.absolute_path``, and ``self.modified``.
Subclasses should only override methods discussed in this section;
overriding other methods is error-prone. Overriding
``StaticFileHandler.get`` is particularly problematic due to the
tight coupling with ``compute_etag`` and other methods.
To change the way static urls are generated (e.g. to match the behavior
of another server or CDN), override `make_static_url`, `parse_url_path`,
`get_cache_time`, and/or `get_version`.
To replace all interaction with the filesystem (e.g. to serve
static content from a database), override `get_content`,
`get_content_size`, `get_modified_time`, `get_absolute_path`, and
`validate_absolute_path`.
.. versionchanged:: 3.1
Many of the methods for subclasses were added in Tornado 3.1.
i �Nr� �default_filenamerB c C rb rC )�rootrf )rI r� rf r4 r4 r5 r[ �
re z StaticFileHandler.initializec C s2 | j � i | _W d � d S 1 sw Y d S rC )�_lock�_static_hashesr� r4 r4 r5 rY �
s "�zStaticFileHandler.resetc C s | j |dd�S )NF)� include_body)r� �rI r� r4 r4 r5 r� �
r� zStaticFileHandler.headTrj c � s. �| � |�| _~| �| j| j�}| �| j|�| _| jd u r d S | �� | _| �� | � � r3| �
d� d S d }| j j �
d�}|rCt�|�}| �� }|r�|\}}|d ur_|dk r_||7 }|dk r_d}|d uro||kss|d uro||kss|dkr�| �
d� | �dd� | �dd|� �� d S |d ur�||kr�|}||p�||p�d kr�| �
d � | �dt�|||�� nd }}|d ur�|d ur�|| } n|d ur�|} n |d ur�|| } n|} | �d
| � |�r | �| j||�}
t|
t�r�|
g}
|
D ] } z| �| � | �� I d H W q� tj�y Y d S w d S | j jd k�sJ �d S ) NrR ZRanger i� rp rh z
Content-Rangezbytes */�� rU r8 )�parse_url_pathr� �get_absolute_pathrg �validate_absolute_path�
absolute_path�get_modified_time�modified� set_headers�should_return_304r� r@ r} r� r
Z_parse_request_range�get_content_sizer� Z_get_content_range� get_contentr� r� r rO r rn rH ) rI r� rj rp Z
request_rangeZ range_header�sizer* �endr^ �contentr� r4 r4 r5 r� �
sx �
��
��zStaticFileHandler.getc C s. | j dusJ �| �| j �}|sdS d|� d�S )a Sets the ``Etag`` header based on static url version.
This allows efficient ``If-None-Match`` checks against cached
versions, and sends the correct ``Etag`` for a partial response
(i.e. the same ``Etag`` as the full file).
.. versionadded:: 3.1
N�")rp �_get_cached_version)rI � version_hashr4 r4 r5 r� 9 s
z StaticFileHandler.compute_etagc C s� | � dd� | �� | jdur| � d| j� | �� }|r"| � d|� | �| j| j|�}|dkrK| � dtj�tjj �tj
|d� � | � d d
t |� � | � | j� dS ) z]Sets the content and caching headers on the response.
.. versionadded:: 3.1
z
Accept-Rangesr� Nz
Last-Modifiedrp r ZExpires)�secondsz
Cache-Controlzmax-age=)
r� rX rr �get_content_type�get_cache_timer� r� r� r� r� r� r� �set_extra_headers)rI � content_typeZ
cache_timer4 r4 r5 rs H s"
��z StaticFileHandler.set_headersc C s� | j j�d�r | �� S | j j�d�}|durDztj�|�}W n
ty( Y dS w |jdu r6|j t
j j d�}| j
dus=J �|| j
krDdS dS )zgReturns True if the headers indicate that we should return 304.
.. versionadded:: 3.1
r� zIf-Modified-SinceNF)�tzinfoT)r@ r} r� rY �email�utils�parsedate_to_datetimer� r� r\ r� r� r� rr )rI Z ims_valueZif_sincer4 r4 r5 rt b s �
z#StaticFileHandler.should_return_304rg c C s t j�t j�||��}|S )a� Returns the absolute location of ``path`` relative to ``root``.
``root`` is the path configured for this `StaticFileHandler`
(in most cases the ``static_path`` `Application` setting).
This class method may be overridden in subclasses. By default
it returns a filesystem path, but other strings may be used
as long as they are unique and understood by the subclass's
overridden `get_content`.
.. versionadded:: 3.1
)r/ r� �abspathr )r� rg r� r� r4 r4 r5 rn { s z#StaticFileHandler.get_absolute_pathrp c C s� t j�|�}|�t jj�s|t jj7 }|t jj �|�s#tdd| j��t j�|�rV| jdurV| j j�d�sN| j j�d�rAtdd��| j
| j jd dd� dS t j� || j�}t j� |�s`td ��t j�
|�smtdd
| j��|S ) a� Validate and return the absolute path.
``root`` is the configured path for the `StaticFileHandler`,
and ``path`` is the result of `get_absolute_path`
This is an instance method called during request processing,
so it may raise `HTTPError` or use methods like
`RequestHandler.redirect` (return None after redirecting to
halt further processing). This is where 404 errors for missing files
are generated.
This method may modify the path before returning it, but note that
any such modifications will not be understood by `make_static_url`.
In instance methods, this method's result is available as
``self.absolute_path``.
.. versionadded:: 3.1
r� z"%s is not in root static directoryNr� z//z-cannot redirect path with two initial slashesTr� r� z%s is not a file)r/ r� r� r� �sepr re �isdirrf r@ r� r �exists�isfile)rI rg rp r4 r4 r5 ro � s& � z(StaticFileHandler.validate_absolute_pathr� r* rx c c s� � t |d��M}|dur|�|� |dur||pd }nd} d}|dur*||k r*|}|�|�}|r?|dur;|t|�8 }|V n|durI|dksIJ � W d � dS q 1 sVw Y dS )aZ Retrieve the content of the requested resource which is located
at the given absolute path.
This class method may be overridden by subclasses. Note that its
signature is different from other overridable class methods
(no ``settings`` argument); this is deliberate to ensure that
``abspath`` is able to stand on its own as a cache key.
This method should either return a byte string or an iterator
of byte strings. The latter is preferred for large files
as it helps reduce memory fragmentation.
.. versionadded:: 3.1
�rbNr Ti )�open�seek�readrV )r� r� r* rx �file� remainingZ
chunk_sizer� r4 r4 r5 rv � s, �
��z StaticFileHandler.get_contentc C sJ | � |�}t�� }t|t�r|�|� |�� S |D ]}|�|� q|�� S )z�Returns a version string for the resource at the given path.
This class method may be overridden by subclasses. The
default implementation is a SHA-512 hash of the file's contents.
.. versionadded:: 3.1
)rv r� �sha512r� r� r6 r� )r� r� rV r� r� r4 r4 r5 �get_content_version� s
� z%StaticFileHandler.get_content_versionc C s, | j d usJ �t| d�st�| j �| _| jS )N� _stat_result)rp r� r/ �statr� rH r4 r4 r5 �_stat s
zStaticFileHandler._statc C s | � � }|jS )a% Retrieve the total size of the resource at the given path.
This method may be overridden by subclasses.
.. versionadded:: 3.1
.. versionchanged:: 4.0
This method is now always called, instead of only when
partial results are requested.
)r� �st_size)rI � stat_resultr4 r4 r5 ru s z"StaticFileHandler.get_content_sizec C s$ | � � }tj�t|j�tjj�}|S )a� Returns the time that ``self.absolute_path`` was last modified.
May be overridden in subclasses. Should return a `~datetime.datetime`
object or None.
.. versionadded:: 3.1
.. versionchanged:: 6.4
Now returns an aware datetime object instead of a naive one.
Subclasses that override this method may return either kind.
)r� r� �
fromtimestampr� �st_mtimer� r� )rI r� rr r4 r4 r5 rq s
�z#StaticFileHandler.get_modified_timec C sF | j dusJ �t�| j �\}}|dkrdS |durdS |dur!|S dS )zhReturns the ``Content-Type`` header to be used for this request.
.. versionadded:: 3.1
Nr zapplication/gzipzapplication/octet-stream)rp � mimetypesZ
guess_type)rI � mime_type�encodingr4 r4 r5 r~ . s z"StaticFileHandler.get_content_typec C rh )z1For subclass to add extra headers to the responseNr4 rk r4 r4 r5 r� C r� z#StaticFileHandler.set_extra_headersrr r� c C s d| j jv r | jS dS )a� Override to customize cache control behavior.
Return a positive number of seconds to make the result
cacheable for that amount of time or 0 to mark resource as
cacheable for an unspecified amount of time (subject to
browser heuristics).
By default returns cache expiry of 10 years for resources requested
with ``v`` argument.
r� r )r@ r� �
CACHE_MAX_AGE)rI r� rr r� r4 r4 r5 r G s
z StaticFileHandler.get_cache_timerb �include_versionc C s: |� dd�| }|s |S | �||�}|s|S |� d|� �S )a Constructs a versioned url for the given path.
This method may be overridden in subclasses (but note that it
is a class method rather than an instance method). Subclasses
are only required to implement the signature
``make_static_url(cls, settings, path)``; other keyword
arguments may be passed through `~RequestHandler.static_url`
but are not standard.
``settings`` is the `Application.settings` dictionary. ``path``
is the static path being requested. The url returned should be
relative to the current host.
``include_version`` determines whether the generated URL should
include the query string containing the version hash of the
file corresponding to the given ``path``.
r r z?v=)r� � get_version)r� rb r� r� r� r| r4 r4 r5 r� V s z!StaticFileHandler.make_static_url�url_pathc C s t jjdkr|�dt jj�}|S )a" Converts a static URL path into a filesystem path.
``url_path`` is the path component of the URL with
``static_url_prefix`` removed. The return value should be
filesystem path relative to ``static_path``.
This is the inverse of `make_static_url`.
r� )r/ r� r� r\ )rI r� r4 r4 r5 rm v s z StaticFileHandler.parse_url_pathc C s | � |d |�}| �|�S )a% Generate the version string to be used in static URLs.
``settings`` is the `Application.settings` dictionary and ``path``
is the relative location of the requested asset on the filesystem.
The returned value should be a string, or ``None`` if no version
could be determined.
.. versionchanged:: 3.1
This method was previously recommended for subclasses to override;
`get_content_version` is now preferred as it allows the base
class to handle caching of the result.
r� )rn r{ )r� rb r� �abs_pathr4 r4 r5 r� � s
z StaticFileHandler.get_versionr� c C s� | j �= | j}||vr(z | �|�||< W n ty' t�d|� d ||< Y nw |�|�}|r8|W d � S W d � d S 1 sCw Y d S )Nz Could not open static file %r)rh ri r� r� r rd r� )r� r� ZhashesZhshr4 r4 r5 r{ � s$ �
�
� � z%StaticFileHandler._get_cached_versionrC r� r� )NN)+r1 r2 r3 r� r� ri r� r� rh r� r! r[ � classmethodrY r" r� r� r� r� rs rt rn ro r� r' r� rv r� r/ r� r� ru r� rq r~ r� r r r r� rm r� r{ r4 r4 r4 r5 r� �
sv B S
;���� �&���
��
��� �
$ r� c @ s8 e Zd ZdZdeejgdf ddfdd�Zd dd�ZdS )
�FallbackHandleraN A `RequestHandler` that wraps another HTTP server callback.
The fallback is a callable object that accepts an
`~.httputil.HTTPServerRequest`, such as an `Application` or
`tornado.wsgi.WSGIContainer`. This is most useful to use both
Tornado ``RequestHandlers`` and WSGI in the same server. Typical
usage::
wsgi_app = tornado.wsgi.WSGIContainer(
django.core.handlers.wsgi.WSGIHandler())
application = tornado.web.Application([
(r"/foo", FooHandler),
(r".*", FallbackHandler, dict(fallback=wsgi_app)),
])
�fallbackNrB c C rq rC )r� )rI r� r4 r4 r5 r[ � r` zFallbackHandler.initializec C s | � | j� d| _| �� d S )NT)r� r@ rO rj rH r4 r4 r5 ri � s zFallbackHandler.preparer� ) r1 r2 r3 r� r% r
r� r[ ri r4 r4 r4 r5 r� � s �
�r� c
@ sf e Zd ZdZdejddfdd�Zdedejd e d
e
de eeje f f
d d �Z d e d
e
de fd
d�Z
dS )r� z�A transform modifies the result of an HTTP request (e.g., GZip encoding)
Applications are not expected to create their own OutputTransforms
or interact with them directly; the framework chooses which transforms
(if any) to apply.
r@ rB Nc C r^ rC r4 �rI r@ r4 r4 r5 rM � r` zOutputTransform.__init__r~ r} r� � finishingc C s
|||fS rC r4 )rI r~ r} r� r� r4 r4 r5 rG � s
z%OutputTransform.transform_first_chunkc C s |S rC r4 �rI r� r� r4 r4 r5 rJ � r` z OutputTransform.transform_chunk)r1 r2 r3 r� r
r� rM r� rr r� r� r# rG rJ r4 r4 r4 r5 r� � s ����
� r� c
@ s� e Zd ZdZh d�ZdZdZdejddfdd �Z d
e
de fd d �Z d
e
dejdede dee
ejef f
dd�Zdede defdd�ZdS )r aI Applies the gzip content encoding to the response.
See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
.. versionchanged:: 4.0
Now compresses all mime types beginning with ``text/``, instead
of just a whitelist. (the whitelist is still used for certain
non-text mime types).
> zapplication/jsonzapplication/xhtml+xmlz
image/svg+xmlzapplication/xmlzapplication/atom+xmlzapplication/javascriptzapplication/x-javascript� i r@ rB Nc C s d|j �dd�v | _d S )Nr �Accept-Encodingr� )r} r� � _gzippingr� r4 r4 r5 rM � � z GZipContentEncoding.__init__�ctypec C s |� d�p || jv S )Nztext/)r �
CONTENT_TYPES)rI r� r4 r4 r5 �_compressible_type� � z&GZipContentEncoding._compressible_typer~ r} r� r� c C s� d|v r
|d d7 < nd|d< | j r5t|�dd���d�d }| �|�o3| p/t|�| jko3d|v| _ | j rcd |d< t� | _t j
d
| j| j d �| _ | �
||�}d |v rc|r`tt|��|d < n|d = |||fS )
NZVaryz, Accept-Encodingr� rp r� rv r r� r �w)�mode�fileobj�
compresslevelrU )r� r r� r~ r� rV �
MIN_LENGTHr � _gzip_valuer �GzipFile�
GZIP_LEVEL�
_gzip_filerJ r� )rI r~ r} r� r� r� r4 r4 r5 rG � s,
��
�
z)GZipContentEncoding.transform_first_chunkc C sR | j r'| j�|� |r| j�� n| j�� | j�� }| j�d� | j�d� |S )Nr ) r� r� r �closerO r� �getvalue�truncater� r� r4 r4 r5 rJ $
s
z#GZipContentEncoding.transform_chunk)r1 r2 r3 r� r� r� r� r
r� rM r� r� r� r� rr r� r# rG rJ r4 r4 r4 r5 r � s& ����
�%r c r� )a� Decorate methods with this to require that the user be logged in.
If the user is not logged in, they will be redirected to the configured
`login url <RequestHandler.get_login_url>`.
If you configure a login url with a query parameter, Tornado will
assume you know what you're doing and use it as-is. If not, it
will add a `next` parameter so the login page knows where to send
you once you're logged in.
rI rB Nc s� | j s@| jjdv r<| �� }d|vr5tj�|�jr | j�� }n | jj d us&J �| jj }|dt
t |d�� 7 }| � |� d S t
d��� | g|�R i |��S )NrP r� )�nextr� )r= r@ rH r� �urllib�parse�urlsplit�schemeZfull_urlr� r r� r� re )rI rc rA r� Znext_urlr r4 r5 r ?
s
z authenticated.<locals>.wrapperr r r4 r r5 �
authenticated1
s �
�r� c @ s� e Zd ZdZdeddfdd�Zedefdd��Zd ed
ede e
e f fd d �Z de
e
fd
d�Zde
ee
fdd�Zde
e
fdd�Zde
ee
fdd�Zde
e
fdd�Zde
e
fdd�Zde
d
ede fdd�ZdS ) r� a2 A re-usable, modular UI unit on a page.
UI modules often execute additional queries, and they can include
additional CSS and JavaScript that will be included in the output
page, which is automatically inserted on page render.
Subclasses of UIModule must override the `render` method.
r< rB Nc C s" || _ |j| _|j| _|j| _d S rC )r< r@ rT r �rI r< r4 r4 r5 rM `
s zUIModule.__init__c C ra rC )r< r= rH r4 r4 r5 r= f
s zUIModule.current_userrc rA c O r� )z6Override in subclasses to return this module's output.r� rf r4 r4 r5 r j
r� zUIModule.renderc C rh )zJOverride to return a JavaScript string
to be embedded in the page.Nr4 rH r4 r4 r5 r n
� z UIModule.embedded_javascriptc C rh )z�Override to return a list of JavaScript files needed by this module.
If the return values are relative paths, they will be passed to
`RequestHandler.static_url`; otherwise they will be used as-is.
Nr4 rH r4 r4 r5 r s
� zUIModule.javascript_filesc C rh )zJOverride to return a CSS string
that will be embedded in the page.Nr4 rH r4 r4 r5 r
{
r� zUIModule.embedded_cssc C rh )z�Override to returns a list of CSS files required by this module.
If the return values are relative paths, they will be passed to
`RequestHandler.static_url`; otherwise they will be used as-is.
Nr4 rH r4 r4 r5 r �
r� zUIModule.css_filesc C rh )z[Override to return an HTML string that will be put in the <head/>
element.
Nr4 rH r4 r4 r5 r �
r� zUIModule.html_headc C rh )zfOverride to return an HTML string that will be put at the end of
the <body/> element.
Nr4 rH r4 r4 r5 r
�
r� zUIModule.html_bodyr� c K s | j j|fi |��S )z.Renders a template and returns it as a string.)r< r )rI r� rA r4 r4 r5 r �
r� zUIModule.render_string)r1 r2 r3 r� r6 rM r� r r= r r� r� r r! r r& r r
r r r
r r4 r4 r4 r5 r� V
s r� c @ s" e Zd Zdededefdd�ZdS )r! �textrA rB c K s t j|fi |��S rC )r r )rI r� rA r4 r4 r5 r �
s z_linkify.renderN)r1 r2 r3 r� r r r4 r4 r4 r5 r! �
s r! c @ s e Zd Zdefdd�ZdS )r" rB c C s
| j �� S rC )r< r@ rH r4 r4 r5 r �
r` z_xsrf_form_html.renderN)r1 r2 r3 r� r r4 r4 r4 r5 r" �
s r" c s� e Zd ZdZdeddf� fdd� Zdededefd d
�Z d ede
e fd d
�Z defdd�Z de
e fdd�Z
defdd�Zde
e fdd�Zdefdd�Zdefdd�Z� ZS )r# a� UIModule that simply renders the given template.
{% module Template("foo.html") %} is similar to {% include "foo.html" %},
but the module version gets its own namespace (with kwargs passed to
Template()) instead of inheriting the outer template's namespace.
Templates rendered through this module also get access to UIModule's
automatic JavaScript/CSS features. Simply call set_resources
inside the template and give it keyword arguments corresponding to
the methods on UIModule: {{ set_resources(js_files=static_url("my.js")) }}
Note that these resources are output once per template file, not once
per instantiation of the template, so they must not depend on
any arguments to the template.
r< rB Nc s t � �|� g | _i | _d S rC )rL rM �_resource_list�_resource_dictr� r\ r4 r5 rM �
s
zTemplateModule.__init__r� rA c s* dt f� �fdd� }�j� fd|i|��S )NrB c s> � �j vr�j�| � | �j � < dS �j � | kr td��dS )NzCset_resources called with different resources for the same templater� )r� r� r� r� )rA �r� rI r4 r5 �
set_resources�
s
��z,TemplateModule.render.<locals>.set_resourcesr� )r� r )rI r� rA r� r4 r� r5 r �
s zTemplateModule.renderrz c s � fdd�| j D �S )Nc 3 s � | ] }� |v r|� V qd S rC r4 )rE �r�rz r4 r5 rJ �
s � z0TemplateModule._get_resources.<locals>.<genexpr>)r� �rI rz r4 r� r5 �_get_resources�
r� z TemplateModule._get_resourcesc C � d� | �d��S )N�
r �r r� rH r4 r4 r5 r �
r8 z"TemplateModule.embedded_javascriptc C �< g }| � d�D ]}t|ttf�r|�|� q|�|� q|S )Nr �r� r� r r� r� r �rI r� rX r4 r4 r5 r �
� z TemplateModule.javascript_filesc C r� )Nr� r
r� rH r4 r4 r5 r
�
r8 zTemplateModule.embedded_cssc C r� )Nr r� r� r4 r4 r5 r �
r� zTemplateModule.css_filesc C r� )Nr� r r� rH r4 r4 r5 r �
r8 zTemplateModule.html_headc C r� )Nr� r
r� rH r4 r4 r5 r
�
r8 zTemplateModule.html_body)r1 r2 r3 r� r6 rM r� r r� r r& r� r r r
r r r
r� r4 r4 r\ r5 r# �
s r# c @ sf e Zd ZdZdedeeee f ddfdd�Z dede
d ef fd
d �Z dede
d ef fd d
�Z dS )rU zALazy namespace which creates UIModule proxies bound to a handler.r< rV rB Nc C rb rC )r< rV )rI r< rV r4 r4 r5 rM �
s
z_UIModuleNamespace.__init__rz .c C s | j �|| j| �S rC )r< r� rV r� r4 r4 r5 � __getitem__�
r� z _UIModuleNamespace.__getitem__c
C s0 z| | W S t y } ztt|���d }~ww rC )rL �AttributeErrorr� )rI rz r� r4 r4 r5 � __getattr__�
s
��z _UIModuleNamespace.__getattr__)
r1 r2 r3 r� r6 r r� r( r� rM r% r� r� r4 r4 r4 r5 rU �
s ��
� rU r� r� r� rt �clockr� c
C s |d u rt }|d u r
tj}ttt|� ���}t�t|��}|dkr9t| t�r(J �t | |||�}d�
|||g�}|S |dkr�dt tt f dt fdd�}d�
d|t|pRd ��||�||�||�d
g�} t| t�rz|d usnJ d ��|dksvJ d ��| | } t
| | �}| | S td
| ��)Nr. r� r/ r� rB c S s t dt| � �t | � S )Nz%d:)r rV )r� r4 r4 r5 � format_field r� z)create_signed_value.<locals>.format_fieldr� r r z2Key version must be set when sign key dict is usedz2Version must be at least 2 for key version supportzUnsupported version %d)� DEFAULT_SIGNED_VALUE_VERSIONrv r r� r� �base64� b64encoder� r� �_create_signature_v1r r r� �_create_signature_v2r� )
r� r� r� rt r� r� r� � signaturer� Zto_signr4 r4 r5 r� �
s> ��
�
r� s ^([1-9][0-9]*)\|(.*)$c C sZ t �| �}|d u r
d}|S zt|�d��}|dkr d}W |S W |S ty, d}Y |S w )Nr. i� )r� r� r� r� r� )r� rG rt r4 r4 r5 � _get_version@ s
��
��r� r� r� r� c C s� |d u rt j }|d u r
t}|dkrtd| ��|sd S t|�}t|�}||k r)d S |dkr<t| t�r4J �t| ||||�S |dkrHt| ||||�S d S )Nr/ zUnsupported min_version %dr. ) rv � DEFAULT_SIGNED_VALUE_MIN_VERSIONr� r r� r� r� �_decode_signed_value_v1�_decode_signed_value_v2)r� r� r� r� r� r� rt r4 r4 r5 r� W s$ r� c C s� t |��d�}t|�dkrd S t| ||d |d �}t�|d |�s*t�d|� d S t|d �}||� |d k rAt�d|� d S ||� d krPt�d
|� d S |d � d �r_t�d |� d S zt
� |d �W S t yq Y d S w )
Nr� � r r. r/ zInvalid cookie signature %r�Q zExpired cookie %ri��( z1Cookie timestamp in future; possible tampering %r� 0zTampered cookie %r)
r r~ rV r� r� r� r r� r� r r� � b64decoder� )r� r� r� r� r� r� r� r� r4 r4 r5 r� v s, �r� c C sh dt dtt t f fdd�}| dd � }||�\}}||�\}}||�\}}||�\}}t|�||||fS )Nr� rB c S sX | � d�\}}}t|�}|d |� }|||d � dkr td��||d d � }||fS )N� :r. r� z malformed v2 signed value field)� partitionr� r� )r� �lengthr> �restrF Z field_valuer4 r4 r5 �_consume_field� s z)_decode_fields_v2.<locals>._consume_fieldr/ )r� r# r� )r� r� r� r� r� �
name_field� value_field�
passed_sigr4 r4 r5 �_decode_fields_v2� s r� c
C s� z t |�\}}}}} W n
ty Y d S w |d t| � � }
t| t�r5z| | } W n
ty4 Y d S w t| |
�} t�| | �sBd S |t |�krJd S t
|�} | |� |d k rYd S zt � |�W S t
yi Y d S w )Nr� )r� r� rV r� r� rL r� r� r� r r� r� r� r� )
r� r� r� r� r� r� Ztimestamp_bytesr� r� r� Z
signed_stringZ expected_sigr� r4 r4 r5 r� � s> � �
�
�r� c C sJ t | �} t| �}|dk rd S z t| �\}}}}}W |S ty$ Y d S w )Nr/ )r r� r� r� )r� rt r� r> r4 r4 r5 r� � s ��r� r� c G s8 t jt| �tjd�}|D ] }|�t|�� q t|�� �S �N)Z digestmod)r� �newr r� r� r6 r� )r� r� �hashrW r4 r4 r5 r� � s r� r� c C s. t jt| �tjd�}|�t|�� t|�� �S r� )r� r� r r� �sha256r6 r� )r� r� r� r4 r4 r5 r� � s r� r� c s t � fdd�dD ��S )Nc 3 s � | ]}� � |�V qd S rC r� )rE r� �r� r4 r5 rJ � s � z is_absolute.<locals>.<genexpr>)r� zhttp:zhttps:)�anyr� r4 r� r5 r# � s r# r� )r� NN)�r� r� r� r� � email.utilsr� r r r� r� Z http.cookiesr� �inspectr �ior r� r� Zos.pathr/ r� rO r* r� rv r� rs rj r@ � urllib.parser� r Ztornado.concurrentr r r r Ztornado.httpserverr r
r r Z tornado.logr
r r r Ztornado.escaper r Ztornado.routingr r r r r r r r Z tornado.utilr r r r� �typingr r r r! r" r# r$ r% r& r' r( r) r* r+ r, �
TYPE_CHECKINGr- r� r� r� r� r� Z_CookieSecretTypesZ"MIN_SUPPORTED_SIGNED_VALUE_VERSIONZ"MAX_SUPPORTED_SIGNED_VALUE_VERSIONr� r� r0 r� r6 r� r� r� rk r r
r r? r rH r� re r� r� rI ra r� r� r� r r� r� r! r" r# rU r� r� r� r� r� r� r� r� r� r� r� r� r# r4 r4 r4 r5 �<module> sj + (
@ )�
� �
�' @Z? 0 Y�
�%CG���
����
�
@��� ����
�
����
�
� #����
�
� (&