Fix a variable typo.
[squirrelmail.git] / functions / page_header.php
index ef044bcb0317e4c01a4f08d71fdecd942713576a..91b5c9a6140463d94f373eb169b6f190adb9aca5 100644 (file)
@@ -3,12 +3,12 @@
 /**
  * page_header.php
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * 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)
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
@@ -19,9 +19,16 @@ require_once(SM_PATH . 'functions/imap_mailbox.php');
 require_once(SM_PATH . 'functions/global.php');
 
 /**
- * Always set up the language before calling these functions
+ * Output a SquirrelMail page header, from <!doctype> to </head>
+ * Always set up the language before calling these functions.
+ *
+ * @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 ) {
+function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = true, $frames = false ) {
     global $squirrelmail_language;
 
     if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
@@ -29,37 +36,52 @@ function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE
     }
     global $theme_css, $custom_css, $pageheader_sent;
 
-    echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">' .
-         "\n\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) . "\n<head>\n";
+    if ($frames) {
+        echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">';
+    } else {
+        echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">';
+    }
+    echo "\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) .
+        "<head>\n<meta name=\"robots\" content=\"noindex,nofollow\">\n";
 
+    /*
+     * 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 "<link rel=\"stylesheet\" type=\"text/css\" href=\"$theme_css\" />";
+            echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"$theme_css\">";
         }
     } else {
         echo '<link rel="stylesheet" type="text/css" href="' .
-             $base_uri . 'themes/css/'.$custom_css.'" />';
+             $base_uri . 'themes/css/'.$custom_css.'">';
     }
-    
+
     if ($squirrelmail_language == 'ja_JP') {
+        /*
+         * force correct detection of charset, when browser does not follow
+         * http content-type and tries to detect charset from page content.
+         * Shooting of browser's creator can't be implemented in php.
+         * 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";
     }
-    
     if ($do_hook) {
         do_hook('generic_header');
     }
-    
-    echo "\n<title>$title</title>$xtra\n";
+
+    echo "<title>$title</title>\n$xtra\n";
 
     /* work around IE6's scrollbar bug */
     echo <<<ECHO
 <style type="text/css">
 <!--
   /* avoid stupid IE6 bug with frames and scrollbars */
-  body { 
-      voice-family: "\"}\""; 
-      voice-family: inherit; 
+  body {
+      voice-family: "\"}\"";
+      voice-family: inherit;
       width: expression(document.documentElement.clientWidth - 30);
   }
 -->
@@ -73,184 +95,82 @@ ECHO;
     $pageheader_sent = TRUE;
 }
 
+/**
+ * Given a path to a SquirrelMail file, return a HTML link to it
+ *
+ * @param string path the SquirrelMail file to link to
+ * @param string text the link text
+ * @param string target the target frame for this link
+ */
 function makeInternalLink($path, $text, $target='') {
     sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
     if ($target != '') {
         $target = " target=\"$target\"";
     }
-    $hooktext = do_hook_function('internal_link',$text);
-    if ($hooktext != '')
-        $text = $hooktext;
+
+    // This is an inefficient hook and is only used by
+    // one plugin that still needs to patch this code,
+    // plus if we are templat-izing SM, visual hooks
+    // are not needed.  However, I am leaving the 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>';
 }
 
+/**
+ * Same as makeInternalLink, but echoes it too
+ */
 function displayInternalLink($path, $text, $target='') {
     echo makeInternalLink($path, $text, $target);
 }
 
-function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
+/**
+ * Outputs a complete SquirrelMail page header, starting with <!doctype> and
+ * including the default menu bar. Uses displayHtmlHeader and takes
+ * JavaScript and locale settings into account.
+ *
+ * @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
+ */
 
