Commit 5e8efa9a authored by Malcolm Tredinnick's avatar Malcolm Tredinnick
Browse files

Implemented a flush() method on sessions that cleans out the session and 

regenerates the key. Used to ensure the caller gets a fresh session at logout,
for example.

Based on a patch from mrts. Refs #7515.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@8342 bcc190cf-cafb-0310-a4f2-bffc1f526a37
parent 31ec68c5

django/contrib/sessions/backends/base.py

+12 −2
Original line number Diff line number Diff line
@@ -223,6 +223,15 @@ class SessionBase(object): 
            return settings.SESSION_EXPIRE_AT_BROWSER_CLOSE

        return self.get('_session_expiry') == 0



    def flush(self):

        """

        Removes the current session data from the database and regenerates the

        key.

        """

        self.clear()

        self.delete()

        self.create()



    # Methods that child classes must implement.



    def exists(self, session_key):
@@ -247,9 +256,10 @@ class SessionBase(object): 
        """

        raise NotImplementedError



    def delete(self, session_key):

    def delete(self, session_key=None):

        """

        Clears out the session data under this key.

        Deletes the session data under this key. If the key is None, the

        current session key value is used.

        """

        raise NotImplementedError

django/contrib/sessions/backends/cache.py

+3 −1
Original line number Diff line number Diff line
@@ -39,6 +39,8 @@ class SessionStore(SessionBase): 
            return True

        return False



    def delete(self, session_key):

    def delete(self, session_key=None):

        if session_key is None:

            session_key = self._session_key

        self._cache.delete(session_key)

django/contrib/sessions/backends/db.py

+3 −1
Original line number Diff line number Diff line
@@ -61,7 +61,9 @@ class SessionStore(SessionBase): 
                raise CreateError

            raise



    def delete(self, session_key):

    def delete(self, session_key=None):

        if session_key is None:

            session_key = self._session_key

        try:

            Session.objects.get(session_key=session_key).delete()

        except Session.DoesNotExist:

django/contrib/sessions/backends/file.py

+3 −1
Original line number Diff line number Diff line
@@ -89,7 +89,9 @@ class SessionStore(SessionBase): 
            return True

        return False



    def delete(self, session_key):

    def delete(self, session_key=None):

        if session_key is None:

            session_key = self._session_key

        try:

            os.unlink(self._key_to_file(session_key))

        except OSError:

django/contrib/sessions/tests.py

+38 −0
Original line number Diff line number Diff line
@@ -23,6 +23,19 @@ True 
>>> db_session.exists(db_session.session_key)

False



>>> db_session['foo'] = 'bar'

>>> db_session.save()

>>> db_session.exists(db_session.session_key)

True

>>> prev_key = db_session.session_key

>>> db_session.flush()

>>> db_session.exists(prev_key)

False

>>> db_session.session_key == prev_key

False

>>> db_session.modified, db_session.accessed

(True, True)



>>> file_session = FileSession()

>>> file_session.modified

False
@@ -40,6 +53,19 @@ True 
>>> file_session.exists(file_session.session_key)

False



>>> file_session['foo'] = 'bar'

>>> file_session.save()

>>> file_session.exists(file_session.session_key)

True

>>> prev_key = file_session.session_key

>>> file_session.flush()

>>> file_session.exists(prev_key)

False

>>> file_session.session_key == prev_key

False

>>> file_session.modified, file_session.accessed

(True, True)



# Make sure the file backend checks for a good storage dir

>>> settings.SESSION_FILE_PATH = "/if/this/directory/exists/you/have/a/weird/computer"

>>> FileSession()
@@ -61,6 +87,18 @@ True 
>>> cache_session.delete(cache_session.session_key)

>>> cache_session.exists(cache_session.session_key)

False

>>> cache_session['foo'] = 'bar'

>>> cache_session.save()

>>> cache_session.exists(cache_session.session_key)

True

>>> prev_key = cache_session.session_key

>>> cache_session.flush()

>>> cache_session.exists(prev_key)

False

>>> cache_session.session_key == prev_key

False

>>> cache_session.modified, cache_session.accessed

(True, True)



>>> s = SessionBase()

>>> s._session['some key'] = 'exists' # Pre-populate the session with some data