page_header.php 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. <?php
  2. /**
  3. * page_header.php
  4. *
  5. * Prints the page header (duh)
  6. *
  7. * @copyright &copy; 1999-2007 The SquirrelMail Project Team
  8. * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  9. * @version $Id$
  10. * @package squirrelmail
  11. */
  12. /** Include required files from SM */
  13. include_once(SM_PATH . 'functions/imap_mailbox.php');
  14. /**
  15. * Output a SquirrelMail page header, from <!doctype> to </head>
  16. * Always set up the language before calling these functions.
  17. *
  18. * Since 1.5.1 function sends http headers. Function should be called
  19. * before any output is started.
  20. * @param string title the page title, default SquirrelMail.
  21. * @param string xtra extra HTML to insert into the header
  22. * @param bool do_hook whether to execute hooks, default true
  23. * @param bool frames generate html frameset doctype (since 1.5.1)
  24. * @return void
  25. */
  26. function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE ) {
  27. global $squirrelmail_language, $sTemplateID, $oErrorHandler, $oTemplate;
  28. if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
  29. global $base_uri;
  30. }
  31. global $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction,
  32. $default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize,
  33. $chosen_theme, $chosen_theme_path, $user_themes, $user_theme_default;
  34. /* add no cache headers here */
  35. //FIXME: should change all header() calls in SM core to use $oTemplate->header()!!
  36. $oTemplate->header('Pragma: no-cache'); // http 1.0 (rfc1945)
  37. $oTemplate->header('Cache-Control: private, no-cache, no-store'); // http 1.1 (rfc2616)
  38. $oTemplate->assign('frames', $frames);
  39. $oTemplate->assign('lang', $squirrelmail_language);
  40. $header_tags = '';
  41. $header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\">\n";
  42. $used_fontset = (!empty($chosen_fontset) ? $chosen_fontset : $default_fontset);
  43. $used_fontsize = (!empty($chosen_fontsize) ? $chosen_fontsize : $default_fontsize);
  44. $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;
  45. /**
  46. * Stylesheets are loaded in the following order:
  47. * 1) All stylesheets provided by the template. Normally, these are
  48. * stylsheets in templates/<template>/css/. This is accomplished by calling
  49. * $oTemplate->fetch_standard_stylesheet_links().
  50. * 2) An optional user-defined stylesheet. This is set in the Display
  51. * Preferences.
  52. * 3) src/style.php which sets some basic font prefs.
  53. * 4) If we are dealing with an RTL language, we load rtl.css from the
  54. * template set.
  55. */
  56. // 1. Stylesheets from the template.
  57. $header_tags .= $oTemplate->fetch_standard_stylesheet_links();
  58. $aUserStyles = array();
  59. // 2. Option user-defined stylesheet from preferences.
  60. if (!empty($used_theme)) {
  61. /**
  62. * All styles just point to a directory, so we need to include all .css
  63. * files in that directory.
  64. */
  65. $styles = list_files($used_theme, '.css');
  66. foreach ($styles as $sheet) {
  67. $aUserStyles[] = $used_theme .'/'.$sheet;
  68. }
  69. }
  70. // 3. src/style.php
  71. $aUserStyles[] = $base_uri .'src/style.php?'
  72. . (!empty($used_fontset) ? '&amp;fontset='.$used_fontset : '')
  73. . (!empty($used_fontsize) ? '&amp;fontsize='.$used_fontsize : '');
  74. // 3.1. Load the stylesheets we have already
  75. $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
  76. // 4. Optional rtl.css stylesheet
  77. if ($text_direction == 'rtl') {
  78. $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
  79. }
  80. if ($squirrelmail_language == 'ja_JP') {
  81. /*
  82. * force correct detection of charset, when browser does not follow
  83. * http content-type and tries to detect charset from page content.
  84. * Shooting of browser's creator can't be implemented in php.
  85. * We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
  86. * recommendations and switch to unicode.
  87. */
  88. $header_tags .= "<!-- \xfd\xfe -->\n";
  89. $header_tags .= '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
  90. }
  91. if ($do_hook) {
  92. // NOTE! plugins here MUST assign output to template
  93. // and NOT echo anything directly!! A common
  94. // approach is if a plugin decides it needs to
  95. // put something at page-top after the standard
  96. // SM page header, to dynamically add itself to
  97. // the page_header_bottom and/or compose_header_bottom
  98. // hooks for the current page request. See
  99. // the Sent Confirmation v1.7 or Restrict Senders v1.2
  100. // plugins for examples of this approach.
  101. global $null;
  102. ob_start();
  103. do_hook('generic_header', $null);
  104. $output = ob_get_contents();
  105. ob_end_clean();
  106. // plugin authors can debug their errors with one of the following:
  107. //sm_print_r($output);
  108. //echo $output;
  109. if (!empty($output)) trigger_error('A plugin on the "generic_header" hook has attempted to output directly to the browser', E_USER_ERROR);
  110. }
  111. $header_tags .= $xtra;
  112. $oTemplate->assign('page_title', $title);
  113. /* work around IE6's scrollbar bug */
  114. $header_tags .= <<<EOS
  115. <!--[if IE 6]>
  116. <style type="text/css">
  117. /* avoid stupid IE6 bug with frames and scrollbars */
  118. body {
  119. width: expression(document.documentElement.clientWidth - 30);
  120. }
  121. </style>
  122. <![endif]-->
  123. EOS;
  124. $oTemplate->assign('header_tags', $header_tags);
  125. $oTemplate->display('protocol_header.tpl');
  126. /* this is used to check elsewhere whether we should call this function */
  127. $pageheader_sent = TRUE;
  128. if (isset($oErrorHandler)) {
  129. $oErrorHandler->HeaderSent();
  130. }
  131. }
  132. /**
  133. * Given a path to a SquirrelMail file, return a HTML link to it
  134. *
  135. * @param string path the SquirrelMail file to link to
  136. * @param string text the link text
  137. * @param string target the target frame for this link
  138. */
  139. function makeInternalLink($path, $text, $target='') {
  140. global $base_uri, $oTemplate;
  141. // sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
  142. // This is an inefficient hook and is only used by
  143. // one plugin that still needs to patch this code,
  144. // plus if we are templat-izing SM, visual hooks
  145. // are not needed. However, I am leaving the code
  146. // here just in case we find a good (non-visual?)
  147. // use for the internal_link hook.
  148. //
  149. //do_hook('internal_link', $text);
  150. return create_hyperlink($base_uri . $path, $text, $target);
  151. }
  152. /**
  153. * Same as makeInternalLink, but echoes it too
  154. */
  155. function displayInternalLink($path, $text, $target='') {
  156. // FIXME: should let the template echo all these kinds of things
  157. echo makeInternalLink($path, $text, $target);
  158. }
  159. /**
  160. * Outputs a complete SquirrelMail page header, starting with <!doctype> and
  161. * including the default menu bar. Uses displayHtmlHeader and takes
  162. * JavaScript and locale settings into account.
  163. *
  164. * @param array color the array of theme colors
  165. * @param string mailbox the current mailbox name to display
  166. * @param string sHeaderJs javascipt code to be inserted in a script block in the header
  167. * @param string sBodyTagJs js events to be inserted in the body tag
  168. * @return void
  169. */
  170. function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sBodyTagJs = '') {
  171. global $reply_focus, $hide_sm_attributions, $frame_top,
  172. $provider_name, $provider_uri, $startMessage,
  173. $action, $oTemplate, $org_title, $base_uri;
  174. //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)
  175. if (empty($sBodyTagJs)) {
  176. if (strpos($action, 'reply') !== FALSE && $reply_focus) {
  177. if ($reply_focus == 'select')
  178. $sBodyTagJs = 'onload="checkForm(\'select\');"';
  179. else if ($reply_focus == 'focus')
  180. $sBodyTagJs = 'onload="checkForm(\'focus\');"';
  181. else if ($reply_focus != 'none')
  182. $sBodyTagJs = 'onload="checkForm();"';
  183. }
  184. else
  185. $sBodyTagJs = 'onload="checkForm();"';
  186. }
  187. $urlMailbox = urlencode($mailbox);
  188. $startMessage = (int)$startMessage;
  189. sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
  190. if (!isset($frame_top)) {
  191. $frame_top = '_top';
  192. }
  193. //FIXME: does checkForJavascript() make the 2nd part of the if() below unneccessary??
  194. if( checkForJavascript() || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
  195. $js_includes = $oTemplate->get_javascript_includes(TRUE);
  196. $sJsBlock = '';
  197. foreach ($js_includes as $js_file) {
  198. $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
  199. }
  200. if ($sHeaderJs) {
  201. $sJsBlock .= "\n<script type=\"text/javascript\">" .
  202. "\n<!--\n" .
  203. $sHeaderJs . "\n\n// -->\n</script>\n";
  204. }
  205. displayHtmlHeader ($org_title, $sJsBlock);
  206. } else {
  207. /* do not use JavaScript */
  208. displayHtmlHeader ($org_title);
  209. $sBodyTagJs = '';
  210. }
  211. /*
  212. * this explains the imap_mailbox.php dependency. We should instead store
  213. * the selected mailbox in the session and fallback to the session var.
  214. */
  215. $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
  216. readShortMailboxName($mailbox, $delimiter)));
  217. if ( $shortBoxName == 'INBOX' ) {
  218. $shortBoxName = _("INBOX");
  219. }
  220. $provider_link = '';
  221. if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
  222. $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
  223. }
  224. $oTemplate->assign('body_tag_js', $sBodyTagJs);
  225. $oTemplate->assign('shortBoxName', $shortBoxName);
  226. $oTemplate->assign('provider_link', $provider_link);
  227. $oTemplate->assign('frame_top', $frame_top);
  228. $oTemplate->assign('urlMailbox', $urlMailbox);
  229. $oTemplate->assign('startMessage', $startMessage);
  230. $oTemplate->assign('hide_sm_attributions', $hide_sm_attributions);
  231. $oTemplate->display('page_header.tpl');
  232. global $null;
  233. do_hook('page_header_bottom', $null);
  234. }
  235. /**
  236. * Blatantly copied/truncated/modified from displayPageHeader.
  237. * Outputs a page header specifically for the compose_in_new popup window
  238. *
  239. * @param array color the array of theme colors
  240. * @param string mailbox the current mailbox name to display
  241. * @param string sHeaderJs javascipt code to be inserted in a script block in the header
  242. * @param string sOnload JavaScript code to be added inside the body's onload handler
  243. * as of 1.5.2, this replaces $sBodyTagJs argument
  244. * @return void
  245. */
  246. function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
  247. global $reply_focus, $action, $oTemplate;
  248. if (empty($sOnload)) {
  249. if (strpos($action, 'reply') !== FALSE && $reply_focus) {
  250. if ($reply_focus == 'select')
  251. $sOnload = 'checkForm(\'select\');';
  252. else if ($reply_focus == 'focus')
  253. $sOnload = 'checkForm(\'focus\');';
  254. else if ($reply_focus != 'none')
  255. $sOnload = 'checkForm();';
  256. }
  257. else
  258. $sOnload = 'checkForm();';
  259. }
  260. /*
  261. * Locate the first displayable form element (only when JavaScript on)
  262. */
  263. if(checkForJavascript()) {
  264. if ($sHeaderJs) {
  265. $sJsBlock = "\n<script type=\"text/javascript\">" .
  266. "\n<!--\n" .
  267. $sHeaderJs . "\n\n// -->\n</script>\n";
  268. } else {
  269. $sJsBlock = '';
  270. }
  271. $sJsBlock .= "\n";
  272. $js_includes = $oTemplate->get_javascript_includes(TRUE);
  273. foreach ($js_includes as $js_file) {
  274. $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
  275. }
  276. displayHtmlHeader (_("Compose"), $sJsBlock);
  277. } else {
  278. /* javascript off */
  279. displayHtmlHeader(_("Compose"));
  280. $onload = '';
  281. }
  282. // FIXME: change the colorization attributes below to a CSS class!
  283. $class = '';
  284. $aAttribs = array('text' => $color[8], 'bgcolor' => $color[4],
  285. 'link' => $color[7], 'vlink' => $color[7],
  286. 'alink' => $color[7]);
  287. // this is template-safe (see create_body() function)
  288. echo create_body($sOnload, $class, $aAttribs);
  289. global $null;
  290. do_hook('compose_header_bottom', $null);
  291. }