]> git.mxchange.org Git - mailer.git/blobdiff - inc/functions.php
Rewritten 'page=finalize' in installer, integrated stelzi's rev. 904 (more comments)
[mailer.git] / inc / functions.php
index dd46f2f13475a0bba3e63babaf6495b636c5216a..a3fb34dbd052fe4cebac2cd731de20cf6bdc6af2 100644 (file)
@@ -191,6 +191,7 @@ function getFatalArray () {
 
 // Add a fatal error message to the queue array
 function addFatalMessage ($F, $L, $message, $extra="") {
+       debug_report_bug($message);
        if (is_array($extra)) {
                // Multiple extras for a message with masks
                $message = call_user_func_array('sprintf', $extra);
@@ -385,68 +386,68 @@ function LOAD_TEMPLATE ($template, $return=false, $content=array()) {
 }
 
 // Send mail out to an email address
-function SEND_EMAIL($TO, $SUBJECT, $MSG, $HTML = "N", $FROM = "") {
-       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$TO},SUBJECT={$SUBJECT}<br />\n";
+function SEND_EMAIL($toEmail, $subject, $message, $HTML = "N", $mailHeader = "") {
+       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$toEmail},SUBJECT={$subject}<br />\n";
 
        // Compile subject line (for POINTS constant etc.)
-       $eval = "\$SUBJECT = decodeEntities(\"".COMPILE_CODE(smartAddSlashes($SUBJECT))."\");";
+       $eval = "\$subject = decodeEntities(\"".COMPILE_CODE(smartAddSlashes($subject))."\");";
        eval($eval);
 
        // Set from header
-       if ((!eregi("@", $TO)) && ($TO > 0)) {
+       if ((!eregi("@", $toEmail)) && ($toEmail > 0)) {
                // Value detected, is the message extension installed?
                if (EXT_IS_ACTIVE("msg")) {
-                       ADD_MESSAGE_TO_BOX($TO, $SUBJECT, $MSG, $HTML);
+                       ADD_MESSAGE_TO_BOX($toEmail, $subject, $message, $HTML);
                        return;
                } else {
                        // Load email address
-                       $result_email = SQL_QUERY_ESC("SELECT email FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1", array(bigintval($TO)), __FUNCTION__, __LINE__);
+                       $result_email = SQL_QUERY_ESC("SELECT email FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1", array(bigintval($toEmail)), __FUNCTION__, __LINE__);
                        //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):numRows=".SQL_NUMROWS($result_email)."<br />\n";
 
                        // Does the user exist?
                        if (SQL_NUMROWS($result_email)) {
                                // Load email address
-                               list($TO) = SQL_FETCHROW($result_email);
+                               list($toEmail) = SQL_FETCHROW($result_email);
                        } else {
                                // Set webmaster
-                               $TO = constant('WEBMASTER');
+                               $toEmail = constant('WEBMASTER');
                        }
 
                        // Free result
                        SQL_FREERESULT($result_email);
                }
-       } elseif ("$TO" == "0") {
+       } elseif ("$toEmail" == "0") {
                // Is the webmaster!
-               $TO = constant('WEBMASTER');
+               $toEmail = constant('WEBMASTER');
        }
-       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$TO}<br />\n";
+       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$toEmail}<br />\n";
 
        // Check for PHPMailer or debug-mode
        if (!CHECK_PHPMAILER_USAGE()) {
                // Not in PHPMailer-Mode
-               if (empty($FROM)) {
+               if (empty($mailHeader)) {
                        // Load email header template
-                       $FROM = LOAD_EMAIL_TEMPLATE("header");
+                       $mailHeader = LOAD_EMAIL_TEMPLATE("header");
                } else {
                        // Append header
-                       $FROM .= LOAD_EMAIL_TEMPLATE("header");
+                       $mailHeader .= LOAD_EMAIL_TEMPLATE("header");
                }
        } elseif (isDebugModeEnabled()) {
-               if (empty($FROM)) {
+               if (empty($mailHeader)) {
                        // Load email header template
-                       $FROM = LOAD_EMAIL_TEMPLATE("header");
+                       $mailHeader = LOAD_EMAIL_TEMPLATE("header");
                } else {
                        // Append header
-                       $FROM .= LOAD_EMAIL_TEMPLATE("header");
+                       $mailHeader .= LOAD_EMAIL_TEMPLATE("header");
                }
        }
 
        // Compile "TO"
-       $eval = "\$TO = \"".COMPILE_CODE(smartAddSlashes($TO))."\";";
+       $eval = "\$toEmail = \"".COMPILE_CODE(smartAddSlashes($toEmail))."\";";
        eval($eval);
 
        // Compile "MSG"
-       $eval = "\$MSG = \"".COMPILE_CODE(smartAddSlashes($MSG))."\";";
+       $eval = "\$message = \"".COMPILE_CODE(smartAddSlashes($message))."\";";
        eval($eval);
 
        // Fix HTML parameter (default is no!)
@@ -454,20 +455,20 @@ function SEND_EMAIL($TO, $SUBJECT, $MSG, $HTML = "N", $FROM = "") {
        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))."
-To      : ".$TO."
-Subject : ".$SUBJECT."
-Message : ".$MSG."
+".htmlentities(trim($mailHeader))."
+To      : ".$toEmail."
+Subject : ".$subject."
+Message : ".$message."
 </pre>\n");
        } elseif (($HTML == "Y") && (EXT_IS_ACTIVE("html_mail"))) {
                // Send mail as HTML away
-               SEND_HTML_EMAIL($TO, $SUBJECT, $MSG, $FROM);
-       } elseif (!empty($TO)) {
+               SEND_HTML_EMAIL($toEmail, $subject, $message, $mailHeader);
+       } elseif (!empty($toEmail)) {
                // Send Mail away
-               SEND_RAW_EMAIL($TO, $SUBJECT, $MSG, $FROM);
+               SEND_RAW_EMAIL($toEmail, $subject, $message, $mailHeader);
        } elseif ($HTML == "N") {
                // Problem found!
-               SEND_RAW_EMAIL(constant('WEBMASTER'), "[PROBLEM:]".$SUBJECT, $MSG, $FROM);
+               SEND_RAW_EMAIL(constant('WEBMASTER'), "[PROBLEM:]".$subject, $message, $mailHeader);
        }
 }
 
@@ -481,7 +482,7 @@ function CHECK_PHPMAILER_USAGE() {
 /*
  * Send out a raw email with PHPMailer class or legacy mail() command
  */
-function SEND_RAW_EMAIL ($to, $subject, $msg, $from) {
+function SEND_RAW_EMAIL ($toEmail, $subject, $msg, $from) {
        // Shall we use PHPMailer class or legacy mode?
        if (CHECK_PHPMAILER_USAGE()) {
                // Use PHPMailer class with SMTP enabled
@@ -513,14 +514,14 @@ function SEND_RAW_EMAIL ($to, $subject, $msg, $from) {
                } else {
                        $mail->Body       = decodeEntities($msg);
                }
-               $mail->AddAddress($to, "");
+               $mail->AddAddress($toEmail, "");
                $mail->AddReplyTo(constant('WEBMASTER'), constant('MAIN_TITLE'));
                $mail->AddCustomHeader("Errors-To:".constant('WEBMASTER'));
                $mail->AddCustomHeader("X-Loop:".constant('WEBMASTER'));
                $mail->Send();
        } else {
                // Use legacy mail() command
-               @mail($to, $subject, decodeEntities($msg), $from);
+               @mail($toEmail, $subject, decodeEntities($msg), $from);
        }
 }
 //
@@ -661,8 +662,7 @@ function TRANSLATE_GENDER ($gender) {
 //
 function FRAMETESTER ($URL) {
        // Prepare frametester URL
-       $frametesterUrl = sprintf("%s/modules.php?module=frametester&amp;url=%s",
-               URL,
+       $frametesterUrl = sprintf("{!URL!}/modules.php?module=frametester&amp;url=%s",
                encodeString(compileUriCode($URL))
        );
        return $frametesterUrl;
@@ -699,7 +699,7 @@ function TRANSLATE_STATUS ($status) {
 
        default:
                DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
-               $ret = sprintf(getMessage('UNKNOWN_STATUS"'), $status);
+               $ret = sprintf(getMessage('UNKNOWN_STATUS'), $status);
                break;
        }
 
@@ -976,13 +976,14 @@ function COMPILE_CODE ($code, $simple = false, $constants = true, $full = true)
                return $code;
        } // END - if
 
-       $ARRAY = $GLOBALS['security_chars'];
+       // Init replacement-array with full security characters
+       $secChars = $GLOBALS['security_chars'];
 
        // Select smaller set of chars to replace when we e.g. want to compile URLs
-       if (!$full) $ARRAY = $GLOBALS['url_chars'];
+       if (!$full) $secChars = $GLOBALS['url_chars'];
 
        // Compile constants
-       if ($constants) {
+       if ($constants === true) {
                // BEFORE 0.2.1 : Language and data constants
                // WITH 0.2.1+  : Only language constants
                $code = str_replace('{--','".', str_replace('--}','."', $code));
@@ -993,16 +994,16 @@ function COMPILE_CODE ($code, $simple = false, $constants = true, $full = true)
        } // END - if
 
        // Compile QUOT and other non-HTML codes
-       foreach ($ARRAY['to'] as $k => $to) {
+       foreach ($secChars['to'] as $k => $to) {
                // Do the reversed thing as in inc/libs/security_functions.php
-               $code = str_replace($to, $ARRAY['from'][$k], $code);
+               $code = str_replace($to, $secChars['from'][$k], $code);
        } // END - foreach
 
        // But shall I keep simple quotes for later use?
        if ($simple) $code = str_replace("'", '{QUOT}', $code);
 
        // Find $content[bla][blub] entries
-       @preg_match_all('/\$(content|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
+       preg_match_all('/\$(content|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
 
        // Are some matches found?
        if ((count($matches) > 0) && (count($matches[0]) > 0)) {
@@ -2040,8 +2041,6 @@ function CREATE_EMAIL_LINK ($email, $table = "admins") {
 
 // Generate a hash for extra-security for all passwords
 function generateHash ($plainText, $salt = "") {
-       global $_SERVER;
-
        // Is the required extension "sql_patches" there and a salt is not given?
        if (((EXT_VERSION_IS_OLDER("sql_patches", "0.3.6")) || (!EXT_IS_ACTIVE("sql_patches"))) && (empty($salt))) {
                // Extension sql_patches is missing/outdated so we hash the plain text with MD5
@@ -2173,7 +2172,7 @@ function genScrambleString ($len) {
 // normally be stored in cookies
 function ADD_URL_DATA ($URL) {
        // Init add
-       $ADD = "";
+       $add = "";
 
        // Determine URL binder
        $BIND = "?";
@@ -2183,15 +2182,15 @@ function ADD_URL_DATA ($URL) {
                // Cookies are not accepted
                if ((REQUEST_ISSET_GET(('refid'))) && (strpos($URL, "refid=") == 0)) {
                        // Cookie found in URL
-                       $ADD .= $BIND."refid=".bigintval(REQUEST_GET('refid'));
+                       $add .= $BIND."refid=".bigintval(REQUEST_GET('refid'));
                } elseif ((GET_EXT_VERSION("sql_patches") != '') && (getConfig('def_refid') > 0)) {
                        // Not found! So let's set default here
-                       $ADD .= $BIND."refid=".getConfig('def_refid');
+                       $add .= $BIND."refid=".getConfig('def_refid');
                }
        } // END - if
 
        // Add all together and return it
-       return $URL . $ADD;
+       return $URL . $add;
 }
 
 // Generate an PGP-like encrypted hash of given hash for e.g. cookies
@@ -2393,10 +2392,10 @@ function GET_CURR_THEME() {
        }
 
        // Add (maybe) found theme.php file to inclusion list
-       $theme = sprintf("%stheme/%s/theme.php", constant('PATH'), SQL_ESCAPE($ret));
+       $INC = sprintf("theme/%s/theme.php", SQL_ESCAPE($ret));
 
        // Try to load the requested include file
-       if (FILE_READABLE($theme)) ADD_INC_TO_POOL($theme);
+       if (INCLUDE_READABLE($INC)) ADD_INC_TO_POOL($INC);
 
        // Return theme value
        return $ret;
@@ -2628,6 +2627,7 @@ function getActualVersion ($type = 'Revision') {
 }
 
 // Repares an array we are looking for
+// The returned Array is needed twice (in getAkt_vers() and in getActualVersion() in the old .revision-fallback) so I puted it in an extra function to not polute the global namespace
 function getSearchFor () {
        // Add Revision, Date, Tag and Author
        $searchFor = array('Revision', 'Date', 'Tag', 'Author');
@@ -2638,47 +2638,53 @@ function getSearchFor () {
 
 function getAkt_vers () {
        // Init variables
-       $next_dir = "";
+       $next_dir = ""; // Directory to start with search
        $last_changed = array(
                'path_name' => "",
                'time'      => 0
        );
-       $akt_vers = array();
-       $res = 0;
+       $akt_vers = array(); // Init return array
+       $res = 0; // Init value for counting the founded keywords
 
        // Searches all Files and there date of the last modifikation and puts the newest File in $last_changed.
-       searchDirsRecursive($next_dir, $last_changed);
+       searchDirsRecursive($next_dir, $last_changed); // @TODO small change to API to $last_changed = searchDirsRecursive($next_dir, $time);
 
        // Get file
        $last_file = READ_FILE($last_changed['path_name']);
+
+       // Get all the keywords to search for
        $searchFor = getSearchFor();
 
-       // @TODO What does this loop/regex do? Document it, please.
+       // This foreach loops the $searchFor-Tags (array('Revision', 'Date', 'Tag', 'Author') --> could easaly extended in the future)
        foreach ($searchFor as $search) {
+               //Searches for "$search-tag:VALUE$" or "$search-tag::VALUE$"(the stylish keywordversion ;-)) in the lates modified file
                $res += preg_match('@\$'.$search.'(:|::) (.*) \$@U', $last_file, $t);
+               // This trimms the search-result and puts it in the $akt_vers-return array
                if (isset($t[2])) $akt_vers[$search] = trim($t[2]);
        } // END - foreach
 
+       // at least 3 keyword-Tags are needed for propper values
        if ($res && $res >= 3) {
-               // Prepare content
-               preg_match('@(....)-(..)-(..) (..):(..):(..)@', $akt_vers['Date'], $match_d);
+               // Prepare content witch need special treadment
 
                // Prepare timestamp for date
+               preg_match('@(....)-(..)-(..) (..):(..):(..)@', $akt_vers['Date'], $match_d);
                $akt_vers['Date'] = mktime($match_d[4], $match_d[5], $match_d[6], $match_d[2], $match_d[3], $match_d[1]);
 
-               // Add Tag if the author is set and is not quix0r (lead coder)
+               // Add author to the Tag if the author is set and is not quix0r (lead coder)
                if ((isset($akt_vers['Author'])) && ($akt_vers['Author'] != "quix0r")) {
                        $akt_vers['Tag'] .= '-'.strtoupper($akt_vers['Author']);
                } // END - if
        } else {
-               // No valid Data from the last modificated file so read the Revision from the Server. Fallback-solution!! Could be removed I think.
+               // No valid Data from the last modificated file so read the Revision from the Server. Fallback-solution!! Should not be removed I think.
                $version = GET_URL("check-updates3.php");
 
                // Prepare content
-               $akt_vers['Revision'] = trim($version[10]);
-               $akt_vers['Date']     = trim($version[9]);
-               $akt_vers['Tag']      = trim($version[8]);
-               $akt_vers['Author']   = "quix0r";
+               // Only sets not setted or not proper values to the Online-Server-Fallback-Solution
+               if (!isset($akt_vers['Revision']) || $akt_vers['Revision'] == '') $akt_vers['Revision'] = trim($version[10]);
+               if (!isset($akt_vers['Date'])     || $akt_vers['Date']     == '') $akt_vers['Date']     = trim($version[9]);
+               if (!isset($akt_vers['Tag'])      || $akt_vers['Tag']      == '') $akt_vers['Tag']      = trim($version[8]);
+               if (!isset($akt_vers['Author'])   || $akt_vers['Author']   == '') $akt_vers['Author']   = "quix0r";
        }
 
        // Return prepared array
@@ -2751,9 +2757,10 @@ function debug_report_bug ($message = "") {
        } // END - if
 
        // Add output
-       $debug .= "Please report this error at <a href=\"http://bugs.mxchange.org\" rel=\"external\" target=\"_blank\">bugs.mxchange.org</a>:<pre>";
+       $debug .= "Please report this bug at <a href=\"http://bugs.mxchange.org\" rel=\"external\" target=\"_blank\">bugs.mxchange.org</a>:<pre>";
        $debug .= debug_get_printable_backtrace();
-       $debug .= "</pre>Thank you for finding bugs.";
+       $debug .= "</pre>Request-URI: ".$_SERVER['REQUEST_URI']."<br />\n";
+       $debug .= "Thank you for finding bugs.";
 
        // And abort here
        // @TODO This cannot be rewritten to mxchange_die(), try to find a solution for this.
@@ -2798,7 +2805,15 @@ function convertCodeToMessage ($code) {
                case getCode('COOKIES_DISABLED') : $msg = getMessage('LOGIN_NO_COOKIES'); break;
                case getCode('BEG_SAME_AS_OWN')  : $msg = getMessage('BEG_SAME_UID_AS_OWN'); break;
                case getCode('LOGIN_FAILED')     : $msg = getMessage('LOGIN_FAILED_GENERAL'); break;
-               default                                : $msg = sprintf(getMessage('UNKNOWN_MAILID_CODE'), $code); break;
+               case getCode('MODULE_MEM_ONLY')  : $msg = sprintf(getMessage('MODULE_MEM_ONLY'), REQUEST_GET('mod')); break;
+
+               default:
+                       // Missing/invalid code
+                       $msg = sprintf(getMessage('UNKNOWN_MAILID_CODE'), $code);
+
+                       // Log it
+                       DEBUG_LOG(__FUNCTION__, __LINE__, $msg);
+                       break;
        } // END - switch
 
        // Return the message
@@ -3089,6 +3104,7 @@ function DEBUG_LOG ($funcFile, $line, $message, $force=true) {
 
 // Reads a directory with PHP files in and gets only files back
 function GET_DIR_AS_ARRAY ($baseDir, $prefix, $includeDirs = false, $addBaseDir = true) {
+       //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix} - Entered!");
        // Init includes
        $INCs = array();
 
@@ -3102,7 +3118,7 @@ function GET_DIR_AS_ARRAY ($baseDir, $prefix, $includeDirs = false, $addBaseDir
                $FQFN = constant('PATH') . $INC;
 
                // Is this a valid reset file?
-               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}<br />\n";
+               //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}");
                if (((FILE_READABLE($FQFN)) && (substr($baseFile, 0, strlen($prefix)) == $prefix) && (substr($baseFile, -4, 4) == ".php")) || (($includeDirs) && (isDirectory($FQFN)))) {
                        // Remove both for extension name
                        $extName = substr($baseFile, strlen($prefix), -4);
@@ -3113,11 +3129,11 @@ function GET_DIR_AS_ARRAY ($baseDir, $prefix, $includeDirs = false, $addBaseDir
                        // Is the extension valid and active?
                        if (($extId > 0) && (EXT_IS_ACTIVE($extName))) {
                                // Then add this file
-                               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): Extension entry ".$baseFile." added.<br />\n";
+                               //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " Extension entry ".$baseFile." added.");
                                $INCs[] = $INC;
                        } elseif ($extId == 0) {
                                // Add non-extension files as well
-                               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): Regular entry ".$baseFile." added.<br />\n";
+                               //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " Regular entry ".$baseFile." added.");
                                if ($addBaseDir) {
                                        $INCs[] = $INC;
                                } else {
@@ -3134,6 +3150,7 @@ function GET_DIR_AS_ARRAY ($baseDir, $prefix, $includeDirs = false, $addBaseDir
        asort($INCs);
 
        // Return array with include files
+       //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Left!");
        return $INCs;
 }
 
@@ -3469,10 +3486,8 @@ function ADD_NEW_BONUS_MAIL ($data, $mode="", $output=true) {
 
 // Determines referal id and sets it
 function DETERMINE_REFID () {
-       global $CLICK, $_SERVER;
-
        // Check if refid is set
-       if ((!empty($_GET['user'])) && ($CLICK == 1) && (basename($_SERVER['PHP_SELF']) == "click.php")) {
+       if ((!empty($_GET['user'])) && (basename($_SERVER['PHP_SELF']) == "click.php")) {
                // The variable user comes from the click-counter script click.php and we only accept this here
                $GLOBALS['refid'] = bigintval($_GET['user']);
        } elseif (!empty($_POST['refid'])) {
@@ -3560,7 +3575,7 @@ function shutdown () {
        if (SQL_IS_LINK_UP()) {
                // Close link
                SQL_CLOSE(__FILE__, __LINE__);
-       } elseif (!isInstalling()) {
+       } elseif ((!isInstalling()) && (isInstalled())) {
                // No database link
                addFatalMessage(__FILE__, __LINE__, getMessage('NO_DB_LINK_SHUTDOWN'));
        }
@@ -3651,6 +3666,23 @@ function REMOVE_INC_FROM_POOL ($INC) {
        } // END - if
 }
 
+// Handle message codes from URL
+function handleCodeMessage () {
+       if (REQUEST_ISSET_GET(('msg'))) {
+               // Default extension is "unknown"
+               $ext = "unknown";
+
+               // Is extension given?
+               if (REQUEST_ISSET_GET(('ext'))) $ext = REQUEST_GET(('ext'));
+
+               // Convert the 'msg' parameter from URL to a human-readable message
+               $msg = convertCodeToMessage(REQUEST_GET('msg'));
+
+               // Load message template
+               LOAD_TEMPLATE("message", false, $msg);
+       } // END - if
+}
+
 //////////////////////////////////////////////////
 // AUTOMATICALLY RE-GENERATED MISSING FUNCTIONS //
 //////////////////////////////////////////////////