-    global $hide_sm_attributions, $PHP_SELF, $frame_top,
-           $compose_new_win, $compose_width, $compose_height,
-           $attachemessages, $provider_name, $provider_uri,
-           $javascript_on, $default_use_mdn, $mdn_user_support;
+function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = 'onload="checkForm();"') {
+    global $hide_sm_attributions, $frame_top,
+           $provider_name, $provider_uri, $startMessage,
+           $javascript_on;
 
-    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).'&amp;attachedmessages=true&amp;session='."$session";
-    } else {
-        $compose_uri = $base_uri.'src/compose.php?newmessage=1';
-       $session = 0;
-    }
-  
-    if($javascript_on) { 
-
-      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(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");'."\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".'<script language="JavaScript" type="text/javascript">' .
-                        "\n<!--\n" . $js . "// -->\n</script>\n";
-                }
-
-                displayHtmlHeader ('SquirrelMail', $js);
-                $onload = $xtra;
-            break;
-        case 'src/compose.php':
-            $js = '<script language="JavaScript" type="text/javascript">' .
-                 "\n<!--\n" .
-             "function checkForm() {\n";
-
-            global $action, $reply_focus;
-            if (strpos($action, 'reply') !== FALSE && $reply_focus)
-            {
-                if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
-                else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
-            }
-            else
-                $js .= "var f = document.forms.length;\n".
-                    "var i = 0;\n".
-                    "var pos = -1;\n".
-                    "while( pos == -1 && i < f ) {\n".
-                        "var e = document.forms[i].elements.length;\n".
-                        "var j = 0;\n".
-                        "while( pos == -1 && j < e ) {\n".
-                            "if ( document.forms[i].elements[j].type == 'text' ) {\n".
-                                "pos = j;\n".
-                            "}\n".
-                            "j++;\n".
-                        "}\n".
-                    "i++;\n".
-                    "}\n".
-                    "if( pos >= 0 ) {\n".
-                        "document.forms[i-1].elements[pos].focus();\n".
-                    "}\n".
-                "}\n";
-           
-            $js .= "// -->\n".
-                "</script>\n";
-            $onload = 'onload="checkForm();"';
-            displayHtmlHeader ('SquirrelMail', $js);
-            break;   
-
-        default:
-            $js = '<script language="JavaScript" type="text/javascript">' .
-                 "\n<!--\n" .
-                 "function checkForm() {\n".
-                    "var f = document.forms.length;\n".
-                    "var i = 0;\n".
-                    "var pos = -1;\n".
-                    "while( pos == -1 && i < f ) {\n".
-                        "var e = document.forms[i].elements.length;\n".
-                        "var j = 0;\n".
-                        "while( pos == -1 && j < e ) {\n".
-                            "if ( document.forms[i].elements[j].type == 'text' " .
-                            "|| document.forms[i].elements[j].type == 'password' ) {\n".
-                                "pos = j;\n".
-                            "}\n".
-                            "j++;\n".
-                        "}\n".
-                    "i++;\n".
-                    "}\n".
-                    "if( pos >= 0 ) {\n".
-                        "document.forms[i-1].elements[pos].focus();\n".
-                    "}\n".
-               "$xtra\n".
-                "}\n";
-           
-                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(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");'."\n".
-                         "}\n\n";
-
-                }
-            $js .= "// -->\n". "</script>\n";
-       
-            $onload = 'onload="checkForm();"';
-            displayHtmlHeader ('SquirrelMail', $js);
-            break;   
-
+    if( $javascript_on || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
+        $sJsBlock = '<script src="'. SM_PATH .'templates/default/js/default.js" type="text/javascript" language="JavaScript"></script>' ."\n";
+        if ($sHeaderJs) {
+            $sJsBlock .= "\n<script language=\"JavaScript\" type=\"text/javascript\">" .
+                        "\n<!--\n" .
+                        $sHeaderJs . "\n\n// -->\n</script>\n";
         }
-    } else {
+        displayHtmlHeader ('SquirrelMail', $sJsBlock);
+   } else {
         /* do not use JavaScript */
         displayHtmlHeader ('SquirrelMail');
-        $onload = '';
+        $sBodyTagJs = '';
     }
 
-    echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
+    echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $sBodyTagJs>\n\n";
+
     /** Here is the header and wrapping table **/
-    $shortBoxName = imap_utf7_decode_local(
-                     readShortMailboxName($mailbox, $delimiter));
+    $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
+                readShortMailboxName($mailbox, $delimiter)));
     if ( $shortBoxName == 'INBOX' ) {
         $shortBoxName = _("INBOX");
     }
@@ -273,17 +193,17 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
                                  : html_tag( 'td', '', 'left' ) )
         . "\n";
     $urlMailbox = urlencode($mailbox);
