X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=43383ad5dc45fd1b68177038699f512e9cd969b7;hp=fafc68fd21c9f3aa07c20f88fc5e4546eece5d28;hb=43a5933f0bcb7e7fc57b491a459548c70aa599a0;hpb=79c811f0b38576d74bdce4f6b3ae811ac003ebe0 diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php index fafc68fd..43383ad5 100644 --- a/inc/config/class_FrameworkConfiguration.php +++ b/inc/config/class_FrameworkConfiguration.php @@ -8,7 +8,7 @@ * @see ClassLoader * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -36,7 +36,7 @@ class FrameworkConfiguration implements Registerable { /** * The configuration instance itself */ - private static $configInstance = null; + private static $configInstance = NULL; // Some constants for the configuration system const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0x130; @@ -52,139 +52,230 @@ class FrameworkConfiguration implements Registerable { } /** - * Getter for an instance of this class + * Compatiblity method to return this class' name + * + * @return __CLASS__ This class' name + */ + public function __toString () { + return get_class($this); + } + + /** + * Getter for a singleton instance of this class * - * @return $configInstance An instance of this class + * @return $configInstance A singleton instance of this class */ - public final static function getInstance () { + public static final function getSelfInstance () { // is the instance there? if (is_null(self::$configInstance)) { // Create a config instance self::$configInstance = new FrameworkConfiguration(); } // END - if + // Return singleton instance return self::$configInstance; } + /** + * Converts dashes to underscores, e.g. useable for configuration entries + * + * @param $str The string with maybe dashes inside + * @return $str The converted string with no dashed, but underscores + */ + private final function convertDashesToUnderscores ($str) { + // Convert them all + $str = str_replace('-', '_', $str); + + // Return converted string + return $str; + } + /** * Setter for default time zone (must be correct!) * - * @param $zone The time-zone string (e.g. Europe/Berlin) + * @param $zone The time-zone string (e.g. Europe/Berlin) * @return void */ public final function setDefaultTimezone ($zone) { // At least 5.1.0 is required for this! - if (version_compare(phpversion(), "5.1.0")) { - @date_default_timezone_set($zone); + if (version_compare(phpversion(), '5.1.0')) { + date_default_timezone_set($zone); } // END - if } /** * Setter for runtime magic quotes + * + * @param $enableQuotes Whether enable magic runtime quotes (should be disabled for security reasons) + * @return void */ public final function setMagicQuotesRuntime ($enableQuotes) { // Cast it to boolean $enableQuotes = (boolean) $enableQuotes; // Set it - @set_magic_quotes_runtime($enableQuotes); + set_magic_quotes_runtime($enableQuotes); } /** - * A private include loader + * Checks whether the given configuration entry is set * - * @param $arrayObject The array object with all include files - * @return void + * @param $configEntry The configuration entry we shall check + * @return $isset Whether the given configuration entry is set */ - private function loadIncludes (ArrayObject $arrayObject) { - // Load only if there are includes defined - if (!is_null($arrayObject)) { - for ($idx = $arrayObject->getIterator(); $idx->valid(); $idx->next()) { - // Get include file - $inc = $idx->current(); - - // Is the file name really set? - if (!empty($inc)) { - // Base path is by default added - $fqfn = $inc; - - // Base path added? (Uni* / Windows) - if ((substr($inc, 0, 1) != "/") && (substr($inc, 1, 1) != ":")) { - // Generate FQFN - $fqfn = sprintf("%s/inc/extra/%s", $this->readConfig('base_path'), $inc); - } // END - if - } // END - if - - // Include them all here - require($fqfn); - } - } // END - if + protected function isConfigurationEntrySet ($configEntry) { + // Is it set? + $isset = isset($this->config[$configEntry]); + + // Return the result + return $isset; } /** * Read a configuration element. * - * @param $cfgEntry The configuration element - * @return $cfgValue The fetched configuration value - * @throws ConfigEntryIsEmptyException If $cfgEntry is empty - * @throws ConfigEntryNotFoundException If a configuration element - * was not found + * @param $configEntry The configuration element + * @return $configValue The fetched configuration value + * @throws ConfigEntryIsEmptyException If $configEntry is empty + * @throws NoConfigEntryException If a configuration element was not found */ - public function readConfig ($cfgEntry) { - // Cast to string - $cfgEntry = (string) $cfgEntry; + public function getConfigEntry ($configEntry) { + // Convert dashes to underscore + $configEntry = $this->convertDashesToUnderscores($configEntry); // Is a valid configuration entry provided? - if (empty($cfgEntry)) { + if (empty($configEntry)) { // Entry is empty throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); - } elseif (!isset($this->config[$cfgEntry])) { + } elseif (!$this->isConfigurationEntrySet($configEntry)) { // Entry was not found! - throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); + throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); } - // Debug message - if ((defined('DEBUG_CONFIG')) || (defined('DEBUG_ALL'))) { - echo "[".__METHOD__."] Configuration entry ".$cfgEntry." requested.
\n"; - } // END - if - // Return the requested value - return $this->config[$cfgEntry]; + return $this->config[$configEntry]; } /** - * Set a configuration entry. + * Set a configuration entry * - * @param $cfgEntry The configuration entry we want to add/change - * @param $cfgValue The configuration value we want to set + * @param $configEntry The configuration entry we want to add/change + * @param $configValue The configuration value we want to set * @return void - * @throws ConfigEntryIsEmptyException If $cfgEntry is empty + * @throws ConfigEntryIsEmptyException If $configEntry is empty */ - public final function setConfigEntry ($cfgEntry, $cfgValue) { + public final function setConfigEntry ($configEntry, $configValue) { // Cast to string - $cfgEntry = (string) $cfgEntry; - $cfgValue = (string) $cfgValue; + $configEntry = $this->convertDashesToUnderscores($configEntry); + $configValue = (string) $configValue; // Is a valid configuration entry provided? - if (empty($cfgEntry)) { + if (empty($configEntry)) { // Entry is empty throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); } // END - if // Set the configuration value - $this->config[$cfgEntry] = $cfgValue; + //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configEntry . ',configValue=' . $configValue . PHP_EOL); + $this->config[$configEntry] = $configValue; // Resort the array ksort($this->config); } /** - * Compatiblity method to return this class' name + * Unset a configuration entry, the entry must be there or else an + * exception is thrown. * - * @return __CLASS__ This class' name + * @param $configKey Configuration entry to unset + * @return void + * @throws NoConfigEntryException If a configuration element was not found */ - public function __toString () { - return get_class($this); + public final function unsetConfigEntry ($configKey) { + // Convert dashes to underscore + $configEntry = $this->convertDashesToUnderscores($configEntry); + + // Is the configuration entry there? + if (!$this->isConfigurationEntrySet($configKey)) { + // Entry was not found! + throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); + } // END - if + + // Unset it + unset($this->config[$configKey]); + } + + /** + * Detects the server address (SERVER_ADDR) and set it in configuration + * + * @return $serverAddress The detected server address + * @todo We have to add some more entries from $_SERVER here + */ + public function detectServerAddress () { + // Is the entry set? + if (!$this->isConfigurationEntrySet('server_addr')) { + // Is it set in $_SERVER? + if (isset($_SERVER['SERVER_ADDR'])) { + // Set it from $_SERVER + $this->setServerAddress($_SERVER['SERVER_ADDR']); + } elseif (class_exists('ConsoleTools')) { + // Run auto-detecting through console tools lib + ConsoleTools::acquireSelfIPAddress(); + } + } // END - if + + // Now get it from configuration + $serverAddress = $this->getServerAddress(); + + // Return it + return $serverAddress; + } + + /** + * Setter for SERVER_ADDR + * + * @param $serverAddress New SERVER_ADDR value to set + * @return void + */ + public function setServerAddress ($serverAddress) { + $this->setConfigEntry('server_addr', (string) $serverAddress); + } + + /** + * Getter for SERVER_ADDR + * + * @return $serverAddress New SERVER_ADDR value to set + */ + public function getServerAddress () { + return $this->getConfigEntry('server_addr'); + } + + /** + * Detects the HTTPS flag + * + * @return $https The detected HTTPS flag or null if failed + */ + public function detectHttpSecured () { + // Default is null + $https = NULL; + + // Is HTTPS set? + if ($this->isHttpSecured()) { + // Then use it + $https = $_SERVER['HTTPS']; + } // END - if + + // Return it + return $https; + } + + /** + * Checks whether HTTPS is set in $_SERVER + * + * @return $isset Whether HTTPS is set + */ + public function isHttpSecured () { + return (isset($_SERVER['HTTPS'])); } /** @@ -192,18 +283,18 @@ class FrameworkConfiguration implements Registerable { * * @return $baseUrl Detected base URL */ - public function detectBaseUrl() { + public function detectBaseUrl () { // Initialize the URL - $baseUrl = "http"; + $baseUrl = 'http'; // Do we have HTTPS? - if (isset($_SERVER['HTTPS'])) { + if ($this->isHttpSecured()) { // Add the >s< for HTTPS - $baseUrl .= "s"; + $baseUrl .= 's'; } // END - if - // Construct the full URL now and secure it against CSRF attacks - $baseUrl = $baseUrl . "://" . $this->detectDomain() . $this->detectScriptPath(); + // Construct the full URL and secure it against CSRF attacks + $baseUrl = $baseUrl . '://' . $this->detectDomain() . $this->detectScriptPath(); // Return the URL return $baseUrl; @@ -216,7 +307,7 @@ class FrameworkConfiguration implements Registerable { */ public function detectDomain () { // Full domain is localnet.invalid by default - $fullDomain = "localnet.invalid"; + $fullDomain = 'localnet.invalid'; // Is the server name there? if (isset($_SERVER['SERVER_NAME'])) { @@ -236,12 +327,12 @@ class FrameworkConfiguration implements Registerable { */ public function detectScriptPath () { // Default is empty - $scriptPath = ""; + $scriptPath = ''; // Is the scriptname set? if (isset($_SERVER['SCRIPT_NAME'])) { // Get dirname from it and replace back-slashes with slashes for lame OSes... - $scriptPath = str_replace("\\", "/", dirname($_SERVER['SCRIPT_NAME'])); + $scriptPath = str_replace("\\", '/', dirname($_SERVER['SCRIPT_NAME'])); } // END - if // Return it @@ -258,6 +349,34 @@ class FrameworkConfiguration implements Registerable { public final function getField ($fieldName) { // Our super interface "FrameworkInterface" requires this } + + /** + * Generates a code for hashes from this class + * + * @return $hashCode The hash code respresenting this class + */ + public function hashCode () { + return crc32($this->__toString()); + } + + /** + * Checks whether an object equals this object. You should overwrite this + * method to implement own equality checks + * + * @param $objectInstance An instance of a FrameworkInterface object + * @return $equals Whether both objects equals + */ + public function equals (FrameworkInterface $objectInstance) { + // Now test it + $equals = (( + $this->__toString() == $objectInstance->__toString() + ) && ( + $this->hashCode() == $objectInstance->hashCode() + )); + + // Return the result + return $equals; + } } // [EOF]