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
295
296
297
298
299
300
301
302
303
304
305
306
|
<?php
/**
* SessionHandler implementation for PHP's PEAR database abstraction layer.
*
* Required parameters:<pre>
* 'phptype' The database type (e.g. 'pgsql', 'mysql', etc.).</pre>
*
* Required by some database implementations:<pre>
* 'hostspec' The hostname of the database server.
* 'protocol' The communication protocol ('tcp', 'unix', etc.).
* 'database' The name of the database.
* 'username' The username with which to connect to the database.
* 'password' The password associated with 'username'.
* 'options' Additional options to pass to the database.
* 'tty' The TTY on which to connect to the database.
* 'port' The port on which to connect to the database.</pre>
*
* Optional parameters:<pre>
* 'persistent' Use persistent DB connections? (boolean)
* 'table' The name of the sessiondata table in 'database'. Default
* is 'horde_sessionhandler'.</pre>
*
* The table structure for the SessionHandler can be found in
* horde/scripts/sql/horde_sessionhandler.sql.
*
* $Horde: framework/SessionHandler/SessionHandler/sql.php,v 1.22.10.13 2006/01/01 21:28:34 jan Exp $
*
* Copyright 2002-2006 Mike Cochrane <mike@graftonhall.co.nz>
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
*
* @author Mike Cochrane <mike@graftonhall.co.nz>
* @since Horde 3.0
* @package Horde_SessionHandler
*/
class SessionHandler_sql extends SessionHandler {
/**
* Handle for the current database connection.
*
* @var DB
*/
var $_db;
/**
* Boolean indicating whether or not we're connected to the SQL server.
*
* @var boolean
*/
var $_connected = false;
/**
* Close the SessionHandler backend.
*
* @return boolean True on success, false otherwise.
*/
function close()
{
/* Disconnect from database. */
if ($this->_connected) {
/* Close any open transactions. */
$this->_db->commit();
$this->_db->autoCommit(true);
$this->_connected = false;
return $this->_db->disconnect();
}
return true;
}
/**
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return string The session data.
*/
function read($id)
{
/* Make sure we have a valid database connection. */
$this->_connect();
/* Begin a transaction. */
$result = $this->_db->autocommit(false);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return '';
}
/* Execute the query. */
require_once 'Horde/SQL.php';
$result = Horde_SQL::readBlob($this->_db, $this->_params['table'], 'session_data',
array('session_id' => $id));
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return '';
}
return $result;
}
/**
* Write session data to the SessionHandler backend.
*
* @param string $id The session identifier.
* @param string $session_data The session data.
*
* @return boolean True on success, false otherwise.
*/
function write($id, $session_data)
{
/* Make sure we have a valid database connection. */
$this->_connect();
/* Build the SQL query. */
$query = sprintf('SELECT session_id FROM %s WHERE session_id = ?',
$this->_params['table']);
$values = array($id);
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('SQL Query by SessionHandler_sql::write(): query = "%s"', $query),
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->getOne($query, $values);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return false;
}
require_once 'Horde/SQL.php';
if ($result) {
$result = Horde_SQL::updateBlob($this->_db, $this->_params['table'], 'session_data',
$session_data, array('session_id' => $id),
array('session_lastmodified' => time()));
} else {
$result = Horde_SQL::insertBlob($this->_db, $this->_params['table'], 'session_data',
$session_data, array('session_id' => $id,
'session_lastmodified' => time()));
}
if (is_a($result, 'PEAR_Error')) {
$this->_db->rollback();
$this->_db->autoCommit(true);
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return false;
}
$result = $this->_db->commit();
if (is_a($result, 'PEAR_Error')) {
$this->_db->autoCommit(true);
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return false;
}
$this->_db->autoCommit(true);
return true;
}
/**
* Destroy the data for a particular session identifier in the
* SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return boolean True on success, false otherwise.
*/
function destroy($id)
{
/* Make sure we have a valid database connection. */
$this->_connect();
/* Build the SQL query. */
$query = sprintf('DELETE FROM %s WHERE session_id = ?',
$this->_params['table']);
$values = array($id);
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('SQL Query by SessionHandler_sql::destroy(): query = "%s"', $query),
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->query($query, $values);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return false;
}
$result = $this->_db->commit();
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return false;
}
return true;
}
/**
* Garbage collect stale sessions from the SessionHandler backend.
*
* @param integer $maxlifetime The maximum age of a session.
*
* @return boolean True on success, false otherwise.
*/
function gc($maxlifetime = 300)
{
/* Make sure we have a valid database connection. */
$this->_connect();
/* Build the SQL query. */
$query = sprintf('DELETE FROM %s WHERE session_lastmodified < ?',
$this->_params['table']);
$values = array(time() - $maxlifetime);
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('SQL Query by SessionHandler_sql::gc(): query = "%s"', $query),
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->query($query, $values);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return false;
}
return true;
}
/**
* Get a list of the valid session identifiers.
*
* @return array A list of valid session identifiers.
*/
function getSessionIDs()
{
/* Make sure we have a valid database connection. */
$this->_connect();
$timeout = time() - ini_get('session.gc_maxlifetime');
/* Build the SQL query. */
$query = 'SELECT session_id FROM ' . $this->_params['table'] .
' WHERE session_lastmodified > ?';
$values = array($timeout);
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('SQL Query by SessionHandler_sql::getSessionIDs(): query = "%s"', $query),
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->getCol($query, 0, $values);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return false;
}
return $result;
}
/**
* Attempts to open a connection to the SQL server.
*
* @return boolean True on success; exits (Horde::fatal()) on error.
*/
function _connect()
{
if (!$this->_connected) {
Horde::assertDriverConfig($this->_params, 'sessionhandler',
array('phptype'),
'session handler SQL');
if (!isset($this->_params['database'])) {
$this->_params['database'] = '';
}
if (!isset($this->_params['username'])) {
$this->_params['username'] = '';
}
if (!isset($this->_params['hostspec'])) {
$this->_params['hostspec'] = '';
}
if (empty($this->_params['table'])) {
$this->_params['table'] = 'horde_sessionhandler';
}
/* Connect to the SQL server using the supplied
* parameters. */
include_once 'DB.php';
$this->_db = &DB::connect($this->_params,
array('persistent' => !empty($this->_params['persistent'])));
if (is_a($this->_db, 'PEAR_Error')) {
Horde::fatal($this->_db, __FILE__, __LINE__);
}
$this->_db->setOption('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS);
$this->_connected = true;
}
return true;
}
}
|
