Added Flashdata variables, session_id regeneration and configurable session update times to the Session class

2 files changed, 164 insertions, 13 deletions

diff --git a/system/application/config/config.php b/system/application/config/config.php
index f0ba241f6..c84a4d802 100644
--- a/system/application/config/config.php
+++ b/system/application/config/config.php
@@ -227,6 +227,7 @@ $config['encryption_key'] = "";
 | 'encrypt_sess_cookie' = TRUE/FALSE (boolean).  Whether to encrypt the cookie

 | 'session_expiration'  = the number of SECONDS you want the session to last.

 |  by default sessions last 7200 seconds (two hours).  Set to zero for no expiration.

+| 'time_to_update'		= how many seconds between CI refreshing Session Information

 |

 */

 $config['sess_cookie_name']		= 'ci_session';

@@ -236,6 +237,7 @@ $config['sess_use_database']	= FALSE;
 $config['sess_table_name']		= 'ci_sessions';

 $config['sess_match_ip']		= FALSE;

 $config['sess_match_useragent']	= TRUE;

+$config['sess_time_to_update'] 		= 300;

 

 /*

 |--------------------------------------------------------------------------

diff --git a/system/libraries/Session.php b/system/libraries/Session.php
index a0fe56274..57106ea2c 100644
--- a/system/libraries/Session.php
+++ b/system/libraries/Session.php
@@ -35,7 +35,8 @@ class CI_Session {
 	var $sess_cookie	= 'ci_session';

 	var $userdata		= array();

 	var $gc_probability	= 5;

-

+	var $flashdata_key 	= 'flash';

+	var $time_to_update	= 300; // 5 mintues, not accessible from config settings

 

 	/**

 	 * Session Constructor

@@ -72,6 +73,12 @@ class CI_Session {
 		 * "last_visit" times based on each user's locale.

 		 *

 		 */

+

+		if (is_numeric($this->CI->config->item('sess_time_to_update')))

+		{

+			$this->time_to_update = $this->CI->config->item('sess_time_to_update');

+		}

