X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fmailbox_display.php;h=08a513130b575747409682f59df4bd28e5bb6817;hp=a48daf4c00d570db9caecc0bb2d7cbfaf1c7c5cb;hb=62f7daa5b0686061e12aeeee9866c195488c0d44;hpb=fb75a74e8e9d37f5d6832e0921bec8dd353cb10d diff --git a/functions/mailbox_display.php b/functions/mailbox_display.php index a48daf4c..08a51313 100644 --- a/functions/mailbox_display.php +++ b/functions/mailbox_display.php @@ -9,7 +9,7 @@ * This contains functions that display mailbox information, such as the * table row that has sender, date, subject, etc... * - * $Id$ + * @version $Id$ * @package squirrelmail */ @@ -19,6 +19,7 @@ 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/imap_asearch.php'); require_once(SM_PATH . 'functions/mime.php'); require_once(SM_PATH . 'functions/forms.php'); @@ -27,100 +28,154 @@ require_once(SM_PATH . 'functions/forms.php'); */ define('PG_SEL_MAX', 10); +/** + * The number of pages to cache msg headers + */ +define('SQM_MAX_PAGES_IN_CACHE',5); + +/** + * Sort constants used for sorting of messages + */ +define('SQSORT_NONE',0); +define('SQSORT_DATE_ASC',1); +define('SQSORT_DATE_DEC',2); +define('SQSORT_FROM_ASC',3); +define('SQSORT_FROM_DEC',4); +define('SQSORT_SUBJ_ASC',5); +define('SQSORT_SUBJ_DEC',6); +define('SQSORT_SIZE_ASC',7); +define('SQSORT_SIZE_DEC',8); +define('SQSORT_TO_ASC',9); +define('SQSORT_TO_DEC',10); +define('SQSORT_CC_ASC',11); +define('SQSORT_CC_DEC',12); +define('SQSORT_INT_DATE_ASC',13); +define('SQSORT_INT_DATE_DEC',14); + +define('SQSORT_THREAD',32); + + +define('MBX_PREF_SORT',0); +define('MBX_PREF_LIMIT',1); +define('MBX_PREF_AUTO_EXPUNGE',2); +define('MBX_PREF_INTERNALDATE',3); +define('SQM_MAX_MBX_IN_CACHE',3); +// define('MBX_PREF_FUTURE',unique integer key); + /** * @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; +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; } /** - * Displays message listing + * Displays message header row in messages list * - * @param mixed $imapConnection - * @param mixed $t UNDOCUMENTED - * @param bool $not_last UNDOCUMENTED - * @param mixed $key UNDOCUMENTED - * @param string $mailbox mail folder - * @param mixed $start_msg UNDOCUMENTED - * @param mixed $where UNDOCUMENTED - * @param mixed $what UNDOCUMENTED + * @param array $aMsg contains all message related parameters + * @return void */ -function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox, - $start_msg, $where, $what) { + +function printMessageInfo($aMsg) { + // FIX ME, remove these globals as well by adding an array as argument for the user settings + // specificly meant for header display 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 */ - $use_icons, /* indicates to use icons or text markers */ - $icon_theme; /* icons theming */ + $color, + $default_use_priority, + $message_highlight_list, + $index_order, + $truncate_sender, /* number of characters for From/To field (<= 0 for unchanged) */ + $email_address, + $show_recipient_instead, /* show recipient name instead of default identity */ + $use_icons, /* indicates to use icons or text markers */ + $icon_theme; /* icons theming */ $color_string = $color[4]; + // initialisation: + $mailbox = $aMsg['MAILBOX']; + $msg = $aMsg['HEADER']; + $t = $aMsg['INDX']; + $start_msg = $aMsg['PAGEOFFSET']; + $last = $aMsg['LAST']; + if (isset($aMsg['SEARCH']) && count($aMsg['SEARCH']) >1 ) { + $where = $aMsg['SEARCH'][0]; + $what = $aMsg['SEARCH'][1]; + } else { + $where = false; + $what = false; + } + $iIndent = $aMsg['INDENT']; + + $sSubject = (isset($msg['SUBJECT']) && $msg['SUBJECT'] != '') ? $msg['SUBJECT'] : _("(no subject)"); + $sFrom = (isset($msg['FROM'])) ? $msg['FROM'] : _("Unknown sender"); + $sTo = (isset($msg['TO'])) ? $msg['TO'] : _("Unknown recipient"); + $sCc = (isset($msg['CC'])) ? $msg['CC'] : ''; + $aFlags = (isset($msg['FLAGS'])) ? $msg['FLAGS'] : array(); + $iPrio = (isset($msg['PRIORITY'])) ? $msg['PRIORITY'] : 3; + $iSize = (isset($msg['SIZE'])) ? $msg['SIZE'] : 0; + $sType0 = (isset($msg['TYPE0'])) ? $msg['TYPE0'] : 'text'; + $sType1 = (isset($msg['TYPE1'])) ? $msg['TYPE1'] : 'plain'; + if (isset($msg['INTERNALDATE'])) { + $sDate = getDateString(getTimeStamp(explode(' ',$msg['INTERNALDATE']))); + } else { + $sDate = (isset($msg['DATE'])) ? getDateString(getTimeStamp(explode(' ',$msg['DATE']))) : ''; + } + $iId = (isset($msg['UID'])) ? $msg['UID'] : false; + + if (!$iId) { + return; + } + if ($GLOBALS['alt_index_colors']) { - if (!isset($row_count)) { - $row_count = 0; - } - $row_count++; - if ($row_count % 2) { + if (!($t % 2)) { if (!isset($color[12])) { $color[12] = '#EAEAEA'; } $color_string = $color[12]; } } - $msg = $msgs[$key]; - if($mailbox == 'None') { - $boxes = sqimap_mailbox_list($imapConnection); - $mailbox = $boxes[0]['unformatted']; - unset($boxes); - } $urlMailbox = urlencode($mailbox); + // FIXME, foldertype should be set in right_main.php + // in other words, handle as sent is obsoleted from now. + // We replace that by providing an array to aMailbox with the to shown headers + // that way we are free to show the user different layouts for different folders $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); + $from_array = parseAddress($sFrom, 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)); - } - else + } else { $bHandleAsSent = $bSentFolder; + } // If this is a Sent message, display To address instead of From - if ($bHandleAsSent) - $msg['FROM'] = $msg['TO']; + if ($bHandleAsSent) { + $sFrom = $sTo; + } // Passing 1 below results in only 1 address being parsed, thus defeating the following code - $msg['FROM'] = parseAddress($msg['FROM']/*,1*/); + $sFrom = parseAddress($sFrom/*,1*/); - /* + /* * This is done in case you're looking into Sent folders, * because you can have multiple receivers. */ - $senderNames = $msg['FROM']; + $senderNames = $sFrom; $senderName = ''; $senderAddress = ''; if (sizeof($senderNames)){ @@ -142,42 +197,51 @@ function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox, } // If Sent, prefix with To: but only if not Sent folder if ($bHandleAsSent ^ $bSentFolder) { - $senderName = _("To:") . ' ' . $senderName; - $senderAddress = _("To:") . ' ' . $senderAddress; + $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 = ''; - } else { - $flag = ''; - $flag_end = ''; + // this is a column property which can apply to multiple columns. Do not use vars for one column + // only. instead we should use something like this: + // 1ed column $aMailbox['columns']['SUBJECT'] value: aray with properties ... + // 2ed column $aMailbox['columns']['FROM'] value: aray with properties ... + // NB in case of the sentfolder this could be the TO field + // properties array example: + // 'truncate' => length (0 is no truncate) + // 'prefix => if (x in b then do that ) + if ($truncate_sender > 0) { + $senderName = truncateWithEntities($senderName, $truncate_sender); } - if (!isset($msg['FLAG_SEEN']) || ($msg['FLAG_SEEN'] == false)) { - $bold = ''; - $bold_end = ''; - } else { - $bold = ''; - $bold_end = ''; + + $flag = $flag_end = $bold = $bold_end = $fontstr = $fontstr_end = $italic = $italic_end = ''; + $bold = ''; + $bold_end = ''; + + foreach ($aFlags as $sFlag => $value) { + switch ($sFlag) { + case '\\flagged': + if ($value) { + $flag = ""; + $flag_end = ''; + } + break; + case '\\seen': + if ($value) { + $bold = ''; + $bold_end = ''; + } + break; + case '\\deleted': + if ($value) { + $fontstr = ""; + $fontstr_end = ''; + } + break; + } } if ($bHandleAsSent) { $italic = ''; $italic_end = ''; - } else { - $italic = ''; - $italic_end = ''; - } - if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED']) { - $fontstr = ""; - $fontstr_end = ''; - } else { - $fontstr = ''; - $fontstr_end = ''; } if ($where && $what) { @@ -185,10 +249,13 @@ function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox, } else { $searchstr = ''; } - + /* + * Message highlight code + */ + $matches = array('TO' => 'sTo', 'CC' => 'sCc', 'FROM' => 'sFrom', 'SUBJECT' => 'sSubject'); if (is_array($message_highlight_list) && count($message_highlight_list)) { - $msg['TO'] = parseAddress($msg['TO']); - $msg['CC'] = parseAddress($msg['CC']); + $sTo = parseAddress($sTo); + $sCc = parseAddress($sCc); foreach ($message_highlight_list as $message_highlight_list_part) { if (trim($message_highlight_list_part['value']) != '') { $high_val = strtolower($message_highlight_list_part['value']); @@ -203,7 +270,7 @@ function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox, case('TO'): case('CC'): case('FROM'): - foreach ($msg[$match_type] as $address) { + foreach ($$matches[$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) || @@ -214,73 +281,73 @@ function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox, } break; default: - $headertest = strtolower(decodeHeader($msg[$match_type], true, false)); + $headertest = strtolower(decodeHeader($$matches[$match_type], true, false)); if (strstr('^^' . $headertest, $high_val)) { $hlt_color = $message_highlight_list_part['color']; - break 3; + break 3; } break; } } } } - } + } /* end Message highlight code */ if (!isset($hlt_color)) { $hlt_color = $color_string; } $col = 0; - $msg['SUBJECT'] = str_replace(' ', ' ', decodeHeader($msg['SUBJECT'])); - $subject = processSubject($msg['SUBJECT'], $indent_array[$msg['ID']]); + $sSubject = str_replace(' ', ' ', decodeHeader($sSubject)); + $subject = processSubject($sSubject, $iIndent); + + echo html_tag( 'tr','','','','valign="top"') . "\n"; + if (sizeof($index_order)) { foreach ($index_order as $index_order_part) { switch ($index_order_part) { case 1: /* checkbox */ echo html_tag( 'td', - addCheckBox("msg[$t]", $checkall, $msg['ID']), - 'center', - $hlt_color ); + addCheckBox("msg[$t]", $checkall, $iId), + '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 + } else { $title = ''; + } echo html_tag( 'td', - $italic . $bold . $flag . $fontstr . $senderName . - $fontstr_end . $flag_end . $bold_end . $italic_end, - 'left', - $hlt_color, $title ); + $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"); + if ($sDate == '') { + $sDate = _("Unknown date"); } echo html_tag( 'td', - $bold . $flag . $fontstr . $date_string . - $fontstr_end . $flag_end . $bold_end, - 'center', - $hlt_color, - 'nowrap' ); + $bold . $flag . $fontstr . $sDate . + $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']]); - } + if ($iIndent) { + $td_str .= str_repeat("    ",$iIndent); } $td_str .= ' '; } if ($default_use_priority) { - if ( ($msg['PRIORITY'] == 1) || ($msg['PRIORITY'] == 2) ) { + if ( ($iPrio == 1) || ($iPrio == 2) ) { $td_str .= ' '; } - else if ($msg['PRIORITY'] == 5) { + else if ($iPrio == 5) { $td_str .= ' '; } - else - { + else { $td_str .= ' '; } } - if ($msg['TYPE0'] == 'multipart') { + if ($sType1 == 'mixed') { $td_str .= ''; - } - else - { + } else { $td_str .= ''; } $msg_icon = ''; - if (!isset($msg['FLAG_SEEN']) || ($msg['FLAG_SEEN']) == false) - { + if (!isset($aFlags['\\seen']) || ($aFlags['\\seen']) == false) { $msg_alt = '(' . _("New") . ')'; $msg_title = '(' . _("New") . ')'; $msg_icon .= SM_PATH . 'images/themes/' . $icon_theme . '/msg_new'; - } - else - { + } else { $msg_alt = '(' . _("Read") . ')'; $msg_title = '(' . _("Read") . ')'; $msg_icon .= SM_PATH . 'images/themes/' . $icon_theme . '/msg_read'; } - if (isset($msg['FLAG_DELETED']) && ($msg['FLAG_DELETED']) == true) - { + if (isset($aFlags['\\deleted']) && ($aFlags['\\deleted']) == true) { $msg_icon .= '_deleted'; } - if (isset($msg['FLAG_ANSWERED']) && ($msg['FLAG_ANSWERED']) == true) - { + if (isset($aFlags['\\answered']) && ($aFlags['\\answered']) == true) { $msg_alt = '(' . _("Answered") . ')'; $msg_title = '(' . _("Answered") . ')'; $msg_icon .= '_reply'; @@ -342,37 +401,36 @@ function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox, $td_str .= ''. $msg_alt . ''; $td_str .= ''; echo html_tag( 'td', - $td_str, - 'right', - $hlt_color, - 'nowrap' ); + $td_str, + 'right', + $hlt_color, + 'nowrap' ); } - // plain text message markers // else { $stuff = false; $td_str = ""; - if (isset($msg['FLAG_ANSWERED']) && $msg['FLAG_ANSWERED'] == true) { + if (isset($aFlags['\\answered']) && $aFlags['\\answered'] == true) { $td_str .= _("A"); $stuff = true; } - if ($msg['TYPE0'] == 'multipart') { + if ($sType1 == 'mixed') { $td_str .= '+'; $stuff = true; } if ($default_use_priority) { - if ( ($msg['PRIORITY'] == 1) || ($msg['PRIORITY'] == 2) ) { + if ( ($iPrio == 1) || ($iPrio == 2) ) { $td_str .= "!"; $stuff = true; } - if ($msg['PRIORITY'] == 5) { + if ($iPrio == 5) { $td_str .= "?"; $stuff = true; } } - if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED'] == true) { + if (isset($aFlags['\\deleted']) && $aFlags['\\deleted'] == true) { $td_str .= "D"; $stuff = true; } @@ -381,465 +439,686 @@ function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox, } $td_str .= ''; echo html_tag( 'td', - $td_str, - 'center', - $hlt_color, - 'nowrap' ); + $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 ); + $bold . $fontstr . show_readable_size($iSize) . + $fontstr_end . $bold_end, + 'right', + $hlt_color ); break; } ++$col; } } - if ($not_last) { - echo '' . "\n" . '' . "\n"; - } else { + /* html for separationlines between rows */ + if ($last) { echo ''."\n"; + } else { + echo '' . "\n" . '' . "\n"; } } + +function setUserPref($username, $pref, $value) { + global $data_dir; + setPref($data_dir,$username,$pref,$value); +} + /** - * FIXME: Undocumented function + * Selects a mailbox for header retrieval. + * Cache control for message headers is embedded. * - * @param mixed $imapConnection - * @param mixed $start_msg - * @param mixed $show_num - * @param mixed $num_msgs - * @param mixed $id - * @return array + * @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 + * @author Marc Groot Koerkamp */ -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; +function sqm_api_mailbox_select($imapConnection,$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; + /** + * In case the properties arrays are empty set the defaults. + */ + $aDefaultMbxPref = array (); +// MBX_PREF_SORT => 0, +// MBX_PREF_LIMIT => 15, +// MBX_PREF_AUTO_EXPUNGE => 0, +// MBX_PREF_INTERNALDATE => 0 +// ); + /* array_merge doesn't work with integers as keys */ +// foreach ($aDefaultMbxPref as $key => $value) { +// if (!isset($aProps[$key])) { +// $aProps[$key] = $value; +// } +// } + $aDefaultConfigProps = array( +// 'allow_thread_sort' => 0, + 'allow_server_sort' => sqimap_capability($imapConnection,'SORT'), +// '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[$mailbox])) { + $aCachedMailbox = $mailbox_cache[$mailbox]; } else { - $end_loop = $show_num; + $aCachedMailbox = false; } - return fillMessageArray($imapConnection,$id,$end_loop,$show_num); + /* 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; + } + } + } + } + } else { - return false; + $aCachedMailbox = false; } -} -/** - * FIXME: Undocumented function - * - * @param mixed $imapConnection - * @param mixed $start_msg - * @param mixed $show_num - * @param mixed $num_msgs - * @return array - */ -function getThreadMessages($imapConnection, $start_msg, $show_num, $num_msgs) { - $id = get_thread_sort($imapConnection); - return getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id); -} + /** + * 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']; + } -/** - * FIXME: Undocumented function - * - * @param mixed $imapConnection - * @param mixed $start_msg - * @param mixed $show_num - * @param mixed $num_msgs - * @param mixed $server_sort_order - * @param mixed $mbxresponse - * @return array - */ -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); -} + $aMailbox['UIDSET'][$iSetIndx] = false; + $aMailbox['ID'] = false; + $aMailbox['SETINDEX'] = $iSetIndx; -/** - * FIXME: Undocumented function - * - * @param mixed $imapConnection - * @param mixed $start_msg - * @param mixed $show_num - * @param mixed $num_msgs - * @param mixed $sort - * @param mixed $mbxresponse - * @return array - */ -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; - } 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 ($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']; } - if ($end_msg < $start_msg) { - $start_msg = $start_msg - $show_num; - if ($start_msg < 1) { - $start_msg = 1; + $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_$mailbox",serialize($aProps)); + } + } else { + $aMailbox['UIDSET'][$iSetIndx] = $aCachedMailbox['UIDSET'][$iSetIndx]; } } - $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; - } } - $msgs = fillMessageArray($imapConnection,$id,$end_loop, $show_num); } - return $msgs; + /** + * 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 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 { + $aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ? 1 : 0; + } + + if (!isset($aProps[MBX_PREF_SORT]) && isset($aCachedMailbox['SORT'])) { + $aMailbox['SORT'] = $aCachedMailbox['SORT']; + } else { + $aMailbox['SORT'] = (isset($aProps[MBX_PREF_SORT])) ? $aProps[MBX_PREF_SORT] : 0; + } + + if (!isset($aProps[MBX_PREF_LIMIT]) && isset($aCachedMailbox['LIMIT'])) { + $aMailbox['LIMIT'] = $aCachedMailbox['LIMIT']; + } else { + $aMailbox['LIMIT'] = (isset($aProps[MBX_PREF_LIMIT])) ? $aProps[MBX_PREF_LIMIT] : 15; + } + + if (!isset($aProps[MBX_PREF_INTERNALDATE]) && isset($aCachedMailbox['INTERNALDATE'])) { + $aMailbox['INTERNALDATE'] = $aCachedMailbox['INTERNALDATE']; + } else { + $aMailbox['INTERNALDATE'] = (isset($aProps[MBX_PREF_INTERNALDATE])) ? $aProps[MBX_PREF_INTERNALDATE] : false; + } + + 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['allow_thread_sort']) && isset($aCachedMailbox['ALLOW_THREAD'])) { + $aMailbox['ALLOW_THREAD'] = $aCachedMailbox['ALLOW_THREAD']; + } else { + $aMailbox['ALLOW_THREAD'] = (isset($aConfig['allow_thread_sort'])) ? $aConfig['allow_thread_sort'] : false; + } + + if (!isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx])) { + $aMailbox['SEARCH'][$iSetIndx] = $aCachedMailbox['SEARCH'][$iSetIndx]; + } 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'; + } + + $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['ALLOW_THREAD']) { + if ($aMailbox['SORT'] & SQSORT_THREAD) { + $aMailbox['SORT'] -= SQSORT_THREAD; + } + } + if ($aMailbox['SORT'] & SQSORT_THREAD) { + $aMailbox['SORT_METHOD'] = 'THREAD'; + $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT']; + } else if (isset($aConfig['allow_server_sort']) && $aConfig['allow_server_sort']) { + $aMailbox['SORT_METHOD'] = 'SERVER'; + $aMailbox['THREAD_INDENT'] = false; + } else { + $aMailbox['SORT_METHOD'] = 'SQUIRREL'; + $aMailbox['THREAD_INDENT'] = false; + } + + /* 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. + * Does the $srt $_GET var to field mapping * - * @param mixed $imapConnection - * @param string $mailbox mail folder - * @param mixed $num_msgs - * @param mixed $start_msg - * @param mixed $sort - * @param mixed $color - * @param mixed $show_num - * @param mixed $use_cache - * @param mixed $mode + * @param int $srt Field to sort on + * @param bool $bServerSort Server sorting is true + * @return string $sSortField Field to sort on */ -function showMessagesForMailbox($imapConnection, $mailbox, $num_msgs, - $start_msg, $sort, $color, $show_num, - $use_cache, $mode='',$mbxresponse) { - global $msgs, $msort, $auto_expunge, $thread_sort_messages, - $allow_server_sort, $server_sort_order; +function getSortField($sort,$bServerSort) { + switch($sort) { + case SQSORT_NONE: + $sSortField = 'UID'; + break; + case SQSORT_DATE_ASC: + case SQSORT_DATE_DEC: + $sSortField = 'DATE'; + break; + case SQSORT_FROM_ASC: + case SQSORT_FROM_DEC: + $sSortField = 'FROM'; + break; + case SQSORT_SUBJ_ASC: + case SQSORT_SUBJ_DEC: + $sSortField = 'SUBJECT'; + break; + case SQSORT_SIZE_ASC: + case SQSORT_SIZE_DEC: + $sSortField = ($bServerSort) ? 'SIZE' : 'RFC822.SIZE'; + break; + case SQSORT_TO_ASC: + case SQSORT_TO_DEC: + $sSortField = 'TO'; + break; + case SQSORT_CC_ASC: + case SQSORT_CC_DEC: + $sSortField = 'CC'; + break; + case SQSORT_INT_DATE_ASC: + case SQSORT_INT_DATE_DEC: + $sSortField = ($bServerSort) ? 'ARRIVAL' : 'INTERNALDATE'; + break; + case SQSORT_THREAD: + break; + default: $sSortField = 'UID'; + break; - /* - * 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 + } + return $sSortField; +} + +function get_sorted_msgs_list($imapConnection,&$aMailbox,&$error) { + $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0; + $bDirection = ($aMailbox['SORT'] % 2); + $error = false; + if (!$aMailbox['SEARCH'][$iSetIndx]) { + $aMailbox['SEARCH'][$iSetIndx] = 'ALL'; + } + switch ($aMailbox['SORT_METHOD']) { + case 'THREAD': + $aRes = get_thread_sort($imapConnection,$aMailbox['SEARCH'][$iSetIndx]); + if ($aRes === false) { + $error = '
' . + _("Thread sorting is not supported by your IMAP server.") . '
' . + _("Please contact your system administrator and report this error.") . + '
'; + $aMailbox['SORT'] -= SQSORT_THREAD; + } else { + $aMailbox['UIDSET'][$iSetIndx] = $aRes[0]; + $aMailbox['THREAD_INDENT'][$iSetIndx] = $aRes[1]; + } + break; + case 'SERVER': + $sSortField = getSortField($aMailbox['SORT'],true); + $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection, $aMailbox['SEARCH'][$iSetIndx]); + if ($id === false) { + $error = '
' . + _("Server-side sorting is not supported by your IMAP server.") . '
' . + _("Please contact your system administrator and report this error.") . + '
'; + } else { + $aMailbox['UIDSET'][$iSetIndx] = $id; + } + break; + default: + $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); + break; + } + return $error; +} + + + + +function fetchMessageHeaders($imapConnection, &$aMailbox) { + + /** + * 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']; - //} + // initialize the fields we want to retrieve: + $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'); + $aFetchItems = array('FLAGS', 'RFC822.SIZE'); - 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 - */ + // Are we sorting on internaldate then retrieve the internaldate value as well + if ($aMailbox['INTERNALDATE']) { + $aFetchItems[] = 'INTERNALDATE'; + } - if($start_msg > $num_msgs) { - $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 (($aMailbox['SORT'] != SQSORT_NONE || $aMailbox['SEARCH'][$iSetIndx] != 'ALL') && + isset($aUid) && $aUid ) { + + // limit the cache to SQM_MAX_PAGES_IN_CACHE + if (!$aMailbox['SHOWALL'][$iSetIndx]) { + $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; + } } } - /* 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 + $id_slice = array_slice($aUid,$start_msg-1,$iLimit); + /* do some funky cache checks */ + $aUidCached = array_keys($aMailbox['MSG_HEADERS']); + $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 ($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; } - if ($use_cache) { - sqgetGlobalVar('msgs', $msgs, SQ_SESSION); - sqgetGlobalVar('msort', $msort, SQ_SESSION); - } else { - sqsession_unregister('msort'); - sqsession_unregister('msgs'); } - switch ($mode) { - case 'thread': - $msgs = getThreadMessages($imapConnection, $start_msg, $show_num, $num_msgs); - 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(); + } else { + /** + * Initialize the sorted UID list and fetch the visible message headers + */ + if ($aMailbox['SORT'] != SQSORT_NONE || $aMailbox['SEARCH'][$iSetIndx] != 'ALL') {// || $aMailbox['SORT_METHOD'] & SQSORT_THREAD 'THREAD') { + + $error = false; + if ($aMailbox['SEARCH'][$iSetIndx] && $aMailbox['SORT'] == 0) { + $aUid = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]); + } else { + $error = get_sorted_msgs_list($imapConnection,$aMailbox,$error); + $aUid = $aMailbox['UIDSET'][$iSetIndx]; + } + if ($error === false) { + $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; + return false; } - break; - case 'serversort': - $msgs = getServerSortMessages($imapConnection, $start_msg, $show_num, - $num_msgs, $sort, $mbxresponse); - 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 { + // FIX ME, format message and fallback to squirrel sort + if ($error) { + echo $error; + } + } + } else { + // limit the cache to SQM_MAX_PAGES_IN_CACHE + if (!$aMailbox['SHOWALL'][$iSetIndx] && isset($aMailbox['MSG_HEADERS']) && is_array($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) { + $iId = $aMailbox['MSG_HEADERS'][$iUid]['ID']; + unset($aMailbox['MSG_HEADERS'][$iUid]); + unset($aMailbox['ID'][$iId]); + } else { + break; + } + --$iReduce; + } + } + } + + /** + * retrieve messages by sequence id's and fetch the UID to retrieve + * the UID. for sorted lists this is not needed because a UID FETCH + * automaticly add the UID value in fetch results + **/ + $aFetchItems[] = 'UID'; + + //create id range + $iRangeStart = $aMailbox['EXISTS'] - $aMailbox['OFFSET']; + $iRangeEnd = ($iRangeStart > $iLimit) ? + ($iRangeStart - $iLimit+1):1; + + $id_slice = range($iRangeStart, $iRangeEnd); + /** + * Non sorted mailbox with cached message headers + */ + if (isset($aMailbox['ID']) && is_array($aMailbox['ID'])) { + // the fetched id => uid relation + $aId = $aMailbox['ID']; + $aIdCached = array(); + foreach ($aId as $iId => $iUid) { + if (isset($aMailbox['MSG_HEADERS'][$iUid])) { + if ($iId <= $iRangeStart && $iId >= $iRangeEnd) { + $aIdCached[] = $iId; + } + } + } + $aIdNotCached = array_diff($id_slice,$aIdCached); + } else { + $aIdNotCached = $id_slice; + } + + if (count($aIdNotCached)) { + $aMsgs = sqimap_get_small_header_list($imapConnection,$aIdNotCached, + $aHeaderFields,$aFetchItems); + // append the msgs to the existend headers + if (isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) { + $aMailbox['MSG_HEADERS'] += $aMsgs; } else { - $msort = $msgs; - $sort = 6; + $aMailbox['MSG_HEADERS'] = $aMsgs; } - 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'); + // update the ID array + foreach ($aMsgs as $iUid => $aMsg) { + if (isset($aMsg['ID'])) { + $aMailbox['ID'][$aMsg['ID']] = $iUid; + } + } + } - } /* if exists > 0 */ + /** + * In unsorted state we show newest messages first which means + * that the UIDSET which represents the order of the messages + * should contain a high to low ordered UID list + */ + $aSortedUidList = array(); + foreach ($id_slice as $iId) { + if (isset($aMailbox['ID'][$iId])) { + $aSortedUidList[] = $aMailbox['ID'][$iId]; + } + } + $aMailbox['UIDSET'][$iSetIndx] = $aSortedUidList; + $aMailbox['OFFSET'] = 0; + } + } + return true; +} + +/** + * This function loops through a group of messages in the mailbox + * and shows them to the user. + * + * @param mixed $imapConnection + * @param array $aMailbox associative array with mailbox related vars + */ +function showMessagesForMailbox($imapConnection, &$aMailbox) { + global $color; - $res = getEndMessage($start_msg, $show_num, $num_msgs); - $start_msg = $res[0]; - $end_msg = $res[1]; + // to retrieve the internaldate pref: (I know this is not the right place to do that, move up in front + // and use a properties array as function argument to provide user preferences + global $data_dir, $username; - $paginator_str = get_paginator_str($mailbox, $start_msg, $end_msg, - $num_msgs, $show_num, $sort); + if (!fetchMessageHeaders($imapConnection, $aMailbox)) { + return false; + } + $iSetIndx = $aMailbox['SETINDEX']; + $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT']; + $iEnd = ($aMailbox['PAGEOFFSET'] + ($iLimit - 1) < $aMailbox['EXISTS']) ? + $aMailbox['PAGEOFFSET'] + $iLimit - 1 : $aMailbox['EXISTS']; - $msg_cnt_str = get_msgcnt_str($start_msg, $end_msg, $num_msgs); + $paginator_str = get_paginator_str($aMailbox['NAME'], $aMailbox['PAGEOFFSET'], + $aMailbox['EXISTS'], $aMailbox['LIMIT'], $aMailbox['SHOWALL'][$iSetIndx]); + + $msg_cnt_str = get_msgcnt_str($aMailbox['PAGEOFFSET'], $iEnd,$aMailbox['EXISTS']); do_hook('mailbox_index_before'); ?> - + - - - + + +
- +
- +
- + -
+ - + - +
- +
-
- +
+ - + $show_num) { - $end_msg = $show_num; - $start_msg = 1; - } + * @param resource $imapConnection socket handle to imap + * @param array $aMailbox array with required elements MSG_HEADERS, UIDSET, OFFSET, LIMIT + * @return void + **/ +function displayMessageArray($imapConnection, $aMailbox) { + $iSetIndx = $aMailbox['SETINDEX']; + $aId = $aMailbox['UIDSET'][$iSetIndx]; + $aHeaders = $aMailbox['MSG_HEADERS']; + $iOffset = $aMailbox['OFFSET']; + $sort = $aMailbox['SORT']; + $iPageOffset = $aMailbox['PAGEOFFSET']; + $sMailbox = $aMailbox['NAME']; + $sSearch = (isset($aMailbox['SEARCH'][$aMailbox['SETINDEX']])) ? $aMailbox['SEARCH'][$aMailbox['SETINDEX']] : false; + $aSearch = ($sSearch) ? array('search.php',$aMailbox['SETINDEX']) : null; + + if ($aMailbox['SORT'] & SQSORT_THREAD) { + $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']]; + $bThread = true; + } else { + $bThread = false; } - $endVar = $end_msg + 1; - /* - * Loop through and display the info for each message. - * ($t is used for the checkbox number) - */ - $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; + * Loop through and display the info for each message. + * ($t is used for the checkbox number) + */ + $iEnd = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $iOffset + $aMailbox['LIMIT']; + for ($i=$iOffset,$t=0;$i<$iEnd;++$i) { + if (isset($aId[$i])) { + $bLast = ((isset($aId[$i+1]) && isset($aHeaders[$aId[$i+1]])) + || ($i == $iEnd )) ? false : true; + if ($bThread) { + $indent = (isset($aIndentArray[$aId[$i]])) ? $aIndentArray[$aId[$i]] : 0; + } else { + $indent = 0; + } + $aMsg = array( + 'HEADER' => $aHeaders[$aId[$i]], + 'INDX' => $t, + 'OFFSET' => $iOffset, + 'PAGEOFFSET' => $iPageOffset, + 'SORT' => $sort, + 'SEARCH' => $aSearch, + 'MAILBOX' => $sMailbox, + 'INDENT' => $indent, + 'LAST' => $bLast + ); + printMessageInfo($aMsg); + ++$t; } else { - $i = 1; + 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); } } @@ -848,30 +1127,22 @@ function displayMessageArray($imapConnection, $num_msgs, $start_msg, * * To finish the table, you need to do a ""; * - * @param mixed $imapConnection - * @param array $mbxresponse the array with the results of SELECT against the current mailbox - * @param string $mailbox the current mailbox - * @param mixed $sort the current sorting method (-1 for no sorting available [searches]) - * @param mixed $msg_cnt_str - * @param mixed $paginator - * @param mixed $start_msg + * @param resource $imapConnection + * @param array $aMailbox associative array with mailbox related information + * @param string $msg_cnt_str + * @param string $paginator Paginator string */ function mail_message_listing_beginning ($imapConnection, - $mbxresponse, - $mailbox = '', $sort = -1, + $aMailbox, $msg_cnt_str = '', - $paginator = ' ', - $start_msg = 1) { - global $color, $auto_expunge, $base_uri, $show_flag_buttons, - $allow_server_sort, $server_sort_order, - $PHP_SELF, $allow_thread_sort, $thread_sort_messages; + $paginator = ' ' + ) { + global $color, $show_flag_buttons, $PHP_SELF; + global $lastTargetMailbox, $boxes; $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); - } - $urlMailbox = urlencode($mailbox); + + $urlMailbox = urlencode($aMailbox['NAME']); if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) { $source_url = $regs[1]; @@ -883,143 +1154,139 @@ function mail_message_listing_beginning ($imapConnection, $msg = ''; } - if (!strpos($php_self,'?')) { - $location = $php_self.'?mailbox=INBOX&startMessage=1'; - } else { - $location = $php_self; - } - $moveFields = addHidden('msg', $msg). - addHidden('mailbox', $mailbox). - addHidden('startMessage', $start_msg). - addHidden('location', $location); + addHidden('mailbox', $aMailbox['NAME']). + addHidden('startMessage', $aMailbox['PAGEOFFSET']); /* build thread sorting links */ - if ($allow_thread_sort == TRUE) { - if ($thread_sort_messages == 1 ) { - $set_thread = 2; - $thread_name = _("Unthread View"); - } elseif ($thread_sort_messages == 0) { - $set_thread = 1; - $thread_name = _("Thread View"); - } - $thread_link_str = '[' . $thread_name - . ']'; - } - else + $sort = $aMailbox['SORT']; + if ($aMailbox['ALLOW_THREAD']) { + if ($aMailbox['SORT'] & SQSORT_THREAD) { + $sort -= SQSORT_THREAD; + $thread_name = _("Unthread View"); + } else { + $thread_name = _("Thread View"); + $sort = $aMailbox['SORT'] + SQSORT_THREAD; + } + $thread_link_str = '[' . $thread_name + . ']'; + } else { $thread_link_str =''; - + } /* - * This is the beginning of the message list table. - * It wraps around all messages - */ - $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $mailbox); + * 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; - echo '
' ."\n" - . $moveFields; + echo '' ."\n" + . $moveFields; + + $button_str = ''; + // display flag buttons only if supported + if ($show_flag_buttons && + in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true) ) { + $button_str .= getButton('submit', 'markUnflagged', _("Unflag")); + $button_str .= getButton('submit', 'markFlagged', _("Flag")); + $button_str .= " \n"; + } + if (in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true)) { + $button_str .= getButton('submit', 'markUnread', _("Unread")); + $button_str .= getButton('submit', 'markRead', _("Read")); + $button_str .= " \n"; + } + $button_str .= getButton('submit', 'attache',_("Forward")) . + " \n"; + if (in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) { + $button_str .= getButton('submit', 'delete',_("Delete")); + $button_str .= '' . _("Bypass Trash"); + $button_str .= " \n"; + } + if (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY') { + $button_str .= getButton('submit', 'expungeButton',_("Expunge")) .' ' . _("mailbox") . "\n"; + $button_str .= ' '; + } ?> - +
- + - + -
+ - - - - - + + ' . $paginator . $thread_link_str . '', 'left') . "\n"; ?> + + ' . $msg_cnt_str . '', 'right') . "\n"; ?> +
-
+ - - + + + + + - - +
- ' . _("Bypass Trash"); - echo ' '; - if (!$auto_expunge) { - echo getButton('SUBMIT', 'expungeButton',_("Expunge")) .' ' . _("mailbox") . "\n"; - echo ' '; - } - do_hook('mailbox_display_buttons'); - ?> +
- + + +   +   + + +
-
- + - - + + - +
- + -
+ - - - - + + ' . $paginator_str . '', 'left'); ?> + ' . $msg_cnt_str . '', 'right'); ?> +
-
+ - + 1,2=>25,3=>5,4=>0,5=>1,6=>5); $subjectwidth = 100; foreach($index_order as $item) { - $subjectwidth -= $widths[$item]; + $subjectwidth -= $widths[$item]; } foreach ($index_order as $item) { switch ($item) { case 1: /* checkbox */ - echo html_tag( 'td',get_selectall_link($start_msg, $sort, $mailbox) , '', '', 'width="1%"' ); + echo html_tag( 'td',get_selectall_link($aMailbox) , '', '', 'width="1%"' ); break; case 5: /* flags */ echo html_tag( 'td','' , '', '', 'width="1%"' ); break; case 2: /* from */ - if (handleAsSent($mailbox)) { + if (handleAsSent($aMailbox['NAME'])) { echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' ) - . '' . _("To") . ''; + . '' . _("To") . ''; + if ($showsort) { + ShowSortButton($aMailbox, SQSORT_TO_ASC, SQSORT_TO_DEC); + } } else { echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' ) - . '' . _("From") . ''; - } - if ($showsort) { - ShowSortButton($sort, $mailbox, 2, 3); + . '' . _("From") . ''; + if ($showsort) { + ShowSortButton($aMailbox, SQSORT_FROM_ASC, SQSORT_FROM_DEC); + } } echo "\n"; break; case 3: /* date */ echo html_tag( 'td' ,'' , 'left', '', 'width="5%" nowrap' ) - . '' . _("Date") . ''; + . '' . _("Date") . ''; if ($showsort) { - ShowSortButton($sort, $mailbox, 0, 1); + if ($internal_date_sort) { + ShowSortButton($aMailbox, SQSORT_INT_DATE_ASC, SQSORT_INT_DATE_DEC); + } else { + ShowSortButton($aMailbox, SQSORT_DATE_ASC, SQSORT_DATE_DEC); + } } echo "\n"; break; case 4: /* subject */ echo html_tag( 'td' ,'' , 'left', '', 'width="'.$subjectwidth.'%"' ) - . '' . _("Subject") . ''; + . '' . _("Subject") . ''; if ($showsort) { - ShowSortButton($sort, $mailbox, 4, 5); + ShowSortButton($aMailbox, SQSORT_SUBJ_ASC, SQSORT_SUBJ_DEC); } echo "\n"; break; case 6: /* size */ - echo html_tag( 'td', '' . _("Size") . '', 'center', '', 'width="5%" nowrap' ); + echo html_tag( 'td', '', 'center','','width="5%" nowrap') + . '' . _("Size") . ''; + if ($showsort) { + ShowSortButton($aMailbox, SQSORT_SIZE_ASC, SQSORT_SIZE_DEC); + } + echo "\n"; break; } } @@ -1096,24 +1378,23 @@ function printHeader($mailbox, $sort, $color, $showsort=true, $start_msg=1) { /** * This function shows the sort button. Isn't this a good comment? * - * @param mixed $sort - * @param string $mailbox - * @param mixed $Down - * @param mixed $Up + * @param array $aMailbox + * @param integer $Down + * @param integer $Up */ -function ShowSortButton($sort, $mailbox, $Down, $Up ) { +function ShowSortButton($aMailbox, $Down, $Up ) { global $PHP_SELF; /* Figure out which image we want to use. */ - if ($sort != $Up && $sort != $Down) { + if ($aMailbox['SORT'] != $Up && $aMailbox['SORT'] != $Down) { $img = 'sort_none.png'; $which = $Up; - } elseif ($sort == $Up) { + } elseif ($aMailbox['SORT'] == $Up) { $img = 'up_pointer.png'; $which = $Down; } else { $img = 'down_pointer.png'; - $which = 6; + $which = 0; } if (preg_match('/^(.+)\?.+$/',$PHP_SELF,$regs)) { @@ -1123,27 +1404,25 @@ function ShowSortButton($sort, $mailbox, $Down, $Up ) { } /* Now that we have everything figured out, show the actual button. */ - echo ' sort'; + echo ' sort'; } /** * FIXME: Undocumented function * - * @param mixed $start_msg - * @param mixed $sort - * @param string $mailbox + * @param array $aMailbox */ -function get_selectall_link($start_msg, $sort, $mailbox) { - global $checkall, $what, $where, $javascript_on; - global $PHP_SELF, $PG_SHOWNUM; +function get_selectall_link($aMailbox) { + global $checkall, $javascript_on; + global $PHP_SELF; $result = ''; if ($javascript_on) { - $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $mailbox); + $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']); $func_name = "CheckAll" . $safe_name; $form_name = "FormMsgs" . $safe_name; $result = '