Source for file SessionHandler.php
Documentation is available at SessionHandler.php
* Copyright (c) 2009 - 2011, RealDolmen
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of RealDolmen nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY RealDolmen ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL RealDolmen BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* @package Microsoft_WindowsAzure
* @copyright Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
* @license http://phpazure.codeplex.com/license
* @version $Id: Storage.php 21617 2009-06-12 10:46:31Z unknown $
* @see Microsoft_AutoLoader
require_once dirname(__FILE__ ) . '/../AutoLoader.php';
* @package Microsoft_WindowsAzure
* @copyright Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
* @license http://phpazure.codeplex.com/license
* Maximal property size in table storage.
* @see http://msdn.microsoft.com/en-us/library/dd179338.aspx
const MAX_TS_PROPERTY_SIZE = 65536;
/** Storage backend type */
const STORAGE_TYPE_TABLE = 'table';
const STORAGE_TYPE_BLOB = 'blob';
* @var Microsoft_WindowsAzure_Storage_Table|Microsoft_WindowsAzure_Storage_Blob
* Session container partition
* Creates a new Microsoft_WindowsAzure_SessionHandler instance
* @param Microsoft_WindowsAzure_Storage_Table|Microsoft_WindowsAzure_Storage_Blob$storage Storage back-end, can be table storage and blob storage
* @param string $sessionContainer Session container name
* @param string $sessionContainerPartition Session container partition
public function __construct(Microsoft_WindowsAzure_Storage $storage, $sessionContainer = 'phpsessions', $sessionContainerPartition = 'sessions')
throw new Microsoft_WindowsAzure_Exception('Invalid storage back-end given. Storage back-end should be of type Microsoft_WindowsAzure_Storage_Table or Microsoft_WindowsAzure_Storage_Blob.');
// Validate other parameters
if ($sessionContainer == '' || $sessionContainerPartition == '') {
// Determine storage type
$storageType = self::STORAGE_TYPE_TABLE;
$storageType = self::STORAGE_TYPE_BLOB;
* Registers the current session handler as PHP's session handler
// Make sure storage container exists
} else if ($this->_storageType == self::STORAGE_TYPE_BLOB) {
* Close the session store
* Read a specific session
* @param int $id Session Id
public function read($id)
$sessionRecord = $this->_storage->retrieveEntityById(
} else if ($this->_storageType == self::STORAGE_TYPE_BLOB) {
* Write a specific session
* @param int $id Session Id
* @param string $serializedData Serialized PHP object
public function write($id, $serializedData)
if (strlen($serializedData) >= self::MAX_TS_PROPERTY_SIZE && $this->_storageType == self::STORAGE_TYPE_TABLE) {
throw new Microsoft_WindowsAzure_Exception('Session data exceeds the maximum allowed size of ' . self::MAX_TS_PROPERTY_SIZE . ' bytes that can be stored using table storage. Consider switching to a blob storage back-end or try reducing session data size.');
$sessionRecord->sessionExpires = time();
$sessionRecord->serializedData = $serializedData;
$sessionRecord->setAzurePropertyType('sessionExpires', 'Edm.Int32');
} else if ($this->_storageType == self::STORAGE_TYPE_BLOB) {
array('sessionexpires' => time())
* Destroy a specific session
* @param int $id Session Id
$sessionRecord = $this->_storage->retrieveEntityById(
} else if ($this->_storageType == self::STORAGE_TYPE_BLOB) {
* @param int $lifeTime Session maximal lifetime
* @see session.gc_divisor 100
* @see session.gc_maxlifetime 1440
* @see session.gc_probability 1
* @usage Execution rate 1/100 (session.gc_probability/session.gc_divisor)
public function gc($lifeTime)
foreach ($result as $sessionRecord)
catch (Microsoft_WindowsAzure_exception $ex)
} else if ($this->_storageType == self::STORAGE_TYPE_BLOB) {
foreach ($result as $sessionRecord)
if ($sessionRecord->Metadata['sessionexpires'] < (time() - $lifeTime)) {
catch (Microsoft_WindowsAzure_exception $ex)
|