More missing config entries added
[mailer.git] / inc / config-functions.php
index 3fd823f6c75bc63c95776fd5428e8d1e1073ac65..db769c06e400bf795772b47c69c9b4e720b20702 100644 (file)
@@ -42,93 +42,99 @@ if (!defined('__SECURITY')) {
        require($INC);
 }
 
-// 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 ((isset($GLOBALS['config'])) && (count($GLOBALS['config']) >= 3)) {
+               // Already initialized
+               trigger_error(sprintf("[%s:%s] Configuration is already initialized.", __FUNCTION__, __LINE__));
+       } // END - if
 
-// Getter for $_CONFIG entries
-function getConfig ($entry) {
-       global $_CONFIG;
+       // Set a minimum dummy configuration
+       $GLOBALS['config'] = array(
+               'code_length'   => 0,
+               'patch_level'   => 0,
+               'last_update'   => time(),
+               'DEBUG_MODE'    => 'N',
+               'DEBUG_RESET'   => 'N',
+               'DEBUG_MONTHLY' => 'N',
+               'DEBUG_WEEKLY'  => 'N',
+               'DEBUG_REGEX'   => 'N',
+               'sql_count'     => 0,
+               'num_templates' => 0,
+               'default_theme' => 'default',
+       );
+}
 
+// 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 (!isConfigEntrySet($configEntry)) {
+               // Raise an error of missing entries
+               trigger_error(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;
-
+// Setter for $GLOBALS['config'] entries
+function setConfigEntry ($configEntry, $value) {
        // Secure the entry name
-       $entry = SQL_ESCAPE($entry);
+       if (function_exists('SQL_ESCAPE')) {
+               // Use our secure function
+               $configEntry = SQL_ESCAPE($configEntry);
+       } else {
+               // Use maybe insecure function
+               $configEntry = smartAddSlashes($configEntry);
+       }
 
        // And set it
-       $_CONFIG[$entry] = $value;
+       $GLOBALS['config'][$configEntry] = $value;
 }
 
 // Checks wether the given config entry is set
-function isConfigEntrySet ($entry) {
-       global $_CONFIG;
-       return (isset($_CONFIG[$entry]));
+function isConfigEntrySet ($configEntry) {
+       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;
+               $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 isConfigLoaded () {
-       global $_CONFIG;
-
        // Check all
-       return ((isset($_CONFIG)) && (is_array($_CONFIG)) && (count($_CONFIG) > 0));
-}
-
-// Init the config array
-function initConfig () {
-       global $_CONFIG;
-
-       // Set a minimum dummy configuration
-       $_CONFIG = array(
-               'code_length' => 0,
-               'patch_level' => 0,
-               'last_update' => time()
-       );
+       return ((isset($GLOBALS['config'])) && (is_array($GLOBALS['config'])) && (count($GLOBALS['config']) > 0));
 }
 
 // Load configuration and return it as an arry
-function loadConfiguration ($no="0") {
-       global $_CONFIG;
-
+function loadConfiguration ($no = '0') {
        // Check for cache extension, cache-array and if the requested configuration is in cache
-       if ((is_array($GLOBALS['cache_array'])) && (isset($GLOBALS['cache_array']['config'][$no])) && (is_array($GLOBALS['cache_array']['config'][$no]))) {
+       if ((isset($GLOBALS['cache_array'])) && (is_array($GLOBALS['cache_array'])) && (isset($GLOBALS['cache_array']['config'][$no])) && (is_array($GLOBALS['cache_array']['config'][$no]))) {
                // Load config from cache
-               //* DEBUG: */ echo gettype($GLOBALS['cache_array']['config'][$no])."<br />\n";
+               //* DEBUG: */ OUTPUT_HTML(gettype($GLOBALS['cache_array']['config'][$no])."<br />");
                foreach ($GLOBALS['cache_array']['config'][$no] as $key => $value) {
-                       $_CONFIG[$key] = $value;
+                       setConfigEntry($key, $value);
                } // END - foreach
 
                // Count cache hits if exists
-               if ((isset($_CONFIG['cache_hits'])) && (EXT_IS_ACTIVE('cache'))) {
-                       $_CONFIG['cache_hits']++;
+               if ((isConfigEntrySet('cache_hits')) && (EXT_IS_ACTIVE('cache'))) {
+                       incrementConfigEntry('cache_hits');
                } // END - if
        } elseif ((!EXT_IS_ACTIVE('cache')) || (!isset($GLOBALS['cache_array']['config'][$no]))) {
                // Load config from DB
@@ -138,23 +144,172 @@ function loadConfiguration ($no="0") {
                // Is the config there?
                if (SQL_NUMROWS($result_config) == 1) {
                        // Get config from database
-                       $_CONFIG = SQL_FETCHARRAY($result_config);
+                       mergeConfig(SQL_FETCHARRAY($result_config));
                } // END - if
 
                // Free result
                SQL_FREERESULT($result_config);
 
                // Remember this config in the array
-               $GLOBALS['cache_array']['config'][$no] = $_CONFIG;
+               $GLOBALS['cache_array']['config'][$no] = getConfigArray();
        }
 }
 
-// Getter for whole $_CONFIG array
+// Getter for whole $GLOBALS['config'] array
 function getConfigArray () {
-       global $_CONFIG;
+       // Default is null
+       $return = null;
 
-       // Return it
-       return $_CONFIG;
+       // Is the config set?
+       if (isConfigLoaded()) {
+               // 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(
+               "define('SITE_KEY',"           => 'SITE_KEY',
+               "define('DEFAULT_LANG',"       => 'DEFAULT_LANG',
+               "define('warn_no_pass',"       => 'WARN_NO_PASS',
+               "define('WRITE_FOOTER',"       => 'WRITE_FOOTER',
+               "define('OUTPUT_MODE',"        => 'OUTPUT_MODE',
+               "define('MAIN_TITLE',"         => 'MAIN_TITLE',
+               "define('SLOGAN',"             => 'SLOGAN',
+               "define('WEBMASTER',"          => 'WEBMASTER',
+               "define('mxchange_installed'," => 'MXCHANGE_INSTALLED',
+               "define('admin_registered',"   => 'ADMIN_REGISTERED',
+               "define('_MYSQL_PREFIX',"      => '_MYSQL_PREFIX',
+               "define('_TABLE_TYPE',"        => '_TABLE_TYPE',
+               "define('_DB_TYPE',"           => '_DB_TYPE',
+               "define('SMTP_HOSTNAME',"      => 'SMTP_HOSTNAME',
+               "define('SMTP_USER'"           => 'SMTP_USER',
+               "define('SMTP_PASSWORD',"      => 'SMTP_PASSWORD',
+               "define('ENABLE_BACKLINK',"    => 'ENABLE_BACKLINK',
+       );
+
+       // Make these lower-case! (damn stupid code...)
+       $lowerCase = array('WARN_NO_PASS', 'MXCHANGE_INSTALLED', 'ADMIN_REGISTERED');
+
+       // These are still constants...
+       // @TODO Rewrite these all to config entries, if somehow possible
+       $constants = array('MAIN_TITLE', 'SLOGAN', 'WEBMASTER');
+
+       // 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(constant('PATH') . 'inc/config-local.php.dist', constant('PATH') . 'inc/cache/config-local.php', 0644);
+
+       // First of all, load the old one!
+       $oldConfig = explode("\n", readFromFile(constant('PATH') . 'inc/config.php'));
+
+       // Now, analyze every entry
+       $done = array();
+       foreach ($oldConfig as $line) {
+               // Check all watch lines
+               foreach ($watchLines as $old => $new) {
+                       // Is the line found?
+                       if ((substr($line, 0, strlen($old)) == $old) && (!isset($done[$old]))) {
+                               // Entry found!
+                               //* DEBUG: */ OUTPUT_HTML(htmlentities($line) . " - FOUND!<br />");
+
+                               // Eval the line...
+                               eval($line);
+
+                               // Setting config entry is new default behaviour!
+                               $function = 'setConfigEntry';
+
+                               // Still some old constants left?
+                               if (in_array($new, $constants)) {
+                                       // Then switch over...
+                                       $function = 'define';
+                               } // END - if
+
+                               // 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: */ OUTPUT_HTML('function=' . $function . ',new=' . $new . ',comment=' . $comment . "<br />");
+                               changeDataInFile(constant('PATH') . 'inc/cache/config-local.php', $comment, $function . "('" . $oldNew . "', \"", "\");", constant($new), 0);
+                               //* DEBUG: */ OUTPUT_HTML("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: */ OUTPUT_HTML(htmlentities($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(constant('PATH') . 'inc/cache/config-local.php', $comments[$key], "    '".$key."'     => \"", "\",", $value, 0);
+               }
+       } // END - foreach
+
+       // Finally remove old config file
+       removeFile(constant('PATH') . 'inc/config.php');
+
+       // Redirect to same URL to reload our new config
+       redirectToUrl($_SERVER['REQUEST_URI']);
 }
 
 // [EOF]