/**
* mailbox_display.php
*
- * Copyright (c) 1999-2002 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-2011 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ */
+
+
+/**
+ * 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
*/
+function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aProps) {
+
+ /**
+ * 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;
-require_once('../functions/strings.php');
-require_once('../functions/imap_utf7_decode_local.php');
-require_once('../functions/html.php');
-
-/* Default value for page_selector_max. */
-define('PG_SEL_MAX', 10);
-
-function printMessageInfo($imapConnection, $t, $i, $key, $mailbox, $sort,
-$start_msg, $where, $what){
- global $checkall,
- $color, $msgs, $msort,
- $sent_folder, $draft_folder,
- $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 */
- $color_string = $color[4];
-
- if ($GLOBALS['alt_index_colors']) {
- if (!isset($row_count)) {
- $row_count = 0;
+ $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);
+
+ 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];
}
+
+ } else {
+ $aCachedMailbox = false;
}
- $msg = $msgs[$key];
- /*
- * This is done in case you're looking into Sent folders,
- * because you can have multiple receivers.
- */
- $senderNames = explode(',', $msg['FROM']);
- $senderName = '';
- if (sizeof($senderNames)){
- foreach ($senderNames as $senderNames_part) {
- if ($senderName != '') {
- $senderName .= ', ';
+ /**
+ * 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'];
+ }
+
+ $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'];
+ }
+ $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];
+ }
}
- $senderName .= sqimap_find_displayable_name($senderNames_part);
}
}
-
- if( $mailbox == 'None' ) {
- $boxes = sqimap_mailbox_list($imapConnection);
- $mailbox = $boxes[0]['unformatted'];
- unset( $boxes );
+ /**
+ * 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 {
+ $aMailbox['OFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] -1 : 0;
+ $aMailbox['PAGEOFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] : 1;
+ }
+ /**
+ * Restore the number of messages in the result set
+ */
+ if (isset($aCachedMailbox['TOTAL'][$iSetIndx]) && $aCachedMailbox['TOTAL'][$iSetIndx]) {
+ $aMailbox['TOTAL'][$iSetIndx] = $aCachedMailbox['TOTAL'][$iSetIndx];
}
- $urlMailbox = urlencode($mailbox);
- $subject = processSubject($msg['SUBJECT']);
- echo "<TR>\n";
- if (isset($msg['FLAG_FLAGGED']) && ($msg['FLAG_FLAGGED'] == true)) {
- $flag = "<font color=\"$color[2]\">";
- $flag_end = '</font>';
+ /**
+ * 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 {
- $flag = '';
- $flag_end = '';
+ $aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ? 1 : 0;
}
- if (!isset($msg['FLAG_SEEN']) || ($msg['FLAG_SEEN'] == false)) {
- $bold = '<b>';
- $bold_end = '</b>';
+
+ /**
+ * 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 {
- $bold = '';
- $bold_end = '';
+ $aMailbox['SORT'] = (isset($aProps[MBX_PREF_SORT])) ? $aProps[MBX_PREF_SORT] : 0;
}
- if (handleAsSent($mailbox)) {
- $italic = '<i>';
- $italic_end = '</i>';
+
+ /**
+ * 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 {
- $italic = '';
- $italic_end = '';
+ $aMailbox['LIMIT'] = (isset($aProps[MBX_PREF_LIMIT])) ? $aProps[MBX_PREF_LIMIT] : 15;
}
- if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED']) {
- $fontstr = "<font color=\"$color[9]\">";
- $fontstr_end = '</font>';
+
+ /**
+ * 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 {
- $fontstr = '';
- $fontstr_end = '';
+ $aMailbox['COLUMNS'] = (isset($aProps[MBX_PREF_COLUMNS])) ? $aProps[MBX_PREF_COLUMNS] :
+ array(SQM_COL_FLAGS,SQM_COL_FROM, SQM_COL_SUBJ, SQM_COL_FLAGS);
}
/**
- * AAAAH! Make my eyes stop bleeding!
- * Who wrote this?!
- */
- if (sizeof($message_highlight_list)){
- foreach ($message_highlight_list as $message_highlight_list_part) {
- if (trim($message_highlight_list_part['value']) != '') {
- if ($message_highlight_list_part['match_type'] == 'to_cc') {
- if (strstr('^^' . strtolower($msg['TO']),
- strtolower($message_highlight_list_part['value']))
- || strstr('^^'.strtolower($msg['CC']),
- strtolower($message_highlight_list_part['value']))) {
- $hlt_color = $message_highlight_list_part['color'];
- continue;
- }
- } else
- if (strstr('^^' . strtolower($msg[strtoupper($message_highlight_list_part['match_type'])]),
- strtolower($message_highlight_list_part['value']))) {
- $hlt_color = $message_highlight_list_part['color'];
- continue;
- }
- }
- }
- }
+ * Restore the headers we fetch the last time. Saves intitialisation stuff in read_body.
+ */
+ $aMailbox['FETCHHEADERS'] = (isset($aCachedMailbox['FETCHHEADERS'])) ? $aCachedMailbox['FETCHHEADERS'] : null;
- if (!isset($hlt_color)) {
- $hlt_color = $color_string;
+ 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 (!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 {
+ $aMailbox['SEARCH'][$iSetIndx] = (isset($aConfig['search'])) ? $aConfig['search'] : 'ALL';
+ }
+ if (!isset($aConfig['charset']) && isset($aCachedMailbox['CHARSET'][$iSetIndx])) {
+ $aMailbox['CHARSET'][$iSetIndx] = $aCachedMailbox['CHARSET'][$iSetIndx];
+ } else {
+ $aMailbox['CHARSET'][$iSetIndx] = (isset($aConfig['charset'])) ? $aConfig['charset'] : 'US-ASCII';
}
- if ($where && $what) {
- if(!isset($pos) || $pos == '') {
- $pos = '0';
+ $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 {
+ $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT'];
}
- $search_stuff = "&pos=" . urlencode($pos)
- . "&where=" . urlencode($where) . '&what=' . urlencode($what);
} else {
- $search_stuff = '';
+ $aMailbox['THREAD_INDENT'] = false;
}
- $checked = ($checkall == 1) ? ' checked' : '';
+ /* set a timestamp for cachecontrol */
+ $aMailbox['TIMESTAMP'] = time();
+ return $aMailbox;
+}
- if (sizeof($index_order)){
- foreach ($index_order as $index_order_part) {
- switch ($index_order_part) {
- case 1: /* checkbox */
- echo html_tag( 'td',
- "<input type=checkbox name=\"msg[$t]\" value=\"".$msg['ID']."\"$checked>",
- 'center',
- $hlt_color );
- break;
- case 2: /* from */
- echo html_tag( 'td',
- $italic . $bold . $flag . $fontstr . $senderName .
- $fontstr_end . $flag_end . $bold_end . $italic_end,
- '',
- $hlt_color );
- break;
- case 3: /* date */
- echo html_tag( 'td',
- $bold . $flag . $fontstr . $msg['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 .= "<a href=\"read_body.php?mailbox=$urlMailbox&passed_id="
- . $msg["ID"]
- . "&startMessage=$start_msg&show_more=0$search_stuff\"";
- do_hook("subject_link");
- if ($subject != $msg['SUBJECT']) {
- $title = get_html_translation_table(HTML_SPECIALCHARS);
- $title = array_flip($title);
- $title = strtr($msg['SUBJECT'], $title);
- $title = str_replace('"', "''", $title);
- $td_str .= " title=\"$title\"";
- }
- $td_str .= ">$flag$subject$flag_end</a>$bold_end";
- echo html_tag( 'td', $td_str, '', $hlt_color );
- break;
- case 5: /* flags */
- $stuff = false;
- $td_str = "<b><small>";
-
- 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 .= "<font color=\"$color[1]\">!</font>";
- $stuff = true;
- }
- if ($msg['PRIORITY'] == 5) {
- $td_str .= "<font color=\"$color[8]\">?</font>";
- $stuff = true;
- }
- }
- if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED'] == true) {
- $td_str .= "<font color=\"$color[1]\">D</font>";
- $stuff = true;
- }
- if (!$stuff) {
- $td_str .= ' ';
- }
- $td_str .= '</small></b>';
- echo html_tag( 'td',
- $td_str,
- 'center',
- $hlt_color,
- 'nowrap' );
- break;
- case 6: /* size */
+/**
+ * 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 fetchMessageHeaders($imapConnection, &$aMailbox) {
- echo html_tag( 'td',
- $bold . $fontstr . show_readable_size($msg['SIZE']) .
- $fontstr_end . $bold_end,
- 'right',
- $hlt_color );
- break;
- }
- }
- }
- echo "</tr>\n";
-}
+ /* 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 */
-/*
-* This function loops through a group of messages in the mailbox
-* and shows them to the user.
-*/
-function showMessagesForMailbox($imapConnection, $mailbox, $num_msgs,
-$start_msg, $sort, $color, $show_num,
-$use_cache) {
- global $msgs, $msort,
- $sent_folder, $draft_folder,
- $message_highlight_list,
- $auto_expunge, $thread_sort_messages, $allow_server_sort,
- $data_dir, $username, $server_sort_order;
-
- /* 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
- */
-
- if($start_msg > $num_msgs) {
- $start_msg -= $show_num;
+ /**
+ * 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;
+
+ $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;
}
}
- /* 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
- */
- if ($thread_sort_messages == 1) {
- $id = get_thread_sort($imapConnection);
- if ($id == 'no') {
- echo '<b><small><center><font color=red>' .
- _("Thread sorting is not supported by your IMAP server.<br>Please report this to the system administrator.").
- '</center></small></b>';
- $thread_sort_messages = 0;
- $id = array();
- }
- else {
- $sort = 6;
- if ($start_msg + ($show_num - 1) < $num_msgs) {
- $end_msg = $start_msg + ($show_num-1);
- }
- else {
- $end_msg = $num_msgs;
- }
- $id = array_slice($id, ($start_msg-1), ($end_msg));
- }
+ if (is_array($aMailbox['UIDSET'])) {
+ $aUid =& $aMailbox['UIDSET'][$iSetIndx];
+ } else {
+ $aUid = false;
}
-
- if ($allow_server_sort == TRUE && $thread_sort_messages != 1) {
- $server_sort_order = $sort;
- $id = sqimap_get_sort_order($imapConnection, $server_sort_order);
- if ($id == 'no') {
- echo '<b><small><center><font color=red>' .
- _( "Server-side sorting is not supported by your IMAP server.<br>Please report this to the system administrator.").
- '</center></small></b>';
- $sort = $server_sort_order;
- $allow_server_sort = FALSE;
- $id = array();
- }
- else {
- $sort = 6;
- if ($start_msg + ($show_num - 1) < $num_msgs) {
- $end_msg = $start_msg + ($show_num-1);
- }
- else {
- $end_msg = $num_msgs;
- }
- $id = array_slice($id, ($start_msg-1), ($end_msg));
- }
+ $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 autoexpunge is turned on, then do it now. */
- if ($auto_expunge == true) {
- sqimap_mailbox_expunge($imapConnection, $mailbox, false);
- }
- sqimap_mailbox_select($imapConnection, $mailbox);
- $issent = handleAsSent($mailbox);
- if (!$use_cache) {
- /* If it is sorted... */
- if ($num_msgs >= 1) {
- if ($sort < 6 ) {
- $id = range(1, $num_msgs);
- }
- elseif ($thread_sort_messages != 1 && $allow_server_sort != TRUE && $sort == 6) {
- /* 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;
+ /**
+ * 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;
}
- }
-
- $real_startMessage = $num_msgs - $start_msg + 1;
- $real_endMessage = $num_msgs - $start_msg - $show_num + 2;
- if ($real_endMessage <= 0) {
- $real_endMessage = 1;
- }
- $id = array_reverse(range($real_endMessage, $real_startMessage));
- }
- $msgs_list = sqimap_get_small_header_list($imapConnection, $id, $issent);
- // $flags = sqimap_get_flags_list($imapConnection, $id, $issent);
- if (sizeof($msgs_list)){
- foreach ($msgs_list as $hdr) {
- $from[] = $hdr->from;
- $date[] = $hdr->date;
- $subject[] = $hdr->subject;
- $to[] = $hdr->to;
- $priority[] = $hdr->priority;
- $cc[] = $hdr->cc;
- $size[] = $hdr->size;
- $type[] = $hdr->type0;
- $flag_deleted[] = $hdr->flag_deleted;
- $flag_answered[] = $hdr->flag_answered;
- $flag_seen[] = $hdr->flag_seen;
- $flag_flagged[] = $hdr->flag_flagged;
+ --$iReduce;
}
}
}
- $j = 0;
- if ($sort == 6) {
- $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;
+
+ $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 {
- $end = $num_msgs;
- $end_loop = $end;
+ $aMailbox['MSG_HEADERS'] = array();
+ $aUidCached = array();
}
- while ($j < $end_loop) {
- if (isset($date[$j])) {
- $date[$j] = str_replace(' ', ' ', $date[$j]);
- $tmpdate = explode(' ', trim($date[$j]));
- } else {
- $tmpdate = $date = array('', '', '', '', '', '');
- }
+ $aUidNotCached = array_values(array_diff($id_slice,$aUidCached));
+
+ /**
+ * $aUidNotCached contains an array with UID's which need to be fetched to
+ * complete the needed message headers.
+ */
+ 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
+ */
- $messages[$j]['TIME_STAMP'] = getTimeStamp($tmpdate);
- $messages[$j]['DATE_STRING'] =
- getDateString($messages[$j]['TIME_STAMP']);
- $messages[$j]['ID'] = $id[$j];
- $messages[$j]['FROM'] = decodeHeader($from[$j]);
- $messages[$j]['FROM-SORT'] =
- strtolower(sqimap_find_displayable_name(decodeHeader($from[$j])));
- $messages[$j]['SUBJECT'] = decodeHeader($subject[$j]);
- $messages[$j]['SUBJECT-SORT'] = strtolower(decodeHeader($subject[$j]));
- $messages[$j]['TO'] = decodeHeader($to[$j]);
- $messages[$j]['PRIORITY'] = $priority[$j];
- $messages[$j]['CC'] = $cc[$j];
- $messages[$j]['SIZE'] = $size[$j];
- $messages[$j]['TYPE0'] = $type[$j];
- $messages[$j]['FLAG_DELETED'] = $flag_deleted[$j];
- $messages[$j]['FLAG_ANSWERED'] = $flag_answered[$j];
- $messages[$j]['FLAG_SEEN'] = $flag_seen[$j];
- $messages[$j]['FLAG_FLAGGED'] = $flag_flagged[$j];
-
-
- /*
- * fix SUBJECT-SORT to remove Re:
- * vedr|sv (Danish)
- * re|aw (English)
- *
- * TODO: i18n should be incorporated here. E.g. we catch the ones
- * we know about, but also define in i18n what the localized
- * "Re: " is for this or that locale.
- */
- if (preg_match("/^(vedr|sv|re|aw):\s*(.*)$/si",
- $messages[$j]['SUBJECT-SORT'], $matches)){
- $messages[$j]['SUBJECT-SORT'] = $matches[2];
- }
- /*
- $num = 0;
- while ($num < count($flags[$j])) {
- if ($flags[$j][$num] == 'Deleted') {
- $messages[$j]['FLAG_DELETED'] = true;
- } else if ($flags[$j][$num] == 'Answered') {
- $messages[$j]['FLAG_ANSWERED'] = true;
- } else if ($flags[$j][$num] == 'Seen') {
- $messages[$j]['FLAG_SEEN'] = true;
- } else if ($flags[$j][$num] == 'Flagged') {
- $messages[$j]['FLAG_FLAGGED'] = true;
- }
- $num++;
- }
- */
- $j++;
+ 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 {
- /*
- * Only ignore messages flagged as deleted if we are
- * using a trash folder or auto_expunge
- */
- if (((isset($move_to_trash) && $move_to_trash)
- || (isset($auto_expunge) && $auto_expunge))
- && $sort != 6) {
-
- /* Find and remove the ones that are deleted */
- $i = 0;
- $j = 0;
-
- while ($j < $num_msgs) {
- if (isset($messages[$j]['FLAG_DELETED'])
- && $messages[$j]['FLAG_DELETED'] == true) {
- $j++;
- continue;
+ $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 {
+ $iError = 1; // FIX ME, define an error code
}
- $msgs[$i] = $messages[$j];
-
- $i++;
- $j++;
}
- $num_msgs = $i;
- } else {
- if (!isset($messages)) {
- $messages = 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 {
+ $iError = 1; // FIX ME, define an error code
+ }
}
- $msgs = $messages;
}
}
+ return $iError;
+}
- /* There's gotta be messages in the array for it to sort them. */
- if (($num_msgs > 0) && (!$use_cache)) {
- /*
- * 0 = Date (up)
- * 1 = Date (dn)
- * 2 = Name (up)
- * 3 = Name (dn)
- * 4 = Subject (up)
- * 5 = Subject (dn)
- */
- session_unregister('msgs');
- if (($sort == 0) || ($sort == 1)) {
- $msort = array_cleave ($msgs, 'TIME_STAMP');
- } elseif (($sort == 2) || ($sort == 3)) {
- $msort = array_cleave ($msgs, 'FROM-SORT');
- } elseif (($sort == 4) || ($sort == 5)) {
- $msort = array_cleave ($msgs, 'SUBJECT-SORT');
- } else {
- $msort = $msgs;
- }
+/**
+ * Prepares the message headers for display inside a template. The links are calculated,
+ * color for row highlighting is calculated and optionally the strings are truncated.
+ *
+ * @param array $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
+ * @param array $aProps properties
+ * @return array $aFormattedMessages array with message headers and format info
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
+ */
+function prepareMessageList(&$aMailbox, $aProps) {
- if ($sort < 6) {
- if ($sort % 2) {
- asort($msort);
- } else {
- arsort($msort);
- }
- }
- session_register('msort');
- } elseif ($thread_sort_messages == 1 || $allow_server_sort == TRUE) {
- $msort = $msgs;
- session_unregister('msgs');
- session_register('msort');
- }
- displayMessageArray($imapConnection, $num_msgs, $start_msg, $msgs,
- $msort, $mailbox, $sort, $color,$show_num);
- /**
- * TODO: Switch to using $_SESSION[] whenever we ditch the 4.0.x series.
- */
- session_register('msgs');
-}
+ /* Globalize link attributes so plugins can share in modifying them */
+ global $link, $title, $target, $onclick, $link_extra, $preselected;
-/* Generic function to convert the msgs array into an HTML table. */
-function displayMessageArray($imapConnection, $num_msgs, $start_msg,
-&$msgs, $msort, $mailbox, $sort, $color,
-$show_num) {
+ /* 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';
- global $folder_prefix, $sent_folder,
- $imapServerAddress, $data_dir, $username, $use_mailbox_cache,
- $index_order, $real_endMessage, $real_startMessage, $checkall,
- $indent_array, $thread_sort_messages, $allow_server_sort,
- $server_sort_order;
+ /*
+ * 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
+ */
- /* If cache isn't already set, do it now. */
- if (!session_is_registered('msgs')) {
- session_register('msgs');
+ /**
+ * 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;
+ }
}
- if (!session_is_registered('msort')) {
- session_register('msort');
+ $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;
+ }
}
-
- if ($start_msg + ($show_num - 1) < $num_msgs){
- $end_msg = $start_msg + ($show_num - 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 {
- $end_msg = $num_msgs;
+ $aInitQuery = false;
}
- if ($end_msg < $start_msg) {
- $start_msg = $start_msg - $show_num;
- if ($start_msg < 1) {
- $start_msg = 1;
- }
+ if ($aMailbox['SORT'] & SQSORT_THREAD) {
+ $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']];
+ $bThread = true;
+ } else {
+ $bThread = false;
+ }
+ /*
+ * Retrieve value for checkbox column
+ */
+ if (!sqgetGlobalVar('checkall',$checkall,SQ_GET)) {
+ $checkall = false;
}
- $urlMailbox = urlencode($mailbox);
-
- do_hook('mailbox_index_before');
+ /*
+ * Loop through and display the info for each message.
+ */
+ $iEnd = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $iOffset + $aMailbox['LIMIT'];
+ for ($i=$iOffset,$t=0;$i<$iEnd;++$i) {
+ if (isset($aId[$i])) {
+
+ $bHighLight = false;
+ $value = $title = $link = $target = $onclick = $link_extra = '';
+ $aQuery = ($aInitQuery !== false) ? $aInitQuery : false;
+ $aMsg = $aHeaders[$aId[$i]];
+ if (isset($aSearch) && count($aSearch) > 1 && $aQuery) {
+ $aQuery[] = "where=". $aSearch[0];
+ $aQuery[] = "what=" . $aSearch[1];
+ }
+ $iUid = (isset($aMsg['UID'])) ? $aMsg['UID'] : $aId[$i];
+ if ($aQuery) {
+ $aQuery[] = "passed_id=$aId[$i]";
+ $aQuery[] = "startMessage=$iPageOffset";
+ }
- $msg_cnt_str = get_msgcnt_str($start_msg, $end_msg, $num_msgs);
- $paginator_str = get_paginator_str($urlMailbox, $start_msg, $end_msg,
- $num_msgs, $show_num, $sort);
+ foreach ($aCol as $k => $v) {
+ $title = $link = $target = $onclick = $link_extra = '';
+ $aColumns[$k] = array();
+ $value = (isset($aMsg[$v])) ? $aMsg[$v] : '';
+ $sUnknown = _("Unknown recipient");
+ switch ($k) {
+ case SQM_COL_FROM:
+ $sUnknown = _("Unknown sender");
+ case SQM_COL_TO:
+ case SQM_COL_CC:
+ case SQM_COL_BCC:
+ $sTmp = false;
+ if ($value) {
+ if ($highlight_list && !$bHighLight) {
+ $bHighLight = highlightMessage($aCol[$k], $value, $highlight_list,$aFormattedMessages[$iUid]);
+ }
+ $aAddressList = parseRFC822Address($value);
+ $sTmp = getAddressString($aAddressList,array('best' => true));
+ $title = $title_maybe = '';
+ foreach ($aAddressList as $aAddr) {
+ $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL])) ? $aAddr[SQM_ADDR_PERSONAL] : '';
+ $sMailbox = (isset($aAddr[SQM_ADDR_MAILBOX])) ? $aAddr[SQM_ADDR_MAILBOX] : '';
+ $sHost = (isset($aAddr[SQM_ADDR_HOST])) ? $aAddr[SQM_ADDR_HOST] : '';
+ if ($sPersonal) {
+ $title .= htmlspecialchars($sMailbox.'@'.$sHost).', ';
+ } else {
+ // if $value gets truncated we need to add the addresses with no
+ // personal name as well
+ $title_maybe .= htmlspecialchars($sMailbox.'@'.$sHost).', ';
+ }
+ }
+ if ($title) {
+ $title = substr($title,0,-2); // strip ', ';
+ }
+ $sTmp = decodeHeader($sTmp);
+ if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
+ $sTrunc = sm_truncate_string($sTmp, $aColumnDesc[$k]['truncate'], '...', TRUE);
+ if ($sTrunc != $sTmp) {
+ if (!$title) {
+ $title = $sTmp;
+ } else if ($title_maybe) {
+ $title = $title .', '.$title_maybe;
+ $title = substr($title,0,-2); // strip ', ';
+ }
+ }
+ $sTmp = $sTrunc;
+ }
+ }
+ $value = ($sTmp) ? (substr($sTmp, 0, 6) == '"' && substr($sTmp, -6) == '"' ? substr(substr($sTmp, 0, -6), 6) : $sTmp) : $sUnknown;
+ break;
+ case SQM_COL_SUBJ:
+ // subject is mime encoded, decode it.
+ // value is sanitized in decoding function.
+ // TODO, verify if it should be done before or after the highlighting
+ $value=decodeHeader($value);
+ if ($highlight_list && !$bHighLight) {
+ $bHighLight = highlightMessage('SUBJECT', $value, $highlight_list, $aFormattedMessages[$iUid]);
+ }
+ $iIndent = (isset($aIndentArray[$aId[$i]])) ? $aIndentArray[$aId[$i]] : 0;
+ // FIXME: don't break 8bit symbols and html entities during truncation
+ if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
+ $sTmp = sm_truncate_string($value, $aColumnDesc[$k]['truncate']-$iIndent, '...', TRUE);
+ // drop any double spaces since these will be displayed in the title
+ $title = ($sTmp != $value) ? preg_replace('/\s{2,}/', ' ', $value) : '';
+ $value = $sTmp;
+ }
+ /* generate the link to the message */
+ if ($aQuery) {
+ // TODO, $sTargetModule should be a query parameter so that we can use a single entrypoint
+ $link = $sTargetModule.'.php?' . implode('&',$aQuery);
+
+ // see top of this function for which attributes are available
+ // in the global scope for plugin use (like $link, $target,
+ // $onclick, $link_extra, $title, and so forth)
+ // plugins are responsible for sharing nicely (such as for
+ // setting the target, etc)
+ $temp = array(&$iPageOffset, &$sSearch, &$aSearch, $aMsg);
+ do_hook('subject_link', $temp);
+ }
+ $value = (trim($value)) ? $value : _("(no subject)");
+ /* add thread indentation */
+ $aColumns[$k]['indent'] = $iIndent;
+ break;
+ case SQM_COL_SIZE:
+ $value = show_readable_size($value);
+ break;
+ case SQM_COL_DATE:
+ case SQM_COL_INT_DATE:
+ $value = getDateString(getTimeStamp(explode(' ',trim($value))));
+ break;
+ case SQM_COL_FLAGS:
+ $aFlagColumn = array('seen' => false,
+ 'deleted'=>false,
+ 'answered'=>false,
+ 'forwarded'=>false,
+ 'flagged' => false,
+ 'draft' => false);
+
+ if(!is_array($value)) $value = array();
+ foreach ($value as $sFlag => $v) {
+ switch ($sFlag) {
+ case '\\seen' : $aFlagColumn['seen'] = true; break;
+ case '\\deleted' : $aFlagColumn['deleted'] = true; break;
+ case '\\answered': $aFlagColumn['answered'] = true; break;
+ case '$forwarded': $aFlagColumn['forwarded'] = true; break;
+ case '\\flagged' : $aFlagColumn['flagged'] = true; break;
+ case '\\draft' : $aFlagColumn['draft'] = true; break;
+ default: break;
+ }
+ }
+ $value = $aFlagColumn;
+ break;
+ case SQM_COL_PRIO:
+ $value = ($value) ? (int) $value : 3;
+ break;
+ case SQM_COL_ATTACHMENT:
+ $value = (is_array($value) && $value[0] == 'multipart' && $value[1] == 'mixed') ? true : false;
+ break;
+ case SQM_COL_CHECK:
+ $value = ($checkall || in_array($iUid, $preselected));
+ break;
+ default : break;
+ }
+ if ($title) { $aColumns[$k]['title'] = $title; }
+ if ($link) { $aColumns[$k]['link'] = $link; }
+ if ($link_extra) { $aColumns[$k]['link_extra'] = $link_extra; }
+ if ($onclick) { $aColumns[$k]['onclick'] = $onclick; }
+ if ($target) { $aColumns[$k]['target'] = $target; }
+ $aColumns[$k]['value'] = $value;
+ }
+ /* columns which will not be displayed but should be inspected
+ because the highlight list contains rules with those columns */
+ foreach ($aExtraHighLightColumns as $v) {
+ if ($highlight_list && !$bHighLight && isset($aMsg[$v])) {
+ $bHighLight = highlightMessage($v, $aMsg[$v], $highlight_list,$aFormattedMessages[$iUid]);
+ }
+ }
+ $aFormattedMessages[$iUid]['columns'] = $aColumns;
- if (!isset($msg)) {
- $msg = '';
+ } else {
+ break;
+ }
}
+ return $aFormattedMessages;
+}
- /* get indent level for subject display */
- if ($thread_sort_messages == 1 ) {
- $indent_array = get_parent_level($imapConnection);
+
+/**
+ * Sets the row color if the provided column value pair matches a hightlight rule
+ *
+ * @param string $sCol column name
+ * @param string $sVal column value
+ * @param array $highlight_list highlight rules
+ * @param array $aFormat (reference) array where row color info is stored
+ * @return bool match found
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
+ */
+function highlightMessage($sCol, $sVal, $highlight_list, &$aFormat) {
+ if (!is_array($highlight_list) && count($highlight_list) == 0) {
+ return false;
}
- $fstring = "move_messages.php?msg=$msg&mailbox=$urlMailbox"
- . "&startMessage=$start_msg";
- mail_message_listing_beginning($imapConnection, $fstring,
- $mailbox, $sort, $msg_cnt_str,
- $paginator_str, $start_msg);
-
- $groupNum = $start_msg % ($show_num - 1);
- $real_startMessage = $start_msg;
- if ($sort == 6) {
- if ($end_msg - $start_msg < $show_num - 1) {
- $end_msg = $end_msg - $start_msg + 1;
- $start_msg = 1;
- } else if ($start_msg > $show_num) {
- $end_msg = $show_num;
- $start_msg = 1;
+ $hlt_color = false;
+ $sCol = strtoupper($sCol);
+
+ foreach ($highlight_list as $highlight_list_part) {
+ if (trim($highlight_list_part['value'])) {
+ $high_val = strtolower($highlight_list_part['value']);
+ $match_type = strtoupper($highlight_list_part['match_type']);
+ if($match_type == 'TO_CC') {
+ if ($sCol == 'TO' || $sCol == 'CC') {
+ $match_type = $sCol;
+ } else {
+ continue;
+ }
+ } else {
+ if ($match_type != $sCol) {
+ continue;
+ }
+ }
+ if (strpos(strtolower($sVal),$high_val) !== false) {
+ $hlt_color = $highlight_list_part['color'];
+ break;
+ }
}
}
- $endVar = $end_msg + 1;
-
- /*
- * Loop through and display the info for each message.
- * ($t is used for the checkbox number)
- */
- $t = 0;
- if ($num_msgs == 0) {
- /* if there's no messages in this folder */
- echo html_tag( 'tr',
- html_tag( 'td',
- "<BR><B>" . _("THIS FOLDER IS EMPTY") . "</B><BR> ",
- '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;
+ if ($hlt_color) {
+ // Bug in highlight color???
+ if ($hlt_color{0} != '#') {
+ $hlt_color = '#'. $hlt_color;
}
- reset($msort);
- $k = 0;
- do {
- $key = key($msort);
- next($msort);
- $k++;
- } while (isset ($key) && ($k < $i));
- printMessageInfo($imapConnection, $t, $i, $key, $mailbox, $sort,
- $real_startMessage, 0, 0);
+ $aFormat['row']['color'] = $hlt_color;
+ return true;
} else {
- $i = $start_msg;
- reset($msort);
- $k = 0;
- do {
- $key = key($msort);
- next($msort);
- $k++;
- } while (isset ($key) && ($k < $i));
- do {
- printMessageInfo($imapConnection, $t, $i, $key, $mailbox,
- $sort, $real_startMessage, 0, 0);
- $key = key($msort);
- $t++;
- $i++;
- next($msort);
- } while ($i && $i < $endVar);
+ return false;
}
-
- echo '</table>';
-
- echo html_tag( 'table',
- html_tag( 'tr',
- html_tag( 'td',
- html_tag( 'table',
- html_tag( 'tr',
- html_tag( 'td', $paginator_str ) .
- html_tag( 'td', $msg_cnt_str, 'right' )
- )
- , '', $color[4], 'width="100%" cellpadding="1" cellspacing="1"' )
- )
- , '', $color[4] )
- , '', $color[9], 'width="100%" cellpadding="1" cellspacing="1"' );
-
- /* End of message-list table */
-
- do_hook('mailbox_index_after');
- echo "</TABLE></FORM>\n";
}
-/*
-* Displays the standard message list header. To finish the table,
-* you need to do a "</table></table>";
-*
-* $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, $moveURL,
-$mailbox = '', $sort = -1,
-$msg_cnt_str = '',
-$paginator = ' ',
-$start_msg = 1) {
- global $color, $index_order, $auto_expunge, $move_to_trash, $base_uri,
- $checkall, $sent_folder, $draft_folder, $thread_sort_messages,
- $allow_thread_sort, $allow_server_sort, $server_sort_order,
- $lastTargetMailbox;
-
- $urlMailbox = urlencode($mailbox);
+function setUserPref($username, $pref, $value) {
+ global $data_dir;
+ setPref($data_dir,$username,$pref,$value);
+}
- /*
- * This is the beginning of the message list table.
- * It wraps around all messages
- */
- echo "<FORM name=\"messageList\" method=post action=\"$moveURL\">\n"
- . "<TABLE WIDTH=\"100%\" BORDER=\"0\" CELLPADDING=\"1\" "
- . "CELLSPACING=\"0\">\n<TR BGCOLOR=\"$color[0]\"><TD>"
- . " <TABLE BGCOLOR=\"$color[4]\" width=\"100%\" CELLPADDING=\"2\" "
- . "CELLSPACING=\"0\" BORDER=\"0\"><TR>\n"
- . html_tag( 'td', $paginator, 'left' )
- . html_tag( 'td', $msg_cnt_str, 'right' )
- . " </TR></TABLE>\n"
- . '</TD></TR>'
- . "<TR><TD BGCOLOR=\"$color[0]\">\n"
- . "<TABLE BGCOLOR=\"$color[0]\" BORDER=0 cellpadding=0 "
- . "cellspacing=0 width=\"100%\">\n"
- . " <TR>\n"
- . html_tag( 'td',
- '<SMALL> ' . _("Move Selected To:") . '</SMALL>',
- 'left',
- '',
- 'valign="middle" nowrap' )
- . html_tag( 'td',
- '<SMALL>' . _("Transform Selected Messages") . ': </SMALL><BR>',
- 'right',
- '',
- 'nowrap' )
- . " </TR>\n"
- . " <TR>\n"
- . html_tag( 'td', '', 'left', '', 'valign="middle" nowrap' )
- . ' <SMALL> <TT><SELECT NAME="targetMailbox">';
-
- $boxes = sqimap_mailbox_list($imapConnection);
- foreach ($boxes as $boxes_part) {
- if (!in_array('noselect', $boxes_part['flags'])) {
- $box = $boxes_part['unformatted'];
- $box2 = str_replace(' ', ' ', imap_utf7_decode_local($boxes_part['unformatted-disp']));
- if( $box2 == 'INBOX' ) {
- $box2 = _("INBOX");
- }
- if ($lastTargetMailbox == $box) {
- echo " <OPTION VALUE=\"$box\" SELECTED>$box2</OPTION>\n";
- }
- else {
- echo " <OPTION VALUE=\"$box\">$box2</OPTION>\n";
- }
- }
- }
- echo ' </SELECT></TT> '
- . '<INPUT TYPE="SUBMIT" NAME="moveButton" VALUE="' . _("Move") . '"> '
- . '<INPUT TYPE="SUBMIT" NAME="attache" VALUE="' . _("Forward")
- . "\"> \n" . "</SMALL>\n";
-
- echo " </TD>\n"
- . " <TD ALIGN=\"RIGHT\" NOWRAP>";
- if (!$auto_expunge) {
- echo '<INPUT TYPE=SUBMIT NAME="expungeButton" VALUE="' . _("Expunge")
- . '"> ' . _("mailbox") . ' ';
+/**
+ * Execute the sorting for a mailbox
+ *
+ * @param resource $imapConnection Imap connection
+ * @param array $aMailbox (reference) Mailbox retrieved with sqm_api_mailbox_select
+ * @return int $error (reference) Error number
+ * @private
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
+ */
+function _get_sorted_msgs_list($imapConnection,&$aMailbox) {
+ $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
+ $bDirection = !($aMailbox['SORT'] % 2);
+ $error = 0;
+ if (!$aMailbox['SEARCH'][$iSetIndx]) {
+ $aMailbox['SEARCH'][$iSetIndx] = 'ALL';
}
- echo '<INPUT TYPE="SUBMIT" NAME="markRead" VALUE="' . _("Read") . '">'
- . '<INPUT TYPE="SUBMIT" NAME="markUnread" VALUE="' . _("Unread") . '">'
- . '<INPUT TYPE="SUBMIT" VALUE="' . _("Delete") . '"> '
- . "</TD>\n"
- . " </TR>\n";
-
- /* draws thread sorting links */
- if ($allow_thread_sort == TRUE) {
- if ($thread_sort_messages == 1 ) {
- $set_thread = 2;
- $thread_name = _("Unthread View");
+ if (($aMailbox['SORT'] & SQSORT_THREAD) && sqimap_capability($imapConnection,'THREAD')) {
+ $aRes = get_thread_sort($imapConnection,$aMailbox['SEARCH'][$iSetIndx]);
+ if ($aRes === false) {
+ $aMailbox['SORT'] -= SQSORT_THREAD;
+ $error = 1; // fix me, define an error code;
+ } else {
+ $aMailbox['UIDSET'][$iSetIndx] = $aRes[0];
+ $aMailbox['THREAD_INDENT'][$iSetIndx] = $aRes[1];
}
- elseif ($thread_sort_messages == 0) {
- $set_thread = 1;
- $thread_name = _("Thread View");
+ } else if ($aMailbox['SORT'] === SQSORT_NONE) {
+ $id = sqimap_run_search($imapConnection, 'ALL' , '');
+ if ($id === false) {
+ $error = 1; // fix me, define an error code
+ } else {
+ $aMailbox['UIDSET'][$iSetIndx] = array_reverse($id);
+ $aMailbox['TOTAL'][$iSetIndx] = $aMailbox['EXISTS'];
}
- echo '<tr><td> <a href=' . "$base_uri" . 'src/right_main.php?sort='
- . "$sort" . '&start_messages=1&set_thread=' . "$set_thread"
- . '&mailbox=' . urlencode($mailbox) . '><small>' . $thread_name
- . '</a></small> </td></tr>';
- }
-
- echo "</TABLE>\n";
- do_hook('mailbox_form_before');
- echo '</TD></TR>'
- . "<TR><TD BGCOLOR=\"$color[0]\">"
- . '<TABLE WIDTH="100%" BORDER=0 CELLPADDING=2 CELLSPACING=';
- if ($GLOBALS['alt_index_colors']){
- echo '0';
} else {
- echo '1';
- }
- echo " BGCOLOR=\"$color[0]\">"
- . "<TR BGCOLOR=\"$color[5]\" ALIGN=\"center\">";
- /* if using server sort we highjack the
- * the $sort var and use $server_sort_order
- * instead. but here we reset sort for a bit
- * since its easy
- */
- if ($allow_server_sort == TRUE) {
- $sort = $server_sort_order;
+ if (sqimap_capability($imapConnection,'SORT')) {
+ $sSortField = _getSortField($aMailbox['SORT'],true);
+ $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection, $aMailbox['SEARCH'][$iSetIndx]);
+ if ($id === false) {
+ $error = 1; // fix me, define an error code
+ } else {
+ $aMailbox['UIDSET'][$iSetIndx] = $id;
+ }
+ } else {
+ $id = NULL;
+ if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') {
+ $id = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
+ }
+ $sSortField = _getSortField($aMailbox['SORT'],false);
+ $aMailbox['UIDSET'][$iSetIndx] = get_squirrel_sort($imapConnection, $sSortField, $bDirection, $id);
+ }
}
- /* Print the headers. */
- for ($i=1; $i <= count($index_order); $i++) {
- switch ($index_order[$i]) {
- case 1: /* checkbox */
- case 5: /* flags */
- echo ' <TD WIDTH="1%"></TD>';
+ return $error;
+}
+
+/**
+ * Does the $srt $_GET var to field mapping
+ *
+ * @param int $srt Field to sort on
+ * @param bool $bServerSort Server sorting is true
+ * @return string $sSortField Field to sort on
+ * @since 1.5.1
+ * @private
+ */
+function _getSortField($sort,$bServerSort) {
+ switch($sort) {
+ case SQSORT_NONE:
+ $sSortField = 'UID';
break;
- case 2: /* from */
- if (handleAsSent($mailbox)) {
- echo ' <TD WIDTH="25%"><B>' . _("To") . '</B>';
- } else {
- echo ' <TD WIDTH="25%"><B>' . _("From") . '</B>';
- }
- if ($allow_thread_sort != TRUE || $thread_sort_messages != 1) {
- ShowSortButton($sort, $mailbox, 2, 3);
- }
- echo "</TD>\n";
+ case SQSORT_DATE_ASC:
+ case SQSORT_DATE_DESC:
+ $sSortField = 'DATE';
break;
- case 3: /* date */
- echo ' <TD NOWRAP WIDTH="5%"><B>' . _("Date") . '</B>';
- if ($allow_thread_sort != TRUE || $thread_sort_messages != 1) {
- ShowSortButton($sort, $mailbox, 0, 1);
- }
- echo "</TD>\n";
+ case SQSORT_FROM_ASC:
+ case SQSORT_FROM_DESC:
+ $sSortField = 'FROM';
break;
- case 4: /* subject */
- echo ' <TD><B>' . _("Subject") . '</B> ';
- if ($allow_thread_sort != TRUE || $thread_sort_messages != 1) {
- ShowSortButton($sort, $mailbox, 4, 5);
- }
- echo "</TD>\n";
+ case SQSORT_SUBJ_ASC:
+ case SQSORT_SUBJ_DESC:
+ $sSortField = 'SUBJECT';
break;
- case 6: /* size */
- echo html_tag( 'td', '<b>' . _("Size") . '</b>', 'center', '', 'width="5%"' );
+ case SQSORT_SIZE_ASC:
+ case SQSORT_SIZE_DESC:
+ $sSortField = ($bServerSort) ? 'SIZE' : 'RFC822.SIZE';
break;
- }
- }
- /* if using server-sorting,
- * send sort back to 6
- */
- if ($allow_server_sort == TRUE) {
- $sort = 6;
+ case SQSORT_TO_ASC:
+ case SQSORT_TO_DESC:
+ $sSortField = 'TO';
+ break;
+ case SQSORT_CC_ASC:
+ case SQSORT_CC_DESC:
+ $sSortField = 'CC';
+ break;
+ case SQSORT_INT_DATE_ASC:
+ case SQSORT_INT_DATE_DESC:
+ $sSortField = ($bServerSort) ? 'ARRIVAL' : 'INTERNALDATE';
+ break;
+ case SQSORT_THREAD:
+ break;
+ default: $sSortField = 'UID';
+ break;
+
}
- echo "</TR>\n";
+ return $sSortField;
}
-/*
-* This function shows the sort button. Isn't this a good comment?
-*/
-function ShowSortButton($sort, $mailbox, $Up, $Down) {
- /* Figure out which image we want to use. */
- if ($sort != $Up && $sort != $Down) {
- $img = 'sort_none.png';
- $which = $Up;
- } elseif ($sort == $Up) {
- $img = 'up_pointer.png';
- $which = $Down;
- } else {
- $img = 'down_pointer.png';
- $which = 6;
- }
+/**
+ * This function is a utility function for setting which headers should be
+ * fetched. It takes into account the highlight list which requires extra
+ * headers to be fetch in order to make those rules work. It's called before
+ * the headers are fetched which happens in showMessagesForMailbox and when
+ * the next and prev links in read_body.php are used.
+ *
+ * @param array $aMailbox associative array with mailbox related vars
+ * @param array $aProps
+ * @return void
+ * @since 1.5.1
+ */
- /* Now that we have everything figured out, show the actual button. */
- echo ' <a href="right_main.php?newsort=' . $which
- . '&startMessage=1&mailbox=' . urlencode($mailbox)
- . '"><IMG SRC="../images/' . $img
- . '" BORDER=0 WIDTH=12 HEIGHT=10 ALT="sort"></a>';
-}
+function calcFetchColumns(&$aMailbox, &$aProps) {
-function get_selectall_link($start_msg, $sort) {
- global $checkall, $what, $where, $mailbox, $javascript_on;
- global $PHP_SELF, $PG_SHOWNUM;
-
- $result = '';
- if ($javascript_on) {
- $result =
- '<script language="JavaScript" type="text/javascript">'
- . "\n<!-- \n"
- . "function CheckAll() {\n"
- . " for (var i = 0; i < document.messageList.elements.length; i++) {\n"
- . " if(document.messageList.elements[i].type == 'checkbox'){\n"
- . " document.messageList.elements[i].checked = "
- . " !(document.messageList.elements[i].checked);\n"
- . " }\n"
- . " }\n"
- . "}\n"
- . "//-->\n"
- . '</script><a href="#" onClick="CheckAll();">' . _("Toggle All")
- . "</a>\n";
- } else {
- if (strpos($PHP_SELF, "?")) {
- $result .= "<a href=\"$PHP_SELF&mailbox=" . urlencode($mailbox)
- . "&startMessage=$start_msg&sort=$sort&checkall=";
- } else {
- $result .= "<a href=\"$PHP_SELF?mailbox=" . urlencode($mailbox)
- . "&startMessage=$start_msg&sort=$sort&checkall=";
+ $highlight_list = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
+ $aColumnsDesc = (isset($aProps['columns'])) ? $aProps['columns'] : false;
+
+ $aFetchColumns = $aColumnsDesc;
+ if (isset($aFetchColumns[SQM_COL_CHECK])) {
+ unset($aFetchColumns[SQM_COL_CHECK]);
+ }
+
+ /*
+ * Before we fetch the message headers, check if we need to fetch extra columns
+ * to make the message highlighting work
+ */
+ if (is_array($highlight_list) && count($highlight_list)) {
+ $aHighlightColumns = array();
+ foreach ($highlight_list as $highlight_list_part) {
+ if (trim($highlight_list_part['value'])) {
+ $match_type = strtoupper($highlight_list_part['match_type']);
+ switch ($match_type) {
+ case 'TO_CC':
+ $aHighlightColumns[SQM_COL_TO] = true;
+ $aHighlightColumns[SQM_COL_CC] = true;
+ break;
+ case 'TO': $aHighlightColumns[SQM_COL_TO] = true; break;
+ case 'CC': $aHighlightColumns[SQM_COL_CC] = true; break;
+ case 'FROM': $aHighlightColumns[SQM_COL_FROM] = true; break;
+ case 'SUBJECT':$aHighlightColumns[SQM_COL_SUBJ] = true; break;
+ }
+ }
}
- if (isset($checkall) && $checkall == '1') {
- $result .= '0';
- } else {
- $result .= '1';
+ $aExtraColumns = array();
+ foreach ($aHighlightColumns as $k => $v) {
+ if (!isset($aFetchColumns[$k])) {
+ $aExtraColumns[] = $k;
+ $aFetchColumns[$k] = true;
+ }
}
-
- if (isset($where) && isset($what)) {
- $result .= '&where=' . urlencode($where)
- . '&what=' . urlencode($what);
+ if (count($aExtraColumns)) {
+ $aProps['extra_columns'] = $aExtraColumns;
}
+ }
+ $aMailbox['FETCHHEADERS'] = array_keys($aFetchColumns);
+}
- $result .= "\">";
- if (isset($checkall) && ($checkall == '1')) {
- $result .= _("Unselect All");
- } else {
- $result .= _("Select All");
- }
+/**
+ * This function loops through a group of messages in the mailbox
+ * and shows them to the user.
+ *
+ * @param resource $imapConnection
+ * @param array $aMailbox associative array with mailbox related vars
+ * @param array $aProps
+ * @param int $iError error code, 0 is no error
+ */
+function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
+ global $PHP_SELF;
+ global $boxes, $show_copy_buttons;
+
+ $highlight_list = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
+ $fancy_index_highlite = (isset($aProps['config']['fancy_index_highlite'])) ? $aProps['config']['fancy_index_highlite'] : true;
+ $aColumnsDesc = (isset($aProps['columns'])) ? $aProps['columns'] : false;
+ $iAccount = (isset($aProps['account'])) ? (int) $aProps['account'] : 0;
+ $sMailbox = (isset($aProps['mailbox'])) ? $aProps['mailbox'] : false;
+ $sTargetModule = (isset($aProps['module'])) ? $aProps['module'] : 'read_body';
+ $show_flag_buttons = (isset($aProps['config']['show_flag_buttons'])) ? $aProps['config']['show_flag_buttons'] : true;
+
+ /* allows to control copy button in function call. If array key is not set, code follows user preferences */
+ if (isset($aProps['config']['show_copy_buttons']))
+ $show_copy_buttons = $aProps['config']['show_copy_buttons'];
+
+ $lastTargetMailbox = (isset($aProps['config']['lastTargetMailbox'])) ? $aProps['config']['lastTargetMailbox'] : '';
+ $aOrder = array_keys($aProps['columns']);
+ $trash_folder = (isset($aProps['config']['trash_folder']) && $aProps['config']['trash_folder'])
+ ? $aProps['config']['trash_folder'] : false;
+ $sent_folder = (isset($aProps['config']['sent_folder']) && $aProps['config']['sent_folder'])
+ ? $aProps['config']['sent_folder'] : false;
+ $draft_folder = (isset($aProps['config']['draft_folder']) && $aProps['config']['draft_folder'])
+ ? $aProps['config']['draft_folder'] : false;
+ $page_selector = (isset($aProps['config']['page_selector'])) ? $aProps['config']['page_selector'] : false;
+ $page_selector_max = (isset($aProps['config']['page_selector_max'])) ? $aProps['config']['page_selector_max'] : 10;
+ $color = $aProps['config']['color'];
- $result .= "</A>\n";
- }
- /* Return our final result. */
- return ($result);
-}
+ /*
+ * Form ID
+ */
+ static $iFormId;
-/*
-* This function computes the "Viewing Messages..." string.
-*/
-function get_msgcnt_str($start_msg, $end_msg, $num_msgs) {
- /* Compute the $msg_cnt_str. */
- $result = '';
- if ($start_msg < $end_msg) {
- $result = sprintf(_("Viewing Messages: <B>%s</B> to <B>%s</B> (%s total)"),
- $start_msg, $end_msg, $num_msgs);
- } else if ($start_msg == $end_msg) {
- $result = sprintf(_("Viewing Message: <B>%s</B> (1 total)"), $start_msg);
+ if (!isset($iFormId)) {
+ $iFormId=1;
} else {
- $result = '<br>';
+ ++$iFormId;
}
+ // store the columns to fetch so we can pick them up in read_body
+ // where we validate the cache.
+ calcFetchColumns($aMailbox ,$aProps);
- /* Return our result string. */
- return ($result);
-}
-
-/*
-* Generate a paginator link.
-*/
-function get_paginator_link($box, $start_msg, $use, $text) {
- $result = "<A HREF=\"right_main.php?use_mailbox_cache=$use"
- . "&startMessage=$start_msg&mailbox=$box\" "
- . "TARGET=\"right\">$text</A>";
- return ($result);
-}
-
-/*
-* This function computes the paginator string.
-*/
-function get_paginator_str($box, $start_msg, $end_msg, $num_msgs,
-$show_num, $sort) {
- global $username, $data_dir, $use_mailbox_cache, $color, $PG_SHOWNUM;
-
- /* Initialize paginator string chunks. */
- $prv_str = '';
- $nxt_str = '';
- $pg_str = '';
- $all_str = '';
- $tgl_str = '';
-
- /* Create simple strings that will be creating the paginator. */
- $spc = ' '; /* This will be used as a space. */
- $sep = '|'; /* This will be used as a seperator. */
-
- /* Get some paginator preference values. */
- $pg_sel = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
- $pg_max = getPref($data_dir, $username, 'page_selector_max', PG_SEL_MAX);
-
- /* Make sure that our start message number is not too big. */
- $start_msg = min($start_msg, $num_msgs);
-
- /* Decide whether or not we will use the mailbox cache. */
- /* Not sure why $use_mailbox_cache is even passed in. */
- if ($sort == 6) {
- $use = 0;
+ $iError = fetchMessageHeaders($imapConnection, $aMailbox);
+ if ($iError) {
+ return array();
} else {
- $use = 1;
+ $aMessages = prepareMessageList($aMailbox, $aProps);
}
- /* Compute the starting message of the previous and next page group. */
- $next_grp = $start_msg + $show_num;
- $prev_grp = $start_msg - $show_num;
-
- /* Compute the basic previous and next strings. */
- if (($next_grp <= $num_msgs) && ($prev_grp >= 0)) {
- $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
- $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
- } else if (($next_grp > $num_msgs) && ($prev_grp >= 0)) {
- $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
- $nxt_str = "<FONT COLOR=\"$color[9]\">"._("Next")."</FONT>\n";
- } else if (($next_grp <= $num_msgs) && ($prev_grp < 0)) {
- $prv_str = "<FONT COLOR=\"$color[9]\">"._("Previous") . '</FONT>';
- $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
- }
+ $iSetIndx = $aMailbox['SETINDEX'];
+ $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
+ $iEnd = ($aMailbox['PAGEOFFSET'] + ($iLimit - 1) < $aMailbox['EXISTS']) ?
+ $aMailbox['PAGEOFFSET'] + $iLimit - 1 : $aMailbox['EXISTS'];
- /* Page selector block. Following code computes page links. */
- if ($pg_sel && ($num_msgs > $show_num)) {
- /* Most importantly, what is the current page!!! */
- $cur_pg = intval($start_msg / $show_num) + 1;
+ $iNumberOfMessages = $aMailbox['TOTAL'][$iSetIndx];
+ $iEnd = min ( $iEnd, $iNumberOfMessages );
- /* Compute total # of pages and # of paginator page links. */
- $tot_pgs = ceil($num_msgs / $show_num); /* Total number of Pages */
- $vis_pgs = min($pg_max, $tot_pgs - 1); /* Visible Pages */
+ $php_self = $PHP_SELF;
- /* Compute the size of the four quarters of the page links. */
+ $urlMailbox = urlencode($aMailbox['NAME']);
- /* If we can, just show all the pages. */
- if (($tot_pgs - 1) <= $pg_max) {
- $q1_pgs = $cur_pg - 1;
- $q2_pgs = $q3_pgs = 0;
- $q4_pgs = $tot_pgs - $cur_pg;
+ if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
+ $source_url = $regs[1];
+ } else {
+ $source_url = $php_self;
+ }
+
+ $baseurl = $source_url.'?mailbox=' . urlencode($aMailbox['NAME']) .'&account='.$aMailbox['ACCOUNT'] . (strpos($source_url, 'src/search.php') ? '&smtoken=' . sm_generate_security_token() : '');
+ $where = urlencode($aMailbox['SEARCH'][$iSetIndx][0]);
+ $what = urlencode($aMailbox['SEARCH'][$iSetIndx][1]);
+ $baseurl .= '&where=' . $where . '&what=' . $what;
- /* Otherwise, compute some magic to choose the four quarters. */
+ /* build thread sorting links */
+ $newsort = $aMailbox['SORT'];
+ if (sqimap_capability($imapConnection,'THREAD')) {
+ if ($aMailbox['SORT'] & SQSORT_THREAD) {
+ $newsort -= SQSORT_THREAD;
+ $thread_name = _("Unthread View");
} else {
- /*
- * Compute the magic base values. Added together,
- * these values will always equal to the $pag_pgs.
- * NOTE: These are DEFAULT values and do not take
- * the current page into account. That is below.
- */
- $q1_pgs = floor($vis_pgs/4);
- $q2_pgs = round($vis_pgs/4, 0);
- $q3_pgs = ceil($vis_pgs/4);
- $q4_pgs = round(($vis_pgs - $q2_pgs)/3, 0);
-
- /* Adjust if the first quarter contains the current page. */
- if (($cur_pg - $q1_pgs) < 1) {
- $extra_pgs = ($q1_pgs - ($cur_pg - 1)) + $q2_pgs;
- $q1_pgs = $cur_pg - 1;
- $q2_pgs = 0;
- $q3_pgs += ceil($extra_pgs / 2);
- $q4_pgs += floor($extra_pgs / 2);
-
- /* Adjust if the first and second quarters intersect. */
- } else if (($cur_pg - $q2_pgs - ceil($q2_pgs/3)) <= $q1_pgs) {
- $extra_pgs = $q2_pgs;
- $extra_pgs -= ceil(($cur_pg - $q1_pgs - 1) * 0.75);
- $q2_pgs = ceil(($cur_pg - $q1_pgs - 1) * 0.75);
- $q3_pgs += ceil($extra_pgs / 2);
- $q4_pgs += floor($extra_pgs / 2);
-
- /* Adjust if the fourth quarter contains the current page. */
- } else if (($cur_pg + $q4_pgs) >= $tot_pgs) {
- $extra_pgs = ($q4_pgs - ($tot_pgs - $cur_pg)) + $q3_pgs;
- $q3_pgs = 0;
- $q4_pgs = $tot_pgs - $cur_pg;
- $q1_pgs += floor($extra_pgs / 2);
- $q2_pgs += ceil($extra_pgs / 2);
-
- /* Adjust if the third and fourth quarter intersect. */
- } else if (($cur_pg + $q3_pgs + 1) >= ($tot_pgs - $q4_pgs + 1)) {
- $extra_pgs = $q3_pgs;
- $extra_pgs -= ceil(($tot_pgs - $cur_pg - $q4_pgs) * 0.75);
- $q3_pgs = ceil(($tot_pgs - $cur_pg - $q4_pgs) * 0.75);
- $q1_pgs += floor($extra_pgs / 2);
- $q2_pgs += ceil($extra_pgs / 2);
- }
+ $thread_name = _("Thread View");
+ $newsort = $aMailbox['SORT'] + SQSORT_THREAD;
}
+ $thread_link_uri = $baseurl . '&srt=' . $newsort
+ . '&startMessage=1';
+ } else {
+ $thread_link_uri ='';
+ $thread_name = '';
+ }
+ $sort = $aMailbox['SORT'];
+
+ /* FIX ME ADD CHECKBOX CONTROL. No checkbox => no buttons */
+
+
+
+ /* future admin control over displayable buttons */
+ $aAdminControl = array(
+ 'markFlagged' => 1,
+ 'markUnflagged' => 1,
+ 'markRead' => 1,
+ 'markUnread' => 1,
+ 'forward' => 1,
+ 'delete' => 1,
+ 'undeleteButton'=> 1,
+ 'bypass_trash' => 1,
+ 'expungeButton' => 1,
+ 'moveButton' => 1,
+ 'copyButton' => 1
+ );
+
+ /* user prefs control */
+ $aUserControl = array (
+
+ 'markFlagged' => $show_flag_buttons,
+ 'markUnflagged' => $show_flag_buttons,
+ 'markRead' => 1,
+ 'markUnread' => 1,
+ 'forward' => 1,
+ 'delete' => 1,
+ 'undeleteButton'=> 1,
+ 'bypass_trash' => 1,
+ 'expungeButton' => 1,
+ 'moveButton' => 1,
+ 'copyButton' => $show_copy_buttons
+
+ );
+
+ $showDelete = ($aMailbox['RIGHTS'] != 'READ-ONLY' &&
+ in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ? true : false;
+ $showByPassTrash = (($aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
+ in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) &&
+ $trash_folder) ? true : false; //
+
+ $showUndelete = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
+ in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true) /* trash folder unrelated methinks: && !$trash_folder*/) ? true : false;
+ $showMove = ($aMailbox['RIGHTS'] != 'READ-ONLY') ? true : false;
+ $showExpunge = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
+ in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ? true : false;
+
+ /* Button options that depend on IMAP server and selected folder */
+ $aImapControl = array (
+ 'markUnflagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true),
+ 'markFlagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true),
+ 'markRead' => in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true),
+ 'markUnread' => in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true),
+ 'forward' => 1,
+ 'delete' => $showDelete,
+ 'undeleteButton'=> $showUndelete,
+ 'bypass_trash' => $showByPassTrash,
+ 'expungeButton' => $showExpunge,
+ 'moveButton' => $showMove,
+ 'copyButton' => 1
+ );
+ /* Button strings */
+ $aButtonStrings = array(
+ 'markFlagged' => _("Flag"),
+ 'markUnflagged' => _("Unflag"),
+ 'markRead' => _("Read"),
+ 'markUnread' => _("Unread"),
+ 'forward' => _("Forward"),
+ 'delete' => _("Delete"),
+ 'undeleteButton' => _("Undelete"),
+ 'bypass_trash' => _("Bypass Trash"),
+ 'expungeButton' => _("Expunge"),
+ 'moveButton' => _("Move"),
+ 'copyButton' => _("Copy")
+ );
+ /* Button access keys */
+ global $accesskey_mailbox_flag, $accesskey_mailbox_unflag,
+ $accesskey_mailbox_read, $accesskey_mailbox_unread,
+ $accesskey_mailbox_forward, $accesskey_mailbox_delete,
+ $accesskey_mailbox_undelete, $accesskey_mailbox_bypass_trash,
+ $accesskey_mailbox_expunge, $accesskey_mailbox_move,
+ $accesskey_mailbox_copy, $accesskey_mailbox_move_to;
+ $aButtonAccessKeys = array(
+ 'markFlagged' => $accesskey_mailbox_flag,
+ 'markUnflagged' => $accesskey_mailbox_unflag,
+ 'markRead' => $accesskey_mailbox_read,
+ 'markUnread' => $accesskey_mailbox_unread,
+ 'forward' => $accesskey_mailbox_forward,
+ 'delete' => $accesskey_mailbox_delete,
+ 'undeleteButton' => $accesskey_mailbox_undelete,
+ 'bypass_trash' => $accesskey_mailbox_bypass_trash,
+ 'expungeButton' => $accesskey_mailbox_expunge,
+ 'moveButton' => $accesskey_mailbox_move,
+ 'copyButton' => $accesskey_mailbox_copy,
+ );
- /*
- * I am leaving this debug code here, commented out, because
- * it is a really nice way to see what the above code is doing.
- * echo "qts = $q1_pgs/$q2_pgs/$q3_pgs/$q4_pgs = "
- * . ($q1_pgs + $q2_pgs + $q3_pgs + $q4_pgs) . '<br>';
- */
-
- /* Print out the page links from the compute page quarters. */
- /* Start with the first quarter. */
- if (($q1_pgs == 0) && ($cur_pg > 1)) {
- $pg_str .= "...$spc";
- } else {
- for ($pg = 1; $pg <= $q1_pgs; ++$pg) {
- $start = (($pg-1) * $show_num) + 1;
- $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
- }
- if ($cur_pg - $q2_pgs - $q1_pgs > 1) {
- $pg_str .= "...$spc";
+ /**
+ * Register buttons in order to an array
+ * The key is the "name", the first element of the value array is the "value", second argument is the type.
+ */
+ $aFormElements = array();
+ foreach($aAdminControl as $k => $v) {
+ if ($v & $aUserControl[$k] & $aImapControl[$k]) {
+ switch ($k) {
+ case 'markFlagged':
+ case 'markUnflagged':
+ case 'markRead':
+ case 'markUnread':
+ case 'delete':
+ case 'undeleteButton':
+ case 'expungeButton':
+ case 'forward':
+ $aFormElements[$k]
+ = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
+ break;
+ case 'bypass_trash':
+ $aFormElements[$k]
+ = array('value' => $aButtonStrings[$k], 'type' => 'checkbox', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
+ break;
+ case 'moveButton':
+ case 'copyButton':
+ $aFormElements['targetMailbox']
+ = array('options_list' => sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes),
+ 'type' => 'select',
+ 'accesskey' => $accesskey_mailbox_move_to);
+ $aFormElements['mailbox']
+ = array('value' => $aMailbox['NAME'], 'type' => 'hidden');
+ $aFormElements['startMessage']
+ = array('value' => $aMailbox['PAGEOFFSET'], 'type' => 'hidden');
+ $aFormElements[$k]
+ = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
+ break;
}
}
+ $aFormElements['account'] = array('value' => $iAccount,'type' => 'hidden');
+ }
+ do_hook('message_list_controls', $aFormElements);
- /* Continue with the second quarter. */
- for ($pg = $cur_pg - $q2_pgs; $pg < $cur_pg; ++$pg) {
- $start = (($pg-1) * $show_num) + 1;
- $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
- }
+ /*
+ * This is the beginning of the message list table.
+ * It wraps around all messages
+ */
+ $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
+ $form_name = "FormMsgs" . $safe_name;
+
+ //if (!sqgetGlobalVar('align',$align,SQ_SESSION)) {
+ $align = array('left' => 'left', 'right' => 'right');
+ //}
+ //sm_print_r($align);
+
+ /* finally set the template vars */
+
+// FIXME, before we support multiple templates we must review the names of the vars
+// BUMP!
+
+
+ $aTemplate['color'] = $color;
+ $aTemplate['form_name'] = "FormMsgs" . $safe_name;
+ $aTemplate['form_id'] = 'mbx_'.$iFormId;
+ $aTemplate['page_selector'] = $page_selector;
+ $aTemplate['page_selector_max'] = $page_selector_max;
+ $aTemplate['messagesPerPage'] = $aMailbox['LIMIT'];
+ $aTemplate['showall'] = $aMailbox['SHOWALL'][$iSetIndx];
+ $aTemplate['end_msg'] = $iEnd;
+ $aTemplate['align'] = $align;
+ $aTemplate['iNumberOfMessages'] = $iNumberOfMessages;
+ $aTemplate['aOrder'] = $aOrder;
+ $aTemplate['aFormElements'] = $aFormElements;
+ $aTemplate['sort'] = $sort;
+ $aTemplate['pageOffset'] = $aMailbox['PAGEOFFSET'];
+ $aTemplate['baseurl'] = $baseurl;
+ $aTemplate['aMessages'] =& $aMessages;
+ $aTemplate['trash_folder'] = $trash_folder;
+ $aTemplate['sent_folder'] = $sent_folder;
+ $aTemplate['draft_folder'] = $draft_folder;
+ $aTemplate['thread_link_uri'] = $thread_link_uri;
+ $aTemplate['thread_name'] = $thread_name;
+ $aTemplate['php_self'] = str_replace('&','&',$php_self);
+ $aTemplate['mailbox'] = $sMailbox;
+//FIXME: javascript_on is always assigned to the template object in places like init.php; is there some reason to reassign it here? is there some chance that it was changed? if not, please remove this line!
+ $aTemplate['javascript_on'] = (isset($aProps['config']['javascript_on'])) ? $aProps['config']['javascript_on'] : false;
+ $aTemplate['enablesort'] = (isset($aProps['config']['enablesort'])) ? $aProps['config']['enablesort'] : false;
+ $aTemplate['icon_theme'] = (isset($aProps['config']['icon_theme'])) ? $aProps['config']['icon_theme'] : false;
+ $aTemplate['use_icons'] = (isset($aProps['config']['use_icons'])) ? $aProps['config']['use_icons'] : false;
+ $aTemplate['alt_index_colors'] = (isset($aProps['config']['alt_index_colors'])) ? $aProps['config']['alt_index_colors'] : false;
+ $aTemplate['fancy_index_highlite'] = $fancy_index_highlite;
- /* Now print the current page. */
- $pg_str .= $cur_pg . $spc;
- /* Next comes the third quarter. */
- for ($pg = $cur_pg + 1; $pg <= $cur_pg + $q3_pgs; ++$pg) {
- $start = (($pg-1) * $show_num) + 1;
- $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
- }
+ /**
+ * Set up sort possibilities; one could argue that this is best
+ * placed in the template, but most template authors won't understand
+ * or need to understand it, so some advanced templates can override
+ * it if they do something different.
+ */
+ if (!($aTemplate['sort'] & SQSORT_THREAD) && $aTemplate['enablesort']) {
+ $aTemplate['aSortSupported']
+ = array(SQM_COL_SUBJ => array(SQSORT_SUBJ_ASC , SQSORT_SUBJ_DESC),
+ SQM_COL_DATE => array(SQSORT_DATE_DESC , SQSORT_DATE_ASC),
+ SQM_COL_INT_DATE => array(SQSORT_INT_DATE_DESC, SQSORT_INT_DATE_ASC),
+ SQM_COL_FROM => array(SQSORT_FROM_ASC , SQSORT_FROM_DESC),
+ SQM_COL_TO => array(SQSORT_TO_ASC , SQSORT_TO_DESC),
+ SQM_COL_CC => array(SQSORT_CC_ASC , SQSORT_CC_DESC),
+ SQM_COL_SIZE => array(SQSORT_SIZE_ASC , SQSORT_SIZE_DESC));
+ } else {
+ $aTemplate['aSortSupported'] = array();
+ }
- /* And last, print the forth quarter page links. */
- if (($q4_pgs == 0) && ($cur_pg < $tot_pgs)) {
- $pg_str .= "...$spc";
- } else {
- if (($tot_pgs - $q4_pgs) > ($cur_pg + $q3_pgs)) {
- $pg_str .= "...$spc";
- }
- for ($pg = $tot_pgs - $q4_pgs + 1; $pg <= $tot_pgs; ++$pg) {
- $start = (($pg-1) * $show_num) + 1;
- $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
+
+ /**
+ * Figure out which columns should serve as labels for checkbox:
+ * we try to grab the two columns before and after the checkbox,
+ * except the subject column, since it is the link that opens
+ * the message view
+ *
+ * if $javascript_on is set, then the highlighting code takes
+ * care of this; just skip it
+ *
+ * This code also might be more appropriate in a template file, but
+ * we are moving this complex stuff out of the way of template
+ * authors; advanced template sets are always free to override
+ * the resultant values.
+ *
+ */
+ $show_label_columns = array();
+ $index_order_part = array();
+ if (!($aTemplate['javascript_on'] && $aTemplate['fancy_index_highlite'])) {
+ $get_next_two = 0;
+ $last_order_part = 0;
+ $last_last_order_part = 0;
+ foreach ($aTemplate['aOrder'] as $index_order_part) {
+ if ($index_order_part == SQM_COL_CHECK) {
+ $get_next_two = 1;
+ if ($last_last_order_part != SQM_COL_SUBJ)
+ $show_label_columns[] = $last_last_order_part;
+ if ($last_order_part != SQM_COL_SUBJ)
+ $show_label_columns[] = $last_order_part;
+
+ } else if ($get_next_two > 0 && $get_next_two < 3 && $index_order_part != SQM_COL_SUBJ) {
+ $show_label_columns[] = $index_order_part;
+ $get_next_two++;
}
+ $last_last_order_part = $last_order_part;
+ $last_order_part = $index_order_part;
}
- } else if ($PG_SHOWNUM == 999999) {
- $pg_str = "<A HREF=\"right_main.php?PG_SHOWALL=0"
- . "&use_mailbox_cache=$use&startMessage=1&mailbox=$box\" "
- . "TARGET=\"right\">" ._("Paginate") . '</A>' . $spc;
- }
-
- /* If necessary, compute the 'show all' string. */
- if (($prv_str != '') || ($nxt_str != '')) {
- $all_str = "<A HREF=\"right_main.php?PG_SHOWALL=1"
- . "&use_mailbox_cache=$use&startMessage=1&mailbox=$box\" "
- . "TARGET=\"right\">" . _("Show All") . '</A>';
}
+ $aTemplate['show_label_columns'] = $show_label_columns;
- /* Last but not least, get the value for the toggle all link. */
- $tgl_str = get_selectall_link($start_msg, $sort);
- /* Put all the pieces of the paginator string together. */
- /**
- * Hairy code... But let's leave it like it is since I am not certain
- * a different approach would be any easier to read. ;)
- */
- $result = '';
- $result .= ($prv_str != '' ? $prv_str . $spc . $sep . $spc : '');
- $result .= ($nxt_str != '' ? $nxt_str . $spc . $sep . $spc : '');
- $result .= ($pg_str != '' ? $pg_str : '');
- $result .= ($all_str != '' ? $sep . $spc . $all_str . $spc : '');
- $result .= ($result != '' ? $sep . $spc . $tgl_str: $tgl_str);
-
- /* If the resulting string is blank, return a non-breaking space. */
- if ($result == '') {
- $result = ' ';
- }
+ return $aTemplate;
- /* Return our final magical paginator string. */
- return ($result);
}
-function processSubject($subject) {
- /* Shouldn't ever happen -- caught too many times in the IMAP functions */
- if ($subject == '')
- return _("(no subject)");
- if (strlen($subject) <= 55)
- return $subject;
-
- $ent_strlen=strlen($subject);
- $trim_val=50;
- $ent_offset=0;
- /*
- * see if this is entities-encoded string
- * If so, Iterate through the whole string, find out
- * the real number of characters, and if more
- * than 55, substr with an updated trim value.
- */
- while ( (($ent_loc = strpos($subject, '&', $ent_offset)) !== false) &&
- (($ent_loc_end = strpos($subject, ';', $ent_loc)) !== false) ) {
- $trim_val += ($ent_loc_end-$ent_loc)+1;
- $ent_strlen -= $ent_loc_end-$ent_loc;
- $ent_offset = $ent_loc_end+1;
+/**
+ * Process messages list form and handle the cache gracefully. If $sButton and
+ * $aUid are provided as argument then you can fake a message list submit and
+ * use it i.e. in read_body.php for del move next and update the cache
+ *
+ * @param resource $imapConnection imap connection
+ * @param array $aMailbox (reference) cached mailbox
+ * @param string $sButton fake a submit button
+ * @param array $aUid fake the $msg array
+ * @param string $targetMailbox fake the target mailbox for move operations
+ * @param boolean $bypass_trash fake the bypass trash checkbox for delete operations
+ * @return string $sError error string in case of an error
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
+ */
+function handleMessageListForm($imapConnection, &$aMailbox, $sButton='',
+ $aUid = array(), $targetMailbox='', $bypass_trash=NULL) {
+ /* incoming formdata */
+ $sButton = (sqgetGlobalVar('moveButton', $sTmp, SQ_FORM)) ? 'move' : $sButton;
+ $sButton = (sqgetGlobalVar('copyButton', $sTmp, SQ_FORM)) ? 'copy' : $sButton;
+ $sButton = (sqgetGlobalVar('expungeButton', $sTmp, SQ_FORM)) ? 'expunge' : $sButton;
+ $sButton = (sqgetGlobalVar('forward', $sTmp, SQ_FORM)) ? 'forward' : $sButton;
+ $sButton = (sqgetGlobalVar('delete', $sTmp, SQ_FORM)) ? 'setDeleted' : $sButton;
+ $sButton = (sqgetGlobalVar('undeleteButton', $sTmp, SQ_FORM)) ? 'unsetDeleted' : $sButton;
+ $sButton = (sqgetGlobalVar('markRead', $sTmp, SQ_FORM)) ? 'setSeen' : $sButton;
+ $sButton = (sqgetGlobalVar('markUnread', $sTmp, SQ_FORM)) ? 'unsetSeen' : $sButton;
+ $sButton = (sqgetGlobalVar('markFlagged', $sTmp, SQ_FORM)) ? 'setFlagged' : $sButton;
+ $sButton = (sqgetGlobalVar('markUnflagged', $sTmp, SQ_FORM)) ? 'unsetFlagged' : $sButton;
+ if (empty($targetMailbox)) sqgetGlobalVar('targetMailbox', $targetMailbox, SQ_FORM);
+ if (is_null($bypass_trash)) sqgetGlobalVar('bypass_trash', $bypass_trash, SQ_FORM);
+ sqgetGlobalVar('msg', $msg, SQ_FORM);
+ if (sqgetGlobalVar('account', $iAccount, SQ_FORM) === false) {
+ $iAccount = 0;
}
-
- if ($ent_strlen <= 55){
- return $subject;
+ $sError = '';
+ $mailbox = $aMailbox['NAME'];
+
+ /* retrieve the check boxes */
+ $aUid = (isset($msg) && is_array($msg)) ? array_values($msg) : $aUid;
+ if (count($aUid) && $sButton != 'expunge') {
+
+ // don't do anything to any messages until we have done security check
+ // FIXME: not sure this code really belongs here, but there's nowhere else to put it with this architecture
+ sqgetGlobalVar('smtoken', $submitted_token, SQ_FORM, '');
+ sm_validate_security_token($submitted_token, 3600, TRUE);
+
+ // make sure message UIDs are sanitized (BIGINT)
+ foreach ($aUid as $i => $uid)
+ $aUid[$i] = (preg_match('/^[0-9]+$/', $uid) ? $uid : '0');
+
+ $aUpdatedMsgs = false;
+ $bExpunge = false;
+ switch ($sButton) {
+ case 'setDeleted':
+ // check if id exists in case we come from read_body
+ if (count($aUid) == 1 && is_array($aMailbox['UIDSET'][$aMailbox['SETINDEX']]) &&
+ !in_array($aUid[0],$aMailbox['UIDSET'][$aMailbox['SETINDEX']])) {
+ break;
+ }
+ $aUpdatedMsgs = sqimap_msgs_list_delete($imapConnection, $mailbox, $aUid,$bypass_trash);
+ $bExpunge = true;
+ //}
+ break;
+ case 'unsetDeleted':
+ case 'setSeen':
+ case 'unsetSeen':
+ case 'setFlagged':
+ case 'unsetFlagged':
+ // get flag
+ $sFlag = (substr($sButton,0,3) == 'set') ? '\\'.substr($sButton,3) : '\\'.substr($sButton,5);
+ $bSet = (substr($sButton,0,3) == 'set') ? true : false;
+ $aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
+ break;
+ case 'move':
+ $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox,true,$mailbox);
+ sqsession_register($targetMailbox,'lastTargetMailbox');
+ $bExpunge = true;
+ break;
+ case 'copy':
+ // sqimap_msgs_list_copy returns true or false.
+ // If error happens - fourth argument handles it inside function.
+ sqimap_msgs_list_copy($imapConnection,$aUid,$targetMailbox,true);
+ sqsession_register($targetMailbox,'lastTargetMailbox');
+ break;
+ case 'forward':
+ $aMsgHeaders = array();
+ foreach ($aUid as $iUid) {
+ $aMsgHeaders[$iUid] = $aMailbox['MSG_HEADERS'][$iUid];
+ }
+ if (count($aMsgHeaders)) {
+ $composesession = attachSelectedMessages($imapConnection,$aMsgHeaders);
+ // dirty hack, add info to $aMailbox
+ $aMailbox['FORWARD_SESSION']['SESSION_NUMBER'] = $composesession;
+ $aMailbox['FORWARD_SESSION']['UIDS'] = $aUid;
+ }
+ break;
+ default:
+ // Hook for plugin buttons
+ $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], &$aUid);
+ do_hook('mailbox_display_button_action', $temp);
+ break;
+ }
+ /**
+ * $aUpdatedMsgs is an array containing the result of the untagged
+ * fetch responses send by the imap server due to a flag change. That
+ * response is parsed in an array with msg arrays by the parseFetch function
+ */
+ if ($aUpdatedMsgs) {
+ // Update the message headers cache
+ $aDeleted = array();
+ foreach ($aUpdatedMsgs as $iUid => $aMsg) {
+ if (isset($aMsg['FLAGS'])) {
+ /**
+ * Only update the cached headers if the header is
+ * cached.
+ */
+ if (isset($aMailbox['MSG_HEADERS'][$iUid])) {
+ $aMailbox['MSG_HEADERS'][$iUid]['FLAGS'] = $aMsg['FLAGS'];
+ }
+ /**
+ * Also update flags in message object
+ */
+//FIXME: WHY are we keeping flags in TWO places?!? This is error-prone and some core code uses the is_xxxx message object values while other code uses the flags array above. That's a mess.
+ if (isset($aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'])) {
+ $message = $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'];
+ $message->is_seen = false;
+ $message->is_answered = false;
+ $message->is_forwarded = false;
+ $message->is_deleted = false;
+ $message->is_flagged = false;
+ $message->is_mdnsent = false;
+ foreach ($aMsg['FLAGS'] as $flag => $value) {
+ if (strtolower($flag) == '\\seen' && $value)
+ $message->is_seen = true;
+ else if (strtolower($flag) == '\\answered' && $value)
+ $message->is_answered = true;
+ else if (strtolower($flag) == '$forwarded' && $value)
+ $message->is_forwarded = true;
+ else if (strtolower($flag) == '\\deleted' && $value)
+ $message->is_deleted = true;
+ else if (strtolower($flag) == '\\flagged' && $value)
+ $message->is_flagged = true;
+ else if (strtolower($flag) == '$mdnsent' && $value)
+ $message->is_mdnsent = true;
+ }
+ $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'] = $message;
+ }
+ /**
+ * Count the messages with the \Delete flag set so we can determine
+ * if the number of expunged messages equals the number of flagged
+ * messages for deletion.
+ */
+ if (isset($aMsg['FLAGS']['\\deleted']) && $aMsg['FLAGS']['\\deleted']) {
+ $aDeleted[] = $iUid;
+ }
+ }
+ }
+ if ($bExpunge && $aMailbox['AUTO_EXPUNGE'] &&
+ $iExpungedMessages = sqimap_mailbox_expunge($imapConnection, $aMailbox['NAME'], true))
+ {
+ if (count($aDeleted) != $iExpungedMessages) {
+ // there are more messages deleted permanently then we expected
+ // invalidate the cache
+ $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = false;
+ $aMailbox['MSG_HEADERS'] = false;
+ } else {
+ // remove expunged messages from cache
+ $aUidSet = $aMailbox['UIDSET'][$aMailbox['SETINDEX']];
+ if (is_array($aUidSet)) {
+ // create a UID => array index temp array
+ $aUidSetDummy = array_flip($aUidSet);
+ foreach ($aDeleted as $iUid) {
+ // get the id as well in case of SQM_SORT_NONE
+ if ($aMailbox['SORT'] == SQSORT_NONE) {
+ $aMailbox['ID'] = false;
+ //$iId = $aMailbox['MSG_HEADERS'][$iUid]['ID'];
+ //unset($aMailbox['ID'][$iId]);
+ }
+ // unset the UID and message header
+ unset($aUidSetDummy[$iUid]);
+ unset($aMailbox['MSG_HEADERS'][$iUid]);
+ }
+ $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = array_keys($aUidSetDummy);
+ }
+ }
+ // update EXISTS info
+ if ($iExpungedMessages) {
+ $aMailbox['EXISTS'] -= (int) $iExpungedMessages;
+ $aMailbox['TOTAL'][$aMailbox['SETINDEX']] -= (int) $iExpungedMessages;
+ }
+ if (($aMailbox['PAGEOFFSET']-1) >= $aMailbox['EXISTS']) {
+ $aMailbox['PAGEOFFSET'] = ($aMailbox['PAGEOFFSET'] > $aMailbox['LIMIT']) ?
+ $aMailbox['PAGEOFFSET'] - $aMailbox['LIMIT'] : 1;
+ $aMailbox['OFFSET'] = $aMailbox['PAGEOFFSET'] - 1 ;
+ }
+ }
+ }
+ } else {
+ if ($sButton == 'expunge') {
+ /**
+ * on expunge we do not know which messages will be deleted
+ * so it's useless to try to sync the cache
+ *
+ * Close the mailbox so we do not need to parse the untagged expunge
+ * responses which do not contain uid info.
+ * NB: Closing a mailbox is faster then expunge because the imap
+ * server does not need to generate the untagged expunge responses
+ */
+ sqimap_run_command($imapConnection,'CLOSE',false,$result,$message);
+ $aMailbox = sqm_api_mailbox_select($imapConnection,$iAccount, $aMailbox['NAME'],array(),array());
+ } else {
+ // this is the same hook as above, but here it is called in the
+ // context of not having had any messages selected and if any
+ // plugin handles the situation, it should return TRUE so we
+ // know this was not an erroneous user action
+ //
+ global $null;
+ $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], $null);
+ if (!boolean_hook_function('mailbox_display_button_action', $temp, 1)
+ && $sButton) {
+ $sError = _("No messages were selected.");
+ }
+ }
}
-
- return substr($subject, 0, $trim_val) . '...';
+ return $sError;
}
-function handleAsSent($mailbox) {
- global $sent_folder, $draft_folder, $handleAsSent_result;
+/**
+ * Attach messages to a compose session
+ *
+ * @param resource $imapConnection imap connection
+ * @param array $aMsgHeaders
+ * @return int $composesession unique compose_session_id where the attached messages belong to
+ * @author Marc Groot Koerkamp
+ */
+function attachSelectedMessages($imapConnection,$aMsgHeaders) {
+
+ sqgetGlobalVar('composesession', $composesession, SQ_SESSION);
+ sqgetGlobalVar('compose_messages', $compose_messages, SQ_SESSION);
+ if (!isset($compose_messages)|| is_null($compose_messages)) {
+ $compose_messages = array();
+ sqsession_register($compose_messages,'compose_messages');
+ }
- /* First check if this is the sent or draft folder. */
- $handleAsSent_result = (($mailbox == $sent_folder)
- || ($mailbox == $draft_folder));
+ if (!$composesession) {
+ $composesession = 1;
+ sqsession_register($composesession,'composesession');
+ } else {
+ $composesession++;
+ sqsession_register($composesession,'composesession');
+ }
- /* Then check the result of the handleAsSent hook. */
- do_hook('check_handleAsSent_result', $mailbox);
+ $composeMessage = new Message();
+ $rfc822_header = new Rfc822Header();
+ $composeMessage->rfc822_header = $rfc822_header;
+ $composeMessage->reply_rfc822_header = '';
+
+ foreach($aMsgHeaders as $iUid => $aMsgHeader) {
+ /**
+ * Retrieve the full message
+ */
+ $body_a = sqimap_run_command($imapConnection, "FETCH $iUid RFC822", true, $response, $readmessage, TRUE);
+ if ($response == 'OK') {
+
+ $subject = (isset($aMsgHeader['subject'])) ? $aMsgHeader['subject'] : $iUid;
+
+ array_shift($body_a);
+ array_pop($body_a);
+ $body = implode('', $body_a);
+ $body .= "\r\n";
+
+ global $username, $attachment_dir;
+ $filename = sq_get_attach_tempfile();
+ $fullpath = getHashedDir($username, $attachment_dir) . '/' . $filename;
+ $fp = fopen($fullpath, 'wb');
+ fwrite ($fp, $body);
+ fclose($fp);
+
+ $composeMessage->initAttachment('message/rfc822', $subject . '.eml', $filename);
+
+ // create subject for new message
+ //
+ $subject = decodeHeader($subject,false,false,true);
+ $subject = str_replace('"', "'", $subject);
+ $subject = trim($subject);
+ if (substr(strtolower($subject), 0, 4) != 'fwd:') {
+ $subject = 'Fwd: ' . $subject;
+ }
+ $composeMessage->rfc822_header->subject = $subject;
+
+ }
+ }
- /* And return the result. */
- return ($handleAsSent_result);
+ $compose_messages[$composesession] = $composeMessage;
+ sqsession_register($compose_messages,'compose_messages');
+ return $composesession;
}
-?>
\ No newline at end of file