src/right_main.php

   1 <?php
   2
   3 /**
   4  * right_main.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  * This is where the mailboxes are listed. This controls most of what
  10  * goes on in SquirrelMail.
  11  *
  12  * @version $Id$
  13  * @package squirrelmail
  14  */
  15
  16 /**
  17  * Path for SquirrelMail required files.
  18  * @ignore
  19  */
  20 define('SM_PATH','../');
  21
  22 /* SquirrelMail required files. */
  23 require_once(SM_PATH . 'include/validate.php');
  24 require_once(SM_PATH . 'functions/global.php');
  25 require_once(SM_PATH . 'functions/imap.php');
  26 require_once(SM_PATH . 'functions/date.php');
  27 require_once(SM_PATH . 'functions/mime.php');
  28 require_once(SM_PATH . 'functions/mailbox_display.php');
  29 require_once(SM_PATH . 'functions/display_messages.php');
  30 require_once(SM_PATH . 'functions/html.php');
  31 require_once(SM_PATH . 'functions/plugin.php');
  32 include_once(SM_PATH . 'class/error.class.php');
  33
  34
  35 //include_once(SM_PATH . 'templates/default/message_list.tpl');
  36 include_once(SM_PATH . 'class/template/template.class.php');
  37
  38 /**
  39  * Which templatedir are we using. TODO, add make a config var of this and make it possible to switch templates
  40  */
  41 $sTplDir = SM_PATH . 'templates/default/';
  42
  43 /*
  44  * Initialize the template object
  45  */
  46 $oTemplate = new Template($sTplDir);
  47
  48 /*
  49  * Initialize our custom error handler object
  50  */
  51 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
  52
  53 /*
  54  * Activate custom error handling
  55  */
  56 if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
  57     $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
  58 } else {
  59     $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
  60 }
  61
  62 // Trigger Developers to look at CSS ;)
  63 trigger_error("This layout sucks. Adapt squirrelmail.css!!!",E_USER_WARNING);
  64 //sqm_trigger_imap_error('SQM_IMAP_NO_THREAD',"BLA1",'BAD', 'BLA2', array('test1'=>'test1'));
  65
  66 /* lets get the global vars we may need */
  67 sqgetGlobalVar('key',       $key,           SQ_COOKIE);
  68 sqgetGlobalVar('username',  $username,      SQ_SESSION);
  69 sqgetGlobalVar('onetimepad',$onetimepad,    SQ_SESSION);
  70 sqgetGlobalVar('delimiter', $delimiter,     SQ_SESSION);
  71 sqgetGlobalVar('base_uri',  $base_uri,      SQ_SESSION);
  72
  73 sqgetGlobalVar('mailbox',   $mailbox);
  74 sqgetGlobalVar('lastTargetMailbox', $lastTargetMailbox, SQ_SESSION);
  75 sqgetGlobalVar('targetMailbox', $lastTargetMailbox, SQ_POST);
  76 sqgetGlobalVar('note',              $note,              SQ_GET);
  77 sqgetGlobalVar('mail_sent',         $mail_sent,         SQ_GET);
  78
  79
  80 if ( sqgetGlobalVar('startMessage', $temp) ) {
  81     $startMessage = (int) $temp;
  82 } else {
  83     $startMessage = 1;
  84 }
  85 // sort => srt because of the changed behaviour which can break new behaviour
  86 if ( sqgetGlobalVar('srt', $temp, SQ_GET) ) {
  87     $srt = (int) $temp;
  88 }
  89
  90 if ( sqgetGlobalVar('showall', $temp, SQ_GET) ) {
  91     $showall = (int) $temp;
  92 }
  93
  94 if ( sqgetGlobalVar('checkall', $temp, SQ_GET) ) {
  95   $checkall = (int) $temp;
  96 }
  97
  98 /* future work */
  99 if ( sqgetGlobalVar('account', $account, SQ_GET) ) {
 100   $account = (int) $account;
 101 } else {
 102   $account = 0;
 103 }
 104
 105 /* end of get globals */
 106
 107
 108 /* Open an imap connection */
 109
 110 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
 111
 112 $mailbox = (isset($mailbox) && $mailbox) ? $mailbox : 'INBOX';
 113
 114 /* compensate for the UW vulnerability. */
 115 if ($imap_server_type == 'uw' && (strstr($mailbox, '../') ||
 116                                   substr($mailbox, 0, 1) == '/')) {
 117    $mailbox = 'INBOX';
 118 }
 119 /**
 120  * Set the global settings for a mailbox and merge them with the usersettings
 121  * for the mailbox. In the future we can add more mailbox specific preferences
 122  * preferences.
 123  */
 124
 125
 126 /* not sure if this hook should be capable to alter the global pref array */
 127 do_hook ('generic_header');
 128
 129 $aMailboxPrefSer=getPref($data_dir, $username,'pref_'.$account.'_'.$mailbox);
 130 if ($aMailboxPrefSer) {
 131     $aMailboxPref = unserialize($aMailboxPrefSer);
 132     $aMailboxPref[MBX_PREF_COLUMNS] = $index_order; // index_order contains the columns to show and the order of the columns
 133 } else {
 134     setUserPref($username,'pref_'.$account.'_'.$mailbox,serialize($default_mailbox_pref));
 135     $aMailboxPref = $default_mailbox_pref;
 136 }
 137 if (isset($srt)) {
 138     $aMailboxPref[MBX_PREF_SORT] = (int) $srt;
 139 }
 140
 141 $trash_folder = (isset($trash_folder)) ? $trash_folder : false;
 142 $sent_folder = (isset($sent_folder)) ? $sent_folder : false;
 143 $draft_folder = (isset($draft_folder)) ? $draft_folder : false;
 144
 145
 146 /**
 147  * until there is no per mailbox option screen to set prefs we override
 148  * the mailboxprefs by the default ones
 149  */
 150 $aMailboxPref[MBX_PREF_LIMIT] = (int)  $show_num;
 151 $aMailboxPref[MBX_PREF_AUTO_EXPUNGE] = (bool) $auto_expunge;
 152 $aMailboxPref[MBX_PREF_INTERNALDATE] = (bool) getPref($data_dir, $username, 'internal_date_sort');
 153 $aMailboxPref[MBX_PREF_COLUMNS] = $index_order;
 154
 155 /**
 156  * Replace From => To  in case it concerns a draft or sent folder
 157  */
 158 if (($mailbox == $sent_folder || $mailbox == $draft_folder) &&
 159     !in_array(SQM_COL_TO,$aMailboxPref[MBX_PREF_COLUMNS])) {
 160     $aNewOrder = array(); // nice var name ;)
 161     foreach($aMailboxPref[MBX_PREF_COLUMNS] as $iCol) {
 162         if ($iCol == SQM_COL_FROM) {
 163             $iCol = SQM_COL_TO;
 164         }
 165         $aNewOrder[] = $iCol;
 166    }
 167    $aMailboxPref[MBX_PREF_COLUMNS] = $aNewOrder;
 168    setUserPref($username,'pref_'.$account.'_'.$mailbox,serialize($aMailboxPref));
 169 }
 170
 171
 172
 173 /**
 174  * Set the config options for the messages list
 175  */
 176 $aColumns = array(); // contains settings per column. Switch to key -> value based array, order is the order of the array keys
 177 foreach ($aMailboxPref[MBX_PREF_COLUMNS] as $iCol) {
 178     $aColumns[$iCol] = array();
 179     switch ($iCol) {
 180         case SQM_COL_SUBJ:
 181             if ($truncate_subject) {
 182                 $aColumns[$iCol]['truncate'] = $truncate_subject;
 183             }
 184             break;
 185         case SQM_COL_FROM:
 186         case SQM_COL_TO:
 187         case SQM_COL_CC:
 188         case SQM_COL_BCC:
 189             if ($truncate_sender) {
 190                 $aColumns[$iCol]['truncate'] = $truncate_sender;
 191             }
 192             break;
 193    }
 194 }
 195
 196 /**
 197  * Properties required by showMessagesForMailbox
 198  */
 199 $aProps = array(
 200     'columns' => $aColumns, // columns bound settings
 201     'config'  => array('alt_index_colors'       => $alt_index_colors,       // alternating row colors (should be a template thing)
 202                         'highlight_list'        => $message_highlight_list, // row highlighting rules
 203                         'fancy_index_highlite'  => $fancy_index_highlite,   // highlight rows on hover or on click -> check
 204                         'show_flag_buttons'     => (isset($show_flag_buttons)) ? $show_flag_buttons : true,
 205                         'lastTargetMailbox'     => (isset($lastTargetMailbox)) ? $lastTargetMailbox : '', // last mailbox where messages are moved/copied to
 206                         'trash_folder'          => $trash_folder,
 207                         'sent_folder'           => $sent_folder,
 208                         'draft_folder'          => $draft_folder,
 209                         'color'                 => $color,
 210                         'enablesort'            => true // enable sorting on columns
 211                 ),
 212     'mailbox' => $mailbox,
 213     'account' => (isset($account)) ? $account : 0, // future usage if we support multiple imap accounts
 214     'module' => 'read_body',
 215     'email'  => false);
 216
 217
 218 /**
 219  * system wide admin settings and incoming vars.
 220  */
 221 $aConfig = array(
 222                 'user'              => $username,
 223                 // incoming vars
 224                 'offset' => $startMessage // offset in paginator
 225                 );
 226 /**
 227  * The showall functionality is for the moment added to the config array
 228  * to avoid storage of the showall link in the mailbox pref. We could change
 229  * this behaviour later and add it to $aMailboxPref instead
 230  */
 231 if (isset($showall)) {
 232     $aConfig['showall'] = $showall; // show all messages in a mailbox (paginator is disabled)
 233 } else {
 234     $showall = false;
 235 }
 236
 237
 238 /**
 239  * Retrieve the mailbox cache from the session.
 240  */
 241 sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
 242
 243 /**
 244  * Select the mailbox and retrieve the cached info.
 245  */
 246 $aMailbox = sqm_api_mailbox_select($imapConnection,$account, $mailbox,$aConfig,$aMailboxPref);
 247
 248 /**
 249  * MOVE THIS to a central init section !!!!
 250  */
 251 if (!sqgetGlobalVar('align',$align,SQ_SESSION)) {
 252     $dir = ( isset( $languages[$squirrelmail_language]['DIR']) ) ? $languages[$squirrelmail_language]['DIR'] : 'ltr';
 253     if ( $dir == 'ltr' ) {
 254         $align = array('left' => 'left', 'right' => 'right');
 255     } else {
 256         $align = array('left' => 'right', 'right' => 'left');
 257     }
 258     sqsession_register($align, 'align');
 259 }
 260
 261 /*
 262  * After initialisation of the mailbox array it's time to handle the FORM data
 263  */
 264 $sError = handleMessageListForm($imapConnection,$aMailbox);
 265 if ($sError) {
 266    $note = $sError;
 267 }
 268
 269
 270
 271 /*
 272  * If we try to forward messages as attachment we have to open a new window
 273  * in case of compose in new window or redirect to compose.php
 274  */
 275 if (isset($aMailbox['FORWARD_SESSION'])) {
 276     if ($compose_new_win) {
 277         /* add the mailbox to the cache */
 278         $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
 279         sqsession_register($mailbox_cache,'mailbox_cache');
 280         // write the session in order to make sure that the compose window has
 281         // access to the composemessages array which is stored in the session
 282         session_write_close();
 283         // restart the session. Do not use sqsession_is_active because the session_id
 284         // isn't empty after a session_write_close
 285         session_start();
 286         if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
 287             $compose_width = '640';
 288         }
 289         if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
 290             $compose_height = '550';
 291         }
 292         // do not use &amp;, it will break the query string and $session will not be detected!!!
 293         $comp_uri = SM_PATH . 'src/compose.php?mailbox='. urlencode($mailbox).
 294                     '&session='.$aMailbox['FORWARD_SESSION'];
 295         displayPageHeader($color, $mailbox, "comp_in_new('$comp_uri', $compose_width, $compose_height);", '');
 296     } else {
 297         $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
 298         sqsession_register($mailbox_cache,'mailbox_cache');
 299
 300         // save mailboxstate
 301         sqsession_register($aMailbox,'aLastSelectedMailbox');
 302         session_write_close();
 303         // we have to redirect to the compose page
 304         $location = SM_PATH . 'src/compose.php?mailbox='. urlencode($mailbox).
 305                     '&session='.$aMailbox['FORWARD_SESSION'];
 306         header("Location: $location");
 307         exit;
 308     }
 309 } else {
 310     displayPageHeader($color, $mailbox);
 311 }
 312
 313 do_hook('right_main_after_header');
 314
 315 /* display a message to the user that their mail has been sent */
 316 if (isset($mail_sent) && $mail_sent == 'yes') {
 317     $note = _("Your Message has been sent.");
 318 }
 319 if (isset($note)) {
 320     echo html_tag( 'div', '<b>' . htmlspecialchars($note) .'</b>', 'center' ) . "<br />\n";
 321 }
 322
 323 if ( sqgetGlobalVar('just_logged_in', $just_logged_in, SQ_SESSION) ) {
 324     if ($just_logged_in == true) {
 325         $just_logged_in = false;
 326         sqsession_register($just_logged_in, 'just_logged_in');
 327
 328         if (strlen(trim($motd)) > 0) {
 329             echo html_tag( 'table',
 330                         html_tag( 'tr',
 331                             html_tag( 'td',
 332                                 html_tag( 'table',
 333                                     html_tag( 'tr',
 334                                         html_tag( 'td', $motd, 'center' )
 335                                     ) ,
 336                                 '', $color[4], 'width="100%" cellpadding="5" cellspacing="1" border="0"' )
 337                              )
 338                         ) ,
 339                     'center', $color[9], 'width="70%" cellpadding="0" cellspacing="3" border="0"' );
 340         }
 341     }
 342 }
 343
 344
 345 if ($aMailbox['EXISTS'] > 0) {
 346     $aTemplateVars = showMessagesForMailbox($imapConnection,$aMailbox,$aProps,$iError);
 347     if ($iError) {
 348
 349     }
 350     foreach ($aTemplateVars as $k => $v) {
 351         $oTemplate->assign($k, $v);
 352     }
 353
 354     /*
 355      * TODO: To many config related vars. We should move all config related vars to
 356      * one single associative array and assign that to the template
 357      */
 358     $oTemplate->assign('page_selector',  $page_selector);
 359     $oTemplate->assign('page_selector_max', $page_selector_max);
 360     $oTemplate->assign('compact_paginator', $compact_paginator);
 361     $oTemplate->assign('javascript_on', $javascript_on);
 362     $oTemplate->assign('enablesort', (isset($aProps['config']['enablesort'])) ? $aProps['config']['enablesort'] : false);
 363     // Aaaaaahhhhhhh FIX ME DO NOT USE the string "none" for a var when you mean the boolean false or null
 364     $oTemplate->assign('icon_theme', (isset($icon_theme) && $icon_theme !== 'none') ? $icon_theme : false);
 365     $oTemplate->assign('use_icons', (isset($use_icons)) ? $use_icons : false);
 366     $oTemplate->assign('aOrder', array_keys($aColumns));
 367     $oTemplate->assign('alt_index_colors', isset($alt_index_colors) ? $alt_index_colors: false);
 368     $oTemplate->assign('color', $color);
 369     $oTemplate->assign('align', $align);
 370
 371     $oTemplate->display('message_list.tpl');
 372
 373 } else {
 374     $string = '<b>' . _("THIS FOLDER IS EMPTY") . '</b>';
 375     echo '    <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="'.$color[9].'">';
 376     echo '     <tr><td>';
 377     echo '       <table width="100%" cellpadding="0" cellspacing="0" align="center" border="0" bgcolor="'.$color[4].'">';
 378     echo '        <tr><td><br />';
 379     echo '            <table cellpadding="1" cellspacing="5" align="center" border="0">';
 380     echo '              <tr>' . html_tag( 'td', $string."\n", 'left')
 381                         . '</tr>';
 382     echo '            </table>';
 383     echo '        <br /></td></tr>';
 384     echo '       </table></td></tr>';
 385     echo '    </table>';
 386 }
 387
 388 do_hook('right_main_bottom');
 389 sqimap_logout ($imapConnection);
 390 $oTemplate->display('footer.tpl');
 391
 392
 393 /* add the mailbox to the cache */
 394 $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
 395 sqsession_register($mailbox_cache,'mailbox_cache');
 396 ?>