1210055114

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/codeigniter4/CodeIgniter4/commit/<a class=hub.com/codeigniter4/CodeIgniter4/commit/<a class="double-link" href="https://git"><a class=hub.com/codeigniter4/CodeIgniter4/commit/<a class="double-link" href="https://git"><a class=hub.com/codeigniter4/CodeIgniter4/commit/<a class="double-link" href="https://git"><a class=hub.com/codeigniter4/CodeIgniter4/commit/7f376c2fa3d93872d2652f35befbee6ad3038fc5">7f376c2fa">&lt;a href=&quot;https://github.com/codeigniter4/CodeIgniter4/commit/</a><a class="double-link" href="https://github.com/codeigniter4/CodeIgniter4/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/codeigniter4/CodeIgniter4/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/codeigniter4/CodeIgniter4/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/codeigniter4/CodeIgniter4/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/codeigniter4/CodeIgniter4/commit/7f376c2fa3d93872d2652f35befbee6ad3038fc5">7f376c2fa</a><a href="https://github.com/codeigniter4/CodeIgniter4/commit/7f376c2fa3d93872d2652f35befbee6ad3038fc5">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/codeigniter4/CodeIgniter4/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/codeigniter4/CodeIgniter4/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/CodeIgniter4/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/CodeIgniter4/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/CodeIgniter4/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/CodeIgniter4/commit/7f376c2fa3d93872d2652f35befbee6ad3038fc5&quot;&gt;7f376c2fa&lt;/a&gt;&lt;a href=&quot;https://github.com/codeigniter4/CodeIgniter4/commit/7f376c2fa3d93872d2652f35befbee6ad3038fc5&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/codeigniter4/CodeIgniter4/commit/&amp;lt;/a&... (continued)

Pull Request Pull Request #5060: Merge branch '4.2'

Run Details

362 of 421 new or added lines in 30 files covered. (85.99%)

13688 of 16302 relevant lines covered (83.97%)

732.67 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

3.66

/system/Debug/Toolbar.php

<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Debug;

use CodeIgniter\CodeIgniter;
use CodeIgniter\Debug\Toolbar\Collectors\BaseCollector;
use CodeIgniter\Debug\Toolbar\Collectors\Config;
use CodeIgniter\Debug\Toolbar\Collectors\History;
use CodeIgniter\Format\JSONFormatter;
use CodeIgniter\Format\XMLFormatter;
use CodeIgniter\HTTP\DownloadResponse;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Config\Toolbar as ToolbarConfig;
use Kint\Kint;

/**
 * Displays a toolbar with bits of stats to aid a developer in debugging.
 *
 * Inspiration: http://prophiler.fabfuel.de
 */
class Toolbar
{
    /**
     * Toolbar configuration settings.
     *
     * @var ToolbarConfig
     */
    protected $config;

    /**
     * Collectors to be used and displayed.
     *
     * @var BaseCollector[]
     */
    protected $collectors = [];

    public function __construct(ToolbarConfig $config)
    {
        $this->config = $config;

        foreach ($config->collectors as $collector) {
            if (! class_exists($collector)) {
                log_message('critical', 'Toolbar collector does not exists(' . $collector . ').' .
                        'please check $collectors in the Config\Toolbar.php file.');

                continue;
            }

            $this->collectors[] = new $collector();
        }
    }

