/**
* page_header.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
* Prints the page header (duh)
*
- * $Id$
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
*/
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
-require_once(SM_PATH . 'functions/imap_mailbox.php');
-require_once(SM_PATH . 'functions/global.php');
+/** Include required files from SM */
+include_once(SM_PATH . 'functions/imap_mailbox.php');
-/* Always set up the language before calling these functions */
-function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE ) {
+/**
+ * Output a SquirrelMail page header, from <!doctype> to </head>
+ * Always set up the language before calling these functions.
+ *
+ * Since 1.5.1 function sends http headers. Function should be called
+ * before any output is started.
+ * @param string title the page title, default SquirrelMail.
+ * @param string xtra extra HTML to insert into the header
+ * @param bool do_hook whether to execute hooks, default true
+ * @param bool frames generate html frameset doctype (since 1.5.1)
+ * @return void
+ */
+function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE ) {
+ global $squirrelmail_language, $sTemplateID, $oErrorHandler, $oTemplate;
- if ( !check_php_version(4,1) ) {
- global $_SESSION;
- }
- if (isset($_SESSION['base_uri'])) {
- $base_uri = $_SESSION['base_uri'];
- }
- else {
+ if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
global $base_uri;
}
- global $theme_css, $custom_css;
+ global $theme_css, $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction,
+ $default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize, $chosen_theme;
+
+ /* add no cache headers here */
+//FIXME: should change all header() calls in SM core to use $oTemplate->header()!!
+ $oTemplate->header('Pragma: no-cache'); // http 1.0 (rfc1945)
+ $oTemplate->header('Cache-Control: private, no-cache, no-store'); // http 1.1 (rfc2616)
+
+ $oTemplate->assign('frames', $frames);
+ $oTemplate->assign('lang', $squirrelmail_language);
+
+ $header_tags = '';
+
+ $header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\">\n";
+
+ $used_fontset = (!empty($chosen_fontset) ? $chosen_fontset : $default_fontset);
+ $used_fontsize = (!empty($chosen_fontsize) ? $chosen_fontsize : $default_fontsize);
+ $used_theme = basename((!empty($chosen_theme) ? $chosen_theme : $theme[$theme_default]['PATH']),'.php');
+
+ /**
+ * Stylesheets are loaded in the following order:
+ * 1) All stylesheets provided by the template. Normally, these are
+ * stylsheets in $sTplDir/css/. This is accomplished by calling
+ * $oTemplate->fetch_standard_stylesheet_links().
+ * 2) An optional user-defined stylesheet. This is set in the Display
+ * Preferences.
+ * 3) src/style.php which sets some basic font prefs.
+ * 4) If we are dealing with an RTL language, we load rtl.css from the
+ * template set.
+ **/
+
+ // 1. Stylesheets from the template.
+ $header_tags .= $oTemplate->fetch_standard_stylesheet_links();
+
+ $aUserStyles = array();
+ // 2. Option user-defined stylesheet from preferences.
+// FIXME: the following user pref ("sUserStyle"; rename as necessary) will have to be populated by the display prefs screen from a widget similar to the color themes widget (which it replaces) where its values should be full relative paths (from SM_PATH) to the selected css "themes" (either in template css/alternates dir or SM_PATH/css/alternates dir)
+// FIXME: uhhh, getPref() is not available yet here. (at least on login page) Ugh. Nor has load_prefs been included yet -- how do we fix this?
+// $aUserStyles[] = getPref($data_dir, $username, 'sUserStyle', '');
+ if (!empty($chosen_theme) && substr($chosen_theme, 0, 2) == 'u_') {
+ $aUserStyles[] = substr($chosen_theme, 2) .'default.css';
+ }
- echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">' .
- "\n\n<HTML>\n<HEAD>\n";
+ // 3. src/style.php
+ $aUserStyles[] = $base_uri .'src/style.php?'
+ . (!empty($used_fontset) ? '&fontset='.$used_fontset : '')
+ . (!empty($used_fontsize) ? '&fontsize='.$used_fontsize : '');
+ $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
- if ( !isset( $custom_css ) || $custom_css == 'none' ) {
- if ($theme_css != '') {
- echo "<LINK REL=\"stylesheet\" TYPE=\"text/css\" HREF=\"$theme_css\">";
- }
- } else {
- echo '<LINK REL="stylesheet" TYPE="text/css" HREF="' .
- $base_uri . 'themes/css/'.$custom_css.'">';
+ // 4. Optional rtl.css stylesheet
+ if ($text_direction == 'rtl') {
+ $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
+ }
+
+ if ($squirrelmail_language == 'ja_JP') {
+ /*
+ * force correct detection of charset, when browser does not follow
+ * http content-type and tries to detect charset from page content.
+ * Shooting of browser's creator can't be implemented in php.
+ * We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
+ * recommendations and switch to unicode.
+ */
+ $header_tags .= "<!-- \xfd\xfe -->\n";
+ $header_tags .= '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
}
-
if ($do_hook) {
- do_hook("generic_header");
+ // NOTE! plugins here must assign output to template
+ // and NOT echo anything directly!!
+ do_hook('generic_header');
}
-
- echo "\n<title>$title</title>$xtra\n";
+
+ $header_tags .= $xtra;
+ $oTemplate->assign('page_title', $title);
/* work around IE6's scrollbar bug */
- echo <<<ECHO
+ $header_tags .= <<<EOS
+<!--[if IE 6]>
<style type="text/css">
-<!--
- /* avoid stupid IE6 bug with frames and scrollbars */
- body {
- voice-family: "\"}\"";
- voice-family: inherit;
- width: expression(document.documentElement.clientWidth - 30);
- }
--->
+/* avoid stupid IE6 bug with frames and scrollbars */
+body {
+ width: expression(document.documentElement.clientWidth - 30);
+}
</style>
+<![endif]-->
-ECHO;
-
- echo "\n</head>\n\n";
-}
+EOS;
+ $oTemplate->assign('header_tags', $header_tags);
+ $oTemplate->display('protocol_header.tpl');
-function displayInternalLink($path, $text, $target='') {
- if ( !check_php_version(4,1) ) {
- global $_SESSION;
+ /* this is used to check elsewhere whether we should call this function */
+ $pageheader_sent = TRUE;
+ if (isset($oErrorHandler)) {
+ $oErrorHandler->HeaderSent();
}
- $base_uri = $_SESSION['base_uri'];
+}
+
+/**
+ * Given a path to a SquirrelMail file, return a HTML link to it
+ *
+ * @param string path the SquirrelMail file to link to
+ * @param string text the link text
+ * @param string target the target frame for this link
+ */
+function makeInternalLink($path, $text, $target='') {
+ global $base_uri;
+// sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
if ($target != '') {
$target = " target=\"$target\"";
}
- echo '<a href="'.$base_uri.$path.'"'.$target.'>'.$text.'</a>';
+
+ // This is an inefficient hook and is only used by
+ // one plugin that still needs to patch this code,
+ // plus if we are templat-izing SM, visual hooks
+ // are not needed. However, I am leaving the code
+ // here just in case we find a good (non-visual?)
+ // use for the internal_link hook.
+ //
+ //$hooktext = do_hook_function('internal_link',$text);
+ //if ($hooktext != '')
+ // $text = $hooktext;
+
+ return '<a href="'.$base_uri.$path.'"'.$target.'>'.$text.'</a>';
+}
+
+/**
+ * Same as makeInternalLink, but echoes it too
+ */
+function displayInternalLink($path, $text, $target='') {
+// FIXME: should let the template echo all these kinds of things
+ echo makeInternalLink($path, $text, $target);
}
-function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
+/**
+ * Outputs a complete SquirrelMail page header, starting with <!doctype> and
+ * including the default menu bar. Uses displayHtmlHeader and takes
+ * JavaScript and locale settings into account.
+ *
+ * @param array color the array of theme colors
+ * @param string mailbox the current mailbox name to display
+ * @param string sHeaderJs javascipt code to be inserted in a script block in the header
+ * @param string sBodyTagJs js events to be inserted in the body tag
+ * @return void
+ */
- global $hide_sm_attributions, $PHP_SELF, $frame_top,
- $compose_new_win, $username, $datadir, $compose_width, $compose_height,
- $attachemessages, $provider_name, $provider_uri;
+function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
- if ( !check_php_version(4,1) ) {
- global $_SESSION;
- }
+ global $reply_focus, $hide_sm_attributions, $frame_top,
+ $provider_name, $provider_uri, $startMessage,
+ $javascript_on, $action, $oTemplate;
- $base_uri = $_SESSION['base_uri'];
- $delimiter = $_SESSION['delimiter'];
- $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
- if ($qmark = strpos($module, '?')) {
- $module = substr($module, 0, $qmark);
+ if (empty($sBodyTagJs)) {
+ if (strpos($action, 'reply') !== FALSE && $reply_focus) {
+ if ($reply_focus == 'select')
+ $sBodyTagJs = 'onload="checkForm(\'select\');"';
+ else if ($reply_focus == 'focus')
+ $sBodyTagJs = 'onload="checkForm(\'focus\');"';
+ else if ($reply_focus != 'none')
+ $sBodyTagJs = 'onload="checkForm();"';
+ }
+ else
+ $sBodyTagJs = 'onload="checkForm();"';
}
+
+ $urlMailbox = urlencode($mailbox);
+ $startMessage = (int)$startMessage;
+
+ sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
+
if (!isset($frame_top)) {
$frame_top = '_top';
}
- if ($session) {
- $compose_uri = $base_uri.'src/compose.php?mailbox='. urlencode($mailbox).'&attachedmessages=true&session='."$session";
+ if( $javascript_on || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
+ $js_includes = $oTemplate->get_javascript_includes(TRUE);
+ $sJsBlock = '';
+ foreach ($js_includes as $js_file) {
+ $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
+ }
+ if ($sHeaderJs) {
+ $sJsBlock .= "\n<script type=\"text/javascript\">" .
+ "\n<!--\n" .
+ $sHeaderJs . "\n\n// -->\n</script>\n";
+ }
+ displayHtmlHeader ('SquirrelMail', $sJsBlock);
} else {
- $compose_uri = $base_uri.'src/compose.php?newmessage=1';
- $session = 0;
- }
-
- switch ( $module ) {
- case 'src/read_body.php':
- $js ='';
- if ($compose_new_win == '1') {
- if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
- $compose_width = '640';
- }
- if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
- $compose_height = '550';
- }
- $js .= "\n".'<script language="JavaScript" type="text/javascript">' .
- "\n<!--\n";
- $js .= "function comp_in_new(comp_uri) {\n".
- " if (!comp_uri) {\n".
- ' comp_uri = "'.$compose_uri."\";\n".
- ' }'. "\n".
- ' var newwin = window.open(comp_uri' .
- ', "_blank",'.
- '"width='.$compose_width. ',height='.$compose_height.
- ',scrollbars=yes,resizable=yes");'."\n".
- "}\n\n";
-
-
- $js .= 'function sendMDN() {'."\n".
- "mdnuri=window.location+'&sendreceipt=1';".
- "var newwin = window.open(mdnuri,'right');".
- "\n}\n\n";
-
- $js .= "// -->\n".
- "</script>\n";
-
- }
- displayHtmlHeader ('SquirrelMail', $js);
- $onload = $xtra;
- break;
- case 'src/compose.php':
- $js = '<script language="JavaScript" type="text/javascript">' .
- "\n<!--\n" .
- "function checkForm() {\n".
- "var f = document.forms.length;\n".
- "var i = 0;\n".
- "var pos = -1;\n".
- "while( pos == -1 && i < f ) {\n".
- "var e = document.forms[i].elements.length;\n".
- "var j = 0;\n".
- "while( pos == -1 && j < e ) {\n".
- "if ( document.forms[i].elements[j].type == 'text' ) {\n".
- "pos = j;\n".
- "}\n".
- "j++;\n".
- "}\n".
- "i++;\n".
- "}\n".
- "if( pos >= 0 ) {\n".
- "document.forms[i-1].elements[pos].focus();\n".
- "}\n".
- "}\n";
-
- $js .= "// -->\n".
- "</script>\n";
- $onload = "onLoad=\"checkForm();\"";
- displayHtmlHeader ('SquirrelMail', $js);
- break;
-
- default:
- $js = '<script language="JavaScript" type="text/javascript">' .
- "\n<!--\n" .
- "function checkForm() {\n".
- "var f = document.forms.length;\n".
- "var i = 0;\n".
- "var pos = -1;\n".
- "while( pos == -1 && i < f ) {\n".
- "var e = document.forms[i].elements.length;\n".
- "var j = 0;\n".
- "while( pos == -1 && j < e ) {\n".
- "if ( document.forms[i].elements[j].type == 'text' ) {\n".
- "pos = j;\n".
- "}\n".
- "j++;\n".
- "}\n".
- "i++;\n".
- "}\n".
- "if( pos >= 0 ) {\n".
- "document.forms[i-1].elements[pos].focus();\n".
- "}\n".
- "$xtra\n".
- "}\n";
-
- if ($compose_new_win == '1') {
- if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
- $compose_width = '640';
- }
- if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
- $compose_height = '550';
- }
- $js .= "function comp_in_new(comp_uri) {\n".
- " if (!comp_uri) {\n".
- ' comp_uri = "'.$compose_uri."\";\n".
- ' }'. "\n".
- ' var newwin = window.open(comp_uri' .
- ', "_blank",'.
- '"width='.$compose_width. ',height='.$compose_height.
- ',scrollbars=yes,resizable=yes");'."\n".
- "}\n\n";
-
- }
- $js .= "// -->\n". "</script>\n";
-
-
- $onload = "onLoad=\"checkForm();\"";
- displayHtmlHeader ('SquirrelMail', $js);
- break;
-
+ /* do not use JavaScript */
+ displayHtmlHeader ('SquirrelMail');
+ $sBodyTagJs = '';
}
-
- echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
- /** Here is the header and wrapping table **/
- $shortBoxName = imap_utf7_decode_local(
- readShortMailboxName($mailbox, $delimiter));
+ /*
+ * this explains the imap_mailbox.php dependency. We should instead store
+ * the selected mailbox in the session and fallback to the session var.
+ */
+ $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
+ readShortMailboxName($mailbox, $delimiter)));
if ( $shortBoxName == 'INBOX' ) {
$shortBoxName = _("INBOX");
}
- echo "<a name=\"pagetop\"></a>\n"
- . html_tag( 'table', '', '', $color[4], 'border="0" width="100%" cellspacing="0" cellpadding="2"' ) ."\n"
- . html_tag( 'tr', '', '', $color[9] ) ."\n"
- . html_tag( 'td', '', 'left' ) ."\n";
- if ( $shortBoxName <> '' && strtolower( $shortBoxName ) <> 'none' ) {
- echo ' ' . _("Current Folder") . ": <b>$shortBoxName </b>\n";
- } else {
- echo ' ';
- }
- echo " </td>\n"
- . html_tag( 'td', '', 'right' ) ."<b>\n";
- displayInternalLink ('src/signout.php', _("Sign Out"), $frame_top);
- echo "</b></td>\n"
- . " </tr>\n"
- . html_tag( 'tr', '', '', $color[4] ) ."\n"
- . html_tag( 'td', '', 'left' ) ."\n";
- $urlMailbox = urlencode($mailbox);
- if ($compose_new_win == '1') {
- echo "<a href=\"javascript:void(0)\" onclick=\"comp_in_new()\">". _("Compose"). '</a>';
- }
- else {
- displayInternalLink ("src/compose.php?mailbox=$urlMailbox", _("Compose"), 'right');
- }
- echo " \n";
- displayInternalLink ("src/addressbook.php", _("Addresses"), 'right');
- echo " \n";
- displayInternalLink ("src/folders.php", _("Folders"), 'right');
- echo " \n";
- displayInternalLink ("src/options.php", _("Options"), 'right');
- echo " \n";
- displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search"), 'right');
- echo " \n";
- displayInternalLink ("src/help.php", _("Help"), 'right');
- echo " \n";
-
- do_hook("menuline");
-
- echo " </td>\n"
- . html_tag( 'td', '', 'right' ) ."\n";
- if (!isset($provider_uri)) $provider_uri= 'http://www.squirrelmail.org/';
- if (!isset($provider_name)) $provider_name= 'SquirrelMail';
- echo ($hide_sm_attributions ? ' ' :
- '<a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>');
- echo "</td>\n".
- " </tr>\n".
- "</table><br>\n\n";
-}
-
-/* blatently copied/truncated/modified from the above function */
-function compose_Header($color, $mailbox) {
- global $delimiter, $hide_sm_attributions, $base_uri, $PHP_SELF, $frame_top, $compose_new_win;
+ $sm_attributes = '';
+ if (!$hide_sm_attributions) {
+ $sm_attributes .= '<td class="sqm_providerInfo">' ."\n";
+ if (empty($provider_uri)) {
+ $sm_attributes .= ' <a href="about.php">SquirrelMail</a>';
+ } else {
+ if (empty($provider_name)) $provider_name= 'SquirrelMail';
+ $sm_attributes .= ' <a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>'."\n";
+ }
+ $sm_attributes .= " </td>\n";
+ }
+ $oTemplate->assign('body_tag_js', $sBodyTagJs);
+ $oTemplate->assign('shortBoxName', $shortBoxName);
+ $oTemplate->assign('sm_attribute_str', $sm_attributes);
+ $oTemplate->assign('frame_top', $frame_top);
+ $oTemplate->assign('urlMailbox', $urlMailbox);
+ $oTemplate->assign('startMessage', $startMessage);
+ $oTemplate->assign('hide_sm_attributions', $hide_sm_attributions);
+ $oTemplate->display('page_header.tpl');
+}
- $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
- if (!isset($frame_top)) {
- $frame_top = '_top';
+/**
+ * Blatantly copied/truncated/modified from displayPageHeader.
+ * Outputs a page header specifically for the compose_in_new popup window
+ *
+ * @param array color the array of theme colors
+ * @param string mailbox the current mailbox name to display
+ * @param string sHeaderJs javascipt code to be inserted in a script block in the header
+ * @param string sBodyTagJs js events to be inserted in the body tag
+ * @return void
+ */
+function compose_Header($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
+
+ global $reply_focus, $javascript_on, $action, $oTemplate;
+
+ if (empty($sBodyTagJs)) {
+ if (strpos($action, 'reply') !== FALSE && $reply_focus) {
+ if ($reply_focus == 'select')
+ $sBodyTagJs = 'onload="checkForm(\'select\');"';
+ else if ($reply_focus == 'focus')
+ $sBodyTagJs = 'onload="checkForm(\'focus\');"';
+ else if ($reply_focus != 'none')
+ $sBodyTagJs = 'onload="checkForm();"';
+ }
+ else
+ $sBodyTagJs = 'onload="checkForm();"';
}
+
/*
- Locate the first displayable form element
- */
- switch ( $module ) {
- case 'src/search.php':
- $pos = getPref($data_dir, $username, 'search_pos', 0 ) - 1;
- $onload = "onLoad=\"document.forms[$pos].elements[2].focus();\"";
- displayHtmlHeader (_("Compose"));
- break;
- default:
- $js = '<script language="JavaScript" type="text/javascript">' .
- "\n<!--\n" .
- "function checkForm() {\n".
- "var f = document.forms.length;\n".
- "var i = 0;\n".
- "var pos = -1;\n".
- "while( pos == -1 && i < f ) {\n".
- "var e = document.forms[i].elements.length;\n".
- "var j = 0;\n".
- "while( pos == -1 && j < e ) {\n".
- "if ( document.forms[i].elements[j].type == 'text' ) {\n".
- "pos = j;\n".
- "}\n".
- "j++;\n".
- "}\n".
- "i++;\n".
- "}\n".
- "if( pos >= 0 ) {\n".
- "document.forms[i-1].elements[pos].focus();\n".
- "}\n".
- "}\n";
- $js .= "// -->\n".
- "</script>\n";
- $onload = "onLoad=\"checkForm();\"";
- displayHtmlHeader (_("Compose"), $js);
- break;
+ * Locate the first displayable form element (only when JavaScript on)
+ */
+ if($javascript_on) {
+ if ($sHeaderJs) {
+ $sJsBlock = "\n<script type=\"text/javascript\">" .
+ "\n<!--\n" .
+ $sHeaderJs . "\n\n// -->\n</script>\n";
+ } else {
+ $sJsBlock = '';
+ }
+ $sJsBlock .= "\n";
- }
+ $js_includes = $oTemplate->get_javascript_includes(TRUE);
+ foreach ($js_includes as $js_file) {
+ $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
+ }
- echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
+ displayHtmlHeader (_("Compose"), $sJsBlock);
+ } else {
+ /* javascript off */
+ displayHtmlHeader(_("Compose"));
+ $onload = '';
+ }
+// FIXME: should let the template echo all these kinds of things
+ echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $sBodyTagJs>\n\n";
}
-?>