o

�N�gZ�@s,
dZd
dl
Z
d
dlZd
dlZd
dlmZ
d
dlm	Z

d
dlmZ
d
dl
Z
d
dlmZ
d
dlZd
dlmZ
d
dlmZ
d
d	lmZ
d
d
lmZ
Gdd�de�ZGd
d�de�ZGdd�de�Zdd�ZGdd�de�ZGdd�de�ZdZ dd�Z!dddddddddddd�Z"dd�Z#d#dd �
Z$d#d!d"�
Z%dS)$aAException classes for CherryPy.

CherryPy provides (and uses) exceptions for declaring that the HTTP response
should be a status other than the default "200 OK". You can ``raise`` them like
normal Python exceptions. You can also call them and they will raise
themselves; this means you can set an
:class:`HTTPError<cherrypy._cperror.HTTPError>`
or :class:`HTTPRedirect<cherrypy._cperror.HTTPRedirect>` as the
:attr:`request.handler<cherrypy._cprequest.Request.handler>`.

.. _redirectingpost:

Redirecting POST
================

When you GET a resource and are redirected by the server to another Location,
there's generally no problem since GET is both a "safe method" (there should
be no side-effects) and an "idempotent method" (multiple calls are no different
than a single call).

POST, however, is neither safe nor idempotent--if you
charge a credit card, you don't want to be charged twice by a redirect!

For this reason, *none* of the 3xx responses permit a user-agent (browser) to
resubmit a POST on redirection without first confirming the action with the
user:

=====    =================================    ===========
300      Multiple Choices                     Confirm with the user
301      Moved Permanently                    Confirm with the user
302      Found (Object moved temporarily)     Confirm with the user
303      See Other                            GET the new URI; no confirmation
304      Not modified                         for conditional GET only;
                                              POST should not raise this error
305      Use Proxy                            Confirm with the user
307      Temporary Redirect                   Confirm with the user
308      Permanent Redirect                   No confirmation
=====    =================================    ===========

However, browsers have historically implemented these restrictions poorly;
in particular, many browsers do not force the user to confirm 301, 302
or 307 when redirecting POST. For this reason, CherryPy defaults to 303,
which most user-agents appear to have implemented correctly. Therefore, if
you raise HTTPRedirect for a POST request, the user-agent will most likely
attempt to GET the new URI (without asking for confirmation from the user).
We realize this is confusing for developers, but it's the safest thing we
could do. You are of course free to raise ``HTTPRedirect(uri, status=302)``
or any other 3xx status if you know what you're doing, but given the
environment, we couldn't let any of those be the default.

Custom Error Handling
=====================

.. image:: /refman/cperrors.gif

Anticipated HTTP responses
--------------------------

The 'error_page' config namespace can be used to provide custom HTML output for
expected responses (like 404 Not Found). Supply a filename from which the
output will be read. The contents will be interpolated with the values
%(status)s, %(message)s, %(traceback)s, and %(version)s using plain old Python
`string formatting
<http://docs.python.org/2/library/stdtypes.html#string-formatting-operations>`_.

::

    _cp_config = {
        'error_page.404': os.path.join(localDir, "static/index.html")
    }


Beginning in version 3.1, you may also provide a function or other callable as
an error_page entry. It will be passed the same status, message, traceback and
version arguments that are interpolated into templates::

    def error_page_402(status, message, traceback, version):
        return "Error %s - Well, I'm very sorry but you haven't paid!" % status
    cherrypy.config.update({'error_page.402': error_page_402})

Also in 3.1, in addition to the numbered error codes, you may also supply
"error_page.default" to handle all codes which do not have their own error_page
entry.



Unanticipated errors
--------------------

CherryPy also has a generic error handling mechanism: whenever an unanticipated
error occurs in your code, it will call
:func:`Request.error_response<cherrypy._cprequest.Request.error_response>` to
set the response status, headers, and body. By default, this is the same
output as
:class:`HTTPError(500) <cherrypy._cperror.HTTPError>`. If you want to provide
some other behavior, you generally replace "request.error_response".