    /**
     * Returns all the data required by Debug Bar
     *
     * @param float           $startTime App start time
     * @param IncomingRequest $request
     * @param Response        $response
     *
     * @return string JSON encoded data
     */
    public function run(float $startTime, float $totalTime, RequestInterface $request, ResponseInterface $response): string
    {
        // Data items used within the view.
        $data['url']             = current_url();
        $data['method']          = $request->getMethod(true);
        $data['isAJAX']          = $request->isAJAX();
        $data['startTime']       = $startTime;
        $data['totalTime']       = $totalTime * 1000;
        $data['totalMemory']     = number_format((memory_get_peak_usage()) / 1024 / 1024, 3);
        $data['segmentDuration'] = $this->roundTo($data['totalTime'] / 7);
        $data['segmentCount']    = (int) ceil($data['totalTime'] / $data['segmentDuration']);
        $data['CI_VERSION']      = CodeIgniter::CI_VERSION;
        $data['collectors']      = [];

        foreach ($this->collectors as $collector) {
            $data['collectors'][] = $collector->getAsArray();
        }

        foreach ($this->collectVarData() as $heading => $items) {
            $varData = [];

            if (is_array($items)) {
                foreach ($items as $key => $value) {
                    if (is_string($value)) {
                        $varData[esc($key)] = esc($value);
                    } else {
                        $oldKintMode       = Kint::$mode_default;
                        $oldKintCalledFrom = Kint::$display_called_from;

                        Kint::$mode_default        = Kint::MODE_RICH;
                        Kint::$display_called_from = false;

                        $kint = @Kint::dump($value);
                        $kint = substr($kint, strpos($kint, '</style>') + 8);

                        Kint::$mode_default        = $oldKintMode;
                        Kint::$display_called_from = $oldKintCalledFrom;

                        $varData[esc($key)] = $kint;
                    }
                }
            }

            $data['vars']['varData'][esc($heading)] = $varData;
        }

        if (! empty($_SESSION)) {
            foreach ($_SESSION as $key => $value) {
                // Replace the binary data with string to avoid json_encode failure.
                if (is_string($value) && preg_match('~[^\x20-\x7E\t\r\n]~', $value)) {
                    $value = 'binary data';
                }

                $data['vars']['session'][esc($key)] = is_string($value) ? esc($value) : '<pre>' . esc(print_r($value, true)) . '</pre>';
            }
        }

        foreach ($request->getGet() as $name => $value) {
            $data['vars']['get'][esc($name)] = is_array($value) ? '<pre>' . esc(print_r($value, true)) . '</pre>' : esc($value);
        }

        foreach ($request->getPost() as $name => $value) {
            $data['vars']['post'][esc($name)] = is_array($value) ? '<pre>' . esc(print_r($value, true)) . '</pre>' : esc($value);
        }

        foreach ($request->headers() as $header) {
            $data['vars']['headers'][esc($header->getName())] = esc($header->getValueLine());
        }

        foreach ($request->getCookie() as $name => $value) {
            $data['vars']['cookies'][esc($name)] = esc($value);
        }

        $data['vars']['request'] = ($request->isSecure() ? 'HTTPS' : 'HTTP') . '/' . $request->getProtocolVersion();

        $data['vars']['response'] = [
            'statusCode'  => $response->getStatusCode(),
            'reason'      => esc($response->getReasonPhrase()),
            'contentType' => esc($response->getHeaderLine('content-type')),
        ];

        $data['config'] = Config::display();

        if ($response->CSP !== null) {
            $response->CSP->addImageSrc('data:');
        }

        return json_encode($data);
    }

    /**
     * Called within the view to display the timeline itself.
     */
    protected function renderTimeline(array $collectors, float $startTime, int $segmentCount, int $segmentDuration, array &$styles): string
    {
        $rows       = $this->collectTimelineData($collectors);
        $output     = '';
        $styleCount = 0;

        // Use recursive render function
        return $this->renderTimelineRecursive($rows, $startTime, $segmentCount, $segmentDuration, $styles, $styleCount);
    }

    /**
     * Recursively renders timeline elements and their children.
     */
    protected function renderTimelineRecursive(array $rows, float $startTime, int $segmentCount, int $segmentDuration, array &$styles, int &$styleCount, int $level = 0, bool $isChild = false): string
    {
        $displayTime = $segmentCount * $segmentDuration;

        $output = '';

        foreach ($rows as $row) {
            $hasChildren = isset($row['children']) && ! empty($row['children']);

            $open = $row['name'] === 'Controller';

            if ($hasChildren) {
                $output .= '<tr class="timeline-parent' . ($open ? ' timeline-parent-open' : '') . '" id="timeline-' . $styleCount . '_parent" onclick="ciDebugBar.toggleChildRows(\'timeline-' . $styleCount . '\');">';
            } else {
                $output .= '<tr>';
            }

            $output .= '<td class="' . ($isChild ? 'debug-bar-width30' : '') . '" style="--level: ' . $level . ';">' . ($hasChildren ? '<nav></nav>' : '') . $row['name'] . '</td>';
            $output .= '<td class="' . ($isChild ? 'debug-bar-width10' : '') . '">' . $row['component'] . '</td>';
            $output .= '<td class="' . ($isChild ? 'debug-bar-width10 ' : '') . 'debug-bar-alignRight">' . number_format($row['duration'] * 1000, 2) . ' ms</td>';
            $output .= "<td class='debug-bar-noverflow' colspan='{$segmentCount}'>";

            $offset = ((((float) $row['start'] - $startTime) * 1000) / $displayTime) * 100;
            $length = (((float) $row['duration'] * 1000) / $displayTime) * 100;

            $styles['debug-bar-timeline-' . $styleCount] = "left: {$offset}%; width: {$length}%;";

            $output .= "<span class='timer debug-bar-timeline-{$styleCount}' title='" . number_format($length, 2) . "%'></span>";
            $output .= '</td>';
            $output .= '</tr>';

            $styleCount++;

            // Add children if any
            if ($hasChildren) {
                $output .= '<tr class="child-row" id="timeline-' . ($styleCount - 1) . '_children" style="' . ($open ? '' : 'display: none;') . '">';
                $output .= '<td colspan="' . ($segmentCount + 3) . '" class="child-container">';
                $output .= '<table class="timeline">';
                $output .= '<tbody>';
                $output .= $this->renderTimelineRecursive($row['children'], $startTime, $segmentCount, $segmentDuration, $styles, $styleCount, $level + 1, true);
                $output .= '</tbody>';
                $output .= '</table>';
                $output .= '</td>';
                $output .= '</tr>';
            }
        }

        return $output;
    }

