src/ListDatabase.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin;
   6
   7 use ArrayObject;
   8 use PhpMyAdmin\Query\Utilities;
   9
  10 use function array_merge;
  11 use function in_array;
  12 use function is_array;
  13 use function is_string;
  14 use function preg_match;
  15 use function sort;
  16 use function strnatcasecmp;
  17 use function strtr;
  18 use function usort;
  19
  20 /**
  21  * Handles database lists
  22  *
  23  * @extends ArrayObject<int, string>
  24  */
  25 class ListDatabase extends ArrayObject
  26 {
  27     public function __construct(
  28         private readonly DatabaseInterface $dbi,
  29         private readonly Config $config,
  30         private readonly UserPrivilegesFactory $userPrivilegesFactory,
  31     ) {
  32         parent::__construct();
  33
  34         $userPrivileges = $this->userPrivilegesFactory->getPrivileges();
  35
  36         $this->build($userPrivileges);
  37     }
  38
  39     /** @return array<int, array<string, bool|string>> */
  40     public function getList(): array
  41     {
  42         $list = [];
  43         foreach ($this as $eachItem) {
  44             if (Utilities::isSystemSchema($eachItem)) {
  45                 continue;
  46             }
  47
  48             $list[] = ['name' => $eachItem, 'is_selected' => $eachItem === Current::$database];
  49         }
  50
  51         return $list;
  52     }
  53
  54     /**
  55      * checks if the configuration wants to hide some databases
  56      */
  57     protected function checkHideDatabase(): void
  58     {
  59         if (empty($this->config->selectedServer['hide_db'])) {
  60             return;
  61         }
  62
  63         foreach ($this->getArrayCopy() as $key => $db) {
  64             if (! preg_match('/' . $this->config->selectedServer['hide_db'] . '/', $db)) {
  65                 continue;
  66             }
  67
  68             $this->offsetUnset($key);
  69         }
  70     }
  71
  72     /**
  73      * retrieves database list from server
  74      *
  75      * @param string|null $likeDbName usually a db_name containing wildcards
  76      *
  77      * @return mixed[]
  78      */
  79     protected function retrieve(UserPrivileges $userPrivileges, string|null $likeDbName = null): array
  80     {
  81         $databaseList = [];
  82         $command = '';
  83         if (! $this->config->selectedServer['DisableIS']) {
  84             $command .= 'SELECT `SCHEMA_NAME` FROM `INFORMATION_SCHEMA`.`SCHEMATA`';
  85             if ($likeDbName !== null) {
  86                 $command .= " WHERE `SCHEMA_NAME` LIKE '" . $likeDbName . "'";
  87             }
  88         } elseif ($userPrivileges->databasesToTest === false || $likeDbName !== null) {
  89             $command .= 'SHOW DATABASES';
  90             if ($likeDbName !== null) {
  91                 $command .= " LIKE '" . $likeDbName . "'";
  92             }
  93         } else {
  94             foreach ($userPrivileges->databasesToTest as $db) {
  95                 $databaseList = array_merge(
  96                     $databaseList,
  97                     $this->retrieve($userPrivileges, $db),
  98                 );
  99             }
 100         }
 101
 102         if ($command !== '') {
 103             $databaseList = $this->dbi->fetchResult($command);
 104         }
 105
 106         if ($this->config->settings['NaturalOrder']) {
 107             usort($databaseList, strnatcasecmp(...));
 108         } else {
 109             // need to sort anyway, otherwise information_schema
 110             // goes at the top
 111             sort($databaseList);
 112         }
 113
 114         return $databaseList;
 115     }
 116
 117     /**
 118      * builds up the list
 119      */
 120     public function build(UserPrivileges $userPrivileges): void
 121     {
 122         if (! $this->checkOnlyDatabase($userPrivileges)) {
 123             $items = $this->retrieve($userPrivileges);
 124             $this->exchangeArray($items);
 125         }
 126
 127         $this->checkHideDatabase();
 128     }
 129
 130     /**
 131      * checks the only_db configuration
 132      */
 133     protected function checkOnlyDatabase(UserPrivileges $userPrivileges): bool
 134     {
 135         if (
 136             is_string($this->config->selectedServer['only_db']) && $this->config->selectedServer['only_db'] !== ''
 137         ) {
 138             $this->config->selectedServer['only_db'] = [$this->config->selectedServer['only_db']];
 139         }
 140
 141         if (! is_array($this->config->selectedServer['only_db'])) {
 142             return false;
 143         }
 144
 145         $items = [];
 146
 147         foreach ($this->config->selectedServer['only_db'] as $eachOnlyDb) {
 148             // check if the db name contains wildcard,
 149             // thus containing not escaped _ or %
 150             if (! preg_match('/(^|[^\\\\])(_|%)/', $eachOnlyDb)) {
 151                 // ... not contains wildcard
 152                 $items[] = strtr($eachOnlyDb, ['\\\\' => '\\', '\\_' => '_', '\\%' => '%']);
 153                 continue;
 154             }
 155
 156             $items = array_merge($items, $this->retrieve($userPrivileges, $eachOnlyDb));
 157         }
 158
 159         $this->exchangeArray($items);
 160
 161         return true;
 162     }
 163
 164     /**
 165      * Checks if the given strings exists in the current list, if there is
 166      * missing at least one item it returns false otherwise true
 167      */
 168     public function exists(string ...$params): bool
 169     {
 170         $elements = $this->getArrayCopy();
 171         foreach ($params as $param) {
 172             if (! in_array($param, $elements, true)) {
 173                 return false;
 174             }
 175         }
 176
 177         return true;
 178     }
 179 }