/**
* mailbox_display.php
*
- * Copyright (c) 1999-2004 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...
*
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
*/
-/** The standard includes.. */
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
-require_once(SM_PATH . 'class/html.class.php');
-require_once(SM_PATH . 'functions/imap_mailbox.php');
-require_once(SM_PATH . 'functions/imap_messages.php');
-require_once(SM_PATH . 'functions/imap_asearch.php');
-require_once(SM_PATH . 'functions/mime.php');
-require_once(SM_PATH . 'functions/forms.php');
-
-/**
- * default value for page_selector_max
- */
-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;
-}
-
-/**
- * Displays message header row in messages list
- *
- * @param array $aMsg contains all message related parameters
- * @return void
- */
-
-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,
- $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;
-
- // These don't appear to be used... are they safe to remove
- $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 (!($t % 2)) {
- if (!isset($color[12])) {
- $color[12] = '#EAEAEA';
- }
- $color_string = $color[12];
- }
- }
-
- $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($sFrom, 1);
- if (!isset($email_address)) {
- global $data_dir, $username;
- $email_address = getPref($data_dir, $username, 'email_address');
- }
- $bHandleAsSent = ((isset($from_array[0][0])) && ($from_array[0][0] == $email_address));
- } else {
- $bHandleAsSent = $bSentFolder;
- }
- // If this is a Sent message, display To address instead of From
- if ($bHandleAsSent) {
- $sFrom = $sTo;
- }
- // Passing 1 below results in only 1 address being parsed, thus defeating the following code
- $sFrom = parseAddress($sFrom/*,1*/);
-
- /*
- * This is done in case you're looking into Sent folders,
- * because you can have multiple receivers.
- */
- $senderNames = $sFrom;
- $senderName = '';
- $senderAddress = '';
- if (sizeof($senderNames)){
- foreach ($senderNames as $senderNames_part) {
- if ($senderName != '') {
- $senderName .= ', ';
- $senderAddress .= ', ';
- }
- $sender_address_part = htmlspecialchars($senderNames_part[0]);
- $sender_name_part = str_replace(' ',' ', decodeHeader($senderNames_part[1]));
- if ($sender_name_part) {
- $senderName .= $sender_name_part;
- $senderAddress .= $sender_name_part . ' <' . $sender_address_part . '>';
- } else {
- $senderName .= $sender_address_part;
- $senderAddress .= $sender_address_part;
- }
- }
- }
- // If Sent, prefix with To: but only if not Sent folder
- if ($bHandleAsSent ^ $bSentFolder) {
- $senderName = _("To") . ': ' . $senderName;
- $senderAddress = _("To") . ': ' . $senderAddress;
- }
-
- // 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);
- }
-
- $flag = $flag_end = $fontstr = $fontstr_end = $italic = $italic_end = '';
- $bold = '<b>';
- $bold_end = '</b>';
-
- foreach ($aFlags as $sFlag => $value) {
- switch ($sFlag) {
- case '\\flagged':
- if ($value) {
- $flag = "<font color=\"$color[2]\">";
- $flag_end = '</font>';
- }
- break;
- case '\\seen':
- if ($value) {
- $bold = '';
- $bold_end = '';
- }
- break;
- case '\\deleted':
- if ($value) {
- $fontstr = "<font color=\"$color[9]\">";
- $fontstr_end = '</font>';
- }
- break;
- }
- }
- if ($bHandleAsSent) {
- $italic = '<i>';
- $italic_end = '</i>';
- }
-
- if ($where && $what) {
- $searchstr = '&where='.$where.'&what='.$what;
- } 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)) {
- $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']);
- $match_type = strtoupper($message_highlight_list_part['match_type']);
- if($match_type == 'TO_CC') {
- $match = array('TO', 'CC');
- } else {
- $match = array($match_type);
- }
- foreach($match as $match_type) {
- switch($match_type) {
- case('TO'):
- case('CC'):
- case('FROM'):
- foreach ($$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) ||
- strstr('^^' . strtolower($address[1]), $high_val)) {
- $hlt_color = $message_highlight_list_part['color'];
- break 4;
- }
- }
- break;
- default:
- $headertest = strtolower(decodeHeader($$matches[$match_type], true, false));
- if (strstr('^^' . $headertest, $high_val)) {
- $hlt_color = $message_highlight_list_part['color'];
- break 3;
- }
- break;
- }
- }
- }
- }
- } /* end Message highlight code */
-
- if (!isset($hlt_color)) {
- $hlt_color = $color_string;
- }
- $col = 0;
- $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, $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(array('"', '<', '>'), array("''", '<', '>'), $senderAddress) . '"';
- } else {
- $title = '';
- }
- echo html_tag( 'td',
- $italic . $bold . $flag . $fontstr . $senderName .
- $fontstr_end . $flag_end . $bold_end . $italic_end,
- 'left',
- $hlt_color, $title );
- break;
- case 3: /* date */
- if ($sDate == '') {
- $sDate = _("Unknown date");
- }
- echo html_tag( 'td',
- $bold . $flag . $fontstr . $sDate .
- $fontstr_end . $flag_end . $bold_end,
- 'center',
- $hlt_color,
- 'style="white-space: nowrap;"' );
- break;
- case 4: /* subject */
- $td_str = $bold;
- if ($iIndent) {
- $td_str .= str_repeat(" ",$iIndent);
- }
- $td_str .= '<a href="read_body.php?mailbox='.$urlMailbox
- . '&passed_id='. $iId
- . '&startMessage='.$start_msg.$searchstr.'"';
- $td_str .= ' ' .concat_hook_function('subject_link', array($start_msg, $searchstr));
- if ($subject != $sSubject) {
- $title = get_html_translation_table(HTML_SPECIALCHARS);
- $title = array_flip($title);
- $title = strtr($sSubject, $title);
- $title = str_replace(array('"', '<', '>'), array("''", '<', '>'), $title);
- $td_str .= " title=\"$title\"";
- }
- $td_str .= ">$flag$subject$flag_end</a>$bold_end";
- echo html_tag( 'td', $td_str, 'left', $hlt_color );
- break;
- case 5: /* flags */
-
- // icon message markers
- //
- if ($use_icons && $icon_theme != 'none') {
- $td_str = "<b><small>";
- if (isset($aFlags['\\flagged']) && $aFlags['\\flagged'] == true) {
- $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/flagged.png" border="0" height="10" width="10" /> ';
- }
- if ($default_use_priority) {
- if ( ($iPrio == 1) || ($iPrio == 2) ) {
- $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/prio_high.png" border="0" height="10" width="5" /> ';
- }
- else if ($iPrio == 5) {
- $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/prio_low.png" border="0" height="10" width="5" /> ';
- }
- else {
- $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/transparent.png" border="0" width="5" /> ';
- }
- }
- if ($sType1 == 'mixed') {
- $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/attach.png" border="0" height="10" width="6" />';
- } else {
- $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/transparent.png" border="0" width="6" />';
- }
-
- $msg_icon = '';
- if (!isset($aFlags['\\seen']) || ($aFlags['\\seen']) == false) {
- $msg_alt = '(' . _("New") . ')';
- $msg_title = '(' . _("New") . ')';
- $msg_icon .= SM_PATH . 'images/themes/' . $icon_theme . '/msg_new';
- } else {
- $msg_alt = '(' . _("Read") . ')';
- $msg_title = '(' . _("Read") . ')';
- $msg_icon .= SM_PATH . 'images/themes/' . $icon_theme . '/msg_read';
- }
- if (isset($aFlags['\\deleted']) && ($aFlags['\\deleted']) == true) {
- $msg_icon .= '_deleted';
- }
- if (isset($aFlags['\\answered']) && ($aFlags['\\answered']) == true) {
- $msg_alt = '(' . _("Answered") . ')';
- $msg_title = '(' . _("Answered") . ')';
- $msg_icon .= '_reply';
- }
- $td_str .= '<img src="' . $msg_icon . '.png" border="0" alt="'. $msg_alt . '" title="' . $msg_title . '" height="12" width="18" />';
- $td_str .= '</small></b>';
- echo html_tag( 'td',
- $td_str,
- 'right',
- $hlt_color,
- 'style="white-space: nowrap;"' );
- }
-
- // plain text message markers
- //
- else {
- $stuff = false;
- $td_str = "<b><small>";
- if (isset($aFlags['\\answered']) && $aFlags['\\answered'] == true) {
- $td_str .= _("A");
- $stuff = true;
- }
- if ($sType1 == 'mixed') {
- $td_str .= '+';
- $stuff = true;
- }
- if ($default_use_priority) {
- if ( ($iPrio == 1) || ($iPrio == 2) ) {
- $td_str .= "<font color=\"$color[1]\">!</font>";
- $stuff = true;
- }
- if ($iPrio == 5) {
- $td_str .= "<font color=\"$color[8]\">?</font>";
- $stuff = true;
- }
- }
- if (isset($aFlags['\\deleted']) && $aFlags['\\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,
- 'style="white-space: nowrap;"' );
- }
- break;
- case 6: /* size */
- echo html_tag( 'td',
- $bold . $fontstr . show_readable_size($iSize) .
- $fontstr_end . $bold_end,
- 'right',
- $hlt_color );
- break;
- }
- ++$col;
- }
- }
- /* html for separationlines between rows */
- if ($last) {
- echo '</tr>'."\n";
- } else {
- echo '</tr>' . "\n" . '<tr><td colspan="' . $col . '" bgcolor="' .
- $color[0] . '" height="1"></td></tr>' . "\n";
- }
-}
-
-
-function setUserPref($username, $pref, $value) {
- global $data_dir;
- setPref($data_dir,$username,$pref,$value);
-}
/**
* Selects a mailbox for header retrieval.
* @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,$mailbox,$aConfig,$aProps) {
+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;
- /**
- * In case the properties arrays are empty set the defaults.
- */
- // Doesn't appear to be used... safe to remove?
- $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,
);
$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];
+ if (isset($mailbox_cache[$account.'_'.$mailbox])) {
+ $aCachedMailbox = $mailbox_cache[$account.'_'.$mailbox];
} else {
$aCachedMailbox = false;
}
$aMbxResponse['UIDVALIDTY'] = $aStatus['UIDVALIDITY'];
}
+ $aMailbox['ACCOUNT'] = $account;
$aMailbox['UIDSET'][$iSetIndx] = false;
$aMailbox['ID'] = false;
$aMailbox['SETINDEX'] = $iSetIndx;
+ $aMailbox['MSG_HEADERS'] = false;
if ($aCachedMailbox) {
/**
(!($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;
}
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));
+ setUserPref($aConfig['user'],'pref_'.$account.'_'.$mailbox,serialize($aProps));
}
} else {
$aMailbox['UIDSET'][$iSetIndx] = $aCachedMailbox['UIDSET'][$iSetIndx];
$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];
+ }
/**
* Restore the showall value no new showall value is provided.
$aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ? 1 : 0;
}
+ /**
+ * 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 {
$aMailbox['SORT'] = (isset($aProps[MBX_PREF_SORT])) ? $aProps[MBX_PREF_SORT] : 0;
}
+ /**
+ * 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 {
$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'];
+ /**
+ * Restore the ordered columns to show when no new ordered columns are provided
+ */
+ if (!isset($aProps[MBX_PREF_COLUMNS]) && isset($aCachedMailbox['COLUMNS'])) {
+ $aMailbox['COLUMNS'] = $aCachedMailbox['COLUMNS'];
} else {
- $aMailbox['INTERNALDATE'] = (isset($aProps[MBX_PREF_INTERNALDATE])) ? $aProps[MBX_PREF_INTERNALDATE] : false;
+ $aMailbox['COLUMNS'] = (isset($aProps[MBX_PREF_COLUMNS])) ? $aProps[MBX_PREF_COLUMNS] :
+ array(SQM_COL_FLAGS,SQM_COL_FROM, SQM_COL_SUBJ, SQM_COL_FLAGS);
}
+ /**
+ * Restore the headers we fetch the last time. Saves intitialisation stuff in read_body.
+ */
+ $aMailbox['FETCHHEADERS'] = (isset($aCachedMailbox['FETCHHEADERS'])) ? $aCachedMailbox['FETCHHEADERS'] : null;
+
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 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['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;
+ if (!sqimap_capability($imapConnection,'THREAD')) {
+ $aMailbox['SORT'] ^= SQSORT_THREAD;
+ } else {
+ $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT'];
+ }
} else {
- $aMailbox['SORT_METHOD'] = 'SQUIRREL';
$aMailbox['THREAD_INDENT'] = false;
}
return $aMailbox;
}
-
-
/**
- * Does the $srt $_GET var to field mapping
+ * 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 int $srt Field to sort on
- * @param bool $bServerSort Server sorting is true
- * @return string $sSortField Field to sort on
+ * @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 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;
-
- }
- 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 = '<b><small><center><font color=red>' .
- _("Thread sorting is not supported by your IMAP server.") . '<br />' .
- _("Please contact your system administrator and report this error.") .
- '</center></small></b>';
- $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 = '<b><small><center><font color=red>' .
- _("Server-side sorting is not supported by your IMAP server.") . '<br />' .
- _("Please contact your system administrator and report this error.") .
- '</center></small></b>';
- } 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) {
+ /* FIX ME, this function is kind of big, maybe we can split it up in
+ a couple of functions. Make sure the functions are private and starts with _
+ Also make sure that the error codes are propagated */
+
/**
* Retrieve the UIDSET.
* Setindex is used to be able to store multiple uid sets. That will make it
}
}
-
if (is_array($aMailbox['UIDSET'])) {
$aUid =& $aMailbox['UIDSET'][$iSetIndx];
} else {
$aUid = false;
}
+ $aFetchHeaders = $aMailbox['FETCHHEADERS'];
+ $iError = 0;
+ $aFetchItems = $aHeaderItems = array();
// initialize the fields we want to retrieve:
- $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type');
- $aFetchItems = array('FLAGS', 'RFC822.SIZE');
-
- // Are we sorting on internaldate then retrieve the internaldate value as well
- if ($aMailbox['INTERNALDATE']) {
- $aFetchItems[] = 'INTERNALDATE';
+ $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;
+ }
}
-
/**
* 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 ) {
-
+ if (isset($aUid) && $aUid ) {
// limit the cache to SQM_MAX_PAGES_IN_CACHE
- if (!$aMailbox['SHOWALL'][$iSetIndx]) {
+ if (!$aMailbox['SHOWALL'][$iSetIndx] && isset($aMailbox['MSG_HEADERS'])) {
$iMaxMsgs = $iLimit * SQM_MAX_PAGES_IN_CACHE;
$iCacheSize = count($aMailbox['MSG_HEADERS']);
if ($iCacheSize > $iMaxMsgs) {
$id_slice = array_slice($aUid,$start_msg-1,$iLimit);
/* do some funky cache checks */
- $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
+ if (isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) {
+ // temp code, read_body del / next links fo not update fields.
+ foreach ($aMailbox['MSG_HEADERS'] as $iUid => $aValue) {
+ if (!isset($aValue['UID'])) {
+ unset($aMailbox['MSG_HEADERS'][$iUid]);
+ }
+ }
+ $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
+ } else {
+ $aMailbox['MSG_HEADERS'] = array();
+ $aUidCached = array();
+ }
$aUidNotCached = array_values(array_diff($id_slice,$aUidCached));
+
/**
* $aUidNotCached contains an array with UID's which need to be fetched to
* complete the needed message headers.
// append the msgs to the existend headers
$aMailbox['MSG_HEADERS'] += $aMsgs;
}
-
} else {
/**
- * Initialize the sorted UID list and fetch the visible message headers
+ * Initialize the sorted UID list or initiate a UID list with search
+ * results 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] != '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 {
- $error = get_sorted_msgs_list($imapConnection,$aMailbox,$error);
+
+ $iError = 0;
+ $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
$aUid = $aMailbox['UIDSET'][$iSetIndx];
}
- if ($error === false) {
+ 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 {
- return false;
- }
-
- } 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;
- }
+ $iError = 1; // FIX ME, define an error code
}
}
-
- /**
- * 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 { //
+ $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 {
- $aMailbox['MSG_HEADERS'] = $aMsgs;
- }
- // update the ID array
- foreach ($aMsgs as $iUid => $aMsg) {
- if (isset($aMsg['ID'])) {
- $aMailbox['ID'][$aMsg['ID']] = $iUid;
- }
+ $iError = 1; // FIX ME, define an error code
}
}
-
- /**
- * 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;
+ return $iError;
}
/**
- * This function loops through a group of messages in the mailbox
- * and shows them to the user.
+ * 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 mixed $imapConnection
- * @param array $aMailbox associative array with mailbox related vars
+ * @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 showMessagesForMailbox($imapConnection, &$aMailbox) {
- global $color, $javascript_on, $compact_paginator;
+function prepareMessageList(&$aMailbox, $aProps) {
- // 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;
+ /* Globalize link attributes so plugins can share in modifying them */
+ global $link, $title, $target, $onclick, $link_extra;
- 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'];
-
- $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');
-
- if ($javascript_on && $compact_paginator) {
- // Insert compact paginator javascript
- echo "\n<!-- start of compact paginator javascript -->\n"
- . "<script language=\"JavaScript\">\n"
- . "function SubmitOnSelect(select, URL)\n"
- . "{\n"
- . " URL += select.options[select.selectedIndex].value;\n"
- . " window.location.href = URL;\n"
- . "}\n"
- . "</script>\n"
- . "<!-- end of compact paginator javascript -->\n";
- }
- mail_message_listing_beginning($imapConnection, $aMailbox, $msg_cnt_str, $paginator_str);
-?>
-<tr><td height="5" bgcolor="<?php echo $color[4]; ?>"></td></tr>
-<tr>
- <td>
- <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="<?php echo $color[9]; ?>">
- <tr>
- <td>
- <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="<?php echo $color[5]; ?>">
- <?php
- printHeader($aMailbox);
- displayMessageArray($imapConnection, $aMailbox);
- ?>
- </table>
- </td>
- </tr>
- </table>
- </td>
-</tr>
-<?php
- mail_message_listing_end($aMailbox, $paginator_str, $msg_cnt_str);
-?>
-</table></form>
-<?php
-
-}
+ /* 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';
-/**
- * Function to map an uid list with a msg header array by uid
- * The mapped headers are printed with printMessage
- * aMailbox parameters contains info about the page we are on, the
- * used search criteria, the number of messages to show
- *
- * @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;
- }
/*
- * 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 {
- break;
- }
- }
-}
-
-/**
- * Displays the standard message list header.
- *
- * To finish the table, you need to do a "</table></table>";
- *
- * @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,
- $aMailbox,
- $msg_cnt_str = '',
- $paginator = ' '
- ) {
- global $color, $show_flag_buttons, $PHP_SELF;
- global $lastTargetMailbox, $boxes;
-
- $php_self = $PHP_SELF;
-
- if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
- $source_url = $regs[1];
- } else {
- $source_url = $php_self;
- }
- $php_self = str_replace('&', '&', $php_self);
-
- if (!isset($msg)) {
- $msg = '';
- }
-
- $moveFields = addHidden('msg', $msg).
- addHidden('mailbox', $aMailbox['NAME']).
- addHidden('startMessage', $aMailbox['PAGEOFFSET']);
+ * 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
+ */
- /* build thread sorting links */
- $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;
+ /**
+ * 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;
}
- $thread_link_str = '<small>[<a href="' . $source_url . '?srt='
- . $sort . '&start_messages=1'
- . '&mailbox=' . urlencode($aMailbox['NAME']) . '">' . $thread_name
- . '</a>]</small>';
- } 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_]/", '_', $aMailbox['NAME']);
- $form_name = "FormMsgs" . $safe_name;
-
- echo '<form name="' . $form_name . '" method="post" action="'.$php_self.'">' ."\n"
- . $moveFields;
- echo '<table border="0" width="100%" cellpadding="0" cellspacing="0"><tr><td>';
-
- $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 .= '<input type="checkbox" name="bypass_trash" />' . _("Bypass Trash");
- $button_str .= " \n";
+ $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 (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY') {
- $button_str .= getButton('submit', 'expungeButton',_("Expunge")) .' ' . _("mailbox") . "\n";
- $button_str .= ' ';
+ $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 {
+ $aInitQuery = false;
}
-?>
- <table width="100%" cellpadding="1" cellspacing="0" style="border: 1px solid <?php echo $color[0]; ?>">
- <tr>
- <td>
- <table bgcolor="<?php echo $color[4]; ?>" border="0" width="100%" cellpadding="1" cellspacing="0">
- <tr>
- <?php echo html_tag('td', '<small>' . $paginator . $thread_link_str . '</small>', 'left') . "\n"; ?>
- <?php echo html_tag('td', ' ', 'center') . "\n"; ?>
- <?php echo html_tag('td', '<small>' . $msg_cnt_str . '</small>', 'right') . "\n"; ?>
- </tr>
- </table>
- </td>
- </tr>
- <tr bgcolor="<?php echo $color[0]; ?>">
- <td>
- <table border="0" width="100%" cellpadding="1" cellspacing="0">
- <tr>
- <?php echo html_tag('td', '', 'left') . "\n"; ?>
- <small>
- <?php echo $button_str; ?>
- <?php do_hook('mailbox_display_buttons'); ?>
- </small>
- </td>
- <?php
- if (in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) {
- ?>
- <?php echo html_tag('td', '', 'right'); ?>
- <small> <tt>
- <select name="targetMailbox">
- <?php echo sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes); ?>
- </select></tt>
- <?php echo getButton('submit', 'moveButton',_("Move")); ?>
- </small>
- <?php
- }
- ?>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
-</td></tr>
-<?php
- do_hook('mailbox_form_before');
-}
-/**
- * Function to add the last row in a message list, it contains the paginator and info about
- * the number of messages.
- *
- * @param array $aMailbox associative array with mailbox related information
- * @param string $paginator_str Paginator string [Prev | Next] [ 1 2 3 ... 91 92 94 ] [Show all]
- * @param string $msg_cnt_str Message count string Viewing Messages: 21 to 1861 (20 total)
- */
-function mail_message_listing_end($aMailbox, $paginator_str, $msg_cnt_str) {
- global $color;
-
- if ($aMailbox['EXISTS']) {
- /* space between list and footer */
-
-?>
-<tr><td height="5" bgcolor="<?php echo $color[4]; ?>" colspan="1"></td></tr>
-<tr>
- <td>
- <table width="100%" cellpadding="1" cellspacing="0" style="border: 1px solid <?php echo $color[0]; ?>">
- <tr>
- <td>
- <table bgcolor="<?php echo $color[4]; ?>" border="0" width="100%" cellpadding="1" cellspacing="0">
- <tr>
- <?php echo html_tag('td', '<small>' . $paginator_str . '</small>', 'left'); ?>
- <?php echo html_tag('td', '<small>' . $msg_cnt_str . '</small>', 'right'); ?>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- </td>
-</tr>
-<?php
-}
- /* End of message-list table */
-
- do_hook('mailbox_index_after');
-}
-
-/**
- * Prints the table header for the messages list view
- *
- * @param array $aMailbox
- */
-function printHeader($aMailbox) {
- global $index_order, $internal_date_sort, $color;
-
- if ($aMailbox['SORT_METHOD'] != 'THREAD') {
- $showsort = true;
+ if ($aMailbox['SORT'] & SQSORT_THREAD) {
+ $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']];
+ $bThread = true;
} else {
- $showsort = false;
+ $bThread = false;
+ }
+ /*
+ * Retrieve value for checkbox column
+ */
+ if (!sqgetGlobalVar('checkall',$checkall,SQ_GET)) {
+ $checkall = false;
}
- echo html_tag( 'tr' ,'' , 'center', $color[5] );
+ /*
+ * 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])) {
- /* calculate the width of the subject column based on the
- * widths of the other columns */
- $widths = array(1=>1,2=>25,3=>5,4=>0,5=>1,6=>5);
- $subjectwidth = 100;
- foreach($index_order as $item) {
- $subjectwidth -= $widths[$item];
- }
+ $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";
+ }
- foreach ($index_order as $item) {
- switch ($item) {
- case 1: /* checkbox */
- 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($aMailbox['NAME'])) {
- echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
- . '<b>' . _("To") . '</b>';
- if ($showsort) {
- ShowSortButton($aMailbox, SQSORT_TO_ASC, SQSORT_TO_DEC);
- }
- } else {
- echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
- . '<b>' . _("From") . '</b>';
- if ($showsort) {
- ShowSortButton($aMailbox, SQSORT_FROM_ASC, SQSORT_FROM_DEC);
+ 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 = truncateWithEntities($sTmp, $aColumnDesc[$k]['truncate']);
+ if ($sTrunc != $sTmp) {
+ if (!$title) {
+ $title = htmlspecialchars($sTmp);
+ } else if ($title_maybe) {
+ $title = $title .', '.$title_maybe;
+ $title = substr($title,0,-2); // strip ', ';
+ }
+ }
+ $sTmp = $sTrunc;
+ }
+ }
+ $value = ($sTmp) ? $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 = truncateWithEntities($value, $aColumnDesc[$k]['truncate']-$iIndent);
+ // 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)
+ do_hook('subject_link', array($iPageOffset, $sSearch, $aSearch));
+ }
+ $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,
+ 'flagged' => false,
+ 'draft' => false);
+
+ if(!is_array($value)) $value = array();
+ foreach ($value as $sFlag => $value) {
+ switch ($sFlag) {
+ case '\\seen' : $aFlagColumn['seen'] = true; break;
+ case '\\deleted' : $aFlagColumn['deleted'] = true; break;
+ case '\\answered': $aFlagColumn['answered'] = 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;
+ 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;
}
- echo "</td>\n";
- break;
- case 3: /* date */
- echo html_tag( 'td' ,'' , 'left', '', 'width="5%" style="white-space: nowrap;"' )
- . '<b>' . _("Date") . '</b>';
- if ($showsort) {
- if ($internal_date_sort) {
- ShowSortButton($aMailbox, SQSORT_INT_DATE_ASC, SQSORT_INT_DATE_DEC);
- } else {
- ShowSortButton($aMailbox, SQSORT_DATE_ASC, SQSORT_DATE_DEC);
+ /* 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]);
}
}
- echo "</td>\n";
- break;
- case 4: /* subject */
- echo html_tag( 'td' ,'' , 'left', '', 'width="'.$subjectwidth.'%"' )
- . '<b>' . _("Subject") . '</b>';
- if ($showsort) {
- ShowSortButton($aMailbox, SQSORT_SUBJ_ASC, SQSORT_SUBJ_DEC);
- }
- echo "</td>\n";
- break;
- case 6: /* size */
- echo html_tag( 'td', '', 'center','','width="5%" style="white-space: nowrap;"')
- . '<b>' . _("Size") . '</b>';
- if ($showsort) {
- ShowSortButton($aMailbox, SQSORT_SIZE_ASC, SQSORT_SIZE_DEC);
- }
- echo "</td>\n";
+ $aFormattedMessages[$iUid]['columns'] = $aColumns;
+
+ } else {
break;
}
}
- echo "</tr>\n";
+ return $aFormattedMessages;
}
/**
- * This function shows the sort button. Isn't this a good comment?
+ * Sets the row color if the provided column value pair matches a hightlight rule
*
- * @param array $aMailbox
- * @param integer $Down
- * @param integer $Up
+ * @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 ShowSortButton($aMailbox, $Down, $Up ) {
- global $PHP_SELF;
-
- /* Figure out which image we want to use. */
- if ($aMailbox['SORT'] != $Up && $aMailbox['SORT'] != $Down) {
- $img = 'sort_none.png';
- $which = $Up;
- } elseif ($aMailbox['SORT'] == $Up) {
- $img = 'up_pointer.png';
- $which = $Down;
- } else {
- $img = 'down_pointer.png';
- $which = 0;
+function highlightMessage($sCol, $sVal, $highlight_list, &$aFormat) {
+ if (!is_array($highlight_list) && count($highlight_list) == 0) {
+ return false;
}
+ $hlt_color = false;
+ $sCol = strtoupper($sCol);
- if (preg_match('/^(.+)\?.+$/',$PHP_SELF,$regs)) {
- $source_url = $regs[1];
+ 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;
+ }
+ }
+ }
+ if ($hlt_color) {
+ // Bug in highlight color???
+ if ($hlt_color{0} != '#') {
+ $hlt_color = '#'. $hlt_color;
+ }
+ $aFormat['row']['color'] = $hlt_color;
+ return true;
} else {
- $source_url = $PHP_SELF;
+ return false;
}
+}
- /* Now that we have everything figured out, show the actual button. */
- echo ' <a href="' . $source_url .'?srt=' . $which
- . '&startMessage=1&mailbox=' . urlencode($aMailbox['NAME'])
- . '"><img src="../images/' . $img
- . '" border="0" width="12" height="10" alt="sort" title="'
- . _("Click here to change the sorting of the message list") .'" /></a>';
+function setUserPref($username, $pref, $value) {
+ global $data_dir;
+ setPref($data_dir,$username,$pref,$value);
}
/**
- * FIXME: Undocumented function
+ * Execute the sorting for a mailbox
*
- * @param array $aMailbox
+ * @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_selectall_link($aMailbox) {
- global $checkall, $javascript_on;
- global $PHP_SELF;
-
- $result = '';
- if ($javascript_on) {
- $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
- $func_name = "CheckAll" . $safe_name;
- $form_name = "FormMsgs" . $safe_name;
- $result = '<script language="JavaScript" type="text/javascript">'
- . "\n<!-- \n"
- . "function " . $func_name . "() {\n"
- . " for (var i = 0; i < document." . $form_name . ".elements.length; i++) {\n"
- . " if(document." . $form_name . ".elements[i].type == 'checkbox' && "
- . " document." . $form_name . ".elements[i].name.substring(0,3) == 'msg'){\n"
- . " document." . $form_name . ".elements[i].checked = "
- . " !(document." . $form_name . ".elements[i].checked);\n"
- . " }\n"
- . " }\n"
- . "}\n"
- . "//-->\n"
- . '</script>'
- . '<input type="checkbox" name="toggleAll" title="'._("Toggle All").'" onclick="'.$func_name.'();" />';
-// . <a href="javascript:void(0)" onclick="' . $func_name . '();">' . _("Toggle All")
-// . "</a>\n";
- } else {
- $result .= "<a href=\"$PHP_SELF";
- // FIXME: why strpos() is used to detect presense of the symbol in the string.
- // Function returns boolean value only when symbol is not found
- if (strpos($PHP_SELF, "?")) {
- $prefix = '&';
+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';
+ }
+ 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 {
- $prefix = '?';
- }
-
- // If variables are part of GET request, they are present in $PHP_SELF
- // maybe other functions can be used instead of sqgetGlobalVar (like preg_match)
- if (! sqgetGlobalVar('mailbox',$tmp,SQ_GET)) {
- $result .= $prefix . 'mailbox=' . urlencode($aMailbox['NAME']);
- $prefix = '&';
- }
- if (! sqgetGlobalVar('startMessage',$tmp,SQ_GET)) {
- $result .= $prefix . 'startMessage=' . $aMailbox['PAGEOFFSET'];
- $prefix = '&';
- }
- if (! sqgetGlobalVar('str',$tmp,SQ_GET)) {
- $result .= $prefix . 'str=' . $aMailbox['SORT'];
- $prefix = '&';
+ $aMailbox['UIDSET'][$iSetIndx] = $aRes[0];
+ $aMailbox['THREAD_INDENT'][$iSetIndx] = $aRes[1];
}
-
- if (isset($checkall) && $checkall == '1') {
- $checkall_val = '0';
+ } else if ($aMailbox['SORT'] === SQSORT_NONE) {
+ $id = sqimap_run_search($imapConnection, 'ALL' , '');
+ if ($id === false) {
+ $error = 1; // fix me, define an error code
} else {
- $checkall_val = '1';
+ $aMailbox['UIDSET'][$iSetIndx] = array_reverse($id);
+ $aMailbox['TOTAL'][$iSetIndx] = $aMailbox['EXISTS'];
}
- if (! sqgetGlobalVar('checkall',$tmp,SQ_GET) ) {
- $result .= $prefix . 'checkall=' . $checkall_val;
- $prefix = '&';
+ } else {
+ 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 {
- // checkall is already present in php_self. replace it
- $result = preg_replace("/checkall=(\d)/","checkall=$checkall_val",$result);
- }
-
- // FIXME: I suspect that search pages use different variables in 1.5.1cvs
- // and these variables are present in $PHP_SELF.
- if (isset($aMailbox['SEARCH']) && isset($aMailbox['SEARCH'][0]) && ! sqgetGlobalVar('where',$tmp,SQ_GET)) {
- $result .= '&where=' . urlencode($aMailbox['SEARCH'][0]);
- if (isset($aMailbox['SEARCH'][1]) && ! sqgetGlobalVar('what',$tmp,SQ_GET)) {
- $result .= '&what=' . urlencode($aMailbox['SEARCH'][1]);
- }
+ $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);
}
- $result .= "\">";
- $result .= _("All");
- $result .= "</a>\n";
- }
-
- /* Return our final result. */
- return ($result);
-}
-
-/**
- * This function computes the "Viewing Messages..." string.
- *
- * @param integer $start_msg first message number
- * @param integer $end_msg last message number
- * @param integer $num_msgs total number of message in folder
- * @return 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: %s to %s (%s total)"),
- '<b>'.$start_msg.'</b>', '<b>'.$end_msg.'</b>', $num_msgs);
- } else if ($start_msg == $end_msg) {
- $result = sprintf(_("Viewing Message: %s (%s total)"), '<b>'.$start_msg.'</b>', $num_msgs);
- } else {
- $result = '<br />';
}
- /* Return our result string. */
- return ($result);
+ return $error;
}
/**
- * Generate a paginator link.
+ * Does the $srt $_GET var to field mapping
*
- * @param mixed $box Mailbox name
- * @param mixed $start_msg Message Offset
- * @param mixed $use
- * @param string $text text used for paginator link
- * @return string
+ * @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 get_paginator_link($box, $start_msg, $text) {
- sqgetGlobalVar('PHP_SELF',$php_self,SQ_SERVER);
- $result = "<a href=\"$php_self?startMessage=$start_msg&mailbox=$box\" "
- . ">$text</a>";
+function _getSortField($sort,$bServerSort) {
+ switch($sort) {
+ case SQSORT_NONE:
+ $sSortField = 'UID';
+ break;
+ case SQSORT_DATE_ASC:
+ case SQSORT_DATE_DESC:
+ $sSortField = 'DATE';
+ break;
+ case SQSORT_FROM_ASC:
+ case SQSORT_FROM_DESC:
+ $sSortField = 'FROM';
+ break;
+ case SQSORT_SUBJ_ASC:
+ case SQSORT_SUBJ_DESC:
+ $sSortField = 'SUBJECT';
+ break;
+ case SQSORT_SIZE_ASC:
+ case SQSORT_SIZE_DESC:
+ $sSortField = ($bServerSort) ? 'SIZE' : 'RFC822.SIZE';
+ break;
+ 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;
- return ($result);
+ }
+ return $sSortField;
}
/**
- * This function computes the paginator string.
+ * 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 string $box mailbox name
- * @param integer $iOffset offset in total number of messages
- * @param integer $iTotal total number of messages
- * @param integer $iLimit maximum number of messages to show on a page
- * @param bool $bShowAll show all messages at once (non paginate mode)
- * @return string $result paginate string with links to pages
+ * @param array $aMailbox associative array with mailbox related vars
+ * @param array $aProps
+ * @return void
+ * @since 1.5.1
*/
-function get_paginator_str($box, $iOffset, $iTotal, $iLimit, $bShowAll) {
- global $username, $data_dir, $javascript_on;
- // page selector globals
- global $page_selector, $page_selector_max, $compact_paginator;
- sqgetGlobalVar('PHP_SELF',$php_self,SQ_SERVER);
-
- /* Initialize paginator string chunks. */
- $prv_str = '';
- $nxt_str = '';
- $pg_str = '';
- $all_str = '';
-
- $box = urlencode($box);
-
- /* 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. */
-
- /* Make sure that our start message number is not too big. */
- $iOffset = min($iOffset, $iTotal);
-
- /* Compute the starting message of the previous and next page group. */
- $next_grp = $iOffset + $iLimit;
- $prev_grp = $iOffset - $iLimit;
-
- if (!$bShowAll) {
- /* Compute the basic previous and next strings. */
- if ($compact_paginator) {
- if (($next_grp <= $iTotal) && ($prev_grp >= 0)) {
- $prv_str = get_paginator_link($box, $prev_grp, '<');
- $nxt_str = get_paginator_link($box, $next_grp, '>');
- } else if (($next_grp > $iTotal) && ($prev_grp >= 0)) {
- $prv_str = get_paginator_link($box, $prev_grp, '<');
- $nxt_str = '>';
- } else if (($next_grp <= $iTotal) && ($prev_grp < 0)) {
- $prv_str = '<';
- $nxt_str = get_paginator_link($box, $next_grp, '>');
- }
- } else {
- if (($next_grp <= $iTotal) && ($prev_grp >= 0)) {
- $prv_str = get_paginator_link($box, $prev_grp, _("Previous"));
- $nxt_str = get_paginator_link($box, $next_grp, _("Next"));
- } else if (($next_grp > $iTotal) && ($prev_grp >= 0)) {
- $prv_str = get_paginator_link($box, $prev_grp, _("Previous"));
- $nxt_str = _("Next");
- } else if (($next_grp <= $iTotal) && ($prev_grp < 0)) {
- $prv_str = _("Previous");
- $nxt_str = get_paginator_link($box, $next_grp, _("Next"));
- }
- }
-
- /* Page selector block. Following code computes page links. */
- if ($iLimit != 0 && $page_selector && ($iTotal > $iLimit)) {
- /* Most importantly, what is the current page!!! */
- $cur_pg = intval($iOffset / $iLimit) + 1;
-
- /* Compute total # of pages and # of paginator page links. */
- $tot_pgs = ceil($iTotal / $iLimit); /* Total number of Pages */
- if (!$compact_paginator) {
- $vis_pgs = min($page_selector_max, $tot_pgs - 1); /* Visible Pages */
+function calcFetchColumns(&$aMailbox, &$aProps) {
- /* Compute the size of the four quarters of the page links. */
+ $highlight_list = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
+ $aColumnsDesc = (isset($aProps['columns'])) ? $aProps['columns'] : false;
- /* If we can, just show all the pages. */
- if (($tot_pgs - 1) <= $page_selector_max) {
- $q1_pgs = $cur_pg - 1;
- $q2_pgs = $q3_pgs = 0;
- $q4_pgs = $tot_pgs - $cur_pg;
+ $aFetchColumns = $aColumnsDesc;
+ if (isset($aFetchColumns[SQM_COL_CHECK])) {
+ unset($aFetchColumns[SQM_COL_CHECK]);
+ }
- /* Otherwise, compute some magic to choose the four quarters. */
- } 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) * 3/4);
- $q2_pgs = ceil(($cur_pg - $q1_pgs - 1) * 3/4);
- $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) * 3/4);
- $q3_pgs = ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
- $q1_pgs += floor($extra_pgs / 2);
- $q2_pgs += ceil($extra_pgs / 2);
- }
+ /*
+ * 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;
}
+ }
+ }
+ $aExtraColumns = array();
+ foreach ($aHighlightColumns as $k => $v) {
+ if (!isset($aFetchColumns[$k])) {
+ $aExtraColumns[] = $k;
+ $aFetchColumns[$k] = true;
+ }
+ }
+ if (count($aExtraColumns)) {
+ $aProps['extra_columns'] = $aExtraColumns;
+ }
+ }
+ $aMailbox['FETCHHEADERS'] = array_keys($aFetchColumns);
+}
- /*
- * 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) * $iLimit) + 1;
- $pg_str .= get_paginator_link($box, $start, $pg) . $spc;
- }
- if ($cur_pg - $q2_pgs - $q1_pgs > 1) {
- $pg_str .= "...$spc";
- }
- }
- /* Continue with the second quarter. */
- for ($pg = $cur_pg - $q2_pgs; $pg < $cur_pg; ++$pg) {
- $start = (($pg-1) * $iLimit) + 1;
- $pg_str .= get_paginator_link($box, $start, $pg) . $spc;
- }
+/**
+ * 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'];
- /* 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) * $iLimit) + 1;
- $pg_str .= get_paginator_link($box, $start, $pg) . $spc;
- }
+ /*
+ * Form ID
+ */
+ static $iFormId;
- /* 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) * $iLimit) + 1;
- $pg_str .= get_paginator_link($box, $start,$pg) . $spc;
- }
- }
- }
- $last_grp = (($tot_pgs - 1) * $iLimit) + 1;
- }
+ if (!isset($iFormId)) {
+ $iFormId=1;
} else {
- $pg_str = "<a href=\"$php_self?showall=0"
- . "&startMessage=1&mailbox=$box\" "
- . ">" ._("Paginate") . '</a>';
+ ++$iFormId;
}
+ // store the columns to fetch so we can pick them up in read_body
+ // where we validate the cache.
+ calcFetchColumns($aMailbox ,$aProps);
- /* 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 = '';
- if ( $prv_str || $nxt_str ) {
-
- /* Compute the 'show all' string. */
- $all_str = "<a href=\"$php_self?showall=1"
- . "&startMessage=1&mailbox=$box\" "
- . ">" . _("Show All") . '</a>';
+ $iError = fetchMessageHeaders($imapConnection, $aMailbox);
+ if ($iError) {
+ return array();
+ } else {
+ $aMessages = prepareMessageList($aMailbox, $aProps);
}
- if ($compact_paginator) {
- if ( $prv_str || $nxt_str ) {
- $result .= '[' . get_paginator_link($box, 1, '<<') . ']';
- $result .= '[' . $prv_str . ']';
+ $iSetIndx = $aMailbox['SETINDEX'];
+ $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
+ $iEnd = ($aMailbox['PAGEOFFSET'] + ($iLimit - 1) < $aMailbox['EXISTS']) ?
+ $aMailbox['PAGEOFFSET'] + $iLimit - 1 : $aMailbox['EXISTS'];
- $pg_url = $php_self . '?mailbox=' . $box;
+ $iNumberOfMessages = $aMailbox['TOTAL'][$iSetIndx];
+ $iEnd = min ( $iEnd, $iNumberOfMessages );
- $result .= '[' . $nxt_str . ']';
- $result .= '[' . get_paginator_link($box, $last_grp, '>>') . ']';
+ $php_self = $PHP_SELF;
- if ($page_selector) {
- $result .= $spc . '<select name="startMessage"';
- if ($javascript_on) {
- $result .= ' onchange="JavaScript:SubmitOnSelect'
- . '(this, \'' . $pg_url . '&startMessage=\')"';
- }
- $result .='>';
+ $urlMailbox = urlencode($aMailbox['NAME']);
- for ($p = 0; $p < $tot_pgs; $p++) {
- $result .= '<option ';
- if (($p+1) == $cur_pg) $result .= 'selected ';
- $result .= 'value="' . (($p*$iLimit)+1) . '">'
- . ($p+1) . "/$tot_pgs" . '</option>';
- }
+ if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
+ $source_url = $regs[1];
+ } else {
+ $source_url = $php_self;
+ }
- $result .= '</select>';
+ $baseurl = $source_url.'?mailbox=' . urlencode($aMailbox['NAME']) .'&account='.$aMailbox['ACCOUNT'];
+ $where = urlencode($aMailbox['SEARCH'][$iSetIndx][0]);
+ $what = urlencode($aMailbox['SEARCH'][$iSetIndx][1]);
+ $baseurl .= '&where=' . $where . '&what=' . $what;
- if ($javascript_on) {
- $result .= '<noscript language="JavaScript">'
- . addSubmit(_("Go"))
- . '</noscript>';
- } else {
- $result .= addSubmit(_("Go"));
- }
- }
+ /* 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 {
+ $thread_name = _("Thread View");
+ $newsort = $aMailbox['SORT'] + SQSORT_THREAD;
}
-
- $result .= ($pg_str != '' ? '['.$pg_str.']' . $spc : '');
- $result .= ($all_str != '' ? $spc . '['.$all_str.']' . $spc . $spc : '');
+ $thread_link_str = '<small>[<a href="' . $baseurl . '&srt='
+ . $newsort . '&startMessage=1">' . $thread_name
+ . '</a>]</small>';
} else {
- if ( $prv_str || $nxt_str ) {
- $result .= '[';
- $result .= ($prv_str != '' ? $prv_str . $spc . $sep . $spc : '');
- $result .= ($nxt_str != '' ? $nxt_str : '');
- $result .= ']' . $spc ;
- }
-
- $result .= ($pg_str != '' ? $spc . '['.$spc.$pg_str.']' . $spc : '');
- $result .= ($all_str != '' ? $spc . '['.$all_str.']' . $spc . $spc : '');
- }
- /* If the resulting string is blank, return a non-breaking space. */
- if ($result == '') {
- $result = ' ';
+ $thread_link_str ='';
}
- /* Return our final magical paginator string. */
- return ($result);
-}
+ $sort = $aMailbox['SORT'];
-/**
- * FIXME: Undocumented function
- */
-function truncateWithEntities($subject, $trim_at)
-{
- $ent_strlen = strlen($subject);
- if (($trim_at <= 0) || ($ent_strlen <= $trim_at))
- return $subject;
+ /* FIX ME ADD CHECKBOX CONTROL. No checkbox => no buttons */
+
+
+
+ /* future admin control over displayable buttons */
+ $aAdminControl = array(
+ 'markUnflagged' => 1,
+ 'markFlagged' => 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 (
+
+ 'markUnflagged' => $show_flag_buttons,
+ 'markFlagged' => $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) ? 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(
+ 'markUnflagged' => _("Unflag"),
+ 'markFlagged' => _("Flag"),
+ 'markRead' => _("Read"),
+ 'markUnread' => _("Unread"),
+ 'forward' => _("Forward"),
+ 'delete' => _("Delete"),
+ 'undeleteButton' => _("Undelete"),
+ 'bypass_trash' => _("Bypass Trash"),
+ 'expungeButton' => _("Expunge"),
+ 'moveButton' => _("Move"),
+ 'copyButton' => _("Copy")
+ );
- global $languages, $squirrelmail_language;
- /*
- * 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 $trim_at, substr with an updated trim value.
+ /**
+ * 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.
*/
- $trim_val = $trim_at;
- $ent_offset = 0;
- $ent_loc = 0;
- while ( $ent_loc < $trim_val && (($ent_loc = strpos($subject, '&', $ent_offset)) !== false) &&
- (($ent_loc_end = strpos($subject, ';', $ent_loc+3)) !== false) ) {
- $trim_val += ($ent_loc_end-$ent_loc);
- $ent_offset = $ent_loc_end+1;
- }
- if (($trim_val > $trim_at) && ($ent_strlen > $trim_val) && (strpos($subject,';',$trim_val) < ($trim_val + 6))) {
- $i = strpos($subject,';',$trim_val);
- if ($i) {
- $trim_val = strpos($subject,';',$trim_val);
+ $aFormElements = array();
+ foreach($aAdminControl as $k => $v) {
+ if ($v & $aUserControl[$k] & $aImapControl[$k]) {
+ switch ($k) {
+ case 'markUnflagged':
+ case 'markFlagged':
+ case 'markRead':
+ case 'markUnread':
+ case 'delete':
+ case 'undeleteButton':
+ case 'expungeButton':
+ case 'forward':
+ $aFormElements[$k] = array($aButtonStrings[$k],'submit');
+ break;
+ case 'bypass_trash':
+ $aFormElements[$k] = array($aButtonStrings[$k],'checkbox');
+ break;
+ case 'moveButton':
+ case 'copyButton':
+ $aFormElements['targetMailbox'] =
+ array(sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes),'select');
+ $aFormElements['mailbox'] = array($aMailbox['NAME'],'hidden');
+ $aFormElements['startMessage'] = array($aMailbox['PAGEOFFSET'],'hidden');
+ $aFormElements[$k] = array($aButtonStrings[$k],'submit');
+ break;
+ }
}
+ $aFormElements['account'] = array($iAccount,'hidden');
}
- // only print '...' when we're actually dropping part of the subject
- if ($ent_strlen <= $trim_val)
- return $subject;
- if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
- function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth')) {
- return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth', $subject, $trim_val);
- }
+ /*
+ * 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;
- return substr_replace($subject, '...', $trim_val + 1);
+ //if (!sqgetGlobalVar('align',$align,SQ_SESSION)) {
+ $align = array('left' => 'left', 'right' => 'right');
+ //}
+ //sm_print_r($align);
+
+ /* finally set the template vars */
+
+ // FIX ME, before we support multiple templates we must review the names of the vars
+
+
+ $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_str'] = $thread_link_str;
+ $aTemplate['php_self'] = str_replace('&','&',$php_self);
+ $aTemplate['mailbox'] = $sMailbox;
+ $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;
+
+
+ return $aTemplate;
}
+
/**
- * FIXME: Undocumented function
+ * Truncates a string and take care of html encoded characters
+ *
+ * @param string $s string to truncate
+ * @param int $iTrimAt Trim at nn characters
+ * @return string Trimmed string
*/
-function processSubject($subject, $threadlevel = 0) {
- /* Shouldn't ever happen -- caught too many times in the IMAP functions */
- if ($subject == '') {
- return _("(no subject)");
- }
-
- global $truncate_subject; /* number of characters for Subject field (<= 0 for unchanged) */
- $trim_at = $truncate_subject;
-
- /* if this is threaded, subtract two chars per indentlevel */
- if (($threadlevel > 0) && ($threadlevel <= 10))
- $trim_at -= (2*$threadlevel);
+function truncateWithEntities($s, $iTrimAt) {
+ global $languages, $squirrelmail_language;
- return truncateWithEntities($subject, $trim_at);
-}
+ $ent_strlen = strlen($s);
+ if (($iTrimAt <= 0) || ($ent_strlen <= $iTrimAt))
+ return $s;
+ if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
+ function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth')) {
+ return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth', $s, $iTrimAt);
+ } else {
+ /*
+ * 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 $iTrimAt, substr with an updated trim value.
+ */
+ $trim_val = $iTrimAt;
+ $ent_offset = 0;
+ $ent_loc = 0;
+ while ( $ent_loc < $trim_val && (($ent_loc = strpos($s, '&', $ent_offset)) !== false) &&
+ (($ent_loc_end = strpos($s, ';', $ent_loc+3)) !== false) ) {
+ $trim_val += ($ent_loc_end-$ent_loc);
+ $ent_offset = $ent_loc_end+1;
+ }
-/**
- * Creates button
- *
- * @deprecated see form functions available in 1.5.1 and 1.4.3.
- * @param string $type
- * @param string $name
- * @param string $value
- * @param string $js
- * @param bool $enabled
- */
-function getButton($type, $name, $value, $js = '', $enabled = TRUE) {
- $disabled = ( $enabled ? '' : 'disabled ' );
- $js = ( $js ? $js.' ' : '' );
- return '<input '.$disabled.$js.
- 'type="'.$type.
- '" name="'.$name.
- '" value="'.$value .
- '" style="padding: 0px; margin: 0px" />';
+ if (($trim_val > $iTrimAt) && ($ent_strlen > $trim_val) && (strpos($s,';',$trim_val) < ($trim_val + 6))) {
+ $i = strpos($s,';',$trim_val);
+ if ($i !== false) {
+ $trim_val = strpos($s,';',$trim_val)+1;
+ }
+ }
+ // only print '...' when we're actually dropping part of the subject
+ if ($ent_strlen <= $trim_val)
+ return $s;
+ }
+ return substr_replace($s, '...', $trim_val);
}
-/**
- * Puts string into cell, aligns it and adds <small> tag
- *
- * @param string $string string
- * @param string $align alignment
- */
-function getSmallStringCell($string, $align) {
- return html_tag('td',
- '<small>' . $string . ': </small>',
- $align,
- '',
- 'style="white-space: nowrap;"' );
-}
/**
* This should go in imap_mailbox.php
* @param string $sButton fake a submit button
* @param array $aUid fake the $msg array
* @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()) {
-
/* incoming formdata */
$sButton = (sqgetGlobalVar('moveButton', $sTmp, SQ_POST)) ? 'move' : $sButton;
+ $sButton = (sqgetGlobalVar('copyButton', $sTmp, SQ_POST)) ? 'copy' : $sButton;
$sButton = (sqgetGlobalVar('expungeButton', $sTmp, SQ_POST)) ? 'expunge' : $sButton;
- $sButton = (sqgetGlobalVar('attache', $sTmp, SQ_POST)) ? 'attache' : $sButton;
+ $sButton = (sqgetGlobalVar('forward', $sTmp, SQ_POST)) ? 'forward' : $sButton;
$sButton = (sqgetGlobalVar('delete', $sTmp, SQ_POST)) ? 'setDeleted' : $sButton;
- $sButton = (sqgetGlobalVar('undeleteButton', $sTmp, SQ_POST)) ? 'setDeleted' : $sButton;
+ $sButton = (sqgetGlobalVar('undeleteButton', $sTmp, SQ_POST)) ? 'unsetDeleted' : $sButton;
$sButton = (sqgetGlobalVar('markRead', $sTmp, SQ_POST)) ? 'setSeen' : $sButton;
$sButton = (sqgetGlobalVar('markUnread', $sTmp, SQ_POST)) ? 'unsetSeen' : $sButton;
$sButton = (sqgetGlobalVar('markFlagged', $sTmp, SQ_POST)) ? 'setFlagged' : $sButton;
sqgetGlobalVar('targetMailbox', $targetMailbox, SQ_POST);
sqgetGlobalVar('bypass_trash', $bypass_trash, SQ_POST);
sqgetGlobalVar('msg', $msg, SQ_POST);
-
+ if (sqgetGlobalVar('account', $iAccount, SQ_POST) === false) {
+ $iAccount = 0;
+ }
$sError = '';
$mailbox = $aMailbox['NAME'];
/* retrieve the check boxes */
$aUid = (isset($msg) && is_array($msg)) ? array_values($msg) : $aUid;
-
if (count($aUid) && $sButton != 'expunge') {
$aUpdatedMsgs = false;
$bExpunge = false;
}
$aUpdatedMsgs = sqimap_msgs_list_delete($imapConnection, $mailbox, $aUid,$bypass_trash);
$bExpunge = true;
+ //}
break;
case 'unsetDeleted':
case 'setSeen':
$aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
break;
case 'move':
- $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox);
+ $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox,true,$mailbox);
sqsession_register($targetMailbox,'lastTargetMailbox');
$bExpunge = true;
break;
- case 'attache':
+ 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];
}
break;
default:
- // Hook for plugin buttons
- do_hook_function('mailbox_display_button_action', $aUid);
- break;
+ // Hook for plugin buttons
+ do_hook_function('mailbox_display_button_action', $aUid);
+ break;
}
/**
* Updates messages is an array containing the result of the untagged
// update EXISTS info
if ($iExpungedMessages) {
$aMailbox['EXISTS'] -= (int) $iExpungedMessages;
+ $aMailbox['TOTAL'][$aMailbox['SETINDEX']] -= (int) $iExpungedMessages;
}
- // Change the startMessage number if the mailbox was changed
if (($aMailbox['PAGEOFFSET']-1) >= $aMailbox['EXISTS']) {
$aMailbox['PAGEOFFSET'] = ($aMailbox['PAGEOFFSET'] > $aMailbox['LIMIT']) ?
$aMailbox['PAGEOFFSET'] - $aMailbox['LIMIT'] : 1;
- $aMailbox['OFFSET'] = $aMailbox['PAGEOFFSET'] - 1 ;
+ $aMailbox['OFFSET'] = $aMailbox['PAGEOFFSET'] - 1 ;
}
}
}
/**
* 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);
- $aMbxResponse = sqimap_mailbox_select($imapConnection,$aMailbox['NAME']);
- // update the $aMailbox array
- $aMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
- $aMailbox['UIDSET'] = false;
+ $aMailbox = sqm_api_mailbox_select($imapConnection,$iAccount, $aMailbox['NAME'],array(),array());
} else {
if ($sButton) {
$sError = _("No messages were selected.");
return $sError;
}
+/**
+ * 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) {
global $username, $attachment_dir,
- $data_dir, $composesession,
- $compose_messages;
+ $data_dir;
- if (!isset($compose_messages)) {
+
+ 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');
}
* 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;
+
+ $subject = (isset($aMsgHeader['subject'])) ? $aMsgHeader['subject'] : $iUid;
array_shift($body_a);
array_pop($body_a);
sqsession_register($compose_messages,'compose_messages');
return $composesession;
}
-
-// vim: et ts=4
-?>
\ No newline at end of file