    /**
     * Returns a sorted array of timeline data arrays from the collectors.
     *
     * @param array $collectors
     */
    protected function collectTimelineData($collectors): array
    {
        $data = [];

        // Collect it
        foreach ($collectors as $collector) {
            if (! $collector['hasTimelineData']) {
                continue;
            }

            $data = array_merge($data, $collector['timelineData']);
        }

        // Sort it
        $sortArray = [
            array_column($data, 'start'), SORT_NUMERIC, SORT_ASC,
            array_column($data, 'duration'), SORT_NUMERIC, SORT_DESC,
            &$data,
        ];

        array_multisort(...$sortArray);

        // Add end time to each element
        array_walk($data, static function (&$row) {
            $row['end'] = $row['start'] + $row['duration'];
        });

        // Group it
        $data = $this->structureTimelineData($data);

        return $data;
    }

    /**
     * Arranges the already sorted timeline data into a parent => child structure.
     */
    protected function structureTimelineData(array $elements): array
    {
        // We define ourselves as the first element of the array
        $element = array_shift($elements);

        // If we have children behind us, collect and attach them to us
        while (! empty($elements) && $elements[array_key_first($elements)]['end'] <= $element['end']) {
            $element['children'][] = array_shift($elements);
        }

        // Make sure our children know whether they have children, too
        if (isset($element['children'])) {
            $element['children'] = $this->structureTimelineData($element['children']);
        }

        // If we have no younger siblings, we can return
        if (empty($elements)) {
            return [$element];
        }

        // Make sure our younger siblings know their relatives, too
        return array_merge([$element], $this->structureTimelineData($elements));
    }

    /**
     * Returns an array of data from all of the modules
     * that should be displayed in the 'Vars' tab.
     */
    protected function collectVarData(): array
    {
        $data = [];

        foreach ($this->collectors as $collector) {
            if (! $collector->hasVarData()) {
                continue;
            }

            $data = array_merge($data, $collector->getVarData());
        }

        return $data;
    }

    /**
     * Rounds a number to the nearest incremental value.
     */
    protected function roundTo(float $number, int $increments = 5): float
    {
        $increments = 1 / $increments;

        return ceil($number * $increments) / $increments;
    }

