src/Profiling.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin;
   6
   7 use PhpMyAdmin\Utils\SessionCache;
   8
   9 /**
  10  * Statement resource usage.
  11  */
  12 final class Profiling
  13 {
  14     public static function isSupported(DatabaseInterface $dbi): bool
  15     {
  16         if (SessionCache::has('profiling_supported')) {
  17             return (bool) SessionCache::get('profiling_supported');
  18         }
  19
  20         /**
  21          * 5.0.37 has profiling but for example, 5.1.20 does not
  22          * (avoid a trip to the server for MySQL before 5.0.37)
  23          * and do not set a constant as we might be switching servers
  24          */
  25         if ($dbi->fetchValue('SELECT @@have_profiling')) {
  26             SessionCache::set('profiling_supported', true);
  27
  28             return true;
  29         }
  30
  31         SessionCache::set('profiling_supported', false);
  32
  33         return false;
  34     }
  35
  36     public static function enable(DatabaseInterface $dbi): void
  37     {
  38         if (! isset($_SESSION['profiling']) || ! self::isSupported($dbi)) {
  39             return;
  40         }
  41
  42         $dbi->query('SET PROFILING=1;');
  43     }
  44
  45     /** @psalm-return list<array{Status: non-empty-string, Duration: numeric-string}> */
  46     public static function getInformation(DatabaseInterface $dbi): array
  47     {
  48         if (! isset($_SESSION['profiling']) || ! self::isSupported($dbi)) {
  49             return [];
  50         }
  51
  52         /** @psalm-var list<array{Status: non-empty-string, Duration: numeric-string}> $profile */
  53         $profile = $dbi->fetchResult('SHOW PROFILE;');
  54
  55         return $profile;
  56     }
  57
  58     /**
  59      * Check if profiling was requested and remember it.
  60      */
  61     public static function check(DatabaseInterface $dbi, ResponseRenderer $response): void
  62     {
  63         if (isset($_REQUEST['profiling']) && self::isSupported($dbi)) {
  64             $_SESSION['profiling'] = true;
  65         } elseif (isset($_REQUEST['profiling_form'])) {
  66             // the checkbox was unchecked
  67             unset($_SESSION['profiling']);
  68         }
  69
  70         if (! isset($_SESSION['profiling'])) {
  71             return;
  72         }
  73
  74         $scripts = $response->getHeader()->getScripts();
  75         $scripts->addFiles([
  76             'vendor/chart.umd.js',
  77             'vendor/jquery/jquery.tablesorter.js',
  78         ]);
  79     }
  80 }