inc/config/class_FrameworkConfiguration.php

   1 <?php
   2 /**
   3  * A class for the configuration stuff implemented in a singleton design paddern
   4  *
   5  * NOTE: We cannot put this in inc/classes/ because it would be loaded (again) in
   6  * class loader. See inc/loader/class_ClassLoader.php for instance
   7  *
   8  * @see                 ClassLoader
   9  * @author              Roland Haeder <webmaster@ship-simu.org>
  10  * @version             0.0.0
  11  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  12  * @license             GNU GPL 3.0 or any newer version
  13  * @link                http://www.ship-simu.org
  14  *
  15  * This program is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation, either version 3 of the License, or
  18  * (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  27  */
  28 class FrameworkConfiguration implements Registerable {
  29         /**
  30          * The framework's main configuration array which will be initialized with
  31          * hard-coded configuration data and might be overwritten/extended by
  32          * config data from the database.
  33          */
  34         private $config = array();
  35
  36         /**
  37          * The configuration instance itself
  38          */
  39         private static $configInstance = NULL;
  40
  41         // Some constants for the configuration system
  42         const EXCEPTION_CONFIG_ENTRY_IS_EMPTY      = 0x130;
  43         const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x131;
  44
  45         /**
  46          * Protected constructor
  47          *
  48          * @return      void
  49          */
  50         protected function __construct () {
  51                 // Empty for now
  52         }
  53
  54         /**
  55          * Compatiblity method to return this class' name
  56          *
  57          * @return      __CLASS__               This class' name
  58          */
  59         public function __toString () {
  60                 return get_class($this);
  61         }
  62
  63         /**
  64          * Getter for an instance of this class
  65          *
  66          * @return      $configInstance An instance of this class
  67          */
  68         public static final function getSelfInstance () {
  69                 // is the instance there?
  70                 if (is_null(self::$configInstance))  {
  71                         // Create a config instance
  72                         self::$configInstance = new FrameworkConfiguration();
  73                 } // END - if
  74
  75                 return self::$configInstance;
  76         }
  77
  78         /**
  79          * Setter for default time zone (must be correct!)
  80          *
  81          * @param       $zone   The time-zone string (e.g. Europe/Berlin)
  82          * @return      void
  83          */
  84         public final function setDefaultTimezone ($zone) {
  85                 // At least 5.1.0 is required for this!
  86                 if (version_compare(phpversion(), '5.1.0')) {
  87                         date_default_timezone_set($zone);
  88                 } // END - if
  89         }
  90
  91         /**
  92          * Setter for runtime magic quotes
  93          *
  94          * @param       $enableQuotes   Whether enable magic runtime quotes (should be disabled for security reasons)
  95          * @return      void
  96          */
  97         public final function setMagicQuotesRuntime ($enableQuotes) {
  98                 // Cast it to boolean
  99                 $enableQuotes = (boolean) $enableQuotes;
 100
 101                 // Set it
 102                 set_magic_quotes_runtime($enableQuotes);
 103         }
 104
 105         /**
 106          * Checks whether the given configuration entry is set
 107          *
 108          * @param       $configEntry    The configuration entry we shall check
 109          * @return      $isset                  Whether the given configuration entry is set
 110          */
 111         protected function isConfigurationEntrySet ($configEntry) {
 112                 // Is it set?
 113                 $isset = isset($this->config[$configEntry]);
 114
 115                 // Return the result
 116                 return $isset;
 117         }
 118
 119         /**
 120          * Read a configuration element.
 121          *
 122          * @param       $configEntry    The configuration element
 123          * @return      $configValue    The fetched configuration value
 124          * @throws      ConfigEntryIsEmptyException             If $configEntry is empty
 125          * @throws      NoConfigEntryException  If a configuration element was not found
 126          */
 127         public function getConfigEntry ($configEntry) {
 128                 // Cast to string
 129                 $configEntry = (string) $configEntry;
 130
 131                 // Is a valid configuration entry provided?
 132                 if (empty($configEntry)) {
 133                         // Entry is empty
 134                         throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
 135                 } elseif (!$this->isConfigurationEntrySet($configEntry)) {
 136                         // Entry was not found!
 137                         throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
 138                 }
 139
 140                 // Return the requested value
 141                 return $this->config[$configEntry];
 142         }
 143
 144         /**
 145          * Set a configuration entry
 146          *
 147          * @param       $configEntry    The configuration entry we want to add/change
 148          * @param       $configValue    The configuration value we want to set
 149          * @return      void
 150          * @throws      ConfigEntryIsEmptyException             If $configEntry is empty
 151          */
 152         public final function setConfigEntry ($configEntry, $configValue) {
 153                 // Cast to string
 154                 $configEntry = (string) $configEntry;
 155                 $configValue = (string) $configValue;
 156
 157                 // Is a valid configuration entry provided?
 158                 if (empty($configEntry)) {
 159                         // Entry is empty
 160                         throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
 161                 } // END - if
 162
 163                 // Set the configuration value
 164                 $this->config[$configEntry] = $configValue;
 165
 166                 // Resort the array
 167                 ksort($this->config);
 168         }
 169
 170         /**
 171          * Unset a configuration entry, the entry must be there or else an
 172          * exception is thrown.
 173          *
 174          * @param       $configKey      Configuration entry to unset
 175          * @return      void
 176          * @throws      NoConfigEntryException  If a configuration element was not found
 177          */
 178         public final function unsetConfigEntry ($configKey) {
 179                 // Is the configuration entry there?
 180                 if (!$this->isConfigurationEntrySet($configEntry)) {
 181                         // Entry was not found!
 182                         throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
 183                 } // END - if
 184
 185                 // Unset it
 186                 unset($this->config[$configKey]);
 187         }
 188
 189         /**
 190          * Detects the server address (SERVER_ADDR) and set it in configuration
 191          *
 192          * @return      $serverAddress  The detected server address
 193          * @todo        We have to add some more entries from $_SERVER here
 194          */
 195         public function detectServerAddress () {
 196                 // Is the entry set?
 197                 if (!$this->isConfigurationEntrySet('server_addr')) {
 198                         // Is it set in $_SERVER?
 199                         if (isset($_SERVER['SERVER_ADDR'])) {
 200                                 // Set it from $_SERVER
 201                                 $this->setServerAddress($_SERVER['SERVER_ADDR']);
 202                         } elseif (class_exists('ConsoleTools')) {
 203                                 // Run auto-detecting through console tools lib
 204                                 ConsoleTools::acquireSelfIPAddress();
 205                         }
 206                 } // END - if
 207
 208                 // Now get it from configuration
 209                 $serverAddress = $this->getServerAddress();
 210
 211                 // Return it
 212                 return $serverAddress;
 213         }
 214
 215         /**
 216          * Setter for SERVER_ADDR
 217          *
 218          * @param       $serverAddress  New SERVER_ADDR value to set
 219          * @return      void
 220          */
 221         public function setServerAddress ($serverAddress) {
 222                 $this->setConfigEntry('server_addr', (string) $serverAddress);
 223         }
 224
 225         /**
 226          * Getter for SERVER_ADDR
 227          *
 228          * @return      $serverAddress  New SERVER_ADDR value to set
 229          */
 230         public function getServerAddress () {
 231                 return $this->getConfigEntry('server_addr');
 232         }
 233
 234         /**
 235          * Detects the HTTPS flag
 236          *
 237          * @return      $https  The detected HTTPS flag or null if failed
 238          */
 239         public function detectHttpSecured () {
 240                 // Default is null
 241                 $https = NULL;
 242
 243                 // Is HTTPS set?
 244                 if ($this->isHttpSecured()) {
 245                         // Then use it
 246                         $https = $_SERVER['HTTPS'];
 247                 } // END - if
 248
 249                 // Return it
 250                 return $https;
 251         }
 252
 253         /**
 254          * Checks whether HTTPS is set in $_SERVER
 255          *
 256          * @return $isset       Whether HTTPS is set
 257          */
 258         public function isHttpSecured () {
 259                 return (isset($_SERVER['HTTPS']));
 260         }
 261
 262         /**
 263          * Dectect and return the base URL for all URLs and forms
 264          *
 265          * @return      $baseUrl        Detected base URL
 266          */
 267         public function detectBaseUrl () {
 268                 // Initialize the URL
 269                 $baseUrl = 'http';
 270
 271                 // Do we have HTTPS?
 272                 if ($this->isHttpSecured()) {
 273                         // Add the >s< for HTTPS
 274                         $baseUrl .= 's';
 275                 } // END - if
 276
 277                 // Construct the full URL and secure it against CSRF attacks
 278                 $baseUrl = $baseUrl . '://' . $this->detectDomain() . $this->detectScriptPath();
 279
 280                 // Return the URL
 281                 return $baseUrl;
 282         }
 283
 284         /**
 285          * Detect safely and return the full domain where this script is installed
 286          *
 287          * @return      $fullDomain             The detected full domain
 288          */
 289         public function detectDomain () {
 290                 // Full domain is localnet.invalid by default
 291                 $fullDomain = 'localnet.invalid';
 292
 293                 // Is the server name there?
 294                 if (isset($_SERVER['SERVER_NAME'])) {
 295                         // Detect the full domain
 296                         $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES);
 297                 } // END - if
 298
 299                 // Return it
 300                 return $fullDomain;
 301         }
 302
 303         /**
 304          * Detect safely the script path without trailing slash which is the glue
 305          * between "http://your-domain.invalid/" and "script-name.php"
 306          *
 307          * @return      $scriptPath             The script path extracted from $_SERVER['SCRIPT_NAME']
 308          */
 309         public function detectScriptPath () {
 310                 // Default is empty
 311                 $scriptPath = '';
 312
 313                 // Is the scriptname set?
 314                 if (isset($_SERVER['SCRIPT_NAME'])) {
 315                         // Get dirname from it and replace back-slashes with slashes for lame OSes...
 316                         $scriptPath = str_replace("\\", '/', dirname($_SERVER['SCRIPT_NAME']));
 317                 } // END - if
 318
 319                 // Return it
 320                 return $scriptPath;
 321         }
 322
 323         /**
 324          * Getter for field name
 325          *
 326          * @param       $fieldName              Field name which we shall get
 327          * @return      $fieldValue             Field value from the user
 328          * @throws      NullPointerException    If the result instance is null
 329          */
 330         public final function getField ($fieldName) {
 331                 // Our super interface "FrameworkInterface" requires this
 332         }
 333
 334         /**
 335          * Generates a code for hashes from this class
 336          *
 337          * @return      $hashCode       The hash code respresenting this class
 338          */
 339         public function hashCode () {
 340                 return crc32($this->__toString());
 341         }
 342
 343         /**
 344          * Checks whether an object equals this object. You should overwrite this
 345          * method to implement own equality checks
 346          *
 347          * @param       $objectInstance         An instance of a FrameworkInterface object
 348          * @return      $equals                         Whether both objects equals
 349          */
 350         public function equals (FrameworkInterface $objectInstance) {
 351                 // Now test it
 352                 $equals = ((
 353                         $this->__toString() == $objectInstance->__toString()
 354                 ) && (
 355                         $this->hashCode() == $objectInstance->hashCode()
 356                 ));
 357
 358                 // Return the result
 359                 return $equals;
 360         }
 361 }
 362
 363 // [EOF]
 364 ?>