blob: f36b31598f3617b77dcfd70f1851faf3b09c1bbd [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
39 public $action;
40 public $severity;
41 public $message;
42 public $filename;
43 public $line;
David Behler209b2cf2011-08-14 23:00:43 +020044
45 /**
46 * Nesting level of the output buffering mechanism
David Behler209b2cf2011-08-14 23:00:43 +020047 *
48 * @var int
David Behler209b2cf2011-08-14 23:00:43 +020049 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020050 public $ob_level;
Derek Allard2067d1a2008-11-13 22:59:24 +000051
David Behler209b2cf2011-08-14 23:00:43 +020052 /**
53 * List if available error levels
54 *
55 * @var array
David Behler209b2cf2011-08-14 23:00:43 +020056 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020057 public $levels = array(
58 E_ERROR => 'Error',
59 E_WARNING => 'Warning',
60 E_PARSE => 'Parsing Error',
61 E_NOTICE => 'Notice',
62 E_CORE_ERROR => 'Core Error',
63 E_CORE_WARNING => 'Core Warning',
64 E_COMPILE_ERROR => 'Compile Error',
65 E_COMPILE_WARNING => 'Compile Warning',
66 E_USER_ERROR => 'User Error',
67 E_USER_WARNING => 'User Warning',
68 E_USER_NOTICE => 'User Notice',
69 E_STRICT => 'Runtime Notice'
70 );
Derek Allard2067d1a2008-11-13 22:59:24 +000071
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 *
83 * This function logs PHP generated error messages
84 *
Derek Allard2067d1a2008-11-13 22:59:24 +000085 * @param string the error severity
86 * @param string the error string
87 * @param string the error filepath
88 * @param string the error 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 {
Derek Allard2067d1a2008-11-13 22:59:24 +000093 $severity = ( ! isset($this->levels[$severity])) ? $severity : $this->levels[$severity];
Derek Jones37f4b9c2011-07-01 17:56:50 -050094 log_message('error', 'Severity: '.$severity.' --> '.$message. ' '.$filepath.' '.$line, TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +000095 }
96
97 // --------------------------------------------------------------------
98
99 /**
100 * 404 Page Not Found Handler
101 *
David Behlercda768a2011-08-14 23:52:48 +0200102 * @param string the page
103 * @param bool log error yes/no
Derek Allard2067d1a2008-11-13 22:59:24 +0000104 * @return string
105 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200106 public function show_404($page = '', $log_error = TRUE)
Barry Mienydd671972010-10-04 16:33:58 +0200107 {
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200108 $heading = '404 Page Not Found';
109 $message = 'The page you requested was not found.';
Derek Allard2067d1a2008-11-13 22:59:24 +0000110
Derek Allard2ddc9492010-08-05 10:08:33 -0400111 // By default we log this, but allow a dev to skip it
112 if ($log_error)
113 {
114 log_message('error', '404 Page Not Found --> '.$page);
115 }
116
Derek Jonesf6b442b2009-07-11 18:23:30 +0000117 echo $this->show_error($heading, $message, 'error_404', 404);
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 exit;
119 }
Barry Mienydd671972010-10-04 16:33:58 +0200120
Derek Allard2067d1a2008-11-13 22:59:24 +0000121 // --------------------------------------------------------------------
122
123 /**
124 * General Error Page
125 *
126 * This function takes an error message as input
127 * (either as a string or an array) and displays
128 * it using the specified template.
129 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000130 * @param string the heading
131 * @param string the message
132 * @param string the template name
David Behlercda768a2011-08-14 23:52:48 +0200133 * @param int the status code
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 * @return string
135 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200136 public function show_error($heading, $message, $template = 'error_general', $status_code = 500)
Derek Allard2067d1a2008-11-13 22:59:24 +0000137 {
Derek Jones817163a2009-07-11 17:05:58 +0000138 set_status_header($status_code);
Barry Mienydd671972010-10-04 16:33:58 +0200139
Derek Allard2067d1a2008-11-13 22:59:24 +0000140 $message = '<p>'.implode('</p><p>', ( ! is_array($message)) ? array($message) : $message).'</p>';
141
142 if (ob_get_level() > $this->ob_level + 1)
143 {
Barry Mienydd671972010-10-04 16:33:58 +0200144 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000145 }
146 ob_start();
Andrey Andreevfdc63822012-01-07 21:17:46 +0200147 include(APPPATH.'errors/'.$template.'.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000148 $buffer = ob_get_contents();
149 ob_end_clean();
150 return $buffer;
151 }
152
153 // --------------------------------------------------------------------
154
155 /**
156 * Native PHP error handler
157 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000158 * @param string the error severity
159 * @param string the error string
160 * @param string the error filepath
161 * @param string the error line number
162 * @return string
163 */
Andrey Andreevc6a68e02012-03-26 14:30:10 +0300164 public function show_php_error($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +0200165 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 $severity = ( ! isset($this->levels[$severity])) ? $severity : $this->levels[$severity];
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200167 $filepath = str_replace('\\', '/', $filepath);
Barry Mienydd671972010-10-04 16:33:58 +0200168
Derek Allard2067d1a2008-11-13 22:59:24 +0000169 // For safety reasons we do not show the full file path
170 if (FALSE !== strpos($filepath, '/'))
171 {
172 $x = explode('/', $filepath);
173 $filepath = $x[count($x)-2].'/'.end($x);
174 }
Barry Mienydd671972010-10-04 16:33:58 +0200175
Derek Allard2067d1a2008-11-13 22:59:24 +0000176 if (ob_get_level() > $this->ob_level + 1)
177 {
Barry Mienydd671972010-10-04 16:33:58 +0200178 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000179 }
180 ob_start();
Andrey Andreevfdc63822012-01-07 21:17:46 +0200181 include(APPPATH.'errors/'.'error_php.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000182 $buffer = ob_get_contents();
183 ob_end_clean();
184 echo $buffer;
185 }
186
Derek Allard2067d1a2008-11-13 22:59:24 +0000187}
Derek Allard2067d1a2008-11-13 22:59:24 +0000188
189/* End of file Exceptions.php */
Andrey Andreevc6a68e02012-03-26 14:30:10 +0300190/* Location: ./system/core/Exceptions.php */