    /**
     * Prepare for debugging..
     *
     * @param RequestInterface  $request
     * @param ResponseInterface $response
     *
     * @global \CodeIgniter\CodeIgniter $app
     */
    public function prepare(?RequestInterface $request = null, ?ResponseInterface $response = null)
    {
        /**
         * @var IncomingRequest $request
         * @var Response        $response
         */
        if (CI_DEBUG && ! is_cli()) {
            global $app;

            $request  = $request ?? Services::request();
            $response = $response ?? Services::response();

            // Disable the toolbar for downloads
            if ($response instanceof DownloadResponse) {
                return;
            }

            $toolbar = Services::toolbar(config(self::class));
            $stats   = $app->getPerformanceStats();
            $data    = $toolbar->run(
                $stats['startTime'],
                $stats['totalTime'],
                $request,
                $response
            );

            helper('filesystem');

            // Updated to time() so we can get history
            $time = time();

            if (! is_dir(WRITEPATH . 'debugbar')) {
                mkdir(WRITEPATH . 'debugbar', 0777);
            }

            write_file(WRITEPATH . 'debugbar/' . 'debugbar_' . $time . '.json', $data, 'w+');

            $format = $response->getHeaderLine('content-type');

            // Non-HTML formats should not include the debugbar
            // then we send headers saying where to find the debug data
            // for this response
            if ($request->isAJAX() || strpos($format, 'html') === false) {
                $response->setHeader('Debugbar-Time', "{$time}")
                    ->setHeader('Debugbar-Link', site_url("?debugbar_time={$time}"))
                    ->getBody();

                return;
            }

            $oldKintMode        = Kint::$mode_default;
            Kint::$mode_default = Kint::MODE_RICH;
            $kintScript         = @Kint::dump('');
            Kint::$mode_default = $oldKintMode;
            $kintScript         = substr($kintScript, 0, strpos($kintScript, '</style>') + 8);

            $script = PHP_EOL
                . '<script type="text/javascript" {csp-script-nonce} id="debugbar_loader" '
                . 'data-time="' . $time . '" '
                . 'src="' . site_url() . '?debugbar"></script>'
                . '<script type="text/javascript" {csp-script-nonce} id="debugbar_dynamic_script"></script>'
                . '<style type="text/css" {csp-style-nonce} id="debugbar_dynamic_style"></style>'
                . $kintScript
                . PHP_EOL;

            if (strpos($response->getBody(), '<head>') !== false) {
                $response->setBody(preg_replace('/<head>/', '<head>' . $script, $response->getBody(), 1));

                return;
            }

            $response->appendBody($script);
        }
    }

    /**
     * Inject debug toolbar into the response.
     */
    public function respond()
    {
        if (ENVIRONMENT === 'testing') {
            return;
        }

        // @codeCoverageIgnoreStart
        $request = Services::request();

        // If the request contains '?debugbar then we're
        // simply returning the loading script
        if ($request->getGet('debugbar') !== null) {
            // Let the browser know that we are sending javascript
            header('Content-Type: application/javascript');

            ob_start();
            include $this->config->viewsPath . 'toolbarloader.js.php';
            $output = ob_get_clean();

            exit($output);
        }

        // Otherwise, if it includes ?debugbar_time, then
        // we should return the entire debugbar.
        if ($request->getGet('debugbar_time')) {
            helper('security');

            // Negotiate the content-type to format the output
            $format = $request->negotiate('media', [
                'text/html',
                'application/json',
                'application/xml',
            ]);
            $format = explode('/', $format)[1];

            $file     = sanitize_filename('debugbar_' . $request->getGet('debugbar_time'));
            $filename = WRITEPATH . 'debugbar/' . $file . '.json';

            // Show the toolbar
            if (is_file($filename)) {
                $contents = $this->format(file_get_contents($filename), $format);

                exit($contents);
            }

            // File was not written or do not exists
            http_response_code(404);

            exit; // Exit here is needed to avoid load the index page
        }
        // @codeCoverageIgnoreEnd
    }

    /**
     * Format output
     */
    protected function format(string $data, string $format = 'html'): string
    {
        $data = json_decode($data, true);

        if ($this->config->maxHistory !== 0) {
            $history = new History();
            $history->setFiles(
                (int) Services::request()->getGet('debugbar_time'),
                $this->config->maxHistory
            );

            $data['collectors'][] = $history->getAsArray();
        }

        $output = '';

        switch ($format) {
            case 'html':
                $data['styles'] = [];
                extract($data);
                $parser = Services::parser($this->config->viewsPath, null, false);
                ob_start();
                include $this->config->viewsPath . 'toolbar.tpl.php';
                $output = ob_get_clean();
                break;

            case 'json':
                $formatter = new JSONFormatter();
                $output    = $formatter->format($data);
                break;

            case 'xml':
                $formatter = new XMLFormatter();
                $output    = $formatter->format($data);
                break;
        }

        return $output;
    }
}

