3
W­E^€0  ã               @   sÖ   d dl Z d dlZd dlZd dlZd dlmZmZ d dlmZ d dlm	Z	 d dl
mZ d dlmZ d dlmZmZmZ d dlmZ d d	lmZ d d
lmZ ejej ZG dd„ deƒZG dd„ deƒZG dd„ dƒZdS )é    N)ÚdatetimeÚ	timedelta)Úsettings)ÚSuspiciousSession)ÚSuspiciousOperation)Útimezone)Úconstant_time_compareÚget_random_stringÚsalted_hmac)ÚRemovedInDjango40Warning)Úimport_string)ÚLANGUAGE_SESSION_KEYc               @   s   e Zd ZdZdS )ÚCreateErrorz‡
    Used internally as a consistent exception type to catch from save (see the
    docstring for SessionBase.save() for details).
    N)Ú__name__Ú
__module__Ú__qualname__Ú__doc__© r   r   úG/tmp/pip-build-78s3knkw/Django/django/contrib/sessions/backends/base.pyr      s   r   c               @   s   e Zd ZdZdS )ÚUpdateErrorzF
    Occurs if Django tries to update a session that was deleted.
    N)r   r   r   r   r   r   r   r   r      s   r   c               @   sŠ  e Zd ZdZdZdZeƒ ZdVdd„Zdd„ Z	d	d
„ Z
dd„ Zdd„ ZdWdd„Zefdd„Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd „ Zd!d"„ Zd#d$„ Zd%d&„ Zd'd(„ Zd)d*„ Zd+d,„ Zd-d.„ Zd/d0„ Zd1d2„ Zd3d4„ Zd5d6„ Z d7d8„ Z!e"e ƒZ#e"e e!ƒZ$dXd:d;„Z%e"e%ƒZ&d<d=„ Z'd>d?„ Z(d@dA„ Z)dBdC„ Z*dDdE„ Z+dFdG„ Z,dHdI„ Z-dJdK„ Z.dLdM„ Z/dYdNdO„Z0dZdPdQ„Z1dRdS„ Z2e3dTdU„ ƒZ4dS )[ÚSessionBasez-
    Base class for all Session classes.
    Z
testcookieZworkedNc             C   s"   || _ d| _d| _ttjƒ| _d S )NF)Ú_session_keyÚaccessedÚmodifiedr   r   ZSESSION_SERIALIZERÚ
serializer)ÚselfÚsession_keyr   r   r   Ú__init__/   s    zSessionBase.__init__c             C   s
   || j kS )N)Ú_session)r   Úkeyr   r   r   Ú__contains__5   s    zSessionBase.__contains__c             C   s"   |t krtjdtdd� | j| S )Nz‘The user language will no longer be stored in request.session in Django 4.0. Read it from request.COOKIES[settings.LANGUAGE_COOKIE_NAME] instead.é   )Ú
stacklevel)r   ÚwarningsÚwarnr   r   )r   r   r   r   r   Ú__getitem__8   s
    
zSessionBase.__getitem__c             C   s   || j |< d| _d S )NT)r   r   )r   r   Úvaluer   r   r   Ú__setitem__B   s    
zSessionBase.__setitem__c             C   s   | j |= d| _d S )NT)r   r   )r   r   r   r   r   Ú__delitem__F   s    zSessionBase.__delitem__c             C   s   | j j||ƒS )N)r   Úget)r   r   Údefaultr   r   r   r)   J   s    zSessionBase.getc             C   s8   | j p|| jk| _ || jkr f n|f}| jj|f|žŽ S )N)r   r   Ú_SessionBase__not_givenÚpop)r   r   r*   Úargsr   r   r   r,   M   s    zSessionBase.popc             C   s,   || j kr| j | S d| _|| j |< |S d S )NT)r   r   )r   r   r&   r   r   r   Ú
setdefaultR   s
    


