Files
Piwigo/include/functions_session.inc.php
nikrou 0b28c9da75 improve sessions: add comments to functions
git-svn-id: http://piwigo.org/svn/trunk@1010 68402e56-0260-453c-a942-63ccdbb3a9ee
2006-01-21 10:56:36 +00:00

160 lines
4.2 KiB
PHP

<?php
// +-----------------------------------------------------------------------+
// | PhpWebGallery - a PHP based picture gallery |
// | Copyright (C) 2002-2003 Pierrick LE GALL - pierrick@phpwebgallery.net |
// | Copyright (C) 2003-2005 PhpWebGallery Team - http://phpwebgallery.net |
// +-----------------------------------------------------------------------+
// | branch : BSF (Best So Far)
// | file : $RCSfile$
// | last update : $Date$
// | last modifier : $Author$
// | revision : $Revision$
// +-----------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or modify |
// | it under the terms of the GNU General Public License as published by |
// | the Free Software Foundation |
// | |
// | 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 |
// | General Public License for more details. |
// | |
// | You should have received a copy of the GNU General Public License |
// | along with this program; if not, write to the Free Software |
// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
// | USA. |
// +-----------------------------------------------------------------------+
if (isset($conf['session_save_handler'])
and ($conf['session_save_handler'] == 'db'))
{
session_set_save_handler('pwg_session_open',
'pwg_session_close',
'pwg_session_read',
'pwg_session_write',
'pwg_session_destroy',
'pwg_session_gc'
);
}
ini_set('session.use_cookies', $conf['session_use_cookies']);
ini_set('session.use_only_cookies', $conf['session_use_only_cookies']);
ini_set('session.use_trans_sid', intval($conf['session_use_trans_sid']));
ini_set('session.name', $conf['session_name']);
/**
* returns true; used when the session_start() function is called
*
* @params not use but useful for php engine
*/
function pwg_session_open($path, $name)
{
return true;
}
/**
* returns true; used when the session is closed (unset($_SESSION))
*
*/
function pwg_session_close()
{
pwg_session_gc();
return true;
}
/**
* this function returns
* a string corresponding to the value of the variable save in the session
* or an empty string when the variable doesn't exist
*
* @param string session id
*/
function pwg_session_read($session_id)
{
$query = '
SELECT data
FROM '.SESSIONS_TABLE.'
WHERE id = \''.$session_id.'\'
;';
$result = pwg_query($query);
if ($result)
{
$row = mysql_fetch_assoc($result);
return $row['data'];
}
else
{
return '';
}
}
/**
* returns true; writes set a variable in the active session
*
* @param string session id
* @data string value of date to be saved
*/
function pwg_session_write($session_id, $data)
{
$query = '
SELECT id
FROM '.SESSIONS_TABLE.'
WHERE id = \''.$session_id.'\'
;';
$result = pwg_query($query);
if (mysql_num_rows($result))
{
$query = '
UPDATE '.SESSIONS_TABLE.'
SET expiration = now()
WHERE id = \''.$session_id.'\'
;';
pwg_query($query);
}
else
{
$query = '
INSERT INTO '.SESSIONS_TABLE.'
(id,data,expiration)
VALUES(\''.$session_id.'\',\''.$data.'\',now())
;';
pwg_query($query);
}
return true;
}
/**
* returns true; delete the active session
*
* @param string session id
*/
function pwg_session_destroy($session_id)
{
$query = '
DELETE
FROM '.SESSIONS_TABLE.'
WHERE id = \''.$session_id.'\'
;';
pwg_query($query);
return true;
}
/**
* returns true; delete expired sessions
* called each time a session is closed.
*/
function pwg_session_gc()
{
global $conf;
$query = '
DELETE
FROM '.SESSIONS_TABLE.'
WHERE UNIX_TIMESTAMP(NOW()) - UNIX_TIMESTAMP(expiration) > '
.$conf['session_length'].'
;';
pwg_query($query);
return true;
}
?>