Source for file page_header.php

Documentation is available at page_header.php

  1. <?php
  3. /**
  4. * page_header.php
  5. *
  6. * Prints the page header (duh)
  7. *
  8. * @copyright 1999-2020 The SquirrelMail Project Team
  9. * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10. * @version $Id: page_header.php 14840 2020年01月07日 07:42:38Z pdontthink $
  11. * @package squirrelmail
  12. */
  14. /** Include required files from SM */
  15. require_once(SM_PATH . 'functions/strings.php');
  16. require_once(SM_PATH . 'functions/html.php');
  17. require_once(SM_PATH . 'functions/imap_mailbox.php');
  18. require_once(SM_PATH . 'functions/global.php');
  20. /* Always set up the language before calling these functions */
  21. /**
  22. * @param string $title This is placed directly in the HTML <title> tag,
  23. * so should be sanitized and ready to go
  24. * @param boolean $xtra_param Any additional HTML code that should be
  25. * included in the <head> tag - this is also
  26. * sent to the browser as-is, so should be pre-
  27. * sanitized
  28. * @param boolean $do_hook When TRUE, the "generic_header" hook is fired
  29. * herein.
  30. * @param array $script_libs_param A list of strings which each point to
  31. * a script to be added to the <head> of
  32. * the page being built. Each string can
  33. * be:
  34. * - One of the pre-defined SM_SCRIPT_LIB_XXX
  35. * constants (see functions/constants.php)
  36. * that correspond to libraries that come
  37. * with SquirrelMail
  38. * - A path to a custom script (say, in a
  39. * plugin directory) (detected by the
  40. * existence of at least one path separator
  41. * in the string) - the script is assumed
  42. * to be and is included as JavaScript
  43. * - A full tag ("<script>", "<style>" or
  44. * other) that will be placed verbatim in
  45. * the page header (detected by the presence
  46. * of a "<" character at the beginning of
  47. * the string). NOTE that $xtra provides the
  48. * same function, without needing the string
  49. * to start with "<"
  50. */
  51. function displayHtmlHeader ($title='SquirrelMail', $xtra_param='', $do_hook=TRUE, $script_libs_param=array()) {
  52. global $squirrelmail_language, $xtra, $script_libs;
  54. // $script_libs and $xtra are globalized to allow plugins to
  55. // modify them on the generic_header hook, but we also want to
  56. // respect the values passed in from the function args, thus:
  57. $xtra = $xtra_param;
  58. $script_libs = $script_libs_param;
  59. if (!is_array ($script_libs))
  60. $script_libs = array($script_libs);
  62. if ( !sqgetGlobalVar ('base_uri', $base_uri, SQ_SESSION ) ) {
  63. global $base_uri;
  64. }
  65. global $theme_css , $custom_css, $pageheader_sent, $browser_rendering_mode , $head_tag_extra;
  67. // prevent clickjack attempts
  68. // 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
  69. header ('X-Frame-Options: SAMEORIGIN');
  71. echo ($browser_rendering_mode === 'standards'
  72. ? '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">'
  73. : ($browser_rendering_mode === 'almost'
  74. ? '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">'
  75. : /* "quirks" */ '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">')) .
  76. "\n\n" . html_tag ( 'html' ,'' , '', '', '' ) . "\n<head>\n" .
  77. "<meta name=\"robots\" content=\"noindex,nofollow\">\n" .
  78. "<meta http-equiv=\"x-dns-prefetch-control\" content=\"off\">\n"
  80. // For adding a favicon or anything else that should be inserted in *ALL* <head> for *ALL* documents,
  81. // define $head_tag_extra in config/config_local.php
  82. // The string "###SM BASEURI###" will be replaced with the base URI for this SquirrelMail installation.
  83. // When not defined, a default is provided that displays the default favicon.ico.
  84. // If you override this and still want to use the default favicon.ico, you'll have to include the following
  85. // following in your $head_tag_extra string:
  86. // $head_tag_extra = '<link rel="shortcut icon" href="###SM BASEURI###favicon.ico" />...<YOUR CONTENT HERE>...';
  87. //
  88. . (empty($head_tag_extra) ? '<link rel="shortcut icon" href="' . sqm_baseuri () . 'favicon.ico" />'
  89. : str_replace ('###SM BASEURI###', sqm_baseuri (), $head_tag_extra))
  91. // prevent clickjack attempts using JavaScript for browsers that
  92. // don't support the X-Frame-Options header...
  93. // we check to see if we are *not* the top page, and if not, check
  94. // whether or not the top page is in the same domain as we are...
  95. // if not, log out immediately -- this is an attempt to do the same
  96. // thing that the X-Frame-Options does using JavaScript (never a good
  97. // idea to rely on JavaScript-based solutions, though)
  98. . '<script type="text/javascript" language="JavaScript">'
  99. . "\n<!--\n"
  100. . 'if (self != top) { try { if (document.domain != top.document.domain) {'
  101. . ' 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 = "'
  102. . sqm_baseuri () . 'src/signout.php"; top.location = "'
  103. . sqm_baseuri () . 'src/signout.php" } }'
  104. . "\n// -->\n</script>\n";
  106. if ( !isset( $custom_css ) || $custom_css == 'none' ) {
  107. if ($theme_css != '') {
  108. echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"$theme_css\">";
  109. }
  110. } else {
  111. echo '<link rel="stylesheet" type="text/css" href="' .
  112. $base_uri . 'themes/css/'.$custom_css.'">';
  113. }
  115. if ($squirrelmail_language == 'ja_JP') {
  116. // Why is it added here? Header ('Content-Type:..) is used in i18n.php
  117. echo "<!-- \xfd\xfe -->\n";
  118. echo '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
  119. }
  121. if ($do_hook) {
  122. do_hook ('generic_header');
  123. }
  125. echo "\n<title>$title</title>$xtra\n";
  127. // output <script> tags as needed (use array_unique so
  128. // more than one plugin can ask for the same library)
  129. //
  130. // usage of $script_libs is discussed in the docs for this function above
  131. //
  132. foreach (array_unique ($script_libs) as $item) {
  133. if ($item{0} === '<')
  134. echo $item . "\n";
  135. else if (strpos ($item, '/') !== FALSE || strpos ($item, '\\') !== FALSE)
  136. echo '<script language="JavaScript" type="text/javascript" src="' . $item . '"></script>' . "\n";
  137. else
  138. echo '<script language="JavaScript" type="text/javascript" src="' . $base_uri . 'scripts/' . $item . '"></script>' . "\n";
  139. }
  141. /* work around IE6's scrollbar bug */
  142. echo <<<ECHO
  143. <!--[if IE 6]>
  144. <style type="text/css">
  145. /* avoid stupid IE6 bug with frames and scrollbars */
  146. body {
  147. width: expression(document.documentElement.clientWidth - 30);
  148. }
  149. </style>
  150. <![endif]-->
  152. ECHO;
  154. echo "\n</head>\n\n";
  156. /* this is used to check elsewhere whether we should call this function */
  157. $pageheader_sent = TRUE;
  158. }
  160. function makeInternalLink ($path, $text, $target='') {
  161. sqgetGlobalVar ('base_uri', $base_uri, SQ_SESSION );
  162. if ($target != '') {
  163. $target = " target=\"$target\"";
  164. }
  165. return '<a href="'.$base_uri.$path.'"'.$target.'>'.$text.'</a>';
  166. }
  168. function displayInternalLink ($path, $text, $target='') {
  169. echo makeInternalLink ($path, $text, $target);
  170. }
  172. function displayPageHeader ($color, $mailbox, $xtra='', $session=false) {
  175. $compose_new_win, $compose_width, $compose_height,
  176. $attachemessages, $provider_name , $provider_uri ,
  177. $javascript_on, $default_use_mdn , $mdn_user_support,
  178. $startMessage, $org_title ;
  180. sqgetGlobalVar ('base_uri', $base_uri, SQ_SESSION );
  181. sqgetGlobalVar ('delimiter', $delimiter, SQ_SESSION );
  182. if (!isset($frame_top)) {
  183. $frame_top = '_top';
  184. }
  186. if ($session) {
  187. $compose_uri = $base_uri.'src/compose.php?mailbox='.urlencode ($mailbox).'&amp;session='."$session";
  188. } else {
  189. $compose_uri = $base_uri.'src/compose.php?newmessage=1';
  190. $session = 0;
  191. }
  193. // only output JavaScript if actually turned on
  194. if($javascript_on || strpos ($xtra, 'new_js_autodetect_results.value') ) {
  195. if ( !defined ('PAGE_NAME') ) define ('PAGE_NAME', NULL);
  196. switch ( PAGE_NAME ) {
  197. case 'read_body':
  198. $js ='';
  200. // compose in new window code
  201. if ($compose_new_win == '1') {
  202. if (!preg_match ("/^[0-9]{3,4}$/", $compose_width)) {
  203. $compose_width = '640';
  204. }
  205. if (!preg_match ("/^[0-9]{3,4}$/", $compose_height)) {
  206. $compose_height = '550';
  207. }
  208. $js .= "function comp_in_new(comp_uri) {\n".
  209. " if (!comp_uri) {\n".
  210. ' comp_uri = "'.$compose_uri."\";\n".
  211. ' }'. "\n".
  212. ' var newwin = window.open(comp_uri' .
  213. ', "_blank",'.
  214. '"width='.$compose_width. ',height='.$compose_height.
  215. ',scrollbars=yes,resizable=yes,status=yes");'."\n".
  216. "}\n\n";
  217. }
  219. // javascript for sending read receipts
  220. if($default_use_mdn && $mdn_user_support) {
  221. $js .= "function sendMDN() {\n".
  222. " mdnuri=window.location+'&sendreceipt=1';\n" .
  223. " window.location = mdnuri;\n" .
  224. "\n}\n\n";
  225. }
  227. // if any of the above passes, add the JS tags too.
  228. if($js) {
  229. $js = "\n".'<script language="JavaScript" type="text/javascript">' .
  230. "\n<!--\n" . $js . "// -->\n</script>\n";
  231. }
  233. displayHtmlHeader ($org_title, $js);
  234. $onload = $xtra;
  235. break;
  236. case 'compose':
  237. $js = '<script language="JavaScript" type="text/javascript">' .
  238. "\n<!--\n" .
  239. "var alreadyFocused = false;\n" .
  240. "function cursorToTop(element) {\n" .
  241. " if (typeof element.selectionStart == 'number')\n" .
  242. // also works:
  243. // " element.setSelectionRange(0, 0);\n" .
  244. " element.selectionStart = element.selectionEnd = 0;\n" .
  245. " else if (typeof element.createTextRange != 'undefined') {\n" .
  246. " var selectionRange = element.createTextRange();\n" .
  247. // also works, but maybe more recent?:
  248. // " selectionRange.collapse(true);\n" .
  249. " selectionRange.moveStart('character', 0);\n" .
  250. " selectionRange.select();\n" .
  251. " }\n" .
  252. "}\n" .
  253. "function checkForm() {\n" .
  254. "\n if (alreadyFocused) return;\n";
  256. global $action, $reply_focus;
  257. if (strpos ($action, 'reply') !== FALSE && $reply_focus)
  258. {
  259. if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
  260. else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus(); cursorToTop(document.forms['compose'].body);}\n";
  261. else if ($reply_focus == 'none') $js .= "}\n";
  262. }
  263. // no reply focus also applies to composing new messages
  264. else if ($reply_focus == 'none')
  265. {
  266. $js .= "}\n";
  267. }
  268. else
  269. $js .= " var f = document.forms.length;\n".
  270. " var i = 0;\n".
  271. " var remembered_form = -1;\n".
  272. " var pos = -1;\n".
  273. " var remembered_pos = -1;\n".
  274. " while( pos == -1 && i < f ) {\n".
  275. " var e = document.forms[i].elements.length;\n".
  276. " var j = 0;\n".
  277. " while( pos == -1 && j < e ) {\n".
  278. " if ( document.forms[i].elements[j].type == 'text' ) {\n".
  279. " if ( document.forms[i].elements[j].id.substring(0, 13) == '__lastfocus__' ) {\n".
  280. " remembered_pos = j;\n".
  281. " remembered_form = i;\n".
  282. " } else if ( document.forms[i].elements[j].id.substring(0, 11) != '__nofocus__' ) {\n".
  283. " pos = j;\n".
  284. " }\n".
  285. " }\n".
  286. " j++;\n".
  287. " }\n".
  288. " i++;\n".
  289. " }\n".
  290. " if( pos >= 0 ) {\n".
  291. " document.forms[i-1].elements[pos].focus();\n".
  292. " } else if ( remembered_pos >= 0 ) {\n".
  293. " document.forms[remembered_form].elements[remembered_pos].focus();\n".
  294. " }\n".
  295. "}\n";
  297. $js .= "// -->\n".
  298. "</script>\n";
  299. $onload = 'onload="checkForm();"';
  300. displayHtmlHeader ($org_title, $js);
  301. break;
  303. default:
  304. $js = '<script language="JavaScript" type="text/javascript">' .
  305. "\n<!--\n" .
  306. "var alreadyFocused = false;\n" .
  307. "function checkForm() {\n".
  308. " if (alreadyFocused) return;\n".
  309. " var f = document.forms.length;\n".
  310. " var i = 0;\n".
  311. " var remembered_form = -1;\n".
  312. " var pos = -1;\n".
  313. " var remembered_pos = -1;\n".
  314. " while( pos == -1 && i < f ) {\n".
  315. " var e = document.forms[i].elements.length;\n".
  316. " var j = 0;\n".
  317. " while( pos == -1 && j < e ) {\n".
  318. " if ( document.forms[i].elements[j].type == 'text' " .
  319. " || document.forms[i].elements[j].type == 'password' ) {\n".
  320. " if ( document.forms[i].elements[j].id.substring(0, 13) == '__lastfocus__' ) {\n".
  321. " remembered_pos = j;\n".
  322. " remembered_form = i;\n".
  323. " } else if ( document.forms[i].elements[j].id.substring(0, 11) != '__nofocus__' ) {\n".
  324. " pos = j;\n".
  325. " }\n".
  326. " }\n".
  327. " j++;\n".
  328. " }\n".
  329. " i++;\n".
  330. " }\n".
  331. " if( pos >= 0 ) {\n".
  332. " document.forms[i-1].elements[pos].focus();\n".
  333. " } else if ( remembered_pos >= 0 ) {\n".
  334. " document.forms[remembered_form].elements[remembered_pos].focus();\n".
  335. " }\n".
  336. " $xtra\n".
  337. "}\n";
  339. if ($compose_new_win == '1') {
  340. if (!preg_match ("/^[0-9]{3,4}$/", $compose_width)) {
  341. $compose_width = '640';
  342. }
  343. if (!preg_match ("/^[0-9]{3,4}$/", $compose_height)) {
  344. $compose_height = '550';
  345. }
  346. $js .= "function comp_in_new(comp_uri) {\n".
  347. " if (!comp_uri) {\n".
  348. ' comp_uri = "'.$compose_uri."\";\n".
  349. ' }'. "\n".
  350. ' var newwin = window.open(comp_uri' .
  351. ', "_blank",'.
  352. '"width='.$compose_width. ',height='.$compose_height.
  353. ',scrollbars=yes,resizable=yes,status=yes");'."\n".
  354. "}\n\n";
  356. }
  357. $js .= "// -->\n". "</script>\n";
  360. $onload = 'onload="checkForm();"';
  361. displayHtmlHeader ($org_title, $js);
  362. } // end switch module
  363. } else {
  364. // JavaScript off
  365. displayHtmlHeader ($org_title);
  366. $onload = '';
  367. }
  369. echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
  370. /** Here is the header and wrapping table **/
  372. readShortMailboxName ($mailbox, $delimiter)));
  373. if ( $shortBoxName == 'INBOX' ) {
  374. $shortBoxName = _ ("INBOX");
  375. }
  376. echo "<a name=\"pagetop\"></a>\n"
  377. . html_tag ( 'table', '', '', $color[4], 'border="0" width="100%" cellspacing="0" cellpadding="2"' ) ."\n"
  378. . html_tag ( 'tr', '', '', $color[9] ) ."\n"
  379. . html_tag ( 'td', '', 'left' ) ."\n";
  380. if ( $shortBoxName <> '' && strtolower ( $shortBoxName ) <> 'none' ) {
  381. echo ' ' . _ ("Current Folder") . ": <b>$shortBoxName&nbsp;</b>\n";
  382. } else {
  383. echo '&nbsp;';
  384. }
  385. echo " </td>\n"
  386. . html_tag ( 'td', '', 'right' ) ."<b>\n";
  387. displayInternalLink ('src/signout.php', _ ("Sign Out"), $frame_top);
  388. echo "</b></td>\n"
  389. . " </tr>\n"
  390. . html_tag ( 'tr', '', '', $color[4] ) ."\n"
  391. . ($hide_sm_attributions ? html_tag ( 'td', '', 'left', '', 'colspan="2"' )
  392. : html_tag ( 'td', '', 'left' ) )
  393. . "\n";
  394. $urlMailbox = urlencode ($mailbox);
  395. $startMessage = (int)$startMessage;
  396. echo makeComposeLink ('src/compose.php?mailbox='.$urlMailbox.'&amp;startMessage='.$startMessage);
  397. echo "&nbsp;&nbsp;\n";
  398. displayInternalLink ('src/addressbook.php', _ ("Addresses"));
  399. echo "&nbsp;&nbsp;\n";
  400. displayInternalLink ('src/folders.php', _ ("Folders"));
  401. echo "&nbsp;&nbsp;\n";
  402. displayInternalLink ('src/options.php', _ ("Options"));
  403. echo "&nbsp;&nbsp;\n";
  404. displayInternalLink ("src/search.php?mailbox=$urlMailbox&amp;what=", _ ("Search"));
  405. echo "&nbsp;&nbsp;\n";
  406. displayInternalLink ('src/help.php', _ ("Help"));
  407. echo "&nbsp;&nbsp;\n";
  409. do_hook ('menuline');
  411. echo " </td>\n";
  413. if (!$hide_sm_attributions)
  414. {
  415. echo html_tag ( 'td', '', 'right' ) ."\n";
  416. if (!isset($provider_uri)) $provider_uri= 'http://squirrelmail.org/';
  417. if (!isset($provider_name)) $provider_name= 'SquirrelMail';
  418. echo '<a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>';
  419. echo "</td>\n";
  420. }
  421. echo " </tr>\n".
  422. "</table><br>\n\n";
  423. }
  425. /* blatently copied/truncated/modified from the above function */
  426. function compose_Header ($color, $mailbox) {
  428. global $delimiter, $hide_sm_attributions , $base_uri,
  429. $data_dir , $username, $frame_top , $compose_new_win;
  432. if (!isset($frame_top)) {
  433. $frame_top = '_top';
  434. }
  436. /*
  437. Locate the first displayable form element
  438. */
  439. if ( !defined ('PAGE_NAME') ) define ('PAGE_NAME', NULL);
  440. switch ( PAGE_NAME ) {
  441. case 'search':
  442. $pos = getPref ($data_dir, $username, 'search_pos', 0 ) - 1;
  443. $onload = "onload=\"document.forms[$pos].elements[2].focus();\"";
  444. displayHtmlHeader (_ ("Compose"));
  445. break;
  446. default:
  447. $js = '<script language="JavaScript" type="text/javascript">' .
  448. "\n<!--\n" .
  449. "var alreadyFocused = false;\n" .
  450. "function checkForm() {\n" .
  451. "\n if (alreadyFocused) return;\n";
  453. global $action, $reply_focus;
  454. if (strpos ($action, 'reply') !== FALSE && $reply_focus)
  455. {
  456. if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
  457. else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
  458. else if ($reply_focus == 'none') $js .= "}\n";
  459. }
  460. // no reply focus also applies to composing new messages
  461. else if ($reply_focus == 'none')
  462. {
  463. $js .= "}\n";
  464. }
  465. else
  466. $js .= "var f = document.forms.length;\n".
  467. "var i = 0;\n".
  468. "var remembered_form = -1;\n".
  469. "var pos = -1;\n".
  470. "var remembered_pos = -1;\n".
  471. "while( pos == -1 && i < f ) {\n".
  472. "var e = document.forms[i].elements.length;\n".
  473. "var j = 0;\n".
  474. "while( pos == -1 && j < e ) {\n".
  475. "if ( document.forms[i].elements[j].type == 'text' ) {\n".
  476. "if ( document.forms[i].elements[j].id.substring(0, 13) == '__lastfocus__' ) {\n".
  477. "remembered_pos = j;\n".
  478. "remembered_form = i;\n".
  479. "} else if ( document.forms[i].elements[j].id.substring(0, 11) != '__nofocus__' ) {\n".
  480. "pos = j;\n".
  481. "}\n".
  482. "}\n".
  483. "j++;\n".
  484. "}\n".
  485. "i++;\n".
  486. "}\n".
  487. "if( pos >= 0 ) {\n".
  488. "document.forms[i-1].elements[pos].focus();\n".
  489. "} else if ( remembered_pos >= 0 ) {\n".
  490. "document.forms[remembered_form].elements[remembered_pos].focus();\n".
  491. "}\n".
  492. "}\n";
  493. $js .= "// -->\n".
  494. "</script>\n";
  495. $onload = 'onload="checkForm();"';
  496. displayHtmlHeader (_ ("Compose"), $js);
  497. break;
  499. }
  501. echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
  502. }

Documentation generated on 2020年1月13日 04:25:09 +0100 by phpDocumentor 1.4.3

AltStyle によって変換されたページ (->オリジナル) /