3 * A class for the configuration stuff implemented in a singleton design paddern
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
9 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
28 class FrameworkConfiguration implements Registerable {
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.
34 private $config = array();
37 * The configuration instance itself
39 private static $configInstance = NULL;
41 // Some constants for the configuration system
42 const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0x130;
43 const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x131;
46 * Protected constructor
50 protected function __construct () {
55 * Compatiblity method to return this class' name
57 * @return __CLASS__ This class' name
59 public function __toString () {
60 return get_class($this);
64 * Getter for an instance of this class
66 * @return $configInstance An instance of this class
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();
75 return self::$configInstance;
79 * Setter for default time zone (must be correct!)
81 * @param $zone The time-zone string (e.g. Europe/Berlin)
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);
92 * Setter for runtime magic quotes
94 * @param $enableQuotes Whether enable magic runtime quotes (should be disabled for security reasons)
97 public final function setMagicQuotesRuntime ($enableQuotes) {
99 $enableQuotes = (boolean) $enableQuotes;
102 set_magic_quotes_runtime($enableQuotes);
106 * Checks whether the given configuration entry is set
108 * @param $configEntry The configuration entry we shall check
109 * @return $isset Whether the given configuration entry is set
111 protected function isConfigurationEntrySet ($configEntry) {
113 $isset = isset($this->config[$configEntry]);
120 * Read a configuration element.
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
127 public function getConfigEntry ($configEntry) {
129 $configEntry = (string) $configEntry;
131 // Is a valid configuration entry provided?
132 if (empty($configEntry)) {
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);
140 // Return the requested value
141 return $this->config[$configEntry];
145 * Set a configuration entry
147 * @param $configEntry The configuration entry we want to add/change
148 * @param $configValue The configuration value we want to set
150 * @throws ConfigEntryIsEmptyException If $configEntry is empty
152 public final function setConfigEntry ($configEntry, $configValue) {
154 $configEntry = (string) $configEntry;
155 $configValue = (string) $configValue;
157 // Is a valid configuration entry provided?
158 if (empty($configEntry)) {
160 throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
163 // Set the configuration value
164 $this->config[$configEntry] = $configValue;
167 ksort($this->config);
171 * Unset a configuration entry, the entry must be there or else an
172 * exception is thrown.
174 * @param $configKey Configuration entry to unset
176 * @throws NoConfigEntryException If a configuration element was not found
178 public final function unsetConfigEntry ($configKey) {
179 // Is the configuration entry there?
180 if (!$this->isConfigurationEntrySet($configKey)) {
181 // Entry was not found!
182 throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
186 unset($this->config[$configKey]);
190 * Detects the server address (SERVER_ADDR) and set it in configuration
192 * @return $serverAddress The detected server address
193 * @todo We have to add some more entries from $_SERVER here
195 public function detectServerAddress () {
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();
208 // Now get it from configuration
209 $serverAddress = $this->getServerAddress();
212 return $serverAddress;
216 * Setter for SERVER_ADDR
218 * @param $serverAddress New SERVER_ADDR value to set
221 public function setServerAddress ($serverAddress) {
222 $this->setConfigEntry('server_addr', (string) $serverAddress);
226 * Getter for SERVER_ADDR
228 * @return $serverAddress New SERVER_ADDR value to set
230 public function getServerAddress () {
231 return $this->getConfigEntry('server_addr');
235 * Detects the HTTPS flag
237 * @return $https The detected HTTPS flag or null if failed
239 public function detectHttpSecured () {
244 if ($this->isHttpSecured()) {
246 $https = $_SERVER['HTTPS'];
254 * Checks whether HTTPS is set in $_SERVER
256 * @return $isset Whether HTTPS is set
258 public function isHttpSecured () {
259 return (isset($_SERVER['HTTPS']));
263 * Dectect and return the base URL for all URLs and forms
265 * @return $baseUrl Detected base URL
267 public function detectBaseUrl () {
268 // Initialize the URL
272 if ($this->isHttpSecured()) {
273 // Add the >s< for HTTPS
277 // Construct the full URL and secure it against CSRF attacks
278 $baseUrl = $baseUrl . '://' . $this->detectDomain() . $this->detectScriptPath();
285 * Detect safely and return the full domain where this script is installed
287 * @return $fullDomain The detected full domain
289 public function detectDomain () {
290 // Full domain is localnet.invalid by default
291 $fullDomain = 'localnet.invalid';
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);
304 * Detect safely the script path without trailing slash which is the glue
305 * between "http://your-domain.invalid/" and "script-name.php"
307 * @return $scriptPath The script path extracted from $_SERVER['SCRIPT_NAME']
309 public function detectScriptPath () {
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']));
324 * Getter for field name
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
330 public final function getField ($fieldName) {
331 // Our super interface "FrameworkInterface" requires this
335 * Generates a code for hashes from this class
337 * @return $hashCode The hash code respresenting this class
339 public function hashCode () {
340 return crc32($this->__toString());
344 * Checks whether an object equals this object. You should overwrite this
345 * method to implement own equality checks
347 * @param $objectInstance An instance of a FrameworkInterface object
348 * @return $equals Whether both objects equals
350 public function equals (FrameworkInterface $objectInstance) {
353 $this->__toString() == $objectInstance->__toString()
355 $this->hashCode() == $objectInstance->hashCode()