6 * Prints the page header (duh)
8 * @copyright © 1999-2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @package squirrelmail
15 if (! defined('SM_PATH')) define('SM_PATH','../');
17 /** Include required files from SM */
18 require_once(SM_PATH
. 'functions/strings.php');
19 require_once(SM_PATH
. 'functions/html.php');
20 require_once(SM_PATH
. 'functions/imap_mailbox.php');
21 require_once(SM_PATH
. 'functions/global.php');
22 include_once(SM_PATH
. 'class/template/template.class.php');
25 * Output a SquirrelMail page header, from <!doctype> to </head>
26 * Always set up the language before calling these functions.
28 * Since 1.5.1 function sends http headers. Function should be called
29 * before any output is started.
30 * @param string title the page title, default SquirrelMail.
31 * @param string xtra extra HTML to insert into the header
32 * @param bool do_hook whether to execute hooks, default true
33 * @param bool frames generate html frameset doctype (since 1.5.1)
36 function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE ) {
37 global $squirrelmail_language, $sTplDir, $oErroHandler;
39 if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION
) ) {
42 global $theme_css, $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction,
43 $default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize, $chosen_theme;
45 /* add no cache headers here */
46 header('Pragma: no-cache'); // http 1.0 (rfc1945)
47 header('Cache-Control: private, no-cache, no-store'); // http 1.1 (rfc2616)
50 echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"'."\n"
51 .' "http://www.w3.org/TR/1999/REC-html401-19991224/frameset.dtd">';
53 echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"'."\n"
54 .' "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">';
56 echo "\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) .
57 "<head>\n<meta name=\"robots\" content=\"noindex,nofollow\">\n";
59 $used_fontset = (!empty($chosen_fontset) ?
$chosen_fontset : $default_fontset);
60 $used_fontsize = (!empty($chosen_fontsize) ?
$chosen_fontsize : $default_fontsize);
61 $used_theme = basename((!empty($chosen_theme) ?
$chosen_theme : $theme[$theme_default]['PATH']),'.php');
64 * Add closing / to link and meta elements only after switching to xhtml 1.0 Transitional.
65 * It is not compatible with html 4.01 Transitional
67 echo '<link rel="stylesheet" type="text/css" href="'. $base_uri .'src/style.php'
68 .'?themeid='.$used_theme
69 .'&templateid='.basename($sTplDir)
70 .(!empty($used_fontset) ?
'&fontset='.$used_fontset : '')
71 .(!empty($used_fontsize) ?
'&fontsize='.$used_fontsize : '')
72 .(!empty($text_direction) ?
'&dir='.$text_direction : '')."\">\n";
75 // load custom style sheet (deprecated)
76 if ( ! empty($theme_css) ) {
77 echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"$theme_css\">\n";
80 if ($squirrelmail_language == 'ja_JP') {
82 * force correct detection of charset, when browser does not follow
83 * http content-type and tries to detect charset from page content.
84 * Shooting of browser's creator can't be implemented in php.
85 * We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
86 * recommendations and switch to unicode.
88 echo "<!-- \xfd\xfe -->\n";
89 echo '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
92 do_hook('generic_header');
95 echo "<title>$title</title>\n$xtra\n";
97 /* work around IE6's scrollbar bug */
99 <style type="text/css">
101 /* avoid stupid IE6 bug with frames and scrollbars */
103 voice-family: "\"}\"";
104 voice-family: inherit;
105 width: expression(document.documentElement.clientWidth - 30);
112 echo "\n</head>\n\n";
114 /* this is used to check elsewhere whether we should call this function */
115 $pageheader_sent = TRUE;
116 if (isset($oErrorHandler)) {
117 $oErrorHander->HeaderSent();
122 * Given a path to a SquirrelMail file, return a HTML link to it
124 * @param string path the SquirrelMail file to link to
125 * @param string text the link text
126 * @param string target the target frame for this link
128 function makeInternalLink($path, $text, $target='') {
129 sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION
);
131 $target = " target=\"$target\"";
134 // This is an inefficient hook and is only used by
135 // one plugin that still needs to patch this code,
136 // plus if we are templat-izing SM, visual hooks
137 // are not needed. However, I am leaving the code
138 // here just in case we find a good (non-visual?)
139 // use for the internal_link hook.
141 //$hooktext = do_hook_function('internal_link',$text);
142 //if ($hooktext != '')
143 // $text = $hooktext;
145 return '<a href="'.$base_uri.$path.'"'.$target.'>'.$text.'</a>';
149 * Same as makeInternalLink, but echoes it too
151 function displayInternalLink($path, $text, $target='') {
152 echo makeInternalLink($path, $text, $target);
156 * Outputs a complete SquirrelMail page header, starting with <!doctype> and
157 * including the default menu bar. Uses displayHtmlHeader and takes
158 * JavaScript and locale settings into account.
160 * @param array color the array of theme colors
161 * @param string mailbox the current mailbox name to display
162 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
163 * @param string sBodyTagJs js events to be inserted in the body tag
167 function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
169 global $reply_focus, $hide_sm_attributions, $frame_top,
170 $provider_name, $provider_uri, $startMessage,
171 $javascript_on, $action, $oTemplate;
173 if (empty($sBodyTagJs)) {
174 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
175 if ($reply_focus == 'select')
176 $sBodyTagJs = 'onload="checkForm(\'select\');"';
177 else if ($reply_focus == 'focus')
178 $sBodyTagJs = 'onload="checkForm(\'focus\');"';
179 else if ($reply_focus != 'none')
180 $sBodyTagJs = 'onload="checkForm();"';
183 $sBodyTagJs = 'onload="checkForm();"';
186 $urlMailbox = urlencode($mailbox);
187 $startMessage = (int)$startMessage;
189 $sTplDir = $oTemplate->template_dir
;
191 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
193 if (!isset($frame_top)) {
197 if( $javascript_on ||
strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
198 $js_includes = $oTemplate->getJavascriptIncludes();
200 foreach ($js_includes as $js_file) {
201 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
204 $sJsBlock .= "\n<script type=\"text/javascript\">" .
206 $sHeaderJs . "\n\n// -->\n</script>\n";
208 displayHtmlHeader ('SquirrelMail', $sJsBlock);
210 /* do not use JavaScript */
211 displayHtmlHeader ('SquirrelMail');
215 $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
216 readShortMailboxName($mailbox, $delimiter)));
217 if ( $shortBoxName == 'INBOX' ) {
218 $shortBoxName = _("INBOX");
222 if (!$hide_sm_attributions) {
223 $sm_attributes .= '<td class="sqm_providerInfo">' ."\n";
224 if (empty($provider_uri)) {
225 $sm_attributes .= ' <a href="about.php">SquirrelMail</a>';
227 if (empty($provider_name)) $provider_name= 'SquirrelMail';
228 $sm_attributes .= ' <a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>'."\n";
230 $sm_attributes .= " </td>\n";
233 $oTemplate->assign('body_tag_js', $sBodyTagJs);
234 $oTemplate->assign('shortBoxName', $shortBoxName);
235 $oTemplate->assign('sm_attribute_str', $sm_attributes);
236 $oTemplate->assign('frame_top', $frame_top);
237 $oTemplate->assign('urlMailbox', $urlMailbox);
238 $oTemplate->assign('startMessage', $startMessage);
239 $oTemplate->assign('hide_sm_attributions', $hide_sm_attributions);
240 $oTemplate->display('page_header.tpl');
244 * Blatantly copied/truncated/modified from displayPageHeader.
245 * Outputs a page header specifically for the compose_in_new popup window
247 * @param array color the array of theme colors
248 * @param string mailbox the current mailbox name to display
249 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
250 * @param string sBodyTagJs js events to be inserted in the body tag
253 function compose_Header($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
255 global $reply_focus, $javascript_on, $action, $oTemplate;
257 if (empty($sBodyTagJs)) {
258 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
259 if ($reply_focus == 'select')
260 $sBodyTagJs = 'onload="checkForm(\'select\');"';
261 else if ($reply_focus == 'focus')
262 $sBodyTagJs = 'onload="checkForm(\'focus\');"';
263 else if ($reply_focus != 'none')
264 $sBodyTagJs = 'onload="checkForm();"';
267 $sBodyTagJs = 'onload="checkForm();"';
272 * Locate the first displayable form element (only when JavaScript on)
276 $sJsBlock = "\n<script type=\"text/javascript\">" .
278 $sHeaderJs . "\n\n// -->\n</script>\n";
284 $js_includes = $oTemplate->getJavascriptIncludes();
285 var_dump($js_includes);
286 foreach ($js_includes as $js_file) {
287 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
290 displayHtmlHeader (_("Compose"), $sJsBlock);
293 displayHtmlHeader(_("Compose"));
296 echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $sBodyTagJs>\n\n";