libraries/RecentTable.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  *
   5  * @package PhpMyAdmin
   6  */
   7
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 require_once './libraries/Message.class.php';
  13
  14 /**
  15  * Handles the recently used tables.
  16  *
  17  * @TODO Change the release version in table pma_recent
  18  * (#recent in documentation)
  19  *
  20  * @package PhpMyAdmin
  21  */
  22 class PMA_RecentTable
  23 {
  24     /**
  25      * Defines the internal PMA table which contains recent tables.
  26      *
  27      * @access  private
  28      * @var string
  29      */
  30     private $_pmaTable;
  31
  32     /**
  33      * Reference to session variable containing recently used tables.
  34      *
  35      * @access public
  36      * @var array
  37      */
  38     public $tables;
  39
  40     /**
  41      * PMA_RecentTable instance.
  42      *
  43      * @var PMA_RecentTable
  44      */
  45     private static $_instance;
  46
  47     public function __construct()
  48     {
  49         if (strlen($GLOBALS['cfg']['Server']['pmadb'])
  50             && strlen($GLOBALS['cfg']['Server']['recent'])
  51         ) {
  52             $this->_pmaTable
  53                 = PMA_Util::backquote($GLOBALS['cfg']['Server']['pmadb']) . "."
  54                 . PMA_Util::backquote($GLOBALS['cfg']['Server']['recent']);
  55         }
  56         $server_id = $GLOBALS['server'];
  57         if (! isset($_SESSION['tmp_user_values']['recent_tables'][$server_id])) {
  58             $_SESSION['tmp_user_values']['recent_tables'][$server_id]
  59                 = isset($this->_pmaTable) ? $this->getFromDb() : array();
  60         }
  61         $this->tables =& $_SESSION['tmp_user_values']['recent_tables'][$server_id];
  62     }
  63
  64     /**
  65      * Returns class instance.
  66      *
  67      * @return PMA_RecentTable
  68      */
  69     public static function getInstance()
  70     {
  71         if (is_null(self::$_instance)) {
  72             self::$_instance = new PMA_RecentTable();
  73         }
  74         return self::$_instance;
  75     }
  76
  77     /**
  78      * Returns recently used tables from phpMyAdmin database.
  79      *
  80      * @return array
  81      */
  82     public function getFromDb()
  83     {
  84         // Read from phpMyAdmin database, if recent tables is not in session
  85         $sql_query
  86             = " SELECT `tables` FROM " . $this->_pmaTable .
  87             " WHERE `username` = '" . $GLOBALS['cfg']['Server']['user'] . "'";
  88
  89         $return = array();
  90         $result = PMA_queryAsControlUser($sql_query, false);
  91         if ($result) {
  92             $row = PMA_DBI_fetch_array($result);
  93             if (isset($row[0])) {
  94                 $return = json_decode($row[0], true);
  95             }
  96         }
  97         return $return;
  98     }
  99
 100     /**
 101      * Save recent tables into phpMyAdmin database.
 102      *
 103      * @return true|PMA_Message
 104      */
 105     public function saveToDb()
 106     {
 107         $username = $GLOBALS['cfg']['Server']['user'];
 108         $sql_query
 109             = " REPLACE INTO " . $this->_pmaTable . " (`username`, `tables`)" .
 110                 " VALUES ('" . $username . "', '"
 111                 . PMA_Util::sqlAddSlashes(
 112                     json_encode($this->tables)
 113                 ) . "')";
 114
 115         $success = PMA_DBI_try_query($sql_query, $GLOBALS['controllink']);
 116
 117         if (! $success) {
 118             $message = PMA_Message::error(__('Could not save recent table'));
 119             $message->addMessage('<br /><br />');
 120             $message->addMessage(
 121                 PMA_Message::rawError(PMA_DBI_getError($GLOBALS['controllink']))
 122             );
 123             return $message;
 124         }
 125         return true;
 126     }
 127
 128     /**
 129      * Trim recent table according to the NumRecentTables configuration.
 130      *
 131      * @return boolean True if trimming occurred
 132      */
 133     public function trim()
 134     {
 135         $max = max($GLOBALS['cfg']['NumRecentTables'], 0);
 136         $trimming_occured = count($this->tables) > $max;
 137         while (count($this->tables) > $max) {
 138             array_pop($this->tables);
 139         }
 140         return $trimming_occured;
 141     }
 142
 143     /**
 144      * Return options for HTML select.
 145      *
 146      * @return string
 147      */
 148     public function getHtmlSelectOption()
 149     {
 150         // trim and save, in case where the configuration is changed
 151         if ($this->trim() && isset($this->_pmaTable)) {
 152             $this->saveToDb();
 153         }
 154
 155         $html = '<option value="">(' . __('Recent tables') . ') ...</option>';
 156         if (count($this->tables)) {
 157             foreach ($this->tables as $table) {
 158                 $html .= '<option value="'
 159                     . htmlspecialchars(json_encode($table)) . '">'
 160                     . htmlspecialchars(
 161                         '`' . $table['db'] . '`.`' . $table['table'] . '`'
 162                     )
 163                     . '</option>';
 164             }
 165         } else {
 166             $html .= '<option value="">'
 167                 . __('There are no recent tables')
 168                 . '</option>';
 169         }
 170         return $html;
 171     }
 172
 173     /**
 174      * Return HTML select.
 175      *
 176      * @return string
 177      */
 178     public function getHtmlSelect()
 179     {
 180         $html  = '<select name="selected_recent_table" id="recentTable">';
 181         $html .= $this->getHtmlSelectOption();
 182         $html .= '</select>';
 183
 184         return $html;
 185     }
 186
 187     /**
 188      * Add recently used tables.
 189      *
 190      * @param string $db    database name where the table is located
 191      * @param string $table table name
 192      *
 193      * @return true|PMA_Message True if success, PMA_Message if not
 194      */
 195     public function add($db, $table)
 196     {
 197         $table_arr = array();
 198         $table_arr['db'] = $db;
 199         $table_arr['table'] = $table;
 200
 201         // add only if this is new table
 202         if (! isset($this->tables[0]) || $this->tables[0] != $table_arr) {
 203             array_unshift($this->tables, $table_arr);
 204             $this->tables = array_merge(array_unique($this->tables, SORT_REGULAR));
 205             $this->trim();
 206             if (isset($this->_pmaTable)) {
 207                 return $this->saveToDb();
 208             }
 209         }
 210         return true;
 211     }
 212
 213 }
 214 ?>