Skip to content

Allow safe use of PHP-Error in production env. by handling display_errors properly #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
panrafal wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Allow safe use of PHP-Error in production env. by handling display_errors properly #59

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
258bdaf
display_errors is handled differently.
panrafal Feb 2, 2013
498de3b
Every broken page should have status 500
panrafal Feb 2, 2013
ef269d4
Flush and close the buffer
panrafal Feb 2, 2013
902db36
Option 'error_page' allows to show specified error page if display_er…
panrafal Feb 2, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 88 additions & 45 deletions src/php_error.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,6 @@
$_php_error_is_ini_enabled =
! @get_cfg_var( 'php_error.force_disabled' ) &&
! @get_cfg_var( 'php_error.force_disable' ) &&
@ini_get('display_errors') === '1' &&
PHP_SAPI !== 'cli'
;
}
Expand Down Expand Up @@ -1135,6 +1134,8 @@ public static function identifyTypeHTML( $arg, $recurseLevels=1 ) {

private $classNotFoundException;

private $errorPage;

/**
* = Options =
*
Expand Down Expand Up @@ -1189,6 +1190,9 @@ public static function identifyTypeHTML( $arg, $recurseLevels=1 ) {
* pages too, such as replying with images of JavaScript
* from your PHP. Defaults to true.
*
* - error_page Error page to show if display_errors is disabled.
* Should be an absolute path to .html or .php file
*
* @param options Optional, an array of values to customize this handler.
* @throws Exception This is raised if given an options that does *not* exist (so you know that option is meaningless).
*/
Expand Down Expand Up @@ -1249,6 +1253,8 @@ public function __construct( $options=null ) {
$this->displayLineNumber = ErrorHandler::optionsPop( $options, 'display_line_numbers' , false );

$this->htmlOnly = !! ErrorHandler::optionsPop( $options, 'html_only', true );

$this->errorPage = ErrorHandler::optionsPop( $options, 'error_page', false );

$this->classNotFoundException = null;

Expand Down Expand Up @@ -1329,6 +1335,10 @@ public function turnOff() {
return $this;
}

public function isDisplayingErrors() {
return ini_get('display_errors') === '1';
}

/**
* Allows you to run a callback with strict errors turned off.
* Standard errors still apply, but this will use the default
Expand Down Expand Up @@ -1499,6 +1509,7 @@ private function flushBuffer() {
public function endBuffer() {
if ( $this->isBufferSetup ) {
$content = ob_get_contents();

$handlers = ob_list_handlers();

$wasGZHandler = false;
Expand Down Expand Up @@ -1526,6 +1537,7 @@ public function endBuffer() {
}

if (
$this->isDisplayingErrors() &&
!$this->isAjax &&
$this->catchAjaxErrors &&
(!$this->htmlOnly || !ErrorHandler::isNonPHPRequest())
Expand All @@ -1544,6 +1556,8 @@ public function endBuffer() {
echo $js;
}
}

ob_end_flush();

echo $content;
}
Expand Down Expand Up @@ -2359,68 +2373,97 @@ public function reportError( $code, $message, $errLine, $errFile, $ex=null ) {
* It runs if:
* - it is globally enabled
* - this error handler is enabled
* - we believe it is a regular html request, or ajax
*/
global $_php_error_is_ini_enabled;
if (
$_php_error_is_ini_enabled &&
$this->isOn() && (
$this->isOn()
) {

/* Every broken page should have status 500 */
header('HTTP/1.1 500 Internal Server Error');

/**
* Error is displayed if:
* - display_errors is 1
* - we believe it is a regular html request, or ajax
*/
if ($this->isDisplayingErrors() && (
$this->isAjax ||
!$this->htmlOnly ||
!ErrorHandler::isNonPHPRequest()
)
) {
$root = $this->applicationRoot;

list( $ex, $stackTrace, $code, $errFile, $errLine ) =
$this->getStackTrace( $ex, $code, $errFile, $errLine );

list( $message, $srcErrFile, $srcErrLine, $altInfo ) =
$this->improveErrorMessage(
$ex,
$code,
$message,
$errLine,
$errFile,
$root,
$stackTrace
);

$errFile = $srcErrFile;
$errLine = $srcErrLine;
) {
$root = $this->applicationRoot;

list( $ex, $stackTrace, $code, $errFile, $errLine ) =
$this->getStackTrace( $ex, $code, $errFile, $errLine );

list( $message, $srcErrFile, $srcErrLine, $altInfo ) =
$this->improveErrorMessage(
$ex,
$code,
$message,
$errLine,
$errFile,
$root,
$stackTrace
);

list( $fileLinesSets, $numFileLines ) = $this->generateFileLineSets( $srcErrFile, $srcErrLine, $stackTrace );
$errFile = $srcErrFile;
$errLine = $srcErrLine;

list( $type, $errFile ) = $this->getFolderType( $root, $errFile );
$errFileType = ErrorHandler::folderTypeToCSS( $type );
list( $fileLinesSets, $numFileLines ) = $this->generateFileLineSets( $srcErrFile, $srcErrLine, $stackTrace );

$stackTrace = $this->parseStackTrace( $code, $message, $errLine, $errFile, $stackTrace, $root, $altInfo );
$fileLines = $this->readCodeFile( $srcErrFile, $srcErrLine );
list( $type, $errFile ) = $this->getFolderType( $root, $errFile );
$errFileType = ErrorHandler::folderTypeToCSS( $type );

// load the session, if it's there
$stackTrace = $this->parseStackTrace( $code, $message, $errLine, $errFile, $stackTrace, $root, $altInfo );
$fileLines = $this->readCodeFile( $srcErrFile, $srcErrLine );

if ( isset($_COOKIE[session_name()]) && session_id() !== '' && !isset($_SESSION)) {
session_start();
}
// load the session, if it's there

$request = ErrorHandler::getRequestHeaders();
$response = ErrorHandler::getResponseHeaders();
if ( isset($_COOKIE[session_name()]) && session_id() !== '' && !isset($_SESSION)) {
session_start();
}

$dump = $this->generateDumpHTML(
array(
'post' => ( isset($_POST) ? $_POST : array() ),
'get' => ( isset($_GET) ? $_GET : array() ),
'session' => ( isset($_SESSION) ? $_SESSION : array() ),
'cookies' => ( isset($_COOKIE) ? $_COOKIE : array() )
),
$request = ErrorHandler::getRequestHeaders();
$response = ErrorHandler::getResponseHeaders();

$request,
$response,
$dump = $this->generateDumpHTML(
array(
'post' => ( isset($_POST) ? $_POST : array() ),
'get' => ( isset($_GET) ? $_GET : array() ),
'session' => ( isset($_SESSION) ? $_SESSION : array() ),
'cookies' => ( isset($_COOKIE) ? $_COOKIE : array() )
),

$_SERVER
);
$this->displayError( $message, $srcErrLine, $errFile, $errFileType, $stackTrace, $fileLinesSets, $numFileLines, $dump );
$request,
$response,

$_SERVER
);
$this->displayError( $message, $srcErrLine, $errFile, $errFileType, $stackTrace, $fileLinesSets, $numFileLines, $dump );

} elseif ( $this->errorPage &&
!$this->isDisplayingErrors() &&
!$this->isAjax &&
(
!$this->htmlOnly ||
!ErrorHandler::isNonPHPRequest()
)
) {
if ( file_exists($this->errorPage) ) {
if (substr($this->errorPage, -4) === '.php' ) {
include($this->errorPage);
} else {
readfile($this->errorPage);
}
} else {
echo '!';
}
}

// exit in order to end processing
$this->turnOff();
exit(0);
Expand Down