*
* Prints the page header (duh)
*
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2007 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
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;
+ 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)
+ // don't show version as a security measure
+ //$oTemplate->header('X-Powered-By: SquirrelMail/' . SM_VERSION, FALSE);
+ $oTemplate->header('X-Powered-By: SquirrelMail', FALSE);
+
$oTemplate->assign('frames', $frames);
$oTemplate->assign('lang', $squirrelmail_language);
$header_tags = '';
- $header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\">\n";
+ $header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\" />\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');
-
+ $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 $sTplDir/css/. This is accomplished by calling
+ * stylsheets in templates/<template>/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.
-// 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', '');
- if (!empty($chosen_theme) && substr($chosen_theme, 0, 2) == 'u_') {
- $aUserStyles[] = substr($chosen_theme, 2) .'default.css';
+ 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;
+ }
}
// 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
$header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
}
+ // 5. Printer friendly stylesheet
+ $header_tags .= create_css_link($base_uri . 'css/print.css', 'printerfriendly', false, 'print');
+
if ($squirrelmail_language == 'ja_JP') {
/*
* force correct detection of charset, when browser does not follow
* recommendations and switch to unicode.
*/
$header_tags .= "<!-- \xfd\xfe -->\n";
- $header_tags .= '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
+ $header_tags .= '<meta http-equiv="Content-type" content="' . $oTemplate->get_content_type() . '; charset=euc-jp" />' . "\n";
}
if ($do_hook) {
- // NOTE! plugins here must assign output to template
- // and NOT echo anything directly!!
- 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.
+ ob_start();
+ $temp = array(&$header_tags);
+ do_hook('generic_header', $temp);
+ $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);
}
$header_tags .= $xtra;
* @param string target the target frame for this link
*/
function makeInternalLink($path, $text, $target='') {
- global $base_uri;
+ global $base_uri, $oTemplate;
// sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
- if ($target != '') {
- $target = " target=\"$target\"";
- }
// This is an inefficient hook and is only used by
// one plugin that still needs to patch this 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 '<a href="'.$base_uri.$path.'"'.$target.'>'.$text.'</a>';
-}
+ //do_hook('internal_link', $text);
-/**
- * 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);
+ return create_hyperlink($base_uri . $path, $text, $target);
}
/**
* @return void
*/
-function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
+function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sBodyTagJs = '') {
global $reply_focus, $hide_sm_attributions, $frame_top,
$provider_name, $provider_uri, $startMessage,
- $javascript_on, $action, $oTemplate;
+ $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();"';
}
- $urlMailbox = urlencode($mailbox);
$startMessage = (int)$startMessage;
sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
$frame_top = '_top';
}
- if( $javascript_on || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
+//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) {
"\n<!--\n" .
$sHeaderJs . "\n\n// -->\n</script>\n";
}
- displayHtmlHeader ('SquirrelMail', $sJsBlock);
+ displayHtmlHeader ($org_title, $sJsBlock);
} else {
/* do not use JavaScript */
- displayHtmlHeader ('SquirrelMail');
+ displayHtmlHeader ($org_title);
$sBodyTagJs = '';
}
- /*
- * 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");
+ 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 {
+ $shortBoxName = '';
+ $urlMailbox = '';
}
- $sm_attributes = '';
- if (!$hide_sm_attributions) {
- $sm_attributes .= '<td class="sqm_providerInfo">' ."\n";
- if (empty($provider_uri)) {
- $sm_attributes .= ' <a href="about.php">SquirrelMail</a>';
- } else {
- if (empty($provider_name)) $provider_name= 'SquirrelMail';
- $sm_attributes .= ' <a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>'."\n";
- }
- $sm_attributes .= " </td>\n";
+ $provider_link = '';
+ if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
+ $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
}
$oTemplate->assign('body_tag_js', $sBodyTagJs);
$oTemplate->assign('shortBoxName', $shortBoxName);
- $oTemplate->assign('sm_attribute_str', $sm_attributes);
+ $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);
}
/**
* @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
+ * @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='', $sBodyTagJs = '') {
+function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
- global $reply_focus, $javascript_on, $action, $oTemplate;
+ global $reply_focus, $action, $oTemplate;
- if (empty($sBodyTagJs)) {
+ if (empty($sOnload)) {
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();"';
+ if ($reply_focus == 'select')
+ $sOnload = 'checkForm(\'select\');';
+ else if ($reply_focus == 'focus')
+ $sOnload = 'checkForm(\'focus\');';
+ else if ($reply_focus != 'none')
+ $sOnload = 'checkForm();';
}
else
- $sBodyTagJs = 'onload="checkForm();"';
+ $sOnload = 'checkForm();';
}
/*
* Locate the first displayable form element (only when JavaScript on)
*/
- if($javascript_on) {
+ if(checkForJavascript()) {
if ($sHeaderJs) {
$sJsBlock = "\n<script type=\"text/javascript\">" .
"\n<!--\n" .
displayHtmlHeader(_("Compose"));
$onload = '';
}
-// FIXME: should let the template echo all these kinds of things
- echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $sBodyTagJs>\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);
}
projects / squirrelmail.git / blobdiff