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 (except "none" - ugh) just point to a directory,
76 * so we need to include all .css files in that directory.
78 //FIXME: rid ourselves of "none" strings! I didn't do it here because I think the problem is that the theme itself should never be "none" (? well, what else would it be? if "none" theme is actually OK, then is there a constant to use below in stead of a hard-coded string?)
79 $styles = $used_theme == 'none' ?
array()
80 : list_files($used_theme, '.css');
81 foreach ($styles as $sheet) {
82 $aUserStyles[] = $used_theme .'/'.$sheet;
87 $aUserStyles[] = $base_uri .'src/style.php?'
88 . (!empty($used_fontset) ?
'&fontset='.$used_fontset : '')
89 . (!empty($used_fontsize) ?
'&fontsize='.$used_fontsize : '');
91 // 3.1. Load the stylesheets we have already
92 $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
94 // 4. Optional rtl.css stylesheet
95 if ($text_direction == 'rtl') {
96 $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
99 if ($squirrelmail_language == 'ja_JP') {
101 * force correct detection of charset, when browser does not follow
102 * http content-type and tries to detect charset from page content.
103 * Shooting of browser's creator can't be implemented in php.
104 * We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
105 * recommendations and switch to unicode.
107 $header_tags .= "<!-- \xfd\xfe -->\n";
108 $header_tags .= '<meta http-equiv="Content-type" content="text/html; charset=euc-jp" />' . "\n";
111 // NOTE! plugins here MUST assign output to template
112 // and NOT echo anything directly!! A common
113 // approach is if a plugin decides it needs to
114 // put something at page-top after the standard
115 // SM page header, to dynamically add itself to
116 // the page_header_bottom and/or compose_header_bottom
117 // hooks for the current page request. See
118 // the Sent Confirmation v1.7 or Restrict Senders v1.2
119 // plugins for examples of this approach.
122 do_hook('generic_header', $null);
123 $output = ob_get_contents();
125 // plugin authors can debug their errors with one of the following:
126 //sm_print_r($output);
128 if (!empty($output)) trigger_error('A plugin on the "generic_header" hook has attempted to output directly to the browser', E_USER_ERROR
);
131 $header_tags .= $xtra;
132 $oTemplate->assign('page_title', $title);
134 /* work around IE6's scrollbar bug */
135 $header_tags .= <<<EOS
137 <style type="text/css">
138 /* avoid stupid IE6 bug with frames and scrollbars */
140 width: expression(document.documentElement.clientWidth - 30);
147 $oTemplate->assign('header_tags', $header_tags);
148 $oTemplate->display('protocol_header.tpl');
150 /* this is used to check elsewhere whether we should call this function */
151 $pageheader_sent = TRUE;
152 if (isset($oErrorHandler)) {
153 $oErrorHandler->HeaderSent();
159 * Given a path to a SquirrelMail file, return a HTML link to it
161 * @param string path the SquirrelMail file to link to
162 * @param string text the link text
163 * @param string target the target frame for this link
165 function makeInternalLink($path, $text, $target='') {
166 global $base_uri, $oTemplate;
167 // sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
169 // This is an inefficient hook and is only used by
170 // one plugin that still needs to patch this code,
171 // plus if we are templat-izing SM, visual hooks
172 // are not needed. However, I am leaving the code
173 // here just in case we find a good (non-visual?)
174 // use for the internal_link hook.
176 //do_hook('internal_link', $text);
178 return create_hyperlink($base_uri . $path, $text, $target);
182 * Outputs a complete SquirrelMail page header, starting with <!doctype> and
183 * including the default menu bar. Uses displayHtmlHeader and takes
184 * JavaScript and locale settings into account.
186 * @param array color the array of theme colors
187 * @param string mailbox the current mailbox name to display
188 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
189 * @param string sBodyTagJs js events to be inserted in the body tag
193 function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sBodyTagJs = '') {
195 global $reply_focus, $hide_sm_attributions, $frame_top,
196 $provider_name, $provider_uri, $startMessage,
197 $action, $oTemplate, $org_title, $base_uri;
199 //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)
200 if (empty($sBodyTagJs)) {
201 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
202 if ($reply_focus == 'select')
203 $sBodyTagJs = 'onload="checkForm(\'select\');"';
204 else if ($reply_focus == 'focus')
205 $sBodyTagJs = 'onload="checkForm(\'focus\');"';
206 else if ($reply_focus != 'none')
207 $sBodyTagJs = 'onload="checkForm();"';
210 $sBodyTagJs = 'onload="checkForm();"';
213 $urlMailbox = urlencode($mailbox);
214 $startMessage = (int)$startMessage;
216 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
218 if (!isset($frame_top)) {
222 //FIXME: does checkForJavascript() make the 2nd part of the if() below unneccessary??
223 if( checkForJavascript() ||
strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
224 $js_includes = $oTemplate->get_javascript_includes(TRUE);
226 foreach ($js_includes as $js_file) {
227 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
230 $sJsBlock .= "\n<script type=\"text/javascript\">" .
232 $sHeaderJs . "\n\n// -->\n</script>\n";
234 displayHtmlHeader ($org_title, $sJsBlock);
236 /* do not use JavaScript */
237 displayHtmlHeader ($org_title);
241 * this explains the imap_mailbox.php dependency. We should instead store
242 * the selected mailbox in the session and fallback to the session var.
244 $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
245 readShortMailboxName($mailbox, $delimiter)));
246 if ( $shortBoxName == 'INBOX' ) {
247 $shortBoxName = _("INBOX");
251 if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
252 $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
255 $oTemplate->assign('body_tag_js', $sBodyTagJs);
256 $oTemplate->assign('shortBoxName', $shortBoxName);
257 $oTemplate->assign('provider_link', $provider_link);
258 $oTemplate->assign('frame_top', $frame_top);
259 $oTemplate->assign('urlMailbox', $urlMailbox);
260 $oTemplate->assign('startMessage', $startMessage);
261 $oTemplate->assign('hide_sm_attributions', $hide_sm_attributions);
262 $oTemplate->display('page_header.tpl');
265 do_hook('page_header_bottom', $null);
269 * Blatantly copied/truncated/modified from displayPageHeader.
270 * Outputs a page header specifically for the compose_in_new popup window
272 * @param array color the array of theme colors
273 * @param string mailbox the current mailbox name to display
274 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
275 * @param string sOnload JavaScript code to be added inside the body's onload handler
276 * as of 1.5.2, this replaces $sBodyTagJs argument
279 function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
281 global $reply_focus, $action, $oTemplate;
283 if (empty($sOnload)) {
284 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
285 if ($reply_focus == 'select')
286 $sOnload = 'checkForm(\'select\');';
287 else if ($reply_focus == 'focus')
288 $sOnload = 'checkForm(\'focus\');';
289 else if ($reply_focus != 'none')
290 $sOnload = 'checkForm();';
293 $sOnload = 'checkForm();';
298 * Locate the first displayable form element (only when JavaScript on)
300 if(checkForJavascript()) {
302 $sJsBlock = "\n<script type=\"text/javascript\">" .
304 $sHeaderJs . "\n\n// -->\n</script>\n";
310 $js_includes = $oTemplate->get_javascript_includes(TRUE);
311 foreach ($js_includes as $js_file) {
312 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
315 displayHtmlHeader (_("Compose"), $sJsBlock);
318 displayHtmlHeader(_("Compose"));
322 // FIXME: change the colorization attributes below to a CSS class!
324 $aAttribs = array('text' => $color[8], 'bgcolor' => $color[4],
325 'link' => $color[7], 'vlink' => $color[7],
326 'alink' => $color[7]);
328 // this is template-safe (see create_body() function)
329 echo create_body($sOnload, $class, $aAttribs);
332 do_hook('compose_header_bottom', $null);