setup/lib/ConfigFile.class.php

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