-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Separate regular PhD output from error handling (#176)
- Move error handling code into a class and remove PhD message output handling from it. - Introduce a new class to handle PhD message output. - Make the implicit dependency on the output functionality of classes explicit. - Update PEAR package.xml. - Fix tests. - Use proper variadic parameters - Use class constants - Use first-class callable syntax --------- Co-authored-by: haszi <haszika80@gmail.com>
- Loading branch information
Showing
84 changed files
with
565 additions
and
439 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| <?php | ||
| namespace phpdotnet\phd; | ||
|
|
||
| class ErrorHandler | ||
| { | ||
| private const ERROR_MAP = [ | ||
| // PHP Triggered Errors | ||
| E_DEPRECATED => 'E_DEPRECATED ', | ||
| E_RECOVERABLE_ERROR => 'E_RECOVERABLE_ERROR ', | ||
| E_STRICT => 'E_STRICT ', | ||
| E_WARNING => 'E_WARNING ', | ||
| E_NOTICE => 'E_NOTICE ', | ||
|
|
||
| // User Triggered Errors | ||
| E_USER_ERROR => 'E_USER_ERROR ', | ||
| E_USER_WARNING => 'E_USER_WARNING ', | ||
| E_USER_NOTICE => 'E_USER_NOTICE ', | ||
| E_USER_DEPRECATED => 'E_USER_DEPRECATED ', | ||
| ]; | ||
|
|
||
| private bool $recursive = false; | ||
|
|
||
| public function __construct( | ||
| private OutputHandler $outputHandler | ||
| ) {} | ||
|
|
||
| public function handleError($errno, $msg, $file, $line) { | ||
| // Respect the error_reporting setting | ||
| if (!(error_reporting() & $errno)) { | ||
| return false; | ||
| } | ||
|
|
||
| // Recursive protection | ||
| if ($this->recursive) { | ||
| // Thats bad.. lets print a backtrace right away | ||
| debug_print_backtrace(); | ||
| // Fallback to the default errorhandler | ||
| return false; | ||
| } | ||
| $this->recursive = true; | ||
|
|
||
| switch($errno) { | ||
| // User triggered errors | ||
| case E_USER_ERROR: | ||
| case E_USER_WARNING: | ||
| case E_USER_NOTICE: | ||
| $this->outputHandler->printUserError($msg, $file, $line, self::ERROR_MAP[$errno]); | ||
| break; | ||
|
|
||
| // PHP triggered errors | ||
| case E_DEPRECATED: | ||
| case E_RECOVERABLE_ERROR: | ||
| case E_STRICT: | ||
| case E_WARNING: | ||
| case E_NOTICE: | ||
| $this->outputHandler->printPhpError($msg, $file, $line, self::ERROR_MAP[$errno]); | ||
| break; | ||
|
|
||
| default: | ||
| $this->recursive = false; | ||
| return false; | ||
| } | ||
|
|
||
| // Abort on fatal errors | ||
| if ($errno & (E_USER_ERROR|E_RECOVERABLE_ERROR)) { | ||
| exit(1); | ||
| } | ||
|
|
||
| $this->recursive = false; | ||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| <?php | ||
| namespace phpdotnet\phd; | ||
|
|
||
| class OutputHandler | ||
| { | ||
| /** @var array */ | ||
| private const CONSTANT_TO_MESSAGE_CATEGORY_MAP = [ | ||
| // PhD informationals | ||
| VERBOSE_INDEXING => 'Indexing ', | ||
| VERBOSE_FORMAT_RENDERING => 'Rendering Format ', | ||
| VERBOSE_THEME_RENDERING => 'Rendering Theme ', | ||
| VERBOSE_RENDER_STYLE => 'Rendering Style ', | ||
| VERBOSE_PARTIAL_READING => 'Partial Reading ', | ||
| VERBOSE_PARTIAL_CHILD_READING => 'Partial Child Reading ', | ||
| VERBOSE_TOC_WRITING => 'Writing TOC ', | ||
| VERBOSE_CHUNK_WRITING => 'Writing Chunk ', | ||
| VERBOSE_MESSAGES => 'Heads up ', | ||
|
|
||
| // PhD warnings | ||
| VERBOSE_NOVERSION => 'No version information', | ||
| VERBOSE_BROKEN_LINKS => 'Broken links ', | ||
| VERBOSE_OLD_LIBXML => 'Old libxml2 ', | ||
| VERBOSE_MISSING_ATTRIBUTES => 'Missing attributes ', | ||
| ]; | ||
|
|
||
| public function __construct( | ||
| private Config $config | ||
| ) {} | ||
|
|
||
| /** | ||
| * Method to get a color escape sequence | ||
| */ | ||
| private function term_color(string $text, string|false $color): string { | ||
| return $this->config->color_output() && $color !== false ? "\033[" . $color . "m" . $text . "\033[m" : $text; | ||
| } | ||
|
|
||
| public function printPhdInfo(string $msg, string $info = ""): int { | ||
| $color = $this->config->phd_info_color(); | ||
| $outputStream = $this->config->phd_info_output(); | ||
|
|
||
| return $this->print($msg, $outputStream, $color, $info); | ||
| } | ||
|
|
||
| private function printPhdWarning(string $msg, string $warning = ""): int { | ||
| $color = $this->config->phd_warning_color(); | ||
| $outputStream = $this->config->phd_warning_output(); | ||
|
|
||
| return $this->print($msg, $outputStream, $color, $warning); | ||
| } | ||
|
|
||
| public function printUserError(string $msg, string $file, int $line, string $error = ""): int { | ||
| $color = $this->config->user_error_color(); | ||
| $outputStream = $this->config->user_error_output(); | ||
| $data = \sprintf("%s:%d\n\t%s", $file, $line, $msg); | ||
|
|
||
| return $this->print($data, $outputStream, $color, $error); | ||
| } | ||
|
|
||
| public function printPhpError(string $msg, string $file, int $line, string $error = ""): int { | ||
| $color = $this->config->php_error_color(); | ||
| $outputStream = $this->config->php_error_output(); | ||
| $data = \sprintf("%s:%d\n\t%s", $file, $line, $msg); | ||
|
|
||
| return $this->print($data, $outputStream, $color, $error); | ||
| } | ||
|
|
||
| private function print(string $msg, $outputStream, string|false $color = false, string $infoOrErrorString = ""): int { | ||
| if ($infoOrErrorString === "") { | ||
| $colorMsg = $this->term_color(\sprintf("%s", $msg), $color); | ||
|
|
||
| return \fprintf($outputStream, "%s\n", $colorMsg); | ||
| } | ||
|
|
||
| $time = \date($this->config->date_format()); | ||
| $timestamp = $this->term_color(\sprintf("[%s - %s]", $time, $infoOrErrorString), $color); | ||
|
|
||
| return \fprintf($outputStream, "%s %s\n", $timestamp, $msg); | ||
| } | ||
|
|
||
| /** | ||
| * Print info messages: v("printf-format-text" [, $arg1, ...], $verbose-level) | ||
| */ | ||
| public function v(...$args): bool { | ||
| $messageCategory = \array_pop($args); | ||
| $msg = \vsprintf(\array_shift($args), $args); | ||
|
|
||
| // Respect the error_reporting setting | ||
| if (!(\error_reporting() & $messageCategory)) { | ||
| return false; | ||
| } | ||
|
|
||
| switch($messageCategory) { | ||
| case VERBOSE_INDEXING: | ||
| case VERBOSE_FORMAT_RENDERING: | ||
| case VERBOSE_THEME_RENDERING: | ||
| case VERBOSE_RENDER_STYLE: | ||
| case VERBOSE_PARTIAL_READING: | ||
| case VERBOSE_PARTIAL_CHILD_READING: | ||
| case VERBOSE_TOC_WRITING: | ||
| case VERBOSE_CHUNK_WRITING: | ||
| case VERBOSE_MESSAGES: | ||
| $this->printPhdInfo($msg, self::CONSTANT_TO_MESSAGE_CATEGORY_MAP[$messageCategory]); | ||
| break; | ||
|
|
||
| case VERBOSE_NOVERSION: | ||
| case VERBOSE_BROKEN_LINKS: | ||
| case VERBOSE_OLD_LIBXML: | ||
| case VERBOSE_MISSING_ATTRIBUTES: | ||
| $this->printPhdWarning($msg, self::CONSTANT_TO_MESSAGE_CATEGORY_MAP[$messageCategory]); | ||
| break; | ||
|
|
||
| default: | ||
| return false; | ||
| } | ||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.