X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fdisplay_messages.php;h=22a6f4d3c2d1cdea7aa710c2e3602a4d286043bb;hp=06e352873e33ff8e0992ea1d0f925baa3e73930c;hb=acb4fcd7e045e250c8028f56ee3d32ef350ed0aa;hpb=7350889b45590aee831ba1150ee94efb95b03992 diff --git a/functions/display_messages.php b/functions/display_messages.php index 06e35287..22a6f4d3 100644 --- a/functions/display_messages.php +++ b/functions/display_messages.php @@ -1,94 +1,196 @@ '. - "". - ''. - "'. - '
". - '
ERROR
'. - '
'. - '

' . _("Unknown user or password incorrect.") . - '
' . - _("Click here to try again") . - '.
'. - '
'. - ''; +/** + * display_messages.php + * + * This contains all messages, including information, error, and just + * about any other message you can think of. + * + * @copyright 1999-2016 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail + */ + +/** + * Displays error message and URL to message listing + * + * Fifth argument ($color array) is removed in 1.5.2. + * @param string $message error message + * @param string $mailbox mailbox name + * @param integer $sort sort order + * @param integer $startMessage first message + * @since 1.0 + */ +function error_message($message, $mailbox, $sort, $startMessage) { + $urlMailbox = urlencode($mailbox); + $link = array ( + 'URL' => sqm_baseuri()."src/right_main.php?sort=$sort&startMessage=$startMessage&mailbox=$urlMailbox", + 'TEXT' => sprintf (_("Click here to return to %s"), + strtoupper($mailbox) == 'INBOX' ? _("INBOX") : sm_encode_html_special_chars(imap_utf7_decode_local($mailbox))) + ); + error_box($message, $link); +} + +/** + * Displays error message + * + * Second argument ($color array) is changed to boolean $return_output as of 1.5.2. + * + * @param string $message error message + * @param boolean $return_output When TRUE, output is returned to caller + * instead of being sent to browser (OPTIONAL; + * default = FALSE) + * @since 1.0 + */ +function plain_error_message($message, $return_output=FALSE) { + return error_box($message, NULL, $return_output); +} + +/** + * 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_logo_width, $org_logo_height, $org_name, + $hide_sm_attributions, $squirrelmail_language, $oTemplate, $base_uri; + + $login_link = array ( + 'URI' => $base_uri . 'src/login.php', + 'FRAME' => $frame_top + ); + + /* As of 1.5.2, plugin parameters are combined into one array; + plugins on this hook must be updated */ + $temp = array(&$errString, &$errTitle, &$login_link); + do_hook('logout_error', $temp); + + if ( $errTitle == '' ) { + $errTitle = $errString; + } + set_up_language($squirrelmail_language, true); + + displayHtmlHeader( $org_name.' - '.$errTitle, '', false ); + + /* If they don't have a logo, don't bother.. */ + $logo_str = ''; + if (isset($org_logo) && $org_logo) { + + if (isset($org_logo_width) && is_numeric($org_logo_width) && + $org_logo_width>0) { + $width = $org_logo_width; + } else { + $width = ''; + } + if (isset($org_logo_height) && is_numeric($org_logo_height) && + $org_logo_height>0) { + $height = $org_logo_height; + } else { + $height = ''; + } + + $logo_str = create_image($org_logo, sprintf(_("%s Logo"), $org_name), + $width, $height, '', 'sqm_loginImage'); + + } + + $sm_attribute_str = ''; + if (isset($hide_sm_attributions) && !$hide_sm_attributions) { + $sm_attribute_str = _("SquirrelMail Webmail") . "\n" + . _("By the SquirrelMail Project Team"); } - function general_info($motd, $org_logo, $version, $org_name, $color) { - echo '
'; - echo "
"; - echo ''; - echo ' '; - echo " '; - echo '
"; - echo '
'; - printf (_("Welcome to %s's WebMail system"), $org_name); - echo '
'; - echo '
'; - echo ' '; - echo ' '; - echo ' '; - echo ' '; - echo ' '; - echo '
'; - if (strlen($org_logo) > 3) - echo " "; - else - echo " $org_name"; - echo '
'; - printf (_("Running SquirrelMail version %s (c) 1999-2000."), $version); - echo '

'; - echo '
'; - echo " $motd"; - echo '
'; - echo '
'; - echo '
'; - } - - function error_message($message, $mailbox, $sort, $startMessage, $color) { - $urlMailbox = urlencode($mailbox); - - echo '
'; - echo ""; - echo ' '; - echo " '; - echo '
"; - echo "
" . _("ERROR") . '
'; - echo '
'; - echo "

$message
\n"; - echo '
'; - echo " "; - printf (_("Click here to return to %s"), $mailbox); - echo '.'; - echo '
'; + $oTemplate->assign('logo_str', $logo_str); + $oTemplate->assign('sm_attribute_str', $sm_attribute_str); + $oTemplate->assign('login_link', $login_link); + $oTemplate->assign('errorMessage', $errString); + $oTemplate->display('error_logout.tpl'); + + $oTemplate->display('footer.tpl'); +} + +/** + * Displays error message + * + * Since 1.4.1 function checks if page header is already displayed. + * + * Since 1.4.3 and 1.5.1, this function contains the 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. + * + * In 1.5.2 second function argument is changed. Older functions used it + * for $color array, new function uses it for optional link data. Function + * will ignore color array and use standard colors instead. + * + * The $return_output argument was added in 1.5.2 + * + * @param string $string Error message to be displayed + * @param array $link Optional array containing link details to be displayed. + * Array uses three keys. 'URL' key is required and should contain link URL. + * 'TEXT' key is optional and should contain link name. 'FRAME' key is + * optional and should contain link target attribute. + * @param boolean $return_output When TRUE, output is returned to caller + * instead of being sent to browser (OPTIONAL; + * default = FALSE) + * + * @since 1.3.2 + */ +function error_box($string, $link=NULL, $return_output=FALSE) { + global $pageheader_sent, $oTemplate, $org_title; + + $err = _("ERROR"); + do_hook('error_box', $string); + if ( !isset($org_title) ) $org_title = 'SquirrelMail'; + + // check if the page header has been sent; if not, send it! + // + // (however, if $return_output is turned on, the output of this + // should be being used in some other page, so we don't have + // to worry about page headers in that case) + // + if (!$return_output && empty($pageheader_sent)) { + displayHtmlHeader($org_title . ': '.$err); + $pageheader_sent = TRUE; + echo create_body(); // this is template-safe (see create_body() function) } - function plain_error_message($message, $color) { - echo '
'; - echo ""; - echo ' '; - echo " '; - echo '
"; - echo "
" . _("ERROR") . '
'; - echo '
'; - echo "

$message"; - echo '
'; - echo '
'; + // Double check the link for everything we need + if (!is_null($link)) { + // safety check for older code + if (isset($link['URL'])) { + if (!isset($link['FRAME'])) $link['FRAME'] = ''; + if (!isset($link['TEXT'])) $link['TEXT'] = $link['URL']; + } else { + // somebody used older error_box() code + $link=null; + } } -?> \ No newline at end of file + + /** ERROR is pre-translated to avoid multiple translation calls. **/ + $oTemplate->assign('error', $err); + $oTemplate->assign('errorMessage', $string); + $oTemplate->assign('link', $link); + $output = $oTemplate->fetch('error_box.tpl'); + + if ($return_output) return $output; + echo $output; +} + +/** + * 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)); +}