Here is some sample code that shows how to display a custom error message and
send an e-mail containing the error::

    from cherrypy import _cperror

    def handle_error():
        cherrypy.response.status = 500
        cherrypy.response.body = [
            "<html><body>Sorry, an error occurred</body></html>"
        ]
        sendMail('error@domain.com',
                 'Error in your web app',
                 _cperror.format_exc())

    @cherrypy.config(**{'request.error_response': handle_error})
    class Root:
        pass

Note that you have to explicitly set
:attr:`response.body <cherrypy._cprequest.Response.body>`
and not simply return an error message as a result.
�N)
�exc_info)
�format_exception)
�saxutils)
�always_iterable)
�ntob)
�tonative)
�
classproperty)
�httputilc
@seZ
dZd
ZdS)�CherryPyExceptionz%A base class for CherryPy exceptions.N)�__name__�
__module__�__qualname__�__doc__�rr�E/opt/saltstack/salt/lib/python3.10/site-packages/cherrypy/_cperror.pyr
�s
r
c@seZ
dZd
Zddd�
ZdS)�InternalRedirecta3
Exception raised to switch to the handler for a different URL.

    This exception will redirect processing to another path within the site
    (without informing the client). Provide the new path as an argument when
    raising the exception. Provide any params in the querystring for the new
    URL.
    �cCsVtj
j|_||_d
|
vr|
�d
d�\}
|_tj�|jj|
�}
|
|_	t
�||
|j�
dS)N�
?�
)�cherrypy�serving�request�query_string�split�urllib�parse�urljoin�	path_info�pathr
�__init__)�selfrrrrrr�s


zInternalRedirect.__init__N)
r�rrr
rrrrrrr�src@sNeZ
dZd
ZdZ	dZ	ddd�
Zedd��
Ze	dd	��
Z
d
d�Zdd
�ZdS)�HTTPRedirecta�Exception raised when the request should be redirected.

    This exception will force a HTTP redirect to the URL or URL's you give it.
    The new URL must be passed as the first argument to the Exception,
    e.g., HTTPRedirect(newUrl). Multiple URLs are allowed in a list.
    If a URL is absolute, it will be used as-is. If it is relative, it is
    assumed to be relative to the current cherrypy.request.path_info.

    If one of the provided URL is a unicode object, it will be encoded
    using the default encoding or the one passed in parameter.

    There are multiple types of redirect, from which you can select via the
    ``status`` argument. If you do not provide a ``status`` arg, it defaults to
    303 (or 302 if responding with HTTP/1.0).

    Examples::

        raise cherrypy.HTTPRedirect("")
        raise cherrypy.HTTPRedirect("/abs/path", 307)
        raise cherrypy.HTTPRedirect(["path1", "path2?a=1&b=2"], 301)

    See :ref:`redirectingpost` for additional caveats.
    N�utf-8csj��
fd
d�t|
�
D�
�
_
}|du
rt|�
n�
j}d|k
r'dk
s,td�
�

td�
�
t��
||�
dS)Nc
s*g|]}
tj
�t��t|
�p�
j���qSr)rrrr�urlr�encoding)�.0r$�r%r rr�
<listcomp>�s
�

��z)HTTPRedirect.__init__.<locals>.<listcomp>�,
i�
z#status must be between 300 and 399.)r�urls�int�default_status�
ValueErrorr
r)r r*�statusr%Zabs_urlsrr'rr�s

���
�
zHTTPRedirect.__init__c

Cstj
jjd
kr	dSdS)a

        The default redirect status for the request.

        RFC 2616 indicates a 301 response code fits our goal; however,
        browser support for 301 is quite messy. Use 302/303 instead. See
        http://www.alanflavell.org.uk/www/post-redirect.html
        )rr�/
�.
)rrr�protocol)
�clsrrrr,�s	zHTTPRedirect.default_statusc
Cs|jd
d�\}
}|S)z%The integer HTTP status code to emit.N�)
�args)r �
_r.rrrr.�s
zHTTPRedirect.statusc
s

tj
j}
|j|
_}|d
vrFd|
jd<|jd|
jd<ddddd	d
d
�|��d7��f
dd
�|jD�
}td�|�
d�|
_|
j�	dd�
dS|dkrddD]}||
jvrW|
j|=qLd|
_|
j�	dd�
dS|dkrt|jdd�|
jd<d|
_|
j�	dd�
dSt
d|�
�
)z�Modify cherrypy.response status, headers, and body to represent
        self.

        CherryPy uses this internally, but you can also use it to create an
        HTTPRedirect object and set its output without *raising* the exception.
        )r)i-
