blob: 0418696414951464b56f4ce89927d9969268b666 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreev7ac33d72012-01-07 19:39:39 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev7ac33d72012-01-07 19:39:39 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
darwinel871754a2014-02-11 17:34:57 +010021 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000028
Derek Allard2067d1a2008-11-13 22:59:24 +000029/**
30 * Exceptions Class
31 *
32 * @package CodeIgniter
33 * @subpackage Libraries
34 * @category Exceptions
Derek Jonesf4a4bd82011-10-20 12:18:42 -050035 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @link http://codeigniter.com/user_guide/libraries/exceptions.html
37 */
38class CI_Exceptions {
Andrey Andreev7ac33d72012-01-07 19:39:39 +020039
David Behler209b2cf2011-08-14 23:00:43 +020040 /**
41 * Nesting level of the output buffering mechanism
David Behler209b2cf2011-08-14 23:00:43 +020042 *
Timothy Warren48a7fbb2012-04-23 11:58:16 -040043 * @var int
David Behler209b2cf2011-08-14 23:00:43 +020044 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020045 public $ob_level;
Derek Allard2067d1a2008-11-13 22:59:24 +000046
David Behler209b2cf2011-08-14 23:00:43 +020047 /**
48 * List if available error levels
49 *
Timothy Warren48a7fbb2012-04-23 11:58:16 -040050 * @var array
David Behler209b2cf2011-08-14 23:00:43 +020051 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020052 public $levels = array(
Timothy Warren40403d22012-04-19 16:38:50 -040053 E_ERROR => 'Error',
54 E_WARNING => 'Warning',
55 E_PARSE => 'Parsing Error',
56 E_NOTICE => 'Notice',
57 E_CORE_ERROR => 'Core Error',
58 E_CORE_WARNING => 'Core Warning',
59 E_COMPILE_ERROR => 'Compile Error',
60 E_COMPILE_WARNING => 'Compile Warning',
61 E_USER_ERROR => 'User Error',
62 E_USER_WARNING => 'User Warning',
63 E_USER_NOTICE => 'User Notice',
64 E_STRICT => 'Runtime Notice'
65 );
Derek Allard2067d1a2008-11-13 22:59:24 +000066
Timothy Warrenad475052012-04-19 13:21:06 -040067 /**
Andrey Andreev3e9d2b82012-10-27 14:28:51 +030068 * Class constructor
Andrey Andreev92ebfb62012-05-17 12:49:24 +030069 *
70 * @return void
Timothy Warrenad475052012-04-19 13:21:06 -040071 */
Greg Akera9263282010-11-10 15:26:43 -060072 public function __construct()
Derek Allard2067d1a2008-11-13 22:59:24 +000073 {
74 $this->ob_level = ob_get_level();
Andrey Andreev7ac33d72012-01-07 19:39:39 +020075 // Note: Do not log messages from this constructor.
Derek Allard2067d1a2008-11-13 22:59:24 +000076 }
Barry Mienydd671972010-10-04 16:33:58 +020077
Derek Allard2067d1a2008-11-13 22:59:24 +000078 // --------------------------------------------------------------------
79
80 /**
81 * Exception Logger
82 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +030083 * Logs PHP generated error messages
Derek Allard2067d1a2008-11-13 22:59:24 +000084 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +030085 * @param int $severity Log level
86 * @param string $message Error message
87 * @param string $filepath File path
88 * @param int $line Line number
Andrey Andreev7ac33d72012-01-07 19:39:39 +020089 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +000090 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020091 public function log_exception($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +020092 {
Andrey Andreev92ebfb62012-05-17 12:49:24 +030093 $severity = isset($this->levels[$severity]) ? $this->levels[$severity] : $severity;
Andrey Andreev29947ee2013-11-12 18:36:46 +020094 log_message('error', 'Severity: '.$severity.' --> '.$message.' '.$filepath.' '.$line);
Derek Allard2067d1a2008-11-13 22:59:24 +000095 }
96
97 // --------------------------------------------------------------------
98
99 /**
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300100 * 404 Error Handler
Derek Allard2067d1a2008-11-13 22:59:24 +0000101 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300102 * @uses CI_Exceptions::show_error()
103 *
104 * @param string $page Page URI
105 * @param bool $log_error Whether to log the error
106 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +0000107 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200108 public function show_404($page = '', $log_error = TRUE)
Barry Mienydd671972010-10-04 16:33:58 +0200109 {
Andrey Andreev29947ee2013-11-12 18:36:46 +0200110 if (is_cli())
111 {
112 $heading = 'Not Found';
113 $message = 'The controller/method pair you requested was not found.';
114 }
115 else
116 {
117 $heading = '404 Page Not Found';
118 $message = 'The page you requested was not found.';
119 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000120
Derek Allard2ddc9492010-08-05 10:08:33 -0400121 // By default we log this, but allow a dev to skip it
122 if ($log_error)
123 {
Andrey Andreev29947ee2013-11-12 18:36:46 +0200124 log_message('error', $heading.': '.$page);
Derek Allard2ddc9492010-08-05 10:08:33 -0400125 }
126
Derek Jonesf6b442b2009-07-11 18:23:30 +0000127 echo $this->show_error($heading, $message, 'error_404', 404);
Andrey Andreev7cf682a2014-03-13 14:55:45 +0200128 exit(4); // EXIT_UNKNOWN_FILE
Derek Allard2067d1a2008-11-13 22:59:24 +0000129 }
Barry Mienydd671972010-10-04 16:33:58 +0200130
Derek Allard2067d1a2008-11-13 22:59:24 +0000131 // --------------------------------------------------------------------
132
133 /**
134 * General Error Page
135 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300136 * Takes an error message as input (either as a string or an array)
137 * and displays it using the specified template.
Derek Allard2067d1a2008-11-13 22:59:24 +0000138 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300139 * @param string $heading Page heading
140 * @param string|string[] $message Error message
141 * @param string $template Template name
Andrey Andreev5232ba02012-10-27 15:25:05 +0300142 * @param int $status_code (default: 500)
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300143 *
144 * @return string Error page output
Derek Allard2067d1a2008-11-13 22:59:24 +0000145 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200146 public function show_error($heading, $message, $template = 'error_general', $status_code = 500)
Derek Allard2067d1a2008-11-13 22:59:24 +0000147 {
Andrey Andreev29947ee2013-11-12 18:36:46 +0200148 if (is_cli())
149 {
150 $message = "\t".(is_array($message) ? implode("\n\t", $message) : $message);
151 $template = 'cli'.DIRECTORY_SEPARATOR.$template;
152 }
153 else
154 {
155 set_status_header($status_code);
156 $message = '<p>'.(is_array($message) ? implode('</p><p>', $message) : $message).'</p>';
157 $template = 'html'.DIRECTORY_SEPARATOR.$template;
158 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000159
160 if (ob_get_level() > $this->ob_level + 1)
161 {
Barry Mienydd671972010-10-04 16:33:58 +0200162 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000163 }
164 ob_start();
Andrey Andreev29947ee2013-11-12 18:36:46 +0200165 include(VIEWPATH.'errors'.DIRECTORY_SEPARATOR.$template.'.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 $buffer = ob_get_contents();
167 ob_end_clean();
168 return $buffer;
169 }
170
171 // --------------------------------------------------------------------
172
173 /**
174 * Native PHP error handler
175 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300176 * @param int $severity Error level
177 * @param string $message Error message
178 * @param string $filepath File path
179 * @param int $line Line number
180 * @return string Error page output
Derek Allard2067d1a2008-11-13 22:59:24 +0000181 */
Andrey Andreevc6a68e02012-03-26 14:30:10 +0300182 public function show_php_error($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +0200183 {
Andrey Andreev92ebfb62012-05-17 12:49:24 +0300184 $severity = isset($this->levels[$severity]) ? $this->levels[$severity] : $severity;
Barry Mienydd671972010-10-04 16:33:58 +0200185
Andrey Andreev29947ee2013-11-12 18:36:46 +0200186 // For safety reasons we don't show the full file path in non-CLI requests
187 if ( ! is_cli())
Derek Allard2067d1a2008-11-13 22:59:24 +0000188 {
Andrey Andreev29947ee2013-11-12 18:36:46 +0200189 $filepath = str_replace('\\', '/', $filepath);
190 if (FALSE !== strpos($filepath, '/'))
191 {
192 $x = explode('/', $filepath);
193 $filepath = $x[count($x)-2].'/'.end($x);
194 }
195
196 $template = 'html'.DIRECTORY_SEPARATOR.'error_php';
197 }
198 else
199 {
200 $template = 'cli'.DIRECTORY_SEPARATOR.'error_php';
Derek Allard2067d1a2008-11-13 22:59:24 +0000201 }
Barry Mienydd671972010-10-04 16:33:58 +0200202
Derek Allard2067d1a2008-11-13 22:59:24 +0000203 if (ob_get_level() > $this->ob_level + 1)
204 {
Barry Mienydd671972010-10-04 16:33:58 +0200205 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000206 }
207 ob_start();
Andrey Andreev29947ee2013-11-12 18:36:46 +0200208 include(VIEWPATH.'errors'.DIRECTORY_SEPARATOR.$template.'.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000209 $buffer = ob_get_contents();
210 ob_end_clean();
211 echo $buffer;
212 }
213
Derek Allard2067d1a2008-11-13 22:59:24 +0000214}
Derek Allard2067d1a2008-11-13 22:59:24 +0000215
216/* End of file Exceptions.php */
Andrey Andreevc6a68e02012-03-26 14:30:10 +0300217/* Location: ./system/core/Exceptions.php */