<?php
/**
 * Inter组件FOR PHP4 - 错误处理
 * 由于PHP4在错误处理上的特殊原因，本组件For PHP4有如下特点：
 *     - 全部换为Inter_Error_PHP4函数组合
 *     - 不能处理类Exception（因为PHP4没这概念）
 *     
 * PHP5及以上的的请使用Inter_Error类。
 * 
 * 本组件依赖性：可独立使用。
 * 本文件的错误处理思路参考过以下程序，在此一并致谢！
 *     - 论坛程序Mybb{@link http://www.mybbchina.net/}
 *     - PHP框架Slightphp{@link http://phpchina.com/bbs/thread-150396-1-1.html}
 *     - PHP框架DooPHP{@link http://doophp.com/blog/article/diagnostic-debug-view-in-doophp}
 *
 * @author Horse Luke<hide@address.com>
 * @copyright Horse Luke, 2010
 * @license the Apache License, Version 2.0 (the "License"). {@link http://www.apache.org/licenses/LICENSE-2.0}
 * @version $Id: Inter_Error_PHP4.php 165 2011-02-26 09:19:28Z hide@address.com $
 * @package Inter_Component_PHP4
 */




/**
 * 设置或者获取Inter_Error_PHP4函数组合的设置函数。
 * 静态变量$conf具体的设置值如下：
     * debugMode：
     * 是否开启debug模式？若为true，将在在浏览器显示详细信息。否则将不显示。
     * 参数选择：默认为false，可选参数true或者false。
     * 参数类型：bool
     * 
     * logType：
     * 对错误进行包括错误追踪在内的详细记录（detail）、还是只需要简单记录（simple）【均使用PHP函数error_log进行记录】？
     * false将不进行任何记录。
     * 参数选择：默认为false。可选择'detail'或者'simple'或者布尔值false。
     * 不建议在生产环境进行详细记录（detail），否则在高访问量的情况下，日志的条目将非常混乱！
     * 参数类型：bool|string
     * 
     * logDir：
     * 记录日志的文件夹（目录路径），结尾不要含有斜杠。
     * 参数选择： 默认为空。本参数只有当logType不为false时才有效；
     * 并且当为若为空、或者不是目录、或者目录不存在，则按照php.ini的设置进行错误记录处理。
     * 参数类型：string
     * 
     * suffix：
     * 记录日志的文件后缀。
     * 参数类型：string
     * 
     * variables：
     * 指定要检测和输出的变量名。
     * 参数类型：array
     * 
     * ignoreERROR：
     * 不要记录的错误类型。
     * 比如，不想记录E_NOTICE或者E_USER_NOTICE错误，则将此设置为array(E_NOTICE, E_USER_NOTICE)
     * 可传入的常量，请自行查找：PHP手册 -> 影响PHP行为的扩展 -> Error Handling -> 预定义常量。{@link http://docs.php.net/manual/zh/errorfunc.constants.php}
     * 参数类型：array
     * 
 * 
 * @param array|string $name 设置名称。如果传入数组，则表示批量设置（将该数组合并到原有设置里面去）
 * @param mixed $value 设置值。若为空，则表示返回指定的$name的设置值。
 * @return mixed
 */
function Inter_Error_PHP4_config( $name, $value = null ){
    static $conf = array(
                          'debugMode' => false,
                          'logType' => false,
                          'logDir' => '',
                          'suffix' => '-Inter-ErrorLog.log',
                          'variables' => array("_GET", "_POST", "_SESSION", "_COOKIE"),
                          'ignoreERROR' => array(),
                         );

    
    if( is_array($name) ){
        $conf = array_merge($conf, $name);
        return true;
    }elseif( is_string($name) ){
        if( null !== $value ){
            $conf[$name] = $value;
            return true;
        }else{
            return isset( $conf[$name] ) ? $conf[$name] : null;
        }
    }else{
        return null;
    }

}

/**
 * 初始化Inter_Error_PHP4函数组合
 * @return bool
 */
function Inter_Error_PHP4_init(){
    static $_registered = false;
    if (false == $_registered) {
        register_shutdown_function ( 'Inter_Error_PHP4_write_errorlog' );
        register_shutdown_function ( 'Inter_Error_PHP4_error_display'  );
        $_registered = true;
    }
    return true;
}

/**
 * 获取request_uri
 * @return string
 */
