File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/ext/tornado/__pycache__/web.cpython-310.pyc
o
�N�g�� � @ s� d Z ddlmZmZmZ ddlZddlZddlZddlZ ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlmZ ddlm Z ddl Z ddl m Z ddl m!Z! ddl m"Z" dd l m#Z# dd
l m$Z$ dd l m%Z% dd l&m'Z'm(Z(m)Z) dd
l m*Z* ddl m+Z+ ddl,m-Z-m.Z. ddl/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6 ddl7m8Z8m9Z9m:Z:m;Z;m<Z< e6Z=e<r�ddl>m?Z@ ddlAmBZC ddlAmDZD nddl@Z@ddlCZCddlEmDZD zddlFZFeFjGeHe:ejIejf ZJW n
eK�y Y nw dZL dZM dZN dZO G dd� deP�ZQdd� ZRdd� ZSdd � ZTd d � ZUd d � ZVG d!d"� d"e5�ZWG d#d$� d$e3�ZXG d%d&� d&e#jY�ZZG d'd(� d(e[�Z\G d)d*� d*e[�Z]G d+d,� d,e\�Z^G d-d.� d.eQ�Z_G d/d0� d0eQ�Z`G d1d2� d2eQ�ZaG d3d4� d4eQ�ZbG d5d6� d6eP�ZcG d7d8� d8ec�Zdd9d:� ZeG d;d<� d<eP�ZfG d=d>� d>ef�ZgG d?d@� d@ef�ZhG dAdB� dBef�ZiG dCdD� dDeP�Zjeke
dE��r�e
jlZmndFdG� Zm d^dHdI�Zne�odJ�ZpdKdL� Zq M d_dNdO�ZrdPdQ� ZsdRdS� ZtdTdU� ZudVdW� ZvdXdY� ZwdZd[� Zxd\d]� ZydS )`a� ``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 tornado.ioloop
import tornado.web
class MainHandler(tornado.web.RequestHandler):
def get(self):
self.write("Hello, world")
if __name__ == "__main__":
application = tornado.web.Application([
(r"/", MainHandler),
])
application.listen(8888)
tornado.ioloop.IOLoop.current().start()
.. testoutput::
:hide:
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.
� )�absolute_import�division�print_functionN)�isclass)�BytesIO)�Future)�escape)�gen)�httputil)�iostream)�locale)�
access_log�app_log�gen_log)�
stack_context)�template)�utf8�_unicode)�
AnyMatches�DefaultHostMatches� HostMatches�ReversibleRouter�Rule�ReversibleRuleRouter�URLSpec)�
ObjectDict�raise_exc_info� unicode_type�_websocket_mask�PY3)� urlencode� � c sN e Zd ZdZdZi Ze�� Ze �
d�Z � fdd�Z dd� Z
edd � �Zd
d � Zd d
� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd�d#d$�Z d%d&� Z d'd(� Z d)d*� Z d+d,� Z e �
d-�Z!d.d/� Z"e#� Z$e$d0fd1d2�Z%d�d3d4�Z&e$d0fd5d6�Z'd�d7d8�Z(e$d0fd9d:�Z)d�d;d<�Z*d�d=d>�Z+d�d?d@�Z,d�dAdB�Z-edCdD� �Z.d�dEdF�Z/ G "d�dHdI�Z0d�dJdK�Z1d�dLdM�Z2d�dOdP�Z3d�dQdR�Z4 S "d�dTdU�Z5d�dVdW�Z6d�dYdZ�Z7d[d\� Z8d]d^� Z9d_d`� Z:dadb� Z;dcdd� Z<dedf� Z=dgdh� Z>didj� Z?dkdl� Z@d�dmdn�ZAd�dodp�ZBdqdr� ZCd�dtdu�ZDdvdw� ZEedxdy� �ZFeFjGdzdy� �ZFd{d|� ZHd�d~d�ZIed�d�� �ZJeJjGd�d�� �ZJd�d�� ZKd�d�� ZLd�d�� ZMed�d�� �ZNd�d�� ZOd�d�� ZPd�d�� ZQd�d�� ZRd�d�d��ZSd�d�d��ZTd�d�� ZUd�d�� ZVd�d�� ZWd�d�� ZXd�d�� ZYeZj[d�d�� �Z\d�d�� Z]d�d�� Z^d�d�� Z_d�d�� Z`d�d�� Zad�d�� Zbd�d�� Zcd�d�� Zd� ZeS )��RequestHandlerz�Base class for HTTP request handlers.
Subclasses must define at least one of the methods defined in the
"Entry points" section below.
)�GET�HEAD�POSTZDELETE�PATCH�PUT�OPTIONSz[\x00-\x08\x0e-\x1f]c s� t t� ��� |� _|� _d� _d� _d� _d � _d � _ d � _
d � _ d � _ t
� fdd�|j�� D ��� _t� |j�� jd< � jd � jd< � �� � jj�� j� � jdi |�� d S )NFTc 3 s" � | ] \}}|� � |�fV qd S �N)�
_ui_method)�.0�n�m��self� �H/opt/saltstack/salt/lib/python3.10/site-packages/salt/ext/tornado/web.py� <genexpr>� s � z*RequestHandler.__init__.<locals>.<genexpr>Z _tt_modules�modulesr1 )�superr# �__init__� application�request�_headers_written� _finished� _auto_finish� _transforms�_prepared_future�_headers� path_args� path_kwargsr �
ui_methods�items�ui�_UIModuleNamespace�
ui_modules�clear�
connection�set_close_callback�on_connection_close�
initialize)r0 r7 r8 �kwargs�� __class__r/ r2 r6 � s*
�
�zRequestHandler.__init__c C � dS )a& Hook for subclass initialization. Called for each request.
A dictionary passed as the third argument of a url spec will be
supplied as keyword arguments to initialize().
Example::
class ProfileHandler(RequestHandler):
def initialize(self, database):
self.database = database
def get(self, username):
...
app = Application([
(r'/user/(.*)', ProfileHandler, dict(database=database)),
])
Nr1 r/ r1 r1 r2 rJ � s zRequestHandler.initializec C � | j jS )z@An alias for `self.application.settings <Application.settings>`.)r7 �settingsr/ r1 r1 r2 rP � s zRequestHandler.settingsc O � t d���N� �� HTTPError�r0 �argsrK r1 r1 r2 �head� � zRequestHandler.headc O rQ rR rT rV r1 r1 r2 �get� rY zRequestHandler.getc O rQ rR rT rV r1 r1 r2 �post� rY zRequestHandler.postc O rQ rR rT rV r1 r1 r2 �delete� rY zRequestHandler.deletec O rQ rR rT rV r1 r1 r2 �patch� rY zRequestHandler.patchc O rQ rR rT rV r1 r1 r2 �put� rY zRequestHandler.putc O rQ rR rT rV r1 r1 r2 �options� rY zRequestHandler.optionsc C rN )a Called at the beginning of a request before `get`/`post`/etc.
Override this method to perform common initialization regardless
of the request method.
Asynchronous support: Decorate this method with `.gen.coroutine`
or `.return_future` to make it asynchronous (the
`asynchronous` decorator cannot be used on `prepare`).
If this method returns a `.Future` execution will not proceed
until the `.Future` is done.
.. versionadded:: 3.1
Asynchronous support.
Nr1 r/ r1 r1 r2 �prepare� s zRequestHandler.preparec C rN )a Called after the end of a request.
Override this method to perform cleanup, logging, etc.
This method is a counterpart to `prepare`. ``on_finish`` may
not produce any output, as it is called after the response
has been sent to the client.
Nr1 r/ r1 r1 r2 � on_finish � 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_bodyrM r8 �body�doneZ
set_exceptionr �StreamClosedError� exceptionr/ r1 r1 r2 rI
s
�z"RequestHandler.on_connection_closec C sL t �dtjjj 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
Z HTTPHeaders�salt�extZtornado�version�format_timestamp�timer> �set_default_headers�
_write_buffer� _status_code� responses�_reasonr/ r1 r1 r2 rF s
�zRequestHandler.clearc C rN )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.
Nr1 r/ r1 r1 r2 ro , rb z"RequestHandler.set_default_headersNc C sL || _ |durt�|�| _dS z tj| | _W dS ty% td| ��w )a� Sets the status code for our response.
:arg int status_code: Response status code. If ``reason`` is ``None``,
it must be present in `httplib.responses <http.client.responses>`.
:arg string reason: Human-readable reason phrase describing the status
code. If ``None``, it will be filled in from
`httplib.responses <http.client.responses>`.
Nzunknown status code %d)rq r �
native_strrs r
rr �KeyError�
ValueError)r0 � status_code�reasonr1 r1 r2 �
set_status6 s �zRequestHandler.set_statusc C s | j S )z)Returns the status code for our response.)rq r/ r1 r1 r2 �
get_statusH � zRequestHandler.get_statusc C s | � |�| j|< dS )a Sets the given response header name and value.
If a datetime is given, we automatically format it according to the
HTTP specification. If the value is not a string, we convert it to
a string. All header values are then encoded as UTF-8.
N)�_convert_header_valuer> �r0 �name�valuer1 r1 r2 �
set_headerL 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)r> �addr| r} r1 r1 r2 �
add_headerV 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)r> )r0 r~ r1 r1 r2 � clear_header_ s
�zRequestHandler.clear_headerz [\x00-\x1f]c C s� t |t�r|}n1t |t�r|�d�}n&t |t�r t�|�}nt |tj�r(t|�S t |t j �r3t
� |�S t d| ��t
j�|�rDtd|��|S )N�latin1zUnsupported header value %rzUnsafe header value %r)�
isinstance�str�bytes�decoder r r �numbers�Integral�datetimer
rm � TypeErrorr# �_INVALID_HEADER_CHAR_RE�searchrv )r0 r �retvalr1 r1 r2 r| j s
z$RequestHandler._convert_header_valueTc C � | � ||| jj|�S )a\ 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 url more than once, we return the
last value.
The returned value is always unicode.
)�
_get_argumentr8 � arguments�r0 r~ �default�stripr1 r1 r2 � get_argument� s zRequestHandler.get_argumentc 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.
The returned values are always unicode.
)r� �bool�_get_argumentsr8 r� �r0 r~ r� r1 r1 r2 �
get_arguments� s z RequestHandler.get_argumentsc C r� )a� 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.
The returned value is always unicode.
.. versionadded:: 3.2
)r� r8 �body_argumentsr� r1 r1 r2 �get_body_argument� s �z RequestHandler.get_body_argumentc 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.
The returned values are always unicode.
.. versionadded:: 3.2
)r� r8 r� r� r1 r1 r2 �get_body_arguments� � z!RequestHandler.get_body_argumentsc C r� )a� 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.
The returned value is always unicode.
.. versionadded:: 3.2
)r� r8 �query_argumentsr� r1 r1 r2 �get_query_argument� s �z!RequestHandler.get_query_argumentc C r� )z�Returns a list of the query arguments with the given name.
If the argument is not present, returns an empty list.
The returned values are always unicode.
.. versionadded:: 3.2
)r� r8 r� r� r1 r1 r2 �get_query_arguments� r� z"RequestHandler.get_query_argumentsc C s2 | j |||d�}|s|| ju rt|��|S |d S )N)r� ���)r� � _ARG_DEFAULT�MissingArgumentError)r0 r~ r� �sourcer� rW r1 r1 r2 r� � s
z RequestHandler._get_argumentc C sV g }|� |g �D ] }| j||d�}t|t�r tj�d|�}|r#|�� }|�|� q|S )N�r~ � ) rZ �decode_argumentr� r r# �_remove_control_chars_regex�subr� �append)r0 r~ r� r� �values�vr1 r1 r2 r� � s
z RequestHandler._get_argumentsc
C s8 zt |�W S ty tdd|pd|dd� f ��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 %s: %r�urlN�( )r �UnicodeDecodeErrorrU )r0 r r~ r1 r1 r2 r� � s
��z RequestHandler.decode_argumentc C rO )zRAn alias for
`self.request.cookies <.httputil.HTTPServerRequest.cookies>`.)r8 �cookiesr/ r1 r1 r2 r� s zRequestHandler.cookiesc C s* | j jdur|| j jv r| j j| jS |S )z?Gets the value of the cookie with the given name, else default.N)r8 r� r )r0 r~ r� r1 r1 r2 �
get_cookie s zRequestHandler.get_cookie�/c K s� t �|�}t �|�}t�d|| �rtd||f ��t| d�s$t�� | _|| jv r-| j|= || j|< | j| }|r=||d< |durN|sNt j �
� t j |d� }|rWt �
|�|d< |r]||d< |�� D ]\} }
| d krkd
} | d v rr|
srqa|
|| < qadS ) a Sets the given cookie name/value with the given options.
Additional keyword arguments are set on the Cookie.Morsel
directly.
See https://docs.python.org/2/library/cookie.html#Cookie.Morsel
for available attributes.
z [\x00-\x20]zInvalid cookie %r: %r� _new_cookie�domainN��days�expires�pathZmax_agezmax-age)ZhttponlyZsecure)r rt �rer� rv �hasattr�CookieZ SimpleCookier� r� �utcnow� timedeltar
rm rB ) r0 r~ r r� r� r� � expires_daysrK Zmorsel�kr� r1 r1 r2 �
set_cookie s6
�
�zRequestHandler.set_cookiec C s. t j �� t jdd� }| j|d|||d� dS )a; Deletes the cookie with the given name.
Due to limitations of the cookie protocol, you must pass the same
path and domain to clear a cookie as were used when that cookie
was set (but there is no way to find out on the server side
which values were used for a given cookie).
im r� � )r r� r� r� N)r� r� r� r� )r0 r~ r� r� r� r1 r1 r2 � clear_cookie; s
�zRequestHandler.clear_cookiec C s" | j jD ]
}| j|||d� qdS )z�Deletes all the cookies the user sent with this request.
See `clear_cookie` for more information on the path and domain
parameters.
.. versionchanged:: 3.2
Added the ``path`` and ``domain`` parameters.
)r� r� N)r8 r� r� )r0 r� r� r~ r1 r1 r2 �clear_all_cookiesG s
�z RequestHandler.clear_all_cookies� 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_secure_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_secure_cookie`.
Secure cookies may contain arbitrary byte values, not just unicode
strings (unlike regular cookies)
.. versionchanged:: 3.2.1
Added the ``version`` argument. Introduced cookie version 2
and made it the default.
)rl r� N)r� �create_signed_value)r0 r~ r r� rl rK r1 r1 r2 �set_secure_cookieT s ��
�z RequestHandler.set_secure_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_secure_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_secure_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)rl r� )�require_settingr7 rP r� �dictrZ � Exceptionr� )r0 r~ r rl �secretr� r1 r1 r2 r� n s
�z"RequestHandler.create_signed_value� c C s8 | � dd� |du r| �|�}t| jjd ||||d�S )aK Returns the given signed cookie if it validates, or None.
The decoded cookie value is returned as a byte string (unlike
`get_cookie`).
.. versionchanged:: 3.2.1
Added the ``min_version`` argument. Introduced cookie version 2;
both versions 1 and 2 are accepted by default.
r� r� N)� max_age_days� min_version)r� r� �decode_signed_valuer7 rP )r0 r~ r r� r� r1 r1 r2 �get_secure_cookie� s
�z RequestHandler.get_secure_cookiec C s& | � dd� |du r| �|�}t|�S )zgReturns the signing key version of the secure cookie.
The version is returned as int.
r� r� N)r� r� �get_signature_key_versionr} r1 r1 r2 � get_secure_cookie_key_version� s
z,RequestHandler.get_secure_cookie_key_versionFc 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)r9 r� r� �intry r� r �finish)r0 r� � permanent�statusr1 r1 r2 �redirect� s &
zRequestHandler.redirectc 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.writerh z application/json; charset=UTF-8N)r: � RuntimeErrorr� r� r r� �listr� r Z json_encoder� r rp r� )r0 �chunk�messager1 r1 r2 �write� s
zRequestHandler.writec K sx | j rtd��| j|fi |��}g }g }g }g }g }g } t| di ��� D ]f}
|
�� } | r3|�t| �� |
�� } | rKt | t
t f�rF|�| � n|� | � |
�
� } | rX|�t| �� |
�� } | rpt | t
t f�rk|�| � 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� }| �r5|�d�}|d|� d�| � d ||d� }| �|� dS )z>Renders the template with the given arguments as the response.z Cannot render() after finish()�_active_moduless </body>N�
s </head>� )r: r� �
render_string�getattrr� �embedded_javascriptr� r �javascript_filesr� 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� )r0 �
template_namerK �html�js_embed�js_files� css_embedr� Z
html_headsZ html_bodies�moduleZ
embed_partZ file_partZ head_partZ body_partZjsZsloc�cssZhlocr1 r1 r2 �render� sp
�
$
$
&
&zRequestHandler.renderc 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�r, �pr1 r1 r2 r3 ! s � � �z2RequestHandler.render_linked_js.<locals>.<genexpr>��set� is_absolute�
static_urlr� r� r� )r0 r� �paths� unique_pathsr� r1 r1 r2 r� �
�
�z RequestHandler.render_linked_jsc 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� )r0 r� r1 r1 r2 r� % s
��z RequestHandler.render_embed_jsc 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 r1 r1 r2 r3 > s � �z3RequestHandler.render_linked_css.<locals>.<genexpr>r )r0 r� r r r� r1 r1 r2 r� . r z RequestHandler.render_linked_cssc 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 )r0 r� r1 r1 r2 r� B s �z RequestHandler.render_embed_cssc K s� | � � }|s&t�d�}|jj}|jj|kr |j}|jj|kstj�|jj�}t j
� |t j vr:| � |�}|t j |< nt j | }W d � n1 sIw 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 Nr1 )�get_template_path�sys� _getframe�f_code� co_filename�f_back�osr� �dirnamer# �_template_loader_lock�_template_loaders�create_template_loader�load�get_template_namespace�updateZgenerate) r0 r� rK �
template_path�frameZweb_file�loader�t� namespacer1 r1 r2 r� K 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`.
) �handlerr8 � current_userr �_�pgettextr �xsrf_form_html� reverse_url) r� r8 r r � translater" r r# r$ r rC )r0 r r1 r1 r2 r d s � z%RequestHandler.get_template_namespacec 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)r7 rP r �Loader)r0 r rP rK r1 r1 r2 r { s z%RequestHandler.create_template_loaderc C s� d� | j�}g | _| jsWd| _| jD ]}|�| j| j||�\| _| _}q| jjdkr,d}t | d�rB| j
� � D ] }| � d|�
d�� q6t�d| j| j�}| jjj|| j||d�S | jD ]}|�||�}qZ| jjdkrr| jjj||d�S t� }|�d� |S ) a� Flushes the current output buffer to the network.
The ``callback`` argument, if given, can be used for flow control:
it will be run when all flushed data has been written to the socket.
Note that only one flush callback can be outstanding at a time;
if another flush occurs before the previous flush's callback
has been run, the previous callback will be discarded.
.. versionchanged:: 4.0
Now returns a `.Future` if no callback is given.
r� Tr% Nr� z
Set-Cookier� )�callback)r� rp r9 r< �transform_first_chunkrq r> r8 �methodr� r� r� r� Z OutputStringr
ZResponseStartLiners rG Z
write_headers�transform_chunkr� r �
set_result)r0 �include_footersr( r� Z transform�cookie�
start_lineZfuturer1 r1 r2 �flush� s:
��
�
�
zRequestHandler.flushc C s | j rtd��|dur| �|� | jsf| jdkr3| jjdv r3d| jvr3| �� | � � r3g | _
| � d� | jdv sB| jdkrQ| jdk rQ| j
rLJ d | j ��| � � nd
| jvrft
d d � | j
D ��}| �d
|� t| jd
�rs| jj�d� | jdd� | j�� | �� d| _ | �� | �� dS )z0Finishes this response, ending the HTTP request.zfinish() called twiceNri �r$ r% �Etag�0 )�� r3 �d zCannot send body with %s�Content-Lengthc s s � | ]}t |�V qd S r* )�len)r, �partr1 r1 r2 r3 � s � z(RequestHandler.finish.<locals>.<genexpr>rG T)r- )r: r� r� r9 rq r8 r* r> �set_etag_header�check_etag_headerrp ry �_clear_headers_for_304�sumr� r� rG rH r0 r� �_logra �
_break_cycles)r0 r� �content_lengthr1 r1 r2 r� � s6
zRequestHandler.finishc C s
d | _ d S r* )rC r/ r1 r1 r2 r> � s
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 | j |fi |�� W n tyf t
jd
dd� Y nw | jsp| �� 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_infoNrx rB r! )rx z!Uncaught exception in write_error)r9 r �errorr: r� r� rF rZ r� rU rx ry � write_errorr )r0 rw rK rx rg r1 r1 r2 �
send_error� s8
���
� �zRequestHandler.send_errorc K sd | j �d�r%d|v r%| �dd� tj|d � D ]}| �|� q| �� dS | �d|| jd� � 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_tracebackrB rh �
text/plainzS<html><title>%(code)d: %(message)s</title><body>%(code)d: %(message)s</body></html>)�coder� N)rP rZ r� � traceback�format_exceptionr� r� rs )r0 rw rK �liner1 r1 r2 rD s �
�zRequestHandler.write_errorc C s4 t | d�s| �� | _| js| �� | _| jsJ �| 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.
�_locale)r� �get_user_localerL �get_browser_localer/ r1 r1 r2 r - s
zRequestHandler.localec C �
|| _ d S r* )rL �r0 r r1 r1 r2 r @ �
c C rN )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")``
Nr1 r/ r1 r1 r2 rM D rb z RequestHandler.get_user_locale�en_USc
C s� d| j jv rf| j jd �d�}g }|D ];}|�� �d�}t|�dkrC|d �d�rCz t|d dd� �}W n ttfyB d}Y nw d }|� |d
|f� q|rf|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" Ng g �?r c S s | d S )Nr! r1 )�pairr1 r1 r2 �<lambda>a s z3RequestHandler.get_browser_locale.<locals>.<lambda>T)�key�reversec S s g | ]}|d �qS )r r1 )r, �lr1 r1 r2 �
<listcomp>b s z5RequestHandler.get_browser_locale.<locals>.<listcomp>)
r8 �headers�splitr� r7 �
startswith�floatrv r� r� �sortr rZ )r0 r� � languagesZlocales�language�partsZscoreZcodesr1 r1 r2 rN N 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_secure_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_secure_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_userrc r/ r1 r1 r2 r f s
zRequestHandler.current_userc C rO r* )rc rP r1 r1 r2 r � rQ c C rN )zrOverride to determine the current user from, e.g., a cookie.
This method may not be a coroutine.
Nr1 r/ r1 r1 r2 rd � 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� r7 rP r/ r1 r1 r2 �
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.
r )r7 rP rZ r/ r1 r1 r2 r � s z RequestHandler.get_template_pathc C s� t | d�se| �� \}}}| j�dd�}| j�di �}|dkr%t�|�| _n(|dkrHt�d�}d� dt�|�t�t
||��t t t
|���g�| _ntd |��|d
u re| jrVd nd
}| jd | jfd
|i|�� | 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
.. 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� �_xsrfr� )r� �_get_raw_xsrf_tokenrP rZ �binascii�b2a_hexrf r �urandomr� r r r� r� rv r r� )r0 rl �token� timestampZoutput_versionZ
cookie_kwargs�maskr� r1 r1 r2 �
xsrf_token� s2
����zRequestHandler.xsrf_tokenc C sd t | d�s/| �d�}|r| �|�\}}}nd\}}}|du r)d}t�d�}t�� }|||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_tokenrj �NNNN� )r� r� �_decode_xsrf_tokenr rn rn rs )r0 r. rl ro rp r1 r1 r2 rk � s
z"RequestHandler._get_raw_xsrf_tokenc 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_tokenTrA rt )�_signed_value_version_re�matchr r� �groupr\ rl �a2b_hexr r� �Errorr� rn r �debug) r0 r. r. rl r! rq Z masked_tokenrp ro r1 r1 r2 rv � s6 � � ��z!RequestHandler._decode_xsrf_tokenc C s� | � dd�p| jj�d�p| jj�d�}|stdd��| �|�\}}}| �� \}}}|s1tdd��tt|�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
Prior to release 1.1.1, this check was ignored if the HTTP header
``X-Requested-With: XMLHTTPRequest`` was present. This exception
has been shown to be insecure and has been removed. For more
information please see
http://www.djangoproject.com/weblog/2011/feb/08/security/
http://weblog.rubyonrails.org/2011/2/8/csrf-protection-bypass-in-ruby-on-rails
.. versionchanged:: 3.2.2
Added support for cookie version 2. Both versions 1 and 2 are
supported.
rj Nz X-Xsrftokenz X-Csrftoken� z"'_xsrf' argument missing from POSTz#'_xsrf' argument has invalid formatz(XSRF cookie does not match POST argument) r� r8 r[ rZ rU rv rk �_time_independent_equalsr )r0 ro r! Zexpected_tokenr1 r1 r2 �check_xsrf_cookie 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 rr r/ r1 r1 r2 r# 9 s
��z RequestHandler.xsrf_form_htmlc 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_classN� include_hostFz://r� ) r� rP rZ �StaticFileHandler�make_static_urlr� r8 �protocol�host)r0 r� r� rK Zget_url�baser1 r1 r2 r I s �� zRequestHandler.static_url� this 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)r7 rP rZ r� )r0 r~ Zfeaturer1 r1 r2 r� l s
��z RequestHandler.require_settingc G s | j j|g|�R � S )z$Alias for `Application.reverse_url`.)r7 r$ )r0 r~ rW r1 r1 r2 r$ r � 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.
�"%s")�hashlib�sha1rp r � hexdigest)r0 �hasherr8 r1 r1 r2 � compute_etagv 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.
Nr2 )r� r� )r0 �etagr1 r1 r2 r9 � s �z RequestHandler.set_etag_headerc C s� t | j�dd��}t�dt | jj�dd���}|r|s dS d}|d dkr)d}|S d d
� }|D ]}||�||�kr>d} |S q/|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.
r2 r� s \*|(?:W/)?"[^"]*"z
If-None-MatchFr � *Tc S s | � d�r | dd � S | S )Ns W/r" �r] )�xr1 r1 r2 �val� s z-RequestHandler.check_etag_header.<locals>.val)r r> rZ r� �findallr8 r[ )r0 Z
computed_etagZetagsry r� r� r1 r1 r2 r: � s& �
��z RequestHandler.check_etag_headerc C s4 z
t |||f� W dS ty | �|� Y dS w �NT)r r� �_handle_request_exception)r0 �typer rI r1 r1 r2 � _stack_context_handle_exception� s � �z.RequestHandler._stack_context_handle_exceptionc / s� � |� _ z�� jj� jvrtd��� fdd�|D �� _t� fdd�|�� D ��� _� jjdvr9� j j
� d�r9� � � � �
� }|durD|V }� jdurO� j�d� � jrUW dS t� j�rnz� jjV W n tjym Y W dS w t� � jj�� �}|� ji � j��}|dur�|V }� jr�� js�� �� W dS W dS W dS ty� } z=z� �|� W n ty� t j d d
d � Y nw � jdurЈ 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.rS c s g | ]}� � |��qS r1 �r� )r, �argr/ r1 r2 rZ � � z+RequestHandler._execute.<locals>.<listcomp>c 3 s& � | ]\}}|� j ||d �fV qdS )r� Nr� )r, r� r� r/ r1 r2 r3 � s � �z*RequestHandler._execute.<locals>.<genexpr>)r$ r% r) Z xsrf_cookiesNz Exception in exception handlerTrA ) r< r8 r* �SUPPORTED_METHODSrU r? r� rB r@ r7 rP rZ r� r` r= r, r: rc rM rd r rf r� �lowerr; r� r� r� r rC re )r0 �
transformsrW rK �resultr* �er1 r/ r2 �_execute� s\ �
� �
� � �
� ���zRequestHandler._executec C � t � �)zwImplement this method to handle streamed request data.
Requires the `.stream_request_body` decorator.
��NotImplementedError)r0 r� r1 r1 r2 �
data_received� 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)r7 � log_requestr/ r1 r1 r2 r= � s zRequestHandler._logc C s d| j j| j j| j jf S )Nz
%s %s (%s))r8 r* �uriZ remote_ipr/ r1 r1 r2 �_request_summary s �z RequestHandler._request_summaryc 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 t
jvrO|jsOt�
d|j � | jdt�� d� d S | j|j t�� d� d S | jdt�� d� d S )NzError in exception loggerTrA zBad HTTP status code: %dr@ )r� �Finishr: r� rW �
log_exceptionr
rB r� r rC rU rw r
rr rx r rE )r0 r� r1 r1 r2 r� s"
�
z(RequestHandler._handle_request_exceptionc C sn t |t�r&|jr$d|j }|j| �� gt|j� }tj|g|�R � dS dS t j
d| �� | 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: zUncaught exception %s
%rrA N) r� rU � log_messagerw r� r� rW r �warningr rC r8 )r0 �typr �tb�formatrW r1 r1 r2 r� & s
��
�z RequestHandler.log_exceptionc s � ��fdd�}|S )Nc sB t �d�si �_��jvr� ���j�< �j� j| i |��}|S )Nr� )r� r� r� )rW rK Zrendered�r� r~ r0 r1 r2 r� ; s
z)RequestHandler._ui_module.<locals>.renderr1 )r0 r~ r� r� r1 r� r2 �
_ui_module: s zRequestHandler._ui_modulec s � �fdd�S )Nc s � �g| �R i |��S r* r1 )rW rK �r* r0 r1 r2 rV E r� z+RequestHandler._ui_method.<locals>.<lambda>r1 )r0 r* r1 r� r2 r+ D � zRequestHandler._ui_methodc C s g d�}|D ]}| � |� qd S )N)ZAllow�Content-EncodingzContent-Languager6 z Content-MD5�
Content-Rangerh �
Last-Modified)r� )r0 r[ �hr1 r1 r2 r; G s �z%RequestHandler._clear_headers_for_304r* �T)NNr� N)r� N)r� N)Nr� N)FN)r@ )rR )r� )f�__name__�
__module__� __qualname__�__doc__r� r � threading�Lockr r� �compiler� r6 rJ �propertyrP rX rZ r[ r\ r] r^ r_ r` ra rI rF ro ry rz r� r� r� r� r| �objectr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r0 r� r> rE rD r �setterrM rN r rd re r rr rk rv r� r# r r� r$ r� r9 r: r� r � coroutiner� r� r= r� r� r� r� r+ r; �
__classcell__r1 r1 rL r2 r# � s�
�
)
�
@
0(
'
#
2$%
#
)
5
r# c s( ddl m� t���� �fdd��}|S )a� Wrap request handler methods with this if they are asynchronous.
This decorator is for callback-style asynchronous methods; for
coroutines, use the ``@gen.coroutine`` decorator without
``@asynchronous``. (It is legal for legacy reasons to use the two
decorators together provided ``@asynchronous`` is first, but
``@asynchronous`` will be ignored in this case)
This decorator should only be applied to the :ref:`HTTP verb
methods <verbs>`; its behavior is undefined for any other method.
This decorator does not *make* a method asynchronous; it tells
the framework that the method *is* asynchronous. For this decorator
to be useful the method must (at least sometimes) do something
asynchronous.
If this decorator is given, the response is not finished when the
method returns. It is up to the request handler to call
`self.finish() <RequestHandler.finish>` to finish the HTTP
request. Without this decorator, the request is automatically
finished when the ``get()`` or ``post()`` method returns. Example:
.. testcode::
class MyRequestHandler(RequestHandler):
@asynchronous
def get(self):
http = httpclient.AsyncHTTPClient()
http.fetch("http://friendfeed.com/", self._on_download)
def _on_download(self, response):
self.write("Downloaded!")
self.finish()
.. testoutput::
:hide:
.. versionchanged:: 3.1
The ability to use ``@gen.coroutine`` without ``@asynchronous``.
.. versionchanged:: 4.3 Returning anything but ``None`` or a
yieldable object from a method decorated with ``@asynchronous``
is an error. Such return values were previously ignored silently.
r )�IOLoopc s� d� _ t�� j��5 �� g|�R i |��}|d ur5t�|�}� fdd�}��� �||� W d � d S |W d � S 1 sAw Y d S )NFc s | � � � js
� �� d S d S r* )r� r: r� )�fr/ r1 r2 �future_complete� s �z6asynchronous.<locals>.wrapper.<locals>.future_complete)r; r ZExceptionStackContextr� r Zconvert_yielded�currentZ
add_future)r0 rW rK r� r� �r� r* r/ r2 �wrapper� s �
�$�z asynchronous.<locals>.wrapper)Zsalt.ext.tornado.ioloopr� � functools�wraps�r* r� r1 r� r2 � asynchronousS s -r� 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/master/demos/file_upload/>`_
for example usage.
�+expected subclass of RequestHandler, got %rT)�
issubclassr# r� �_stream_request_body��clsr1 r1 r2 �stream_request_body� s
r� c C s t | t�s
td| ��t| dd�S )Nr� r� F)r� r# r� r� r� r1 r1 r2 rc � s
rc c � t �� �� 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.
c 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� r1 �?T�r� � )r8 r� �endswithr* �rstrip�queryr� rU �r0 rW rK r� �r* r1 r2 r� � s �z removeslash.<locals>.wrapper�r� r� r� r1 r� r2 � 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.
c 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� )r8 r� r� r* r� r� rU r� r� r1 r2 r� � s zaddslash.<locals>.wrapperr� r� r1 r� r2 �addslash� s
r� c s: e Zd ZdZd � fdd� Z� fdd�Z� 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.
Nc s( t |t�sJ �|| _tt| ��|� d S r* )r� � Applicationr7 r5 r� r6 )r0 r7 �rulesrL r1 r2 r6 � s z_ApplicationRouter.__init__c s4 t t| ��|�}t|jttf�rt| j|j�|_|S r* )r5 r� � process_ruler� �targetr� �tupler7 )r0 �rulerL r1 r2 r� � s z _ApplicationRouter.process_rulec sB t |�rt|t�r| jj||fi |��S tt| �j||fi |��S r* )r r� r# r7 �get_handler_delegater5 r� �get_target_delegate)r0 r� r8 Z
target_paramsrL r1 r2 r� s z&_ApplicationRouter.get_target_delegater* )r� r� r� r� r6 r� r� r� r1 r1 rL r2 r� � s
r� c @ sr e Zd ZdZddd�Zddd�Zdd � Zd
d � Zd d
� Zdd� Z dd� Z
dd� Z ddd�Z dd� Z
dd� ZdS ) r� 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)
ioloop.IOLoop.current().start()
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.
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.
Nc 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# �TemplaterE rA r� �static_url_prefix�/static/r� �static_handler_argsr� z(.*)z/(favicon\.ico)z/(robots\.txt)r r} �
autoreloadT�compiled_template_cacheF�static_hash_cacherF )r� )r� rZ r� �GZipContentEncoding� default_hostrP �_linkify�_xsrf_form_html�TemplateModulerE rA �_load_ui_modules�_load_ui_methodsr� r� r� r �insert�
setdefaultr� �wildcard_routerr r �default_router�salt.ext.tornador� �start) r0 �handlersr� r� rP r� r� r� r� �patternr� r1 r1 r2 r6 S sZ ��
�� �
� � �zApplication.__init__r� c K s, ddl m} || fi |��}|�||� |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()`` to start the server.
Returns the `.HTTPServer` object.
.. versionchanged:: 4.3
Now returns the `.HTTPServer` object.
r )�
HTTPServer)Zsalt.ext.tornado.httpserverr �listen)r0 �port�addressrK r Zserverr1 r1 r2 r � s zApplication.listenc 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 � host_pattern)r0 r Z
host_handlersZ host_matcherr� r1 r1 r2 � add_handlers� s
��zApplication.add_handlersc C s | j �|� d S r* )r� r� )r0 Ztransform_classr1 r1 r2 �
add_transform� � zApplication.add_transformc s� t � tj�r| �t� fdd�t� �D ��� d S t � t�r)� D ]}| �|� q d S � �� D ] \}}|�d�sJt |d�rJ|d �
� |d krJ|| j |< q-d S )Nc 3 � � | ]
}|t � |�fV qd S r* �r� �r, r- ��methodsr1 r2 r3 � � � �z/Application._load_ui_methods.<locals>.<genexpr>r! �__call__r ) r� �types�
ModuleTyper� r� �dirr� rB r] r� r� rA )r0 r r. r~ �fnr1 r r2 r� � s �
�
��z Application._load_ui_methodsc s� t � tj�r| �t� fdd�t� �D ��� d S t � t�r)� D ]}| �|� q d S t � t�s0J �� �� D ]\}}z t|t �rC|| j
|< W q4 t yM Y q4w d S )Nc 3 r
r* r r �r4 r1 r2 r3 � r z/Application._load_ui_modules.<locals>.<genexpr>) r� r r r� r� r r� rB r� �UIModulerE r� )r0 r4 r. r~ r� r1 r r2 r� � s$ �
�
� ��z Application._load_ui_modulesc C s | � |�}|�� S r* )� find_handler�execute)r0 r8 �
dispatcherr1 r1 r2 r � s
zApplication.__call__c K sT | j �|�}|d ur |S | j�d�r!| �|| jd | j�di ��S | �|tddi�S )NZdefault_handler_classZdefault_handler_argsrw r� )r r rP rZ r� � ErrorHandler)r0 r8 rK Zrouter1 r1 r2 r � s �
�zApplication.find_handlerc 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.
)�_HandlerDelegate)r0 r8 Z target_classZ
target_kwargsr? r@ r1 r1 r2 r� � s �z Application.get_handler_delegatec 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 r$ ru )r0 r~ rW Z reversed_urlr1 r1 r2 r$ � s zApplication.reverse_urlc 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� r@ g @�@z %d %s %.2fms) rP rz r
�infor� rC r8 � request_timer� )r0 r Z
log_methodr r1 r1 r2 r� � s
�zApplication.log_requestrt )r� )r� r� r� r� r6 r r
r r� r� r r r� r$ r� r1 r1 r1 r2 r� s
F
/
� r� c @ s< e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
S )r c C sN || _ |j| _|| _|| _|pi | _|pg | _|pi | _g | _t| j�| _ d S r* )
r7 rG r8 �
handler_class�handler_kwargsr? r@ �chunksrc r� )r0 r7 r8 r! r" r? r@ r1 r1 r2 r6 s
z_HandlerDelegate.__init__c C s | j r t� | j_| �� S d S r* )r� r r8 rd r )r0 r/ r[ r1 r1 r2 �headers_received! s
�z!_HandlerDelegate.headers_receivedc C s" | j r | j�|�S | j�|� d S r* )r� r r� r# r� )r0 �datar1 r1 r2 r� & s z _HandlerDelegate.data_receivedc C s> | j r | jj�d � d S d�| j�| j_| j�� | �� d S )Nr� )r� r8 rd r, r� r# Z _parse_bodyr r/ r1 r1 r2 r� , s
z_HandlerDelegate.finishc C s | j r
| j�� d S d | _d S r* )r� r rI r# r/ r1 r1 r2 rI 4 s
z$_HandlerDelegate.on_connection_closec s� � j j�dd�s'tj� tj�� D ]}|�� qW d � n1 s"w Y � j j�dd�s3t�� � j � j � j
fi � j ��� _ � fdd�� j j
D �}� jrTt� � j _� j j|g� j�R i � j�� � j jS )Nr� Tr� c s g | ]}|� j ��qS r1 )r8 )r, r r/ r1 r2 rZ G r� z,_HandlerDelegate.execute.<locals>.<listcomp>)r7 rP rZ r# r r r� �resetr� r! r8 r" r r� r� r r= r� r? r@ )r0 r r� r1 r/ r2 r : s$
� ��
�z_HandlerDelegate.executeN) r� r� r� r6 r$ r� r� rI r r1 r1 r1 r2 r s r c @ s" e Zd ZdZddd�Zdd� ZdS ) rU a 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 string 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 string reason: Keyword-only argument. The HTTP "reason" phrase
to pass in the status line along with ``status_code``. Normally
determined automatically from ``status_code``, but can be used
to use a non-standard numeric code.
r@ Nc O sB || _ || _|| _|�dd �| _|r |s |�dd�| _d S d S d S )Nrx �%z%%)rw r� rW rZ rx �replace)r0 rw r� rW rK r1 r1 r2 r6 p s �zHTTPError.__init__c C sB d| j | jp
tj�| j d�f }| jr |d | j| j d S |S )Nz HTTP %d: %sZUnknownz (�))rw rx r
rr rZ r� rW )r0 r� r1 r1 r2 �__str__x s �zHTTPError.__str__)r@ N)r� r� r� r� r6 r* r1 r1 r1 r2 rU Z s
rU 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)r� r� r� r� r1 r1 r1 r2 r� � s r� c s e Zd ZdZ� 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
c s t t| ��dd| � || _d S )Nr� zMissing argument %s)r5 r� r6 �arg_name)r0 r+ rL r1 r2 r6 � s
�
z MissingArgumentError.__init__)r� r� r� r� r6 r� r1 r1 rL r2 r� � s r� c @ �( e Zd ZdZdd� Zdd� Zdd� ZdS ) r zBGenerates an error response with ``status_code`` for all requests.c C s | � |� d S r* )ry )r0 rw r1 r1 r2 rJ � r� zErrorHandler.initializec C s
t | j��r* )rU rq r/ r1 r1 r2 r` � �
zErrorHandler.preparec C � d S r* r1 r/ r1 r1 r2 r� � � z ErrorHandler.check_xsrf_cookieN)r� r� r� r� rJ r` r� r1 r1 r1 r2 r � s
r c @ s" e Zd ZdZddd�Zdd� 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.
Tc C � || _ || _d S r* )�_url�
_permanent)r0 r� r� r1 r1 r2 rJ � �
zRedirectHandler.initializec G s | j | jj|� | jd� d S )Nr� )r� r2 r� r3 )r0 rW r1 r1 r2 rZ � s zRedirectHandler.getNr� )r� r� r� r� rJ rZ r1 r1 r1 r2 r0 � s
r0 c @ s� e Zd ZdZdZi Ze�� Zd/dd�Z e
dd� �Z dd � Z e
jd0d d ��Zd
d� Zdd� Zdd� Ze
dd� �Zdd� Ze
d1dd��Ze
dd� �Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Z e
d0d'd(��Z d)d*� Z e
d+d,� �Z e
d-d.� �Z dS )2r� 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 �Nc C r1 r* )�root�default_filename)r0 r� r6 r1 r1 r2 rJ % r4 z StaticFileHandler.initializec C s2 | j � i | _W d � d S 1 sw Y d S r* )�_lock�_static_hashesr� r1 r1 r2 r& ) s "�zStaticFileHandler.resetc C s | j |dd�S )NF)� include_body)rZ �r0 r� r1 r1 r2 rX . r� zStaticFileHandler.headTc c s
� | � |�| _~| �| j| j�}| �| j|�| _| jd u r d S | �� | _| �� | � � r3| �
d� d S d }| j j �
d�}|rCt�|�}| �� }|r�|\}}|d urU||ksY|dkro| �
d� | �dd� | �dd|f � d S |d ur{|dk r{||7 }|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 | �| � | �� V W q� tjy� Y d S w d S | j jd k�sJ �d S ) Nr3 ZRanger i� rh rG r� z
bytes */%s�� r6 r% )�parse_url_pathr� �get_absolute_pathr5 �validate_absolute_path�
absolute_path�get_modified_time�modified� set_headers�should_return_304ry r8 r[ rZ r
Z_parse_request_range�get_content_sizer� Z_get_content_range� get_contentr� r� r� r0 r rf r* ) r0 r� r9 r? Z
request_rangeZ range_header�sizer �endr? �contentr� r1 r1 r2 rZ 1 st � �
��
��zStaticFileHandler.getc C s | � | j�}|s
dS d|f 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
Nr� )�_get_cached_versionr? )r0 � version_hashr1 r1 r2 r� } s
z StaticFileHandler.compute_etagc C s� | � dd� | �� | jdur| � d| j� | �� }|r"| � d|� | �| j| j|�}|dkrH| � dtj�� tj|d� � | � d d
t |� � | �
| j� dS ) z]Sets the content and caching headers on the response.
.. versionadded:: 3.1
z
Accept-Rangesr� Nr� rh r ZExpires)�secondsz
Cache-Controlzmax-age=) r� r9 rA �get_content_type�get_cache_timer� r� r� r� r� �set_extra_headers)r0 � content_typeZ
cache_timer1 r1 r2 rB � s
�
�z StaticFileHandler.set_headersc C sZ | � � rdS | jj�d�}|dur+tj�|�}|dur+tj|dd� � }|| jkr+dS dS )zgReturns True if the headers indicate that we should return 304.
.. versionadded:: 3.1
TzIf-Modified-SinceN� F) r: r8 r[ rZ �email�utils� parsedater� rA )r0 Z ims_valueZ
date_tupleZif_sincer1 r1 r2 rC � s
z#StaticFileHandler.should_return_304c 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� r5 r� rT r1 r1 r2 r= � s z#StaticFileHandler.get_absolute_pathc C s� t j�|�}|�t jj�s|t jj7 }|t jj �|�s#tdd| j��t j�|�rJ| jdurJ| j j�d�sB| j
| j jd dd� dS t j� || j�}t j� |�sTtd��t j�
|�satdd| 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� Tr� r� z%s is not a file)r r� rT r� �sepr] rU �isdirr6 r8 r� r� �exists�isfile)r0 r5 r? r1 r1 r2 r> � s$ �
z(StaticFileHandler.validate_absolute_pathc 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�readr7 )r� rT r rG �file� remainingZ
chunk_sizer� r1 r1 r2 rE � 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 hash of the file's contents.
.. versionadded:: 3.1
)rE r� �md5r� r� r r� )r� rT r% r� r� r1 r1 r2 �get_content_version!
s
� z%StaticFileHandler.get_content_versionc C s t | d�s t�| j�| _| jS )N� _stat_result)r� r �statr? ra r/ r1 r1 r2 �_stat3
s
zStaticFileHandler._statc C s | � � }|tj S )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.
)rc rb �ST_SIZE)r0 � stat_resultr1 r1 r2 rD 8
s
z"StaticFileHandler.get_content_sizec C s | � � }tj�|tj �}|S )z�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
)rc r� �utcfromtimestamprb �ST_MTIME)r0 re rA r1 r1 r2 r@ F
s
�z#StaticFileHandler.get_modified_timec C s8 t �| j�\}}|dkrdS |durdS |dur|S dS )zhReturns the ``Content-Type`` header to be used for this request.
.. versionadded:: 3.1
r� zapplication/gzipNzapplication/octet-stream)� mimetypesZ
guess_typer? )r0 � mime_type�encodingr1 r1 r2 rL S
s z"StaticFileHandler.get_content_typec C rN )z1For subclass to add extra headers to the responseNr1 r: r1 r1 r2 rN g
s z#StaticFileHandler.set_extra_headersc 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 )r8 r� �
CACHE_MAX_AGE)r0 r� rA ri r1 r1 r2 rM k
s z StaticFileHandler.get_cache_timec C s8 |� dd�| }|s |S | �||�}|s|S d||f 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%s?v=%s)rZ � get_version)r� rP r� Zinclude_versionr� rJ r1 r1 r2 r� x
s z!StaticFileHandler.make_static_urlc 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� rU r( )r0 Zurl_pathr1 r1 r2 r< �
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� )r= rI )r� rP r� �abs_pathr1 r1 r2 rl �
s
z StaticFileHandler.get_versionc 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)r7 r8 r` r� r rC rZ )r� rm ZhashesZhshr1 r1 r2 rI �
s$ �
�
� � z%StaticFileHandler._get_cached_versionr* r� )NN)!r� r� r� r� rk r8 r� r� r7 rJ � classmethodr& rX r r� rZ r� rB rC r= r> rE r` rc rD r@ rL rN rM r� r< rl rI r1 r1 r1 r2 r� � sD A
K
4 $
r� c @ s e Zd ZdZdd� Zdd� ZdS )�FallbackHandleraM 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),
])
c C rO r* )�fallback)r0 rp r1 r1 r2 rJ �
r- zFallbackHandler.initializec C s | � | j� d| _d S r� )rp r8 r: r/ r1 r1 r2 r` �
s
zFallbackHandler.prepareN)r� r� r� r� rJ r` r1 r1 r1 r2 ro �
s ro c @ r, ) �OutputTransformz�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.
c C r. r* r1 �r0 r8 r1 r1 r2 r6 �
� zOutputTransform.__init__c C s
|||fS r* r1 )r0 rw r[ r� � finishingr1 r1 r2 r) �
rQ z%OutputTransform.transform_first_chunkc C s |S r* r1 �r0 r� rt r1 r1 r2 r+ �
rs z OutputTransform.transform_chunkN)r� r� r� r� r6 r) r+ r1 r1 r1 r2 rq �
s
rq c @ sD e Zd ZdZeg d��ZdZdZdd� Zdd� Z d d
� Z
d d � Z d
S )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/javascriptzapplication/x-javascriptzapplication/xmlzapplication/atom+xmlzapplication/jsonzapplication/xhtml+xmlz
image/svg+xmlrP i c C s d|j �dd�v | _d S )Nr� �Accept-Encodingr� )r[ rZ � _gzippingrr r1 r1 r2 r6 � z GZipContentEncoding.__init__c C s |� d�p || jv S )Nztext/)r] �
CONTENT_TYPES)r0 �ctyper1 r1 r2 �_compressible_type � z&GZipContentEncoding._compressible_typec 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-Encodingrv rh r� rT r r� r� �w)�mode�fileobj�
compresslevelr6 )rw r rZ r\ r{ r7 �
MIN_LENGTHr � _gzip_valuer� �GzipFile�
GZIP_LEVEL�
_gzip_filer+ r� )r0 rw r[ r� rt rz r1 r1 r2 r) s,
��
�
z)GZipContentEncoding.transform_first_chunkc C sR | j r'| j�|� |r| j�� n| j�� | j�� }| j�d� | j�d� |S )Nr ) rw r� r� �closer0 r� �getvalue�truncater[ ru r1 r1 r2 r+ , s
z#GZipContentEncoding.transform_chunkN) r� r� r� r� r ry r� r� r6 r{ r) r+ r1 r1 r1 r2 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.
c s� | j s7| jjdv r3| �� }d|vr,t�|�jr | j�� }n| jj}|dt t
|d�� 7 }| � |� d S t d��� | g|�R i |��S )Nr1 r� )�nextr~ )
r r8 r* re �urlparse�urlsplit�schemeZfull_urlr� r r� r� rU )r0 rW rK r� Znext_urlr� r1 r2 r� D s
z authenticated.<locals>.wrapperr� r� r1 r� r2 �
authenticated9 s r� c @ sd e Zd ZdZdd� Zedd� �Zdd� Zdd � Zd
d � Z d d
� Z
dd� Z dd� Z dd� Z
dd� 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.
c C s" || _ |j| _|j| _|j| _d S r* )r r8 rC r �r0 r r1 r1 r2 r6 ` s zUIModule.__init__c C rO r* )r r r/ r1 r1 r2 r f s zUIModule.current_userc O r� )z6Override in subclasses to return this module's output.r� rV r1 r1 r2 r� j r{ zUIModule.renderc C rN )zJOverride to return a JavaScript string
to be embedded in the page.Nr1 r/ r1 r1 r2 r� n � z UIModule.embedded_javascriptc C rN )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.
Nr1 r/ r1 r1 r2 r� s � zUIModule.javascript_filesc C rN )zJOverride to return a CSS string
that will be embedded in the page.Nr1 r/ r1 r1 r2 r� { r� zUIModule.embedded_cssc C rN )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.
Nr1 r/ r1 r1 r2 r� � r� zUIModule.css_filesc C rN )z[Override to return an HTML string that will be put in the <head/>
element.
Nr1 r/ r1 r1 r2 r� � r/ zUIModule.html_headc C rN )zfOverride to return an HTML string that will be put at the end of
the <body/> element.
Nr1 r/ r1 r1 r2 r� � r/ zUIModule.html_bodyc K s | j j|fi |��S )z.Renders a template and returns it as a string.)r r� )r0 r� rK r1 r1 r2 r� � r� zUIModule.render_stringN)r� r� r� r� r6 r� r r� r� r� r� r� r� r� r� r1 r1 r1 r2 r W s
r c @ � e Zd Zdd� ZdS )r� c K s t j|fi |��S r* )r r� )r0 �textrK r1 r1 r2 r� � s z_linkify.renderN�r� r� r� r� r1 r1 r1 r2 r� � � r� c @ r� )r� c C s
| j �� S r* )r r# r/ r1 r1 r2 r� � r- z_xsrf_form_html.renderNr� r1 r1 r1 r2 r� � r� r� c s` e Zd ZdZ� fdd�Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z � Z
S )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.
c s t t| ��|� g | _i | _d S r* )r5 r� r6 �_resource_list�_resource_dictr� rL r1 r2 r6 � s
zTemplateModule.__init__c s$ � �fdd�}�j � fd|i|��S )Nc s> � �j vr�j�| � | �j � < dS �j � | kr td��dS )NzCset_resources called with different resources for the same templater� )r� r� r� rv )rK �r� r0 r1 r2 �
set_resources� s
�z,TemplateModule.render.<locals>.set_resourcesr� )r� )r0 r� rK r� r1 r� r2 r� � s �zTemplateModule.renderc s � fdd�| j D �S )Nc 3 s � | ] }� |v r|� V qd S r* r1 )r, �r�rW r1 r2 r3 � s � z0TemplateModule._get_resources.<locals>.<genexpr>)r� �r0 rW r1 r� r2 �_get_resources� r| z TemplateModule._get_resourcesc C � d� | �d��S )N�
r� �r� r� r/ r1 r1 r2 r� � r z"TemplateModule.embedded_javascriptc C �< g }| � d�D ]}t|ttf�r|�|� q|�|� q|S )Nr� �r� r� r r� r� r� �r0 r� r� r1 r1 r2 r� � � z TemplateModule.javascript_filesc C r� )Nr� r� r� r/ r1 r1 r2 r� � r zTemplateModule.embedded_cssc C r� )Nr� r� r� r1 r1 r2 r� � r� zTemplateModule.css_filesc C r� )Nr� r� r� r/ r1 r1 r2 r� � r zTemplateModule.html_headc C r� )Nr� r� r� r/ r1 r1 r2 r� � r zTemplateModule.html_body)r� r� r� r� r6 r� r� r� r� r� r� r� r� r� r1 r1 rL r2 r� � s
r� c @ r, ) rD zALazy namespace which creates UIModule proxies bound to a handler.c C r1 r* )r rE )r0 r rE r1 r1 r2 r6 � r4 z_UIModuleNamespace.__init__c C s | j �|| j| �S r* )r r� rE r� r1 r1 r2 � __getitem__� r| z _UIModuleNamespace.__getitem__c
C s0 z| | W S t y } ztt|���d }~ww r* )ru �AttributeErrorr� )r0 rW r� r1 r1 r2 � __getattr__� s
��z _UIModuleNamespace.__getattr__N)r� r� r� r� r6 r� r� r1 r1 r1 r2 rD � s
rD �compare_digestc C s~ t | �t |�kr
dS d}t| d t�r't| |�D ]
\}}|||A O }q|dkS t| |�D ]\}}|t|�t|�A O }q,|dkS )NFr )r7 r� r� �zip�ord)�a�br� r� �yr1 r1 r2 r � s �r c
C s� |d u rt }|d u r
tj}ttt|� ���}t�t|��}|dkr2t| |||�}d�|||g�}|S |dkrsdd� }d�d|t|pBd��||�||�||�dg�} t | t
�rj|d us^J d ��|dksfJ d
��| | } t | | �}| | S t d | ��) Nr! rh r" c S s t dt| � �t | � S )Nz%d:)r r7 )�sr1 r1 r2 � format_field# rx z)create_signed_value.<locals>.format_fieldri 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_VERSIONrn r r� r� �base64� b64encode�_create_signature_v1r� r� r� �_create_signature_v2rv )
r� r~ r rl �clockr� rp � signaturer� Zto_signr1 r1 r2 r� s6 �
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� )rx ry r� rz rv )r r. rl r1 r1 r2 � _get_version= s
��
��r� r� c C s� |d u rt j }|d u r
t}|dkrtd| ��|sd S t|�}t|�}||k r)d S |dkr5t| ||||�S |dkrAt| ||||�S d S )Nr" zUnsupported min_version %dr! )rn � DEFAULT_SIGNED_VALUE_MIN_VERSIONrv r r� �_decode_signed_value_v1�_decode_signed_value_v2)r� r~ r r� r� r� rl r1 r1 r2 r� T s* ��r� c C s� t |��d�}t|�dkrd S t| ||d |d �}t|d |�s)t�d|� d S t|d �}||� |d k r@t�d|� d S ||� d krOt�d
|� d S |d �d �r^t�d |� d S zt �
|d �W S t yp Y d S w )
Nrh � r r! r" zInvalid cookie signature %r�Q zExpired cookie %ri��( z1Cookie timestamp in future; possible tampering %r� 0zTampered cookie %r) r r\ r7 r� r r r� r� r] r� � b64decoder� )r� r~ r r� r� rb r� rp r1 r1 r2 r� n s0 � �r� c C sV dd� }| dd � }||�\}}||�\}}||�\}}||�\}}t |�||||fS )Nc S sX | � d�\}}}t|�}|d |� }|||d � dkr td��||d d � }||fS )N� :r! rh z malformed v2 signed value field)� partitionr� rv )r� �lengthr! �restr- Z field_valuer1 r1 r2 �_consume_field� s z)_decode_fields_v2.<locals>._consume_fieldr" )r� )r r� r� r� rp �
name_field� value_field�
passed_sigr1 r1 r2 �_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| | �sAd S |t|�krId S t |�}||� |d k rXd S zt
� |�W S t yh Y d S w )Nr� )
r� rv r7 r� r� ru r� r r r� r� r� r� ) r� r~ r r� r� r� rp r� r� r� Z
signed_stringZ expected_sigr1 r1 r2 r� � s2 �
�
�r� c C sJ t | �} t| �}|dk rd S z t| �\}}}}}W |S ty$ Y d S w )Nr" )r r� r� rv )r rl r� r! r1 r1 r2 r� � s ��r� c G s8 t jt| �tjd�}|D ] }|�t|�� q t|�� �S �N)Z digestmod)�hmac�newr r� r� r r� )r� rb �hashr8 r1 r1 r2 r� � s r� c C s. t jt| �tjd�}|�t|�� t|�� �S r� )r� r� r r� �sha256r r� )r� r� r� r1 r1 r2 r� � s r� c s t � fdd�dD ��S )Nc 3 s � | ]}� � |�V qd S r* r� )r, r� �r� r1 r2 r3 � s � z is_absolute.<locals>.<genexpr>)r� zhttp:zhttps:)�anyr� r1 r� r2 r � s r rt )r� NN)zr� Z
__future__r r r r� rl r� � email.utilsrQ r� r� r� r� rh r� Zos.pathr r� rb r
r� rn rI r �inspectr �ior r rj Zsalt.ext.tornado.concurrentr r r r
r r Zsalt.ext.tornado.logr
r r r r Zsalt.ext.tornado.escaper r Zsalt.ext.tornado.routingr r r r r r r Zsalt.ext.tornado.utilr r r r r r� Z http.cookiesr� r� � urllib.parse�parser� r �urllib�typing�Unionr� r� Z _HeaderTypes� ImportErrorZ"MIN_SUPPORTED_SIGNED_VALUE_VERSIONZ"MAX_SUPPORTED_SIGNED_VALUE_VERSIONr� r� r� r# r� r� rc r� r� r� r� ZHTTPMessageDelegater r� rU r� r� r r0 r� ro rq r� r� r r� r� r� rD r� r� r r� r� rx r� r� r� r� r� r� r� r� r r1 r1 r1 r2 �<module> s� + $
�� CM
F($ iK BD
�
3
