first commi

system/src/Grav/Common/Errors/BareHandler.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * @package    Grav\Common\Errors
+ *
+ * @copyright  Copyright (c) 2015 - 2021 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Errors;
+
+use Whoops\Handler\Handler;
+
+/**
+ * Class BareHandler
+ * @package Grav\Common\Errors
+ */
+class BareHandler extends Handler
+{
+    /**
+     * @return int
+     */
+    public function handle()
+    {
+        $inspector = $this->getInspector();
+        $code = $inspector->getException()->getCode();
+        if (($code >= 400) && ($code < 600)) {
+            $this->getRun()->sendHttpCode($code);
+        }
+
+        return Handler::QUIT;
+    }
+}

system/src/Grav/Common/Errors/Errors.php

@@ -0,0 +1,85 @@
+<?php
+
+/**
+ * @package    Grav\Common\Errors
+ *
+ * @copyright  Copyright (c) 2015 - 2021 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Errors;
+
+use Exception;
+use Grav\Common\Grav;
+use Whoops\Handler\JsonResponseHandler;
+use Whoops\Handler\PrettyPageHandler;
+use Whoops\Run;
+use Whoops\Util\Misc;
+use function is_int;
+
+/**
+ * Class Errors
+ * @package Grav\Common\Errors
+ */
+class Errors
+{
+    /**
+     * @return void
+     */
+    public function resetHandlers()
+    {
+        $grav = Grav::instance();
+        $config = $grav['config']->get('system.errors');
+        $jsonRequest = $_SERVER && isset($_SERVER['HTTP_ACCEPT']) && $_SERVER['HTTP_ACCEPT'] === 'application/json';
+
+        // Setup Whoops-based error handler
+        $system = new SystemFacade;
+        $whoops = new Run($system);
+
+        $verbosity = 1;
+
+        if (isset($config['display'])) {
+            if (is_int($config['display'])) {
+                $verbosity = $config['display'];
+            } else {
+                $verbosity = $config['display'] ? 1 : 0;
+            }
+        }
+
+        switch ($verbosity) {
+            case 1:
+                $error_page = new PrettyPageHandler();
+                $error_page->setPageTitle('Crikey! There was an error...');
+                $error_page->addResourcePath(GRAV_ROOT . '/system/assets');
+                $error_page->addCustomCss('whoops.css');
+                $whoops->prependHandler($error_page);
+                break;
+            case -1:
+                $whoops->prependHandler(new BareHandler);
+                break;
+            default:
+                $whoops->prependHandler(new SimplePageHandler);
+                break;
+        }
+
+        if ($jsonRequest || Misc::isAjaxRequest()) {
+            $whoops->prependHandler(new JsonResponseHandler());
+        }
+
+        if (isset($config['log']) && $config['log']) {
+            $logger = $grav['log'];
+            $whoops->pushHandler(function ($exception, $inspector, $run) use ($logger) {
+                try {
+                    $logger->addCritical($exception->getMessage() . ' - Trace: ' . $exception->getTraceAsString());
+                } catch (Exception $e) {
+                    echo $e;
+                }
+            });
+        }
+
+        $whoops->register();
+
+        // Re-register deprecation handler.
+        $grav['debugger']->setErrorHandler();
+    }
+}

system/src/Grav/Common/Errors/Resources/error.css

@@ -0,0 +1,52 @@
+html, body {
+    height: 100%
+}
+body {
+    margin:0 3rem;
+    padding:0;
+    font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+    font-size: 1.5rem;
+    line-height: 1.4;
+    display: -webkit-box;      /* OLD - iOS 6-, Safari 3.1-6 */
+    display: -moz-box;         /* OLD - Firefox 19- (buggy but mostly works) */
+    display: -ms-flexbox;      /* TWEENER - IE 10 */
+    display: -webkit-flex;     /* NEW - Chrome */
+    display: flex;
+    -webkit-align-items: center;
+    align-items: center;
+    -webkit-justify-content: center;
+    justify-content: center;
+}
+.container {
+    margin: 0rem;
+    max-width: 600px;
+    padding-bottom:5rem;
+}
+
+header {
+    color: #000;
+    font-size: 4rem;
+    letter-spacing: 2px;
+    line-height: 1.1;
+    margin-bottom: 2rem;
+}
+p {
+    font-family: Optima, Segoe, "Segoe UI", Candara, Calibri, Arial, sans-serif;
+    color: #666;
+}
+
+h5 {
+    font-weight: normal;
+    color: #999;
+    font-size: 1rem;
+}
+
+h6 {
+    font-weight: normal;
+    color: #999;
+}
+
+code {
+    font-weight: bold;
+    font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
+}

