Changeset 4890

Timestamp:

08/23/07 17:48:11 (1 year ago)

Author:

fabien

Message:

refactored storage sub-framework

• removed sfContext, sfConfig and sfDatabaseManager dependencies
  
• added a new sfNoStorage to be able to disable sessions
  
• added a new sfDatabaseStorage abstract class for all database based session storage classes
  
• added unit tests
  
• simplified some calls: ->getParameterHolder()->get() to ->getParameter()
  
• fixed a bug in sfPostgreSQLSessionStorage::sessionGC()
  
• fixed coding standards
  

Files:

• trunk/data/skeleton/app/app/config/factories.yml (modified) (1 diff)
• trunk/lib/addon/creole/storage/sfCreoleSessionStorage.class.php (modified) (9 diffs)
• trunk/lib/config/sfFactoryConfigHandler.class.php (modified) (1 diff)
• trunk/lib/database/sfDatabase.class.php (modified) (3 diffs)
• trunk/lib/storage/sfDatabaseSessionStorage.class.php (added)
• trunk/lib/storage/sfMySQLSessionStorage.class.php (modified) (10 diffs)
• trunk/lib/storage/sfNoStorage.class.php (added)
• trunk/lib/storage/sfPDOSessionStorage.class.php (modified) (10 diffs)
• trunk/lib/storage/sfPostgreSQLSessionStorage.class.php (modified) (13 diffs)
• trunk/lib/storage/sfSessionStorage.class.php (modified) (8 diffs)
• trunk/lib/storage/sfSessionTestStorage.class.php (modified) (10 diffs)
• trunk/lib/storage/sfStorage.class.php (modified) (6 diffs)
• trunk/test/functional/fixtures/project/apps/backend/config/factories.yml (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/cache/config/factories.yml (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/crud/config/factories.yml (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/frontend/config/factories.yml (modified) (1 diff)
• trunk/test/functional/fixtures/project/apps/i18n/config/factories.yml (modified) (1 diff)
• trunk/test/unit/sfContextMock.class.php (modified) (1 diff)
• trunk/test/unit/storage/sfNoStorageTest.php (added)
• trunk/test/unit/storage/sfPDOSessionStorageTest.php (added)
• trunk/test/unit/storage/sfStorageTest.php (modified) (3 diffs)
• trunk/test/unit/user/sfUserTest.php (modified) (1 diff)

trunk/data/skeleton/app/app/config/factories.yml

@@ -17 +17 @@
-  storage:
-    class: sfSessionTestStorage
+    param:
+      session_path: %SF_TEST_CACHE_DIR%/sessions
-
-#all:

trunk/lib/addon/creole/storage/sfCreoleSessionStorage.class.php

@@ -16 +16 @@
- * Provides support for session storage using a CreoleDb database abstraction layer.
- *
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
- *
- * @package    symfony
@@ -40 +25 @@
- * @version    SVN: $Id$
- */
-
+Database
-{
-  /**
-   * Creole Database Connection
-   * @var Connection
-   */
-  protected $db;
-
-  /**
-   * Initialize this Storage.
-   *
-   * @param Context A Context instance.
-   * @param array   An associative array of initialization parameters.
-   *
-   * @return bool true, if initialization completes successfully, otherwise
-   *              false.
-   *
-   * @throws <b>InitializationException</b> If an error occurs while
-   *                                        initializing this Storage.
-   */
-  public function initialize($context, $parameters = null)
-  {
-    // disable auto_start
-    $parameters['auto_start'] = false;
-
-    // initialize the parent
-    parent::initialize($context, $parameters);
-
-    if (!$this->getParameterHolder()->has('db_table'))
-    {
-      // missing required 'db_table' parameter
-      throw new sfInitializationException('Factory configuration file is missing required "db_table" parameter for the Storage category.');
-    }
-
-    // use this object as the session handler
-    session_set_save_handler(array($this, 'sessionOpen'),
-                             array($this, 'sessionClose'),
-                             array($this, 'sessionRead'),
-                             array($this, 'sessionWrite'),
-                             array($this, 'sessionDestroy'),
-                             array($this, 'sessionGC'));
-
-    // start our session
-    session_start();
-  }
-
-  /**
-  * Close a session.
-  *
-  * @return bool true, if the session was closed, otherwise false.
-  */
-  public function sessionClose()
-  {
-    // do nothing
-    return true;
-  }
-
-  /**
-   * Destroy a session.
@@ -109 +39 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
+
+
-
-    // delete the record associated with this id
-
+ 
-
-    try
@@ -125 +55 @@
-      throw new sfDatabaseException(sprintf('Creole SQLException was thrown when trying to manipulate session data. Message: %s.', $e->getMessage()));
-    }
+
+    return true;
-  }
-
@@ -138 +70 @@
-  public function sessionGC($lifetime)
-  {
-    // determine deletable session time
-    $time = time() - $lifetime;
-
-    // get table/column
-Holder()->get
-Holder()->get
+
+
-
-    // delete the record associated with this id
-'.'WHERE '.$db_time_col.' < '.$time
+WHERE '.$db_time_col.' < '.(time() - $lifetime)
-
-    try
-    {
-      $this->db->executeQuery($sql);
-      return true;
-    }
-    catch (SQLException $e)
-    {
-      throw new sfDatabaseException(sprintf('Creole SQLException was thrown when trying to manipulate session data. Message: %s.', $e->getMessage()));
-    }
-  }
-
-  /**
-   * Open a session.
-   *
-   * @param string
-   * @param string
-   *
-   * @return bool true, if the session was opened, otherwise an exception is thrown.
-   *
-   * @throws <b>DatabaseException</b> If a connection with the database does
-   *                                  not exist or cannot be created.
-   */
-  public function sessionOpen($path, $name)
-  {
-    // what database are we using?
-    $database = $this->getParameterHolder()->get('database', 'default');
-
-    // autoload propel propely if we're reusing the propel connection for session storage
-    if ($this->getContext()->getDatabaseManager()->getDatabase($database) instanceof sfPropelDatabase && !Propel::isInit())
-    {
-      throw new sfDatabaseException('Creole dabatase connection is the same as the propel database connection, but could not be initialized.');
-    }
-
-    $this->db = $this->getContext()->getDatabaseConnection($database);
-    if ($this->db == null || !$this->db instanceof Connection)
-    {
-      throw new sfDatabaseException('Creole dabatase connection doesn\'t exist. Unable to open session.');
-    }
-
@@ -202 +101 @@
-  {
-    // get table/columns
-Holder()->get
-Holder()->get
-Holder()->get
-Holder()->get
+
+
+
+
-
-    try
@@ -256 +155 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
-Holder()->get
-Holder()->get
+
+
+
+
-
-    $sql = 'UPDATE '.$db_table.' SET '.$db_data_col.'=?, '.$db_time_col.' = '.time().' WHERE '.$db_id_col.'=?';
@@ -269 +168 @@
-      $stmt->setString(2, $id);
-      $stmt->executeUpdate();
-
-      return true;
-    }
-
-    catch (SQLException $e)
-    {
@@ -278 +174 @@
-    }
-
-
-
-
-
-
-
-
-
-
-
+
-  }
-}

trunk/lib/config/sfFactoryConfigHandler.class.php

@@ -127 +127 @@
-
-          // append instance initialization
-
+
+
+
+
+
+
+
-          break;
-

trunk/lib/database/sfDatabase.class.php

@@ -23 +23 @@
-{
-  protected
+    $parameterHolder = null,
-    $connection      = null,
-    $parameterHolder = null,
-    $resource        = null;
-
@@ -46 +46 @@
-  public function getConnection()
-  {
-$this->connection == null
+is_null($this->connection)
-    {
-      $this->connect();
@@ -63 +63 @@
-  public function getResource()
-  {
-$this->resource == null
+is_null($this->resource)
-    {
-      $this->connect();

trunk/lib/storage/sfMySQLSessionStorage.class.php

@@ -13 +13 @@
- * Provides support for session storage using a MySQL brand database.
- *
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
- *
- * @package    symfony
@@ -34 +21 @@
- * @version    SVN: $Id$
- */
-
+Database
-{
-  protected
-    $resource = null;
-
-  /**
-   * Initializes this Storage instance.
-   *
-   * @param sfContext A sfContext instance
-   * @param array   An associative array of initialization parameters
-   *
-   * @return boolean true, if initialization completes successfully, otherwise false
-   *
-   * @throws <b>sfInitializationException</b> If an error occurs while initializing this Storage
-   */
-  public function initialize($context, $parameters = null)
-  {
-    // disable auto_start
-    $parameters['auto_start'] = false;
-
-    // initialize the parent
-    parent::initialize($context, $parameters);
-
-    if (!$this->getParameterHolder()->has('db_table'))
-    {
-        // missing required 'db_table' parameter
-        throw new sfInitializationException('Factory configuration file is missing required "db_table" parameter for the Storage category.');
-    }
-
-    // use this object as the session handler
-    session_set_save_handler(array($this, 'sessionOpen'),
-                             array($this, 'sessionClose'),
-                             array($this, 'sessionRead'),
-                             array($this, 'sessionWrite'),
-                             array($this, 'sessionDestroy'),
-                             array($this, 'sessionGC'));
-
-    // start our session
-    session_start();
-  }
-
-  /**
-   * Closes a session.
-   *
-   * @return boolean true, if the session was closed, otherwise false
-   */
-  public function sessionClose()
-  {
-    // do nothing
-    return true;
-  }
-
-  /**
-   * Destroys a session.
@@ -98 +35 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
+
+
-
-    // cleanup the session id, just in case
-resource
+db
-
-    // delete the record associated with this id
-    $sql = 'DELETE FROM '.$db_table.' WHERE '.$db_id_col.' = \''.$id.'\'';
-
-resource
+db
-    {
-      return true;
@@ -113 +50 @@
-
-    // failed to destroy session
-
+sf
-  }
-
@@ -127 +64 @@
-  public function sessionGC($lifetime)
-  {
-    // determine deletable session time
-    $time = time() - $lifetime;
-
-    // get table/column
-Holder()->get
-Holder()->get
+
+
-
-    // delete the record associated with this id
-
-
+
-
-@mysql_query($sql, $this->resource
+!@mysql_query($sql, $this->db
-    {
-return true
+throw new sfDatabaseException('sfMySQLSessionStorage cannot delete old sessions.')
-    }
-
-    // failed to cleanup old sessions
-    throw new sfDatabaseException('MySQLSessionStorage cannot delete old sessions.');
-  }
-
-  /**
-   * Opens a session.
-   *
-   * @param string
-   * @param string
-   *
-   * @return boolean true, if the session was opened, otherwise an exception is thrown
-   *
-   * @throws <b>sfDatabaseException</b> If a connection with the database does not exist or cannot be created
-   */
-  public function sessionOpen($path, $name)
-  {
-    // what database are we using?
-    $database = $this->getParameterHolder()->get('database', 'default');
-
-    // get the database resource
-    $this->resource = $this->context->getDatabaseManager()->getDatabase($database)->getResource();
-
-    return true;
@@ -180 +91 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
-Holder()->get
-Holder()->get
+
+
+
+
-
-    // cleanup the session id, just in case
-resource
+db
-
-    // delete the record associated with this id
-
-
-
+
-
-resource
+db
-
-    if ($result != false && @mysql_num_rows($result) == 1)
@@ -205 +114 @@
-    {
-      // session does not exist, create it
-
-
-
+
-
-resource
+db
-      {
-        return '';
@@ -215 +122 @@
-
-      // can't create record
-
+sf
-    }
-  }
@@ -232 +139 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
-Holder()->get
-Holder()->get
+
+
+
+
-
-    // cleanup the session id and data, just in case
-resource
-resource
+db
+db
-
-    // delete the record associated with this id
-
-
-
-
+
-
-resource
+db
-    {
-      return true;
@@ -253 +157 @@
-
-    // failed to write session data
-
-
-
-
-
-
-
-
-
+
-  }
-}

trunk/lib/storage/sfPDOSessionStorage.class.php

@@ -13 +13 @@
- * Provides support for session storage using a PDO database abstraction layer.
- *
-
-
-
-
-
-
-
-
-
-
-
+
- *
- * @package    symfony
@@ -32 +22 @@
- * @version    SVN: $Id$
- */
-
+Database
-{
-  /**
-   * PDO connection
-   * @var Connection
-   */
-  protected $db;
-
-  /**
-   * Initializes this Storage instance.
-   *
-   * @param sfContext A sfContext instance
-   * @param array     An associative array of initialization parameters
-   *
-   * @return boolean true, if initialization completes successfully, otherwise false
-   *
-   * @throws <b>InitializationException</b> If an error occurs while initializing this Storage
-   */
-  public function initialize($context, $parameters = null)
-  {
-    // disable auto_start
-    $parameters['auto_start'] = false;
-
-    // initialize the parent
-    parent::initialize($context, $parameters);
-
-    if (!$this->getParameterHolder()->has('db_table'))
-    {
-      // missing required 'db_table' parameter
-      $error = 'Factory configuration file is missing required "db_table" parameter for the Storage category';
-
-      throw new sfInitializationException($error);
-    }
-
-    // use this object as the session handler
-    session_set_save_handler(array($this, 'sessionOpen'),
-                             array($this, 'sessionClose'),
-                             array($this, 'sessionRead'),
-                             array($this, 'sessionWrite'),
-                             array($this, 'sessionDestroy'),
-                             array($this, 'sessionGC'));
-
-    // start our session
-    session_start();
-  }
-
-  /**
-  * Closes a session.
-  *
-  * @return boolean true, if the session was closed, otherwise false
-  */
-  public function sessionClose()
-  {
-    // do nothing
-    return true;
-  }
-
-  /**
-   * Destroys a session.
@@ -101 +36 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
+
+
-
-    // delete the record associated with this id
@@ -110 +45 @@
-    {
-      $stmt = $this->db->prepare($sql);
- // setString(1, $id);
+
-      $stmt->execute();
-    }
-    catch (PDOException $e)
-    {
-
-
-
+
-    }
-  }
@@ -132 +65 @@
-  public function sessionGC($lifetime)
-  {
-    // determine deletable session time
-    $time = time() - $lifetime;
-
-    // get table/column
-Holder()->get
-Holder()->get
+
+
-
-    // delete the record associated with this id
-$time
+(time() - $lifetime)
-
-    try
-    {
-      $this->db->query($sql);
-      return true;
-    }
-    catch (PDOException $e)
-    {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-    }
-
@@ -193 +96 @@
-  {
-    // get table/columns
-Holder()->get
-Holder()->get
-Holder()->get
-Holder()->get
+
+
+
+
-
-    try
@@ -216 +119 @@
-
-        $stmt = $this->db->prepare($sql);
- // setString(1, $id);
- // setString(2, '');
- // setInt(3, time());
+
+
+
-        $stmt->execute();
-
@@ -226 +129 @@
-    catch (PDOException $e)
-    {
-
-
-
+
-    }
-  }
@@ -245 +146 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
-Holder()->get
-Holder()->get
+
+
+
+
-
-    $sql = 'UPDATE '.$db_table.' SET '.$db_data_col.' = ?, '.$db_time_col.' = '.time().' WHERE '.$db_id_col.'= ?';
@@ -255 +156 @@
-    {
-      $stmt = $this->db->prepare($sql);
- // setString(1, $data);
- // setString(2, $id);
+
+
-      $stmt->execute();
-      return true;
-    }
-
-    catch (PDOException $e)
-    {
-
-
-
+
-    }
-
-    return false;
-  }
-
-  /**
-   * Executes the shutdown procedure.
-   *
-   */
-  public function shutdown()
-  {
-  }
-}

trunk/lib/storage/sfPostgreSQLSessionStorage.class.php

@@ -13 +13 @@
- * Provides support for session storage using a PostgreSQL brand database.
- *
-
-
-
-
-
-
-
-
-
-
-
-
-
+
- *
- * @package    symfony
@@ -33 +21 @@
- * @version    SVN: $Id$
- */
-
+Database
-{
-  protected
-    $resource = null;
-
-  /**
-   * Initializes this Storage instance.
-   *
-   * @param sfContext A sfContext instance
-   * @param array   An associative array of initialization parameters
-   *
-   * @return boolean true, if initialization completes successfully, otherwise false
-   *
-   * @throws <b>sfInitializationException</b> If an error occurs while initializing this Storage
-   */
-  public function initialize($context, $parameters = null)
-  {
-    // disable auto_start
-    $parameters['auto_start'] = false;
-
-    // initialize the parent
-    parent::initialize($context, $parameters);
-
-    if (!$this->getParameterHolder()->has('db_table'))
-    {
-      // missing required 'db_table' parameter
-      throw new sfInitializationException('Factory configuration file is missing required "db_table" parameter for the Storage category.');
-    }
-
-    // use this object as the session handler
-    session_set_save_handler(array($this, 'sessionOpen'),
-                             array($this, 'sessionClose'),
-                             array($this, 'sessionRead'),
-                             array($this, 'sessionWrite'),
-                             array($this, 'sessionDestroy'),
-                             array($this, 'sessionGC'));
-
-    // start our session
-    session_start();
-  }
-
-  /**
-   * Closes a session.
-   *
-   * @return boolean true, if the session was closed, otherwise false
-   */
-  public function sessionClose()
-  {
-    // do nothing
-    return true;
-  }
-
-  /**
-   * Destroys a session.
@@ -97 +35 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
+
+
-
-    // cleanup the session id, just in case
@@ -106 +44 @@
-    $sql = 'DELETE FROM '.$db_table.' WHERE '.$db_id_col.' = \''.$id.'\'';
-
-resource
+db
-    {
-      return true;
@@ -112 +50 @@
-
-    // failed to destroy session
-
+sf
-  }
-
@@ -126 +64 @@
-  public function sessionGC($lifetime)
-  {
-    // determine deletable session time
-    $time = time() - $lifetime;
-
-    // get table/column
-Holder()->get
-Holder()->get
+
+
-
-    // delete the record associated with this id
-$lifetime
+(time() - $lifetime)
-
-@pg_query($this->resource
+!@pg_query($this->db
-    {
-return true
+throw new sfDatabaseException('sfPostgreSQLSessionStorage cannot delete old sessions.')
-    }
-
-    // failed to cleanup old sessions
-    throw new sfDatabaseException('PostgreSQLSessionStorage cannot delete old sessions.');
-  }
-
-  /**
-   * Opens a session.
-   *
-   * @param string
-   * @param string
-   *
-   * @return boolean true, if the session was opened, otherwise an exception is thrown
-   *
-   * @throws <b>sfDatabaseException</b> If a connection with the database does
-   *                                  not exist or cannot be created
-   */
-  public function sessionOpen($path, $name)
-  {
-    // what database are we using?
-    $database = $this->getParameterHolder()->get('database', 'default');
-
-    // get the database resource
-    $this->resource = $this->context->getDatabaseManager()->getDatabase($database)->getResource();
-
-    return true;
@@ -179 +91 @@
-  {
-    // get table/column
-Holder()->get
-Holder()->get
-Holder()->get
-Holder()->get
+
+
+
+
-
-    // cleanup the session id, just in case
@@ -188 +100 @@
-
-    // delete the record associated with this id
-
-
-
+
-
-resource
+db