Added support for using Squirrelmail without frames
[squirrelmail.git] / functions / page_header.php
index c335530594c48b60b8ecb0ca2b5d0327f96f2431..9999df71b6083b968aeb5cb966cda3ef65443fae 100644 (file)
@@ -9,14 +9,24 @@
  * Prints the page header (duh)
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/** 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');
 
-/* 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
+ * @return void
+ */
 function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE ) {
     global $squirrelmail_language;
 
@@ -26,7 +36,7 @@ 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' ,'' , '', '', '' ) . "\n<head>\n";
+         "\n\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) . "\n<head>\n";
 
     if ( !isset( $custom_css ) || $custom_css == 'none' ) {
         if ($theme_css != '') {
@@ -39,7 +49,7 @@ function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE
     
     if ($squirrelmail_language == 'ja_JP') {
         echo "<!-- \xfd\xfe -->\n";
-        echo '<meta http-equuiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
+        echo '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
     }
     
     if ($do_hook) {
@@ -69,24 +79,52 @@ 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='') {
+    global $use_frames;
     sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
-    if ($target != '') {
-        $target = " target=\"$target\"";
-    }
+    if (isset($use_frames) && $use_frames) {
+        if ($target != '')
+            $target = " target=\"$target\"";
+    } else 
+       $target='';
+
+    $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);
 }
 
+/**
+ * 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 xtra extra html code to add
+ * @param bool session
+ * @return void
+ */
 function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
 
     global $hide_sm_attributions, $PHP_SELF, $frame_top,
            $compose_new_win, $compose_width, $compose_height,
            $attachemessages, $provider_name, $provider_uri,
-           $javascript_on;
+           $javascript_on, $default_use_mdn, $mdn_user_support;
 
     sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION );
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
@@ -110,6 +148,8 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
       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';
@@ -117,8 +157,6 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
                     if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
                         $compose_height = '550';
                     }
-                    $js .= "\n".'<script language="JavaScript" type="text/javascript">' .
-                        "\n<!--\n";
                     $js .= "function comp_in_new(comp_uri) {\n".
                     "       if (!comp_uri) {\n".
                     '           comp_uri = "'.$compose_uri."\";\n".
@@ -128,25 +166,38 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
                          '"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';".
+                           "    mdnuri=window.location+'&sendreceipt=1'; ".
                            "var newwin = window.open(mdnuri,'right');".
                       "\n}\n\n";
+                }
 
-                    $js .= "// -->\n".
-                      "</script>\n";
-            
-                 }
-                 displayHtmlHeader ('SquirrelMail', $js);
-                 $onload = $xtra;
+                // 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".
-                    "var f = document.forms.length;\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".
@@ -228,6 +279,8 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
     }
 
     echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
+    noframes_top();
+
     /** Here is the header and wrapping table **/
     $shortBoxName = imap_utf7_decode_local(
                      readShortMailboxName($mailbox, $delimiter));
@@ -249,7 +302,9 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
     echo "</b></td>\n"
         . "   </tr>\n"
         . html_tag( 'tr', '', '', $color[4] ) ."\n"
-        . html_tag( 'td', '', 'left' ) ."\n";
+        . ($hide_sm_attributions ? html_tag( 'td', '', 'left', '', 'colspan="2"' )
+                                 : html_tag( 'td', '', 'left' ) )
+        . "\n";
     $urlMailbox = urlencode($mailbox);
     echo makeComposeLink('src/compose.php?mailbox='.$urlMailbox);
     echo "&nbsp;&nbsp;\n";
@@ -266,18 +321,28 @@ function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
 
     do_hook('menuline');
 
-    echo "      </td>\n"
-        . html_tag( 'td', '', 'right' ) ."\n";
-    if (!isset($provider_uri)) $provider_uri= 'http://www.squirrelmail.org/';
-    if (!isset($provider_name)) $provider_name= 'SquirrelMail';
-    echo ($hide_sm_attributions ? '&nbsp;' :
-            '<a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>');
-    echo "</td>\n".
-        "   </tr>\n".
+    echo "      </td>\n";
+
+    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>';
+        echo "</td>\n";
+    }
+    echo "   </tr>\n".
         "</table><br>\n\n";
 }
 
-/* blatently copied/truncated/modified from the above function */
+/**
+ * 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
+ * @return void
+ */
 function compose_Header($color, $mailbox) {
 
     global $javascript_on;
@@ -299,8 +364,16 @@ function compose_Header($color, $mailbox) {
         default:
             $js = '<script language="JavaScript" type="text/javascript">' .
                  "\n<!--\n" .
-                 "function checkForm() {\n".
-                    "var f = document.forms.length;\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".
@@ -331,6 +404,8 @@ function compose_Header($color, $mailbox) {
     }
 
     echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
+
+
 }
 
-?>
+?>
\ No newline at end of file