projects / squirrelmail.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
adding decoding of subject. might have to check other columns too.
[squirrelmail.git] / functions / mailbox_display.php
CommitLineData
59177427 1<?php
2ba13803 2
35586184 3/**
91c27aee 4* mailbox_display.php
5*
6* Copyright (c) 1999-2005 The SquirrelMail Project Team
7* Licensed under the GNU GPL. For full terms see the file COPYING.
8*
9* This contains functions that display mailbox information, such as the
10* table row that has sender, date, subject, etc...
11*
12* @version $Id$
13* @package squirrelmail
14*/
a4c2cd49 15
d6c32258 16/** The standard includes.. */
b68edc75 17require_once(SM_PATH . 'functions/strings.php');
18require_once(SM_PATH . 'functions/html.php');
b68edc75 19require_once(SM_PATH . 'functions/imap_mailbox.php');
26454147 20require_once(SM_PATH . 'functions/imap_messages.php');
324ac3c5 21require_once(SM_PATH . 'functions/imap_asearch.php');
26454147 22require_once(SM_PATH . 'functions/mime.php');
b531f8ea 23require_once(SM_PATH . 'functions/forms.php');
43fdb2a4 24
324ac3c5 25
26/**
27 * Selects a mailbox for header retrieval.
28 * Cache control for message headers is embedded.
29 *
30 * @param resource $imapConnection imap socket handle
31 * @param string $mailbox mailbox to select and retrieve message headers from
32 * @param array $aConfig array with system config settings and incoming vars
33 * @param array $aProps mailbox specific properties
34 * @return array $aMailbox mailbox array with all relevant information
35 * @author Marc Groot Koerkamp
36 */
91c27aee 37function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aProps) {
38
324ac3c5 39 /**
40 * NB: retrieve this from the session before accessing this function
41 * and make sure you write it back at the end of the script after
42 * the aMailbox var is added so that the headers are added to the cache
43 */
44 global $mailbox_cache;
91c27aee 45
324ac3c5 46 $aDefaultConfigProps = array(
324ac3c5 47// 'charset' => 'US-ASCII',
48 'user' => false, /* no pref storage if false */
49 'setindex' => 0,
50// 'search' => 'ALL',
51 'max_cache_size' => SQM_MAX_MBX_IN_CACHE
52 );
53
54 $aConfig = array_merge($aDefaultConfigProps,$aConfig);
91c27aee 55
324ac3c5 56 $iSetIndx = $aConfig['setindex'];
57
58 $aMbxResponse = sqimap_mailbox_select($imapConnection, $mailbox);
59
60 if ($mailbox_cache) {
91c27aee 61 if (isset($mailbox_cache[$account.'_'.$mailbox])) {
62 $aCachedMailbox = $mailbox_cache[$account.'_'.$mailbox];
324ac3c5 63 } else {
64 $aCachedMailbox = false;
65 }
66 /* cleanup cache */
67 if (count($mailbox_cache) > $aConfig['max_cache_size'] -1) {
68 $aTime = array();
69 foreach($mailbox_cache as $cachedmailbox => $aVal) {
70 $aTime[$aVal['TIMESTAMP']] = $cachedmailbox;
71 }
72 if (ksort($aTime,SORT_NUMERIC)) {
73 for ($i=0,$iCnt=count($mailbox_cache);$i<($iCnt-$aConfig['max_cache_size']);++$i) {
74 $sOldestMbx = array_shift($aTime);
75 /**
76 * Remove only the UIDSET and MSG_HEADERS from cache because those can
77 * contain large amounts of data.
78 */
79 if (isset($mailbox_cache[$sOldestMbx]['UIDSET'])) {
80 $mailbox_cache[$sOldestMbx]['UIDSET']= false;
81 }
82 if (isset($mailbox_cache[$sOldestMbx]['MSG_HEADERS'])) {
83 $mailbox_cache[$sOldestMbx]['MSG_HEADERS'] = false;
84 }
85 }
86 }
87 }
88
89 } else {
90 $aCachedMailbox = false;
91 }
92
93 /**
94 * Deal with imap servers that do not return the required UIDNEXT or
95 * UIDVALIDITY response
96 * from a SELECT call (since rfc 3501 it's required).
97 */
98 if (!isset($aMbxResponse['UIDNEXT']) || !isset($aMbxResponse['UIDVALIDITY'])) {
99 $aStatus = sqimap_status_messages($imapConnection,$mailbox,
100 array('UIDNEXT','UIDVALIDITY'));
101 $aMbxResponse['UIDNEXT'] = $aStatus['UIDNEXT'];
102 $aMbxResponse['UIDVALIDTY'] = $aStatus['UIDVALIDITY'];
103 }
104
91c27aee 105 $aMailbox['ACCOUNT'] = $account;
324ac3c5 106 $aMailbox['UIDSET'][$iSetIndx] = false;
107 $aMailbox['ID'] = false;
108 $aMailbox['SETINDEX'] = $iSetIndx;
109
110 if ($aCachedMailbox) {
111 /**
112 * Validate integrity of cached data
113 */
114 if ($aCachedMailbox['EXISTS'] == $aMbxResponse['EXISTS'] &&
115 $aMbxResponse['EXISTS'] &&
116 $aCachedMailbox['UIDVALIDITY'] == $aMbxResponse['UIDVALIDITY'] &&
117 $aCachedMailbox['UIDNEXT'] == $aMbxResponse['UIDNEXT'] &&
118 isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
119 (!isset($aConfig['search']) || /* always set search from the searchpage */
120 $aCachedMailbox['SEARCH'][$iSetIndx] == $aConfig['search'])) {
121 if (isset($aCachedMailbox['MSG_HEADERS'])) {
122 $aMailbox['MSG_HEADERS'] = $aCachedMailbox['MSG_HEADERS'];
123 }
124 $aMailbox['ID'] = $aCachedMailbox['ID'];
125 if (isset($aCachedMailbox['UIDSET'][$iSetIndx]) && $aCachedMailbox['UIDSET'][$iSetIndx]) {
126 if (isset($aProps[MBX_PREF_SORT]) && $aProps[MBX_PREF_SORT] != $aCachedMailbox['SORT'] ) {
127 $newsort = $aProps[MBX_PREF_SORT];
128 $oldsort = $aCachedMailbox['SORT'];
129 /**
130 * If it concerns a reverse sort we do not need to invalidate
131 * the cached sorted UIDSET, a reverse is sufficient.
132 */
133 if ((($newsort % 2) && ($newsort + 1 == $oldsort)) ||
134 (!($newsort % 2) && ($newsort - 1 == $oldsort))) {
135 $aMailbox['UIDSET'][$iSetIndx] = array_reverse($aCachedMailbox['UIDSET'][$iSetIndx]);
136 } else {
91c27aee 137 $server_sort_array = false;
324ac3c5 138 $aMailbox['MSG_HEADERS'] = false;
139 $aMailbox['ID'] = false;
140 }
141 // store the new sort value in the mailbox pref
142 if ($aConfig['user']) {
143 // FIXME, in ideal situation, we write back the
144 // prefs at the end of the script
91c27aee 145 setUserPref($aConfig['user'],'pref_'.$account.'_'.$mailbox,serialize($aProps));
324ac3c5 146 }
147 } else {
148 $aMailbox['UIDSET'][$iSetIndx] = $aCachedMailbox['UIDSET'][$iSetIndx];
149 }
150 }
151 }
152 }
153 /**
154 * Restore the offset in the paginator if no new offset is provided.
155 */
156 if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['offset']) && $aCachedMailbox['OFFSET']) {
157 $aMailbox['OFFSET'] = $aCachedMailbox['OFFSET'];
158 $aMailbox['PAGEOFFSET'] = $aCachedMailbox['PAGEOFFSET'];
159 } else {
160 $aMailbox['OFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] -1 : 0;
161 $aMailbox['PAGEOFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] : 1;
162 }
91c27aee 163 /**
164 * Restore the number of messages in the result set
165 */
166 if (isset($aCachedMailbox['TOTAL'][$iSetIndx]) && $aCachedMailbox['TOTAL'][$iSetIndx]) {
167 $aMailbox['TOTAL'][$iSetIndx] = $aCachedMailbox['TOTAL'][$iSetIndx];
168 }
324ac3c5 169
170 /**
171 * Restore the showall value no new showall value is provided.
172 */
173 if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['showall']) &&
174 isset($aCachedMailbox['SHOWALL'][$iSetIndx]) && $aCachedMailbox['SHOWALL'][$iSetIndx]) {
175 $aMailbox['SHOWALL'][$iSetIndx] = $aCachedMailbox['SHOWALL'][$iSetIndx];
176 } else {
177 $aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ? 1 : 0;
178 }
179
91c27aee 180 /**
181 * Restore the sort order if no new sort order is provided.
182 */
324ac3c5 183 if (!isset($aProps[MBX_PREF_SORT]) && isset($aCachedMailbox['SORT'])) {
184 $aMailbox['SORT'] = $aCachedMailbox['SORT'];
185 } else {
186 $aMailbox['SORT'] = (isset($aProps[MBX_PREF_SORT])) ? $aProps[MBX_PREF_SORT] : 0;
187 }
188
91c27aee 189 /**
190 * Restore the number of message to show per page when no new limit is provided
191 */
324ac3c5 192 if (!isset($aProps[MBX_PREF_LIMIT]) && isset($aCachedMailbox['LIMIT'])) {
193 $aMailbox['LIMIT'] = $aCachedMailbox['LIMIT'];
194 } else {
195 $aMailbox['LIMIT'] = (isset($aProps[MBX_PREF_LIMIT])) ? $aProps[MBX_PREF_LIMIT] : 15;
196 }
197
91c27aee 198 /**
199 * Restore the ordered columns to show when no new ordered columns are provided
200 */
201 if (!isset($aProps[MBX_PREF_COLUMNS]) && isset($aCachedMailbox['COLUMNS'])) {
202 $aMailbox['COLUMNS'] = $aCachedMailbox['COLUMNS'];
324ac3c5 203 } else {
91c27aee 204 $aMailbox['COLUMNS'] = (isset($aProps[MBX_PREF_COLUMNS])) ? $aProps[MBX_PREF_COLUMNS] :
205 array(SQM_COL_FLAGS,SQM_COL_FROM, SQM_COL_SUBJ, SQM_COL_FLAGS);
324ac3c5 206 }
207
208 if (!isset($aProps[MBX_PREF_AUTO_EXPUNGE]) && isset($aCachedMailbox['AUTO_EXPUNGE'])) {
209 $aMailbox['AUTO_EXPUNGE'] = $aCachedMailbox['AUTO_EXPUNGE'];
210 } else {
211 $aMailbox['AUTO_EXPUNGE'] = (isset($aProps[MBX_PREF_AUTO_EXPUNGE])) ? $aProps[MBX_PREF_AUTO_EXPUNGE] : false;
212 }
324ac3c5 213 if (!isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx])) {
214 $aMailbox['SEARCH'][$iSetIndx] = $aCachedMailbox['SEARCH'][$iSetIndx];
215 } else {
216 $aMailbox['SEARCH'][$iSetIndx] = (isset($aConfig['search'])) ? $aConfig['search'] : 'ALL';
217 }
324ac3c5 218 if (!isset($aConfig['charset']) && isset($aCachedMailbox['CHARSET'][$iSetIndx])) {
219 $aMailbox['CHARSET'][$iSetIndx] = $aCachedMailbox['CHARSET'][$iSetIndx];
220 } else {
221 $aMailbox['CHARSET'][$iSetIndx] = (isset($aConfig['charset'])) ? $aConfig['charset'] : 'US-ASCII';
222 }
223
224 $aMailbox['NAME'] = $mailbox;
225 $aMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
226 $aMailbox['SEEN'] = (isset($aMbxResponse['SEEN'])) ? $aMbxResponse['SEEN'] : $aMbxResponse['EXISTS'];
227 $aMailbox['RECENT'] = (isset($aMbxResponse['RECENT'])) ? $aMbxResponse['RECENT'] : 0;
228 $aMailbox['UIDVALIDITY'] = $aMbxResponse['UIDVALIDITY'];
229 $aMailbox['UIDNEXT'] = $aMbxResponse['UIDNEXT'];
230 $aMailbox['PERMANENTFLAGS'] = $aMbxResponse['PERMANENTFLAGS'];
231 $aMailbox['RIGHTS'] = $aMbxResponse['RIGHTS'];
232
324ac3c5 233 /* decide if we are thread sorting or not */
324ac3c5 234 if ($aMailbox['SORT'] & SQSORT_THREAD) {
91c27aee 235 if (!sqimap_capability($imapConnection,'THREAD')) {
236 $aMailbox['SORT'] ^= SQSORT_THREAD;
237 } else {
238 $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT'];
239 }
324ac3c5 240 } else {
324ac3c5 241 $aMailbox['THREAD_INDENT'] = false;
242 }
243
244 /* set a timestamp for cachecontrol */
245 $aMailbox['TIMESTAMP'] = time();
246 return $aMailbox;
247}
248
c7df3f1b 249/**
91c27aee 250 * Fetch the message headers for a mailbox. Settings are part of the aMailbox
251 * array.
62f7daa5 252 *
91c27aee 253 * @param resource $imapConnection imap socket handle
254 * @param array $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
255 * @return error $error error number
256 * @author Marc Groot Koerkamp
62f7daa5 257 */
91c27aee 258function fetchMessageHeaders($imapConnection, &$aMailbox, $aFetchHeaders) {
e0e30169 259
91c27aee 260 /* FIX ME, this function is kind of big, maybe we can split it up in
261 a couple of functions. Make sure the functions are private and starts with _
262 Also make sure that the error codes are propagated */
324ac3c5 263
264 /**
265 * Retrieve the UIDSET.
266 * Setindex is used to be able to store multiple uid sets. That will make it
267 * possible to display the mailbox multiple times in different sort order
268 * or to store serach results separate from normal mailbox view.
269 */
270 $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
271
272 $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
273 /**
274 * Adjust the start_msg
275 */
276 $start_msg = $aMailbox['PAGEOFFSET'];
277 if($aMailbox['PAGEOFFSET'] > $aMailbox['EXISTS']) {
278 $start_msg -= $aMailbox['LIMIT'];
279 if($start_msg < 1) {
280 $start_msg = 1;
281 }
282 }
91c27aee 283 //sm_print_r($aMailbox);
324ac3c5 284 if (is_array($aMailbox['UIDSET'])) {
285 $aUid =& $aMailbox['UIDSET'][$iSetIndx];
f6b262a3 286 } else {
324ac3c5 287 $aUid = false;
288 }
289
91c27aee 290 $iError = 0;
291 $aFetchItems = $aHeaderItems = array();
324ac3c5 292 // initialize the fields we want to retrieve:
91c27aee 293 foreach ($aFetchHeaders as $v) {
294 switch ($v) {
295 case SQM_COL_DATE: $aHeaderFields[] = 'Date'; break;
296 case SQM_COL_TO: $aHeaderFields[] = 'To'; break;
297 case SQM_COL_CC: $aHeaderFields[] = 'Cc'; break;
298 case SQM_COL_FROM: $aHeaderFields[] = 'From'; break;
299 case SQM_COL_SUBJ: $aHeaderFields[] = 'Subject'; break;
300 case SQM_COL_PRIO: $aHeaderFields[] = 'X-Priority'; break;
301 case SQM_COL_ATTACHMENT: $aHeaderFields[] = 'Content-Type'; break;
302 case SQM_COL_INT_DATE: $aFetchItems[] = 'INTERNALDATE'; break;
303 case SQM_COL_FLAGS: $aFetchItems[] = 'FLAGS'; break;
304 case SQM_COL_SIZE: $aFetchItems[] = 'RFC822.SIZE'; break;
305 default: break;
306 }
324ac3c5 307 }
308
324ac3c5 309 /**
310 * A uidset with sorted uid's is available. We can use the cache
311 */
91c27aee 312 if (isset($aUid) && $aUid ) {
324ac3c5 313
314 // limit the cache to SQM_MAX_PAGES_IN_CACHE
91c27aee 315 if (!$aMailbox['SHOWALL'][$iSetIndx] && isset($aMailbox['MSG_HEADERS'])) {
324ac3c5 316 $iMaxMsgs = $iLimit * SQM_MAX_PAGES_IN_CACHE;
317 $iCacheSize = count($aMailbox['MSG_HEADERS']);
318 if ($iCacheSize > $iMaxMsgs) {
319 $iReduce = $iCacheSize - $iMaxMsgs;
320 foreach ($aMailbox['MSG_HEADERS'] as $iUid => $value) {
321 if ($iReduce) {
322 unset($aMailbox['MSG_HEADERS'][$iUid]);
323 } else {
324 break;
325 }
326 --$iReduce;
327 }
6a622b59 328 }
e9e5f0fa 329 }
324ac3c5 330
331 $id_slice = array_slice($aUid,$start_msg-1,$iLimit);
332 /* do some funky cache checks */
91c27aee 333 if (isset($aMailbox['MSG_HEADERS'])) {
334 $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
335 } else {
336 $aMailbox['MSG_HEADERS'] = array();
337 $aUidCached = array();
338 }
324ac3c5 339 $aUidNotCached = array_values(array_diff($id_slice,$aUidCached));
91c27aee 340
324ac3c5 341 /**
342 * $aUidNotCached contains an array with UID's which need to be fetched to
343 * complete the needed message headers.
344 */
345 if (count($aUidNotCached)) {
346 $aMsgs = sqimap_get_small_header_list($imapConnection,$aUidNotCached,
347 $aHeaderFields,$aFetchItems);
348 // append the msgs to the existend headers
349 $aMailbox['MSG_HEADERS'] += $aMsgs;
8cc8ec79 350 }
324ac3c5 351 } else {
352 /**
91c27aee 353 * Initialize the sorted UID list or initiate a UID list with search
354 * results and fetch the visible message headers
324ac3c5 355 */
324ac3c5 356
91c27aee 357 if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') { // in case of a search request
358
324ac3c5 359 if ($aMailbox['SEARCH'][$iSetIndx] && $aMailbox['SORT'] == 0) {
360 $aUid = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
361 } else {
91c27aee 362
363 $iError = 0;
364 $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
324ac3c5 365 $aUid = $aMailbox['UIDSET'][$iSetIndx];
03975a39 366 }
91c27aee 367 if (!$iError) {
368 /**
369 * Number of messages is the resultset
370 */
371 $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
324ac3c5 372 $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
373 if (count($id_slice)) {
374 $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
375 $aHeaderFields,$aFetchItems);
376 } else {
91c27aee 377 $iError = 1; // FIX ME, define an error code
324ac3c5 378 }
03975a39 379 }
91c27aee 380 } else { //
381 $iError = 0;
382 $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
383 $aUid = $aMailbox['UIDSET'][$iSetIndx];
384
385 if (!$iError) {
386 /**
387 * Number of messages is the resultset
388 */
389 $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
390 $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
391 if (count($id_slice)) {
392 $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
393 $aHeaderFields,$aFetchItems);
324ac3c5 394 } else {
91c27aee 395 $iError = 1; // FIX ME, define an error code
324ac3c5 396 }
397 }
8cc8ec79 398 }
8cc8ec79 399 }
91c27aee 400 return $iError;
0fdc2fb6 401}
a966982b 402
91c27aee 403function prepareMessageList(&$aMailbox, $aProps) {
404 /* retrieve the properties */
405 $my_email_address = (isset($aProps['email'])) ? $aProps['email'] : false;
406 $highlight_list = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
407 $aColumnDesc = (isset($aProps['columns'])) ? $aProps['columns'] : false;
408 $aExtraColumns = (isset($aProps['extra_columns'])) ? $aProps['extra_columns'] : array();
409 $iAccount = (isset($aProps['account'])) ? (int) $aProps['account'] : 0;
410 $sMailbox = (isset($aProps['mailbox'])) ? $aProps['mailbox'] : false;
411 $sTargetModule = (isset($aProps['module'])) ? $aProps['module'] : 'read_body';
a966982b 412
91c27aee 413 /*
414 * TODO 1, retrieve array with identity email addresses in order to match against to,cc and set a flag
415 * $aFormattedMessages[$iUid]['match_identity'] = true
416 * The template can show some image if there is a match.
417 * TODO 2, makes sure the matching is done fast by doing a strpos call on the returned $value
418 */
8cc8ec79 419
91c27aee 420 /**
421 * Only retrieve values for displayable columns
422 */
423 foreach ($aColumnDesc as $k => $v) {
424 switch ($k) {
425 case SQM_COL_FROM: $aCol[SQM_COL_FROM] = 'from'; break;
426 case SQM_COL_DATE: $aCol[SQM_COL_DATE] = 'date'; break;
427 case SQM_COL_SUBJ: $aCol[SQM_COL_SUBJ] = 'subject'; break;
428 case SQM_COL_FLAGS: $aCol[SQM_COL_FLAGS] = 'FLAGS'; break;
429 case SQM_COL_SIZE: $aCol[SQM_COL_SIZE] = 'SIZE'; break;
430 case SQM_COL_PRIO: $aCol[SQM_COL_PRIO] = 'x-priority'; break;
431 case SQM_COL_ATTACHMENT: $aCol[SQM_COL_ATTACHMENT] = 'content-type'; break;
432 case SQM_COL_INT_DATE: $aCol[SQM_COL_INT_DATE] = 'INTERNALDATE'; break;
433 case SQM_COL_TO: $aCol[SQM_COL_TO] = 'to'; break;
434 case SQM_COL_CC: $aCol[SQM_COL_CC] = 'cc'; break;
435 case SQM_COL_BCC: $aCol[SQM_COL_BCC] = 'bcc'; break;
436 default: break;
437 }
438 }
439 $aFormattedMessages = array();
440
441
442 $iSetIndx = $aMailbox['SETINDEX'];
443 $aId = $aMailbox['UIDSET'][$iSetIndx];
444 $aHeaders =& $aMailbox['MSG_HEADERS']; /* use a reference to avoid a copy.
445 MSG_HEADERS can contain large amounts of data */
446 $iOffset = $aMailbox['OFFSET'];
447 $sort = $aMailbox['SORT'];
448 $iPageOffset = $aMailbox['PAGEOFFSET'];
449 $sMailbox = $aMailbox['NAME'];
450 $sSearch = (isset($aMailbox['SEARCH'][$aMailbox['SETINDEX']]) &&
451 $aMailbox['SEARCH'][$aMailbox['SETINDEX']] != 'ALL') ? $aMailbox['SEARCH'][$aMailbox['SETINDEX']] : false;
452 $aSearch = ($sSearch) ? array('search.php',$aMailbox['SETINDEX']) : null;
453 /* avoid improper usage */
454 if ($sMailbox && isset($iAccount) && $sTargetModule) {
455 $aInitQuery = array("account=$iAccount",'mailbox='.urlencode($sMailbox));
8cc8ec79 456 } else {
91c27aee 457 $aInitQuery = false;
8cc8ec79 458 }
459
91c27aee 460 if ($aMailbox['SORT'] & SQSORT_THREAD) {
461 $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']];
462 $bThread = true;
463 } else {
464 $bThread = false;
465 }
466 /*
467 * Retrieve value for checkbox column
468 */
469 if (!sqgetGlobalVar('checkall',$checkall,SQ_GET)) {
470 $checkall = false;
e4b5f9d1 471 }
472
91c27aee 473 /*
474 * Loop through and display the info for each message.
475 */
476 $iEnd = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $iOffset + $aMailbox['LIMIT'];
477 for ($i=$iOffset,$t=0;$i<$iEnd;++$i) {
478 if (isset($aId[$i])) {
479
480 $bHighLight = false;
481 $value = $title = $link = $target = '';
482 $aQuery = ($aInitQuery !== false) ? $aInitQuery : false;
483 $aMsg = $aHeaders[$aId[$i]];
484 if (isset($aSearch) && count($aSearch) > 1 && $aQuery) {
485 $aQuery[] = "where=". $aSearch[0];
486 $aQuery[] = "what=" . $aSearch[1];
8008456a 487 }
91c27aee 488 $iUid = (isset($aMsg['UID'])) ? $aMsg['UID'] : $aId[$i];
489 if ($aQuery) {
490 $aQuery[] = "passed_id=$aId[$i]";
491 $aQuery[] = "startMessage=$iPageOffset";
8008456a 492 }
91c27aee 493
494 foreach ($aCol as $k => $v) {
495 $link = $target = $title = '';
496 $aColumns[$k] = array();
497 $value = (isset($aMsg[$v])) ? $aMsg[$v] : '';
498 $sUnknown = _("Unknown recipient");
499 switch ($k) {
500 case SQM_COL_FROM:
501 $sUnknown = _("Unknown sender");
502 case SQM_COL_TO:
503 case SQM_COL_CC:
504 case SQM_COL_BCC:
505 $sTmp = false;
506 if ($value) {
507 if ($highlight_list && !$bHighLight) {
508 $bHighLight = highlightMessage($aCol[$k], $value, $highlight_list,$aFormattedMessages[$iUid]);
509 }
510 $sTmp = getAddressString(parseRFC822Address($value),array('best' => true));
511 if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
512 $sTrunc = truncateWithEntities($sTmp, $aColumnDesc[$k]['truncate']);
513 $title = ($sTrunc != $sTmp) ? htmlspecialchars($sTmp) : '';
514 $sTmp = $sTrunc;
515 }
516 }
517 $value = ($sTmp) ? htmlspecialchars($sTmp) : $sUnknown;
518 break;
519 case SQM_COL_SUBJ:
129c22ed 520 // subject is mime encoded, decode it.
521 // value is sanitized in decoding function.
522 $value=decodeHeader($value);
91c27aee 523 if ($highlight_list && !$bHighLight) {
524 $bHighLight = highlightMessage('SUBJECT', $value, $highlight_list, $aFormattedMessages[$iUid]);
525 }
526 $iIndent = (isset($aIndentArray[$aId[$i]])) ? $aIndentArray[$aId[$i]] : 0;
129c22ed 527 // FIXME: don't break 8bit symbols and html entities during truncation
91c27aee 528 if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
529 $sTmp = truncateWithEntities($value, $aColumnDesc[$k]['truncate']-$iIndent);
129c22ed 530 $title = ($sTmp != $value) ? $value : '';
91c27aee 531 $value = $sTmp;
532 }
533 /* generate the link to the message */
534 if ($aQuery) {
535 // TODO, $sTargetModule should be a query parameter so that we can use a single entrypoint
536 $link = $sTargetModule.'.php?' . implode('&amp;',$aQuery);
537 }
91c27aee 538 $value = (trim($value)) ? $value : _("(no subject)");
539 /* add thread indentation */
540 $aColumns[$k]['indent'] = $iIndent;
91c27aee 541 break;
542 case SQM_COL_SIZE:
543 $value = show_readable_size($value);
544 break;
545 case SQM_COL_DATE:
546 case SQM_COL_INT_DATE:
547 $value = getDateString(getTimeStamp(explode(' ',trim($value))));
548 break;
549 case SQM_COL_FLAGS:
550 $aFlagColumn = array('seen' => false,
551 'deleted'=>false,
552 'answered'=>false,
553 'flagged' => false,
554 'draft' => false);
555 foreach ($value as $sFlag => $value) {
556 switch ($sFlag) {
557 case '\\seen' : $aFlagColumn['seen'] = true; break;
558 case '\\deleted' : $aFlagColumn['deleted'] = true; break;
559 case '\\answered': $aFlagColumn['answered'] = true; break;
560 case '\\flagged' : $aFlagColumn['flagged'] = true; break;
561 case '\\draft' : $aFlagColumn['draft'] = true; break;
562 default: break;
563 }
564 }
565 $value = $aFlagColumn;
566 break;
567 case SQM_COL_PRIO:
568 $value = ($value) ? (int) $value : 3;
569 break;
570 case SQM_COL_ATTACHMENT:
571 $value = (is_array($value) && $value[0] == 'multipart' && $value[1] == 'mixed') ? true : false;
572 break;
573 case SQM_COL_CHECK:
574 $value = $checkall;
575 break;
576 default : break;
577 }
578 if ($title) { $aColumns[$k]['title'] = $title; }
579 if ($link) { $aColumns[$k]['link'] = $link; }
580 if ($target) { $aColumns[$k]['target'] = $target; }
581 $aColumns[$k]['value'] = $value;
8008456a 582 }
91c27aee 583 /* columns which will not be displayed but should be inspected
584 because the highlight list contains rules with those columns */
585 foreach ($aExtraColumns as $k) {
586 if ($highlight_list && !$bHighLight) {
587 $bHighLight = highlightMessage($k, $value, $highlight_list,$aFormattedMessages[$iUid]);
588 }
03975a39 589 }
91c27aee 590 $aFormattedMessages[$iUid]['columns'] = $aColumns;
591
592 } else {
8008456a 593 break;
594 }
bdfb67f8 595 }
91c27aee 596 return $aFormattedMessages;
bdfb67f8 597}
598
e9e5f0fa 599
94a4ea53 600
91c27aee 601function highlightMessage($sCol, $sVal, $highlight_list, &$aFormat) {
6a622b59 602
91c27aee 603
604 if (!is_array($highlight_list) && count($highlight_list) == 0) {
605 return false;
606 }
607 $hlt_color = false;
608 $sCol = strtoupper($sCol);
609 //echo "$sCol $sVal<br>";
610 foreach ($highlight_list as $highlight_list_part) {
611 if (trim($highlight_list_part['value'])) {
612 $high_val = strtolower($highlight_list_part['value']);
613 $match_type = strtoupper($highlight_list_part['match_type']);
614 if($match_type == 'TO_CC') {
615 if ($sCol == 'TO' || $sCol == 'CC') {
616 $match_type = $sCol;
617 } else {
618 continue;
619 }
620 } else {
621 if ($match_type != $sCol) {
622 continue;
623 }
624 }
625 if (strpos(strtolower($sVal),$high_val) !== false) {
626 $hlt_color = $highlight_list_part['color'];
627 break;
628 }
629 }
630 }
631 if ($hlt_color) {
f3a1e5fa 632 // Bug in highlight color???
633 if ($hlt_color{0} != '#') {
634 $hlt_color = '#'. $hlt_color;
635 }
91c27aee 636 $aFormat['row']['color'] = $hlt_color;
637 return true;
e35045b7 638 } else {
91c27aee 639 return false;
6c930ade 640 }
91c27aee 641}
6a622b59 642
91c27aee 643function setUserPref($username, $pref, $value) {
644 global $data_dir;
645 setPref($data_dir,$username,$pref,$value);
6a622b59 646}
647
c7df3f1b 648/**
91c27aee 649* Execute the sorting for a mailbox
650*
651* @param resource $imapConnection Imap connection
652* @param array $aMailbox (reference) Mailbox retrieved with sqm_api_mailbox_select
653* @return int $error (reference) Error number
654* @private
655* @author Marc Groot Koerkamp
656*/
657function _get_sorted_msgs_list($imapConnection,&$aMailbox) {
658 $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
659 $bDirection = ($aMailbox['SORT'] % 2);
660 $error = 0;
661 if (!$aMailbox['SEARCH'][$iSetIndx]) {
662 $aMailbox['SEARCH'][$iSetIndx] = 'ALL';
663 }
664 if (($aMailbox['SORT'] & SQSORT_THREAD) && sqimap_capability($imapConnection,'THREAD')) {
665 $aRes = get_thread_sort($imapConnection,$aMailbox['SEARCH'][$iSetIndx]);
666 if ($aRes === false) {
667 $aMailbox['SORT'] -= SQSORT_THREAD;
668 $error = 1; // fix me, define an error code;
6a622b59 669 } else {
91c27aee 670 $aMailbox['UIDSET'][$iSetIndx] = $aRes[0];
671 $aMailbox['THREAD_INDENT'][$iSetIndx] = $aRes[1];
a6d36aa5 672 }
91c27aee 673 } else if ($aMailbox['SORT'] === SQSORT_NONE) {
674 $id = sqimap_run_search($imapConnection, 'ALL' , '');
675 if ($id === false) {
676 $error = 1; // fix me, define an error code
a6d36aa5 677 } else {
91c27aee 678 $aMailbox['UIDSET'][$iSetIndx] = array_reverse($id);
679 $aMailbox['TOTAL'][$iSetIndx] = $aMailbox['EXISTS'];
a6d36aa5 680 }
91c27aee 681 } else {
682 if (sqimap_capability($imapConnection,'SORT')) {
683 $sSortField = _getSortField($aMailbox['SORT'],true);
684 $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection, $aMailbox['SEARCH'][$iSetIndx]);
685 if ($id === false) {
686 $error = 1; // fix me, define an error code
687 } else {
688 $aMailbox['UIDSET'][$iSetIndx] = $id;
689 }
6a622b59 690 } else {
91c27aee 691 $id = NULL;
692 if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') {
693 $id = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
694 }
695 $sSortField = _getSortField($aMailbox['SORT'],false);
696 $aMailbox['UIDSET'][$iSetIndx] = get_squirrel_sort($imapConnection, $sSortField, $bDirection, $id);
6a622b59 697 }
e35045b7 698 }
91c27aee 699 return $error;
bdfb67f8 700}
1a0e0983 701
c7df3f1b 702/**
91c27aee 703* Does the $srt $_GET var to field mapping
704*
705* @param int $srt Field to sort on
706* @param bool $bServerSort Server sorting is true
707* @return string $sSortField Field to sort on
708* @private
709*/
710function _getSortField($sort,$bServerSort) {
711 switch($sort) {
712 case SQSORT_NONE:
713 $sSortField = 'UID';
714 break;
715 case SQSORT_DATE_ASC:
716 case SQSORT_DATE_DESC:
717 $sSortField = 'DATE';
718 break;
719 case SQSORT_FROM_ASC:
720 case SQSORT_FROM_DESC:
721 $sSortField = 'FROM';
722 break;
723 case SQSORT_SUBJ_ASC:
724 case SQSORT_SUBJ_DESC:
725 $sSortField = 'SUBJECT';
726 break;
727 case SQSORT_SIZE_ASC:
728 case SQSORT_SIZE_DESC:
729 $sSortField = ($bServerSort) ? 'SIZE' : 'RFC822.SIZE';
730 break;
731 case SQSORT_TO_ASC:
732 case SQSORT_TO_DESC:
733 $sSortField = 'TO';
734 break;
735 case SQSORT_CC_ASC:
736 case SQSORT_CC_DESC:
737 $sSortField = 'CC';
738 break;
739 case SQSORT_INT_DATE_ASC:
740 case SQSORT_INT_DATE_DESC:
741 $sSortField = ($bServerSort) ? 'ARRIVAL' : 'INTERNALDATE';
742 break;
743 case SQSORT_THREAD:
744 break;
745 default: $sSortField = 'UID';
746 break;
747
6a622b59 748 }
91c27aee 749 return $sSortField;
bdfb67f8 750}
751
7b294953 752
6a622b59 753
6a622b59 754
91c27aee 755/**
756* This function loops through a group of messages in the mailbox
757* and shows them to the user.
758*
759* @param resource $imapConnection
760* @param array $aMailbox associative array with mailbox related vars
761* @param array $aProps
762* @param int $iError error code, 0 is no error
763*/
764function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
765 global $PHP_SELF;
766 global $boxes;
767
768 $highlight_list = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
769 $fancy_index_highlite = (isset($aProps['config']['fancy_index_highlite'])) ? $aProps['config']['fancy_index_highlite'] : true;
770 $aColumnsDesc = (isset($aProps['columns'])) ? $aProps['columns'] : false;
771 $iAccount = (isset($aProps['account'])) ? (int) $aProps['account'] : 0;
772 $sMailbox = (isset($aProps['mailbox'])) ? $aProps['mailbox'] : false;
773 $sTargetModule = (isset($aProps['module'])) ? $aProps['module'] : 'read_body';
774 $show_flag_buttons = (isset($aProps['config']['show_flag_buttons'])) ? $aProps['config']['show_flag_buttons'] : true;
775 $lastTargetMailbox = (isset($aProps['config']['lastTargetMailbox'])) ? $aProps['config']['lastTargetMailbox'] : '';
776 $aOrder = array_keys($aProps['columns']);
777 $trash_folder = (isset($aProps['config']['trash_folder']) && $aProps['config']['trash_folder'])
778 ? $aProps['config']['trash_folder'] : false;
779 $sent_folder = (isset($aProps['config']['sent_folder']) && $aProps['config']['sent_folder'])
780 ? $aProps['config']['sent_folder'] : false;
781 $draft_folder = (isset($aProps['config']['draft_folder']) && $aProps['config']['draft_folder'])
782 ? $aProps['config']['draft_folder'] : false;
783 $page_selector = (isset($aProps['config']['page_selector'])) ? $aProps['config']['page_selector'] : false;
784 $page_selector_max = (isset($aProps['config']['page_selector_max'])) ? $aProps['config']['page_selector_max'] : 10;
785 $color = $aProps['config']['color'];
6a622b59 786
6a622b59 787
91c27aee 788 /*
789 * Form ID
790 */
791 static $iFormId;
324ac3c5 792
91c27aee 793 if (!isset($iFormId)) {
794 $iFormId=1;
795 } else {
796 ++$iFormId;
797 }
798 /*
799 * Remove the checkbox column because we cannot fetch it from the imap server
800 */
801 $aFetchColumns = $aColumnsDesc;
802 if (isset($aFetchColumns[SQM_COL_CHECK])) {
803 unset($aFetchColumns[SQM_COL_CHECK]);
804 }
0bb37159 805
91c27aee 806 /*
807 * Before we fetch the message headers, check if we need to fetch extra columns
808 * to make the message highlighting work
809 */
810 if (is_array($highlight_list) && count($highlight_list)) {
811 $aHighlightColumns = array();
812 foreach ($highlight_list as $highlight_list_part) {
813 if (trim($highlight_list_part['value'])) {
814 $match_type = strtoupper($highlight_list_part['match_type']);
815 $aHighlightColumns = array();
816 switch ($match_type) {
817 case 'TO_CC':
818 $aHighlightColumns[SQM_COL_TO] = true;
819 $aHighlightColumns[SQM_COL_CC] = true;
820 break;
821 case 'TO': $aHighlightColumns[SQM_COL_TO] = true; break;
822 case 'CC': $aHighlightColumns[SQM_COL_CC] = true; break;
823 case 'FROM': $aHighlightColumns[SQM_COL_FROM] = true; break;
824 case 'SUBJECT':$aHighlightColumns[SQM_COL_SUBJ] = true; break;
324ac3c5 825 }
91c27aee 826 }
827 }
828 $aExtraColumns = array();
829 foreach ($aHighlightColumns as $k => $v) {
830 if (!isset($aFetchColumns[$k])) {
831 $aExtraColumns[] = $k;
832 $aFetchColumns[$k] = true;
833 }
834 }
835 if (count($aExtraColumns)) {
836 $aProps['extra_columns'] = $aExtraColumns;
837 }
838 }
839 $aFetchColumns = array_keys($aFetchColumns);
840 // store the columns to fetch to the session so we can pick them up in read_body
841 // where we validate the cache.
842 /////// sqsession_register($aFetchColumns,'aFetchColumns');
e35045b7 843
91c27aee 844 $iError = fetchMessageHeaders($imapConnection, $aMailbox, $aFetchColumns);
845 if ($iError) {
846 return array();
847 } else {
848 $aMessages = prepareMessageList($aMailbox, $aProps);
849 }
6a622b59 850
91c27aee 851 $iSetIndx = $aMailbox['SETINDEX'];
852 $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
853 $iEnd = ($aMailbox['PAGEOFFSET'] + ($iLimit - 1) < $aMailbox['EXISTS']) ?
854 $aMailbox['PAGEOFFSET'] + $iLimit - 1 : $aMailbox['EXISTS'];
6a622b59 855
91c27aee 856 $iNumberOfMessages = $aMailbox['TOTAL'][$iSetIndx];
6a622b59 857
91c27aee 858 $php_self = $PHP_SELF;
6a622b59 859
91c27aee 860 $urlMailbox = urlencode($aMailbox['NAME']);
6a622b59 861
91c27aee 862 if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
863 $source_url = $regs[1];
864 } else {
865 $source_url = $php_self;
866 }
6a622b59 867
91c27aee 868 $baseurl = $source_url.'?mailbox=' . urlencode($aMailbox['NAME']) .'&amp;account='.$aMailbox['ACCOUNT'];
869 $where = urlencode($aMailbox['SEARCH'][$iSetIndx][0]);
870 $what = urlencode($aMailbox['SEARCH'][$iSetIndx][1]);
871 $baseurl .= '&amp;where=' . $where . '&amp;what=' . $what;
872
873 /* build thread sorting links */
874 $newsort = $aMailbox['SORT'];
875 if (sqimap_capability($imapConnection,'THREAD')) {
876 if ($aMailbox['SORT'] & SQSORT_THREAD) {
877 $newsort -= SQSORT_THREAD;
878 $thread_name = _("Unthread View");
879 } else {
880 $thread_name = _("Thread View");
881 $newsort = $aMailbox['SORT'] + SQSORT_THREAD;
6a622b59 882 }
91c27aee 883 $thread_link_str = '<small>[<a href="' . $baseurl . '&amp;srt='
884 . $newsort . '&amp;startMessage=1">' . $thread_name
885 . '</a>]</small>';
324ac3c5 886 } else {
91c27aee 887 $thread_link_str ='';
6a622b59 888 }
91c27aee 889 $sort = $aMailbox['SORT'];
6a622b59 890
91c27aee 891 /* FIX ME ADD CHECKBOX CONTROL. No checkbox => no buttons */
892
893
894
895 /* future admin control over displayable buttons */
896
897 $aAdminControl = array(
898 'markUnflagged' => 1,
899 'markFlagged' => 1,
900 'markRead' => 1,
901 'markUnread' => 1,
902 'delete' => 1,
903 'undeleteButton'=> 1,
904 'bypass_trash' => 1,
905 'expungeButton' => 1,
906 'moveButton' => 1,
907 'forward' => 1
908 );
909 /* user prefs control */
910 $aUserControl = array (
911 'markUnflagged' => $show_flag_buttons,
912 'markFlagged' => $show_flag_buttons,
913 'markRead' => 1,
914 'markUnread' => 1,
915 'delete' => 1,
916 'undeleteButton'=> 1,
917 'bypass_trash' => 1,
918 'expungeButton' => 1,
919 'moveButton' => 1,
920 'forward' => 1
921 );
922
923 $showDelete = ($aMailbox['RIGHTS'] != 'READ-ONLY' &&
924 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ? true : false;
925 $showByPassTrash = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
926 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) &&
927 $trash_folder ? true : false; //
928 $showUndelete = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
929 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true) && !$trash_folder) ? true : false;
930 $showMove = ($aMailbox['RIGHTS'] != 'READ-ONLY') ? true : false;
931 $showExpunge = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
932 in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ? true : false;
933 $aImapControl = array (
934 'markUnflagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true),
935 'markFlagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true),
936 'markRead' => in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true),
937 'markUnread' => in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true),
938 'delete' => $showDelete,
939 'undeleteButton'=> $showUndelete,
940 'bypass_trash' => $showByPassTrash,
941 'expungeButton' => $showExpunge,
942 'moveButton' => $showMove,
943 'forward' => 1
944 );
945 $aButtonStrings = array(
946 'markUnflagged' => _("Unflag"),
947 'markFlagged' => _("Flag"),
948 'markRead' => _("Read"),
949 'markUnread' => _("Unread"),
950 'delete' => _("Delete"),
951 'undeleteButton' => _("Undelete"),
952 'bypass_trash' => _("Bypass Trash"),
953 'expungeButton' => _("Expunge"),
954 'moveButton' => _("Move"),
955 'forward' => _("Forward")
956 );
6a622b59 957 /**
91c27aee 958 * Register buttons in order to an array
959 * The key is the "name", the first element of the value array is the "value", second argument is the type.
62f7daa5 960 */
91c27aee 961 $aFormElements = array();
962 foreach($aAdminControl as $k => $v) {
963 if ($v & $aUserControl[$k] & $aImapControl[$k]) {
964 switch ($k) {
965 case 'markUnflagged':
966 case 'markFlagged':
967 case 'markRead':
968 case 'markUnread':
969 case 'delete':
970 case 'undeleteButton':
971 case 'expungeButton':
972 case 'forward':
973 $aFormElements[$k] = array($aButtonStrings[$k],'submit');
974 break;
975 case 'bypass_trash':
976 $aFormElements[$k] = array($aButtonStrings[$k],'checkbox');
977 break;
978 case 'moveButton':
979 $aFormElements['targetMailbox'] =
980 array(sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes),'select');
981 $aFormElements['mailbox'] = array($aMailbox['NAME'],'hidden');
982 $aFormElements['startMessage'] = array($aMailbox['PAGEOFFSET'],'hidden');
983 $aFormElements[$k] = array($aButtonStrings[$k],'submit');
984 break;
0bb37159 985 }
986 }
91c27aee 987 $aFormElements['account'] = array($iAccount,'hidden');
988 }
0bb37159 989
91c27aee 990 /*
991 * This is the beginning of the message list table.
992 * It wraps around all messages
993 */
994 $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
995 $form_name = "FormMsgs" . $safe_name;
0bb37159 996
91c27aee 997 //if (!sqgetGlobalVar('align',$align,SQ_SESSION)) {
998 $align = array('left' => 'left', 'right' => 'right');
999 //}
1000 //sm_print_r($align);
1001
1002 /* finally set the template vars */
1003
1004 // FIX ME, before we support multiple templates we must review the names of the vars
1005
1006
1007
1008 $aTemplate['color'] = $color;
1009 $aTemplate['form_name'] = "FormMsgs" . $safe_name;
1010 $aTemplate['form_id'] = 'mbx_'.$iFormId;
1011 $aTemplate['page_selector'] = $page_selector;
1012 $aTemplate['page_selector_max'] = $page_selector_max;
1013 $aTemplate['messagesPerPage'] = $aMailbox['LIMIT'];
1014 $aTemplate['showall'] = $aMailbox['SHOWALL'][$iSetIndx];
1015 $aTemplate['end_msg'] = $iEnd;
1016 $aTemplate['align'] = $align;
1017 $aTemplate['iNumberOfMessages'] = $iNumberOfMessages;
1018 $aTemplate['aOrder'] = $aOrder;
1019 $aTemplate['aFormElements'] = $aFormElements;
1020 $aTemplate['sort'] = $sort;
1021 $aTemplate['pageOffset'] = $aMailbox['PAGEOFFSET'];
1022 $aTemplate['baseurl'] = $baseurl;
1023 $aTemplate['aMessages'] =& $aMessages;
1024 $aTemplate['trash_folder'] = $trash_folder;
1025 $aTemplate['sent_folder'] = $sent_folder;
1026 $aTemplate['draft_folder'] = $draft_folder;
1027 $aTemplate['thread_link_str'] = $thread_link_str;
1028 $aTemplate['php_self'] = str_replace('&','&amp;',$php_self);
1029 $aTemplate['mailbox'] = $sMailbox;
1030 $aTemplate['javascript_on'] = (isset($aProps['config']['javascript_on'])) ? $aProps['config']['javascript_on'] : false;
1031 $aTemplate['enablesort'] = (isset($aProps['config']['enablesort'])) ? $aProps['config']['enablesort'] : false;
1032 $aTemplate['icon_theme'] = (isset($aProps['config']['icon_theme'])) ? $aProps['config']['icon_theme'] : false;
1033 $aTemplate['use_icons'] = (isset($aProps['config']['use_icons'])) ? $aProps['config']['use_icons'] : false;
1034 $aTemplate['alt_index_colors'] = (isset($aProps['config']['alt_index_colors'])) ? $aProps['config']['alt_index_colors'] : false;
1035 $aTemplate['fancy_index_highlite'] = $fancy_index_highlite;
1036
1037 return $aTemplate;
bdfb67f8 1038}
1039
91c27aee 1040
c7df3f1b 1041/**
91c27aee 1042* FIXME: Undocumented function
1043*/
eaa4f45f 1044function truncateWithEntities($subject, $trim_at)
1045{
341aa42f 1046 $ent_strlen = strlen($subject);
1047 if (($trim_at <= 0) || ($ent_strlen <= $trim_at))
6a622b59 1048 return $subject;
eaa4f45f 1049
1050 global $languages, $squirrelmail_language;
6a622b59 1051
6a622b59 1052 /*
91c27aee 1053 * see if this is entities-encoded string
1054 * If so, Iterate through the whole string, find out
1055 * the real number of characters, and if more
1056 * than $trim_at, substr with an updated trim value.
1057 */
341aa42f 1058 $trim_val = $trim_at;
1059 $ent_offset = 0;
1060 $ent_loc = 0;
a1440f89 1061 while ( $ent_loc < $trim_val && (($ent_loc = strpos($subject, '&', $ent_offset)) !== false) &&
1062 (($ent_loc_end = strpos($subject, ';', $ent_loc+3)) !== false) ) {
1063 $trim_val += ($ent_loc_end-$ent_loc);
6a622b59 1064 $ent_offset = $ent_loc_end+1;
1065 }
341aa42f 1066 if (($trim_val > $trim_at) && ($ent_strlen > $trim_val) && (strpos($subject,';',$trim_val) < ($trim_val + 6))) {
a1440f89 1067 $i = strpos($subject,';',$trim_val);
1068 if ($i) {
1069 $trim_val = strpos($subject,';',$trim_val);
1070 }
46a49f65 1071 }
341aa42f 1072 // only print '...' when we're actually dropping part of the subject
1073 if ($ent_strlen <= $trim_val)
6a622b59 1074 return $subject;
6a622b59 1075
1076 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
b3e4bf71 1077 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth')) {
1078 return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth', $subject, $trim_val);
6a622b59 1079 }
ecaf6352 1080
91c27aee 1081 return substr_replace($subject, '...', $trim_val);
e9e5f0fa 1082}
1083
c7df3f1b 1084/**
91c27aee 1085* This should go in imap_mailbox.php
1086* @param string $mailbox
1087*/
a3439b27 1088function handleAsSent($mailbox) {
6a8e7cae 1089 global $handleAsSent_result;
4669e892 1090
6a622b59 1091 /* First check if this is the sent or draft folder. */
6a8e7cae 1092 $handleAsSent_result = isSentMailbox($mailbox) || isDraftMailbox($mailbox);
a3439b27 1093
6a622b59 1094 /* Then check the result of the handleAsSent hook. */
1095 do_hook('check_handleAsSent_result', $mailbox);
a3439b27 1096
6a622b59 1097 /* And return the result. */
6a8e7cae 1098 return $handleAsSent_result;
6a622b59 1099}
e842b215 1100
324ac3c5 1101/**
1102 * Process messages list form and handle the cache gracefully. If $sButton and
1103 * $aUid are provided as argument then you can fake a message list submit and
1104 * use it i.e. in read_body.php for del move next and update the cache
1105 *
1106 * @param resource $imapConnection imap connection
1107 * @param array $aMailbox (reference) cached mailbox
1108 * @param string $sButton fake a submit button
1109 * @param array $aUid fake the $msg array
1110 * @return string $sError error string in case of an error
1111 * @author Marc Groot Koerkamp
1112 */
1113function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = array()) {
324ac3c5 1114 /* incoming formdata */
1115 $sButton = (sqgetGlobalVar('moveButton', $sTmp, SQ_POST)) ? 'move' : $sButton;
1116 $sButton = (sqgetGlobalVar('expungeButton', $sTmp, SQ_POST)) ? 'expunge' : $sButton;
91c27aee 1117 $sButton = (sqgetGlobalVar('forward', $sTmp, SQ_POST)) ? 'forward' : $sButton;
324ac3c5 1118 $sButton = (sqgetGlobalVar('delete', $sTmp, SQ_POST)) ? 'setDeleted' : $sButton;
91c27aee 1119 $sButton = (sqgetGlobalVar('undeleteButton', $sTmp, SQ_POST)) ? 'unsetDeleted' : $sButton;
324ac3c5 1120 $sButton = (sqgetGlobalVar('markRead', $sTmp, SQ_POST)) ? 'setSeen' : $sButton;
1121 $sButton = (sqgetGlobalVar('markUnread', $sTmp, SQ_POST)) ? 'unsetSeen' : $sButton;
1122 $sButton = (sqgetGlobalVar('markFlagged', $sTmp, SQ_POST)) ? 'setFlagged' : $sButton;
1123 $sButton = (sqgetGlobalVar('markUnflagged', $sTmp, SQ_POST)) ? 'unsetFlagged' : $sButton;
1124 sqgetGlobalVar('targetMailbox', $targetMailbox, SQ_POST);
1125 sqgetGlobalVar('bypass_trash', $bypass_trash, SQ_POST);
1126 sqgetGlobalVar('msg', $msg, SQ_POST);
91c27aee 1127 if (sqgetGlobalVar('account', $iAccount, SQ_POST) === false) {
1128 $iAccount = 0;
1129 }
324ac3c5 1130 $sError = '';
1131 $mailbox = $aMailbox['NAME'];
1132
1133 /* retrieve the check boxes */
1134 $aUid = (isset($msg) && is_array($msg)) ? array_values($msg) : $aUid;
324ac3c5 1135 if (count($aUid) && $sButton != 'expunge') {
1136 $aUpdatedMsgs = false;
1137 $bExpunge = false;
1138 switch ($sButton) {
1139 case 'setDeleted':
1140 // check if id exists in case we come from read_body
1141 if (count($aUid) == 1 && is_array($aMailbox['UIDSET'][$aMailbox['SETINDEX']]) &&
1142 !in_array($aUid[0],$aMailbox['UIDSET'][$aMailbox['SETINDEX']])) {
1143 break;
1144 }
7c788b1c 1145 $aUpdatedMsgs = sqimap_msgs_list_delete($imapConnection, $mailbox, $aUid,$bypass_trash);
1146 $bExpunge = true;
91c27aee 1147 //}
324ac3c5 1148 break;
1149 case 'unsetDeleted':
1150 case 'setSeen':
1151 case 'unsetSeen':
1152 case 'setFlagged':
1153 case 'unsetFlagged':
1154 // get flag
1155 $sFlag = (substr($sButton,0,3) == 'set') ? '\\'.substr($sButton,3) : '\\'.substr($sButton,5);
1156 $bSet = (substr($sButton,0,3) == 'set') ? true : false;
1157 $aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
1158 break;
1159 case 'move':
1160 $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox);
1161 sqsession_register($targetMailbox,'lastTargetMailbox');
1162 $bExpunge = true;
1163 break;
91c27aee 1164 case 'forward':
324ac3c5 1165 $aMsgHeaders = array();
1166 foreach ($aUid as $iUid) {
1167 $aMsgHeaders[$iUid] = $aMailbox['MSG_HEADERS'][$iUid];
1168 }
1169 if (count($aMsgHeaders)) {
1170 $composesession = attachSelectedMessages($imapConnection,$aMsgHeaders);
1171 // dirty hack, add info to $aMailbox
1172 $aMailbox['FORWARD_SESSION'] = $composesession;
1173 }
1174 break;
7c788b1c 1175 default:
91c27aee 1176 // Hook for plugin buttons
1177 do_hook_function('mailbox_display_button_action', $aUid);
1178 break;
324ac3c5 1179 }
1180 /**
1181 * Updates messages is an array containing the result of the untagged
1182 * fetch responses send by the imap server due to a flag change. That
1183 * response is parsed in a array with msg arrays by the parseFetch function
1184 */
1185 if ($aUpdatedMsgs) {
1186 // Update the message headers cache
1187 $aDeleted = array();
1188 foreach ($aUpdatedMsgs as $iUid => $aMsg) {
1189 if (isset($aMsg['FLAGS'])) {
fd28fa79 1190 /**
ddd209f2 1191 * Only update the cached headers if the header is
fd28fa79 1192 * cached.
1193 */
1194 if (isset($aMailbox['MSG_HEADERS'][$iUid])) {
1195 $aMailbox['MSG_HEADERS'][$iUid]['FLAGS'] = $aMsg['FLAGS'];
1196 }
324ac3c5 1197 /**
1198 * Count the messages with the \Delete flag set so we can determine
1199 * if the number of expunged messages equals the number of flagged
1200 * messages for deletion.
1201 */
1202 if (isset($aMsg['FLAGS']['\\deleted']) && $aMsg['FLAGS']['\\deleted']) {
1203 $aDeleted[] = $iUid;
1204 }
1205 }
1206 }
1207 if ($bExpunge && $aMailbox['AUTO_EXPUNGE'] &&
1208 $iExpungedMessages = sqimap_mailbox_expunge($imapConnection, $aMailbox['NAME'], true))
1209 {
1210 if (count($aDeleted) != $iExpungedMessages) {
1211 // there are more messages deleted permanently then we expected
1212 // invalidate the cache
1213 $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = false;
1214 $aMailbox['MSG_HEADERS'] = false;
1215 } else {
1216 // remove expunged messages from cache
1217 $aUidSet = $aMailbox['UIDSET'][$aMailbox['SETINDEX']];
1218 if (is_array($aUidSet)) {
1219 // create a UID => array index temp array
1220 $aUidSetDummy = array_flip($aUidSet);
1221 foreach ($aDeleted as $iUid) {
1222 // get the id as well in case of SQM_SORT_NONE
1223 if ($aMailbox['SORT'] == SQSORT_NONE) {
1224 $aMailbox['ID'] = false;
1225 //$iId = $aMailbox['MSG_HEADERS'][$iUid]['ID'];
1226 //unset($aMailbox['ID'][$iId]);
1227 }
1228 // unset the UID and message header
1229 unset($aUidSetDummy[$iUid]);
1230 unset($aMailbox['MSG_HEADERS'][$iUid]);
1231 }
1232 $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = array_keys($aUidSetDummy);
324ac3c5 1233 }
1234 }
ddd209f2 1235 // update EXISTS info
1236 if ($iExpungedMessages) {
1237 $aMailbox['EXISTS'] -= (int) $iExpungedMessages;
91c27aee 1238 $aMailbox['TOTAL'][$aMailbox['SETINDEX']] -= (int) $iExpungedMessages;
ddd209f2 1239 }
4c284a74 1240 if (($aMailbox['PAGEOFFSET']-1) >= $aMailbox['EXISTS']) {
324ac3c5 1241 $aMailbox['PAGEOFFSET'] = ($aMailbox['PAGEOFFSET'] > $aMailbox['LIMIT']) ?
1242 $aMailbox['PAGEOFFSET'] - $aMailbox['LIMIT'] : 1;
91c27aee 1243 $aMailbox['OFFSET'] = $aMailbox['PAGEOFFSET'] - 1 ;
324ac3c5 1244 }
1245 }
1246 }
1247 } else {
1248 if ($sButton == 'expunge') {
1249 /**
1250 * on expunge we do not know which messages will be deleted
1251 * so it's useless to try to sync the cache
1252
1253 * Close the mailbox so we do not need to parse the untagged expunge
1254 * responses which do not contain uid info.
1255 * NB: Closing a mailbox is faster then expunge because the imap
1256 * server does not need to generate the untagged expunge responses
1257 */
1258 sqimap_run_command($imapConnection,'CLOSE',false,$result,$message);
91c27aee 1259 $aMailbox = sqm_api_mailbox_select($imapConnection,$iAccount, $aMailbox['NAME'],array(),array());
324ac3c5 1260 } else {
1261 if ($sButton) {
1262 $sError = _("No messages were selected.");
1263 }
1264 }
1265 }
1266 return $sError;
1267}
1268
1269function attachSelectedMessages($imapConnection,$aMsgHeaders) {
1270 global $username, $attachment_dir,
91c27aee 1271 $data_dir;
1272
324ac3c5 1273
91c27aee 1274 sqgetGlobalVar('composesession', $composesession, SQ_SESSION);
1275 sqgetGlobalVar('compose_messages', $compose_messages, SQ_SESSION);
1276 if (!isset($compose_messages)|| is_null($compose_messages)) {
324ac3c5 1277 $compose_messages = array();
1278 sqsession_register($compose_messages,'compose_messages');
1279 }
1280
1281 if (!$composesession) {
1282 $composesession = 1;
1283 sqsession_register($composesession,'composesession');
1284 } else {
1285 $composesession++;
1286 sqsession_register($composesession,'composesession');
1287 }
1288
1289 $hashed_attachment_dir = getHashedDir($username, $attachment_dir);
1290
1291 $composeMessage = new Message();
1292 $rfc822_header = new Rfc822Header();
1293 $composeMessage->rfc822_header = $rfc822_header;
1294 $composeMessage->reply_rfc822_header = '';
1295
1296 foreach($aMsgHeaders as $iUid => $aMsgHeader) {
1297 /**
1298 * Retrieve the full message
1299 */
1300 $body_a = sqimap_run_command($imapConnection, "FETCH $iUid RFC822", true, $response, $readmessage, TRUE);
324ac3c5 1301 if ($response == 'OK') {
91c27aee 1302
1303 $subject = (isset($aMsgHeader['subject'])) ? $aMsgHeader['subject'] : $iUid;
324ac3c5 1304
1305 array_shift($body_a);
1306 array_pop($body_a);
1307 $body = implode('', $body_a);
1308 $body .= "\r\n";
1309
1310 $localfilename = GenerateRandomString(32, 'FILE', 7);
1311 $full_localfilename = "$hashed_attachment_dir/$localfilename";
1312
1313 $fp = fopen( $full_localfilename, 'wb');
1314 fwrite ($fp, $body);
1315 fclose($fp);
1316 $composeMessage->initAttachment('message/rfc822',$subject.'.msg',
1317 $full_localfilename);
1318 }
1319 }
1320
1321 $compose_messages[$composesession] = $composeMessage;
1322 sqsession_register($compose_messages,'compose_messages');
1323 return $composesession;
1324}
1325
b4482518 1326?>
Unnamed repository; edit this file 'description' to name the repository.