X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fpage_header.php;h=095638f07572b255a92d07d5d0950aff89cc570d;hp=568053be4c7ace8553f0785486f6f1a442cd16aa;hb=6182ab4dbd078c7b6855c6a25d7cd0b5d3f4258b;hpb=3e28c1231fe4d9a49563b39c1647d26d7723bd96
diff --git a/functions/page_header.php b/functions/page_header.php
index 568053be..095638f0 100644
--- a/functions/page_header.php
+++ b/functions/page_header.php
@@ -3,320 +3,297 @@
/**
* 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-2006 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 ) {
+/**
+ * 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;
+ global $theme_css, $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction,
+ $default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize, $chosen_theme;
- echo '' .
- "\n\n\n\n";
+ /* 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)
- if ( !isset( $custom_css ) || $custom_css == 'none' ) {
- if ($theme_css != '') {
- echo "";
- }
- } else {
- echo '';
+ $oTemplate->assign('frames', $frames);
+ $oTemplate->assign('lang', $squirrelmail_language);
+
+ $header_tags = '';
+
+ $header_tags .= "\n";
+
+ $used_fontset = (!empty($chosen_fontset) ? $chosen_fontset : $default_fontset);
+ $used_fontsize = (!empty($chosen_fontsize) ? $chosen_fontsize : $default_fontsize);
+ $used_theme = basename((!empty($chosen_theme) ? $chosen_theme : $theme[$theme_default]['PATH']),'.php');
+
+ $header_tags .= $oTemplate->fetch_standard_stylesheet_links();
+ $aUserStyles = array();
+//FIXME: remove this!!
+ // load custom style sheet (deprecated)
+ if ( ! empty($theme_css) ) {
+ $aUserStyles[] = $theme_css;
+ }
+// FIXME: the following user pref ("sUserStyle"; rename as necessary) will have to be populated by the display prefs screen from a widget similar to the color themes widget (which it replaces) where its values should be full relative paths (from SM_PATH) to the selected css "themes" (either in template css/alternates dir or SM_PATH/css/alternates dir)
+// FIXME: uhhh, getPref() is not available yet here. (at least on login page) Ugh. Nor has load_prefs been included yet -- how do we fix this?
+// $aUserStyles[] = getPref($data_dir, $username, 'sUserStyle', '');
+ $aUserStyles[] = $base_uri .'src/style.php'
+ . '?themeid='.$used_theme
+ . '&templateid='.$sTemplateID
+ . (!empty($used_fontset) ? '&fontset='.$used_fontset : '')
+ . (!empty($used_fontsize) ? '&fontsize='.$used_fontsize : '')
+ . (!empty($text_direction) ? '&dir='.$text_direction : '');
+ $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
+
+ if ($text_direction == 'rtl') {
+ $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
+ }
+
+ if ($squirrelmail_language == 'ja_JP') {
+ /*
+ * 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) {
+ // NOTE! plugins here must assign output to template
+ // and NOT echo anything directly!!
do_hook('generic_header');
}
-
- 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();
+ }
-function displayInternalLink($path, $text, $target='') {
- sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
+}
+
+/**
+ * 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='') {
+ global $base_uri;
+// sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
if ($target != '') {
$target = " target=\"$target\"";
}
- echo ''.$text.'';
+
+ // 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.
+ //
+ //$hooktext = do_hook_function('internal_link',$text);
+ //if ($hooktext != '')
+ // $text = $hooktext;
+
+ return ''.$text.'';
}
-function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
+/**
+ * Same as makeInternalLink, but echoes it too
+ */
+function displayInternalLink($path, $text, $target='') {
+// FIXME: should let the template echo all these kinds of things
+ 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
+ */
- global $hide_sm_attributions, $PHP_SELF, $frame_top,
- $compose_new_win, $compose_width, $compose_height,
- $attachemessages, $provider_name, $provider_uri;
+function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
- 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);
+ global $reply_focus, $hide_sm_attributions, $frame_top,
+ $provider_name, $provider_uri, $startMessage,
+ $javascript_on, $action, $oTemplate;
+
+ 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();"';
}
+
+ $urlMailbox = urlencode($mailbox);
+ $startMessage = (int)$startMessage;
+
+ sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
+
if (!isset($frame_top)) {
$frame_top = '_top';
}
- if ($session) {
- $compose_uri = $base_uri.'src/compose.php?mailbox='.urlencode($mailbox).'&attachedmessages=true&session='."$session";
+ if( $javascript_on || 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 ('SquirrelMail', $sJsBlock);
} else {
- $compose_uri = $base_uri.'src/compose.php?newmessage=1';
- $session = 0;
- }
-
- switch ( $module ) {
- case 'src/read_body.php':
- $js ='';
- 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 .= "\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;
-
+ /* do not use JavaScript */
+ displayHtmlHeader ('SquirrelMail');
+ $sBodyTagJs = '';
}
-
- echo "\n\n";
- /** Here is the header and wrapping table **/
- $shortBoxName = imap_utf7_decode_local(
- readShortMailboxName($mailbox, $delimiter));
+ /*
+ * 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 ( $shortBoxName == 'INBOX' ) {
$shortBoxName = _("INBOX");
}
- 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";
- } else {
- echo ' ';
- }
- echo " \n"
- . html_tag( 'td', '', 'right' ) ."\n";
- displayInternalLink ('src/signout.php', _("Sign Out"), $frame_top);
- echo "\n"
- . " \n"
- . html_tag( 'tr', '', '', $color[4] ) ."\n"
- . html_tag( 'td', '', 'left' ) ."\n";
- $urlMailbox = urlencode($mailbox);
- if ($compose_new_win == '1') {
- echo ''. _("Compose").'';
- }
- else {
- displayInternalLink ("src/compose.php?mailbox=$urlMailbox", _("Compose"), 'right');
- }
- echo " \n";
- if (getPref($data_dir, $username,"vcard")==1) {
- displayInternalLink ('src/addressbook_vcard.php', _("Addresses"), 'right');
- } else {
- 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"
- . html_tag( 'td', '', 'right' ) ."\n";
- if (!isset($provider_uri)) $provider_uri= 'http://www.squirrelmail.org/';
- if (!isset($provider_name)) $provider_name= 'SquirrelMail';
- echo ($hide_sm_attributions ? ' ' :
- ''.$provider_name.'');
- echo "\n".
- " \n".
- "
\n\n";
-}
-
-/* blatently copied/truncated/modified from the above function */
-function compose_Header($color, $mailbox) {
- global $delimiter, $hide_sm_attributions, $base_uri, $PHP_SELF,
- $data_dir, $username, $frame_top, $compose_new_win;
+ $sm_attributes = '';
+ if (!$hide_sm_attributions) {
+ $sm_attributes .= '' ."\n";
+ if (empty($provider_uri)) {
+ $sm_attributes .= ' SquirrelMail';
+ } else {
+ if (empty($provider_name)) $provider_name= 'SquirrelMail';
+ $sm_attributes .= ' '.$provider_name.''."\n";
+ }
+ $sm_attributes .= " | \n";
+ }
+ $oTemplate->assign('body_tag_js', $sBodyTagJs);
+ $oTemplate->assign('shortBoxName', $shortBoxName);
+ $oTemplate->assign('sm_attribute_str', $sm_attributes);
+ $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');
+}
- $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
- if (!isset($frame_top)) {
- $frame_top = '_top';
+/**
+ * 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 sBodyTagJs js events to be inserted in the body tag
+ * @return void
+ */
+function compose_Header($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
+
+ global $reply_focus, $javascript_on, $action, $oTemplate;
+
+ 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();"';
}
+
/*
- Locate the first displayable form element
- */
- 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;
+ * Locate the first displayable form element (only when JavaScript on)
+ */
+ if($javascript_on) {
+ if ($sHeaderJs) {
+ $sJsBlock = "\n\n";
+ } else {
+ $sJsBlock = '';
+ }
+ $sJsBlock .= "\n";
- }
+ $js_includes = $oTemplate->get_javascript_includes(TRUE);
+ foreach ($js_includes as $js_file) {
+ $sJsBlock .= '' ."\n";
+ }
- echo "\n\n";
+ displayHtmlHeader (_("Compose"), $sJsBlock);
+ } else {
+ /* javascript off */
+ displayHtmlHeader(_("Compose"));
+ $onload = '';
+ }
+// FIXME: should let the template echo all these kinds of things
+ echo "\n\n";
}
-?>