12d7044218d0e9db4e617a1cb6ec2c796e31c987
[core.git] / 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 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          * Getter for an instance of this class
56          *
57          * @return      $configInstance An instance of this class
58          */
59         public final static function getInstance () {
60                 // is the instance there?
61                 if (is_null(self::$configInstance))  {
62                         // Create a config instance
63                         self::$configInstance = new FrameworkConfiguration();
64                 } // END - if
65
66                 return self::$configInstance;
67         }
68
69         /**
70          * Setter for default time zone (must be correct!)
71          *
72          * @param               $zone   The time-zone string (e.g. Europe/Berlin)
73          * @return      void
74          */
75         public final function setDefaultTimezone ($zone) {
76                 // At least 5.1.0 is required for this!
77                 if (version_compare(phpversion(), "5.1.0")) {
78                         @date_default_timezone_set($zone);
79                 } // END - if
80         }
81
82         /**
83          * Setter for runtime magic quotes
84          */
85         public final function setMagicQuotesRuntime ($enableQuotes) {
86                 // Cast it to boolean
87                 $enableQuotes = (boolean) $enableQuotes;
88
89                 // Set it
90                 @set_magic_quotes_runtime($enableQuotes);
91         }
92
93         /**
94          * A private include loader
95          *
96          * @param       $arrayObject    The array object with all include files
97          * @return      void
98          */
99         private function loadIncludes (ArrayObject $arrayObject) {
100                 // Load only if there are includes defined
101                 if (!is_null($arrayObject)) {
102                         for ($idx = $arrayObject->getIterator(); $idx->valid(); $idx->next()) {
103                                 // Get include file
104                                 $inc = $idx->current();
105
106                                 // Is the file name really set?
107                                 if (!empty($inc)) {
108                                         // Base path is by default added
109                                         $fqfn = $inc;
110
111                                         // Base path added? (Uni* / Windows)
112                                         if ((substr($inc, 0, 1) != '/') && (substr($inc, 1, 1) != ':')) {
113                                                 // Generate FQFN
114                                                 $fqfn = $this->getConfigEntry('base_path') . '/inc/extra/' . $inc;
115                                         } // END - if
116                                 } // END - if
117
118                                 // Include them all here
119                                 require($fqfn);
120                         }
121                 } // END - if
122         }
123
124         /**
125          * Read a configuration element.
126          *
127          * @param       $cfgEntry       The configuration element
128          * @return      $cfgValue       The fetched configuration value
129          * @throws      ConfigEntryIsEmptyException             If $cfgEntry is empty
130          * @throws      ConfigEntryNotFoundException    If a configuration element
131          *                                                                                      was not found
132          */
133         public function getConfigEntry ($cfgEntry) {
134                 // Cast to string
135                 $cfgEntry = (string) $cfgEntry;
136
137                 // Is a valid configuration entry provided?
138                 if (empty($cfgEntry)) {
139                         // Entry is empty
140                         throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
141                 } elseif (!isset($this->config[$cfgEntry])) {
142                         // Entry was not found!
143                         throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
144                 }
145
146                 // Return the requested value
147                 return $this->config[$cfgEntry];
148         }
149
150         /**
151          * Set a configuration entry.
152          *
153          * @param       $cfgEntry       The configuration entry we want to add/change
154          * @param       $cfgValue       The configuration value we want to set
155          * @return      void
156          * @throws      ConfigEntryIsEmptyException     If $cfgEntry is empty
157          */
158         public final function setConfigEntry ($cfgEntry, $cfgValue) {
159                 // Cast to string
160                 $cfgEntry = (string) $cfgEntry;
161                 $cfgValue = (string) $cfgValue;
162
163                 // Is a valid configuration entry provided?
164                 if (empty($cfgEntry)) {
165                         // Entry is empty
166                         throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
167                 } // END - if
168
169                 // Set the configuration value
170                 $this->config[$cfgEntry] = $cfgValue;
171
172                 // Resort the array
173                 ksort($this->config);
174         }
175
176         /**
177          * Compatiblity method to return this class' name
178          *
179          * @return      __CLASS__               This class' name
180          */
181         public function __toString () {
182                 return get_class($this);
183         }
184
185         /**
186          * Dectect and return the base URL for all URLs and forms
187          *
188          * @return      $baseUrl        Detected base URL
189          */
190         public function detectBaseUrl() {
191                 // Initialize the URL
192                 $baseUrl = 'http';
193
194                 // Do we have HTTPS?
195                 if (isset($_SERVER['HTTPS'])) {
196                         // Add the >s< for HTTPS
197                         $baseUrl .= 's';
198                 } // END - if
199
200                 // Construct the full URL and secure it against CSRF attacks
201                 $baseUrl = $baseUrl . '://' . $this->detectDomain() . $this->detectScriptPath();
202
203                 // Return the URL
204                 return $baseUrl;
205         }
206
207         /**
208          * Detect safely and return the full domain where this script is installed
209          *
210          * @return      $fullDomain             The detected full domain
211          */
212         public function detectDomain () {
213                 // Full domain is localnet.invalid by default
214                 $fullDomain = 'localnet.invalid';
215
216                 // Is the server name there?
217                 if (isset($_SERVER['SERVER_NAME'])) {
218                         // Detect the full domain
219                         $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES);
220                 } // END - if
221
222                 // Return it
223                 return $fullDomain;
224         }
225
226         /**
227          * Detect safely the script path without trailing slash which is the glue
228          * between "http://your-domain.invalid/" and "script-name.php"
229          *
230          * @return      $scriptPath             The script path extracted from $_SERVER['SCRIPT_NAME']
231          */
232         public function detectScriptPath () {
233                 // Default is empty
234                 $scriptPath = '';
235
236                 // Is the scriptname set?
237                 if (isset($_SERVER['SCRIPT_NAME'])) {
238                         // Get dirname from it and replace back-slashes with slashes for lame OSes...
239                         $scriptPath = str_replace("\\", '/', dirname($_SERVER['SCRIPT_NAME']));
240                 } // END - if
241
242                 // Return it
243                 return $scriptPath;
244         }
245
246         /**
247          * Getter for field name
248          *
249          * @param       $fieldName              Field name which we shall get
250          * @return      $fieldValue             Field value from the user
251          * @throws      NullPointerException    If the result instance is null
252          */
253         public final function getField ($fieldName) {
254                 // Our super interface "FrameworkInterface" requires this
255         }
256 }
257
258 // [EOF]
259 ?>