1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
|
<?php
/**
* page_header.php
*
* Prints the page header (duh)
*
* @copyright 1999-2015 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
*/
/** Include required files from SM */
include_once(SM_PATH . 'functions/imap_mailbox.php');
/**
* Output a SquirrelMail page header, from <!doctype> to </head>
* Always set up the language before calling these functions.
*
* Since 1.5.1 function sends http headers. Function should be called
* before any output is started.
* @param string title the page title, default SquirrelMail.
* @param string xtra extra HTML to insert into the header
* @param bool do_hook whether to execute hooks, default true
* @param bool frames generate html frameset doctype (since 1.5.1)
* @param bool $browser_cache_ok When TRUE, it's OK to leave out the
* no-cache browser headers (OPTIONAL;
* default = FALSE, send no-cache headers)
* @return void
*/
function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE, $browser_cache_ok=FALSE ) {
global $squirrelmail_language, $sTemplateID, $oErrorHandler, $oTemplate;
if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
global $base_uri;
}
global $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction,
$default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize,
$chosen_theme, $chosen_theme_path, $user_themes, $user_theme_default;
// add no cache headers here
//
if (!$browser_cache_ok) {
//FIXME: should change all header() calls in SM core to use $oTemplate->header()!!
$oTemplate->header('Pragma: no-cache'); // http 1.0 (rfc1945)
$oTemplate->header('Cache-Control: private, no-cache, no-store, must-revalidate, max-age=0'); // http 1.1 (rfc2616)
$oTemplate->header('Expires: Sat, 1 Jan 2000 00:00:00 GMT');
//TODO: is this needed? $oTemplate->header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . 'GMT');
}
/* prevent information leakage about read emails by forbidding Firefox
* to do preemptive DNS requests for any links in the message body. */
$oTemplate->header('X-DNS-Prefetch-Control: off');
// don't show version as a security measure
//$oTemplate->header('X-Powered-By: SquirrelMail/' . SM_VERSION, FALSE);
$oTemplate->header('X-Powered-By: SquirrelMail', FALSE);
// prevent clickjack attempts
// FIXME: should we use DENY instead? We can also make this a configurable value, including giving the admin the option of removing this entirely in case they WANT to be framed by an external domain
$oTemplate->header('X-Frame-Options: SAMEORIGIN');
// prevent clickjack attempts using JavaScript for browsers that
// don't support the X-Frame-Options header...
// we check to see if we are *not* the top page, and if not, check
// whether or not the top page is in the same domain as we are...
// if not, log out immediately -- this is an attempt to do the same
// thing that the X-Frame-Options does using JavaScript (never a good
// idea to rely on JavaScript-based solutions, though)
//FIXME: is it a problem that we still force the clickjack protection code whether or not JavaScript is supported or desired by the user?
$header_tags = '<script type="text/javascript" language="JavaScript">'
. "\n<!--\n"
. 'if (self != top) { try { if (document.domain != top.document.domain) {'
. ' throw "Clickjacking security violation! Please log out immediately!"; /* this code should never execute - exception should already have been thrown since it\'s a security violation in this case to even try to access top.document.domain (but it\'s left here just to be extra safe) */ } } catch (e) { self.location = "'
. sqm_baseuri() . 'src/signout.php"; top.location = "'
. sqm_baseuri() . 'src/signout.php" } }'
. "\n// -->\n</script>\n";
$oTemplate->assign('frames', $frames);
$oTemplate->assign('lang', $squirrelmail_language);
$header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\" />\n";
$used_fontset = (!empty($chosen_fontset) ? $chosen_fontset : $default_fontset);
$used_fontsize = (!empty($chosen_fontsize) ? $chosen_fontsize : $default_fontsize);
$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;
/**
* Stylesheets are loaded in the following order:
* 1) All stylesheets provided by the template. Normally, these are
* stylsheets in templates/<template>/css/. This is accomplished by calling
* $oTemplate->fetch_standard_stylesheet_links().
* 2) An optional user-defined stylesheet. This is set in the Display
* Preferences.
* 3) src/style.php which sets some basic font prefs.
* 4) If we are dealing with an RTL language, we load rtl.css from the
* template set.
*/
// 1. Stylesheets from the template.
$header_tags .= $oTemplate->fetch_standard_stylesheet_links();
$aUserStyles = array();
// 2. Option user-defined stylesheet from preferences.
if (!empty($used_theme) && $used_theme != 'none') {
/**
* All styles (except "none" - ugh) just point to a directory,
* so we need to include all .css files in that directory.
*/
//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?)
$styles = $used_theme == 'none' ? array()
: list_files($used_theme, '.css');
foreach ($styles as $sheet) {
$aUserStyles[] = $used_theme .'/'.$sheet;
}
}
// 3. src/style.php
$aUserStyles[] = $base_uri .'src/style.php?'
. (!empty($used_fontset) ? '&fontset='.$used_fontset : '')
. (!empty($used_fontsize) ? '&fontsize='.$used_fontsize : '');
// 3.1. Load the stylesheets we have already
$header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
// 4. Optional rtl.css stylesheet
if ($text_direction == 'rtl') {
$header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
}
// 5. Printer friendly stylesheet
$header_tags .= create_css_link($base_uri . 'css/print.css', 'printerfriendly', false, 'print');
if ($squirrelmail_language == 'ja_JP') {
/*
* force correct detection of charset, when browser does not follow
* http content-type and tries to detect charset from page content.
* Shooting of browser's creator can't be implemented in php.
* We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
* recommendations and switch to unicode.
*/
$header_tags .= "<!-- \xfd\xfe -->\n";
$header_tags .= '<meta http-equiv="Content-type" content="' . $oTemplate->get_content_type() . '; charset=euc-jp" />' . "\n";
}
if ($do_hook) {
// NOTE! plugins here MUST assign output to template
// and NOT echo anything directly!! A common
// approach is if a plugin decides it needs to
// put something at page-top after the standard
// SM page header, to dynamically add itself to
// the page_header_bottom and/or compose_header_bottom
// hooks for the current page request. See
// the Sent Confirmation v1.7 or Restrict Senders v1.2
// plugins for examples of this approach.
ob_start();
$temp = array(&$header_tags);
do_hook('generic_header', $temp);
$output = ob_get_contents();
ob_end_clean();
// plugin authors can debug their errors with one of the following:
//sm_print_r($output);
//echo $output;
if (!empty($output)) trigger_error('A plugin on the "generic_header" hook has attempted to output directly to the browser', E_USER_ERROR);
}
$header_tags .= $xtra;
$oTemplate->assign('page_title', $title);
/* work around IE6's scrollbar bug */
$header_tags .= <<<EOS
<!--[if IE 6]>
<style type="text/css">
/* avoid stupid IE6 bug with frames and scrollbars */
body {
width: expression(document.documentElement.clientWidth - 30);
}
</style>
<![endif]-->
EOS;
$oTemplate->assign('header_tags', $header_tags);
$oTemplate->display('protocol_header.tpl');
/* this is used to check elsewhere whether we should call this function */
$pageheader_sent = TRUE;
if (isset($oErrorHandler)) {
$oErrorHandler->HeaderSent();
}
}
/**
* Given a path to a SquirrelMail file, return a HTML link to it
*
* @param string $path The SquirrelMail file to link to
* (should start with something like "src/..." or
* "functions/..." or "plugins/..." etc.)
* @param string $text The link text
* @param string $target The target frame for this link
* @param string $accesskey The access key to be used, if any
*/
function makeInternalLink($path, $text, $target='', $accesskey='NONE') {
global $base_uri, $oTemplate;
// sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
// This is an inefficient hook and is only used by
// one plugin that still needs to patch this code,
// plus if we are templat-izing SM, visual hooks
// are not needed. However, I am leaving the code
// here just in case we find a good (non-visual?)
// use for the internal_link hook.
//
//do_hook('internal_link', $text);
return create_hyperlink($base_uri . $path, $text, $target,
'', '', '', '',
($accesskey == 'NONE'
? array()
: array('accesskey' => $accesskey)));
}
/**
* Outputs a complete SquirrelMail page header, starting with <!doctype> and
* including the default menu bar. Uses displayHtmlHeader and takes
* JavaScript and locale settings into account.
*
* @param array color the array of theme colors
* @param string mailbox the current mailbox name to display
* @param string sHeaderJs javascipt code to be inserted in a script block in the header
* @param string sOnload JavaScript code to be added inside the body's onload handler
* as of 1.5.2, this replaces $sBodyTagJs argument
* @return void
*/
function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sOnload = '') {
global $reply_focus, $hide_sm_attributions, $frame_top,
$provider_name, $provider_uri, $startMessage,
$action, $oTemplate, $org_title, $base_uri,
$data_dir, $username;
if (empty($sOnload)) {
if (strpos($action, 'reply') !== FALSE && $reply_focus) {
if ($reply_focus == 'select')
$sOnload = 'checkForm(\'select\');';
else if ($reply_focus == 'focus')
$sOnload = 'checkForm(\'focus\');';
else if ($reply_focus != 'none')
$sOnload = 'checkForm();';
}
else
$sOnload = 'checkForm();';
}
$startMessage = (int)$startMessage;
sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
if (!isset($frame_top)) {
$frame_top = '_top';
}
//FIXME: does checkForJavascript() make the 2nd part of the if() below unneccessary?? (that is, I think checkForJavascript() might already look for new_js_autodetect_results...(?))
if( checkForJavascript() || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
$js_includes = $oTemplate->get_javascript_includes(TRUE);
$sJsBlock = '';
foreach ($js_includes as $js_file) {
$sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
}
if ($sHeaderJs) {
$sJsBlock .= "\n<script type=\"text/javascript\">" .
"\n<!--\n" .
$sHeaderJs . "\n\n// -->\n</script>\n";
}
displayHtmlHeader ($org_title, $sJsBlock);
} else {
/* do not use JavaScript */
displayHtmlHeader ($org_title);
$sOnload = '';
}
if ($mailbox) {
/*
* this explains the imap_mailbox.php dependency. We should instead store
* the selected mailbox in the session and fallback to the session var.
*/
$shortBoxName = sm_encode_html_special_chars(imap_utf7_decode_local(
readShortMailboxName($mailbox, $delimiter)));
if (getPref($data_dir, $username, 'translate_special_folders')) {
global $sent_folder, $trash_folder, $draft_folder;
if ($mailbox == $sent_folder)
$shortBoxName = _("Sent");
else if ($mailbox == $trash_folder)
$shortBoxName = _("Trash");
else if ($mailbox == $sent_folder)
$shortBoxName = _("Drafts");
}
$urlMailbox = urlencode($mailbox);
} else {
$shortBoxName = '';
$urlMailbox = '';
}
$provider_link = '';
if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
$provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
}
$oTemplate->assign('onload', $sOnload);
$oTemplate->assign('shortBoxName', $shortBoxName);
$oTemplate->assign('provider_link', $provider_link);
$oTemplate->assign('frame_top', $frame_top);
$oTemplate->assign('urlMailbox', $urlMailbox);
$oTemplate->assign('startMessage', $startMessage);
$oTemplate->assign('hide_sm_attributions', $hide_sm_attributions);
// access keys
//
global $accesskey_menubar_compose, $accesskey_menubar_addresses,
$accesskey_menubar_folders, $accesskey_menubar_options,
$accesskey_menubar_search, $accesskey_menubar_help,
$accesskey_menubar_signout;
$oTemplate->assign('accesskey_menubar_compose', $accesskey_menubar_compose);
$oTemplate->assign('accesskey_menubar_addresses', $accesskey_menubar_addresses);
$oTemplate->assign('accesskey_menubar_folders', $accesskey_menubar_folders);
$oTemplate->assign('accesskey_menubar_options', $accesskey_menubar_options);
$oTemplate->assign('accesskey_menubar_search', $accesskey_menubar_search);
$oTemplate->assign('accesskey_menubar_help', $accesskey_menubar_help);
$oTemplate->assign('accesskey_menubar_signout', $accesskey_menubar_signout);
$oTemplate->display('page_header.tpl');
global $null;
do_hook('page_header_bottom', $null);
}
/**
* Blatantly copied/truncated/modified from displayPageHeader.
* Outputs a page header specifically for the compose_in_new popup window
*
* @param array color the array of theme colors
* @param string mailbox the current mailbox name to display
* @param string sHeaderJs javascipt code to be inserted in a script block in the header
* @param string sOnload JavaScript code to be added inside the body's onload handler
* as of 1.5.2, this replaces $sBodyTagJs argument
* @return void
*/
function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
global $reply_focus, $action, $oTemplate;
if (empty($sOnload)) {
if (strpos($action, 'reply') !== FALSE && $reply_focus) {
if ($reply_focus == 'select')
$sOnload = 'checkForm(\'select\');';
else if ($reply_focus == 'focus')
$sOnload = 'checkForm(\'focus\');';
else if ($reply_focus != 'none')
$sOnload = 'checkForm();';
}
else
$sOnload = 'checkForm();';
}
/*
* Locate the first displayable form element (only when JavaScript on)
*/
if(checkForJavascript()) {
if ($sHeaderJs) {
$sJsBlock = "\n<script type=\"text/javascript\">" .
"\n<!--\n" .
$sHeaderJs . "\n\n// -->\n</script>\n";
} else {
$sJsBlock = '';
}
$sJsBlock .= "\n";
$js_includes = $oTemplate->get_javascript_includes(TRUE);
foreach ($js_includes as $js_file) {
$sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
}
displayHtmlHeader (_("Compose"), $sJsBlock);
} else {
/* javascript off */
displayHtmlHeader(_("Compose"));
$sOnload = '';
}
// FIXME: change the colorization attributes below to a CSS class!
$class = '';
$aAttribs = array('text' => $color[8], 'bgcolor' => $color[4],
'link' => $color[7], 'vlink' => $color[7],
'alink' => $color[7]);
// this is template-safe (see create_body() function)
echo create_body($sOnload, $class, $aAttribs);
global $null;
do_hook('compose_header_bottom', $null);
}
|