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
|
<?php
/**
* SessionHandler implementation for PHP's PEAR database abstraction layer.
*
* Required values for $params:<pre>
* 'phptype' The database type (e.g. 'pgsql', 'mysql', etc.).
* 'hostspec' The hostname of the database server.
* 'protocol' The communication protocol ('tcp', 'unix', etc.).
* 'username' The username with which to connect to the database.
* 'password' The password associated with 'username'.
* 'database' The name of the database.
* 'table' The name of the sessiondata table in 'database'.</pre>
*
* Required by some database implementations:
* '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.
*
* Optional parameters:
* 'persistent' Use persistent DB connections? (boolean)
*
* The table structure can be created by the scripts/db/sessionhandler.sql
* script.
*
* $Horde: horde/lib/SessionHandler/sql.php,v 1.9.2.3 2003/05/19 17:56:11 slusarz Exp $
*
* Copyright 2002-2003 Mike Cochrane <mike@graftonhall>
*
* 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 Cochrame <mike@graftonhall.co.nz>
* @version $Revision: 1.9.2.3 $
* @since Horde 2.2
* @package horde.session
*/
class SessionHandler_sql extends SessionHandler {
/** Hash containing connection parameters. */
var $_params = array();
/** Handle for the current database connection.
@var object DB $_db */
var $_db;
/**
* Boolean indicating whether or not we're connected to the SQL
* server. */
var $_connected = false;
/**
* Constructs a new SQL SessionHandler object.
*
* @param array $params A hash containing connection parameters.
*/
function SessionHandler_sql($params = array())
{
$this->_params = $params;
}
function open($save_path, $session_name)
{
/* Connect to database */
$this->_connect();
}
function close()
{
/* Disconnect from Database */
$this->_disconnect();
}
function read($id)
{
/* Make sure we have a valid database connection. */
$this->_connect();
require_once HORDE_BASE . '/lib/SQL.php';
/* Execute the query. */
$result = Horde_SQL::readBlob($this->_db, $this->_params['table'], 'session_data',
array('session_id' => $id));
if (DB::isError($result)) {
Horde::logMessage($result, __FILE__, __LINE__, LOG_ERR);
return '';
}
return $result;
}
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 = %s',
$this->_params['table'], $this->_db->quote($id));
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('SQL Query by SessionHandler_sql::write(): query = "%s"', $query),
__FILE__, __LINE__, LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->getOne($query);
if (DB::isError($result)) {
Horde::logMessage($result, __FILE__, __LINE__, LOG_ERR);
return false;
}
require_once HORDE_BASE . '/lib/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 (DB::isError($result)) {
Horde::logMessage($result, __FILE__, __LINE__, LOG_ERR);
return false;
}
return true;
}
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 = %s',
$this->_params['table'], $this->_db->quote($id));
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('SQL Query by SessionHandler_sql::destroy(): query = "%s"', $query),
__FILE__, __LINE__, LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->query($query);
if (DB::isError($result)) {
Horde::logMessage($result, __FILE__, __LINE__, LOG_ERR);
return false;
}
return true;
}
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 < %s',
$this->_params['table'], $this->_db->quote(time() - $maxlifetime));
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('SQL Query by SessionHandler_sql::gc(): query = "%s"', $query),
__FILE__, __LINE__, LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->query($query);
if (DB::isError($result)) {
Horde::logMessage($result, __FILE__, __LINE__, LOG_ERR);
return false;
}
return true;
}
/**
* Attempts to open a connection to the SQL server.
*
* @return boolean True on success; exits (Horde::fatal()) on error.
*/
function _connect()
{
if (!$this->_connected) {
if (!is_array($this->_params)) {
Horde::fatal(new PEAR_Error(_("No configuration information specified for SQL SessionHandler.")), __FILE__, __LINE__);
}
if (!isset($this->_params['phptype'])) {
Horde::fatal(new PEAR_Error(_("Required 'phptype' not specified in SessionHandler configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['hostspec'])) {
Horde::fatal(new PEAR_Error(_("Required 'hostspec' not specified in SessionHandler configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['username'])) {
Horde::fatal(new PEAR_Error(_("Required 'username' not specified in SessionHandler configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['password'])) {
Horde::fatal(new PEAR_Error(_("Required 'password' not specified in SessionHandler configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['database'])) {
Horde::fatal(new PEAR_Error(_("Required 'database' not specified in SessionHandler configuration.")), __FILE__, __LINE__);
}
if (!array_key_exists('table', $this->_params)) {
$this->_params['table'] = 'horde_sessionhandler';
}
/* Use persistent connections? */
if (empty($this->_params['persistent'])) {
$persistent = false;
} else {
$persistent = true;
}
/* Connect to the SQL server using the supplied parameters. */
include_once 'DB.php';
$this->_db = &DB::connect($this->_params, $persistent);
if (DB::isError($this->_db)) {
Horde::fatal($this->_db, __FILE__, __LINE__);
}
/* Enable the "portability" option. */
$this->_db->setOption('optimize', 'portability');
$this->_connected = true;
}
return true;
}
/**
* Disconnect from the SQL server and clean up the connection.
*
* @return boolean true on success, false on failure.
*/
function _disconnect()
{
if ($this->_connected) {
$this->_connected = false;
return $this->_db->disconnect();
}
return true;
}
}
|