Session.inc
7.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<?php
/**
* $Id$
*
* Session management class.
*
* Copyright (c) 2003 Jam Warehouse http://www.jamwarehouse.com
*
* 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; either version 2 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 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
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
* @package lib.session
*/
class Session {
/**
* Creates a session.
*
* @param int the id of the user to create a session for
* @return string the generated sessionID
*/
function create($iUserID) {
global $default;
session_start();
// bind user id to session
$_SESSION["userID"] = $iUserID;
$_SESSION["KTErrorMessage"] = array();
// use the PHP generated session id
$sessionID = session_id();
// retrieve client ip
$ip = $this->getClientIP();
$default->log->debug("Session::create() new session for $iUserID, from $ip, sessionID=$sessionID");
// insert session information into db
$sql = $default->db;
$aParams = array(
'session_id' => $sessionID,
'user_id' => $iUserID,
'lastused' => date("Y-m-d H:i:s", time()),
'ip' => $ip,
);
$result = DBUtil::autoInsert($default->sessions_table, $aParams);
if (PEAR::isError($result)) {
die("Error creating session: " . $result->toString());
}
return $sessionID;
}
/**
* Destroys the current session.
*/
function destroy() {
global $default;
session_start();
$sSessionID = session_id();
$iUserID = $_SESSION["userID"];
// remove the session information from the database
$sql = $default->db;
$query = "DELETE FROM $default->sessions_table WHERE session_id = '$sSessionID'" . ($iUserID ? " AND user_id=$iUserID" : "");
$default->log->info("Session::destroy $query");
$sql->query($query);
// remove the php4 session
session_unset();
session_destroy();
}
/**
* Removes any stale sessions for the specified userID
*
* @param int the userID to remove stale sessions for
*/
function removeStaleSessions($userID = -1) {
global $default;
// deletes any sessions for this userID where the default timeout has elapsed.
$time = time() - $default->sessionTimeout;
$sql = $default->db;
$sQuery = "DELETE FROM $default->sessions_table WHERE " . (($userID != -1) ? "user_id=$userID AND " : "") . "lastused <= '" . formatDateTime($time) . "'";
$sql->query($sQuery);
}
/**
* Used to verify the current user's session.
*
* @param boolean optional parameter set if we're downloading a file
* @return int session verification status
*/
function verify($bDownload = false) {
global $default, $lang_sesstimeout, $lang_sessinuse, $lang_err_sess_notvalid;
// this is a workaround for an SSL download bug with IE.
if ($bDownload) {
session_cache_limiter('public');
}
session_start();
$sessionID = session_id();
if (strlen($sessionID) > 0) {
// initialise return status
$sessionStatus = 0;
// this should be an existing session, so check the db
$sql = $default->db;
$sql->query(array("SELECT * FROM $default->sessions_table WHERE session_id = ?", $sessionID));/*ok*/
$numrows = $sql->num_rows($sql);
// FIXME: if there aren't more rows that the max sessions for this user
if ($numrows >= 1) {
$default->log->debug("Session::verify found session in db");
while($sql->next_record()) {
$iUserID = $sql->f("user_id");
$ip = $this->getClientIP();
// check that ip matches
if ($ip == trim($sql->f("ip"))) {
// now check if the timeout has been exceeded
$lastused = $sql->f("lastused");
$diff = time() - strtotime($lastused);
if($diff <= $default->sessionTimeout) {
// session has been verified, update status
$sessionStatus = 1;
// use userID to refresh user details and set on session
// ??: will this change during a user session?
// only set the userID if its not in the array already
if (!$_SESSION["userID"]) {
$_SESSION["userID"] = $iUserID;
}
// update last used timestamp
$aFV = array(
'lastused' => getCurrentDateTime(),
);
$aWFV = array(
'user_id' => $iUserID,
'session_id' => $sessionID,
);
$res = DBUtil::whereUpdate($default->sessions_table, $aFV, $aWFV);
// add the array to the session
$_SESSION["sessionStatus"] = $sessionStatus;
} else {
// session timed out status
$sessionStatus = 2;
// destroy this session
$this->destroy();
$_SESSION["errorMessage"] = $lang_sesstimeout;
}
} else {
// session in use status
$sessionStatus = 3;
$_SESSION["errorMessage"] = $lang_sessinuse;
}
}
} else {
// the session doesn't exist in the db
$default->log->info("Session::verify sessionID=$sessionID, not in db");
$sessionStatus = false;
}
} else {
$default->log->info("Session::verify session not in db");
// there is no session
$sessionStatus = false;
}
// remove old sessions
Session::removeStaleSessions();
// return the status
return $sessionStatus;
}
/**
* Retrieves and returns the IP address of the current user
*/
function getClientIP() {
// get client ip
if (getenv("REMOTE_ADDR")) {
$ip = getenv("REMOTE_ADDR");
} elseif(getenv("HTTP_X_FORWARDED_FOR")) {
$forwardedip = getenv("HTTP_X_FORWARDED_FOR");
list($ip,$ip2,$ip3,$ip4)= split (",", $forwardedip);
} elseif (getenv("HTTP_CLIENT_IP")) {
$ip = getenv("HTTP_CLIENT_IP");
}
return $ip;
}
}
?>