* This contains all messages, including information, error, and just
* about any other message you can think of.
*
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright 1999-2009 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
/**
* Displays error message
*
- * Second argument ($color array) is removed in 1.5.2.
+ * 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) {
- error_box($message);
+function plain_error_message($message, $return_output=FALSE) {
+ return error_box($message, NULL, $return_output);
}
/**
*/
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 = sqm_baseuri();
+ $hide_sm_attributions, $squirrelmail_language, $oTemplate, $base_uri;
- 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 */
+ $temp = array(&$errString, &$errTitle, &$login_link);
+ do_hook('logout_error', $temp);
if ( $errTitle == '' ) {
$errTitle = $errString;
/* If they don't have a logo, don't bother.. */
$logo_str = '';
if (isset($org_logo) && $org_logo) {
- /* 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\"";
+ $width = $org_logo_width;
+ } else {
+ $width = '';
}
if (isset($org_logo_height) && is_numeric($org_logo_height) &&
$org_logo_height>0) {
- $width_and_height .= " height=\"$org_logo_height\"";
+ $height = $org_logo_height;
+ } else {
+ $height = '';
}
-
- $logo_str = '<img src="'.$org_logo.'" ' .
- 'alt="'. sprintf(_("%s Logo"), $org_name).'" ' .
- $width_and_height .
- 'class="sqm_loginImage" ' .
- ' /><br />'."\n";
+
+ $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 Application")."<br />\n" .
- _("By the SquirrelMail Project Team")."<br />\n";
+ $sm_attribute_str = _("SquirrelMail Webmail") . "\n"
+ . _("By the SquirrelMail Project Team");
}
- $login_link = array (
- 'URL' => $base_uri . 'src/login.php',
- 'FRAME' => $frame_top
- );
-
$oTemplate->assign('logo_str', $logo_str);
$oTemplate->assign('sm_attribute_str', $sm_attribute_str);
$oTemplate->assign('login_link', $login_link);
*
* Since 1.4.1 function checks if page header is already displayed.
*
- * Since 1.4.3 and 1.5.1 function contains error_box hook.
+ * 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) {
- global $pageheader_sent, $oTemplate;
+function error_box($string, $link=NULL, $return_output=FALSE) {
+ global $pageheader_sent, $oTemplate, $org_title;
$err = _("ERROR");
- $ret = concat_hook_function('error_box', $string);
- if($ret != '') {
- $string = $ret;
- }
-
- /* check if the page header has been sent; if not, send it! */
- if(!isset($pageheader_sent) && !$pageheader_sent) {
- displayHtmlHeader('SquirrelMail: '.$err);
+ 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>\n\n";
+ echo create_body(); // this is template-safe (see create_body() function)
}
// Double check the link for everything we need
$oTemplate->assign('error', $err);
$oTemplate->assign('errorMessage', $string);
$oTemplate->assign('link', $link);
- $oTemplate->display('error_box.tpl');
+ $output = $oTemplate->fetch('error_box.tpl');
+
+ if ($return_output) return $output;
+ echo $output;
}
/**