blob: 2e9f0c766d059b4ed11c4b5331dc77a121e9468a [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 /**
67 * Initialize execption class
68 */
Greg Akera9263282010-11-10 15:26:43 -060069 public function __construct()
Derek Allard2067d1a2008-11-13 22:59:24 +000070 {
71 $this->ob_level = ob_get_level();
Andrey Andreev7ac33d72012-01-07 19:39:39 +020072 // Note: Do not log messages from this constructor.
Derek Allard2067d1a2008-11-13 22:59:24 +000073 }
Barry Mienydd671972010-10-04 16:33:58 +020074
Derek Allard2067d1a2008-11-13 22:59:24 +000075 // --------------------------------------------------------------------
76
77 /**
78 * Exception Logger
79 *
80 * This function logs PHP generated error messages
81 *
Derek Allard2067d1a2008-11-13 22:59:24 +000082 * @param string the error severity
83 * @param string the error string
84 * @param string the error filepath
85 * @param string the error line number
Andrey Andreev7ac33d72012-01-07 19:39:39 +020086 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +000087 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020088 public function log_exception($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +020089 {
Derek Allard2067d1a2008-11-13 22:59:24 +000090 $severity = ( ! isset($this->levels[$severity])) ? $severity : $this->levels[$severity];
Derek Jones37f4b9c2011-07-01 17:56:50 -050091 log_message('error', 'Severity: '.$severity.' --> '.$message. ' '.$filepath.' '.$line, TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +000092 }
93
94 // --------------------------------------------------------------------
95
96 /**
97 * 404 Page Not Found Handler
98 *
David Behlercda768a2011-08-14 23:52:48 +020099 * @param string the page
100 * @param bool log error yes/no
Derek Allard2067d1a2008-11-13 22:59:24 +0000101 * @return string
102 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200103 public function show_404($page = '', $log_error = TRUE)
Barry Mienydd671972010-10-04 16:33:58 +0200104 {
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200105 $heading = '404 Page Not Found';
106 $message = 'The page you requested was not found.';
Derek Allard2067d1a2008-11-13 22:59:24 +0000107
Derek Allard2ddc9492010-08-05 10:08:33 -0400108 // By default we log this, but allow a dev to skip it
109 if ($log_error)
110 {
111 log_message('error', '404 Page Not Found --> '.$page);
112 }
113
Derek Jonesf6b442b2009-07-11 18:23:30 +0000114 echo $this->show_error($heading, $message, 'error_404', 404);
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 exit;
116 }
Barry Mienydd671972010-10-04 16:33:58 +0200117
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 // --------------------------------------------------------------------
119
120 /**
121 * General Error Page
122 *
123 * This function takes an error message as input
124 * (either as a string or an array) and displays
125 * it using the specified template.
126 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000127 * @param string the heading
128 * @param string the message
129 * @param string the template name
David Behlercda768a2011-08-14 23:52:48 +0200130 * @param int the status code
Derek Allard2067d1a2008-11-13 22:59:24 +0000131 * @return string
132 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200133 public function show_error($heading, $message, $template = 'error_general', $status_code = 500)
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 {
Derek Jones817163a2009-07-11 17:05:58 +0000135 set_status_header($status_code);
Barry Mienydd671972010-10-04 16:33:58 +0200136
Derek Allard2067d1a2008-11-13 22:59:24 +0000137 $message = '<p>'.implode('</p><p>', ( ! is_array($message)) ? array($message) : $message).'</p>';
138
139 if (ob_get_level() > $this->ob_level + 1)
140 {
Barry Mienydd671972010-10-04 16:33:58 +0200141 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000142 }
143 ob_start();
Andrey Andreevfdc63822012-01-07 21:17:46 +0200144 include(APPPATH.'errors/'.$template.'.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000145 $buffer = ob_get_contents();
146 ob_end_clean();
147 return $buffer;
148 }
149
150 // --------------------------------------------------------------------
151
152 /**
153 * Native PHP error handler
154 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000155 * @param string the error severity
156 * @param string the error string
157 * @param string the error filepath
158 * @param string the error line number
159 * @return string
160 */
Andrey Andreevc6a68e02012-03-26 14:30:10 +0300161 public function show_php_error($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +0200162 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000163 $severity = ( ! isset($this->levels[$severity])) ? $severity : $this->levels[$severity];
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200164 $filepath = str_replace('\\', '/', $filepath);
Barry Mienydd671972010-10-04 16:33:58 +0200165
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 // For safety reasons we do not show the full file path
167 if (FALSE !== strpos($filepath, '/'))
168 {
169 $x = explode('/', $filepath);
170 $filepath = $x[count($x)-2].'/'.end($x);
171 }
Barry Mienydd671972010-10-04 16:33:58 +0200172
Derek Allard2067d1a2008-11-13 22:59:24 +0000173 if (ob_get_level() > $this->ob_level + 1)
174 {
Barry Mienydd671972010-10-04 16:33:58 +0200175 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000176 }
177 ob_start();
Andrey Andreevfdc63822012-01-07 21:17:46 +0200178 include(APPPATH.'errors/'.'error_php.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000179 $buffer = ob_get_contents();
180 ob_end_clean();
181 echo $buffer;
182 }
183
Derek Allard2067d1a2008-11-13 22:59:24 +0000184}
Derek Allard2067d1a2008-11-13 22:59:24 +0000185
186/* End of file Exceptions.php */
Andrey Andreevc6a68e02012-03-26 14:30:10 +0300187/* Location: ./system/core/Exceptions.php */