59177427 |
1 | <?php |
7350889b |
2 | |
35586184 |
3 | /** |
4 | * page_header.php |
5 | * |
35586184 |
6 | * Prints the page header (duh) |
7 | * |
4b5049de |
8 | * @copyright © 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 |
15 | include_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 |
29 | function 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) ? '&fontset='.$used_fontset : '') |
d6a6f46b |
89 | . (!empty($used_fontsize) ? '&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 */ |
139 | body { |
5fe8257d |
140 | width: expression(document.documentElement.clientWidth - 30); |
141 | } |
5ca4b1ee |
142 | </style> |
292a9c32 |
143 | <![endif]--> |
5ca4b1ee |
144 | |
b8292491 |
145 | EOS; |
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 |
165 | function 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 | /** |
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 |
193 | function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sBodyTagJs = '') { |
10bf80c0 |
194 | |
195 | global $reply_focus, $hide_sm_attributions, $frame_top, |
5fe8257d |
196 | $provider_name, $provider_uri, $startMessage, |
d8ca5ea3 |
197 | $action, $oTemplate, $org_title, $base_uri, |
198 | $data_dir, $username; |
10bf80c0 |
199 | |
5bcce050 |
200 | //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 |
201 | if (empty($sBodyTagJs)) { |
202 | if (strpos($action, 'reply') !== FALSE && $reply_focus) { |
5fe8257d |
203 | if ($reply_focus == 'select') |
204 | $sBodyTagJs = 'onload="checkForm(\'select\');"'; |
205 | else if ($reply_focus == 'focus') |
206 | $sBodyTagJs = 'onload="checkForm(\'focus\');"'; |
207 | else if ($reply_focus != 'none') |
208 | $sBodyTagJs = 'onload="checkForm();"'; |
10bf80c0 |
209 | } |
210 | else |
5fe8257d |
211 | $sBodyTagJs = 'onload="checkForm();"'; |
10bf80c0 |
212 | } |
213 | |
5fe8257d |
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 | } |
d8ca5ea3 |
240 | if ($mailbox) { |
241 | /* |
242 | * this explains the imap_mailbox.php dependency. We should instead store |
243 | * the selected mailbox in the session and fallback to the session var. |
244 | */ |
245 | $shortBoxName = htmlspecialchars(imap_utf7_decode_local( |
246 | readShortMailboxName($mailbox, $delimiter))); |
247 | if (getPref($data_dir, $username, 'translate_special_folders')) { |
248 | $shortBoxName = _($shortBoxName); |
249 | } |
250 | $urlMailbox = urlencode($mailbox); |
251 | } else { |
252 | $shortBoxName = ''; |
253 | $urlMailbox = ''; |
7da23762 |
254 | } |
0493ed11 |
255 | |
5810acfa |
256 | $provider_link = ''; |
257 | if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') { |
258 | $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank'); |
99ea51d3 |
259 | } |
5fe8257d |
260 | |
261 | $oTemplate->assign('body_tag_js', $sBodyTagJs); |
262 | $oTemplate->assign('shortBoxName', $shortBoxName); |
4bf6fc19 |
263 | $oTemplate->assign('provider_link', $provider_link); |
5fe8257d |
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'); |
c5634692 |
269 | |
270 | global $null; |
271 | do_hook('page_header_bottom', $null); |
a07cd1a4 |
272 | } |
2ba13803 |
273 | |
8b096f0a |
274 | /** |
275 | * Blatantly copied/truncated/modified from displayPageHeader. |
276 | * Outputs a page header specifically for the compose_in_new popup window |
277 | * |
278 | * @param array color the array of theme colors |
279 | * @param string mailbox the current mailbox name to display |
91c27aee |
280 | * @param string sHeaderJs javascipt code to be inserted in a script block in the header |
5bcce050 |
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 |
8b096f0a |
283 | * @return void |
284 | */ |
5bcce050 |
285 | function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') { |
10bf80c0 |
286 | |
83aff890 |
287 | global $reply_focus, $action, $oTemplate; |
10bf80c0 |
288 | |
5bcce050 |
289 | if (empty($sOnload)) { |
10bf80c0 |
290 | if (strpos($action, 'reply') !== FALSE && $reply_focus) { |
5bcce050 |
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();'; |
10bf80c0 |
297 | } |
298 | else |
5bcce050 |
299 | $sOnload = 'checkForm();'; |
10bf80c0 |
300 | } |
301 | |
302 | |
9c3e6cd4 |
303 | /* |
d62c4938 |
304 | * Locate the first displayable form element (only when JavaScript on) |
305 | */ |
83aff890 |
306 | if(checkForJavascript()) { |
91c27aee |
307 | if ($sHeaderJs) { |
2c92ea9d |
308 | $sJsBlock = "\n<script type=\"text/javascript\">" . |
91c27aee |
309 | "\n<!--\n" . |
a3d59ec3 |
310 | $sHeaderJs . "\n\n// -->\n</script>\n"; |
91c27aee |
311 | } else { |
5fe8257d |
312 | $sJsBlock = ''; |
d62c4938 |
313 | } |
6373ad12 |
314 | $sJsBlock .= "\n"; |
315 | |
b8292491 |
316 | $js_includes = $oTemplate->get_javascript_includes(TRUE); |
6373ad12 |
317 | foreach ($js_includes as $js_file) { |
318 | $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n"; |
319 | } |
320 | |
91c27aee |
321 | displayHtmlHeader (_("Compose"), $sJsBlock); |
d62c4938 |
322 | } else { |
323 | /* javascript off */ |
324 | displayHtmlHeader(_("Compose")); |
325 | $onload = ''; |
9c3e6cd4 |
326 | } |
5bcce050 |
327 | |
328 | // FIXME: change the colorization attributes below to a CSS class! |
329 | $class = ''; |
330 | $aAttribs = array('text' => $color[8], 'bgcolor' => $color[4], |
331 | 'link' => $color[7], 'vlink' => $color[7], |
332 | 'alink' => $color[7]); |
ed1c151d |
333 | |
334 | // this is template-safe (see create_body() function) |
5bcce050 |
335 | echo create_body($sOnload, $class, $aAttribs); |
336 | |
6f4b6b68 |
337 | global $null; |
338 | do_hook('compose_header_bottom', $null); |
9c3e6cd4 |
339 | } |