Create template for errors when not logged in.
[squirrelmail.git] / functions / display_messages.php
index 2fe6bd4a6a14dd4d0358fea35cc08acc7a498cda..f0c79f254c31a4fa4a8561f14910f7ebef8edb2e 100644 (file)
 /**
  * display_messages.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * This contains all messages, including information, error, and just
  * about any other message you can think of.
  *
- * $Id$
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
  */
 
-function error_username_password_incorrect() {
-    global $frame_top, $color;
-    /* XXX: Should really not start the HTML before this, or close off more
-       cleanly. */
 
-    if (!isset($frame_top)) {
-        $frame_top = '_top';
-    }
+/**
+ * Displays error message and URL to message listing
+ * @param string $message error message
+ * @param string $mailbox mailbox name
+ * @param integer $sort sort order
+ * @param integer $startMessage first message
+ * @param array $color color theme
+ * @since 1.0
+ */
+function error_message($message, $mailbox, $sort, $startMessage) {
+    $urlMailbox = urlencode($mailbox);
+    $link = array   (
+                        'URL'   => sqm_baseuri()."src/right_main.php?sort=$sort&startMessage=$startMessage&mailbox=$urlMailbox",
+                        'TEXT'  => sprintf (_("Click here to return to %s"), strtoupper($mailbox) == 'INBOX' ? _("INBOX") : imap_utf7_decode_local($mailbox)) 
+                    );
+    error_box($message, $link);
+}
 
-    echo '<BR>'.
-                '<TABLE COLS=1 WIDTH="75%" BORDER="0" BGCOLOR="' . $color[4] . '" ALIGN=CENTER>'.
-                '<TR BGCOLOR="' . $color[0] . '">'.
-                    '<TH>' . _("ERROR") . '</TH>'.
-                '</TR>' .
-                '<TR><TD>'.
-                    '<CENTER><BR>' . _("Unknown user or password incorrect.") .
-                    '<BR><A HREF="login.php" TARGET='.$frame_top.'>' .
-                    _("Click here to try again") .
-                    '</A>.</CENTER>'.
-                '</TD></TR>'.
-                '</TABLE>'.
-            '</BODY></HTML>';
+/**
+ * Displays error message
+ * @param string $message error message
+ * @param array $color color theme
+ * @since 1.0
+ */
+function plain_error_message($message) {
+    error_box($message);
 }
 
-function general_info($motd, $org_logo, $version, $org_name, $color) {
-
-    echo '<BR>'.
-         "<TABLE COLS=1 WIDTH=\"80%\" CELLSPACING=0 CELLPADDING=2 BORDER=\"0\" ALIGN=CENTER><TR><TD BGCOLOR=\"$color[9]\">".
-         '<TABLE COLS=1 WIDTH="100%" CELLSPACING=0 CELLPADDING=3 BORDER="0" BGCOLOR="' .  $color[4] . '" ALIGN=CENTER>'.
-            '<TR>' .
-               "<TD BGCOLOR=\"$color[0]\">" .
-                  '<B><CENTER>';
-    printf (_("Welcome to %s's WebMail system"), $org_name);
-    echo          '</CENTER></B>'.
-            '<TR><TD BGCOLOR="' . $color[4] .  '">'.
-               '<TABLE COLS=2 WIDTH="90%" CELLSPACING=0 CELLPADDING=3 BORDER="0" align="center">'.
-                  '<TR>'.
-                     '<TD BGCOLOR="' . $color[4] .  '"><CENTER>';
-    if ( strlen($org_logo) > 3 ) {
-        echo                "<IMG SRC=\"$org_logo\">";
-    } else {
-        echo                "<B>$org_name</B>";
+/**
+ * Displays error when user is logged out
+ * 
+ * Error strings can be overriden by logout_error hook
+ * @param string $errString error message
+ * @param string $errTitle title of page with error message
+ * @since 1.2.6
+ */
+function logout_error( $errString, $errTitle = '' ) {
+    global $frame_top, $org_logo, $org_logo_width, $org_logo_height, $org_name,
+           $hide_sm_attributions, $squirrelmail_language, $oTemplate;
+
+    $base_uri = sqm_baseuri();
+
+    list($junk, $errString, $errTitle) = do_hook('logout_error', $errString, $errTitle);
+
+    if ( $errTitle == '' ) {
+        $errTitle = $errString;
     }
-    echo          '<BR><CENTER>';
-    printf (_("Running SquirrelMail version %s (c) 1999-2001."), $version);
-    echo             '</CENTER><BR>'.
-                     '</CENTER></TD></TR><TR>' .
-                     '<TD BGCOLOR="' . $color[4] .  '">' .
-                         $motd.
-                     '</TD>'.
-                  '</TR>'.
-               '</TABLE>'.
-            '</TD></TR>'.
-         '</TABLE>'.
-         '</TD></TR></TABLE>';
-}
+    set_up_language($squirrelmail_language, true);
 
-function error_message($message, $mailbox, $sort, $startMessage, $color) {
-    $urlMailbox = urlencode($mailbox);
+    displayHtmlHeader( $org_name.' - '.$errTitle, '', false );
+
+    /* If they don't have a logo, don't bother.. */
+    $logo_str = '';
+    if (isset($org_logo) && $org_logo) {
+        /* Display width and height like good little people */
+        $width_and_height = '';
+        if (isset($org_logo_width) && is_numeric($org_logo_width) &&
+         $org_logo_width>0) {
+            $width_and_height = " width=\"$org_logo_width\"";
+        }
+        if (isset($org_logo_height) && is_numeric($org_logo_height) &&
+         $org_logo_height>0) {
+            $width_and_height .= " height=\"$org_logo_height\"";
+        }
+        
+        $logo_str = '<img src="'.$org_logo.'" ' .
+                    'alt="'. sprintf(_("%s Logo"), $org_name).'" ' .
+                    $width_and_height .
+                    'class="sqm_loginImage" ' .
+                    ' /><br />'."\n";
+    }
+    
+    $sm_attribute_str = '';
+    if (isset($hide_sm_attributions) && !$hide_sm_attributions) {
+        $sm_attribute_str = _("SquirrelMail Webmail Application")."<br />\n" .
+                            _("By the SquirrelMail Project Team")."<br />\n";
+    }
 
-    echo '<BR>'.
-         "<TABLE COLS=1 WIDTH=\"70%\" BORDER=\"0\" BGCOLOR=\"$color[4]\" ALIGN=CENTER>".
-            '<TR>'.
-               "<TD BGCOLOR=\"$color[0]\">".
-                  "<FONT COLOR=\"$color[2]\"><B><CENTER>" . _("ERROR") . '</CENTER></B></FONT>'.
-            '</TD></TR><TR><TD>'.
-               "<CENTER><BR>$message<BR>\n".
-               '<BR>'.
-                  "<A HREF=\"right_main.php?sort=$sort&amp;startMessage=$startMessage&amp;mailbox=$urlMailbox\">";
-    printf (_("Click here to return to %s"), $mailbox);
-    echo '</A>.'.
-            '</TD></TR>'.
-         '</TABLE>';
+    $login_link = array (
+                            'URL'   => $base_uri . 'src/login.php',
+                            'FRAME' => $frame_top
+                        );
+                        
+    $oTemplate->assign('logo_str', $logo_str);
+    $oTemplate->assign('sm_attribute_str', $sm_attribute_str);
+    $oTemplate->assign('login_link', $login_link);
+    $oTemplate->assign('errorMessage', $errString);
+    $oTemplate->display('error_logout.tpl');
+
+    $oTemplate->display('footer.tpl');
 }
 
-function plain_error_message($message, $color) {
-    echo '<BR>'.
-         "<TABLE COLS=1 WIDTH=\"70%\" BORDER=\"0\" BGCOLOR=\"$color[4]\" ALIGN=CENTER>".
-            '<TR>'.
-               "<TD BGCOLOR=\"$color[0]\">".
-                  "<FONT COLOR=\"$color[2]\"><B><CENTER>" . _("ERROR") . '</CENTER></B></FONT>'.
-            '</TD></TR><TR><TD>'.
-               "<CENTER><BR>$message".
-               '</CENTER>'.
-            '</TD></TR>'.
-         '</TABLE>';
+/**
+ * Displays error message
+ * 
+ * Since 1.4.1 function checks if page header is already displayed.
+ * Since 1.4.3 and 1.5.1 function contains error_box hook.
+ * Use plain_error_message() and make sure that page header is created,
+ * if you want compatibility with 1.4.0 and older.
+ * @param string $string Error message to be displayed
+ * @param mixed $link Optional array containing link details to be displayed
+ * @since 1.3.2
+ */
+function error_box($string, $link=NULL) {
+    global $pageheader_sent, $oTemplate;
+
+    $err = _("ERROR");
+    $ret = concat_hook_function('error_box', $string);
+    if($ret != '') {
+        $string = $ret;
+    }
+
+    /* check if the page header has been sent; if not, send it! */
+    if(!isset($pageheader_sent) && !$pageheader_sent) {
+        displayHtmlHeader('SquirrelMail: '.$err);
+        $pageheader_sent = TRUE;
+        echo "<body>\n\n";
+    }
+
+    // Double check the link for everything we need
+    if (!is_null($link)) {
+        if (!isset($link['FRAME']))
+            $link['FRAME'] = '';
+        if (!isset($link['TEXT']))
+            $link['TEXT'] = $link['URL'];
+    }
+    
+    /** ERROR is pre-translated to avoid multiple translation calls. **/
+    $oTemplate->assign('error', $err);
+    $oTemplate->assign('errorMessage', $string);
+    $oTemplate->assign('link', $link);
+    $oTemplate->display('error_box.tpl');
 }
 
-?>
+/**
+ * Adds message that informs about non fatal error that can happen while saving preferences
+ * @param string $message error message
+ * @since 1.5.1 and 1.4.5
+ */
+function error_option_save($message) {
+    global $optpage_save_error;
+
+    if (! is_array($optpage_save_error) )
+        $optpage_save_error=array();
+
+    $optpage_save_error=array_merge($optpage_save_error,array($message));
+}