libraries/RecentTable.class.php

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