o NK&hS@sddlmZddlZddlZddlmZddlmZmZddlm Z er*ddl m Z ddlm Z ee de d e d e d e d e d fZ dZdZejejdZedZddeeddDZddZedeejZGdddZGdddZdS)) annotationsN)datetime) TYPE_CHECKINGUnion) ServerError)Header)LiteralStrictLaxNonestrictlaxnone)r r rz!#$%&'*+-.^_`|~:z ()/<=>?@[]{}cCsi|] }|d|dqS)\03o).0chrrI/var/www/html/venv/lib/python3.10/site-packages/sanic/cookies/response.py sr s";\cCs&|dust|r |Sd|tdS)zQuote a string for use in a cookie header. If the string does not need to be double-quoted, then just return the string. Otherwise, surround the string in doublequotes and quote (with a \) special characters. N") _is_legal_key translate TRANSLATOR)strrrr_quote#srz[%s]+c @seZdZdZdZd2ddZddZed3d d Z   d4d5ddZ   d4d6ddZ d ddddddddddd d7d,d-Z d ddddd.d8d0d1Z dS)9 CookieJaraOA container to manipulate cookies. CookieJar dynamically writes headers as cookies are added and removed It gets around the limitation of one header per name by using the MultiHeader class to provide a unique key that encodes to Set-Cookie. Args: headers (Header): The headers object to write cookies to. z Set-CookieheadersrcC ||_dSN)r)selfrrrr__init__? zCookieJar.__init__cCs t|jSr )lencookiesr!rrr__len__Br#zCookieJar.__len__return list[Cookie]cCs|j|jgS)z|A list of cookies in the CookieJar. Returns: List[Cookie]: A list of cookies in the CookieJar. )rgetall HEADER_KEYr&rrrr%EszCookieJar.cookies/NFkeyrpathdomain str | None host_prefixbool secure_prefix Cookie | NonecCs@|jD]}|jt|||kr|j|kr|j|kr|SqdS)aFetch a cookie from the CookieJar. Args: key (str): The key of the cookie to fetch. path (str, optional): The path of the cookie. Defaults to `"/"`. domain (Optional[str], optional): The domain of the cookie. Defaults to `None`. host_prefix (bool, optional): Whether to add __Host- as a prefix to the key. This requires that path="/", domain=None, and secure=True. Defaults to `False`. secure_prefix (bool, optional): Whether to add __Secure- as a prefix to the key. This requires that secure=True. Defaults to `False`. Returns: Optional[Cookie]: The cookie if it exists, otherwise `None`. Nr%r-Cookiemake_keyr.r/r!r-r.r/r1r3cookierrr get_cookieNs   zCookieJar.get_cookiecCs>|jD]}|jt|||kr|j|kr|j|krdSqdS)aCheck if a cookie exists in the CookieJar. Args: key (str): The key of the cookie to check. path (str, optional): The path of the cookie. Defaults to `"/"`. domain (Optional[str], optional): The domain of the cookie. Defaults to `None`. host_prefix (bool, optional): Whether to add __Host- as a prefix to the key. This requires that path="/", domain=None, and secure=True. Defaults to `False`. secure_prefix (bool, optional): Whether to add __Secure- as a prefix to the key. This requires that secure=True. Defaults to `False`. Returns: bool: Whether the cookie exists. TFr5r8rrr has_cookieos   zCookieJar.has_cookieTr r.r/securemax_ageexpireshttponlysamesite partitionedcommentr1r3valuer=r> int | Noner?datetime | Noner@rASameSite | NonerBrCr6c Cs6t||||| ||||| | | | d }|j|j||S)a5 Add a cookie to the CookieJar. Args: key (str): Key of the cookie. value (str): Value of the cookie. path (str, optional): Path of the cookie. Defaults to "/". domain (Optional[str], optional): Domain of the cookie. Defaults to None. secure (bool, optional): Whether to set it as a secure cookie. Defaults to True. max_age (Optional[int], optional): Max age of the cookie in seconds; if set to 0 a browser should delete it. Defaults to None. expires (Optional[datetime], optional): When the cookie expires; if set to None browsers should set it as a session cookie. Defaults to None. httponly (bool, optional): Whether to set it as HTTP only. Defaults to False. samesite (Optional[SameSite], optional): How to set the samesite property, should be strict, lax, or none (case insensitive). Defaults to "Lax". partitioned (bool, optional): Whether to set it as partitioned. Defaults to False. comment (Optional[str], optional): A cookie comment. Defaults to None. host_prefix (bool, optional): Whether to add __Host- as a prefix to the key. This requires that path="/", domain=None, and secure=True. Defaults to False. secure_prefix (bool, optional): Whether to add __Secure- as a prefix to the key. This requires that secure=True. Defaults to False. Returns: Cookie: The instance of the created cookie. Raises: ServerError: If host_prefix is set without secure=True. ServerError: If host_prefix is set without path="/" and domain=None. ServerError: If host_prefix is set with domain. ServerError: If secure_prefix is set without secure=True. ServerError: If partitioned is set without host_prefix=True. Examples: Basic usage ```python cookie = add_cookie('name', 'value') ``` Adding a cookie with a custom path and domain ```python cookie = add_cookie('name', 'value', path='/custom', domain='example.com') ``` Adding a secure, HTTP-only cookie with a comment ```python cookie = add_cookie('name', 'value', secure=True, httponly=True, comment='My Cookie') ``` Adding a cookie with a max age of 60 seconds ```python cookie = add_cookie('name', 'value', max_age=60) ``` ) r.r?rCr/r>r=r@rArBr1r3)r6raddr+)r!r-rDr.r/r=r>r?r@rArBrCr1r3r9rrr add_cookies"FzCookieJar.add_cookie)r.r/r=r1r3r c Cs|r|r |dkr |dustd|r|std|j|jg}d}|D]%} | jt|||ks:| j|ks:| j|krC|j |j| q$|durI| }q$|durf|j |d|j|j|j d|j |j |j||d dS|j |d|||dd||d dS) a Delete a cookie This will effectively set it as Max-Age: 0, which a browser should interpret it to mean: "delete the cookie". Since it is a browser/client implementation, your results may vary depending upon which client is being used. :param key: The key to be deleted :type key: str :param path: Path of the cookie, defaults to None :type path: Optional[str], optional :param domain: Domain of the cookie, defaults to None :type domain: Optional[str], optional :param secure: Whether to delete a secure cookie. Defaults to True. :param secure: bool :param host_prefix: Whether to add __Host- as a prefix to the key. This requires that path="/", domain=None, and secure=True, defaults to False :type host_prefix: bool :param secure_prefix: Whether to add __Secure- as a prefix to the key. This requires that secure=True, defaults to False :type secure_prefix: bool r,NzQCannot set host_prefix on a cookie without path='/', domain=None, and secure=True8Cannot set secure_prefix on a cookie without secure=Truer) r-rDr.r/r=r>r@rBrAr1r3) r-rDr.r/r=r>rAr1r3)rrpopallr+r-r6r7r.r/rHrIr=r@rBrA) r!r-r.r/r=r1r3r%existing_cookier9rrr delete_cookiesV#    zCookieJar.delete_cookie)rr)r(r))r,NFF) r-rr.rr/r0r1r2r3r2r(r4) r-rr.rr/r0r1r2r3r2r(r2)r-rrDrr.rr/r0r=r2r>rEr?rFr@r2rArGrBr2rCr0r1r2r3r2r(r6)r-rr.rr/r0r=r2r1r2r3r2r(r ) __name__ __module__ __qualname____doc__r+r"r'propertyr%r:r;rIrNrrrrr2sF    $ &]rc @seZdZdZdZdZdZddddd d d d d d ZhdZdddddddddddd dMd(d)Z d*d+Z e dNd-d.Z e j dOd0d.Z e dPd1d2Zej dQd4d2Ze dRd5d6Zej dOd7d6Ze dRd8d9Zej dOd:d9Ze dSd;d<Zej dTd>d<Ze dUd?d@Zej dVdAd@Ze dUdBdCZej dVdDdCZe dWdEdFZej dXdGdFZe dUdHdIZej dVdJdIZe dYdZdKdLZdS)[r6a'A representation of a HTTP cookie, providing an interface to manipulate cookie attributes intended for a response. This class is a simplified representation of a cookie, similar to the Morsel SimpleCookie in Python's standard library. It allows the manipulation of various cookie attributes including path, domain, security settings, and others. Several "smart defaults" are provided to make it easier to create cookies that are secure by default. These include: - Setting the `secure` flag to `True` by default - Setting the `samesite` flag to `Lax` by default Args: key (str): The key (name) of the cookie. value (str): The value of the cookie. path (str, optional): The path for the cookie. Defaults to "/". domain (Optional[str], optional): The domain for the cookie. Defaults to `None`. secure (bool, optional): Whether the cookie is secure. Defaults to `True`. max_age (Optional[int], optional): The maximum age of the cookie in seconds. Defaults to `None`. expires (Optional[datetime], optional): The expiration date of the cookie. Defaults to `None`. httponly (bool, optional): HttpOnly flag for the cookie. Defaults to `False`. samesite (Optional[SameSite], optional): The SameSite attribute for the cookie. Defaults to `"Lax"`. partitioned (bool, optional): Whether the cookie is partitioned. Defaults to `False`. comment (Optional[str], optional): A comment for the cookie. Defaults to `None`. host_prefix (bool, optional): Whether to use the host prefix. Defaults to `False`. secure_prefix (bool, optional): Whether to use the secure prefix. Defaults to `False`. z__Host-z __Secure-) r-rD_path_comment_domain_secure _httponly _partitioned_expires_max_age _samesitePathCommentDomainzMax-Ager?SameSiteSecureHttpOnly Partitioned) r.rCr/max-ager?rAr=r@rB>r=r@rBr,NTFr r<r-rrDr.r/r0r=r2r>rErFr@rArGrBrCr1r3c Cs||jvr tdt|std| r(|std|dkr!td|r'tdn| r0|s0td| r8| s8td||| | |_||_||_| |_||_ ||_ ||_ | |_ d|_ d|_d|_|dure||_|durl||_| duru| |_dSdS) NzCookie name is a reserved wordz&Cookie key contains illegal charactersz6Cannot set host_prefix on a cookie without secure=Truer,z2Cannot set host_prefix on a cookie unless path='/'z8Cannot set host_prefix on a cookie with a defined domainrJzHCannot create a partitioned cookie without also setting host_prefix=True)_keysKeyErrorrrr7r-rDrTrUrVrWrXrYrZr[r\r?r>rA)r!r-rDr.r/r=r>r?r@rArBrCr1r3rrrr"sX  zCookie.__init__c sd|jt|jg}t|jt|jfdddD]i}t|| dd}|dur|dur|d krZz| d |j||fWqt yY| d|j||Yqw|d krn| d |j|| d fq||j vr|| |j|q| d|j||qd|S)z$Format as a Set-Cookie header value.z{}={}cs |Sr )index)k ordered_keysrrs z Cookie.__str__..)r--_NFrdz%s=%dr?z%s=%sz%a, %d-%b-%Y %T GMTz; )formatr-rrDlistrekeyssortedgetattrreplaceappend TypeErrorstrftime_flagsjoin)r!outputr-rDrrir__str__s4    zCookie.__str__r(cC|jS)z*The path of the cookie. Defaults to `"/"`.rTr&rrrr.z Cookie.pathr cCrr r|r!rDrrrr. cCr{)z6The expiration date of the cookie. Defaults to `None`.)rZr&rrrr?r}zCookie.expiresrcCst|ts td||_dS)Nz,Cookie 'expires' property must be a datetime) isinstancerrurZr~rrrr?s  cCr{)z-A comment for the cookie. Defaults to `None`.rUr&rrrrCr}zCookie.commentcCrr rr~rrrrCrcCr{)z-The domain of the cookie. Defaults to `None`.rVr&rrrr/r}z Cookie.domaincCrr rr~rrrr/rcCr{)z=The maximum age of the cookie in seconds. Defaults to `None`.)r[r&rrrr> r}zCookie.max_ageintcCst|s td||_dS)Nz!Cookie max-age must be an integer)risdigit ValueErrorr[r~rrrr>s  cCr{)z1Whether the cookie is secure. Defaults to `True`.rWr&rrrr=r}z Cookie.securecCrr rr~rrrr=rcCr{)z5Whether the cookie is HTTP only. Defaults to `False`.rXr&rrrr@r}zCookie.httponlycCrr rr~rrrr@"rcCr{)z;The SameSite attribute for the cookie. Defaults to `"Lax"`.)r\r&rrrrA&r}zCookie.samesitecCs.|tvrtddt||_dS)Nz+Cookie 'samesite' property must be one of: ,)lowerSAMESITE_VALUESrurxtitler\r~rrrrA+s cCr{)z7Whether the cookie is partitioned. Defaults to `False`.rYr&rrrrB4r}zCookie.partitionedcCrr rr~rrrrB9rcCs4|r|rtd|r|j|}|S|r|j|}|S)aCreate a cookie key with the appropriate prefix. Cookies can have one ow two prefixes. The first is `__Host-` which requires that the cookie be set with `path="/", domain=None, and secure=True`. The second is `__Secure-` which requires that `secure=True`. They cannot be combined. Args: key (str): The key (name) of the cookie. host_prefix (bool, optional): Whether to add __Host- as a prefix to the key. This requires that path="/", domain=None, and secure=True. Defaults to `False`. secure_prefix (bool, optional): Whether to add __Secure- as a prefix to the key. This requires that secure=True. Defaults to `False`. Raises: ServerError: If both host_prefix and secure_prefix are set. Returns: str: The key with the appropriate prefix. zXBoth host_prefix and secure_prefix were requested. A cookie should have only one prefix.)r HOST_PREFIX SECURE_PREFIX)clsr-r1r3rrrr7=s  zCookie.make_key)r-rrDrr.rr/r0r=r2r>rEr?rFr@r2rArGrBr2rCr0r1r2r3r2)r(r)rDrr(r )r(rF)rDrr(r )r(r0)r(rE)rDrr(r )r(r2)rDr2r(r )r(rG)rDr`r(r )FF)r-rr1r2r3r2r(r)rOrPrQrRrr __slots__rerwr"rzrSr.setterr?rCr/r>r=r@rArB classmethodr7rrrrr6@s$ B                  r6) __future__rrestringrtypingrrsanic.exceptionsr sanic.compatrrr`DEFAULT_MAX_AGEr ascii_lettersdigits LEGAL_CHARSUNESCAPED_CHARSbytesrangerrcompileescape fullmatchrrr6rrrrs: