/**
* display_messages.php
*
- * Copyright (c) 1999-2005 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.
*
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
*/
-/**
- * including plugin functions
- */
-require_once(SM_PATH . 'functions/plugin.php');
/**
- * 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.
+ * Displays error message and URL to message listing
*
- * @return string the base uri of SquirrelMail installation.
+ * 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 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;
-}
-
-function error_message($message, $mailbox, $sort, $startMessage, $color) {
+function error_message($message, $mailbox, $sort, $startMessage) {
$urlMailbox = urlencode($mailbox);
- $string = '<tr><td align="center">' . $message . '</td></tr>'.
- '<tr><td align="center">'.
- '<a href="'.sqm_baseuri()."src/right_main.php?sort=$sort&startMessage=$startMessage&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);
+ $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") : htmlspecialchars(imap_utf7_decode_local($mailbox)))
+ );
+ error_box($message, $link);
}
-function plain_error_message($message, $color) {
- error_box($message, $color);
+/**
+ * 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_name, $org_logo_width, $org_logo_height,
- $hide_sm_attributions, $version, $squirrelmail_language;
+ global $frame_top, $org_logo, $org_logo_width, $org_logo_height, $org_name,
+ $hide_sm_attributions, $squirrelmail_language, $oTemplate;
$base_uri = sqm_baseuri();
- include_once( SM_PATH . 'functions/page_header.php' );
- if ( !isset( $org_logo ) ) {
- // Don't know yet why, but in some accesses $org_logo is not set.
- include( SM_PATH . 'config/config.php' );
- }
- /* 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\"";
- }
- if (isset($org_logo_height) && is_numeric($org_logo_height) && $org_logo_height>0) {
- $width_and_height .= " height=\"$org_logo_height\"";
- }
-
- if (!isset($frame_top) || $frame_top == '' ) {
- $frame_top = '_top';
- }
-
- // Since $color never is set, this is always true
- 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 */
- }
-
- list($junk, $errString, $errTitle) = do_hook('logout_error', $errString, $errTitle);
+ $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 */
+ do_hook('logout_error', $temp=array(&$errString, &$errTitle, &$login_link));
if ( $errTitle == '' ) {
$errTitle = $errString;
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>';
+ /* 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');
- if (isset($org_logo) && ($org_logo != '')) {
- 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 />'.
- _("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>';
-}
-
-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 */
+
+ $sm_attribute_str = '';
+ if (isset($hide_sm_attributions) && !$hide_sm_attributions) {
+ $sm_attribute_str = _("SquirrelMail Webmail Application") . "\n"
+ . _("By the SquirrelMail Project Team");
}
- $err = _("ERROR");
+ $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');
- $ret = concat_hook_function('error_box', $string);
- if($ret != '') {
- $string = $ret;
- }
+ $oTemplate->display('footer.tpl');
+}
- /* check if the page header has been sent; if not, send it! */
- if(!isset($pageheader_sent) && !$pageheader_sent) {
- /* include this just to be sure */
- include_once( SM_PATH . 'functions/page_header.php' );
- displayHtmlHeader('SquirrelMail: '.$err);
+/**
+ * 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 "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\">\n\n";
+ echo create_body(); // this is template-safe (see create_body() function)
}
- 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>';
+ // 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;
+ }
+ }
+
+ /** 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
+ * @since 1.5.1 and 1.4.5
*/
function error_option_save($message) {
global $optpage_save_error;
$optpage_save_error=array_merge($optpage_save_error,array($message));
}
-// vim: et ts=4
-?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff