Session.inc
10.4 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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
<?php
/**
* $Id$
*
* Session management class.
*
* KnowledgeTree Open Source Edition
* Document Management Made Simple
* Copyright (C) 2004 - 2008 The Jam Warehouse Software (Pty) Limited
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 3 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, see <http://www.gnu.org/licenses/>.
*
* You can contact The Jam Warehouse Software (Pty) Limited, Unit 1, Tramber Place,
* Blake Street, Observatory, 7925 South Africa. or email info@knowledgetree.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
* must display the words "Powered by KnowledgeTree" and retain the original
* copyright notice.
* Contributor( s): ______________________________________
*/
class Session {
var $_bNotEmpty = true;
/**
* Creates a session.
*
* @param int the id of the user to create a session for
* @return string the generated sessionID
*/
function create(&$oUser) {
$iUserId = $oUser->getId();
global $default;
session_start();
// Don't need to lock a user out the web interface if KT Tools exists and has no license.
if (KTPluginUtil::pluginIsActive('ktdms.wintools')) {
if (!$oUser->isAnonymous()) {
require_once(KT_DIR . '/plugins/wintools/baobabkeyutil.inc.php');
$res = BaobabKeyUtil::isValidUser($oUser);
if (PEAR::isError($res)) {
return $res;
}
}
}
if ($oUser->getDisabled() == 1) {
return PEAR::raiseError(_kt("Your account has been disabled. Please contact the system administrator for assistance."));
}
// 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();
if (KTLOG_CACHE) $default->log->debug("Session::create() new session for $iUserId, from $ip, sessionID=$sessionID");
// insert session information into 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());
}
$_SESSION['sessionID'] = $result;
$aParams = array(
'userid' => $iUserId,
'datetime' => date("Y-m-d H:i:s", time()),
'actionnamespace' => 'ktcore.user_history.login',
'comments' => sprintf('Logged in from %s', $ip),
'sessionid' => $_SESSION['sessionID'],
);
require_once(KT_LIB_DIR . '/users/userhistory.inc.php');
$res = KTUserHistory::createFromArray($aParams);
$oUser->setLastLogin(getCurrentDateTime());
$oUser->update();
$oProvider =& KTAuthenticationUtil::getAuthenticationProviderForUser($oUser);
$oProvider->login($oUser);
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
$sTable = KTUtil::getTableName('sessions');
$res = DBUtil::whereDelete($sTable, array('session_id' => $sSessionID));
$aParams = array(
'userid' => $iUserId,
'datetime' => date("Y-m-d H:i:s", time()),
'actionnamespace' => 'ktcore.user_history.logout',
'sessionid' => $_SESSION['sessonID'],
);
require_once(KT_LIB_DIR . '/users/userhistory.inc.php');
$res = KTUserHistory::createFromArray($aParams);
// remove the php4 session
unset($_SESSION['userID']);
unset($_SESSION['sessionStatus']);
session_unset();
session_destroy();
}
/**
* Removes any stale sessions for the specified userID
*
* @param int the userID to remove stale sessions for
*/
function removeStaleSessions() {
global $default;
$time = time() - $default->sessionTimeout;
$sTable = KTUtil::getTableName('sessions');
$aQuery = array(
sprintf('SELECT id, lastused, user_id FROM %s WHERE lastused <= ?', $sTable),
array(formatDateTime($time)),
);
$aSessions = DBUtil::getResultArray($aQuery);
foreach ($aSessions as $aSessionData) {
$iId = $aSessionData['id'];
$dLastUsed = $aSessionData['lastused'];
$iUserId = $aSessionData['user_id'];
$iTime = strtotime($dLastUsed);
$iTime = $iTime + $default->sessionTimeout;
$aParams = array(
'userid' => $iUserId,
'datetime' => formatDateTime($iTime),
'actionnamespace' => 'ktcore.user_history.timeout',
'comments' => 'Session timed out',
'sessionid' => $_SESSION['sessionID'],
);
require_once(KT_LIB_DIR . '/users/userhistory.inc.php');
$res = KTUserHistory::createFromArray($aParams);
DBUtil::whereDelete($sTable, array('id' => $iId));
}
}
/**
* Used to verify the current user's session.
*/
function verify() {
global $default;
// this is a workaround for an SSL download bug with IE.
session_cache_limiter('none');
session_start();
header("Cache-Control: must-revalidate");
header("Expires: " . gmdate("D, d M Y H:i:s", time() - 3600) . " GMT");
$sessionID = session_id();
$version = KTUtil::getSystemSetting('databaseVersion');
if ($default->systemVersion != $version) {
if (KTLOG_CACHE) $default->log->info("Session::verify : Database not upgraded");
return PEAR::raiseError(sprintf(_kt('Database incompatibility error: <br> Please ensure that you have completed the database upgrade procedure. <br> Please <a href=%s>click here</a> to complete.'),'setup/upgrade.php' ));
}
if (empty($sessionID)) {
if (KTLOG_CACHE) $default->log->info("Session::verify session not in db");
return PEAR::raiseError(_kt('You need to login to access this page'));
}
// this should be an existing session, so check the db
$aRows = DBUtil::getResultArray(array("SELECT * FROM $default->sessions_table WHERE session_id = ?", $sessionID));
$numrows = count($aRows);
// FIXME: if there aren't more rows that the max sessions for this user
if ($numrows < 1) {
// the session doesn't exist in the db
if (KTLOG_CACHE) $default->log->info("Session::verify sessionID=$sessionID, not in db");
return PEAR::raiseError(_kt('You need to login to access this page'));
return false;
}
if (KTLOG_CACHE) $default->log->debug("Session::verify found session in db");
$aRow = $aRows[0];
$iUserID = $aRow["user_id"];
$oKTConfig = KTConfig::getSingleton();
$allowAnon = $oKTConfig->get('session/allowAnonymousLogin', false);
$ANON = -2;
if ((!$allowAnon) && ($iUserID == $ANON)) {
Session::destroy(); // delete the anonymous session - config.ini has changed under this session.
return PEAR::raiseError(_kt("Anonymous logins are no longer allowed by the system administrator. Please login."));
}
$ipTracking = $oKTConfig->get('session/ipTracking', false);
// check that ip matches
$ip = $this->getClientIP();
if ($ipTracking && ($ip != trim($aRow["ip"]))) {
return PEAR::raiseError(_kt("You are coming from a different IP address than the session requires"));
}
if (empty($_SESSION['userID'])) {
Session::removeStaleSessions();
return PEAR::raiseError(_kt('Session timed out'));
}
// now check if the timeout has been exceeded
$lastused = $aRow["lastused"];
$diff = time() - strtotime($lastused);
if($diff <= $default->sessionTimeout) {
// 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;
Session::removeStaleSessions();
return true;
} else {
Session::removeStaleSessions();
return PEAR::raiseError(_kt('Session timed out'));
}
Session::removeStaleSessions();
return false;
}
/**
* 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;
}
}
?>