Fix broken'Thread' and the no-javascript 'All' links (add security tokens)
[squirrelmail.git] / functions / mailbox_display.php
CommitLineData
59177427 1<?php
2ba13803 2
35586184 3/**
4b4abf93 4 * mailbox_display.php
5 *
6 * This contains functions that display mailbox information, such as the
7 * table row that has sender, date, subject, etc...
8 *
d4e46166 9 * @copyright &copy; 1999-2009 The SquirrelMail Project Team
4b4abf93 10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @version $Id$
12 * @package squirrelmail
13 */
a4c2cd49 14
324ac3c5 15
16/**
17 * Selects a mailbox for header retrieval.
18 * Cache control for message headers is embedded.
19 *
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
d849b570 24 *
324ac3c5 25 * @return array $aMailbox mailbox array with all relevant information
d849b570 26 *
4955562f 27 * @since 1.5.1
324ac3c5 28 * @author Marc Groot Koerkamp
29 */
91c27aee 30function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aProps) {
31
324ac3c5 32 /**
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
36 */
37 global $mailbox_cache;
91c27aee 38
324ac3c5 39 $aDefaultConfigProps = array(
324ac3c5 40// 'charset' => 'US-ASCII',
41 'user' => false, /* no pref storage if false */
42 'setindex' => 0,
43// 'search' => 'ALL',
44 'max_cache_size' => SQM_MAX_MBX_IN_CACHE
45 );
46
47 $aConfig = array_merge($aDefaultConfigProps,$aConfig);
91c27aee 48
324ac3c5 49 $iSetIndx = $aConfig['setindex'];
50
51 $aMbxResponse = sqimap_mailbox_select($imapConnection, $mailbox);
52
53 if ($mailbox_cache) {
91c27aee 54 if (isset($mailbox_cache[$account.'_'.$mailbox])) {
55 $aCachedMailbox = $mailbox_cache[$account.'_'.$mailbox];
324ac3c5 56 } else {
57 $aCachedMailbox = false;
58 }
59 /* cleanup cache */
60 if (count($mailbox_cache) > $aConfig['max_cache_size'] -1) {
61 $aTime = array();
62 foreach($mailbox_cache as $cachedmailbox => $aVal) {
63 $aTime[$aVal['TIMESTAMP']] = $cachedmailbox;
64 }
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);
68 /**
69 * Remove only the UIDSET and MSG_HEADERS from cache because those can
70 * contain large amounts of data.
71 */
72 if (isset($mailbox_cache[$sOldestMbx]['UIDSET'])) {
73 $mailbox_cache[$sOldestMbx]['UIDSET']= false;
74 }
75 if (isset($mailbox_cache[$sOldestMbx]['MSG_HEADERS'])) {
76 $mailbox_cache[$sOldestMbx]['MSG_HEADERS'] = false;
77 }
78 }
79 }
80 }
81
82 } else {
83 $aCachedMailbox = false;
84 }
85
86 /**
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).
90 */
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'];
96 }
97
91c27aee 98 $aMailbox['ACCOUNT'] = $account;
324ac3c5 99 $aMailbox['UIDSET'][$iSetIndx] = false;
100 $aMailbox['ID'] = false;
101 $aMailbox['SETINDEX'] = $iSetIndx;
c3731db5 102 $aMailbox['MSG_HEADERS'] = false;
324ac3c5 103
104 if ($aCachedMailbox) {
105 /**
106 * Validate integrity of cached data
107 */
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'];
117 }
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'];
123 /**
124 * If it concerns a reverse sort we do not need to invalidate
125 * the cached sorted UIDSET, a reverse is sufficient.
126 */
127 if ((($newsort % 2) && ($newsort + 1 == $oldsort)) ||
128 (!($newsort % 2) && ($newsort - 1 == $oldsort))) {
129 $aMailbox['UIDSET'][$iSetIndx] = array_reverse($aCachedMailbox['UIDSET'][$iSetIndx]);
130 } else {
91c27aee 131 $server_sort_array = false;
324ac3c5 132 $aMailbox['MSG_HEADERS'] = false;
133 $aMailbox['ID'] = false;
134 }
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
91c27aee 139 setUserPref($aConfig['user'],'pref_'.$account.'_'.$mailbox,serialize($aProps));
324ac3c5 140 }
141 } else {
142 $aMailbox['UIDSET'][$iSetIndx] = $aCachedMailbox['UIDSET'][$iSetIndx];
143 }
144 }
145 }
146 }
147 /**
148 * Restore the offset in the paginator if no new offset is provided.
149 */
150 if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['offset']) && $aCachedMailbox['OFFSET']) {
151 $aMailbox['OFFSET'] = $aCachedMailbox['OFFSET'];
152 $aMailbox['PAGEOFFSET'] = $aCachedMailbox['PAGEOFFSET'];
153 } else {
154 $aMailbox['OFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] -1 : 0;
155 $aMailbox['PAGEOFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] : 1;
156 }
91c27aee 157 /**
158 * Restore the number of messages in the result set
159 */
160 if (isset($aCachedMailbox['TOTAL'][$iSetIndx]) && $aCachedMailbox['TOTAL'][$iSetIndx]) {
161 $aMailbox['TOTAL'][$iSetIndx] = $aCachedMailbox['TOTAL'][$iSetIndx];
162 }
324ac3c5 163
164 /**
165 * Restore the showall value no new showall value is provided.
166 */
167 if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['showall']) &&
168 isset($aCachedMailbox['SHOWALL'][$iSetIndx]) && $aCachedMailbox['SHOWALL'][$iSetIndx]) {
169 $aMailbox['SHOWALL'][$iSetIndx] = $aCachedMailbox['SHOWALL'][$iSetIndx];
170 } else {
171 $aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ? 1 : 0;
172 }
173
91c27aee 174 /**
175 * Restore the sort order if no new sort order is provided.
176 */
324ac3c5 177 if (!isset($aProps[MBX_PREF_SORT]) && isset($aCachedMailbox['SORT'])) {
178 $aMailbox['SORT'] = $aCachedMailbox['SORT'];
179 } else {
180 $aMailbox['SORT'] = (isset($aProps[MBX_PREF_SORT])) ? $aProps[MBX_PREF_SORT] : 0;
181 }
182
91c27aee 183 /**
184 * Restore the number of message to show per page when no new limit is provided
185 */
324ac3c5 186 if (!isset($aProps[MBX_PREF_LIMIT]) && isset($aCachedMailbox['LIMIT'])) {
187 $aMailbox['LIMIT'] = $aCachedMailbox['LIMIT'];
188 } else {
189 $aMailbox['LIMIT'] = (isset($aProps[MBX_PREF_LIMIT])) ? $aProps[MBX_PREF_LIMIT] : 15;
190 }
191
91c27aee 192 /**
193 * Restore the ordered columns to show when no new ordered columns are provided
194 */
195 if (!isset($aProps[MBX_PREF_COLUMNS]) && isset($aCachedMailbox['COLUMNS'])) {
196 $aMailbox['COLUMNS'] = $aCachedMailbox['COLUMNS'];
324ac3c5 197 } else {
91c27aee 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);
324ac3c5 200 }
201
d0b119a5 202 /**
203 * Restore the headers we fetch the last time. Saves intitialisation stuff in read_body.
204 */
205 $aMailbox['FETCHHEADERS'] = (isset($aCachedMailbox['FETCHHEADERS'])) ? $aCachedMailbox['FETCHHEADERS'] : null;
206
324ac3c5 207 if (!isset($aProps[MBX_PREF_AUTO_EXPUNGE]) && isset($aCachedMailbox['AUTO_EXPUNGE'])) {
208 $aMailbox['AUTO_EXPUNGE'] = $aCachedMailbox['AUTO_EXPUNGE'];
209 } else {
210 $aMailbox['AUTO_EXPUNGE'] = (isset($aProps[MBX_PREF_AUTO_EXPUNGE])) ? $aProps[MBX_PREF_AUTO_EXPUNGE] : false;
211 }
324ac3c5 212 if (!isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx])) {
213 $aMailbox['SEARCH'][$iSetIndx] = $aCachedMailbox['SEARCH'][$iSetIndx];
7762b03c 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;
324ac3c5 220 } else {
221 $aMailbox['SEARCH'][$iSetIndx] = (isset($aConfig['search'])) ? $aConfig['search'] : 'ALL';
222 }
324ac3c5 223 if (!isset($aConfig['charset']) && isset($aCachedMailbox['CHARSET'][$iSetIndx])) {
224 $aMailbox['CHARSET'][$iSetIndx] = $aCachedMailbox['CHARSET'][$iSetIndx];
225 } else {
226 $aMailbox['CHARSET'][$iSetIndx] = (isset($aConfig['charset'])) ? $aConfig['charset'] : 'US-ASCII';
227 }
228
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'];
237
324ac3c5 238 /* decide if we are thread sorting or not */
324ac3c5 239 if ($aMailbox['SORT'] & SQSORT_THREAD) {
91c27aee 240 if (!sqimap_capability($imapConnection,'THREAD')) {
241 $aMailbox['SORT'] ^= SQSORT_THREAD;
242 } else {
243 $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT'];
244 }
324ac3c5 245 } else {
324ac3c5 246 $aMailbox['THREAD_INDENT'] = false;
247 }
248
249 /* set a timestamp for cachecontrol */
250 $aMailbox['TIMESTAMP'] = time();
251 return $aMailbox;
252}
253
c7df3f1b 254/**
91c27aee 255 * Fetch the message headers for a mailbox. Settings are part of the aMailbox
4955562f 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
62f7daa5 258 *
91c27aee 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
4955562f 262 * @since 1.5.1
91c27aee 263 * @author Marc Groot Koerkamp
62f7daa5 264 */
d0b119a5 265function fetchMessageHeaders($imapConnection, &$aMailbox) {
e0e30169 266
91c27aee 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 */
324ac3c5 270
271 /**
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.
276 */
277 $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
278
279 $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
280 /**
281 * Adjust the start_msg
282 */
283 $start_msg = $aMailbox['PAGEOFFSET'];
284 if($aMailbox['PAGEOFFSET'] > $aMailbox['EXISTS']) {
285 $start_msg -= $aMailbox['LIMIT'];
286 if($start_msg < 1) {
287 $start_msg = 1;
288 }
289 }
d0b119a5 290
324ac3c5 291 if (is_array($aMailbox['UIDSET'])) {
292 $aUid =& $aMailbox['UIDSET'][$iSetIndx];
f6b262a3 293 } else {
324ac3c5 294 $aUid = false;
295 }
d0b119a5 296 $aFetchHeaders = $aMailbox['FETCHHEADERS'];
324ac3c5 297
91c27aee 298 $iError = 0;
299 $aFetchItems = $aHeaderItems = array();
324ac3c5 300 // initialize the fields we want to retrieve:
b4246036 301 $aHeaderFields = array();
91c27aee 302 foreach ($aFetchHeaders as $v) {
303 switch ($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;
314 default: break;
315 }
324ac3c5 316 }
317
324ac3c5 318 /**
319 * A uidset with sorted uid's is available. We can use the cache
320 */
91c27aee 321 if (isset($aUid) && $aUid ) {
324ac3c5 322 // limit the cache to SQM_MAX_PAGES_IN_CACHE
91c27aee 323 if (!$aMailbox['SHOWALL'][$iSetIndx] && isset($aMailbox['MSG_HEADERS'])) {
324ac3c5 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) {
329 if ($iReduce) {
330 unset($aMailbox['MSG_HEADERS'][$iUid]);
331 } else {
332 break;
333 }
334 --$iReduce;
335 }
6a622b59 336 }
e9e5f0fa 337 }
324ac3c5 338
339 $id_slice = array_slice($aUid,$start_msg-1,$iLimit);
340 /* do some funky cache checks */
6ab20f61 341 if (isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) {
fe1521ef 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]);
346 }
347 }
91c27aee 348 $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
349 } else {
350 $aMailbox['MSG_HEADERS'] = array();
351 $aUidCached = array();
352 }
324ac3c5 353 $aUidNotCached = array_values(array_diff($id_slice,$aUidCached));
91c27aee 354
324ac3c5 355 /**
356 * $aUidNotCached contains an array with UID's which need to be fetched to
357 * complete the needed message headers.
358 */
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;
8cc8ec79 364 }
324ac3c5 365 } else {
366 /**
91c27aee 367 * Initialize the sorted UID list or initiate a UID list with search
368 * results and fetch the visible message headers
324ac3c5 369 */
324ac3c5 370
91c27aee 371 if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') { // in case of a search request
372
324ac3c5 373 if ($aMailbox['SEARCH'][$iSetIndx] && $aMailbox['SORT'] == 0) {
374 $aUid = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
375 } else {
91c27aee 376
377 $iError = 0;
378 $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
324ac3c5 379 $aUid = $aMailbox['UIDSET'][$iSetIndx];
03975a39 380 }
91c27aee 381 if (!$iError) {
382 /**
383 * Number of messages is the resultset
384 */
385 $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
324ac3c5 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);
390 } else {
91c27aee 391 $iError = 1; // FIX ME, define an error code
324ac3c5 392 }
03975a39 393 }
91c27aee 394 } else { //
395 $iError = 0;
396 $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
397 $aUid = $aMailbox['UIDSET'][$iSetIndx];
398
399 if (!$iError) {
400 /**
401 * Number of messages is the resultset
402 */
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);
324ac3c5 408 } else {
91c27aee 409 $iError = 1; // FIX ME, define an error code
324ac3c5 410 }
411 }
8cc8ec79 412 }
8cc8ec79 413 }
91c27aee 414 return $iError;
0fdc2fb6 415}
a966982b 416
4955562f 417/**
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.
420 *
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
424 * @since 1.5.1
425 * @author Marc Groot Koerkamp
426 */
91c27aee 427function prepareMessageList(&$aMailbox, $aProps) {
84bb1d31 428
429 /* Globalize link attributes so plugins can share in modifying them */
02def6a1 430 global $link, $title, $target, $onclick, $link_extra, $preselected;
84bb1d31 431
91c27aee 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';
a966982b 440
91c27aee 441 /*
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
446 */
8cc8ec79 447
91c27aee 448 /**
449 * Only retrieve values for displayable columns
450 */
451 foreach ($aColumnDesc as $k => $v) {
452 switch ($k) {
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;
464 default: break;
465 }
466 }
83eb12fc 467 $aExtraHighLightColumns = array();
468 foreach ($aExtraColumns as $v) {
469 switch ($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;
23541351 475 default: break;
476 }
477 }
91c27aee 478 $aFormattedMessages = array();
479
480
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));
8cc8ec79 495 } else {
91c27aee 496 $aInitQuery = false;
8cc8ec79 497 }
498
91c27aee 499 if ($aMailbox['SORT'] & SQSORT_THREAD) {
500 $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']];
501 $bThread = true;
502 } else {
503 $bThread = false;
504 }
505 /*
506 * Retrieve value for checkbox column
507 */
508 if (!sqgetGlobalVar('checkall',$checkall,SQ_GET)) {
509 $checkall = false;
e4b5f9d1 510 }
511
91c27aee 512 /*
513 * Loop through and display the info for each message.
514 */
515 $iEnd = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $iOffset + $aMailbox['LIMIT'];
516 for ($i=$iOffset,$t=0;$i<$iEnd;++$i) {
517 if (isset($aId[$i])) {
518
519 $bHighLight = false;
02e830bd 520 $value = $title = $link = $target = $onclick = $link_extra = '';
91c27aee 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];
8008456a 526 }
91c27aee 527 $iUid = (isset($aMsg['UID'])) ? $aMsg['UID'] : $aId[$i];
528 if ($aQuery) {
529 $aQuery[] = "passed_id=$aId[$i]";
530 $aQuery[] = "startMessage=$iPageOffset";
8008456a 531 }
91c27aee 532
533 foreach ($aCol as $k => $v) {
02e830bd 534 $title = $link = $target = $onclick = $link_extra = '';
91c27aee 535 $aColumns[$k] = array();
536 $value = (isset($aMsg[$v])) ? $aMsg[$v] : '';
537 $sUnknown = _("Unknown recipient");
538 switch ($k) {
539 case SQM_COL_FROM:
540 $sUnknown = _("Unknown sender");
541 case SQM_COL_TO:
542 case SQM_COL_CC:
543 case SQM_COL_BCC:
544 $sTmp = false;
545 if ($value) {
546 if ($highlight_list && !$bHighLight) {
547 $bHighLight = highlightMessage($aCol[$k], $value, $highlight_list,$aFormattedMessages[$iUid]);
548 }
582bbe27 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] : '';
556 if ($sPersonal) {
557 $title .= htmlspecialchars($sMailbox.'@'.$sHost).', ';
558 } else {
559 // if $value gets truncated we need to add the addresses with no
560 // personal name as well
561 $title_maybe .= htmlspecialchars($sMailbox.'@'.$sHost).', ';
562 }
563 }
564 if ($title) {
565 $title = substr($title,0,-2); // strip ', ';
566 }
86ef259b 567 $sTmp = decodeHeader($sTmp);
91c27aee 568 if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
569 $sTrunc = truncateWithEntities($sTmp, $aColumnDesc[$k]['truncate']);
582bbe27 570 if ($sTrunc != $sTmp) {
571 if (!$title) {
2b883a9a 572 $title = $sTmp;
582bbe27 573 } else if ($title_maybe) {
574 $title = $title .', '.$title_maybe;
575 $title = substr($title,0,-2); // strip ', ';
576 }
577 }
91c27aee 578 $sTmp = $sTrunc;
579 }
580 }
86ef259b 581 $value = ($sTmp) ? $sTmp : $sUnknown;
91c27aee 582 break;
583 case SQM_COL_SUBJ:
d0b119a5 584 // subject is mime encoded, decode it.
129c22ed 585 // value is sanitized in decoding function.
86ef259b 586 // TODO, verify if it should be done before or after the highlighting
129c22ed 587 $value=decodeHeader($value);
91c27aee 588 if ($highlight_list && !$bHighLight) {
589 $bHighLight = highlightMessage('SUBJECT', $value, $highlight_list, $aFormattedMessages[$iUid]);
590 }
591 $iIndent = (isset($aIndentArray[$aId[$i]])) ? $aIndentArray[$aId[$i]] : 0;
129c22ed 592 // FIXME: don't break 8bit symbols and html entities during truncation
91c27aee 593 if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
594 $sTmp = truncateWithEntities($value, $aColumnDesc[$k]['truncate']-$iIndent);
887f7f28 595 // drop any double spaces since these will be displayed in the title
596 $title = ($sTmp != $value) ? preg_replace('/\s{2,}/', ' ', $value) : '';
91c27aee 597 $value = $sTmp;
598 }
599 /* generate the link to the message */
600 if ($aQuery) {
601 // TODO, $sTargetModule should be a query parameter so that we can use a single entrypoint
602 $link = $sTargetModule.'.php?' . implode('&amp;',$aQuery);
02e830bd 603
84bb1d31 604 // see top of this function for which attributes are available
202bcbcc 605 // in the global scope for plugin use (like $link, $target,
84bb1d31 606 // $onclick, $link_extra, $title, and so forth)
202bcbcc 607 // plugins are responsible for sharing nicely (such as for
84bb1d31 608 // setting the target, etc)
0e525861 609 $temp = array(&$iPageOffset, &$sSearch, &$aSearch, $aMsg);
610 do_hook('subject_link', $temp);
91c27aee 611 }
91c27aee 612 $value = (trim($value)) ? $value : _("(no subject)");
613 /* add thread indentation */
614 $aColumns[$k]['indent'] = $iIndent;
91c27aee 615 break;
616 case SQM_COL_SIZE:
617 $value = show_readable_size($value);
618 break;
619 case SQM_COL_DATE:
620 case SQM_COL_INT_DATE:
3b64ced2 621 $value = getDateString(getTimeStamp(explode(' ',trim($value))));
91c27aee 622 break;
623 case SQM_COL_FLAGS:
624 $aFlagColumn = array('seen' => false,
625 'deleted'=>false,
626 'answered'=>false,
1a753239 627 'forwarded'=>false,
91c27aee 628 'flagged' => false,
629 'draft' => false);
c3731db5 630
631 if(!is_array($value)) $value = array();
e961d845 632 foreach ($value as $sFlag => $v) {
91c27aee 633 switch ($sFlag) {
1a753239 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;
91c27aee 640 default: break;
641 }
642 }
643 $value = $aFlagColumn;
644 break;
645 case SQM_COL_PRIO:
646 $value = ($value) ? (int) $value : 3;
647 break;
648 case SQM_COL_ATTACHMENT:
649 $value = (is_array($value) && $value[0] == 'multipart' && $value[1] == 'mixed') ? true : false;
650 break;
651 case SQM_COL_CHECK:
02def6a1 652 $value = ($checkall || in_array($iUid, $preselected));
91c27aee 653 break;
654 default : break;
655 }
02e830bd 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; }
91c27aee 661 $aColumns[$k]['value'] = $value;
8008456a 662 }
91c27aee 663 /* columns which will not be displayed but should be inspected
664 because the highlight list contains rules with those columns */
83eb12fc 665 foreach ($aExtraHighLightColumns as $v) {
666 if ($highlight_list && !$bHighLight && isset($aMsg[$v])) {
667 $bHighLight = highlightMessage($v, $aMsg[$v], $highlight_list,$aFormattedMessages[$iUid]);
91c27aee 668 }
03975a39 669 }
91c27aee 670 $aFormattedMessages[$iUid]['columns'] = $aColumns;
671
672 } else {
8008456a 673 break;
674 }
bdfb67f8 675 }
91c27aee 676 return $aFormattedMessages;
bdfb67f8 677}
678
e9e5f0fa 679
4955562f 680/**
681 * Sets the row color if the provided column value pair matches a hightlight rule
682 *
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
688 * @since 1.5.1
689 * @author Marc Groot Koerkamp
690 */
91c27aee 691function highlightMessage($sCol, $sVal, $highlight_list, &$aFormat) {
91c27aee 692 if (!is_array($highlight_list) && count($highlight_list) == 0) {
693 return false;
694 }
695 $hlt_color = false;
696 $sCol = strtoupper($sCol);
83eb12fc 697
91c27aee 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') {
704 $match_type = $sCol;
705 } else {
706 continue;
707 }
708 } else {
709 if ($match_type != $sCol) {
710 continue;
711 }
712 }
713 if (strpos(strtolower($sVal),$high_val) !== false) {
714 $hlt_color = $highlight_list_part['color'];
715 break;
716 }
717 }
718 }
719 if ($hlt_color) {
d0b119a5 720 // Bug in highlight color???
f3a1e5fa 721 if ($hlt_color{0} != '#') {
722 $hlt_color = '#'. $hlt_color;
723 }
91c27aee 724 $aFormat['row']['color'] = $hlt_color;
725 return true;
e35045b7 726 } else {
91c27aee 727 return false;
6c930ade 728 }
91c27aee 729}
6a622b59 730
91c27aee 731function setUserPref($username, $pref, $value) {
732 global $data_dir;
733 setPref($data_dir,$username,$pref,$value);
6a622b59 734}
735
c7df3f1b 736/**
4b4abf93 737 * Execute the sorting for a mailbox
738 *
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
742 * @private
4955562f 743 * @since 1.5.1
4b4abf93 744 * @author Marc Groot Koerkamp
745 */
91c27aee 746function _get_sorted_msgs_list($imapConnection,&$aMailbox) {
747 $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
49719da8 748 $bDirection = !($aMailbox['SORT'] % 2);
91c27aee 749 $error = 0;
750 if (!$aMailbox['SEARCH'][$iSetIndx]) {
751 $aMailbox['SEARCH'][$iSetIndx] = 'ALL';
752 }
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;
6a622b59 758 } else {
91c27aee 759 $aMailbox['UIDSET'][$iSetIndx] = $aRes[0];
760 $aMailbox['THREAD_INDENT'][$iSetIndx] = $aRes[1];
a6d36aa5 761 }
91c27aee 762 } else if ($aMailbox['SORT'] === SQSORT_NONE) {
763 $id = sqimap_run_search($imapConnection, 'ALL' , '');
764 if ($id === false) {
765 $error = 1; // fix me, define an error code
a6d36aa5 766 } else {
91c27aee 767 $aMailbox['UIDSET'][$iSetIndx] = array_reverse($id);
768 $aMailbox['TOTAL'][$iSetIndx] = $aMailbox['EXISTS'];
a6d36aa5 769 }
91c27aee 770 } else {
771 if (sqimap_capability($imapConnection,'SORT')) {
772 $sSortField = _getSortField($aMailbox['SORT'],true);
773 $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection, $aMailbox['SEARCH'][$iSetIndx]);
774 if ($id === false) {
775 $error = 1; // fix me, define an error code
776 } else {
777 $aMailbox['UIDSET'][$iSetIndx] = $id;
778 }
6a622b59 779 } else {
91c27aee 780 $id = NULL;
781 if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') {
782 $id = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
783 }
784 $sSortField = _getSortField($aMailbox['SORT'],false);
785 $aMailbox['UIDSET'][$iSetIndx] = get_squirrel_sort($imapConnection, $sSortField, $bDirection, $id);
6a622b59 786 }
e35045b7 787 }
91c27aee 788 return $error;
bdfb67f8 789}
1a0e0983 790
c7df3f1b 791/**
4b4abf93 792 * Does the $srt $_GET var to field mapping
793 *
794 * @param int $srt Field to sort on
795 * @param bool $bServerSort Server sorting is true
796 * @return string $sSortField Field to sort on
4955562f 797 * @since 1.5.1
4b4abf93 798 * @private
799 */
91c27aee 800function _getSortField($sort,$bServerSort) {
801 switch($sort) {
802 case SQSORT_NONE:
803 $sSortField = 'UID';
804 break;
805 case SQSORT_DATE_ASC:
806 case SQSORT_DATE_DESC:
807 $sSortField = 'DATE';
808 break;
809 case SQSORT_FROM_ASC:
810 case SQSORT_FROM_DESC:
811 $sSortField = 'FROM';
812 break;
813 case SQSORT_SUBJ_ASC:
814 case SQSORT_SUBJ_DESC:
815 $sSortField = 'SUBJECT';
816 break;
817 case SQSORT_SIZE_ASC:
818 case SQSORT_SIZE_DESC:
819 $sSortField = ($bServerSort) ? 'SIZE' : 'RFC822.SIZE';
820 break;
821 case SQSORT_TO_ASC:
822 case SQSORT_TO_DESC:
823 $sSortField = 'TO';
824 break;
825 case SQSORT_CC_ASC:
826 case SQSORT_CC_DESC:
827 $sSortField = 'CC';
828 break;
829 case SQSORT_INT_DATE_ASC:
830 case SQSORT_INT_DATE_DESC:
831 $sSortField = ($bServerSort) ? 'ARRIVAL' : 'INTERNALDATE';
832 break;
833 case SQSORT_THREAD:
834 break;
835 default: $sSortField = 'UID';
836 break;
837
6a622b59 838 }
91c27aee 839 return $sSortField;
bdfb67f8 840}
841
4955562f 842/**
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.
848 *
849 * @param array $aMailbox associative array with mailbox related vars
850 * @param array $aProps
851 * @return void
852 * @since 1.5.1
853 */
854
c3731db5 855function calcFetchColumns(&$aMailbox, &$aProps) {
856
857 $highlight_list = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
858 $aColumnsDesc = (isset($aProps['columns'])) ? $aProps['columns'] : false;
859
860 $aFetchColumns = $aColumnsDesc;
861 if (isset($aFetchColumns[SQM_COL_CHECK])) {
862 unset($aFetchColumns[SQM_COL_CHECK]);
863 }
864
865 /*
866 * Before we fetch the message headers, check if we need to fetch extra columns
867 * to make the message highlighting work
868 */
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) {
875 case 'TO_CC':
876 $aHighlightColumns[SQM_COL_TO] = true;
877 $aHighlightColumns[SQM_COL_CC] = true;
878 break;
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;
883 }
884 }
885 }
886 $aExtraColumns = array();
887 foreach ($aHighlightColumns as $k => $v) {
888 if (!isset($aFetchColumns[$k])) {
889 $aExtraColumns[] = $k;
890 $aFetchColumns[$k] = true;
891 }
892 }
893 if (count($aExtraColumns)) {
894 $aProps['extra_columns'] = $aExtraColumns;
895 }
896 }
897 $aMailbox['FETCHHEADERS'] = array_keys($aFetchColumns);
c3731db5 898}
6a622b59 899
6a622b59 900
91c27aee 901/**
4b4abf93 902 * This function loops through a group of messages in the mailbox
903 * and shows them to the user.
904 *
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
909 */
91c27aee 910function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
911 global $PHP_SELF;
24bb7e49 912 global $boxes, $show_copy_buttons;
91c27aee 913
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;
24bb7e49 921
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'];
925
91c27aee 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'];
6a622b59 937
6a622b59 938
91c27aee 939 /*
940 * Form ID
941 */
942 static $iFormId;
324ac3c5 943
91c27aee 944 if (!isset($iFormId)) {
945 $iFormId=1;
946 } else {
947 ++$iFormId;
948 }
d0b119a5 949 // store the columns to fetch so we can pick them up in read_body
91c27aee 950 // where we validate the cache.
c3731db5 951 calcFetchColumns($aMailbox ,$aProps);
e35045b7 952
d0b119a5 953 $iError = fetchMessageHeaders($imapConnection, $aMailbox);
91c27aee 954 if ($iError) {
955 return array();
956 } else {
957 $aMessages = prepareMessageList($aMailbox, $aProps);
958 }
6a622b59 959
91c27aee 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'];
6a622b59 964
91c27aee 965 $iNumberOfMessages = $aMailbox['TOTAL'][$iSetIndx];
aa2e9274 966 $iEnd = min ( $iEnd, $iNumberOfMessages );
6a622b59 967
91c27aee 968 $php_self = $PHP_SELF;
6a622b59 969
91c27aee 970 $urlMailbox = urlencode($aMailbox['NAME']);
6a622b59 971
91c27aee 972 if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
973 $source_url = $regs[1];
974 } else {
975 $source_url = $php_self;
976 }
6a622b59 977
f830c8ed 978 $baseurl = $source_url.'?mailbox=' . urlencode($aMailbox['NAME']) .'&amp;account='.$aMailbox['ACCOUNT'] . (strpos($source_url, 'src/search.php') ? '&amp;smtoken=' . sm_generate_security_token() : '');
91c27aee 979 $where = urlencode($aMailbox['SEARCH'][$iSetIndx][0]);
980 $what = urlencode($aMailbox['SEARCH'][$iSetIndx][1]);
981 $baseurl .= '&amp;where=' . $where . '&amp;what=' . $what;
982
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");
989 } else {
990 $thread_name = _("Thread View");
991 $newsort = $aMailbox['SORT'] + SQSORT_THREAD;
6a622b59 992 }
cd693cf4 993 $thread_link_uri = $baseurl . '&amp;srt=' . $newsort
994 . '&amp;startMessage=1';
324ac3c5 995 } else {
cd693cf4 996 $thread_link_uri ='';
997 $thread_name = '';
6a622b59 998 }
91c27aee 999 $sort = $aMailbox['SORT'];
6a622b59 1000
91c27aee 1001 /* FIX ME ADD CHECKBOX CONTROL. No checkbox => no buttons */
1002
1003
1004
1005 /* future admin control over displayable buttons */
91c27aee 1006 $aAdminControl = array(
91c27aee 1007 'markFlagged' => 1,
47485591 1008 'markUnflagged' => 1,
91c27aee 1009 'markRead' => 1,
1010 'markUnread' => 1,
a5d40e74 1011 'forward' => 1,
91c27aee 1012 'delete' => 1,
1013 'undeleteButton'=> 1,
1014 'bypass_trash' => 1,
1015 'expungeButton' => 1,
24bb7e49 1016 'moveButton' => 1,
1017 'copyButton' => 1
91c27aee 1018 );
24bb7e49 1019
91c27aee 1020 /* user prefs control */
1021 $aUserControl = array (
a5d40e74 1022
91c27aee 1023 'markFlagged' => $show_flag_buttons,
47485591 1024 'markUnflagged' => $show_flag_buttons,
91c27aee 1025 'markRead' => 1,
1026 'markUnread' => 1,
a5d40e74 1027 'forward' => 1,
91c27aee 1028 'delete' => 1,
1029 'undeleteButton'=> 1,
1030 'bypass_trash' => 1,
1031 'expungeButton' => 1,
24bb7e49 1032 'moveButton' => 1,
1033 'copyButton' => $show_copy_buttons
a5d40e74 1034
91c27aee 1035 );
1036
1037 $showDelete = ($aMailbox['RIGHTS'] != 'READ-ONLY' &&
1038 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ? true : false;
a5d40e74 1039 $showByPassTrash = (($aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
91c27aee 1040 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) &&
a5d40e74 1041 $trash_folder) ? true : false; //
1042
91c27aee 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;
24bb7e49 1048
1049 /* Button options that depend on IMAP server and selected folder */
91c27aee 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),
a5d40e74 1055 'forward' => 1,
91c27aee 1056 'delete' => $showDelete,
1057 'undeleteButton'=> $showUndelete,
1058 'bypass_trash' => $showByPassTrash,
1059 'expungeButton' => $showExpunge,
24bb7e49 1060 'moveButton' => $showMove,
1061 'copyButton' => 1
91c27aee 1062 );
24bb7e49 1063 /* Button strings */
91c27aee 1064 $aButtonStrings = array(
47485591 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")
1076 );
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,
91c27aee 1096 );
a5d40e74 1097
1098
6a622b59 1099 /**
91c27aee 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.
62f7daa5 1102 */
91c27aee 1103 $aFormElements = array();
1104 foreach($aAdminControl as $k => $v) {
1105 if ($v & $aUserControl[$k] & $aImapControl[$k]) {
1106 switch ($k) {
91c27aee 1107 case 'markFlagged':
47485591 1108 case 'markUnflagged':
91c27aee 1109 case 'markRead':
1110 case 'markUnread':
1111 case 'delete':
1112 case 'undeleteButton':
1113 case 'expungeButton':
1114 case 'forward':
4127171c 1115 $aFormElements[$k]
47485591 1116 = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
91c27aee 1117 break;
1118 case 'bypass_trash':
4127171c 1119 $aFormElements[$k]
47485591 1120 = array('value' => $aButtonStrings[$k], 'type' => 'checkbox', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
91c27aee 1121 break;
1122 case 'moveButton':
24bb7e49 1123 case 'copyButton':
4127171c 1124 $aFormElements['targetMailbox']
1125 = array('options_list' => sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes),
47485591 1126 'type' => 'select',
1127 'accesskey' => $accesskey_mailbox_move_to);
4127171c 1128 $aFormElements['mailbox']
1129 = array('value' => $aMailbox['NAME'], 'type' => 'hidden');
1130 $aFormElements['startMessage']
1131 = array('value' => $aMailbox['PAGEOFFSET'], 'type' => 'hidden');
1132 $aFormElements[$k]
47485591 1133 = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
91c27aee 1134 break;
0bb37159 1135 }
1136 }
4127171c 1137 $aFormElements['account'] = array('value' => $iAccount,'type' => 'hidden');
91c27aee 1138 }
4127171c 1139 do_hook('message_list_controls', $aFormElements);
0bb37159 1140
91c27aee 1141 /*
4b4abf93 1142 * This is the beginning of the message list table.
1143 * It wraps around all messages
1144 */
91c27aee 1145 $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
1146 $form_name = "FormMsgs" . $safe_name;
0bb37159 1147
91c27aee 1148 //if (!sqgetGlobalVar('align',$align,SQ_SESSION)) {
1149 $align = array('left' => 'left', 'right' => 'right');
1150 //}
1151 //sm_print_r($align);
1152
1153 /* finally set the template vars */
1154
4127171c 1155// FIXME, before we support multiple templates we must review the names of the vars
1156// BUMP!
91c27aee 1157
1158
91c27aee 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;
cd693cf4 1178 $aTemplate['thread_link_uri'] = $thread_link_uri;
1179 $aTemplate['thread_name'] = $thread_name;
91c27aee 1180 $aTemplate['php_self'] = str_replace('&','&amp;',$php_self);
1181 $aTemplate['mailbox'] = $sMailbox;
83aff890 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!
91c27aee 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;
1189
49719da8 1190
4127171c 1191 /**
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.
1196 */
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));
1206 } else {
1207 $aTemplate['aSortSupported'] = array();
1208 }
1209
1210
1211 /**
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
1215 * the message view
1216 *
1217 * if $javascript_on is set, then the highlighting code takes
1218 * care of this; just skip it
1219 *
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.
1224 *
1225 */
1226 $show_label_columns = array();
1227 $index_order_part = array();
1228 if (!($aTemplate['javascript_on'] && $aTemplate['fancy_index_highlite'])) {
1229 $get_next_two = 0;
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) {
1234 $get_next_two = 1;
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;
1239
1240 } else if ($get_next_two > 0 && $get_next_two < 3 && $index_order_part != SQM_COL_SUBJ) {
1241 $show_label_columns[] = $index_order_part;
1242 $get_next_two++;
1243 }
1244 $last_last_order_part = $last_order_part;
1245 $last_order_part = $index_order_part;
1246 }
1247 }
1248 $aTemplate['show_label_columns'] = $show_label_columns;
1249
1250
91c27aee 1251 return $aTemplate;
4127171c 1252
bdfb67f8 1253}
1254
91c27aee 1255
c7df3f1b 1256/**
4b4abf93 1257 * Truncates a string and take care of html encoded characters
1258 *
1259 * @param string $s string to truncate
1260 * @param int $iTrimAt Trim at nn characters
1261 * @return string Trimmed string
1262 */
d7112bcb 1263function truncateWithEntities($s, $iTrimAt) {
eaa4f45f 1264 global $languages, $squirrelmail_language;
6a622b59 1265
d7112bcb 1266 $ent_strlen = strlen($s);
1267 if (($iTrimAt <= 0) || ($ent_strlen <= $iTrimAt))
1268 return $s;
6a622b59 1269
1270 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
b3e4bf71 1271 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth')) {
d7112bcb 1272 return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth', $s, $iTrimAt);
1273 } else {
1274 /*
4b4abf93 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.
1279 */
d7112bcb 1280 $trim_val = $iTrimAt;
1281 $ent_offset = 0;
1282 $ent_loc = 0;
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;
1287 }
ecaf6352 1288
d7112bcb 1289 if (($trim_val > $iTrimAt) && ($ent_strlen > $trim_val) && (strpos($s,';',$trim_val) < ($trim_val + 6))) {
1290 $i = strpos($s,';',$trim_val);
1291 if ($i !== false) {
1292 $trim_val = strpos($s,';',$trim_val)+1;
1293 }
1294 }
1295 // only print '...' when we're actually dropping part of the subject
1296 if ($ent_strlen <= $trim_val)
1297 return $s;
1298 }
1299 return substr_replace($s, '...', $trim_val);
e9e5f0fa 1300}
1301
d7112bcb 1302
c7df3f1b 1303/**
324ac3c5 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
1307 *
1308 * @param resource $imapConnection imap connection
ee19932b 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
324ac3c5 1314 * @return string $sError error string in case of an error
4955562f 1315 * @since 1.5.1
324ac3c5 1316 * @author Marc Groot Koerkamp
1317 */
ee19932b 1318function handleMessageListForm($imapConnection, &$aMailbox, $sButton='',
1319 $aUid = array(), $targetMailbox='', $bypass_trash=NULL) {
324ac3c5 1320 /* incoming formdata */
c9b94b04 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;
ee19932b 1331 if (empty($targetMailbox)) sqgetGlobalVar('targetMailbox', $targetMailbox, SQ_FORM);
1332 if (is_null($bypass_trash)) sqgetGlobalVar('bypass_trash', $bypass_trash, SQ_FORM);
c9b94b04 1333 sqgetGlobalVar('msg', $msg, SQ_FORM);
1334 if (sqgetGlobalVar('account', $iAccount, SQ_FORM) === false) {
91c27aee 1335 $iAccount = 0;
1336 }
324ac3c5 1337 $sError = '';
1338 $mailbox = $aMailbox['NAME'];
1339
1340 /* retrieve the check boxes */
1341 $aUid = (isset($msg) && is_array($msg)) ? array_values($msg) : $aUid;
324ac3c5 1342 if (count($aUid) && $sButton != 'expunge') {
51bbe8fa 1343
199a9ab8 1344 // don't do anything to any messages until we have done security check
1345 // FIXME: not sure this code really belongs here, but there's nowhere else to put it with this architecture
7e6bff9b 1346 sqgetGlobalVar('smtoken', $submitted_token, SQ_FORM, '');
199a9ab8 1347 sm_validate_security_token($submitted_token, 3600, TRUE);
1348
51bbe8fa 1349 // make sure message UIDs are sanitized (BIGINT)
1350 foreach ($aUid as $i => $uid)
1351 $aUid[$i] = (preg_match('/^[0-9]+$/', $uid) ? $uid : '0');
1352
324ac3c5 1353 $aUpdatedMsgs = false;
1354 $bExpunge = false;
1355 switch ($sButton) {
1356 case 'setDeleted':
1357 // check if id exists in case we come from read_body
1358 if (count($aUid) == 1 && is_array($aMailbox['UIDSET'][$aMailbox['SETINDEX']]) &&
1359 !in_array($aUid[0],$aMailbox['UIDSET'][$aMailbox['SETINDEX']])) {
1360 break;
1361 }
7c788b1c 1362 $aUpdatedMsgs = sqimap_msgs_list_delete($imapConnection, $mailbox, $aUid,$bypass_trash);
1363 $bExpunge = true;
91c27aee 1364 //}
324ac3c5 1365 break;
1366 case 'unsetDeleted':
1367 case 'setSeen':
1368 case 'unsetSeen':
1369 case 'setFlagged':
1370 case 'unsetFlagged':
1371 // get flag
1372 $sFlag = (substr($sButton,0,3) == 'set') ? '\\'.substr($sButton,3) : '\\'.substr($sButton,5);
1373 $bSet = (substr($sButton,0,3) == 'set') ? true : false;
1374 $aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
1375 break;
1376 case 'move':
821651ff 1377 $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox,true,$mailbox);
324ac3c5 1378 sqsession_register($targetMailbox,'lastTargetMailbox');
1379 $bExpunge = true;
1380 break;
24bb7e49 1381 case 'copy':
b400dda3 1382 // sqimap_msgs_list_copy returns true or false.
1383 // If error happens - fourth argument handles it inside function.
1384 sqimap_msgs_list_copy($imapConnection,$aUid,$targetMailbox,true);
24bb7e49 1385 sqsession_register($targetMailbox,'lastTargetMailbox');
1386 break;
91c27aee 1387 case 'forward':
324ac3c5 1388 $aMsgHeaders = array();
1389 foreach ($aUid as $iUid) {
1390 $aMsgHeaders[$iUid] = $aMailbox['MSG_HEADERS'][$iUid];
1391 }
1392 if (count($aMsgHeaders)) {
1393 $composesession = attachSelectedMessages($imapConnection,$aMsgHeaders);
1394 // dirty hack, add info to $aMailbox
e506b6e5 1395 $aMailbox['FORWARD_SESSION']['SESSION_NUMBER'] = $composesession;
1396 $aMailbox['FORWARD_SESSION']['UIDS'] = $aUid;
324ac3c5 1397 }
1398 break;
7c788b1c 1399 default:
91c27aee 1400 // Hook for plugin buttons
c1c0ce3e 1401 $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], &$aUid);
b77cbccc 1402 do_hook('mailbox_display_button_action', $temp);
91c27aee 1403 break;
324ac3c5 1404 }
1405 /**
bdfa0f9a 1406 * $aUpdatedMsgs is an array containing the result of the untagged
324ac3c5 1407 * fetch responses send by the imap server due to a flag change. That
bdfa0f9a 1408 * response is parsed in an array with msg arrays by the parseFetch function
324ac3c5 1409 */
1410 if ($aUpdatedMsgs) {
1411 // Update the message headers cache
1412 $aDeleted = array();
1413 foreach ($aUpdatedMsgs as $iUid => $aMsg) {
1414 if (isset($aMsg['FLAGS'])) {
fd28fa79 1415 /**
ddd209f2 1416 * Only update the cached headers if the header is
fd28fa79 1417 * cached.
1418 */
1419 if (isset($aMailbox['MSG_HEADERS'][$iUid])) {
1420 $aMailbox['MSG_HEADERS'][$iUid]['FLAGS'] = $aMsg['FLAGS'];
1421 }
324ac3c5 1422 /**
bdfa0f9a 1423 * Also update flags in message object
1424 */
1425//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.
1426 if (isset($aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'])) {
1427 $message = $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'];
1428 $message->is_seen = false;
1429 $message->is_answered = false;
1a753239 1430 $message->is_forwarded = false;
bdfa0f9a 1431 $message->is_deleted = false;
1432 $message->is_flagged = false;
1433 $message->is_mdnsent = false;
1434 foreach ($aMsg['FLAGS'] as $flag => $value) {
1435 if (strtolower($flag) == '\\seen' && $value)
1436 $message->is_seen = true;
1437 else if (strtolower($flag) == '\\answered' && $value)
1438 $message->is_answered = true;
1a753239 1439 else if (strtolower($flag) == '$forwarded' && $value)
1440 $message->is_forwarded = true;
bdfa0f9a 1441 else if (strtolower($flag) == '\\deleted' && $value)
1442 $message->is_deleted = true;
1443 else if (strtolower($flag) == '\\flagged' && $value)
1444 $message->is_flagged = true;
1445 else if (strtolower($flag) == '$mdnsent' && $value)
1446 $message->is_mdnsent = true;
1447 }
1448 $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'] = $message;
1449 }
1450 /**
324ac3c5 1451 * Count the messages with the \Delete flag set so we can determine
1452 * if the number of expunged messages equals the number of flagged
1453 * messages for deletion.
1454 */
1455 if (isset($aMsg['FLAGS']['\\deleted']) && $aMsg['FLAGS']['\\deleted']) {
1456 $aDeleted[] = $iUid;
1457 }
1458 }
1459 }
1460 if ($bExpunge && $aMailbox['AUTO_EXPUNGE'] &&
1461 $iExpungedMessages = sqimap_mailbox_expunge($imapConnection, $aMailbox['NAME'], true))
1462 {
1463 if (count($aDeleted) != $iExpungedMessages) {
1464 // there are more messages deleted permanently then we expected
1465 // invalidate the cache
1466 $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = false;
1467 $aMailbox['MSG_HEADERS'] = false;
1468 } else {
1469 // remove expunged messages from cache
1470 $aUidSet = $aMailbox['UIDSET'][$aMailbox['SETINDEX']];
1471 if (is_array($aUidSet)) {
1472 // create a UID => array index temp array
1473 $aUidSetDummy = array_flip($aUidSet);
1474 foreach ($aDeleted as $iUid) {
1475 // get the id as well in case of SQM_SORT_NONE
1476 if ($aMailbox['SORT'] == SQSORT_NONE) {
1477 $aMailbox['ID'] = false;
1478 //$iId = $aMailbox['MSG_HEADERS'][$iUid]['ID'];
1479 //unset($aMailbox['ID'][$iId]);
1480 }
1481 // unset the UID and message header
1482 unset($aUidSetDummy[$iUid]);
1483 unset($aMailbox['MSG_HEADERS'][$iUid]);
1484 }
1485 $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = array_keys($aUidSetDummy);
324ac3c5 1486 }
1487 }
ddd209f2 1488 // update EXISTS info
1489 if ($iExpungedMessages) {
1490 $aMailbox['EXISTS'] -= (int) $iExpungedMessages;
91c27aee 1491 $aMailbox['TOTAL'][$aMailbox['SETINDEX']] -= (int) $iExpungedMessages;
ddd209f2 1492 }
4c284a74 1493 if (($aMailbox['PAGEOFFSET']-1) >= $aMailbox['EXISTS']) {
324ac3c5 1494 $aMailbox['PAGEOFFSET'] = ($aMailbox['PAGEOFFSET'] > $aMailbox['LIMIT']) ?
1495 $aMailbox['PAGEOFFSET'] - $aMailbox['LIMIT'] : 1;
91c27aee 1496 $aMailbox['OFFSET'] = $aMailbox['PAGEOFFSET'] - 1 ;
324ac3c5 1497 }
1498 }
1499 }
1500 } else {
1501 if ($sButton == 'expunge') {
1502 /**
1503 * on expunge we do not know which messages will be deleted
1504 * so it's useless to try to sync the cache
4b4abf93 1505 *
324ac3c5 1506 * Close the mailbox so we do not need to parse the untagged expunge
1507 * responses which do not contain uid info.
1508 * NB: Closing a mailbox is faster then expunge because the imap
1509 * server does not need to generate the untagged expunge responses
1510 */
1511 sqimap_run_command($imapConnection,'CLOSE',false,$result,$message);
91c27aee 1512 $aMailbox = sqm_api_mailbox_select($imapConnection,$iAccount, $aMailbox['NAME'],array(),array());
324ac3c5 1513 } else {
b262c520 1514 // this is the same hook as above, but here it is called in the
1515 // context of not having had any messages selected and if any
1516 // plugin handles the situation, it should return TRUE so we
1517 // know this was not an erroneous user action
1518 //
1519 global $null;
c1c0ce3e 1520 $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], $null);
b77cbccc 1521 if (!boolean_hook_function('mailbox_display_button_action', $temp, 1)
b262c520 1522 && $sButton) {
324ac3c5 1523 $sError = _("No messages were selected.");
1524 }
1525 }
1526 }
1527 return $sError;
1528}
1529
4955562f 1530/**
1531 * Attach messages to a compose session
1532 *
1533 * @param resource $imapConnection imap connection
1534 * @param array $aMsgHeaders
1535 * @return int $composesession unique compose_session_id where the attached messages belong to
1536 * @author Marc Groot Koerkamp
1537 */
324ac3c5 1538function attachSelectedMessages($imapConnection,$aMsgHeaders) {
324ac3c5 1539
91c27aee 1540 sqgetGlobalVar('composesession', $composesession, SQ_SESSION);
1541 sqgetGlobalVar('compose_messages', $compose_messages, SQ_SESSION);
1542 if (!isset($compose_messages)|| is_null($compose_messages)) {
324ac3c5 1543 $compose_messages = array();
1544 sqsession_register($compose_messages,'compose_messages');
1545 }
1546
1547 if (!$composesession) {
1548 $composesession = 1;
1549 sqsession_register($composesession,'composesession');
1550 } else {
1551 $composesession++;
1552 sqsession_register($composesession,'composesession');
1553 }
1554
324ac3c5 1555 $composeMessage = new Message();
1556 $rfc822_header = new Rfc822Header();
1557 $composeMessage->rfc822_header = $rfc822_header;
1558 $composeMessage->reply_rfc822_header = '';
1559
1560 foreach($aMsgHeaders as $iUid => $aMsgHeader) {
1561 /**
1562 * Retrieve the full message
1563 */
1564 $body_a = sqimap_run_command($imapConnection, "FETCH $iUid RFC822", true, $response, $readmessage, TRUE);
324ac3c5 1565 if ($response == 'OK') {
91c27aee 1566
1567 $subject = (isset($aMsgHeader['subject'])) ? $aMsgHeader['subject'] : $iUid;
324ac3c5 1568
1569 array_shift($body_a);
1570 array_pop($body_a);
1571 $body = implode('', $body_a);
1572 $body .= "\r\n";
1573
1f270d3c 1574 global $username, $attachment_dir;
628bce99 1575 $filename = sq_get_attach_tempfile();
1f270d3c 1576 $fullpath = getHashedDir($username, $attachment_dir) . '/' . $filename;
1577 $fp = fopen($fullpath, 'wb');
324ac3c5 1578 fwrite ($fp, $body);
1579 fclose($fp);
628bce99 1580
54156b1c 1581 $composeMessage->initAttachment('message/rfc822', $subject . '.eml', $filename);
324ac3c5 1582 }
1583 }
1584
1585 $compose_messages[$composesession] = $composeMessage;
1586 sqsession_register($compose_messages,'compose_messages');
1587 return $composesession;
1588}
628bce99 1589