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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
<?php
/**
* Turba directory driver implementation for PHP's PEAR database abstraction
* layer.
*
* $Horde: turba/lib/Driver/sql.php,v 1.59.10.3 2005/01/31 20:55:19 jan Exp $
*
* @author Jon Parise <jon@csh.rit.edu>
* @since Turba 0.0.1
* @package Turba
*/
class Turba_Driver_sql extends Turba_Driver {
/**
* What can this backend do?
*
* @var array $_capabilities
*/
var $_capabilities = array('delete_all' => true);
/**
* Handle for the database connection.
*
* @var object DB $_db
*/
var $_db;
function _init()
{
include_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;
}
$this->_db->setOption('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS);
if ($this->_params['phptype'] == 'oci8') {
$this->_db->query('ALTER SESSION SET NLS_DATE_FORMAT = \'YYYY-MM-DD\'');
}
return true;
}
/**
* Searches the SQL database with the given criteria and returns a
* filtered list of results. If the criteria parameter is an empty
* array, all records will be returned.
*
* @param $criteria Array containing the search criteria.
* @param $fields List of fields to return.
*
* @return Hash containing the search results.
*/
function _search($criteria, $fields)
{
/* Build the WHERE clause. */
$where = '';
if (count($criteria)) {
foreach ($criteria as $key => $vals) {
if ($key == 'OR' || $key == 'AND') {
if (!empty($where)) {
$where .= ' ' . $key . ' ';
}
$where .= '(' . $this->_buildSearchQuery($key, $vals) . ')';
}
}
$where = ' WHERE ' . $where;
}
/* Build up the full query. */
$query = 'SELECT ' . implode(', ', $fields) . ' FROM ' . $this->_params['table'] . $where;
/* Log the query at a DEBUG log level. */
Horde::logMessage('SQL query by Turba_Driver_sql::_search(): ' . $query,
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Run query. */
$result = $this->_db->query($query);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return $result;
}
$results = array();
$iMax = count($fields);
while ($row = $result->fetchRow()) {
if (is_a($row, 'PEAR_Error')) {
Horde::logMessage($row, __FILE__, __LINE__, PEAR_LOG_ERR);
return $result;
}
$row = $this->_convertFromDriver($row);
$entry = array();
for ($i = 0; $i < $iMax; $i++) {
$field = $fields[$i];
$entry[$field] = $row[$i];
}
$results[] = $entry;
}
return $results;
}
/**
* Read the given data from the SQL database and returns the
* result's fields.
*
* @param $criteria Search criteria.
* @param $id Data identifier.
* @param $fields List of fields to return.
*
* @return Hash containing the search results.
*/
function _read($criteria, $id, $fields)
{
$in = '';
if (is_array($id)) {
if (!count($id)) {
return array();
}
foreach ($id as $key) {
$in .= empty($in) ? $this->_db->quote($this->_convertToDriver($key))
: ', ' . $this->_db->quote($this->_convertToDriver($key));
}
$where = $criteria . ' IN (' . $in . ')';
} else {
$where = $criteria . ' = ' . $this->_db->quote($this->_convertToDriver($id));
}
// backport security patch from Turba 2.1.7 for sarge
if (isset($this->map['__owner'])) {
$owner = Auth::getAuth();
$where .= ' AND ' . $this->map['__owner'] . " = '" . $this->_convertToDriver($owner) . "'";
}
$query = 'SELECT ' . implode(', ', $fields) . ' ';
$query .= 'FROM ' . $this->_params['table'] . ' WHERE ' . $where;
/* Log the query at a DEBUG log level. */
Horde::logMessage('SQL query by Turba_Driver_sql::_read(): ' . $query,
__FILE__, __LINE__, PEAR_LOG_DEBUG);
$result = $this->_db->getAll($query);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
}
$results = array();
$iMax = count($fields);
if (!is_a($result, 'PEAR_Error')) {
foreach ($result as $row) {
$entry = array();
for ($i=0; $i < $iMax; $i++) {
$field = $fields[$i];
$entry[$field] = $this->_convertFromDriver($row[$i]);
}
$results[] = $entry;
}
}
return $results;
}
/**
* Adds the specified object to the SQL database.
*/
function _add($attributes)
{
$fields = array();
$values = array();
foreach ($attributes as $field => $value) {
$fields[] = $field;
$values[] = $this->_convertToDriver($value);
}
$query = 'INSERT INTO ' . $this->_params['table'] . ' (' . implode(', ', $fields) . ')';
$query .= ' VALUES (' . str_repeat('?, ', count($values) - 1) . '?)';
$sth = $this->_db->prepare($query);
$result = $this->_db->execute($sth, $values);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return $result;
}
return true;
}
/**
* Deletes the specified object from the SQL database.
*/
function _delete($object_key, $object_id)
{
$where = $object_key . ' = ' . $this->_db->quote($object_id);
$query = 'DELETE FROM ' . $this->_params['table'] . ' WHERE ' . $where;
$result = $this->_db->query($query);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return $result;
}
return true;
}
/**
* Deletes all contacts from the address book.
*
* @return boolean True if the operation worked.
*/
function _deleteAll()
{
if (!Auth::getAuth()) {
return PEAR::raiseError('permission denied');
}
$query = 'DELETE FROM ' . $this->_params['table'] . ' WHERE owner_id=' .
$this->_db->quote(Auth::getAuth());
return $this->_db->query($query);
}
/**
* Saves the specified object in the SQL database.
*
* @return string The object id, possibly updated.
*/
function _save($object_key, $object_id, $attributes)
{
$where = $object_key . ' = ' . $this->_db->quote($object_id);
unset($attributes[$object_key]);
$fields = array();
$values = array();
foreach ($attributes as $field => $value) {
$fields[] = $field . ' = ?';
$values[] = $this->_convertToDriver($value);
}
$query = 'UPDATE ' . $this->_params['table'] . ' SET ' . implode(', ', $fields) . ' ';
$query .= 'WHERE ' . $where;
/* Log the query at a DEBUG log level. */
Horde::logMessage('SQL query by Turba_Driver_sql::_save(): ' . $query,
__FILE__, __LINE__, PEAR_LOG_DEBUG);
$sth = $this->_db->prepare($query);
$result = $this->_db->execute($sth, $values);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return $result;
}
return $object_id;
}
/**
* Create an object key for a new object.
*
* @param array $attributes The attributes (in driver keys) of the
* object being added.
*
* @return string A unique ID for the new object.
*/
function _makeKey($attributes)
{
return md5(uniqid(mt_rand(), true));
}
/**
* Build a piece of a search query.
*
* @param string $glue The glue to join the criteria (OR/AND).
* @param array $criteria The array of criteria.
*
* @return string An SQL fragment.
*/
function _buildSearchQuery($glue, $criteria)
{
require_once 'Horde/SQL.php';
$clause = '';
foreach ($criteria as $key => $vals) {
if (!empty($vals['OR']) || !empty($vals['AND'])) {
if (!empty($clause)) {
$clause .= ' ' . $glue . ' ';
}
$clause .= '(' . $this->_buildSearchQuery($glue, $vals) . ')';
} else {
if (isset($vals['field'])) {
if (!empty($clause)) {
$clause .= ' ' . $glue . ' ';
}
$rhs = $this->_convertToDriver($vals['test']);
$clause .= Horde_SQL::buildClause($this->_db, $vals['field'], $vals['op'], $rhs);
} else {
foreach ($vals as $test) {
if (!empty($test['OR']) || !empty($test['AND'])) {
if (!empty($clause)) {
$clause .= ' ' . $glue . ' ';
}
$clause .= '(' . $this->_buildSearchQuery($glue, $test) . ')';
} else {
if (!empty($clause)) {
$clause .= ' ' . $key . ' ';
}
$rhs = $this->_convertToDriver($test['test']);
$clause .= Horde_SQL::buildClause($this->_db, $test['field'], $test['op'], $rhs);
}
}
}
}
}
return $clause;
}
/**
* Converts a value from the driver's charset to the default charset.
*
* @param mixed $value A value to convert.
* @return mixed The converted value.
*/
function _convertFromDriver($value)
{
return String::convertCharset($value, $this->_params['charset']);
}
/**
* Converts a value from the default charset to the driver's charset.
*
* @param mixed $value A value to convert.
* @return mixed The converted value.
*/
function _convertToDriver($value)
{
return String::convertCharset($value, NLS::getCharset(), $this->_params['charset']);
}
}
|
