6 * This is where the mailboxes are listed. This controls most of what
7 * goes on in SquirrelMail.
9 * @copyright © 1999-2006 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @package squirrelmail
15 //xdebug_start_profiling("/var/spool/xdebug/right_main.txt");
19 * Include the SquirrelMail initialization file.
21 include('../include/init.php');
23 /* SquirrelMail required files. */
24 require_once(SM_PATH
. 'functions/imap_asearch.php');
25 require_once(SM_PATH
. 'functions/imap_general.php');
26 require_once(SM_PATH
. 'functions/imap_messages.php');
27 require_once(SM_PATH
. 'functions/date.php');
28 require_once(SM_PATH
. 'functions/mime.php');
29 require_once(SM_PATH
. 'functions/mailbox_display.php');
32 /* lets get the global vars we may need */
33 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
34 sqgetGlobalVar('delayed_errors', $delayed_errors, SQ_SESSION
);
35 if (is_array($delayed_errors)) {
36 $oErrorHandler->AssignDelayedErrors($delayed_errors);
37 sqsession_unregister("delayed_errors");
39 sqgetGlobalVar('mailbox', $mailbox);
40 sqgetGlobalVar('lastTargetMailbox', $lastTargetMailbox, SQ_SESSION
);
41 sqgetGlobalVar('targetMailbox', $lastTargetMailbox, SQ_POST
);
42 sqgetGlobalVar('note', $note, SQ_GET
);
43 sqgetGlobalVar('mail_sent', $mail_sent, SQ_GET
);
46 if ( sqgetGlobalVar('startMessage', $temp) ) {
47 $startMessage = (int) $temp;
51 // sort => srt because of the changed behaviour which can break new behaviour
52 if ( sqgetGlobalVar('srt', $temp, SQ_GET
) ) {
56 if ( sqgetGlobalVar('showall', $temp, SQ_GET
) ) {
57 $showall = (int) $temp;
60 if ( sqgetGlobalVar('checkall', $temp, SQ_GET
) ) {
61 $checkall = (int) $temp;
65 if ( sqgetGlobalVar('account', $account, SQ_GET
) ) {
66 $account = (int) $account;
71 /* end of get globals */
74 /* Open an imap connection */
76 $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
78 $mailbox = (isset($mailbox) && $mailbox) ?
$mailbox : 'INBOX';
80 /* compensate for the UW vulnerability. */
81 if ($imap_server_type == 'uw' && (strstr($mailbox, '../') ||
82 substr($mailbox, 0, 1) == '/')) {
86 * Set the global settings for a mailbox and merge them with the usersettings
87 * for the mailbox. In the future we can add more mailbox specific preferences
91 $aMailboxPrefSer=getPref($data_dir, $username,'pref_'.$account.'_'.$mailbox);
92 if ($aMailboxPrefSer) {
93 $aMailboxPref = unserialize($aMailboxPrefSer);
94 $aMailboxPref[MBX_PREF_COLUMNS
] = $index_order; // index_order contains the columns to show and the order of the columns
96 setUserPref($username,'pref_'.$account.'_'.$mailbox,serialize($default_mailbox_pref));
97 $aMailboxPref = $default_mailbox_pref;
100 $aMailboxPref[MBX_PREF_SORT
] = (int) $srt;
103 $trash_folder = (isset($trash_folder)) ?
$trash_folder : false;
104 $sent_folder = (isset($sent_folder)) ?
$sent_folder : false;
105 $draft_folder = (isset($draft_folder)) ?
$draft_folder : false;
109 * until there is no per mailbox option screen to set prefs we override
110 * the mailboxprefs by the default ones
112 $aMailboxPref[MBX_PREF_LIMIT
] = (int) $show_num;
113 $aMailboxPref[MBX_PREF_AUTO_EXPUNGE
] = (bool) $auto_expunge;
114 $aMailboxPref[MBX_PREF_INTERNALDATE
] = (bool) getPref($data_dir, $username, 'internal_date_sort');
115 $aMailboxPref[MBX_PREF_COLUMNS
] = $index_order;
118 * Replace From => To in case it concerns a draft or sent folder
120 if (($mailbox == $sent_folder ||
$mailbox == $draft_folder) &&
121 !in_array(SQM_COL_TO
,$aMailboxPref[MBX_PREF_COLUMNS
])) {
122 $aNewOrder = array(); // nice var name ;)
123 foreach($aMailboxPref[MBX_PREF_COLUMNS
] as $iCol) {
124 if ($iCol == SQM_COL_FROM
) {
127 $aNewOrder[] = $iCol;
129 $aMailboxPref[MBX_PREF_COLUMNS
] = $aNewOrder;
130 setUserPref($username,'pref_'.$account.'_'.$mailbox,serialize($aMailboxPref));
136 * Set the config options for the messages list
138 $aColumns = array(); // contains settings per column. Switch to key -> value based array, order is the order of the array keys
139 foreach ($aMailboxPref[MBX_PREF_COLUMNS
] as $iCol) {
140 $aColumns[$iCol] = array();
143 if ($truncate_subject) {
144 $aColumns[$iCol]['truncate'] = $truncate_subject;
151 if ($truncate_sender) {
152 $aColumns[$iCol]['truncate'] = $truncate_sender;
159 * Properties required by showMessagesForMailbox
162 'columns' => $aColumns, // columns bound settings
163 'config' => array('alt_index_colors' => $alt_index_colors, // alternating row colors (should be a template thing)
164 'highlight_list' => $message_highlight_list, // row highlighting rules
165 'fancy_index_highlite' => $fancy_index_highlite, // highlight rows on hover or on click -> check
166 'show_flag_buttons' => (isset($show_flag_buttons)) ?
$show_flag_buttons : true,
167 'lastTargetMailbox' => (isset($lastTargetMailbox)) ?
$lastTargetMailbox : '', // last mailbox where messages are moved/copied to
168 'trash_folder' => $trash_folder,
169 'sent_folder' => $sent_folder,
170 'draft_folder' => $draft_folder,
172 'enablesort' => true // enable sorting on columns
174 'mailbox' => $mailbox,
175 'account' => (isset($account)) ?
$account : 0, // future usage if we support multiple imap accounts
176 'module' => 'read_body',
181 * system wide admin settings and incoming vars.
186 'offset' => $startMessage // offset in paginator
189 * The showall functionality is for the moment added to the config array
190 * to avoid storage of the showall link in the mailbox pref. We could change
191 * this behaviour later and add it to $aMailboxPref instead
193 if (isset($showall)) {
194 $aConfig['showall'] = $showall; // show all messages in a mailbox (paginator is disabled)
201 * Retrieve the mailbox cache from the session.
203 sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION
);
206 * Select the mailbox and retrieve the cached info.
208 $aMailbox = sqm_api_mailbox_select($imapConnection,$account, $mailbox,$aConfig,$aMailboxPref);
211 * MOVE THIS to a central init section !!!!
213 if (!sqgetGlobalVar('align',$align,SQ_SESSION
)) {
214 $dir = ( isset( $languages[$squirrelmail_language]['DIR']) ) ?
$languages[$squirrelmail_language]['DIR'] : 'ltr';
215 if ( $dir == 'ltr' ) {
216 $align = array('left' => 'left', 'right' => 'right');
218 $align = array('left' => 'right', 'right' => 'left');
220 sqsession_register($align, 'align');
224 * After initialisation of the mailbox array it's time to handle the FORM data
226 $sError = handleMessageListForm($imapConnection,$aMailbox);
234 * If we try to forward messages as attachment we have to open a new window
235 * in case of compose in new window or redirect to compose.php
237 if (isset($aMailbox['FORWARD_SESSION'])) {
238 if ($compose_new_win) {
239 /* add the mailbox to the cache */
240 $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
241 sqsession_register($mailbox_cache,'mailbox_cache');
242 // write the session in order to make sure that the compose window has
243 // access to the composemessages array which is stored in the session
244 session_write_close();
245 // restart the session. Do not use sqsession_is_active because the session_id
246 // isn't empty after a session_write_close
248 if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
249 $compose_width = '640';
251 if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
252 $compose_height = '550';
254 // do not use &, it will break the query string and $session will not be detected!!!
255 $comp_uri = SM_PATH
. 'src/compose.php?mailbox='. urlencode($mailbox).
256 '&session='.$aMailbox['FORWARD_SESSION'];
257 displayPageHeader($color, $mailbox, "comp_in_new('$comp_uri', $compose_width, $compose_height);", '');
259 $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
260 sqsession_register($mailbox_cache,'mailbox_cache');
263 sqsession_register($aMailbox,'aLastSelectedMailbox');
264 session_write_close();
265 // we have to redirect to the compose page
266 $location = SM_PATH
. 'src/compose.php?mailbox='. urlencode($mailbox).
267 '&session='.$aMailbox['FORWARD_SESSION'];
268 header("Location: $location");
272 displayPageHeader($color, $mailbox);
275 do_hook('right_main_after_header');
277 /* display a message to the user that their mail has been sent */
278 if (isset($mail_sent) && $mail_sent == 'yes') {
279 $note = _("Your Message has been sent.");
282 $oTemplate->assign('note', htmlspecialchars($note));
283 $oTemplate->display('note.tpl');
286 if ( sqgetGlobalVar('just_logged_in', $just_logged_in, SQ_SESSION
) ) {
287 if ($just_logged_in == true) {
288 $just_logged_in = false;
289 sqsession_register($just_logged_in, 'just_logged_in');
292 if (strlen($motd) > 0) {
293 $oTemplate->assign('motd', $motd);
294 $oTemplate->display('motd.tpl');
300 if ($aMailbox['EXISTS'] > 0) {
301 $aTemplateVars = showMessagesForMailbox($imapConnection,$aMailbox,$aProps,$iError);
305 foreach ($aTemplateVars as $k => $v) {
306 $oTemplate->assign($k, $v);
310 * TODO: To many config related vars. We should move all config related vars to
311 * one single associative array and assign that to the template
313 $oTemplate->assign('page_selector', $page_selector);
314 $oTemplate->assign('page_selector_max', $page_selector_max);
315 $oTemplate->assign('compact_paginator', $compact_paginator);
316 $oTemplate->assign('javascript_on', $javascript_on);
317 $oTemplate->assign('enablesort', (isset($aProps['config']['enablesort'])) ?
$aProps['config']['enablesort'] : false);
318 $oTemplate->assign('icon_theme_path', $icon_theme_path);
319 $oTemplate->assign('aOrder', array_keys($aColumns));
320 $oTemplate->assign('alt_index_colors', isset($alt_index_colors) ?
$alt_index_colors: false);
321 $oTemplate->assign('color', $color);
322 $oTemplate->assign('align', $align);
324 $oTemplate->display('message_list.tpl');
327 $oTemplate->display('empty_folder.tpl');
330 do_hook('right_main_bottom');
331 sqimap_logout ($imapConnection);
332 $oTemplate->display('footer.tpl');
335 /* add the mailbox to the cache */
336 $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
337 sqsession_register($mailbox_cache,'mailbox_cache');