| 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 © 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&startMessage=$startMessage&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 | do_hook('logout_error', $temp=array(&$errString, &$errTitle, &$login_link)); |
| 72 | |
| 73 | if ( $errTitle == '' ) { |
| 74 | $errTitle = $errString; |
| 75 | } |
| 76 | set_up_language($squirrelmail_language, true); |
| 77 | |
| 78 | displayHtmlHeader( $org_name.' - '.$errTitle, '', false ); |
| 79 | |
| 80 | /* If they don't have a logo, don't bother.. */ |
| 81 | $logo_str = ''; |
| 82 | if (isset($org_logo) && $org_logo) { |
| 83 | |
| 84 | if (isset($org_logo_width) && is_numeric($org_logo_width) && |
| 85 | $org_logo_width>0) { |
| 86 | $width = $org_logo_width; |
| 87 | } else { |
| 88 | $width = ''; |
| 89 | } |
| 90 | if (isset($org_logo_height) && is_numeric($org_logo_height) && |
| 91 | $org_logo_height>0) { |
| 92 | $height = $org_logo_height; |
| 93 | } else { |
| 94 | $height = ''; |
| 95 | } |
| 96 | |
| 97 | $logo_str = create_image($org_logo, sprintf(_("%s Logo"), $org_name), |
| 98 | $width, $height, '', 'sqm_loginImage'); |
| 99 | |
| 100 | } |
| 101 | |
| 102 | $sm_attribute_str = ''; |
| 103 | if (isset($hide_sm_attributions) && !$hide_sm_attributions) { |
| 104 | $sm_attribute_str = _("SquirrelMail Webmail Application") . "\n" |
| 105 | . _("By the SquirrelMail Project Team"); |
| 106 | } |
| 107 | |
| 108 | $oTemplate->assign('logo_str', $logo_str); |
| 109 | $oTemplate->assign('sm_attribute_str', $sm_attribute_str); |
| 110 | $oTemplate->assign('login_link', $login_link); |
| 111 | $oTemplate->assign('errorMessage', $errString); |
| 112 | $oTemplate->display('error_logout.tpl'); |
| 113 | |
| 114 | $oTemplate->display('footer.tpl'); |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Displays error message |
| 119 | * |
| 120 | * Since 1.4.1 function checks if page header is already displayed. |
| 121 | * |
| 122 | * Since 1.4.3 and 1.5.1, this function contains the error_box hook. |
| 123 | * Use plain_error_message() and make sure that page header is created, |
| 124 | * if you want compatibility with 1.4.0 and older. |
| 125 | * |
| 126 | * In 1.5.2 second function argument is changed. Older functions used it |
| 127 | * for $color array, new function uses it for optional link data. Function |
| 128 | * will ignore color array and use standard colors instead. |
| 129 | * |
| 130 | * The $return_output argument was added in 1.5.2 |
| 131 | * |
| 132 | * @param string $string Error message to be displayed |
| 133 | * @param array $link Optional array containing link details to be displayed. |
| 134 | * Array uses three keys. 'URL' key is required and should contain link URL. |
| 135 | * 'TEXT' key is optional and should contain link name. 'FRAME' key is |
| 136 | * optional and should contain link target attribute. |
| 137 | * @param boolean $return_output When TRUE, output is returned to caller |
| 138 | * instead of being sent to browser (OPTIONAL; |
| 139 | * default = FALSE) |
| 140 | * |
| 141 | * @since 1.3.2 |
| 142 | */ |
| 143 | function error_box($string, $link=NULL, $return_output=FALSE) { |
| 144 | global $pageheader_sent, $oTemplate, $org_title; |
| 145 | |
| 146 | $err = _("ERROR"); |
| 147 | do_hook('error_box', $string); |
| 148 | if ( !isset($org_title) ) $org_title = 'SquirrelMail'; |
| 149 | |
| 150 | // check if the page header has been sent; if not, send it! |
| 151 | // |
| 152 | // (however, if $return_output is turned on, the output of this |
| 153 | // should be being used in some other page, so we don't have |
| 154 | // to worry about page headers in that case) |
| 155 | // |
| 156 | if (!$return_output && empty($pageheader_sent)) { |
| 157 | displayHtmlHeader($org_title . ': '.$err); |
| 158 | $pageheader_sent = TRUE; |
| 159 | echo create_body(); // this is template-safe (see create_body() function) |
| 160 | } |
| 161 | |
| 162 | // Double check the link for everything we need |
| 163 | if (!is_null($link)) { |
| 164 | // safety check for older code |
| 165 | if (isset($link['URL'])) { |
| 166 | if (!isset($link['FRAME'])) $link['FRAME'] = ''; |
| 167 | if (!isset($link['TEXT'])) $link['TEXT'] = $link['URL']; |
| 168 | } else { |
| 169 | // somebody used older error_box() code |
| 170 | $link=null; |
| 171 | } |
| 172 | } |
| 173 | |
| 174 | /** ERROR is pre-translated to avoid multiple translation calls. **/ |
| 175 | $oTemplate->assign('error', $err); |
| 176 | $oTemplate->assign('errorMessage', $string); |
| 177 | $oTemplate->assign('link', $link); |
| 178 | $output = $oTemplate->fetch('error_box.tpl'); |
| 179 | |
| 180 | if ($return_output) return $output; |
| 181 | echo $output; |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Adds message that informs about non fatal error that can happen while saving preferences |
| 186 | * @param string $message error message |
| 187 | * @since 1.5.1 and 1.4.5 |
| 188 | */ |
| 189 | function error_option_save($message) { |
| 190 | global $optpage_save_error; |
| 191 | |
| 192 | if (! is_array($optpage_save_error) ) |
| 193 | $optpage_save_error=array(); |
| 194 | |
| 195 | $optpage_save_error=array_merge($optpage_save_error,array($message)); |
| 196 | } |