blitz-php / framework

src/Debug/Toolbar.php

<?php

/**
 * This file is part of Blitz PHP framework.
 *
 * (c) 2022 Dimitri Sitchet Tomkeu <devcode.dst@gmail.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace BlitzPHP\Debug;

use BlitzPHP\Core\Application;
use BlitzPHP\Debug\Toolbar\Collectors\BaseCollector;
use BlitzPHP\Debug\Toolbar\Collectors\Config;
use BlitzPHP\Debug\Toolbar\Collectors\HistoryCollector;
use BlitzPHP\Formatter\JsonFormatter;
use BlitzPHP\Formatter\XmlFormatter;
use BlitzPHP\Http\Request;
use BlitzPHP\Http\Response;
use BlitzPHP\Utilities\Date;
use BlitzPHP\View\Parser;
use Exception;
use GuzzleHttp\Psr7\Utils;
use Kint\Kint;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use stdClass;

/**
 * Affiche une barre d'outils avec des bits de statistiques pour aider un développeur dans le débogage.
 *
 * Inspiration: http://prophiler.fabfuel.de
 *
 * @credit	<a href="https://codeigniter.com">CodeIgniter 4.2 - CodeIgniter\Debug\Toolbar</a>
 */
class Toolbar
{
    /**
     * Paramètres de configuration de la barre d'outils.
     *
     * @var stdClass
     */
    protected $config;

    /**
     * Collecteurs à utiliser et à exposer.
     *
     * @var list<BaseCollector>

The type BlitzPHP\Debug\list was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $collectors = [];

    /**
     * Dossier de sauvegarde des information de debogage
     */
    private string $debugPath = FRAMEWORK_STORAGE_PATH . 'debugbar';

