source: branches/version-2_12-dev/data/class/helper/SC_Helper_HandleError.php @ 21482

Revision 21482, 9.0 KB checked in by Seasoft, 9 years ago (diff)

#1589 (パフォーマンス改善 handle_error の無駄を省く)

  • r21465 でのエンバグを修正

#1635 (PHP 5.4 対応)

  • 定義済み定数の変更を考慮
  • Property svn:eol-style set to LF
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2011 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24/**
25 * エラーハンドリングのクラス
26 *
27 * @package Page
28 * @version $Id$
29 */
30class SC_Helper_HandleError {
31
32    /**
33     * 処理の読み込みを行う
34     *
35     * @return void
36     */
37    static function load() {
38        // E_DEPRECATED 定数 (for PHP < 5.3)
39        // TODO バージョン互換処理に統合したい。
40        if (!defined('E_DEPRECATED')) {
41            define('E_DEPRECATED', 8192);
42        }
43
44        // エラーレベル設定 (PHPのログに対する指定であり、以降のエラーハンドリングには影響しない模様)
45        // 開発時は -1 (全て) を推奨
46        error_reporting(E_ALL & ~E_NOTICE & ~E_USER_NOTICE & ~E_DEPRECATED & ~E_STRICT);
47
48        if (!defined('SAFE') || SAFE !== true || !defined('INSTALL_FUNCTION') || INSTALL_FUNCTION !== true) {
49
50            // E_USER_ERROR または警告を捕捉した場合のエラーハンドラ
51            set_error_handler(array(__CLASS__, 'handle_warning'), E_USER_ERROR | E_WARNING | E_USER_WARNING | E_CORE_WARNING | E_COMPILE_WARNING);
52
53            // 実質的に PHP 5.2 以降かで処理が分かれる
54            if (function_exists('error_get_last')) {
55                // E_USER_ERROR 以外のエラーを捕捉した場合の処理用
56                register_shutdown_function(array(__CLASS__, 'handle_error'));
57                // 以降の処理では画面へのエラー表示は行なわない
58                ini_set('display_errors' , 0);
59            } else {
60                // エラー捕捉用の出力バッファリング
61                ob_start(array(__CLASS__, '_fatal_error_handler'));
62                ini_set('display_errors' , 1);
63            }
64        }
65    }
66
67    /**
68     * 警告や E_USER_ERROR を捕捉した場合にエラー画面を表示させるエラーハンドラ関数.
69     *
70     * この関数は, set_error_handler() 関数に登録するための関数である.
71     * trigger_error にて E_USER_ERROR が生成されると, エラーログを出力した後,
72     * エラー画面を表示させる.
73     * E_WARNING, E_USER_WARNING が発生した場合、ログを記録して、true を返す。
74     * (エラー画面・エラー文言は表示させない。)
75     *
76     * @param integer $errno エラーコード
77     * @param string $errstr エラーメッセージ
78     * @param string $errfile エラーが発生したファイル名
79     * @param integer $errline エラーが発生した行番号
80     * @return void|boolean E_USER_ERROR が発生した場合は, エラーページへリダイレクト;
81     *                      E_WARNING, E_USER_WARNING が発生した場合、true を返す
82     */
83    static function handle_warning($errno, $errstr, $errfile, $errline) {
84        // error_reporting 設定に含まれていないエラーコードは処理しない
85        if (!(error_reporting() & $errno)) {
86            return;
87        }
88
89        $now = date("Y/m/d H:i:s");
90        // 本来 realpath() で正規化したいところだが、NULL を返すケースがあるため避けている (#1618)
91        $log_file_path = DATA_REALDIR . 'logs/site.log';
92        switch ($errno) {
93            case E_USER_ERROR:
94                $message = $now . " [$errfile:$errline] FATAL Error($errno) $errstr from ". $_SERVER['REMOTE_ADDR'] . "\n";
95                error_log($message, 3, $log_file_path);
96
97                self::displaySystemError($errstr);
98                exit(1);
99                break;
100
101            case E_WARNING:
102            case E_USER_WARNING:
103            case E_CORE_WARNING:
104            case E_COMPILE_WARNING:
105                $message = $now . " [$errfile:$errline] WARNING($errno) $errstr from ". $_SERVER['REMOTE_ADDR'] . "\n";
106                error_log($message, 3, $log_file_path);
107                return true;
108                break;
109
110            default:
111        }
112    }
113
114    /**
115     * エラーを捕捉するための関数. (for PHP < 5.2.0)
116     *
117     * PHP4 では, try/catch が使用できず, かつ set_error_handler で Fatal Error は
118     * 捕捉できないため, ob_start にこの関数を定義し, Fatal Error が発生した場合
119     * に出力される HTML 出力を捕捉する.
120     * この関数が実行され, エラーが捕捉されると, DEBUG_MODE が無効な場合,
121     * エラーページへリダイレクトする.
122     *
123     * @param string $buffer 出力バッファリングの内容
124     * @return string|void エラーが捕捉された場合は, エラーページへリダイレクトする;
125     *                     エラーが捕捉されない場合は, 出力バッファリングの内容を返す
126     */
127    static function &_fatal_error_handler(&$buffer) {
128        if (preg_match('/<b>(Fatal) error<\/b>: +(.+) in <b>(.+)<\/b> on line <b>(\d+)<\/b><br \/>/i', $buffer, $matches)) {
129            $now = date("Y/m/d H:i:s");
130            // 本来 realpath() で正規化したいところだが、NULL を返すケースがあるため避けている (#1618)
131            $log_file_path = DATA_REALDIR . 'logs/site.log';
132            $message = $now . " [$matches[3]:$matches[4]] FATAL Error: $matches[2] from ". $_SERVER['REMOTE_ADDR'] . "\n";
133            error_log($message, 3, $log_file_path);
134            if (DEBUG_MODE !== true) {
135                $url = HTTP_URL . "error.php";
136                if (defined('ADMIN_FUNCTION') && ADMIN_FUNCTION) {
137                    $url .= "?admin";
138                }
139                header("Location: $url");
140                exit;
141            }
142        }
143        return $buffer;
144    }
145
146    /**
147     * エラー捕捉時のエラーハンドラ関数 (for PHP >= 5.2.0)
148     *
149     * この関数は, register_shutdown_function() 関数に登録するための関数である。
150     * PHP 5.1 対応処理との互換運用ため E_USER_ERROR は handle_warning で捕捉する。
151     *
152     * @return void
153     */
154    static function handle_error() {
155        // 最後のエラーを確実に捉えるため、先頭で呼び出す。
156        $arrError = error_get_last();
157
158        $is_error = false;
159        if (isset($arrError)) {
160             switch ($arrError['type']) {
161                 case E_ERROR:
162                 case E_PARSE:
163                 case E_CORE_ERROR:
164                 case E_COMPILE_ERROR:
165                      $is_error = true;
166                 break;
167             }
168        }
169
170        if (!$is_error) {
171            return;
172        }
173
174        $errstr = "[{$arrError[file]}:{$arrError[line]}] FATAL Error({$arrError[type]}) {$arrError[message]}";
175
176        // ログの書き出し
177        $now = date("Y/m/d H:i:s");
178        // 本来 realpath() で正規化したいところだが、NULL を返すケースがあるため避けている (#1618)
179        $log_file_path = DATA_REALDIR . 'logs/site.log';
180        error_log($now . " $errstr from ". $_SERVER['REMOTE_ADDR'] . "\n", 3, $log_file_path);
181
182        // エラー画面を表示する
183        self::displaySystemError($errstr);
184    }
185
186    /**
187     * エラー画面を表示する
188     *
189     * @param string|null $errstr エラーメッセージ
190     * @return void
191     */
192    static function displaySystemError($errstr = null) {
193        ob_clean();
194
195        // 絵文字変換・除去フィルターが有効か評価する。
196        $loaded_ob_emoji = false;
197        $arrObs = ob_get_status(true);
198        foreach ($arrObs as $arrOb) {
199            if ($arrOb['name'] === 'SC_MobileEmoji::handler') {
200                $loaded_ob_emoji = true;
201                break;
202            }
203        }
204
205        // 絵文字変換・除去フィルターが無効で、利用できる場合、有効にする。
206        if (!$loaded_ob_emoji && class_exists('SC_MobileEmoji')) {
207            ob_start(array('SC_MobileEmoji', 'handler'));
208        }
209
210        require_once CLASS_EX_REALDIR . 'page_extends/error/LC_Page_Error_SystemError_Ex.php';
211        $objPage = new LC_Page_Error_SystemError_Ex();
212        register_shutdown_function(array($objPage, 'destroy'));
213        $objPage->init();
214        if (isset($errstr)) {
215            $objPage->arrDebugMsg[]
216                = "▼▼▼ エラーメッセージ ▼▼▼\n"
217                . $errstr . "\n"
218                . "▲▲▲ エラーメッセージ ▲▲▲\n"
219            ;
220        }
221        $objPage->process();
222    }
223}
Note: See TracBrowser for help on using the repository browser.