X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fdisplay_messages.php;h=5ef7941ae256927d39c1e0c5e621148109d0e312;hp=29e1c16ecb40a8c44a3ba89a3ffe9e1f57cc8419;hb=fbf11cec94461e2ba1a9f62c7c4b80f70b4e7c07;hpb=399846eafde629feb72e20d8a2b1d24d247da183

diff --git a/functions/display_messages.php b/functions/display_messages.php
index 29e1c16e..5ef7941a 100644
--- a/functions/display_messages.php
+++ b/functions/display_messages.php
@@ -3,181 +3,195 @@
 /**
  * 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-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
  */
 
-function sqm_baseuri(){
-    global $base_uri, $PHP_SELF;
-    if (isset($base_uri)){
-        return $base_uri;
-    }
-    $dirs = array("|src/.*|", "|plugins/.*|", "|functions/.*|");
-    $repl = array("", "", "");
-    $base_uri = preg_replace($dirs, $repl, $PHP_SELF);
-    return $base_uri;
+
+/**
+ * Displays error message and URL to message listing
+ *
+ * Fifth argument ($color array) is removed in 1.5.2.
+ * @param string $message error message
+ * @param string $mailbox mailbox name
+ * @param integer $sort sort order
+ * @param integer $startMessage first message
+ * @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") : htmlspecialchars(imap_utf7_decode_local($mailbox))) 
+                   );
+    error_box($message, $link);
 }
 
-function error_username_password_incorrect() {
-    global $frame_top, $color;
-    /* XXX: Should really not start the HTML before this, or close off more
-       cleanly. */
+/**
+ * Displays error message
+ * 
+ * Second argument ($color array) is changed to boolean $return_output as of 1.5.2.
+ * @param string $message error message
+ * @param boolean $return_output When TRUE, output is returned to caller
+ *                               instead of being sent to browser (OPTIONAL;
+ *                               default = FALSE)
+ * @since 1.0
+ */
+function plain_error_message($message, $return_output=FALSE) {
+    return error_box($message, NULL, $return_output);
+}
 
-    if (!isset($frame_top)) {
-        $frame_top = '_top';
-    }
+/**
+ * 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;
 
-    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="' . sqm_baseuri() . '"login.php" TARGET='.
-                    $frame_top.'>' . _("Click here to try again") .
-                    '</A>.</CENTER>'.
-                '</TD></TR>'.
-                '</TABLE>'.
-            '</BODY></HTML>';
-}
+    $base_uri = sqm_baseuri();
+
+    $login_link = array (
+                            'URI'   => $base_uri . 'src/login.php',
+                            'FRAME' => $frame_top
+                        );
+                        
+    /* As of 1.5.2, plugin parameters are combined into one array; 
+       plugins on this hook must be updated */
+    $temp = array(&$errString, &$errTitle, &$login_link);
+    do_hook('logout_error', $temp);
 
-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>";
+    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 );
 
-    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=\"" . sqm_baseuri() 
-                  . "right_main.php?sort=$sort&amp;startMessage=$startMessage"
-                  . "&amp;mailbox=$urlMailbox\">";
-    printf (_("Click here to return to %s"), $mailbox);
-    echo '</A>.'.
-            '</TD></TR>'.
-         '</TABLE>';
-}
+    /* If they don't have a logo, don't bother.. */
+    $logo_str = '';
+    if (isset($org_logo) && $org_logo) {
 
-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>';
-}
+        if (isset($org_logo_width) && is_numeric($org_logo_width) &&
+         $org_logo_width>0) {
+            $width = $org_logo_width;
+        } else {
+            $width = '';
+        }
+        if (isset($org_logo_height) && is_numeric($org_logo_height) &&
+         $org_logo_height>0) {
+            $height = $org_logo_height;
+        } else {
+            $height = '';
+        }
 
