X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fpage_header.php;h=5042302086889d84e6c3f4e742407e3400ba98d3;hp=59efe1ef96c6200f0d1516c36260b185cc3587c1;hb=38bbe4a5d0901c53cc045332b91ec20d886f87e7;hpb=dad8c15a03d38a6f5a3091cb3a9291b4a6ffc684 diff --git a/functions/page_header.php b/functions/page_header.php index 59efe1ef..50423020 100644 --- a/functions/page_header.php +++ b/functions/page_header.php @@ -3,497 +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-2006 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'); -require_once('../functions/html.php'); -require_once('../class/html.class'); +/** 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, $sTplDir, $oErrorHandler, $oTemplate; - 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, $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 */ + header('Pragma: no-cache'); // http 1.0 (rfc1945) + header('Cache-Control: private, no-cache, no-store'); // http 1.1 (rfc2616) - if ( !isset( $custom_css ) || $custom_css == 'none' ) { - if ($theme_css != '') { - echo ""; - } + if ($frames) { + echo ''; } else { - echo ''; + echo ''; } + echo "\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) . + "\n\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'); + + /* + * Add closing / to link and meta elements only after switching to xhtml 1.0 Transitional. + * It is not compatible with html 4.01 Transitional + */ + $templatedir=basename($sTplDir); + $oTemplate->assign('base_uri',$base_uri); + $oTemplate->assign('templatedir',$templatedir); + $oTemplate->assign('themeid',$used_theme); + $oTemplate->display('stylelink.tpl'); + echo '\n"; + // load custom style sheet (deprecated) + if ( ! empty($theme_css) ) { + echo "\n"; + } + + 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"); + do_hook('generic_header'); } - - echo "\n$title$xtra\n\n"; + + echo "$title\n$xtra\n"; + + /* work around IE6's scrollbar bug */ + echo << + + -function displayInternalLink($path, $text, $target='') { - global $base_uri; +ECHO; + + echo "\n\n\n"; + /* 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='') { + 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) { - - global $delimiter, $hide_sm_attributions, $base_uri, $PHP_SELF, $frame_top, - $compose_new_win, $username, $datadir, $compose_width, $compose_height, - $attachemessages, $session; +/** + * Same as makeInternalLink, but echoes it too + */ +function displayInternalLink($path, $text, $target='') { + echo makeInternalLink($path, $text, $target); +} - $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'; - } +/** + * 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 + */ - /* - Locate the first displayable form element - */ +function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') { - 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; - } - - 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; + 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();"'; } - echo "\n\n"; - /** Here is the header and wrapping table **/ - $shortBoxName = 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"; - 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"; - echo ($hide_sm_attributions ? ' ' : - 'SquirrelMail'); - echo "\n". - " \n". - "\n\n"; -} + $startMessage = (int)$startMessage; -/* blatently copied/truncated/modified from the above function */ -function compose_Header($color, $mailbox) { + $sTplDir = $oTemplate->template_dir; - global $delimiter, $hide_sm_attributions, $base_uri, $PHP_SELF, $frame_top, $compose_new_win; + sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION ); - - $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 ); if (!isset($frame_top)) { $frame_top = '_top'; } + if( $javascript_on || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) { + $js_includes = $oTemplate->getJavascriptIncludes(); + $sJsBlock = ''; + foreach ($js_includes as $js_file) { + $sJsBlock .= '' ."\n"; + } + if ($sHeaderJs) { + $sJsBlock .= "\n\n"; + } + displayHtmlHeader ('SquirrelMail', $sJsBlock); + } else { + /* do not use JavaScript */ + displayHtmlHeader ('SquirrelMail'); + $sBodyTagJs = ''; + } /* - 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; - + * 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\n"; -} - -function initPage () { - - global $theme_css, $custom_css, $base_uri; - $page = new html(); - $page->addChild('','',array('!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"' => false),'','',''); - $html = new html('html'); - $html->addChild('HTML'); -/* shouldn't the last two lines be just this line? $page->addChild('HTML'); */ - return $page; -} - -function initHead ($title = 'SquirrelMail') { - global $use_css, $compose_new_win, $compose_width, $compose_height, - $base_uri; - - $head = new html('head'); - $head->addChild('title', $title); - if ($use_css) { - $head->addChild('link','','','','', - array('REL' => 'stylesheet', 'TYPE' => 'text/css', - 'HREF' => $base_uri .'/css/read_body.css')); - } - 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(new_mes, comp_uri) {\n". - ' if (new_mes) { '."\n". - " comp_uri = \"".$base_uri."src/compose.php?newmessage=1\";\n". - ' } else { '."\n". - " if (comp_uri =='') {\n". - ' comp_uri = "'.$base_uri.$compose_uri."\";\n". - ' }'. "\n". - ' }'. "\n". - ' var newwin = window.open(comp_uri' . - ', "_blank", - "width='.$compose_width.",height=$compose_height". - ",scrollbars=yes,resizable=yes\");\n". - "}\n"; - $head->scriptAdd($js); - } - return $head; -} + $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"; + } -function initBody($color, $javascript='') { - global $use_css; - - if (!$use_css) { - $body = new html('body','','','','', - array('bgcolor' => $color[4], 'text' => $color[8], 'link' => $color[7], - 'vlink' => $color[7], 'alink' => $color[7]), $javascript); - } else { - $body = new html('body','','','','','',$javascript); - } - return $body; + $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'); } - -function getTop($color, $mailbox) { - - global $use_css, $languages, $squirrelmail_language, $frame_top, - $delimiter, $base_uri; - - if ( isset( $languages[$squirrelmail_language]['DIR']) ) { - $dir = $languages[$squirrelmail_language]['DIR']; - } else { - $dir = 'ltr'; - } - - if ( $dir == 'ltr' ) { - $rgt = 'right'; - $lft = 'left'; - } else { - $rgt = 'left'; - $lft = 'right'; - } +/** + * 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 (only when JavaScript on) + */ + if($javascript_on) { + if ($sHeaderJs) { + $sJsBlock = "\n\n"; + } else { + $sJsBlock = ''; + } + $sJsBlock .= "\n"; - if (!$use_css) { - $tbl_ar = array('bgcolor' => $color[4], 'border' => 0, 'width' => '100%', - 'cellspacing' => 0, 'cellpadding' => 2); - $row_ar = array('bgcolor' => $color[9]); - $col_ar = array('align' => $lft); - } else { - $tbl_ar = array('border' => 0, - 'cellspacing' => 0, 'cellpadding' => 2); - $row_ar = ''; - $col_ar = array('align' => $lft); - } + $js_includes = $oTemplate->getJavascriptIncludes(); + foreach ($js_includes as $js_file) { + $sJsBlock .= '' ."\n"; + } - $shortBoxName = imap_utf7_decode_local( - readShortMailboxName($mailbox, $delimiter)); - if ( $shortBoxName == 'INBOX' ) { - $shortBoxName = _("INBOX"); + displayHtmlHeader (_("Compose"), $sJsBlock); + } else { + /* javascript off */ + displayHtmlHeader(_("Compose")); + $onload = ''; } - - $top = new html('table','','','tp','tp',$tbl_ar); - $row = new html('tr','','','tp_r','tp_r',$row_ar); - - if ( $shortBoxName <> '' && strtolower( $shortBoxName ) <> 'none' ) { - $row->addChild('td',_("Current Folder") .':','','tp_c','tp_mbx_k', - array('align' => $lft)); - $row->addChild('td',$shortBoxName .' ',array('b'=>true),'tp_c', - 'tp_mbx_v',array('align' => $lft)); - } - $col = new html('td','','','tp_c','tp_so',array('align' => $rgt)); - if ($frame_top) { - $lnk_ar = array('href' => $base_uri.'src/signout.php', 'target' => $frame_top); - } else { - $lnk_ar = array('href' => $base_uri.'src/signout.php'); - } - $col->addChild('a', _("Sign Out"),array('b'=>true),'','',$lnk_ar); - $row->htmlAdd($col); - $top->htmlAdd($row); - - return $top; + echo "\n\n"; } - -function getMenu($color,$mailbox) { - global $use_css, $languages, $squirrelmail_language, $frame_top, $base_uri, - $compose_new_win,$hide_sm_attributions; - - $urlMailbox = urlencode($mailbox); - - if ( isset( $languages[$squirrelmail_language]['DIR']) ) { - $dir = $languages[$squirrelmail_language]['DIR']; - } else { - $dir = 'ltr'; - } - - if ( $dir == 'ltr' ) { - $rgt = 'right'; - $lft = 'left'; - } else { - $rgt = 'left'; - $lft = 'right'; - } - - if (!$use_css) { - $tbl_ar = array('bgcolor' => $color[4], 'border' => 0, 'width' => '100%', - 'cellspacing' => 0, 'cellpadding' => 2); - $row_ar = array('bgcolor' => $color[4]); - $col_ar = array('align' => $lft); - } else { - $tbl_ar = array('border' => 0, - 'cellspacing' => 0, 'cellpadding' => 2); - $row_ar = ''; - $col_ar = array('align' => $lft); - } - - $menu = new html('table','','','mn','mn',$tbl_ar); - $row = new html('tr','','','mn','mn_r',$row_ar); - $col = new html('td','','','mn','mn_c',$col_ar); - $delimiter = new html('','  '); - if ($compose_new_win == '1') { - $col->addChild('a',_("Compose"),'','mn_c','mn_co', - array('href' => 'javascript:void(0)'), - array('onclick'=>'comp_in_new(true,"")')); - } else { - $col->addChild('a',_("Compose"),'','mn_c','mn_co', - array('href' => $base_uri.'src/compose.php?mailbox='.$urlMailbox, - 'target' => 'right')); - } - $col->htmlAdd($delimiter); - $col->addChild('a',_("Addresses"),'','mn_c','mn_ad', - array('href' => $base_uri.'src/addressbook.php', - 'target' => 'right')); - $col->htmlAdd($delimiter); - $col->addChild('a',_("Folders"),'','mn_c','mn_fo', - array('href' => $base_uri.'src/folders.php', - 'target' => 'right')); - $col->htmlAdd($delimiter); - - $col->addChild('a',_("Options"),'','mn_c','mn_op', - array('href' => $base_uri.'src/options.php', - 'target' => 'right')); - $col->htmlAdd($delimiter); - $col->addChild('a',_("Search"),'','mn_c','mn_se', - array('href' => $base_uri.'src/search.php?mailbox='.$urlMailbox, - 'target' => 'right')); - $col->htmlAdd($delimiter); - $col->addChild('a',_("Help"),'','mn_c','mn_he', - array('href' => $base_uri.'src/help.php', - 'target' => 'right')); - - do_hook("menuline"); - $row->htmlAdd($col); - if (!$hide_sm_attributions) { - $col = new html('td','','','mn','mn_sm',array('align'=>$rgt)); - $col->addChild('a','SquirrelMail','','','', - array('href'=>'http://www.squirrelmail.org','target'=>'_blank')); - $row->htmlAdd($col); - } - $menu->htmlAdd($row); - return $menu; -} - -?>