1. sfMySQLSessionStorage.class.php
  2. /**
 * Provides support for session storage using a MySQL brand database.
 *
 * parameters: see sfDatabaseSessionStorage
 *
 * @package    symfony
 * @subpackage storage
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @author     Julien Garand 
 * @version    SVN: $Id: sfMySQLSessionStorage.class.php 24590 2009-11-30 18:28:13Z FabianLange $
 */
  3. class sfMySQLSessionStorage extends sfDatabaseSessionStorage
  4. {
  5.   /**
  6.    * Destroys a session.
  7.    *
  8.    * @param  string $id  A session ID
  9.    *
  10.    * @return bool true, if the session was destroyed, otherwise an exception is thrown
  11.    *
  12.    * @throws <b>sfDatabaseException</b> If the session cannot be destroyed.
  13.    */
  14.   public function sessionDestroy($id)
  15.   {
  16.     // get table/column
  17.     $db_table  = $this->options['db_table'];
  18.     $db_id_col = $this->options['db_id_col'];
  20.     // cleanup the session id, just in case
  21.     $id = $this->db_escape($id);
  23.     // delete the record associated with this id
  24.     $sql = "DELETE FROM $db_table WHERE $db_id_col = '$id'";
  26.     if ($this->db_query($sql))
  27.     {
  28.       return true;
  29.     }
  31.     // failed to destroy session
  32.     throw new sfDatabaseException(sprintf('%s cannot destroy session id "%s" (%s).', get_class($this), $id, $this->db_error()));
  33.   }
  35.   /**
  36.    * Cleans up old sessions.
  37.    *
  38.    * @param  int $lifetime  The lifetime of a session
  39.    *
  40.    * @return bool true, if old sessions have been cleaned, otherwise an exception is thrown
  41.    *
  42.    * @throws <b>sfDatabaseException</b> If any old sessions cannot be cleaned
  43.    */
  44.   public function sessionGC($lifetime)
  45.   {
  46.     // get table/column
  47.     $db_table    = $this->options['db_table'];
  48.     $db_time_col = $this->options['db_time_col'];
  50.     // delete the record older than the authorised session life time 
  51.     $lifetime = $this->db_escape($lifetime); // We never know...
  52.     $sql = "DELETE FROM $db_table WHERE $db_time_col + $lifetime < UNIX_TIMESTAMP()";
  54.     if (!$this->db_query($sql))
  55.     {
  56.       throw new sfDatabaseException(sprintf('%s cannot delete old sessions (%s).', get_class($this), $this->db_error()));
  57.     }
  59.     return true;
  60.   }
  62.   /**
  63.    * Reads a session.
  64.    *
  65.    * @param  string $id  A session ID
  66.    *
  67.    * @return string      The session data if the session was read or created, otherwise an exception is thrown
  68.    *
  69.    * @throws <b>sfDatabaseException</b> If the session cannot be read
  70.    */
  71.   public function sessionRead($id)
  72.   {
  73.     // get table/column
  74.     $db_table    = $this->options['db_table'];
  75.     $db_data_col = $this->options['db_data_col'];
  76.     $db_id_col   = $this->options['db_id_col'];
  77.     $db_time_col = $this->options['db_time_col'];
  79.     // cleanup the session id, just in case
  80.     $id = $this->db_escape($id);
  82.     // get the record associated with this id
  83.     $sql = "SELECT $db_data_col FROM $db_table WHERE $db_id_col = '$id'";
  85.     $result = $this->db_query($sql);
  87.     if ($result != false && $this->db_num_rows($result) == 1)
  88.     {
  89.       // found the session
  90.       $data = $this->db_fetch_row($result);
  92.       return $data[0];
  93.     }
  94.     else
  95.     {
  96.       // session does not exist, create it
  97.       $sql = "INSERT INTO $db_table ($db_id_col, $db_data_col, $db_time_col) VALUES ('$id', '', UNIX_TIMESTAMP())";
  98.       if ($this->db_query($sql))
  99.       {
  100.         return '';
  101.       }
  103.       // can't create record
  104.       throw new sfDatabaseException(sprintf('%s cannot create new record for id "%s" (%s).', get_class($this), $id, $this->db_error()));
  105.     }
  106.   }
  108.   /**
  109.    * Writes session data.
  110.    *
  111.    * @param  string $id    A session ID
  112.    * @param  string $data  A serialized chunk of session data
  113.    *
  114.    * @return bool true, if the session was written, otherwise an exception is thrown
  115.    *
  116.    * @throws <b>sfDatabaseException</b> If the session data cannot be written
  117.    */
  118.   public function sessionWrite($id, $data)
  119.   {
  120.     // get table/column
  121.     $db_table    = $this->options['db_table'];
  122.     $db_data_col = $this->options['db_data_col'];
  123.     $db_id_col   = $this->options['db_id_col'];
  124.     $db_time_col = $this->options['db_time_col'];
  126.     // cleanup the session id and data, just in case
  127.     $id   = $this->db_escape($id);
  128.     $data = $this->db_escape($data);
  130.     // update the record associated with this id
  131.     $sql = "UPDATE $db_table SET $db_data_col='$data', $db_time_col=UNIX_TIMESTAMP() WHERE $db_id_col='$id'";
  133.     if ($this->db_query($sql))
  134.     {
  135.       return true;
  136.     }
  138.     // failed to write session data
  139.     throw new sfDatabaseException(sprintf('%s cannot write session data for id "%s" (%s).', get_class($this), $id, $this->db_error()));
  140.   }
  142.   /**
  143.    * Executes an SQL Query
  144.    *
  145.    * @param  string $query  The query to execute
  146.    * @return mixed The result of the query
  147.    */
  148.   protected function db_query($query)
  149.   {
  150.     return @mysql_query($query, $this->db);
  151.   }
  153.   /**
  154.    * Escapes a string before using it in a query statement
  155.    *
  156.    * @param  string $string  The string to escape
  157.    * @return string The escaped string
  158.    */
  159.   protected function db_escape($string)
  160.   {
  161.     return mysql_real_escape_string($string, $this->db);
  162.   }
  164.   /**
  165.    * Counts the rows in a query result
  166.    *
  167.    * @param  resource $result  Result of a query
  168.    * @return int Number of rows
  169.    */
  170.   protected function db_num_rows($result)
  171.   {
  172.     return mysql_num_rows($result);
  173.   }
  175.   /**
  176.    * Extracts a row from a query result set
  177.    *
  178.    * @param  resource $result  Result of a query
  179.    * @return array Extracted row as an indexed array
  180.    */
  181.   protected function db_fetch_row($result)
  182.   {
  183.     return mysql_fetch_row($result);
  184.   }
  186.   /**
  187.    * Returns the text of the error message from previous database operation
  188.    *
  189.    * @return string The error text from the last database function
  190.    */
  191.   protected function db_error()
  192.   {
  193.     return mysql_error($this->db);
  194.   }
  195. }
Debug toolbar