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