Our convention says if(-else) blocks should not be put in one line

[mailer.git] / inc / functions.php

diff --git a/inc/functions.php b/inc/functions.php
index 69bdcc37d4ae3dbe48186def8aa002f2c620b2de..740dccbd1b16e3fce38a15ff94224465a0662e8f 100644 (file)
--- a/inc/functions.php
+++ b/inc/functions.php
@@ -89,7 +89,7 @@ function addFatalMessage ($F, $L, $message, $extra = '') {
 
 // Getter for total fatal message count
 function getTotalFatalErrors () {
-       // Init coun
+       // Init count
        $count = '0';
 
        // Do we have at least the first entry?
@@ -376,25 +376,26 @@ function translateComma ($dotted, $cut = true, $max = '0') {
                if (count($com) < 2) {
                        // Don't display commatas even if there are none... ;-)
                        $maxComma = '0';
-               }
+               } // END - if
        } // END - if
 
        // Debug log
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "dotted={$dotted},maxComma={$maxComma}");
 
        // Translate it now
+       $translated = $dotted;
        switch (getLanguage()) {
                case 'de': // German language
-                       $dotted = number_format($dotted, $maxComma, ',', '.');
+                       $translated = number_format($dotted, $maxComma, ',', '.');
                        break;
 
                default: // All others
-                       $dotted = number_format($dotted, $maxComma, '.', ',');
+                       $translated = number_format($dotted, $maxComma, '.', ',');
                        break;
        } // END - switch
 
        // Return translated value
-       return $dotted;
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dotted=' . $dotted . ',translated=' . $translated . ',maxComma=' . $maxComma);
+       return $translated;
 }
 
 // Translate Uni*-like gender to human-readable
