2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 02/28/2009 *
4 * =================== Last change: 02/28/2009 *
6 * -------------------------------------------------------------------- *
7 * File : config-functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Configuration functions *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Konfigurationsfunktionen *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009 - 2012 by Mailer Developer Team *
20 * For more information visit: http://mxchange.org *
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. *
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. *
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, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
43 // Init the config array
44 function initConfig () {
45 // Init not if already found
46 if (isConfigurationLoaded()) {
47 // Already initialized
48 reportBug(__FUNCTION__, __LINE__, 'Configuration is already initialized.');
51 // Set a minimum of configuration, required to by-pass some error triggers in getConfig()
52 $GLOBALS['config'] = array(
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' => '',
67 'SMTP_PASSWORD' => '',
68 'MT_WORD' => '{--DEFAULT_MT_WORD--}',
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 reportBug(__FUNCTION__, __LINE__, sprintf("Configuration entry <span class=\"data\">%s</span> is missing.", $configEntry));
81 //* DEBUG: */ error_log(__FUNCTION__.'['.__LINE__.':] '.$configEntry.'='.$GLOBALS['config'][$configEntry]);
82 return $GLOBALS['config'][$configEntry];
85 // Setter for $GLOBALS['config'] entries
86 function setConfigEntry ($configEntry, $value) {
87 // Just set it (unsecured won't hurt?)
88 $GLOBALS['config'][$configEntry] = $value;
91 removeGlobalCache($configEntry);
94 // Removes entry in $GLOBALS
95 function removeGlobalCache ($configEntry) {
97 $key = 'get' . capitalizeUnderscoreString($configEntry);
100 unset($GLOBALS[$key]);
103 // Checks whether the given config entry is set
104 function isConfigEntrySet ($configEntry) {
105 //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $configEntry . '=' . intval(isset($GLOBALS['config'][$configEntry])));
106 return ((isset($GLOBALS['config'][$configEntry])) || (array_key_exists($configEntry, $GLOBALS['config'])));
109 // Merges $GLOBALS['config'] with data in given array
110 function mergeConfig ($newConfig) {
111 // Merge current configuration with new one
112 $GLOBALS['config'] = merge_array(getConfigArray(), $newConfig);
115 // Increment or init with given value or 1 as default the given config entry
116 function incrementConfigEntry ($configEntry, $value=1) {
117 // Increment it if set or init it with $value
118 if (isConfigEntrySet($configEntry)) {
119 $GLOBALS['config'][$configEntry] += $value;
121 $GLOBALS['config'][$configEntry] = $value;
125 // Checks whether the configuration array is set so the config is loaded
126 function isConfigurationLoaded () {
128 return (isset($GLOBALS['config']['config']));
131 // Getter for whole $GLOBALS['config'] array
132 function getConfigArray () {
136 // Is the config set?
137 if (isset($GLOBALS['config'])) {
139 $return = $GLOBALS['config'];
146 // Updates an old inc/config.php to a inc/cache/config-local.php file
147 function updateOldConfigFile () {
148 // Watch out for these lines and execute them as single command
149 // @TODO Make this all better... :-/
151 'SITE_KEY' => 'SITE_KEY',
152 'DEFAULT_LANG' => 'DEFAULT_LANG',
153 'warn_no_pass' => 'WARN_NO_PASS',
154 'WRITE_FOOTER' => 'WRITE_FOOTER',
155 'OUTPUT_MODE' => 'OUTPUT_MODE',
156 'MAIN_TITLE' => 'MAIN_TITLE',
157 'SLOGAN' => 'SLOGAN',
158 'WEBMASTER' => 'WEBMASTER',
159 'mxchange_installed' => 'MXCHANGE_INSTALLED',
160 'admin_registered' => 'ADMIN_REGISTERED',
161 '_MYSQL_PREFIX' => '_MYSQL_PREFIX',
162 '_TABLE_TYPE' => '_TABLE_TYPE',
163 '_DB_TYPE' => '_DB_TYPE',
164 'SMTP_HOSTNAME' => 'SMTP_HOSTNAME',
165 'SMTP_USER' => 'SMTP_USER',
166 'SMTP_PASSWORD' => 'SMTP_PASSWORD',
167 'ENABLE_BACKLINK' => 'ENABLE_BACKLINK',
168 'MAIN_TITLE' => 'MAIN_TITLE',
169 'SLOGAN' => 'SLOGAN',
170 'WEBMASTER' => 'WEBMASTER',
175 // Make these lower-case! (damn stupid code...)
176 $lowerCase = array('WARN_NO_PASS', 'MXCHANGE_INSTALLED', 'ADMIN_REGISTERED');
178 // Special comments...
180 'WARN_NO_PASS' => 'NULLPASS-WARNING',
181 'MXCHANGE_INSTALLED' => 'INSTALLED',
182 'ADMIN_REGISTERED' => 'ADMIN-SETUP',
183 '_MYSQL_PREFIX' => 'MYSQL-PREFIX',
184 '_TABLE_TYPE' => 'TABLE-TYPE',
185 '_DB_TYPE' => 'DATABASE-TYPE',
186 'ENABLE_BACKLINK' => 'BACKLINK',
187 'host' => 'MYSQL-HOST',
188 'dbase' => 'MYSQL-DBASE',
189 'login' => 'MYSQL-LOGIN',
190 'password' => 'MYSQL-PASSWORD'
193 // Copy template to new file destionation
194 copyFileVerified(getPath() . 'inc/config-local.php.dist', getCachePath() . 'config-local.php', 0644);
196 // First of all, load the old one!
197 $oldConfig = explode(PHP_EOL, readFromFile(getPath() . 'inc/config.php'));
199 // Now, analyze every entry
201 foreach ($oldConfig as $line) {
202 // Check all watch lines
203 foreach ($watchLines as $old => $new) {
204 // Add define() command around old one
205 $old = "define('" . $old . "',";
207 // Is the line found?
208 if ((substr($line, 0, strlen($old)) == $old) && (!isset($done[$old]))) {
210 //* DEBUG: */ debugOutput(secureString($line) . ' - FOUND!');
215 // Setting config entry is new default behaviour!
216 $function = 'setConfigEntry';
219 $comment = str_replace('_', '-', $new);
221 // Is there a special comment?
222 if (isset($comments[$new])) {
224 $comment = $comments[$new];
227 // Does $new needs to be lower-case?
229 if (in_array($new, $lowerCase)) {
231 $new = strtolower($new);
234 // ... and write it to the new config
235 //* DEBUG: */ debugOutput('function=' . $function . ',new=' . $new . ',comment=' . $comment);
236 changeDataInInclude(getCachePath() . 'config-local.php', $comment, $function . "('" . $oldNew . "', \"", '");', constant($new), 0);
237 //* DEBUG: */ debugOutput('CHANGED!');
245 // By default the old array $MySQL was not found
248 // Analyze every entry again for the MySQL configuration
249 foreach ($oldConfig as $line) {
253 // Is the $MySQL found?
254 if (substr($line, 0, 6) == '$MySQL') {
257 } elseif ($found === TRUE) {
258 // Now check this row
259 if (substr($line, 0, 2) == ');') {
260 // MySQL array is closed so stop looking for it
262 } elseif (substr($line, 0, 2) == '//') {
268 //* DEBUG: */ debugOutput(secureString($line) . ' - MySQL!');
270 // Split parts so we can check them and prepare them
271 $parts = explode('=>', $line);
272 $key = substr(trim($parts[0]), 1, -1); $value = substr(trim($parts[1]), 1, -2);
274 // We can now save the right part in new config file
275 changeDataInInclude(getCachePath() . 'config-local.php', $comments[$key], " '".$key."' => \"", '",', $value, 0);
279 // Finally remove old config file
280 removeFile(getPath() . 'inc/config.php');
282 // Redirect to same URL to reload our new config
283 redirectToUrl(getRequestUri());
286 // Update config entries
287 function updateConfiguration ($entries, $values, $updateMode = '', $config = '0') {
288 // Do not update config in CSS mode
289 if ((isCssOutputMode()) || (isRawOutputMode()) || (isInstallationPhase())) {
290 // This logger line may be very noisy
291 //* 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()));
295 // Default is empty SQL
298 // Is there multiple entries?
299 if (is_array($entries)) {
301 foreach ($entries as $idx => $entry) {
303 if (!empty($updateMode)) {
305 $SQL .= sprintf("`%s`=`%s`%s%s,", $entry, $entry, $updateMode, (float) $values[$idx]);
307 // Check if string or number but no array
308 if (is_array($values[$idx])) {
309 // Arrays must be fixed...
310 reportBug(__FUNCTION__, __LINE__, 'values[' . $idx . '] should not be an array! Content=<pre>'.print_r($values[$idx], TRUE).'</pre>');
311 } elseif ($values[$idx] == 'UNIX_TIMESTAMP()') {
312 // Function UNIX_TIMESTAMP() detected
313 $SQL .= sprintf("`%s`=UNIX_TIMESTAMP(),", $entry);
315 // Set timestamp in array as well
316 setConfigEntry($entry, time());
317 } elseif (!empty($updateMode)) {
318 // Is the value zero?
319 if ($values[$idx] == '0') {
325 // @TODO Call setConfigEntry() somehow
326 $SQL .= $entries = sprintf("`%s`=`%s`%s%s", $entry, $entry, $updateMode, (float) $values[$idx]);
327 } elseif (($values[$idx] + 0) === $values[$idx]) {
329 $SQL .= sprintf("`%s`=%s,", $entry, (float) $values[$idx]);
331 // Set it in config as well
332 setConfigEntry($entry, $values[$idx]);
335 $SQL .= sprintf("`%s`='%s',", $entry, SQL_ESCAPE($values[$idx]));
337 // Set it in config as well
338 setConfigEntry($entry, $values[$idx]);
344 $SQL = substr($SQL, 0, -1);
345 } elseif (!empty($updateMode)) {
346 // Is the value zero?
347 if ($values == '0') {
353 // @TODO Call setConfigEntry() somehow
354 $SQL = sprintf("`%s`=`%s`%s%s", $entries, $entries, $updateMode, (float) $values);
355 } elseif (($values + 0) === $values) {
357 $SQL = sprintf("`%s`=%s", $entries, (float) $values);
359 // Set it in config first
360 setConfigEntry($entries, (float) $values);
361 } elseif ($values == 'UNIX_TIMESTAMP()') {
362 // Function UNIX_TIMESTAMP() detected
363 $SQL = sprintf("`%s`=UNIX_TIMESTAMP()", $entries);
365 // Set timestamp in array as well
366 setConfigEntry($entries, time());
368 // Regular entry to update
369 $SQL = sprintf("`%s`='%s'", $entries, SQL_ESCAPE($values));
371 // Set it in config as well
372 setConfigEntry($entries, SQL_ESCAPE($values));
375 // Run database update
376 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL=' . $SQL);
377 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_config` SET ".$SQL." WHERE `config`=%s LIMIT 1",
378 array(bigintval($config)), __FUNCTION__, __LINE__);
379 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL=' . $SQL . ',affectedRows=' . SQL_AFFECTEDROWS());
382 rebuildCache('config', 'config');
385 // Filter for loading configuration
386 function FILTER_LOAD_CONFIGURATION ($no = '0') {
387 // Is installation phase?
388 if (isInstallationPhase()) {
389 // Then don't load any configuration
393 // Is the value null, it comes from the 'init' filter chain
398 // Check for cache extension, cache-array and if the requested configuration is in cache
399 if ((isset($GLOBALS['cache_array']['config'][$no])) && (is_array($GLOBALS['cache_array']['config'][$no]))) {
400 // Load config from cache
401 mergeConfig($GLOBALS['cache_array']['config'][$no]);
404 incrementStatsEntry('cache_hits');
405 } elseif ((!isExtensionActive('cache')) || (!isset($GLOBALS['cache_array']['config'][$no]))) {
406 // Load config from DB
407 $result_config = SQL_QUERY_ESC("SELECT * FROM `{?_MYSQL_PREFIX?}_config` WHERE `config`='%s' LIMIT 1",
408 array(bigintval($no)), __FUNCTION__, __LINE__);
410 // Is the config there?
411 if (SQL_NUMROWS($result_config) == 1) {
412 // Get config from database
413 mergeConfig(SQL_FETCHARRAY($result_config));
417 SQL_FREERESULT($result_config);
419 // Remember this config in the array
420 $GLOBALS['cache_array']['config'][$no] = getConfigArray();