X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fdisplay_messages.php;h=0854caba1ff8630232d577cd2ffbfd6d97b1ada6;hp=e021557dee3b8398da02075c5ba0c3d77f8cbaeb;hb=653a7e8738ce74830826c25771c1d8938106da96;hpb=26f9a94a1f7c04666c65f75dce311988df6b6a94

diff --git a/functions/display_messages.php b/functions/display_messages.php
index e021557d..0854caba 100644
--- a/functions/display_messages.php
+++ b/functions/display_messages.php
@@ -3,158 +3,194 @@
 /**
  * display_messages.php
  *
- * Copyright (c) 1999-2003 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-2012 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
  */
 
+
 /**
- * Find out where squirrelmail lives and try to be smart about it.
- * The only problem would be when squirrelmail lives in directories
- * called "src", "functions", or "plugins", but people who do that need
- * to be beaten with a steel pipe anyway.
+ * Displays error message and URL to message listing
  *
- * @return  the base uri of squirrelmail installation.
+ * 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 sqm_baseuri(){
-    global $base_uri, $PHP_SELF;
-    /**
-     * If it is in the session, just return it.
-     */
-    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;
+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. */
-
-    if (!isset($frame_top)) {
-        $frame_top = '_top';
-    }
-    $string = '<TR><TD ALIGN="center">'.
-                 _("Unknown user or password incorrect.") .
-              '</TD></TR><TR><TD ALIGN="center">'.
-	         '<A HREF="' . sqm_baseuri() . '"login.php" TARGET='.
-                    $frame_top.'>' . _("Click here to try again") .
-                    '</A>.'.
-              '</TD></TR>';
-   error_box($string,$color);
-echo  '</BODY></HTML>';
+/**
+ * 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);
 }
 
-function error_message($message, $mailbox, $sort, $startMessage, $color) {
-    $urlMailbox = urlencode($mailbox);
+/**
+ * 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;
+
+    $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);
 
-    $string = '<tr><td ALIGN="center">' . $message . '</td></tr>'."\n".
-               '<tr><td ALIGN="center">'.
-                  '<A HREF="' . sqm_baseuri() 
-                  . "src/right_main.php?sort=$sort&amp;startMessage=$startMessage"
-                  . "&amp;mailbox=$urlMailbox\">" .
-	    sprintf (_("Click here to return to %s"), $mailbox) .
-	    '</A></td></tr>';
-    error_box($string, $color);
-}
+    if ( $errTitle == '' ) {
+        $errTitle = $errString;
+    }
+    set_up_language($squirrelmail_language, true);
 
-function plain_error_message($message, $color) {
-    error_box($message, $color);
-}
+    displayHtmlHeader( $org_name.' - '.$errTitle, '', false );
 
-function logout_error( $errString, $errTitle = '' ) {
-    global $frame_top, $org_logo, $org_name, $org_logo_width, $org_logo_height,
-           $hide_sm_attributions, $version, $squirrelmail_language;
+    /* If they don't have a logo, don't bother.. */
+    $logo_str = '';
+    if (isset($org_logo) && $org_logo) {
 
-    $base_uri = sqm_baseuri();
+        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 = '';
+        }
+
+        $logo_str = create_image($org_logo, sprintf(_("%s Logo"), $org_name),
+                                 $width, $height, '', 'sqm_loginImage');
 
-    include_once( SM_PATH . 'functions/page_header.php' );
-    if ( !isset( $org_logo ) ) {
-        // Don't know yet why, but in some accesses $org_logo is not set.
-        include( SM_PATH . 'config/config.php' );
-    }
-    /* 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\"";
+    
+    $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');
+}
 
-    if ( $errTitle == '' ) {
-        $errTitle = $errString;
+/**
+ * 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)
     }
-    set_up_language($squirrelmail_language, true);
 
-    displayHtmlHeader( $errTitle, '', false );
-
-    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 WIDTH=\"100%\" BORDER=\"0\" BGCOLOR=\"$color[4]\" ALIGN=CENTER>".
-            "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=\"center\">".
-                  "<FONT COLOR=\"$color[2]\"><B>" . _("ERROR") .
-                  '</B></FONT></TD></TR>'.
-            '<TR><TD ALIGN="center">' . $errString . '</TD></TR>'.
-            "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=\"center\">".
-                  "<FONT COLOR=\"$color[2]\"><B>".
-                  '<a href="' . $base_uri . 'src/login.php" target="' .
-                  $frame_top . '">' .
-                  _("Go to the login page") . "</a></B></FONT>".
-            '</TD></TR>'.
-            '</TABLE></td></tr></table></center></body></html>';
+    // 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;
+        }
+    }
+    
+    /** 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;
 }
 
-function error_box($string, $color) {
-   echo '    <table width="100%" cellpadding="1" cellspacing="0" align="center"'.' border="0" bgcolor="'.$color[9].'">';
-   echo '     <tr><td>';
-   echo '       <table width="100%" cellpadding="0" cellspacing="0" align="center" border="0" bgcolor="'.$color[4].'">';
-   echo '        <tr><td ALIGN="center" bgcolor="'.$color[0].'">';
-   echo '           <font color="' . $color[2].'"><b>' . _("ERROR") . ':</b></font>';
-   echo '        </td></tr>';
-   echo '        <tr><td>';
-   echo '            <table cellpadding="1" cellspacing="5" align="center" border="0">';
-   echo '              <tr>' . html_tag( 'td', $string."\n", 'left')
-                    . '</tr>';
-   echo '            </table>';
-   echo '       </table></td></tr>';
-   echo '    </table>';
-   echo '  </td></tr>';
+/**
+ * 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));
 }
-?>