function Inter_Error_PHP4__get_request_uri(){
    static $uri = null;
    if(null !== $uri){
        return $uri;
    }
    if(isset($_SERVER['REQUEST_URI'])){
        $uri = $_SERVER['REQUEST_URI'];
    }elseif(isset($_SERVER['PHP_SELF'])){
        if(isset($_SERVER['argv'][0])){
            $uri = $_SERVER['PHP_SELF']. '?'. $_SERVER['argv'][0];
        }elseif(isset($_SERVER['QUERY_STRING'])){
            $uri = $_SERVER['PHP_SELF']. '?'. $_SERVER['QUERY_STRING'];
        }else{
            $uri = $_SERVER['PHP_SELF'];
        }
    }else{
        $uri = '_UNKNOWN_URI_';
    }
    
    return $uri;
}

/**
 * 处理PHP发现的错误
 * 
 * @param integer $errno 错误代号
 * @param string $errstr 错误信息
 * @param string $errfile 错误所在文件
 * @param string $errline 错误所在行
 */
function Inter_Error_PHP4_error_handler($errno, $errstr, $errfile, $errline){
    
    
    //echo $errno. $errstr. $errfile. $errline.'<br />';

    //对error类型进行直观化处理~
    static $errorText = array("1"=>"E_ERROR",
                            "2"=>"E_WARNING",
                            "4"=>"E_PARSE",
                            "8"=>"E_NOTICE",
                            "16"=>"E_CORE_ERROR",
                            "32"=>"E_CORE_WARNING",
                            "64"=>"E_COMPILE_ERROR",
                            "128"=>"E_COMPILE_WARNING",
                            "256"=>"E_USER_ERROR",
                            "512"=>"E_USER_WARNING",
                            "1024"=>"E_USER_NOTICE",
                            "2047"=>"E_ALL",
                            "2048"=>"E_STRICT"
                          );

    Inter_Error_PHP4_init();
    $ignoreError = Inter_Error_PHP4_config('ignoreERROR');
    if (empty ( $ignoreError ) || ! in_array ( $errno, $ignoreError )) {
        
        $errorInfo = array ();
        $errorInfo ['time'] = time ();
        $errorInfo ['type'] = 'ERROR';
        
        if (! empty ( $errorText [$errno] )) {
            $errorInfo ['name'] = $errorText [$errno];
        } else {
            $errorInfo ['name'] = '__UNKNOWN';
        }
        
        $errorInfo ['code'] = $errno;
        $errorInfo ['message'] = $errstr;
        $errorInfo ['file'] = $errfile;
        $errorInfo ['line'] = $errline;
        $trace = debug_backtrace ();
        unset ( $trace [0] ); //调用该类自身的error_handler方法所产生的trace，故删除
        $errorInfo ['trace'] = Inter_Error_PHP4__format_trace ( $trace );
        Inter_Error_PHP4_log($errorInfo);
        
    }
    
    //需要手动对FATAL ERROR错误进行停止
    if( in_array($errno, array(1, 4, 16, 64, 256 )) ){
        die();
    }
    
}
    
/**
 * 记录错误信息，或者返回所有错误信息的存储数组
 * @param array $value 需要记录的错误，若不传入则表示返回全部已经记录的错误
 * @return mixed
 */    
function Inter_Error_PHP4_log( $value = null ){
    static $_allError = array();
    if( !is_array($value) ){
        return $_allError;
    }else{
        $_allError[] = $value;
        return true;
    }
}

/**
 * (私有)对错误回溯追踪信息进行格式化输出处理。
 *
 * @param array $trace 错误回溯追踪信息数组
 * @return array $trace 错误回溯追踪信息数组
 */
function Inter_Error_PHP4__format_trace($trace){
    $return = array ();
    //逐条追踪记录处理
    foreach ( $trace as $stack => $detail ) {
        if (! empty ( $detail ['args'] )) {
            $args_string = Inter_Error_PHP4__args_to_string ( $detail ['args'] );
        } else {
            $args_string = '';
        }
        
        //规范追踪记录（感慨PHP太过自由，连trace记录也是不尽相同-_-||）
        $return [$stack] ['class'] = isset ( $trace [$stack] ['class'] ) ? $trace [$stack] ['class'] : '';
        $return [$stack] ['type'] = isset ( $trace [$stack] ['type'] ) ? $trace [$stack] ['type'] : '';
        //只有存在function的时候，才可能存在args，故以此合并之
        $return [$stack] ['function'] = isset ( $trace [$stack] ['function'] ) ? $trace [$stack] ['function'] . '(' . $args_string . ')' : '';
        $return [$stack] ['file'] = isset ( $trace [$stack] ['file'] ) ? $trace [$stack] ['file'] : '';
        $return [$stack] ['line'] = isset ( $trace [$stack] ['line'] ) ? $trace [$stack] ['line'] : '';
    }
    return $return;
}


