]> git.mxchange.org Git - mailer.git/blobdiff - inc/functions.php
Next wave of lesser getMessage()
[mailer.git] / inc / functions.php
index f303ce5c685ca3ce250ce42d5c270a661dd21dab..107542e91f55811176def121dbff5a08e4c21e8f 100644 (file)
@@ -178,7 +178,7 @@ function doFinalCompilation ($code, $insertComments = true) {
        $cnt = 0;
 
        // Compile all out
-       while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($cnt < 3)) {
+       while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($cnt < 4)) {
                // Init common variables
                $content = array();
                $newContent = '';
@@ -270,7 +270,7 @@ function loadTemplate ($template, $return = false, $content = array()) {
        global $DATA;
 
        // Do we have cache?
-       if (isTemplateCached($template)) {
+       if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template))) {
                // Evaluate the cache
                eval(readTemplateCache($template));
        } elseif (!isset($GLOBALS['template_eval'][$template])) {
@@ -432,24 +432,18 @@ function loadEmailTemplate ($template, $content = array(), $userid = '0') {
        // Make sure all template names are lowercase!
        $template = strtolower($template);
 
-       // Default 'nickname' if extension is not installed
-       $nick = '---';
-
-       // Neutral email address is default
-       $email = getConfig('WEBMASTER');
-
        // Is content an array?
        if (is_array($content)) {
                // Add expiration to array
                if ((isConfigEntrySet('auto_purge')) && (getConfig('auto_purge') == '0')) {
                        // Will never expire!
-                       $content['expiration'] = getMessage('MAIL_WILL_NEVER_EXPIRE');
+                       $content['expiration'] = '{--MAIL_WILL_NEVER_EXPIRE--}';
                } elseif (isConfigEntrySet('auto_purge')) {
                        // Create nice date string
                        $content['expiration'] = createFancyTime(getConfig('auto_purge'));
                } else {
                        // Missing entry
-                       $content['expiration'] = getMessage('MAIL_NO_CONFIG_AUTO_PURGE');
+                       $content['expiration'] = '{--MAIL_NO_CONFIG_AUTO_PURGE--}';
                }
        } // END - if
 
@@ -522,7 +516,7 @@ function loadEmailTemplate ($template, $content = array(), $userid = '0') {
                if (!isDebugModeEnabled()) $newContent = secureString($newContent);
        } else {
                // No template name supplied!
-               $newContent = getMessage('NO_TEMPLATE_SUPPLIED');
+               $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
        }
 
        // Is there some content?
@@ -758,8 +752,8 @@ function translateYesNo ($yn) {
        // Default
        $translated = '??? (' . $yn . ')';
        switch ($yn) {
-               case 'Y': $translated = getMessage('YES'); break;
-               case 'N': $translated = getMessage('NO'); break;
+               case 'Y': $translated = '{--YES--}'; break;
+               case 'N': $translated = '{--NO--}'; break;
                default:
                        // Log unknown value
                        logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown value %s. Expected Y/N!", $yn));
@@ -837,9 +831,9 @@ function translateGender ($gender) {
 
        // Male/female or company?
        switch ($gender) {
-               case 'M': $ret = getMessage('GENDER_M'); break;
-               case 'F': $ret = getMessage('GENDER_F'); break;
-               case 'C': $ret = getMessage('GENDER_C'); break;
+               case 'M': $ret = '{--GENDER_M--}'; break;
+               case 'F': $ret = '{--GENDER_F--}'; break;
+               case 'C': $ret = '{--GENDER_C--}'; break;
                default:
                        // Please report bugs on unknown genders
                        debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown gender %s detected.", $gender));
@@ -862,7 +856,7 @@ function translateUserStatus ($status) {
 
                case '':
                case null:
-                       $ret = getMessage('ACCOUNT_DELETED');
+                       $ret = '{--ACCOUNT_DELETED--}';
                        break;
 
                default:
@@ -2058,13 +2052,16 @@ function isUrlValid ($URL, $compile=true) {
 }
 
 // Generate a list of administrative links to a given userid
-function generateMemberAdminActionLinks ($userid, $status = '') {
+function generateMemberAdminActionLinks ($userid) {
        // Make sure userid is a number
        if ($userid != bigintval($userid)) debug_report_bug(__FUNCTION__, __LINE__, 'userid is not a number!');
 
        // Define all main targets
        $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
 
+       // Get user status
+       $status = getFetchedUserData('userid', $userid, 'status');
+
        // Begin of navigation links
        $OUT = '[';
 
@@ -2087,10 +2084,10 @@ function generateMemberAdminActionLinks ($userid, $status = '') {
                        $OUT .= strtoupper($tar);
                }
                $OUT .= '--}</a></span>|';
-       }
+       } // END - foreach
 
        // Finish navigation link
-       $OUT = substr($OUT, 0, -7) . ']';
+       $OUT = substr($OUT, 0, -1) . ']';
 
        // Return string
        return $OUT;
@@ -2565,39 +2562,39 @@ function getMessageFromErrorCode ($code) {
        $message = '';
        switch ($code) {
                case '': break;
-               case getCode('LOGOUT_DONE')        : $message = getMessage('LOGOUT_DONE'); break;
+               case getCode('LOGOUT_DONE')        : $message = '{--LOGOUT_DONE--}'; break;
                case getCode('LOGOUT_FAILED')      : $message = '<span class="guest_failed">{--LOGOUT_FAILED--}</span>'; break;
-               case getCode('DATA_INVALID')       : $message = getMessage('MAIL_DATA_INVALID'); break;
-               case getCode('POSSIBLE_INVALID')   : $message = getMessage('MAIL_POSSIBLE_INVALID'); break;
-               case getCode('USER_404')           : $message = getMessage('USER_404'); break;
-               case getCode('STATS_404')          : $message = getMessage('MAIL_STATS_404'); break;
-               case getCode('ALREADY_CONFIRMED')  : $message = getMessage('MAIL_ALREADY_CONFIRMED'); break;
-               case getCode('WRONG_PASS')         : $message = getMessage('LOGIN_WRONG_PASS'); break;
-               case getCode('WRONG_ID')           : $message = getMessage('LOGIN_WRONG_ID'); break;
-               case getCode('ACCOUNT_LOCKED')     : $message = getMessage('LOGIN_STATUS_LOCKED'); break;
-               case getCode('ACCOUNT_UNCONFIRMED'): $message = getMessage('LOGIN_STATUS_UNCONFIRMED'); break;
-               case getCode('COOKIES_DISABLED')   : $message = getMessage('LOGIN_COOKIES_DISABLED'); break;
-               case getCode('BEG_SAME_AS_OWN')    : $message = getMessage('BEG_SAME_UID_AS_OWN'); break;
-               case getCode('LOGIN_FAILED')       : $message = getMessage('LOGIN_FAILED_GENERAL'); break;
+               case getCode('DATA_INVALID')       : $message = '{--MAIL_DATA_INVALID--}'; break;
+               case getCode('POSSIBLE_INVALID')   : $message = '{--MAIL_POSSIBLE_INVALID--}'; break;
+               case getCode('USER_404')           : $message = '{--USER_404--}'; break;
+               case getCode('STATS_404')          : $message = '{--MAIL_STATS_404--}'; break;
+               case getCode('ALREADY_CONFIRMED')  : $message = '{--MAIL_ALREADY_CONFIRMED--}'; break;
+               case getCode('WRONG_PASS')         : $message = '{--LOGIN_WRONG_PASS--}'; break;
+               case getCode('WRONG_ID')           : $message = '{--LOGIN_WRONG_ID--}'; break;
+               case getCode('ACCOUNT_LOCKED')     : $message = '{--LOGIN_STATUS_LOCKED--}'; break;
+               case getCode('ACCOUNT_UNCONFIRMED'): $message = '{--LOGIN_STATUS_UNCONFIRMED--}'; break;
+               case getCode('COOKIES_DISABLED')   : $message = '{--LOGIN_COOKIES_DISABLED--}'; break;
+               case getCode('BEG_SAME_AS_OWN')    : $message = '{--BEG_SAME_UID_AS_OWN--}'; break;
+               case getCode('LOGIN_FAILED')       : $message = '{--LOGIN_FAILED_GENERAL--}'; break;
                case getCode('MODULE_MEMBER_ONLY') : $message = getMaskedMessage('MODULE_MEMBER_ONLY', getRequestParameter('mod')); break;
-               case getCode('OVERLENGTH')         : $message = getMessage('MEMBER_TEXT_OVERLENGTH'); break;
-               case getCode('URL_FOUND')          : $message = getMessage('MEMBER_TEXT_CONTAINS_URL'); break;
-               case getCode('SUBJ_URL')           : $message = getMessage('MEMBER_SUBJ_CONTAINS_URL'); break;
+               case getCode('OVERLENGTH')         : $message = '{--MEMBER_TEXT_OVERLENGTH--}'; break;
+               case getCode('URL_FOUND')          : $message = '{--MEMBER_TEXT_CONTAINS_URL--}'; break;
+               case getCode('SUBJ_URL')           : $message = '{--MEMBER_SUBJ_CONTAINS_URL--}'; break;
                case getCode('BLIST_URL')          : $message = '{--MEMBER_URL_BLACK_LISTED--}<br />{--MEMBER_BLIST_TIME--}: ' . generateDateTime(getRequestParameter('blist'), 0); break;
-               case getCode('NO_RECS_LEFT')       : $message = getMessage('MEMBER_SELECTED_MORE_RECS'); break;
-               case getCode('INVALID_TAGS')       : $message = getMessage('MEMBER_HTML_INVALID_TAGS'); break;
-               case getCode('MORE_POINTS')        : $message = getMessage('MEMBER_MORE_POINTS_NEEDED'); break;
-               case getCode('MORE_RECEIVERS1')    : $message = getMessage('MEMBER_ENTER_MORE_RECEIVERS'); break;
-               case getCode('MORE_RECEIVERS2')    : $message = getMessage('MEMBER_NO_MORE_RECEIVERS_FOUND'); break;
-               case getCode('MORE_RECEIVERS3')    : $message = getMessage('MEMBER_ENTER_MORE_MIN_RECEIVERS'); break;
-               case getCode('INVALID_URL')        : $message = getMessage('MEMBER_ENTER_INVALID_URL'); break;
-               case getCode('NO_MAIL_TYPE')       : $message = getMessage('MEMBER_NO_MAIL_TYPE_SELECTED'); break;
-               case getCode('UNKNOWN_ERROR')      : $message = getMessage('LOGIN_UNKNOWN_ERROR'); break;
-               case getCode('UNKNOWN_STATUS')     : $message = getMessage('LOGIN_UNKNOWN_STATUS'); break;
+               case getCode('NO_RECS_LEFT')       : $message = '{--MEMBER_SELECTED_MORE_RECS--}'; break;
+               case getCode('INVALID_TAGS')       : $message = '{--MEMBER_HTML_INVALID_TAGS--}'; break;
+               case getCode('MORE_POINTS')        : $message = '{--MEMBER_MORE_POINTS_NEEDED--}'; break;
+               case getCode('MORE_RECEIVERS1')    : $message = '{--MEMBER_ENTER_MORE_RECEIVERS--}'; break;
+               case getCode('MORE_RECEIVERS2')    : $message = '{--MEMBER_NO_MORE_RECEIVERS_FOUND--}'; break;
+               case getCode('MORE_RECEIVERS3')    : $message = '{--MEMBER_ENTER_MORE_MIN_RECEIVERS--}'; break;
+               case getCode('INVALID_URL')        : $message = '{--MEMBER_ENTER_INVALID_URL--}'; break;
+               case getCode('NO_MAIL_TYPE')       : $message = '{--MEMBER_NO_MAIL_TYPE_SELECTED--}'; break;
+               case getCode('UNKNOWN_ERROR')      : $message = '{--LOGIN_UNKNOWN_ERROR--}'; break;
+               case getCode('UNKNOWN_STATUS')     : $message = '{--LOGIN_UNKNOWN_STATUS--}'; break;
 
                case getCode('ERROR_MAILID'):
                        if (isExtensionActive('mailid', true)) {
-                               $message = getMessage('ERROR_CONFIRMING_MAIL');
+                               $message = '{--ERROR_CONFIRMING_MAIL--}';
                        } else {
                                $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', 'mailid');
                        }
@@ -2607,7 +2604,7 @@ function getMessageFromErrorCode ($code) {
                        if (isGetRequestParameterSet('ext')) {
                                $message = generateExtensionInactiveNotInstalledMessage(getRequestParameter('ext'));
                        } else {
-                               $message = getMessage('EXTENSION_PROBLEM_UNSET_EXT');
+                               $message = '{--EXTENSION_PROBLEM_UNSET_EXT--}';
                        }
                        break;
 
@@ -2757,12 +2754,12 @@ function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
                $tmp = $FQFN . '.tmp';
 
                // Open the source file
-               $fp = fopen($FQFN, 'r') or debug_report_bug('Cannot read. file=' . basename($FQFN));
+               $fp = fopen($FQFN, 'r') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot read. file=' . basename($FQFN));
 
                // Is the resource valid?
                if (is_resource($fp)) {
                        // Open temporary file
-                       $fp_tmp = fopen($tmp, 'w') or debug_report_bug('Cannot write. tmp=' . basename($tmp) . ',file=' . $FQFN);
+                       $fp_tmp = fopen($tmp, 'w') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write. tmp=' . basename($tmp) . ',file=' . $FQFN);
 
                        // Is the resource again valid?
                        if (is_resource($fp_tmp)) {
@@ -2811,7 +2808,7 @@ function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
                }
        } else {
                // File not found, not readable or writeable
-               debug_report_bug('File not readable/writeable. file=' . basename($FQFN));
+               debug_report_bug(__FUNCTION__, __LINE__, 'File not readable/writeable. file=' . basename($FQFN));
        }
 
        // An error was detected!
@@ -3030,25 +3027,27 @@ function addNewBonusMail ($data, $mode = '', $output=true) {
        if (!empty($receiver)) {
                // Add bonus mail to queue
                addBonusMailToQueue(
-               $data['subject'],
-               $data['text'],
-               $receiver,
-               $data['points'],
-               $data['seconds'],
-               $data['url'],
-               $data['cat'],
-               $mode,
-               $data['receiver']
+                       $data['subject'],
+                       $data['text'],
+                       $receiver,
+                       $data['points'],
+                       $data['seconds'],
+                       $data['url'],
+                       $data['cat'],
+                       $mode,
+                       $data['receiver']
                );
 
                // Mail inserted into bonus pool
-               if ($output) loadTemplate('admin_settings_saved', false, getMessage('ADMIN_BONUS_SEND'));
-       } elseif ($output) {
+               if ($output === true) {
+                       loadTemplate('admin_settings_saved', false, '{--ADMIN_BONUS_SEND--}');
+               } // END - if
+       } elseif ($output === true) {
                // More entered than can be reached!
-               loadTemplate('admin_settings_saved', false, getMessage('ADMIN_MORE_SELECTED'));
+               loadTemplate('admin_settings_saved', false, '{--ADMIN_MORE_SELECTED--}');
        } else {
                // Debug log
-               logDebugMessage(__FUNCTION__, __LINE__, "cat={$data['cat']},receiver={$data['receiver']},data=".base64_encode(serialize($data))." More selected, than available!");
+               logDebugMessage(__FUNCTION__, __LINE__, 'cat=' . $data['cat'] . ',receiver=' . $data['receiver'] . ',data=' . base64_encode(serialize($data)) . ' More selected, than available!');
        }
 }
 
@@ -3134,7 +3133,7 @@ function shutdown () {
                SQL_CLOSE(__FUNCTION__, __LINE__);
        } elseif (!isInstallationPhase()) {
                // No database link
-               addFatalMessage(__FUNCTION__, __LINE__, getMessage('NO_DB_LINK_SHUTDOWN'));
+               addFatalMessage(__FUNCTION__, __LINE__, '{--NO_DB_LINK_SHUTDOWN--}');
        }
 
        // Stop executing here
@@ -3536,16 +3535,16 @@ function determinePageTitle () {
                $pageTitle = '[-- ' . getConfig('MAIN_TITLE') . ' - ' . getModuleTitle(getModule()) . ' --]';
        } elseif ((isInstalled()) && (!isAdminRegistered())) {
                // Installed but no admin registered
-               $pageTitle = getMessage('SETUP_OF_MAILER');
+               $pageTitle = '{--SETUP_OF_MAILER--}';
        } elseif ((!isInstalled()) || (!isAdminRegistered())) {
                // Installation mode
-               $pageTitle = getMessage('INSTALLATION_OF_MAILER');
+               $pageTitle = '{--INSTALLATION_OF_MAILER--}';
        } else {
                // Configuration not found!
-               $pageTitle = getMessage('NO_CONFIG_FOUND_TITLE');
+               $pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
 
                // Do not add the fatal message in installation mode
-               if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, getMessage('NO_CONFIG_FOUND'));
+               if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, '{--NO_CONFIG_FOUND--}');
        }
 
        // Return title
@@ -3582,7 +3581,13 @@ function flushTemplateCache ($template, $eval) {
 // Reads a template cache
 function readTemplateCache ($template) {
        // Check it again
-       if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template))) {
+       if ((isDebuggingTemplateCache()) || (!isTemplateCached($template))) {
+               // This should not happen
+               debug_report_bug('Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
+       } // END - if
+
+       // Is it cached?
+       if (!isset($GLOBALS['template_eval'][$template])) {
                // Generate FQFN
                $FQFN = generateCacheFqfn($template);
 
@@ -3645,16 +3650,16 @@ function sendModeMails ($mod, $modes) {
                                                switch ($mode) {
                                                        case 'normal': break; // Do not add any special lines
                                                        case 'email': // Email was changed!
-                                                               $content['message'] = getMessage('MEMBER_CHANGED_EMAIL').": ".postRequestParameter('old_email')."\n";
+                                                               $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestParameter('old_email') . "\n";
                                                                break;
 
                                                        case 'pass': // Password was changed
-                                                               $content['message'] = getMessage('MEMBER_CHANGED_PASS')."\n";
+                                                               $content['message'] = '{--MEMBER_CHANGED_PASS--}' . "\n";
                                                                break;
 
                                                        default:
                                                                logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
-                                                               $content['message'] = getMessage('MEMBER_UNKNOWN_MODE') . ': ' . $mode . "\n\n";
+                                                               $content['message'] = '{--MEMBER_UNKNOWN_MODE--}' . ': ' . $mode . "\n\n";
                                                                break;
                                                } // END - switch
                                        } // END - foreach
@@ -3673,7 +3678,7 @@ function sendModeMails ($mod, $modes) {
                                        if (getConfig('admin_notify') == 'Y') {
                                                // The admin needs to be notified about a profile change
                                                $message_admin = 'admin_mydata_notify';
-                                               $sub_adm   = getMessage('ADMIN_CHANGED_DATA');
+                                               $sub_adm   = '{--ADMIN_CHANGED_DATA--}';
                                        } else {
                                                // No mail to admin
                                                $message_admin = '';
@@ -3681,7 +3686,7 @@ function sendModeMails ($mod, $modes) {
                                        }
 
                                        // Set subject lines
-                                       $sub_mem = getMessage('MEMBER_CHANGED_DATA');
+                                       $sub_mem = '{--MEMBER_CHANGED_DATA--}';
 
                                        // Output success message
                                        $content = '<span class="member_done">{--MYDATA_MAIL_SENT--}</span>';
@@ -3714,7 +3719,7 @@ function sendModeMails ($mod, $modes) {
                        sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
                } elseif (getConfig('admin_notify') == 'Y') {
                        // Cannot send mails to admin!
-                       $content = getMessage('CANNOT_SEND_ADMIN_MAILS');
+                       $content = '{--CANNOT_SEND_ADMIN_MAILS--}';
                } else {
                        // No mail to admin
                        $content = '<span class="member_done">{--MYDATA_MAIL_SENT--}</span>';
@@ -3876,11 +3881,16 @@ function generateMetaDescriptionCode () {
 }
 
 // Generates an FQFN for template cache from the given template name
-function generateCacheFqfn ($template) {
+function generateCacheFqfn ($template, $mode = 'html') {
        // Is this cached?
        if (!isset($GLOBALS['template_cache_fqfn'][$template])) {
                // Generate the FQFN
-               $GLOBALS['template_cache_fqfn'][$template] = sprintf("%s_compiled/html/%s.tpl.cache", getConfig('CACHE_PATH'), $template);
+               $GLOBALS['template_cache_fqfn'][$template] = sprintf(
+                       "%s_compiled/%s/%s.tpl.cache",
+                       getConfig('CACHE_PATH'),
+                       $mode,
+                       $template
+               );
        } // END - if
 
        // Return it