r0r/i3
i4
�text/html;charset=utf-8�Content-Typer
�LocationzThis resource can be found at z'This resource has permanently moved to z%This resource resides temporarily at z'This resource has moved temporarily to z This resource has been moved to z<a href=%s>%s</a>.c
s(g|]}
�t�
|
�
tj|
dd
�f�qS)F�
�quote)rZ	quoteattr�html�escape)r&�
u�
�msgrrr(
s��z-HTTPRedirect.set_response.<locals>.<listcomp>z<br />
r#�Content-LengthNi0
)
ZAllow�Content-EncodingzContent-Languager@�Content-Location�Content-MD5�
Content-Ranger7�Expires�
Last-Modifiedi1
zThe %s status code is unknown.)rr�responser.�headersr*r�join�body�popr-)r rGr.Zmsgs�keyrr>r�set_response�s@







��

�


�

zHTTPRedirect.set_responsec


C�|�
�
z5Use this exception as a request.handler (raise self).r�
r rrr�__call__8
�zHTTPRedirect.__call__)NN)
rrr
rr*r%rrr,�propertyr.rMrQrrrrr"�s







@r"c
CsHtj
j}
|
j}d
D]	}||vr||=q	|dkr d|vr"|d=dSdSdS)z?Remove any headers which should not apply to an error response.)z
Accept-RangesZAgeZETagr8zRetry-AfterZVaryrAr@rErBrCrFi�
rDN)rrrGrH)r.rGZrespheadersrLrrr�
clean_headers=
s

�

�rTc@sXeZ
dZd
ZdZ	dZ	dZ	ddd�
Zdd�Zdd	�Z	d
d�Z
eej
dd
d�
�
�
ZdS)�	HTTPErrora�Exception used to return an HTTP error code (4xx-5xx) to the client.

    This exception can be used to automatically send a response using a
    http status code, with an appropriate error page. It takes an optional
    ``status`` argument (which must be between 400 and 599); it defaults to 500
    ("Internal Server Error"). It also takes an optional ``message`` argument,
    which will be returned in the response body. See
    `RFC2616 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4>`_
    for a complete list of available error codes and when to use them.

    Examples::

        raise cherrypy.HTTPError(403)
        raise cherrypy.HTTPError(
            "403 Forbidden", "You are not allowed to access this resource.")
    N��
cCs~|
|_zt
�|
�
\|_|_}Wnty"


|�d
t�djd��
w|jdks-|jdkr1td�
�
|p4||_	t
�||
|�
dS)NrVrr
�
iWz#status must be between 400 and 599.)r.�	_httputil�valid_status�code�reasonr-�	__class__�	_exc_infor4�_messager
r)r r.�messageZ
defaultmsgrrrrr
s




�


zHTTPError.__init__c
Csdtj
j}
t|j�

|j|
_d
}tj
jjrt�}|
j	�
dd
�
|j|j||jd�}||
_
t|j�

d
S)z�Modify cherrypy.response status, headers, and body to represent
        self.

        CherryPy uses this internally, but you can also use it to create an
        HTTPError object and set its output without *raising* the exception.
        Nr@)�	tracebackr_)rrrGrTrZr.rZshow_tracebacks�
format_excrHrK�get_error_pager^rJ�_be_ie_unfriendly)r rG�tb�contentrrrrM�
s






�zHTTPError.set_responsec
Ost|
i|�
�
S�
N)
rb)r r4�kwargsrrrrb�
s
zHTTPError.get_error_pagec


CrNrOrrPrrrrQ�
rRzHTTPError.__call__rc
cs:�zd
V
Wd
S|
y
}
z	|||pt|�
��
d
}~w
w)z&Translate exception into an HTTPError.N)
�str)r2�	exceptionr.r_�excrrr�handle�
s�


��zHTTPError.handle)rVN)rVr)rrr
rr.rZr[rrMrbrQ�classmethod�
contextlib�contextmanagerrkrrrrrUU
s





rUc@seZ
dZd
Zddd�
ZdS)�NotFoundz�Exception raised when a URL could not be mapped to any handler (404).

    This is equivalent to raising
    :class:`HTTPError("404 Not Found") <cherrypy._cperror.HTTPError>`.
    NcCs:|
