libraries/classes/RecentFavoriteTable.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Recent and Favorite table list handling
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 declare(strict_types=1);
   9
  10 namespace PhpMyAdmin;
  11
  12 /**
  13  * Handles the recently used and favorite tables.
  14  *
  15  * @TODO Change the release version in table pma_recent
  16  * (#recent in documentation)
  17  *
  18  * @package PhpMyAdmin
  19  */
  20 class RecentFavoriteTable
  21 {
  22     /**
  23      * Reference to session variable containing recently used or favorite tables.
  24      *
  25      * @access private
  26      * @var array
  27      */
  28     private $_tables;
  29
  30     /**
  31      * Defines type of action, Favorite or Recent table.
  32      *
  33      * @access private
  34      * @var string
  35      */
  36     private $_tableType;
  37
  38     /**
  39      * RecentFavoriteTable instances.
  40      *
  41      * @access private
  42      * @var array
  43      */
  44     private static $_instances = [];
  45
  46     /**
  47      * @var Relation
  48      */
  49     private $relation;
  50
  51     /**
  52      * Creates a new instance of RecentFavoriteTable
  53      *
  54      * @param string $type the table type
  55      *
  56      * @access private
  57      */
  58     private function __construct($type)
  59     {
  60         $this->relation = new Relation($GLOBALS['dbi']);
  61         $this->_tableType = $type;
  62         $server_id = $GLOBALS['server'];
  63         if (! isset($_SESSION['tmpval'][$this->_tableType . 'Tables'][$server_id])
  64         ) {
  65             $_SESSION['tmpval'][$this->_tableType . 'Tables'][$server_id]
  66                 = $this->_getPmaTable() ? $this->getFromDb() : [];
  67         }
  68         $this->_tables
  69             =& $_SESSION['tmpval'][$this->_tableType . 'Tables'][$server_id];
  70     }
  71
  72     /**
  73      * Returns class instance.
  74      *
  75      * @param string $type the table type
  76      *
  77      * @return RecentFavoriteTable
  78      */
  79     public static function getInstance($type)
  80     {
  81         if (! array_key_exists($type, self::$_instances)) {
  82             self::$_instances[$type] = new RecentFavoriteTable($type);
  83         }
  84         return self::$_instances[$type];
  85     }
  86
  87     /**
  88      * Returns the recent/favorite tables array
  89      *
  90      * @return array
  91      */
  92     public function getTables()
  93     {
  94         return $this->_tables;
  95     }
  96
  97     /**
  98      * Returns recently used tables or favorite from phpMyAdmin database.
  99      *
 100      * @return array
 101      */
 102     public function getFromDb()
 103     {
 104         // Read from phpMyAdmin database, if recent tables is not in session
 105         $sql_query
 106             = " SELECT `tables` FROM " . $this->_getPmaTable() .
 107             " WHERE `username` = '" . $GLOBALS['dbi']->escapeString($GLOBALS['cfg']['Server']['user']) . "'";
 108
 109         $return = [];
 110         $result = $this->relation->queryAsControlUser($sql_query, false);
 111         if ($result) {
 112             $row = $GLOBALS['dbi']->fetchArray($result);
 113             if (isset($row[0])) {
 114                 $return = json_decode($row[0], true);
 115             }
 116         }
 117         return $return;
 118     }
 119
 120     /**
 121      * Save recent/favorite tables into phpMyAdmin database.
 122      *
 123      * @return true|Message
 124      */
 125     public function saveToDb()
 126     {
 127         $username = $GLOBALS['cfg']['Server']['user'];
 128         $sql_query
 129             = " REPLACE INTO " . $this->_getPmaTable() . " (`username`, `tables`)" .
 130                 " VALUES ('" . $GLOBALS['dbi']->escapeString($username) . "', '"
 131                 . $GLOBALS['dbi']->escapeString(
 132                     json_encode($this->_tables)
 133                 ) . "')";
 134
 135         $success = $GLOBALS['dbi']->tryQuery($sql_query, DatabaseInterface::CONNECT_CONTROL);
 136
 137         if (! $success) {
 138             $error_msg = '';
 139             switch ($this->_tableType) {
 140                 case 'recent':
 141                     $error_msg = __('Could not save recent table!');
 142                     break;
 143
 144                 case 'favorite':
 145                     $error_msg = __('Could not save favorite table!');
 146                     break;
 147             }
 148             $message = Message::error($error_msg);
 149             $message->addMessage(
 150                 Message::rawError(
 151                     $GLOBALS['dbi']->getError(DatabaseInterface::CONNECT_CONTROL)
 152                 ),
 153                 '<br><br>'
 154             );
 155             return $message;
 156         }
 157         return true;
 158     }
 159
 160     /**
 161      * Trim recent.favorite table according to the
 162      * NumRecentTables/NumFavoriteTables configuration.
 163      *
 164      * @return boolean True if trimming occurred
 165      */
 166     public function trim()
 167     {
 168         $max = max(
 169             $GLOBALS['cfg']['Num' . ucfirst($this->_tableType) . 'Tables'],
 170             0
 171         );
 172         $trimming_occurred = count($this->_tables) > $max;
 173         while (count($this->_tables) > $max) {
 174             array_pop($this->_tables);
 175         }
 176         return $trimming_occurred;
 177     }
 178
 179     /**
 180      * Return HTML ul.
 181      *
 182      * @return string
 183      */
 184     public function getHtmlList()
 185     {
 186         $html = '';
 187         if (count($this->_tables)) {
 188             if ($this->_tableType == 'recent') {
 189                 foreach ($this->_tables as $table) {
 190                     $html .= '<li class="warp_link">';
 191                     $recent_params = [
 192                         'db'    => $table['db'],
 193                         'table' => $table['table'],
 194                     ];
 195                     $recent_url = 'tbl_recent_favorite.php'
 196                         . Url::getCommon($recent_params);
 197                     $html .= '<a href="' . $recent_url . '">`'
 198                           . htmlspecialchars($table['db']) . '`.`'
 199                           . htmlspecialchars($table['table']) . '`</a>';
 200                     $html .= '</li>';
 201                 }
 202             } else {
 203                 foreach ($this->_tables as $table) {
 204                     $html .= '<li class="warp_link">';
 205
 206                     $html .= '<a class="ajax favorite_table_anchor" ';
 207                     $fav_rm_url = Url::getFromRoute('/database/structure', [
 208                         'db' => $table['db'],
 209                         'ajax_request' => true,
 210                         'favorite_table' => $table['table'],
 211                         'remove_favorite' => true,
 212                     ]);
 213                     $html .= 'href="' . $fav_rm_url
 214                         . '" title="' . __("Remove from Favorites")
 215                         . '" data-favtargetn="'
 216                         . md5($table['db'] . "." . $table['table'])
 217                         . '" >'
 218                         . Util::getIcon('b_favorite')
 219                         . '</a>';
 220
 221                     $fav_params = [
 222                         'db'    => $table['db'],
 223                         'table' => $table['table'],
 224                     ];
 225                     $table_url = 'tbl_recent_favorite.php'
 226                         . Url::getCommon($fav_params);
 227                     $html .= '<a href="' . $table_url . '">`'
 228                         . htmlspecialchars($table['db']) . '`.`'
 229                         . htmlspecialchars($table['table']) . '`</a>';
 230                     $html .= '</li>';
 231                 }
 232             }
 233         } else {
 234             $html .= '<li class="warp_link">'
 235                   . ($this->_tableType == 'recent'
 236                     ? __('There are no recent tables.')
 237                     : __('There are no favorite tables.'))
 238                   . '</li>';
 239         }
 240         return $html;
 241     }
 242
 243     /**
 244      * Return HTML.
 245      *
 246      * @return string
 247      */
 248     public function getHtml()
 249     {
 250         $html  = '<div class="drop_list">';
 251         if ($this->_tableType == 'recent') {
 252             $html .= '<button title="' . __('Recent tables')
 253                 . '" class="drop_button btn">'
 254                 . __('Recent') . '</button><ul id="pma_recent_list">';
 255         } else {
 256             $html .= '<button title="' . __('Favorite tables')
 257                 . '" class="drop_button btn">'
 258                 . __('Favorites') . '</button><ul id="pma_favorite_list">';
 259         }
 260         $html .= $this->getHtmlList();
 261         $html .= '</ul></div>';
 262         return $html;
 263     }
 264
 265     /**
 266      * Add recently used or favorite tables.
 267      *
 268      * @param string $db    database name where the table is located
 269      * @param string $table table name
 270      *
 271      * @return true|Message True if success, Message if not
 272      */
 273     public function add($db, $table)
 274     {
 275         // If table does not exist, do not add._getPmaTable()
 276         if (! $GLOBALS['dbi']->getColumns($db, $table)) {
 277             return true;
 278         }
 279
 280         $table_arr = [];
 281         $table_arr['db'] = $db;
 282         $table_arr['table'] = $table;
 283
 284         // add only if this is new table
 285         if (! isset($this->_tables[0]) || $this->_tables[0] != $table_arr) {
 286             array_unshift($this->_tables, $table_arr);
 287             $this->_tables = array_merge(array_unique($this->_tables, SORT_REGULAR));
 288             $this->trim();
 289             if ($this->_getPmaTable()) {
 290                 return $this->saveToDb();
 291             }
 292         }
 293         return true;
 294     }
 295
 296     /**
 297      * Removes recent/favorite tables that don't exist.
 298      *
 299      * @param string $db    database
 300      * @param string $table table
 301      *
 302      * @return boolean|Message True if invalid and removed, False if not invalid,
 303      *                            Message if error while removing
 304      */
 305     public function removeIfInvalid($db, $table)
 306     {
 307         foreach ($this->_tables as $tbl) {
 308             if ($tbl['db'] == $db && $tbl['table'] == $table) {
 309                 // TODO Figure out a better way to find the existence of a table
 310                 if (! $GLOBALS['dbi']->getColumns($tbl['db'], $tbl['table'])) {
 311                     return $this->remove($tbl['db'], $tbl['table']);
 312                 }
 313             }
 314         }
 315         return false;
 316     }
 317
 318     /**
 319      * Remove favorite tables.
 320      *
 321      * @param string $db    database name where the table is located
 322      * @param string $table table name
 323      *
 324      * @return true|Message True if success, Message if not
 325      */
 326     public function remove($db, $table)
 327     {
 328         foreach ($this->_tables as $key => $value) {
 329             if ($value['db'] == $db && $value['table'] == $table) {
 330                 unset($this->_tables[$key]);
 331             }
 332         }
 333         if ($this->_getPmaTable()) {
 334             return $this->saveToDb();
 335         }
 336         return true;
 337     }
 338
 339     /**
 340      * Generate Html for sync Favorite tables anchor. (from localStorage to pmadb)
 341      *
 342      * @return string
 343      */
 344     public function getHtmlSyncFavoriteTables()
 345     {
 346         $retval = '';
 347         $server_id = $GLOBALS['server'];
 348         if ($server_id == 0) {
 349             return '';
 350         }
 351         $cfgRelation = $this->relation->getRelationsParam();
 352         // Not to show this once list is synchronized.
 353         if ($cfgRelation['favoritework'] && ! isset($_SESSION['tmpval']['favorites_synced'][$server_id])) {
 354             $url = Url::getFromRoute('/database/structure', [
 355                 'ajax_request' => true,
 356                 'favorite_table' => true,
 357                 'sync_favorite_tables' => true,
 358             ]);
 359             $retval  = '<a class="hide" id="sync_favorite_tables"';
 360             $retval .= ' href="' . $url . '"></a>';
 361         }
 362         return $retval;
 363     }
 364
 365     /**
 366      * Generate Html to update recent tables.
 367      *
 368      * @return string html
 369      */
 370     public static function getHtmlUpdateRecentTables()
 371     {
 372         $params  = [
 373             'ajax_request' => true,
 374             'recent_table' => true,
 375         ];
 376         $url     = 'index.php' . Url::getCommon($params);
 377         $retval  = '<a class="hide" id="update_recent_tables"';
 378         $retval .= ' href="' . $url . '"></a>';
 379         return $retval;
 380     }
 381
 382     /**
 383      * Return the name of the configuration storage table
 384      *
 385      * @return string|null pma table name
 386      */
 387     private function _getPmaTable(): ?string
 388     {
 389         $cfgRelation = $this->relation->getRelationsParam();
 390         if (! empty($cfgRelation['db'])
 391             && ! empty($cfgRelation[$this->_tableType])
 392         ) {
 393             return Util::backquote($cfgRelation['db']) . "."
 394                 . Util::backquote($cfgRelation[$this->_tableType]);
 395         }
 396         return null;
 397     }
 398 }