X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fpage_header.php;h=a7812b526b77302c2998cbe4c26fbbcf0bd5ad6d;hp=dc892c6d6fbc486358ec04bb380cee972894035c;hb=10bf80c009d938fc0cf85a70d0a6b3834365b146;hpb=d7f8e6e69e33b218bf6d7775a53c811d839bce61 diff --git a/functions/page_header.php b/functions/page_header.php index dc892c6d..a7812b52 100644 --- a/functions/page_header.php +++ b/functions/page_header.php @@ -3,289 +3,292 @@ /** * page_header.php * - * Copyright (c) 1999-2002 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * * Prints the page header (duh) * - * $Id$ + * @copyright © 1999-2005 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail */ -require_once('../functions/strings.php'); -require_once('../functions/imap_utf7_decode_local.php'); +/** Include required files from SM */ +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'); -/* 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. + * + * @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; - global $theme_css, $custom_css, $base_uri; + if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) { + global $base_uri; + } + global $theme_css, $custom_css, $pageheader_sent; - echo '' . - "\n\n\n\n"; + if ($frames) { + echo ''; + } else { + echo ''; + } + echo "\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) . + "\n\n"; + /* + * Add closing / to link and meta elements only after switching to xhtml 1.0 Transitional. + * It is not compatible with html 4.01 Transitional + */ if ( !isset( $custom_css ) || $custom_css == 'none' ) { if ($theme_css != '') { - echo ""; + echo ""; } } else { - echo ''; } - - echo "\n$title$xtra\n\n"; -} -function displayInternalLink($path, $text, $target='') { - global $base_uri; + echo ''; + + 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. + */ + echo "\n"; + echo '' . "\n"; + } + if ($do_hook) { + do_hook('generic_header'); + } + + echo "$title\n$xtra\n"; + + /* work around IE6's scrollbar bug */ + echo << + + +ECHO; + + echo "\n\n\n"; + + /* this is used to check elsewhere whether we should call this function */ + $pageheader_sent = TRUE; +} + +/** + * 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\""; } - 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='') { + echo makeInternalLink($path, $text, $target); +} - global $delimiter, $hide_sm_attributions, $base_uri, $PHP_SELF, $frame_top, - $compose_new_win, $username, $datadir, $compose_width, $compose_height, - $attachemessages, $session; +/** + * 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 + */ - $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 ); - if ($qmark = strpos($module, '?')) { - $module = substr($module, 0, $qmark); +function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') { + + global $reply_focus, $hide_sm_attributions, $frame_top, + $provider_name, $provider_uri, $startMessage, + $javascript_on, $action; + + 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();"'; } + + + sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION ); + if (!isset($frame_top)) { $frame_top = '_top'; } - /* - Locate the first displayable form element - */ - - if ($session !== false) { - $compose_uri = 'src/compose.php?mailbox='. urlencode($mailbox).'&attachedmessages=true&session='."$session"; - } else { - $compose_uri = 'src/compose.php?newmessage=1'; - $session = 0; + if( $javascript_on || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) { + $sJsBlock = '' ."\n"; + if ($sHeaderJs) { + $sJsBlock .= "\n\n"; + } + displayHtmlHeader ('SquirrelMail', $sJsBlock); + } else { + /* do not use JavaScript */ + displayHtmlHeader ('SquirrelMail'); + $sBodyTagJs = ''; } - switch ( $module ) { - case 'src/read_body.php': - 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); - } - displayHtmlHeader(); - $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; - - } + echo "\n\n"; - echo "\n\n"; /** Here is the header and wrapping table **/ - $shortBoxName = imap_utf7_decode_local( - readShortMailboxName($mailbox, $delimiter)); + $shortBoxName = htmlspecialchars(imap_utf7_decode_local( + readShortMailboxName($mailbox, $delimiter))); if ( $shortBoxName == 'INBOX' ) { $shortBoxName = _("INBOX"); } - echo "\n" - . "\n" - . " \n" - . " \n" - . ' \n" + . html_tag( 'td', '', 'right' ) ."\n"; displayInternalLink ('src/signout.php', _("Sign Out"), $frame_top); - echo "\n" - . " \n" - . " \n" - . " \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); - if ($compose_new_win == '1') { - echo "". _("Compose"). ''; - } - else { - displayInternalLink ("src/compose.php?mailbox=$urlMailbox", _("Compose"), 'right'); - } + $startMessage = (int)$startMessage; + + echo makeComposeLink('src/compose.php?mailbox='.$urlMailbox.'&startMessage='.$startMessage); echo "  \n"; - displayInternalLink ("src/addressbook.php", _("Addresses"), 'right'); + displayInternalLink ('src/addressbook.php', _("Addresses")); echo "  \n"; - displayInternalLink ("src/folders.php", _("Folders"), 'right'); + displayInternalLink ('src/folders.php', _("Folders")); echo "  \n"; - displayInternalLink ("src/options.php", _("Options"), 'right'); + displayInternalLink ('src/options.php', _("Options")); echo "  \n"; - displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search"), 'right'); + displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search")); echo "  \n"; - displayInternalLink ("src/help.php", _("Help"), 'right'); + displayInternalLink ('src/help.php', _("Help")); echo "  \n"; - do_hook("menuline"); + do_hook('menuline'); - echo " \n \n". - " \n". - "
\n"; + 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"; + echo ' ' . _("Current Folder") . ": $shortBoxName \n"; } else { echo ' '; } - echo " '; + echo "
\n"; + echo "
"; - echo ($hide_sm_attributions ? ' ' : - 'SquirrelMail'); - echo "
\n\n"; -} + echo " \n"; -/* blatently copied/truncated/modified from the above function */ -function compose_Header($color, $mailbox) { + if (!$hide_sm_attributions) + { + echo html_tag( 'td', '', 'right' ) ."\n"; + if (empty($provider_uri)) { + echo 'SquirrelMail'; + } else { + if (empty($provider_name)) $provider_name= 'SquirrelMail'; + echo ''.$provider_name.''; + } + echo "\n"; + } + echo " \n". + "
\n\n"; +} - global $delimiter, $hide_sm_attributions, $base_uri, $PHP_SELF, $frame_top, $compose_new_win; +/** + * 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; - $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 ); - if (!isset($frame_top)) { - $frame_top = '_top'; + 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" . '' ."\n"; + displayHtmlHeader (_("Compose"), $sJsBlock); + } else { + /* javascript off */ + displayHtmlHeader(_("Compose")); + $onload = ''; } - - echo "\n\n"; + echo "\n\n"; } ?>