db5bbcf61a8c7cf1b8444897dc336e3a15a0ca7d
[squirrelmail.git] / functions / mailbox_display.php
1 <?php
2
3 /**
4 * mailbox_display.php
5 *
6 * Copyright (c) 1999-2004 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 */
15
16 /** The standard includes.. */
17 require_once(SM_PATH . 'functions/strings.php');
18 require_once(SM_PATH . 'functions/html.php');
19 require_once(SM_PATH . 'class/html.class.php');
20 require_once(SM_PATH . 'functions/imap_mailbox.php');
21 require_once(SM_PATH . 'functions/imap_messages.php');
22 require_once(SM_PATH . 'functions/mime.php');
23 require_once(SM_PATH . 'functions/forms.php');
24
25 /**
26 * default value for page_selector_max
27 */
28 define('PG_SEL_MAX', 10);
29
30 /**
31 * Sort constants used for sorting of messages
32 */
33 define('SQSORT_NONE',0);
34 define('SQSORT_DATE_ASC',1);
35 define('SQSORT_DATE_DEC',2);
36 define('SQSORT_FROM_ASC',3);
37 define('SQSORT_FROM_DEC',4);
38 define('SQSORT_SUBJ_ASC',5);
39 define('SQSORT_SUBJ_DEC',6);
40 define('SQSORT_SIZE_ASC',7);
41 define('SQSORT_SIZE_DEC',8);
42 define('SQSORT_TO_ASC',9);
43 define('SQSORT_TO_DEC',10);
44 define('SQSORT_CC_ASC',11);
45 define('SQSORT_CC_DEC',12);
46 define('SQSORT_INT_DATE_ASC',13);
47 define('SQSORT_INT_DATE_DEC',14);
48 define('SQSORT_THREAD',42);
49 /**
50 * @param mixed $start UNDOCUMENTED
51 */
52 function elapsed($start) {
53
54 $end = microtime();
55 list($start2, $start1) = explode(" ", $start);
56 list($end2, $end1) = explode(" ", $end);
57 $diff1 = $end1 - $start1;
58 $diff2 = $end2 - $start2;
59 if( $diff2 < 0 ){
60 $diff1 -= 1;
61 $diff2 += 1.0;
62 }
63 return $diff2 + $diff1;
64 }
65
66 /**
67 * Displays message header row in messages list
68 *
69 * @param array $aMsg contains all message related parameters
70 * @return void
71 */
72
73 function printMessageInfo($aMsg) {
74 // FIX ME, remove these globals as well by adding an array as argument for the user settings
75 // specificly meant for header display
76 global $checkall,
77 $color,
78 $default_use_priority,
79 $message_highlight_list,
80 $index_order,
81 $truncate_sender, /* number of characters for From/To field (<= 0 for unchanged) */
82 $email_address,
83 $show_recipient_instead, /* show recipient name instead of default identity */
84 $use_icons, /* indicates to use icons or text markers */
85 $icon_theme; /* icons theming */
86
87 $color_string = $color[4];
88
89 // initialisation:
90 $mailbox = $aMsg['MAILBOX'];
91 $msg = $aMsg['HEADER'];
92 $t = $aMsg['INDX'];
93 $start_msg = $aMsg['PAGEOFFSET'];
94 $last = $aMsg['LAST'];
95 if (isset($aMsg['SEARCH']) && count($aMsg['SEARCH']) >1 ) {
96 $where = $aMsg['SEARCH'][0];
97 $what = $aMsg['SEARCH'][1];
98 } else {
99 $where = false;
100 $what = false;
101 }
102 $iIndent = $aMsg['INDENT'];
103
104 $sSubject = (isset($msg['SUBJECT']) && $msg['SUBJECT'] != '') ? $msg['SUBJECT'] : _("(no subject)");
105 $sFrom = (isset($msg['FROM'])) ? $msg['FROM'] : _("Unknown sender");
106 $sTo = (isset($msg['TO'])) ? $msg['TO'] : _("Unknown recipient");
107 $sCc = (isset($msg['CC'])) ? $msg['CC'] : '';
108 $aFlags = (isset($msg['FLAGS'])) ? $msg['FLAGS'] : array();
109 $iPrio = (isset($msg['PRIORITY'])) ? $msg['PRIORITY'] : 3;
110 $iSize = (isset($msg['SIZE'])) ? $msg['SIZE'] : 0;
111 $sType0 = (isset($msg['TYPE0'])) ? $msg['TYPE0'] : 'text';
112 $sType1 = (isset($msg['TYPE1'])) ? $msg['TYPE1'] : 'plain';
113 if (isset($msg['INTERNALDATE'])) {
114 $sDate = getDateString(getTimeStamp(explode(' ',$msg['INTERNALDATE'])));
115 } else {
116 $sDate = (isset($msg['DATE'])) ? getDateString(getTimeStamp(explode(' ',$msg['DATE']))) : '';
117 }
118 $iId = (isset($msg['ID'])) ? $msg['ID'] : false;
119
120 if (!$iId) {
121 return;
122 }
123
124 if ($GLOBALS['alt_index_colors']) {
125 if (!($t % 2)) {
126 if (!isset($color[12])) {
127 $color[12] = '#EAEAEA';
128 }
129 $color_string = $color[12];
130 }
131 }
132
133 $urlMailbox = urlencode($mailbox);
134
135 // FIXME, foldertype should be set in right_main.php
136 // in other words, handle as sent is obsoleted from now.
137 // We replace that by providing an array to aMailbox with the to shown headers
138 // that way we are free to show the user different layouts for different folders
139 $bSentFolder = handleAsSent($mailbox);
140 if ((!$bSentFolder) && ($show_recipient_instead)) {
141 // If the From address is the same as $email_address, then handle as Sent
142 $from_array = parseAddress($sFrom, 1);
143 if (!isset($email_address)) {
144 global $datadir, $username;
145 $email_address = getPref($datadir, $username, 'email_address');
146 }
147 $bHandleAsSent = ((isset($from_array[0][0])) && ($from_array[0][0] == $email_address));
148 } else {
149 $bHandleAsSent = $bSentFolder;
150 }
151 // If this is a Sent message, display To address instead of From
152 if ($bHandleAsSent) {
153 $sFrom = $sTo;
154 }
155 // Passing 1 below results in only 1 address being parsed, thus defeating the following code
156 $sFrom = parseAddress($sFrom/*,1*/);
157
158 /*
159 * This is done in case you're looking into Sent folders,
160 * because you can have multiple receivers.
161 */
162 $senderNames = $sFrom;
163 $senderName = '';
164 $senderAddress = '';
165 if (sizeof($senderNames)){
166 foreach ($senderNames as $senderNames_part) {
167 if ($senderName != '') {
168 $senderName .= ', ';
169 $senderAddress .= ', ';
170 }
171 $sender_address_part = htmlspecialchars($senderNames_part[0]);
172 $sender_name_part = str_replace('&nbsp;',' ', decodeHeader($senderNames_part[1]));
173 if ($sender_name_part) {
174 $senderName .= $sender_name_part;
175 $senderAddress .= $sender_name_part . ' <' . $sender_address_part . '>';
176 } else {
177 $senderName .= $sender_address_part;
178 $senderAddress .= $sender_address_part;
179 }
180 }
181 }
182 // If Sent, prefix with To: but only if not Sent folder
183 if ($bHandleAsSent ^ $bSentFolder) {
184 $senderName = _("To:") . ' ' . $senderName;
185 $senderAddress = _("To:") . ' ' . $senderAddress;
186 }
187
188 // this is a column property which can apply to multiple columns. Do not use vars for one column
189 // only. instead we should use something like this:
190 // 1ed column $aMailbox['columns']['SUBJECT'] value: aray with properties ...
191 // 2ed column $aMailbox['columns']['FROM'] value: aray with properties ...
192 // NB in case of the sentfolder this could be the TO field
193 // properties array example:
194 // 'truncate' => length (0 is no truncate)
195 // 'prefix => if (x in b then do that )
196 if ($truncate_sender > 0) {
197 $senderName = truncateWithEntities($senderName, $truncate_sender);
198 }
199
200 $flag = $flag_end = $bold = $bold_end = $fontstr = $fontstr_end = $italic = $italic_end = '';
201 $bold = '<b>';
202 $bold_end = '</b>';
203
204 foreach ($aFlags as $sFlag => $value) {
205 switch ($sFlag) {
206 case '\\flagged':
207 if ($value) {
208 $flag = "<font color=\"$color[2]\">";
209 $flag_end = '</font>';
210 }
211 break;
212 case '\\seen':
213 if ($value) {
214 $bold = '';
215 $bold_end = '';
216 }
217 break;
218 case '\\deleted':
219 if ($value) {
220 $fontstr = "<font color=\"$color[9]\">";
221 $fontstr_end = '</font>';
222 }
223 break;
224 }
225 }
226 if ($bHandleAsSent) {
227 $italic = '<i>';
228 $italic_end = '</i>';
229 }
230
231 if ($where && $what) {
232 $searchstr = '&amp;where='.$where.'&amp;what='.$what;
233 } else {
234 $searchstr = '';
235 }
236 /*
237 * Message highlight code
238 */
239 $matches = array('TO' => 'sTo', 'CC' => 'sCc', 'FROM' => 'sFrom', 'SUBJECT' => 'sSubject');
240 if (is_array($message_highlight_list) && count($message_highlight_list)) {
241 $sTo = parseAddress($sTo);
242 $sCc = parseAddress($sCc);
243 foreach ($message_highlight_list as $message_highlight_list_part) {
244 if (trim($message_highlight_list_part['value']) != '') {
245 $high_val = strtolower($message_highlight_list_part['value']);
246 $match_type = strtoupper($message_highlight_list_part['match_type']);
247 if($match_type == 'TO_CC') {
248 $match = array('TO', 'CC');
249 } else {
250 $match = array($match_type);
251 }
252 foreach($match as $match_type) {
253 switch($match_type) {
254 case('TO'):
255 case('CC'):
256 case('FROM'):
257 foreach ($$matches[$match_type] as $address) {
258 $address[0] = decodeHeader($address[0], true, false);
259 $address[1] = decodeHeader($address[1], true, false);
260 if (strstr('^^' . strtolower($address[0]), $high_val) ||
261 strstr('^^' . strtolower($address[1]), $high_val)) {
262 $hlt_color = $message_highlight_list_part['color'];
263 break 4;
264 }
265 }
266 break;
267 default:
268 $headertest = strtolower(decodeHeader($$matches[$match_type], true, false));
269 if (strstr('^^' . $headertest, $high_val)) {
270 $hlt_color = $message_highlight_list_part['color'];
271 break 3;
272 }
273 break;
274 }
275 }
276 }
277 }
278 } /* end Message highlight code */
279
280 if (!isset($hlt_color)) {
281 $hlt_color = $color_string;
282 }
283 $col = 0;
284 $sSubject = str_replace('&nbsp;', ' ', decodeHeader($sSubject));
285 $subject = processSubject($sSubject, $iIndent);
286
287 echo html_tag( 'tr','','','','VALIGN="top"') . "\n";
288
289 if (sizeof($index_order)) {
290 foreach ($index_order as $index_order_part) {
291 switch ($index_order_part) {
292 case 1: /* checkbox */
293 echo html_tag( 'td',
294 addCheckBox("msg[$t]", $checkall, $iId),
295 'center',
296 $hlt_color );
297 break;
298 case 2: /* from */
299 if ($senderAddress != $senderName) {
300 $senderAddress = strtr($senderAddress, array_flip(get_html_translation_table(HTML_SPECIALCHARS)));
301 $title = ' title="' . str_replace('"', "''", $senderAddress) . '"';
302 } else {
303 $title = '';
304 }
305 echo html_tag( 'td',
306 $italic . $bold . $flag . $fontstr . $senderName .
307 $fontstr_end . $flag_end . $bold_end . $italic_end,
308 'left',
309 $hlt_color, $title );
310 break;
311 case 3: /* date */
312 if ($sDate == '') {
313 $sDate = _("Unknown date");
314 }
315 echo html_tag( 'td',
316 $bold . $flag . $fontstr . $sDate .
317 $fontstr_end . $flag_end . $bold_end,
318 'center',
319 $hlt_color,
320 'nowrap' );
321 break;
322 case 4: /* subject */
323 $td_str = $bold;
324 if ($iIndent) {
325 $td_str .= str_repeat("&nbsp;&nbsp;&nbsp;&nbsp;",$iIndent);
326 }
327 $td_str .= '<a href="read_body.php?mailbox='.$urlMailbox
328 . '&amp;passed_id='. $msg["ID"]
329 . '&amp;startMessage='.$start_msg.$searchstr.'"';
330 $td_str .= ' ' .concat_hook_function('subject_link', array($start_msg, $searchstr));
331 if ($subject != $sSubject) {
332 $title = get_html_translation_table(HTML_SPECIALCHARS);
333 $title = array_flip($title);
334 $title = strtr($sSubject, $title);
335 $title = str_replace('"', "''", $title);
336 $td_str .= " title=\"$title\"";
337 }
338 $td_str .= ">$flag$subject$flag_end</a>$bold_end";
339 echo html_tag( 'td', $td_str, 'left', $hlt_color );
340 break;
341 case 5: /* flags */
342
343 // icon message markers
344 //
345 if ($use_icons && $icon_theme != 'none') {
346 $td_str = "<b><small>";
347 if (isset($aFlags['\\flagged']) && $aFlags['\\flagged'] == true) {
348 $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/flagged.png" border="0" height="10" width="10" /> ';
349 }
350 if ($default_use_priority) {
351 if ( ($iPrio == 1) || ($iPrio == 2) ) {
352 $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/prio_high.png" border="0" height="10" width="5" /> ';
353 }
354 else if ($iPrio == 5) {
355 $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/prio_low.png" border="0" height="10" width="5" /> ';
356 }
357 else {
358 $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/transparent.png" border="0" width="5" /> ';
359 }
360 }
361 if ($sType1 == 'mixed') {
362 $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/attach.png" border="0" height="10" width="6" />';
363 } else {
364 $td_str .= '<img src="' . SM_PATH . 'images/themes/' . $icon_theme . '/transparent.png" border="0" width="6" />';
365 }
366
367 $msg_icon = '';
368 if (!isset($aFlags['\\seen']) || ($aFlags['\\seen']) == false) {
369 $msg_alt = '(' . _("New") . ')';
370 $msg_title = '(' . _("New") . ')';
371 $msg_icon .= SM_PATH . 'images/themes/' . $icon_theme . '/msg_new';
372 } else {
373 $msg_alt = '(' . _("Read") . ')';
374 $msg_title = '(' . _("Read") . ')';
375 $msg_icon .= SM_PATH . 'images/themes/' . $icon_theme . '/msg_read';
376 }
377 if (isset($aFlags['\\deleted']) && ($aFlags['\\deleted']) == true) {
378 $msg_icon .= '_deleted';
379 }
380 if (isset($aFlags['\\answered']) && ($aFlags['\\answered']) == true) {
381 $msg_alt = '(' . _("Answered") . ')';
382 $msg_title = '(' . _("Answered") . ')';
383 $msg_icon .= '_reply';
384 }
385 $td_str .= '<img src="' . $msg_icon . '.png" border="0" alt="'. $msg_alt . '" title="' . $msg_title . '" height="12" width="18" />';
386 $td_str .= '</small></b>';
387 echo html_tag( 'td',
388 $td_str,
389 'right',
390 $hlt_color,
391 'nowrap' );
392 }
393
394 // plain text message markers
395 //
396 else {
397 $stuff = false;
398 $td_str = "<b><small>";
399 if (isset($aFlags['\\answered']) && $aFlags['\\answered'] == true) {
400 $td_str .= _("A");
401 $stuff = true;
402 }
403 if ($sType1 == 'mixed') {
404 $td_str .= '+';
405 $stuff = true;
406 }
407 if ($default_use_priority) {
408 if ( ($iPrio == 1) || ($iPrio == 2) ) {
409 $td_str .= "<font color=\"$color[1]\">!</font>";
410 $stuff = true;
411 }
412 if ($iPrio == 5) {
413 $td_str .= "<font color=\"$color[8]\">?</font>";
414 $stuff = true;
415 }
416 }
417 if (isset($aFlags['\\deleted']) && $aFlags['\\deleted'] == true) {
418 $td_str .= "<font color=\"$color[1]\">D</font>";
419 $stuff = true;
420 }
421 if (!$stuff) {
422 $td_str .= '&nbsp;';
423 }
424 $td_str .= '</small></b>';
425 echo html_tag( 'td',
426 $td_str,
427 'center',
428 $hlt_color,
429 'nowrap' );
430 }
431 break;
432 case 6: /* size */
433 echo html_tag( 'td',
434 $bold . $fontstr . show_readable_size($iSize) .
435 $fontstr_end . $bold_end,
436 'right',
437 $hlt_color );
438 break;
439 }
440 ++$col;
441 }
442 }
443 /* html for separationlines between rows */
444 if ($last) {
445 echo '</tr>'."\n";
446 } else {
447 echo '</tr>' . "\n" . '<tr><td colspan="' . $col . '" bgcolor="' .
448 $color[0] . '" height="1"></td></tr>' . "\n";
449 }
450 }
451
452 /**
453 * Does the $sort $_GET var to field mapping
454 *
455 * @param int $sort Field to sort on
456 * @param bool $bServerSort Server sorting is true
457 * @param mixed $key UNDOCUMENTED
458 * @return string $sSortField Field tosort on
459 */
460 function getSortField($sort,$bServerSort) {
461 switch($sort) {
462 case SQSORT_NONE:
463 $sSortField = 'UID';
464 break;
465 case SQSORT_DATE_ASC:
466 case SQSORT_DATE_DEC:
467 $sSortField = 'DATE';
468 break;
469 case SQSORT_FROM_ASC:
470 case SQSORT_FROM_DEC:
471 $sSortField = 'FROM';
472 break;
473 case SQSORT_SUBJ_ASC:
474 case SQSORT_SUBJ_DEC:
475 $sSortField = 'SUBJECT';
476 break;
477 case SQSORT_SIZE_ASC:
478 case SQSORT_SIZE_DEC:
479 $sSortField = ($bServerSort) ? 'SIZE' : 'RFC822.SIZE';
480 break;
481 case SQSORT_TO_ASC:
482 case SQSORT_TO_DEC:
483 $sSortField = 'TO';
484 break;
485 case SQSORT_CC_ASC:
486 case SQSORT_CC_DEC:
487 $sSortField = 'CC';
488 break;
489 case SQSORT_INT_DATE_ASC:
490 case SQSORT_INT_DATE_DEC:
491 $sSortField = ($bServerSort) ? 'ARRIVAL' : 'INTERNALDATE';
492 break;
493 case SQSORT_THREAD:
494 break;
495 default: $sSortField = 'UID';
496 break;
497
498 }
499 return $sSortField;
500 }
501
502 function get_sorted_msgs_list($imapConnection,$aMailbox,&$error) {
503 $bDirection = ($aMailbox['SORT'] % 2);
504 $error = false;
505 switch ($aMailbox['SORT_METHOD']) {
506 case 'THREAD':
507 $id = get_thread_sort($imapConnection);
508 if ($id === false) {
509 $error = '<b><small><center><font color=red>' .
510 _("Thread sorting is not supported by your IMAP server.") . '<br />' .
511 _("Please report this to the system administrator.").
512 '</center></small></b>';
513 }
514 break;
515 case 'SERVER':
516 $sSortField = getSortField($aMailbox['SORT'],true);
517 $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection);
518 if ($id === false) {
519 $error = '<b><small><center><font color=red>' .
520 _( "Server-side sorting is not supported by your IMAP server.") . '<br />' .
521 _("Please report this to the system administrator.").
522 '</center></small></b>';
523 }
524 break;
525 default:
526 $sSortField = getSortField($aMailbox['SORT'],false);
527 $id = get_squirrel_sort($imapConnection, $sSortField, $bDirection);
528 break;
529 }
530 return $id;
531 }
532
533 /**
534 * This function loops through a group of messages in the mailbox
535 * and shows them to the user.
536 *
537 * @param mixed $imapConnection
538 * @param array $aMailbox associative array with mailbox related vars
539 */
540 function showMessagesForMailbox($imapConnection, $aMailbox) {
541 global $msgs, $server_sort_array,$indent_array;
542
543 // to retrieve the internaldate pref: (I know this is not the right place to do that, move up in front
544 // and use a properties array as function argument to provide user preferences
545 global $data_dir, $username;
546
547 /* if there's no messages in this folder */
548 if ($aMailbox['EXISTS'] == 0) {
549 $string = '<b>' . _("THIS FOLDER IS EMPTY") . '</b>';
550 echo ' <table width="100%" cellpadding="1" cellspacing="0" align="center"'.' border="0" bgcolor="'.$color[9].'">';
551 echo ' <tr><td>';
552 echo ' <table width="100%" cellpadding="0" cellspacing="0" align="center" border="0" bgcolor="'.$color[4].'">';
553 echo ' <tr><td><br />';
554 echo ' <table cellpadding="1" cellspacing="5" align="center" border="0">';
555 echo ' <tr>' . html_tag( 'td', $string."\n", 'left')
556 . '</tr>';
557 echo ' </table>';
558 echo ' <br /></td></tr>';
559 echo ' </table></td></tr>';
560 echo ' </table>';
561 return;
562 } else {
563 /*
564 * Adjust the start_msg
565 */
566 $start_msg = $aMailbox['PAGEOFFSET'];
567 if($aMailbox['PAGEOFFSET'] > $aMailbox['EXISTS']) {
568 $start_msg -= $aMailbox['LIMIT'];
569 if($start_msg < 1) {
570 $start_msg = 1;
571 }
572 }
573 $aMailbox['SEARCH'] = array(); // Alex maybe you can change this so that you can use it from a search
574
575 // initialize the fields we want to retrieve:
576 $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type');
577 $aFetchItems = array('FLAGS', 'RFC822.SIZE');
578 // Are we sorting on internaldate then retrieve the internaldate value as well
579 $internaldate = getPref($data_dir, $username, 'internal_date_sort');
580 if ($internaldate) {
581 $aFetchItems[] = 'INTERNALDATE';
582 }
583
584 if ($aMailbox['SORT'] != SQSORT_NONE && isset($aMailbox['UIDSET']) &&
585 $aMailbox['UIDSET'] ) {
586 $id = $aMailbox['UIDSET'];
587 if (sqsession_is_registered('msgs')) {
588 sqsession_unregister('msgs');
589 }
590 $id_slice = array_slice($id,$start_msg-1,$aMailbox['LIMIT']);
591 if (count($id_slice)) {
592 $msgs = sqimap_get_small_header_list($imapConnection,$id_slice,$aMailbox['LIMIT'],
593 $aHeaderFields,$aFetchItems);
594
595 } else {
596 return false;
597 }
598 // FIX ME, move to msgs cache bound to a mailbox
599 sqsession_register($msgs, 'msgs');
600 } else {
601 if (sqsession_is_registered('server_sort_array')) {
602 sqsession_unregister('server_sort_array');
603 }
604
605 if ($aMailbox['SORT'] != SQSORT_NONE || $aMailbox['SORT_METHOD'] == 'THREAD') {
606 $id = get_sorted_msgs_list($imapConnection,$aMailbox,$error);
607 if ($id !== false) {
608 $id_slice = array_slice($id,$aMailbox['OFFSET'], $aMailbox['LIMIT']);
609 if (count($id_slice)) {
610 $msgs = sqimap_get_small_header_list($imapConnection,$id_slice,$aMailbox['LIMIT'],
611 $aHeaderFields,$aFetchItems);
612 } else {
613 // FIX ME do error handling
614 return false;
615 }
616 } else {
617 // FIX ME, format message and fallback to squirrel sort
618 if ($error) {
619 echo $error;
620 }
621 }
622 } else {
623 /**
624 * retrieve messages by sequence id's and fetch the UID to retrieve
625 * the UID. for sorted lists this is not needed because a UID FETCH
626 * automaticly add the UID value in fetch results
627 **/
628 $aFetchItems[] = 'UID';
629
630 //create id range
631 $iRangeEnd = (($aMailbox['EXISTS'] - $aMailbox['OFFSET']) > $aMailbox['LIMIT']) ?
632 $aMailbox['EXISTS'] - $aMailbox['OFFSET'] +1 - $aMailbox['LIMIT']:
633 $aMailbox['EXISTS'] - $aMailbox['OFFSET'];
634 $iRangeStart = (($aMailbox['EXISTS'] - $aMailbox['OFFSET']) > $aMailbox['LIMIT']) ?
635 $aMailbox['EXISTS']-$aMailbox['OFFSET'] +1:1;
636 $id_slice = range($iRangeStart, $iRangeEnd);
637 $msgs = sqimap_get_small_header_list($imapConnection,$id_slice,$aMailbox['LIMIT'],
638 $aHeaderFields,$aFetchItems);
639 $msgs = array_reverse($msgs,true /* preserve key */);
640 // generate id array
641 $id = array_keys($msgs);
642 $aMailbox['OFFSET'] = 0;
643 }
644 // FIX ME, use an id list bound to a mailbox
645 if ($id !== false) {
646 sqsession_register($id, 'server_sort_array');
647 }
648
649 sqsession_register($msgs, 'msgs');
650 }
651 $aMailbox['UIDSET'] =& $id;
652 $aMailbox['MSG_HEADERS'] =& $msgs;
653 if ($aMailbox['SORT_METHOD'] == 'THREAD') {
654 // retrieve indent array for thread sort
655 sqgetGlobalVar('indent_array',$indent_array,SQ_SESSION);
656 $aMailbox['THREAD_INDENT'] =& $indent_array;
657 }
658 } /* if exists > 0 */
659
660 $iEnd = ($aMailbox['PAGEOFFSET'] + ($aMailbox['LIMIT'] - 1) < $aMailbox['EXISTS']) ?
661 $aMailbox['PAGEOFFSET'] + $aMailbox['LIMIT'] - 1 : $aMailbox['EXISTS'];
662
663 $paginator_str = get_paginator_str($aMailbox['NAME'], $aMailbox['PAGEOFFSET'], $iEnd,
664 $aMailbox['EXISTS'], $aMailbox['LIMIT'], $aMailbox['SORT']);
665
666 $msg_cnt_str = get_msgcnt_str($aMailbox['PAGEOFFSET'], $iEnd,$aMailbox['EXISTS']);
667
668 do_hook('mailbox_index_before');
669 ?>
670 <table border="0" width="100%" cellpadding="0" cellspacing="0">
671 <tr>
672 <td>
673 <?php mail_message_listing_beginning($imapConnection, $aMailbox, $msg_cnt_str, $paginator_str); ?>
674 </td>
675 </tr>
676 <tr><td height="5" bgcolor="<?php echo $color[4]; ?>"></td></tr>
677 <tr>
678 <td>
679 <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="<?php echo $color[9]; ?>">
680 <tr>
681 <td>
682 <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="<?php echo $color[5]; ?>">
683 <tr>
684 <td>
685 <?php
686 printHeader($aMailbox);
687 displayMessageArray($imapConnection, $aMailbox);
688 ?>
689 </td>
690 </tr>
691 </table>
692 </td>
693 </tr>
694 </table>
695 <?php
696 mail_message_listing_end($aMailbox['EXISTS'], $paginator_str, $msg_cnt_str);
697 ?>
698 </td>
699 </tr>
700 </table>
701 <?php
702 //$t = elapsed($start);
703 //echo("elapsed time = $t seconds\n");
704 }
705
706 /**
707 * Function to map an uid list with a msg header array by uid
708 * The mapped headers are printed with printMessage
709 * aMailbox parameters contains info about the page we are on, the
710 * used search criteria, the number of messages to show
711 *
712 * @param resource $imapConnection socket handle to imap
713 * @param array $aMailbox array with required elements MSG_HEADERS, UIDSET, OFFSET, LIMIT
714 * @return void
715 **/
716 function displayMessageArray($imapConnection, $aMailbox) {
717
718 $aId = $aMailbox['UIDSET'];
719 $aHeaders = $aMailbox['MSG_HEADERS'];
720 $iOffset = $aMailbox['OFFSET'];
721 $sort = $aMailbox['SORT'];
722 $iPageOffset = $aMailbox['PAGEOFFSET'];
723 $sMailbox = $aMailbox['NAME'];
724 $aSearch = (isset($aMailbox['SEARCH'])) ? $aMailbox['SEARCH'] : false;
725 if ($aMailbox['SORT_METHOD'] == 'THREAD') {
726 $aIndentArray =& $aMailbox['THREAD_INDENT'];
727 $bThread = true;
728 } else {
729 $bThread = false;
730 }
731 /*
732 * Loop through and display the info for each message.
733 * ($t is used for the checkbox number)
734 */
735 $iEnd = ($aMailbox['LIMIT']) ? $iOffset + $aMailbox['LIMIT'] : 99999999 /* no limit */;
736 for ($i=$iOffset,$t=0;$i<$iEnd;++$i) {
737 if (isset($aId[$i])) {
738 $bLast = ((isset($aId[$i+1]) && isset($aHeaders[$aId[$i+1]]))
739 || ($i == $iEnd )) ? false : true;
740 if ($bThread) {
741 $indent = (isset($aIndentArray[$aId[$i]])) ? $aIndentArray[$aId[$i]] : 0;
742 } else {
743 $indent = 0;
744 }
745 $aMsg = array(
746 'HEADER' => $aHeaders[$aId[$i]],
747 'INDX' => $t,
748 'OFFSET' => $iOffset,
749 'PAGEOFFSET' => $iPageOffset,
750 'SORT' => $sort,
751 'SEARCH' => $aSearch,
752 'MAILBOX' => $sMailbox,
753 'INDENT' => $indent,
754 'LAST' => $bLast
755 );
756 printMessageInfo($aMsg);
757 ++$t;
758 } else {
759 break;
760 }
761 }
762 }
763
764 /**
765 * Displays the standard message list header.
766 *
767 * To finish the table, you need to do a "</table></table>";
768 *
769 * @param resource $imapConnection
770 * @param array $aMailbox associative array with mailbox related information
771 * @param string $msg_cnt_str
772 * @param string $paginator Paginator string
773 */
774 function mail_message_listing_beginning ($imapConnection,
775 $aMailbox,
776 $msg_cnt_str = '',
777 $paginator = '&nbsp;'
778 ) {
779 global $color, $base_uri, $show_flag_buttons, $PHP_SELF;
780
781
782
783 $php_self = $PHP_SELF;
784 /* fix for incorrect $PHP_SELF */
785 if (strpos($php_self, 'move_messages.php')) {
786 $php_self = str_replace('move_messages.php', 'right_main.php', $php_self);
787 }
788 $urlMailbox = urlencode($aMailbox['NAME']);
789
790 if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
791 $source_url = $regs[1];
792 } else {
793 $source_url = $php_self;
794 }
795
796 if (!isset($msg)) {
797 $msg = '';
798 }
799
800 if (!strpos($php_self,'?')) {
801 $location = $php_self.'?mailbox=INBOX&amp;startMessage=1';
802 } else {
803 $location = $php_self;
804 }
805
806 $moveFields = addHidden('msg', $msg).
807 addHidden('mailbox', $aMailbox['NAME']).
808 addHidden('startMessage', $aMailbox['PAGEOFFSET']).
809 addHidden('location', $location);
810
811 /* build thread sorting links */
812
813 if ($aMailbox['ALLOW_THREAD']) {
814 if ($aMailbox['SORT_METHOD'] == 'THREAD') {
815 $set_thread = 2;
816 $thread_name = _("Unthread View");
817 } else {
818 $set_thread = 1;
819 $thread_name = _("Thread View");
820 }
821 $thread_link_str = '<small>[<a href="' . $source_url . '?sort='
822 . $aMailbox['SORT'] . '&start_messages=1&set_thread=' . $set_thread
823 . '&mailbox=' . urlencode($aMailbox['NAME']) . '">' . $thread_name
824 . '</a>]</small>';
825 } else {
826 $thread_link_str ='';
827 }
828 /*
829 * This is the beginning of the message list table.
830 * It wraps around all messages
831 */
832 $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
833 $form_name = "FormMsgs" . $safe_name;
834
835 echo '<form name="' . $form_name . '" method="post" action="move_messages.php">' ."\n"
836 . $moveFields;
837 ?>
838 <table width="100%" cellpadding="1" cellspacing="0" style="border: 1px solid <?php echo $color[0]; ?>">
839 <tr>
840 <td>
841 <table bgcolor="<?php echo $color[4]; ?>" border="0" width="100%" cellpadding="1" cellspacing="0">
842 <tr>
843 <td align="left"><small><?php echo $paginator . $thread_link_str; ?></small></td>
844 <td align="center"></td>
845 <td align="right"><small><?php echo $msg_cnt_str; ?></small></td>
846 </tr>
847 </table>
848 </td>
849 </tr>
850 <tr width="100%" cellpadding="1" cellspacing="0" border="0" bgcolor="<?php echo $color[0]; ?>">
851 <td>
852 <table border="0" width="100%" cellpadding="1" cellspacing="0">
853 <tr>
854 <td align="left">
855 <small><?php
856
857 // display flag buttons only if supported
858 if ($show_flag_buttons &&
859 array_search('\\flagged',$aMailbox['PERMANENTFLAGS'], true) !== FALSE) {
860 echo getButton('SUBMIT', 'markUnflagged',_("Unflag"));
861 echo getButton('SUBMIT', 'markFlagged',_("Flag"));
862 echo '&nbsp;';
863 }
864 if (array_search('\\seen',$aMailbox['PERMANENTFLAGS'], true) !== FALSE) {
865 echo getButton('SUBMIT', 'markUnread',_("Unread"));
866 echo getButton('SUBMIT', 'markRead',_("Read"));
867 echo '&nbsp;';
868 }
869
870 echo getButton('SUBMIT', 'attache',_("Forward"));
871 echo '&nbsp;';
872 if (array_search('\\deleted',$aMailbox['PERMANENTFLAGS'], true) !== FALSE) {
873 echo getButton('SUBMIT', 'delete',_("Delete"));
874 echo '<input type="checkbox" name="bypass_trash" />' . _("Bypass Trash");
875 echo '&nbsp;';
876 }
877 if (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY') {
878 echo getButton('SUBMIT', 'expungeButton',_("Expunge")) .'&nbsp;' . _("mailbox") . "\n";
879 echo '&nbsp;';
880 }
881 do_hook('mailbox_display_buttons');
882 ?></small>
883 </td>
884 <?php
885 if (array_search('\\deleted',$aMailbox['PERMANENTFLAGS'], true) !== FALSE) {
886 echo '<td align="right">
887 <small>';
888 //echo $thread_link_str; //previous behaviour
889 getMbxList($imapConnection);
890 echo getButton('SUBMIT', 'moveButton',_("Move")) . "\n
891 </small>";
892 }
893 ?>
894 </td>
895 </tr>
896 </table>
897 </td>
898 </tr>
899 </table>
900
901 <?php
902 do_hook('mailbox_form_before');
903 }
904
905 /**
906 * Function to add the last row in a message list, it contains the paginator and info about
907 * the number of messages.
908 *
909 * @param integer $num_msgs number of messages in a mailbox
910 * @param string $paginator_str Paginator string [Prev | Next] [ 1 2 3 ... 91 92 94 ] [Show all]
911 * @param string $msg_cnt_str Message count string Viewing Messages: 21 to 1861 (20 total)
912 */
913 function mail_message_listing_end($num_msgs, $paginator_str, $msg_cnt_str) {
914 global $color;
915 if ($num_msgs) {
916 /* space between list and footer */
917 ?>
918 <tr><td height="5" bgcolor="<?php echo $color[4]; ?>" colspan="1"></td></tr>
919 <tr>
920 <td>
921 <table width="100%" cellpadding="1" cellspacing="0" style="border: 1px solid <?php echo $color[0]; ?>">
922 <tr>
923 <td>
924 <table bgcolor="<?php echo $color[4]; ?>" border="0" width="100%" cellpadding="1" cellspacing="0">
925 <tr>
926 <td align="left"><small><?php echo $paginator_str; ?></small></td>
927 <td align="right"><small><?php echo $msg_cnt_str; ?></small></td>
928 </tr>
929 </table>
930 </td>
931 </tr>
932 </table>
933 </td>
934 </tr>
935 <?php
936 }
937 /* End of message-list table */
938
939 do_hook('mailbox_index_after');
940 echo "</form>\n";
941 }
942
943 /**
944 * Prints the table header for the messages list view
945 *
946 * @param array $aMailbox
947 */
948 function printHeader($aMailbox) {
949 global $index_order, $internal_date_sort, $color;
950
951 if ($aMailbox['SORT_METHOD'] != 'THREAD') {
952 $showsort = true;
953 } else {
954 $showsort = false;
955 }
956
957 echo html_tag( 'tr' ,'' , 'center', $color[5] );
958
959 /* calculate the width of the subject column based on the
960 * widths of the other columns */
961 $widths = array(1=>1,2=>25,3=>5,4=>0,5=>1,6=>5);
962 $subjectwidth = 100;
963 foreach($index_order as $item) {
964 $subjectwidth -= $widths[$item];
965 }
966
967 foreach ($index_order as $item) {
968 switch ($item) {
969 case 1: /* checkbox */
970 echo html_tag( 'td',get_selectall_link($aMailbox) , '', '', 'width="1%"' );
971 break;
972 case 5: /* flags */
973 echo html_tag( 'td','' , '', '', 'width="1%"' );
974 break;
975 case 2: /* from */
976 if (handleAsSent($aMailbox['NAME'])) {
977 echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
978 . '<b>' . _("To") . '</b>';
979 if ($showsort) {
980 ShowSortButton($aMailbox, SQSORT_TO_ASC, SQSORT_TO_DEC);
981 }
982 } else {
983 echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
984 . '<b>' . _("From") . '</b>';
985 if ($showsort) {
986 ShowSortButton($aMailbox, SQSORT_FROM_ASC, SQSORT_FROM_DEC);
987 }
988 }
989 echo "</td>\n";
990 break;
991 case 3: /* date */
992 echo html_tag( 'td' ,'' , 'left', '', 'width="5%" nowrap' )
993 . '<b>' . _("Date") . '</b>';
994 if ($showsort) {
995 if ($internal_date_sort) {
996 ShowSortButton($aMailbox, SQSORT_INT_DATE_ASC, SQSORT_INT_DATE_DEC);
997 } else {
998 ShowSortButton($aMailbox, SQSORT_DATE_ASC, SQSORT_DATE_DEC);
999 }
1000 }
1001 echo "</td>\n";
1002 break;
1003 case 4: /* subject */
1004 echo html_tag( 'td' ,'' , 'left', '', 'width="'.$subjectwidth.'%"' )
1005 . '<b>' . _("Subject") . '</b>';
1006 if ($showsort) {
1007 ShowSortButton($aMailbox, SQSORT_SUBJ_ASC, SQSORT_SUBJ_DEC);
1008 }
1009 echo "</td>\n";
1010 break;
1011 case 6: /* size */
1012 echo html_tag( 'td', '', 'center','','width="5%" nowrap')
1013 . '<b>' . _("Size") . '</b>';
1014 if ($showsort) {
1015 ShowSortButton($aMailbox, SQSORT_SIZE_ASC, SQSORT_SIZE_DEC);
1016 }
1017 echo "</td>\n";
1018 break;
1019 }
1020 }
1021 echo "</tr>\n";
1022 }
1023
1024
1025 /**
1026 * This function shows the sort button. Isn't this a good comment?
1027 *
1028 * @param array $aMailbox
1029 * @param integer $Down
1030 * @param integer $Up
1031 */
1032 function ShowSortButton($aMailbox, $Down, $Up ) {
1033 global $PHP_SELF;
1034
1035 /* Figure out which image we want to use. */
1036 if ($aMailbox['SORT'] != $Up && $aMailbox['SORT'] != $Down) {
1037 $img = 'sort_none.png';
1038 $which = $Up;
1039 } elseif ($aMailbox['SORT'] == $Up) {
1040 $img = 'up_pointer.png';
1041 $which = $Down;
1042 } else {
1043 $img = 'down_pointer.png';
1044 $which = 0;
1045 }
1046
1047 if (preg_match('/^(.+)\?.+$/',$PHP_SELF,$regs)) {
1048 $source_url = $regs[1];
1049 } else {
1050 $source_url = $PHP_SELF;
1051 }
1052
1053 /* Now that we have everything figured out, show the actual button. */
1054 echo ' <a href="' . $source_url .'?newsort=' . $which
1055 . '&amp;startMessage=1&amp;mailbox=' . urlencode($aMailbox['NAME'])
1056 . '"><img src="../images/' . $img
1057 . '" border="0" width="12" height="10" alt="sort" title="'
1058 . _("Click here to change the sorting of the message list") .' /"></a>';
1059 }
1060
1061 /**
1062 * FIXME: Undocumented function
1063 *
1064 * @param array $aMailbox
1065 */
1066 function get_selectall_link($aMailbox) {
1067 global $checkall, $javascript_on;
1068 global $PHP_SELF, $PG_SHOWNUM;
1069
1070 $result = '';
1071 if ($javascript_on) {
1072 $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
1073 $func_name = "CheckAll" . $safe_name;
1074 $form_name = "FormMsgs" . $safe_name;
1075 $result = '<script language="JavaScript" type="text/javascript">'
1076 . "\n<!-- \n"
1077 . "function " . $func_name . "() {\n"
1078 . " for (var i = 0; i < document." . $form_name . ".elements.length; i++) {\n"
1079 . " if(document." . $form_name . ".elements[i].type == 'checkbox' && "
1080 . " document." . $form_name . ".elements[i].name.substring(0,3) == 'msg'){\n"
1081 . " document." . $form_name . ".elements[i].checked = "
1082 . " !(document." . $form_name . ".elements[i].checked);\n"
1083 . " }\n"
1084 . " }\n"
1085 . "}\n"
1086 . "//-->\n"
1087 . '</script>'
1088 . '<input type="checkbox" name="toggleAll" title="'._("Toggle All").'" onclick="'.$func_name.'();" />';
1089 // . <a href="javascript:void(0)" onClick="' . $func_name . '();">' . _("Toggle All")
1090 // . "</a>\n";
1091 } else {
1092 if (strpos($PHP_SELF, "?")) {
1093 $result .= "<a href=\"$PHP_SELF&amp;mailbox=" . urlencode($aMailbox['NAME'])
1094 . "&amp;startMessage=$aMailbox[PAGEOFFSET]&amp;sort=$aMailbox[SORT]&amp;checkall=";
1095 } else {
1096 $result .= "<a href=\"$PHP_SELF?mailbox=" . urlencode($mailbox)
1097 . "&amp;startMessage=$aMailbox[PAGEOFFSET]&amp;sort=$aMailbox[SORT]&amp;checkall=";
1098 }
1099 if (isset($checkall) && $checkall == '1') {
1100 $result .= '0';
1101 } else {
1102 $result .= '1';
1103 }
1104
1105 if (isset($aMailbox['SEARCH']) && $aMailbox['SEARCH'][0]) {
1106 $result .= '&amp;where=' . urlencode($aMailbox['SEARCH'][0])
1107 . '&amp;what=' . urlencode($aMailbox['SEARCH'][1]);
1108 }
1109 $result .= "\">";
1110 $result .= _("All");
1111 $result .= "</a>\n";
1112 }
1113
1114 /* Return our final result. */
1115 return ($result);
1116 }
1117
1118 /**
1119 * This function computes the "Viewing Messages..." string.
1120 *
1121 * @param integer $start_msg first message number
1122 * @param integer $end_msg last message number
1123 * @param integer $num_msgs total number of message in folder
1124 * @return string
1125 */
1126 function get_msgcnt_str($start_msg, $end_msg, $num_msgs) {
1127 /* Compute the $msg_cnt_str. */
1128 $result = '';
1129 if ($start_msg < $end_msg) {
1130 $result = sprintf(_("Viewing Messages: %s to %s (%s total)"),
1131 '<b>'.$start_msg.'</b>', '<b>'.$end_msg.'</b>', $num_msgs);
1132 } else if ($start_msg == $end_msg) {
1133 $result = sprintf(_("Viewing Message: %s (1 total)"), '<b>'.$start_msg.'</b>');
1134 } else {
1135 $result = '<br />';
1136 }
1137 /* Return our result string. */
1138 return ($result);
1139 }
1140
1141 /**
1142 * Generate a paginator link.
1143 *
1144 * @param mixed $box Mailbox name
1145 * @param mixed $start_msg Message Offset
1146 * @param mixed $use
1147 * @param string $text text used for paginator link
1148 * @return string
1149 */
1150 function get_paginator_link($box, $start_msg, $use, $text) {
1151
1152 $result = "<a href=\"right_main.php?use_mailbox_cache=$use"
1153 . "&amp;startMessage=$start_msg&amp;mailbox=$box\" "
1154 . ">$text</a>";
1155
1156 return ($result);
1157 }
1158
1159 /**
1160 * This function computes the paginator string.
1161 *
1162 * @param string $box
1163 * @param integer $start_msg
1164 * @param integer $end_msg
1165 * @param integer $num_msgs
1166 * @param integer $show_num
1167 * @param integer $sort
1168 */
1169 function get_paginator_str($box, $start_msg, $end_msg, $num_msgs,
1170 $show_num, $sort) {
1171 global $username, $data_dir, $use_mailbox_cache, $color, $PG_SHOWNUM;
1172
1173 /* Initialize paginator string chunks. */
1174 $prv_str = '';
1175 $nxt_str = '';
1176 $pg_str = '';
1177 $all_str = '';
1178
1179 $box = urlencode($box);
1180 $use = 0;
1181 /* Create simple strings that will be creating the paginator. */
1182 $spc = '&nbsp;'; /* This will be used as a space. */
1183 $sep = '|'; /* This will be used as a seperator. */
1184
1185 /* Get some paginator preference values. */
1186 $pg_sel = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
1187 $pg_max = getPref($data_dir, $username, 'page_selector_max', PG_SEL_MAX);
1188
1189 /* Make sure that our start message number is not too big. */
1190 $start_msg = min($start_msg, $num_msgs);
1191
1192 /* Compute the starting message of the previous and next page group. */
1193 $next_grp = $start_msg + $show_num;
1194 $prev_grp = $start_msg - $show_num;
1195
1196 /* Compute the basic previous and next strings. */
1197 if (($next_grp <= $num_msgs) && ($prev_grp >= 0)) {
1198 $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
1199 $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
1200 } else if (($next_grp > $num_msgs) && ($prev_grp >= 0)) {
1201 $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
1202 $nxt_str = _("Next");
1203 } else if (($next_grp <= $num_msgs) && ($prev_grp < 0)) {
1204 $prv_str = _("Previous");
1205 $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
1206 }
1207
1208 /* Page selector block. Following code computes page links. */
1209 if ($show_num != 0 && $pg_sel && ($num_msgs > $show_num)) {
1210 /* Most importantly, what is the current page!!! */
1211 $cur_pg = intval($start_msg / $show_num) + 1;
1212
1213 /* Compute total # of pages and # of paginator page links. */
1214 $tot_pgs = ceil($num_msgs / $show_num); /* Total number of Pages */
1215 $vis_pgs = min($pg_max, $tot_pgs - 1); /* Visible Pages */
1216
1217 /* Compute the size of the four quarters of the page links. */
1218
1219 /* If we can, just show all the pages. */
1220 if (($tot_pgs - 1) <= $pg_max) {
1221 $q1_pgs = $cur_pg - 1;
1222 $q2_pgs = $q3_pgs = 0;
1223 $q4_pgs = $tot_pgs - $cur_pg;
1224
1225 /* Otherwise, compute some magic to choose the four quarters. */
1226 } else {
1227 /*
1228 * Compute the magic base values. Added together,
1229 * these values will always equal to the $pag_pgs.
1230 * NOTE: These are DEFAULT values and do not take
1231 * the current page into account. That is below.
1232 */
1233 $q1_pgs = floor($vis_pgs/4);
1234 $q2_pgs = round($vis_pgs/4, 0);
1235 $q3_pgs = ceil($vis_pgs/4);
1236 $q4_pgs = round(($vis_pgs - $q2_pgs)/3, 0);
1237
1238 /* Adjust if the first quarter contains the current page. */
1239 if (($cur_pg - $q1_pgs) < 1) {
1240 $extra_pgs = ($q1_pgs - ($cur_pg - 1)) + $q2_pgs;
1241 $q1_pgs = $cur_pg - 1;
1242 $q2_pgs = 0;
1243 $q3_pgs += ceil($extra_pgs / 2);
1244 $q4_pgs += floor($extra_pgs / 2);
1245
1246 /* Adjust if the first and second quarters intersect. */
1247 } else if (($cur_pg - $q2_pgs - ceil($q2_pgs/3)) <= $q1_pgs) {
1248 $extra_pgs = $q2_pgs;
1249 $extra_pgs -= ceil(($cur_pg - $q1_pgs - 1) * 3/4);
1250 $q2_pgs = ceil(($cur_pg - $q1_pgs - 1) * 3/4);
1251 $q3_pgs += ceil($extra_pgs / 2);
1252 $q4_pgs += floor($extra_pgs / 2);
1253
1254 /* Adjust if the fourth quarter contains the current page. */
1255 } else if (($cur_pg + $q4_pgs) >= $tot_pgs) {
1256 $extra_pgs = ($q4_pgs - ($tot_pgs - $cur_pg)) + $q3_pgs;
1257 $q3_pgs = 0;
1258 $q4_pgs = $tot_pgs - $cur_pg;
1259 $q1_pgs += floor($extra_pgs / 2);
1260 $q2_pgs += ceil($extra_pgs / 2);
1261
1262 /* Adjust if the third and fourth quarter intersect. */
1263 } else if (($cur_pg + $q3_pgs + 1) >= ($tot_pgs - $q4_pgs + 1)) {
1264 $extra_pgs = $q3_pgs;
1265 $extra_pgs -= ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
1266 $q3_pgs = ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
1267 $q1_pgs += floor($extra_pgs / 2);
1268 $q2_pgs += ceil($extra_pgs / 2);
1269 }
1270 }
1271
1272 /*
1273 * I am leaving this debug code here, commented out, because
1274 * it is a really nice way to see what the above code is doing.
1275 * echo "qts = $q1_pgs/$q2_pgs/$q3_pgs/$q4_pgs = "
1276 * . ($q1_pgs + $q2_pgs + $q3_pgs + $q4_pgs) . '<br />';
1277 */
1278
1279 /* Print out the page links from the compute page quarters. */
1280
1281 /* Start with the first quarter. */
1282 if (($q1_pgs == 0) && ($cur_pg > 1)) {
1283 $pg_str .= "...$spc";
1284 } else {
1285 for ($pg = 1; $pg <= $q1_pgs; ++$pg) {
1286 $start = (($pg-1) * $show_num) + 1;
1287 $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
1288 }
1289 if ($cur_pg - $q2_pgs - $q1_pgs > 1) {
1290 $pg_str .= "...$spc";
1291 }
1292 }
1293
1294 /* Continue with the second quarter. */
1295 for ($pg = $cur_pg - $q2_pgs; $pg < $cur_pg; ++$pg) {
1296 $start = (($pg-1) * $show_num) + 1;
1297 $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
1298 }
1299
1300 /* Now print the current page. */
1301 $pg_str .= $cur_pg . $spc;
1302
1303 /* Next comes the third quarter. */
1304 for ($pg = $cur_pg + 1; $pg <= $cur_pg + $q3_pgs; ++$pg) {
1305 $start = (($pg-1) * $show_num) + 1;
1306 $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
1307 }
1308
1309 /* And last, print the forth quarter page links. */
1310 if (($q4_pgs == 0) && ($cur_pg < $tot_pgs)) {
1311 $pg_str .= "...$spc";
1312 } else {
1313 if (($tot_pgs - $q4_pgs) > ($cur_pg + $q3_pgs)) {
1314 $pg_str .= "...$spc";
1315 }
1316 for ($pg = $tot_pgs - $q4_pgs + 1; $pg <= $tot_pgs; ++$pg) {
1317 $start = (($pg-1) * $show_num) + 1;
1318 $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
1319 }
1320 }
1321 } else if ($PG_SHOWNUM == 999999) {
1322 $pg_str = "<a href=\"right_main.php?PG_SHOWALL=0"
1323 . "&amp;use_mailbox_cache=$use&amp;startMessage=1&amp;mailbox=$box\" "
1324 . ">" ._("Paginate") . '</a>';
1325 }
1326
1327 /* Put all the pieces of the paginator string together. */
1328 /**
1329 * Hairy code... But let's leave it like it is since I am not certain
1330 * a different approach would be any easier to read. ;)
1331 */
1332 $result = '';
1333 if ( $prv_str != '' || $nxt_str != '' )
1334 {
1335 $result .= '[';
1336 $result .= ($prv_str != '' ? $prv_str . $spc . $sep . $spc : '');
1337 $result .= ($nxt_str != '' ? $nxt_str : '');
1338 $result .= ']' . $spc ;
1339
1340 /* Compute the 'show all' string. */
1341 $all_str = "<a href=\"right_main.php?PG_SHOWALL=1"
1342 . "&amp;use_mailbox_cache=$use&amp;startMessage=1&amp;mailbox=$box\" "
1343 . ">" . _("Show All") . '</a>';
1344 }
1345
1346 $result .= ($pg_str != '' ? $spc . '['.$spc.$pg_str.']' . $spc : '');
1347 $result .= ($all_str != '' ? $spc . '['.$all_str.']' . $spc . $spc : '');
1348
1349 /* If the resulting string is blank, return a non-breaking space. */
1350 if ($result == '') {
1351 $result = '&nbsp;';
1352 }
1353
1354 /* Return our final magical paginator string. */
1355 return ($result);
1356 }
1357
1358 /**
1359 * FIXME: Undocumented function
1360 */
1361 function truncateWithEntities($subject, $trim_at)
1362 {
1363 $ent_strlen = strlen($subject);
1364 if (($trim_at <= 0) || ($ent_strlen <= $trim_at))
1365 return $subject;
1366
1367 global $languages, $squirrelmail_language;
1368
1369 /*
1370 * see if this is entities-encoded string
1371 * If so, Iterate through the whole string, find out
1372 * the real number of characters, and if more
1373 * than $trim_at, substr with an updated trim value.
1374 */
1375 $trim_val = $trim_at;
1376 $ent_offset = 0;
1377 $ent_loc = 0;
1378 while ( $ent_loc < $trim_val && (($ent_loc = strpos($subject, '&', $ent_offset)) !== false) &&
1379 (($ent_loc_end = strpos($subject, ';', $ent_loc+3)) !== false) ) {
1380 $trim_val += ($ent_loc_end-$ent_loc);
1381 $ent_offset = $ent_loc_end+1;
1382 }
1383 if (($trim_val > $trim_at) && ($ent_strlen > $trim_val) && (strpos($subject,';',$trim_val) < ($trim_val + 6))) {
1384 $i = strpos($subject,';',$trim_val);
1385 if ($i) {
1386 $trim_val = strpos($subject,';',$trim_val);
1387 }
1388 }
1389 // only print '...' when we're actually dropping part of the subject
1390 if ($ent_strlen <= $trim_val)
1391 return $subject;
1392
1393 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
1394 function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
1395 return $languages[$squirrelmail_language]['XTRA_CODE']('strimwidth', $subject, $trim_val);
1396 }
1397
1398 return substr_replace($subject, '...', $trim_val);
1399 }
1400
1401 /**
1402 * FIXME: Undocumented function
1403 */
1404 function processSubject($subject, $threadlevel = 0) {
1405 /* Shouldn't ever happen -- caught too many times in the IMAP functions */
1406 if ($subject == '') {
1407 return _("(no subject)");
1408 }
1409
1410 global $truncate_subject; /* number of characters for Subject field (<= 0 for unchanged) */
1411 $trim_at = $truncate_subject;
1412
1413 /* if this is threaded, subtract two chars per indentlevel */
1414 if (($threadlevel > 0) && ($threadlevel <= 10))
1415 $trim_at -= (2*$threadlevel);
1416
1417 return truncateWithEntities($subject, $trim_at);
1418 }
1419
1420 /**
1421 * FIXME: Undocumented function
1422 *
1423 * @param mixed $imapConnection
1424 * @param mixed $boxes
1425 */
1426 function getMbxList($imapConnection, $boxes = 0) {
1427 global $lastTargetMailbox;
1428 echo ' <small>&nbsp;<tt><select name="targetMailbox">';
1429 echo sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes);
1430 echo ' </select></tt>&nbsp;';
1431 }
1432
1433 /**
1434 * Creates button
1435 *
1436 * @deprecated see form functions available in 1.5.1 and 1.4.3.
1437 * @param string $type
1438 * @param string $name
1439 * @param string $value
1440 * @param string $js
1441 * @param bool $enabled
1442 */
1443 function getButton($type, $name, $value, $js = '', $enabled = TRUE) {
1444 $disabled = ( $enabled ? '' : 'disabled ' );
1445 $js = ( $js ? $js.' ' : '' );
1446 return '<input '.$disabled.$js.
1447 'type="'.$type.
1448 '" name="'.$name.
1449 '" value="'.$value .
1450 '" style="padding: 0px; margin: 0px" />';
1451 }
1452
1453 /**
1454 * Puts string into cell, aligns it and adds <small> tag
1455 *
1456 * @param string $string string
1457 * @param string $align alignment
1458 */
1459 function getSmallStringCell($string, $align) {
1460 return html_tag('td',
1461 '<small>' . $string . ':&nbsp; </small>',
1462 $align,
1463 '',
1464 'nowrap' );
1465 }
1466
1467 /**
1468 * This should go in imap_mailbox.php
1469 * @param string $mailbox
1470 */
1471 function handleAsSent($mailbox) {
1472 global $handleAsSent_result;
1473
1474 /* First check if this is the sent or draft folder. */
1475 $handleAsSent_result = isSentMailbox($mailbox) || isDraftMailbox($mailbox);
1476
1477 /* Then check the result of the handleAsSent hook. */
1478 do_hook('check_handleAsSent_result', $mailbox);
1479
1480 /* And return the result. */
1481 return $handleAsSent_result;
1482 }
1483
1484 ?>