* -------------------------------------------------------------------- *
* File : config-functions.php *
* -------------------------------------------------------------------- *
- * Short description : Many non-MySQL functions (also file access) *
+ * Short description : Configuration functions *
* -------------------------------------------------------------------- *
- * 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!!!!!! *
+ * Kurzbeschreibung : Konfigurationsfunktionen *
* -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
- * For more information visit: http://www.mxchange.org *
+ * 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 *
* it under the terms of the GNU General Public License as published by *
// Init not if already found
if (isConfigurationLoaded()) {
// Already initialized
- debug_report_bug(sprintf("[%s:%s] Configuration is already initialized.", __FUNCTION__, __LINE__));
+ reportBug(__FUNCTION__, __LINE__, 'Configuration is already initialized.');
} // END - if
// Set a minimum of configuration, required to by-pass some error triggers in getConfig()
'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',
// 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
- ));
+ reportBug(__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];
}
function setConfigEntry ($configEntry, $value) {
// 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) {
- //* DEBUG: */ print __FUNCTION__.':'.$configEntry.'='.intval(isset($GLOBALS['config'][$configEntry])).'<br />';
- 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
+ // Increment it if set or init it with $value
if (isConfigEntrySet($configEntry)) {
$GLOBALS['config'][$configEntry] += $value;
} else {
}
}
-// Checks wether the configuration array is set so the config is loaded
+// Checks whether the configuration array is set so the config is loaded
function isConfigurationLoaded () {
// Check all
return (isset($GLOBALS['config']['config']));
// 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',
);
// 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(PHP_EOL, readFromFile(getPath() . 'inc/config.php'));
// Now, analyze every entry
$done = array();
// Is the line found?
if ((substr($line, 0, strlen($old)) == $old) && (!isset($done[$old]))) {
- // Entry found!
- //* DEBUG: */ outputHtml(secureString($line) . " - FOUND!<br />");
+ // Entry found
+ //* DEBUG: */ debugOutput(secureString($line) . ' - FOUND!');
// Eval the line...
eval($line);
// 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: */ 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 />");
+ // ... 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;
} // 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) {
$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
}
// Debug output only
- //* DEBUG: */ outputHtml(secureString($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());
}
// 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 ((getOutputMode() == 1) || (getOutputMode() == -1) || (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()) . ',isInstaller()=' . intval(isInstaller()));
return;
} // END - if
- // Do we have multiple entries?
+ // Default is empty SQL
+ $SQL = '';
+
+ // Is there 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]);
+ $SQL .= sprintf('`%s`=`%s`%s%01.5f,', $entry, $entry, $updateMode, (float) $values[$idx]);
} else {
- // Check if string or number
- if (($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]);
+ // 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=<pre>'.print_r($values[$idx], TRUE).'</pre>');
} elseif ($values[$idx] == 'UNIX_TIMESTAMP()') {
// Function UNIX_TIMESTAMP() detected
- $all .= 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());
+ } 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
- $all .= 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]);
} // END - foreach
// Remove last comma
- $entries = substr($all, 0, -1);
+ $SQL = substr($SQL, 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);
+ // Is the value zero?
+ if ($values == '0') {
+ // Then skip it
+ return;
+ } // END - if
- // Set it in config first
- setConfigEntry($entries, (float)$values);
+ // 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
- $entries = 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
- $entries = 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__, "entries={$entries}");
- SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_config` SET ".$entries." WHERE `config`=%s LIMIT 1",
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL=' . $SQL);
+ sqlQueryEscaped('UPDATE `{?_MYSQL_PREFIX?}_config` SET ' . $SQL . ' 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__, 'SQL=' . $SQL . ',affectedRows=' . sqlAffectedRows());
// 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';
+ // 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 if exists
- if ((isStatsEntrySet('cache_hits')) && (isExtensionActive('cache'))) {
- incrementStatsEntry('cache_hits');
- } // END - if
+ // 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]
?>
projects / mailer.git / blobdiff