Description made more clear
[mailer.git] / inc / config-functions.php
index 694a53eb639071f9f1010524ff658d073c899fa4..01d538db1977cd093cbb6e9edb1239a021e9220d 100644 (file)
@@ -1,23 +1,22 @@
 <?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                             *
  * -------------------------------------------------------------------- *
- * Short description : Many non-MySQL functions (also file access)      *
+ * Short description : Configuration functions                          *
  * -------------------------------------------------------------------- *
- * Kurzbeschreibung  : Viele Nicht-MySQL-Funktionen (auch Dateizugriff) *
+ * Kurzbeschreibung  : Konfigurationsfunktionen                         *
  * -------------------------------------------------------------------- *
  * $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 - 2009 by Roland Haeder                           *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -46,7 +45,7 @@ function initConfig () {
        // Init not if already found
        if (isConfigurationLoaded()) {
                // Already initialized
-               debug_report_bug(sprintf("[%s:%s] Configuration is already initialized.", __FUNCTION__, __LINE__));
+               debug_report_bug(__FUNCTION__, __LINE__, 'Configuration is already initialized.');
        } // END - if
 
        // Set a minimum of configuration, required to by-pass some error triggers in getConfig()
@@ -72,20 +71,14 @@ function initConfig () {
 
 // Getter for $GLOBALS['config'] entries
 function getConfig ($configEntry) {
-       // Default value
-       $value = null;
-
        // Is the entry there?
-       if (!isset($GLOBALS['config'][$configEntry])) {
+       if (!isConfigEntrySet($configEntry)) {
                // Raise an error of missing entries
-               debug_report_bug(sprintf("[%s:%s] Configuration entry <em>%s</em> is missing.",
-                       __FUNCTION__,
-                       __LINE__,
-                       $configEntry
-               ));
+               debug_report_bug(__FUNCTION__, __LINE__, sprintf("Configuration entry <span class=\"data\">%s</span> is missing.", $configEntry));
        } // END - if
 
        // Return it
+       //* DEBUG: */ error_log(__FUNCTION__.'['.__LINE__.':] '.$configEntry.'='.$GLOBALS['config'][$configEntry]);
        return $GLOBALS['config'][$configEntry];
 }
 
@@ -97,7 +90,7 @@ function setConfigEntry ($configEntry, $value) {
 
 // Checks wether the given config entry is set
 function isConfigEntrySet ($configEntry) {
-       //* DEBUG: */ print __FUNCTION__.':'.$configEntry.'='.intval(isset($GLOBALS['config'][$configEntry])).'<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $configEntry . '=' . intval(isset($GLOBALS['config'][$configEntry])));
        return (isset($GLOBALS['config'][$configEntry]));
 }
 
@@ -108,7 +101,7 @@ function mergeConfig ($newConfig) {
 
 // Increment or init with given value or 1 as default the given config entry
 function incrementConfigEntry ($configEntry, $value=1) {
-       // Increment it if set or init it with 1
+       // Increment it if set or init it with $value
        if (isConfigEntrySet($configEntry)) {
                $GLOBALS['config'][$configEntry] += $value;
        } else {
@@ -156,7 +149,7 @@ function updateOldConfigFile () {
                '_TABLE_TYPE'        => '_TABLE_TYPE',
                '_DB_TYPE'           => '_DB_TYPE',
                'SMTP_HOSTNAME'      => 'SMTP_HOSTNAME',
-               'SMTP_USER'           => 'SMTP_USER',
+               'SMTP_USER'          => 'SMTP_USER',
                'SMTP_PASSWORD'      => 'SMTP_PASSWORD',
                'ENABLE_BACKLINK'    => 'ENABLE_BACKLINK',
                'MAIN_TITLE'         => 'MAIN_TITLE',
@@ -185,10 +178,10 @@ function updateOldConfigFile () {
        );
 
        // Copy template to new file destionation
-       copyFileVerified(getConfig('PATH') . 'inc/config-local.php.dist', getConfig('CACHE_PATH') . 'config-local.php', 0644);
+       copyFileVerified(getPath() . 'inc/config-local.php.dist', getCachePath() . 'config-local.php', 0644);
 
        // First of all, load the old one!
-       $oldConfig = explode("\n", readFromFile(getConfig('PATH') . 'inc/config.php'));
+       $oldConfig = explode("\n", readFromFile(getPath() . 'inc/config.php'));
 
        // Now, analyze every entry
        $done = array();
@@ -200,8 +193,8 @@ function updateOldConfigFile () {
 
                        // Is the line found?
                        if ((substr($line, 0, strlen($old)) == $old) && (!isset($done[$old]))) {
-                               // Entry found!
-                               //* DEBUG: */ outputHtml(htmlentities($line) . " - FOUND!<br />");
+                               // Entry found
+                               //* DEBUG: */ debugOutput(secureString($line) . ' - FOUND!');
 
                                // Eval the line...
                                eval($line);
@@ -226,9 +219,9 @@ function updateOldConfigFile () {
                                } // 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 />");
+                               //* DEBUG: */ debugOutput('function=' . $function . ',new=' . $new . ',comment=' . $comment);
+                               changeDataInInclude(getCachePath() . 'config-local.php', $comment, $function . "('" . $oldNew . "', \"", '");', constant($new), 0);
+                               //* DEBUG: */ debugOutput('CHANGED!');
 
                                // Mark it as done
                                $done[$old] = 1;
@@ -245,8 +238,8 @@ function updateOldConfigFile () {
                $line = trim($line);
 
                // Is the $MySQL found?
-               if (substr($line, 0, 6) == "\$MySQL") {
-                       // Okay found!
+               if (substr($line, 0, 6) == '$MySQL') {
+                       // Okay, found
                        $found = true;
                } elseif ($found === true) {
                        // Now check this row
@@ -259,19 +252,19 @@ function updateOldConfigFile () {
                        }
 
                        // Debug output only
-                       //* DEBUG: */ outputHtml(htmlentities($line) . " - MySQL!<br />");
+                       //* DEBUG: */ debugOutput(secureString($line) . ' - MySQL!');
 
                        // 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);
+                       changeDataInInclude(getCachePath() . 'config-local.php', $comments[$key], "     '".$key."'     => \"", '",', $value, 0);
                }
        } // END - foreach
 
        // Finally remove old config file
-       removeFile(getConfig('PATH') . 'inc/config.php');
+       removeFile(getPath() . 'inc/config.php');
 
        // Redirect to same URL to reload our new config
        redirectToUrl(getRequestUri());
@@ -280,7 +273,7 @@ function updateOldConfigFile () {
 // Update config entries
 function updateConfiguration ($entries, $values, $updateMode='', $config = '0') {
        // Do not update config in CSS mode
-       if ((getOutputMode() == 1) || (getOutputMode() == -1) || (isInstallationPhase())) {
+       if ((isCssOutputMode()) || (isRawOutputMode()) || (isInstallationPhase())) {
                return;
        } // END - if
 
@@ -292,12 +285,15 @@ function updateConfiguration ($entries, $values, $updateMode='', $config = '0')
                        // Update mode set?
                        if (!empty($updateMode)) {
                                // Update entry
-                               $all .= sprintf("`%s`=`%s`%s%s,", $entry, $entry, $updateMode, (float)$values[$idx]);
+                               $all .= sprintf("`%s`=`%s`%s%s,", $entry, $entry, $updateMode, (float) $values[$idx]);
                        } else {
-                               // Check if string or number
-                               if (($values[$idx] + 0) === $values[$idx]) {
+                               // Check if string or number but no array
+                               if (is_array($values[$idx])) {
+                                       // Arrays must be fixed...
+                                       debug_report_bug(__FUNCTION__, __LINE__, '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]);
+                                       $all .= sprintf("`%s`=%s,", $entry, (float) $values[$idx]);
 
                                        // Set it in config as well
                                        setConfigEntry($entry, $values[$idx]);
@@ -321,13 +317,13 @@ function updateConfiguration ($entries, $values, $updateMode='', $config = '0')
                $entries = substr($all, 0, -1);
        } elseif (!empty($updateMode)) {
                // Update mode set
-               $entries = sprintf("`%s`=`%s`%s%s", $entries, $entries, $updateMode, (float)$values);
+               $entries = sprintf("`%s`=`%s`%s%s", $entries, $entries, $updateMode, (float) $values);
        } elseif (($values + 0) === $values) {
                // Number detected
-               $entries = sprintf("`%s`=%s", $entries, (float)$values);
+               $entries = sprintf("`%s`=%s", $entries, (float) $values);
 
                // Set it in config first
-               setConfigEntry($entries, (float)$values);
+               setConfigEntry($entries, (float) $values);
        } elseif ($values == 'UNIX_TIMESTAMP()') {
                // Function UNIX_TIMESTAMP() detected
                $entries = sprintf("`%s`=UNIX_TIMESTAMP()", $entries);
@@ -343,19 +339,21 @@ function updateConfiguration ($entries, $values, $updateMode='', $config = '0')
        }
 
        // Run database update
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "entries={$entries}");
+       //* 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: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):entries={$entries},affectedRows={$affectedRows}<br />");
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'entries=' . $entries . ',affectedRows=' . SQL_AFFECTEDROWS());
 
        // Rebuild cache
-       rebuildCacheFile('config', 'config');
+       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';
+       if (is_null($no)) {
+               $no = '0';
+       } // END - if
 
        // 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]))) {