system/src/Grav/Common/Errors/Resources/layout.html.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Layout template file for Whoops's pretty error output.
+ */
+?>
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <title>Whoops there was an error!</title>
+    <style><?php echo $stylesheet ?></style>
+</head>
+<body>
+    <div class="container">
+        <div class="details">
+            <header>
+                Server Error
+            </header>
+
+
+
+            <p>Sorry, something went terribly wrong!</p>
+
+            <h3><?php echo $code ?> - <?php echo $message ?></h3>
+
+            <h5>For further details please review your <code>logs/</code> folder, or enable displaying of errors in your system configuration.</h5>
+        </div>
+    </div>
+</body>
+</html>

system/src/Grav/Common/Errors/SimplePageHandler.php

@@ -0,0 +1,122 @@
+<?php
+
+/**
+ * @package    Grav\Common\Errors
+ *
+ * @copyright  Copyright (c) 2015 - 2021 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Errors;
+
+use ErrorException;
+use InvalidArgumentException;
+use RuntimeException;
+use Whoops\Handler\Handler;
+use Whoops\Util\Misc;
+use Whoops\Util\TemplateHelper;
+
+/**
+ * Class SimplePageHandler
+ * @package Grav\Common\Errors
+ */
+class SimplePageHandler extends Handler
+{
+    /** @var array */
+    private $searchPaths = [];
+    /** @var array */
+    private $resourceCache = [];
+
+    public function __construct()
+    {
+        // Add the default, local resource search path:
+        $this->searchPaths[] = __DIR__ . '/Resources';
+    }
+
+    /**
+     * @return int
+     */
+    public function handle()
+    {
+        $inspector = $this->getInspector();
+
+        $helper = new TemplateHelper();
+        $templateFile = $this->getResource('layout.html.php');
+        $cssFile      = $this->getResource('error.css');
+
+        $code = $inspector->getException()->getCode();
+        if (($code >= 400) && ($code < 600)) {
+            $this->getRun()->sendHttpCode($code);
+        }
+        $message = $inspector->getException()->getMessage();
+
+        if ($inspector->getException() instanceof ErrorException) {
+            $code = Misc::translateErrorCode($code);
+        }
+
+        $vars = array(
+            'stylesheet' => file_get_contents($cssFile),
+            'code'        => $code,
+            'message'     => filter_var(rawurldecode($message), FILTER_SANITIZE_STRING),
+        );
+
+        $helper->setVariables($vars);
+        $helper->render($templateFile);
+
+        return Handler::QUIT;
+    }
+
+    /**
+     * @param string $resource
+     * @return string
+     * @throws RuntimeException
+     */
+    protected function getResource($resource)
+    {
+        // If the resource was found before, we can speed things up
+        // by caching its absolute, resolved path:
+        if (isset($this->resourceCache[$resource])) {
+            return $this->resourceCache[$resource];
+        }
+
+        // Search through available search paths, until we find the
+        // resource we're after:
+        foreach ($this->searchPaths as $path) {
+            $fullPath = "{$path}/{$resource}";
+
+            if (is_file($fullPath)) {
+                // Cache the result:
+                $this->resourceCache[$resource] = $fullPath;
+                return $fullPath;
+            }
+        }
+
+        // If we got this far, nothing was found.
+        throw new RuntimeException(
+            "Could not find resource '{$resource}' in any resource paths (searched: " . implode(', ', $this->searchPaths). ')'
+        );
+    }
+
+    /**
+     * @param string $path
+     * @return void
+     */
+    public function addResourcePath($path)
+    {
+        if (!is_dir($path)) {
+            throw new InvalidArgumentException(
+                "'{$path}' is not a valid directory"
+            );
+        }
+
+        array_unshift($this->searchPaths, $path);
+    }
+
+    /**
+     * @return array
+     */
+    public function getResourcePaths()
+    {
+        return $this->searchPaths;
+    }
+}

system/src/Grav/Common/Errors/SystemFacade.php

@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * @package    Grav\Common\Errors
+ *
+ * @copyright  Copyright (c) 2015 - 2021 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Errors;
+
+/**
+ * Class SystemFacade
+ * @package Grav\Common\Errors
+ */
+class SystemFacade extends \Whoops\Util\SystemFacade
+{
+    /** @var callable */
+    protected $whoopsShutdownHandler;
+
+    /**
+     * @param callable $function
+     * @return void
+     */
+    public function registerShutdownFunction(callable $function)
+    {
+        $this->whoopsShutdownHandler = $function;
+        register_shutdown_function([$this, 'handleShutdown']);
+    }
+
+    /**
+     * Special case to deal with Fatal errors and the like.
+     *
+     * @return void
+     */
+    public function handleShutdown()
+    {
+        $error = $this->getLastError();
+
+        // Ignore core warnings and errors.
+        if ($error && !($error['type'] & (E_CORE_WARNING | E_CORE_ERROR))) {
+            $handler = $this->whoopsShutdownHandler;
+            $handler();
+        }
+    }
+}