6 * This contains all messages, including information, error, and just
7 * about any other message you can think of.
9 * @copyright © 1999-2007 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @package squirrelmail
17 * Displays error message and URL to message listing
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
26 function error_message($message, $mailbox, $sort, $startMessage) {
27 $urlMailbox = urlencode($mailbox);
29 'URL' => sqm_baseuri()."src/right_main.php?sort=$sort&startMessage=$startMessage&mailbox=$urlMailbox",
30 'TEXT' => sprintf (_("Click here to return to %s"),
31 strtoupper($mailbox) == 'INBOX' ?
_("INBOX") : htmlspecialchars(imap_utf7_decode_local($mailbox)))
33 error_box($message, $link);
37 * Displays error message
39 * Second argument ($color array) is removed in 1.5.2.
40 * @param string $message error message
43 function plain_error_message($message) {
48 * Displays error when user is logged out
50 * Error strings can be overriden by logout_error hook
51 * @param string $errString error message
52 * @param string $errTitle title of page with error message
55 function logout_error( $errString, $errTitle = '' ) {
56 global $frame_top, $org_logo, $org_logo_width, $org_logo_height, $org_name,
57 $hide_sm_attributions, $squirrelmail_language, $oTemplate;
59 $base_uri = sqm_baseuri();
62 'URI' => $base_uri . 'src/login.php',
66 /* As of 1.5.2, plugin parameters are combined into one array;
67 plugins on this hook must be updated */
68 do_hook('logout_error', $temp=array(&$errString, &$errTitle, &$login_link));
70 if ( $errTitle == '' ) {
71 $errTitle = $errString;
73 set_up_language($squirrelmail_language, true);
75 displayHtmlHeader( $org_name.' - '.$errTitle, '', false );
77 /* If they don't have a logo, don't bother.. */
79 if (isset($org_logo) && $org_logo) {
81 if (isset($org_logo_width) && is_numeric($org_logo_width) &&
83 $width = $org_logo_width;
87 if (isset($org_logo_height) && is_numeric($org_logo_height) &&
89 $height = $org_logo_height;
94 $logo_str = create_image($org_logo, sprintf(_("%s Logo"), $org_name),
95 $width, $height, '', 'sqm_loginImage');
99 $sm_attribute_str = '';
100 if (isset($hide_sm_attributions) && !$hide_sm_attributions) {
101 $sm_attribute_str = _("SquirrelMail Webmail Application") . "\n"
102 . _("By the SquirrelMail Project Team");
105 $oTemplate->assign('logo_str', $logo_str);
106 $oTemplate->assign('sm_attribute_str', $sm_attribute_str);
107 $oTemplate->assign('login_link', $login_link);
108 $oTemplate->assign('errorMessage', $errString);
109 $oTemplate->display('error_logout.tpl');
111 $oTemplate->display('footer.tpl');
115 * Displays error message
117 * Since 1.4.1 function checks if page header is already displayed.
119 * Since 1.4.3 and 1.5.1, this function contains the error_box hook.
120 * Use plain_error_message() and make sure that page header is created,
121 * if you want compatibility with 1.4.0 and older.
123 * In 1.5.2 second function argument is changed. Older functions used it
124 * for $color array, new function uses it for optional link data. Function
125 * will ignore color array and use standard colors instead.
127 * @param string $string Error message to be displayed
128 * @param array $link Optional array containing link details to be displayed.
129 * Array uses three keys. 'URL' key is required and should contain link URL.
130 * 'TEXT' key is optional and should contain link name. 'FRAME' key is
131 * optional and should contain link target attribute.
135 function error_box($string, $link=NULL) {
136 global $pageheader_sent, $oTemplate;
139 do_hook('error_box', $string);
141 /* check if the page header has been sent; if not, send it! */
142 if (!isset($pageheader_sent) && !$pageheader_sent) {
143 displayHtmlHeader('SquirrelMail: '.$err);
144 $pageheader_sent = TRUE;
148 // Double check the link for everything we need
149 if (!is_null($link)) {
150 // safety check for older code
151 if (isset($link['URL'])) {
152 if (!isset($link['FRAME'])) $link['FRAME'] = '';
153 if (!isset($link['TEXT'])) $link['TEXT'] = $link['URL'];
155 // somebody used older error_box() code
160 /** ERROR is pre-translated to avoid multiple translation calls. **/
161 $oTemplate->assign('error', $err);
162 $oTemplate->assign('errorMessage', $string);
163 $oTemplate->assign('link', $link);
164 $oTemplate->display('error_box.tpl');
168 * Adds message that informs about non fatal error that can happen while saving preferences
169 * @param string $message error message
170 * @since 1.5.1 and 1.4.5
172 function error_option_save($message) {
173 global $optpage_save_error;
175 if (! is_array($optpage_save_error) )
176 $optpage_save_error=array();
178 $optpage_save_error=array_merge($optpage_save_error,array($message));