use org_title instead of "SquirrelMail" in error_box
[squirrelmail.git] / functions / display_messages.php
index 1428d0f3d16fa68923a89660a69b04eeaeef3de6..643aeb6df50b0323300501f67acdc86e390e78e8 100644 (file)
-<?
-   /**
-    **  display_messages.php
-    **
-    **  This contains all messages, including information, error, and just
-    **  about any other message you can think of.
-    **
-    **/
-
-    $display_messages_php = true;
-
-    function error_username_password_incorrect($color) {
-      echo "<BR>";
-      echo "<TABLE COLS=1 WIDTH=75% NOBORDER BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-      echo "   <TR>";
-      echo "      <TD BGCOLOR=\"$color[0]\">";
-      echo "         <B><CENTER>ERROR</CENTER></B>";
-      echo "   </TD></TR><TR><TD>";
-      echo "      <CENTER><BR>". _("Unknown user or password incorrect.") ."<BR><A HREF=\"login.php\" TARGET=_top>". _("Click here to try again") ."</A>.</CENTER>";
-      echo "   </TD></TR>";
-      echo "</TABLE>";
-      echo "</BODY></HTML>";
-    }
+<?php
+
+/**
+ * display_messages.php
+ *
+ * This contains all messages, including information, error, and just
+ * about any other message you can think of.
+ *
+ * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ */
+
+
+/**
+ * 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&amp;startMessage=$startMessage&amp;mailbox=$urlMailbox",
+        'TEXT'  => sprintf (_("Click here to return to %s"),
+                            strtoupper($mailbox) == 'INBOX' ? _("INBOX") : htmlspecialchars(imap_utf7_decode_local($mailbox))) 
+                   );
+    error_box($message, $link);
+}
+
+/**
+ * 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);
+}
+
+/**
+ * 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;
 
-    function general_info($motd, $org_logo, $version, $org_name, $color) {
-      echo "<BR>";
-      echo "<TABLE COLS=1 WIDTH=80% CELLSPACING=0 CELLPADDING=2 NOBORDER ALIGN=CENTER><TR><TD BGCOLOR=\"$color[9]\">";
-      echo "<TABLE COLS=1 WIDTH=100% CELLSPACING=0 CELLPADDING=3 NOBORDER BGCOLOR=\"FFFFFF\" ALIGN=CENTER>";
-      echo "   <TR>";
-      echo "      <TD BGCOLOR=\"$color[0]\">";
-      echo "         <B><CENTER>". _("Welcome to $org_name's WebMail system") ."</CENTER></B>";
-      echo "   <TR><TD BGCOLOR=\"FFFFFF\">";
-      echo "      <TABLE COLS=2 WIDTH=90% CELLSPACING=0 CELLPADDING=3 NOBORDER align=\"center\">";
-      echo "         <TR>";
-      echo "            <TD BGCOLOR=\"FFFFFF\"><CENTER>";
-      if (strlen($org_logo) > 3)
-         echo "               <IMG SRC=\"$org_logo\">";
-      else
-         echo "               <B>$org_name</B>";
-      echo "         <BR><CENTER>". _("Running SquirrelMail version $version (c) 1999-2000.") ."</CENTER><BR>";
-      echo "            </CENTER></TD></TR><TR>";
-      echo "            <TD BGCOLOR=\"FFFFFF\">";
-      echo "               $motd";
-      echo "            </TD>";
-      echo "         </TR>";
-      echo "      </TABLE>";
-      echo "   </TD></TR>";
-      echo "</TABLE>";
-      echo "</TD></TR></TABLE>";
-   }
-
-    function messages_deleted_message($mailbox, $sort, $startMessage, $color) {
-      $urlMailbox = urlencode($mailbox);
-      echo "<BR>";
-      echo "<TABLE COLS=1 WIDTH=70% NOBORDER BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-      echo "   <TR>";
-      echo "      <TD BGCOLOR=\"$color[0]\">";
-      echo "         <B><CENTER>". _("Messages Deleted") ."</CENTER></B>";
-      echo "   </TD></TR><TR><TD>";
-      echo "      <CENTER><BR>". _("The selected messages were deleted successfully.") ."<BR>\n";
-      echo "      <BR>";
-      echo "              <A HREF=\"webmail.php?right_frame=right_main.php&sort=$sort&startMessage=$startMessage&mailbox=$urlMailbox\" TARGET=_top>";
-      echo "              ". _("Click here to return to ") ."$mailbox</A>.";
-      echo "      </CENTER>";
-      echo "   </TD></TR>";
-      echo "</TABLE>";
+    $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 */
+    do_hook('logout_error', $temp=array(&$errString, &$errTitle, &$login_link));
+
+    if ( $errTitle == '' ) {
+        $errTitle = $errString;
     }
