5 * @version $Id: mysqli.php,v 1.4 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
14 if (!defined('SQL_LAYER'))
17 define('SQL_LAYER', 'mysqli');
20 * @package dbal_mysqli
21 * MySQLi Database Abstraction Layer
22 * Minimum Requirement is MySQL 4.1+ and the mysqli-extension
28 var $return_on_error = false;
29 var $transaction = false;
32 var $open_queries = array();
36 function sql_connect($sqlserver, $sqluser, $sqlpassword, $database, $port = false, $persistency = false)
38 $this->persistency = $persistency;
39 $this->user = $sqluser;
40 $this->server = $sqlserver . (($port) ? ':' . $port : '');
41 $this->dbname = $database;
43 $this->db_connect_id = ($this->persistency) ? @mysqli_pconnect($this->server, $this->user, $sqlpassword) : @mysqli_connect($this->server, $this->user, $sqlpassword);
45 if ($this->db_connect_id && $this->dbname != '')
47 if (@mysqli_select_db($this->db_connect_id, $this->dbname))
50 mysqli_query($this->db_connect_id, 'SET CHARACTER SET utf8');
51 return $this->db_connect_id;
55 return $this->sql_error('');
63 if (!$this->db_connect_id)
68 if ($this->transaction)
70 @mysqli_commit($this->db_connect_id);
73 return @mysqli_close($this->db_connect_id);
76 function sql_return_on_error($fail = false)
78 $this->return_on_error = $fail;
81 function sql_num_queries()
83 return $this->num_queries;
86 function sql_transaction($status = 'begin')
91 $result = @mysqli_autocommit($this->db_connect_id, false);
92 $this->transaction = true;
96 $result = @mysqli_commit($this->db_connect_id);
97 @mysqli_autocommit($this->db_connect_id, true);
98 $this->transaction = false;
102 @mysqli_rollback($this->db_connect_id);
103 @mysqli_autocommit($this->db_connect_id, true);
108 $result = @mysqli_rollback($this->db_connect_id);
109 @mysqli_autocommit($this->db_connect_id, true);
110 $this->transaction = false;
121 function sql_query($query = '', $cache_ttl = 0)
127 // EXPLAIN only in extra debug mode
128 if (defined('DEBUG_EXTRA'))
130 $this->sql_report('start', $query);
133 $this->query_result = ($cache_ttl && method_exists($cache, 'sql_load')) ? $cache->sql_load($query) : false;
135 if (!$this->query_result)
137 $this->num_queries++;
139 if (($this->query_result = @mysqli_query($this->db_connect_id, $query)) === false)
141 $this->sql_error($query);
144 if (is_object($this->query_result))
146 $this->query_result->cur_index = $this->indexed++;
149 if (defined('DEBUG_EXTRA'))
151 $this->sql_report('stop', $query);
154 if ($cache_ttl && method_exists($cache, 'sql_save'))
156 $cache->sql_save($query, $this->query_result, $cache_ttl);
159 else if (defined('DEBUG_EXTRA'))
161 $this->sql_report('fromcache', $query);
169 return ($this->query_result) ? $this->query_result : false;
172 function sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0) {
174 $this->query_result = false;
176 // only limit the number of rows if $total is greater than 0
178 $query .= "\n LIMIT " . ((!empty($offset)) ? $offset . ', ' . $total : $total);
180 return $this->sql_query($query, $cache_ttl);
186 // Idea for this from Ikonboard
187 function sql_build_array($query, $assoc_ary = false)
189 if (!is_array($assoc_ary))
196 if ($query == 'INSERT')
198 foreach ($assoc_ary as $key => $var)
206 elseif (is_string($var))
208 $values[] = "'" . $this->sql_escape($var) . "'";
212 $values[] = (is_bool($var)) ? intval($var) : $var;
216 $query = ' (' . implode(', ', $fields) . ') VALUES (' . implode(', ', $values) . ')';
218 else if ($query == 'UPDATE' || $query == 'SELECT')
221 foreach ($assoc_ary as $key => $var)
225 $values[] = "$key = NULL";
227 elseif (is_string($var))
229 $values[] = "$key = '" . $this->sql_escape($var) . "'";
233 $values[] = (is_bool($var)) ? "$key = " . intval($var) : "$key = $var";
236 $query = implode(($query == 'UPDATE') ? ', ' : ' AND ', $values);
242 // Other query methods
244 // NOTE :: Want to remove _ALL_ reliance on sql_numrows from core code ...
245 // don't want this here by a middle Milestone
246 function sql_numrows($query_id = false)
250 $query_id = $this->query_result;
253 return ($query_id) ? @mysqli_num_rows($query_id) : false;
256 function sql_affectedrows()
258 return ($this->db_connect_id) ? @mysqli_affected_rows($this->db_connect_id) : false;
261 function sql_fetchrow($query_id = false)
267 $query_id = $this->query_result;
270 if (!is_object($query_id) && isset($cache->sql_rowset[$query_id]))
272 return $cache->sql_fetchrow($query_id);
275 return ($query_id) ? @mysqli_fetch_assoc($query_id) : false;
278 function sql_fetchrowset($query_id = false)
282 $query_id = $this->query_result;
287 $cur_index = (is_object($query_id)) ? $query_id->cur_index : $query_id;
289 unset($this->rowset[$cur_index]);
290 unset($this->row[$cur_index]);
293 while ($this->rowset[$cur_index] = $this->sql_fetchrow($query_id))
295 $result[] = $this->rowset[$cur_index];
303 function sql_fetchfield($field, $rownum = -1, $query_id = false)
307 $query_id = $this->query_result;
314 @mysqli_data_seek($query_id, $rownum);
315 $row = @mysqli_fetch_assoc($query_id);
316 $result = isset($row[$field]) ? $row[$field] : false;
320 $cur_index = (is_object($query_id)) ? $query_id->cur_index : $query_id;
322 if (empty($this->row[$cur_index]) && empty($this->rowset[$cur_index]))
324 if ($this->row[$cur_index] = $this->sql_fetchrow($query_id))
326 $result = $this->row[$cur_index][$field];
331 if ($this->rowset[$cur_index])
333 $result = $this->rowset[$cur_index][$field];
335 elseif ($this->row[$cur_index])
337 $result = $this->row[$cur_index][$field];
346 function sql_rowseek($rownum, $query_id = false)
350 $query_id = $this->query_result;
353 return ($query_id) ? @mysqli_data_seek($query_id, $rownum) : false;
356 function sql_nextid()
358 return ($this->db_connect_id) ? @mysqli_insert_id($this->db_connect_id) : false;
361 function sql_freeresult($query_id = false)
365 $query_id = $this->query_result;
368 $cur_index = (is_object($query_id)) ? $query_id->cur_index : $query_id;
370 unset($this->rowset[$cur_index]);
371 unset($this->row[$cur_index]);
373 if (is_object($query_id))
376 return @mysqli_free_result($query_id);
384 function sql_escape($msg) {
385 if (function_exists('mysqli_real_escape_string')) {
386 return @mysqli_real_escape_string($this->db_connect_id, $msg);
388 return mysqli_escape_string($this->db_connect_id, $msg);
392 function sql_error($sql = '')
394 if (!$this->return_on_error)
396 $this_page = (isset($_SERVER['PHP_SELF']) && !empty($_SERVER['PHP_SELF'])) ? $_SERVER['PHP_SELF'] : $_ENV['PHP_SELF'];
397 $this_page .= '&' . ((isset($_SERVER['QUERY_STRING']) && !empty($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : (isset($_ENV['QUERY_STRING']) ? $_ENV['QUERY_STRING'] : ''));
399 $message = '<u>SQL ERROR</u> [ ' . SQL_LAYER . ' ]<br /><br />' . @mysqli_error($this->db_connect_id) . '<br /><br /><u>CALLING PAGE</u><br /><br />' . htmlspecialchars($this_page) . (($sql != '') ? '<br /><br /><u>SQL</u><br /><br />' . $sql : '') . '<br />';
401 if ($this->transaction)
403 $this->sql_transaction('rollback');
406 trigger_error($message, E_USER_ERROR);
410 'message' => @mysqli_error($this->db_connect_id),
411 'code' => @mysqli_errno($this->db_connect_id)
417 function sql_report($mode, $query = '')
419 if (empty($_GET['explain']))
424 global $db, $cache, $starttime, $phpbb_root_path;
425 static $curtime, $query_hold, $html_hold;
426 static $sql_report = '';
427 static $cache_num_queries = 0;
429 if (!$query && !empty($query_hold))
431 $query = $query_hold;
443 $mtime = explode(' ', microtime());
444 $totaltime = $mtime[0] + $mtime[1] - $starttime;
446 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";
447 echo 'th { background-image: url(\'' . $phpbb_root_path . 'adm/images/cellpic3.gif\') }' . "\n";
448 echo 'td.cat { background-image: url(\'' . $phpbb_root_path . 'adm/images/cellpic1.gif\') }' . "\n";
449 echo '</style><title>' . $msg_title . '</title></head><body>';
450 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> </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>';
452 echo '</td></tr></table><br /></body></html>';
457 $query_hold = $query;
460 $explain_query = $query;
461 if (preg_match('/UPDATE ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))
463 $explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];
465 elseif (preg_match('/DELETE FROM ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))
467 $explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];
470 if (preg_match('/^SELECT/', $explain_query))
474 if ($result = @mysqli_query($this->db_connect_id, "EXPLAIN $explain_query"))
476 while ($row = @mysqli_fetch_assoc($result))
478 if (!$html_table && sizeof($row))
481 $html_hold .= '<table class="bg" width="100%" cellspacing="1" cellpadding="4" border="0" align="center"><tr>';
483 foreach (array_keys($row) as $val)
485 $html_hold .= '<th nowrap="nowrap">' . (($val) ? ucwords(str_replace('_', ' ', $val)) : ' ') . '</th>';
487 $html_hold .= '</tr>';
489 $html_hold .= '<tr>';
492 foreach (array_values($row) as $val)
494 $class = ($class == 'row1') ? 'row2' : 'row1';
495 $html_hold .= '<td class="' . $class . '">' . (($val) ? $val : ' ') . '</td>';
497 $html_hold .= '</tr>';
503 $html_hold .= '</table>';
507 $curtime = explode(' ', microtime());
508 $curtime = $curtime[0] + $curtime[1];
512 $endtime = explode(' ', microtime());
513 $endtime = $endtime[0] + $endtime[1];
515 $result = @mysqli_query($this->db_connect_id, $query);
516 while ($void = @mysqli_fetch_assoc($result))
518 // Take the time spent on parsing rows into account
520 $splittime = explode(' ', microtime());
521 $splittime = $splittime[0] + $splittime[1];
523 $time_cache = $endtime - $curtime;
524 $time_db = $splittime - $endtime;
525 $color = ($time_db > $time_cache) ? 'green' : 'red';
527 $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">';
529 $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>';
531 // Pad the start time to not interfere with page timing
532 $starttime += $time_db;
534 @mysqli_free_result($result);
535 $cache_num_queries++;
539 $endtime = explode(' ', microtime());
540 $endtime = $endtime[0] + $endtime[1];
542 $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">';
544 if ($this->query_result)
546 if (preg_match('/^(UPDATE|DELETE|REPLACE)/', $query))
548 $sql_report .= "Affected rows: <b>" . $this->sql_affectedrows($this->query_result) . '</b> | ';
550 $sql_report .= 'Before: ' . sprintf('%.5f', $curtime - $starttime) . 's | After: ' . sprintf('%.5f', $endtime - $starttime) . 's | Elapsed: <b>' . sprintf('%.5f', $endtime - $curtime) . 's</b>';
554 $error = $this->sql_error();
555 $sql_report .= '<b style="color: red">FAILED</b> - MySQL Error ' . $error['code'] . ': ' . htmlspecialchars($error['message']);
558 $sql_report .= '</p>';
560 $this->sql_time += $endtime - $curtime;