gnu-social/classes/Session.php

219 lines
6.8 KiB
PHP
Raw Normal View History

2009-06-27 13:15:59 +01:00
<?php
/**
* Table Definition for session
*
2009-08-25 23:14:12 +01:00
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2009, StatusNet, Inc.
2009-06-27 13:15:59 +01:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
2009-06-27 13:15:59 +01:00
require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
2009-06-27 13:15:59 +01:00
2011-08-22 22:52:02 +01:00
class Session extends Managed_DataObject
2009-06-27 13:15:59 +01:00
{
###START_AUTOCODE
/* the code below is auto generated do not remove the above tag */
public $__table = 'session'; // table name
2009-06-27 13:15:59 +01:00
public $id; // varchar(32) primary_key not_null
public $session_data; // text()
public $created; // datetime() not_null
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
2009-06-27 13:15:59 +01:00
/* the code above is auto generated do not remove the tag below */
###END_AUTOCODE
2011-08-22 22:52:02 +01:00
public static function schemaDef()
{
return [
'fields' => [
'id' => ['type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'session ID'],
'session_data' => ['type' => 'text', 'description' => 'session data'],
'created' => ['type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'],
'modified' => ['type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'],
],
'primary key' => ['id'],
'indexes' => [
'session_modified_idx' => ['modified'],
],
];
2009-06-27 15:09:21 +01:00
}
static function open($save_path, $session_name)
{
return true;
}
static function close()
{
return true;
}
static function read($id)
{
2009-06-27 15:09:21 +01:00
self::logdeb("Fetching session '$id'");
$session = Session::getKV('id', $id);
if (empty($session)) {
2010-01-28 18:53:28 +00:00
self::logdeb("Couldn't find '$id'");
return '';
} else {
2010-01-28 18:53:28 +00:00
self::logdeb("Found '$id', returning " .
strlen($session->session_data) .
" chars of data");
return (string)$session->session_data;
}
}
static function logdeb($msg)
{
if (common_config('sessions', 'debug')) {
common_debug("Session: " . $msg);
}
}
static function write($id, $session_data)
{
2009-06-27 15:09:21 +01:00
self::logdeb("Writing session '$id'");
$session = Session::getKV('id', $id);
if (empty($session)) {
2010-01-28 18:53:28 +00:00
self::logdeb("'$id' doesn't yet exist; inserting.");
$session = new Session();
$session->id = $id;
$session->session_data = $session_data;
$session->created = common_sql_now();
2010-01-28 18:53:28 +00:00
$result = $session->insert();
if (!$result) {
common_log_db_error($session, 'INSERT', __FILE__);
self::logdeb("Failed to insert '$id'.");
} else {
self::logdeb("Successfully inserted '$id' (result = $result).");
}
return $result;
} else {
2010-01-28 18:53:28 +00:00
self::logdeb("'$id' already exists; updating.");
2009-10-09 15:39:56 +01:00
if (strcmp($session->session_data, $session_data) == 0) {
self::logdeb("Not writing session '$id'; unchanged");
return true;
} else {
self::logdeb("Session '$id' data changed; updating");
$orig = clone($session);
$session->session_data = $session_data;
2010-01-28 18:53:28 +00:00
$result = $session->update($orig);
if (!$result) {
common_log_db_error($session, 'UPDATE', __FILE__);
self::logdeb("Failed to update '$id'.");
} else {
self::logdeb("Successfully updated '$id' (result = $result).");
}
return $result;
2009-10-09 15:39:56 +01:00
}
}
}
static function gc($maxlifetime)
{
2009-06-27 15:09:21 +01:00
self::logdeb("garbage collection (maxlifetime = $maxlifetime)");
2009-07-21 19:31:34 +01:00
$epoch = common_sql_date(time() - $maxlifetime);
$ids = [];
2009-08-02 16:18:41 +01:00
$session = new Session();
$session->whereAdd('modified < "' . $epoch . '"');
2009-08-02 16:18:41 +01:00
$session->selectAdd();
$session->selectAdd('id');
2009-06-27 15:09:21 +01:00
$limit = common_config('sessions', 'gc_limit');
if ($limit > 0) {
// On large sites, too many sessions to expire
// at once will just result in failure.
$session->limit($limit);
}
$session->find();
while ($session->fetch()) {
2009-08-02 16:18:41 +01:00
$ids[] = $session->id;
}
$session->free();
2009-08-02 16:18:41 +01:00
2010-01-28 18:53:28 +00:00
self::logdeb("Found " . count($ids) . " ids to delete.");
2009-08-02 16:18:41 +01:00
foreach ($ids as $id) {
2010-01-28 18:53:28 +00:00
self::logdeb("Destroying session '$id'.");
2009-08-02 16:18:41 +01:00
self::destroy($id);
}
}
static function destroy($id)
{
self::logdeb("Deleting session $id");
$session = Session::getKV('id', $id);
if (empty($session)) {
self::logdeb("Can't find '$id' to delete.");
return false;
} else {
$result = $session->delete();
if (!$result) {
common_log_db_error($session, 'DELETE', __FILE__);
self::logdeb("Failed to delete '$id'.");
} else {
self::logdeb("Successfully deleted '$id' (result = $result).");
}
return $result;
}
}
static function setSaveHandler()
{
2009-06-27 15:09:21 +01:00
self::logdeb("setting save handlers");
$result = session_set_save_handler('Session::open', 'Session::close', 'Session::read',
'Session::write', 'Session::destroy', 'Session::gc');
self::logdeb("save handlers result = $result");
// PHP 5.3 with APC ends up destroying a bunch of object stuff before the session
// save handlers get called on request teardown.
// Registering an explicit shutdown function should take care of this before
// everything breaks on us.
register_shutdown_function('Session::cleanup');
2009-06-27 15:09:21 +01:00
return $result;
}
static function cleanup()
{
session_write_close();
}
2009-06-27 13:15:59 +01:00
}