+    set_up_language($squirrelmail_language, true);
+
+    displayHtmlHeader( $org_name.' - '.$errTitle, '', false );
+
+    /* If they don't have a logo, don't bother.. */
+    $logo_str = '';
+    if (isset($org_logo) && $org_logo) {
+
+        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 messages_moved_message($mailbox, $sort, $startMessage, $color) {
-      $urlMailbox = urlencode($mailbox);
-      echo "<BR>";
-      echo "<TABLE COLS=1 WIDTH=70% NOBORDER BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-      echo "   <TR>";
-      echo "      <TD BGCOLOR=\"$color[0]\">";
-      echo "         <B><CENTER>". _("Messages Moved") ."</CENTER></B>";
-      echo "   </TD></TR><TR><TD>";
-      echo "      <CENTER><BR>". _("The selected messages were moved successfully.") ."<BR>\n";
-      echo "      <BR>";
-      echo "              <A HREF=\"webmail.php?right_frame=right_main.php&sort=$sort&startMessage=$startMessage&mailbox=$urlMailbox\" TARGET=_top>";
-      echo "              ". _("Click here to return to ") ."$mailbox</A>.";
-      echo "      </CENTER>";
-      echo "   </TD></TR>";
-      echo "</TABLE>";
+        $logo_str = create_image($org_logo, sprintf(_("%s Logo"), $org_name),
+                                 $width, $height, '', 'sqm_loginImage');
+
+    }
+    
+    $sm_attribute_str = '';
+    if (isset($hide_sm_attributions) && !$hide_sm_attributions) {
+        $sm_attribute_str = _("SquirrelMail Webmail Application") . "\n" 
+                          . _("By the SquirrelMail Project Team");
     }
 
-    function error_message($message, $mailbox, $sort, $startMessage, $color) {
-      $urlMailbox = urlencode($mailbox);
-      echo "<BR>";
-      echo "<TABLE COLS=1 WIDTH=70% NOBORDER BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-      echo "   <TR>";
-      echo "      <TD BGCOLOR=\"$color[0]\">";
-      echo "         <FONT COLOR=\"$color[2]\"><B><CENTER>". _("ERROR") ."</CENTER></B></FONT>";
-      echo "   </TD></TR><TR><TD>";
-      echo "      <CENTER><BR>$message<BR>\n";
-      echo "      <BR>";
-      echo "              <A HREF=\"webmail.php?right_frame=right_main.php&sort=$sort&startMessage=$startMessage&mailbox=$urlMailbox\" TARGET=_top>";
-      echo "              ". _("Click here to return to ") ."$mailbox</A>.";
-      echo "      </CENTER>";
-      echo "   </TD></TR>";
-      echo "</TABLE>";
+    $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');
+}
+
+/**
+ * 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)
     }
 
-    function plain_error_message($message, $color) {
-      echo "<BR>";
-      echo "<TABLE COLS=1 WIDTH=70% NOBORDER BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-      echo "   <TR>";
-      echo "      <TD BGCOLOR=\"$color[0]\">";
-      echo "         <FONT COLOR=\"$color[2]\"><B><CENTER>" . _("ERROR") . "</CENTER></B></FONT>";
-      echo "   </TD></TR><TR><TD>";
-      echo "      <CENTER><BR>$message";
-      echo "      </CENTER>";
-      echo "   </TD></TR>";
-      echo "</TABLE>";
+    // 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;
+}
+
+/**
+ * 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));
+}