5 * @version $Id: mysql4.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', 'mysql4');
20 * @package dbal_mysql4
21 * MySQL4 Database Abstraction Layer
22 * Minimum Requirement is 4.0+/4.1+
28 var $return_on_error = false;
29 var $transaction = false;
32 var $open_queries = array();
34 function sql_connect($sqlserver, $sqluser, $sqlpassword, $database, $port = false, $persistency = false)
36 $this->persistency = $persistency;
37 $this->user = $sqluser;
38 $this->server = $sqlserver . (($port) ? ':' . $port : '');
39 $this->dbname = $database;
41 $this->db_connect_id = ($this->persistency) ? @mysql_pconnect($this->server, $this->user, $sqlpassword) : @mysql_connect($this->server, $this->user, $sqlpassword);
43 if ($this->db_connect_id && $this->dbname != '')
45 if (@mysql_select_db($this->dbname))
48 mysql_query('SET CHARACTER SET utf8', $this->db_connect_id);
49 return $this->db_connect_id;
53 return $this->sql_error('');
61 if (!$this->db_connect_id)
66 if (sizeof($this->open_queries))
68 foreach ($this->open_queries as $i_query_id => $query_id)
70 @mysql_free_result($query_id);
74 return @mysql_close($this->db_connect_id);
77 function sql_return_on_error($fail = false)
79 $this->return_on_error = $fail;
82 function sql_num_queries()
84 return $this->num_queries;
87 function sql_transaction($status = 'begin')
92 $result = @mysql_query('BEGIN', $this->db_connect_id);
93 $this->transaction = true;
97 $result = @mysql_query('COMMIT', $this->db_connect_id);
98 $this->transaction = false;
102 @mysql_query('ROLLBACK', $this->db_connect_id);
107 $result = @mysql_query('ROLLBACK', $this->db_connect_id);
108 $this->transaction = false;
119 function sql_query($query = '', $cache_ttl = 0)
125 // EXPLAIN only in extra debug mode
126 if (defined('DEBUG_EXTRA'))
128 $this->sql_report('start', $query);
131 $this->query_result = ($cache_ttl && method_exists($cache, 'sql_load')) ? $cache->sql_load($query) : false;
133 if (!$this->query_result)
135 $this->num_queries++;
137 if (($this->query_result = @mysql_query($query, $this->db_connect_id)) === false)
139 $this->sql_error($query);
142 if (defined('DEBUG_EXTRA'))
144 $this->sql_report('stop', $query);
147 if ($cache_ttl && method_exists($cache, 'sql_save'))
149 $this->open_queries[(int) $this->query_result] = $this->query_result;
150 $cache->sql_save($query, $this->query_result, $cache_ttl);
151 // mysql_free_result called within sql_save()
153 else if (strpos($query, 'SELECT') !== false && $this->query_result)
155 $this->open_queries[(int) $this->query_result] = $this->query_result;
158 else if (defined('DEBUG_EXTRA'))
160 $this->sql_report('fromcache', $query);
168 return ($this->query_result) ? $this->query_result : false;
171 function sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0) {
173 $this->query_result = false;
175 // only limit the number of rows if $total is greater than 0
177 $query .= "\n LIMIT " . ((!empty($offset)) ? $offset . ', ' . $total : $total);
179 return $this->sql_query($query, $cache_ttl);
185 // Idea for this from Ikonboard
186 function sql_build_array($query, $assoc_ary = false)
188 if (!is_array($assoc_ary))
195 if ($query == 'INSERT')
197 foreach ($assoc_ary as $key => $var)
205 elseif (is_string($var))
207 $values[] = "'" . $this->sql_escape($var) . "'";
211 $values[] = (is_bool($var)) ? intval($var) : $var;
215 $query = ' (' . implode(', ', $fields) . ') VALUES (' . implode(', ', $values) . ')';
217 else if ($query == 'UPDATE' || $query == 'SELECT')
220 foreach ($assoc_ary as $key => $var)
224 $values[] = "$key = NULL";
226 elseif (is_string($var))
228 $values[] = "$key = '" . $this->sql_escape($var) . "'";
232 $values[] = (is_bool($var)) ? "$key = " . intval($var) : "$key = $var";
235 $query = implode(($query == 'UPDATE') ? ', ' : ' AND ', $values);
241 // Other query methods
243 // NOTE :: Want to remove _ALL_ reliance on sql_numrows from core code ...
244 // don't want this here by a middle Milestone
245 function sql_numrows($query_id = false)
249 $query_id = $this->query_result;
252 return ($query_id) ? @mysql_num_rows($query_id) : false;
255 function sql_affectedrows()
257 return ($this->db_connect_id) ? @mysql_affected_rows($this->db_connect_id) : false;
260 function sql_fetchrow($query_id = false)
266 $query_id = $this->query_result;
269 if (isset($cache->sql_rowset[$query_id]))
271 return $cache->sql_fetchrow($query_id);
274 return ($query_id) ? @mysql_fetch_assoc($query_id) : false;
277 function sql_fetchrowset($query_id = false)
281 $query_id = $this->query_result;
286 unset($this->rowset[$query_id]);
287 unset($this->row[$query_id]);
290 while ($this->rowset[$query_id] = $this->sql_fetchrow($query_id))
292 $result[] = $this->rowset[$query_id];
300 function sql_fetchfield($field, $rownum = -1, $query_id = false)
304 $query_id = $this->query_result;
311 $result = @mysql_result($query_id, $rownum, $field);
315 if (empty($this->row[$query_id]) && empty($this->rowset[$query_id]))
317 if ($this->sql_fetchrow($query_id))
319 $result = $this->row[$query_id][$field];
324 if ($this->rowset[$query_id])
326 $result = $this->rowset[$query_id][$field];
328 elseif ($this->row[$query_id])
330 $result = $this->row[$query_id][$field];
339 function sql_rowseek($rownum, $query_id = false)
343 $query_id = $this->query_result;
346 return ($query_id) ? @mysql_data_seek($query_id, $rownum) : false;
349 function sql_nextid()
351 return ($this->db_connect_id) ? @mysql_insert_id($this->db_connect_id) : false;
354 function sql_freeresult($query_id = false)
358 $query_id = $this->query_result;
361 if (isset($this->open_queries[(int) $query_id]))
363 unset($this->open_queries[(int) $query_id]);
364 return @mysql_free_result($query_id);
370 function sql_escape($msg) {
371 if (function_exists('mysql_real_escape_string')) {
372 return @mysql_real_escape_string($msg, $this->db_connect_id);
374 return mysql_escape_string($msg);
378 function sql_error($sql = '')
380 if (!$this->return_on_error)
382 $this_page = (isset($_SERVER['PHP_SELF']) && !empty($_SERVER['PHP_SELF'])) ? $_SERVER['PHP_SELF'] : $_ENV['PHP_SELF'];
383 $this_page .= '&' . ((isset($_SERVER['QUERY_STRING']) && !empty($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : (isset($_ENV['QUERY_STRING']) ? $_ENV['QUERY_STRING'] : ''));
385 $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 />';
387 if ($this->transaction)
389 $this->sql_transaction('rollback');
392 trigger_error($message, E_USER_ERROR);
396 'message' => @mysql_error(),
397 'code' => @mysql_errno()
403 function sql_report($mode, $query = '')
405 if (empty($_GET['explain']))
410 global $db, $cache, $starttime, $phpbb_root_path;
411 static $curtime, $query_hold, $html_hold;
412 static $sql_report = '';
413 static $cache_num_queries = 0;
415 if (!$query && !empty($query_hold))
417 $query = $query_hold;
429 $mtime = explode(' ', microtime());
430 $totaltime = $mtime[0] + $mtime[1] - $starttime;
432 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";
433 echo 'th { background-image: url(\'' . $phpbb_root_path . 'adm/images/cellpic3.gif\') }' . "\n";
434 echo 'td.cat { background-image: url(\'' . $phpbb_root_path . 'adm/images/cellpic1.gif\') }' . "\n";
435 echo '</style><title>' . $msg_title . '</title></head><body>';
436 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>';
438 echo '</td></tr></table><br /></body></html>';
443 $query_hold = $query;
446 $explain_query = $query;
447 if (preg_match('/UPDATE ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))
449 $explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];
451 elseif (preg_match('/DELETE FROM ([a-z0-9_]+).*?WHERE(.*)/s', $query, $m))
453 $explain_query = 'SELECT * FROM ' . $m[1] . ' WHERE ' . $m[2];
456 if (preg_match('/^SELECT/', $explain_query))
460 if ($result = mysql_query("EXPLAIN $explain_query", $this->db_connect_id))
462 while ($row = mysql_fetch_assoc($result))
464 if (!$html_table && sizeof($row))
467 $html_hold .= '<table class="bg" width="100%" cellspacing="1" cellpadding="4" border="0" align="center"><tr>';
469 foreach (array_keys($row) as $val)
471 $html_hold .= '<th nowrap="nowrap">' . (($val) ? ucwords(str_replace('_', ' ', $val)) : ' ') . '</th>';
473 $html_hold .= '</tr>';
475 $html_hold .= '<tr>';
478 foreach (array_values($row) as $val)
480 $class = ($class == 'row1') ? 'row2' : 'row1';
481 $html_hold .= '<td class="' . $class . '">' . (($val) ? $val : ' ') . '</td>';
483 $html_hold .= '</tr>';
489 $html_hold .= '</table>';
493 $curtime = explode(' ', microtime());
494 $curtime = $curtime[0] + $curtime[1];
498 $endtime = explode(' ', microtime());
499 $endtime = $endtime[0] + $endtime[1];
501 $result = mysql_query($query, $this->db_connect_id);
502 while ($void = mysql_fetch_assoc($result))
504 // Take the time spent on parsing rows into account
506 $splittime = explode(' ', microtime());
507 $splittime = $splittime[0] + $splittime[1];
509 $time_cache = $endtime - $curtime;
510 $time_db = $splittime - $endtime;
511 $color = ($time_db > $time_cache) ? 'green' : 'red';
513 $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">';
515 $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>';
517 // Pad the start time to not interfere with page timing
518 $starttime += $time_db;
520 mysql_free_result($result);
521 $cache_num_queries++;
525 $endtime = explode(' ', microtime());
526 $endtime = $endtime[0] + $endtime[1];
528 $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">';
530 if ($this->query_result)
532 if (preg_match('/^(UPDATE|DELETE|REPLACE)/', $query))
534 $sql_report .= "Affected rows: <b>" . $this->sql_affectedrows($this->query_result) . '</b> | ';
536 $sql_report .= 'Before: ' . sprintf('%.5f', $curtime - $starttime) . 's | After: ' . sprintf('%.5f', $endtime - $starttime) . 's | Elapsed: <b>' . sprintf('%.5f', $endtime - $curtime) . 's</b>';
540 $error = $this->sql_error();
541 $sql_report .= '<b style="color: red">FAILED</b> - MySQL Error ' . $error['code'] . ': ' . htmlspecialchars($error['message']);
544 $sql_report .= '</p>';
546 $this->sql_time += $endtime - $curtime;