Continued a bit:
[mailer.git] / inc / config-functions.php
index 035f169d7864b68de7f3311fe313314d23ec6eec..825faea0d883e6fa11593a19de0ac1919229ae31 100644 (file)
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Konfigurationsfunktionen                         *
  * -------------------------------------------------------------------- *
- * $Revision::                                                        $ *
- * $Date::                                                            $ *
- * $Tag:: 0.2.1-FINAL                                                 $ *
- * $Author::                                                          $ *
- * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
+ * Copyright (c) 2009 - 2016 by Mailer Developer Team                   *
  * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -55,8 +50,10 @@ function initConfig () {
                'num_templates'       => 0,
                // 'DEFAULT_SALT_LENGTH' => 40,
                // 'DEBUG_MODE'          => 'N',
-               // 'DEBUG_RESET'         => 'N',
+               // 'DEBUG_HOURLY'        => 'N',
+               // 'DEBUG_DAILY'         => 'N',
                // 'DEBUG_MONTHLY'       => 'N',
+               // 'DEBUG_YEARLY'        => 'N',
                // 'DEBUG_WEEKLY'        => 'N',
                // 'DEBUG_REGEX'         => 'N',
                // 'ADMIN_REGISTERED'    => 'N',
@@ -74,7 +71,7 @@ function getConfig ($configEntry) {
        // Is the entry there?
        if (!isConfigEntrySet($configEntry)) {
                // Raise an error of missing entries
-               reportBug(__FUNCTION__, __LINE__, sprintf("Configuration entry <span class=\"data\">%s</span> is missing.", $configEntry));
+               reportBug(__FUNCTION__, __LINE__, sprintf('Configuration entry <span class="data">%s</span> is missing.', $configEntry));
        } // END - if
 
        // Return it
@@ -148,37 +145,37 @@ 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',
+               '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',
+               'mailer_installed' => 'MAILER_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');
+       $lowerCase = array('WARN_NO_PASS', 'MAILER_INSTALLED', 'ADMIN_REGISTERED');
 
        // Special comments...
        $comments = array(
                'WARN_NO_PASS'       => 'NULLPASS-WARNING',
-               'MXCHANGE_INSTALLED' => 'INSTALLED',
+               'MAILER_INSTALLED  ' => 'INSTALLED',
                'ADMIN_REGISTERED'   => 'ADMIN-SETUP',
                '_MYSQL_PREFIX'      => 'MYSQL-PREFIX',
                '_TABLE_TYPE'        => 'TABLE-TYPE',
@@ -194,7 +191,7 @@ function updateOldConfigFile () {
        copyFileVerified(getPath() . 'inc/config-local.php.dist', getCachePath() . 'config-local.php', 0644);
 
        // First of all, load the old one!
-       $oldConfig = explode(chr(10), readFromFile(getPath() . 'inc/config.php'));
+       $oldConfig = explode(PHP_EOL, readFromFile(getPath() . 'inc/config.php'));
 
        // Now, analyze every entry
        $done = array();
@@ -258,6 +255,7 @@ function updateOldConfigFile () {
                        // Now check this row
                        if (substr($line, 0, 2) == ');') {
                                // MySQL array is closed so stop looking for it
+                               $found = FALSE;
                                break;
                        } elseif (substr($line, 0, 2) == '//') {
                                // Skip this line
@@ -284,11 +282,11 @@ function updateOldConfigFile () {
 }
 
 // Update config entries
-function updateConfiguration ($entries, $values, $updateMode = '', $config = '0') {
+function updateConfiguration ($entries, $values, $updateMode = '', $config = '0', $force = FALSE) {
        // Do not update config in CSS mode
-       if ((isCssOutputMode()) || (isRawOutputMode()) || (isInstallationPhase())) {
+       if (($force === FALSE) && ((isCssOutputMode()) || (isRawOutputMode()) || (isInstaller()))) {
                // This logger line may be very noisy
-               //* 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()));
+               /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Not updating configuration. entries[]=' . gettype($entries) . ',values[]=' . gettype($values) . ',updateMode=' . $updateMode . ',config=' . $config . ',isCssOutputMode()=' . intval(isCssOutputMode()) . ',isRawOutputMode()=' . intval(isRawOutputMode()) . ',isInstaller()=' . intval(isInstaller()));
                return;
        } // END - if
 
@@ -302,7 +300,7 @@ function updateConfiguration ($entries, $values, $updateMode = '', $config = '0'
                        // Update mode set?
                        if (!empty($updateMode)) {
                                // Update entry
-                               $SQL .= sprintf("`%s`=`%s`%s%s,", $entry, $entry, $updateMode, (float) $values[$idx]);
+                               $SQL .= sprintf('`%s`=`%s`%s%01.5f,', $entry, $entry, $updateMode, (float) $values[$idx]);
                        } else {
                                // Check if string or number but no array
                                if (is_array($values[$idx])) {
@@ -310,7 +308,8 @@ function updateConfiguration ($entries, $values, $updateMode = '', $config = '0'
                                        reportBug(__FUNCTION__, __LINE__, 'values[' . $idx . '] should not be an array! Content=<pre>'.print_r($values[$idx], TRUE).'</pre>');
                                } elseif ($values[$idx] == 'UNIX_TIMESTAMP()') {
                                        // Function UNIX_TIMESTAMP() detected
-                                       $SQL .= sprintf("`%s`=UNIX_TIMESTAMP(),", $entry);
+                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Function UNIX_TIMESAMP() detected: entry=' . $entry);
+                                       $SQL .= sprintf('`%s`=UNIX_TIMESTAMP(),', $entry);
 
                                        // Set timestamp in array as well
                                        setConfigEntry($entry, time());
@@ -323,16 +322,18 @@ function updateConfiguration ($entries, $values, $updateMode = '', $config = '0'
 
                                        // Update mode set
                                        // @TODO Call setConfigEntry() somehow
-                                       $SQL .= $entries = sprintf("`%s`=`%s`%s%s", $entry, $entry, $updateMode, (float) $values[$idx]);
+                                       $SQL .= $entries = sprintf('`%s`=`%s`%s%01.5f', $entry, $entry, $updateMode, (float) $values[$idx]);
                                } elseif (($values[$idx] + 0) === $values[$idx]) {
                                        // Number detected
-                                       $SQL .= sprintf("`%s`=%s,", $entry, (float) $values[$idx]);
+                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Number detected: entry=' . $entry . ',values[' . $idx . '/' . gettype($values[$idx]) . ']=' . $values[$idx]);
+                                       $SQL .= sprintf('`%s`=%01.5f,', $entry, (float) $values[$idx]);
 
                                        // Set it in config as well
                                        setConfigEntry($entry, $values[$idx]);
                                } else {
                                        // String detected
-                                       $SQL .= sprintf("`%s`='%s',", $entry, SQL_ESCAPE($values[$idx]));
+                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Regular value detected: entry=' . $entry . ',values[' . $idx . '/' . gettype($values[$idx]) . ']=' . $values[$idx]);
+                                       $SQL .= sprintf("`%s`='%s',", $entry, sqlEscapeString($values[$idx]));
 
                                        // Set it in config as well
                                        setConfigEntry($entry, $values[$idx]);
@@ -346,37 +347,40 @@ function updateConfiguration ($entries, $values, $updateMode = '', $config = '0'
                // Is the value zero?
                if ($values == '0') {
                        // Then skip it
-                       continue;
+                       return;
                } // END - if
 
                // Update mode set
                // @TODO Call setConfigEntry() somehow
-               $SQL = sprintf("`%s`=`%s`%s%s", $entries, $entries, $updateMode, (float) $values);
-       } elseif (($values + 0) === $values) {
-               // Number detected
-               $SQL = sprintf("`%s`=%s", $entries, (float) $values);
-
-               // Set it in config first
-               setConfigEntry($entries, (float) $values);
+               $SQL = sprintf('`%s`=`%s`%s%01.5f', $entries, $entries, $updateMode, (float) $values);
        } elseif ($values == 'UNIX_TIMESTAMP()') {
                // Function UNIX_TIMESTAMP() detected
-               $SQL = sprintf("`%s`=UNIX_TIMESTAMP()", $entries);
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Function UNIX_TIMESAMP() detected: entries=' . $entries);
+               $SQL = sprintf('`%s`=UNIX_TIMESTAMP()', $entries);
 
                // Set timestamp in array as well
                setConfigEntry($entries, time());
+       } elseif (($values + 0) === $values) {
+               // Number detected
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Number detected: entries=' . $entries . ',values[' . gettype($values) . ']=' . $values);
+               $SQL = sprintf('`%s`=%01.5f', $entries, (float) $values);
+
+               // Set it in config first
+               setConfigEntry($entries, (float) $values);
        } else {
                // Regular entry to update
-               $SQL = sprintf("`%s`='%s'", $entries, SQL_ESCAPE($values));
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Regular value detected: entries=' . $entries . ',values[' . gettype($values) . ']=' . $values);
+               $SQL = sprintf("`%s`='%s'", $entries, sqlEscapeString($values));
 
                // Set it in config as well
-               setConfigEntry($entries, SQL_ESCAPE($values));
+               setConfigEntry($entries, sqlEscapeString($values));
        }
 
        // Run database update
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL=' . $SQL);
-       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_config` SET ".$SQL." WHERE `config`=%s LIMIT 1",
+       sqlQueryEscaped('UPDATE `{?_MYSQL_PREFIX?}_config` SET ' . $SQL . ' WHERE `config`=%s LIMIT 1',
                        array(bigintval($config)), __FUNCTION__, __LINE__);
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL=' . $SQL . ',affectedRows=' . SQL_AFFECTEDROWS());
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL=' . $SQL . ',affectedRows=' . sqlAffectedRows());
 
        // Rebuild cache
        rebuildCache('config', 'config');
@@ -385,7 +389,7 @@ function updateConfiguration ($entries, $values, $updateMode = '', $config = '0'
 // Filter for loading configuration
 function FILTER_LOAD_CONFIGURATION ($no = '0') {
        // Is installation phase?
-       if (isInstallationPhase()) {
+       if (isInstaller()) {
                // Then don't load any configuration
                return;
        } // END - if
@@ -400,26 +404,58 @@ function FILTER_LOAD_CONFIGURATION ($no = '0') {
                // Load config from cache
                mergeConfig($GLOBALS['cache_array']['config'][$no]);
 
-               // Count cache hits 
+               // Count cache hits
                incrementStatsEntry('cache_hits');
        } 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",
+               $result_config = sqlQueryEscaped('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) {
+               if (sqlNumRows($result_config) == 1) {
                        // Get config from database
-                       mergeConfig(SQL_FETCHARRAY($result_config));
+                       mergeConfig(sqlFetchArray($result_config));
                } // END - if
 
                // Free result
-               SQL_FREERESULT($result_config);
+               sqlFreeResult($result_config);
 
                // Remember this config in the array
                $GLOBALS['cache_array']['config'][$no] = getConfigArray();
        }
 }
 
+// "Getter" for "checked" configuration entries
+function getCheckedConfig ($configEntries) {
+       // Add entries
+       $content = getConfigEntries($configEntries, ' checked="checked"');
+
+       // Return it
+       return $content;
+}
+
+// "Getter" for "selected" configuration entries
+function getSelectedConfig ($configEntries) {
+       // Add entries
+       $content = getConfigEntries($configEntries, ' selected="selected"');
+
+       // Return it
+       return $content;
+}
+
+// "Getter" for configuration entries
+function getConfigEntries ($configEntries, $value) {
+       // Init content
+       $content = array();
+
+       // "Walk" through all entries
+       foreach ($configEntries as $entry) {
+               $content[$entry . '_' . strtolower(getConfig($entry))] = $value;
+       } // END - foreach
+
+       // Return it
+       return $content;
+}
+
 // [EOF]
 ?>