blob: 556257729be95bbbc67d06fdd6bb4397051e2f7e [file] [log] [blame]
Andrey Andreev7ac33d72012-01-07 19:39:39 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
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
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, 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 */
27
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * Exceptions Class
30 *
31 * @package CodeIgniter
32 * @subpackage Libraries
33 * @category Exceptions
Derek Jonesf4a4bd82011-10-20 12:18:42 -050034 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000035 * @link http://codeigniter.com/user_guide/libraries/exceptions.html
36 */
37class CI_Exceptions {
Andrey Andreev7ac33d72012-01-07 19:39:39 +020038
David Behler209b2cf2011-08-14 23:00:43 +020039 /**
40 * Nesting level of the output buffering mechanism
David Behler209b2cf2011-08-14 23:00:43 +020041 *
Timothy Warren48a7fbb2012-04-23 11:58:16 -040042 * @var int
David Behler209b2cf2011-08-14 23:00:43 +020043 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020044 public $ob_level;
Derek Allard2067d1a2008-11-13 22:59:24 +000045
David Behler209b2cf2011-08-14 23:00:43 +020046 /**
47 * List if available error levels
48 *
Timothy Warren48a7fbb2012-04-23 11:58:16 -040049 * @var array
David Behler209b2cf2011-08-14 23:00:43 +020050 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020051 public $levels = array(
Timothy Warren40403d22012-04-19 16:38:50 -040052 E_ERROR => 'Error',
53 E_WARNING => 'Warning',
54 E_PARSE => 'Parsing Error',
55 E_NOTICE => 'Notice',
56 E_CORE_ERROR => 'Core Error',
57 E_CORE_WARNING => 'Core Warning',
58 E_COMPILE_ERROR => 'Compile Error',
59 E_COMPILE_WARNING => 'Compile Warning',
60 E_USER_ERROR => 'User Error',
61 E_USER_WARNING => 'User Warning',
62 E_USER_NOTICE => 'User Notice',
63 E_STRICT => 'Runtime Notice'
64 );
Derek Allard2067d1a2008-11-13 22:59:24 +000065
Timothy Warrenad475052012-04-19 13:21:06 -040066 /**
Andrey Andreev3e9d2b82012-10-27 14:28:51 +030067 * Class constructor
Andrey Andreev92ebfb62012-05-17 12:49:24 +030068 *
69 * @return void
Timothy Warrenad475052012-04-19 13:21:06 -040070 */
Greg Akera9263282010-11-10 15:26:43 -060071 public function __construct()
Derek Allard2067d1a2008-11-13 22:59:24 +000072 {
73 $this->ob_level = ob_get_level();
Andrey Andreev7ac33d72012-01-07 19:39:39 +020074 // Note: Do not log messages from this constructor.
Derek Allard2067d1a2008-11-13 22:59:24 +000075 }
Barry Mienydd671972010-10-04 16:33:58 +020076
Derek Allard2067d1a2008-11-13 22:59:24 +000077 // --------------------------------------------------------------------
78
79 /**
80 * Exception Logger
81 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +030082 * Logs PHP generated error messages
Derek Allard2067d1a2008-11-13 22:59:24 +000083 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +030084 * @param int $severity Log level
85 * @param string $message Error message
86 * @param string $filepath File path
87 * @param int $line Line number
Andrey Andreev7ac33d72012-01-07 19:39:39 +020088 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +000089 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020090 public function log_exception($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +020091 {
Andrey Andreev92ebfb62012-05-17 12:49:24 +030092 $severity = isset($this->levels[$severity]) ? $this->levels[$severity] : $severity;
Derek Jones37f4b9c2011-07-01 17:56:50 -050093 log_message('error', 'Severity: '.$severity.' --> '.$message. ' '.$filepath.' '.$line, TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +000094 }
95
96 // --------------------------------------------------------------------
97
98 /**
Andrey Andreev3e9d2b82012-10-27 14:28:51 +030099 * 404 Error Handler
Derek Allard2067d1a2008-11-13 22:59:24 +0000100 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300101 * @uses CI_Exceptions::show_error()
102 *
103 * @param string $page Page URI
104 * @param bool $log_error Whether to log the error
105 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +0000106 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200107 public function show_404($page = '', $log_error = TRUE)
Barry Mienydd671972010-10-04 16:33:58 +0200108 {
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200109 $heading = '404 Page Not Found';
110 $message = 'The page you requested was not found.';
Derek Allard2067d1a2008-11-13 22:59:24 +0000111
Derek Allard2ddc9492010-08-05 10:08:33 -0400112 // By default we log this, but allow a dev to skip it
113 if ($log_error)
114 {
115 log_message('error', '404 Page Not Found --> '.$page);
116 }
117
Derek Jonesf6b442b2009-07-11 18:23:30 +0000118 echo $this->show_error($heading, $message, 'error_404', 404);
Derek Allard2067d1a2008-11-13 22:59:24 +0000119 exit;
120 }
Barry Mienydd671972010-10-04 16:33:58 +0200121
Derek Allard2067d1a2008-11-13 22:59:24 +0000122 // --------------------------------------------------------------------
123
124 /**
125 * General Error Page
126 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300127 * Takes an error message as input (either as a string or an array)
128 * and displays it using the specified template.
Derek Allard2067d1a2008-11-13 22:59:24 +0000129 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300130 * @param string $heading Page heading
131 * @param string|string[] $message Error message
132 * @param string $template Template name
Andrey Andreev5232ba02012-10-27 15:25:05 +0300133 * @param int $status_code (default: 500)
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300134 *
135 * @return string Error page output
Derek Allard2067d1a2008-11-13 22:59:24 +0000136 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200137 public function show_error($heading, $message, $template = 'error_general', $status_code = 500)
Derek Allard2067d1a2008-11-13 22:59:24 +0000138 {
Derek Jones817163a2009-07-11 17:05:58 +0000139 set_status_header($status_code);
Barry Mienydd671972010-10-04 16:33:58 +0200140
Andrey Andreev92ebfb62012-05-17 12:49:24 +0300141 $message = '<p>'.implode('</p><p>', is_array($message) ? $message : array($message)).'</p>';
Derek Allard2067d1a2008-11-13 22:59:24 +0000142
143 if (ob_get_level() > $this->ob_level + 1)
144 {
Barry Mienydd671972010-10-04 16:33:58 +0200145 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000146 }
147 ob_start();
Nicholas Avenellc59d25d2012-06-24 10:57:18 +0000148 include(VIEWPATH.'errors/'.$template.'.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000149 $buffer = ob_get_contents();
150 ob_end_clean();
151 return $buffer;
152 }
153
154 // --------------------------------------------------------------------
155
156 /**
157 * Native PHP error handler
158 *
Andrey Andreev3e9d2b82012-10-27 14:28:51 +0300159 * @param int $severity Error level
160 * @param string $message Error message
161 * @param string $filepath File path
162 * @param int $line Line number
163 * @return string Error page output
Derek Allard2067d1a2008-11-13 22:59:24 +0000164 */
Andrey Andreevc6a68e02012-03-26 14:30:10 +0300165 public function show_php_error($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +0200166 {
Andrey Andreev92ebfb62012-05-17 12:49:24 +0300167 $severity = isset($this->levels[$severity]) ? $this->levels[$severity] : $severity;
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200168 $filepath = str_replace('\\', '/', $filepath);
Barry Mienydd671972010-10-04 16:33:58 +0200169
Derek Allard2067d1a2008-11-13 22:59:24 +0000170 // For safety reasons we do not show the full file path
171 if (FALSE !== strpos($filepath, '/'))
172 {
173 $x = explode('/', $filepath);
174 $filepath = $x[count($x)-2].'/'.end($x);
175 }
Barry Mienydd671972010-10-04 16:33:58 +0200176
Derek Allard2067d1a2008-11-13 22:59:24 +0000177 if (ob_get_level() > $this->ob_level + 1)
178 {
Barry Mienydd671972010-10-04 16:33:58 +0200179 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000180 }
181 ob_start();
Nicholas Avenellc59d25d2012-06-24 10:57:18 +0000182 include(VIEWPATH.'errors/error_php.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000183 $buffer = ob_get_contents();
184 ob_end_clean();
185 echo $buffer;
186 }
187
Derek Allard2067d1a2008-11-13 22:59:24 +0000188}
Derek Allard2067d1a2008-11-13 22:59:24 +0000189
190/* End of file Exceptions.php */
Andrey Andreevc6a68e02012-03-26 14:30:10 +0300191/* Location: ./system/core/Exceptions.php */