X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fconfig-functions.php;h=29c0a7a2e12ec4f4ee05f1fbbb2d48d38d028462;hp=c70857e9af77a6b39957d952af2335b5cb34ab74;hb=15e0995f7a4a4b2c9b1b1a9273f785cf13605829;hpb=36c3c8b749a88ce05ad0fda81e00047f9cb5433f diff --git a/inc/config-functions.php b/inc/config-functions.php index c70857e9af..29c0a7a2e1 100644 --- a/inc/config-functions.php +++ b/inc/config-functions.php @@ -1,24 +1,23 @@ 0, + 'sql_count' => 0, + 'num_templates' => 0, + // 'DEFAULT_SALT_LENGTH' => 40, + // 'DEBUG_MODE' => 'N', + // 'DEBUG_HOURLY' => 'N', + // 'DEBUG_DAILY' => 'N', + // 'DEBUG_MONTHLY' => 'N', + // 'DEBUG_YEARLY' => '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($configEntry)) { - // Then use it - $value = $GLOBALS['config'][$configEntry]; + if (!isConfigEntrySet($configEntry)) { + // Raise an error of missing entries + reportBug(__FUNCTION__, __LINE__, sprintf('Configuration entry %s is missing.', $configEntry)); } // END - if // Return it - return $value; + //* DEBUG: */ error_log(__FUNCTION__.'['.__LINE__.':] '.$configEntry.'='.$GLOBALS['config'][$configEntry]); + return $GLOBALS['config'][$configEntry]; } // Setter for $GLOBALS['config'] entries function setConfigEntry ($configEntry, $value) { - // Secure the entry name - if (function_exists('SQL_ESCAPE')) { - // Use our secure function - $configEntry = SQL_ESCAPE($configEntry); - } else { - // Use maybe insecure function - $configEntry = smartAddSlashes($configEntry); - } - - // And set it + // Just set it (unsecured won't hurt?) $GLOBALS['config'][$configEntry] = $value; + + // Remove cache + removeGlobalCache($configEntry); +} + +// Removes entry in $GLOBALS +function removeGlobalCache ($configEntry) { + // Generate key + $key = 'get' . capitalizeUnderscoreString($configEntry); + + // Remove it + unset($GLOBALS[$key]); } -// Checks wether the given config entry is set +// Checks whether the given config entry is set function isConfigEntrySet ($configEntry) { - return (isset($GLOBALS['config'][$configEntry])); + //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $configEntry . '=' . intval(isset($GLOBALS['config'][$configEntry]))); + return ((isset($GLOBALS['config'][$configEntry])) || (array_key_exists($configEntry, $GLOBALS['config']))); +} + +// Merges $GLOBALS['config'] with data in given array +function mergeConfig ($newConfig) { + // Merge current configuration with new one + $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) { - // Increment it if set or init it with 1 - if (getConfig($configEntry) > 0) { + // Increment it if set or init it with $value + if (isConfigEntrySet($configEntry)) { $GLOBALS['config'][$configEntry] += $value; } else { $GLOBALS['config'][$configEntry] = $value; } } -// Checks wether the configuration array is set so the config is loaded -function isConfigLoaded () { +// Checks whether the configuration array is set so the config is loaded +function isConfigurationLoaded () { // Check all - return ((isset($GLOBALS['config'])) && (is_array($GLOBALS['config'])) && (count($GLOBALS['config']) > 0)); -} - -// Init the config array -function initConfig () { - // Set a minimum dummy configuration - $GLOBALS['config'] = array( - 'code_length' => 0, - 'patch_level' => 0, - 'last_update' => time() - ); -} - -// Load configuration and return it as an arry -function loadConfiguration ($no = '0') { - // Check for cache extension, cache-array and if the requested configuration is in cache - 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: */ OUTPUT_HTML(gettype($GLOBALS['cache_array']['config'][$no])."
"); - foreach ($GLOBALS['cache_array']['config'][$no] as $key => $value) { - setConfigEntry($key, $value); - } // END - foreach - - // Count cache hits if exists - 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 - $result_config = SQL_QUERY_ESC("SELECT * FROM `{!_MYSQL_PREFIX!}_config` WHERE config=%d 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(); - } + return (isset($GLOBALS['config']['config'])); } // Getter for whole $GLOBALS['config'] array function getConfigArray () { // Default is null - $return = null; + $return = array(); // Is the config set? - if (isConfigLoaded()) { + if (isset($GLOBALS['config'])) { // Then use it $return = $GLOBALS['config']; } // END - if @@ -161,36 +150,37 @@ 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', + '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'); - - // These are still constants... - // @TODO Rewrite these all to config entries, if somehow possible - $constants = array('MAIN_TITLE', 'SLOGAN', 'WEBMASTER'); + $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', @@ -203,20 +193,23 @@ function updateOldConfigFile () { ); // Copy template to new file destionation - copyFileVerified(constant('PATH') . 'inc/config-local.php.dist', constant('PATH') . 'inc/cache/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(constant('PATH') . 'inc/config.php')); + $oldConfig = explode(PHP_EOL, readFromFile(getPath() . '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: */ OUTPUT_HTML(htmlentities($line) . " - FOUND!
"); + // Entry found + //* DEBUG: */ debugOutput(secureString($line) . ' - FOUND!'); // Eval the line... eval($line); @@ -224,32 +217,26 @@ function updateOldConfigFile () { // 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? + // Is there a special comment? if (isset($comments[$new])) { // Then use it $comment = $comments[$new]; } // END - if - // Do we need to make $new lowercase? + // Does $new needs to be lower-case? $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 . "
"); - changeDataInFile(constant('PATH') . 'inc/cache/config-local.php', $comment, $function . "('" . $oldNew . "', \"", "\");", constant($new), 0); - //* DEBUG: */ OUTPUT_HTML("CHANGED!
"); + // ... and write it to the new config + //* 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; @@ -258,7 +245,7 @@ function updateOldConfigFile () { } // END - foreach // By default the old array $MySQL was not found - $found = false; + $found = FALSE; // Analyze every entry again for the MySQL configuration foreach ($oldConfig as $line) { @@ -266,13 +253,14 @@ function updateOldConfigFile () { $line = trim($line); // Is the $MySQL found? - if (substr($line, 0, 6) == "\$MySQL") { - // Okay found! - $found = true; - } elseif ($found === true) { + 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 + $found = FALSE; break; } elseif (substr($line, 0, 2) == '//') { // Skip this line @@ -280,22 +268,198 @@ function updateOldConfigFile () { } // Debug output only - //* DEBUG: */ OUTPUT_HTML(htmlentities($line) . " - MySQL!
"); + //* 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(constant('PATH') . 'inc/cache/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(constant('PATH') . 'inc/config.php'); + removeFile(getPath() . 'inc/config.php'); // Redirect to same URL to reload our new config - redirectToUrl($_SERVER['REQUEST_URI']); + redirectToUrl(getRequestUri()); +} + +// Update config entries +function updateConfiguration ($entries, $values, $updateMode = '', $config = '0', $force = FALSE) { + // Do not update config in CSS mode + 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()) . ',isInstaller()=' . intval(isInstaller())); + return; + } // END - if + + // Default is empty SQL + $SQL = ''; + + // Is there multiple entries? + if (is_array($entries)) { + // Walk through all + foreach ($entries as $idx => $entry) { + // Update mode set? + if (!empty($updateMode)) { + // Update entry + $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])) { + // Arrays must be fixed... + reportBug(__FUNCTION__, __LINE__, 'values[' . $idx . '] should not be an array! Content=
'.print_r($values[$idx], TRUE).'
'); + } elseif ($values[$idx] == 'UNIX_TIMESTAMP()') { + // Function UNIX_TIMESTAMP() detected + //* 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()); + } elseif (!empty($updateMode)) { + // Is the value zero? + if ($values[$idx] == '0') { + // Then skip it + continue; + } // END - if + + // Update mode set + // @TODO Call setConfigEntry() somehow + $SQL .= $entries = sprintf('`%s`=`%s`%s%01.5f', $entry, $entry, $updateMode, (float) $values[$idx]); + } elseif (($values[$idx] + 0) === $values[$idx]) { + // Number detected + //* 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 + //* 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]); + } + } + } // END - foreach + + // Remove last comma + $SQL = substr($SQL, 0, -1); + } elseif (!empty($updateMode)) { + // Is the value zero? + if ($values == '0') { + // Then skip it + continue; + } // END - if + + // Update mode set + // @TODO Call setConfigEntry() somehow + $SQL = sprintf('`%s`=`%s`%s%01.5f', $entries, $entries, $updateMode, (float) $values); + } elseif ($values == 'UNIX_TIMESTAMP()') { + // Function UNIX_TIMESTAMP() detected + //* 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 + //* 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, sqlEscapeString($values)); + } + + // Run database update + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL=' . $SQL); + sqlQueryEscaped('UPDATE `{?_MYSQL_PREFIX?}_config` SET ' . $SQL . ' WHERE `config`=%s LIMIT 1', + array(bigintval($config)), __FUNCTION__, __LINE__); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL=' . $SQL . ',affectedRows=' . sqlAffectedRows()); + + // Rebuild cache + rebuildCache('config', 'config'); +} + +// Filter for loading configuration +function FILTER_LOAD_CONFIGURATION ($no = '0') { + // Is installation phase? + if (isInstaller()) { + // Then don't load any configuration + return; + } // END - if + + // Is the value null, it comes from the 'init' filter chain + 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]))) { + // Load config from cache + mergeConfig($GLOBALS['cache_array']['config'][$no]); + + // Count cache hits + incrementStatsEntry('cache_hits'); + } elseif ((!isExtensionActive('cache')) || (!isset($GLOBALS['cache_array']['config'][$no]))) { + // Load config from DB + $result_config = sqlQueryEscaped('SELECT * FROM `{?_MYSQL_PREFIX?}_config` WHERE `config`=%s LIMIT 1', + array(bigintval($no)), __FUNCTION__, __LINE__); + + // Is the config there? + if (sqlNumRows($result_config) == 1) { + // Get config from database + mergeConfig(sqlFetchArray($result_config)); + } // END - if + + // Free result + 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]