1	<?php
2
3	/**
4	* This file is part of CodeIgniter 4 framework.
5	*
6	* (c) CodeIgniter Foundation <admin@codeigniter.com>
7	*
8	* For the full copyright and license information, please view
9	* the LICENSE file that was distributed with this source code.
10	*/
11
12	namespace CodeIgniter\Debug;
13
14	use CodeIgniter\CodeIgniter;
15	use CodeIgniter\Debug\Toolbar\Collectors\BaseCollector;
16	use CodeIgniter\Debug\Toolbar\Collectors\Config;
17	use CodeIgniter\Debug\Toolbar\Collectors\History;
18	use CodeIgniter\Format\JSONFormatter;
19	use CodeIgniter\Format\XMLFormatter;
20	use CodeIgniter\HTTP\DownloadResponse;
21	use CodeIgniter\HTTP\IncomingRequest;
22	use CodeIgniter\HTTP\RequestInterface;
23	use CodeIgniter\HTTP\Response;
24	use CodeIgniter\HTTP\ResponseInterface;
25	use Config\Services;
26	use Config\Toolbar as ToolbarConfig;
27	use Kint\Kint;
28
29	/**
30	* Displays a toolbar with bits of stats to aid a developer in debugging.
31	*
32	* Inspiration: http://prophiler.fabfuel.de
33	*/
34	class Toolbar
35	{
36	/**
37	* Toolbar configuration settings.
38	*
39	* @var ToolbarConfig
40	*/
41	protected $config;
42
43	/**
44	* Collectors to be used and displayed.
45	*
46	* @var BaseCollector[]
47	*/
48	protected $collectors = [];
49
50	public function __construct(ToolbarConfig $config)
51	{
52	$this->config = $config;	245✔
53
54	foreach ($config->collectors as $collector) {	245✔
55	if (! class_exists($collector)) {	245✔
56	log_message('critical', 'Toolbar collector does not exists(' . $collector . ').' .	×
57	'please check $collectors in the Config\Toolbar.php file.');	×
58
59	continue;	×
60	}
61
62	$this->collectors[] = new $collector();	245✔
63	}
64	}	245✔
65
66	/**
67	* Returns all the data required by Debug Bar
68	*
69	* @param float $startTime App start time
70	* @param IncomingRequest $request
71	* @param Response $response
72	*
73	* @return string JSON encoded data
74	*/
75	public function run(float $startTime, float $totalTime, RequestInterface $request, ResponseInterface $response): string
76	{
77	// Data items used within the view.
78	$data['url'] = current_url();	×
79	$data['method'] = $request->getMethod(true);	×
80	$data['isAJAX'] = $request->isAJAX();	×
81	$data['startTime'] = $startTime;	×
82	$data['totalTime'] = $totalTime * 1000;	×
83	$data['totalMemory'] = number_format((memory_get_peak_usage()) / 1024 / 1024, 3);	×
84	$data['segmentDuration'] = $this->roundTo($data['totalTime'] / 7);	×
85	$data['segmentCount'] = (int) ceil($data['totalTime'] / $data['segmentDuration']);	×
86	$data['CI_VERSION'] = CodeIgniter::CI_VERSION;	×
87	$data['collectors'] = [];	×
88
89	foreach ($this->collectors as $collector) {	×
90	$data['collectors'][] = $collector->getAsArray();	×
91	}
92
93	foreach ($this->collectVarData() as $heading => $items) {	×
94	$varData = [];	×
95
96	if (is_array($items)) {	×
97	foreach ($items as $key => $value) {	×
98	if (is_string($value)) {	×
99	$varData[esc($key)] = esc($value);	×
100	} else {
101	$oldKintMode = Kint::$mode_default;	×
102	$oldKintCalledFrom = Kint::$display_called_from;	×
103
104	Kint::$mode_default = Kint::MODE_RICH;	×
105	Kint::$display_called_from = false;	×
106
107	$kint = @Kint::dump($value);	×
108	$kint = substr($kint, strpos($kint, '</style>') + 8);	×
109
110	Kint::$mode_default = $oldKintMode;	×
111	Kint::$display_called_from = $oldKintCalledFrom;	×
112
113	$varData[esc($key)] = $kint;	×
114	}
115	}
116	}
117
118	$data['vars']['varData'][esc($heading)] = $varData;	×
119	}
120
121	if (! empty($_SESSION)) {	×
122	foreach ($_SESSION as $key => $value) {	×
123	// Replace the binary data with string to avoid json_encode failure.
124	if (is_string($value) && preg_match('~[^\x20-\x7E\t\r\n]~', $value)) {	×
125	$value = 'binary data';	×
126	}
127
128	$data['vars']['session'][esc($key)] = is_string($value) ? esc($value) : '<pre>' . esc(print_r($value, true)) . '</pre>';	×
129	}
130	}
131
132	foreach ($request->getGet() as $name => $value) {	×
133	$data['vars']['get'][esc($name)] = is_array($value) ? '<pre>' . esc(print_r($value, true)) . '</pre>' : esc($value);	×
134	}
135
136	foreach ($request->getPost() as $name => $value) {	×
137	$data['vars']['post'][esc($name)] = is_array($value) ? '<pre>' . esc(print_r($value, true)) . '</pre>' : esc($value);	×
138	}
139
140	foreach ($request->headers() as $header) {	×
141	$data['vars']['headers'][esc($header->getName())] = esc($header->getValueLine());	×
142	}
143
144	foreach ($request->getCookie() as $name => $value) {	×
145	$data['vars']['cookies'][esc($name)] = esc($value);	×
146	}
147
148	$data['vars']['request'] = ($request->isSecure() ? 'HTTPS' : 'HTTP') . '/' . $request->getProtocolVersion();	×
149
150	$data['vars']['response'] = [	×
151	'statusCode' => $response->getStatusCode(),	×
NEW 152	'reason' => esc($response->getReasonPhrase()),	×
153	'contentType' => esc($response->getHeaderLine('content-type')),	×
154	];
155
156	$data['config'] = Config::display();	×
157
158	if ($response->CSP !== null) {	×
159	$response->CSP->addImageSrc('data:');	×
160	}
161
162	return json_encode($data);	×
163	}
164
165	/**
166	* Called within the view to display the timeline itself.
167	*/
168	protected function renderTimeline(array $collectors, float $startTime, int $segmentCount, int $segmentDuration, array &$styles): string
169	{
NEW 170	$rows = $this->collectTimelineData($collectors);	×
NEW 171	$output = '';	×
NEW 172	$styleCount = 0;	×
173
174	// Use recursive render function
NEW 175	return $this->renderTimelineRecursive($rows, $startTime, $segmentCount, $segmentDuration, $styles, $styleCount);	×
176	}
177
178	/**
179	* Recursively renders timeline elements and their children.
180	*/
181	protected function renderTimelineRecursive(array $rows, float $startTime, int $segmentCount, int $segmentDuration, array &$styles, int &$styleCount, int $level = 0, bool $isChild = false): string
182	{
183	$displayTime = $segmentCount * $segmentDuration;	×
184
NEW 185	$output = '';	×
186
187	foreach ($rows as $row) {	×
NEW 188	$hasChildren = isset($row['children']) && ! empty($row['children']);	×
189
NEW 190	$open = $row['name'] === 'Controller';	×
191
NEW 192	if ($hasChildren) {	×
NEW 193	$output .= '<tr class="timeline-parent' . ($open ? ' timeline-parent-open' : '') . '" id="timeline-' . $styleCount . '_parent" onclick="ciDebugBar.toggleChildRows(\'timeline-' . $styleCount . '\');">';	×
194	} else {
NEW 195	$output .= '<tr>';	×
196	}
197
NEW 198	$output .= '<td class="' . ($isChild ? 'debug-bar-width30' : '') . '" style="--level: ' . $level . ';">' . ($hasChildren ? '<nav></nav>' : '') . $row['name'] . '</td>';	×
NEW 199	$output .= '<td class="' . ($isChild ? 'debug-bar-width10' : '') . '">' . $row['component'] . '</td>';	×
NEW 200	$output .= '<td class="' . ($isChild ? 'debug-bar-width10 ' : '') . 'debug-bar-alignRight">' . number_format($row['duration'] * 1000, 2) . ' ms</td>';	×
201	$output .= "<td class='debug-bar-noverflow' colspan='{$segmentCount}'>";	×
202
203	$offset = ((((float) $row['start'] - $startTime) * 1000) / $displayTime) * 100;	×
204	$length = (((float) $row['duration'] * 1000) / $displayTime) * 100;	×
205
206	$styles['debug-bar-timeline-' . $styleCount] = "left: {$offset}%; width: {$length}%;";	×
207
208	$output .= "<span class='timer debug-bar-timeline-{$styleCount}' title='" . number_format($length, 2) . "%'></span>";	×
209	$output .= '</td>';	×
210	$output .= '</tr>';	×
211
212	$styleCount++;	×
213
214	// Add children if any
NEW 215	if ($hasChildren) {	×
NEW 216	$output .= '<tr class="child-row" id="timeline-' . ($styleCount - 1) . '_children" style="' . ($open ? '' : 'display: none;') . '">';	×
NEW 217	$output .= '<td colspan="' . ($segmentCount + 3) . '" class="child-container">';	×
NEW 218	$output .= '<table class="timeline">';	×
NEW 219	$output .= '<tbody>';	×
NEW 220	$output .= $this->renderTimelineRecursive($row['children'], $startTime, $segmentCount, $segmentDuration, $styles, $styleCount, $level + 1, true);	×
NEW 221	$output .= '</tbody>';	×
NEW 222	$output .= '</table>';	×
NEW 223	$output .= '</td>';	×
NEW 224	$output .= '</tr>';	×
225	}
226	}
227
228	return $output;	×
229	}
230
231	/**
232	* Returns a sorted array of timeline data arrays from the collectors.
233	*
234	* @param array $collectors
235	*/
236	protected function collectTimelineData($collectors): array
237	{
238	$data = [];	×
239
240	// Collect it
241	foreach ($collectors as $collector) {	×
242	if (! $collector['hasTimelineData']) {	×
243	continue;	×
244	}
245
246	$data = array_merge($data, $collector['timelineData']);	×
247	}
248
249	// Sort it
250	$sortArray = [
NEW 251	array_column($data, 'start'), SORT_NUMERIC, SORT_ASC,	×
NEW 252	array_column($data, 'duration'), SORT_NUMERIC, SORT_DESC,	×
NEW 253	&$data,	×
254	];
255
NEW 256	array_multisort(...$sortArray);	×
257
258	// Add end time to each element
NEW 259	array_walk($data, static function (&$row) {	×
NEW 260	$row['end'] = $row['start'] + $row['duration'];	×
NEW 261	});	×
262
263	// Group it
NEW 264	$data = $this->structureTimelineData($data);	×
265
266	return $data;	×
267	}
268
269	/**
270	* Arranges the already sorted timeline data into a parent => child structure.
271	*/
272	protected function structureTimelineData(array $elements): array
273	{
274	// We define ourselves as the first element of the array
NEW 275	$element = array_shift($elements);	×
276
277	// If we have children behind us, collect and attach them to us
NEW 278	while (! empty($elements) && $elements[array_key_first($elements)]['end'] <= $element['end']) {	×
NEW 279	$element['children'][] = array_shift($elements);	×
280	}
281
282	// Make sure our children know whether they have children, too
NEW 283	if (isset($element['children'])) {	×
NEW 284	$element['children'] = $this->structureTimelineData($element['children']);	×
285	}
286
287	// If we have no younger siblings, we can return
NEW 288	if (empty($elements)) {	×
NEW 289	return [$element];	×
290	}
291
292	// Make sure our younger siblings know their relatives, too
NEW 293	return array_merge([$element], $this->structureTimelineData($elements));	×
294	}
295
296	/**
297	* Returns an array of data from all of the modules
298	* that should be displayed in the 'Vars' tab.
299	*/
300	protected function collectVarData(): array
301	{
302	$data = [];	×
303
304	foreach ($this->collectors as $collector) {	×
305	if (! $collector->hasVarData()) {	×
306	continue;	×
307	}
308
309	$data = array_merge($data, $collector->getVarData());	×
310	}
311
312	return $data;	×
313	}
314
315	/**
316	* Rounds a number to the nearest incremental value.
317	*/
318	protected function roundTo(float $number, int $increments = 5): float
319	{
320	$increments = 1 / $increments;	×
321
322	return ceil($number * $increments) / $increments;	×
323	}
324
325	/**
326	* Prepare for debugging..
327	*
328	* @param RequestInterface $request
329	* @param ResponseInterface $response
330	*
331	* @global \CodeIgniter\CodeIgniter $app
332	*/
333	public function prepare(?RequestInterface $request = null, ?ResponseInterface $response = null)
334	{
335	/**
336	* @var IncomingRequest $request
337	* @var Response $response
338	*/
339	if (CI_DEBUG && ! is_cli()) {	230✔
340	global $app;	×
341
342	$request = $request ?? Services::request();	×
343	$response = $response ?? Services::response();	×
344
345	// Disable the toolbar for downloads
346	if ($response instanceof DownloadResponse) {	×
347	return;	×
348	}
349
350	$toolbar = Services::toolbar(config(self::class));	×
351	$stats = $app->getPerformanceStats();	×
352	$data = $toolbar->run(	×
353	$stats['startTime'],	×
354	$stats['totalTime'],	×
355	$request,
356	$response
357	);
358
359	helper('filesystem');	×
360
361	// Updated to time() so we can get history
362	$time = time();	×
363
364	if (! is_dir(WRITEPATH . 'debugbar')) {	×
365	mkdir(WRITEPATH . 'debugbar', 0777);	×
366	}
367
368	write_file(WRITEPATH . 'debugbar/' . 'debugbar_' . $time . '.json', $data, 'w+');	×
369
370	$format = $response->getHeaderLine('content-type');	×
371
372	// Non-HTML formats should not include the debugbar
373	// then we send headers saying where to find the debug data
374	// for this response
375	if ($request->isAJAX() \|\| strpos($format, 'html') === false) {	×
376	$response->setHeader('Debugbar-Time', "{$time}")	×
377	->setHeader('Debugbar-Link', site_url("?debugbar_time={$time}"))	×
378	->getBody();	×
379
380	return;	×
381	}
382
383	$oldKintMode = Kint::$mode_default;	×
384	Kint::$mode_default = Kint::MODE_RICH;	×
385	$kintScript = @Kint::dump('');	×
386	Kint::$mode_default = $oldKintMode;	×
387	$kintScript = substr($kintScript, 0, strpos($kintScript, '</style>') + 8);	×
388
389	$script = PHP_EOL	×
390	. '<script type="text/javascript" {csp-script-nonce} id="debugbar_loader" '	×
391	. 'data-time="' . $time . '" '	×
392	. 'src="' . site_url() . '?debugbar"></script>'	×
393	. '<script type="text/javascript" {csp-script-nonce} id="debugbar_dynamic_script"></script>'	×
394	. '<style type="text/css" {csp-style-nonce} id="debugbar_dynamic_style"></style>'	×
395	. $kintScript	×
396	. PHP_EOL;	×
397
398	if (strpos($response->getBody(), '<head>') !== false) {	×
399	$response->setBody(preg_replace('/<head>/', '<head>' . $script, $response->getBody(), 1));	×
400
401	return;	×
402	}
403
404	$response->appendBody($script);	×
405	}
406	}	230✔
407
408	/**
409	* Inject debug toolbar into the response.
410	*/
411	public function respond()
412	{
413	if (ENVIRONMENT === 'testing') {	×
414	return;	×
415	}
416
417	// @codeCoverageIgnoreStart
418	$request = Services::request();
419
420	// If the request contains '?debugbar then we're
421	// simply returning the loading script
422	if ($request->getGet('debugbar') !== null) {
423	// Let the browser know that we are sending javascript
424	header('Content-Type: application/javascript');
425
426	ob_start();
427	include $this->config->viewsPath . 'toolbarloader.js.php';
428	$output = ob_get_clean();
429
430	exit($output);
431	}
432
433	// Otherwise, if it includes ?debugbar_time, then
434	// we should return the entire debugbar.
435	if ($request->getGet('debugbar_time')) {
436	helper('security');
437
438	// Negotiate the content-type to format the output
439	$format = $request->negotiate('media', [
440	'text/html',
441	'application/json',
442	'application/xml',
443	]);
444	$format = explode('/', $format)[1];
445
446	$file = sanitize_filename('debugbar_' . $request->getGet('debugbar_time'));
447	$filename = WRITEPATH . 'debugbar/' . $file . '.json';
448
449	// Show the toolbar
450	if (is_file($filename)) {
451	$contents = $this->format(file_get_contents($filename), $format);
452
453	exit($contents);
454	}
455
456	// File was not written or do not exists
457	http_response_code(404);
458
459	exit; // Exit here is needed to avoid load the index page
460	}
461	// @codeCoverageIgnoreEnd
462	}	×
463
464	/**
465	* Format output
466	*/
467	protected function format(string $data, string $format = 'html'): string
468	{
469	$data = json_decode($data, true);	×
470
471	if ($this->config->maxHistory !== 0) {	×
472	$history = new History();	×
473	$history->setFiles(	×
474	(int) Services::request()->getGet('debugbar_time'),	×
475	$this->config->maxHistory	×
476	);
477
478	$data['collectors'][] = $history->getAsArray();	×
479	}
480
481	$output = '';	×
482
483	switch ($format) {	×
484	case 'html':	×
485	$data['styles'] = [];	×
486	extract($data);	×
487	$parser = Services::parser($this->config->viewsPath, null, false);	×
488	ob_start();	×
489	include $this->config->viewsPath . 'toolbar.tpl.php';	×
490	$output = ob_get_clean();	×
491	break;	×
492
493	case 'json':	×
494	$formatter = new JSONFormatter();	×
495	$output = $formatter->format($data);	×
496	break;	×
497
498	case 'xml':	×
499	$formatter = new XMLFormatter();	×
500	$output = $formatter->format($data);	×
501	break;	×
502	}
503
504	return $output;	×
505	}
506	}

codeigniter4 / CodeIgniter4 / 1210055114

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous