X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Flanguage-functions.php;h=0db9afe7130c7ff49f4be9ce105ca9522a2fe7e1;hp=f1d7f0ac93b385c4135aae61daf3dd9828c61b5e;hb=49acdb7a7adbcf25a8e8683b5581bfcec72b23bd;hpb=1c4e78c5d68b97b82a3b930aa6db1e6df188f653 diff --git a/inc/language-functions.php b/inc/language-functions.php index f1d7f0ac93..0db9afe713 100644 --- a/inc/language-functions.php +++ b/inc/language-functions.php @@ -10,16 +10,9 @@ * -------------------------------------------------------------------- * * Kurzbeschreibung : Sprachfunktionen * * -------------------------------------------------------------------- * - * $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, 2010 by Mailer Developer Team * - * For more information visit: http://www.mxchange.org * + * Copyright (c) 2009 - 2015 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 * @@ -43,9 +36,8 @@ if (!defined('__SECURITY')) { } // END - if // "Getter" for language strings -// @TODO Rewrite all language constants to this function. function getMessage ($messageId) { - // Default is not found! + // Default is not found $return = '!' . $messageId . '!'; // Is the language string found? @@ -54,7 +46,7 @@ function getMessage ($messageId) { $return = $GLOBALS['messages'][getCurrentLanguage()][$messageId]; } else { // Missing language constant - logDebugMessage(__FUNCTION__, __LINE__, sprintf("Missing message string %s detected.", $messageId)); + logDebugMessage(__FUNCTION__, __LINE__, sprintf('Missing message string %s detected.', $messageId)); } // Return the string @@ -63,31 +55,42 @@ function getMessage ($messageId) { // Getter for message string as a mask function getMaskedMessage ($messageId, $data) { - return sprintf(getMessage($messageId), $data); + // Construct message + $message = sprintf(getMessage($messageId), $data); + + // Return it + return $message; } // Init messages function initMessages () { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getLanguage()=' . getLanguage()); $GLOBALS['messages'][getLanguage()] = array(); } // Add messages function addMessages ($messages) { + // Cache current language + $currentLanguage = getCurrentLanguage(); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentLanguage=' . $currentLanguage); + // Merge both - $GLOBALS['messages'][getCurrentLanguage()] = merge_array($GLOBALS['messages'][getCurrentLanguage()], $messages); + $GLOBALS['messages'][$currentLanguage] = merge_array($GLOBALS['messages'][$currentLanguage], $messages); // Don't count them if we don't want it - if (isset($GLOBALS['count'])) return; + if (isset($GLOBALS['count'])) { + return; + } // END - if // And count them - if (isset($GLOBALS['msg_count'][getCurrentLanguage()])) { - $GLOBALS['msg_count'][getCurrentLanguage()] += count($messages); + if (isset($GLOBALS['msg_count'][$currentLanguage])) { + $GLOBALS['msg_count'][$currentLanguage] += count($messages); } else { - $GLOBALS['msg_count'][getCurrentLanguage()] = count($messages); + $GLOBALS['msg_count'][$currentLanguage] = count($messages); } } -// Checks wether given message id is valid +// Checks whether given message id is valid function isMessageIdValid ($messageId) { return (isset($GLOBALS['messages'][getCurrentLanguage()][$messageId])); } @@ -102,34 +105,46 @@ function setCurrentLanguage ($language) { $GLOBALS['language'] = (string) $language; } +// Checks whether current language is set +function isCurrentLanguageSet () { + return (isset($GLOBALS['language'])); +} + // "Getter" for language function getLanguage () { - // Default is 'de'. DO NOT CHANGE THIS!!! - $ret = 'de'; - - // Set default return value to default language from config - if (isConfigEntrySet('DEFAULT_LANG')) $ret = getConfig('DEFAULT_LANG'); - - // Is the variable set - if (isGetRequestParameterSet('mx_lang')) { - // Accept only first 2 chars - $ret = substr(getRequestParameter('mx_lang'), 0, 2); - } elseif (isset($GLOBALS['language'])) { - // Use cached - $ret = getCurrentLanguage(); - } elseif (isSessionVariableSet('mx_lang')) { - // Return stored value from cookie - $ret = getSession('mx_lang'); - - // Fixes a warning before the session has the mx_lang constant - if (empty($ret)) $ret = getConfig('DEFAULT_LANG'); - } + // Is there cache? + if (!isCurrentLanguageSet()) { + // Default is 'de'. DO NOT CHANGE THIS!!! + $ret = 'de'; + + // Set default return value to default language from config + if (isConfigEntrySet('DEFAULT_LANG')) { + $ret = getDefaultLanguage(); + } // END - if + + // Is the variable set + if (isGetRequestElementSet('mailer_lang')) { + // Accept only first 2 chars + $ret = substr(getRequestElement('mailer_lang'), 0, 2); + } elseif (isCurrentLanguageSet()) { + // Use cached + $ret = getCurrentLanguage(); + } elseif (isSessionVariableSet('mailer_lang')) { + // Return stored value from cookie + $ret = getSession('mailer_lang'); + + // Fixes a warning before the session has the mailer_lang constant + if (empty($ret)) { + $ret = getDefaultLanguage(); + } // END - if + } - // Cache entry - setCurrentLanguage($ret); + // Cache entry + setCurrentLanguage($ret); + } // END - if - // Return value - return $ret; + // Return cached value + return getCurrentLanguage(); } // "Setter" for language @@ -138,25 +153,25 @@ function setLanguage ($lang) { $lang = substr(secureString($lang), 0, 2); // Set cookie - setSession('mx_lang', $lang); + setSession('mailer_lang', $lang); } -// Checks wether a language file is there for optional extension +// Checks whether a language file is there for optional extension function isLanguageIncludeReadable ($ext_name = 'none') { - // Do we have array element? + // Is there array element? if (!isset($GLOBALS['lang_inc'][$ext_name])) { // Generate filename if ($ext_name == 'none') { // Generic - $languageInclude = sprintf("inc/language/%s.php", getLanguage()); + $languageInclude = sprintf('inc/language/%s.php', getLanguage()); } else { // Extension's language file - $languageInclude = sprintf("inc/language/%s_%s.php", $ext_name, getLanguage()); + $languageInclude = sprintf('inc/language/%s_%s.php', $ext_name, getLanguage()); } // Look for file if no extension name is provided $GLOBALS['lang_inc'][$ext_name] = isIncludeReadable($languageInclude); - //* DEBUG: */ debugOutput(__FUNCTION__.':'.$ext_name.'='.$languageInclude.'='.intval(isIncludeReadable($languageInclude))); + //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $ext_name . '=' . $languageInclude . '=' . intval(isIncludeReadable($languageInclude))); } // END - if // Return it @@ -173,13 +188,13 @@ function loadLanguageFile ($ext_name = 'none') { // Set default language if it is not (yet) set if (is_null($currLanguage)) { // Get it from config - $currLanguage = getConfig('DEFAULT_LANG'); + $currLanguage = getDefaultLanguage(); // And save it in session setLanguage($currLanguage); } // END - if - // Do we have the language file NOT? + // Is there the language file NOT? if (!isLanguageIncludeReadable($ext_name)) { // Switch to default (DO NOT CHANGE!!!) setLanguage('de'); @@ -192,9 +207,9 @@ function loadLanguageFile ($ext_name = 'none') { if (isLanguageIncludeReadable($ext_name)) { // Load language file loadLanguageInclude($ext_name); - } elseif ((isDebugModeEnabled()) && (getOutputMode() == '0') && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme')) { + } elseif ((isDebugModeEnabled()) && (isHtmlOutputMode()) && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme')) { // No language file is not so good... - logDebugMessage(__FUNCTION__, __LINE__, sprintf("NOTICE: Extension %s has no language file or we cannot read from it. lang=%s, mode=%s", + logDebugMessage(__FUNCTION__, __LINE__, sprintf('NOTICE: Extension %s has no language file or we cannot read from it. lang=%s, mode=%s', $ext_name, getLanguage(), getExtensionMode() @@ -202,7 +217,7 @@ function loadLanguageFile ($ext_name = 'none') { } // Check for installation mode - if ((isInstallationPhase()) || (!isAdminRegistered())) { + if ((isInstaller()) || (!isAdminRegistered())) { // Load language file loadLanguageInclude('install'); } // END - if @@ -213,10 +228,10 @@ function loadLanguageInclude ($ext_name = 'none') { // Generate filename if ($ext_name == 'none') { // Generic - $languageInclude = sprintf("inc/language/%s.php", getLanguage()); + $languageInclude = sprintf('inc/language/%s.php', getLanguage()); } else { // Extension's language file - $languageInclude = sprintf("inc/language/%s_%s.php", $ext_name, getLanguage()); + $languageInclude = sprintf('inc/language/%s_%s.php', $ext_name, getLanguage()); } // Check it before loading @@ -225,7 +240,7 @@ function loadLanguageInclude ($ext_name = 'none') { loadIncludeOnce($languageInclude); } else { // Not readable! - logDebugMessage(__FUNCTION__, __LINE__, sprintf("Language file %s not found or readable.", $languageInclude)); + logDebugMessage(__FUNCTION__, __LINE__, sprintf('Language file %s not found or readable.', $languageInclude)); } } @@ -249,21 +264,23 @@ function ifLanguageFilesCompares ($source, $target, $targetLanguage) { // Init differences $GLOBALS['lang_diff'][$target] = array(); $GLOBALS['lang_diff_count'][$target] = 0; - if (!isset($GLOBALS['lang_diff_count']['total'])) $GLOBALS['lang_diff_count']['total'] = 0; + if (!isset($GLOBALS['lang_diff_count']['total'])) { + $GLOBALS['lang_diff_count']['total'] = 0; + } // END - if // *Does* match by default - $matches = true; + $matches = TRUE; // Is one not readable? if (!isIncludeReadable($source)) { // Please report this bug! - debug_report_bug(__FUNCTION__ . ': Source file ' . $source . ' is not readable.'); + reportBug(__FUNCTION__, __LINE__, 'Source file ' . $source . ' is not readable.'); } elseif (!isIncludeReadable($target)) { // Please report this bug! - debug_report_bug(__FUNCTION__ . ': Target file ' . $target . ' is not readable.'); + reportBug(__FUNCTION__, __LINE__, 'Target file ' . $target . ' is not readable.'); } elseif ($targetLanguage == getCurrentLanguage()) { // Must be different - debug_report_bug(__FUNCTION__ . ': Target language ' . $targetLanguage . ' is same as current.'); + reportBug(__FUNCTION__, __LINE__, 'Target language ' . $targetLanguage . ' is same as current.'); } // Backup current messages/language @@ -272,7 +289,7 @@ function ifLanguageFilesCompares ($source, $target, $targetLanguage) { $GLOBALS['messages'][$backupLang] = array(); // Both are readable so include current language file - $GLOBALS['count'] = false; + $GLOBALS['count'] = FALSE; loadInclude($source); $GLOBALS['msgs'][$source] = $GLOBALS['messages'][$backupLang]; unset($GLOBALS['count']); @@ -280,7 +297,7 @@ function ifLanguageFilesCompares ($source, $target, $targetLanguage) { // Set target language setCurrentLanguage($targetLanguage); - // Do we have an array? + // Is there an array? if (!isset($GLOBALS['messages'][$targetLanguage])) { // Then create it to avoid notice $GLOBALS['messages'][$targetLanguage] = array(); @@ -299,7 +316,7 @@ function ifLanguageFilesCompares ($source, $target, $targetLanguage) { // Do they mismatch? if ((count($GLOBALS['msgs'][$source])) != (count($GLOBALS['msgs'][$target]))) { // Does not match - $matches = false; + $matches = FALSE; // Check all differences foreach ($GLOBALS['msgs'][$source] as $key => $value) { @@ -324,19 +341,20 @@ function getLanguageComparisonDifference ($target) { return $GLOBALS['lang_diff_count'][$target]; } -// Checks wether the given message is masked -function isMessageMasked ($messageId) { +// Checks whether the given message is masked +function isMessageMasked ($messageId, $strict = TRUE) { // Is the message id valid? - if (!isMessageIdValid($messageId)) { + if (($strict === TRUE) && (!isMessageIdValid($messageId))) { // No, then abort here - debug_report_bug(__FUNCTION__ . ': Invalid message id ' . $messageId . ' detected.'); + reportBug(__FUNCTION__, __LINE__, 'Invalid message id ' . $messageId . ' detected.'); } // END - if // Now simply check it - $masked = (strpos($GLOBALS['messages'][getCurrentLanguage()][$messageId], '%') !== false); + $isMasked = isInString('%', getMessage($messageId)); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'messageId=' . $messageId . ',isMasked=' . intval($isMasked)); // Return result - return $masked; + return $isMasked; } // [EOF]