Move sqm_baseuri() to strings.php. A file for functions that manipulate strings...
[squirrelmail.git] / functions / display_messages.php
index d0b0f522174d2e6740ff50a01aa55e5d66804c04..37ab2613bceafc371d26872db77d3abc795aad55 100644 (file)
@@ -3,60 +3,65 @@
 /**
  * display_messages.php
  *
- * 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$
+ * @copyright © 1999-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package squirrelmail
  */
 
-require_once(SM_PATH . 'functions/plugin.php');
-
+/** @ignore */
+if (! defined('SM_PATH')) define('SM_PATH','../');
 
 /**
- * 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 string the base uri of squirrelmail installation.
+ * including plugin functions
  */
-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;
-}
+include_once(SM_PATH . 'functions/plugin.php');
 
+/**
+ * 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, $color) {
     $urlMailbox = urlencode($mailbox);
-    $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"), strtoupper($mailbox) == 'INBOX' ? _("INBOX") : imap_utf7_decode_local($mailbox)) .
-           '</A></td></tr>';
+    $string = '<tr><td align="center">' . $message . '</td></tr>'.
+              '<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"),
+                  strtoupper($mailbox) == 'INBOX' ? _("INBOX") : imap_utf7_decode_local($mailbox)).
+              '</a></td></tr>';
     error_box($string, $color);
 }
 
+/**
+ * Displays error message
+ * @param string $message error message
+ * @param array $color color theme
+ * @since 1.0
+ */
 function plain_error_message($message, $color) {
     error_box($message, $color);
 }
 
+/**
+ * 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_name, $org_logo_width, $org_logo_height,
-           $hide_sm_attributions, $version, $squirrelmail_language;
+           $hide_sm_attributions, $version, $squirrelmail_language, 
+           $color, $theme, $theme_default;
 
     $base_uri = sqm_baseuri();
 
@@ -68,23 +73,27 @@ function logout_error( $errString, $errTitle = '' ) {
     /* 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\"";
+        $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\"";
+        $width_and_height .= " height=\"$org_logo_height\"";
     }
 
     if (!isset($frame_top) || $frame_top == '' ) {
         $frame_top = '_top';
     }
 
+    // load default theme if possible
+    if (!isset($color) && @file_exists($theme[$theme_default]['PATH']))
+        @include ($theme[$theme_default]['PATH']);
+
     if ( !isset( $color ) ) {
         $color = array();
-        $color[0]  = '#DCDCDC';  /* light gray    TitleBar               */
+        $color[0]  = '#dcdcdc';  /* light gray    TitleBar               */
         $color[1]  = '#800000';  /* red                                  */
-        $color[2]  = '#CC0000';  /* light red     Warning/Error Messages */
-        $color[4]  = '#FFFFFF';  /* white         Normal Background      */
-        $color[7]  = '#0000CC';  /* blue          Links                  */
+        $color[2]  = '#cc0000';  /* light red     Warning/Error Messages */
+        $color[4]  = '#ffffff';  /* white         Normal Background      */
+        $color[7]  = '#0000cc';  /* blue          Links                  */
         $color[8]  = '#000000';  /* black         Normal text            */
     }
 
@@ -95,36 +104,57 @@ function logout_error( $errString, $errTitle = '' ) {
     }
     set_up_language($squirrelmail_language, true);
 
-    displayHtmlHeader( $errTitle, '', false );
+    displayHtmlHeader( $org_name.' - '.$errTitle, '', false );
 
-    echo "<BODY TEXT=\"$color[8]\" BGCOLOR=\"$color[4]\" LINK=\"$color[7]\" VLINK=\"$color[7]\" ALINK=\"$color[7]\">\n\n" .
-         '<CENTER>';
+    echo '<body text="'.$color[8].'" bgcolor="'.$color[4].'" link="'.$color[7].'" vlink="'.$color[7].'" alink="'.$color[7]."\">\n\n".
+         '<center>';
 
     if (isset($org_logo) && ($org_logo != '')) {
-        echo "<IMG SRC=\"$org_logo\" ALT=\"" . sprintf(_("%s Logo"), $org_name) .
-             "\"$width_and_height><BR>\n";
+        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>".
-         "<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>';
+            '<small>' .  _("SquirrelMail Webmail Application") . '<br />'.
+            _("By the SquirrelMail Project 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>';
 }
 
+/**
+ * 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
+ * @param array $color
+ * @since 1.3.2
+ */
 function error_box($string, $color) {
     global $pageheader_sent;
 
+    if ( !isset( $color ) ) {
+        $color = array();
+        $color[0]  = '#dcdcdc';  /* light gray    TitleBar               */
+        $color[1]  = '#800000';  /* red                                  */
+        $color[2]  = '#cc0000';  /* light red     Warning/Error Messages */
+        $color[4]  = '#ffffff';  /* white         Normal Background      */
+        $color[7]  = '#0000cc';  /* blue          Links                  */
+        $color[8]  = '#000000';  /* black         Normal text            */
+        $color[9]  = '#ababab';  /* mid-gray      Darker version of #0   */
+    }
+
     $err = _("ERROR");
 
     $ret = concat_hook_function('error_box', $string);
@@ -141,19 +171,29 @@ function error_box($string, $color) {
         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>';
+    echo '<table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="'.$color[9].'">'.
+         '<tr><td>'.
+         '<table width="100%" cellpadding="0" cellspacing="0" align="center" border="0" bgcolor="'.$color[4].'">'.
+         '<tr><td align="center" bgcolor="'.$color[0].'">'.
+         '<font color="'.$color[2].'"><b>' . $err . ':</b></font>'.
+         '</td></tr><tr><td>'.
+         '<table cellpadding="1" cellspacing="5" align="center" border="0">'.
+         '<tr>' . html_tag( 'td', $string."\n", 'left') . '</tr></table>'.
+         '</td></tr></table></td></tr></table>';
+}
+
+/**
+ * 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));
 }
+// vim: et ts=4
 ?>