6 * This contains functions that display mailbox information, such as the
7 * table row that has sender, date, subject, etc...
9 * @copyright © 1999-2009 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @package squirrelmail
17 * Selects a mailbox for header retrieval.
18 * Cache control for message headers is embedded.
20 * @param resource $imapConnection imap socket handle
21 * @param string $mailbox mailbox to select and retrieve message headers from
22 * @param array $aConfig array with system config settings and incoming vars
23 * @param array $aProps mailbox specific properties
25 * @return array $aMailbox mailbox array with all relevant information
28 * @author Marc Groot Koerkamp
30 function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aProps) {
33 * NB: retrieve this from the session before accessing this function
34 * and make sure you write it back at the end of the script after
35 * the aMailbox var is added so that the headers are added to the cache
37 global $mailbox_cache;
39 $aDefaultConfigProps = array(
40 // 'charset' => 'US-ASCII',
41 'user' => false, /* no pref storage if false */
44 'max_cache_size' => SQM_MAX_MBX_IN_CACHE
47 $aConfig = array_merge($aDefaultConfigProps,$aConfig);
49 $iSetIndx = $aConfig['setindex'];
51 $aMbxResponse = sqimap_mailbox_select($imapConnection, $mailbox);
54 if (isset($mailbox_cache[$account.'_'.$mailbox])) {
55 $aCachedMailbox = $mailbox_cache[$account.'_'.$mailbox];
57 $aCachedMailbox = false;
60 if (count($mailbox_cache) > $aConfig['max_cache_size'] -1) {
62 foreach($mailbox_cache as $cachedmailbox => $aVal) {
63 $aTime[$aVal['TIMESTAMP']] = $cachedmailbox;
65 if (ksort($aTime,SORT_NUMERIC
)) {
66 for ($i=0,$iCnt=count($mailbox_cache);$i<($iCnt-$aConfig['max_cache_size']);++
$i) {
67 $sOldestMbx = array_shift($aTime);
69 * Remove only the UIDSET and MSG_HEADERS from cache because those can
70 * contain large amounts of data.
72 if (isset($mailbox_cache[$sOldestMbx]['UIDSET'])) {
73 $mailbox_cache[$sOldestMbx]['UIDSET']= false;
75 if (isset($mailbox_cache[$sOldestMbx]['MSG_HEADERS'])) {
76 $mailbox_cache[$sOldestMbx]['MSG_HEADERS'] = false;
83 $aCachedMailbox = false;
87 * Deal with imap servers that do not return the required UIDNEXT or
88 * UIDVALIDITY response
89 * from a SELECT call (since rfc 3501 it's required).
91 if (!isset($aMbxResponse['UIDNEXT']) ||
!isset($aMbxResponse['UIDVALIDITY'])) {
92 $aStatus = sqimap_status_messages($imapConnection,$mailbox,
93 array('UIDNEXT','UIDVALIDITY'));
94 $aMbxResponse['UIDNEXT'] = $aStatus['UIDNEXT'];
95 $aMbxResponse['UIDVALIDTY'] = $aStatus['UIDVALIDITY'];
98 $aMailbox['ACCOUNT'] = $account;
99 $aMailbox['UIDSET'][$iSetIndx] = false;
100 $aMailbox['ID'] = false;
101 $aMailbox['SETINDEX'] = $iSetIndx;
102 $aMailbox['MSG_HEADERS'] = false;
104 if ($aCachedMailbox) {
106 * Validate integrity of cached data
108 if ($aCachedMailbox['EXISTS'] == $aMbxResponse['EXISTS'] &&
109 $aMbxResponse['EXISTS'] &&
110 $aCachedMailbox['UIDVALIDITY'] == $aMbxResponse['UIDVALIDITY'] &&
111 $aCachedMailbox['UIDNEXT'] == $aMbxResponse['UIDNEXT'] &&
112 isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
113 (!isset($aConfig['search']) ||
/* always set search from the searchpage */
114 $aCachedMailbox['SEARCH'][$iSetIndx] == $aConfig['search'])) {
115 if (isset($aCachedMailbox['MSG_HEADERS'])) {
116 $aMailbox['MSG_HEADERS'] = $aCachedMailbox['MSG_HEADERS'];
118 $aMailbox['ID'] = $aCachedMailbox['ID'];
119 if (isset($aCachedMailbox['UIDSET'][$iSetIndx]) && $aCachedMailbox['UIDSET'][$iSetIndx]) {
120 if (isset($aProps[MBX_PREF_SORT
]) && $aProps[MBX_PREF_SORT
] != $aCachedMailbox['SORT'] ) {
121 $newsort = $aProps[MBX_PREF_SORT
];
122 $oldsort = $aCachedMailbox['SORT'];
124 * If it concerns a reverse sort we do not need to invalidate
125 * the cached sorted UIDSET, a reverse is sufficient.
127 if ((($newsort %
2) && ($newsort +
1 == $oldsort)) ||
128 (!($newsort %
2) && ($newsort - 1 == $oldsort))) {
129 $aMailbox['UIDSET'][$iSetIndx] = array_reverse($aCachedMailbox['UIDSET'][$iSetIndx]);
131 $server_sort_array = false;
132 $aMailbox['MSG_HEADERS'] = false;
133 $aMailbox['ID'] = false;
135 // store the new sort value in the mailbox pref
136 if ($aConfig['user']) {
137 // FIXME, in ideal situation, we write back the
138 // prefs at the end of the script
139 setUserPref($aConfig['user'],'pref_'.$account.'_'.$mailbox,serialize($aProps));
142 $aMailbox['UIDSET'][$iSetIndx] = $aCachedMailbox['UIDSET'][$iSetIndx];
148 * Restore the offset in the paginator if no new offset is provided.
150 if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['offset']) && $aCachedMailbox['OFFSET']) {
151 $aMailbox['OFFSET'] = $aCachedMailbox['OFFSET'];
152 $aMailbox['PAGEOFFSET'] = $aCachedMailbox['PAGEOFFSET'];
154 $aMailbox['OFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ?
$aConfig['offset'] -1 : 0;
155 $aMailbox['PAGEOFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ?
$aConfig['offset'] : 1;
158 * Restore the number of messages in the result set
160 if (isset($aCachedMailbox['TOTAL'][$iSetIndx]) && $aCachedMailbox['TOTAL'][$iSetIndx]) {
161 $aMailbox['TOTAL'][$iSetIndx] = $aCachedMailbox['TOTAL'][$iSetIndx];
165 * Restore the showall value no new showall value is provided.
167 if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['showall']) &&
168 isset($aCachedMailbox['SHOWALL'][$iSetIndx]) && $aCachedMailbox['SHOWALL'][$iSetIndx]) {
169 $aMailbox['SHOWALL'][$iSetIndx] = $aCachedMailbox['SHOWALL'][$iSetIndx];
171 $aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ?
1 : 0;
175 * Restore the sort order if no new sort order is provided.
177 if (!isset($aProps[MBX_PREF_SORT
]) && isset($aCachedMailbox['SORT'])) {
178 $aMailbox['SORT'] = $aCachedMailbox['SORT'];
180 $aMailbox['SORT'] = (isset($aProps[MBX_PREF_SORT
])) ?
$aProps[MBX_PREF_SORT
] : 0;
184 * Restore the number of message to show per page when no new limit is provided
186 if (!isset($aProps[MBX_PREF_LIMIT
]) && isset($aCachedMailbox['LIMIT'])) {
187 $aMailbox['LIMIT'] = $aCachedMailbox['LIMIT'];
189 $aMailbox['LIMIT'] = (isset($aProps[MBX_PREF_LIMIT
])) ?
$aProps[MBX_PREF_LIMIT
] : 15;
193 * Restore the ordered columns to show when no new ordered columns are provided
195 if (!isset($aProps[MBX_PREF_COLUMNS
]) && isset($aCachedMailbox['COLUMNS'])) {
196 $aMailbox['COLUMNS'] = $aCachedMailbox['COLUMNS'];
198 $aMailbox['COLUMNS'] = (isset($aProps[MBX_PREF_COLUMNS
])) ?
$aProps[MBX_PREF_COLUMNS
] :
199 array(SQM_COL_FLAGS
,SQM_COL_FROM
, SQM_COL_SUBJ
, SQM_COL_FLAGS
);
203 * Restore the headers we fetch the last time. Saves intitialisation stuff in read_body.
205 $aMailbox['FETCHHEADERS'] = (isset($aCachedMailbox['FETCHHEADERS'])) ?
$aCachedMailbox['FETCHHEADERS'] : null;
207 if (!isset($aProps[MBX_PREF_AUTO_EXPUNGE
]) && isset($aCachedMailbox['AUTO_EXPUNGE'])) {
208 $aMailbox['AUTO_EXPUNGE'] = $aCachedMailbox['AUTO_EXPUNGE'];
210 $aMailbox['AUTO_EXPUNGE'] = (isset($aProps[MBX_PREF_AUTO_EXPUNGE
])) ?
$aProps[MBX_PREF_AUTO_EXPUNGE
] : false;
212 if (!isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx])) {
213 $aMailbox['SEARCH'][$iSetIndx] = $aCachedMailbox['SEARCH'][$iSetIndx];
214 } else if (isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
215 $aConfig['search'] != $aCachedMailbox['SEARCH'][$iSetIndx]) {
216 // reset the pageindex
217 $aMailbox['SEARCH'][$iSetIndx] = $aConfig['search'];
218 $aMailbox['OFFSET'] = 0;
219 $aMailbox['PAGEOFFSET'] = 1;
221 $aMailbox['SEARCH'][$iSetIndx] = (isset($aConfig['search'])) ?
$aConfig['search'] : 'ALL';
223 if (!isset($aConfig['charset']) && isset($aCachedMailbox['CHARSET'][$iSetIndx])) {
224 $aMailbox['CHARSET'][$iSetIndx] = $aCachedMailbox['CHARSET'][$iSetIndx];
226 $aMailbox['CHARSET'][$iSetIndx] = (isset($aConfig['charset'])) ?
$aConfig['charset'] : 'US-ASCII';
229 $aMailbox['NAME'] = $mailbox;
230 $aMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
231 $aMailbox['SEEN'] = (isset($aMbxResponse['SEEN'])) ?
$aMbxResponse['SEEN'] : $aMbxResponse['EXISTS'];
232 $aMailbox['RECENT'] = (isset($aMbxResponse['RECENT'])) ?
$aMbxResponse['RECENT'] : 0;
233 $aMailbox['UIDVALIDITY'] = $aMbxResponse['UIDVALIDITY'];
234 $aMailbox['UIDNEXT'] = $aMbxResponse['UIDNEXT'];
235 $aMailbox['PERMANENTFLAGS'] = $aMbxResponse['PERMANENTFLAGS'];
236 $aMailbox['RIGHTS'] = $aMbxResponse['RIGHTS'];
238 /* decide if we are thread sorting or not */
239 if ($aMailbox['SORT'] & SQSORT_THREAD
) {
240 if (!sqimap_capability($imapConnection,'THREAD')) {
241 $aMailbox['SORT'] ^
= SQSORT_THREAD
;
243 $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT'];
246 $aMailbox['THREAD_INDENT'] = false;
249 /* set a timestamp for cachecontrol */
250 $aMailbox['TIMESTAMP'] = time();
255 * Fetch the message headers for a mailbox. Settings are part of the aMailbox
256 * array. Dependent of the mailbox settings it deals with sort, thread and search
257 * If server sort is supported then SORT is also used for retrieving sorted search results
259 * @param resource $imapConnection imap socket handle
260 * @param array $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
261 * @return error $error error number
263 * @author Marc Groot Koerkamp
265 function fetchMessageHeaders($imapConnection, &$aMailbox) {
267 /* FIX ME, this function is kind of big, maybe we can split it up in
268 a couple of functions. Make sure the functions are private and starts with _
269 Also make sure that the error codes are propagated */
272 * Retrieve the UIDSET.
273 * Setindex is used to be able to store multiple uid sets. That will make it
274 * possible to display the mailbox multiple times in different sort order
275 * or to store serach results separate from normal mailbox view.
277 $iSetIndx = (isset($aMailbox['SETINDEX'])) ?
$aMailbox['SETINDEX'] : 0;
279 $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ?
$aMailbox['EXISTS'] : $aMailbox['LIMIT'];
281 * Adjust the start_msg
283 $start_msg = $aMailbox['PAGEOFFSET'];
284 if($aMailbox['PAGEOFFSET'] > $aMailbox['EXISTS']) {
285 $start_msg -= $aMailbox['LIMIT'];
291 if (is_array($aMailbox['UIDSET'])) {
292 $aUid =& $aMailbox['UIDSET'][$iSetIndx];
296 $aFetchHeaders = $aMailbox['FETCHHEADERS'];
299 $aFetchItems = $aHeaderItems = array();
300 // initialize the fields we want to retrieve:
301 $aHeaderFields = array();
302 foreach ($aFetchHeaders as $v) {
304 case SQM_COL_DATE
: $aHeaderFields[] = 'Date'; break;
305 case SQM_COL_TO
: $aHeaderFields[] = 'To'; break;
306 case SQM_COL_CC
: $aHeaderFields[] = 'Cc'; break;
307 case SQM_COL_FROM
: $aHeaderFields[] = 'From'; break;
308 case SQM_COL_SUBJ
: $aHeaderFields[] = 'Subject'; break;
309 case SQM_COL_PRIO
: $aHeaderFields[] = 'X-Priority'; break;
310 case SQM_COL_ATTACHMENT
: $aHeaderFields[] = 'Content-Type'; break;
311 case SQM_COL_INT_DATE
: $aFetchItems[] = 'INTERNALDATE'; break;
312 case SQM_COL_FLAGS
: $aFetchItems[] = 'FLAGS'; break;
313 case SQM_COL_SIZE
: $aFetchItems[] = 'RFC822.SIZE'; break;
319 * A uidset with sorted uid's is available. We can use the cache
321 if (isset($aUid) && $aUid ) {
322 // limit the cache to SQM_MAX_PAGES_IN_CACHE
323 if (!$aMailbox['SHOWALL'][$iSetIndx] && isset($aMailbox['MSG_HEADERS'])) {
324 $iMaxMsgs = $iLimit * SQM_MAX_PAGES_IN_CACHE
;
325 $iCacheSize = count($aMailbox['MSG_HEADERS']);
326 if ($iCacheSize > $iMaxMsgs) {
327 $iReduce = $iCacheSize - $iMaxMsgs;
328 foreach ($aMailbox['MSG_HEADERS'] as $iUid => $value) {
330 unset($aMailbox['MSG_HEADERS'][$iUid]);
339 $id_slice = array_slice($aUid,$start_msg-1,$iLimit);
340 /* do some funky cache checks */
341 if (isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) {
342 // temp code, read_body del / next links fo not update fields.
343 foreach ($aMailbox['MSG_HEADERS'] as $iUid => $aValue) {
344 if (!isset($aValue['UID'])) {
345 unset($aMailbox['MSG_HEADERS'][$iUid]);
348 $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
350 $aMailbox['MSG_HEADERS'] = array();
351 $aUidCached = array();
353 $aUidNotCached = array_values(array_diff($id_slice,$aUidCached));
356 * $aUidNotCached contains an array with UID's which need to be fetched to
357 * complete the needed message headers.
359 if (count($aUidNotCached)) {
360 $aMsgs = sqimap_get_small_header_list($imapConnection,$aUidNotCached,
361 $aHeaderFields,$aFetchItems);
362 // append the msgs to the existend headers
363 $aMailbox['MSG_HEADERS'] +
= $aMsgs;
367 * Initialize the sorted UID list or initiate a UID list with search
368 * results and fetch the visible message headers
371 if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') { // in case of a search request
373 if ($aMailbox['SEARCH'][$iSetIndx] && $aMailbox['SORT'] == 0) {
374 $aUid = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
378 $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
379 $aUid = $aMailbox['UIDSET'][$iSetIndx];
383 * Number of messages is the resultset
385 $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
386 $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
387 if (count($id_slice)) {
388 $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
389 $aHeaderFields,$aFetchItems);
391 $iError = 1; // FIX ME, define an error code
396 $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
397 $aUid = $aMailbox['UIDSET'][$iSetIndx];
401 * Number of messages is the resultset
403 $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
404 $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
405 if (count($id_slice)) {
406 $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
407 $aHeaderFields,$aFetchItems);
409 $iError = 1; // FIX ME, define an error code
418 * Prepares the message headers for display inside a template. The links are calculated,
419 * color for row highlighting is calculated and optionally the strings are truncated.
421 * @param array $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
422 * @param array $aProps properties
423 * @return array $aFormattedMessages array with message headers and format info
425 * @author Marc Groot Koerkamp
427 function prepareMessageList(&$aMailbox, $aProps) {
429 /* Globalize link attributes so plugins can share in modifying them */
430 global $link, $title, $target, $onclick, $link_extra, $preselected;
432 /* retrieve the properties */
433 $my_email_address = (isset($aProps['email'])) ?
$aProps['email'] : false;
434 $highlight_list = (isset($aProps['config']['highlight_list'])) ?
$aProps['config']['highlight_list'] : false;
435 $aColumnDesc = (isset($aProps['columns'])) ?
$aProps['columns'] : false;
436 $aExtraColumns = (isset($aProps['extra_columns'])) ?
$aProps['extra_columns'] : array();
437 $iAccount = (isset($aProps['account'])) ?
(int) $aProps['account'] : 0;
438 $sMailbox = (isset($aProps['mailbox'])) ?
$aProps['mailbox'] : false;
439 $sTargetModule = (isset($aProps['module'])) ?
$aProps['module'] : 'read_body';
442 * TODO 1, retrieve array with identity email addresses in order to match against to,cc and set a flag
443 * $aFormattedMessages[$iUid]['match_identity'] = true
444 * The template can show some image if there is a match.
445 * TODO 2, makes sure the matching is done fast by doing a strpos call on the returned $value
449 * Only retrieve values for displayable columns
451 foreach ($aColumnDesc as $k => $v) {
453 case SQM_COL_FROM
: $aCol[SQM_COL_FROM
] = 'from'; break;
454 case SQM_COL_DATE
: $aCol[SQM_COL_DATE
] = 'date'; break;
455 case SQM_COL_SUBJ
: $aCol[SQM_COL_SUBJ
] = 'subject'; break;
456 case SQM_COL_FLAGS
: $aCol[SQM_COL_FLAGS
] = 'FLAGS'; break;
457 case SQM_COL_SIZE
: $aCol[SQM_COL_SIZE
] = 'SIZE'; break;
458 case SQM_COL_PRIO
: $aCol[SQM_COL_PRIO
] = 'x-priority'; break;
459 case SQM_COL_ATTACHMENT
: $aCol[SQM_COL_ATTACHMENT
] = 'content-type'; break;
460 case SQM_COL_INT_DATE
: $aCol[SQM_COL_INT_DATE
] = 'INTERNALDATE'; break;
461 case SQM_COL_TO
: $aCol[SQM_COL_TO
] = 'to'; break;
462 case SQM_COL_CC
: $aCol[SQM_COL_CC
] = 'cc'; break;
463 case SQM_COL_BCC
: $aCol[SQM_COL_BCC
] = 'bcc'; break;
467 $aExtraHighLightColumns = array();
468 foreach ($aExtraColumns as $v) {
470 case SQM_COL_FROM
: $aExtraHighLightColumns[] = 'from'; break;
471 case SQM_COL_SUBJ
: $aExtraHighLightColumns[] = 'subject'; break;
472 case SQM_COL_TO
: $aExtraHighLightColumns[] = 'to'; break;
473 case SQM_COL_CC
: $aExtraHighLightColumns[] = 'cc'; break;
474 case SQM_COL_BCC
: $aExtraHighLightColumns[] = 'bcc'; break;
478 $aFormattedMessages = array();
481 $iSetIndx = $aMailbox['SETINDEX'];
482 $aId = $aMailbox['UIDSET'][$iSetIndx];
483 $aHeaders =& $aMailbox['MSG_HEADERS']; /* use a reference to avoid a copy.
484 MSG_HEADERS can contain large amounts of data */
485 $iOffset = $aMailbox['OFFSET'];
486 $sort = $aMailbox['SORT'];
487 $iPageOffset = $aMailbox['PAGEOFFSET'];
488 $sMailbox = $aMailbox['NAME'];
489 $sSearch = (isset($aMailbox['SEARCH'][$aMailbox['SETINDEX']]) &&
490 $aMailbox['SEARCH'][$aMailbox['SETINDEX']] != 'ALL') ?
$aMailbox['SEARCH'][$aMailbox['SETINDEX']] : false;
491 $aSearch = ($sSearch) ?
array('search.php',$aMailbox['SETINDEX']) : null;
492 /* avoid improper usage */
493 if ($sMailbox && isset($iAccount) && $sTargetModule) {
494 $aInitQuery = array("account=$iAccount",'mailbox='.urlencode($sMailbox));
499 if ($aMailbox['SORT'] & SQSORT_THREAD
) {
500 $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']];
506 * Retrieve value for checkbox column
508 if (!sqgetGlobalVar('checkall',$checkall,SQ_GET
)) {
513 * Loop through and display the info for each message.
515 $iEnd = ($aMailbox['SHOWALL'][$iSetIndx]) ?
$aMailbox['EXISTS'] : $iOffset +
$aMailbox['LIMIT'];
516 for ($i=$iOffset,$t=0;$i<$iEnd;++
$i) {
517 if (isset($aId[$i])) {
520 $value = $title = $link = $target = $onclick = $link_extra = '';
521 $aQuery = ($aInitQuery !== false) ?
$aInitQuery : false;
522 $aMsg = $aHeaders[$aId[$i]];
523 if (isset($aSearch) && count($aSearch) > 1 && $aQuery) {
524 $aQuery[] = "where=". $aSearch[0];
525 $aQuery[] = "what=" . $aSearch[1];
527 $iUid = (isset($aMsg['UID'])) ?
$aMsg['UID'] : $aId[$i];
529 $aQuery[] = "passed_id=$aId[$i]";
530 $aQuery[] = "startMessage=$iPageOffset";
533 foreach ($aCol as $k => $v) {
534 $title = $link = $target = $onclick = $link_extra = '';
535 $aColumns[$k] = array();
536 $value = (isset($aMsg[$v])) ?
$aMsg[$v] : '';
537 $sUnknown = _("Unknown recipient");
540 $sUnknown = _("Unknown sender");
546 if ($highlight_list && !$bHighLight) {
547 $bHighLight = highlightMessage($aCol[$k], $value, $highlight_list,$aFormattedMessages[$iUid]);
549 $aAddressList = parseRFC822Address($value);
550 $sTmp = getAddressString($aAddressList,array('best' => true));
551 $title = $title_maybe = '';
552 foreach ($aAddressList as $aAddr) {
553 $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL
])) ?
$aAddr[SQM_ADDR_PERSONAL
] : '';
554 $sMailbox = (isset($aAddr[SQM_ADDR_MAILBOX
])) ?
$aAddr[SQM_ADDR_MAILBOX
] : '';
555 $sHost = (isset($aAddr[SQM_ADDR_HOST
])) ?
$aAddr[SQM_ADDR_HOST
] : '';
557 $title .= htmlspecialchars($sMailbox.'@'.$sHost).', ';
559 // if $value gets truncated we need to add the addresses with no
560 // personal name as well
561 $title_maybe .= htmlspecialchars($sMailbox.'@'.$sHost).', ';
565 $title = substr($title,0,-2); // strip ', ';
567 $sTmp = decodeHeader($sTmp);
568 if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
569 $sTrunc = truncateWithEntities($sTmp, $aColumnDesc[$k]['truncate']);
570 if ($sTrunc != $sTmp) {
573 } else if ($title_maybe) {
574 $title = $title .', '.$title_maybe;
575 $title = substr($title,0,-2); // strip ', ';
581 $value = ($sTmp) ?
$sTmp : $sUnknown;
584 // subject is mime encoded, decode it.
585 // value is sanitized in decoding function.
586 // TODO, verify if it should be done before or after the highlighting
587 $value=decodeHeader($value);
588 if ($highlight_list && !$bHighLight) {
589 $bHighLight = highlightMessage('SUBJECT', $value, $highlight_list, $aFormattedMessages[$iUid]);
591 $iIndent = (isset($aIndentArray[$aId[$i]])) ?
$aIndentArray[$aId[$i]] : 0;
592 // FIXME: don't break 8bit symbols and html entities during truncation
593 if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
594 $sTmp = truncateWithEntities($value, $aColumnDesc[$k]['truncate']-$iIndent);
595 // drop any double spaces since these will be displayed in the title
596 $title = ($sTmp != $value) ?
preg_replace('/\s{2,}/', ' ', $value) : '';
599 /* generate the link to the message */
601 // TODO, $sTargetModule should be a query parameter so that we can use a single entrypoint
602 $link = $sTargetModule.'.php?' . implode('&',$aQuery);
604 // see top of this function for which attributes are available
605 // in the global scope for plugin use (like $link, $target,
606 // $onclick, $link_extra, $title, and so forth)
607 // plugins are responsible for sharing nicely (such as for
608 // setting the target, etc)
609 $temp = array(&$iPageOffset, &$sSearch, &$aSearch, $aMsg);
610 do_hook('subject_link', $temp);
612 $value = (trim($value)) ?
$value : _("(no subject)");
613 /* add thread indentation */
614 $aColumns[$k]['indent'] = $iIndent;
617 $value = show_readable_size($value);
620 case SQM_COL_INT_DATE
:
621 $value = getDateString(getTimeStamp(explode(' ',trim($value))));
624 $aFlagColumn = array('seen' => false,
631 if(!is_array($value)) $value = array();
632 foreach ($value as $sFlag => $v) {
634 case '\\seen' : $aFlagColumn['seen'] = true; break;
635 case '\\deleted' : $aFlagColumn['deleted'] = true; break;
636 case '\\answered': $aFlagColumn['answered'] = true; break;
637 case '$forwarded': $aFlagColumn['forwarded'] = true; break;
638 case '\\flagged' : $aFlagColumn['flagged'] = true; break;
639 case '\\draft' : $aFlagColumn['draft'] = true; break;
643 $value = $aFlagColumn;
646 $value = ($value) ?
(int) $value : 3;
648 case SQM_COL_ATTACHMENT
:
649 $value = (is_array($value) && $value[0] == 'multipart' && $value[1] == 'mixed') ?
true : false;
652 $value = ($checkall ||
in_array($iUid, $preselected));
656 if ($title) { $aColumns[$k]['title'] = $title; }
657 if ($link) { $aColumns[$k]['link'] = $link; }
658 if ($link_extra) { $aColumns[$k]['link_extra'] = $link_extra; }
659 if ($onclick) { $aColumns[$k]['onclick'] = $onclick; }
660 if ($target) { $aColumns[$k]['target'] = $target; }
661 $aColumns[$k]['value'] = $value;
663 /* columns which will not be displayed but should be inspected
664 because the highlight list contains rules with those columns */
665 foreach ($aExtraHighLightColumns as $v) {
666 if ($highlight_list && !$bHighLight && isset($aMsg[$v])) {
667 $bHighLight = highlightMessage($v, $aMsg[$v], $highlight_list,$aFormattedMessages[$iUid]);
670 $aFormattedMessages[$iUid]['columns'] = $aColumns;
676 return $aFormattedMessages;
681 * Sets the row color if the provided column value pair matches a hightlight rule
683 * @param string $sCol column name
684 * @param string $sVal column value
685 * @param array $highlight_list highlight rules
686 * @param array $aFormat (reference) array where row color info is stored
687 * @return bool match found
689 * @author Marc Groot Koerkamp
691 function highlightMessage($sCol, $sVal, $highlight_list, &$aFormat) {
692 if (!is_array($highlight_list) && count($highlight_list) == 0) {
696 $sCol = strtoupper($sCol);
698 foreach ($highlight_list as $highlight_list_part) {
699 if (trim($highlight_list_part['value'])) {
700 $high_val = strtolower($highlight_list_part['value']);
701 $match_type = strtoupper($highlight_list_part['match_type']);
702 if($match_type == 'TO_CC') {
703 if ($sCol == 'TO' ||
$sCol == 'CC') {
709 if ($match_type != $sCol) {
713 if (strpos(strtolower($sVal),$high_val) !== false) {
714 $hlt_color = $highlight_list_part['color'];
720 // Bug in highlight color???
721 if ($hlt_color{0} != '#') {
722 $hlt_color = '#'. $hlt_color;
724 $aFormat['row']['color'] = $hlt_color;
731 function setUserPref($username, $pref, $value) {
733 setPref($data_dir,$username,$pref,$value);
737 * Execute the sorting for a mailbox
739 * @param resource $imapConnection Imap connection
740 * @param array $aMailbox (reference) Mailbox retrieved with sqm_api_mailbox_select
741 * @return int $error (reference) Error number
744 * @author Marc Groot Koerkamp
746 function _get_sorted_msgs_list($imapConnection,&$aMailbox) {
747 $iSetIndx = (isset($aMailbox['SETINDEX'])) ?
$aMailbox['SETINDEX'] : 0;
748 $bDirection = !($aMailbox['SORT'] %
2);
750 if (!$aMailbox['SEARCH'][$iSetIndx]) {
751 $aMailbox['SEARCH'][$iSetIndx] = 'ALL';
753 if (($aMailbox['SORT'] & SQSORT_THREAD
) && sqimap_capability($imapConnection,'THREAD')) {
754 $aRes = get_thread_sort($imapConnection,$aMailbox['SEARCH'][$iSetIndx]);
755 if ($aRes === false) {
756 $aMailbox['SORT'] -= SQSORT_THREAD
;
757 $error = 1; // fix me, define an error code;
759 $aMailbox['UIDSET'][$iSetIndx] = $aRes[0];
760 $aMailbox['THREAD_INDENT'][$iSetIndx] = $aRes[1];
762 } else if ($aMailbox['SORT'] === SQSORT_NONE
) {
763 $id = sqimap_run_search($imapConnection, 'ALL' , '');
765 $error = 1; // fix me, define an error code
767 $aMailbox['UIDSET'][$iSetIndx] = array_reverse($id);
768 $aMailbox['TOTAL'][$iSetIndx] = $aMailbox['EXISTS'];
771 if (sqimap_capability($imapConnection,'SORT')) {
772 $sSortField = _getSortField($aMailbox['SORT'],true);
773 $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection, $aMailbox['SEARCH'][$iSetIndx]);
775 $error = 1; // fix me, define an error code
777 $aMailbox['UIDSET'][$iSetIndx] = $id;
781 if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') {
782 $id = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
784 $sSortField = _getSortField($aMailbox['SORT'],false);
785 $aMailbox['UIDSET'][$iSetIndx] = get_squirrel_sort($imapConnection, $sSortField, $bDirection, $id);
792 * Does the $srt $_GET var to field mapping
794 * @param int $srt Field to sort on
795 * @param bool $bServerSort Server sorting is true
796 * @return string $sSortField Field to sort on
800 function _getSortField($sort,$bServerSort) {
805 case SQSORT_DATE_ASC
:
806 case SQSORT_DATE_DESC
:
807 $sSortField = 'DATE';
809 case SQSORT_FROM_ASC
:
810 case SQSORT_FROM_DESC
:
811 $sSortField = 'FROM';
813 case SQSORT_SUBJ_ASC
:
814 case SQSORT_SUBJ_DESC
:
815 $sSortField = 'SUBJECT';
817 case SQSORT_SIZE_ASC
:
818 case SQSORT_SIZE_DESC
:
819 $sSortField = ($bServerSort) ?
'SIZE' : 'RFC822.SIZE';
829 case SQSORT_INT_DATE_ASC
:
830 case SQSORT_INT_DATE_DESC
:
831 $sSortField = ($bServerSort) ?
'ARRIVAL' : 'INTERNALDATE';
835 default: $sSortField = 'UID';
843 * This function is a utility function for setting which headers should be
844 * fetched. It takes into account the highlight list which requires extra
845 * headers to be fetch in order to make those rules work. It's called before
846 * the headers are fetched which happens in showMessagesForMailbox and when
847 * the next and prev links in read_body.php are used.
849 * @param array $aMailbox associative array with mailbox related vars
850 * @param array $aProps
855 function calcFetchColumns(&$aMailbox, &$aProps) {
857 $highlight_list = (isset($aProps['config']['highlight_list'])) ?
$aProps['config']['highlight_list'] : false;
858 $aColumnsDesc = (isset($aProps['columns'])) ?
$aProps['columns'] : false;
860 $aFetchColumns = $aColumnsDesc;
861 if (isset($aFetchColumns[SQM_COL_CHECK
])) {
862 unset($aFetchColumns[SQM_COL_CHECK
]);
866 * Before we fetch the message headers, check if we need to fetch extra columns
867 * to make the message highlighting work
869 if (is_array($highlight_list) && count($highlight_list)) {
870 $aHighlightColumns = array();
871 foreach ($highlight_list as $highlight_list_part) {
872 if (trim($highlight_list_part['value'])) {
873 $match_type = strtoupper($highlight_list_part['match_type']);
874 switch ($match_type) {
876 $aHighlightColumns[SQM_COL_TO
] = true;
877 $aHighlightColumns[SQM_COL_CC
] = true;
879 case 'TO': $aHighlightColumns[SQM_COL_TO
] = true; break;
880 case 'CC': $aHighlightColumns[SQM_COL_CC
] = true; break;
881 case 'FROM': $aHighlightColumns[SQM_COL_FROM
] = true; break;
882 case 'SUBJECT':$aHighlightColumns[SQM_COL_SUBJ
] = true; break;
886 $aExtraColumns = array();
887 foreach ($aHighlightColumns as $k => $v) {
888 if (!isset($aFetchColumns[$k])) {
889 $aExtraColumns[] = $k;
890 $aFetchColumns[$k] = true;
893 if (count($aExtraColumns)) {
894 $aProps['extra_columns'] = $aExtraColumns;
897 $aMailbox['FETCHHEADERS'] = array_keys($aFetchColumns);
902 * This function loops through a group of messages in the mailbox
903 * and shows them to the user.
905 * @param resource $imapConnection
906 * @param array $aMailbox associative array with mailbox related vars
907 * @param array $aProps
908 * @param int $iError error code, 0 is no error
910 function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
912 global $boxes, $show_copy_buttons;
914 $highlight_list = (isset($aProps['config']['highlight_list'])) ?
$aProps['config']['highlight_list'] : false;
915 $fancy_index_highlite = (isset($aProps['config']['fancy_index_highlite'])) ?
$aProps['config']['fancy_index_highlite'] : true;
916 $aColumnsDesc = (isset($aProps['columns'])) ?
$aProps['columns'] : false;
917 $iAccount = (isset($aProps['account'])) ?
(int) $aProps['account'] : 0;
918 $sMailbox = (isset($aProps['mailbox'])) ?
$aProps['mailbox'] : false;
919 $sTargetModule = (isset($aProps['module'])) ?
$aProps['module'] : 'read_body';
920 $show_flag_buttons = (isset($aProps['config']['show_flag_buttons'])) ?
$aProps['config']['show_flag_buttons'] : true;
922 /* allows to control copy button in function call. If array key is not set, code follows user preferences */
923 if (isset($aProps['config']['show_copy_buttons']))
924 $show_copy_buttons = $aProps['config']['show_copy_buttons'];
926 $lastTargetMailbox = (isset($aProps['config']['lastTargetMailbox'])) ?
$aProps['config']['lastTargetMailbox'] : '';
927 $aOrder = array_keys($aProps['columns']);
928 $trash_folder = (isset($aProps['config']['trash_folder']) && $aProps['config']['trash_folder'])
929 ?
$aProps['config']['trash_folder'] : false;
930 $sent_folder = (isset($aProps['config']['sent_folder']) && $aProps['config']['sent_folder'])
931 ?
$aProps['config']['sent_folder'] : false;
932 $draft_folder = (isset($aProps['config']['draft_folder']) && $aProps['config']['draft_folder'])
933 ?
$aProps['config']['draft_folder'] : false;
934 $page_selector = (isset($aProps['config']['page_selector'])) ?
$aProps['config']['page_selector'] : false;
935 $page_selector_max = (isset($aProps['config']['page_selector_max'])) ?
$aProps['config']['page_selector_max'] : 10;
936 $color = $aProps['config']['color'];
944 if (!isset($iFormId)) {
949 // store the columns to fetch so we can pick them up in read_body
950 // where we validate the cache.
951 calcFetchColumns($aMailbox ,$aProps);
953 $iError = fetchMessageHeaders($imapConnection, $aMailbox);
957 $aMessages = prepareMessageList($aMailbox, $aProps);
960 $iSetIndx = $aMailbox['SETINDEX'];
961 $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ?
$aMailbox['EXISTS'] : $aMailbox['LIMIT'];
962 $iEnd = ($aMailbox['PAGEOFFSET'] +
($iLimit - 1) < $aMailbox['EXISTS']) ?
963 $aMailbox['PAGEOFFSET'] +
$iLimit - 1 : $aMailbox['EXISTS'];
965 $iNumberOfMessages = $aMailbox['TOTAL'][$iSetIndx];
966 $iEnd = min ( $iEnd, $iNumberOfMessages );
968 $php_self = $PHP_SELF;
970 $urlMailbox = urlencode($aMailbox['NAME']);
972 if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
973 $source_url = $regs[1];
975 $source_url = $php_self;
978 $baseurl = $source_url.'?mailbox=' . urlencode($aMailbox['NAME']) .'&account='.$aMailbox['ACCOUNT'];
979 $where = urlencode($aMailbox['SEARCH'][$iSetIndx][0]);
980 $what = urlencode($aMailbox['SEARCH'][$iSetIndx][1]);
981 $baseurl .= '&where=' . $where . '&what=' . $what;
983 /* build thread sorting links */
984 $newsort = $aMailbox['SORT'];
985 if (sqimap_capability($imapConnection,'THREAD')) {
986 if ($aMailbox['SORT'] & SQSORT_THREAD
) {
987 $newsort -= SQSORT_THREAD
;
988 $thread_name = _("Unthread View");
990 $thread_name = _("Thread View");
991 $newsort = $aMailbox['SORT'] + SQSORT_THREAD
;
993 $thread_link_uri = $baseurl . '&srt=' . $newsort
994 . '&startMessage=1';
996 $thread_link_uri ='';
999 $sort = $aMailbox['SORT'];
1001 /* FIX ME ADD CHECKBOX CONTROL. No checkbox => no buttons */
1005 /* future admin control over displayable buttons */
1006 $aAdminControl = array(
1008 'markUnflagged' => 1,
1013 'undeleteButton'=> 1,
1014 'bypass_trash' => 1,
1015 'expungeButton' => 1,
1020 /* user prefs control */
1021 $aUserControl = array (
1023 'markFlagged' => $show_flag_buttons,
1024 'markUnflagged' => $show_flag_buttons,
1029 'undeleteButton'=> 1,
1030 'bypass_trash' => 1,
1031 'expungeButton' => 1,
1033 'copyButton' => $show_copy_buttons
1037 $showDelete = ($aMailbox['RIGHTS'] != 'READ-ONLY' &&
1038 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ?
true : false;
1039 $showByPassTrash = (($aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
1040 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) &&
1041 $trash_folder) ?
true : false; //
1043 $showUndelete = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
1044 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true) && !$trash_folder) ?
true : false;
1045 $showMove = ($aMailbox['RIGHTS'] != 'READ-ONLY') ?
true : false;
1046 $showExpunge = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
1047 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ?
true : false;
1049 /* Button options that depend on IMAP server and selected folder */
1050 $aImapControl = array (
1051 'markUnflagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true),
1052 'markFlagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true),
1053 'markRead' => in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true),
1054 'markUnread' => in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true),
1056 'delete' => $showDelete,
1057 'undeleteButton'=> $showUndelete,
1058 'bypass_trash' => $showByPassTrash,
1059 'expungeButton' => $showExpunge,
1060 'moveButton' => $showMove,
1063 /* Button strings */
1064 $aButtonStrings = array(
1065 'markFlagged' => _("Flag"),
1066 'markUnflagged' => _("Unflag"),
1067 'markRead' => _("Read"),
1068 'markUnread' => _("Unread"),
1069 'forward' => _("Forward"),
1070 'delete' => _("Delete"),
1071 'undeleteButton' => _("Undelete"),
1072 'bypass_trash' => _("Bypass Trash"),
1073 'expungeButton' => _("Expunge"),
1074 'moveButton' => _("Move"),
1075 'copyButton' => _("Copy")
1077 /* Button access keys */
1078 global $accesskey_mailbox_flag, $accesskey_mailbox_unflag,
1079 $accesskey_mailbox_read, $accesskey_mailbox_unread,
1080 $accesskey_mailbox_forward, $accesskey_mailbox_delete,
1081 $accesskey_mailbox_undelete, $accesskey_mailbox_bypass_trash,
1082 $accesskey_mailbox_expunge, $accesskey_mailbox_move,
1083 $accesskey_mailbox_copy, $accesskey_mailbox_move_to;
1084 $aButtonAccessKeys = array(
1085 'markFlagged' => $accesskey_mailbox_flag,
1086 'markUnflagged' => $accesskey_mailbox_unflag,
1087 'markRead' => $accesskey_mailbox_read,
1088 'markUnread' => $accesskey_mailbox_unread,
1089 'forward' => $accesskey_mailbox_forward,
1090 'delete' => $accesskey_mailbox_delete,
1091 'undeleteButton' => $accesskey_mailbox_undelete,
1092 'bypass_trash' => $accesskey_mailbox_bypass_trash,
1093 'expungeButton' => $accesskey_mailbox_expunge,
1094 'moveButton' => $accesskey_mailbox_move,
1095 'copyButton' => $accesskey_mailbox_copy,
1100 * Register buttons in order to an array
1101 * The key is the "name", the first element of the value array is the "value", second argument is the type.
1103 $aFormElements = array();
1104 foreach($aAdminControl as $k => $v) {
1105 if ($v & $aUserControl[$k] & $aImapControl[$k]) {
1108 case 'markUnflagged':
1112 case 'undeleteButton':
1113 case 'expungeButton':
1116 = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ?
$aButtonAccessKeys[$k] : 'NONE'));
1118 case 'bypass_trash':
1120 = array('value' => $aButtonStrings[$k], 'type' => 'checkbox', 'accesskey' => (isset($aButtonAccessKeys[$k]) ?
$aButtonAccessKeys[$k] : 'NONE'));
1124 $aFormElements['targetMailbox']
1125 = array('options_list' => sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes),
1127 'accesskey' => $accesskey_mailbox_move_to);
1128 $aFormElements['mailbox']
1129 = array('value' => $aMailbox['NAME'], 'type' => 'hidden');
1130 $aFormElements['startMessage']
1131 = array('value' => $aMailbox['PAGEOFFSET'], 'type' => 'hidden');
1133 = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ?
$aButtonAccessKeys[$k] : 'NONE'));
1137 $aFormElements['account'] = array('value' => $iAccount,'type' => 'hidden');
1139 do_hook('message_list_controls', $aFormElements);
1142 * This is the beginning of the message list table.
1143 * It wraps around all messages
1145 $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
1146 $form_name = "FormMsgs" . $safe_name;
1148 //if (!sqgetGlobalVar('align',$align,SQ_SESSION)) {
1149 $align = array('left' => 'left', 'right' => 'right');
1151 //sm_print_r($align);
1153 /* finally set the template vars */
1155 // FIXME, before we support multiple templates we must review the names of the vars
1159 $aTemplate['color'] = $color;
1160 $aTemplate['form_name'] = "FormMsgs" . $safe_name;
1161 $aTemplate['form_id'] = 'mbx_'.$iFormId;
1162 $aTemplate['page_selector'] = $page_selector;
1163 $aTemplate['page_selector_max'] = $page_selector_max;
1164 $aTemplate['messagesPerPage'] = $aMailbox['LIMIT'];
1165 $aTemplate['showall'] = $aMailbox['SHOWALL'][$iSetIndx];
1166 $aTemplate['end_msg'] = $iEnd;
1167 $aTemplate['align'] = $align;
1168 $aTemplate['iNumberOfMessages'] = $iNumberOfMessages;
1169 $aTemplate['aOrder'] = $aOrder;
1170 $aTemplate['aFormElements'] = $aFormElements;
1171 $aTemplate['sort'] = $sort;
1172 $aTemplate['pageOffset'] = $aMailbox['PAGEOFFSET'];
1173 $aTemplate['baseurl'] = $baseurl;
1174 $aTemplate['aMessages'] =& $aMessages;
1175 $aTemplate['trash_folder'] = $trash_folder;
1176 $aTemplate['sent_folder'] = $sent_folder;
1177 $aTemplate['draft_folder'] = $draft_folder;
1178 $aTemplate['thread_link_uri'] = $thread_link_uri;
1179 $aTemplate['thread_name'] = $thread_name;
1180 $aTemplate['php_self'] = str_replace('&','&',$php_self);
1181 $aTemplate['mailbox'] = $sMailbox;
1182 //FIXME: javascript_on is always assigned to the template object in places like init.php; is there some reason to reassign it here? is there some chance that it was changed? if not, please remove this line!
1183 $aTemplate['javascript_on'] = (isset($aProps['config']['javascript_on'])) ?
$aProps['config']['javascript_on'] : false;
1184 $aTemplate['enablesort'] = (isset($aProps['config']['enablesort'])) ?
$aProps['config']['enablesort'] : false;
1185 $aTemplate['icon_theme'] = (isset($aProps['config']['icon_theme'])) ?
$aProps['config']['icon_theme'] : false;
1186 $aTemplate['use_icons'] = (isset($aProps['config']['use_icons'])) ?
$aProps['config']['use_icons'] : false;
1187 $aTemplate['alt_index_colors'] = (isset($aProps['config']['alt_index_colors'])) ?
$aProps['config']['alt_index_colors'] : false;
1188 $aTemplate['fancy_index_highlite'] = $fancy_index_highlite;
1192 * Set up sort possibilities; one could argue that this is best
1193 * placed in the template, but most template authors won't understand
1194 * or need to understand it, so some advanced templates can override
1195 * it if they do something different.
1197 if (!($aTemplate['sort'] & SQSORT_THREAD
) && $aTemplate['enablesort']) {
1198 $aTemplate['aSortSupported']
1199 = array(SQM_COL_SUBJ
=> array(SQSORT_SUBJ_ASC
, SQSORT_SUBJ_DESC
),
1200 SQM_COL_DATE
=> array(SQSORT_DATE_DESC
, SQSORT_DATE_ASC
),
1201 SQM_COL_INT_DATE
=> array(SQSORT_INT_DATE_DESC
, SQSORT_INT_DATE_ASC
),
1202 SQM_COL_FROM
=> array(SQSORT_FROM_ASC
, SQSORT_FROM_DESC
),
1203 SQM_COL_TO
=> array(SQSORT_TO_ASC
, SQSORT_TO_DESC
),
1204 SQM_COL_CC
=> array(SQSORT_CC_ASC
, SQSORT_CC_DESC
),
1205 SQM_COL_SIZE
=> array(SQSORT_SIZE_ASC
, SQSORT_SIZE_DESC
));
1207 $aTemplate['aSortSupported'] = array();
1212 * Figure out which columns should serve as labels for checkbox:
1213 * we try to grab the two columns before and after the checkbox,
1214 * except the subject column, since it is the link that opens
1217 * if $javascript_on is set, then the highlighting code takes
1218 * care of this; just skip it
1220 * This code also might be more appropriate in a template file, but
1221 * we are moving this complex stuff out of the way of template
1222 * authors; advanced template sets are always free to override
1223 * the resultant values.
1226 $show_label_columns = array();
1227 $index_order_part = array();
1228 if (!($aTemplate['javascript_on'] && $aTemplate['fancy_index_highlite'])) {
1230 $last_order_part = 0;
1231 $last_last_order_part = 0;
1232 foreach ($aTemplate['aOrder'] as $index_order_part) {
1233 if ($index_order_part == SQM_COL_CHECK
) {
1235 if ($last_last_order_part != SQM_COL_SUBJ
)
1236 $show_label_columns[] = $last_last_order_part;
1237 if ($last_order_part != SQM_COL_SUBJ
)
1238 $show_label_columns[] = $last_order_part;
1240 } else if ($get_next_two > 0 && $get_next_two < 3 && $index_order_part != SQM_COL_SUBJ
) {
1241 $show_label_columns[] = $index_order_part;
1244 $last_last_order_part = $last_order_part;
1245 $last_order_part = $index_order_part;
1248 $aTemplate['show_label_columns'] = $show_label_columns;
1257 * Truncates a string and take care of html encoded characters
1259 * @param string $s string to truncate
1260 * @param int $iTrimAt Trim at nn characters
1261 * @return string Trimmed string
1263 function truncateWithEntities($s, $iTrimAt) {
1264 global $languages, $squirrelmail_language;
1266 $ent_strlen = strlen($s);
1267 if (($iTrimAt <= 0) ||
($ent_strlen <= $iTrimAt))
1270 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
1271 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth')) {
1272 return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth', $s, $iTrimAt);
1275 * see if this is entities-encoded string
1276 * If so, Iterate through the whole string, find out
1277 * the real number of characters, and if more
1278 * than $iTrimAt, substr with an updated trim value.
1280 $trim_val = $iTrimAt;
1283 while ( $ent_loc < $trim_val && (($ent_loc = strpos($s, '&', $ent_offset)) !== false) &&
1284 (($ent_loc_end = strpos($s, ';', $ent_loc+
3)) !== false) ) {
1285 $trim_val +
= ($ent_loc_end-$ent_loc);
1286 $ent_offset = $ent_loc_end+
1;
1289 if (($trim_val > $iTrimAt) && ($ent_strlen > $trim_val) && (strpos($s,';',$trim_val) < ($trim_val +
6))) {
1290 $i = strpos($s,';',$trim_val);
1292 $trim_val = strpos($s,';',$trim_val)+
1;
1295 // only print '...' when we're actually dropping part of the subject
1296 if ($ent_strlen <= $trim_val)
1299 return substr_replace($s, '...', $trim_val);
1304 * Process messages list form and handle the cache gracefully. If $sButton and
1305 * $aUid are provided as argument then you can fake a message list submit and
1306 * use it i.e. in read_body.php for del move next and update the cache
1308 * @param resource $imapConnection imap connection
1309 * @param array $aMailbox (reference) cached mailbox
1310 * @param string $sButton fake a submit button
1311 * @param array $aUid fake the $msg array
1312 * @param string $targetMailbox fake the target mailbox for move operations
1313 * @param boolean $bypass_trash fake the bypass trash checkbox for delete operations
1314 * @return string $sError error string in case of an error
1316 * @author Marc Groot Koerkamp
1318 function handleMessageListForm($imapConnection, &$aMailbox, $sButton='',
1319 $aUid = array(), $targetMailbox='', $bypass_trash=NULL) {
1320 /* incoming formdata */
1321 $sButton = (sqgetGlobalVar('moveButton', $sTmp, SQ_FORM
)) ?
'move' : $sButton;
1322 $sButton = (sqgetGlobalVar('copyButton', $sTmp, SQ_FORM
)) ?
'copy' : $sButton;
1323 $sButton = (sqgetGlobalVar('expungeButton', $sTmp, SQ_FORM
)) ?
'expunge' : $sButton;
1324 $sButton = (sqgetGlobalVar('forward', $sTmp, SQ_FORM
)) ?
'forward' : $sButton;
1325 $sButton = (sqgetGlobalVar('delete', $sTmp, SQ_FORM
)) ?
'setDeleted' : $sButton;
1326 $sButton = (sqgetGlobalVar('undeleteButton', $sTmp, SQ_FORM
)) ?
'unsetDeleted' : $sButton;
1327 $sButton = (sqgetGlobalVar('markRead', $sTmp, SQ_FORM
)) ?
'setSeen' : $sButton;
1328 $sButton = (sqgetGlobalVar('markUnread', $sTmp, SQ_FORM
)) ?
'unsetSeen' : $sButton;
1329 $sButton = (sqgetGlobalVar('markFlagged', $sTmp, SQ_FORM
)) ?
'setFlagged' : $sButton;
1330 $sButton = (sqgetGlobalVar('markUnflagged', $sTmp, SQ_FORM
)) ?
'unsetFlagged' : $sButton;
1331 if (empty($targetMailbox)) sqgetGlobalVar('targetMailbox', $targetMailbox, SQ_FORM
);
1332 if (is_null($bypass_trash)) sqgetGlobalVar('bypass_trash', $bypass_trash, SQ_FORM
);
1333 sqgetGlobalVar('msg', $msg, SQ_FORM
);
1334 if (sqgetGlobalVar('account', $iAccount, SQ_FORM
) === false) {
1338 $mailbox = $aMailbox['NAME'];
1340 /* retrieve the check boxes */
1341 $aUid = (isset($msg) && is_array($msg)) ?
array_values($msg) : $aUid;
1342 if (count($aUid) && $sButton != 'expunge') {
1344 // make sure message UIDs are sanitized (BIGINT)
1345 foreach ($aUid as $i => $uid)
1346 $aUid[$i] = (preg_match('/^[0-9]+$/', $uid) ?
$uid : '0');
1348 $aUpdatedMsgs = false;
1352 // check if id exists in case we come from read_body
1353 if (count($aUid) == 1 && is_array($aMailbox['UIDSET'][$aMailbox['SETINDEX']]) &&
1354 !in_array($aUid[0],$aMailbox['UIDSET'][$aMailbox['SETINDEX']])) {
1357 $aUpdatedMsgs = sqimap_msgs_list_delete($imapConnection, $mailbox, $aUid,$bypass_trash);
1361 case 'unsetDeleted':
1365 case 'unsetFlagged':
1367 $sFlag = (substr($sButton,0,3) == 'set') ?
'\\'.substr($sButton,3) : '\\'.substr($sButton,5);
1368 $bSet = (substr($sButton,0,3) == 'set') ?
true : false;
1369 $aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
1372 $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox,true,$mailbox);
1373 sqsession_register($targetMailbox,'lastTargetMailbox');
1377 // sqimap_msgs_list_copy returns true or false.
1378 // If error happens - fourth argument handles it inside function.
1379 sqimap_msgs_list_copy($imapConnection,$aUid,$targetMailbox,true);
1380 sqsession_register($targetMailbox,'lastTargetMailbox');
1383 $aMsgHeaders = array();
1384 foreach ($aUid as $iUid) {
1385 $aMsgHeaders[$iUid] = $aMailbox['MSG_HEADERS'][$iUid];
1387 if (count($aMsgHeaders)) {
1388 $composesession = attachSelectedMessages($imapConnection,$aMsgHeaders);
1389 // dirty hack, add info to $aMailbox
1390 $aMailbox['FORWARD_SESSION']['SESSION_NUMBER'] = $composesession;
1391 $aMailbox['FORWARD_SESSION']['UIDS'] = $aUid;
1395 // Hook for plugin buttons
1396 $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], &$aUid);
1397 do_hook('mailbox_display_button_action', $temp);
1401 * $aUpdatedMsgs is an array containing the result of the untagged
1402 * fetch responses send by the imap server due to a flag change. That
1403 * response is parsed in an array with msg arrays by the parseFetch function
1405 if ($aUpdatedMsgs) {
1406 // Update the message headers cache
1407 $aDeleted = array();
1408 foreach ($aUpdatedMsgs as $iUid => $aMsg) {
1409 if (isset($aMsg['FLAGS'])) {
1411 * Only update the cached headers if the header is
1414 if (isset($aMailbox['MSG_HEADERS'][$iUid])) {
1415 $aMailbox['MSG_HEADERS'][$iUid]['FLAGS'] = $aMsg['FLAGS'];
1418 * Also update flags in message object
1420 //FIXME: WHY are we keeping flags in TWO places?!? This is error-prone and some core code uses the is_xxxx message object values while other code uses the flags array above. That's a mess.
1421 if (isset($aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'])) {
1422 $message = $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'];
1423 $message->is_seen
= false;
1424 $message->is_answered
= false;
1425 $message->is_forwarded
= false;
1426 $message->is_deleted
= false;
1427 $message->is_flagged
= false;
1428 $message->is_mdnsent
= false;
1429 foreach ($aMsg['FLAGS'] as $flag => $value) {
1430 if (strtolower($flag) == '\\seen' && $value)
1431 $message->is_seen
= true;
1432 else if (strtolower($flag) == '\\answered' && $value)
1433 $message->is_answered
= true;
1434 else if (strtolower($flag) == '$forwarded' && $value)
1435 $message->is_forwarded
= true;
1436 else if (strtolower($flag) == '\\deleted' && $value)
1437 $message->is_deleted
= true;
1438 else if (strtolower($flag) == '\\flagged' && $value)
1439 $message->is_flagged
= true;
1440 else if (strtolower($flag) == '$mdnsent' && $value)
1441 $message->is_mdnsent
= true;
1443 $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'] = $message;
1446 * Count the messages with the \Delete flag set so we can determine
1447 * if the number of expunged messages equals the number of flagged
1448 * messages for deletion.
1450 if (isset($aMsg['FLAGS']['\\deleted']) && $aMsg['FLAGS']['\\deleted']) {
1451 $aDeleted[] = $iUid;
1455 if ($bExpunge && $aMailbox['AUTO_EXPUNGE'] &&
1456 $iExpungedMessages = sqimap_mailbox_expunge($imapConnection, $aMailbox['NAME'], true))
1458 if (count($aDeleted) != $iExpungedMessages) {
1459 // there are more messages deleted permanently then we expected
1460 // invalidate the cache
1461 $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = false;
1462 $aMailbox['MSG_HEADERS'] = false;
1464 // remove expunged messages from cache
1465 $aUidSet = $aMailbox['UIDSET'][$aMailbox['SETINDEX']];
1466 if (is_array($aUidSet)) {
1467 // create a UID => array index temp array
1468 $aUidSetDummy = array_flip($aUidSet);
1469 foreach ($aDeleted as $iUid) {
1470 // get the id as well in case of SQM_SORT_NONE
1471 if ($aMailbox['SORT'] == SQSORT_NONE
) {
1472 $aMailbox['ID'] = false;
1473 //$iId = $aMailbox['MSG_HEADERS'][$iUid]['ID'];
1474 //unset($aMailbox['ID'][$iId]);
1476 // unset the UID and message header
1477 unset($aUidSetDummy[$iUid]);
1478 unset($aMailbox['MSG_HEADERS'][$iUid]);
1480 $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = array_keys($aUidSetDummy);
1483 // update EXISTS info
1484 if ($iExpungedMessages) {
1485 $aMailbox['EXISTS'] -= (int) $iExpungedMessages;
1486 $aMailbox['TOTAL'][$aMailbox['SETINDEX']] -= (int) $iExpungedMessages;
1488 if (($aMailbox['PAGEOFFSET']-1) >= $aMailbox['EXISTS']) {
1489 $aMailbox['PAGEOFFSET'] = ($aMailbox['PAGEOFFSET'] > $aMailbox['LIMIT']) ?
1490 $aMailbox['PAGEOFFSET'] - $aMailbox['LIMIT'] : 1;
1491 $aMailbox['OFFSET'] = $aMailbox['PAGEOFFSET'] - 1 ;
1496 if ($sButton == 'expunge') {
1498 * on expunge we do not know which messages will be deleted
1499 * so it's useless to try to sync the cache
1501 * Close the mailbox so we do not need to parse the untagged expunge
1502 * responses which do not contain uid info.
1503 * NB: Closing a mailbox is faster then expunge because the imap
1504 * server does not need to generate the untagged expunge responses
1506 sqimap_run_command($imapConnection,'CLOSE',false,$result,$message);
1507 $aMailbox = sqm_api_mailbox_select($imapConnection,$iAccount, $aMailbox['NAME'],array(),array());
1509 // this is the same hook as above, but here it is called in the
1510 // context of not having had any messages selected and if any
1511 // plugin handles the situation, it should return TRUE so we
1512 // know this was not an erroneous user action
1515 $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], $null);
1516 if (!boolean_hook_function('mailbox_display_button_action', $temp, 1)
1518 $sError = _("No messages were selected.");
1526 * Attach messages to a compose session
1528 * @param resource $imapConnection imap connection
1529 * @param array $aMsgHeaders
1530 * @return int $composesession unique compose_session_id where the attached messages belong to
1531 * @author Marc Groot Koerkamp
1533 function attachSelectedMessages($imapConnection,$aMsgHeaders) {
1535 sqgetGlobalVar('composesession', $composesession, SQ_SESSION
);
1536 sqgetGlobalVar('compose_messages', $compose_messages, SQ_SESSION
);
1537 if (!isset($compose_messages)||
is_null($compose_messages)) {
1538 $compose_messages = array();
1539 sqsession_register($compose_messages,'compose_messages');
1542 if (!$composesession) {
1543 $composesession = 1;
1544 sqsession_register($composesession,'composesession');
1547 sqsession_register($composesession,'composesession');
1550 $composeMessage = new Message();
1551 $rfc822_header = new Rfc822Header();
1552 $composeMessage->rfc822_header
= $rfc822_header;
1553 $composeMessage->reply_rfc822_header
= '';
1555 foreach($aMsgHeaders as $iUid => $aMsgHeader) {
1557 * Retrieve the full message
1559 $body_a = sqimap_run_command($imapConnection, "FETCH $iUid RFC822", true, $response, $readmessage, TRUE);
1560 if ($response == 'OK') {
1562 $subject = (isset($aMsgHeader['subject'])) ?
$aMsgHeader['subject'] : $iUid;
1564 array_shift($body_a);
1566 $body = implode('', $body_a);
1569 global $username, $attachment_dir;
1570 $filename = sq_get_attach_tempfile();
1571 $fullpath = getHashedDir($username, $attachment_dir) . '/' . $filename;
1572 $fp = fopen($fullpath, 'wb');
1573 fwrite ($fp, $body);
1576 $composeMessage->initAttachment('message/rfc822', $subject . '.eml', $filename);
1580 $compose_messages[$composesession] = $composeMessage;
1581 sqsession_register($compose_messages,'compose_messages');
1582 return $composesession;