phpmyadmin/libraries/user_preferences.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Functions for displaying user preferences pages
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * Common initialization for user preferences modification pages
  14  *
  15  * @return void
  16  */
  17 function PMA_userprefsPageInit()
  18 {
  19     $forms_all_keys = PMA_readUserprefsFieldNames($GLOBALS['forms']);
  20     $cf = ConfigFile::getInstance();
  21     $cf->resetConfigData(); // start with a clean instance
  22     $cf->setAllowedKeys($forms_all_keys);
  23     $cf->setCfgUpdateReadMapping(
  24         array(
  25             'Server/hide_db' => 'Servers/1/hide_db',
  26             'Server/only_db' => 'Servers/1/only_db'
  27         )
  28     );
  29     $cf->updateWithGlobalConfig($GLOBALS['cfg']);
  30 }
  31
  32 /**
  33  * Loads user preferences
  34  *
  35  * Returns an array:
  36  * * config_data - path => value pairs
  37  * * mtime - last modification time
  38  * * type - 'db' (config read from pmadb) or 'session' (read from user session)
  39  *
  40  * @return array
  41  */
  42 function PMA_loadUserprefs()
  43 {
  44     $cfgRelation = PMA_getRelationsParam();
  45     if (! $cfgRelation['userconfigwork']) {
  46         // no pmadb table, use session storage
  47         if (! isset($_SESSION['userconfig'])) {
  48             $_SESSION['userconfig'] = array(
  49                 'db' => array(),
  50                 'ts' => time());
  51         }
  52         return array(
  53             'config_data' => $_SESSION['userconfig']['db'],
  54             'mtime' => $_SESSION['userconfig']['ts'],
  55             'type' => 'session');
  56     }
  57     // load configuration from pmadb
  58     $query_table = PMA_Util::backquote($cfgRelation['db']) . '.'
  59         . PMA_Util::backquote($cfgRelation['userconfig']);
  60     $query = '
  61         SELECT `config_data`, UNIX_TIMESTAMP(`timevalue`) ts
  62         FROM ' . $query_table . '
  63           WHERE `username` = \'' . PMA_Util::sqlAddSlashes($cfgRelation['user']) . '\'';
  64     $row = PMA_DBI_fetch_single_row($query, 'ASSOC', $GLOBALS['controllink']);
  65
  66     return array(
  67         'config_data' => $row ? (array)json_decode($row['config_data']) : array(),
  68         'mtime' => $row ? $row['ts'] : time(),
  69         'type' => 'db');
  70 }
  71
  72 /**
  73  * Saves user preferences
  74  *
  75  * @param array $config_array configuration array
  76  *
  77  * @return true|PMA_Message
  78  */
  79 function PMA_saveUserprefs(array $config_array)
  80 {
  81     $cfgRelation = PMA_getRelationsParam();
  82     $server = isset($GLOBALS['server'])
  83         ? $GLOBALS['server']
  84         : $GLOBALS['cfg']['ServerDefault'];
  85     $cache_key = 'server_' . $server;
  86     if (! $cfgRelation['userconfigwork']) {
  87         // no pmadb table, use session storage
  88         $_SESSION['userconfig'] = array(
  89             'db' => $config_array,
  90             'ts' => time());
  91         if (isset($_SESSION['cache'][$cache_key]['userprefs'])) {
  92             unset($_SESSION['cache'][$cache_key]['userprefs']);
  93         }
  94         return true;
  95     }
  96
  97     // save configuration to pmadb
  98     $query_table = PMA_Util::backquote($cfgRelation['db']) . '.'
  99         . PMA_Util::backquote($cfgRelation['userconfig']);
 100     $query = '
 101         SELECT `username`
 102         FROM ' . $query_table . '
 103           WHERE `username` = \'' . PMA_Util::sqlAddSlashes($cfgRelation['user']) . '\'';
 104
 105     $has_config = PMA_DBI_fetch_value($query, 0, 0, $GLOBALS['controllink']);
 106     $config_data = json_encode($config_array);
 107     if ($has_config) {
 108         $query = '
 109             UPDATE ' . $query_table . '
 110             SET `config_data` = \'' . PMA_Util::sqlAddSlashes($config_data) . '\'
 111             WHERE `username` = \'' . PMA_Util::sqlAddSlashes($cfgRelation['user']) . '\'';
 112     } else {
 113         $query = '
 114             INSERT INTO ' . $query_table . ' (`username`, `config_data`)
 115             VALUES (\'' . PMA_Util::sqlAddSlashes($cfgRelation['user']) . '\',
 116                 \'' . PMA_Util::sqlAddSlashes($config_data) . '\')';
 117     }
 118     if (isset($_SESSION['cache'][$cache_key]['userprefs'])) {
 119         unset($_SESSION['cache'][$cache_key]['userprefs']);
 120     }
 121     if (!PMA_DBI_try_query($query, $GLOBALS['controllink'])) {
 122         $message = PMA_Message::error(__('Could not save configuration'));
 123         $message->addMessage('<br /><br />');
 124         $message->addMessage(
 125             PMA_Message::rawError(PMA_DBI_getError($GLOBALS['controllink']))
 126         );
 127         return $message;
 128     }
 129     return true;
 130 }
 131
 132 /**
 133  * Returns a user preferences array filtered by $cfg['UserprefsDisallow']
 134  * (blacklist) and keys from user preferences form (whitelist)
 135  *
 136  * @param array $config_data path => value pairs
 137  *
 138  * @return array
 139  */
 140 function PMA_applyUserprefs(array $config_data)
 141 {
 142     $cfg = array();
 143     $blacklist = array_flip($GLOBALS['cfg']['UserprefsDisallow']);
 144     if (!$GLOBALS['cfg']['UserprefsDeveloperTab']) {
 145         // disallow everything in the Developers tab
 146         $blacklist['Error_Handler/display'] = true;
 147         $blacklist['Error_Handler/gather'] = true;
 148         $blacklist['DBG/sql'] = true;
 149     }
 150     $whitelist = array_flip(PMA_readUserprefsFieldNames());
 151     // whitelist some additional fields which are custom handled
 152     $whitelist['ThemeDefault'] = true;
 153     $whitelist['fontsize'] = true;
 154     $whitelist['lang'] = true;
 155     $whitelist['collation_connection'] = true;
 156     $whitelist['Server/hide_db'] = true;
 157     $whitelist['Server/only_db'] = true;
 158     foreach ($config_data as $path => $value) {
 159         if (! isset($whitelist[$path]) || isset($blacklist[$path])) {
 160             continue;
 161         }
 162         PMA_arrayWrite($path, $cfg, $value);
 163     }
 164     return $cfg;
 165 }
 166
 167 /**
 168  * Reads user preferences field names
 169  *
 170  * @param array|null $forms
 171  *
 172  * @return array
 173  */
 174 function PMA_readUserprefsFieldNames(array $forms = null)
 175 {
 176     static $names;
 177
 178     // return cached results
 179     if ($names !== null) {
 180         return $names;
 181     }
 182     if (is_null($forms)) {
 183         $forms = array();
 184         include 'libraries/config/user_preferences.forms.php';
 185     }
 186     $names = array();
 187     foreach ($forms as $formset) {
 188         foreach ($formset as $form) {
 189             foreach ($form as $k => $v) {
 190                 $names[] = is_int($k) ? $v : $k;
 191             }
 192         }
 193     }
 194     return $names;
 195 }
 196
 197 /**
 198  * Updates one user preferences option (loads and saves to database).
 199  *
 200  * No validation is done!
 201  *
 202  * @param string $path          configuration
 203  * @param mixed  $value         value
 204  * @param mixed  $default_value default value
 205  *
 206  * @return void
 207  */
 208 function PMA_persistOption($path, $value, $default_value)
 209 {
 210     $prefs = PMA_loadUserprefs();
 211     if ($value === $default_value) {
 212         if (isset($prefs['config_data'][$path])) {
 213             unset($prefs['config_data'][$path]);
 214         } else {
 215             return;
 216         }
 217     } else {
 218         $prefs['config_data'][$path] = $value;
 219     }
 220     PMA_saveUserprefs($prefs['config_data']);
 221 }
 222
 223 /**
 224  * Redirects after saving new user preferences
 225  *
 226  * @param string $file_name
 227  * @param array  $params
 228  * @param string $hash
 229  *
 230  * @return void
 231  */
 232 function PMA_userprefsRedirect($file_name,
 233     $params = null, $hash = null
 234 ) {
 235     // redirect
 236     $url_params = array('saved' => 1);
 237     if (is_array($params)) {
 238         $url_params = array_merge($params, $url_params);
 239     }
 240     if ($hash) {
 241         $hash = '#' . urlencode($hash);
 242     }
 243     PMA_sendHeaderLocation(
 244         $GLOBALS['cfg']['PmaAbsoluteUri'] . $file_name
 245         . PMA_generate_common_url($url_params, '&') . $hash
 246     );
 247 }
 248
 249 /**
 250  * Shows form which allows to quickly load
 251  * settings stored in browser's local storage
 252  *
 253  * @return string
 254  */
 255 function PMA_userprefsAutoloadGetHeader()
 256 {
 257     $retval = '';
 258
 259     if (isset($_REQUEST['prefs_autoload'])
 260         && $_REQUEST['prefs_autoload'] == 'hide'
 261     ) {
 262         $_SESSION['userprefs_autoload'] = true;
 263     } else {
 264         $script_name = basename(basename($GLOBALS['PMA_PHP_SELF']));
 265         $return_url = htmlspecialchars(
 266             $script_name . '?' . http_build_query($_GET, '', '&')
 267         );
 268
 269         $retval .= '<div id="prefs_autoload" class="notice" style="display:none">';
 270         $retval .= '<form action="prefs_manage.php" method="post">';
 271         $retval .= PMA_generate_common_hidden_inputs();
 272         $retval .= '<input type="hidden" name="json" value="" />';
 273         $retval .= '<input type="hidden" name="submit_import" value="1" />';
 274         $retval .= '<input type="hidden" name="return_url" value="' . $return_url . '" />';
 275         $retval .=  __(
 276             'Your browser has phpMyAdmin configuration for this domain. '
 277             . 'Would you like to import it for current session?'
 278         );
 279         $retval .= '<br />';
 280         $retval .= '<a href="#yes">' . __('Yes') . '</a>';
 281         $retval .= ' / ';
 282         $retval .= '<a href="#no">' . __('No') . '</a>';
 283         $retval .= '</form>';
 284         $retval .= '</div>';
 285     }
 286     return $retval;
 287 }
 288 ?>