]> git.mxchange.org Git - mailer.git/blobdiff - inc/functions.php
Fixed typo in function name
[mailer.git] / inc / functions.php
index e779bae69271a9e53f4a732f5eb7e9f254b7adbb..bfead5a33ee9ba7c8b810a35e540848429ad0318 100644 (file)
@@ -101,7 +101,7 @@ function OUTPUT_HTML ($HTML, $newLine = true) {
                        mxchange_die("<strong>{--FATAL_ERROR--}:</strong> {--LANG_NO_RENDER_DIRECT--}");
                        break;
                }
-       } elseif ((constant('_OB_CACHING') == "on") && ($GLOBALS['footer_sent'] == 1)) {
+       } elseif ((constant('_OB_CACHING') == "on") && (isset($GLOBALS['footer_sent'])) && ($GLOBALS['footer_sent'] == 1)) {
                // Headers already sent?
                if (headers_sent()) {
                        // Log this error
@@ -382,7 +382,7 @@ function LOAD_TEMPLATE ($template, $return=false, $content=array()) {
                        // Output direct
                        OUTPUT_HTML($ret);
                }
-       } elseif (isBooleanConstantAndTrue('DEBUG_MODE')) {
+       } elseif (isDebugModeEnabled()) {
                // Warning, empty output!
                return "E:".$template."<br />\n";
        }
@@ -435,7 +435,7 @@ function SEND_EMAIL($TO, $SUBJECT, $MSG, $HTML = "N", $FROM = "") {
                        // Append header
                        $FROM .= LOAD_EMAIL_TEMPLATE("header");
                }
-       } elseif (isBooleanConstantAndTrue('DEBUG_MODE')) {
+       } elseif (isDebugModeEnabled()) {
                if (empty($FROM)) {
                        // Load email header template
                        $FROM = LOAD_EMAIL_TEMPLATE("header");
@@ -455,7 +455,7 @@ function SEND_EMAIL($TO, $SUBJECT, $MSG, $HTML = "N", $FROM = "") {
 
        // Fix HTML parameter (default is no!)
        if (empty($HTML)) $HTML = "N";
-       if (isBooleanConstantAndTrue('DEBUG_MODE')) {
+       if (isDebugModeEnabled()) {
                // In debug mode we want to display the mail instead of sending it away so we can debug this part
                print("<pre>
 ".htmlentities(trim($FROM))."
@@ -476,9 +476,10 @@ Message : ".$MSG."
 }
 
 // Check if legacy or PHPMailer command
+// @TODO Rewrite this to an extension 'smtp'
 // @private
 function CHECK_PHPMAILER_USAGE() {
-       return ((defined('SMTP_HOSTNAME')) && (defined('SMTP_USER')) && (defined('SMTP_PASSWORD')) && (SMTP_HOSTNAME != "") && (SMTP_USER != ""));
+       return ((defined('SMTP_HOSTNAME')) && (defined('SMTP_USER')) && (defined('SMTP_PASSWORD')) && (constant('SMTP_HOSTNAME') != "") && (constant('SMTP_USER') != ""));
 }
 
 /*
@@ -675,8 +676,8 @@ function FRAMETESTER ($URL) {
 function SELECTION_COUNT ($array) {
        $ret = 0;
        if (is_array($array)) {
-               foreach ($array as $key => $sel) {
-                       if (!empty($sel)) $ret++;
+               foreach ($array as $key => $selected) {
+                       if (!empty($selected)) $ret++;
                }
        }
        return $ret;
@@ -881,7 +882,7 @@ function LOAD_EMAIL_TEMPLATE($template, $content=array(), $UID="0") {
 <br /><br />";
 
                // Debug mode not active? Then remove the HTML tags
-               if (!isBooleanConstantAndTrue('DEBUG_MODE')) $newContent = strip_tags($newContent);
+               if (!isDebugModeEnabled()) $newContent = strip_tags($newContent);
        } else {
                // No template name supplied!
                $newContent = getMessage('NO_TEMPLATE_SUPPLIED');
@@ -1241,8 +1242,9 @@ function TRANSLATE_YESNO ($yn) {
 // Deprecated : $length
 // Optional   : $DATA
 //
-function GEN_RANDOM_CODE ($length, $code, $uid, $DATA="") {
+function generateRandomCodde ($length, $code, $uid, $DATA="") {
        // Fix missing _MAX constant
+       // @TODO Rewrite this unnice code
        if (!defined('_MAX')) define('_MAX', 15235);
 
        // Build server string
@@ -1261,9 +1263,9 @@ function GEN_RANDOM_CODE ($length, $code, $uid, $DATA="") {
        // Add more additional data
        if (isSessionVariableSet('u_hash'))                     $data .= ":".get_session('u_hash');
        if (isset($GLOBALS['userid']))                          $data .= ":".$GLOBALS['userid'];
-       if (isSessionVariableSet('mxchange_theme'))     $data .= ":".get_session('mxchange_theme');
-       if (isSessionVariableSet('mx_lang'))            $data .= ":".GET_LANGUAGE();
-       if (isset($GLOBALS['refid']))                           $data .= ":".$GLOBALS['refid'];
+       if (isSessionVariableSet('mxchange_theme'))             $data .= ":".get_session('mxchange_theme');
+       if (isSessionVariableSet('mx_lang'))                    $data .= ":".GET_LANGUAGE();
+       if (isset($GLOBALS['refid']))                                   $data .= ":".$GLOBALS['refid'];
 
        // Calculate number for generating the code
        $a = $code + constant('_ADD') - 1;
@@ -1276,7 +1278,7 @@ function GEN_RANDOM_CODE ($length, $code, $uid, $DATA="") {
                $rcode = hexdec(substr($saltedHash, strlen(getConfig('master_salt')), 9)) / abs(constant('_MAX') - $a + sqrt(constant('_ADD'))) / pi();
        } else {
                // Generate hash with "hash of site key" from modula of number with the prime number and other data
-               $saltedHash = generateHash(($a % constant('_PRIME')).":".$server.":".$keys.":".$data.":".date("d-m-Y (l-F-T)", time()).":".$a, substr(sha1(SITE_KEY), 0, 8));
+               $saltedHash = generateHash(($a % constant('_PRIME')).":".$server.":".$keys.":".$data.":".date("d-m-Y (l-F-T)", time()).":".$a, substr(sha1(constant('SITE_KEY')), 0, 8));
 
                // Create number from hash
                $rcode = hexdec(substr($saltedHash, 8, 9)) / abs(constant('_MAX') - $a + sqrt(constant('_ADD'))) / pi();
@@ -1978,7 +1980,7 @@ function VALIDATE_URL ($URL, $compile=true) {
        return isUrlValid($URL);
 }
 
-//
+// Generate a list of administrative links to a given userid
 function MEMBER_ACTION_LINKS ($uid, $status = "") {
        // Define all main targets
        $TARGETS = array("del_user", "edit_user", "lock_user", "add_points", "sub_points");
@@ -2015,13 +2017,6 @@ function MEMBER_ACTION_LINKS ($uid, $status = "") {
        return $OUT;
 }
 
-// Function for backward-compatiblity
-// @TODO Can this function be deprecated?
-function ADD_CATEGORY_TABLE ($MODE, $return=false) {
-       // Load it from the register extension
-       return REGISTER_ADD_CATEGORY_TABLE ($MODE, $return);
-}
-
 // Generate an email link
 function CREATE_EMAIL_LINK ($email, $table = "admins") {
        // Default email link (INSECURE! Spammer can read this by harvester programs)
@@ -2045,6 +2040,7 @@ function CREATE_EMAIL_LINK ($email, $table = "admins") {
        // Return email link
        return $EMAIL;
 }
+
 // Generate a hash for extra-security for all passwords
 function generateHash ($plainText, $salt = "") {
        global $_SERVER;
@@ -2095,7 +2091,8 @@ function generateHash ($plainText, $salt = "") {
        // Return hash
        return $salt.sha1($salt.$plainText);
 }
-//
+
+// Scramble a string
 function scrambleString($str) {
        // Init
        $scrambled = "";
@@ -2126,7 +2123,8 @@ function scrambleString($str) {
        //* DEBUG: */ echo "***Scrambled=".$scrambled."***<br />";
        return $scrambled;
 }
-//
+
+// De-scramble a string scrambled by scrambleString()
 function descrambleString($str) {
        // Scramble only 40 chars long strings
        if (strlen($str) != 40) return $str;
@@ -2149,7 +2147,8 @@ function descrambleString($str) {
        //* DEBUG: */ echo "+++Original=".$orig."+++<br />";
        return $orig;
 }
-//
+
+// Generated a "string" for scrambling
 function genScrambleString ($len) {
        // Prepare array for the numbers
        $scrambleNumbers = array();
@@ -2575,19 +2574,8 @@ function getActualVersion ($type = 0) {
 
 // Loads an include file and logs any missing files for debug purposes
 function LOAD_INC ($INC) {
-       // Get constant path
-       $PATH = constant('PATH');
-
-       // Use the include file name directly
-       // @TODO Try to find all locations where an FQFN is given to these two
-       // @TODO functions and avoid it.
-       $FQFN = $INC;
-
-       // Check if PATH is in $INC
-       if (substr($INC, 0, $PATH) != $PATH) {
-               // Add it. This is why we need a trailing slash in config.php
-               $FQFN = $PATH . $INC;
-       } // END - if
+       // Add the path. This is why we need a trailing slash in config.php
+       $FQFN = constant('PATH') . $INC;
 
        // Is the include file there?
        if (!FILE_READABLE($FQFN)) {
@@ -2973,7 +2961,7 @@ function merge_array ($array1, $array2) {
 // Debug message logger
 function DEBUG_LOG ($funcFile, $line, $message, $force=true) {
        // Is debug mode enabled?
-       if ((isBooleanConstantAndTrue('DEBUG_MODE')) || ($force === true)) {
+       if ((isDebugModeEnabled()) || ($force === true)) {
                // Log this message away
                $fp = fopen(constant('PATH')."inc/cache/debug.log", 'a') or mxchange_die("Cannot write logfile debug.log!");
                fwrite($fp, date("d.m.Y|H:i:s", time())."|".basename($funcFile)."|".$line."|".strip_tags($message)."\n");
@@ -3025,11 +3013,11 @@ function GET_DIR_AS_ARRAY ($baseDir, $prefix) {
 }
 
 // Load more reset scripts
-function RESET_ADD_INCLUDES () {
+function runResetIncludes () {
        // Is the reset set or old sql_patches?
-       if ((!defined('__DAILY_RESET')) || (EXT_VERSION_IS_OLDER("sql_patches", "0.4.5"))) {
+       if ((!isResetModeEnabled()) || (EXT_VERSION_IS_OLDER("sql_patches", "0.4.5"))) {
                // Then abort here
-               return array();
+               DEBUG_LOG(__FUNCTION__, __LINE__, "Cannot run reset! Please report this bug. Thanks");
        } // END - if
 
        // Get more daily reset scripts
@@ -3062,8 +3050,8 @@ function RESET_ADD_INCLUDES () {
                if (!defined('DEBUG_MONTHLY')) UPDATE_CONFIG("last_month", $currMonth);
        } // END - if
 
-       // Return array
-       return $INC_POOL;
+       // Run the filter
+       runFilterChain('load_includes', $INC_POOL);
 }
 
 // Handle extra values
@@ -3132,7 +3120,8 @@ function CONVERT_SELECTIONS_TO_TIMESTAMP(&$POST, &$DATA, &$id, &$skip) {
                } // END - if
        } else {
                // Process this entry
-               $skip = false; $test2 = "";
+               $skip = false;
+               $test2 = "";
        }
 }
 
@@ -3191,7 +3180,7 @@ function HANDLE_LOGIN_FAILTURES ($accessLevel) {
 }
 
 // Rebuild cache
-function REBUILD_CACHE ($cache, $inc="") {
+function rebuildCacheFiles ($cache, $inc="") {
        // Shall I remove the cache file?
        if ((EXT_IS_ACTIVE("cache")) && (is_object($GLOBALS['cache_instance']))) {
                // Rebuild cache
@@ -3406,6 +3395,28 @@ function isAdminRegistered () {
        return isBooleanConstantAndTrue('admin_registered');
 }
 
+// Enables the reset mode. Only call this function if you really want the
+// reset to be run!
+function enableResetMode () {
+       // Enable the reset mode
+       $GLOBALS['reset_enabled'] = true;
+
+       // Run filters
+       runFilterChain('reset_enabled');
+}
+
+// Checks wether the reset mode is active
+function isResetModeEnabled () {
+       // Now simply check it
+       return ((isset($GLOBALS['reset_enabled'])) && ($GLOBALS['reset_enabled'] === true));
+}
+
+// Checks wether the debug mode is enabled
+function isDebugModeEnabled () {
+       // Simply check it
+       return isBooleanConstantAndTrue('DEBUG_MODE');
+}
+
 //////////////////////////////////////////////////
 // AUTOMATICALLY RE-GENERATED MISSING FUNCTIONS //
 //////////////////////////////////////////////////