fix string, thanks Thierry Godefroy
[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
b8292491 44 $oTemplate->assign('frames', $frames);
45 $oTemplate->assign('lang', $squirrelmail_language);
46
47 $header_tags = '';
48
b116fd78 49 $header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\" />\n";
2c21ef20 50
d88941c7 51 $used_fontset = (!empty($chosen_fontset) ? $chosen_fontset : $default_fontset);
52 $used_fontsize = (!empty($chosen_fontsize) ? $chosen_fontsize : $default_fontsize);
8757c848 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;
acd7fdf2 54
d6a6f46b 55 /**
56 * Stylesheets are loaded in the following order:
57 * 1) All stylesheets provided by the template. Normally, these are
e2048f8e 58 * stylsheets in templates/<template>/css/. This is accomplished by calling
d6a6f46b 59 * $oTemplate->fetch_standard_stylesheet_links().
60 * 2) An optional user-defined stylesheet. This is set in the Display
61 * Preferences.
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
64 * template set.
e2048f8e 65 */
66
d6a6f46b 67 // 1. Stylesheets from the template.
b8292491 68 $header_tags .= $oTemplate->fetch_standard_stylesheet_links();
d6a6f46b 69
b8292491 70 $aUserStyles = array();
e2048f8e 71
d6a6f46b 72 // 2. Option user-defined stylesheet from preferences.
cd81f956 73 if (!empty($used_theme) && $used_theme != 'none') {
83fc5c5e 74 /**
2d2acf5e 75 * All styles (except "none" - ugh) just point to a directory,
76 * so we need to include all .css files in that directory.
83fc5c5e 77 */
2d2acf5e 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');
8757c848 81 foreach ($styles as $sheet) {
82 $aUserStyles[] = $used_theme .'/'.$sheet;
f9376f0b 83 }
deb25c8f 84 }
d6a6f46b 85
86 // 3. src/style.php
87 $aUserStyles[] = $base_uri .'src/style.php?'
b8292491 88 . (!empty($used_fontset) ? '&amp;fontset='.$used_fontset : '')
d6a6f46b 89 . (!empty($used_fontsize) ? '&amp;fontsize='.$used_fontsize : '');
f9376f0b 90
91 // 3.1. Load the stylesheets we have already
b8292491 92 $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
6182ab4d 93
d6a6f46b 94 // 4. Optional rtl.css stylesheet
6182ab4d 95 if ($text_direction == 'rtl') {
96 $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
97 }
62f7daa5 98
e842b215 99 if ($squirrelmail_language == 'ja_JP') {
683b7853 100 /*
cbd8c251 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.
106 */
b8292491 107 $header_tags .= "<!-- \xfd\xfe -->\n";
b116fd78 108 $header_tags .= '<meta http-equiv="Content-type" content="text/html; charset=euc-jp" />' . "\n";
e842b215 109 }
237470b4 110 if ($do_hook) {
ed1c151d 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.
d849b570 120 global $null;
ed1c151d 121 ob_start();
d849b570 122 do_hook('generic_header', $null);
ed1c151d 123 $output = ob_get_contents();
124 ob_end_clean();
125 // plugin authors can debug their errors with one of the following:
126 //sm_print_r($output);
127 //echo $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);
237470b4 129 }
62f7daa5 130
b8292491 131 $header_tags .= $xtra;
132 $oTemplate->assign('page_title', $title);
5ca4b1ee 133
134 /* work around IE6's scrollbar bug */
b8292491 135 $header_tags .= <<<EOS
292a9c32 136<!--[if IE 6]>
5ca4b1ee 137<style type="text/css">
5fe8257d 138/* avoid stupid IE6 bug with frames and scrollbars */
139body {
5fe8257d 140 width: expression(document.documentElement.clientWidth - 30);
141}
5ca4b1ee 142</style>
292a9c32 143<![endif]-->
5ca4b1ee 144
b8292491 145EOS;
5ca4b1ee 146
4bf6fc19 147 $oTemplate->assign('header_tags', $header_tags);
b8292491 148 $oTemplate->display('protocol_header.tpl');
b6c283c4 149
150 /* this is used to check elsewhere whether we should call this function */
151 $pageheader_sent = TRUE;
81de00c0 152 if (isset($oErrorHandler)) {
e6c4caae 153 $oErrorHandler->HeaderSent();
81de00c0 154 }
b8292491 155
a07cd1a4 156}
157
8b096f0a 158/**
159 * Given a path to a SquirrelMail file, return a HTML link to it
160 *
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
164 */
d62c4938 165function makeInternalLink($path, $text, $target='') {
f7b996c3 166 global $base_uri, $oTemplate;
202bcbcc 167// sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
4910106a 168
e50f5ac2 169 // This is an inefficient hook and is only used by
4910106a 170 // one plugin that still needs to patch this code,
e50f5ac2 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?)
4910106a 174 // use for the internal_link hook.
175 //
d849b570 176 //do_hook('internal_link', $text);
4910106a 177
769a819d 178 return create_hyperlink($base_uri . $path, $text, $target);
d62c4938 179}
180
8b096f0a 181/**
8b096f0a 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.
185 *
186 * @param array color the array of theme colors
187 * @param string mailbox the current mailbox name to display
91c27aee 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
8b096f0a 190 * @return void
191 */
715225af 192
876fdb60 193function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sBodyTagJs = '') {
10bf80c0 194
195 global $reply_focus, $hide_sm_attributions, $frame_top,
5fe8257d 196 $provider_name, $provider_uri, $startMessage,
5f66bc58 197 $action, $oTemplate, $org_title, $base_uri;
10bf80c0 198
5bcce050 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)
10bf80c0 200 if (empty($sBodyTagJs)) {
201 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
5fe8257d 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();"';
10bf80c0 208 }
209 else
5fe8257d 210 $sBodyTagJs = 'onload="checkForm();"';
10bf80c0 211 }
212
5fe8257d 213 $urlMailbox = urlencode($mailbox);
214 $startMessage = (int)$startMessage;
215
0365891c 216 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
91c27aee 217
d03f3582 218 if (!isset($frame_top)) {
219 $frame_top = '_top';
220 }
715225af 221
83aff890 222//FIXME: does checkForJavascript() make the 2nd part of the if() below unneccessary??
223 if( checkForJavascript() || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
b8292491 224 $js_includes = $oTemplate->get_javascript_includes(TRUE);
6373ad12 225 $sJsBlock = '';
226 foreach ($js_includes as $js_file) {
227 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
228 }
91c27aee 229 if ($sHeaderJs) {
2c92ea9d 230 $sJsBlock .= "\n<script type=\"text/javascript\">" .
91c27aee 231 "\n<!--\n" .
a3d59ec3 232 $sHeaderJs . "\n\n// -->\n</script>\n";
d62c4938 233 }
e9e5a322 234 displayHtmlHeader ($org_title, $sJsBlock);
5fe8257d 235 } else {
d62c4938 236 /* do not use JavaScript */
e9e5a322 237 displayHtmlHeader ($org_title);
91c27aee 238 $sBodyTagJs = '';
715225af 239 }
202bcbcc 240 /*
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.
243 */
72520f77 244 $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
91e0dccc 245 readShortMailboxName($mailbox, $delimiter)));
3b7d68e6 246 if ( $shortBoxName == 'INBOX' ) {
7da23762 247 $shortBoxName = _("INBOX");
248 }
0493ed11 249
5810acfa 250 $provider_link = '';
251 if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
252 $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
99ea51d3 253 }
5fe8257d 254
255 $oTemplate->assign('body_tag_js', $sBodyTagJs);
256 $oTemplate->assign('shortBoxName', $shortBoxName);
4bf6fc19 257 $oTemplate->assign('provider_link', $provider_link);
5fe8257d 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');
c5634692 263
264 global $null;
265 do_hook('page_header_bottom', $null);
a07cd1a4 266}
2ba13803 267
8b096f0a 268/**
269 * Blatantly copied/truncated/modified from displayPageHeader.
270 * Outputs a page header specifically for the compose_in_new popup window
271 *
272 * @param array color the array of theme colors
273 * @param string mailbox the current mailbox name to display
91c27aee 274 * @param string sHeaderJs javascipt code to be inserted in a script block in the header
5bcce050 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
8b096f0a 277 * @return void
278 */
5bcce050 279function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
10bf80c0 280
83aff890 281 global $reply_focus, $action, $oTemplate;
10bf80c0 282
5bcce050 283 if (empty($sOnload)) {
10bf80c0 284 if (strpos($action, 'reply') !== FALSE && $reply_focus) {
5bcce050 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();';
10bf80c0 291 }
292 else
5bcce050 293 $sOnload = 'checkForm();';
10bf80c0 294 }
295
296
9c3e6cd4 297 /*
d62c4938 298 * Locate the first displayable form element (only when JavaScript on)
299 */
83aff890 300 if(checkForJavascript()) {
91c27aee 301 if ($sHeaderJs) {
2c92ea9d 302 $sJsBlock = "\n<script type=\"text/javascript\">" .
91c27aee 303 "\n<!--\n" .
a3d59ec3 304 $sHeaderJs . "\n\n// -->\n</script>\n";
91c27aee 305 } else {
5fe8257d 306 $sJsBlock = '';
d62c4938 307 }
6373ad12 308 $sJsBlock .= "\n";
309
b8292491 310 $js_includes = $oTemplate->get_javascript_includes(TRUE);
6373ad12 311 foreach ($js_includes as $js_file) {
312 $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
313 }
314
91c27aee 315 displayHtmlHeader (_("Compose"), $sJsBlock);
d62c4938 316 } else {
317 /* javascript off */
318 displayHtmlHeader(_("Compose"));
319 $onload = '';
9c3e6cd4 320 }
5bcce050 321
322// FIXME: change the colorization attributes below to a CSS class!
323 $class = '';
324 $aAttribs = array('text' => $color[8], 'bgcolor' => $color[4],
325 'link' => $color[7], 'vlink' => $color[7],
326 'alink' => $color[7]);
ed1c151d 327
328 // this is template-safe (see create_body() function)
5bcce050 329 echo create_body($sOnload, $class, $aAttribs);
330
6f4b6b68 331 global $null;
332 do_hook('compose_header_bottom', $null);
9c3e6cd4 333}