mirror of
https://github.com/phpbb/phpbb.git
synced 2025-02-23 11:28:33 +01:00
513 lines
12 KiB
PHP
513 lines
12 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* @package dbal
|
|
* @version $Id$
|
|
* @copyright (c) 2005 phpBB Group
|
|
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @package dbal
|
|
* Database Abstraction Layer
|
|
*/
|
|
class dbal
|
|
{
|
|
var $db_connect_id;
|
|
var $query_result;
|
|
var $return_on_error = false;
|
|
var $transaction = false;
|
|
var $sql_time = 0;
|
|
var $num_queries = 0;
|
|
var $open_queries = array();
|
|
|
|
var $curtime = 0;
|
|
var $query_hold = '';
|
|
var $html_hold = '';
|
|
var $sql_report = '';
|
|
var $cache_num_queries = 0;
|
|
|
|
var $persistency = false;
|
|
var $user = '';
|
|
var $server = '';
|
|
var $dbname = '';
|
|
|
|
/**
|
|
* return on error or display error message
|
|
*/
|
|
function sql_return_on_error($fail = false)
|
|
{
|
|
$this->return_on_error = $fail;
|
|
}
|
|
|
|
/**
|
|
* Return number of sql queries used (cached and real queries are counted the same)
|
|
*/
|
|
function sql_num_queries()
|
|
{
|
|
return $this->num_queries;
|
|
}
|
|
|
|
/**
|
|
* DBAL garbage collection, close sql connection
|
|
*/
|
|
function sql_close()
|
|
{
|
|
if (!$this->db_connect_id)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if ($this->transaction)
|
|
{
|
|
$this->sql_transaction('commit');
|
|
}
|
|
|
|
if (sizeof($this->open_queries))
|
|
{
|
|
foreach ($this->open_queries as $i_query_id => $query_id)
|
|
{
|
|
$this->sql_freeresult($query_id);
|
|
}
|
|
}
|
|
|
|
return $this->_sql_close();
|
|
}
|
|
|
|
/**
|
|
* Fetch all rows
|
|
*/
|
|
function sql_fetchrowset($query_id = false)
|
|
{
|
|
if (!$query_id)
|
|
{
|
|
$query_id = $this->query_result;
|
|
}
|
|
|
|
if ($query_id)
|
|
{
|
|
$result = array();
|
|
while ($row = $this->sql_fetchrow($query_id))
|
|
{
|
|
$result[] = $row;
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Build sql statement from array for insert/update/select statements
|
|
*
|
|
* Idea for this from Ikonboard
|
|
* Possible query values: INSERT, INSERT_SELECT, MULTI_INSERT, UPDATE, SELECT
|
|
*/
|
|
function sql_build_array($query, $assoc_ary = false)
|
|
{
|
|
if (!is_array($assoc_ary))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
$fields = array();
|
|
$values = array();
|
|
if ($query == 'INSERT' || $query == 'INSERT_SELECT')
|
|
{
|
|
foreach ($assoc_ary as $key => $var)
|
|
{
|
|
$fields[] = $key;
|
|
|
|
if (is_null($var))
|
|
{
|
|
$values[] = 'NULL';
|
|
}
|
|
else if (is_string($var))
|
|
{
|
|
$values[] = "'" . $this->sql_escape($var) . "'";
|
|
}
|
|
else if (is_array($var) && is_string($var[0]))
|
|
{
|
|
// This is used for INSERT_SELECT(s)
|
|
$values[] = $var[0];
|
|
}
|
|
else
|
|
{
|
|
$values[] = (is_bool($var)) ? intval($var) : $var;
|
|
}
|
|
}
|
|
|
|
$query = ($query == 'INSERT') ? ' (' . implode(', ', $fields) . ') VALUES (' . implode(', ', $values) . ')' : ' (' . implode(', ', $fields) . ') SELECT ' . implode(', ', $values) . ' ';
|
|
}
|
|
else if ($query == 'MULTI_INSERT')
|
|
{
|
|
$ary = array();
|
|
foreach ($assoc_ary as $id => $sql_ary)
|
|
{
|
|
$values = array();
|
|
foreach ($sql_ary as $key => $var)
|
|
{
|
|
if (is_null($var))
|
|
{
|
|
$values[] = 'NULL';
|
|
}
|
|
else if (is_string($var))
|
|
{
|
|
$values[] = "'" . $this->sql_escape($var) . "'";
|
|
}
|
|
else
|
|
{
|
|
$values[] = (is_bool($var)) ? intval($var) : $var;
|
|
}
|
|
}
|
|
$ary[] = '(' . implode(', ', $values) . ')';
|
|
}
|
|
|
|
$query = ' (' . implode(', ', array_keys($assoc_ary[0])) . ') VALUES ' . implode(', ', $ary);
|
|
}
|
|
else if ($query == 'UPDATE' || $query == 'SELECT')
|
|
{
|
|
$values = array();
|
|
foreach ($assoc_ary as $key => $var)
|
|
{
|
|
if (is_null($var))
|
|
{
|
|
$values[] = "$key = NULL";
|
|
}
|
|
else if (is_string($var))
|
|
{
|
|
$values[] = "$key = '" . $this->sql_escape($var) . "'";
|
|
}
|
|
else
|
|
{
|
|
$values[] = (is_bool($var)) ? "$key = " . intval($var) : "$key = $var";
|
|
}
|
|
}
|
|
$query = implode(($query == 'UPDATE') ? ', ' : ' AND ', $values);
|
|
}
|
|
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* Build sql statement from array for select and select distinct statements
|
|
*
|
|
* Possible query values: SELECT, SELECT_DISTINCT
|
|
*/
|
|
function sql_build_query($query, $array)
|
|
{
|
|
$sql = '';
|
|
switch ($query)
|
|
{
|
|
case 'SELECT':
|
|
case 'SELECT_DISTINCT';
|
|
|
|
if ($query == 'SELECT_DISTINCT')
|
|
{
|
|
$sql .= 'SELECT DISTINCT';
|
|
}
|
|
else
|
|
{
|
|
$sql .= 'SELECT';
|
|
}
|
|
|
|
$sql .= ' ' . $array['SELECT'];
|
|
$sql .= ' FROM ';
|
|
|
|
$table_array = array();
|
|
foreach ($array['FROM'] as $table_name => $alias)
|
|
{
|
|
$table_array[] = $table_name . ' ' . $alias;
|
|
}
|
|
|
|
$sql .= $this->_sql_custom_build('FROM', implode(', ', $table_array));
|
|
|
|
if (!empty($array['LEFT_JOIN']))
|
|
{
|
|
foreach ($array['LEFT_JOIN'] as $join)
|
|
{
|
|
$sql .= ' LEFT JOIN ' . key($join['FROM']) . ' ' . current($join['FROM']) . ' ON (' . $join['ON'] . ')';
|
|
}
|
|
}
|
|
|
|
if (!empty($array['WHERE']))
|
|
{
|
|
$sql .= ' WHERE ' . $this->_sql_custom_build('WHERE', $array['WHERE']);
|
|
}
|
|
|
|
if (!empty($array['GROUP_BY']))
|
|
{
|
|
$sql .= ' GROUP BY ' . $array['GROUP_BY'];
|
|
}
|
|
|
|
if (!empty($array['ORDER_BY']))
|
|
{
|
|
$sql .= ' ORDER BY ' . $array['ORDER_BY'];
|
|
}
|
|
|
|
break;
|
|
}
|
|
return $sql;
|
|
}
|
|
|
|
/**
|
|
* display sql error page
|
|
*/
|
|
function sql_error($sql = '')
|
|
{
|
|
global $auth, $user;
|
|
|
|
$error = $this->_sql_error();
|
|
|
|
if (!$this->return_on_error)
|
|
{
|
|
$message = '<u>SQL ERROR</u> [ ' . SQL_LAYER . ' ]<br /><br />' . $error['message'] . ' [' . $error['code'] . ']';
|
|
|
|
// Show complete SQL error and path to administrators only
|
|
// Additionally show complete error on installation or if extended debug mode is enabled
|
|
// The DEBUG_EXTRA constant is for development only!
|
|
if ($auth->acl_get('a_') || defined('IN_INSTALL') || defined('DEBUG_EXTRA'))
|
|
{
|
|
// Print out a nice backtrace...
|
|
$backtrace = get_backtrace();
|
|
|
|
$message .= ($sql) ? '<br /><br /><u>SQL</u><br /><br />' . $sql : '';
|
|
$message .= ($backtrace) ? '<br /><br /><u>BACKTRACE</u><br />' . $backtrace : '';
|
|
$message .= '<br />';
|
|
}
|
|
else
|
|
{
|
|
// If error occurs in initiating the session we need to use a pre-defined language string
|
|
// This could happen if the connection could not be established for example (then we are not able to grab the default language)
|
|
if (!isset($user->lang['SQL_ERROR_OCCURRED']))
|
|
{
|
|
$message .= '<br /><br />An sql error occurred while fetching this page. Please contact an administrator if this problem persist.';
|
|
}
|
|
else
|
|
{
|
|
$message .= '<br /><br />' . $user->lang['SQL_ERROR_OCCURRED'];
|
|
}
|
|
}
|
|
|
|
if ($this->transaction)
|
|
{
|
|
$this->sql_transaction('rollback');
|
|
}
|
|
|
|
if (strlen($message) > 1024)
|
|
{
|
|
// We need to define $msg_long_text here to circumvent text stripping.
|
|
global $msg_long_text;
|
|
$msg_long_text = $message;
|
|
|
|
trigger_error(false, E_USER_ERROR);
|
|
}
|
|
|
|
trigger_error($message, E_USER_ERROR);
|
|
}
|
|
|
|
return $error;
|
|
}
|
|
|
|
/**
|
|
* Explain queries
|
|
*/
|
|
function sql_report($mode, $query = '')
|
|
{
|
|
global $cache, $starttime, $phpbb_root_path, $user, $SID;
|
|
|
|
if (empty($_GET['explain']))
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (!$query && $this->query_hold != '')
|
|
{
|
|
$query = $this->query_hold;
|
|
}
|
|
|
|
switch ($mode)
|
|
{
|
|
case 'display':
|
|
if (!empty($cache))
|
|
{
|
|
$cache->unload();
|
|
}
|
|
$this->sql_close();
|
|
|
|
$mtime = explode(' ', microtime());
|
|
$totaltime = $mtime[0] + $mtime[1] - $starttime;
|
|
|
|
echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" dir="ltr">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<meta http-equiv="Content-Style-Type" content="text/css" />
|
|
<meta http-equiv="imagetoolbar" content="no" />
|
|
<title>SQL Report</title>
|
|
<link href="' . $phpbb_root_path . 'adm/style/admin.css" rel="stylesheet" type="text/css" media="screen" />
|
|
</head>
|
|
<body id="errorpage">
|
|
<div id="wrap">
|
|
<div id="page-header">
|
|
<a href="' . build_url('explain') . '">Return to previous page</a>
|
|
</div>
|
|
<div id="page-body">
|
|
<div class="panel">
|
|
<span class="corners-top"><span></span></span>
|
|
<div id="content">
|
|
<h1>SQL Report</h1>
|
|
<br />
|
|
<p><b>Page generated in ' . round($totaltime, 4) . " seconds with {$this->num_queries} queries" . (($this->cache_num_queries) ? " + {$this->cache_num_queries} " . (($this->cache_num_queries == 1) ? 'query' : 'queries') . ' returning data from cache' : '') . '</b></p>
|
|
|
|
<p>Time spent on ' . SQL_LAYER . ' queries: <b>' . round($this->sql_time, 5) . 's</b> | Time spent on PHP: <b>' . round($totaltime - $this->sql_time, 5) . 's</b></p>
|
|
|
|
<br /><br />
|
|
' . $this->sql_report . '
|
|
</div>
|
|
<span class="corners-bottom"><span></span></span>
|
|
</div>
|
|
</div>
|
|
<div id="page-footer">
|
|
Powered by phpBB © ' . date('Y') . ' <a href="http://www.phpbb.com/">phpBB Group</a>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>';
|
|
exit;
|
|
break;
|
|
|
|
case 'stop':
|
|
$endtime = explode(' ', microtime());
|
|
$endtime = $endtime[0] + $endtime[1];
|
|
|
|
$this->sql_report .= '
|
|
|
|
<table cellspacing="1">
|
|
<thead>
|
|
<tr>
|
|
<th>Query #' . $this->num_queries . '</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="row3"><textarea style="font-family:\'Courier New\',monospace;width:99%" rows="5" cols="10">' . 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>
|
|
|
|
' . $this->html_hold . '
|
|
|
|
<p style="text-align: center;">
|
|
';
|
|
|
|
if ($this->query_result)
|
|
{
|
|
if (preg_match('/^(UPDATE|DELETE|REPLACE)/', $query))
|
|
{
|
|
$this->sql_report .= 'Affected rows: <b>' . $this->sql_affectedrows($this->query_result) . '</b> | ';
|
|
}
|
|
$this->sql_report .= 'Before: ' . sprintf('%.5f', $this->curtime - $starttime) . 's | After: ' . sprintf('%.5f', $endtime - $starttime) . 's | Elapsed: <b>' . sprintf('%.5f', $endtime - $this->curtime) . 's</b>';
|
|
}
|
|
else
|
|
{
|
|
$error = $this->sql_error();
|
|
$this->sql_report .= '<b style="color: red">FAILED</b> - ' . SQL_LAYER . ' Error ' . $error['code'] . ': ' . htmlspecialchars($error['message']);
|
|
}
|
|
|
|
$this->sql_report .= '</p><br /><br />';
|
|
|
|
$this->sql_time += $endtime - $this->curtime;
|
|
break;
|
|
|
|
case 'start':
|
|
$this->query_hold = $query;
|
|
$this->html_hold = '';
|
|
|
|
$this->_sql_report($mode, $query);
|
|
|
|
$this->curtime = explode(' ', microtime());
|
|
$this->curtime = $this->curtime[0] + $this->curtime[1];
|
|
|
|
break;
|
|
|
|
case 'add_select_row':
|
|
|
|
$html_table = func_get_arg(2);
|
|
$row = func_get_arg(3);
|
|
|
|
if (!$html_table && sizeof($row))
|
|
{
|
|
$html_table = true;
|
|
$this->html_hold .= '<table cellspacing="1"><tr>';
|
|
|
|
foreach (array_keys($row) as $val)
|
|
{
|
|
$this->html_hold .= '<th>' . (($val) ? ucwords(str_replace('_', ' ', $val)) : ' ') . '</th>';
|
|
}
|
|
$this->html_hold .= '</tr>';
|
|
}
|
|
$this->html_hold .= '<tr>';
|
|
|
|
$class = 'row1';
|
|
foreach (array_values($row) as $val)
|
|
{
|
|
$class = ($class == 'row1') ? 'row2' : 'row1';
|
|
$this->html_hold .= '<td class="' . $class . '">' . (($val) ? $val : ' ') . '</td>';
|
|
}
|
|
$this->html_hold .= '</tr>';
|
|
|
|
return $html_table;
|
|
|
|
break;
|
|
|
|
case 'fromcache':
|
|
|
|
$this->_sql_report($mode, $query);
|
|
|
|
$this->cache_num_queries++;
|
|
|
|
break;
|
|
|
|
case 'record_fromcache':
|
|
|
|
$endtime = func_get_arg(2);
|
|
$splittime = func_get_arg(3);
|
|
|
|
$time_cache = $endtime - $this->curtime;
|
|
$time_db = $splittime - $endtime;
|
|
$color = ($time_db > $time_cache) ? 'green' : 'red';
|
|
|
|
$this->sql_report .= '<table cellspacing="1"><thead><tr><th>Query results obtained from the cache</th></tr></thead><tbody><tr>';
|
|
$this->sql_report .= '<td class="row3"><textarea style="font-family:\'Courier New\',monospace;width:99%" rows="5" cols="10">' . preg_replace('/\t(AND|OR)(\W)/', "\$1\$2", htmlspecialchars(preg_replace('/[\s]*[\n\r\t]+[\n\r\s\t]*/', "\n", $query))) . '</textarea></td></tr></tbody></table>';
|
|
$this->sql_report .= '<p style="text-align: center;">';
|
|
$this->sql_report .= 'Before: ' . sprintf('%.5f', $this->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><br /><br />';
|
|
|
|
// Pad the start time to not interfere with page timing
|
|
$starttime += $time_db;
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
$this->_sql_report($mode, $query);
|
|
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
*/
|
|
if (!defined('IN_PHPBB'))
|
|
{
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* This variable holds the class name to use later
|
|
*/
|
|
$sql_db = 'dbal_' . $dbms;
|
|
|
|
?>
|