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
|
<?php
/**
* Token tracking implementation for PHP's PEAR database abstraction layer.
*
* Required parameters:<pre>
* 'phptype' The database type (ie. 'pgsql', 'mysql', etc.).</pre>
*
* Required by some database implementations:<pre>
* 'database' The name of the database.
* 'hostspec' The hostname of the database server.
* '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>
* 'table' The name of the tokens table in 'database'.
* Defaults to 'horde_tokens'.
* 'timeout' The period (in seconds) after which an id is purged.
* Defaults to 86400 (i.e. 24 hours).</pre>
*
* The table structure for the tokens is as follows:
*
* <pre>
* CREATE TABLE horde_tokens (
* token_address VARCHAR(100) NOT NULL,
* token_id VARCHAR(32) NOT NULL,
* token_timestamp BIGINT NOT NULL,
*
* PRIMARY KEY (token_address, token_id)
* );
* </pre>
*
* $Horde: framework/Token/Token/sql.php,v 1.23.6.12 2006/01/18 19:40:51 ben Exp $
*
* Copyright 1999-2006 Max Kalika <max@horde.org>
*
* 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 Max Kalika <max@horde.org>
* @since Horde 1.3
* @package Horde_Token
*/
class Horde_Token_sql extends Horde_Token {
/**
* 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;
/**
* Constructs a new SQL connection object.
*
* @param array $params A hash containing connection parameters.
*/
function Horde_Token_sql($params = array())
{
$this->_params = $params;
/* Set timeout to 24 hours if not specified. */
if (!isset($this->_params['timeout'])) {
$this->_params['timeout'] = 86400;
}
}
/**
* Deletes all expired connection id's from the SQL server.
*
* @return boolean True on success, a PEAR_Error object on failure.
*/
function purge()
{
if (is_a(($result = $this->_connect()), 'PEAR_Error')) {
return $result;
}
/* Build SQL query. */
$query = 'DELETE FROM ' . $this->_params['table'] . ' WHERE ';
$query .= 'token_timestamp < ?';
$values = array(time() - $this->_params['timeout']);
$result = $this->_db->query($query, $values);
/* Return an error if the update fails, too. */
if (is_a($result, 'PEAR_Error')) {
return $result;
}
return true;
}
function exists($tokenID)
{
if (is_a(($result = $this->_connect()), 'PEAR_Error')) {
return false;
}
/* Build SQL query. */
$query = 'SELECT token_id FROM ' . $this->_params['table'];
$query .= ' WHERE token_address = ?';
$query .= ' AND token_id = ?';
$values = array($this->encodeRemoteAddress(), $tokenID);
$result = $this->_db->getOne($query, $values);
if (is_a($result, 'PEAR_Error')) {
return false;
} else {
return !empty($result);
}
}
function add($tokenID)
{
if (is_a(($result = $this->_connect()), 'PEAR_Error')) {
return $result;
}
/* Build SQL query. */
$query = 'INSERT INTO ' . $this->_params['table'] . ' (token_address, token_id, token_timestamp) ';
$query .= 'VALUES (?, ?, ?)';
$values = array($this->encodeRemoteAddress(), $tokenID, time());
$result = $this->_db->query($query, $values);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
return true;
}
/**
* Opens a connection to the SQL server.
*
* @return boolean True on success, a PEAR_Error object on failure.
*/
function _connect()
{
if ($this->_connected) {
return true;
}
$result = Util::assertDriverConfig($this->_params, array('phptype'),
'token SQL', array('driver' => 'token'));
if (is_a($result, 'PEAR_Error')) {
return $result;
}
if (!isset($this->_params['database'])) {
$this->_params['database'] = '';
}
if (!isset($this->_params['username'])) {
$this->_params['username'] = '';
}
if (!isset($this->_params['password'])) {
$this->_params['password'] = '';
}
if (!isset($this->_params['hostspec'])) {
$this->_params['hostspec'] = '';
}
if (!isset($this->_params['table'])) {
$this->_params['table'] = 'horde_tokens';
}
/* Connect to the SQL server using the supplied parameters. */
require_once 'DB.php';
$this->_db = &DB::connect($this->_params,
array('persistent' => !empty($this->_params['persistent'])));
if (is_a($this->_db, 'PEAR_Error')) {
return $this->_db;
}
// Set DB portability options.
switch ($this->_db->phptype) {
case 'mssql':
$this->_db->setOption('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS | DB_PORTABILITY_RTRIM);
break;
default:
$this->_db->setOption('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS);
}
$this->_connected = true;
return true;
}
/**
* Disconnect from the SQL server and clean up the connection.
*
* @return boolean True on success, a PEAR_Error object on failure.
*/
function _disconnect()
{
if ($this->_connected) {
$this->_connected = false;
return $this->_db->disconnect();
}
return true;
}
}
|
