Session.inc
7.28 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
<?php
/**
* $Id$
*
* This class is used for session management.
*
* @author <a href="mailto:michael@jamwarehouse.com">Michael Joseph</a>, Jam Warehouse (Pty) Ltd, South Africa
* @version $Revision$
* @package dmslib
*/
class Session {
/**
* Creates a session.
*
* @param array $userDetails the details of the user to create a session for
* @return string the generated sessionID
*/
function create($userDetails) {
global $default;
session_start();
// bind user details to session
$_SESSION["userID"] = $userDetails["userID"];
/*
$_SESSION["groupID"] = $userDetails["groupID"];
$_SESSION["unitID"] = $userDetails["unitID"];
$_SESSION["organisationID"] = $userDetails["organisationID"];
$_SESSION["username"] = $userDetails["username"];
*/
$default->log->debug("Session::create session variables=" . arrayToString($_SESSION));
// use the PHP generated session id
$sessionID = session_id();
// retrieve client ip
$ip = $this->getClientIP();
// insert session information into db
$sql = new Owl_DB;
$query = "INSERT INTO $default->owl_sessions_table (session_id, user_id, lastused, ip) VALUES ('$sessionID', '$userID', '" . date("Y-m-d H:i:s", time()) . "', '$ip')";
$result = $sql->query($query);
if(!$result) {
die("$lang_err_sess_write");
}
return $sessionID;
}
/**
* Destroys the current session.
*/
function destroy() {
global $default;
session_start();
// remove the session information from the database
$sql = new Owl_DB;
$query = "DELETE FROM $default->owl_sessions_table WHERE session_id = '" . session_id() . "'";
$sql->query($query);
// remove the php4 session
session_unset();
session_destroy();
}
/**
* Removes any stale sessions for the specified userID
*
* @param userID
* the userID to remove stale sessions for
*/
function removeStaleSessions($userID) {
global $default;
// deletes any sessions for this userID where the default timeout has elapsed.
$time = time() - $default->owl_timeout;
$sql = new Owl_DB;
$sql->query("DELETE FROM $default->owl_sessions_table WHERE user_id = '" . $userID . "' AND lastused <= '" . date("Y-m-d H:i:s",$time) . "'");
}
/**
* Used to verify the current user's session.
*
* @return
* array containing the userID, groupID and session verification status
*/
function verify() {
global $default, $lang_sesstimeout, $lang_sessinuse, $lang_err_sess_notvalid;
session_start();
$sessionID = session_id();
$default->log->debug("Session::verify retrieved sessionID=$sessionID");
if (strlen($sessionID) > 0) {
// initialise return status
$sessionStatus = 0;
// this should be an existing session, so check the db
$sql = new Owl_DB;
$sql->query("SELECT * FROM $default->owl_sessions_table WHERE session_id = '$sessionID'");
$numrows = $sql->num_rows($sql);
// found one match
if ($numrows == 1) {
$userID = $sql->f("user_id");
$default->log->debug("Session::verify found session in db");
while($sql->next_record()) {
$ip = $this->getClientIP();
// check that ip matches
if ($ip == $sql->f("ip")) {
// now check if the timeout has been exceeded
$lastused = $sql->f("lastused");
$default->log->debug("Session::verify lastused=$lastused; str=" . strtotime($lastused));
$default->log->debug("Session::verify current time=" . time());
$diff = time() - strtotime($lastused);
$default->log->debug("Session::verify timeout = " . $default->owl_timeout . "; diff=$diff");
if($diff <= $default->owl_timeout) {
// 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"] = $sql->f("user_id");
}
// lookup the user
$sql->query("SELECT * FROM $default->owl_users_groups_table WHERE id = ".$_SESSION["userID"]);
while($sql->next_record()) {
// FIXME: this much change to look at users_groups_link
// only set the groupID if its not in the array already
if (!$_SESSION["groupID"]) {
$_SESSION["groupID"] = $sql->f("group_id");
}
}
// update last used timestamps
$sql->query("UPDATE $default->owl_sessions_table SET lastused = '" . date("Y-m-d H:i:s",time()) ."' " .
"WHERE user_id = " . $_SESSION["userID"] . " AND session_id = '$sessionID'");
// add the array to the session
$_SESSION["sessionStatus"] = $sessionStatus;
} else {
// session timed out status
$sessionStatus = 2;
// remove old sessions
Session::removeStaleSessions($userID);
$_SESSION["errorMessage"] = $lang_sesstimeout;
}
} else {
// session in use status
$sessionStatus = 3;
$_SESSION["errorMessage"] = $lang_sessinuse;
}
}
}
} else {
$default->log->error("Session::verify session not in db");
// there is no session
return false;
}
// return the array
$output = "Session::verify returning sessionStatus[\"status\"]=" . $sessionStatus;
$default->log->debug($output);
return $sessionStatus;
}
/**
* Retrieves and returns the IP address of the current user
*/
function getClientIP() {
// get client ip
if(getenv("HTTP_CLIENT_IP")) {
$ip = getenv("HTTP_CLIENT_IP");
} elseif(getenv("HTTP_X_FORWARDED_FOR")) {
$forwardedip = getenv("HTTP_X_FORWARDED_FOR");
list($ip,$ip2,$ip3,$ip4)= split (",", $forwardedip);
} else {
$ip = getenv("REMOTE_ADDR");
}
return $ip;
}
}
?>