X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fpage_header.php;h=8052a0a9e63829b821b3c02f928672aaa4e45f2e;hp=53c5d003e4603a30a125b22c3c586989405495ef;hb=f2fdd884b725543a6bd045f91167af772680c1e8;hpb=99ea51d389e159ea9cd6313520b5dd4da7ecef4d
diff --git a/functions/page_header.php b/functions/page_header.php
index 53c5d003..8052a0a9 100644
--- a/functions/page_header.php
+++ b/functions/page_header.php
@@ -3,344 +3,337 @@
/**
* page_header.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
* Prints the page header (duh)
*
- * $Id$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
*/
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
-require_once(SM_PATH . 'functions/imap_mailbox.php');
-require_once(SM_PATH . 'functions/global.php');
+/** Include required files from SM */
+include_once(SM_PATH . 'functions/imap_mailbox.php');
-/* Always set up the language before calling these functions */
-function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE ) {
- global $squirrelmail_language;
+/**
+ * Output a SquirrelMail page header, from to
+ * 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)
+ * @return void
+ */
+function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE ) {
+ global $squirrelmail_language, $sTemplateID, $oErrorHandler, $oTemplate;
if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
global $base_uri;
}
- global $theme_css, $custom_css, $pageheader_sent;
+ 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 */
+//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'); // http 1.1 (rfc2616)
+
+ $oTemplate->assign('frames', $frames);
+ $oTemplate->assign('lang', $squirrelmail_language);
+
+ $header_tags = '';
- echo '' .
- "\n\n" . html_tag( 'html' ,'' , '', '', '' ) . "\n\n";
+ $header_tags .= "\n";
- if ( !isset( $custom_css ) || $custom_css == 'none' ) {
- if ($theme_css != '') {
- echo "";
+ $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//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;
}
- } else {
- echo '';
}
-
+
+ // 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();
+ }
+
if ($squirrelmail_language == 'ja_JP') {
- echo "\n";
- echo '' . "\n";
+ /*
+ * 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 .= "\n";
+ $header_tags .= '' . "\n";
}
-
if ($do_hook) {
- do_hook('generic_header');
+ // 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.
+ global $null;
+ ob_start();
+ do_hook('generic_header', $null);
+ $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);
}
-
- echo "\n$title$xtra\n";
+
+ $header_tags .= $xtra;
+ $oTemplate->assign('page_title', $title);
/* work around IE6's scrollbar bug */
- echo <<
+
-ECHO;
+EOS;
- echo "\n\n\n";
+ $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
+ * @param string text the link text
+ * @param string target the target frame for this link
+ */
function makeInternalLink($path, $text, $target='') {
- sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
- if ($target != '') {
- $target = " target=\"$target\"";
- }
- return ''.$text.'';
+ 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);
}
-function displayInternalLink($path, $text, $target='') {
- echo makeInternalLink($path, $text, $target);
-}
+/**
+ * Outputs a complete SquirrelMail page header, starting with 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 sBodyTagJs js events to be inserted in the body tag
+ * @return void
+ */
-function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
+function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sBodyTagJs = '') {
+
+ global $reply_focus, $hide_sm_attributions, $frame_top,
+ $provider_name, $provider_uri, $startMessage,
+ $action, $oTemplate, $org_title, $base_uri,
+ $data_dir, $username;
+
+//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)
+ if (empty($sBodyTagJs)) {
+ if (strpos($action, 'reply') !== FALSE && $reply_focus) {
+ if ($reply_focus == 'select')
+ $sBodyTagJs = 'onload="checkForm(\'select\');"';
+ else if ($reply_focus == 'focus')
+ $sBodyTagJs = 'onload="checkForm(\'focus\');"';
+ else if ($reply_focus != 'none')
+ $sBodyTagJs = 'onload="checkForm();"';
+ }
+ else
+ $sBodyTagJs = 'onload="checkForm();"';
+ }
- global $hide_sm_attributions, $PHP_SELF, $frame_top,
- $compose_new_win, $compose_width, $compose_height,
- $attachemessages, $provider_name, $provider_uri,
- $javascript_on, $default_use_mdn, $mdn_user_support;
+ $startMessage = (int)$startMessage;
- sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION );
sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
- $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
- if ($qmark = strpos($module, '?')) {
- $module = substr($module, 0, $qmark);
- }
+
if (!isset($frame_top)) {
$frame_top = '_top';
}
- if ($session) {
- $compose_uri = $base_uri.'src/compose.php?mailbox='.urlencode($mailbox).'&attachedmessages=true&session='."$session";
- } else {
- $compose_uri = $base_uri.'src/compose.php?newmessage=1';
- $session = 0;
- }
-
- if($javascript_on) {
-
- switch ( $module ) {
- case 'src/read_body.php':
- $js ='';
-
- // compose in new window code
- if ($compose_new_win == '1') {
- if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
- $compose_width = '640';
- }
- if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
- $compose_height = '550';
- }
- $js .= "function comp_in_new(comp_uri) {\n".
- " if (!comp_uri) {\n".
- ' comp_uri = "'.$compose_uri."\";\n".
- ' }'. "\n".
- ' var newwin = window.open(comp_uri' .
- ', "_blank",'.
- '"width='.$compose_width. ',height='.$compose_height.
- ',scrollbars=yes,resizable=yes");'."\n".
- "}\n\n";
- }
-
- // javascript for sending read receipts
- if($default_use_mdn && $mdn_user_support) {
- $js .= 'function sendMDN() {'."\n".
- " mdnuri=window.location+'&sendreceipt=1'; ".
- "var newwin = window.open(mdnuri,'right');".
- "\n}\n\n";
- }
-
- // if any of the above passes, add the JS tags too.
- if($js) {
- $js = "\n".'\n";
- }
-
- displayHtmlHeader ('SquirrelMail', $js);
- $onload = $xtra;
- break;
- case 'src/compose.php':
- $js = '\n";
- $onload = 'onload="checkForm();"';
- displayHtmlHeader ('SquirrelMail', $js);
- break;
-
- default:
- $js = '\n";
-
- $onload = 'onload="checkForm();"';
- displayHtmlHeader ('SquirrelMail', $js);
- break;
-
+//FIXME: does checkForJavascript() make the 2nd part of the if() below unneccessary??
+ if( checkForJavascript() || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
+ $js_includes = $oTemplate->get_javascript_includes(TRUE);
+ $sJsBlock = '';
+ foreach ($js_includes as $js_file) {
+ $sJsBlock .= '' ."\n";
+ }
+ if ($sHeaderJs) {
+ $sJsBlock .= "\n\n";
}
+ displayHtmlHeader ($org_title, $sJsBlock);
} else {
/* do not use JavaScript */
- displayHtmlHeader ('SquirrelMail');
- $onload = '';
- }
-
- echo "\n\n";
- /** Here is the header and wrapping table **/
- $shortBoxName = imap_utf7_decode_local(
- readShortMailboxName($mailbox, $delimiter));
- if ( $shortBoxName == 'INBOX' ) {
- $shortBoxName = _("INBOX");
+ displayHtmlHeader ($org_title);
+ $sBodyTagJs = '';
}
- echo "\n"
- . html_tag( 'table', '', '', $color[4], 'border="0" width="100%" cellspacing="0" cellpadding="2"' ) ."\n"
- . html_tag( 'tr', '', '', $color[9] ) ."\n"
- . html_tag( 'td', '', 'left' ) ."\n";
- if ( $shortBoxName <> '' && strtolower( $shortBoxName ) <> 'none' ) {
- echo ' ' . _("Current Folder") . ": $shortBoxName \n";
+ 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 = htmlspecialchars(imap_utf7_decode_local(
+ readShortMailboxName($mailbox, $delimiter)));
+ if (getPref($data_dir, $username, 'translate_special_folders')) {
+ $shortBoxName = _($shortBoxName);
+ }
+ $urlMailbox = urlencode($mailbox);
} else {
- echo ' ';
+ $shortBoxName = '';
+ $urlMailbox = '';
}
- echo " \n"
- . html_tag( 'td', '', 'right' ) ."\n";
- displayInternalLink ('src/signout.php', _("Sign Out"), $frame_top);
- echo "\n"
- . " \n"
- . html_tag( 'tr', '', '', $color[4] ) ."\n"
- . ($hide_sm_attributions ? html_tag( 'td', '', 'left', '', 'colspan="2"' )
- : html_tag( 'td', '', 'left' ) )
- . "\n";
- $urlMailbox = urlencode($mailbox);
- echo makeComposeLink('src/compose.php?mailbox='.$urlMailbox);
- echo " \n";
- displayInternalLink ('src/addressbook.php', _("Addresses"), 'right');
- echo " \n";
- displayInternalLink ('src/folders.php', _("Folders"), 'right');
- echo " \n";
- displayInternalLink ('src/options.php', _("Options"), 'right');
- echo " \n";
- displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search"), 'right');
- echo " \n";
- displayInternalLink ('src/help.php', _("Help"), 'right');
- echo " \n";
-
- do_hook('menuline');
-
- echo " \n";
-
- if (!$hide_sm_attributions)
- {
- echo html_tag( 'td', '', 'right' ) ."\n";
- if (!isset($provider_uri)) $provider_uri= 'http://www.squirrelmail.org/';
- if (!isset($provider_name)) $provider_name= 'SquirrelMail';
- echo ''.$provider_name.'';
- echo "\n";
+
+ $provider_link = '';
+ if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
+ $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
}
- echo " \n".
- "
\n\n";
+
+ $oTemplate->assign('body_tag_js', $sBodyTagJs);
+ $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);
+ $oTemplate->display('page_header.tpl');
+
+ global $null;
+ do_hook('page_header_bottom', $null);
}
-/* blatently copied/truncated/modified from the above function */
-function compose_Header($color, $mailbox) {
+/**
+ * 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();';
+ }
- global $javascript_on;
/*
* Locate the first displayable form element (only when JavaScript on)
*/
- if($javascript_on) {
- global $delimiter, $base_uri, $PHP_SELF, $data_dir, $username;
-
- $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
-
- switch ( $module ) {
- case 'src/search.php':
- $pos = getPref($data_dir, $username, 'search_pos', 0 ) - 1;
- $onload = "onload=\"document.forms[$pos].elements[2].focus();\"";
- displayHtmlHeader (_("Compose"));
- break;
- default:
- $js = '\n";
- $onload = 'onload="checkForm();"';
- displayHtmlHeader (_("Compose"), $js);
- break;
+ if(checkForJavascript()) {
+ if ($sHeaderJs) {
+ $sJsBlock = "\n\n";
+ } else {
+ $sJsBlock = '';
+ }
+ $sJsBlock .= "\n";
+
+ $js_includes = $oTemplate->get_javascript_includes(TRUE);
+ foreach ($js_includes as $js_file) {
+ $sJsBlock .= '' ."\n";
}
+
+ displayHtmlHeader (_("Compose"), $sJsBlock);
} else {
/* javascript off */
displayHtmlHeader(_("Compose"));
$onload = '';
}
- echo "\n\n";
-}
+// 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);
+}