source: branches/version-2_13-dev/data/class/helper/SC_Helper_HandleError.php @ 23124

Revision 23124, 8.6 KB checked in by kimoto, 9 years ago (diff)

#2043 typo修正・ソース整形・ソースコメントの改善 for 2.13.0
PHP4的な書き方の修正

  • 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-2013 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 * 依存するクラスに構文エラーがあると、捕捉できない。よって、依存は最小に留めること。
28 * 現状 GC_Utils_Ex(GC_Utils) に依存しているため、その中で構文エラーは捕捉できない。
29 * @package Helper
30 * @version $Id$
31 */
32class SC_Helper_HandleError
33{
34    /**
35     * 処理の読み込みを行う
36     *
37     * @return void
38     */
39    public static function load()
40    {
41        // E_DEPRECATED 定数 (for PHP < 5.3)
42        // TODO バージョン互換処理に統合したい。
43        if (!defined('E_DEPRECATED')) {
44            define('E_DEPRECATED', 8192);
45        }
46
47        // エラーレベル設定 (PHPのログに対する指定であり、以降のエラーハンドリングには影響しない模様)
48        // 開発時は -1 (全て) を推奨
49        error_reporting(E_ALL & ~E_NOTICE & ~E_USER_NOTICE & ~E_DEPRECATED & ~E_STRICT);
50
51        if (!(defined('SAFE') && SAFE === true) && !(defined('INSTALL_FUNCTION') && INSTALL_FUNCTION === true)) {
52            // E_USER_ERROR または警告を捕捉した場合のエラーハンドラ
53            set_error_handler(array(__CLASS__, 'handle_warning'), E_USER_ERROR | E_WARNING | E_USER_WARNING | E_CORE_WARNING | E_COMPILE_WARNING);
54
55            // 実質的に PHP 5.2 以降かで処理が分かれる
56            if (function_exists('error_get_last')) {
57                // E_USER_ERROR 以外のエラーを捕捉した場合の処理用
58                register_shutdown_function(array(__CLASS__, 'handle_error'));
59                // 以降の処理では画面へのエラー表示は行なわない
60                ini_set('display_errors' , 0);
61            } else {
62                // エラー捕捉用の出力バッファリング
63                ob_start(array(__CLASS__, '_fatal_error_handler'));
64                ini_set('display_errors' , 1);
65            }
66        }
67    }
68
69    /**
70     * 警告や E_USER_ERROR を捕捉した場合にエラー画面を表示させるエラーハンドラ関数.
71     *
72     * この関数は, set_error_handler() 関数に登録するための関数である.
73     * trigger_error にて E_USER_ERROR が生成されると, エラーログを出力した後,
74     * エラー画面を表示させる.
75     * E_WARNING, E_USER_WARNING が発生した場合、ログを記録して、true を返す。
76     * (エラー画面・エラー文言は表示させない。)
77     *
78     * @param  integer      $errno   エラーコード
79     * @param  string       $errstr  エラーメッセージ
80     * @param  string       $errfile エラーが発生したファイル名
81     * @param  integer      $errline エラーが発生した行番号
82     * @return void|boolean E_USER_ERROR が発生した場合は, エラーページへリダイレクト;
83     *                      E_WARNING, E_USER_WARNING が発生した場合、true を返す
84     */
85    public static function handle_warning($errno, $errstr, $errfile, $errline)
86    {
87        // error_reporting 設定に含まれていないエラーコードは処理しない
88        if (!(error_reporting() & $errno)) {
89            return;
90        }
91
92        $error_type_name = GC_Utils_Ex::getErrorTypeName($errno);
93
94        switch ($errno) {
95            case E_USER_ERROR:
96                $message = "Fatal error($error_type_name): $errstr on [$errfile($errline)]";
97                GC_Utils_Ex::gfPrintLog($message, ERROR_LOG_REALFILE, true);
98
99                SC_Helper_HandleError_Ex::displaySystemError($message);
100                exit(1);
101                break;
102
103            case E_WARNING:
104            case E_USER_WARNING:
105            case E_CORE_WARNING:
106            case E_COMPILE_WARNING:
107                $message = "Warning($error_type_name): $errstr on [$errfile($errline)]";
108                GC_Utils_Ex::gfPrintLog($message, ERROR_LOG_REALFILE);
109
110                return true;
111
112            default:
113                break;
114        }
115    }
116
117    /**
118     * エラーを捕捉するための関数. (for PHP < 5.2.0)
119     *
120     * PHP4 では, try/catch が使用できず, かつ set_error_handler で Fatal Error は
121     * 捕捉できないため, ob_start にこの関数を定義し, Fatal Error が発生した場合
122     * に出力される HTML 出力を捕捉する.
123     * この関数が実行され, エラーが捕捉されると, DEBUG_MODE が無効な場合,
124     * エラーページへリダイレクトする.
125     *
126     * @param  string      $buffer 出力バッファリングの内容
127     * @return string|void エラーが捕捉された場合は, エラーページへリダイレクトする;
128     *                     エラーが捕捉されない場合は, 出力バッファリングの内容を返す
129     */
130    static function &_fatal_error_handler(&$buffer)
131    {
132        if (preg_match('/<b>(Fatal error)<\/b>: +(.+) in <b>(.+)<\/b> on line <b>(\d+)<\/b><br \/>/i', $buffer, $matches)) {
133            $message = "$matches[1]: $matches[2] on [$matches[3]($matches[4])]";
134            GC_Utils_Ex::gfPrintLog($message, ERROR_LOG_REALFILE, true);
135            if (DEBUG_MODE !== true) {
136                $url = HTTP_URL . 'error.php';
137                if (defined('ADMIN_FUNCTION') && ADMIN_FUNCTION === true) {
138                    $url .= '?admin';
139                }
140                header("Location: $url");
141                exit;
142            }
143        }
144
145        return $buffer;
146    }
147
148    /**
149     * エラー捕捉時のエラーハンドラ関数 (for PHP >= 5.2.0)
150     *
151     * この関数は, register_shutdown_function() 関数に登録するための関数である。
152     * PHP 5.1 対応処理との互換運用ため E_USER_ERROR は handle_warning で捕捉する。
153     *
154     * @return void
155     */
156    public static function handle_error()
157    {
158        // 最後のエラーを確実に捉えるため、先頭で呼び出す。
159        $arrError = error_get_last();
160
161        $is_error = false;
162        if (isset($arrError)) {
163            switch ($arrError['type']) {
164                case E_ERROR:
165                case E_PARSE:
166                case E_CORE_ERROR:
167                case E_COMPILE_ERROR:
168                    $is_error = true;
169                    break;
170                default:
171                    break;
172            }
173        }
174
175        if (!$is_error) {
176            return;
177        }
178
179        $error_type_name = GC_Utils_Ex::getErrorTypeName($arrError['type']);
180        $errstr = "Fatal error($error_type_name): {$arrError[message]} on [{$arrError[file]}({$arrError[line]})]";
181
182        GC_Utils_Ex::gfPrintLog($errstr, ERROR_LOG_REALFILE, true);
183
184        // エラー画面を表示する
185        SC_Helper_HandleError_Ex::displaySystemError($errstr);
186    }
187
188    /**
189     * エラー画面を表示する
190     *
191     * @param  string|null $errstr エラーメッセージ
192     * @return void
193     */
194    public static function displaySystemError($errstr = null)
195    {
196        ob_clean();
197
198        // 絵文字変換・除去フィルターが有効か評価する。
199        $loaded_ob_emoji = false;
200        $arrObs = ob_get_status(true);
201        foreach ($arrObs as $arrOb) {
202            if ($arrOb['name'] === 'SC_MobileEmoji::handler') {
203                $loaded_ob_emoji = true;
204                break;
205            }
206        }
207
208        // 絵文字変換・除去フィルターが無効で、利用できる場合、有効にする。
209        if (!$loaded_ob_emoji && class_exists('SC_MobileEmoji')) {
210            ob_start(array('SC_MobileEmoji', 'handler'));
211        }
212
213        require_once CLASS_EX_REALDIR . 'page_extends/error/LC_Page_Error_SystemError_Ex.php';
214        $objPage = new LC_Page_Error_SystemError_Ex();
215        $objPage->init();
216        if (isset($errstr)) {
217            $objPage->addDebugMsg($errstr);
218        }
219        $objPage->process();
220    }
221}
Note: See TracBrowser for help on using the repository browser.