Redirection work-around added
[mailer.git] / inc / functions.php
index c449c058a29024c509b99eed283c6b2e316c552a..1ef5165a5a35d301c484bb8fce92f98306cdc59e 100644 (file)
@@ -71,18 +71,15 @@ function OPEN_TABLE($PERCENT = "", $CLASS = "", $ALIGN="left", $VALIGN="", $td_o
 
        // Vertical align is given
        if (!empty($VALIGN))  $OUT .= " valign=\"".$VALIGN."\"";
-       $OUT .= ">
-<TR>
-  <TD";
+       $OUT .= ">\n<TR>\n<TD";
        if (!empty($ALIGN)) $OUT .=" align=\"".$ALIGN."\"";
        $OUT .= " class=\"".$CLASS."\">";
-       OUTPUT_HTML($OUT);
+       OUTPUT_HTML($OUT);
 }
 
 // Close a table (you may want to add some footer stuff here)
 function CLOSE_TABLE($ADD="") {
-       OUTPUT_HTML("  </TD>
-</TR>");
+       OUTPUT_HTML("  </TD>\n</TR>");
        if (!empty($ADD)) OUTPUT_HTML($ADD);
        OUTPUT_HTML("</TABLE>");
 }
@@ -140,9 +137,9 @@ function OUTPUT_HTML($HTML, $NEW_LINE = true) {
                }
 
                // Compile and run finished rendered HTML code
-               while (strpos($OUTPUT, "{!") > 0) {
+               while (strpos($OUTPUT, '{!') > 0) {
                        $eval = "\$OUTPUT = \"" . COMPILE_CODE(addslashes($OUTPUT)) . "\";";
-                       @eval($eval);
+                       eval($eval);
                }
 
                // Output code here, DO NOT REMOVE! ;-)
@@ -154,9 +151,9 @@ function OUTPUT_HTML($HTML, $NEW_LINE = true) {
                }
 
                // Compile and run finished rendered HTML code
-               while (strpos($OUTPUT, "{!") > 0) {
+               while (strpos($OUTPUT, '{!') > 0) {
                        $eval = "\$OUTPUT = \"" . COMPILE_CODE(addslashes($OUTPUT)) . "\";";
-                       @eval($eval);
+                       eval($eval);
                }
 
                // Output code here, DO NOT REMOVE! ;-)
@@ -166,7 +163,7 @@ function OUTPUT_HTML($HTML, $NEW_LINE = true) {
 
 // Output the raw HTML code
 function OUTPUT_RAW ($HTML) {
-       if ((mxchange_installed) && (basename($_SERVER['PHP_SELF']) != "install.php")) {
+       if ((isBooleanConstantAndTrue('mxchange_installed')) && (basename($_SERVER['PHP_SELF']) != "install.php")) {
                // Not in install-mode so strip slashes away
                echo stripslashes($HTML);
        } else {
@@ -179,8 +176,7 @@ function OUTPUT_RAW ($HTML) {
 }
 
 // Add a fatal error message to the queue array
-function ADD_FATAL ($message, $extra="")
-{
+function ADD_FATAL ($message, $extra="") {
        global $FATAL;
        if (empty($extra)) {
                // Regular text message to add to $FATAL
@@ -273,23 +269,23 @@ function LOAD_TEMPLATE($template, $return=false, $content="") {
        }
 
        // Does the special template exists?
-       if (!file_exists($file)) {
+       if ((!file_exists($file)) || (!is_readable($file))) {
                // Reset to default template
                $file = $BASE.$template.".tpl";
        }
 
        // Now does the final template exists?
-       if (file_exists($file)) {
+       if ((file_exists($file)) && (is_readable($file))) {
                // The local file does exists so we load it. :)
                $tmpl_file = implode("", file($file));
 
                // Replace ' to our own chars to preventing them being quoted
-               while (strpos($tmpl_file, "\'") !== false) { $tmpl_file = str_replace("\'", "{QUOT}", $tmpl_file); }
+               while (strpos($tmpl_file, "\'") !== false) { $tmpl_file = str_replace("\'", '{QUOT}', $tmpl_file); }
 
                // Do we have to compile the code?
                if ((strpos($tmpl_file, "\$") !== false) || (strpos($tmpl_file, '{--') !== false) || (strpos($tmpl_file, '--}') > 0)) {
                        // Okay, compile it!
-                       $tmpl_file = "\$ret=\"".COMPILE_CODE(addslashes($tmpl_file))."\";";
+                       $tmpl_file = "\$ret=\"" . COMPILE_CODE(addslashes($tmpl_file)) . "\";";
                        eval($tmpl_file);
                } else {
                        // Simply return loaded code
@@ -298,7 +294,7 @@ function LOAD_TEMPLATE($template, $return=false, $content="") {
 
                // Add surrounding HTML comments to help finding bugs faster
                $ret = "<!-- Template ".$template." - Start -->\n".$ret."<!-- Template ".$template." - End -->\n";
-       } elseif ((IS_ADMIN()) || ((mxchange_installing) && (!mxchange_installed))) {
+       } elseif ((IS_ADMIN()) || ((isBooleanConstantAndTrue('mxchange_installing')) && (!isBooleanConstantAndTrue('mxchange_installed')))) {
                // Only admins shall see this warning or when installation mode is active
                $ret = "<br /><SPAN class=\"guest_failed\">".TEMPLATE_404."</SPAN><br />
 (".basename($file).")<br />
@@ -320,7 +316,7 @@ function LOAD_TEMPLATE($template, $return=false, $content="") {
                        // Output direct
                        OUTPUT_HTML($ret);
                }
-       } elseif (DEBUG_MODE) {
+       } elseif (isBooleanConstantAndTrue('DEBUG_MODE')) {
                // Warning, empty output!
                return "E:".$template."<br />\n";
        }
@@ -329,7 +325,7 @@ function LOAD_TEMPLATE($template, $return=false, $content="") {
 // Send mail out to an email address
 function SEND_EMAIL($TO, $SUBJECT, $MSG, $HTML='N', $FROM="") {
        // Compile subject line (for POINTS constant etc.)
-       $eval = "\$SUBJECT = \"".COMPILE_CODE(addslashes($SUBJECT))."\";";
+       $eval = "\$SUBJECT = \"" . COMPILE_CODE(addslashes($SUBJECT)) . "\";";
        eval($eval);
        $SUBJECT = html_entity_decode($SUBJECT);
 
@@ -355,7 +351,7 @@ function SEND_EMAIL($TO, $SUBJECT, $MSG, $HTML='N', $FROM="") {
                        // Append header
                        $FROM .= LOAD_EMAIL_TEMPLATE("header");
                }
-       } elseif (DEBUG_MODE) {
+       } elseif (isBooleanConstantAndTrue('DEBUG_MODE')) {
                if (empty($FROM)) {
                        // Load email header template
                        $FROM = LOAD_EMAIL_TEMPLATE("header");
@@ -367,7 +363,7 @@ function SEND_EMAIL($TO, $SUBJECT, $MSG, $HTML='N', $FROM="") {
 
        // Fix HTML parameter (default is no!)
        if (empty($HTML)) $HTML = 'N';
-       if (DEBUG_MODE) {
+       if (isBooleanConstantAndTrue('DEBUG_MODE')) {
                // In debug mode we want to display the mail instead of sending it away so we can debug this part
                echo "<PRE>
 ".htmlentities(trim($FROM))."
@@ -638,15 +634,11 @@ function TRANSLATE_STATUS($status)
        return $ret;
 }
 //
-function GET_LANGUAGE()
-{
-       if (!empty($_GET['mx_lang']))
-       {
+function GET_LANGUAGE() {
+       if (!empty($_GET['mx_lang'])) {
                // Accept only first 2 chars
                $lang = substr($_GET['mx_lang'], 0, 2);
-       }
-        else
-       {
+       } else {
                // Do nothing
                $lang = "";
        }
@@ -655,25 +647,23 @@ function GET_LANGUAGE()
        $ret = DEFAULT_LANG;
 
        // Check GET variable and cookie
-       if (!empty($lang))
-       {
+       if (!empty($lang)) {
                // Check if main language file does exist
-               if (file_exists(PATH."inc/language/".$lang.".php"))
-               {
+               if (file_exists(PATH."inc/language/".$lang.".php")) {
                        // Okay found, so let's update cookies
                        SET_LANGUAGE($lang);
                }
-       }
-        elseif (!empty($_SESSION['mx_lang']))
-       {
+       } elseif (!isSessionVariableSet('mx_lang')) {
                // Return stored value from cookie
-               $ret = $_SESSION['mx_lang'];
+               $ret = get_session('mx_lang');
+
+               // Fixes a warning before the session has the mx_lang constant
+               if (empty($ret)) $ret = DEFAULT_LANG;
        }
        return $ret;
 }
 //
-function SET_LANGUAGE($lang)
-{
+function SET_LANGUAGE($lang) {
        global $_CONFIG;
 
        // Accept only first 2 chars!
@@ -681,13 +671,9 @@ function SET_LANGUAGE($lang)
 
        // Set cookie
        set_session("mx_lang", $lang);
-
-       // Set array
-       $_SESSION['mx_lang'] = $lang;
 }
 //
-function LOAD_EMAIL_TEMPLATE($template, $content="", $UID="0")
-{
+function LOAD_EMAIL_TEMPLATE($template, $content="", $UID="0") {
        global $DATA, $_CONFIG, $REPLACER;
 
        // Keept for backward-compatiblity (please replace these variables against our new {--CONST--} syntax!)
@@ -699,31 +685,26 @@ function LOAD_EMAIL_TEMPLATE($template, $content="", $UID="0")
        $HTTP_USER_AGENT  = getenv('HTTP_USER_AGENT');
 
        $ADMIN = MAIN_TITLE;
-       if (!empty($_SESSION['admin_login']))
-       {
+       if (isSessionVariableSet('admin_login')) {
                // Load Admin data
                $result = SQL_QUERY_ESC("SELECT email FROM "._MYSQL_PREFIX."_admins WHERE login='%s' LIMIT 1",
-                       array(SQL_ESCAPE($_SESSION['admin_login'])), __FILE__, __LINE__);
+                       array(SQL_ESCAPE(get_session('admin_login'))), __FILE__, __LINE__);
                list($ADMIN) = SQL_FETCHROW($result);
                SQL_FREERESULT($result);
        }
 
        // Expiration in a nice output format
-       if ($_CONFIG['auto_purge'] == 0)
-       {
+       if ($_CONFIG['auto_purge'] == 0) {
                // Will never expire!
                $EXPIRATION = MAIL_WILL_NEVER_EXPIRE;
-       }
-        elseif (function_exists('CREATE_FANCY_TIME'))
-       {
+       } elseif (function_exists('CREATE_FANCY_TIME')) {
                // Create nice date string
                $EXPIRATION = CREATE_FANCY_TIME($_CONFIG['auto_purge']);
-       }
-        else
-       {
+       } else {
                // Display days only
                $EXPIRATION = round($_CONFIG['auto_purge']/60/60/24)." "._DAYS;
        }
+
        switch ($template)
        {
        case "bonus-mail": // Load data for the bonus mail
@@ -801,11 +782,11 @@ function LOAD_EMAIL_TEMPLATE($template, $content="", $UID="0")
 
        case "back-admin":
        case "back-member":
-               $points     = TRANSLATE_COMMA($DATA[10]);
+               $points         = TRANSLATE_COMMA($DATA[10]);
                break;
 
        case "add-points":
-               $points = bigintval($_POST['points']);
+               $points         = bigintval($_POST['points']);
                break;
 
        case "guest_request_confirm":
@@ -814,18 +795,14 @@ function LOAD_EMAIL_TEMPLATE($template, $content="", $UID="0")
        }
 
        // Load user's data
-       if ($UID > 0)
-       {
-               if (EXT_IS_ACTIVE("nickname"))
-               {
+       if ($UID > 0) {
+               if (EXT_IS_ACTIVE("nickname")) {
                        // Load nickname
                        $result = SQL_QUERY_ESC("SELECT surname, family, sex, email, nickname FROM "._MYSQL_PREFIX."_user_data WHERE userid=%d LIMIT 1",
                         array(bigintval($UID)), __FILE__, __LINE__);
                        list($surname, $family, $sex, $email, $nick) = SQL_FETCHROW($result);
                        SQL_FREERESULT($result);
-               }
-                else
-               {
+               } else {
                        // Load normal data
                        $result = SQL_QUERY_ESC("SELECT surname, family, sex, email FROM "._MYSQL_PREFIX."_user_data WHERE userid=%d LIMIT 1",
                         array(bigintval($UID)), __FILE__, __LINE__);
@@ -833,9 +810,7 @@ function LOAD_EMAIL_TEMPLATE($template, $content="", $UID="0")
                        SQL_FREERESULT($result);
                        $nick = "---";
                }
-       }
-        else
-       {
+       } else {
                // Neutral sex and email address is default
                $sex = 'N';
                $email = WEBMASTER;
@@ -851,40 +826,29 @@ function LOAD_EMAIL_TEMPLATE($template, $content="", $UID="0")
        $BASE = PATH."templates/".GET_LANGUAGE()."/emails/";
 
        // Check for admin/guest/member templates
-       if (strpos($template, "admin_") > -1)
-       {
+       if (strpos($template, "admin_") > -1) {
                // Admin template found
                $file = $BASE."admin/".$template.".tpl";
-       }
-        elseif (strpos($template, "guest_") > -1)
-       {
+       } elseif (strpos($template, "guest_") > -1) {
                // Guest template found
                $file = $BASE."guest/".$template.".tpl";
-       }
-        elseif (strpos($template, "member_") > -1)
-       {
+       } elseif (strpos($template, "member_") > -1) {
                // Member template found
                $file = $BASE."member/".$template.".tpl";
-       }
-        else
-       {
+       } else {
                // Test for extension
                $test = substr($template, 0, strpos($template, "_"));
-               if (EXT_IS_ACTIVE($test))
-               {
+               if (EXT_IS_ACTIVE($test)) {
                        // Set extra path to extension's name
                        $file = $BASE.$test."/".$template.".tpl";
-               }
-                else
-               {
+               } else {
                        // No special filename
                        $file = $BASE.$template.".tpl";
                }
        }
 
        // Does the special template exists?
-       if (!@file_exists($file))
-       {
+       if ((!@file_exists($file)) || (!is_readable($file))) {
                // Reset to default template
                $file = $BASE.$template.".tpl";
        }
@@ -966,7 +930,7 @@ function LOAD_URL($URL, $addUrlData=true) {
        } else {
                // Output error message
                include(PATH."inc/header.php");
-               OUTPUT_HTML(LOAD_URL_ERROR_1.$URL.LOAD_URL_ERROR_2);
+               LOAD_TEMPLATE("redirect_url", false, $URL);
                include(PATH."inc/footer.php");
        }
        exit();
@@ -983,11 +947,11 @@ function COMPILE_CODE($code, $simple = false, $constants = true, $full = true) {
        if ($constants) {
                // BEFORE 0.2.1 : Language and data constants
                // WITH 0.2.1+  : Only language constants
-               $code = str_replace("{--", '".', str_replace("--}", '."', $code));
+               $code = str_replace('{--', '".', str_replace('--}', '."', $code));
 
                // BEFORE 0.2.1 : Not used
                // WITH 0.2.1+  : Data constants
-               $code = str_replace("{!", '".', str_replace("!}", '."', $code));
+               $code = str_replace('{!', '".', str_replace("!}", '."', $code));
        }
 
        // Compile QUOT and other non-HTML codes
@@ -997,7 +961,7 @@ function COMPILE_CODE($code, $simple = false, $constants = true, $full = true) {
        }
 
        // But shall I keep simple quotes for later use?
-       if ($simple) $code = str_replace("\'", "{QUOT}", $code);
+       if ($simple) $code = str_replace("\'", '{QUOT}', $code);
 
        // Find $content[bla][blub] entries
        @preg_match_all('/\$(content|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
@@ -1184,7 +1148,7 @@ function ADD_SELECTION($type, $DEFAULT, $prefix="", $id="0")
                $OUT .= "      <OPTION value=\"Y\"";
                if ($DEFAULT == 'Y') $OUT .= " selected=\"selected\"";
                $OUT .= ">".YES."</OPTION>
-      <OPTION value=\"N\"";
+                       <OPTION value=\"N\"";
                if ($DEFAULT == 'N') $OUT .= " selected=\"selected\"";
                $OUT .= ">".NO."</OPTION>\n";
                break;
@@ -1221,12 +1185,12 @@ function GEN_RANDOM_CODE($length, $code, $uid, $DATA="")
        $data   = $code.":".$uid.":".$DATA;
 
        // Add more additional data
-       if (isset($_SESSION['u_hash']))         $data .= ":".$_SESSION['u_hash'];
-       if (isset($GLOBALS['userid']))         $data .= ":".$GLOBALS['userid'];
-       if (isset($_SESSION['lifetime']))       $data .= ":".$_SESSION['lifetime'];
-       if (isset($_SESSION['mxchange_theme'])) $data .= ":".$_SESSION['mxchange_theme'];
-       if (isset($_SESSION['mx_lang']))        $data .= ":".$_SESSION['mx_lang'];
-       if (isset($GLOBALS['refid']))          $data .= ":".$GLOBALS['refid'];
+       if (isSessionVariableSet('u_hash'))                     $data .= ":".get_session('u_hash');
+       if (isset($GLOBALS['userid']))                          $data .= ":".$GLOBALS['userid'];
+       if (isSessionVariableSet('lifetime'))           $data .= ":".get_session('lifetime');
+       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 + _ADD - 1;
@@ -1242,7 +1206,7 @@ function GEN_RANDOM_CODE($length, $code, $uid, $DATA="")
        if ($len == 0) $len = 10;
 
        // Cut off requested counts of number
-       $return = substr(str_replace('.', '', $rcode), 0, $len);
+       $return = substr(str_replace('.', "", $rcode), 0, $len);
 
        // Done building code
        return $return;
@@ -1715,7 +1679,7 @@ function MXCHANGE_OPEN($script) {
 
        // Read response
        while(!feof($fp)) {
-               $response[] = fgets($fp, 1024);
+               $response[] = trim(fgets($fp, 1024));
        }
 
        // Close socket
@@ -1974,7 +1938,7 @@ function ADD_URL_DATA($URL)
                if ((!empty($_GET['refid'])) && (strpos($URL, "refid=") == 0)) {
                        // Cookie found in URL
                        $ADD .= $BIND."refid=".bigintval($_GET['refid']);
-               } elseif ((GET_EXT_VERSION("sql_patches") != "") && ($_CONFIG['def_refid'] > 0)) {
+               } elseif ((GET_EXT_VERSION("sql_patches") != '') && ($_CONFIG['def_refid'] > 0)) {
                        // Not found! So let's set default here
                        $ADD .= $BIND."refid=".$_CONFIG['def_refid'];
                }
@@ -1998,7 +1962,9 @@ function ADD_URL_DATA($URL)
 //
 function generatePassString($passHash) {
        global $_CONFIG;
-       $ret = "*FAILED*";
+
+       // Return vanilla password hash
+       $ret = $passHash;
 
        // Is a secret key and master salt already initialized?
        if ((!empty($_CONFIG['secret_key'])) && (!empty($_CONFIG['master_salt']))) {
@@ -2019,6 +1985,7 @@ function generatePassString($passHash) {
                        $start += 4;
                        $newHash .= $mod;
                }
+
                //* DEBUG: */ die($passHash."<br>".$newHash." (".strlen($newHash).")");
                $ret = generateHash($newHash, $_CONFIG['master_salt']);
        }
@@ -2033,8 +2000,8 @@ function FIX_DELETED_COOKIES ($cookies) {
                // Then check all cookies if they are marked as deleted!
                foreach ($cookies as $cookieName) {
                        // Is the cookie set to "deleted"?
-                       if ((isset($_SESSION[$cookieName])) && ($_SESSION[$cookieName] == "deleted")) {
-                               unset($_SESSION[$cookieName]);
+                       if (get_session($cookieName) == "deleted") {
+                               set_session($cookieName, "");
                        }
                }
        }
@@ -2079,7 +2046,7 @@ function DISPLAY_PARSING_TIME_FOOTER() {
        );
 
        // Load the template
-       LOAD_TEMPLATE("footer_stats", false, $content);
+       LOAD_TEMPLATE("show_timings", false, $content);
 }
 
 // Unset/set session variables
@@ -2092,12 +2059,12 @@ function set_session ($var, $value) {
        $var = trim(SQL_ESCAPE($var)); $value = trim($value);
 
        // Is the session variable set?
-       if (("".$value."" == "") && (isset($_SESSION[$var]))) {
+       if (("".$value."" == "") && (isSessionVariableSet($var))) {
                // Remove the session
-               //* DEBUG: */ echo "UNSET:".$var."=".$_SESSION[$var]."<br />\n";
+               //* DEBUG: */ echo "UNSET:".$var."=".get_session($var)."<br />\n";
                unset($_SESSION[$var]);
                return session_unregister($var);
-       } elseif (("".$value."" != "") && (!isset($_SESSION[$var]))) {
+       } elseif (("".$value."" != '') && (!isSessionVariableSet($var))) {
                // Set session
                //* DEBUG: */ echo "SET:".$var."=".$value."<br />\n";
                $_SESSION[$var] =  $value;
@@ -2109,6 +2076,35 @@ function set_session ($var, $value) {
        //* DEBUG: */ echo "IGNORED:".$var."=".$value."<br />\n";
        return true;
 }
+// Check wether a boolean constant is set
+// Taken from user comments in PHP documentation for function constant()
+function isBooleanConstantAndTrue($constname) { // : Boolean
+       $res = false;
+       if (defined($constname)) $res = (constant($constname) === true);
+       return($res);
+}
+
+// Check wether a session variable is set
+function isSessionVariableSet($var) {
+       return (isset($_SESSION[$var]));
+}
+
+// Returns wether the value of the session variable or NULL if not set
+function get_session($var) {
+       if (!isset($_SESSION)) session_start();
+
+       // Default is not found! ;-)
+       $value = null;
+
+       // Is the variable there?
+       if (isSessionVariableSet($var)) {
+               // Then  get it secured!
+               $value = SQL_ESCAPE($_SESSION[$var]);
+       }
+
+       // Return the value
+       return $value;
+}
 
 //
 //////////////////////////////////////////////