/**
 * (私有)将参数转变为可读的字符串
 * 力求做到$e->getTraceAsString()的效果
 *
 * @param array $args
 * @return string
*/
function Inter_Error_PHP4__args_to_string($args){
    $string = '';
    $argsAll = array ();
    foreach ( $args as $key => $value ) {
        if (true == is_object ( $value )) {
            $argsAll [$key] = 'Object(' . get_class ( $value ) . ')';
        } elseif (true == is_numeric ( $value )) {
            $argsAll [$key] = $value;
        } elseif (true == is_string ( $value )) {
            $temp = $value;
            if (! extension_loaded ( 'mbstring' )) {
                if (strlen ( $temp ) > 300) {
                    $temp = substr ( $temp, 0, 300 ) . '...';
                }
            } else {
                if (mb_strlen ( $temp ) > 300) {
                    $temp = mb_substr ( $temp, 0, 300 ) . '...';
                }
            }
            $argsAll [$key] = "'{$temp}'";
            $temp = null;
        } elseif (true == is_bool ( $value )) {
            if (true == $value) {
                $argsAll [$key] = 'true';
            } else {
                $argsAll [$key] = 'false';
            }
        } else {
            $argsAll [$key] = gettype ( $value );
        }
    }
    $string = implode ( ',', $argsAll );
    return $string;
}



function Inter_Error_PHP4_write_errorlog(){
    $conf_logType = Inter_Error_PHP4_config('logType');
    if ( false == $conf_logType ){
        return null;
    }
    $allError = Inter_Error_PHP4_log();
    if( empty($allError) ){
        return null;
    }
    
    $logText = '';
    foreach ( $allError as $key => $errorInfo ) {
        $logText .= date ( "Y-m-d H:i:s", $errorInfo ['time'] ) . "\t" . Inter_Error_PHP4__get_request_uri() . "\t" . $errorInfo ['type'] . "\t" . $errorInfo ['name'] . "\t" . 'Code ' . $errorInfo ['code'] . "\t" . $errorInfo ['message'] . "\t" . $errorInfo ['file'] . "\t" . 'Line ' . $errorInfo ['line'] . "\n";
        
        if ('detail' == $conf_logType && ! empty ( $errorInfo ['trace'] )) {
            $prefix = "TRACE\t#";
            foreach ( $errorInfo ['trace'] as $stack => $trace ) {
                $logText .= $prefix . $stack . "\t" . $trace ['file'] . "\t" . $trace ['line'] . "\t" . $trace ['class'] . $trace ['type'] . $trace ['function'] . "\n";
            }
        }
    
    }
    
    $conf_logDir = Inter_Error_PHP4_config('logDir');
    if (empty ( $conf_logDir ) || false == is_dir ( $conf_logDir )) {
        error_log ( $logText );
    } else {
        $logFilename = date ( "Y-m-d", time () ) . Inter_Error_PHP4_config('suffix');
        error_log ( $logText, 3, $conf_logDir . DIRECTORY_SEPARATOR . $logFilename );
    }

    
}
    
