/src/Network/Session/DatabaseSession.php
PHP | 156 lines | 67 code | 16 blank | 73 comment | 5 complexity | e3ce97c4005e4e347596ac1d9abf95f5 MD5 | raw file
- <?php
- /**
- * Database Session save handler. Allows saving session information into a model.
- *
- * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
- * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
- *
- * Licensed under The MIT License
- * For full copyright and license information, please see the LICENSE.txt
- * Redistributions of files must retain the above copyright notice.
- *
- * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
- * @link http://cakephp.org CakePHP(tm) Project
- * @since 2.0.0
- * @license http://www.opensource.org/licenses/mit-license.php MIT License
- */
- namespace Cake\Network\Session;
- use Cake\ORM\Entity;
- use Cake\ORM\TableRegistry;
- use SessionHandlerInterface;
- /**
- * DatabaseSession provides methods to be used with Session.
- *
- */
- class DatabaseSession implements SessionHandlerInterface
- {
- /**
- * Reference to the table handling the session data
- *
- * @var \Cake\ORM\Table
- */
- protected $_table;
- /**
- * Number of seconds to mark the session as expired
- *
- * @var int
- */
- protected $_timeout;
- /**
- * Constructor. Looks at Session configuration information and
- * sets up the session model.
- *
- * @param array $config The configuration for this engine. It requires the 'model'
- * key to be present corresponding to the Table to use for managing the sessions.
- */
- public function __construct(array $config = [])
- {
- if (empty($config['model'])) {
- $config = TableRegistry::exists('Sessions') ? [] : ['table' => 'sessions'];
- $this->_table = TableRegistry::get('Sessions', $config);
- } else {
- $this->_table = TableRegistry::get($config['model']);
- }
- $this->_timeout = ini_get('session.gc_maxlifetime');
- }
- /**
- * Method called on open of a database session.
- *
- * @param string $savePath The path where to store/retrieve the session.
- * @param string $name The session name.
- * @return bool Success
- */
- public function open($savePath, $name)
- {
- return true;
- }
- /**
- * Method called on close of a database session.
- *
- * @return bool Success
- */
- public function close()
- {
- return true;
- }
- /**
- * Method used to read from a database session.
- *
- * @param int|string $id The key of the value to read
- * @return mixed The value of the key or false if it does not exist
- */
- public function read($id)
- {
- $result = $this->_table
- ->find('all')
- ->select(['data'])
- ->where([$this->_table->primaryKey() => $id])
- ->hydrate(false)
- ->first();
- if (empty($result)) {
- return false;
- }
- if (is_string($result['data'])) {
- return $result['data'];
- }
- return stream_get_contents($result['data']);
- }
- /**
- * Helper function called on write for database sessions.
- *
- * @param int $id ID that uniquely identifies session in database
- * @param mixed $data The value of the data to be saved.
- * @return bool True for successful write, false otherwise.
- */
- public function write($id, $data)
- {
- if (!$id) {
- return false;
- }
- $expires = time() + $this->_timeout;
- $record = compact('data', 'expires');
- $record[$this->_table->primaryKey()] = $id;
- $result = $this->_table->save(new Entity($record));
- return (bool)$result;
- }
- /**
- * Method called on the destruction of a database session.
- *
- * @param int $id ID that uniquely identifies session in database
- * @return bool True for successful delete, false otherwise.
- */
- public function destroy($id)
- {
- return (bool)$this->_table->delete(new Entity(
- [$this->_table->primaryKey() => $id],
- ['markNew' => false]
- ));
- }
- /**
- * Helper function called on gc for database sessions.
- *
- * @param string $maxlifetime Sessions that have not updated for the last maxlifetime seconds will be removed.
- * @return bool True on success, false on failure.
- */
- public function gc($maxlifetime)
- {
- $this->_table->deleteAll(['expires <' => time() - $maxlifetime]);
- return true;
- }
- }