functions/display_messages.php

   1 <?php
   2
   3 /**
   4  * display_messages.php
   5  *
   6  * This contains all messages, including information, error, and just
   7  * about any other message you can think of.
   8  *
   9  * @copyright &copy; 1999-2007 The SquirrelMail Project Team
  10  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11  * @version $Id$
  12  * @package squirrelmail
  13  */
  14
  15
  16 /**
  17  * Displays error message and URL to message listing
  18  *
  19  * Fifth argument ($color array) is removed in 1.5.2.
  20  * @param string $message error message
  21  * @param string $mailbox mailbox name
  22  * @param integer $sort sort order
  23  * @param integer $startMessage first message
  24  * @since 1.0
  25  */
  26 function error_message($message, $mailbox, $sort, $startMessage) {
  27     $urlMailbox = urlencode($mailbox);
  28     $link = array (
  29         'URL'   => sqm_baseuri()."src/right_main.php?sort=$sort&amp;startMessage=$startMessage&amp;mailbox=$urlMailbox",
  30         'TEXT'  => sprintf (_("Click here to return to %s"),
  31                             strtoupper($mailbox) == 'INBOX' ? _("INBOX") : htmlspecialchars(imap_utf7_decode_local($mailbox)))
  32                    );
  33     error_box($message, $link);
  34 }
  35
  36 /**
  37  * Displays error message
  38  *
  39  * Second argument ($color array) is changed to boolean $return_output as of 1.5.2.
  40  * @param string $message error message
  41  * @param boolean $return_output When TRUE, output is returned to caller
  42  *                               instead of being sent to browser (OPTIONAL;
  43  *                               default = FALSE)
  44  * @since 1.0
  45  */
  46 function plain_error_message($message, $return_output=FALSE) {
  47     return error_box($message, NULL, $return_output);
  48 }
  49
  50 /**
  51  * Displays error when user is logged out
  52  *
  53  * Error strings can be overriden by logout_error hook
  54  * @param string $errString error message
  55  * @param string $errTitle title of page with error message
  56  * @since 1.2.6
  57  */
  58 function logout_error( $errString, $errTitle = '' ) {
  59     global $frame_top, $org_logo, $org_logo_width, $org_logo_height, $org_name,
  60            $hide_sm_attributions, $squirrelmail_language, $oTemplate;
  61
  62     $base_uri = sqm_baseuri();
  63
  64     $login_link = array (
  65                             'URI'   => $base_uri . 'src/login.php',
  66                             'FRAME' => $frame_top
  67                         );
  68
  69     /* As of 1.5.2, plugin parameters are combined into one array;
  70        plugins on this hook must be updated */
  71     $temp = array(&$errString, &$errTitle, &$login_link);
  72     do_hook('logout_error', $temp);
  73
  74     if ( $errTitle == '' ) {
  75         $errTitle = $errString;
  76     }
  77     set_up_language($squirrelmail_language, true);
  78
  79     displayHtmlHeader( $org_name.' - '.$errTitle, '', false );
  80
  81     /* If they don't have a logo, don't bother.. */
  82     $logo_str = '';
  83     if (isset($org_logo) && $org_logo) {
  84
  85         if (isset($org_logo_width) && is_numeric($org_logo_width) &&
  86          $org_logo_width>0) {
  87             $width = $org_logo_width;
  88         } else {
  89             $width = '';
  90         }
  91         if (isset($org_logo_height) && is_numeric($org_logo_height) &&
  92          $org_logo_height>0) {
  93             $height = $org_logo_height;
  94         } else {
  95             $height = '';
  96         }
  97
  98         $logo_str = create_image($org_logo, sprintf(_("%s Logo"), $org_name),
  99                                  $width, $height, '', 'sqm_loginImage');
 100
 101     }
 102
 103     $sm_attribute_str = '';
 104     if (isset($hide_sm_attributions) && !$hide_sm_attributions) {
 105         $sm_attribute_str = _("SquirrelMail Webmail") . "\n"
 106                           . _("By the SquirrelMail Project Team");
 107     }
 108
 109     $oTemplate->assign('logo_str', $logo_str);
 110     $oTemplate->assign('sm_attribute_str', $sm_attribute_str);
 111     $oTemplate->assign('login_link', $login_link);
 112     $oTemplate->assign('errorMessage', $errString);
 113     $oTemplate->display('error_logout.tpl');
 114
 115     $oTemplate->display('footer.tpl');
 116 }
 117
 118 /**
 119  * Displays error message
 120  *
 121  * Since 1.4.1 function checks if page header is already displayed.
 122  *
 123  * Since 1.4.3 and 1.5.1, this function contains the error_box hook.
 124  * Use plain_error_message() and make sure that page header is created,
 125  * if you want compatibility with 1.4.0 and older.
 126  *
 127  * In 1.5.2 second function argument is changed. Older functions used it
 128  * for $color array, new function uses it for optional link data. Function
 129  * will ignore color array and use standard colors instead.
 130  *
 131  * The $return_output argument was added in 1.5.2
 132  *
 133  * @param string $string Error message to be displayed
 134  * @param array $link Optional array containing link details to be displayed.
 135  *  Array uses three keys. 'URL' key is required and should contain link URL.
 136  *  'TEXT' key is optional and should contain link name. 'FRAME' key is
 137  *  optional and should contain link target attribute.
 138  * @param boolean $return_output When TRUE, output is returned to caller
 139  *                               instead of being sent to browser (OPTIONAL;
 140  *                               default = FALSE)
 141  *
 142  * @since 1.3.2
 143  */
 144 function error_box($string, $link=NULL, $return_output=FALSE) {
 145     global $pageheader_sent, $oTemplate, $org_title;
 146
 147     $err = _("ERROR");
 148     do_hook('error_box', $string);
 149     if ( !isset($org_title) ) $org_title = 'SquirrelMail';
 150
 151     // check if the page header has been sent; if not, send it!
 152     //
 153     // (however, if $return_output is turned on, the output of this
 154     // should be being used in some other page, so we don't have
 155     // to worry about page headers in that case)
 156     //
 157     if (!$return_output && empty($pageheader_sent)) {
 158         displayHtmlHeader($org_title . ': '.$err);
 159         $pageheader_sent = TRUE;
 160         echo create_body();  // this is template-safe (see create_body() function)
 161     }
 162
 163     // Double check the link for everything we need
 164     if (!is_null($link)) {
 165         // safety check for older code
 166         if (isset($link['URL'])) {
 167             if (!isset($link['FRAME'])) $link['FRAME'] = '';
 168             if (!isset($link['TEXT'])) $link['TEXT'] = $link['URL'];
 169         } else {
 170             // somebody used older error_box() code
 171             $link=null;
 172         }
 173     }
 174
 175     /** ERROR is pre-translated to avoid multiple translation calls. **/
 176     $oTemplate->assign('error', $err);
 177     $oTemplate->assign('errorMessage', $string);
 178     $oTemplate->assign('link', $link);
 179     $output = $oTemplate->fetch('error_box.tpl');
 180
 181     if ($return_output) return $output;
 182     echo $output;
 183 }
 184
 185 /**
 186  * Adds message that informs about non fatal error that can happen while saving preferences
 187  * @param string $message error message
 188  * @since 1.5.1 and 1.4.5
 189  */
 190 function error_option_save($message) {
 191     global $optpage_save_error;
 192
 193     if (! is_array($optpage_save_error) )
 194         $optpage_save_error=array();
 195
 196     $optpage_save_error=array_merge($optpage_save_error,array($message));
 197 }