functions/page_header.php

   1 <?php
   2
   3 /**
   4  * page_header.php
   5  *
   6  * Prints the page header (duh)
   7  *
   8  * @copyright 1999-2010 The SquirrelMail Project Team
   9  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10  * @version $Id$
  11  * @package squirrelmail
  12  */
  13
  14 /** Include required files from SM */
  15 include_once(SM_PATH . 'functions/imap_mailbox.php');
  16
  17 /**
  18  * Output a SquirrelMail page header, from <!doctype> to </head>
  19  * Always set up the language before calling these functions.
  20  *
  21  * Since 1.5.1 function sends http headers. Function should be called
  22  * before any output is started.
  23  * @param string title the page title, default SquirrelMail.
  24  * @param string xtra extra HTML to insert into the header
  25  * @param bool do_hook whether to execute hooks, default true
  26  * @param bool frames generate html frameset doctype (since 1.5.1)
  27  * @return void
  28  */
  29 function displayHtmlHeader( $title = 'SquirrelMail', $xtra = '', $do_hook = TRUE, $frames = FALSE ) {
  30     global $squirrelmail_language, $sTemplateID, $oErrorHandler, $oTemplate;
  31
  32     if ( !sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION) ) {
  33         global $base_uri;
  34     }
  35     global $custom_css, $pageheader_sent, $theme, $theme_default, $text_direction,
  36         $default_fontset, $chosen_fontset, $default_fontsize, $chosen_fontsize,
  37         $chosen_theme, $chosen_theme_path, $user_themes, $user_theme_default;
  38
  39     /* add no cache headers here */
  40 //FIXME: should change all header() calls in SM core to use $oTemplate->header()!!
  41     $oTemplate->header('Pragma: no-cache'); // http 1.0 (rfc1945)
  42     $oTemplate->header('Cache-Control: private, no-cache, no-store'); // http 1.1 (rfc2616)
  43     /* prevent information leakage about read emails by forbidding Firefox
  44      * to do preemptive DNS requests for any links in the message body. */
  45     $oTemplate->header('X-DNS-Prefetch-Control: off');
  46
  47     // don't show version as a security measure
  48     //$oTemplate->header('X-Powered-By: SquirrelMail/' . SM_VERSION, FALSE);
  49     $oTemplate->header('X-Powered-By: SquirrelMail', FALSE);
  50
  51     $oTemplate->assign('frames', $frames);
  52     $oTemplate->assign('lang', $squirrelmail_language);
  53
  54     $header_tags = '';
  55
  56     $header_tags .= "<meta name=\"robots\" content=\"noindex,nofollow\" />\n";
  57
  58     $used_fontset = (!empty($chosen_fontset) ? $chosen_fontset : $default_fontset);
  59     $used_fontsize = (!empty($chosen_fontsize) ? $chosen_fontsize : $default_fontsize);
  60     $used_theme = !isset($chosen_theme) && $user_theme_default != 'none' && is_dir($chosen_theme) && is_readable($chosen_theme)?  $user_themes[$user_theme_default]['PATH'].'/default.css' : $chosen_theme_path;
  61
  62     /**
  63      * Stylesheets are loaded in the following order:
  64      *    1) All stylesheets provided by the template.  Normally, these are
  65      *       stylsheets in templates/<template>/css/.  This is accomplished by calling
  66      *       $oTemplate->fetch_standard_stylesheet_links().
  67      *    2) An optional user-defined stylesheet.  This is set in the Display
  68      *       Preferences.
  69      *    3) src/style.php which sets some basic font prefs.
  70      *    4) If we are dealing with an RTL language, we load rtl.css from the
  71      *       template set.
  72      */
  73
  74     // 1. Stylesheets from the template.
  75     $header_tags .= $oTemplate->fetch_standard_stylesheet_links();
  76
  77     $aUserStyles = array();
  78
  79     // 2. Option user-defined stylesheet from preferences.
  80     if (!empty($used_theme) && $used_theme != 'none') {
  81         /**
  82          * All styles (except "none" - ugh) just point to a directory,
  83          * so we need to include all .css files in that directory.
  84          */
  85 //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?)
  86         $styles = $used_theme == 'none' ? array()
  87                 : list_files($used_theme, '.css');
  88         foreach ($styles as $sheet) {
  89             $aUserStyles[] = $used_theme .'/'.$sheet;
  90         }
  91     }
  92
  93     // 3. src/style.php
  94     $aUserStyles[] = $base_uri .'src/style.php?'
  95                    . (!empty($used_fontset) ? '&amp;fontset='.$used_fontset : '')
  96                    . (!empty($used_fontsize) ? '&amp;fontsize='.$used_fontsize : '');
  97
  98     // 3.1.  Load the stylesheets we have already
  99     $header_tags .= $oTemplate->fetch_external_stylesheet_links($aUserStyles);
 100
 101     // 4. Optional rtl.css stylesheet
 102     if ($text_direction == 'rtl') {
 103         $header_tags .= $oTemplate->fetch_right_to_left_stylesheet_link();
 104     }
 105
 106     // 5. Printer friendly stylesheet
 107     $header_tags .= create_css_link($base_uri . 'css/print.css', 'printerfriendly', false, 'print');
 108
 109     if ($squirrelmail_language == 'ja_JP') {
 110         /*
 111          * force correct detection of charset, when browser does not follow
 112          * http content-type and tries to detect charset from page content.
 113          * Shooting of browser's creator can't be implemented in php.
 114          * We might get rid of it, if we follow http://www.w3.org/TR/japanese-xml/
 115          * recommendations and switch to unicode.
 116          */
 117         $header_tags .= "<!-- \xfd\xfe -->\n";
 118         $header_tags .= '<meta http-equiv="Content-type" content="' . $oTemplate->get_content_type() . '; charset=euc-jp" />' . "\n";
 119     }
 120     if ($do_hook) {
 121         // NOTE! plugins here MUST assign output to template
 122         //       and NOT echo anything directly!!  A common
 123         //       approach is if a plugin decides it needs to
 124         //       put something at page-top after the standard
 125         //       SM page header, to dynamically add itself to
 126         //       the page_header_bottom and/or compose_header_bottom
 127         //       hooks for the current page request.  See
 128         //       the Sent Confirmation v1.7 or Restrict Senders v1.2
 129         //       plugins for examples of this approach.
 130         ob_start();
 131         $temp = array(&$header_tags);
 132         do_hook('generic_header', $temp);
 133         $output = ob_get_contents();
 134         ob_end_clean();
 135         // plugin authors can debug their errors with one of the following:
 136         //sm_print_r($output);
 137         //echo $output;
 138         if (!empty($output)) trigger_error('A plugin on the "generic_header" hook has attempted to output directly to the browser', E_USER_ERROR);
 139     }
 140
 141     $header_tags .= $xtra;
 142     $oTemplate->assign('page_title', $title);
 143
 144     /* work around IE6's scrollbar bug */
 145     $header_tags .= <<<EOS
 146 <!--[if IE 6]>
 147 <style type="text/css">
 148 /* avoid stupid IE6 bug with frames and scrollbars */
 149 body {
 150     width: expression(document.documentElement.clientWidth - 30);
 151 }
 152 </style>
 153 <![endif]-->
 154
 155 EOS;
 156
 157     $oTemplate->assign('header_tags', $header_tags);
 158     $oTemplate->display('protocol_header.tpl');
 159
 160     /* this is used to check elsewhere whether we should call this function */
 161     $pageheader_sent = TRUE;
 162     if (isset($oErrorHandler)) {
 163         $oErrorHandler->HeaderSent();
 164     }
 165
 166 }
 167
 168 /**
 169  * Given a path to a SquirrelMail file, return a HTML link to it
 170  *
 171  * @param string $path      The SquirrelMail file to link to
 172  *                          (should start with something like "src/..." or
 173  *                          "functions/..." or "plugins/..." etc.)
 174  * @param string $text      The link text
 175  * @param string $target    The target frame for this link
 176  * @param string $accesskey The access key to be used, if any
 177  */
 178 function makeInternalLink($path, $text, $target='', $accesskey='NONE') {
 179     global $base_uri, $oTemplate;
 180 //    sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
 181
 182     // This is an inefficient hook and is only used by
 183     // one plugin that still needs to patch this code,
 184     // plus if we are templat-izing SM, visual hooks
 185     // are not needed.  However, I am leaving the code
 186     // here just in case we find a good (non-visual?)
 187     // use for the internal_link hook.
 188     //
 189     //do_hook('internal_link', $text);
 190
 191     return create_hyperlink($base_uri . $path, $text, $target,
 192                             '', '', '', '',
 193                             ($accesskey == 'NONE'
 194                             ? array()
 195                             : array('accesskey' => $accesskey)));
 196 }
 197
 198 /**
 199  * Outputs a complete SquirrelMail page header, starting with <!doctype> and
 200  * including the default menu bar. Uses displayHtmlHeader and takes
 201  * JavaScript and locale settings into account.
 202  *
 203  * @param array color the array of theme colors
 204  * @param string mailbox the current mailbox name to display
 205  * @param string sHeaderJs javascipt code to be inserted in a script block in the header
 206  * @param string sOnload JavaScript code to be added inside the body's onload handler
 207  *                       as of 1.5.2, this replaces $sBodyTagJs argument
 208  * @return void
 209  */
 210 function displayPageHeader($color, $mailbox='', $sHeaderJs='', $sOnload = '') {
 211
 212     global $reply_focus, $hide_sm_attributions, $frame_top,
 213         $provider_name, $provider_uri, $startMessage,
 214         $action, $oTemplate, $org_title, $base_uri,
 215         $data_dir, $username;
 216
 217     if (empty($sOnload)) {
 218         if (strpos($action, 'reply') !== FALSE && $reply_focus) {
 219             if ($reply_focus == 'select')
 220                 $sOnload = 'checkForm(\'select\');';
 221             else if ($reply_focus == 'focus')
 222                 $sOnload = 'checkForm(\'focus\');';
 223             else if ($reply_focus != 'none')
 224                 $sOnload = 'checkForm();';
 225         }
 226         else
 227             $sOnload = 'checkForm();';
 228     }
 229
 230     $startMessage = (int)$startMessage;
 231
 232     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION );
 233
 234     if (!isset($frame_top)) {
 235         $frame_top = '_top';
 236     }
 237
 238 //FIXME: does checkForJavascript() make the 2nd part of the if() below unneccessary?? (that is, I think checkForJavascript() might already look for new_js_autodetect_results...(?))
 239     if( checkForJavascript() || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
 240         $js_includes = $oTemplate->get_javascript_includes(TRUE);
 241         $sJsBlock = '';
 242         foreach ($js_includes as $js_file) {
 243             $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
 244         }
 245         if ($sHeaderJs) {
 246             $sJsBlock .= "\n<script type=\"text/javascript\">" .
 247                         "\n<!--\n" .
 248                         $sHeaderJs . "\n\n// -->\n</script>\n";
 249         }
 250         displayHtmlHeader ($org_title, $sJsBlock);
 251     } else {
 252         /* do not use JavaScript */
 253         displayHtmlHeader ($org_title);
 254         $sOnload = '';
 255     }
 256     if ($mailbox) {
 257         /*
 258         * this explains the imap_mailbox.php dependency. We should instead store
 259         * the selected mailbox in the session and fallback to the session var.
 260         */
 261         $shortBoxName = htmlspecialchars(imap_utf7_decode_local(
 262                     readShortMailboxName($mailbox, $delimiter)));
 263         if (getPref($data_dir, $username, 'translate_special_folders')) {
 264             global $sent_folder, $trash_folder, $draft_folder;
 265             if ($mailbox == $sent_folder)
 266                 $shortBoxName = _("Sent");
 267             else if ($mailbox == $trash_folder)
 268                 $shortBoxName = _("Trash");
 269             else if ($mailbox == $sent_folder)
 270                 $shortBoxName = _("Drafts");
 271         }
 272         $urlMailbox = urlencode($mailbox);
 273     } else {
 274         $shortBoxName = '';
 275         $urlMailbox = '';
 276     }
 277
 278     $provider_link = '';
 279     if (!empty($provider_uri) && !empty($provider_name) && $provider_name != 'SquirrelMail') {
 280         $provider_link = create_hyperlink($provider_uri, $provider_name, '_blank');
 281     }
 282
 283     $oTemplate->assign('onload', $sOnload);
 284     $oTemplate->assign('shortBoxName', $shortBoxName);
 285     $oTemplate->assign('provider_link', $provider_link);
 286     $oTemplate->assign('frame_top', $frame_top);
 287     $oTemplate->assign('urlMailbox', $urlMailbox);
 288     $oTemplate->assign('startMessage', $startMessage);
 289     $oTemplate->assign('hide_sm_attributions', $hide_sm_attributions);
 290
 291     // access keys
 292     //
 293     global $accesskey_menubar_compose, $accesskey_menubar_addresses,
 294            $accesskey_menubar_folders, $accesskey_menubar_options,
 295            $accesskey_menubar_search, $accesskey_menubar_help,
 296            $accesskey_menubar_signout;
 297     $oTemplate->assign('accesskey_menubar_compose', $accesskey_menubar_compose);
 298     $oTemplate->assign('accesskey_menubar_addresses', $accesskey_menubar_addresses);
 299     $oTemplate->assign('accesskey_menubar_folders', $accesskey_menubar_folders);
 300     $oTemplate->assign('accesskey_menubar_options', $accesskey_menubar_options);
 301     $oTemplate->assign('accesskey_menubar_search', $accesskey_menubar_search);
 302     $oTemplate->assign('accesskey_menubar_help', $accesskey_menubar_help);
 303     $oTemplate->assign('accesskey_menubar_signout', $accesskey_menubar_signout);
 304
 305     $oTemplate->display('page_header.tpl');
 306
 307     global $null;
 308     do_hook('page_header_bottom', $null);
 309 }
 310
 311 /**
 312  * Blatantly copied/truncated/modified from displayPageHeader.
 313  * Outputs a page header specifically for the compose_in_new popup window
 314  *
 315  * @param array color the array of theme colors
 316  * @param string mailbox the current mailbox name to display
 317  * @param string sHeaderJs javascipt code to be inserted in a script block in the header
 318  * @param string sOnload JavaScript code to be added inside the body's onload handler
 319  *                       as of 1.5.2, this replaces $sBodyTagJs argument
 320  * @return void
 321  */
 322 function compose_Header($color, $mailbox, $sHeaderJs='', $sOnload = '') {
 323
 324     global $reply_focus, $action, $oTemplate;
 325
 326     if (empty($sOnload)) {
 327         if (strpos($action, 'reply') !== FALSE && $reply_focus) {
 328             if ($reply_focus == 'select')
 329                 $sOnload = 'checkForm(\'select\');';
 330             else if ($reply_focus == 'focus')
 331                 $sOnload = 'checkForm(\'focus\');';
 332             else if ($reply_focus != 'none')
 333                 $sOnload = 'checkForm();';
 334         }
 335         else
 336             $sOnload = 'checkForm();';
 337     }
 338
 339
 340     /*
 341      * Locate the first displayable form element (only when JavaScript on)
 342      */
 343     if(checkForJavascript()) {
 344         if ($sHeaderJs) {
 345             $sJsBlock = "\n<script type=\"text/javascript\">" .
 346                         "\n<!--\n" .
 347                         $sHeaderJs . "\n\n// -->\n</script>\n";
 348         } else {
 349         $sJsBlock = '';
 350         }
 351         $sJsBlock .= "\n";
 352
 353         $js_includes = $oTemplate->get_javascript_includes(TRUE);
 354         foreach ($js_includes as $js_file) {
 355             $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
 356         }
 357
 358         displayHtmlHeader (_("Compose"), $sJsBlock);
 359     } else {
 360         /* javascript off */
 361         displayHtmlHeader(_("Compose"));
 362         $sOnload = '';
 363     }
 364
 365 // FIXME: change the colorization attributes below to a CSS class!
 366     $class = '';
 367     $aAttribs = array('text' => $color[8], 'bgcolor' => $color[4],
 368                       'link' => $color[7], 'vlink' => $color[7],
 369                       'alink' => $color[7]);
 370
 371     // this is template-safe (see create_body() function)
 372     echo create_body($sOnload, $class, $aAttribs);
 373
 374     global $null;
 375     do_hook('compose_header_bottom', $null);
 376 }