Allow prefs plugins to fetch values such as FALSE, 0, '', '0', or other values that...
[squirrelmail.git] / functions / page_header.php
index 3420c882e69693c9b263c40d1541107115cb771d..22413f414ee552b5ba3a535222d27384bdb90887 100644 (file)
@@ -46,7 +46,7 @@ function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE
 
     $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);
@@ -70,12 +70,14 @@ function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE
     $aUserStyles = array();
 
     // 2. Option user-defined stylesheet from preferences.
-    if (!empty($used_theme)) {
+    if (!empty($used_theme) && $used_theme != 'none') {
         /**
-         * All styles just point to a directory, so we need to include all .css
-         * files in that directory. 
+         * All styles (except "none" - ugh) just point to a directory,
+         * so we need to include all .css files in that directory.
          */
-        $styles = list_files($used_theme, '.css');
+//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;
         }
@@ -94,6 +96,9 @@ function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE
         $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
@@ -103,13 +108,27 @@ function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE
          * 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="text/html; charset=euc-jp" />' . "\n";
     }
     if ($do_hook) {
-        // NOTE! plugins here must assign output to template 
-        //       and NOT echo anything directly!!
-        global $null;
-        do_hook('generic_header', $null);
+        // 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;
@@ -162,14 +181,6 @@ function makeInternalLink($path, $text, $target='') {
     return create_hyperlink($base_uri . $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);
-}
-
 /**
  * Outputs a complete SquirrelMail page header, starting with <!doctype> and
  * including the default menu bar. Uses displayHtmlHeader and takes
@@ -182,11 +193,12 @@ function displayInternalLink($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,
-        $action, $oTemplate, $org_title, $base_uri;
+        $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)) {
@@ -202,7 +214,6 @@ function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
         $sBodyTagJs = 'onload="checkForm();"';
     }
 
-    $urlMailbox = urlencode($mailbox);
     $startMessage = (int)$startMessage;
 
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
@@ -229,29 +240,30 @@ function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
         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) {
-        if (empty($provider_uri)) {
-            $sm_attributes .= create_hyperlink($base_uri . 'src/about.php', 'SquirrelMail');
-        } else {
-            if (empty($provider_name)) $provider_name = 'SquirrelMail';
-            $sm_attributes .= create_hyperlink($provider_uri, $provider_name, '_blank');
-        }
+    $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);
@@ -321,6 +333,10 @@ function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
     $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);
 }