]> git.mxchange.org Git - mailer.git/blobdiff - inc/functions.php
Rewrites/fixes for CURRENT_DATE, better encapsulation of redirect, coding convention:
[mailer.git] / inc / functions.php
index f50a594a58a21f8feec74f756c87a495a5cdd49c..ff063d75f75c854f946c209e55acaaada197f321 100644 (file)
@@ -106,9 +106,6 @@ function getTotalFatalErrors () {
 function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '') {
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'toEmail=' . $toEmail . ',subject=' . $subject . ',isHtml=' . $isHtml);
 
-       // Compile subject line (for POINTS constant etc.)
-       eval('$subject = decodeEntities("' . compileRawCode(escapeQuotes($subject)) . '");');
-
        // Set from header
        if ((!isInStringIgnoreCase('@', $toEmail)) && ($toEmail > 0)) {
                // Value detected, is the message extension installed?
@@ -134,13 +131,22 @@ function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '
 
        // Check for PHPMailer or debug-mode
        if ((!checkPhpMailerUsage()) || (isDebugModeEnabled())) {
+               // Prefix is '' for text mails
+               $prefix = '';
+
+               // Is HTML?
+               if ($isHtml == 'Y') {
+                       // Set prefix
+                       $prefix = 'html_';
+               } // END - if
+
                // Not in PHPMailer-Mode
                if (empty($mailHeader)) {
                        // Load email header template
-                       $mailHeader = loadEmailTemplate('header');
+                       $mailHeader = loadEmailTemplate($prefix . 'header');
                } else {
                        // Append header
-                       $mailHeader .= loadEmailTemplate('header');
+                       $mailHeader .= loadEmailTemplate($prefix . 'header');
                }
        } // END - if
 
@@ -151,17 +157,14 @@ function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '
        if (isDebugModeEnabled()) {
                // In debug mode we want to display the mail instead of sending it away so we can debug this part
                outputHtml('<pre>
-Headers : ' . encodeEntities(utf8_decode(trim($mailHeader))) . '
-To      : ' . encodeEntities(utf8_decode($toEmail)) . '
-Subject : ' . encodeEntities(utf8_decode($subject)) . '
-Message : ' . encodeEntities(utf8_decode($message)) . '
+Headers : ' . htmlentities(utf8_decode(trim($mailHeader))) . '
+To      : ' . htmlentities(utf8_decode($toEmail)) . '
+Subject : ' . htmlentities(utf8_decode($subject)) . '
+Message : ' . htmlentities(utf8_decode($message)) . '
 </pre>');
 
                // This is always fine
                return true;
-       } elseif (($isHtml == 'Y') && (isExtensionActive('html_mail'))) {
-               // Send mail as HTML away
-               return sendHtmlEmail($toEmail, $subject, $message, $mailHeader);
        } elseif (!empty($toEmail)) {
                // Send Mail away
                return sendRawEmail($toEmail, $subject, $message, $mailHeader);
@@ -182,12 +185,17 @@ function checkPhpMailerUsage() {
 }
 
 // Send out a raw email with PHPMailer class or legacy mail() command
-function sendRawEmail ($toEmail, $subject, $message, $from) {
-       // Just compile all again, to put out all configs, etc.
-       eval('$toEmail = decodeEntities("' . doFinalCompilation(compileRawCode(escapeQuotes($toEmail)), false) . '");');
-       eval('$subject = decodeEntities("' . doFinalCompilation(compileRawCode(escapeQuotes($subject)), false) . '");');
-       eval('$message = decodeEntities("' . doFinalCompilation(compileRawCode(escapeQuotes($message)), false) . '");');
-       eval('$from    = decodeEntities("' . doFinalCompilation(compileRawCode(escapeQuotes($from))   , false) . '");');
+function sendRawEmail ($toEmail, $subject, $message, $headers) {
+       // Just compile all to put out all configs, etc.
+       $eval  = '$toEmail = decodeEntities("' . escapeQuotes(doFinalCompilation(compileRawCode($toEmail), false)) . '"); ';
+       $eval .= '$subject = decodeEntities("' . escapeQuotes(doFinalCompilation(compileRawCode($subject), false)) . '"); ';
+       $eval .= '$headers = decodeEntities("' . escapeQuotes(doFinalCompilation(compileRawCode($headers), false)) . '"); ';
+
+       // Do not decode entities in the message because we also send HTML mails through this function
+       $eval .= '$message = "' . escapeQuotes(doFinalCompilation(compileRawCode($message), false)) . '";';
+
+       // Run the final eval() command
+       eval($eval);
 
        // Shall we use PHPMailer class or legacy mode?
        if (checkPhpMailerUsage()) {
@@ -210,10 +218,10 @@ function sendRawEmail ($toEmail, $subject, $message, $from) {
                $mail->Port       = 25;
                $mail->Username   = getConfig('SMTP_USER');
                $mail->Password   = getConfig('SMTP_PASSWORD');
-               if (empty($from)) {
+               if (empty($headers)) {
                        $mail->From = getConfig('WEBMASTER');
                } else {
-                       $mail->From = $from;
+                       $mail->From = $headers;
                }
                $mail->FromName   = getMainTitle();
                $mail->Subject    = $subject;
@@ -225,10 +233,12 @@ function sendRawEmail ($toEmail, $subject, $message, $from) {
                } else {
                        $mail->Body       = decodeEntities($message);
                }
+
                $mail->AddAddress($toEmail, '');
                $mail->AddReplyTo(getConfig('WEBMASTER'), getMainTitle());
                $mail->AddCustomHeader('Errors-To:' . getConfig('WEBMASTER'));
                $mail->AddCustomHeader('X-Loop:' . getConfig('WEBMASTER'));
+               $mail->AddCustomHeader('Bounces-To:' . getConfig('WEBMASTER'));
                $mail->Send();
 
                // Has an error occured?
@@ -244,7 +254,7 @@ function sendRawEmail ($toEmail, $subject, $message, $from) {
                }
        } else {
                // Use legacy mail() command
-               return mail($toEmail, $subject, decodeEntities($message), $from);
+               return mail($toEmail, $subject, decodeEntities($message), $headers);
        }
 }
 
@@ -554,7 +564,7 @@ function redirectToUrl ($URL, $allowSpider = true) {
        } // END - if
 
        // Three different ways to debug...
-       //* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, sprintf("%s[%s:] URL=%s", __FUNCTION__, __LINE__, $URL));
+       //* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, 'URL=' . $URL);
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $URL);
        //* DEBUG: */ die($URL);
 
@@ -575,9 +585,6 @@ function redirectToUrl ($URL, $allowSpider = true) {
                // Clear own output buffer
                $GLOBALS['output'] = '';
 
-               // Set header
-               setHttpStatus('302 Found');
-
                // Load URL when headers are not sent
                sendRawRedirect(doFinalCompilation(str_replace('&amp;', '&', $URL), false));
        } else {
@@ -763,7 +770,7 @@ function createFancyTime ($stamp) {
        foreach($data as $k => $v) {
                if ($v > 0) {
                        // Value is greater than 0 "eval" data to return string
-                       eval('$ret .= ", ".$v." {--_' . strtoupper($k) . '--}";');
+                       $ret .= ', ' . $v . ' {--_' . strtoupper($k) . '--}';
                        break;
                } // END - if
        } // END - foreach
@@ -824,20 +831,23 @@ function sendGetRequest ($script, $data = array()) {
        // Add data
        $body = http_build_query($data, '', '&');
 
-       // Do we have a question-mark in the script?
-       if (strpos($script, '?') === false) {
-               // No, so first char must be question mark
-               $body = '?' . $body;
-       } else {
-               // Ok, add &
-               $body = '&' . $body;
-       }
+       // There should be data, else we don't need to extend $script with $body
+       if (empty($body)) {
+               // Do we have a question-mark in the script?
+               if (strpos($script, '?') === false) {
+                       // No, so first char must be question mark
+                       $body = '?' . $body;
+               } else {
+                       // Ok, add &
+                       $body = '&' . $body;
+               }
 
-       // Add script data
-       $script .= $body;
+               // Add script data
+               $script .= $body;
 
-       // Remove trailed & to make it more conform
-       if (substr($script, -1, 1) == '&') $script = substr($script, 0, -1);
+               // Remove trailed & to make it more conform
+               if (substr($script, -1, 1) == '&') $script = substr($script, 0, -1);
+       } // END - if
 
        // Generate GET request header
        $request  = 'GET /' . trim($script) . ' HTTP/1.1' . getConfig('HTTP_EOL');
@@ -1398,7 +1408,7 @@ function debug_get_printable_backtrace () {
                if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
                if (!isset($trace['line'])) $trace['line'] = __LINE__;
                if (!isset($trace['args'])) $trace['args'] = array();
-               $backtrace .= '<li class="debug_list"><span class="backtrace_file">' . basename($trace['file']) . '</span>:' . $trace['line'].", <span class=\"backtrace_function\">" . $trace['function'] . '(' . count($trace['args']) . ')</span></li>';
+               $backtrace .= '<li class="debug_list"><span class="backtrace_file">' . basename($trace['file']) . '</span>:' . $trace['line'] . ', <span class="backtrace_function">' . $trace['function'] . '(' . count($trace['args']) . ')</span></li>';
        } // END - foreach
 
        // Close it
@@ -2003,7 +2013,9 @@ function initMemberId () {
 // Setter for member id
 function setMemberId ($memberid) {
        // We should not set member id to zero
-       if ($memberid == '0') debug_report_bug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
+       if ($memberid == '0') {
+               debug_report_bug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
+       } // END - if
 
        // Set it secured
        $GLOBALS['member_id'] = bigintval($memberid);
@@ -2176,15 +2188,6 @@ function mapModuleToTable ($moduleName) {
 
 // Add SQL debug data to array for later output
 function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
-       // Already executed?
-       if (isset($GLOBALS['debug_sqls'][$F][$L][$sqlString])) {
-               // Then abort here, we don't need to profile a query twice
-               return;
-       } // END - if
-
-       // Remeber this as profiled (or not, but we don't care here)
-       $GLOBALS['debug_sqls'][$F][$L][$sqlString] = true;
-
        // Do we have cache?
        if (!isset($GLOBALS['debug_sql_available'])) {
                // Check it and cache it in $GLOBALS
@@ -2196,6 +2199,15 @@ function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
                return;
        } // END - if
 
+       // Already executed?
+       if (isset($GLOBALS['debug_sqls'][$F][$L][$sqlString])) {
+               // Then abort here, we don't need to profile a query twice
+               return;
+       } // END - if
+
+       // Remeber this as profiled (or not, but we don't care here)
+       $GLOBALS['debug_sqls'][$F][$L][$sqlString] = true;
+
        // Generate record
        $record = array(
                'num_rows' => SQL_NUMROWS($result),
@@ -2305,8 +2317,8 @@ function encodeUrl ($url, $outputMode = '0') {
 
 // Simple check for spider
 function isSpider () {
-       // Get the UA
-       $userAgent = strtolower(detectUserAgent(true));
+       // Get the UA and trim it down
+       $userAgent = trim(strtolower(detectUserAgent(true)));
 
        // It should not be empty, if so it is better a spider/bot
        if (empty($userAgent)) return true;
@@ -2389,6 +2401,31 @@ function makeDatabaseUserId ($userid) {
        return $userid;
 }
 
+// Capitalizes a string with underscores, e.g.: some_foo_string will become SomeFooString
+// Note: This function is cached
+function capitalizeUnderscoreString ($str) {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__][$str])) {
+               // Init target string
+               $capitalized = '';
+
+               // Explode it with the underscore, but rewrite dashes to underscore before
+               $strArray = explode('_', str_replace('-', '_', $str));
+
+               // "Walk" through all elements and make them lower-case but first upper-case
+               foreach ($strArray as $part) {
+                       // Capitalize the string part
+                       $capitalized .= ucfirst(strtolower($part));
+               } // END - foreach
+
+               // Store the converted string in cache array
+               $GLOBALS[__FUNCTION__][$str] = $capitalized;
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__][$str];
+}
+
 //-----------------------------------------------------------------------------
 // Automatically re-created functions, all taken from user comments on www.php.net
 //-----------------------------------------------------------------------------