adding phpdoc blocks and including new themes into default config
[squirrelmail.git] / functions / page_header.php
CommitLineData
59177427 1<?php
7350889b 2
35586184 3/**
4 * page_header.php
5 *
82d304a0 6 * Copyright (c) 1999-2004 The SquirrelMail Project Team
35586184 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * Prints the page header (duh)
10 *
31841a9e 11 * @version $Id$
d6c32258 12 * @package squirrelmail
35586184 13 */
14
d6c32258 15/** Include required files from SM */
b68edc75 16require_once(SM_PATH . 'functions/strings.php');
17require_once(SM_PATH . 'functions/html.php');
18require_once(SM_PATH . 'functions/imap_mailbox.php');
0b97a708 19require_once(SM_PATH . 'functions/global.php');
b68edc75 20
d6c32258 21/**
8b096f0a 22 * Output a SquirrelMail page header, from <!doctype> to </head>
23 * Always set up the language before calling these functions.
24 *
25 * @param string title the page title, default SquirrelMail.
26 * @param string xtra extra HTML to insert into the header
27 * @param bool do_hook whether to execute hooks, default true
62b9c984 28 * @param bool frames generate html frameset doctype (since 1.5.1)
8b096f0a 29 * @return void
d6c32258 30 */
62b9c984 31function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = true, $frames = false ) {
e842b215 32 global $squirrelmail_language;
692155b7 33
0365891c 34 if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
0b97a708 35 global $base_uri;
36 }
b6c283c4 37 global $theme_css, $custom_css, $pageheader_sent;
2c21ef20 38
62b9c984 39 if ($frames) {
40 echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">';
91e0dccc 41 } else {
62b9c984 42 echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">';
43 }
44 echo "\n\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) . "\n<head>\n";
2c21ef20 45
a714cb95 46 if ( !isset( $custom_css ) || $custom_css == 'none' ) {
692155b7 47 if ($theme_css != '') {
d68323ff 48 echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"$theme_css\" />";
692155b7 49 }
8f1ba72b 50 } else {
d68323ff 51 echo '<link rel="stylesheet" type="text/css" href="' .
52 $base_uri . 'themes/css/'.$custom_css.'" />';
8f1ba72b 53 }
62f7daa5 54
e842b215 55 if ($squirrelmail_language == 'ja_JP') {
56 echo "<!-- \xfd\xfe -->\n";
04fa3c41 57 echo '<meta http-equiv="Content-type" content="text/html; charset=euc-jp" />' . "\n";
e842b215 58 }
62f7daa5 59
237470b4 60 if ($do_hook) {
d68323ff 61 do_hook('generic_header');
237470b4 62 }
62f7daa5 63
5ca4b1ee 64 echo "\n<title>$title</title>$xtra\n";
65
66 /* work around IE6's scrollbar bug */
67 echo <<<ECHO
68<style type="text/css">
69<!--
70 /* avoid stupid IE6 bug with frames and scrollbars */
62f7daa5 71 body {
72 voice-family: "\"}\"";
73 voice-family: inherit;
5ca4b1ee 74 width: expression(document.documentElement.clientWidth - 30);
75 }
76-->
77</style>
78
79ECHO;
80
81 echo "\n</head>\n\n";
b6c283c4 82
83 /* this is used to check elsewhere whether we should call this function */
84 $pageheader_sent = TRUE;
a07cd1a4 85}
86
8b096f0a 87/**
88 * Given a path to a SquirrelMail file, return a HTML link to it
89 *
90 * @param string path the SquirrelMail file to link to
91 * @param string text the link text
92 * @param string target the target frame for this link
93 */
d62c4938 94function makeInternalLink($path, $text, $target='') {
0365891c 95 sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
dcc1cc82 96 if ($target != '') {
97 $target = " target=\"$target\"";
98 }
d3714d3a 99 $hooktext = do_hook_function('internal_link',$text);
100 if ($hooktext != '')
101 $text = $hooktext;
d62c4938 102 return '<a href="'.$base_uri.$path.'"'.$target.'>'.$text.'</a>';
103}
104
8b096f0a 105/**
106 * Same as makeInternalLink, but echoes it too
107 */
d62c4938 108function displayInternalLink($path, $text, $target='') {
b26d81e5 109 echo makeInternalLink($path, $text, $target);
a07cd1a4 110}
111
8b096f0a 112/**
113 * Outputs a complete SquirrelMail page header, starting with <!doctype> and
114 * including the default menu bar. Uses displayHtmlHeader and takes
115 * JavaScript and locale settings into account.
116 *
117 * @param array color the array of theme colors
118 * @param string mailbox the current mailbox name to display
119 * @param string xtra extra html code to add
120 * @param bool session
121 * @return void
122 */
aca403fa 123function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
715225af 124
0b97a708 125 global $hide_sm_attributions, $PHP_SELF, $frame_top,
1ba8cd6b 126 $compose_new_win, $compose_width, $compose_height,
ce68b76b 127 $provider_name, $provider_uri, $startMessage,
128 $javascript_on, $default_use_mdn, $mdn_user_support;
715225af 129
0365891c 130 sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION );
131 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
715225af 132 $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
f3e14140 133 if ($qmark = strpos($module, '?')) {
134 $module = substr($module, 0, $qmark);
135 }
d03f3582 136 if (!isset($frame_top)) {
137 $frame_top = '_top';
138 }
715225af 139
735f6b9c 140 if ($session) {
1a531551 141 $compose_uri = $base_uri.'src/compose.php?mailbox='.urlencode($mailbox).'&amp;attachedmessages=true&amp;session='."$session";
aca403fa 142 } else {
087ce5f8 143 $compose_uri = $base_uri.'src/compose.php?newmessage=1';
1a531551 144 $session = 0;
aca403fa 145 }
62f7daa5 146
147 if($javascript_on) {
d62c4938 148
149 switch ( $module ) {
150 case 'src/read_body.php':
151 $js ='';
32485e5e 152
153 // compose in new window code
d62c4938 154 if ($compose_new_win == '1') {
155 if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
156 $compose_width = '640';
157 }
158 if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
159 $compose_height = '550';
160 }
1a531551 161 $js .= "function comp_in_new_form(comp_uri, button, myform) {\n".
162 ' if (!comp_uri) {'."\n".
163 ' comp_uri = "'.$compose_uri."\";\n".
164 ' }'. "\n".
165 ' comp_uri += "&" + button.name + "=1";'."\n".
166 ' for ( var i=0; i < myform.elements.length; i++ ) {'."\n".
167 ' if ( myform.elements[i].type == "checkbox" && myform.elements[i].checked )'."\n".
168 ' comp_uri += "&" + myform.elements[i].name + "=1";'."\n".
169 ' }'."\n".
170 ' var newwin = window.open(comp_uri' .
171 ', "_blank",'.
172 '"width='.$compose_width. ',height='.$compose_height.
75442b66 173 ',scrollbars=yes,resizable=yes,status=yes");'."\n".
1a531551 174 "}\n\n";
e346043e 175 $js .= "function comp_in_new(comp_uri) {\n".
176 " if (!comp_uri) {\n".
177 ' comp_uri = "'.$compose_uri."\";\n".
178 ' }'. "\n".
179 ' var newwin = window.open(comp_uri' .
180 ', "_blank",'.
181 '"width='.$compose_width. ',height='.$compose_height.
75442b66 182 ',scrollbars=yes,resizable=yes,status=yes");'."\n".
e346043e 183 "}\n\n";
32485e5e 184 }
d62c4938 185
32485e5e 186 // javascript for sending read receipts
187 if($default_use_mdn && $mdn_user_support) {
d62c4938 188 $js .= 'function sendMDN() {'."\n".
32485e5e 189 " mdnuri=window.location+'&sendreceipt=1'; ".
d62c4938 190 "var newwin = window.open(mdnuri,'right');".
1a531551 191 "\n}\n\n";
32485e5e 192 }
193
194 // if any of the above passes, add the JS tags too.
195 if($js) {
196 $js = "\n".'<script language="JavaScript" type="text/javascript">' .
197 "\n<!--\n" . $js . "// -->\n</script>\n";
198 }
d62c4938 199
32485e5e 200 displayHtmlHeader ('SquirrelMail', $js);
201 $onload = $xtra;
d62c4938 202 break;
203 case 'src/compose.php':
204 $js = '<script language="JavaScript" type="text/javascript">' .
205 "\n<!--\n" .
9f2f6126 206 "function checkForm() {\n";
207
208 global $action, $reply_focus;
209 if (strpos($action, 'reply') !== FALSE && $reply_focus)
210 {
211 if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
212 else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
192cdcf5 213 else if ($reply_focus == 'none') $js .= "}\n";
214 }
215 // no reply focus also applies to composing new messages
216 else if ($reply_focus == 'none')
217 {
218 $js .= "}\n";
9f2f6126 219 }
220 else
221 $js .= "var f = document.forms.length;\n".
d62c4938 222 "var i = 0;\n".
223 "var pos = -1;\n".
224 "while( pos == -1 && i < f ) {\n".
225 "var e = document.forms[i].elements.length;\n".
226 "var j = 0;\n".
227 "while( pos == -1 && j < e ) {\n".
228 "if ( document.forms[i].elements[j].type == 'text' ) {\n".
229 "pos = j;\n".
230 "}\n".
231 "j++;\n".
d7f8e6e6 232 "}\n".
d62c4938 233 "i++;\n".
d7f8e6e6 234 "}\n".
d62c4938 235 "if( pos >= 0 ) {\n".
236 "document.forms[i-1].elements[pos].focus();\n".
237 "}\n".
238 "}\n";
62f7daa5 239
d62c4938 240 $js .= "// -->\n".
1a531551 241 "</script>\n";
d62c4938 242 $onload = 'onload="checkForm();"';
243 displayHtmlHeader ('SquirrelMail', $js);
62f7daa5 244 break;
d62c4938 245
246 default:
247 $js = '<script language="JavaScript" type="text/javascript">' .
248 "\n<!--\n" .
249 "function checkForm() {\n".
250 "var f = document.forms.length;\n".
251 "var i = 0;\n".
252 "var pos = -1;\n".
253 "while( pos == -1 && i < f ) {\n".
254 "var e = document.forms[i].elements.length;\n".
255 "var j = 0;\n".
256 "while( pos == -1 && j < e ) {\n".
257 "if ( document.forms[i].elements[j].type == 'text' " .
258 "|| document.forms[i].elements[j].type == 'password' ) {\n".
259 "pos = j;\n".
260 "}\n".
261 "j++;\n".
353616c4 262 "}\n".
d62c4938 263 "i++;\n".
264 "}\n".
265 "if( pos >= 0 ) {\n".
266 "document.forms[i-1].elements[pos].focus();\n".
353616c4 267 "}\n".
1a531551 268 "$xtra\n".
d62c4938 269 "}\n";
62f7daa5 270
d62c4938 271 if ($compose_new_win == '1') {
272 if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
273 $compose_width = '640';
274 }
275 if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
276 $compose_height = '550';
277 }
278 $js .= "function comp_in_new(comp_uri) {\n".
75442b66 279 " if (!comp_uri) {\n".
280 ' comp_uri = "'.$compose_uri."\";\n".
281 ' }'. "\n".
d62c4938 282 ' var newwin = window.open(comp_uri' .
283 ', "_blank",'.
284 '"width='.$compose_width. ',height='.$compose_height.
75442b66 285 ',scrollbars=yes,resizable=yes,status=yes");'."\n".
d62c4938 286 "}\n\n";
287
9c3e6cd4 288 }
d62c4938 289 $js .= "// -->\n". "</script>\n";
62f7daa5 290
d62c4938 291 $onload = 'onload="checkForm();"';
292 displayHtmlHeader ('SquirrelMail', $js);
62f7daa5 293 break;
0cba960a 294
d62c4938 295 }
296 } else {
297 /* do not use JavaScript */
298 displayHtmlHeader ('SquirrelMail');
299 $onload = '';
715225af 300 }
301
b01b21d0 302 echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
a07cd1a4 303 /** Here is the header and wrapping table **/
72520f77 304 $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
91e0dccc 305 readShortMailboxName($mailbox, $delimiter)));
3b7d68e6 306 if ( $shortBoxName == 'INBOX' ) {
7da23762 307 $shortBoxName = _("INBOX");
308 }
b01b21d0 309 echo "<a name=\"pagetop\"></a>\n"
310 . html_tag( 'table', '', '', $color[4], 'border="0" width="100%" cellspacing="0" cellpadding="2"' ) ."\n"
311 . html_tag( 'tr', '', '', $color[9] ) ."\n"
312 . html_tag( 'td', '', 'left' ) ."\n";
5bb2a991 313 if ( $shortBoxName <> '' && strtolower( $shortBoxName ) <> 'none' ) {
b01b21d0 314 echo ' ' . _("Current Folder") . ": <b>$shortBoxName&nbsp;</b>\n";
5bb2a991 315 } else {
316 echo '&nbsp;';
317 }
b01b21d0 318 echo " </td>\n"
319 . html_tag( 'td', '', 'right' ) ."<b>\n";
80e86e94 320 displayInternalLink ('src/signout.php', _("Sign Out"), $frame_top);
b01b21d0 321 echo "</b></td>\n"
322 . " </tr>\n"
323 . html_tag( 'tr', '', '', $color[4] ) ."\n"
99ea51d3 324 . ($hide_sm_attributions ? html_tag( 'td', '', 'left', '', 'colspan="2"' )
325 : html_tag( 'td', '', 'left' ) )
326 . "\n";
a07cd1a4 327 $urlMailbox = urlencode($mailbox);
e233a3ad 328 echo makeComposeLink('src/compose.php?mailbox='.$urlMailbox.'&amp;startMessage='.$startMessage);
a07cd1a4 329 echo "&nbsp;&nbsp;\n";
21a957a9 330 displayInternalLink ('src/addressbook.php', _("Addresses"));
a07cd1a4 331 echo "&nbsp;&nbsp;\n";
21a957a9 332 displayInternalLink ('src/folders.php', _("Folders"));
a07cd1a4 333 echo "&nbsp;&nbsp;\n";
21a957a9 334 displayInternalLink ('src/options.php', _("Options"));
a07cd1a4 335 echo "&nbsp;&nbsp;\n";
21a957a9 336 displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search"));
a07cd1a4 337 echo "&nbsp;&nbsp;\n";
21a957a9 338 displayInternalLink ('src/help.php', _("Help"));
a07cd1a4 339 echo "&nbsp;&nbsp;\n";
340
d68323ff 341 do_hook('menuline');
a07cd1a4 342
99ea51d3 343 echo " </td>\n";
344
345 if (!$hide_sm_attributions)
346 {
347 echo html_tag( 'td', '', 'right' ) ."\n";
348 if (!isset($provider_uri)) $provider_uri= 'http://www.squirrelmail.org/';
349 if (!isset($provider_name)) $provider_name= 'SquirrelMail';
350 echo '<a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>';
351 echo "</td>\n";
352 }
353 echo " </tr>\n".
04fa3c41 354 "</table><br />\n\n";
a07cd1a4 355}
2ba13803 356
8b096f0a 357/**
358 * Blatantly copied/truncated/modified from displayPageHeader.
359 * Outputs a page header specifically for the compose_in_new popup window
360 *
361 * @param array color the array of theme colors
362 * @param string mailbox the current mailbox name to display
363 * @return void
364 */
9c3e6cd4 365function compose_Header($color, $mailbox) {
366
d62c4938 367 global $javascript_on;
9c3e6cd4 368
369 /*
d62c4938 370 * Locate the first displayable form element (only when JavaScript on)
371 */
372 if($javascript_on) {
ce68b76b 373 global $base_uri, $PHP_SELF, $data_dir, $username;
d62c4938 374
375 $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
376
377 switch ( $module ) {
378 case 'src/search.php':
379 $pos = getPref($data_dir, $username, 'search_pos', 0 ) - 1;
380 $onload = "onload=\"document.forms[$pos].elements[2].focus();\"";
381 displayHtmlHeader (_("Compose"));
382 break;
383 default:
384 $js = '<script language="JavaScript" type="text/javascript">' .
385 "\n<!--\n" .
9f2f6126 386 "function checkForm() {\n";
387
388 global $action, $reply_focus;
389 if (strpos($action, 'reply') !== FALSE && $reply_focus)
390 {
391 if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
392 else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
192cdcf5 393 else if ($reply_focus == 'none') $js .= "}\n";
394 }
395 // no reply focus also applies to composing new messages
396 else if ($reply_focus == 'none')
397 {
398 $js .= "}\n";
9f2f6126 399 }
400 else
401 $js .= "var f = document.forms.length;\n".
d62c4938 402 "var i = 0;\n".
403 "var pos = -1;\n".
404 "while( pos == -1 && i < f ) {\n".
405 "var e = document.forms[i].elements.length;\n".
406 "var j = 0;\n".
407 "while( pos == -1 && j < e ) {\n".
408 "if ( document.forms[i].elements[j].type == 'text' ) {\n".
409 "pos = j;\n".
410 "}\n".
411 "j++;\n".
9c3e6cd4 412 "}\n".
d62c4938 413 "i++;\n".
9c3e6cd4 414 "}\n".
d62c4938 415 "if( pos >= 0 ) {\n".
416 "document.forms[i-1].elements[pos].focus();\n".
417 "}\n".
418 "}\n";
419 $js .= "// -->\n".
1a531551 420 "</script>\n";
d62c4938 421 $onload = 'onload="checkForm();"';
422 displayHtmlHeader (_("Compose"), $js);
62f7daa5 423 break;
d62c4938 424 }
425 } else {
426 /* javascript off */
427 displayHtmlHeader(_("Compose"));
428 $onload = '';
9c3e6cd4 429 }
430
b01b21d0 431 echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
9c3e6cd4 432}
e842b215 433
62f7daa5 434?>