Passed
Push — master ( 439edc...3c5346 )
by Alexander
09:35
created

HtmlRenderer::renderTemplate()   A

Complexity

Conditions 5
Paths 8

Size

Total Lines 24
Code Lines 16

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 12
CRAP Score 5.6359

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 5
dl 0
loc 24
ccs 12
cts 17
cp 0.7059
crap 5.6359
rs 9.4222
c 1
b 0
f 0
eloc 16
nc 8
nop 2
1
<?php
2
3
namespace Yiisoft\Yii\Web\ErrorHandler;
4
5
use Alexkart\CurlBuilder\Command;
6
use Yiisoft\Yii\Web\Info;
7
8
final class HtmlRenderer extends ThrowableRenderer
9
{
10
    private int $maxSourceLines = 19;
11
    private int $maxTraceLines = 13;
12
13
    private string $traceLine = '{html}';
14
15
    private string $defaultTemplatePath;
16
17
    private string $errorTemplate;
18
    private string $exceptionTemplate;
19
20
    private array $defaultTemplates;
21
22 5
    public function __construct(array $templates = [])
23
    {
24 5
        $this->defaultTemplatePath = $templates['path'];
25 5
        $this->defaultTemplates = $templates['default'];
26 5
        $this->errorTemplate = $templates['error'] ?? $this->defaultTemplatePath . '/error.php';
27 5
        $this->exceptionTemplate = $templates['exception'] ?? $this->defaultTemplatePath . '/exception.php';
28 5
    }
29
30
    public function withMaxSourceLines(int $maxSourceLines): self
31
    {
32
        $new = clone $this;
33
        $new->maxSourceLines = $maxSourceLines;
34
        return $new;
35
    }
36
37
    public function withMaxTraceLines(int $maxTraceLines): self
38
    {
39
        $new = clone $this;
40
        $new->maxTraceLines = $maxTraceLines;
41
        return $new;
42
    }
43
44
    public function withTraceLine(string $traceLine): self
45
    {
46
        $new = clone $this;
47
        $new->traceLine = $traceLine;
48
        return $new;
49
    }
50
51 3
    public function render(\Throwable $t): string
52
    {
53 3
        return $this->renderTemplate($this->errorTemplate, [
54 3
            'throwable' => $t,
55
        ]);
56
    }
57
58 2
    public function renderVerbose(\Throwable $t): string
59
    {
60 2
        return $this->renderTemplate($this->exceptionTemplate, [
61 2
            'throwable' => $t,
62
        ]);
63
    }
64
65 2
    private function htmlEncode(string $text): string
66
    {
67 2
        return htmlspecialchars($text, ENT_QUOTES, 'UTF-8');
68
    }
69
70 5
    private function renderTemplate(string $path, array $params): string
71
    {
72 5
        if (!file_exists($path)) {
73 1
            throw new \RuntimeException("Template not found at $path");
74
        }
75
76 4
        $renderer = function (): void {
77 4
            extract(func_get_arg(1), EXTR_OVERWRITE);
78 4
            require func_get_arg(0);
79 4
        };
80
81 4
        $obInitialLevel = ob_get_level();
82 4
        ob_start();
83 4
        ob_implicit_flush(0);
84
        try {
85 4
            $renderer->bindTo($this)($path, $params);
86 4
            return ob_get_clean();
87
        } catch (\Throwable $e) {
88
            while (ob_get_level() > $obInitialLevel) {
89
                if (!@ob_end_clean()) {
90
                    ob_clean();
91
                }
92
            }
93
            throw $e;
94
        }
95
    }
96
97
    /**
98
     * Renders the previous exception stack for a given Exception.
99
     * @param \Throwable $t the exception whose precursors should be rendered.
100
     * @return string HTML content of the rendered previous exceptions.
101
     * Empty string if there are none.
102
     * @throws \Throwable
103
     */
104 1
    private function renderPreviousExceptions(\Throwable $t): string
0 ignored issues
show
Unused Code introduced by
The method renderPreviousExceptions() is not used, and could be removed.

This check looks for private methods that have been defined, but are not used inside the class.

Loading history...
105
    {
106 1
        if (($previous = $t->getPrevious()) !== null) {
107
            $templatePath = $this->defaultTemplatePath . '/previousException.php';
108
            return $this->renderTemplate($templatePath, ['throwable' => $previous]);
109
        }
110 1
        return '';
111
    }
112
113
    /**
114
     * Renders a single call stack element.
115
     * @param string|null $file name where call has happened.
116
     * @param int|null $line number on which call has happened.
117
     * @param string|null $class called class name.
118
     * @param string|null $method called function/method name.
119
     * @param array $args array of method arguments.
120
     * @param int $index number of the call stack element.
121
     * @return string HTML content of the rendered call stack element.
122
     * @throws \Throwable
123
     */
124 1
    private function renderCallStackItem(?string $file, ?int $line, ?string $class, ?string $method, array $args, int $index): string
125
    {
126 1
        $lines = [];
127 1
        $begin = $end = 0;
128 1
        if ($file !== null && $line !== null) {
129 1
            $line--; // adjust line number from one-based to zero-based
130 1
            $lines = @file($file);
131 1
            if ($line < 0 || $lines === false || ($lineCount = count($lines)) < $line) {
132
                return '';
133
            }
134 1
            $half = (int)(($index === 1 ? $this->maxSourceLines : $this->maxTraceLines) / 2);
135 1
            $begin = $line - $half > 0 ? $line - $half : 0;
136 1
            $end = $line + $half < $lineCount ? $line + $half : $lineCount - 1;
137
        }
138 1
        $templatePath = $this->defaultTemplatePath . '/callStackItem.php';
139 1
        return $this->renderTemplate($templatePath, [
140 1
            'file' => $file,
141 1
            'line' => $line,
142 1
            'class' => $class,
143 1
            'method' => $method,
144 1
            'index' => $index,
145 1
            'lines' => $lines,
146 1
            'begin' => $begin,
147 1
            'end' => $end,
148 1
            'args' => $args,
149
        ]);
150
    }
151
152
    /**
153
     * Renders call stack.
154
     * @param \Throwable $t exception to get call stack from
155
     * @return string HTML content of the rendered call stack.
156
     * @throws \Throwable
157
     */
158 1
    private function renderCallStack(\Throwable $t): string
0 ignored issues
show
Unused Code introduced by
The method renderCallStack() is not used, and could be removed.

This check looks for private methods that have been defined, but are not used inside the class.

Loading history...
159
    {
160 1
        $out = '<ul>';
161 1
        $out .= $this->renderCallStackItem($t->getFile(), $t->getLine(), null, null, [], 1);
162 1
        for ($i = 0, $trace = $t->getTrace(), $length = count($trace); $i < $length; ++$i) {
163 1
            $file = !empty($trace[$i]['file']) ? $trace[$i]['file'] : null;
164 1
            $line = !empty($trace[$i]['line']) ? $trace[$i]['line'] : null;
165 1
            $class = !empty($trace[$i]['class']) ? $trace[$i]['class'] : null;
166 1
            $function = null;
167 1
            if (!empty($trace[$i]['function']) && $trace[$i]['function'] !== 'unknown') {
168 1
                $function = $trace[$i]['function'];
169
            }
170 1
            $args = !empty($trace[$i]['args']) ? $trace[$i]['args'] : [];
171 1
            $out .= $this->renderCallStackItem($file, $line, $class, $function, $args, $i + 2);
172
        }
173 1
        $out .= '</ul>';
174 1
        return $out;
175
    }
176
177
    /**
178
     * Determines whether given name of the file belongs to the framework.
179
     * @param string $file name to be checked.
180
     * @return bool whether given name of the file belongs to the framework.
181
     */
182 1
    private function isCoreFile(?string $file): bool
0 ignored issues
show
Unused Code introduced by
The method isCoreFile() is not used, and could be removed.

This check looks for private methods that have been defined, but are not used inside the class.

Loading history...
183
    {
184 1
        return $file === null || strpos(realpath($file), Info::frameworkPath() . DIRECTORY_SEPARATOR) === 0;
185
    }
186
187
    /**
188
     * Adds informational links to the given PHP type/class.
189
     * @param string $code type/class name to be linkified.
190
     * @param string $title custom title to use
191
     * @return string linkified with HTML type/class name.
192
     * @throws \ReflectionException
193
     */
194 1
    private function addTypeLinks(string $code, string $title = null): string
0 ignored issues
show
Unused Code introduced by
The method addTypeLinks() is not used, and could be removed.

This check looks for private methods that have been defined, but are not used inside the class.

Loading history...
195
    {
196 1
        if (preg_match('/(.*?)::([^(]+)/', $code, $matches)) {
197 1
            [, $class, $method] = $matches;
198 1
            $text = $title ? $this->htmlEncode($title) : $this->htmlEncode($class) . '::' . $this->htmlEncode($method);
199
        } else {
200 1
            $class = $code;
201 1
            $method = null;
202 1
            $text = $title ? $this->htmlEncode($title) : $this->htmlEncode($class);
203
        }
204 1
        $url = null;
205 1
        $shouldGenerateLink = true;
206 1
        if ($method !== null && substr_compare($method, '{closure}', -9) !== 0) {
207 1
            $reflection = new \ReflectionClass($class);
208 1
            if ($reflection->hasMethod($method)) {
209 1
                $reflectionMethod = $reflection->getMethod($method);
210 1
                $shouldGenerateLink = $reflectionMethod->isPublic() || $reflectionMethod->isProtected();
211
            } else {
212
                $shouldGenerateLink = false;
213
            }
214
        }
215 1
        if ($shouldGenerateLink) {
216 1
            $url = $this->getTypeUrl($class, $method);
217
        }
218 1
        if ($url === null) {
219 1
            return $text;
220
        }
221 1
        return '<a href="' . $url . '" target="_blank">' . $text . '</a>';
222
    }
223
224
    /**
225
     * Returns the informational link URL for a given PHP type/class.
226
     * @param string $class the type or class name.
227
     * @param string|null $method the method name.
228
     * @return string|null the informational link URL.
229
     * @see addTypeLinks()
230
     */
231 1
    private function getTypeUrl(?string $class, ?string $method): ?string
232
    {
233 1
        if (strncmp($class, 'Yiisoft\\', 8) !== 0) {
234 1
            return null;
235
        }
236 1
        $page = $this->htmlEncode(strtolower(str_replace('\\', '-', $class)));
237 1
        $url = "http://www.yiiframework.com/doc-3.0/$page.html";
238 1
        if ($method) {
239 1
            $url .= "#$method()-detail";
240
        }
241 1
        return $url;
242
    }
243
244
    /**
245
     * Converts arguments array to its string representation.
246
     *
247
     * @param array $args arguments array to be converted
248
     * @return string string representation of the arguments array
249
     */
250 1
    private function argumentsToString(array $args): string
251
    {
252 1
        $count = 0;
253 1
        $isAssoc = $args !== array_values($args);
254 1
        foreach ($args as $key => $value) {
255
            $count++;
256
            if ($count >= 5) {
257
                if ($count > 5) {
258
                    unset($args[$key]);
259
                } else {
260
                    $args[$key] = '...';
261
                }
262
                continue;
263
            }
264
            if (is_object($value)) {
265
                $args[$key] = '<span class="title">' . $this->htmlEncode(get_class($value)) . '</span>';
266
            } elseif (is_bool($value)) {
267
                $args[$key] = '<span class="keyword">' . ($value ? 'true' : 'false') . '</span>';
268
            } elseif (is_string($value)) {
269
                $fullValue = $this->htmlEncode($value);
270
                if (mb_strlen($value, 'UTF-8') > 32) {
271
                    $displayValue = $this->htmlEncode(mb_substr($value, 0, 32, 'UTF-8')) . '...';
272
                    $args[$key] = "<span class=\"string\" title=\"$fullValue\">'$displayValue'</span>";
273
                } else {
274
                    $args[$key] = "<span class=\"string\">'$fullValue'</span>";
275
                }
276
            } elseif (is_array($value)) {
277
                $args[$key] = '[' . $this->argumentsToString($value) . ']';
278
            } elseif ($value === null) {
279
                $args[$key] = '<span class="keyword">null</span>';
280
            } elseif (is_resource($value)) {
281
                $args[$key] = '<span class="keyword">resource</span>';
282
            } else {
283
                $args[$key] = '<span class="number">' . $value . '</span>';
284
            }
285
            if (is_string($key)) {
286
                $args[$key] = '<span class="string">\'' . $this->htmlEncode($key) . "'</span> => $args[$key]";
287
            } elseif ($isAssoc) {
288
                $args[$key] = "<span class=\"number\">$key</span> => $args[$key]";
289
            }
290
        }
291 1
        return implode(', ', $args);
292
    }
293
294
    /**
295
     * Renders the information about request.
296
     * @return string the rendering result
297
     */
298 1
    private function renderRequest(): string
0 ignored issues
show
Unused Code introduced by
The method renderRequest() is not used, and could be removed.

This check looks for private methods that have been defined, but are not used inside the class.

Loading history...
299
    {
300 1
        if ($this->request === null) {
301
            return '';
302
        }
303
304 1
        $request = $this->request;
305 1
        $output = $request->getMethod() . ' ' . $request->getUri() . "\n";
306
307 1
        foreach ($request->getHeaders() as $name => $values) {
308 1
            if ($name === 'Host') {
309
                continue;
310
            }
311
312 1
            foreach ($values as $value) {
313 1
                $output .= "$name: $value\n";
314
            }
315
        }
316
317 1
        $output .= "\n" . $request->getBody() . "\n\n";
318
319 1
        return '<pre>' . $this->htmlEncode(rtrim($output, "\n")) . '</pre>';
320
    }
321
322 1
    private function renderCurl(): string
0 ignored issues
show
Unused Code introduced by
The method renderCurl() is not used, and could be removed.

This check looks for private methods that have been defined, but are not used inside the class.

Loading history...
323
    {
324
        try {
325 1
            $output = (new Command())->setRequest($this->request)->build();
326
        } catch (\Throwable $e) {
327
            $output = 'Error generating curl command: ' . $e->getMessage();
328
        }
329
330 1
        return $this->htmlEncode($output);
331
    }
332
333
334
    /**
335
     * Creates string containing HTML link which refers to the home page of determined web-server software
336
     * and its full name.
337
     * @return string server software information hyperlink.
338
     */
339 1
    private function createServerInformationLink(): string
0 ignored issues
show
Unused Code introduced by
The method createServerInformationLink() is not used, and could be removed.

This check looks for private methods that have been defined, but are not used inside the class.

Loading history...
340
    {
341 1
        if (isset($_SERVER['SERVER_SOFTWARE'])) {
342
            $serverUrls = [
343
                'http://httpd.apache.org/' => ['apache'],
344
                'http://nginx.org/' => ['nginx'],
345
                'http://lighttpd.net/' => ['lighttpd'],
346
                'http://gwan.com/' => ['g-wan', 'gwan'],
347
                'http://iis.net/' => ['iis', 'services'],
348
                'https://secure.php.net/manual/en/features.commandline.webserver.php' => ['development'],
349
            ];
350
351
            foreach ($serverUrls as $url => $keywords) {
352
                foreach ($keywords as $keyword) {
353
                    if (stripos($_SERVER['SERVER_SOFTWARE'], $keyword) !== false) {
354
                        return '<a href="' . $url . '" target="_blank">' . $this->htmlEncode($_SERVER['SERVER_SOFTWARE']) . '</a>';
355
                    }
356
                }
357
            }
358
        }
359 1
        return '';
360
    }
361
362
    /**
363
     * Creates string containing HTML link which refers to the page with the current version
364
     * of the framework and version number text.
365
     * @return string framework version information hyperlink.
366
     */
367 1
    public function createFrameworkVersionLink(): string
368
    {
369 1
        return '<a href="http://github.com/yiisoft/yii-web/" target="_blank">' . $this->htmlEncode(Info::frameworkVersion()) . '</a>';
370
    }
371
}
372