Debug mailer finished and debug messages removed:
[shipsimu.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)
6  * in the 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, this is free software
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 $cfgInstance = 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          * "Create" a configuration instance
56          *
57          * @param       $enableDebug    Wether enable debug mode (default: off)
58          * @return      $cfgInstance    An instance of this configuration class
59          */
60         public final static function createFrameworkConfiguration ($enableDebug = false) {
61                 /**
62                  * For singleton design pattern because we only need a one-time-run
63                  * through the initial configuration.
64                  */
65                 if (is_null(self::$cfgInstance))  {
66                         // CFG: ERROR-REPORTING
67                         @error_reporting(E_ALL | E_STRICT);
68
69                         /**
70                          * Shall we enable the debug mode?
71                          */
72                         if ($enableDebug) {
73                                 define('DEBUG_MODE', true);
74                         }
75
76                         /**
77                          * Crate a config instance
78                          */
79                         self::$cfgInstance = new FrameworkConfiguration();
80                 }
81
82                 /**
83                  * Return the instance
84                  */
85                 return self::$cfgInstance;
86         }
87
88         /**
89          * Getter for an instance of this class
90          *
91          * @return      $cfgInstance    An instance of this class
92          */
93         public final static function getInstance () {
94                 return self::$cfgInstance;
95         }
96
97         /**
98          * Setter for default time zone (must be correct!)
99          *
100          * @param               $zone   The time-zone string (e.g. Europe/Berlin)
101          * @return      void
102          */
103         public final function setDefaultTimezone ($zone) {
104                 // At least 5.1.0 is required for this!
105                 if (version_compare(phpversion(), "5.1.0")) {
106                         @date_default_timezone_set($zone);
107                 } // END - if
108         }
109
110         /**
111          * Setter for runtime magic quotes
112          */
113         public final function setMagicQuotesRuntime ($enableQuotes) {
114                 // Cast it to boolean
115                 $enableQuotes = (boolean) $enableQuotes;
116
117                 // Set it
118                 @set_magic_quotes_runtime($enableQuotes);
119         }
120
121         /**
122          * A private include loader
123          *
124          * @param       $arrayObject    The array object with all include files
125          * @return      void
126          */
127         private function loadIncludes (ArrayObject $arrayObject) {
128                 // Load only if there are includes defined
129                 if (!is_null($arrayObject)) {
130                         for ($idx = $arrayObject->getIterator(); $idx->valid(); $idx->next()) {
131                                 // Get include file
132                                 $inc = $idx->current();
133
134                                 // Is the file name really set?
135                                 if (!empty($inc)) {
136                                         // Base path added? (Uni* / Windows)
137                                         if ((substr($inc, 0, 1) != "/") && (substr($inc, 1, 1) != ":")) {
138                                                 // Generate FQFN
139                                                 $fqfn = sprintf("%s/inc/extra/%s", PATH, $inc);
140                                         } else {
141                                                 // Base path is already added
142                                                 $fqfn = $inc;
143                                         }
144                                 } // END - if
145
146                                 // Include them all here
147                                 require($fqfn);
148                         }
149                 } // END - if
150         }
151
152         /**
153          * Define the database type which must be valid and will not be verified.
154          *
155          * @param               $type   The database type. See path inc/database/.
156          * @return      void
157          */
158         public function defineDatabaseType ($type) {
159                 // Is it defined or not?
160                 if (!defined('_DB_TYPE')) {
161                         // Cast to string
162                         $type = (string) $type;
163
164                         // Set the constant
165                         define('_DB_TYPE', $type);
166                 } else {
167                         // Already defined! But we cannot throw an exception here... :(
168                         ApplicationEntryPoint::app_die(sprintf("[%s:] Please define the database type only once in your application!",
169                                 __CLASS__
170                         ));
171                 }
172         }
173
174         /**
175          * Define the local file path
176          *
177          * @param               $path   Local file path for include files.
178          * @return      void
179          */
180         public function definePath ($path) {
181                 // Cast to string
182                 $path = (string) $path;
183
184                 // Replace backslashes with slashes
185                 $path = str_replace("\\", "/", $path);
186
187                 // Is it defined or not?
188                 if ((!is_dir($path)) || (!is_readable($path))) {
189                         // Is not a valid path
190                         ApplicationEntryPoint::app_die(sprintf("[%s:] Invalid path (not found) specified. Please make sure it is created.",
191                                 __CLASS__
192                         ));
193                 } elseif (!defined('PATH')) {
194                         // Set the constant
195                         define('PATH', $path);
196                 } else {
197                         // Already defined! But we cannot throw an exception here... :(
198                         ApplicationEntryPoint::app_die(sprintf("[%s:] Please define the local file path only once in your application.",
199                                 __CLASS__
200                         ));
201                 }
202         }
203
204         /**
205          * Read a configuration element.
206          *
207          * @param               $cfgEntry       The configuration element
208          * @return      $cfgValue       The fetched configuration value
209          * @throws      ConfigEntryIsEmptyException     If $cfgEntry is empty
210          * @throws      ConfigEntryNotFoundException    If a configuration element
211          *                                                                      was not found
212          */
213         public function readConfig ($cfgEntry) {
214                 // Cast to string
215                 $cfgEntry = (string) $cfgEntry;
216
217                 // Is a valid configuration entry provided?
218                 if (empty($cfgEntry)) {
219                         // Entry is empty
220                         throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
221                 } elseif (!isset($this->config[$cfgEntry])) {
222                         // Entry was not found!
223                         throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
224                 }
225
226                 // Debug message
227                 if ((defined('DEBUG_CONFIG')) || (defined('DEBUG_ALL'))) {
228                         echo "[".__METHOD__."] Configuration entry ".$cfgEntry." requested.<br />\n";
229                 } // END - if
230
231                 // Return the requested value
232                 return $this->config[$cfgEntry];
233         }
234
235         /**
236          * Set a configuration entry.
237          *
238          * @param               $cfgEntry       The configuration entry we want to add/change
239          * @param               $cfgValue       The configuration value we want to set
240          * @return      void
241          * @throws      ConfigEntryIsEmptyException     If $cfgEntry is empty
242          */
243         public final function setConfigEntry ($cfgEntry, $cfgValue) {
244                 // Cast to string
245                 $cfgEntry = (string) $cfgEntry;
246                 $cfgValue = (string) $cfgValue;
247
248                 // Is a valid configuration entry provided?
249                 if (empty($cfgEntry)) {
250                         // Entry is empty
251                         throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
252                 } // END - if
253
254                 // Set the configuration value
255                 $this->config[$cfgEntry] = $cfgValue;
256
257                 // Resort the array
258                 ksort($this->config);
259         }
260
261         /**
262          * Compatiblity method to return this class' name
263          *
264          * @return      __CLASS__               This class' name
265          */
266         public function __toString () {
267                 return get_class($this);
268         }
269
270         /**
271          * Dectect and return the base URL for all URLs and forms
272          *
273          * @return      $baseUrl        Detected base URL
274          */
275         public function detectBaseUrl() {
276                 // Initialize the URL
277                 $baseUrl = "http";
278
279                 // Do we have HTTPS?
280                 if (isset($_SERVER['HTTPS'])) {
281                         // Add the >s< for HTTPS
282                         $baseUrl .= "s";
283                 } // END - if
284
285                 // Construct the full URL now and secure it against CSRF attacks
286                 $baseUrl = $baseUrl . "://" . $this->detectDomain() . dirname($_SERVER['SCRIPT_NAME']);
287
288                 // Return the URL
289                 return $baseUrl;
290         }
291
292         /**
293          * Detect safely and return the full domain where this script is installed
294          *
295          * @return      $fullDomain             The detected full domain
296          */
297         public function detectDomain () {
298                 // Detect the full domain
299                 $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES);
300
301                 // Return it
302                 return $fullDomain;
303         }
304
305         /**
306          * Getter for field name
307          *
308          * @param       $fieldName              Field name which we shall get
309          * @return      $fieldValue             Field value from the user
310          */
311         function getField ($fieldName) {
312                 // Dummy method!
313         }
314
315         /**
316          * Updates a given field with new value
317          *
318          * @param       $fieldName              Field to update
319          * @param       $fieldValue             New value to store
320          * @return      void
321          */
322         public function updateDatabaseField ($fieldName, $fieldValue) {
323                 // Dummy method!
324         }
325 }
326
327 // [EOF]
328 ?>