Add fixme/note

[squirrelmail.git] / functions / page_header.php

diff --git a/functions/page_header.php b/functions/page_header.php
index 1581db79543e1f6227821327bfda80ce8b624702..17e1d1aac0319c6dcc1b0ae9cf7e6e7ed1037c1f 100644 (file)
--- a/functions/page_header.php
+++ b/functions/page_header.php
@@ -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;
         }
@@ -103,13 +105,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!!
+        // 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.
         global $null;
+        ob_start();
         do_hook('generic_header', $null);
+        $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 +178,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,7 +190,7 @@ 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,
@@ -316,6 +324,8 @@ 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;