@@ -404,9 +405,12 @@ function translateGender ($gender) {
 
        // Male/female or company?
        switch ($gender) {
-               case 'M': $ret = '{--GENDER_M--}'; break;
-               case 'F': $ret = '{--GENDER_F--}'; break;
-               case 'C': $ret = '{--GENDER_C--}'; break;
+               case 'M': // Male
+               case 'F': // Female
+               case 'C': // Company
+                       $ret = sprintf("{--GENDER_%s--}", $gender);
+                       break;
+
                default:
                        // Please report bugs on unknown genders
                        debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown gender %s detected.", $gender));
@@ -424,17 +428,17 @@ function translateUserStatus ($status) {
                case 'UNCONFIRMED':
                case 'CONFIRMED':
                case 'LOCKED':
-                       $ret = sprintf("{--ACCOUNT_%s--}", $status);
+                       $ret = sprintf("{--ACCOUNT_STATUS_%s--}", $status);
                        break;
 
                case '':
                case null:
-                       $ret = '{--ACCOUNT_DELETED--}';
+                       $ret = '{--ACCOUNT_STATUS_DELETED--}';
                        break;
 
                default:
                        // Please report all unknown status
-                       debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
+                       debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown status %s(%s) detected.", $status, gettype($status)));
                        break;
        } // END - switch
 
@@ -1194,7 +1198,7 @@ function generateHash ($plainText, $salt = '', $hash = true) {
 }
 
 // Scramble a string
-function scrambleString($str) {
+function scrambleString ($str) {
        // Init
        $scrambled = '';
 
@@ -1229,7 +1233,7 @@ function scrambleString($str) {
 }
 
 // De-scramble a string scrambled by scrambleString()
-function descrambleString($str) {
+function descrambleString ($str) {
        // Scramble only 40 chars long strings
        if (strlen($str) != 40) return $str;
 
@@ -1357,7 +1361,7 @@ function getCurrentTheme () {
 }
 
 // Generates an error code from given account status
-function generateErrorCodeFromUserStatus ($status='') {
+function generateErrorCodeFromUserStatus ($status = '') {
        // If no status is provided, use the default, cached
        if ((empty($status)) && (isMember())) {
                // Get user status
@@ -1365,10 +1369,10 @@ function generateErrorCodeFromUserStatus ($status='') {
        } // END - if
 
        // Default error code if unknown account status
-       $errorCode = getCode('UNKNOWN_STATUS');
+       $errorCode = getCode('ACCOUNT_STATUS_UNKNOWN');
 
        // Generate constant name
-       $codeName = sprintf("ACCOUNT_%s", strtoupper($status));
+       $codeName = sprintf("ACCOUNT_STATUS_%s", strtoupper($status));
 
        // Is the constant there?
        if (isCodeSet($codeName)) {
@@ -1445,7 +1449,7 @@ function getMessageFromErrorCode ($code) {
                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('LOGIN_FAILED')       : $message = '{--GUEST_LOGIN_FAILED_GENERAL--}'; break;
                case getCode('MODULE_MEMBER_ONLY') : $message = getMaskedMessage('MODULE_MEMBER_ONLY', getRequestParameter('mod')); break;
                case getCode('OVERLENGTH')         : $message = '{--MEMBER_TEXT_OVERLENGTH--}'; break;
                case getCode('URL_FOUND')          : $message = '{--MEMBER_TEXT_CONTAINS_URL--}'; break;
@@ -1503,9 +1507,9 @@ function getMessageFromErrorCode ($code) {
 
                        // Finally contruct the message
                        // @TODO Rewrite this old lost code to a template
-                       $message = "{--MEMBER_URL_TIME_LOCK--}<br />{--CONFIG_URL_TLOCK--} ".$STD."
-                       {--_HOURS--}, ".$MIN." {--_MINUTES--} {--_AND--} ".$SEC." {--_SECONDS--}<br />
-                       {--MEMBER_LAST_TLOCK--}: ".$timestamp;
+                       $message = '{--MEMBER_URL_TIME_LOCK--}<br />{--CONFIG_URL_TLOCK--} ' . $STD . '
+                       {--_HOURS--}, ' . $MIN . ' {--_MINUTES--} {--_AND--} ' . $SEC . ' {--_SECONDS--}<br />
+                       {--MEMBER_LAST_TLOCK--}: ' . $timestamp;
                        break;
 
                default:
@@ -1571,9 +1575,9 @@ function isUrlValidSimple ($url) {
                // Debug regex?
                if (isDebugRegularExpressionEnabled()) {
                        // @TODO Are these convertions still required?
-                       $pat = str_replace('.', "&#92;&#46;", $pat);
-                       $pat = str_replace('@', "&#92;&#64;", $pat);
-                       //* DEBUG: */ debugOutput($key."=&nbsp;" . $pat);
+                       $pat = str_replace('.', '&#92;&#46;', $pat);
+                       $pat = str_replace('@', '&#92;&#64;', $pat);
+                       //* DEBUG: */ debugOutput($key . '=&nbsp;' . $pat);
                } // END - if
 
                // Check if expression matches
@@ -1619,7 +1623,10 @@ function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
                                        // Read from source file
                                        $line = fgets ($fp, 1024);
 
-                                       if (strpos($line, $search) > -1) { $next = '0'; $found = true; }
+                                       if (strpos($line, $search) > -1) { 
+                                               $next = '0';
+                                               $found = true;
+                                       } // END - if
 
                                        if ($next > -1) {
                                                if ($next === $seek) {
@@ -1788,7 +1795,7 @@ function handleLoginFailures ($accessLevel) {
                // Ignore zero values
                if (getSession('mailer_' . $accessLevel . '_failures') > 0) {
                        // Non-guest has login failures found, get both data and prepare it for template
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "accessLevel={$accessLevel}<br />");
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'accessLevel=' . $accessLevel . '<br />');
                        $content = array(
                                'login_failures' => 'mailer_' . $accessLevel . '_failures',
                                'last_failure'   => generateDateTime(getSession('mailer_' . $accessLevel . '_last_failure'), 2)
@@ -2054,7 +2061,7 @@ function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = false, $ad
        $excludeArray[] = '.svn';
        $excludeArray[] = '.htaccess';
 
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix} - Entered!");
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',prefix=' . $prefix . ' - Entered!');
        // Init includes
        $files = array();
 
@@ -2097,20 +2104,20 @@ function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = false, $ad
                        continue;
                } elseif (substr($baseFile, 0, strlen($prefix)) != $prefix) {
                        // Skip this file
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Invalid prefix in file " . $baseFile . ", prefix=" . $prefix);
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Invalid prefix in file ' . $baseFile . ', prefix=' . $prefix);
                        continue;
                } elseif ((!empty($suffix)) && (substr($baseFile, -(strlen($suffix . $extension)), (strlen($suffix . $extension))) != $suffix . $extension)) {
                        // Skip wrong suffix as well
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Invalid suffix in file " . $baseFile . ", suffix=" . $suffix);
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Invalid suffix in file ' . $baseFile . ', suffix=' . $suffix);
                        continue;
                } elseif (!isFileReadable($FQFN)) {
                        // Not readable so skip it
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "File " . $FQFN . " is not readable!");
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File ' . $FQFN . ' is not readable!');
                        continue;
                }
 
                // Is the file a PHP script or other?
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}");
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',prefix=' . $prefix . ',baseFile=' . $baseFile);
                if ((substr($baseFile, -4, 4) == '.php') || (($fileIncludeDirs === true) && (isDirectory($FQFN)))) {
                        // Is this a valid include file?
                        if ($extension == '.php') {