function Inter_Error_PHP4_error_display(){
    $conf_debugMode = Inter_Error_PHP4_config('debugMode');
    if ( false == $conf_debugMode ){
        return null;
    }
    $allError = Inter_Error_PHP4_log();
    if( !empty($allError) ){
            $htmlText = '';
            foreach ($allError as $key => $errorInfo){


                //错误div头
                $htmlText .= '<div class="intererrorblock">
                                <div class="intererrortitle">['.$errorInfo['name'].'][Code '.$errorInfo['code'].'] '.$errorInfo['message'].'</div>
                                <div class="intererrorsubtitle">Line '.$errorInfo['line'].' On <a href="'.$errorInfo['file'].'">'.$errorInfo['file'].'</a></div>
                                <div class="intererrorcontent">
                            ';

                //trace显示区
                if(empty($errorInfo['trace'])){
                    $htmlText .= 'No Traceable Information.';
                }else{
                    $htmlText .= '<table width="100%" border="1" cellpadding="1" cellspacing="1" rules="rows">
                                    <tr>
                                        <th scope="col">#</th>
                                        <th scope="col">File</th>
                                        <th scope="col">Line</th>
                                        <th scope="col">Class::Method(Args)</th>
                                    </tr>';
                    foreach ($errorInfo['trace'] as $stack => $trace){
                        $htmlText .= '<tr>
                                        <td>'.$stack.'</td>
                                        <td><a href="'.$trace['file'].'">'.$trace['file'].'</a></td>
                                        <td>'.$trace['line'].'</td>
                                        <td>'.$trace['class']. $trace['type']. htmlspecialchars($trace['function']) .'</td>
                                    </tr>';
                    }
                    $htmlText .= '</table>';
                }

                //错误div尾
                $htmlText .= '    </div>
                            </div>
                            ';
            }

            //输出
            echo <<<END
<style type="text/css">
<!--
.intererrorblock {
    font-size: 12pt;
    background-color: #FFC;
    text-align: left;
    vertical-align: middle;
    display: inline-block;
    border-collapse: collapse;
    word-break: break-all;
    padding: 3px;
    width: 100%;
}

.intererrorblock a:link {
    color: #00F;
    text-decoration: none;
}
.intererrorblock a:visited {
    text-decoration: none;
    color: #00F;
}
.intererrorblock a:hover {
    text-decoration: underline;
    color: #00F;
}
.intererrorblock a:active {
    text-decoration: none;
    color: #00F;
}

.intererrortitle {
    color: #FFF;
    background-color: #963;
    padding: 3px;
    font-weight: bold;
}

.intererrorsubtitle {
    padding: 3px;
    font-weight: bold;
    color: #F00;
}

.intererrorcontent {
    font-size: 11pt;
    color: #000;
    background-color: #FFF;
    padding: 3px;
}

.intererrorcontent table{
    font-size:14px;
    word-break: break-all;
    background-color:#D4D0C8;
    border-color:#000000;
}

.intererrorblock table a:link {
    color: #00F;
    text-decoration: none;
}
.intererrorblock table a:visited {
    text-decoration: none;
    color: #00F;
}
.intererrorblock table a:hover {
    text-decoration: underline;
    color: #00F;
}
.intererrorblock table a:active {
    text-decoration: none;
    color: #00F;
}

-->
</style>
{$htmlText}
END;


        Inter_Error_PHP4_show_variables();
    }
}
    
/**
 * 指定变量名检测和显示
 */
function Inter_Error_PHP4_show_variables(){
        $variables_link = '';
        $variables_content = '';
        $conf_variables = Inter_Error_PHP4_config('variables');
        foreach( $conf_variables as $key ){
            $variables_link .= '<a href="#variables'.$key.'">$'.$key.'</a>&nbsp;';
            $variables_content .= '<div class="variablessubtitle"><a name="variables'.$key.'" id="variables'.$key.'"></a><strong>$'.$key.'</strong></div>
                          <div class="variablescontent">';
            if(!isset($GLOBALS[$key])){
                $variables_content .= '$'. $key .' IS NOT SET.';
            }else{
                $variables_content .= nl2br(htmlspecialchars(var_export($GLOBALS[$key], true)));
            }
             $variables_content .= '</div>';
        }
        
            //输出
            echo <<<END
<style type="text/css">
<!--
.variablesblock {
    font-size: 12pt;
    background-color: #CCC;
    text-align: left;
    vertical-align: middle;
    display: inline-block;
    border-collapse: collapse;
    word-break: break-all;
    padding: 3px;
    width: 100%;
    color: #000;
}

.variablesblock a:link {
    color: #000;
    text-decoration: none;
}
.variablesblock a:visited {
    text-decoration: none;
    color: #000;
}
.variablesblock a:hover {
    text-decoration: underline;
    color: #000;
}
.variablesblock a:active {
    text-decoration: none;
    color: #000;
}

.variablessubtitle {
    padding: 3px;
    font-weight: bold;
    border: 1px solid #FFF;
}

.variablescontent {
    font-size: 11pt;
    color: #000;
    background-color: #FFF;
    padding: 3px;
}
-->
</style>
<div class="variablesblock">
    <div class="variablessubtitle">Variables: {$variables_link}</div>
    {$variables_content}
</div>
END;

}