X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fmailbox_display.php;h=41a277a9c91cbbe016da22236cbd1bb2609aed10;hb=316c380a2f5f3495fc8f95f304514d4082b0aa8b;hp=4eeefd8aaafa44cae49edd386605f9a23772cb24;hpb=abafb676191905f40ed21a163c95f4aa676e88ff;p=squirrelmail.git
diff --git a/functions/mailbox_display.php b/functions/mailbox_display.php
index 4eeefd8a..41a277a9 100644
--- a/functions/mailbox_display.php
+++ b/functions/mailbox_display.php
@@ -3,1346 +3,1553 @@
/**
* mailbox_display.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
* This contains functions that display mailbox information, such as the
* table row that has sender, date, subject, etc...
*
- * $Id$
+ * @copyright 1999-2013 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
* @package squirrelmail
*/
-/** The standard includes.. */
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
-require_once(SM_PATH . 'class/html.class.php');
-require_once(SM_PATH . 'functions/imap_mailbox.php');
-require_once(SM_PATH . 'functions/imap_messages.php');
-require_once(SM_PATH . 'functions/mime.php');
/**
- * default value for page_selector_max
+ * Selects a mailbox for header retrieval.
+ * Cache control for message headers is embedded.
+ *
+ * @param resource $imapConnection imap socket handle
+ * @param string $mailbox mailbox to select and retrieve message headers from
+ * @param array $aConfig array with system config settings and incoming vars
+ * @param array $aProps mailbox specific properties
+ *
+ * @return array $aMailbox mailbox array with all relevant information
+ *
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
*/
-define('PG_SEL_MAX', 10);
+function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aProps) {
-/**
- * @param mixed $start UNDOCUMENTED
- */
-function elapsed($start)
-{
- $end = microtime();
- list($start2, $start1) = explode(" ", $start);
- list($end2, $end1) = explode(" ", $end);
- $diff1 = $end1 - $start1;
- $diff2 = $end2 - $start2;
- if( $diff2 < 0 ){
- $diff1 -= 1;
- $diff2 += 1.0;
- }
- return $diff2 + $diff1;
-}
+ /**
+ * NB: retrieve this from the session before accessing this function
+ * and make sure you write it back at the end of the script after
+ * the aMailbox var is added so that the headers are added to the cache
+ */
+ global $mailbox_cache;
+
+ $aDefaultConfigProps = array(
+// 'charset' => 'US-ASCII',
+ 'user' => false, /* no pref storage if false */
+ 'setindex' => 0,
+// 'search' => 'ALL',
+ 'max_cache_size' => SQM_MAX_MBX_IN_CACHE
+ );
+
+ $aConfig = array_merge($aDefaultConfigProps,$aConfig);
+
+ $iSetIndx = $aConfig['setindex'];
+
+ $aMbxResponse = sqimap_mailbox_select($imapConnection, $mailbox);
-function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox,
- $start_msg, $where, $what) {
- global $checkall,
- $color, $msgs, $msort, $td_str, $msg,
- $default_use_priority,
- $message_highlight_list,
- $index_order,
- $indent_array, /* indent subject by */
- $pos, /* Search postion (if any) */
- $thread_sort_messages, /* thread sorting on/off */
- $server_sort_order, /* sort value when using server-sorting */
- $row_count,
- $allow_server_sort, /* enable/disable server-side sorting */
- $truncate_sender, /* number of characters for From/To field (<= 0 for unchanged) */
- $email_address,
- $show_recipient_instead; /* show recipient name instead of default identity */
-
- $color_string = $color[4];
-
- if ($GLOBALS['alt_index_colors']) {
- if (!isset($row_count)) {
- $row_count = 0;
+ if ($mailbox_cache) {
+ if (isset($mailbox_cache[$account.'_'.$mailbox])) {
+ $aCachedMailbox = $mailbox_cache[$account.'_'.$mailbox];
+ } else {
+ $aCachedMailbox = false;
}
- $row_count++;
- if ($row_count % 2) {
- if (!isset($color[12])) {
- $color[12] = '#EAEAEA';
+ /* cleanup cache */
+ if (count($mailbox_cache) > $aConfig['max_cache_size'] -1) {
+ $aTime = array();
+ foreach($mailbox_cache as $cachedmailbox => $aVal) {
+ $aTime[$aVal['TIMESTAMP']] = $cachedmailbox;
+ }
+ if (ksort($aTime,SORT_NUMERIC)) {
+ for ($i=0,$iCnt=count($mailbox_cache);$i<($iCnt-$aConfig['max_cache_size']);++$i) {
+ $sOldestMbx = array_shift($aTime);
+ /**
+ * Remove only the UIDSET and MSG_HEADERS from cache because those can
+ * contain large amounts of data.
+ */
+ if (isset($mailbox_cache[$sOldestMbx]['UIDSET'])) {
+ $mailbox_cache[$sOldestMbx]['UIDSET']= false;
+ }
+ if (isset($mailbox_cache[$sOldestMbx]['MSG_HEADERS'])) {
+ $mailbox_cache[$sOldestMbx]['MSG_HEADERS'] = false;
+ }
+ }
}
- $color_string = $color[12];
}
- }
- $msg = $msgs[$key];
- if($mailbox == 'None') {
- $boxes = sqimap_mailbox_list($imapConnection);
- $mailbox = $boxes[0]['unformatted'];
- unset($boxes);
+ } else {
+ $aCachedMailbox = false;
}
- $urlMailbox = urlencode($mailbox);
-
- $bSentFolder = handleAsSent($mailbox);
- if ((!$bSentFolder) && ($show_recipient_instead)) {
- // If the From address is the same as $email_address, then handle as Sent
- $from_array = parseAddress($msg['FROM'], 1);
- if (!isset($email_address)) {
- global $datadir, $username;
- $email_address = getPref($datadir, $username, 'email_address');
- }
- $bHandleAsSent = ((isset($from_array[0][0])) && ($from_array[0][0] == $email_address));
+
+ /**
+ * Deal with imap servers that do not return the required UIDNEXT or
+ * UIDVALIDITY response
+ * from a SELECT call (since rfc 3501 it's required).
+ */
+ if (!isset($aMbxResponse['UIDNEXT']) || !isset($aMbxResponse['UIDVALIDITY'])) {
+ $aStatus = sqimap_status_messages($imapConnection,$mailbox,
+ array('UIDNEXT','UIDVALIDITY'));
+ $aMbxResponse['UIDNEXT'] = $aStatus['UIDNEXT'];
+ $aMbxResponse['UIDVALIDTY'] = $aStatus['UIDVALIDITY'];
}
- else
- $bHandleAsSent = $bSentFolder;
- // If this is a Sent message, display To address instead of From
- if ($bHandleAsSent)
- $msg['FROM'] = $msg['TO'];
- // Passing 1 below results in only 1 address being parsed, thus defeating the following code
- $msg['FROM'] = parseAddress($msg['FROM']/*,1*/);
-
- /*
- * This is done in case you're looking into Sent folders,
- * because you can have multiple receivers.
- */
- $senderNames = $msg['FROM'];
- $senderName = '';
- $senderAddress = '';
- if (sizeof($senderNames)){
- foreach ($senderNames as $senderNames_part) {
- if ($senderName != '') {
- $senderName .= ', ';
- $senderAddress .= ', ';
+
+ $aMailbox['ACCOUNT'] = $account;
+ $aMailbox['UIDSET'][$iSetIndx] = false;
+ $aMailbox['ID'] = false;
+ $aMailbox['SETINDEX'] = $iSetIndx;
+ $aMailbox['MSG_HEADERS'] = false;
+
+ if ($aCachedMailbox) {
+ /**
+ * Validate integrity of cached data
+ */
+ if ($aCachedMailbox['EXISTS'] == $aMbxResponse['EXISTS'] &&
+ $aMbxResponse['EXISTS'] &&
+ $aCachedMailbox['UIDVALIDITY'] == $aMbxResponse['UIDVALIDITY'] &&
+ $aCachedMailbox['UIDNEXT'] == $aMbxResponse['UIDNEXT'] &&
+ isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
+ (!isset($aConfig['search']) || /* always set search from the searchpage */
+ $aCachedMailbox['SEARCH'][$iSetIndx] == $aConfig['search'])) {
+ if (isset($aCachedMailbox['MSG_HEADERS'])) {
+ $aMailbox['MSG_HEADERS'] = $aCachedMailbox['MSG_HEADERS'];
}
- $sender_address_part = htmlspecialchars($senderNames_part[0]);
- $sender_name_part = str_replace(' ',' ', decodeHeader($senderNames_part[1]));
- if ($sender_name_part) {
- $senderName .= $sender_name_part;
- $senderAddress .= $sender_name_part . ' <' . $sender_address_part . '>';
- } else {
- $senderName .= $sender_address_part;
- $senderAddress .= $sender_address_part;
+ $aMailbox['ID'] = $aCachedMailbox['ID'];
+ if (isset($aCachedMailbox['UIDSET'][$iSetIndx]) && $aCachedMailbox['UIDSET'][$iSetIndx]) {
+ if (isset($aProps[MBX_PREF_SORT]) && $aProps[MBX_PREF_SORT] != $aCachedMailbox['SORT'] ) {
+ $newsort = $aProps[MBX_PREF_SORT];
+ $oldsort = $aCachedMailbox['SORT'];
+ /**
+ * If it concerns a reverse sort we do not need to invalidate
+ * the cached sorted UIDSET, a reverse is sufficient.
+ */
+ if ((($newsort % 2) && ($newsort + 1 == $oldsort)) ||
+ (!($newsort % 2) && ($newsort - 1 == $oldsort))) {
+ $aMailbox['UIDSET'][$iSetIndx] = array_reverse($aCachedMailbox['UIDSET'][$iSetIndx]);
+ } else {
+ $server_sort_array = false;
+ $aMailbox['MSG_HEADERS'] = false;
+ $aMailbox['ID'] = false;
+ }
+ // store the new sort value in the mailbox pref
+ if ($aConfig['user']) {
+ // FIXME, in ideal situation, we write back the
+ // prefs at the end of the script
+ setUserPref($aConfig['user'],'pref_'.$account.'_'.$mailbox,serialize($aProps));
+ }
+ } else {
+ $aMailbox['UIDSET'][$iSetIndx] = $aCachedMailbox['UIDSET'][$iSetIndx];
+ }
}
}
}
- // If Sent, prefix with To: but only if not Sent folder
- if ($bHandleAsSent ^ $bSentFolder) {
- $senderName = _("To:") . ' ' . $senderName;
- $senderAddress = _("To:") . ' ' . $senderAddress;
- }
-
- if ($truncate_sender > 0)
- $senderName = truncateWithEntities($senderName, $truncate_sender);
-
- echo html_tag( 'tr','','','','VALIGN="top"') . "\n";
-
- if (isset($msg['FLAG_FLAGGED']) && ($msg['FLAG_FLAGGED'] == true)) {
- $flag = "";
- $flag_end = '';
+ /**
+ * Restore the offset in the paginator if no new offset is provided.
+ */
+ if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['offset']) && $aCachedMailbox['OFFSET']) {
+ $aMailbox['OFFSET'] = $aCachedMailbox['OFFSET'];
+ $aMailbox['PAGEOFFSET'] = $aCachedMailbox['PAGEOFFSET'];
} else {
- $flag = '';
- $flag_end = '';
+ $aMailbox['OFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] -1 : 0;
+ $aMailbox['PAGEOFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] : 1;
}
- if (!isset($msg['FLAG_SEEN']) || ($msg['FLAG_SEEN'] == false)) {
- $bold = '';
- $bold_end = '';
- } else {
- $bold = '';
- $bold_end = '';
+ /**
+ * Restore the number of messages in the result set
+ */
+ if (isset($aCachedMailbox['TOTAL'][$iSetIndx]) && $aCachedMailbox['TOTAL'][$iSetIndx]) {
+ $aMailbox['TOTAL'][$iSetIndx] = $aCachedMailbox['TOTAL'][$iSetIndx];
}
- if ($bHandleAsSent) {
- $italic = '';
- $italic_end = '';
+
+ /**
+ * Restore the showall value no new showall value is provided.
+ */
+ if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['showall']) &&
+ isset($aCachedMailbox['SHOWALL'][$iSetIndx]) && $aCachedMailbox['SHOWALL'][$iSetIndx]) {
+ $aMailbox['SHOWALL'][$iSetIndx] = $aCachedMailbox['SHOWALL'][$iSetIndx];
} else {
- $italic = '';
- $italic_end = '';
+ $aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ? 1 : 0;
}
- if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED']) {
- $fontstr = "";
- $fontstr_end = '';
+
+ /**
+ * Restore the sort order if no new sort order is provided.
+ */
+ if (!isset($aProps[MBX_PREF_SORT]) && isset($aCachedMailbox['SORT'])) {
+ $aMailbox['SORT'] = $aCachedMailbox['SORT'];
} else {
- $fontstr = '';
- $fontstr_end = '';
+ $aMailbox['SORT'] = (isset($aProps[MBX_PREF_SORT])) ? $aProps[MBX_PREF_SORT] : 0;
}
- if ($where && $what) {
- $searchstr = '&where='.$where.'&what='.$what;
+ /**
+ * Restore the number of message to show per page when no new limit is provided
+ */
+ if (!isset($aProps[MBX_PREF_LIMIT]) && isset($aCachedMailbox['LIMIT'])) {
+ $aMailbox['LIMIT'] = $aCachedMailbox['LIMIT'];
} else {
- $searchstr = '';
+ $aMailbox['LIMIT'] = (isset($aProps[MBX_PREF_LIMIT])) ? $aProps[MBX_PREF_LIMIT] : 15;
}
- if (is_array($message_highlight_list) && count($message_highlight_list)) {
- $msg['TO'] = parseAddress($msg['TO']);
- $msg['CC'] = parseAddress($msg['CC']);
- foreach ($message_highlight_list as $message_highlight_list_part) {
- if (trim($message_highlight_list_part['value']) != '') {
- $high_val = strtolower($message_highlight_list_part['value']);
- $match_type = strtoupper($message_highlight_list_part['match_type']);
- if($match_type == 'TO_CC') {
- $match = array('TO', 'CC');
- } else {
- $match = array($match_type);
- }
- foreach($match as $match_type) {
- switch($match_type) {
- case('TO'):
- case('CC'):
- case('FROM'):
- foreach ($msg[$match_type] as $address) {
- $address[0] = decodeHeader($address[0], true, false);
- $address[1] = decodeHeader($address[1], true, false);
- if (strstr('^^' . strtolower($address[0]), $high_val) ||
- strstr('^^' . strtolower($address[1]), $high_val)) {
- $hlt_color = $message_highlight_list_part['color'];
- break 4;
- }
- }
- break;
- default:
- $headertest = strtolower(decodeHeader($msg[$match_type], true, false));
- if (strstr('^^' . $headertest, $high_val)) {
- $hlt_color = $message_highlight_list_part['color'];
- break 3;
- }
- break;
- }
- }
- }
- }
+ /**
+ * Restore the ordered columns to show when no new ordered columns are provided
+ */
+ if (!isset($aProps[MBX_PREF_COLUMNS]) && isset($aCachedMailbox['COLUMNS'])) {
+ $aMailbox['COLUMNS'] = $aCachedMailbox['COLUMNS'];
+ } else {
+ $aMailbox['COLUMNS'] = (isset($aProps[MBX_PREF_COLUMNS])) ? $aProps[MBX_PREF_COLUMNS] :
+ array(SQM_COL_FLAGS,SQM_COL_FROM, SQM_COL_SUBJ, SQM_COL_FLAGS);
}
- if (!isset($hlt_color)) {
- $hlt_color = $color_string;
- }
- $checked = ($checkall == 1) ? ' CHECKED' : '';
- $col = 0;
- $msg['SUBJECT'] = str_replace(' ', ' ', decodeHeader($msg['SUBJECT']));
- $subject = processSubject($msg['SUBJECT'], $indent_array[$msg['ID']]);
- if (sizeof($index_order)) {
- foreach ($index_order as $index_order_part) {
- switch ($index_order_part) {
- case 1: /* checkbox */
- echo html_tag( 'td',
- "",
- 'center',
- $hlt_color );
- break;
- case 2: /* from */
- if ($senderAddress != $senderName) {
- $senderAddress = strtr($senderAddress, array_flip(get_html_translation_table(HTML_SPECIALCHARS)));
- $title = ' title="' . str_replace('"', "''", $senderAddress) . '"';
- }
- else
- $title = '';
- echo html_tag( 'td',
- $italic . $bold . $flag . $fontstr . $senderName .
- $fontstr_end . $flag_end . $bold_end . $italic_end,
- 'left',
- $hlt_color, $title );
- break;
- case 3: /* date */
- $date_string = $msg['DATE_STRING'] . '';
- if ($date_string == '') {
- $date_string = _("Unknown date");
- }
- echo html_tag( 'td',
- $bold . $flag . $fontstr . $date_string .
- $fontstr_end . $flag_end . $bold_end,
- 'center',
- $hlt_color,
- 'nowrap' );
- break;
- case 4: /* subject */
- $td_str = $bold;
- if ($thread_sort_messages == 1) {
- if (isset($indent_array[$msg['ID']])) {
- $td_str .= str_repeat(" ",$indent_array[$msg['ID']]);
- }
- }
- $td_str .= '";
+ /**
+ * Restore the headers we fetch the last time. Saves intitialisation stuff in read_body.
+ */
+ $aMailbox['FETCHHEADERS'] = (isset($aCachedMailbox['FETCHHEADERS'])) ? $aCachedMailbox['FETCHHEADERS'] : null;
- if (isset($msg['FLAG_ANSWERED']) && $msg['FLAG_ANSWERED'] == true) {
- $td_str .= _("A");
- $stuff = true;
- }
- if ($msg['TYPE0'] == 'multipart') {
- $td_str .= '+';
- $stuff = true;
- }
- if ($default_use_priority) {
- if ( ($msg['PRIORITY'] == 1) || ($msg['PRIORITY'] == 2) ) {
- $td_str .= "!";
- $stuff = true;
- }
- if ($msg['PRIORITY'] == 5) {
- $td_str .= "?";
- $stuff = true;
- }
- }
- if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED'] == true) {
- $td_str .= "D";
- $stuff = true;
- }
- if (!$stuff) {
- $td_str .= ' ';
- }
- do_hook("msg_envelope");
- $td_str .= '';
- echo html_tag( 'td',
- $td_str,
- 'center',
- $hlt_color,
- 'nowrap' );
- break;
- case 6: /* size */
- echo html_tag( 'td',
- $bold . $fontstr . show_readable_size($msg['SIZE']) .
- $fontstr_end . $bold_end,
- 'right',
- $hlt_color );
- break;
- }
- ++$col;
- }
+ if (!isset($aProps[MBX_PREF_AUTO_EXPUNGE]) && isset($aCachedMailbox['AUTO_EXPUNGE'])) {
+ $aMailbox['AUTO_EXPUNGE'] = $aCachedMailbox['AUTO_EXPUNGE'];
+ } else {
+ $aMailbox['AUTO_EXPUNGE'] = (isset($aProps[MBX_PREF_AUTO_EXPUNGE])) ? $aProps[MBX_PREF_AUTO_EXPUNGE] : false;
}
- if ($not_last) {
- echo '' . "\n" . ' |
' . "\n";
+ if (!isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx])) {
+ $aMailbox['SEARCH'][$iSetIndx] = $aCachedMailbox['SEARCH'][$iSetIndx];
+ } else if (isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
+ $aConfig['search'] != $aCachedMailbox['SEARCH'][$iSetIndx]) {
+ // reset the pageindex
+ $aMailbox['SEARCH'][$iSetIndx] = $aConfig['search'];
+ $aMailbox['OFFSET'] = 0;
+ $aMailbox['PAGEOFFSET'] = 1;
} else {
- echo ''."\n";
+ $aMailbox['SEARCH'][$iSetIndx] = (isset($aConfig['search'])) ? $aConfig['search'] : 'ALL';
}
-}
-
-function getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id) {
- if ($id != 'no') {
- $id = array_slice($id, ($start_msg-1), $show_num);
- $end = $start_msg + $show_num - 1;
- if ($num_msgs < $show_num) {
- $end_loop = $num_msgs;
- } else if ($end > $num_msgs) {
- $end_loop = $num_msgs - $start_msg + 1;
- } else {
- $end_loop = $show_num;
- }
- return fillMessageArray($imapConnection,$id,$end_loop,$show_num);
+ if (!isset($aConfig['charset']) && isset($aCachedMailbox['CHARSET'][$iSetIndx])) {
+ $aMailbox['CHARSET'][$iSetIndx] = $aCachedMailbox['CHARSET'][$iSetIndx];
} else {
- return false;
+ $aMailbox['CHARSET'][$iSetIndx] = (isset($aConfig['charset'])) ? $aConfig['charset'] : 'US-ASCII';
}
-}
-
-function getThreadMessages($imapConnection, $start_msg, $show_num, $num_msgs) {
- $id = get_thread_sort($imapConnection);
- return getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id);
-}
-function getServerSortMessages($imapConnection, $start_msg, $show_num,
- $num_msgs, $server_sort_order, $mbxresponse) {
- $id = sqimap_get_sort_order($imapConnection, $server_sort_order,$mbxresponse);
- return getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id);
-}
-
-function getSelfSortMessages($imapConnection, $start_msg, $show_num,
- $num_msgs, $sort, $mbxresponse) {
- $msgs = array();
- if ($num_msgs >= 1) {
- $id = sqimap_get_php_sort_order ($imapConnection, $mbxresponse);
- if ($sort < 6 ) {
- $end = $num_msgs;
- $end_loop = $end;
- /* set shownum to 999999 to fool sqimap_get_small_header_list
- and rebuild the msgs_str to 1:* */
- $show_num = 999999;
+ $aMailbox['NAME'] = $mailbox;
+ $aMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
+ $aMailbox['SEEN'] = (isset($aMbxResponse['SEEN'])) ? $aMbxResponse['SEEN'] : $aMbxResponse['EXISTS'];
+ $aMailbox['RECENT'] = (isset($aMbxResponse['RECENT'])) ? $aMbxResponse['RECENT'] : 0;
+ $aMailbox['UIDVALIDITY'] = $aMbxResponse['UIDVALIDITY'];
+ $aMailbox['UIDNEXT'] = $aMbxResponse['UIDNEXT'];
+ $aMailbox['PERMANENTFLAGS'] = $aMbxResponse['PERMANENTFLAGS'];
+ $aMailbox['RIGHTS'] = $aMbxResponse['RIGHTS'];
+
+ /* decide if we are thread sorting or not */
+ if ($aMailbox['SORT'] & SQSORT_THREAD) {
+ if (!sqimap_capability($imapConnection,'THREAD')) {
+ $aMailbox['SORT'] ^= SQSORT_THREAD;
} else {
- /* if it's not sorted */
- if ($start_msg + ($show_num - 1) < $num_msgs) {
- $end_msg = $start_msg + ($show_num - 1);
- } else {
- $end_msg = $num_msgs;
- }
- if ($end_msg < $start_msg) {
- $start_msg = $start_msg - $show_num;
- if ($start_msg < 1) {
- $start_msg = 1;
- }
- }
- $id = array_slice(array_reverse($id), ($start_msg-1), $show_num);
- $end = $start_msg + $show_num - 1;
- if ($num_msgs < $show_num) {
- $end_loop = $num_msgs;
- } else if ($end > $num_msgs) {
- $end_loop = $num_msgs - $start_msg + 1;
- } else {
- $end_loop = $show_num;
- }
+ $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT'];
}
- $msgs = fillMessageArray($imapConnection,$id,$end_loop, $show_num);
+ } else {
+ $aMailbox['THREAD_INDENT'] = false;
}
- return $msgs;
-}
-
+ /* set a timestamp for cachecontrol */
+ $aMailbox['TIMESTAMP'] = time();
+ return $aMailbox;
+}
-/*
- * This function loops through a group of messages in the mailbox
- * and shows them to the user.
+/**
+ * Fetch the message headers for a mailbox. Settings are part of the aMailbox
+ * array. Dependent of the mailbox settings it deals with sort, thread and search
+ * If server sort is supported then SORT is also used for retrieving sorted search results
+ *
+ * @param resource $imapConnection imap socket handle
+ * @param array $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
+ * @return error $error error number
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
*/
-function showMessagesForMailbox($imapConnection, $mailbox, $num_msgs,
- $start_msg, $sort, $color, $show_num,
- $use_cache, $mode='') {
- global $msgs, $msort, $auto_expunge, $thread_sort_messages,
- $allow_server_sort, $server_sort_order;
+function fetchMessageHeaders($imapConnection, &$aMailbox) {
- /*
- * For some reason, on PHP 4.3+, this being unset, and set in the session causes havoc
- * so setting it to an empty array beforehand seems to clean up the issue, and stopping the
- * "Your script possibly relies on a session side-effect which existed until PHP 4.2.3" error
+ /* FIX ME, this function is kind of big, maybe we can split it up in
+ a couple of functions. Make sure the functions are private and starts with _
+ Also make sure that the error codes are propagated */
+
+ /**
+ * Retrieve the UIDSET.
+ * Setindex is used to be able to store multiple uid sets. That will make it
+ * possible to display the mailbox multiple times in different sort order
+ * or to store serach results separate from normal mailbox view.
*/
+ $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
- if (!isset($msort)) {
- $msort = array();
+ $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
+ /**
+ * Adjust the start_msg
+ */
+ $start_msg = $aMailbox['PAGEOFFSET'];
+ if($aMailbox['PAGEOFFSET'] > $aMailbox['EXISTS']) {
+ $start_msg -= $aMailbox['LIMIT'];
+ if($start_msg < 1) {
+ $start_msg = 1;
+ }
}
- if (!isset($msgs)) {
- $msgs = array();
+ if (is_array($aMailbox['UIDSET'])) {
+ $aUid =& $aMailbox['UIDSET'][$iSetIndx];
+ } else {
+ $aUid = false;
}
-
- //$start = microtime();
- /* If autoexpunge is turned on, then do it now. */
- $mbxresponse = sqimap_mailbox_select($imapConnection, $mailbox);
- $srt = $sort;
- /* If autoexpunge is turned on, then do it now. */
- if ($auto_expunge == true) {
- $exp_cnt = sqimap_mailbox_expunge($imapConnection, $mailbox, false, '');
- $mbxresponse['EXISTS'] = $mbxresponse['EXISTS'] - $exp_cnt;
- $num_msgs = $mbxresponse['EXISTS'];
+ $aFetchHeaders = $aMailbox['FETCHHEADERS'];
+
+ $iError = 0;
+ $aFetchItems = $aHeaderItems = array();
+ // initialize the fields we want to retrieve:
+ $aHeaderFields = array();
+ foreach ($aFetchHeaders as $v) {
+ switch ($v) {
+ case SQM_COL_DATE: $aHeaderFields[] = 'Date'; break;
+ case SQM_COL_TO: $aHeaderFields[] = 'To'; break;
+ case SQM_COL_CC: $aHeaderFields[] = 'Cc'; break;
+ case SQM_COL_FROM: $aHeaderFields[] = 'From'; break;
+ case SQM_COL_SUBJ: $aHeaderFields[] = 'Subject'; break;
+ case SQM_COL_PRIO: $aHeaderFields[] = 'X-Priority'; break;
+ case SQM_COL_ATTACHMENT: $aHeaderFields[] = 'Content-Type'; break;
+ case SQM_COL_INT_DATE: $aFetchItems[] = 'INTERNALDATE'; break;
+ case SQM_COL_FLAGS: $aFetchItems[] = 'FLAGS'; break;
+ case SQM_COL_SIZE: $aFetchItems[] = 'RFC822.SIZE'; break;
+ default: break;
+ }
}
- if ($mbxresponse['EXISTS'] > 0) {
- /* if $start_msg is lower than $num_msgs, we probably deleted all messages
- * in the last page. We need to re-adjust the start_msg
- */
+ /**
+ * A uidset with sorted uid's is available. We can use the cache
+ */
+ if (isset($aUid) && $aUid ) {
+ // limit the cache to SQM_MAX_PAGES_IN_CACHE
+ if (!$aMailbox['SHOWALL'][$iSetIndx] && isset($aMailbox['MSG_HEADERS'])) {
+ $iMaxMsgs = $iLimit * SQM_MAX_PAGES_IN_CACHE;
+ $iCacheSize = count($aMailbox['MSG_HEADERS']);
+ if ($iCacheSize > $iMaxMsgs) {
+ $iReduce = $iCacheSize - $iMaxMsgs;
+ foreach ($aMailbox['MSG_HEADERS'] as $iUid => $value) {
+ if ($iReduce) {
+ unset($aMailbox['MSG_HEADERS'][$iUid]);
+ } else {
+ break;
+ }
+ --$iReduce;
+ }
+ }
+ }
- if($start_msg > $num_msgs) {
- $start_msg -= $show_num;
- if($start_msg < 1) {
- $start_msg = 1;
+ $id_slice = array_slice($aUid,$start_msg-1,$iLimit);
+ /* do some funky cache checks */
+ if (isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) {
+ // temp code, read_body del / next links fo not update fields.
+ foreach ($aMailbox['MSG_HEADERS'] as $iUid => $aValue) {
+ if (!isset($aValue['UID'])) {
+ unset($aMailbox['MSG_HEADERS'][$iUid]);
+ }
}
+ $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
+ } else {
+ $aMailbox['MSG_HEADERS'] = array();
+ $aUidCached = array();
}
+ $aUidNotCached = array_values(array_diff($id_slice,$aUidCached));
- /* This code and the next if() block check for
- * server-side sorting methods. The $id array is
- * formatted and $sort is set to 6 to disable
- * SM internal sorting
+ /**
+ * $aUidNotCached contains an array with UID's which need to be fetched to
+ * complete the needed message headers.
*/
-
- if ($thread_sort_messages == 1) {
- $mode = 'thread';
- } elseif ($allow_server_sort == 1) {
- $mode = 'serversort';
- } else {
- $mode = '';
+ if (count($aUidNotCached)) {
+ $aMsgs = sqimap_get_small_header_list($imapConnection,$aUidNotCached,
+ $aHeaderFields,$aFetchItems);
+ // append the msgs to the existend headers
+ $aMailbox['MSG_HEADERS'] += $aMsgs;
}
+ } else {
+ /**
+ * Initialize the sorted UID list or initiate a UID list with search
+ * results and fetch the visible message headers
+ */
- if ($use_cache) {
- sqgetGlobalVar('msgs', $msgs, SQ_SESSION);
- sqgetGlobalVar('msort', $msort, SQ_SESSION);
- } else {
- sqsession_unregister('msort');
- sqsession_unregister('msgs'); }
- switch ($mode) {
- case 'thread':
- $id = get_thread_sort($imapConnection);
- $msgs = getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id);
- if ($msgs === false) {
- echo '' .
- _("Thread sorting is not supported by your IMAP server.
Please report this to the system administrator.").
- '';
- $thread_sort_messages = 0;
- $msort = $msgs = array();
+ if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') { // in case of a search request
+
+ if ($aMailbox['SEARCH'][$iSetIndx] && $aMailbox['SORT'] == 0) {
+ $aUid = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
+ } else {
+
+ $iError = 0;
+ $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
+ $aUid = $aMailbox['UIDSET'][$iSetIndx];
+ }
+ if (!$iError) {
+ /**
+ * Number of messages is the resultset
+ */
+ $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
+ $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
+ if (count($id_slice)) {
+ $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
+ $aHeaderFields,$aFetchItems);
} else {
- $msort= $msgs;
- $sort = 6;
+ $iError = 1; // FIX ME, define an error code
}
- break;
- case 'serversort':
- $id = sqimap_get_sort_order($imapConnection, $sort, $mbxresponse);
- $msgs = getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id);
- if ($msgs === false) {
- echo '' .
- _( "Server-side sorting is not supported by your IMAP server.
Please report this to the system administrator.").
- '';
- $sort = $server_sort_order;
- $allow_server_sort = FALSE;
- $msort = $msgs = array();
- $id = array();
+ }
+ } else { //
+ $iError = 0;
+ $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
+ $aUid = $aMailbox['UIDSET'][$iSetIndx];
+
+ if (!$iError) {
+ /**
+ * Number of messages is the resultset
+ */
+ $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
+ $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
+ if (count($id_slice)) {
+ $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
+ $aHeaderFields,$aFetchItems);
} else {
- $msort = $msgs;
- $sort = 6;
+ $iError = 1; // FIX ME, define an error code
}
- break;
- default:
- if (!$use_cache) {
- $msgs = getSelfSortMessages($imapConnection, $start_msg, $show_num,
- $num_msgs, $sort, $mbxresponse);
- $msort = calc_msort($msgs, $sort);
- } /* !use cache */
- break;
- } // switch
- sqsession_register($msort, 'msort');
- sqsession_register($msgs, 'msgs');
-
- } /* if exists > 0 */
-
- $res = getEndMessage($start_msg, $show_num, $num_msgs);
- $start_msg = $res[0];
- $end_msg = $res[1];
-
- $paginator_str = get_paginator_str($mailbox, $start_msg, $end_msg,
- $num_msgs, $show_num, $sort);
-
- $msg_cnt_str = get_msgcnt_str($start_msg, $end_msg, $num_msgs);
-
- do_hook('mailbox_index_before');
-?>
-
-
-
-
- |
-
- |
-
-
-
-
- |
-
-
- $show_num) {
- $end_msg = $show_num;
- $start_msg = 1;
- }
- }
- $endVar = $end_msg + 1;
+ /* retrieve the properties */
+ $my_email_address = (isset($aProps['email'])) ? $aProps['email'] : false;
+ $highlight_list = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
+ $aColumnDesc = (isset($aProps['columns'])) ? $aProps['columns'] : false;
+ $aExtraColumns = (isset($aProps['extra_columns'])) ? $aProps['extra_columns'] : array();
+ $iAccount = (isset($aProps['account'])) ? (int) $aProps['account'] : 0;
+ $sMailbox = (isset($aProps['mailbox'])) ? $aProps['mailbox'] : false;
+ $sTargetModule = (isset($aProps['module'])) ? $aProps['module'] : 'read_body';
/*
- * Loop through and display the info for each message.
- * ($t is used for the checkbox number)
+ * TODO 1, retrieve array with identity email addresses in order to match against to,cc and set a flag
+ * $aFormattedMessages[$iUid]['match_identity'] = true
+ * The template can show some image if there is a match.
+ * TODO 2, makes sure the matching is done fast by doing a strpos call on the returned $value
*/
- $t = 0;
-
- /* messages display */
-
- if (!$num_msgs) {
- /* if there's no messages in this folder */
- echo html_tag( 'tr',
- html_tag( 'td',
- "
" . _("THIS FOLDER IS EMPTY") . "
",
- 'center',
- $color[4],
- 'COLSPAN="' . count($index_order) . '"'
- )
- );
- } elseif ($start_msg == $end_msg) {
- /* if there's only one message in the box, handle it differently. */
- if ($sort != 6) {
- $i = $start_msg;
- } else {
- $i = 1;
+
+ /**
+ * Only retrieve values for displayable columns
+ */
+ foreach ($aColumnDesc as $k => $v) {
+ switch ($k) {
+ case SQM_COL_FROM: $aCol[SQM_COL_FROM] = 'from'; break;
+ case SQM_COL_DATE: $aCol[SQM_COL_DATE] = 'date'; break;
+ case SQM_COL_SUBJ: $aCol[SQM_COL_SUBJ] = 'subject'; break;
+ case SQM_COL_FLAGS: $aCol[SQM_COL_FLAGS] = 'FLAGS'; break;
+ case SQM_COL_SIZE: $aCol[SQM_COL_SIZE] = 'SIZE'; break;
+ case SQM_COL_PRIO: $aCol[SQM_COL_PRIO] = 'x-priority'; break;
+ case SQM_COL_ATTACHMENT: $aCol[SQM_COL_ATTACHMENT] = 'content-type'; break;
+ case SQM_COL_INT_DATE: $aCol[SQM_COL_INT_DATE] = 'INTERNALDATE'; break;
+ case SQM_COL_TO: $aCol[SQM_COL_TO] = 'to'; break;
+ case SQM_COL_CC: $aCol[SQM_COL_CC] = 'cc'; break;
+ case SQM_COL_BCC: $aCol[SQM_COL_BCC] = 'bcc'; break;
+ default: break;
}
- reset($msort);
- $k = 0;
- do {
- $key = key($msort);
- next($msort);
- $k++;
- } while (isset ($key) && ($k < $i));
- printMessageInfo($imapConnection, $t, true, $key, $mailbox,
- $real_startMessage, $where, $what);
- } else {
- $i = $start_msg;
- reset($msort);
- $k = 0;
- do {
- $key = key($msort);
- next($msort);
- $k++;
- } while (isset ($key) && ($k < $i));
- $not_last = true;
- do {
- if (!$i || $i == $endVar-1) $not_last = false;
- printMessageInfo($imapConnection, $t, $not_last, $key, $mailbox,
- $real_startMessage, $where, $what);
- $key = key($msort);
- $t++;
- $i++;
- next($msort);
- } while ($i && $i < $endVar);
}
-}
-
-/*
- * Displays the standard message list header. To finish the table,
- * you need to do a "";
- *
- * $moveURL is the URL to submit the delete/move form to
- * $mailbox is the current mailbox
- * $sort is the current sorting method (-1 for no sorting available [searches])
- * $Message is a message that is centered on top of the list
- * $More is a second line that is left aligned
- */
-
-function mail_message_listing_beginning ($imapConnection,
- $mailbox = '', $sort = -1,
- $msg_cnt_str = '',
- $paginator = ' ',
- $start_msg = 1) {
- global $color, $auto_expunge, $base_uri,
- $allow_server_sort, $server_sort_order,
- $PHP_SELF;
-
- $php_self = $PHP_SELF;
- /* fix for incorrect $PHP_SELF */
- if (strpos($php_self, 'move_messages.php')) {
- $php_self = str_replace('move_messages.php', 'right_main.php', $php_self);
+ $aExtraHighLightColumns = array();
+ foreach ($aExtraColumns as $v) {
+ switch ($v) {
+ case SQM_COL_FROM: $aExtraHighLightColumns[] = 'from'; break;
+ case SQM_COL_SUBJ: $aExtraHighLightColumns[] = 'subject'; break;
+ case SQM_COL_TO: $aExtraHighLightColumns[] = 'to'; break;
+ case SQM_COL_CC: $aExtraHighLightColumns[] = 'cc'; break;
+ case SQM_COL_BCC: $aExtraHighLightColumns[] = 'bcc'; break;
+ default: break;
+ }
}
- $urlMailbox = urlencode($mailbox);
-
- if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
- $source_url = $regs[1];
+ $aFormattedMessages = array();
+
+
+ $iSetIndx = $aMailbox['SETINDEX'];
+ $aId = $aMailbox['UIDSET'][$iSetIndx];
+ $aHeaders =& $aMailbox['MSG_HEADERS']; /* use a reference to avoid a copy.
+ MSG_HEADERS can contain large amounts of data */
+ $iOffset = $aMailbox['OFFSET'];
+ $sort = $aMailbox['SORT'];
+ $iPageOffset = $aMailbox['PAGEOFFSET'];
+ $sMailbox = $aMailbox['NAME'];
+ $sSearch = (isset($aMailbox['SEARCH'][$aMailbox['SETINDEX']]) &&
+ $aMailbox['SEARCH'][$aMailbox['SETINDEX']] != 'ALL') ? $aMailbox['SEARCH'][$aMailbox['SETINDEX']] : false;
+ $aSearch = ($sSearch) ? array('search.php',$aMailbox['SETINDEX']) : null;
+ /* avoid improper usage */
+ if ($sMailbox && isset($iAccount) && $sTargetModule) {
+ $aInitQuery = array("account=$iAccount",'mailbox='.urlencode($sMailbox));
} else {
- $source_url = $php_self;
- }
-
- if (!isset($msg)) {
- $msg = '';
+ $aInitQuery = false;
}
- if (!strpos($php_self,'?')) {
- $location = $php_self.'?mailbox=INBOX&startMessage=1';
+ if ($aMailbox['SORT'] & SQSORT_THREAD) {
+ $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']];
+ $bThread = true;
} else {
- $location = $php_self;
+ $bThread = false;
}
-
- $moveFields = '' .
- '' .
- ''.
- '';
-
/*
- * This is the beginning of the message list table.
- * It wraps around all messages
- */
- $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $mailbox);
- $form_name = "FormMsgs" . $safe_name;
- echo '