X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fpage_header.php;h=095638f07572b255a92d07d5d0950aff89cc570d;hp=d62321fa5fd0a5fb1b8333527cdfa2ff23305460;hb=6182ab4dbd078c7b6855c6a25d7cd0b5d3f4258b;hpb=f9f738dc5a91f1fab0a05e6d4a3654f98817597e diff --git a/functions/page_header.php b/functions/page_header.php index d62321fa..095638f0 100644 --- a/functions/page_header.php +++ b/functions/page_header.php @@ -3,58 +3,74 @@ /** * page_header.php * - * Copyright (c) 1999-2005 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * * Prints the page header (duh) * + * @copyright © 1999-2006 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail */ /** 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'); +include_once(SM_PATH . 'functions/imap_mailbox.php'); /** * 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; +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 $theme_css, $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction, + $default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize, $chosen_theme; - if ($frames) { - echo ''; - } else { - echo ''; - } - echo "\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) . - "\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) - /* - * 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 ""; - } - } 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') { @@ -65,35 +81,40 @@ function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = true * 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"; + $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 "$title\n$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(); + } + } /** @@ -104,7 +125,8 @@ ECHO; * @param string target the target frame for this link */ function makeInternalLink($path, $text, $target='') { - sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION); + global $base_uri; +// sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION); if ($target != '') { $target = " target=\"$target\""; } @@ -127,6 +149,7 @@ function makeInternalLink($path, $text, $target='') { * 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); } @@ -137,430 +160,86 @@ function displayInternalLink($path, $text, $target='') { * * @param array color the array of theme colors * @param string mailbox the current mailbox name to display - * @param string xtra extra html code to add - * @param bool session + * @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) { - - global $hide_sm_attributions, $PHP_SELF, $frame_top, - $compose_new_win, $compose_width, $compose_height, - $provider_name, $provider_uri, $startMessage, - $javascript_on, $default_use_mdn, $mdn_user_support; - - 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 || strpos($xtra, 'new_js_autodetect_results.value') ) { - - 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_form(comp_uri, button, myform) {\n". - ' if (!comp_uri) {'."\n". - ' comp_uri = "'.$compose_uri."\";\n". - ' }'. "\n". - ' comp_uri += "&" + button.name + "=1";'."\n". - ' for ( var i=0; i < myform.elements.length; i++ ) {'."\n". - ' if ( myform.elements[i].type == "checkbox" && myform.elements[i].checked )'."\n". - ' comp_uri += "&" + myform.elements[i].name + "=1";'."\n". - ' }'."\n". - ' var newwin = window.open(comp_uri' . - ', "_blank",'. - '"width='.$compose_width. ',height='.$compose_height. - ',scrollbars=yes,resizable=yes,status=yes");'."\n". - "}\n\n"; - $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,status=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; - - case 'src/right_main.php': - global $fancy_index_highlite; - if (!$fancy_index_highlite) { - $js = ''; - } else //{ putting braces around this block creats strange PHP errors - // following code graciously borrowed from - // phpMyAdmin project at: - // http://www.phpmyadmin.net - $js = << exits - if ((thePointerColor == '' && theMarkColor == '') - || typeof(theRow.style) == 'undefined') { - return false; - } - - // 2. Gets the current row and exits if the browser can't get it - if (typeof(document.getElementsByTagName) != 'undefined') { - theCells = theRow.getElementsByTagName('td'); - } - else if (typeof(theRow.cells) != 'undefined') { - theCells = theRow.cells; - } - else { - return false; - } + sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION ); - // 3. Gets the current color... - var rowCellsCnt = theCells.length; - var domDetect = null; - var currentColor = null; - var newColor = null; - // 3.1 ... with DOM compatible browsers except Opera that does not return - // valid values with "getAttribute" - if (typeof(window.opera) == 'undefined' - && typeof(theCells[0].getAttribute) != 'undefined') { - currentColor = theCells[0].getAttribute('bgcolor'); - domDetect = true; - } - // 3.2 ... with other browsers - else { - currentColor = theCells[0].style.backgroundColor; - domDetect = false; - } // end 3 - - // 3.3 ... Opera changes colors set via HTML to rgb(r,g,b) format so fix it - if (currentColor.indexOf("rgb") >= 0) - { - var rgbStr = currentColor.slice(currentColor.indexOf('(') + 1, - currentColor.indexOf(')')); - var rgbValues = rgbStr.split(","); - currentColor = "#"; - var hexChars = "0123456789ABCDEF"; - for (var i = 0; i < 3; i++) - { - var v = rgbValues[i].valueOf(); - currentColor += hexChars.charAt(v/16) + hexChars.charAt(v%16); - } + if (!isset($frame_top)) { + $frame_top = '_top'; } - // 4. Defines the new color - // 4.1 Current color is the default one - if (currentColor == '' - || currentColor.toLowerCase() == theDefaultColor.toLowerCase()) { - if (theAction == 'over' && thePointerColor != '') { - newColor = thePointerColor; + 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"; } - else if (theAction == 'click' && theMarkColor != '') { - newColor = theMarkColor; - marked_row[theRowNum] = true; - // deactivated onclick marking of the checkbox because it's also executed - // when an action (clicking on the checkbox itself) on a single item is - // performed. Then the checkbox would get deactived, even though we need - // it activated. Maybe there is a way to detect if the row was clicked, - // and not an item therein... - //document.getElementById('msg[' + theRowNum + ']').checked = true; - } - } - // 4.1.2 Current color is the pointer one - else if (currentColor.toLowerCase() == thePointerColor.toLowerCase() - && (typeof(marked_row[theRowNum]) == 'undefined' || !marked_row[theRowNum])) { - if (theAction == 'out') { - newColor = theDefaultColor; - } - else if (theAction == 'click' && theMarkColor != '') { - newColor = theMarkColor; - marked_row[theRowNum] = true; - //document.getElementById('msg[' + theRowNum + ']').checked = true; - } - } - // 4.1.3 Current color is the marker one - else if (currentColor.toLowerCase() == theMarkColor.toLowerCase()) { - if (theAction == 'click') { - newColor = (thePointerColor != '') - ? thePointerColor - : theDefaultColor; - marked_row[theRowNum] = (typeof(marked_row[theRowNum]) == 'undefined' || !marked_row[theRowNum]) - ? true - : null; - //document.getElementById('msg[' + theRowNum + ']').checked = false; - } - } // end 4 - - // 5. Sets the new color... - if (newColor) { - var c = null; - // 5.1 ... with DOM compatible browsers except Opera - if (domDetect) { - for (c = 0; c < rowCellsCnt; c++) { - theCells[c].setAttribute('bgcolor', newColor, 0); - } // end for - } - // 5.2 ... with other browsers - else { - for (c = 0; c < rowCellsCnt; c++) { - theCells[c].style.backgroundColor = newColor; - } - } - } // end 5 - - return true; -} // end of the 'setPointer()' function -EOS; - //} putting braces around this block creats strange PHP errors - $js = "\n".'\n"; - $onload = ''; - displayHtmlHeader ('SquirrelMail', $js); - break; - - default: - $js = '\n"; - - $onload = 'onload="checkForm();"'; - displayHtmlHeader ('SquirrelMail', $js); - break; - + if ($sHeaderJs) { + $sJsBlock .= "\n\n"; } + displayHtmlHeader ('SquirrelMail', $sJsBlock); } else { /* do not use JavaScript */ displayHtmlHeader ('SquirrelMail'); - $onload = ''; + $sBodyTagJs = ''; } - - echo "\n\n"; - /** Here is the header and wrapping table **/ + /* + * 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" - . ($hide_sm_attributions ? html_tag( 'td', '', 'left', '', 'colspan="2"' ) - : html_tag( 'td', '', 'left' ) ) - . "\n"; - $urlMailbox = urlencode($mailbox); - echo makeComposeLink('src/compose.php?mailbox='.$urlMailbox.'&startMessage='.$startMessage); - echo "  \n"; - displayInternalLink ('src/addressbook.php', _("Addresses")); - echo "  \n"; - displayInternalLink ('src/folders.php', _("Folders")); - echo "  \n"; - displayInternalLink ('src/options.php', _("Options")); - echo "  \n"; - displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search")); - echo "  \n"; - displayInternalLink ('src/help.php', _("Help")); - echo "  \n"; - - do_hook('menuline'); - - echo " \n"; - - if (!$hide_sm_attributions) - { - echo html_tag( 'td', '', 'right' ) ."\n"; + + $sm_attributes = ''; + if (!$hide_sm_attributions) { + $sm_attributes .= '' ."\n"; if (empty($provider_uri)) { - echo 'SquirrelMail'; + $sm_attributes .= ' SquirrelMail'; } else { if (empty($provider_name)) $provider_name= 'SquirrelMail'; - echo ''.$provider_name.''; + $sm_attributes .= ' '.$provider_name.''."\n"; } - echo "\n"; + $sm_attributes .= " \n"; } - echo " \n". - "
\n\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'); } /** @@ -569,75 +248,52 @@ EOS; * * @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) { +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();"'; + } - global $javascript_on; /* * Locate the first displayable form element (only when JavaScript on) */ if($javascript_on) { - global $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 ($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: should let the template echo all these kinds of things + echo "\n\n"; } - -?>