Reverted of changes in 1704, see ticket #160
[mailer.git] / inc / config-functions.php
index cde1fa35c3e96e574ae0d41aa0a05581fa7b8f38..bc3eea007071a28706792fa977eac94d557114af 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 02/28/2009 *
- * ===============                              Last change: 02/28/2009 *
+ * Mailer v0.2.1-FINAL                                Start: 02/28/2009 *
+ * ===================                          Last change: 02/28/2009 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : config-functions.php                             *
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Viele Nicht-MySQL-Funktionen (auch Dateizugriff) *
  * -------------------------------------------------------------------- *
- *                                                                      *
+ * $Revision::                                                        $ *
+ * $Date::                                                            $ *
+ * $Tag:: 0.2.1-FINAL                                                 $ *
+ * $Author::                                                          $ *
+ * Needs to be in all Files and every File needs "svn propset           *
+ * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
- * Copyright (c) 2003 - 2008 by Roland Haeder                           *
+ * Copyright (c) 2003 - 2009 by Roland Haeder                           *
+ * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
 
 // Some security stuff...
 if (!defined('__SECURITY')) {
-       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4)."/security.php";
-       require($INC);
-}
+       die();
+} // END - if
 
-// Merges $_CONFIG with data in given array
-function mergeConfig ($newConfig) {
-       global $_CONFIG;
-       $_CONFIG = merge_array($_CONFIG, $newConfig);
-}
+// Init the config array
+function initConfig () {
+       // Init not if already found
+       if (isConfigurationLoaded()) {
+               // Already initialized
+               debug_report_bug(sprintf("[%s:%s] Configuration is already initialized.", __FUNCTION__, __LINE__));
+       } // END - if
 
-// Getter for $_CONFIG entries
-function getConfig ($entry) {
-       global $_CONFIG;
+       // Set a minimum of configuration, required to by-pass some error triggers in getConfig()
+       $GLOBALS['config'] = array(
+               'sql_time'            => 0,
+               'sql_count'           => 0,
+               'num_templates'       => 0,
+               // 'DEFAULT_SALT_LENGTH' => 40,
+               // 'DEBUG_MODE'          => 'N',
+               // 'DEBUG_RESET'         => 'N',
+               // 'DEBUG_MONTHLY'       => 'N',
+               // 'DEBUG_WEEKLY'        => 'N',
+               // 'DEBUG_REGEX'         => 'N',
+               // 'ADMIN_REGISTERED'    => 'N',
+               // 'verbose_sql'         => 'Y',
+               // For installation phase:
+               'SMTP_HOSTNAME'       => '',
+               'SMTP_USER'           => '',
+               'SMTP_PASSWORD'       => '',
+               'MT_WORD'             => '{--DEFAULT_MT_WORD--}',
+       );
+}
 
+// Getter for $GLOBALS['config'] entries
+function getConfig ($configEntry) {
        // Default value
        $value = null;
 
        // Is the entry there?
-       if (isConfigEntrySet($entry)) {
-               // Then use it
-               $value = $_CONFIG[$entry];
+       if (!isset($GLOBALS['config'][$configEntry])) {
+               // Raise an error of missing entries
+               debug_report_bug(sprintf("[%s:%s] Configuration entry <em>%s</em> is missing.",
+                       __FUNCTION__,
+                       __LINE__,
+                       $configEntry
+               ));
        } // END - if
 
        // Return it
-       return $value;
+       return $GLOBALS['config'][$configEntry];
 }
 
-// Setter for $_CONFIG entries
-function setConfigEntry ($entry, $value) {
-       global $_CONFIG;
-
-       // Secure the entry name
-       $entry = SQL_ESCAPE($entry);
-
-       // And set it
-       $_CONFIG[$entry] = $value;
+// Setter for $GLOBALS['config'] entries
+function setConfigEntry ($configEntry, $value) {
+       // Just set it (unsecured won't hurt?)
+       $GLOBALS['config'][$configEntry] = $value;
 }
 
 // Checks wether the given config entry is set
-function isConfigEntrySet ($entry) {
-       global $_CONFIG;
-       return (isset($_CONFIG[$entry]));
+function isConfigEntrySet ($configEntry) {
+       //* DEBUG: */ print __FUNCTION__.':'.$configEntry.'='.intval(isset($GLOBALS['config'][$configEntry])).'<br />';
+       return (isset($GLOBALS['config'][$configEntry]));
+}
+
+// Merges $GLOBALS['config'] with data in given array
+function mergeConfig ($newConfig) {
+       $GLOBALS['config'] = merge_array(getConfigArray(), $newConfig);
 }
 
 // Increment or init with given value or 1 as default the given config entry
 function incrementConfigEntry ($configEntry, $value=1) {
-       global $_CONFIG;
-
        // Increment it if set or init it with 1
-       if (getConfig($configEntry) > 0) {
-               $_CONFIG[$configEntry] += $value;
+       if (isConfigEntrySet($configEntry)) {
+               $GLOBALS['config'][$configEntry] += $value;
        } else {
-               $_CONFIG[$configEntry] = $value;
+               $GLOBALS['config'][$configEntry] = $value;
+       }
+}
+
+// Checks wether the configuration array is set so the config is loaded
+function isConfigurationLoaded () {
+       // Check all
+       return (isset($GLOBALS['config']['config']));
+}
+
+// Getter for whole $GLOBALS['config'] array
+function getConfigArray () {
+       // Default is null
+       $return = array();
+
+       // Is the config set?
+       if (isset($GLOBALS['config'])) {
+               // Then use it
+               $return = $GLOBALS['config'];
+       } // END - if
+
+       // Return result
+       return $return;
+}
+
+// Updates an old inc/config.php to a inc/cache/config-local.php file
+function updateOldConfigFile () {
+       // Watch out for these lines and execute them as single command
+       // @TODO Make this all better... :-/
+       $watchLines = array(
+               'SITE_KEY'           => 'SITE_KEY',
+               'DEFAULT_LANG'       => 'DEFAULT_LANG',
+               'warn_no_pass'       => 'WARN_NO_PASS',
+               'WRITE_FOOTER'       => 'WRITE_FOOTER',
+               'OUTPUT_MODE'        => 'OUTPUT_MODE',
+               'MAIN_TITLE'         => 'MAIN_TITLE',
+               'SLOGAN'             => 'SLOGAN',
+               'WEBMASTER'          => 'WEBMASTER',
+               'mxchange_installed' => 'MXCHANGE_INSTALLED',
+               'admin_registered'   => 'ADMIN_REGISTERED',
+               '_MYSQL_PREFIX'      => '_MYSQL_PREFIX',
+               '_TABLE_TYPE'        => '_TABLE_TYPE',
+               '_DB_TYPE'           => '_DB_TYPE',
+               'SMTP_HOSTNAME'      => 'SMTP_HOSTNAME',
+               'SMTP_USER'           => 'SMTP_USER',
+               'SMTP_PASSWORD'      => 'SMTP_PASSWORD',
+               'ENABLE_BACKLINK'    => 'ENABLE_BACKLINK',
+               'MAIN_TITLE'         => 'MAIN_TITLE',
+               'SLOGAN'             => 'SLOGAN',
+               'WEBMASTER'          => 'WEBMASTER',
+               'PATH'               => 'PATH',
+               'URL'                => 'URL',
+       );
+
+       // Make these lower-case! (damn stupid code...)
+       $lowerCase = array('WARN_NO_PASS', 'MXCHANGE_INSTALLED', 'ADMIN_REGISTERED');
+
+       // Special comments...
+       $comments = array(
+               'WARN_NO_PASS'       => 'NULLPASS-WARNING',
+               'MXCHANGE_INSTALLED' => 'INSTALLED',
+               'ADMIN_REGISTERED'   => 'ADMIN-SETUP',
+               '_MYSQL_PREFIX'      => 'MYSQL-PREFIX',
+               '_TABLE_TYPE'        => 'TABLE-TYPE',
+               '_DB_TYPE'           => 'DATABASE-TYPE',
+               'ENABLE_BACKLINK'    => 'BACKLINK',
+               'host'               => 'MYSQL-HOST',
+               'dbase'              => 'MYSQL-DBASE',
+               'login'              => 'MYSQL-LOGIN',
+               'password'           => 'MYSQL-PASSWORD'
+       );
+
+       // Copy template to new file destionation
+       copyFileVerified(getConfig('PATH') . 'inc/config-local.php.dist', getConfig('CACHE_PATH') . 'config-local.php', 0644);
+
+       // First of all, load the old one!
+       $oldConfig = explode("\n", readFromFile(getConfig('PATH') . 'inc/config.php'));
+
+       // Now, analyze every entry
+       $done = array();
+       foreach ($oldConfig as $line) {
+               // Check all watch lines
+               foreach ($watchLines as $old => $new) {
+                       // Add define() command around old one
+                       $old = "define('" . $old . "',";
+
+                       // Is the line found?
+                       if ((substr($line, 0, strlen($old)) == $old) && (!isset($done[$old]))) {
+                               // Entry found!
+                               //* DEBUG: */ outputHtml(secureString($line) . " - FOUND!<br />");
+
+                               // Eval the line...
+                               eval($line);
+
+                               // Setting config entry is new default behaviour!
+                               $function = 'setConfigEntry';
+
+                               // Default comment
+                               $comment = str_replace('_', '-', $new);
+
+                               // Do we have a special comment?
+                               if (isset($comments[$new])) {
+                                       // Then use it
+                                       $comment = $comments[$new];
+                               } // END - if
+
+                               // Do we need to make $new lowercase?
+                               $oldNew = $new;
+                               if (in_array($new, $lowerCase)) {
+                                       // Then do so... :)
+                                       $new = strtolower($new);
+                               } // END - if
+
+                               /// ... and write it to the new config
+                               //* DEBUG: */ outputHtml('function=' . $function . ',new=' . $new . ',comment=' . $comment . "<br />");
+                               changeDataInFile(getConfig('CACHE_PATH') . 'config-local.php', $comment, $function . "('" . $oldNew . "', \"", "\");", constant($new), 0);
+                               //* DEBUG: */ outputHtml("CHANGED!<br />");
+
+                               // Mark it as done
+                               $done[$old] = 1;
+                       } // END - if
+               } // END - foreach
+       } // END - foreach
+
+       // By default the old array $MySQL was not found
+       $found = false;
+
+       // Analyze every entry again for the MySQL configuration
+       foreach ($oldConfig as $line) {
+               // Trim spaces
+               $line = trim($line);
+
+               // Is the $MySQL found?
+               if (substr($line, 0, 6) == "\$MySQL") {
+                       // Okay found!
+                       $found = true;
+               } elseif ($found === true) {
+                       // Now check this row
+                       if (substr($line, 0, 2) == ');') {
+                               // MySQL array is closed so stop looking for it
+                               break;
+                       } elseif (substr($line, 0, 2) == '//') {
+                               // Skip this line
+                               continue;
+                       }
+
+                       // Debug output only
+                       //* DEBUG: */ outputHtml(secureString($line) . " - MySQL!<br />");
+
+                       // Split parts so we can check them and prepare them
+                       $parts = explode('=>', $line);
+                       $key = substr(trim($parts[0]), 1, -1); $value = substr(trim($parts[1]), 1, -2);
+
+                       // We can now save the right part in new config file
+                       changeDataInFile(getConfig('CACHE_PATH') . 'config-local.php', $comments[$key], "       '".$key."'     => \"", "\",", $value, 0);
+               }
+       } // END - foreach
+
+       // Finally remove old config file
+       removeFile(getConfig('PATH') . 'inc/config.php');
+
+       // Redirect to same URL to reload our new config
+       redirectToUrl(getRequestUri());
+}
+
+// Update config entries
+function updateConfiguration ($entries, $values, $updateMode='', $config = '0') {
+       // Do not update config in CSS mode
+       if ((getOutputMode() == 1) || (getOutputMode() == -1) || (isInstallationPhase())) {
+               return;
+       } // END - if
+
+       // Do we have multiple entries?
+       if (is_array($entries)) {
+               // Walk through all
+               $all = '';
+               foreach ($entries as $idx => $entry) {
+                       // Update mode set?
+                       if (!empty($updateMode)) {
+                               // Update entry
+                               $all .= sprintf("`%s`=`%s`%s%s,", $entry, $entry, $updateMode, (float)$values[$idx]);
+                       } else {
+                               // Check if string or number but no array
+                               if (is_array($values[$idx])) {
+                                       // Arrays must be fixed...
+                                       debug_report_bug('values[' . $idx . '] should not be an array! Content=<pre>'.print_r($values[$idx], true).'</pre>');
+                               } elseif (($values[$idx] + 0) === $values[$idx]) {
+                                       // Number detected
+                                       $all .= sprintf("`%s`=%s,", $entry, (float)$values[$idx]);
+
+                                       // Set it in config as well
+                                       setConfigEntry($entry, $values[$idx]);
+                               } elseif ($values[$idx] == 'UNIX_TIMESTAMP()') {
+                                       // Function UNIX_TIMESTAMP() detected
+                                       $all .= sprintf("`%s`=UNIX_TIMESTAMP(),", $entry);
+
+                                       // Set timestamp in array as well
+                                       setConfigEntry($entry, time());
+                               } else {
+                                       // String detected
+                                       $all .= sprintf("`%s`='%s',", $entry, SQL_ESCAPE($values[$idx]));
+
+                                       // Set it in config as well
+                                       setConfigEntry($entry, $values[$idx]);
+                               }
+                       }
+               } // END - foreach
+
+               // Remove last comma
+               $entries = substr($all, 0, -1);
+       } elseif (!empty($updateMode)) {
+               // Update mode set
+               $entries = sprintf("`%s`=`%s`%s%s", $entries, $entries, $updateMode, (float)$values);
+       } elseif (($values + 0) === $values) {
+               // Number detected
+               $entries = sprintf("`%s`=%s", $entries, (float)$values);
+
+               // Set it in config first
+               setConfigEntry($entries, (float)$values);
+       } elseif ($values == 'UNIX_TIMESTAMP()') {
+               // Function UNIX_TIMESTAMP() detected
+               $entries = sprintf("`%s`=UNIX_TIMESTAMP()", $entries);
+
+               // Set timestamp in array as well
+               setConfigEntry($entries, time());
+       } else {
+               // Regular entry to update
+               $entries = sprintf("`%s`='%s'", $entries, SQL_ESCAPE($values));
+
+               // Set it in config as well
+               setConfigEntry($entries, SQL_ESCAPE($values));
+       }
+
+       // Run database update
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "entries={$entries}");
+       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_config` SET ".$entries." WHERE `config`=%s LIMIT 1",
+                       array(bigintval($config)), __FUNCTION__, __LINE__);
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "entries={$entries},affectedRows={$affectedRows}<br />");
+
+       // Rebuild cache
+       rebuildCache('config', 'config');
+}
+
+// Filter for loading configuration
+function FILTER_LOAD_CONFIGURATION ($no = '0') {
+       // Is the value null, fix it :(
+       if (is_null($no)) $no = '0';
+
+       // Check for cache extension, cache-array and if the requested configuration is in cache
+       if ((isset($GLOBALS['cache_array']['config'][$no])) && (is_array($GLOBALS['cache_array']['config'][$no]))) {
+               // Load config from cache
+               mergeConfig($GLOBALS['cache_array']['config'][$no]);
+
+               // Count cache hits if exists
+               if ((isStatsEntrySet('cache_hits')) && (isExtensionActive('cache'))) {
+                       incrementStatsEntry('cache_hits');
+               } // END - if
+       } elseif ((!isExtensionActive('cache')) || (!isset($GLOBALS['cache_array']['config'][$no]))) {
+               // Load config from DB
+               $result_config = SQL_QUERY_ESC("SELECT * FROM `{?_MYSQL_PREFIX?}_config` WHERE `config`='%s' LIMIT 1",
+                       array(bigintval($no)), __FUNCTION__, __LINE__);
+
+               // Is the config there?
+               if (SQL_NUMROWS($result_config) == 1) {
+                       // Get config from database
+                       mergeConfig(SQL_FETCHARRAY($result_config));
+               } // END - if
+
+               // Free result
+               SQL_FREERESULT($result_config);
+
+               // Remember this config in the array
+               $GLOBALS['cache_array']['config'][$no] = getConfigArray();
        }
 }