File: //opt/saltstack/salt/lib/python3.10/site-packages/cherrypy/lib/__pycache__/cptools.cpython-310.pyc
o
�N�gj[ � @ s8 d Z ddlZddlZddlmZ ddlZddlZddlm Z ddl
m Z ddl
m
Z
d7dd �Zd
d � Zd8d d
�Z d9dd�Zd:dd�Zd8dd�Zde_ d;dd �ZG d d � d e�Zd d � Zejdfd!d"�Zd<d#d$�Zd<d%d&�Z d=d(d)�Z d>d*d+�Z d<d,d-�Z d8d.d/�Z G d0d1� d1e j!�Z"d8d2d3�Z#e$d4fd5d6�Z%dS )?z%Functions for builtin CherryPy tools.� N)�md5)�
text_or_bytes)�httputil)� is_iteratorFc C s� t jj}t|d�r dS t�|j�\}}}|j�d�}|r'|r&t � d| d� n3| s2|r1t � dd� n(|dkr?|r>t � dd� n|�
� }dt |�� � }|rUt � d | d� ||jd< ||_
|rgt � d
| d� |dkr�|d kr�t jj}|j�d �pzg }d
d� |D �}|r�t � dt|� d� |r�|dgks�||v s�t �dd||f ��|j�d�p�g }dd� |D �}|r�t � dt|� d� |dgks�||v r�|r�t � d|j d� |jdv r�t �g d��t �dd||f ��dS dS dS )a Validate the current ETag against If-Match, If-None-Match headers.
If autotags is True, an ETag response-header value will be provided
from an MD5 hash of the response body (unless some other code has
already provided an ETag header). If False (the default), the ETag
will not be automatic.
WARNING: the autotags feature is not designed for URL's which allow
methods other than GET. For example, if a POST to the same URL returns
no content, the automatic ETag will be incorrect, breaking a fundamental
use for entity tags in a possibly destructive fashion. Likewise, if you
raise 304 Not Modified, the response body will be empty, the ETag hash
will be incorrect, and your application will break.
See :rfc:`2616` Section 14.24.
�ETagNzETag already set: %sz TOOLS.ETAGSz Autotags off�� zStatus not 200z"%s"zSetting ETag: %sz
Status: %s�+ zIf-Matchc S � g | ]}t |��qS � ��str��.0�xr
r
�H/opt/saltstack/salt/lib/python3.10/site-packages/cherrypy/lib/cptools.py�
<listcomp>F � z"validate_etags.<locals>.<listcomp>zIf-Match conditions: %s�*� z)If-Match failed: ETag %r did not match %rz
If-None-Matchc S r r
r r
r
r
r r O r z If-None-Match conditions: %szrequest.method: %s��GET�HEAD�0 z(If-None-Match failed: ETag %r matched %r)�cherrypy�serving�response�hasattr� _httputil� valid_status�status�headers�get�logZ
collapse_bodyr � hexdigestr �request�elements�repr� HTTPError�method� HTTPRedirect) Zautotags�debugr r �reason�msgZetagr$ Z
conditionsr
r
r �validate_etags sr
� � �
�����
��r- c C s� t jj} | j�d�}|r^t�| j�\}}}t jj}|j�d�}|r6||kr6|dkr-|dks1|dkr6t � d��|j�d�}|r`||krb|dkrJ|dksN|dkrd|j
dv rYt � g d��t � d��d S d S d S d S )
z�Validate the current Last-Modified against If-Modified-Since headers.
If no code has set the Last-Modified response header, then no validation
will be performed.
z
Last-ModifiedzIf-Unmodified-Sincer r r zIf-Modified-Sincer r N) r r r r r! r r r r$ r' r( r) )r Zlastmodr r+ r, r$ Zsincer
r
r �validate_since^ s$
� r. c C s� t | ttf�s
| g} dd� | D �} | sddg} n
d| v r%d| vr%| �d� d�| �tjjd< tjj | vrG|rBt�
dtjj | f d� t� d ��|rWt�
d
tjj | f d� d S d S ) a� Raise 405 if request.method not in methods (default ['GET', 'HEAD']).
The given methods are case-insensitive, and may be in any order.
If only one method is allowed, you may supply a single string;
if more than one, supply a list of strings.
Regardless of whether the current method is allowed or not, this
also emits an 'Allow' response header, containing the given methods.
c S s g | ]}|r|� � �qS r
)�upper)r �mr
r
r r � s zallow.<locals>.<listcomp>r r �, �Allowz#request.method %r not in methods %rz TOOLS.ALLOW� z request.method %r in methods %rN) �
isinstance�tuple�list�append�joinr r r r$ r( r" r' )�methodsr* r
r
r �allow{ s.
��
���r: �X-Forwarded-Host�X-Forwarded-For�X-Forwarded-Protoc
C sL t jj}|r(|j�|d�}|rt �d||f d� |dkr&d|�� v r&d}n|}|s5|jd|j�d�� }|rU|j�|d�}|rJt �d||f d� |durU|� d �d
} | sft
j � |j�j
}|j�d |�} | �d�d krs|d | } | |_|r�|j�|�} |r�t �d
|| f d� | r�|dkr�tdd� | � d �D ��} | |j_dS dS dS )a� Change the base URL (scheme://host[:port][/path]).
For running a CP server behind Apache, lighttpd, or other HTTP server.
For Apache and lighttpd, you should leave the 'local' argument at the
default value of 'X-Forwarded-Host'. For Squid, you probably want to set
tools.proxy.local = 'Origin'.
If you want the new request.base to include path info (not just the host),
you must explicitly set base to the full base path, and ALSO set 'local'
to '', so that the X-Forwarded-Host request header (which never includes
path info) does not override it. Regardless, the value for 'base' MUST
NOT end in a slash.
cherrypy.request.remote.ip (the IP address of the client) will be
rewritten if the header specified by the 'remote' arg is valid.
By default, 'remote' is set to 'X-Forwarded-For'. If you do not
want to rewrite remote.ip, set the 'remote' arg to an empty string.
NzTesting scheme %r:%rz TOOLS.PROXY�on�ssl�httpsz://zTesting local %r:%r�,r �Host���zTesting remote %r:%rr< c s s � | ]}|� � V qd S �N)�strip)r �ipr
r
r � <genexpr>� s � zproxy.<locals>.<genexpr>)r r r$ r r! r" �lower�base�find�split�urllib�parse�urlparse�netloc�next�remoterF )
rI �localrQ �schemer* r$ �sZlbase�defaultZxffr
r
r �proxy� s@ �rV �ZRangec C s< t jj}| D ]}||jv r|rt �d| d� |j|= qdS )a Delete request headers whose field names are included in 'headers'.
This is a useful tool for working behind certain HTTP servers;
for example, Apache duplicates the work that CP does for 'Range'
headers, and will doubly-truncate the response.
zIgnoring request header %rzTOOLS.IGNORE_HEADERSN)r r r$ r r" )r r* r$ �namer
r
r �ignore_headers� s
���rY c C s< |r t �dt| � d� | pg D ] \}}|t jjj|< qdS )z Set headers on the response.z Setting response headers: %szTOOLS.RESPONSE_HEADERSN)r r" r& r r r )r r* rX �valuer
r
r �response_headers� s ��r[ T� �Forbidden Referer header.c C s� z$t jjjd }tt�| |��}|r t �d|| f d� ||kr#W dS W n ty: |r3t �dd� |r8Y dS Y nw t � ||��)a� Raise HTTPError if Referer header does/does not match the given pattern.
pattern
A regular expression pattern to test against the Referer.
accept
If True, the Referer must match the pattern; if False,
the Referer must NOT match the pattern.
accept_missing
If True, permit requests with no Referer header.
error
The HTTP error code to return to the client on failure.
message
A string to include in the response body on failure.
ZRefererzReferer %r matches %rz
TOOLS.REFERERNzNo Referer header)
r r r$ r �bool�re�matchr" �KeyErrorr' )�pattern�acceptZaccept_missing�error�messager* �refr` r
r
r �referer� s$ �� �� rg c @ sz e Zd ZdZdZdZdd� Zdd� Zdd � Zd
d � Z d d
� Z
d dd�Z d dd�Z d dd�Z
dd� Zi fdd�Zdd� Zd S ) � SessionAuthz"Assert that the user is logged in.�usernameFc C � d S rD r
)�selfri �passwordr
r
r �check_username_and_password" � z'SessionAuth.check_username_and_passwordc C s dS )z2Provide a temporary user name for anonymous users.Nr
�rk r
r
r � anonymous% s zSessionAuth.anonymousc C rj rD r
�rk ri r
r
r �on_login) rn zSessionAuth.on_loginc C rj rD r
rq r
r
r � on_logout, rn zSessionAuth.on_logoutc C rj rD r
rq r
r
r �on_check/ rn zSessionAuth.on_check�..� c K s t d�t� �d�S )Nas <html><body>
Message: %(error_msg)s
<form method="post" action="do_login">
Login: <input type="text" name="username" value="%(username)s" size="10" />
<br />
Password: <input type="password" name="password" size="10" />
<br />
<input type="hidden" name="from_page" value="%(from_page)s" />
<br />
<input type="submit" />
</form>
</body></html>zutf-8)r �vars�encode)rk � from_pageri � error_msg�kwargsr
r
r � login_screen2 s
� �zSessionAuth.login_screenc K sp t jj}| �||�}|r!| �|||�}||_d|jv r |jd= dS |t jj_|t j | j
< | � |� t � |p6d��)z=Login. May raise redirect, or return True if request handled.�Content-LengthT�/)
r r r rm r| �bodyr r$ �login�session� session_keyrr r) )rk ri rl ry r{ r rz r r
r
r �do_loginA s
zSessionAuth.do_loginc K s> t j}|�| j�}d|| j< |rdt jj_| �|� t �|��)z>Logout. May raise redirect, or return True if request handled.N) r r� r! r� r r$ r� rs r) )rk ry r{ �sessri r
r
r � do_logoutR s
zSessionAuth.do_logoutc C s� t j}t jj}t jj}|�| j�}|s!| �� || j< }| �d� |sBt j |j
d�}| �dt � � | � |�|_
d|jv r@|jd= dS | �dt � � ||_| �|� dS )zLAssert username. Raise redirect, or return True if request handled.
z&No session[username], trying anonymous)�qsz;No username, routing to login_screen with from_page %(url)rr} Tz%Setting request.login to %(username)rN)r r� r r$ r r! r� rp �_debug_message�url� query_string�localsr| r r r� rt )rk r� r$ r ri r� r
r
r �do_check\ s(
�
zSessionAuth.do_checkc C s | j sd S t�|| d� d S )NzTOOLS.SESSAUTH)r* r r" )rk �template�contextr
r
r r� v s zSessionAuth._debug_messagec C s� t jj}t jj}|j}|�d�r | �dt� � | �� |_ dS |�d�rG|j
dkr7d|j d< | �d� t � d��| �d t� � | j
d
i |j��S |�d
�rk|j
dkr[d|j d< t � d��| �d t� � | jd
i |j��S | �d � | �� S )Nr| z routing %(path)r to login_screenTr� �POSTr2 zdo_login requires POSTr3 z routing %(path)r to do_loginr� z routing %(path)r to do_logoutz!No special path, running do_checkr
)r r r$ r � path_info�endswithr� r� r| r r( r r' r� �paramsr� r� )rk r$ r �pathr
r
r �run{ s,
zSessionAuth.runN)ru rv rv )ru )�__name__�
__module__� __qualname__�__doc__r� r* rm rp rr rs rt r| r� r� r� r� r� r
r
r
r rh s
rh c K sH dd� dd� tt�D �� t� }| �� D ]
\}}t|||� q|�� S )Nz�Session authentication hook.
Any attribute of the SessionAuth class may be overridden
via a keyword arg to this function:
z
c s s2 � | ]}|� d �sd�|ttt|��j�V qdS )�__z
{!s}: {!s}N)�
startswith�format�type�getattrrh r� )r �kr
r
r rG � s � �
�z session_auth.<locals>.<genexpr>)r8 �dirrh �items�setattrr� )r{ �sar� �vr
r
r � session_auth� s
��
r� c C s t jdd| dd� dS )z;Write the last error's traceback to the cherrypy error log.rv �HTTPT)�severity� tracebackN)r r" )r� r* r
r
r �
log_traceback� s r� c C s. dd� t jjjD �}t �dd�|� d� dS )z0Write request headers to the cherrypy error log.c S s g | ]
\}}d ||f �qS )z %s: %sr
)r r� r� r
r
r r � s z'log_request_headers.<locals>.<listcomp>z
Request Headers:
�
r� N)r r r$ Z header_listr" r8 )r* �hr
r
r �log_request_headers� s r� c C s� t jj}g }ddl m} |j}|j�� D ] }||vr |�|� q|D ] }|�d| � |j�|g �}|� � |D ] }|�d| � q8q"t �
dt � � d d� |� d� d S )
z.Write request.hooks to the cherrypy error log.r )�
_cprequestz %s:z
%rz
Request Hooks for z:
r� r� N)
r r r$ r� Z
hookpoints�hooks�keysr7 r! �sortr" r� r8 )r* r$ r, r� Zpointsr� r� r� r
r
r � log_hooks� s,
�����r� rv c C s: |rt �dddd�| | f d� |rt �| ��t �| ��)z8Raise InternalRedirect or HTTPRedirect to the given url.zRedirecting %sto: %sz internal rv )TFzTOOLS.REDIRECT)r r" ZInternalRedirectr) )r� Zinternalr* r
r
r �redirect� s ��
r� c C s� t jj}|j}|rt �d|j| ||f d� |jdu r8| r4|�d�s6t �|d |j�}t j ||p1dd��dS dS |jdu r\|r^|�d�r`|dkrbt �|dd � |j�}t j ||pYdd��dS dS dS dS )
z9Redirect if path_info has (missing|extra) trailing slash.z3is_index: %r, missing: %r, extra: %r, path_info: %rzTOOLS.TRAILING_SLASHTr~ i- )r FNrC )
r r r$ r� r" Zis_indexr� r� r� r) )�missing�extrar r* r$ �piZnew_urlr
r
r �trailing_slash� s. ��
�
�r� c s& � �fdd��t jj}�|j�|_dS )z�Wrap response.body in a generator that recursively iterates over body.
This allows cherrypy.response.body to consist of 'nested generators';
that is, a set of generators that yield generators.
c 3 s` � d}| D ] }t |�s|d7 }|V q�|�D ] }|d7 }|V qq� r.t�d| d� d S d S )Nr � zFlattened %d chunksz
TOOLS.FLATTEN)r r r" )�inputZ numchunksr �y�r* � flattenerr
r r� � s � ��zflatten.<locals>.flattenerN)r r r r )r* r r
r� r �flatten� s r� c C s> | sdS t | t�r | g} tjj}|j�d�}|s$|r t�dd� | d S |D ]X}|jdkr~|j dkr@|r:t�dd� | d S |j �
d�ri|j dd � }| D ]}|� |�rg|rat�d
|j d� | S qOq&|j | v r~|ryt�d
|j d� |j S q&|j� d�}|du r�d }nd | }|d
d�
| � 7 }t�d|��)ap Return the client's preferred media-type (from the given Content-Types).
If 'media' is None (the default), no test will be performed.
If 'media' is provided, it should be the Content-Type value (as a string)
or values (as a list or tuple of strings) which the current resource
can emit. The client's acceptable media ranges (as declared in the
Accept request header) will be matched in order to these Content-Type
values; the first such string is returned. That is, the return value
will always be one of the strings provided in the 'media' arg (or None
if 'media' is None).
If no match is found, then HTTPError 406 (Not Acceptable) is raised.
Note that most web browsers send */* as a (low-quality) acceptable
media range, which should match any Content-Type. In addition, "...if
no Accept header field is present, then it is assumed that the client
accepts all media types."
Matching types are checked in order of client preference first,
and then in the order of the given 'media' values.
Note that this function does not honor accept-params (other than "q").
NZAcceptzNo Accept header elementsz TOOLS.ACCEPTr z*/*zMatch due to */*z/*rC zMatch due to %sz*Your client did not send an Accept header.z(Your client sent this Accept header: %s.z4 But this resource only emits these media types: %s.r1 i� )r4 r r r r$ r r% r" ZqvaluerZ r� r� r! r8 r' ) Zmediar* r$ Zranges�elementZmtyper0 Zahr, r
r
r rc sT
� ��
�
� � rc c s( e Zd Z� fdd�Z� fdd�Z� ZS )�MonitoredHeaderMapc s | j �|� tt| ��|�S rD )�accessed_headers�add�superr� �
transform_key)rk �key�� __class__r
r r� M s z MonitoredHeaderMap.transform_keyc s t � | _tt| ��� d S rD )�setr� r� r� �__init__ro r� r
r r� Q s zMonitoredHeaderMap.__init__)r� r� r� r� r� �
__classcell__r
r
r� r r� K s r� c sZ t jj��j}t� �_�j�|� �du rtg d���� ��fdd�}�j�d|d� dS )zKAuto-populate the Vary response header based on request.header access.
N)zContent-Dispositionr} z Content-Typec st t jjj} tdd� | �d�D ��}� r t �d�jj d� |��jj�}|� ��}t
|�}|� � d� |�| d< d S )Nc S s g | ]}|j �qS r
)rZ )r �er
r
r r c s z9autovary.<locals>.set_response_header.<locals>.<listcomp>ZVaryzAccessed headers: %szTOOLS.AUTOVARYr1 )
r r r r r� r% r" r� �union�
differencer6 r� r8 )Zresp_hr� �r* �ignorer$ r
r �set_response_headera s
�
z%autovary.<locals>.set_response_headerZbefore_finalize�_ ) r r r$ r r� �updater� r� �attach)r� r* Zreq_hr� r
r� r �autovaryV s r� i� c C st t jj}|jjj}t j�| |�� t|�� |j
�D ]}|| |j
| �|j
|< qW d � dS 1 s3w Y dS )z�Convert request params based on function annotations, with error handling.
exception
Exception class to catch.
status
The HTTP error code to return to the client on failure.
N) r r r$ �handler�callable�__annotations__r' �handler� � intersectionr� )� exceptionrd r$ �typesr� r
r
r �convert_paramsp s
�"�r� )FF)NF)Nr; r< r= F)rW F)TFr\ r] F)F)rv TF)TFNF)&r� �loggingr_ �hashlibr � urllib.parserL r Zcherrypy._cpcompatr Z cherrypy.libr r r r- r. r: rV rY r[ Zfailsaferg �objectrh r� �ERRORr� r� r� r� r� r� rc Z HeaderMapr� r� �
ValueErrorr� r
r
r
r �<module> sB
N
�
@
�&{
K