+

 		if (strtolower($this->CI->config->item('time_reference')) == 'gmt')

 		{

 			$now = time();

@@ -146,7 +153,7 @@ class CI_Session {
 		else

 		{	

 			// We only update the session every five minutes

-			if (($this->userdata['last_activity'] + 300) < $this->now)

+			if (($this->userdata['last_activity'] + $this->time_to_update) < $this->now)

 			{

 				$this->sess_update();

 			}

@@ -156,7 +163,13 @@ class CI_Session {
 		if ($this->use_database === TRUE)

 		{		

 			$this->sess_gc();

-		}	

+		}

+

+		// Delete 'old' flashdata (from last request)

+       	$this->_flashdata_sweep();

+        

+        // Mark all new flashdata as old (data will be deleted before next request)

+       	$this->_flashdata_mark();

 	}

 	

 	// --------------------------------------------------------------------

@@ -313,7 +326,7 @@ class CI_Session {
 		}

 			

 		// Write the cookie

-		$this->userdata['last_visit'] = 0;		

+		$this->userdata['last_visit'] = 0;

 		$this->sess_write();

 	}

 	

@@ -331,13 +344,25 @@ class CI_Session {
 		{

 			$this->userdata['last_visit'] = $this->userdata['last_activity'];

 		}

-	

+

+		// Save the old session id so we know which record to 

+		// update in the database if we need it

+		$old_sessid = $this->userdata['session_id'];

+		$new_sessid = '';

+		while (strlen($new_sessid) < 32)

+		{

+			$new_sessid .= mt_rand(0, mt_getrandmax());

+		}

+		$new_sessid = md5(uniqid($new_sessid, TRUE));

+		

+        // Update the session data in the session data array

+		$this->userdata['session_id'] = $new_sessid;

 		$this->userdata['last_activity'] = $this->now;

 		

 		// Update the session in the DB if needed

 		if ($this->use_database === TRUE)

 		{		

-			$this->CI->db->query($this->CI->db->update_string($this->session_table, array('last_activity' => $this->now), array('session_id' => $this->userdata['session_id'])));

+			$this->CI->db->query($this->CI->db->update_string($this->session_table, array('last_activity' => $this->now, 'session_id' => $new_sessid), array('session_id' => $old_sessid)));

 		}

 		

 		// Write the cookie

@@ -392,7 +417,7 @@ class CI_Session {
 	// --------------------------------------------------------------------

 	

 	/**

-	 * Fetch a specific item form  the session array

+	 * Fetch a specific item from the session array

 	 *

 	 * @access	public

 	 * @param	string

@@ -402,6 +427,19 @@ class CI_Session {
 	{

 		return ( ! isset($this->userdata[$item])) ? FALSE : $this->userdata[$item];

 	}

+

+	// --------------------------------------------------------------------

+	

+	/**

+	 * Fetch all session data

+	 *

+	 * @access	public

+	 * @return	mixed

+	 */	

+	function all_userdata()

+	{

+        return ( ! isset($this->userdata)) ? FALSE : $this->userdata;

+	}

 	

 	// --------------------------------------------------------------------

 	

@@ -427,7 +465,7 @@ class CI_Session {
 				$this->userdata[$key] = $val;

 			}

 		}

-	

+

 		$this->sess_write();

 	}

 	

@@ -436,8 +474,7 @@ class CI_Session {
 	/**

 	 * Delete a session variable from the "userdata" array

 	 *

-	 * @access	public

-	 * @param	array

+	 * @access	array

 	 * @return	void

 	 */		

 	function unset_userdata($newdata = array())

@@ -467,9 +504,9 @@ class CI_Session {
 	 * @param	mixed

 	 * @return	mixed

 	 */

-	 function strip_slashes($vals)

-	 {

-	 	if (is_array($vals))

+	function strip_slashes($vals)

+	{

+		if (is_array($vals))

 	 	{	

 	 		foreach ($vals as $key=>$val)

 	 		{

@@ -484,6 +521,118 @@ class CI_Session {
 	 	return $vals;

 	}

 

+	

+    // ------------------------------------------------------------------------

+

+    /**

+	 * Add or change flashdata, only available

+	 * until the next request

+	 *

+	 * @access	public

+	 * @param	mixed

+	 * @param	string

+	 * @return	void

+	 */

+    function set_flashdata($newdata = array(), $newval = '')

+    {

+        if (is_string($newdata))

+        {

+            $newdata = array($newdata => $newval);

+        }

+        

+        if (count($newdata) > 0)

+        {

+            foreach ($newdata as $key => $val)

+            {

+                $flashdata_key = $this->flashdata_key.':new:'.$key;

+                $this->set_userdata($flashdata_key, $val);

+            }

+        }

+    } 

+	

+    // ------------------------------------------------------------------------

+

+    /**

+     * Keeps existing flashdata available to next request.

+	 *

+	 * @access	public

+	 * @param	string

+	 * @return	void

+     */

+    function keep_flashdata($key)

+    {

+		// 'old' flashdata gets removed.  Here we mark all 

+		// flashdata as 'new' to preserve it from _flashdata_sweep()

+		// Note the function will return FALSE if the $key 

+		// provided cannot be found

+        $old_flashdata_key = $this->flashdata_key.':old:'.$key;

+        $value = $this->userdata($old_flashdata_key);

+

+        $new_flashdata_key = $this->flashdata_key.':new:'.$key;

+        $this->set_userdata($new_flashdata_key, $value);

+    }

+	

+    // ------------------------------------------------------------------------

+

+	/**

+	 * Fetch a specific flashdata item from the session array

+	 *

+	 * @access	public

+	 * @param	string

+	 * @return	string

+	 */	

+    function flashdata($key)

+    {

+        $flashdata_key = $this->flashdata_key.':old:'.$key;

+        return $this->userdata($flashdata_key);

+    }

+

+    // ------------------------------------------------------------------------

+

+    /**

+     * Identifies flashdata as 'old' for removal

+	 * when _flashdata_sweep() runs.

+	 *

+	 * @access	private

+	 * @return	void

+     */

+    function _flashdata_mark()

+    {

+		$userdata = $this->all_userdata();

+        foreach ($userdata as $name => $value)

+        {

+            $parts = explode(':new:', $name);

+            if (is_array($parts) && count($parts) === 2)

+            {

+                $new_name = $this->flashdata_key.':old:'.$parts[1];

+                $this->set_userdata($new_name, $value);

+                $this->unset_userdata($name);

+            }

+        }

+    }

+

+    // ------------------------------------------------------------------------

+

+    /**

+     * Removes all flashdata marked as 'old'

+	 *

+	 * @access	private

+	 * @return	void

+     */

+

+    function _flashdata_sweep()

+    {

+		$userdata = $this->all_userdata();

+        foreach ($userdata as $key => $value)

+        {

+            if (strpos($key, ':old:'))

+            {

+                $this->unset_userdata($key);

+            }

+        }

+

+    }

+	

 }

 // END Session Class

 ?>
\ No newline at end of file