    /**
     * Constructeur
     */
    public function __construct(?stdClass $config = null)
    {
        $this->config = $config ?? (object) config('toolbar');

        foreach ($this->config->collectors as $collector) {
            if (! class_exists($collector)) {
                logger()->critical(
                    'Le collecteur de la barre d\'outils n\'existe pas (' . $collector . ').'
                    . ' Veuillez vérifier $collectors dans le fichier app/Config/toolbar.php.'
                );

                continue;
            }

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

    /**
     * Renvoie toutes les données requises par la barre de débogage
     *
     * @param float   $startTime Heure de début de l'application
     * @param Request $request
     *
     * @return string Données encodées en JSON
     */
    public function run(float $startTime, float $totalTime, ServerRequestInterface $request, ResponseInterface $response): string
    {
        // Éléments de données utilisés dans la vue.
        $data['url']             = current_url();

$data was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data = array(); before regardless.

        $data['method']          = $request->getMethod();
        $data['isAJAX']          = $request->ajax();

The method ajax() does not exist on Psr\Http\Message\ServerRequestInterface. It seems like you code against a sub-type of Psr\Http\Message\ServerRequestInterface such as BlitzPHP\Http\ServerRequest.

        $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['blitzVersion']    = Application::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 ($_SESSION !== []) {
            foreach ($_SESSION as $key => $value) {
                // Remplacez les données binaires par une chaîne pour éviter l'échec de json_encode.
                if (is_string($value) && preg_match('~[^\x20-\x7E\t\r\n]~', $value)) {
                    $value = 'donnée binaire';
                }

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

Are you sure esc(print_r($value, true)) of type array|string can be used in concatenation?

It seems like print_r($value, true) can also be of type true; however, parameter $data of esc() does only seem to accept array|string, maybe add an additional type check?

            }
        }

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

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

        foreach ($request->getHeaders() as $header => $value) {
            if (empty($value)) {
                continue;
            }
            $data['vars']['headers'][esc($header)] = esc($request->getHeaderLine($header));
        }

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

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

The method is() does not exist on Psr\Http\Message\ServerRequestInterface. It seems like you code against a sub-type of Psr\Http\Message\ServerRequestInterface such as BlitzPHP\Http\ServerRequest.

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

        foreach ($response->getHeaders() as $header => $value) {
            if (empty($value)) {
                continue;
            }
            $data['vars']['response']['headers'][esc($header)] = esc($response->getHeaderLine($header));
        }

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

        return json_encode($data);
    }

    /**
     * Appelé dans la vue pour afficher la chronologie elle-même.
     */
    protected function renderTimeline(array $collectors, float $startTime, int $segmentCount, int $segmentDuration, array &$styles): string
    {
        $rows       = $this->collectTimelineData($collectors);
        $styleCount = 0;

        // Utiliser la fonction de rendu récursif
        return $this->renderTimelineRecursive($rows, $startTime, $segmentCount, $segmentDuration, $styles, $styleCount);
    }

    /**
     * Restitue de manière récursive les éléments de la chronologie et leurs enfants.
     */
    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']);
            $isQuery     = isset($row['query']) && ! empty($row['query']);

            // Ouvrir la chronologie du contrôleur par défaut
            $open = $row['name'] === 'Controller';

            if ($hasChildren || $isQuery) {
                $output .= '<tr class="timeline-parent' . ($open ? ' timeline-parent-open' : '') . '" id="timeline-' . $styleCount . '_parent" data-toggle="childrows" data-child="timeline-' . $styleCount . '">';
            } else {
                $output .= '<tr>';
            }

            $output .= '<td class="' . ($isChild ? 'debug-bar-width30' : '') . ' debug-bar-level-' . $level . '" >' . ($hasChildren || $isQuery ? '<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++;

            // Ajouter des enfants le cas échéant
            if ($hasChildren || $isQuery) {
                $output .= '<tr class="child-row ' . ($open ? '' : ' debug-bar-ndisplay') . '" id="timeline-' . ($styleCount - 1) . '_children" >';
                $output .= '<td colspan="' . ($segmentCount + 3) . '" class="child-container">';
                $output .= '<table class="timeline">';
                $output .= '<tbody>';

                if ($isQuery) {
                    // Sortie de la chaîne de requête si requête
                    $output .= '<tr>';
                    $output .= '<td class="query-container debug-bar-level-' . ($level + 1) . '" >' . $row['query'] . '</td>';
                    $output .= '</tr>';
                } else {
                    // Rendre récursivement les enfants
                    $output .= $this->renderTimelineRecursive($row['children'], $startTime, $segmentCount, $segmentDuration, $styles, $styleCount, $level + 1, true);
                }

                $output .= '</tbody>';
                $output .= '</table>';
                $output .= '</td>';
                $output .= '</tr>';
            }
        }

        return $output;
    }

    /**
     * Renvoie un tableau trié de tableaux de données chronologiques à partir des collecteurs.
     *
     * @param mixed $collectors
     */
    protected function collectTimelineData($collectors): array
    {
        $data = [];

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

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

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

        array_multisort(...$sortArray);

It seems like $sortArray can also be of type integer; however, parameter $array of array_multisort() does only seem to accept array, maybe add an additional type check?

        // Ajouter une heure de fin à chaque élément
        array_walk($data, static function (&$row): void {
            $row['end'] = $row['start'] + $row['duration'];
        });

        // Le grouper
        $data = $this->structureTimelineData($data);

        return $data;
    }

    /**
     * Organise les données de chronologie déjà triées dans une structure parent => enfant.
     */
    protected function structureTimelineData(array $elements): array
    {
        // Nous nous définissons comme le premier élément du tableau
        $element = array_shift($elements);

        // Si nous avons des enfants derrière nous, récupérez-les et attachez-les-nous
        while ($elements !== [] && $elements[array_key_first($elements)]['end'] <= $element['end']) {
            $element['children'][] = array_shift($elements);
        }

        // Assurez-vous que nos enfants sachent s'ils ont eux aussi des enfants
        if (isset($element['children'])) {
            $element['children'] = $this->structureTimelineData($element['children']);
        }

        // Si nous n'avons pas de frères et sœurs plus jeunes, nous pouvons revenir
        if ($elements === []) {
            return [$element];
        }

        // Assurez-vous que nos jeunes frères et sœurs connaissent également leurs proches
        return array_merge([$element], $this->structureTimelineData($elements));
    }

    /**
     * Renvoie un tableau de données de tous les modules
     * qui devrait être affiché dans l'onglet 'Vars'.
     */
    protected function collectVarData(): array
    {
        if (! ($this->config->collectVarData ?? true)) {
            return [];
        }

        $data = [];

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

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

        return $data;
    }

    /**
     * Arrondit un nombre à la valeur incrémentielle la plus proche.
     */
    protected function roundTo(float $number, int $increments = 5): float
    {
        $increments = 1 / $increments;

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

    /**
     * Traite la barre d'outils de débogage pour la requête en cours.
     *
     * Cette méthode détermine s'il faut afficher la barre d'outils de débogage ou la préparer pour une utilisation ultérieure.
     *
     * @param array             $stats    Un tableau contenant des statistiques de performances.
     * @param Request           $request  La requête serveur en cours.
     * @param ResponseInterface $response La réponse en cours.
     *
     * @return ResponseInterface La réponse traitée, avec la barre d'outils de débogage injectée ou préparée pour une utilisation ultérieure.
     */
    public function process(array $stats, ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
    {
        if ($request->hasAny('blitzphp-debugbar', 'debugbar_time')) {

The method hasAny() does not exist on Psr\Http\Message\ServerRequestInterface. It seems like you code against a sub-type of Psr\Http\Message\ServerRequestInterface such as BlitzPHP\Http\ServerRequest.

            return $this->respond($request);
        }

        return $this->prepare($stats, $request, $response);
    }

    /**
     * Préparez-vous au débogage..
     */
    public function prepare(array $stats, ?ServerRequestInterface $request = null, ?ResponseInterface $response = null): ResponseInterface
    {
        /** @var Request $request */
        $request ??= service('request');
        /** @var Response $response */
        $response ??= service('response');

        // Si on est en CLI ou en prod, pas la peine de continuer car la debugbar n'est pas utilisable dans ces environnements
        if (is_cli() || on_prod()) {
            return $response;
        }

        // Si on a desactiver le debogage ou l'affichage de la debugbar, on s'arrete
        if (! BLITZ_DEBUG || ! $this->config->show_debugbar) {
            return $response;
        }

        $toolbar = service('toolbar', $this->config);
        $data    = $toolbar->run(
            $stats['startTime'],
            $stats['totalTime'],
            $request,
            $response
        );

        // Mise à jour vers microtime() pour que nous puissions obtenir l'historique
        $time = sprintf('%.6f', Date::now()->format('U.u'));

        if (! is_dir($this->debugPath)) {
            mkdir($this->debugPath, 0o777);
        }

        $this->writeFile($this->debugPath . '/debugbar_' . $time . '.json', $data, 'w+');

        $format = $response->getHeaderLine('Content-Type');

        // Les formats non HTML ne doivent pas inclure la barre de débogage,
        // puis nous envoyons des en-têtes indiquant où trouver les données de débogage pour cette réponse
        if ($request->ajax() || ! str_contains($format, 'html')) {
            return $response

The expression return $response->withHeader('Debugbar-Time', $time)->withHeader('Debugbar-Link', site_url('?debugbar_time='.$time)) returns the type Psr\Http\Message\MessageInterface which includes types incompatible with the type-hinted return Psr\Http\Message\ResponseInterface.

                ->withHeader('Debugbar-Time', "{$time}")
                ->withHeader('Debugbar-Link', site_url("?debugbar_time={$time}"));
        }

        $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);
        $kintScript         = ($kintScript === '0') ? '' : $kintScript;

        $script = PHP_EOL
            . '<script id="debugbar_loader" '
            . 'data-time="' . $time . '" '
            . 'src="' . site_url() . '?blitzphp-debugbar"></script>'
            . '<script id="debugbar_dynamic_script"></script>'
            . '<style id="debugbar_dynamic_style"></style>'
            . $kintScript
            . PHP_EOL;

        if (str_contains($responseContent = (string) $response->getBody(), '<head>')) {
            $responseContent = preg_replace(
                '/<head>/',
                '<head>' . $script,
                $responseContent,
                1,
            );
        } else {
            $responseContent .= $script;
        }

        return $response->withBody(Utils::streamFor($responseContent));

The expression return $response->withBody(GuzzleHttp\Psr7\Utils::streamFor($responseContent)) returns the type Psr\Http\Message\MessageInterface which includes types incompatible with the type-hinted return Psr\Http\Message\ResponseInterface.

    }

    /**
     * Injectez la barre d'outils de débogage dans la réponse.
     *
     * @param Request $request
     *
     * @codeCoverageIgnore
     */
    public function respond(ServerRequestInterface $request): Response
    {
        $response = new Response();

        if (on_test()) {
            return $response;
        }

        // Si la requête contient '?blitzphp-debugbar alors nous sommes
        // renvoie simplement le script de chargement
        if ($request->getQuery('blitzphp-debugbar') !== null) {

The method getQuery() does not exist on Psr\Http\Message\ServerRequestInterface. Did you maybe mean getQueryParams()?

            $response = $response->withType('application/javascript');

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

            return $response->withStringBody(str_replace('{url}', rtrim(site_url(), '/'), $output));
        }

        // Sinon, s'il inclut ?debugbar_time, alors
        // nous devrions retourner la barre de débogage entière.
        if (null !== $debugbarTime = $request->getQuery('debugbar_time')) {
            // Négociation du type de contenu pour formater la sortie
            $format   = $request->negotiate('media', ['text/html', 'application/json', 'application/xml']);

The method negotiate() does not exist on Psr\Http\Message\ServerRequestInterface. It seems like you code against a sub-type of Psr\Http\Message\ServerRequestInterface such as BlitzPHP\Http\ServerRequest.

            $response = $response->withType($format);
            $format   = explode('/', $format)[1];

            $filename = 'debugbar_' . $debugbarTime;
            $filename = $this->debugPath . DS . $filename . '.json';

            if (is_file($filename)) {
                // Affiche la barre d'outils si elle existe
                return $response->withStringBody($this->format($debugbarTime, file_get_contents($filename), $format));
            }
        }

        // Nom de fichier introuvable
        return $response->withStatus(404);
    }

    /**
     * Formatte la sortie
     *
     * @param mixed $debugbar_time
     */
    protected function format($debugbar_time, string $data, string $format = 'html'): string
    {
        $data = json_decode($data, true);

        if ($this->config->max_history !== 0 && preg_match('/\d+\.\d{6}/s', (string) $debugbar_time, $debugbarTime)) {
            $history = new HistoryCollector();
            $history->setFiles(
                $debugbarTime[0],
                $this->config->max_history
            );

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

        switch ($format) {
            case 'html':
                $data['styles'] = [];
                extract($data);
                $parser = new Parser([], $this->config->view_path);
                ob_start();
                include rtrim($this->config->view_path, '/\\') . DS . '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;

The expression return $output could return the type false which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Écrit des données dans le fichier spécifié dans le chemin.
     * Crée un nouveau fichier s'il n'existe pas.
     */
    protected function writeFile(string $path, string $data, string $mode = 'wb'): bool
    {
        try {
            $fp = fopen($path, $mode);

            flock($fp, LOCK_EX);

            for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result) {
                if (($result = fwrite($fp, substr($data, $written))) === false) {
                    break;
                }
            }

            flock($fp, LOCK_UN);
            fclose($fp);

            return is_int($result);
        } catch (Exception) {
            return false;
        }
    }
}