zSessionBase.setdefaultc             C   s   | j | | j< d S )N)ÚTEST_COOKIE_VALUEÚTEST_COOKIE_NAME)r   r   r   r   Úset_test_cookieZ   s    zSessionBase.set_test_cookiec             C   s   | j | jƒ| jkS )N)r)   r0   r/   )r   r   r   r   Útest_cookie_worked]   s    zSessionBase.test_cookie_workedc             C   s   | | j = d S )N)r0   )r   r   r   r   Údelete_test_cookie`   s    zSessionBase.delete_test_cookiec             C   s   d| j j }t||ƒjƒ S )Nzdjango.contrib.sessions)Ú	__class__r   r
   Ú	hexdigest)r   r&   Zkey_saltr   r   r   Ú_hashc   s    zSessionBase._hashc             C   s4   | j ƒ j|ƒ}| j|ƒ}tj|jƒ d | ƒjdƒS )zGReturn the given session dictionary serialized and encoded as a string.ó   :Úascii)r   Údumpsr6   Úbase64Ú	b64encodeÚencodeÚdecode)r   Zsession_dictÚ
serializedÚhashr   r   r   r<   g   s    
zSessionBase.encodec             C   s¤   t j|jdƒƒ}yD|jddƒ\}}| j|ƒ}t|jƒ |ƒsDtdƒ‚n| jƒ j	|ƒS W nJ t
k
rž } z.t|tƒr�tjd|jj ƒ}|jt|ƒƒ i S d }~X nX d S )Nr8   r7   é   zSession data corruptedzdjango.security.%s)r:   Ú	b64decoder<   Úsplitr6   r   r=   r   r   ÚloadsÚ	ExceptionÚ
isinstancer   ÚloggingÚ	getLoggerr4   r   ÚwarningÚstr)r   Zsession_dataZencoded_datar?   r>   Zexpected_hashÚeÚloggerr   r   r   r=   m   s    


zSessionBase.decodec             C   s   | j j|ƒ d| _d S )NT)r   Úupdater   )r   Zdict_r   r   r   rL      s    zSessionBase.updatec             C   s
   || j kS )N)r   )r   r   r   r   r   Úhas_keyƒ   s    zSessionBase.has_keyc             C   s
   | j jƒ S )N)r   Úkeys)r   r   r   r   rN   †   s    zSessionBase.keysc             C   s
   | j jƒ S )N)r   Úvalues)r   r   r   r   rO   ‰   s    zSessionBase.valuesc             C   s
   | j jƒ S )N)r   Úitems)r   r   r   r   rP   Œ   s    zSessionBase.itemsc             C   s   i | _ d| _d| _d S )NT)Ú_session_cacher   r   )r   r   r   r   Úclear�   s    zSessionBase.clearc             C   s*   y| j  o| j S  tk
r$   dS X dS )zBReturn True when there is no session_key and the session is empty.TN)r   rQ   ÚAttributeError)r   r   r   r   Úis_empty—   s    zSessionBase.is_emptyc             C   s"   xt dtƒ}| j|ƒs|S qW dS )z)Return session key that isn't being used.é    N)r	   ÚVALID_KEY_CHARSÚexists)r   r   r   r   r   Ú_get_new_session_keyž   s    

z SessionBase._get_new_session_keyc             C   s   | j d kr| jƒ | _ | j S )N)r   rX   )r   r   r   r   Ú_get_or_create_session_key¥   s    

z&SessionBase._get_or_create_session_keyc             C   s   |ot |ƒdkS )z”
        Key must be truthy and at least 8 characters long. 8 characters is an
        arbitrary lower bound for some minimal key security.
        é   )Úlen)r   r   r   r   r   Ú_validate_session_keyª   s    z!SessionBase._validate_session_keyc             C   s   | j S )N)Ú_SessionBase__session_key)r   r   r   r   Ú_get_session_key±   s    zSessionBase._get_session_keyc             C   s   | j |ƒr|| _nd| _dS )zV
        Validate session key on assignment. Invalid values will set to None.
        N)r\   r]   )r   r&   r   r   r   Ú_set_session_key´   s    
zSessionBase._set_session_keyFc             C   sH   d| _ y| jS  tk
r@   | jdks*|r2i | _n
| jƒ | _Y nX | jS )zž
        Lazily load session from storage (unless "no_load" is True, when only
        an empty dict is stored) and store it in the current instance.
        TN)r   rQ   rS   r   Úload)r   Zno_loadr   r   r   Ú_get_sessionÀ   s    zSessionBase._get_sessionc             C   s   t jS )N)r   ZSESSION_COOKIE_AGE)r   r   r   r   Úget_session_cookie_ageÑ   s    z"SessionBase.get_session_cookie_agec             K   sˆ   y|d }W n t k
r(   tjƒ }Y nX y|d }W n t k
rT   | jdƒ}Y nX |sb| jƒ S t|tƒsp|S || }|jd |j S )zÕGet the number of seconds until the session expires.

        Optionally, this function accepts `modification` and `expiry` keyword
        arguments specifying the modification and expiry of the session.
        ÚmodificationÚexpiryÚ_session_expiryi€Q )	ÚKeyErrorr   Únowr)   rb   rE   r   ÚdaysÚseconds)r   Úkwargsrc   rd   Údeltar   r   r   Úget_expiry_ageÔ   s    
zSessionBase.get_expiry_agec             K   s~   y|d }W n t k
r(   tjƒ }Y nX y|d }W n t k
rT   | jdƒ}Y nX t|tƒrd|S |pn| jƒ }|t|d� S )zÔGet session the expiry date (as a datetime object).

        Optionally, this function accepts `modification` and `expiry` keyword
        arguments specifying the modification and expiry of the session.
        rc   rd   re   )ri   )rf   r   rg   r)   rE   r   rb   r   )r   rj   rc   rd   r   r   r   Úget_expiry_dateí   s    
zSessionBase.get_expiry_datec             C   sN   |dkr,y
| d= W n t k
r&   Y nX dS t|tƒrBtjƒ | }|| d< dS )a*  
        Set a custom expiration for the session. ``value`` can be an integer,
        a Python ``datetime`` or ``timedelta`` object or ``None``.

        If ``value`` is an integer, the session will expire after that many
        seconds of inactivity. If set to ``0`` then the session will expire on
        browser close.

        If ``value`` is a ``datetime`` or ``timedelta`` object, the session
        will expire at that specific future time.

        If ``value`` is ``None``, the session uses the global session expiry
        policy.
        Nre   )rf   rE   r   r   rg   )r   r&   r   r   r   Ú
set_expiry  s    

zSessionBase.set_expiryc             C   s"   | j dƒdkrtjS | j dƒdkS )a  
        Return ``True`` if the session is set to expire when the browser
        closes, and ``False`` if there's an expiry date. Use
        ``get_expiry_date()`` or ``get_expiry_age()`` to find the actual expiry
        date/age, if there is one.
        re   Nr   )r)   r   ZSESSION_EXPIRE_AT_BROWSER_CLOSE)r   r   r   r   Úget_expire_at_browser_close  s    z'SessionBase.get_expire_at_browser_closec             C   s   | j ƒ  | jƒ  d| _dS )zc
        Remove the current session data from the database and regenerate the
        key.
        N)rR   Údeleter   )r   r   r   r   Úflush'  s    zSessionBase.flushc             C   s,   | j }| j}| jƒ  || _|r(| j|ƒ dS )zU
        Create a new session key, while retaining the current session data.
        N)r   r   ÚcreaterQ   rp   )r   Údatar   r   r   r   Ú	cycle_key0  s    zSessionBase.cycle_keyc             C   s   t dƒ‚dS )zF
        Return True if the given session_key already exists.
        z9subclasses of SessionBase must provide an exists() methodN)ÚNotImplementedError)r   r   r   r   r   rW   =  s    zSessionBase.existsc             C   s   t dƒ‚dS )zÅ
        Create a new session instance. Guaranteed to create a new object with
        a unique key and will have saved the result once (with empty data)
        before the method returns.
        z8subclasses of SessionBase must provide a create() methodN)ru   )r   r   r   r   rr   C  s    zSessionBase.createc             C   s   t dƒ‚dS )zä
        Save the session data. If 'must_create' is True, create a new session
        object (or raise CreateError). Otherwise, only update an existing
        object and don't create one (raise UpdateError if needed).
        z6subclasses of SessionBase must provide a save() methodN)ru   )r   Zmust_creater   r   r   ÚsaveK  s    zSessionBase.savec             C   s   t dƒ‚dS )zx
        Delete the session data under this key. If the key is None, use the
        current session key value.
        z8subclasses of SessionBase must provide a delete() methodN)ru   )r   r   r   r   r   rp   S  s    zSessionBase.deletec             C   s   t dƒ‚dS )z@
        Load the session data and return a dictionary.
        z6subclasses of SessionBase must provide a load() methodN)ru   )r   r   r   r   r`   Z  s    zSessionBase.loadc             C   s   t dƒ‚dS )a  
        Remove expired sessions from the session store.

        If this operation isn't possible on a given backend, it should raise
        NotImplementedError. If it isn't necessary, because the backend has
        a built-in expiration mechanism, it should be a no-op.
        z.This backend does not support clear_expired().N)ru   )Úclsr   r   r   Úclear_expired`  s    	zSessionBase.clear_expired)N)N)F)F)N)5r   r   r   r   r0   r/   Úobjectr+   r   r    r%   r'   r(   r)   r,   r.   r1   r2   r3   r6   r<   r=   rL   rM   rN   rO   rP   rR   rT   rX   rY   r\   r^   r_   Úpropertyr   r   ra   r   rb   rl   rm   rn   ro   rq   rt   rW   rr   rv   rp   r`   Úclassmethodrx   r   r   r   r   r   &   s^   


	

	

r   )r:   rF   Ústringr#   r   r   Zdjango.confr   Z"django.contrib.sessions.exceptionsr   Zdjango.core.exceptionsr   Zdjango.utilsr   Zdjango.utils.cryptor   r	   r
   Zdjango.utils.deprecationr   Zdjango.utils.module_loadingr   Zdjango.utils.translationr   Úascii_lowercaseÚdigitsrV   rD   r   r   r   r   r   r   r   Ú<module>   s    