-    echo makeComposeLink('src/compose.php?mailbox='.$urlMailbox);
+    echo makeComposeLink('src/compose.php?mailbox='.$urlMailbox.'&amp;startMessage='.$startMessage);
     echo "&nbsp;&nbsp;\n";
-    displayInternalLink ('src/addressbook.php', _("Addresses"), 'right');
+    displayInternalLink ('src/addressbook.php', _("Addresses"));
     echo "&nbsp;&nbsp;\n";
-    displayInternalLink ('src/folders.php', _("Folders"), 'right');
+    displayInternalLink ('src/folders.php', _("Folders"));
     echo "&nbsp;&nbsp;\n";
-    displayInternalLink ('src/options.php', _("Options"), 'right');
+    displayInternalLink ('src/options.php', _("Options"));
     echo "&nbsp;&nbsp;\n";
-    displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search"), 'right');
+    displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search"));
     echo "&nbsp;&nbsp;\n";
-    displayInternalLink ('src/help.php', _("Help"), 'right');
+    displayInternalLink ('src/help.php', _("Help"));
     echo "&nbsp;&nbsp;\n";
 
     do_hook('menuline');
@@ -293,77 +213,48 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
     if (!$hide_sm_attributions)
     {
         echo html_tag( 'td', '', 'right' ) ."\n";
-        if (!isset($provider_uri)) $provider_uri= 'http://www.squirrelmail.org/';
-        if (!isset($provider_name)) $provider_name= 'SquirrelMail';
-        echo '<a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>';
+        if (empty($provider_uri)) {
+            echo '<a href="about.php">SquirrelMail</a>';
+        } else {
+            if (empty($provider_name)) $provider_name= 'SquirrelMail';
+            echo '<a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>';
+        }
         echo "</td>\n";
     }
     echo "   </tr>\n".
-        "</table><br>\n\n";
+        "</table><br />\n\n";
 }
 
-/* blatently copied/truncated/modified from the above function */
-function compose_Header($color, $mailbox) {
-
+/**
+ * Blatantly copied/truncated/modified from displayPageHeader.
+ * Outputs a page header specifically for the compose_in_new popup window
+ *
+ * @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, $sHeaderJs='', $sBodyTagJs = 'onload="checkForm();"') {
     global $javascript_on;
-
     /*
      * Locate the first displayable form element (only when JavaScript on)
      */
     if($javascript_on) {
-        global $delimiter, $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 = '<script language="JavaScript" type="text/javascript">' .
-                 "\n<!--\n" .
-             "function checkForm() {\n";
-
-            global $action, $reply_focus;
-            if (strpos($action, 'reply') !== FALSE && $reply_focus)
-            {
-                if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
-                else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
-            }
-            else
-                $js .= "var f = document.forms.length;\n".
-                    "var i = 0;\n".
-                    "var pos = -1;\n".
-                    "while( pos == -1 && i < f ) {\n".
-                        "var e = document.forms[i].elements.length;\n".
-                        "var j = 0;\n".
-                        "while( pos == -1 && j < e ) {\n".
-                            "if ( document.forms[i].elements[j].type == 'text' ) {\n".
-                                "pos = j;\n".
-                            "}\n".
-                            "j++;\n".
-                        "}\n".
-                    "i++;\n".
-                    "}\n".
-                    "if( pos >= 0 ) {\n".
-                        "document.forms[i-1].elements[pos].focus();\n".
-                    "}\n".
-                "}\n";
-            $js .= "// -->\n".
-                "</script>\n";
-            $onload = 'onload="checkForm();"';
-            displayHtmlHeader (_("Compose"), $js);
-            break;   
+        if ($sHeaderJs) {
+            $sJsBlock = "\n<script language=\"JavaScript\" type=\"text/javascript\">" .
+                        "\n<!--\n" .
+                        $sHeaderJs . "\n\n// -->\n</script>\n";
+        } else {
+           $sJsBlock = '';
         }
+        $sJsBlock .= "\n" . '<script src="'. SM_PATH .'templates/default/js/default.js" type="text/javascript" language="JavaScript"></script>' ."\n";
+        displayHtmlHeader (_("Compose"), $sJsBlock);
     } else {
         /* javascript off */
         displayHtmlHeader(_("Compose"));
         $onload = '';
     }
-
-    echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
+    echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $sBodyTagJs>\n\n";
 }
-
 ?>