PrettyPageHandler.php

Go to the documentation of this file.

<?php
namespace Whoops\Handler;
 
use InvalidArgumentException;
use RuntimeException;
use Whoops\Exception\Formatter;
use Whoops\Util\Misc;
use Whoops\Util\TemplateHelper;
 
class PrettyPageHandler extends Handler
{
    private $searchPaths = array();
 
    private $resourceCache = array();
 
    private $customCss = null;
 
    private $extraTables = array();
 
    private $handleUnconditionally = false;
 
    private $pageTitle = "Whoops! There was an error.";
 
    protected $editor;
 
    protected $editors = array(
        "sublime"  => "subl://open?url=file://%file&line=%line",
        "textmate" => "txmt://open?url=file://%file&line=%line",
        "emacs"    => "emacs://open?url=file://%file&line=%line",
        "macvim"   => "mvim://open/?url=file://%file&line=%line",
    );
 
    public function __construct()
    {
        if (ini_get('xdebug.file_link_format') || extension_loaded('xdebug')) {
            // Register editor using xdebug's file_link_format option.
            $this->editors['xdebug'] = function ($file, $line) {
                return str_replace(array('%f', '%l'), array($file, $line), ini_get('xdebug.file_link_format'));
            };
        }
 
        // Add the default, local resource search path:
        $this->searchPaths[] = __DIR__ . "/../Resources";
    }
 
    public function handle()
    {
        if (!$this->handleUnconditionally()) {
            // Check conditions for outputting HTML:
            // @todo: Make this more robust
            if (php_sapi_name() === 'cli') {
                // Help users who have been relying on an internal test value
                // fix their code to the proper method
                if (isset($_ENV['whoops-test'])) {
                    throw new \Exception(
                        'Use handleUnconditionally instead of whoops-test'
                        .' environment variable'
                    );
                }
 
                return Handler::DONE;
            }
        }
 
        // @todo: Make this more dynamic
        $helper = new TemplateHelper();
 
        $templateFile = $this->getResource("views/layout.html.php");
        $cssFile      = $this->getResource("css/whoops.base.css");
        $zeptoFile    = $this->getResource("js/zepto.min.js");
        $jsFile       = $this->getResource("js/whoops.base.js");
 
        if ($this->customCss) {
            $customCssFile = $this->getResource($this->customCss);
        }
 
        $inspector = $this->getInspector();
        $frames    = $inspector->getFrames();
 
        $code = $inspector->getException()->getCode();
 
        if ($inspector->getException() instanceof \ErrorException) {
            $code = Misc::translateErrorCode($code);
        }
 
        // List of variables that will be passed to the layout template.
        $vars = array(
            "page_title" => $this->getPageTitle(),
 
            // @todo: Asset compiler
            "stylesheet" => file_get_contents($cssFile),
            "zepto"      => file_get_contents($zeptoFile),
            "javascript" => file_get_contents($jsFile),
 
            // Template paths:
            "header"      => $this->getResource("views/header.html.php"),
            "frame_list"  => $this->getResource("views/frame_list.html.php"),
            "frame_code"  => $this->getResource("views/frame_code.html.php"),
            "env_details" => $this->getResource("views/env_details.html.php"),
 
            "title"          => $this->getPageTitle(),
            "name"           => explode("\\", $inspector->getExceptionName()),
            "message"        => $inspector->getException()->getMessage(),
            "code"           => $code,
            "plain_exception" => Formatter::formatExceptionPlain($inspector),
            "frames"         => $frames,
            "has_frames"     => !!count($frames),
            "handler"        => $this,
            "handlers"       => $this->getRun()->getHandlers(),
 
            "tables"      => array(
                "Server/Request Data"   => $_SERVER,
                "GET Data"              => $_GET,
                "POST Data"             => $_POST,
                "Files"                 => $_FILES,
                "Cookies"               => $_COOKIE,
                "Session"               => isset($_SESSION) ? $_SESSION :  array(),
                "Environment Variables" => $_ENV,
            ),
        );
 
        if (isset($customCssFile)) {
            $vars["stylesheet"] .= file_get_contents($customCssFile);
        }
 
        // Add extra entries list of data tables:
        // @todo: Consolidate addDataTable and addDataTableCallback
        $extraTables = array_map(function ($table) {
            return $table instanceof \Closure ? $table() : $table;
        }, $this->getDataTables());
        $vars["tables"] = array_merge($extraTables, $vars["tables"]);
 
        $helper->setVariables($vars);
        $helper->render($templateFile);
 
        return Handler::QUIT;
    }
 
