libraries/RecentTable.class.php

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