src/Scripts.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin;
   6
   7 use function array_key_exists;
   8 use function defined;
   9 use function md5;
  10 use function str_contains;
  11
  12 /**
  13  * Collects information about which JavaScript
  14  * files and objects are necessary to render
  15  * the page and generates the relevant code.
  16  */
  17 class Scripts
  18 {
  19     /**
  20      * An array of SCRIPT tags
  21      *
  22      * @var array<string, array<string, int|string|array<string, string>>>
  23      * @psalm-var array<string, array{has_onload: 0|1, filename: non-empty-string, params: array<string, string>}>
  24      */
  25     private array $files = [];
  26     /**
  27      * A string of discrete javascript code snippets
  28      */
  29     private string $code = '';
  30
  31     /**
  32      * Generates new Scripts objects
  33      */
  34     public function __construct(private readonly Template $template)
  35     {
  36     }
  37
  38     /**
  39      * Adds a new file to the list of scripts
  40      *
  41      * @param string                $filename The name of the file to include
  42      * @param array<string, string> $params   Additional parameters to pass to the file
  43      */
  44     public function addFile(
  45         string $filename,
  46         array $params = [],
  47     ): void {
  48         $hash = md5($filename);
  49         if (array_key_exists($hash, $this->files) || $filename === '') {
  50             return;
  51         }
  52
  53         $hasOnload = $this->hasOnloadEvent($filename);
  54         $this->files[$hash] = ['has_onload' => (int) $hasOnload, 'filename' => $filename, 'params' => $params];
  55     }
  56
  57     /**
  58      * Add new files to the list of scripts
  59      *
  60      * @param string[] $filelist The array of file names
  61      */
  62     public function addFiles(array $filelist): void
  63     {
  64         foreach ($filelist as $filename) {
  65             $this->addFile($filename);
  66         }
  67     }
  68
  69     /**
  70      * Determines whether to fire up an onload event for a file
  71      *
  72      * @param string $filename The name of the file to be checked against the exclude list.
  73      *
  74      * @return bool true to fire up the event, false not to
  75      */
  76     private function hasOnloadEvent(string $filename): bool
  77     {
  78         return ! str_contains($filename, 'vendor')
  79             && ! str_contains($filename, 'runtime.js')
  80             && ! str_contains($filename, 'name-conflict-fixes.js')
  81             && ! str_contains($filename, 'index.php')
  82             && ! str_contains($filename, 'shared.js')
  83             && ! str_contains($filename, 'datetimepicker.js')
  84             && ! str_contains($filename, 'validator-messages.js');
  85     }
  86
  87     /**
  88      * Adds a new code snippet to the code to be executed
  89      *
  90      * @param string $code The JS code to be added
  91      */
  92     public function addCode(string $code): void
  93     {
  94         $this->code .= $code . "\n";
  95     }
  96
  97     /**
  98      * Returns a list with filenames and a flag to indicate
  99      * whether to register onload events for this file
 100      *
 101      * @return array<int, array<string, int|string>>
 102      * @psalm-return list<array{name: non-empty-string, fire: 0|1}>
 103      */
 104     public function getFiles(): array
 105     {
 106         $retval = [];
 107         foreach ($this->files as $file) {
 108             //If filename contains a "?", continue.
 109             if (str_contains($file['filename'], '?')) {
 110                 continue;
 111             }
 112
 113             $retval[] = ['name' => $file['filename'], 'fire' => $file['has_onload']];
 114         }
 115
 116         return $retval;
 117     }
 118
 119     /**
 120      * Renders all the JavaScript file inclusions, code and events
 121      */
 122     public function getDisplay(): string
 123     {
 124         $baseDir = defined('PMA_PATH_TO_BASEDIR') ? PMA_PATH_TO_BASEDIR : '';
 125
 126         return $this->template->render('scripts', [
 127             'base_dir' => $baseDir,
 128             'files' => $this->files,
 129             'version' => Version::VERSION,
 130             'code' => $this->code,
 131         ]);
 132     }
 133 }