]> projects.mako.cc - scuttle/blob - includes/db/mysql.php
remove duplicate shared-tag in xml - the android apps dont like this
[scuttle] / includes / db / mysql.php
1 <?php
2 /** 
3 *
4 * @package dbal_mysql
5 * @version $Id: mysql.php,v 1.5 2006/02/10 01:30:19 scronide Exp $
6 * @copyright (c) 2005 phpBB Group 
7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License 
8 *
9 */
10
11 /**
12 * @ignore
13 */
14 if (!defined('SQL_LAYER'))
15 {
16
17 define('SQL_LAYER', 'mysql');
18
19 /**
20 * @package dbal_mysql
21 * MySQL Database Abstraction Layer
22 * Minimum Requirement is 3.23+/4.0+/4.1+
23 */
24 class sql_db
25 {
26         var $db_connect_id;
27         var $query_result;
28         var $return_on_error = false;
29         var $transaction = false;
30         var $sql_time = 0;
31         var $num_queries = 0;
32         var $open_queries = array();
33
34         function sql_connect($sqlserver, $sqluser, $sqlpassword, $database, $port = false, $persistency = false)
35         {
36                 $this->persistency = $persistency;
37                 $this->user = $sqluser;
38                 $this->server = $sqlserver . (($port) ? ':' . $port : '');
39                 $this->dbname = $database;
40
41                 $this->db_connect_id = ($this->persistency) ? @mysql_pconnect($this->server, $this->user, $sqlpassword) : @mysql_connect($this->server, $this->user, $sqlpassword);
42
43                 if ($this->db_connect_id && $this->dbname != '')
44                 {
45                         if (@mysql_select_db($this->dbname))
46                         {
47                                 return $this->db_connect_id;
48                         }
49                 }
50
51                 return $this->sql_error('');
52         }
53
54         //
55         // Other base methods
56         //
57         function sql_close()
58         {
59                 if (!$this->db_connect_id)
60                 {
61                         return false;
62                 }
63
64                 if (sizeof($this->open_queries))
65                 {
66                         foreach ($this->open_queries as $i_query_id => $query_id)
67                         {
68                                 @mysql_free_result($query_id);
69                         }
70                 }
71
72                 return @mysql_close($this->db_connect_id);
73         }
74
75         function sql_return_on_error($fail = false)
76         {
77                 $this->return_on_error = $fail;
78         }
79
80         function sql_num_queries()
81         {
82                 return $this->num_queries;
83         }
84
85         function sql_transaction($status = 'begin')
86         {
87                 switch ($status)
88                 {
89                         case 'begin':
90                                 $result = @mysql_query('BEGIN', $this->db_connect_id);
91                                 $this->transaction = true;
92                                 break;
93
94                         case 'commit':
95                                 $result = @mysql_query('COMMIT', $this->db_connect_id);
96                                 $this->transaction = false;
97                                 
98                                 if (!$result)
99                                 {
100                                         @mysql_query('ROLLBACK', $this->db_connect_id);
101                                 }
102                                 break;
103
104                         case 'rollback':
105                                 $result = @mysql_query('ROLLBACK', $this->db_connect_id);
106                                 $this->transaction = false;
107                                 break;
108
109                         default:
110                                 $result = true;
111                 }
112
113                 return $result;
114         }
115
116         // Base query method
117         function sql_query($query = '', $cache_ttl = 0)
118         {
119                 if ($query != '')
120                 {
121                         global $cache;
122
123                         // EXPLAIN only in extra debug mode
124                         if (defined('DEBUG_EXTRA'))
125                         {
126                                 $this->sql_report('start', $query);
127                         }
128
129                         $this->query_result = ($cache_ttl && method_exists($cache, 'sql_load')) ? $cache->sql_load($query) : false;
130
131                         if (!$this->query_result)
132                         {
133                                 $this->num_queries++;
134
135                                 if (($this->query_result = @mysql_query($query, $this->db_connect_id)) === false)
136                                 {
137                                         $this->sql_error($query);
138                                 }
139
140                                 if (defined('DEBUG_EXTRA'))
141                                 {
142                                         $this->sql_report('stop', $query);
143                                 }
144
145                                 if ($cache_ttl && method_exists($cache, 'sql_save'))
146                                 {
147                                         $this->open_queries[(int) $this->query_result] = $this->query_result;
148                                         $cache->sql_save($query, $this->query_result, $cache_ttl);
149                                         // mysql_free_result called within sql_save()
150                                 }
151                                 else if (strpos($query, 'SELECT') !== false && $this->query_result)
152                                 {
153                                         $this->open_queries[(int) $this->query_result] = $this->query_result;
154                                 }
155                         }
156                         else if (defined('DEBUG_EXTRA'))
157                         {
158                                 $this->sql_report('fromcache', $query);
159                         }
160                 }
161                 else
162                 {
163                         return false;
164                 }
165
166                 return ($this->query_result) ? $this->query_result : false;
167         }
168
169         function sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0) { 
170                 if ($query != '') {
171             $this->query_result = false; 
172
173                         // only limit the number of rows if $total is greater than 0
174                         if ($total > 0)
175                         $query .= "\n LIMIT " . ((!empty($offset)) ? $offset . ', ' . $total : $total);
176
177                         return $this->sql_query($query, $cache_ttl); 
178                 } else { 
179             return false; 
180                 } 
181         }
182
183         // Idea for this from Ikonboard
184         function sql_build_array($query, $assoc_ary = false)
185         {
186                 if (!is_array($assoc_ary))
187                 {
188                         return false;
189                 }
190
191                 $fields = array();
192                 $values = array();
193                 if ($query == 'INSERT')
194                 {
195                         foreach ($assoc_ary as $key => $var)
196                         {
197                                 $fields[] = $key;
198
199                                 if (is_null($var))
200                                 {
201                                         $values[] = 'NULL';
202                                 }
203                                 elseif (is_string($var))
204                                 {
205                                         $values[] = "'" . $this->sql_escape($var) . "'";
206                                 }
207                                 else
208                                 {
209                                         $values[] = (is_bool($var)) ? intval($var) : $var;
210                                 }
211                         }
212
213                         $query = ' (' . implode(', ', $fields) . ') VALUES (' . implode(', ', $values) . ')';
214                 }
215                 else if ($query == 'UPDATE' || $query == 'SELECT')
216                 {
217                         $values = array();
218                         foreach ($assoc_ary as $key => $var)
219                         {
220                                 if (is_null($var))
221                                 {
222                                         $values[] = "$key = NULL";
223                                 }
224                                 elseif (is_string($var))
225                                 {
226                                         $values[] = "$key = '" . $this->sql_escape($var) . "'";
227                                 }
228                                 else
229                                 {
230                                         $values[] = (is_bool($var)) ? "$key = " . intval($var) : "$key = $var";
231                                 }
232                         }
233                         $query = implode(($query == 'UPDATE') ? ', ' : ' AND ', $values);
234                 }
235
236                 return $query;
237         }
238
239         // Other query methods
240         //
241         // NOTE :: Want to remove _ALL_ reliance on sql_numrows from core code ...
242         //         don't want this here by a middle Milestone
243         function sql_numrows($query_id = false)
244         {
245                 if (!$query_id)
246                 {
247                         $query_id = $this->query_result;
248                 }
249
250                 return ($query_id) ? @mysql_num_rows($query_id) : false;
251         }
252
253         function sql_affectedrows()
254         {
255                 return ($this->db_connect_id) ? @mysql_affected_rows($this->db_connect_id) : false;
256         }
257
258         function sql_fetchrow($query_id = false)
259         {
260                 global $cache;
261
262                 if (!$query_id)
263                 {
264                         $query_id = $this->query_result;
265                 }
266
267                 if (isset($cache->sql_rowset[$query_id]))
268                 {
269                         return $cache->sql_fetchrow($query_id);
270                 }
271
272                 return ($query_id) ? @mysql_fetch_assoc($query_id) : false;
273         }
274
275         function sql_fetchrowset($query_id = false)
276         {
277                 if (!$query_id)
278                 {
279                         $query_id = $this->query_result;
280                 }
281
282                 if ($query_id)
283                 {
284                         unset($this->rowset[$query_id]);
285                         unset($this->row[$query_id]);
286
287                         $result = array();
288                         while ($this->rowset[$query_id] = $this->sql_fetchrow($query_id))
289                         {
290                                 $result[] = $this->rowset[$query_id];
291                         }
292                         return $result;
293                 }
294                 
295                 return false;
296         }
297
298         function sql_fetchfield($field, $rownum = -1, $query_id = false)
299         {
300                 if (!$query_id)
301                 {
302                         $query_id = $this->query_result;
303                 }
304
305                 if ($query_id)
306                 {
307                         if ($rownum > -1)
308                         {
309                                 $result = @mysql_result($query_id, $rownum, $field);
310                         }
311                         else
312                         {
313                                 if (empty($this->row[$query_id]) && empty($this->rowset[$query_id]))
314                                 {
315                                         if ($this->sql_fetchrow($query_id))
316                                         {
317                                                 $result = $this->row[$query_id][$field];
318                                         }
319                                 }
320                                 else
321                                 {
322                                         if ($this->rowset[$query_id])
323                                         {
324                                                 $result = $this->rowset[$query_id][$field];
325                                         }
326                                         elseif ($this->row[$query_id])
327                                         {
328                                                 $result = $this->row[$query_id][$field];
329                                         }
330                                 }
331                         }
332                         return $result;
333                 }
334                 return false;
335         }
336
337         function sql_rowseek($rownum, $query_id = false)
338         {
339                 if (!$query_id)
340                 {
341                         $query_id = $this->query_result;
342                 }
343
344                 return ($query_id) ? @mysql_data_seek($query_id, $rownum) : false;
345         }
346
347         function sql_nextid()
348         {
349                 return ($this->db_connect_id) ? @mysql_insert_id($this->db_connect_id) : false;
350         }
351
352         function sql_freeresult($query_id = false)
353         {
354                 if (!$query_id)
355                 {
356                         $query_id = $this->query_result;
357                 }
358
359                 if (isset($this->open_queries[(int) $query_id]))
360                 {
361                         unset($this->open_queries[(int) $query_id]);
362                         return @mysql_free_result($query_id);
363                 }
364
365                 return false;
366         }
367
368         function sql_escape($msg) {
369                 if (function_exists('mysql_real_escape_string')) {
370                         return @mysql_real_escape_string($msg, $this->db_connect_id);
371                 } else {
372                         return mysql_escape_string($msg);
373                 }               
374         }
375         
376         function sql_error($sql = '')
377         {
378                 if (!$this->return_on_error)
379                 {
380                         $this_page = (isset($_SERVER['PHP_SELF']) && !empty($_SERVER['PHP_SELF'])) ? $_SERVER['PHP_SELF'] : $_ENV['PHP_SELF'];
381                         $this_page .= '&' . ((isset($_SERVER['QUERY_STRING']) && !empty($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : (isset($_ENV['QUERY_STRING']) ? $_ENV['QUERY_STRING'] : ''));
382
383                         $message = '<u>SQL ERROR</u> [ ' . SQL_LAYER . ' ]<br /><br />' . @mysql_error() . '<br /><br /><u>CALLING PAGE</u><br /><br />'  . htmlspecialchars($this_page) . (($sql != '') ? '<br /><br /><u>SQL</u><br /><br />' . $sql : '') . '<br />';
384
385                         if ($this->transaction)
386                         {
387                                 $this->sql_transaction('rollback');
388                         }
389                         
390                         trigger_error($message, E_USER_ERROR);
391                 }
392
393                 $result = array(
394                         'message'       => @mysql_error(),
395                         'code'          => @mysql_errno()
396                 );
397
398                 return $result;
399         }
400
401         function sql_report($mode, $query = '')
402         {
403                 if (empty($_GET['explain']))
404                 {
405                         return;
406                 }
407
408                 global $db, $cache, $starttime, $phpbb_root_path;
409                 static $curtime, $query_hold, $html_hold;
410                 static $sql_report = '';
411                 static $cache_num_queries = 0;
412
413                 if (!$query && !empty($query_hold))
414                 {
415                         $query = $query_hold;
416                 }
417
418                 switch ($mode)
419                 {
420                         case 'display':
421                                 if (!empty($cache))
422                                 {
423                                         $cache->unload();
424                                 }
425                                 $db->sql_close();
426
427                                 $mtime = explode(' ', microtime());
428                                 $totaltime = $mtime[0] + $mtime[1] - $starttime;
429
430                                 echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html; charset=iso-8869-1"><meta http-equiv="Content-Style-Type" content="text/css"><link rel="stylesheet" href="' . $phpbb_root_path . 'adm/subSilver.css" type="text/css"><style type="text/css">' . "\n";
431                                 echo 'th { background-image: url(\'' . $phpbb_root_path . 'adm/images/cellpic3.gif\') }' . "\n";
432                                 echo 'td.cat    { background-image: url(\'' . $phpbb_root_path . 'adm/images/cellpic1.gif\') }' . "\n";
433                                 echo '</style><title>' . $msg_title . '</title></head><body>';
434                                 echo '<table width="100%" cellspacing="0" cellpadding="0" border="0"><tr><td><a href="' . htmlspecialchars(preg_replace('/&explain=([^&]*)/', '', $_SERVER['REQUEST_URI'])) . '"><img src="' . $phpbb_root_path . 'adm/images/header_left.jpg" width="200" height="60" alt="phpBB Logo" title="phpBB Logo" border="0"/></a></td><td width="100%" background="' . $phpbb_root_path . 'adm/images/header_bg.jpg" height="60" align="right" nowrap="nowrap"><span class="maintitle">SQL Report</span> &nbsp; &nbsp; &nbsp;</td></tr></table><br clear="all"/><table width="95%" cellspacing="1" cellpadding="4" border="0" align="center"><tr><td height="40" align="center" valign="middle"><b>Page generated in ' . round($totaltime, 4) . " seconds with {$this->num_queries} queries" . (($cache_num_queries) ? " + $cache_num_queries " . (($cache_num_queries == 1) ? 'query' : 'queries') . ' returning data from cache' : '') . '</b></td></tr><tr><td align="center" nowrap="nowrap">Time spent on MySQL queries: <b>' . round($this->sql_time, 5) . 's</b> | Time spent on PHP: <b>' . round($totaltime - $this->sql_time, 5) . 's</b></td></tr></table><table width="95%" cellspacing="1" cellpadding="4" border="0" align="center"><tr><td>';
435                                 echo $sql_report;
436                                 echo '</td></tr></table><br /></body></html>';
437                                 exit;
438                                 break;
439
440                         case 'start':
441                                 $query_hold = $query;
442                                 $html_hold = '';
443
444                                 $explain_query = $query;
445                                 if (preg_match('/UPDATE ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))
446                                 {
447                                         $explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];
448                                 }
449                                 elseif (preg_match('/DELETE FROM ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))
450                                 {
451                                         $explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];
452                                 }
453
454                                 if (preg_match('/^SELECT/', $explain_query))
455                                 {
456                                         $html_table = FALSE;
457
458                                         if ($result = mysql_query("EXPLAIN $explain_query", $this->db_connect_id))
459                                         {
460                                                 while ($row = mysql_fetch_assoc($result))
461                                                 {
462                                                         if (!$html_table && sizeof($row))
463                                                         {
464                                                                 $html_table = TRUE;
465                                                                 $html_hold .= '<table class="bg" width="100%" cellspacing="1" cellpadding="4" border="0" align="center"><tr>';
466                                                                 
467                                                                 foreach (array_keys($row) as $val)
468                                                                 {
469                                                                         $html_hold .= '<th nowrap="nowrap">' . (($val) ? ucwords(str_replace('_', ' ', $val)) : '&nbsp;') . '</th>';
470                                                                 }
471                                                                 $html_hold .= '</tr>';
472                                                         }
473                                                         $html_hold .= '<tr>';
474
475                                                         $class = 'row1';
476                                                         foreach (array_values($row) as $val)
477                                                         {
478                                                                 $class = ($class == 'row1') ? 'row2' : 'row1';
479                                                                 $html_hold .= '<td class="' . $class . '">' . (($val) ? $val : '&nbsp;') . '</td>';
480                                                         }
481                                                         $html_hold .= '</tr>';
482                                                 }
483                                         }
484
485                                         if ($html_table)
486                                         {
487                                                 $html_hold .= '</table>';
488                                         }
489                                 }
490
491                                 $curtime = explode(' ', microtime());
492                                 $curtime = $curtime[0] + $curtime[1];
493                                 break;
494
495                         case 'fromcache':
496                                 $endtime = explode(' ', microtime());
497                                 $endtime = $endtime[0] + $endtime[1];
498
499                                 $result = mysql_query($query, $this->db_connect_id);
500                                 while ($void = mysql_fetch_assoc($result))
501                                 {
502                                         // Take the time spent on parsing rows into account
503                                 }
504                                 $splittime = explode(' ', microtime());
505                                 $splittime = $splittime[0] + $splittime[1];
506
507                                 $time_cache = $endtime - $curtime;
508                                 $time_db = $splittime - $endtime;
509                                 $color = ($time_db > $time_cache) ? 'green' : 'red';
510
511                                 $sql_report .= '<hr width="100%"/><br /><table class="bg" width="100%" cellspacing="1" cellpadding="4" border="0"><tr><th>Query results obtained from the cache</th></tr><tr><td class="row1"><textarea style="font-family:\'Courier New\',monospace;width:100%" rows="5">' . preg_replace('/\t(AND|OR)(\W)/', "\$1\$2", htmlspecialchars(preg_replace('/[\s]*[\n\r\t]+[\n\r\s\t]*/', "\n", $query))) . '</textarea></td></tr></table><p align="center">';
512
513                                 $sql_report .= 'Before: ' . sprintf('%.5f', $curtime - $starttime) . 's | After: ' . sprintf('%.5f', $endtime - $starttime) . 's | Elapsed [cache]: <b style="color: ' . $color . '">' . sprintf('%.5f', ($time_cache)) . 's</b> | Elapsed [db]: <b>' . sprintf('%.5f', $time_db) . 's</b></p>';
514
515                                 // Pad the start time to not interfere with page timing
516                                 $starttime += $time_db;
517
518                                 mysql_free_result($result);
519                                 $cache_num_queries++;
520                                 break;
521
522                         case 'stop':
523                                 $endtime = explode(' ', microtime());
524                                 $endtime = $endtime[0] + $endtime[1];
525
526                                 $sql_report .= '<hr width="100%"/><br /><table class="bg" width="100%" cellspacing="1" cellpadding="4" border="0"><tr><th>Query #' . $this->num_queries . '</th></tr><tr><td class="row1"><textarea style="font-family:\'Courier New\',monospace;width:100%" rows="5">' . preg_replace('/\t(AND|OR)(\W)/', "\$1\$2", htmlspecialchars(preg_replace('/[\s]*[\n\r\t]+[\n\r\s\t]*/', "\n", $query))) . '</textarea></td></tr></table> ' . $html_hold . '<p align="center">';
527
528                                 if ($this->query_result)
529                                 {
530                                         if (preg_match('/^(UPDATE|DELETE|REPLACE)/', $query))
531                                         {
532                                                 $sql_report .= "Affected rows: <b>" . $this->sql_affectedrows($this->query_result) . '</b> | ';
533                                         }
534                                         $sql_report .= 'Before: ' . sprintf('%.5f', $curtime - $starttime) . 's | After: ' . sprintf('%.5f', $endtime - $starttime) . 's | Elapsed: <b>' . sprintf('%.5f', $endtime - $curtime) . 's</b>';
535                                 }
536                                 else
537                                 {
538                                         $error = $this->sql_error();
539                                         $sql_report .= '<b style="color: red">FAILED</b> - MySQL Error ' . $error['code'] . ': ' . htmlspecialchars($error['message']);
540                                 }
541
542                                 $sql_report .= '</p>';
543
544                                 $this->sql_time += $endtime - $curtime;
545                                 break;
546                 }
547         }
548 } // class sql_db
549
550 } // if ... define
551
552 ?>

Benjamin Mako Hill || Want to submit a patch?