File: /var/www/vhosts/pgkdistribution.com.au/citisolar.com.au/mantis/bugtrack/core/error_api.php
<?php
# MantisBT - a php based bugtracking system
# MantisBT is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# MantisBT is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with MantisBT. If not, see <http://www.gnu.org/licenses/>.
/**
* @package CoreAPI
* @subpackage ErrorAPI
* @copyright Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*/
$g_error_parameters = array();
$g_error_handled = false;
$g_error_proceed_url = null;
$g_error_send_page_header = true;
set_error_handler( 'error_handler' );
/**
* Default error handler
*
* This handler will not receive E_ERROR, E_PARSE, E_CORE_*, or E_COMPILE_*
* errors.
*
* E_USER_* are triggered by us and will contain an error constant in $p_error
* The others, being system errors, will come with a string in $p_error
*
* @access private
* @param int p_type contains the level of the error raised, as an integer.
* @param string p_error contains the error message, as a string.
* @param string p_file contains the filename that the error was raised in, as a string.
* @param int p_line contains the line number the error was raised at, as an integer.
* @param array p_context to the active symbol table at the point the error occurred (optional)
* @uses lang_api.php
* @uses config_api.php
* @uses compress_api.php
* @uses database_api.php (optional)
* @uses html_api.php (optional)
*/
function error_handler( $p_type, $p_error, $p_file, $p_line, $p_context ) {
global $g_error_parameters, $g_error_handled, $g_error_proceed_url;
global $g_lang_overrides;
global $g_error_send_page_header;
# check if errors were disabled with @ somewhere in this call chain
if( 0 == error_reporting() ) {
return;
}
$t_lang_pushed = false;
$t_db_connected = false;
if( function_exists( 'db_is_connected' ) ) {
if( db_is_connected() ) {
$t_db_connected = true;
}
}
$t_html_api = false;
if( function_exists( 'html_end' ) ) {
$t_html_api = true;
}
# flush any language overrides to return to user's natural default
if( $t_db_connected ) {
lang_push( lang_get_default() );
$t_lang_pushed = true;
}
$t_short_file = basename( $p_file );
$t_method_array = config_get_global( 'display_errors' );
if( isset( $t_method_array[$p_type] ) ) {
$t_method = $t_method_array[$p_type];
} else {
if( isset( $t_method_array[E_ALL] ) ) {
$t_method = $t_method_array[E_ALL];
} else {
$t_method = 'none';
}
}
# build an appropriate error string
switch( $p_type ) {
case E_WARNING:
$t_error_type = 'SYSTEM WARNING';
$t_error_description = $p_error;
break;
case E_NOTICE:
$t_error_type = 'SYSTEM NOTICE';
$t_error_description = $p_error;
break;
case E_USER_ERROR:
$t_error_type = "APPLICATION ERROR #$p_error";
$t_error_description = error_string( $p_error );
break;
case E_USER_WARNING:
$t_error_type = "APPLICATION WARNING #$p_error";
$t_error_description = error_string( $p_error );
break;
case E_USER_NOTICE:
# used for debugging
$t_error_type = 'DEBUG';
$t_error_description = $p_error;
break;
default:
# shouldn't happen, just display the error just in case
$t_error_type = '';
$t_error_description = $p_error;
}
$t_error_description = nl2br( $t_error_description );
switch( $t_method ) {
case 'halt':
# disable any further event callbacks
if ( function_exists( 'event_clear_callbacks' ) ) {
event_clear_callbacks();
}
$t_oblen = ob_get_length();
if( error_handled() && $t_oblen > 0 ) {
$t_old_contents = ob_get_contents();
}
# We need to ensure compression is off - otherwise the compression headers are output.
compress_disable();
# then clean the buffer, leaving output buffering on.
if( $t_oblen > 0 ) {
ob_clean();
}
# don't send the page header information if it has already been sent
if( $g_error_send_page_header ) {
if( $t_html_api ) {
html_page_top1();
if( $p_error != ERROR_DB_QUERY_FAILED && $t_db_connected == true ) {
html_page_top2();
} else {
html_page_top2a();
}
} else {
echo '<html><head><title>', $t_error_type, '</title></head><body>';
}
}
echo '<br /><div align="center"><table class="width50" cellspacing="1">';
echo '<tr><td class="form-title">', $t_error_type, '</td></tr>';
echo '<tr><td><p class="center" style="color:red">', $t_error_description, '</p></td></tr>';
echo '<tr><td><p class="center">';
if( null === $g_error_proceed_url ) {
echo lang_get( 'error_no_proceed' );
} else {
echo '<a href="', $g_error_proceed_url, '">', lang_get( 'proceed' ), '</a>';
}
echo '</p></td></tr>';
if( ON == config_get_global( 'show_detailed_errors' ) ) {
echo '<tr><td>';
error_print_details( $p_file, $p_line, $p_context );
echo '</td></tr>';
echo '<tr><td>';
error_print_stack_trace();
echo '</td></tr>';
}
echo '</table></div>';
if( isset( $t_old_contents ) ) {
echo '<p>Previous non-fatal errors occurred. Page contents follow.</p>';
echo '<div style="border: solid 1px black;padding: 4px">';
echo $t_old_contents;
echo '</div>';
}
if( $t_html_api ) {
if( $p_error != ERROR_DB_QUERY_FAILED && $t_db_connected == true ) {
html_page_bottom();
} else {
html_body_end();
html_end();
}
} else {
echo '</body></html>', "\n";
}
exit();
case 'inline':
echo '<p style="color:red">', $t_error_type, ': ', $t_error_description, '</p>';
$g_error_handled = true;
break;
default:
# do nothing - note we treat this as we've not handled an error, so any redirects go through.
}
if( $t_lang_pushed ) {
lang_pop();
}
$g_error_parameters = array();
$g_error_proceed_url = null;
}
/**
* Print out the error details including context
* @param string $p_file
* @param int $p_line
* @param string $p_context
* @return null
*/
function error_print_details( $p_file, $p_line, $p_context ) {
?>
<center>
<table class="width75">
<tr>
<td>Full path: <?php echo htmlentities( $p_file, ENT_COMPAT, 'UTF-8' );?></td>
</tr>
<tr>
<td>Line: <?php echo $p_line?></td>
</tr>
<tr>
<td>
<?php error_print_context( $p_context )?>
</td>
</tr>
</table>
</center>
<?php
}
/**
* Print out the variable context given
* @param string $p_context
* @return null
*/
function error_print_context( $p_context ) {
if( !is_array( $p_context ) ) {
return;
}
echo '<table class="width100"><tr><th>Variable</th><th>Value</th><th>Type</th></tr>';
# print normal variables
foreach( $p_context as $t_var => $t_val ) {
if( !is_array( $t_val ) && !is_object( $t_val ) ) {
$t_type = gettype( $t_val );
$t_val = htmlentities( (string) $t_val, ENT_COMPAT, 'UTF-8' );
# Mask Passwords
if( strpos( $t_var, 'password' ) !== false ) {
$t_val = '**********';
}
echo '<tr><td>', $t_var, '</td><td>', $t_val, '</td><td>', $t_type, '</td></tr>', "\n";
}
}
# print arrays
foreach( $p_context as $t_var => $t_val ) {
if( is_array( $t_val ) && ( $t_var != 'GLOBALS' ) ) {
echo '<tr><td colspan="3" align="left"><br /><strong>', $t_var, '</strong></td></tr>';
echo '<tr><td colspan="3">';
error_print_context( $t_val );
echo '</td></tr>';
}
}
echo '</table>';
}
/**
* Print out a stack trace
* @return null
* @uses error_alternate_class
*/
function error_print_stack_trace() {
echo '<center><table class="width75">';
echo '<tr><th>Filename</th><th>Line</th><th></th><th></th><th>Function</th><th>Args</th></tr>';
$t_stack = debug_backtrace();
array_shift( $t_stack );
# remove the call to this function from the stack trace
array_shift( $t_stack );
# remove the call to the error handler from the stack trace
foreach( $t_stack as $t_frame ) {
echo '<tr ', error_alternate_class(), '>';
echo '<td>', ( isset( $t_frame['file'] ) ? htmlentities( $t_frame['file'], ENT_COMPAT, 'UTF-8' ) : '-' ), '</td><td>', ( isset( $t_frame['line'] ) ? $t_frame['line'] : '-' ), '</td><td>', ( isset( $t_frame['class'] ) ? $t_frame['class'] : '-' ), '</td><td>', ( isset( $t_frame['type'] ) ? $t_frame['type'] : '-' ), '</td><td>', ( isset( $t_frame['function'] ) ? $t_frame['function'] : '-' ), '</td>';
$t_args = array();
if( isset( $t_frame['args'] ) && !empty( $t_frame['args'] ) ) {
foreach( $t_frame['args'] as $t_value ) {
$t_args[] = error_build_parameter_string( $t_value );
}
echo '<td>( ', htmlentities( implode( $t_args, ', ' ), ENT_COMPAT, 'UTF-8' ), ' )</td></tr>';
} else {
echo '<td>-</td></tr>';
}
}
echo '</table></center>';
}
/**
* Build a string describing the parameters to a function
* @param string $p_param
* @param bool $p_showtype default true
* @param int $p_depth default 0
* @return string
*/
function error_build_parameter_string( $p_param, $p_showtype = true, $p_depth = 0 ) {
if( $p_depth++ > 10 ) {
return '<b>***Nesting Level Too Deep***</b>';
}
if( is_array( $p_param ) ) {
$t_results = array();
foreach( $p_param as $t_key => $t_value ) {
$t_results[] = '[' . error_build_parameter_string( $t_key, false, $p_depth ) . ']' . ' => ' . error_build_parameter_string( $t_value, false, $p_depth );
}
return '<Array> { ' . implode( $t_results, ', ' ) . ' }';
}
else if( is_object( $p_param ) ) {
$t_results = array();
$t_class_name = get_class( $p_param );
$t_inst_vars = get_object_vars( $p_param );
foreach( $t_inst_vars as $t_name => $t_value ) {
$t_results[] = "[$t_name]" . ' => ' . error_build_parameter_string( $t_value, false, $p_depth );
}
return '<Object><' . $t_class_name . '> ( ' . implode( $t_results, ', ' ) . ' )';
} else {
if( $p_showtype ) {
return '<' . gettype( $p_param ) . '>' . var_export( $p_param, true );
} else {
return var_export( $p_param, true );
}
}
}
/**
* Return an error string (in the current language) for the given error.
* @param int $p_error
* @return string
* @access public
*/
function error_string( $p_error ) {
global $g_error_parameters;
$MANTIS_ERROR = lang_get( 'MANTIS_ERROR' );
# We pad the parameter array to make sure that we don't get errors if
# the caller didn't give enough parameters for the error string
$t_padding = array_pad( array(), 10, '' );
$t_error = $MANTIS_ERROR[$p_error];
# ripped from string_api
$t_string = call_user_func_array( 'sprintf', array_merge( array( $t_error ), $g_error_parameters, $t_padding ) );
return preg_replace( "/&(#[0-9]+|[a-z]+);/i", "&$1;", @htmlspecialchars( $t_string, ENT_COMPAT, 'UTF-8' ) );
}
/**
* Check if we have handled an error during this page
* Return true if an error has been handled, false otherwise
* @return bool
*/
function error_handled() {
global $g_error_handled;
return( true == $g_error_handled );
}
/**
* Set additional info parameters to be used when displaying the next error
* This function takes a variable number of parameters
*
* When writing internationalized error strings, note that you can change the
* order of parameters in the string. See the PHP manual page for the
* sprintf() function for more details.
* @access public
* @return null
*/
function error_parameters() {
global $g_error_parameters;
$g_error_parameters = func_get_args();
}
/**
* Set a url to give to the user to proceed after viewing the error
* @access public
* @param string p_url url given to user after viewing the error
* @return null
*/
function error_proceed_url( $p_url ) {
global $g_error_proceed_url;
$g_error_proceed_url = $p_url;
}
/**
* Simple version of helper_alternate_class for use by error api only.
* @access private
* @return string representing css class
*/
function error_alternate_class() {
static $t_errindex = 1;
if( 1 == $t_errindex++ % 2 ) {
return 'class="row-1"';
} else {
return 'class="row-2"';
}
}