-function logout_error( $errString, $errTitle = '' ) {
+        $logo_str = create_image($org_logo, sprintf(_("%s Logo"), $org_name),
+                                 $width, $height, '', 'sqm_loginImage');
 
-    GLOBAL $frame_top, $org_logo, $org_name, $org_logo_width, $org_logo_height,
-           $hide_sm_attributions, $version;
-    $base_uri = sqm_baseuri();
-    include_once($base_uri . 'functions/page_header.php' );
-    if ( !isset( $org_logo ) ) {
-        // Don't know yet why, but in some accesses $org_logo is not set.
-        include( $base_uri . '../config/config.php' );
     }
-    /* Display width and height like good little people */
-    $width_and_height = '';
-    if (isset($org_logo_width) && is_int($org_logo_width) && $org_logo_width>0) {
-        $width_and_height = " WIDTH=\"$org_logo_width\"";
-    }
-    if (isset($org_logo_height) && is_int($org_logo_height) && $org_logo_height>0) {
-        $width_and_height .= " HEIGHT=\"$org_logo_height\"";
+    
+    $sm_attribute_str = '';
+    if (isset($hide_sm_attributions) && !$hide_sm_attributions) {
+        $sm_attribute_str = _("SquirrelMail Webmail") . "\n" 
+                          . _("By the SquirrelMail Project Team");
     }
 
-    if (!isset($frame_top) || $frame_top == '' ) {
-        $frame_top = '_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');
 
-    if ( !isset( $color ) ) {
-        $color = array();
-        $color[0]  = '#DCDCDC';  /* light gray    TitleBar               */
-        $color[1]  = '#800000';  /* red                                  */
-        $color[2]  = '#CC0000';  /* light red     Warning/Error Messages */
-        $color[3]  = '#A0B8C8';  /* green-blue    Left Bar Background    */
-        $color[4]  = '#FFFFFF';  /* white         Normal Background      */
-        $color[5]  = '#FFFFCC';  /* light yellow  Table Headers          */
-        $color[6]  = '#000000';  /* black         Text on left bar       */
-        $color[7]  = '#0000CC';  /* blue          Links                  */
-        $color[8]  = '#000000';  /* black         Normal text            */
-        $color[9]  = '#ABABAB';  /* mid-gray      Darker version of #0   */
-        $color[10] = '#666666';  /* dark gray     Darker version of #9   */
-        $color[11] = '#770000';  /* dark red      Special Folders color  */
-        $color[12] = '#EDEDED';
-        $color[15] = '#002266';  /* (dark blue)      Unselectable folders */
+    $oTemplate->display('footer.tpl');
+}
+
+/**
+ * Displays error message
+ * 
+ * Since 1.4.1 function checks if page header is already displayed.
+ * 
+ * Since 1.4.3 and 1.5.1, this function contains the 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.
+ *
+ * In 1.5.2 second function argument is changed. Older functions used it
+ * for $color array, new function uses it for optional link data. Function 
+ * will ignore color array and use standard colors instead.
+ *
+ * The $return_output argument was added in 1.5.2
+ *
+ * @param string $string Error message to be displayed
+ * @param array $link Optional array containing link details to be displayed.
+ *  Array uses three keys. 'URL' key is required and should contain link URL.
+ *  'TEXT' key is optional and should contain link name. 'FRAME' key is 
+ *  optional and should contain link target attribute.
+ * @param boolean $return_output When TRUE, output is returned to caller
+ *                               instead of being sent to browser (OPTIONAL;
+ *                               default = FALSE)
+ *
+ * @since 1.3.2
+ */
+function error_box($string, $link=NULL, $return_output=FALSE) {
+    global $pageheader_sent, $oTemplate, $org_title;
+
+    $err = _("ERROR");
+    do_hook('error_box', $string);
+    if ( !isset($org_title) ) $org_title = 'SquirrelMail';
+
+    // check if the page header has been sent; if not, send it!
+    //
+    // (however, if $return_output is turned on, the output of this
+    // should be being used in some other page, so we don't have
+    // to worry about page headers in that case)
+    //
+    if (!$return_output && empty($pageheader_sent)) {
+        displayHtmlHeader($org_title . ': '.$err);
+        $pageheader_sent = TRUE;
+        echo create_body();  // this is template-safe (see create_body() function)
     }
 
-    if ( $errTitle == '' ) {
-        $errTitle = $errString;
+    // Double check the link for everything we need
+    if (!is_null($link)) {
+        // safety check for older code
+        if (isset($link['URL'])) {
+            if (!isset($link['FRAME'])) $link['FRAME'] = '';
+            if (!isset($link['TEXT'])) $link['TEXT'] = $link['URL'];
+        } else {
+            // somebody used older error_box() code
+            $link=null;
+        }
     }
-    set_up_language($squirrelmail_language, true);
-    displayHtmlHeader( $errTitle );
     
-    echo "<BODY TEXT=\"$color[8]\" BGCOLOR=\"$color[4]\" LINK=\"$color[7]\" VLINK=\"$color[7]\" ALINK=\"$color[7]\">\n\n" .
-         '<CENTER>'.
-         "<IMG SRC=\"$org_logo\" ALT=\"" . sprintf(_("%s Logo"), $org_name) .
-            "\"$width_and_height><BR>\n".
-         ( $hide_sm_attributions ? '' :
-           '<SMALL>' . sprintf (_("SquirrelMail version %s"), $version) . "<BR>\n".
-           '  ' . _("By the SquirrelMail Development Team") . "<BR></SMALL>\n" ) .
-         "<table cellspacing=1 cellpadding=0 bgcolor=\"$color[1]\" width=\"70%\"><tr><td>".
-         "<TABLE COLS=1 WIDTH=\"100%\" 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>' . $errString . '</CENTER></TD></TR>'.
-            "<TR><TD BGCOLOR=\"$color[0]\">".
-                  "<FONT COLOR=\"$color[2]\"><B><CENTER>".
-                  '<a href="' . $base_uri . '" target="' . $frame_top . '">' .
-                  _("Go to the login page") . "</a></CENTER></B></FONT>".
-            '</TD></TR>'.
-         '</TABLE></td></tr></table></body></html>';
+    /** ERROR is pre-translated to avoid multiple translation calls. **/
+    $oTemplate->assign('error', $err);
+    $oTemplate->assign('errorMessage', $string);
+    $oTemplate->assign('link', $link);
+    $output = $oTemplate->fetch('error_box.tpl');
+
+    if ($return_output) return $output;
+    echo $output;
 }
 
-?>
\ No newline at end of file
+/**
+ * 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));
+}