]> git.mxchange.org Git - mailer.git/blob - inc/config-functions.php
Updated notes about contributors
[mailer.git] / inc / config-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 02/28/2009 *
4  * ===================                          Last change: 02/28/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : config-functions.php                             *
8  * -------------------------------------------------------------------- *
9  * Short description : Configuration functions                          *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Konfigurationsfunktionen                         *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
20  * For more information visit: http://mxchange.org                      *
21  *                                                                      *
22  * This program is free software; you can redistribute it and/or modify *
23  * it under the terms of the GNU General Public License as published by *
24  * the Free Software Foundation; either version 2 of the License, or    *
25  * (at your option) any later version.                                  *
26  *                                                                      *
27  * This program is distributed in the hope that it will be useful,      *
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
30  * GNU General Public License for more details.                         *
31  *                                                                      *
32  * You should have received a copy of the GNU General Public License    *
33  * along with this program; if not, write to the Free Software          *
34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
43 // Init the config array
44 function initConfig () {
45         // Init not if already found
46         if (isConfigurationLoaded()) {
47                 // Already initialized
48                 debug_report_bug(__FUNCTION__, __LINE__, 'Configuration is already initialized.');
49         } // END - if
50
51         // Set a minimum of configuration, required to by-pass some error triggers in getConfig()
52         $GLOBALS['config'] = array(
53                 'sql_time'            => 0,
54                 'sql_count'           => 0,
55                 'num_templates'       => 0,
56                 // 'DEFAULT_SALT_LENGTH' => 40,
57                 // 'DEBUG_MODE'          => 'N',
58                 // 'DEBUG_RESET'         => 'N',
59                 // 'DEBUG_MONTHLY'       => 'N',
60                 // 'DEBUG_WEEKLY'        => 'N',
61                 // 'DEBUG_REGEX'         => 'N',
62                 // 'ADMIN_REGISTERED'    => 'N',
63                 // 'verbose_sql'         => 'Y',
64                 // For installation phase:
65                 'SMTP_HOSTNAME'       => '',
66                 'SMTP_USER'           => '',
67                 'SMTP_PASSWORD'       => '',
68                 'MT_WORD'             => '{--DEFAULT_MT_WORD--}',
69         );
70 }
71
72 // Getter for $GLOBALS['config'] entries
73 function getConfig ($configEntry) {
74         // Is the entry there?
75         if (!isConfigEntrySet($configEntry)) {
76                 // Raise an error of missing entries
77                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Configuration entry <span class=\"data\">%s</span> is missing.", $configEntry));
78         } // END - if
79
80         // Return it
81         //* DEBUG: */ error_log(__FUNCTION__.'['.__LINE__.':] '.$configEntry.'='.$GLOBALS['config'][$configEntry]);
82         return $GLOBALS['config'][$configEntry];
83 }
84
85 // Setter for $GLOBALS['config'] entries
86 function setConfigEntry ($configEntry, $value) {
87         // Just set it (unsecured won't hurt?)
88         $GLOBALS['config'][$configEntry] = $value;
89 }
90
91 // Checks wether the given config entry is set
92 function isConfigEntrySet ($configEntry) {
93         //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $configEntry . '=' . intval(isset($GLOBALS['config'][$configEntry])));
94         return (isset($GLOBALS['config'][$configEntry]));
95 }
96
97 // Merges $GLOBALS['config'] with data in given array
98 function mergeConfig ($newConfig) {
99         $GLOBALS['config'] = merge_array(getConfigArray(), $newConfig);
100
101         // Remove all cached entries
102 }
103
104 // Increment or init with given value or 1 as default the given config entry
105 function incrementConfigEntry ($configEntry, $value=1) {
106         // Increment it if set or init it with $value
107         if (isConfigEntrySet($configEntry)) {
108                 $GLOBALS['config'][$configEntry] += $value;
109         } else {
110                 $GLOBALS['config'][$configEntry] = $value;
111         }
112 }
113
114 // Checks wether the configuration array is set so the config is loaded
115 function isConfigurationLoaded () {
116         // Check all
117         return (isset($GLOBALS['config']['config']));
118 }
119
120 // Getter for whole $GLOBALS['config'] array
121 function getConfigArray () {
122         // Default is null
123         $return = array();
124
125         // Is the config set?
126         if (isset($GLOBALS['config'])) {
127                 // Then use it
128                 $return = $GLOBALS['config'];
129         } // END - if
130
131         // Return result
132         return $return;
133 }
134
135 // Updates an old inc/config.php to a inc/cache/config-local.php file
136 function updateOldConfigFile () {
137         // Watch out for these lines and execute them as single command
138         // @TODO Make this all better... :-/
139         $watchLines = array(
140                 'SITE_KEY'           => 'SITE_KEY',
141                 'DEFAULT_LANG'       => 'DEFAULT_LANG',
142                 'warn_no_pass'       => 'WARN_NO_PASS',
143                 'WRITE_FOOTER'       => 'WRITE_FOOTER',
144                 'OUTPUT_MODE'        => 'OUTPUT_MODE',
145                 'MAIN_TITLE'         => 'MAIN_TITLE',
146                 'SLOGAN'             => 'SLOGAN',
147                 'WEBMASTER'          => 'WEBMASTER',
148                 'mxchange_installed' => 'MXCHANGE_INSTALLED',
149                 'admin_registered'   => 'ADMIN_REGISTERED',
150                 '_MYSQL_PREFIX'      => '_MYSQL_PREFIX',
151                 '_TABLE_TYPE'        => '_TABLE_TYPE',
152                 '_DB_TYPE'           => '_DB_TYPE',
153                 'SMTP_HOSTNAME'      => 'SMTP_HOSTNAME',
154                 'SMTP_USER'          => 'SMTP_USER',
155                 'SMTP_PASSWORD'      => 'SMTP_PASSWORD',
156                 'ENABLE_BACKLINK'    => 'ENABLE_BACKLINK',
157                 'MAIN_TITLE'         => 'MAIN_TITLE',
158                 'SLOGAN'             => 'SLOGAN',
159                 'WEBMASTER'          => 'WEBMASTER',
160                 'PATH'               => 'PATH',
161                 'URL'                => 'URL',
162         );
163
164         // Make these lower-case! (damn stupid code...)
165         $lowerCase = array('WARN_NO_PASS', 'MXCHANGE_INSTALLED', 'ADMIN_REGISTERED');
166
167         // Special comments...
168         $comments = array(
169                 'WARN_NO_PASS'       => 'NULLPASS-WARNING',
170                 'MXCHANGE_INSTALLED' => 'INSTALLED',
171                 'ADMIN_REGISTERED'   => 'ADMIN-SETUP',
172                 '_MYSQL_PREFIX'      => 'MYSQL-PREFIX',
173                 '_TABLE_TYPE'        => 'TABLE-TYPE',
174                 '_DB_TYPE'           => 'DATABASE-TYPE',
175                 'ENABLE_BACKLINK'    => 'BACKLINK',
176                 'host'               => 'MYSQL-HOST',
177                 'dbase'              => 'MYSQL-DBASE',
178                 'login'              => 'MYSQL-LOGIN',
179                 'password'           => 'MYSQL-PASSWORD'
180         );
181
182         // Copy template to new file destionation
183         copyFileVerified(getPath() . 'inc/config-local.php.dist', getCachePath() . 'config-local.php', 0644);
184
185         // First of all, load the old one!
186         $oldConfig = explode("\n", readFromFile(getPath() . 'inc/config.php'));
187
188         // Now, analyze every entry
189         $done = array();
190         foreach ($oldConfig as $line) {
191                 // Check all watch lines
192                 foreach ($watchLines as $old => $new) {
193                         // Add define() command around old one
194                         $old = "define('" . $old . "',";
195
196                         // Is the line found?
197                         if ((substr($line, 0, strlen($old)) == $old) && (!isset($done[$old]))) {
198                                 // Entry found
199                                 //* DEBUG: */ debugOutput(secureString($line) . ' - FOUND!');
200
201                                 // Eval the line...
202                                 eval($line);
203
204                                 // Setting config entry is new default behaviour!
205                                 $function = 'setConfigEntry';
206
207                                 // Default comment
208                                 $comment = str_replace('_', '-', $new);
209
210                                 // Do we have a special comment?
211                                 if (isset($comments[$new])) {
212                                         // Then use it
213                                         $comment = $comments[$new];
214                                 } // END - if
215
216                                 // Do we need to make $new lowercase?
217                                 $oldNew = $new;
218                                 if (in_array($new, $lowerCase)) {
219                                         // Then do so... :)
220                                         $new = strtolower($new);
221                                 } // END - if
222
223                                 // ... and write it to the new config
224                                 //* DEBUG: */ debugOutput('function=' . $function . ',new=' . $new . ',comment=' . $comment);
225                                 changeDataInInclude(getCachePath() . 'config-local.php', $comment, $function . "('" . $oldNew . "', \"", '");', constant($new), 0);
226                                 //* DEBUG: */ debugOutput('CHANGED!');
227
228                                 // Mark it as done
229                                 $done[$old] = 1;
230                         } // END - if
231                 } // END - foreach
232         } // END - foreach
233
234         // By default the old array $MySQL was not found
235         $found = false;
236
237         // Analyze every entry again for the MySQL configuration
238         foreach ($oldConfig as $line) {
239                 // Trim spaces
240                 $line = trim($line);
241
242                 // Is the $MySQL found?
243                 if (substr($line, 0, 6) == '$MySQL') {
244                         // Okay, found
245                         $found = true;
246                 } elseif ($found === true) {
247                         // Now check this row
248                         if (substr($line, 0, 2) == ');') {
249                                 // MySQL array is closed so stop looking for it
250                                 break;
251                         } elseif (substr($line, 0, 2) == '//') {
252                                 // Skip this line
253                                 continue;
254                         }
255
256                         // Debug output only
257                         //* DEBUG: */ debugOutput(secureString($line) . ' - MySQL!');
258
259                         // Split parts so we can check them and prepare them
260                         $parts = explode('=>', $line);
261                         $key = substr(trim($parts[0]), 1, -1); $value = substr(trim($parts[1]), 1, -2);
262
263                         // We can now save the right part in new config file
264                         changeDataInInclude(getCachePath() . 'config-local.php', $comments[$key], "     '".$key."'     => \"", '",', $value, 0);
265                 }
266         } // END - foreach
267
268         // Finally remove old config file
269         removeFile(getPath() . 'inc/config.php');
270
271         // Redirect to same URL to reload our new config
272         redirectToUrl(getRequestUri());
273 }
274
275 // Update config entries
276 function updateConfiguration ($entries, $values, $updateMode = '', $config = '0') {
277         // Do not update config in CSS mode
278         if ((isCssOutputMode()) || (isRawOutputMode()) || (isInstallationPhase())) {
279                 // This logger line may be very noisy
280                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Not updating configuration. entries[]=' . gettype($entries) . ',values[]=' . gettype($values) . ',updateMode=' . $updateMode . ',config=' . $config . ',isCssOutputMode()=' . intval(isCssOutputMode()) . ',isRawOutputMode()=' . intval(isRawOutputMode()) . ',isInstallationPhase()=' . intval(isInstallationPhase()));
281                 return;
282         } // END - if
283
284         // Do we have multiple entries?
285         if (is_array($entries)) {
286                 // Walk through all
287                 $all = '';
288                 foreach ($entries as $idx => $entry) {
289                         // Update mode set?
290                         if (!empty($updateMode)) {
291                                 // Update entry
292                                 $all .= sprintf("`%s`=`%s`%s%s,", $entry, $entry, $updateMode, (float) $values[$idx]);
293                         } else {
294                                 // Check if string or number but no array
295                                 if (is_array($values[$idx])) {
296                                         // Arrays must be fixed...
297                                         debug_report_bug(__FUNCTION__, __LINE__, 'values[' . $idx . '] should not be an array! Content=<pre>'.print_r($values[$idx], true).'</pre>');
298                                 } elseif (($values[$idx] + 0) === $values[$idx]) {
299                                         // Number detected
300                                         $all .= sprintf("`%s`=%s,", $entry, (float) $values[$idx]);
301
302                                         // Set it in config as well
303                                         setConfigEntry($entry, $values[$idx]);
304                                 } elseif ($values[$idx] == 'UNIX_TIMESTAMP()') {
305                                         // Function UNIX_TIMESTAMP() detected
306                                         $all .= sprintf("`%s`=UNIX_TIMESTAMP(),", $entry);
307
308                                         // Set timestamp in array as well
309                                         setConfigEntry($entry, time());
310                                 } else {
311                                         // String detected
312                                         $all .= sprintf("`%s`='%s',", $entry, SQL_ESCAPE($values[$idx]));
313
314                                         // Set it in config as well
315                                         setConfigEntry($entry, $values[$idx]);
316                                 }
317                         }
318                 } // END - foreach
319
320                 // Remove last comma
321                 $entries = substr($all, 0, -1);
322         } elseif (!empty($updateMode)) {
323                 // Update mode set
324                 $entries = sprintf("`%s`=`%s`%s%s", $entries, $entries, $updateMode, (float) $values);
325         } elseif (($values + 0) === $values) {
326                 // Number detected
327                 $entries = sprintf("`%s`=%s", $entries, (float) $values);
328
329                 // Set it in config first
330                 setConfigEntry($entries, (float) $values);
331         } elseif ($values == 'UNIX_TIMESTAMP()') {
332                 // Function UNIX_TIMESTAMP() detected
333                 $entries = sprintf("`%s`=UNIX_TIMESTAMP()", $entries);
334
335                 // Set timestamp in array as well
336                 setConfigEntry($entries, time());
337         } else {
338                 // Regular entry to update
339                 $entries = sprintf("`%s`='%s'", $entries, SQL_ESCAPE($values));
340
341                 // Set it in config as well
342                 setConfigEntry($entries, SQL_ESCAPE($values));
343         }
344
345         // Run database update
346         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'entries=' . $entries);
347         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_config` SET ".$entries." WHERE `config`=%s LIMIT 1",
348                         array(bigintval($config)), __FUNCTION__, __LINE__);
349         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'entries=' . $entries . ',affectedRows=' . SQL_AFFECTEDROWS());
350
351         // Rebuild cache
352         rebuildCache('config', 'config');
353 }
354
355 // Filter for loading configuration
356 function FILTER_LOAD_CONFIGURATION ($no = '0') {
357         // Is the value null, it comes from the 'init' filter chain
358         if (is_null($no)) {
359                 $no = '0';
360         } // END - if
361
362         // Check for cache extension, cache-array and if the requested configuration is in cache
363         if ((isset($GLOBALS['cache_array']['config'][$no])) && (is_array($GLOBALS['cache_array']['config'][$no]))) {
364                 // Load config from cache
365                 mergeConfig($GLOBALS['cache_array']['config'][$no]);
366
367                 // Count cache hits if exists
368                 if ((isStatsEntrySet('cache_hits')) && (isExtensionActive('cache'))) {
369                         incrementStatsEntry('cache_hits');
370                 } // END - if
371         } elseif ((!isExtensionActive('cache')) || (!isset($GLOBALS['cache_array']['config'][$no]))) {
372                 // Load config from DB
373                 $result_config = SQL_QUERY_ESC("SELECT * FROM `{?_MYSQL_PREFIX?}_config` WHERE `config`='%s' LIMIT 1",
374                         array(bigintval($no)), __FUNCTION__, __LINE__);
375
376                 // Is the config there?
377                 if (SQL_NUMROWS($result_config) == 1) {
378                         // Get config from database
379                         mergeConfig(SQL_FETCHARRAY($result_config));
380                 } // END - if
381
382                 // Free result
383                 SQL_FREERESULT($result_config);
384
385                 // Remember this config in the array
386                 $GLOBALS['cache_array']['config'][$no] = getConfigArray();
387         }
388 }
389
390 // [EOF]
391 ?>