    public function addDataTable($label, array $data)
    {
        $this->extraTables[$label] = $data;
    }
 
    public function addDataTableCallback($label, /* callable */ $callback)
    {
        if (!is_callable($callback)) {
            throw new InvalidArgumentException('Expecting callback argument to be callable');
        }
 
        $this->extraTables[$label] = function () use ($callback) {
            try {
                $result = call_user_func($callback);
 
                // Only return the result if it can be iterated over by foreach().
                return is_array($result) || $result instanceof \Traversable ? $result : array();
            } catch (\Exception $e) {
                // Don't allow failure to break the rendering of the original exception.
                return array();
            }
        };
    }
 
    public function getDataTables($label = null)
    {
        if ($label !== null) {
            return isset($this->extraTables[$label]) ?
                   $this->extraTables[$label] : array();
        }
 
        return $this->extraTables;
    }
 
    public function handleUnconditionally($value = null)
    {
        if (func_num_args() == 0) {
            return $this->handleUnconditionally;
        }
 
        $this->handleUnconditionally = (bool) $value;
    }
 
    public function addEditor($identifier, $resolver)
    {
        $this->editors[$identifier] = $resolver;
    }
 
    public function setEditor($editor)
    {
        if (!is_callable($editor) && !isset($this->editors[$editor])) {
            throw new InvalidArgumentException(
                "Unknown editor identifier: $editor. Known editors:" .
                implode(",", array_keys($this->editors))
            );
        }
 
        $this->editor = $editor;
    }
 
    public function getEditorHref($filePath, $line)
    {
        if ($this->editor === null) {
            return false;
        }
 
        $editor = $this->editor;
        if (is_string($editor)) {
            $editor = $this->editors[$editor];
        }
 
        if (is_callable($editor)) {
            $editor = call_user_func($editor, $filePath, $line);
        }
 
        // Check that the editor is a string, and replace the
        // %line and %file placeholders:
        if (!is_string($editor)) {
            throw new InvalidArgumentException(
                __METHOD__ . " should always resolve to a string; got something else instead"
            );
        }
 
        $editor = str_replace("%line", rawurlencode($line), $editor);
        $editor = str_replace("%file", rawurlencode($filePath), $editor);
 
        return $editor;
    }
 
    public function setPageTitle($title)
    {
        $this->pageTitle = (string) $title;
    }
 
    public function getPageTitle()
    {
        return $this->pageTitle;
    }
 
    public function addResourcePath($path)
    {
        if (!is_dir($path)) {
            throw new InvalidArgumentException(
                "'$path' is not a valid directory"
            );
        }
 
        array_unshift($this->searchPaths, $path);
    }
 
    public function addCustomCss($name)
    {
        $this->customCss = $name;
    }
 
    public function getResourcePaths()
    {
        return $this->searchPaths;
    }
 
    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: " . join(", ", $this->searchPaths). ")"
        );
    }
 
    public function getResourcesPath()
    {
        $allPaths = $this->getResourcePaths();
 
        // Compat: return only the first path added
        return end($allPaths) ?: null;
    }
 
    public function setResourcesPath($resourcesPath)
    {
        $this->addResourcePath($resourcesPath);
    }
}