functions/page_header.php

   1 <?php
   2
   3 /**
   4  * page_header.php
   5  *
   6  * Copyright (c) 1999-2005 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * Prints the page header (duh)
  10  *
  11  * @version $Id$
  12  * @package squirrelmail
  13  */
  14
  15 /** Include required files from SM */
  16 require_once(SM_PATH . 'functions/strings.php');
  17 require_once(SM_PATH . 'functions/html.php');
  18 require_once(SM_PATH . 'functions/imap_mailbox.php');
  19 require_once(SM_PATH . 'functions/global.php');
  20
  21 /**
  22  * Output a SquirrelMail page header, from <!doctype> to </head>
  23  * Always set up the language before calling these functions.
  24  *
  25  * @param string title the page title, default SquirrelMail.
  26  * @param string xtra extra HTML to insert into the header
  27  * @param bool do_hook whether to execute hooks, default true
  28  * @param bool frames generate html frameset doctype (since 1.5.1)
  29  * @return void
  30  */
  31 function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = true, $frames = false ) {
  32     global $squirrelmail_language;
  33
  34     if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
  35         global $base_uri;
  36     }
  37     global $theme_css, $custom_css, $pageheader_sent;
  38
  39     if ($frames) {
  40         echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">';
  41     } else {
  42         echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">';
  43     }
  44     echo "\n\n" . html_tag( 'html' ,'' , '', '', 'lang="'.$squirrelmail_language.'"' ) . "\n<head>\n";
  45
  46     /*
  47      * Add closing / to link and meta elements only after switching to xhtml 1.0 Transitional.
  48      * It is not compatible with html 4.01 Transitional
  49      */
  50     if ( !isset( $custom_css ) || $custom_css == 'none' ) {
  51         if ($theme_css != '') {
  52             echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"$theme_css\">";
  53         }
  54     } else {
  55         echo '<link rel="stylesheet" type="text/css" href="' .
  56              $base_uri . 'themes/css/'.$custom_css.'">';
  57     }
  58
  59     if ($squirrelmail_language == 'ja_JP') {
  60         /*
  61          * force correct detection of charset, when browser does not follow
  62          * http content-type and tries to detect charset from page content.
  63          * Shooting of browser's creator can't be implemented in php.
  64          * We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
  65          * recommendations and switch to unicode.
  66          */
  67         echo "<!-- \xfd\xfe -->\n";
  68         echo '<meta http-equiv="Content-type" content="text/html; charset=euc-jp">' . "\n";
  69     }
  70
  71     if ($do_hook) {
  72         do_hook('generic_header');
  73     }
  74
  75     echo "\n<title>$title</title>$xtra\n";
  76
  77     /* work around IE6's scrollbar bug */
  78     echo <<<ECHO
  79 <style type="text/css">
  80 <!--
  81   /* avoid stupid IE6 bug with frames and scrollbars */
  82   body {
  83       voice-family: "\"}\"";
  84       voice-family: inherit;
  85       width: expression(document.documentElement.clientWidth - 30);
  86   }
  87 -->
  88 </style>
  89
  90 ECHO;
  91
  92     echo "\n</head>\n\n";
  93
  94     /* this is used to check elsewhere whether we should call this function */
  95     $pageheader_sent = TRUE;
  96 }
  97
  98 /**
  99  * Given a path to a SquirrelMail file, return a HTML link to it
 100  *
 101  * @param string path the SquirrelMail file to link to
 102  * @param string text the link text
 103  * @param string target the target frame for this link
 104  */
 105 function makeInternalLink($path, $text, $target='') {
 106     sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
 107     if ($target != '') {
 108         $target = " target=\"$target\"";
 109     }
 110
 111     // This is an inefficient hook and is only used by
 112     // one plugin that still needs to patch this code,
 113     // plus if we are templat-izing SM, visual hooks
 114     // are not needed.  However, I am leaving the code
 115     // here just in case we find a good (non-visual?)
 116     // use for the internal_link hook.
 117     //
 118     //$hooktext = do_hook_function('internal_link',$text);
 119     //if ($hooktext != '')
 120     //    $text = $hooktext;
 121
 122     return '<a href="'.$base_uri.$path.'"'.$target.'>'.$text.'</a>';
 123 }
 124
 125 /**
 126  * Same as makeInternalLink, but echoes it too
 127  */
 128 function displayInternalLink($path, $text, $target='') {
 129     echo makeInternalLink($path, $text, $target);
 130 }
 131
 132 /**
 133  * Outputs a complete SquirrelMail page header, starting with <!doctype> and
 134  * including the default menu bar. Uses displayHtmlHeader and takes
 135  * JavaScript and locale settings into account.
 136  *
 137  * @param array color the array of theme colors
 138  * @param string mailbox the current mailbox name to display
 139  * @param string xtra extra html code to add
 140  * @param bool session
 141  * @return void
 142  */
 143 function displayPageHeader($color, $mailbox, $xtra='', $session=false) {
 144
 145     global $hide_sm_attributions, $PHP_SELF, $frame_top,
 146            $compose_new_win, $compose_width, $compose_height,
 147            $provider_name, $provider_uri, $startMessage,
 148            $javascript_on, $default_use_mdn, $mdn_user_support;
 149
 150     sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION );
 151     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
 152     $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
 153     if ($qmark = strpos($module, '?')) {
 154         $module = substr($module, 0, $qmark);
 155     }
 156     if (!isset($frame_top)) {
 157         $frame_top = '_top';
 158     }
 159
 160     if ($session) {
 161     $compose_uri = $base_uri.'src/compose.php?mailbox='.urlencode($mailbox).'&amp;attachedmessages=true&amp;session='."$session";
 162     } else {
 163         $compose_uri = $base_uri.'src/compose.php?newmessage=1';
 164     $session = 0;
 165     }
 166
 167     if( $javascript_on || strpos($xtra, 'new_js_autodetect_results.value') ) {
 168
 169       switch ( $module ) {
 170         case 'src/read_body.php':
 171                 $js ='';
 172
 173                 // compose in new window code
 174                 if ($compose_new_win == '1') {
 175                     if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
 176                         $compose_width = '640';
 177                     }
 178                     if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
 179                         $compose_height = '550';
 180                     }
 181                     $js .= "function comp_in_new_form(comp_uri, button, myform) {\n".
 182                            '   if (!comp_uri) {'."\n".
 183                            '       comp_uri = "'.$compose_uri."\";\n".
 184                            '   }'. "\n".
 185                            '   comp_uri += "&" + button.name + "=1";'."\n".
 186                            '   for ( var i=0; i < myform.elements.length; i++ ) {'."\n".
 187                            '      if ( myform.elements[i].type == "checkbox"  && myform.elements[i].checked )'."\n".
 188                            '         comp_uri += "&" + myform.elements[i].name + "=1";'."\n".
 189                            '   }'."\n".
 190                            '   var newwin = window.open(comp_uri' .
 191                            ', "_blank",'.
 192                            '"width='.$compose_width. ',height='.$compose_height.
 193                            ',scrollbars=yes,resizable=yes,status=yes");'."\n".
 194                            "}\n\n";
 195                     $js .= "function comp_in_new(comp_uri) {\n".
 196                            "       if (!comp_uri) {\n".
 197                            '           comp_uri = "'.$compose_uri."\";\n".
 198                            '       }'. "\n".
 199                            '    var newwin = window.open(comp_uri' .
 200                            ', "_blank",'.
 201                            '"width='.$compose_width. ',height='.$compose_height.
 202                            ',scrollbars=yes,resizable=yes,status=yes");'."\n".
 203                            "}\n\n";
 204                 }
 205
 206                 // javascript for sending read receipts
 207                 if($default_use_mdn && $mdn_user_support) {
 208                     $js .= 'function sendMDN() {'."\n".
 209                            "    mdnuri=window.location+'&sendreceipt=1'; ".
 210                            "var newwin = window.open(mdnuri,'right');".
 211                        "\n}\n\n";
 212                 }
 213
 214                 // if any of the above passes, add the JS tags too.
 215                 if($js) {
 216                     $js = "\n".'<script language="JavaScript" type="text/javascript">' .
 217                         "\n<!--\n" . $js . "// -->\n</script>\n";
 218                 }
 219
 220                 displayHtmlHeader ('SquirrelMail', $js);
 221                 $onload = $xtra;
 222             break;
 223         case 'src/compose.php':
 224             $js = '<script language="JavaScript" type="text/javascript">' .
 225                  "\n<!--\n" .
 226              "function checkForm() {\n";
 227
 228             global $action, $reply_focus;
 229             if (strpos($action, 'reply') !== FALSE && $reply_focus)
 230             {
 231                 if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
 232                 else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
 233                 else if ($reply_focus == 'none') $js .= "}\n";
 234             }
 235             // no reply focus also applies to composing new messages
 236             else if ($reply_focus == 'none')
 237             {
 238                 $js .= "}\n";
 239             }
 240             else
 241                 $js .= "var f = document.forms.length;\n".
 242                     "var i = 0;\n".
 243                     "var pos = -1;\n".
 244                     "while( pos == -1 && i < f ) {\n".
 245                         "var e = document.forms[i].elements.length;\n".
 246                         "var j = 0;\n".
 247                         "while( pos == -1 && j < e ) {\n".
 248                             "if ( document.forms[i].elements[j].type == 'text' ) {\n".
 249                                 "pos = j;\n".
 250                             "}\n".
 251                             "j++;\n".
 252                         "}\n".
 253                     "i++;\n".
 254                     "}\n".
 255                     "if( pos >= 0 ) {\n".
 256                         "document.forms[i-1].elements[pos].focus();\n".
 257                     "}\n".
 258                 "}\n";
 259
 260             $js .= "// -->\n".
 261                  "</script>\n";
 262             $onload = 'onload="checkForm();"';
 263             displayHtmlHeader ('SquirrelMail', $js);
 264             break;
 265
 266         default:
 267             $js = '<script language="JavaScript" type="text/javascript">' .
 268                  "\n<!--\n" .
 269                  "function checkForm() {\n".
 270                     "var f = document.forms.length;\n".
 271                     "var i = 0;\n".
 272                     "var pos = -1;\n".
 273                     "while( pos == -1 && i < f ) {\n".
 274                         "var e = document.forms[i].elements.length;\n".
 275                         "var j = 0;\n".
 276                         "while( pos == -1 && j < e ) {\n".
 277                             "if ( document.forms[i].elements[j].type == 'text' " .
 278                             "|| document.forms[i].elements[j].type == 'password' ) {\n".
 279                                 "pos = j;\n".
 280                             "}\n".
 281                             "j++;\n".
 282                         "}\n".
 283                     "i++;\n".
 284                     "}\n".
 285                     "if( pos >= 0 ) {\n".
 286                         "document.forms[i-1].elements[pos].focus();\n".
 287                     "}\n".
 288             "$xtra\n".
 289                 "}\n";
 290
 291                 if ($compose_new_win == '1') {
 292                     if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
 293                         $compose_width = '640';
 294                     }
 295                     if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
 296                         $compose_height = '550';
 297                     }
 298                     $js .= "function comp_in_new(comp_uri) {\n".
 299                          "       if (!comp_uri) {\n".
 300                          '           comp_uri = "'.$compose_uri."\";\n".
 301                          '       }'. "\n".
 302                          '    var newwin = window.open(comp_uri' .
 303                          ', "_blank",'.
 304                          '"width='.$compose_width. ',height='.$compose_height.
 305                          ',scrollbars=yes,resizable=yes,status=yes");'."\n".
 306                          "}\n\n";
 307
 308                 }
 309             $js .= "// -->\n". "</script>\n";
 310
 311             $onload = 'onload="checkForm();"';
 312             displayHtmlHeader ('SquirrelMail', $js);
 313             break;
 314
 315         }
 316     } else {
 317         /* do not use JavaScript */
 318         displayHtmlHeader ('SquirrelMail');
 319         $onload = '';
 320     }
 321
 322     echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
 323     /** Here is the header and wrapping table **/
 324     $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
 325                 readShortMailboxName($mailbox, $delimiter)));
 326     if ( $shortBoxName == 'INBOX' ) {
 327         $shortBoxName = _("INBOX");
 328     }
 329     echo "<a name=\"pagetop\"></a>\n"
 330         . html_tag( 'table', '', '', $color[4], 'border="0" width="100%" cellspacing="0" cellpadding="2"' ) ."\n"
 331         . html_tag( 'tr', '', '', $color[9] ) ."\n"
 332         . html_tag( 'td', '', 'left' ) ."\n";
 333     if ( $shortBoxName <> '' && strtolower( $shortBoxName ) <> 'none' ) {
 334         echo '         ' . _("Current Folder") . ": <b>$shortBoxName&nbsp;</b>\n";
 335     } else {
 336         echo '&nbsp;';
 337     }
 338     echo  "      </td>\n"
 339         . html_tag( 'td', '', 'right' ) ."<b>\n";
 340     displayInternalLink ('src/signout.php', _("Sign Out"), $frame_top);
 341     echo "</b></td>\n"
 342         . "   </tr>\n"
 343         . html_tag( 'tr', '', '', $color[4] ) ."\n"
 344         . ($hide_sm_attributions ? html_tag( 'td', '', 'left', '', 'colspan="2"' )
 345                                  : html_tag( 'td', '', 'left' ) )
 346         . "\n";
 347     $urlMailbox = urlencode($mailbox);
 348     echo makeComposeLink('src/compose.php?mailbox='.$urlMailbox.'&amp;startMessage='.$startMessage);
 349     echo "&nbsp;&nbsp;\n";
 350     displayInternalLink ('src/addressbook.php', _("Addresses"));
 351     echo "&nbsp;&nbsp;\n";
 352     displayInternalLink ('src/folders.php', _("Folders"));
 353     echo "&nbsp;&nbsp;\n";
 354     displayInternalLink ('src/options.php', _("Options"));
 355     echo "&nbsp;&nbsp;\n";
 356     displayInternalLink ("src/search.php?mailbox=$urlMailbox", _("Search"));
 357     echo "&nbsp;&nbsp;\n";
 358     displayInternalLink ('src/help.php', _("Help"));
 359     echo "&nbsp;&nbsp;\n";
 360
 361     do_hook('menuline');
 362
 363     echo "      </td>\n";
 364
 365     if (!$hide_sm_attributions)
 366     {
 367         echo html_tag( 'td', '', 'right' ) ."\n";
 368         if (!isset($provider_uri)) $provider_uri= 'http://www.squirrelmail.org/';
 369         if (!isset($provider_name)) $provider_name= 'SquirrelMail';
 370         echo '<a href="'.$provider_uri.'" target="_blank">'.$provider_name.'</a>';
 371         echo "</td>\n";
 372     }
 373     echo "   </tr>\n".
 374         "</table><br />\n\n";
 375 }
 376
 377 /**
 378  * Blatantly copied/truncated/modified from displayPageHeader.
 379  * Outputs a page header specifically for the compose_in_new popup window
 380  *
 381  * @param array color the array of theme colors
 382  * @param string mailbox the current mailbox name to display
 383  * @return void
 384  */
 385 function compose_Header($color, $mailbox) {
 386
 387     global $javascript_on;
 388
 389     /*
 390      * Locate the first displayable form element (only when JavaScript on)
 391      */
 392     if($javascript_on) {
 393         global $base_uri, $PHP_SELF, $data_dir, $username;
 394
 395         $module = substr( $PHP_SELF, ( strlen( $PHP_SELF ) - strlen( $base_uri ) ) * -1 );
 396
 397         switch ( $module ) {
 398         case 'src/search.php':
 399             $pos = getPref($data_dir, $username, 'search_pos', 0 ) - 1;
 400             $onload = "onload=\"document.forms[$pos].elements[2].focus();\"";
 401             displayHtmlHeader (_("Compose"));
 402             break;
 403         default:
 404             $js = '<script language="JavaScript" type="text/javascript">' .
 405                  "\n<!--\n" .
 406              "function checkForm() {\n";
 407
 408             global $action, $reply_focus;
 409             if (strpos($action, 'reply') !== FALSE && $reply_focus)
 410             {
 411                 if ($reply_focus == 'select') $js .= "document.forms['compose'].body.select();}\n";
 412                 else if ($reply_focus == 'focus') $js .= "document.forms['compose'].body.focus();}\n";
 413                 else if ($reply_focus == 'none') $js .= "}\n";
 414             }
 415             // no reply focus also applies to composing new messages
 416             else if ($reply_focus == 'none')
 417             {
 418                 $js .= "}\n";
 419             }
 420             else
 421                 $js .= "var f = document.forms.length;\n".
 422                     "var i = 0;\n".
 423                     "var pos = -1;\n".
 424                     "while( pos == -1 && i < f ) {\n".
 425                         "var e = document.forms[i].elements.length;\n".
 426                         "var j = 0;\n".
 427                         "while( pos == -1 && j < e ) {\n".
 428                             "if ( document.forms[i].elements[j].type == 'text' ) {\n".
 429                                 "pos = j;\n".
 430                             "}\n".
 431                             "j++;\n".
 432                         "}\n".
 433                     "i++;\n".
 434                     "}\n".
 435                     "if( pos >= 0 ) {\n".
 436                         "document.forms[i-1].elements[pos].focus();\n".
 437                     "}\n".
 438                 "}\n";
 439             $js .= "// -->\n".
 440                  "</script>\n";
 441             $onload = 'onload="checkForm();"';
 442             displayHtmlHeader (_("Compose"), $js);
 443             break;
 444         }
 445     } else {
 446         /* javascript off */
 447         displayHtmlHeader(_("Compose"));
 448         $onload = '';
 449     }
 450
 451     echo "<body text=\"$color[8]\" bgcolor=\"$color[4]\" link=\"$color[7]\" vlink=\"$color[7]\" alink=\"$color[7]\" $onload>\n\n";
 452 }
 453
 454 ?>