#
# This file is part of wfpl.
#
-# wfpl 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; either version 2, or (at your option)
+# wfpl is free software; you can redistribute it and/or modify it under the
+# terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation; either version 2.1 of the License, or (at your option)
# any later version.
#
-# wfpl 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.
+# wfpl 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 Lesser General Public License for
+# more details.
#
-# You should have received a copy of the GNU General Public License
-# along with wfpl; see the file COPYING. If not, write to the
-# Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-# MA 02111-1307, USA.
-
-# you'll need this file that calles db_connect()
-require_once('db_connect.php');
+# You should have received a copy of the GNU Lesser General Public License
+# along with wfpl; if not, write to the Free Software Foundation, Inc., 51
+# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+# you'll need this file that calls db_connect()
+if(!isset($GLOBALS['wfpl_db_handle'])) {
+ if(file_exists('db_connect.php')) {
+ require_once('db_connect.php');
+ } elseif(file_exists('code/db_connect.php')) {
+ require_once('code/db_connect.php');
+ } else {
+ die("session.php requires a file db_connect.php or that you call db_connect() first. See code/wfpl/db.php for more information.");
+ }
+}
# and these database tables:
-# create table sessions (id int unique auto_increment, session_key varchar(16), length int, expires int);
-# create table session_data (id int unique auto_increment, session_id int, name varchar(100), value text);
+# create table wfpl_sessions (id int unique auto_increment, session_key varchar(16), length int, expires int);
+# create table wfpl_session_data (id int unique auto_increment, session_id int, name varchar(100), value text);
+# run this command to install/clear the tables:
+# mysql DATABASE_NAME < code/wfpl/examples/session.sql
+# note: you may need these parameters for mysql: -u USERNAME -p
# GLOSSARY
#
# generate a new random 16-character string
function session_generate_key() {
- $character_set = "abcdefghijklmnopqrstuvwqyzABCDEFGHIJKLMNOPQRSTUVWQYZ0123456789";
+ $character_set = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
$id = " ";
# PHP 4.2.0 and up seed the random number generator for you.
function session_new($length = 86400) {
$session_key = session_generate_key();
- db_insert('sessions', 'session_key,length', $session_key, $length);
+ db_insert('wfpl_sessions', 'session_key,length', $session_key, $length);
$GLOBALS['session_id'] = db_auto_id();
$GLOBALS['session_key'] = $session_key;
$_REQUEST['session_key'] = $session_key; #just in case someone calls session_exists() after session_new()
session_touch($length);
+ return $GLOBALS['session_key'];
}
# call to renew the timeout for the session.
# assumes there's a session. call session_init() if you'd like one auto-create one if not found.
function session_touch($length = false) {
if(!$length) {
- $length = db_get_value('sessions', 'length', 'id = %i', $GLOBALS['session_id']);
+ $length = db_get_value('wfpl_sessions', 'length', 'where id=%i', $GLOBALS['session_id']);
}
$expires = time() + $length;
header('Set-Cookie: session_key=' . $GLOBALS['session_key']);
- db_update('sessions', 'expires', $expires, 'id = %i', $GLOBALS['session_id']);
+ db_update('wfpl_sessions', 'expires', $expires, 'where id=%i', $GLOBALS['session_id']);
+}
+
+# delete the current session
+function kill_session() {
+ if(!session_exists()) {
+ return;
+ }
+ _kill_session($GLOBALS['session_id']);
+}
+
+# for internal use. use kill_session() above
+function _kill_session($id) {
+ db_delete('wfpl_session_data', 'where session_id=%i', $id);
+ db_delete('wfpl_sessions', 'where id=%i', $id);
}
# delete expired sessions from database
function session_purge_old() {
$now = time();
- $exired_sessions = db_get_column('sessions', 'id', 'expires < %i', $now);
- db_delete('sessions', 'expires < %i', $now);
- if($expired_sessions) {
- foreach($expired_sessions as $expired_session) {
- db_delete('session_data', 'session_id=%i', $expired_session);
- }
+ $expired_sessions = db_get_column('wfpl_sessions', 'id', 'where expires < %i', $now);
+ if($expired_sessions) foreach($expired_sessions as $expired_session) {
+ _kill_session($expired_session);
}
}
return false;
}
+ if(isset($GLOBALS['session_id'])) {
+ return true;
+ }
+
$session_key = ereg_replace('[^a-zA-Z0-9]', '', $_REQUEST['session_key']);
if(!strlen($session_key) == 16) {
$GLOBALS['session_key'] = $session_key;
session_purge_old();
- $id = db_get_value('sessions', 'id', 'session_key = %"', $session_key);
+ $id = db_get_value('wfpl_sessions', 'id', 'where session_key=%"', $session_key);
if($id === false) {
return false;
}
# save a variable into the session
function session_set($name, $value) {
- db_replace('session_data', 'name,value', $name, $value);
+ session_clear($name);
+ db_insert('wfpl_session_data', 'session_id,name,value', $GLOBALS['session_id'], $name, $value);
+}
+
+# remove variable from the session
+function session_clear($name) {
+ db_delete('wfpl_session_data', 'where session_id=%i && name=%"', $GLOBALS['session_id'], $name);
}
# get a variable into the session
function session_get($name) {
- return db_get_value('session_data', 'value', 'name=%"', $name);
+ return db_get_value('wfpl_session_data', 'value', 'where session_id=%i && name=%"', $GLOBALS['session_id'], $name);
}
?>
Got questions, comments, patches, etc.? Contact Jason Woofenden