blob: 9b672ac54e9a09bea423dadb46511c7b754f4d98 [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 *
Greg Aker741de1c2010-11-10 14:52:57 -06005 * An open source application development framework for PHP 5.1.6 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
28// ------------------------------------------------------------------------
29
30/**
31 * Exceptions Class
32 *
33 * @package CodeIgniter
34 * @subpackage Libraries
35 * @category Exceptions
Derek Jonesf4a4bd82011-10-20 12:18:42 -050036 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000037 * @link http://codeigniter.com/user_guide/libraries/exceptions.html
38 */
39class CI_Exceptions {
Andrey Andreev7ac33d72012-01-07 19:39:39 +020040
41 public $action;
42 public $severity;
43 public $message;
44 public $filename;
45 public $line;
David Behler209b2cf2011-08-14 23:00:43 +020046
47 /**
48 * Nesting level of the output buffering mechanism
David Behler209b2cf2011-08-14 23:00:43 +020049 *
50 * @var int
David Behler209b2cf2011-08-14 23:00:43 +020051 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020052 public $ob_level;
Derek Allard2067d1a2008-11-13 22:59:24 +000053
David Behler209b2cf2011-08-14 23:00:43 +020054 /**
55 * List if available error levels
56 *
57 * @var array
David Behler209b2cf2011-08-14 23:00:43 +020058 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020059 public $levels = array(
60 E_ERROR => 'Error',
61 E_WARNING => 'Warning',
62 E_PARSE => 'Parsing Error',
63 E_NOTICE => 'Notice',
64 E_CORE_ERROR => 'Core Error',
65 E_CORE_WARNING => 'Core Warning',
66 E_COMPILE_ERROR => 'Compile Error',
67 E_COMPILE_WARNING => 'Compile Warning',
68 E_USER_ERROR => 'User Error',
69 E_USER_WARNING => 'User Warning',
70 E_USER_NOTICE => 'User Notice',
71 E_STRICT => 'Runtime Notice'
72 );
Derek Allard2067d1a2008-11-13 22:59:24 +000073
Greg Akera9263282010-11-10 15:26:43 -060074 public function __construct()
Derek Allard2067d1a2008-11-13 22:59:24 +000075 {
76 $this->ob_level = ob_get_level();
Andrey Andreev7ac33d72012-01-07 19:39:39 +020077 // Note: Do not log messages from this constructor.
Derek Allard2067d1a2008-11-13 22:59:24 +000078 }
Barry Mienydd671972010-10-04 16:33:58 +020079
Derek Allard2067d1a2008-11-13 22:59:24 +000080 // --------------------------------------------------------------------
81
82 /**
83 * Exception Logger
84 *
85 * This function logs PHP generated error messages
86 *
Derek Allard2067d1a2008-11-13 22:59:24 +000087 * @param string the error severity
88 * @param string the error string
89 * @param string the error filepath
90 * @param string the error line number
Andrey Andreev7ac33d72012-01-07 19:39:39 +020091 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +000092 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +020093 public function log_exception($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +020094 {
Derek Allard2067d1a2008-11-13 22:59:24 +000095 $severity = ( ! isset($this->levels[$severity])) ? $severity : $this->levels[$severity];
Derek Jones37f4b9c2011-07-01 17:56:50 -050096 log_message('error', 'Severity: '.$severity.' --> '.$message. ' '.$filepath.' '.$line, TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +000097 }
98
99 // --------------------------------------------------------------------
100
101 /**
102 * 404 Page Not Found Handler
103 *
David Behlercda768a2011-08-14 23:52:48 +0200104 * @param string the page
105 * @param bool log error yes/no
Derek Allard2067d1a2008-11-13 22:59:24 +0000106 * @return string
107 */
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 Andreev7ac33d72012-01-07 19:39:39 +0200110 $heading = '404 Page Not Found';
111 $message = 'The page you requested was not found.';
Derek Allard2067d1a2008-11-13 22:59:24 +0000112
Derek Allard2ddc9492010-08-05 10:08:33 -0400113 // By default we log this, but allow a dev to skip it
114 if ($log_error)
115 {
116 log_message('error', '404 Page Not Found --> '.$page);
117 }
118
Derek Jonesf6b442b2009-07-11 18:23:30 +0000119 echo $this->show_error($heading, $message, 'error_404', 404);
Derek Allard2067d1a2008-11-13 22:59:24 +0000120 exit;
121 }
Barry Mienydd671972010-10-04 16:33:58 +0200122
Derek Allard2067d1a2008-11-13 22:59:24 +0000123 // --------------------------------------------------------------------
124
125 /**
126 * General Error Page
127 *
128 * This function takes an error message as input
129 * (either as a string or an array) and displays
130 * it using the specified template.
131 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000132 * @param string the heading
133 * @param string the message
134 * @param string the template name
David Behlercda768a2011-08-14 23:52:48 +0200135 * @param int the status code
Derek Allard2067d1a2008-11-13 22:59:24 +0000136 * @return string
137 */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200138 public function show_error($heading, $message, $template = 'error_general', $status_code = 500)
Derek Allard2067d1a2008-11-13 22:59:24 +0000139 {
Derek Jones817163a2009-07-11 17:05:58 +0000140 set_status_header($status_code);
Barry Mienydd671972010-10-04 16:33:58 +0200141
Derek Allard2067d1a2008-11-13 22:59:24 +0000142 $message = '<p>'.implode('</p><p>', ( ! is_array($message)) ? array($message) : $message).'</p>';
143
144 if (ob_get_level() > $this->ob_level + 1)
145 {
Barry Mienydd671972010-10-04 16:33:58 +0200146 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000147 }
148 ob_start();
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200149 include(APPPATH.'errors'.DIRECTORY_SEPARATOR.$template.'.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000150 $buffer = ob_get_contents();
151 ob_end_clean();
152 return $buffer;
153 }
154
155 // --------------------------------------------------------------------
156
157 /**
158 * Native PHP error handler
159 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000160 * @param string the error severity
161 * @param string the error string
162 * @param string the error filepath
163 * @param string the error line number
164 * @return string
165 */
166 function show_php_error($severity, $message, $filepath, $line)
Barry Mienydd671972010-10-04 16:33:58 +0200167 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000168 $severity = ( ! isset($this->levels[$severity])) ? $severity : $this->levels[$severity];
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200169 $filepath = str_replace('\\', '/', $filepath);
Barry Mienydd671972010-10-04 16:33:58 +0200170
Derek Allard2067d1a2008-11-13 22:59:24 +0000171 // For safety reasons we do not show the full file path
172 if (FALSE !== strpos($filepath, '/'))
173 {
174 $x = explode('/', $filepath);
175 $filepath = $x[count($x)-2].'/'.end($x);
176 }
Barry Mienydd671972010-10-04 16:33:58 +0200177
Derek Allard2067d1a2008-11-13 22:59:24 +0000178 if (ob_get_level() > $this->ob_level + 1)
179 {
Barry Mienydd671972010-10-04 16:33:58 +0200180 ob_end_flush();
Derek Allard2067d1a2008-11-13 22:59:24 +0000181 }
182 ob_start();
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200183 include(APPPATH.'errors'.DIRECTORY_SEPARATOR.'error_php.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000184 $buffer = ob_get_contents();
185 ob_end_clean();
186 echo $buffer;
187 }
188
Derek Allard2067d1a2008-11-13 22:59:24 +0000189}
Derek Allard2067d1a2008-11-13 22:59:24 +0000190
191/* End of file Exceptions.php */
Andrey Andreev7ac33d72012-01-07 19:39:39 +0200192/* Location: ./system/core/Exceptions.php */