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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
<?php
/**
* Elgg database
* Contains database connection and transfer functionality
*
* @package Elgg
* @subpackage Core
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
* @author Curverider Ltd
* @copyright Curverider Ltd 2008
* @link http://elgg.org/
*/
/**
* Connect to the database server and use the Elgg database for a particular database link
*
* @param string $dblinkname Default "readwrite"; you can change this to set up additional global database links, eg "read" and "write"
*/
function establish_db_link($dblinkname = "readwrite") {
// Get configuration, and globalise database link
global $CONFIG, $dblink;
if (!isset($dblink)) {
$dblink = array();
}
if ($dblinkname != "readwrite" && isset($CONFIG->db[$dblinkname])) {
if (is_array($CONFIG->db[$dblinkname])) {
$index = rand(0,sizeof($CONFIG->db[$dblinkname]));
$dbhost = $CONFIG->db[$dblinkname][$index]->dbhost;
$dbuser = $CONFIG->db[$dblinkname][$index]->dbuser;
$dbpass = $CONFIG->db[$dblinkname][$index]->dbpass;
$dbname = $CONFIG->db[$dblinkname][$index]->dbname;
} else {
$dbhost = $CONFIG->db[$dblinkname]->dbhost;
$dbuser = $CONFIG->db[$dblinkname]->dbuser;
$dbpass = $CONFIG->db[$dblinkname]->dbpass;
$dbname = $CONFIG->db[$dblinkname]->dbname;
}
} else {
$dbhost = $CONFIG->dbhost;
$dbuser = $CONFIG->dbuser;
$dbpass = $CONFIG->dbpass;
$dbname = $CONFIG->dbname;
}
// Connect to database
if (!$dblink[$dblinkname] = mysql_connect($CONFIG->dbhost, $CONFIG->dbuser, $CONFIG->dbpass, true))
throw new DatabaseException(sprintf(elgg_echo('DatabaseException:WrongCredentials'), $CONFIG->dbuser, $CONFIG->dbhost, $CONFIG->debug ? $CONFIG->dbpass : "****"));
if (!mysql_select_db($CONFIG->dbname, $dblink[$dblinkname]))
throw new DatabaseException(sprintf(elgg_echo('DatabaseException:NoConnect'), $CONFIG->dbname));
}
/**
* Establish all database connections
*
* If the configuration has been set up for multiple read/write databases, set those
* links up separately; otherwise just create the one database link
*
*/
function setup_db_connections() {
// Get configuration and globalise database link
global $CONFIG, $dblink;
if (!empty($CONFIG->db->split)) {
establish_db_link('read');
establish_db_link('write');
} else {
establish_db_link('readwrite');
}
}
/**
* Alias to setup_db_connections, for use in the event handler
*
* @param string $event The event type
* @param string $object_type The object type
* @param mixed $object Used for nothing in this context
*/
function init_db($event, $object_type, $object = null) {
setup_db_connections();
return true;
}
/**
* Gets the appropriate db link for the operation mode requested
*
* @param string $dblinktype The type of link we want - "read", "write" or "readwrite" (the default)
* @return object Database link
*/
function get_db_link($dblinktype) {
global $dblink;
if (isset($dblink[$dblinktype])) {
return $dblink[$dblinktype];
} else {
return $dblink['readwrite'];
}
}
/**
* Explain a given query, useful for debug.
*/
function explain_query($query, $link)
{
if ($result = mysql_query("explain " . $query, $link)) {
return mysql_fetch_object($result);
}
return false;
}
/**
* Use this function to get data from the database
* @param mixed $query The query being passed.
* @param string $call Optionally, the name of a function to call back to on each row (which takes $row as a single parameter)
* @return array An array of database result objects
*/
function get_data($query, $callback = "") {
global $CONFIG, $dbcalls;
if (!callpath_gatekeeper($CONFIG->path . "engine/", true, true))
throw new SecurityException(sprintf(elgg_echo('SecurityException:FunctionDenied'), 'get_data()'));
$dblink = get_db_link('read');
$resultarray = array();
$dbcalls++;
if ((isset($CONFIG->debug)) && ($CONFIG->debug==true))
{
error_log("--- DB QUERY --- $query");
error_log("--- EXPLAINATION --- " . print_r(explain_query($query,$dblink), true));
}
if ($result = mysql_query("$query", $dblink)) {
while ($row = mysql_fetch_object($result)) {
if (!empty($callback) && is_callable($callback)) {
$row = $callback($row);
}
$resultarray[] = $row;
}
}
if (mysql_errno($dblink))
throw new DatabaseException(mysql_error($dblink) . " QUERY: " . $query);
if (empty($resultarray)) {
if ((isset($CONFIG->debug)) && ($CONFIG->debug==true))
error_log("WARNING: DB query \"$query\" returned no results.");
return false;
}
return $resultarray;
}
/**
* Use this function to get a single data row from the database
* @param mixed $query The query to run.
* @return object A single database result object
*/
function get_data_row($query) {
global $CONFIG, $dbcalls;
if (!callpath_gatekeeper($CONFIG->path . "engine/", true, true))
throw new SecurityException(sprintf(elgg_echo('SecurityException:FunctionDenied'), 'get_data_row()'));
$dblink = get_db_link('read');
$dbcalls++;
if ((isset($CONFIG->debug)) && ($CONFIG->debug==true))
{
error_log("--- DB QUERY --- $query");
error_log("--- EXPLAINATION --- " . print_r(explain_query($query,$dblink), true));
}
if ($result = mysql_query("$query", $dblink)) {
while ($row = mysql_fetch_object($result)) {
return $row;
}
}
if (mysql_errno($dblink))
throw new DatabaseException(mysql_error($dblink) . " QUERY: " . $query);
if ((isset($CONFIG->debug)) && ($CONFIG->debug==true))
error_log("WARNING: DB query \"$query\" returned no results.");
return false;
}
/**
* Use this function to insert database data; returns id or false
*
* @param mixed $query The query to run.
* @return int $id the database id of the inserted row.
*/
function insert_data($query) {
global $CONFIG, $dbcalls;
if (!callpath_gatekeeper($CONFIG->path . "engine/", true, true))
throw new SecurityException(sprintf(elgg_echo('SecurityException:FunctionDenied'), 'insert_data()'));
$dblink = get_db_link('write');
$dbcalls++;
if (mysql_query("$query", $dblink))
return mysql_insert_id($dblink);
if (mysql_errno($dblink))
throw new DatabaseException(mysql_error($dblink) . " QUERY: " . $query);
return false;
}
/**
* Update database data
*
* @param mixed $query The query to run.
* @return int|false Either the number of affected rows, or false on failure
*/
function update_data($query) {
global $dbcalls, $CONFIG;
if (!callpath_gatekeeper($CONFIG->path . "engine/", true, true))
throw new SecurityException(sprintf(elgg_echo('SecurityException:FunctionDenied'), 'update_data()'));
$dblink = get_db_link('write');
$dbcalls++;
if (mysql_query("$query", $dblink))
return mysql_affected_rows();
if (mysql_errno($dblink))
throw new DatabaseException(mysql_error($dblink) . " QUERY: " . $query);
return false;
}
/**
* Use this function to delete data
*
* @param mixed $query The SQL query to run
* @return int|false Either the number of affected rows, or false on failure
*/
function delete_data($query) {
global $dbcalls, $CONFIG;
if (!callpath_gatekeeper($CONFIG->path . "engine/", true, true))
throw new SecurityException(sprintf(elgg_echo('SecurityException:FunctionDenied'), 'delete_data()'));
$dblink = get_db_link('write');
$dbcalls++;
if (mysql_query("$query", $dblink))
return mysql_affected_rows();
if (mysql_errno($dblink))
throw new DatabaseException(mysql_error($dblink) . " QUERY: " . $query);
return false;
}
/**
* Returns the number of rows returned by the last select statement, without the need to re-execute the query.
*
* CANDIDATE FOR DELETION?
*
* @return int The number of rows returned by the last statement
*/
function count_last_select() {
$row = get_data_row("SELECT found_rows() as count");
if ($row)
return $row->count;
return 0;
}
/**
* Get the tables currently installed in the Elgg database
*
* @return array List of tables
*/
function get_db_tables() {
global $CONFIG;
$result = get_data("show tables");
$tables = array();
if (is_array($result) && !empty($result)) {
foreach($result as $row) {
$row = (array) $row;
if (is_array($row) && !empty($row))
foreach($row as $element) {
$tables[] = $element;
}
}
}
else
return false;
return $tables;
}
/**
* Get the last database error for a particular database link
*
* @param database link $dblink
* @return string Database error message
*/
function get_db_error($dblink) {
return mysql_error($dblink);
}
/**
* Runs a full database script from disk
*
* @uses $CONFIG
* @param string $scriptlocation The full path to the script
*/
function run_sql_script($scriptlocation) {
if ($script = file_get_contents($scriptlocation)) {
global $CONFIG;
$errors = array();
$script = preg_replace('/\-\-.*\n/', '', $script);
$sql_statements = preg_split('/;[\n\r]+/', $script);
foreach($sql_statements as $statement) {
$statement = trim($statement);
$statement = str_replace("prefix_",$CONFIG->dbprefix,$statement);
if (!empty($statement)) {
$result = update_data($statement);
}
}
if (!empty($errors)) {
$errortxt = "";
foreach($errors as $error)
$errortxt .= " {$error};";
throw new DatabaseException(elgg_echo('DatabaseException:DBSetupIssues') . $errortxt);
}
} else {
throw new DatabaseException(sprintf(elgg_echo('DatabaseException:ScriptNotFound'), $scriptlocation));
}
}
/**
* Sanitise a string for database use
*
* @param string $string The string to sanitise
* @return string Sanitised string
*/
function sanitise_string($string) {
return mysql_real_escape_string(trim($string));
}
/**
* Wrapper function for Americans
*
* @param string $string The string to sanitise
* @return string Sanitised string
* @uses sanitise_string
*/
function sanitize_string($string) {
return sanitise_string($string);
}
/**
* Sanitises an integer for database use
*
* @param int $int
* @return int Sanitised integer
*/
function sanitise_int($int) {
return (int) $int;
}
/**
* Wrapper function for Americans
*
* @param int $int
* @return int Sanitised integer
* @uses sanitise_string
*/
function sanitize_int($int) {
return (int) $int;
}
// Stuff for initialisation
register_event_handler('boot','system','init_db',0);
?>
|
