missing phpdoc declaration
[squirrelmail.git] / functions / display_messages.php
index cce8e1109b95c1f0477630ca4e634e1e608899ff..af92c0e943e27ba2bfac84a66a9fe18ad622e3ef 100644 (file)
@@ -3,22 +3,28 @@
 /**
  * display_messages.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 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$
+ * @package squirrelmail
  */
 
+/**
+ * including plugin functions
+ */
+require_once(SM_PATH . 'functions/plugin.php');
+
 /**
  * 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.
  *
- * @return  the base uri of squirrelmail installation.
+ * @return string the base uri of squirrelmail installation.
  */
 function sqm_baseuri(){
     global $base_uri, $PHP_SELF;
@@ -34,80 +40,20 @@ function sqm_baseuri(){
     return $base_uri;
 }
 
-/**
- * Find out the top REAL path of the squirrelmail installation.
- *
- * @return  the real installation directory of squirrelmail.
- */
-
-function sqm_topdir(){
-    $topdir = '';
-    /**
-     * $levels is just to avoid a potential infinite loop in case
-     * things are REALLY broken. Shouldn't really ever happen.
-     */
-    $levels = 0;
-    while (!(is_dir("$topdir/functions") && is_dir("$topdir/src"))
-           && $levels < 10){
-        $topdir .= '../';
-        $levels++;
-    }
-    return $topdir;
-}
-
-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';
-    }
-
-    echo '<BR>'.
-                '<TABLE COLS=1 WIDTH="75%" BORDER="0" BGCOLOR="' . $color[4] . '" ALIGN=CENTER>'.
-                '<TR BGCOLOR="' . $color[0] . '">'.
-                    '<TH>' . _("ERROR") . '</TH>'.
-                '</TR>' .
-                '<TR><TD ALIGN="center">'.
-                    '<BR>' . _("Unknown user or password incorrect.") .
-                    '<BR><A HREF="' . sqm_baseuri() . '"login.php" TARGET='.
-                    $frame_top.'>' . _("Click here to try again") .
-                    '</A>.'.
-                '</TD></TR>'.
-                '</TABLE>'.
-            '</BODY></HTML>';
-}
-
 function error_message($message, $mailbox, $sort, $startMessage, $color) {
     $urlMailbox = urlencode($mailbox);
-
-    echo '<BR>'.
-         "<TABLE WIDTH=\"70%\" 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">'.
-               "<BR>$message<BR>\n".
-               '<BR>'.
-                  "<A HREF=\"" . sqm_baseuri() 
+    $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\">";
-    printf (_("Click here to return to %s"), $mailbox);
-    echo '</A>.'.
-            '</TD></TR>'.
-         '</TABLE>';
+                  . "&amp;mailbox=$urlMailbox\">" .
+    sprintf (_("Click here to return to %s"), strtoupper($mailbox) == 'INBOX' ? _("INBOX") : imap_utf7_decode_local($mailbox)) .
+           '</A></td></tr>';
+    error_box($string, $color);
 }
 
 function plain_error_message($message, $color) {
-    echo "<br><TABLE WIDTH=\"70%\" 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">'.
-               "<BR>$message".
-            '</TD></TR>'.
-         '</TABLE>';
+    error_box($message, $color);
 }
 
 function logout_error( $errString, $errTitle = '' ) {
@@ -115,18 +61,18 @@ function logout_error( $errString, $errTitle = '' ) {
            $hide_sm_attributions, $version, $squirrelmail_language;
 
     $base_uri = sqm_baseuri();
-    $topdir = sqm_topdir();
-    include_once( "$topdir/functions/page_header.php" );
+
+    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( "$topdir/config/config.php" );
+        include( SM_PATH . '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) {
+    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_int($org_logo_height) && $org_logo_height>0) {
+    if (isset($org_logo_height) && is_numeric($org_logo_height) && $org_logo_height>0) {
         $width_and_height .= " HEIGHT=\"$org_logo_height\"";
     }
 
@@ -139,19 +85,13 @@ function logout_error( $errString, $errTitle = '' ) {
         $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 */
     }
 
+    list($junk, $errString, $errTitle) = do_hook('logout_error', $errString, $errTitle);
+
     if ( $errTitle == '' ) {
         $errTitle = $errString;
     }
@@ -160,10 +100,13 @@ function logout_error( $errString, $errTitle = '' ) {
     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 ? '' :
+         '<CENTER>';
+
+    if (isset($org_logo) && ($org_logo != '')) {
+        echo "<IMG SRC=\"$org_logo\" ALT=\"" . sprintf(_("%s Logo"), $org_name) .
+             "\"$width_and_height><BR>\n";
+    }
+    echo ( $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>".
@@ -181,4 +124,38 @@ function logout_error( $errString, $errTitle = '' ) {
             '</TABLE></td></tr></table></center></body></html>';
 }
 
+function error_box($string, $color) {
+    global $pageheader_sent;
+
+    $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) {
+        /* include this just to be sure */
+        include_once( SM_PATH . 'functions/page_header.php' );
+        displayHtmlHeader('SquirrelMail: '.$err);
+        $pageheader_sent = TRUE;
+        echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\">\n\n";
+    }
+
+   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>' . $err . ':</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 '        </td></tr>';
+   echo '       </table></td></tr>';
+   echo '    </table>';
+}
 ?>