6 * Prints the page header (duh)
8 * @copyright © 1999-2007 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @package squirrelmail
14 /** Include required files from SM */
15 include_once(SM_PATH
. 'functions/imap_mailbox.php');
18 * Output a SquirrelMail page header, from <!doctype> to </head>
19 * Always set up the language before calling these functions.
21 * Since 1.5.1 function sends http headers. Function should be called
22 * before any output is started.
23 * @param string title the page title, default SquirrelMail.
24 * @param string xtra extra HTML to insert into the header
25 * @param bool do_hook whether to execute hooks, default true
26 * @param bool frames generate html frameset doctype (since 1.5.1)
29 function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE ) {
30 global $squirrelmail_language, $sTemplateID, $oErrorHandler, $oTemplate;
32 if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION
) ) {
35 global $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction,
36 $default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize,
37 $chosen_theme, $chosen_theme_path, $user_themes, $user_theme_default;
39 /* add no cache headers here */
40 //FIXME: should change all header() calls in SM core to use $oTemplate->header()!!
41 $oTemplate->header('Pragma: no-cache'); // http 1.0 (rfc1945)
42 $oTemplate->header('Cache-Control: private, no-cache, no-store'); // http 1.1 (rfc2616)
44 $oTemplate->assign('frames', $frames);
45 $oTemplate->assign('lang', $squirrelmail_language);
49 $header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\" />\n";
51 $used_fontset = (!empty($chosen_fontset) ?
$chosen_fontset : $default_fontset);
52 $used_fontsize = (!empty($chosen_fontsize) ?
$chosen_fontsize : $default_fontsize);
53 $used_theme = !isset($chosen_theme) && $user_theme_default != 'none' && is_dir($chosen_theme) && is_readable($chosen_theme)?
$user_themes[$user_theme_default]['PATH'].'/default.css' : $chosen_theme_path;
56 * Stylesheets are loaded in the following order:
57 * 1) All stylesheets provided by the template. Normally, these are
58 * stylsheets in templates/<template>/css/. This is accomplished by calling
59 * $oTemplate->fetch_standard_stylesheet_links().
60 * 2) An optional user-defined stylesheet. This is set in the Display
62 * 3) src/style.php which sets some basic font prefs.
63 * 4) If we are dealing with an RTL language, we load rtl.css from the
67 // 1. Stylesheets from the template.
68 $header_tags .= $oTemplate->fetch_standard_stylesheet_links();
70 $aUserStyles = array();
72 // 2. Option user-defined stylesheet from preferences.
73 if (!empty($used_theme) && $used_theme != 'none') {
75 * All styles just point to a directory, so we need to include all .css
76 * files in that directory.
78 $styles = list_files($used_theme, '.css');
79 foreach ($styles as $sheet) {
80 $aUserStyles[] = $used_theme .'/'.$sheet;
85 $aUserStyles[] = $base_uri .'src/style.php?'
86 . (!empty($used_fontset) ?
'&fontset='.$used_fontset : '')
87 . (!empty($used_fontsize) ?
'&fontsize='.$used_fontsize : '');
89 // 3.1. Load the stylesheets we have already
90 $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
92 // 4. Optional rtl.css stylesheet
93 if ($text_direction == 'rtl') {
94 $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
97 if ($squirrelmail_language == 'ja_JP') {
99 * force correct detection of charset, when browser does not follow
100 * http content-type and tries to detect charset from page content.
101 * Shooting of browser's creator can't be implemented in php.
102 * We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
103 * recommendations and switch to unicode.
105 $header_tags .= "<!-- \xfd\xfe -->\n";
106 $header_tags .= '<meta http-equiv="Content-type" content="text/html; charset=euc-jp" />' . "\n";
109 // NOTE! plugins here MUST assign output to template
110 // and NOT echo anything directly!! A common
111 // approach is if a plugin decides it needs to
112 // put something at page-top after the standard
113 // SM page header, to dynamically add itself to
114 // the page_header_bottom and/or compose_header_bottom
115 // hooks for the current page request. See
116 // the Sent Confirmation v1.7 or Restrict Senders v1.2
117 // plugins for examples of this approach.
120 do_hook('generic_header', $null);
121 $output = ob_get_contents();
123 // plugin authors can debug their errors with one of the following:
124 //sm_print_r($output);
126 if (!empty($output)) trigger_error('A plugin on the "generic_header" hook has attempted to output directly to the browser', E_USER_ERROR
);
129 $header_tags .= $xtra;
130 $oTemplate->assign('page_title', $title);
132 /* work around IE6's scrollbar bug */
133 $header_tags .= <<<EOS
135 <style type="text/css">
136 /* avoid stupid IE6 bug with frames and scrollbars */
138 width: expression(document.documentElement.clientWidth - 30);
145 $oTemplate->assign('header_tags', $header_tags);
146 $oTemplate->display('protocol_header.tpl');
148 /* this is used to check elsewhere whether we should call this function */
149 $pageheader_sent = TRUE;
150 if (isset($oErrorHandler)) {
151 $oErrorHandler->HeaderSent();
157 * Given a path to a SquirrelMail file, return a HTML link to it
159 * @param string path the SquirrelMail file to link to
160 * @param string text the link text
161 * @param string target the target frame for this link
163 function makeInternalLink($path, $text, $target='') {
164 global $base_uri, $oTemplate;
165 // sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
167 // This is an inefficient hook and is only used by
168 // one plugin that still needs to patch this code,
169 // plus if we are templat-izing SM, visual hooks
170 // are not needed. However, I am leaving the code
171 // here just in case we find a good (non-visual?)
172 // use for the internal_link hook.
174 //do_hook('internal_link', $text);
176 return create_hyperlink($base_uri . $path, $text, $target);
180 * Same as makeInternalLink, but echoes it too
182 function displayInternalLink($path, $text, $target='') {
183 // FIXME: should let the template echo all these kinds of things
184 echo makeInternalLink($path, $text, $target);
188 * Outputs a complete SquirrelMail page header, starting with <!doctype> and
189 * including the default menu bar. Uses displayHtmlHeader and takes
190 * JavaScript and locale settings into account.
192 * @param array color the array of theme colors
193 * @param string mailbox the current mailbox name to display
194 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
195 * @param string sBodyTagJs js events to be inserted in the body tag
199 function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sBodyTagJs = '') {
201 global $reply_focus, $hide_sm_attributions, $frame_top,
202 $provider_name, $provider_uri, $startMessage,
203 $action, $oTemplate, $org_title, $base_uri;
205 //FIXME: $sBodyTag should be turned into $sOnload and should only contain the contents of the onload attribute (not the attribute name nor any quotes).... only question is if anyone was using $sBodyTag for anything but onload event handlers? (see function compose_Header() below for how to fix it once we confirm it can be changed)
206 if (empty($sBodyTagJs)) {
207 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
208 if ($reply_focus == 'select')
209 $sBodyTagJs = 'onload="checkForm(\'select\');"';
210 else if ($reply_focus == 'focus')
211 $sBodyTagJs = 'onload="checkForm(\'focus\');"';
212 else if ($reply_focus != 'none')
213 $sBodyTagJs = 'onload="checkForm();"';
216 $sBodyTagJs = 'onload="checkForm();"';
219 $urlMailbox = urlencode($mailbox);
220 $startMessage = (int)$startMessage;
222 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
224 if (!isset($frame_top)) {
228 //FIXME: does checkForJavascript() make the 2nd part of the if() below unneccessary??
229 if( checkForJavascript() ||
strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
230 $js_includes = $oTemplate->get_javascript_includes(TRUE);
232 foreach ($js_includes as $js_file) {
233 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
236 $sJsBlock .= "\n<script type=\"text/javascript\">" .
238 $sHeaderJs . "\n\n// -->\n</script>\n";
240 displayHtmlHeader ($org_title, $sJsBlock);
242 /* do not use JavaScript */
243 displayHtmlHeader ($org_title);
247 * this explains the imap_mailbox.php dependency. We should instead store
248 * the selected mailbox in the session and fallback to the session var.
250 $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
251 readShortMailboxName($mailbox, $delimiter)));
252 if ( $shortBoxName == 'INBOX' ) {
253 $shortBoxName = _("INBOX");
257 if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
258 $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
261 $oTemplate->assign('body_tag_js', $sBodyTagJs);
262 $oTemplate->assign('shortBoxName', $shortBoxName);
263 $oTemplate->assign('provider_link', $provider_link);
264 $oTemplate->assign('frame_top', $frame_top);
265 $oTemplate->assign('urlMailbox', $urlMailbox);
266 $oTemplate->assign('startMessage', $startMessage);
267 $oTemplate->assign('hide_sm_attributions', $hide_sm_attributions);
268 $oTemplate->display('page_header.tpl');
271 do_hook('page_header_bottom', $null);
275 * Blatantly copied/truncated/modified from displayPageHeader.
276 * Outputs a page header specifically for the compose_in_new popup window
278 * @param array color the array of theme colors
279 * @param string mailbox the current mailbox name to display
280 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
281 * @param string sOnload JavaScript code to be added inside the body's onload handler
282 * as of 1.5.2, this replaces $sBodyTagJs argument
285 function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
287 global $reply_focus, $action, $oTemplate;
289 if (empty($sOnload)) {
290 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
291 if ($reply_focus == 'select')
292 $sOnload = 'checkForm(\'select\');';
293 else if ($reply_focus == 'focus')
294 $sOnload = 'checkForm(\'focus\');';
295 else if ($reply_focus != 'none')
296 $sOnload = 'checkForm();';
299 $sOnload = 'checkForm();';
304 * Locate the first displayable form element (only when JavaScript on)
306 if(checkForJavascript()) {
308 $sJsBlock = "\n<script type=\"text/javascript\">" .
310 $sHeaderJs . "\n\n// -->\n</script>\n";
316 $js_includes = $oTemplate->get_javascript_includes(TRUE);
317 foreach ($js_includes as $js_file) {
318 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
321 displayHtmlHeader (_("Compose"), $sJsBlock);
324 displayHtmlHeader(_("Compose"));
328 // FIXME: change the colorization attributes below to a CSS class!
330 $aAttribs = array('text' => $color[8], 'bgcolor' => $color[4],
331 'link' => $color[7], 'vlink' => $color[7],
332 'alink' => $color[7]);
334 // this is template-safe (see create_body() function)
335 echo create_body($sOnload, $class, $aAttribs);
338 do_hook('compose_header_bottom', $null);