Just fiddling. Give credit where credit is due. Template class header() function...
[squirrelmail.git] / functions / page_header.php
CommitLineData
59177427 1<?php
7350889b 2
35586184 3/**
4 * page_header.php
5 *
35586184 6 * Prints the page header (duh)
7 *
4b5049de 8 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
4b4abf93 9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
31841a9e 10 * @version $Id$
d6c32258 11 * @package squirrelmail
35586184 12 */
13
d6c32258 14/** Include required files from SM */
202bcbcc 15include_once(SM_PATH . 'functions/imap_mailbox.php');
b68edc75 16
d6c32258 17/**
8b096f0a 18 * Output a SquirrelMail page header, from <!doctype> to </head>
19 * Always set up the language before calling these functions.
20 *
81132de8 21 * Since 1.5.1 function sends http headers. Function should be called
22 * before any output is started.
8b096f0a 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
62b9c984 26 * @param bool frames generate html frameset doctype (since 1.5.1)
8b096f0a 27 * @return void
d6c32258 28 */
d88941c7 29function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE ) {
b8292491 30 global $squirrelmail_language, $sTemplateID, $oErrorHandler, $oTemplate;
692155b7 31
0365891c 32 if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
0b97a708 33 global $base_uri;
34 }
ab034e59 35 global $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction,
acd7fdf2 36 $default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize,
37 $chosen_theme, $chosen_theme_path, $user_themes, $user_theme_default;
81132de8 38
39 /* add no cache headers here */
b8292491 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)
2c21ef20 43
1f2f93e6 44 // don't show version as a security measure
45 //$oTemplate->header('X-Powered-By: SquirrelMail/' . SM_VERSION, FALSE);
46 $oTemplate->header('X-Powered-By: SquirrelMail', FALSE);
47
b8292491 48 $oTemplate->assign('frames', $frames);
49 $oTemplate->assign('lang', $squirrelmail_language);
50
51 $header_tags = '';
52
b116fd78 53 $header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\" />\n";
2c21ef20 54
d88941c7 55 $used_fontset = (!empty($chosen_fontset) ? $chosen_fontset : $default_fontset);
56 $used_fontsize = (!empty($chosen_fontsize) ? $chosen_fontsize : $default_fontsize);
8757c848 57 $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;
acd7fdf2 58
d6a6f46b 59 /**
60 * Stylesheets are loaded in the following order:
61 * 1) All stylesheets provided by the template. Normally, these are
e2048f8e 62 * stylsheets in templates/<template>/css/. This is accomplished by calling
d6a6f46b 63 * $oTemplate->fetch_standard_stylesheet_links().
64 * 2) An optional user-defined stylesheet. This is set in the Display
65 * Preferences.
66 * 3) src/style.php which sets some basic font prefs.
67 * 4) If we are dealing with an RTL language, we load rtl.css from the
68 * template set.
e2048f8e 69 */
70
d6a6f46b 71 // 1. Stylesheets from the template.
b8292491 72 $header_tags .= $oTemplate->fetch_standard_stylesheet_links();
d6a6f46b 73
b8292491 74 $aUserStyles = array();
e2048f8e 75
d6a6f46b 76 // 2. Option user-defined stylesheet from preferences.
cd81f956 77 if (!empty($used_theme) && $used_theme != 'none') {
83fc5c5e 78 /**
2d2acf5e 79 * All styles (except "none" - ugh) just point to a directory,
80 * so we need to include all .css files in that directory.
83fc5c5e 81 */
2d2acf5e 82//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?)
83 $styles = $used_theme == 'none' ? array()
84 : list_files($used_theme, '.css');
8757c848 85 foreach ($styles as $sheet) {
86 $aUserStyles[] = $used_theme .'/'.$sheet;
f9376f0b 87 }
deb25c8f 88 }
d6a6f46b 89
90 // 3. src/style.php
91 $aUserStyles[] = $base_uri .'src/style.php?'
b8292491 92 . (!empty($used_fontset) ? '&amp;fontset='.$used_fontset : '')
d6a6f46b 93 . (!empty($used_fontsize) ? '&amp;fontsize='.$used_fontsize : '');
f9376f0b 94
95 // 3.1. Load the stylesheets we have already
b8292491 96 $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
6182ab4d 97
d6a6f46b 98 // 4. Optional rtl.css stylesheet
6182ab4d 99 if ($text_direction == 'rtl') {
100 $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
101 }
62f7daa5 102
2ad37738 103 // 5. Printer friendly stylesheet
104 $header_tags .= create_css_link($base_uri . 'css/print.css', 'printerfriendly', false, 'print');
105
e842b215 106 if ($squirrelmail_language == 'ja_JP') {
683b7853 107 /*
cbd8c251 108 * force correct detection of charset, when browser does not follow
109 * http content-type and tries to detect charset from page content.
110 * Shooting of browser's creator can't be implemented in php.
111 * We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
112 * recommendations and switch to unicode.
113 */
b8292491 114 $header_tags .= "<!-- \xfd\xfe -->\n";
0d56053e 115 $header_tags .= '<meta http-equiv="Content-type" content="' . $oTemplate->get_content_type() . '; charset=euc-jp" />' . "\n";
e842b215 116 }
237470b4 117 if ($do_hook) {
ed1c151d 118 // NOTE! plugins here MUST assign output to template
119 // and NOT echo anything directly!! A common
120 // approach is if a plugin decides it needs to
121 // put something at page-top after the standard
122 // SM page header, to dynamically add itself to
123 // the page_header_bottom and/or compose_header_bottom
124 // hooks for the current page request. See
125 // the Sent Confirmation v1.7 or Restrict Senders v1.2
126 // plugins for examples of this approach.
ed1c151d 127 ob_start();
c0071a26 128 $temp = array(&$header_tags);
129 do_hook('generic_header', $temp);
ed1c151d 130 $output = ob_get_contents();
131 ob_end_clean();
132 // plugin authors can debug their errors with one of the following:
133 //sm_print_r($output);
134 //echo $output;
135 if (!empty($output)) trigger_error('A plugin on the "generic_header" hook has attempted to output directly to the browser', E_USER_ERROR);
237470b4 136 }
62f7daa5 137
b8292491 138 $header_tags .= $xtra;
139 $oTemplate->assign('page_title', $title);
5ca4b1ee 140
141 /* work around IE6's scrollbar bug */
b8292491 142 $header_tags .= <<<EOS
292a9c32 143<!--[if IE 6]>
5ca4b1ee 144<style type="text/css">
5fe8257d 145/* avoid stupid IE6 bug with frames and scrollbars */
146body {
5fe8257d 147 width: expression(document.documentElement.clientWidth - 30);
148}
5ca4b1ee 149</style>
292a9c32 150<![endif]-->
5ca4b1ee 151
b8292491 152EOS;
5ca4b1ee 153
4bf6fc19 154 $oTemplate->assign('header_tags', $header_tags);
b8292491 155 $oTemplate->display('protocol_header.tpl');
b6c283c4 156
157 /* this is used to check elsewhere whether we should call this function */
158 $pageheader_sent = TRUE;
81de00c0 159 if (isset($oErrorHandler)) {
e6c4caae 160 $oErrorHandler->HeaderSent();
81de00c0 161 }
b8292491 162
a07cd1a4 163}
164
8b096f0a 165/**
166 * Given a path to a SquirrelMail file, return a HTML link to it
167 *
168 * @param string path the SquirrelMail file to link to
169 * @param string text the link text
170 * @param string target the target frame for this link
171 */
d62c4938 172function makeInternalLink($path, $text, $target='') {
f7b996c3 173 global $base_uri, $oTemplate;
202bcbcc 174// sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
4910106a 175
e50f5ac2 176 // This is an inefficient hook and is only used by
4910106a 177 // one plugin that still needs to patch this code,
e50f5ac2 178 // plus if we are templat-izing SM, visual hooks
179 // are not needed. However, I am leaving the code
180 // here just in case we find a good (non-visual?)
4910106a 181 // use for the internal_link hook.
182 //
d849b570 183 //do_hook('internal_link', $text);
4910106a 184
769a819d 185 return create_hyperlink($base_uri . $path, $text, $target);
d62c4938 186}
187
8b096f0a 188/**
8b096f0a 189 * Outputs a complete SquirrelMail page header, starting with <!doctype> and
190 * including the default menu bar. Uses displayHtmlHeader and takes
191 * JavaScript and locale settings into account.
192 *
193 * @param array color the array of theme colors
194 * @param string mailbox the current mailbox name to display
91c27aee 195 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
196 * @param string sBodyTagJs js events to be inserted in the body tag
8b096f0a 197 * @return void
198 */
715225af 199
876fdb60 200function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sBodyTagJs = '') {
10bf80c0 201
202 global $reply_focus, $hide_sm_attributions, $frame_top,
5fe8257d 203 $provider_name, $provider_uri, $startMessage,
d8ca5ea3 204 $action, $oTemplate, $org_title, $base_uri,
205 $data_dir, $username;
10bf80c0 206
5bcce050 207//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)
10bf80c0 208 if (empty($sBodyTagJs)) {
209 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
5fe8257d 210 if ($reply_focus == 'select')
211 $sBodyTagJs = 'onload="checkForm(\'select\');"';
212 else if ($reply_focus == 'focus')
213 $sBodyTagJs = 'onload="checkForm(\'focus\');"';
214 else if ($reply_focus != 'none')
215 $sBodyTagJs = 'onload="checkForm();"';
10bf80c0 216 }
217 else
5fe8257d 218 $sBodyTagJs = 'onload="checkForm();"';
10bf80c0 219 }
220
5fe8257d 221 $startMessage = (int)$startMessage;
222
0365891c 223 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
91c27aee 224
d03f3582 225 if (!isset($frame_top)) {
226 $frame_top = '_top';
227 }
715225af 228
83aff890 229//FIXME: does checkForJavascript() make the 2nd part of the if() below unneccessary??
230 if( checkForJavascript() || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
b8292491 231 $js_includes = $oTemplate->get_javascript_includes(TRUE);
6373ad12 232 $sJsBlock = '';
233 foreach ($js_includes as $js_file) {
234 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
235 }
91c27aee 236 if ($sHeaderJs) {
2c92ea9d 237 $sJsBlock .= "\n<script type=\"text/javascript\">" .
91c27aee 238 "\n<!--\n" .
a3d59ec3 239 $sHeaderJs . "\n\n// -->\n</script>\n";
d62c4938 240 }
e9e5a322 241 displayHtmlHeader ($org_title, $sJsBlock);
5fe8257d 242 } else {
d62c4938 243 /* do not use JavaScript */
e9e5a322 244 displayHtmlHeader ($org_title);
91c27aee 245 $sBodyTagJs = '';
715225af 246 }
d8ca5ea3 247 if ($mailbox) {
248 /*
249 * this explains the imap_mailbox.php dependency. We should instead store
250 * the selected mailbox in the session and fallback to the session var.
251 */
252 $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
253 readShortMailboxName($mailbox, $delimiter)));
254 if (getPref($data_dir, $username, 'translate_special_folders')) {
255 $shortBoxName = _($shortBoxName);
256 }
257 $urlMailbox = urlencode($mailbox);
258 } else {
259 $shortBoxName = '';
260 $urlMailbox = '';
7da23762 261 }
0493ed11 262
5810acfa 263 $provider_link = '';
264 if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
265 $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
99ea51d3 266 }
5fe8257d 267
268 $oTemplate->assign('body_tag_js', $sBodyTagJs);
269 $oTemplate->assign('shortBoxName', $shortBoxName);
4bf6fc19 270 $oTemplate->assign('provider_link', $provider_link);
5fe8257d 271 $oTemplate->assign('frame_top', $frame_top);
272 $oTemplate->assign('urlMailbox', $urlMailbox);
273 $oTemplate->assign('startMessage', $startMessage);
274 $oTemplate->assign('hide_sm_attributions', $hide_sm_attributions);
275 $oTemplate->display('page_header.tpl');
c5634692 276
277 global $null;
278 do_hook('page_header_bottom', $null);
a07cd1a4 279}
2ba13803 280
8b096f0a 281/**
282 * Blatantly copied/truncated/modified from displayPageHeader.
283 * Outputs a page header specifically for the compose_in_new popup window
284 *
285 * @param array color the array of theme colors
286 * @param string mailbox the current mailbox name to display
91c27aee 287 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
5bcce050 288 * @param string sOnload JavaScript code to be added inside the body's onload handler
289 * as of 1.5.2, this replaces $sBodyTagJs argument
8b096f0a 290 * @return void
291 */
5bcce050 292function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
10bf80c0 293
83aff890 294 global $reply_focus, $action, $oTemplate;
10bf80c0 295
5bcce050 296 if (empty($sOnload)) {
10bf80c0 297 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
5bcce050 298 if ($reply_focus == 'select')
299 $sOnload = 'checkForm(\'select\');';
300 else if ($reply_focus == 'focus')
301 $sOnload = 'checkForm(\'focus\');';
302 else if ($reply_focus != 'none')
303 $sOnload = 'checkForm();';
10bf80c0 304 }
305 else
5bcce050 306 $sOnload = 'checkForm();';
10bf80c0 307 }
308
309
9c3e6cd4 310 /*
d62c4938 311 * Locate the first displayable form element (only when JavaScript on)
312 */
83aff890 313 if(checkForJavascript()) {
91c27aee 314 if ($sHeaderJs) {
2c92ea9d 315 $sJsBlock = "\n<script type=\"text/javascript\">" .
91c27aee 316 "\n<!--\n" .
a3d59ec3 317 $sHeaderJs . "\n\n// -->\n</script>\n";
91c27aee 318 } else {
5fe8257d 319 $sJsBlock = '';
d62c4938 320 }
6373ad12 321 $sJsBlock .= "\n";
322
b8292491 323 $js_includes = $oTemplate->get_javascript_includes(TRUE);
6373ad12 324 foreach ($js_includes as $js_file) {
325 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
326 }
327
91c27aee 328 displayHtmlHeader (_("Compose"), $sJsBlock);
d62c4938 329 } else {
330 /* javascript off */
331 displayHtmlHeader(_("Compose"));
332 $onload = '';
9c3e6cd4 333 }
5bcce050 334
335// FIXME: change the colorization attributes below to a CSS class!
336 $class = '';
337 $aAttribs = array('text' => $color[8], 'bgcolor' => $color[4],
338 'link' => $color[7], 'vlink' => $color[7],
339 'alink' => $color[7]);
ed1c151d 340
341 // this is template-safe (see create_body() function)
5bcce050 342 echo create_body($sOnload, $class, $aAttribs);
343
6f4b6b68 344 global $null;
345 do_hook('compose_header_bottom', $null);
9c3e6cd4 346}