Add / before default.css in user themes in case it is not in the path for some reason.
[squirrelmail.git] / functions / page_header.php
index bfdc58722cc080d7290b1e1875186bb37665d419..e6a6cf3d8c70d34c391ba61ba9ec269a3a95605e 100644 (file)
  * @package squirrelmail
  */
 
-/** @ignore */
-if (! defined('SM_PATH')) define('SM_PATH','../');
-
 /** 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 . 'class/template/template.class.php');
+include_once(SM_PATH . 'functions/imap_mailbox.php');
 
 /**
  * Output a SquirrelMail page header, from <!doctype> to </head>
@@ -34,47 +27,84 @@ include_once(SM_PATH . 'class/template/template.class.php');
  * @return void
  */
 function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE ) {
-    global $squirrelmail_language, $sTplDir, $oErroHandler;
+    global $squirrelmail_language, $sTemplateID, $oErrorHandler, $oTemplate;
 
     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 */
-    header('Pragma: no-cache'); // http 1.0 (rfc1945)
-    header('Cache-Control: private, no-cache, no-store'); // http 1.1 (rfc2616)
+//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 ($frames) {
-        echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"'."\n"
-            .' "http://www.w3.org/TR/1999/REC-html401-19991224/frameset.dtd">';
-    } else {
-        echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"'."\n"
-            .' "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">';
-    }
-    echo "\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) .
-        "<head>\n<meta name=\"robots\" content=\"noindex,nofollow\">\n";
+    $oTemplate->assign('frames', $frames);
+    $oTemplate->assign('lang', $squirrelmail_language);
+
+    $header_tags = '';
+
+    $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');
-
-    /*
-     * Add closing / to link and meta elements only after switching to xhtml 1.0 Transitional.
-     * It is not compatible with html 4.01 Transitional
+    $used_theme = !isset($chosen_theme) && $user_theme_default != 'none' ?  'u_'.$user_themes[$user_theme_default]['PATH'] : $chosen_theme_path;
+    
+    /**
+     * Stylesheets are loaded in the following order:
+     *    1) All stylesheets provided by the template.  Normally, these are
+     *       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.
      */
-    echo '<link rel="stylesheet" type="text/css" href="'. $base_uri .'src/style.php'
-        .'?themeid='.$used_theme
-        .'&amp;templateid='.basename($sTplDir)
-        .(!empty($used_fontset) ? '&amp;fontset='.$used_fontset : '')
-        .(!empty($used_fontsize) ? '&amp;fontsize='.$used_fontsize : '')
-        .(!empty($text_direction) ? '&amp;dir='.$text_direction : '')."\">\n";
 
+    // 1. Stylesheets from the template.
+    $header_tags .= $oTemplate->fetch_standard_stylesheet_links();
 
-    // load custom style sheet (deprecated)
-    if ( ! empty($theme_css) ) {
-        echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"$theme_css\">\n";
+    $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', '');
+// Steve, can you please document what u_ means?  Will it work with the
+// new template inheritance system and auto-detection of alternate sheets?
+/**
+ * Stylesheets beginning with a "u_" == user provided stylesheets, e.g. those
+ * in SM_PATH/css/.  Template provided stylesheets (TEMPLATE_DIR/css/alternatives/)
+ * should begin with 't_'.  This was the initial path I took to get it working 
+ * since I wasn't sure what mods to the Template class would be used to handle
+ * template-provided alt stylesheets.
+ * 
+ * TODO: Re-evaluate this naming convetion.
+ */
+#    var_dump($used_theme);
+    if (!empty($used_theme)) {
+        if (substr($used_theme, 0, 2) == 'u_') {
+            $aUserStyles[] = substr($used_theme, 2) .'/default.css';
+        } elseif (substr($used_theme, 0, 2) == 't_') {
+            $aUserStyles[] = SM_PATH . $oTemplate->get_template_file_directory().'css/alternates/'.substr($used_theme, 2);
+#            $aUserStyles[] = substr($used_theme, 2);
+        }
+    }
+
+    // 3. src/style.php
+    $aUserStyles[] = $base_uri .'src/style.php?'
+                   . (!empty($used_fontset) ? '&amp;fontset='.$used_fontset : '')
+                   . (!empty($used_fontsize) ? '&amp;fontsize='.$used_fontsize : '');
+
+    // 3.1.  Load the stylesheets we have already  
+    $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
+
+    // 4. Optional rtl.css stylesheet
+    if ($text_direction == 'rtl') {
+        $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
     }
 
     if ($squirrelmail_language == 'ja_JP') {
@@ -85,37 +115,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 "<!-- \xfd\xfe -->\n";
-        echo '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
+        $header_tags .= "<!-- \xfd\xfe -->\n";
+        $header_tags .= '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
     }
     if ($do_hook) {
+        // NOTE! plugins here must assign output to template 
+        //       and NOT echo anything directly!!
         do_hook('generic_header');
     }
 
-    echo "<title>$title</title>\n$xtra\n";
+    $header_tags .= $xtra;
+    $oTemplate->assign('page_title', $title);
 
     /* work around IE6's scrollbar bug */
-    echo <<<ECHO
+    $header_tags .= <<<EOS
+<!--[if IE 6]>
 <style type="text/css">
-<!--
 /* avoid stupid IE6 bug with frames and scrollbars */
 body {
-    voice-family: "\"}\"";
-    voice-family: inherit;
     width: expression(document.documentElement.clientWidth - 30);
 }
--->
 </style>
+<![endif]-->
 
-ECHO;
+EOS;
 
-    echo "\n</head>\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)) {
-        $oErrorHander->HeaderSent();
+        $oErrorHandler->HeaderSent();
     }
+
 }
 
 /**
@@ -126,7 +159,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\"";
     }
@@ -149,6 +183,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);
 }
 
@@ -186,8 +221,6 @@ function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
     $urlMailbox = urlencode($mailbox);
     $startMessage = (int)$startMessage;
 
-    $sTplDir = $oTemplate->template_dir;
-
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
 
     if (!isset($frame_top)) {
@@ -195,7 +228,11 @@ function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
     }
 
     if( $javascript_on || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
-        $sJsBlock = '<script src="'. $sTplDir. 'js/default.js" type="text/javascript"></script>' ."\n";
+        $js_includes = $oTemplate->get_javascript_includes(TRUE);
+        $sJsBlock = '';
+        foreach ($js_includes as $js_file) {
+            $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
+        }
         if ($sHeaderJs) {
             $sJsBlock .= "\n<script type=\"text/javascript\">" .
                         "\n<!--\n" .
@@ -207,7 +244,10 @@ function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
         displayHtmlHeader ('SquirrelMail');
         $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' ) {
@@ -248,7 +288,7 @@ function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
  */
 function compose_Header($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
 
-    global $reply_focus, $javascript_on, $action;
+    global $reply_focus, $javascript_on, $action, $oTemplate;
 
     if (empty($sBodyTagJs)) {
         if (strpos($action, 'reply') !== FALSE && $reply_focus) {
@@ -275,13 +315,19 @@ function compose_Header($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
         } else {
         $sJsBlock = '';
         }
-        $sJsBlock .= "\n" . '<script src="'. SM_PATH .'templates/default/js/default.js" type="text/javascript"></script>' ."\n";
+        $sJsBlock .= "\n";
+
+        $js_includes = $oTemplate->get_javascript_includes(TRUE);
+        foreach ($js_includes as $js_file) {
+            $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
+        }
+
         displayHtmlHeader (_("Compose"), $sJsBlock);
     } else {
         /* javascript off */
         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";
 }
-?>
\ No newline at end of file