setup/lib/ConfigFile.class.php

   1 <?php
   2 /**
   3  * Config file management and generation
   4  *
   5  * @license    http://www.gnu.org/licenses/gpl.html GNU GPL 2.0
   6  * @version    $Id$
   7  * @package    phpMyAdmin-setup
   8  */
   9
  10 /**
  11  * Config file management and generation class
  12  *
  13  * @package    phpMyAdmin-setup
  14  */
  15 class ConfigFile
  16 {
  17     /**
  18      * Stores default PMA config from config.default.php
  19      * @var array
  20      */
  21     private $cfg;
  22
  23     /**
  24      * Stores allowed values for non-standard fields
  25      * @var array
  26      */
  27     private $cfgDb;
  28
  29     /**
  30      * Keys which will be always written to config file
  31      * @var array
  32      */
  33     private $persistKeys;
  34
  35     /**
  36      * ConfigFile instance
  37      * @var ConfigFile
  38      */
  39     private static $_instance;
  40
  41     /**
  42      * Private constructor, use {@link getInstance()}
  43      */
  44     private function __construct()
  45     {
  46         // load default config values
  47         $cfg = &$this->cfg;
  48         require './libraries/config.default.php';
  49
  50         // load additionsl config information
  51         $cfg_db = &$this->cfgDb;
  52         $persist_keys = array();
  53         require './setup/lib/config_info.inc.php';
  54
  55         // apply default values overrides
  56         if (count($cfg_db['_overrides'])) {
  57             foreach ($cfg_db['_overrides'] as $path => $value) {
  58                 array_write($path, $cfg, $value);
  59             }
  60         }
  61
  62         // checking key presence is much faster than searching so move values to keys
  63         $this->persistKeys = array_flip($persist_keys);
  64     }
  65
  66     /**
  67      * Returns class instance
  68      *
  69      * @return ConfigFile
  70      */
  71     public static function getInstance()
  72     {
  73         if (is_null(self::$_instance)) {
  74             self::$_instance = new ConfigFile();
  75         }
  76         return self::$_instance;
  77     }
  78
  79     /**
  80      * Sets config value
  81      *
  82      * @param string $path
  83      * @param mixed  $value
  84      * @param string $canonical_path
  85      */
  86     public function set($path, $value, $canonical_path = null)
  87     {
  88         if ($canonical_path === null) {
  89             $canonical_path = $this->getCanonicalPath($path);
  90         }
  91         // remove if the path isn't protected and it's empty or has a default value
  92         $default_value = $this->getDefault($canonical_path);
  93         if (!isset($this->persistKeys[$canonical_path])
  94             && (($value == $default_value) || (empty($value) && empty($default_value)))) {
  95             array_remove($path, $_SESSION['ConfigFile']);
  96         } else {
  97             array_write($path, $_SESSION['ConfigFile'], $value);
  98         }
  99     }
 100
 101     /**
 102      * Returns config value or $default if it's not set
 103      *
 104      * @param  string $path
 105      * @param  mixed  $default
 106      * @return mixed
 107      */
 108     public function get($path, $default = null)
 109     {
 110         return array_read($path, $_SESSION['ConfigFile'], $default);
 111     }
 112
 113     /**
 114      * Returns default config value or $default it it's not set ie. it doesn't
 115      * exist in config.default.php ($cfg) and config_info.inc.php
 116      * ($_cfg_db['_overrides'])
 117      *
 118      * @param  string $canonical_path
 119      * @param  mixed  $default
 120      * @return mixed
 121      */
 122     public function getDefault($canonical_path, $default = null)
 123     {
 124         return array_read($canonical_path, $this->cfg, $default);
 125     }
 126
 127     /**
 128      * Returns config value, if it's not set uses the default one; returns
 129      * $default if the path isn't set and doesn't contain a default value
 130      *
 131      * @param  string $path
 132      * @param  mixed  $default
 133      * @return mixed
 134      */
 135     public function getValue($path, $default = null)
 136     {
 137         $v = array_read($path, $_SESSION['ConfigFile'], null);
 138         if ($v !== null) {
 139             return $v;
 140         }
 141         $path = $this->getCanonicalPath($path);
 142         return $this->getDefault($path, $default);
 143     }
 144
 145     /**
 146      * Returns canonical path
 147      *
 148      * @param string $path
 149      * @return string
 150      */
 151     public function getCanonicalPath($path) {
 152         return preg_replace('#^Servers/([\d]+)/#', 'Servers/1/', $path);
 153     }
 154
 155     /**
 156      * Returns config database entry for $path ($cfg_db in config_info.php)
 157      *
 158      * @param  string $path
 159      * @param  mixed  $default
 160      * @return mixed
 161      */
 162     public function getDbEntry($path, $default = null)
 163     {
 164         return array_read($path, $this->cfgDb, $default);
 165     }
 166
 167     /**
 168      * Returns server count
 169      *
 170      * @return int
 171      */
 172     public function getServerCount()
 173     {
 174       return isset($_SESSION['ConfigFile']['Servers'])
 175           ? count($_SESSION['ConfigFile']['Servers'])
 176           : 0;
 177     }
 178
 179     /**
 180      * Returns DSN of given server
 181      *
 182      * @param integer $server
 183      * @return string
 184      */
 185     function getServerDSN($server)
 186     {
 187         if (!isset($_SESSION['ConfigFile']['Servers'][$server])) {
 188             return '';
 189         }
 190
 191         $path = 'Servers/' . $server;
 192         $dsn = $this->getValue("$path/extension") . '://';
 193         if ($this->getValue("$path/auth_type") == 'config') {
 194             $dsn .= $this->getValue("$path/user");
 195             if (!$this->getValue("$path/nopassword")) {
 196                 $dsn .= ':***';
 197             }
 198             $dsn .= '@';
 199         }
 200         if ($this->getValue("$path/connect_type") == 'tcp') {
 201             $dsn .= $this->getValue("$path/host");
 202             $port = $this->getValue("$path/port");
 203             if ($port) {
 204                 $dsn .= ':' . $port;
 205             }
 206         } else {
 207             $dsn .= $this->getValue("$path/socket");
 208         }
 209         return $dsn;
 210     }
 211
 212     /**
 213      * Returns server name
 214      *
 215      * @param int $id
 216      * @return string
 217      */
 218     public function getServerName($id)
 219     {
 220         if (!isset($_SESSION['ConfigFile']['Servers'][$id])) {
 221             return '';
 222         }
 223         $verbose = $this->get("Servers/$id/verbose");
 224         if (!empty($verbose)) {
 225             return $verbose;
 226         }
 227         $host = $this->get("Servers/$id/host");
 228         return empty($host) ? 'localhost' : $host;
 229     }
 230
 231     /**
 232      * Removes server
 233      *
 234      * @param int $server
 235      */
 236     public function removeServer($server)
 237     {
 238         if (!isset($_SESSION['ConfigFile']['Servers'][$server])) {
 239             return;
 240         }
 241         $last_server = $this->getServerCount();
 242
 243         for ($i = $server; $i < $last_server; $i++) {
 244             $_SESSION['ConfigFile']['Servers'][$i] = $_SESSION['ConfigFile']['Servers'][$i+1];
 245         }
 246         unset($_SESSION['ConfigFile']['Servers'][$last_server]);
 247
 248         if (isset($_SESSION['ConfigFile']['ServerDefault'])
 249             && $_SESSION['ConfigFile']['ServerDefault'] >= 0) {
 250             unset($_SESSION['ConfigFile']['ServerDefault']);
 251         }
 252     }
 253
 254     /**
 255      * Returns config file path
 256      *
 257      * @return unknown
 258      */
 259     public function getFilePath()
 260     {
 261         return $this->getDbEntry('_config_file_path');
 262     }
 263
 264     /**
 265      * Creates config file
 266      *
 267      * @return string
 268      */
 269     public function getConfigFile()
 270     {
 271         $crlf = (isset($_SESSION['eol']) && $_SESSION['eol'] == 'win') ? "\r\n" : "\n";
 272         $c = $_SESSION['ConfigFile'];
 273
 274         // header
 275         $ret = '<?php' . $crlf
 276             . '/*' . $crlf
 277             . ' * Generated configuration file' . $crlf
 278             . ' * Generated by: phpMyAdmin '
 279                     . $GLOBALS['PMA_Config']->get('PMA_VERSION')
 280                     . ' setup script by Piotr Przybylski <piotrprz@gmail.com>' . $crlf
 281             . ' * Date: ' . date(DATE_RFC1123) . $crlf
 282             . ' */' . $crlf . $crlf;
 283
 284         // servers
 285         if ($this->getServerCount() > 0) {
 286             $ret .= "/* Servers configuration */$crlf\$i = 0;" . $crlf . $crlf;
 287             foreach ($c['Servers'] as $id => $server) {
 288                 $ret .= '/* Server: ' . strtr($this->getServerName($id), '*/', '-') . " [$id] */" . $crlf
 289                     . '$i++;' . $crlf;
 290                 foreach ($server as $k => $v) {
 291                     $k = preg_replace('/[^A-Za-z0-9_]/', '_', $k);
 292                     $ret .= "\$cfg['Servers'][\$i]['$k'] = "
 293                         . var_export($v, true) . ';' . $crlf;
 294                 }
 295                 $ret .= $crlf;
 296             }
 297             $ret .= '/* End of servers configuration */' . $crlf . $crlf;
 298         }
 299         unset($c['Servers']);
 300
 301         // other settings
 302         $persistKeys = $this->persistKeys;
 303         foreach ($c as $k => $v) {
 304             $k = preg_replace('/[^A-Za-z0-9_]/', '_', $k);
 305             $ret .= "\$cfg['$k'] = " . var_export($v, true) . ';' . $crlf;
 306             if (isset($persistKeys[$k])) {
 307                 unset($persistKeys[$k]);
 308             }
 309         }
 310         // keep 1d array keys which are present in $persist_keys (config_info.inc.php)
 311         foreach (array_keys($persistKeys) as $k) {
 312             if (strpos($k, '/') === false) {
 313                 $k = preg_replace('/[^A-Za-z0-9_]/', '_', $k);
 314                 $ret .= "\$cfg['$k'] = " . var_export($this->getDefault($k), true) . ';' . $crlf;
 315             }
 316         }
 317         $ret .= '?>';
 318
 319         return $ret;
 320     }
 321 }
 322 ?>