durtj
j}|j|j}
|
f
|_t�|d
d|
�
dS)N�
zThe path '%s' was not found.)rrr�script_namerr4rUr)r rrrrrr�
s





zNotFound.__init__rfr!rrrrro�
sroa�<!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta>
    <title>%(status)s</title>
    <style type="text/css">
    #powered_by {
        margin-top: 20px;
        border-top: 2px solid black;
        font-style: italic;
    }

    #traceback {
        color: red;
    }
    </style>
</head>
    <body>
        <h2>%(status)s</h2>
        <p>%(message)s</p>
        <pre id="traceback">%(traceback)s</pre>
    <div id="powered_by">
      <span>
        Powered by <a href="http://www.cherrypy.org">CherryPy %(version)s</a>
      </span>
    </div>
    </body>
</html>
c
Ks�
z
t�
|�
\}}}Wnty


t�d
t�djd��
w|
�d�
dur-d||f|
d<|
�d�
dur8||
d<|
�d�
durCd	|
d<|
�d
�
durOtj|
d
<|
�	�D]\}}|dur`d	|
|<qSt
j|
|dd�|
|<qStjj
j}|�|�
pz|�d
�
}t}	|r�zDt|d�r�|di|
�
�
}
tj�|
�
r�ddlm}
||
�
WSt|
t�r�|
�d�
WSt|
t�s�tdt|
�
j�
�
|
WStj|d	d���}	Wn$ty�


tt��d}|
d}
|
r�|
d7}
|
d|7}
|
|
d<Yn
wtjj }d|j!d<|	|
}
|
�d�
S)z�Return an HTML page, containing a pretty error response.

    status should be an int or a str.
    kwargs will be interpolated into the page template.
    rVrr
r.Nz%s %sr_r`r�versionFr9�defaultrQ)
�UTF8StreamEncoderr#zaerror page function did not return a bytestring, str or an iterator - returned object of type %s.)
�newline���z<br />z3In addition, the custom error page failed:
<br />%sr6r7r)"rXrYr-rrUr]r4�get�__version__�itemsr;r<rr�
error_page�_HTTPErrorTemplate�hasattr�libZis_iteratorZcherrypy.lib.encodingrt�
isinstancerh�encode�bytes�typer�io�open�read�	Exception�_format_exceptionrGrH)r.rgrZr[r_�
k�
vZpagesrz�template�resultrt�
e�
mrGrrrrb�
sb


�


























��






�




rbi�
)rWi�
rpi�
i�
i�
i�
i�
rVi�
i�
c
Csltj
j}
t�|d
�}|r4|d7}|
��}t|�
}|r&||kr&|d||}||
_tt|�
�
|
j	d<dSdS)Nr
r�
 r@)
rrrG�_ie_friendly_error_sizesrwZ
collapse_body�lenrJrhrH)r.rG�
sre�content_lengthrrrrc-s






�rcc
Cs@z|d
urt�}|dkrW~dSdd
l
}
d�|
j|��
W~S~w)z0Return exc (or sys.exc_info if None), formatted.N)NNNrr
)r]r`rIr)rjr`rrrraDs



�
rac
CsNd
}
|du
rt|t
�s|�d�
}|
d|7}
dddttt|
�
�
d�fg|
g
fS)	a�
Produce status, headers, body for a critical error.

    Returns a triple without calling any other questionable functions,
    so it should be as error-free as possible. Call it from an HTTP server
    if you get errors outside of the request.

    If extrabody is None, a friendly but rather unhelpful error message
    is set in the body. If extrabody is a string, it will be appended
    as-is to the body.
    s"Unrecoverable error in the server.Nr#�

s500 Internal Server Error)sContent-Types
text/plainsContent-Lengthz
ISO-8859-1)r~r�rrrhr�)Z	extrabodyrJrrr�
bare_errorQs







��r�rf)&rr�rm�urllib.parser�sysrr]r`rr�Zxml.saxrr;Zmore_itertoolsrrZcherrypy._cpcompatrrZcherrypy._helperrZcherrypy.libr	rXr�r
rr"rTrUror{rbr�rcrar�rrrr�<module>
s<x









W!J

