functions/mailbox_display.php

   1 <?php
   2
   3 /**
   4  * mailbox_display.php
   5  *
   6  * Copyright (c) 1999-2003 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  * $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
  24 /**
  25  * default value for page_selector_max
  26  */
  27 define('PG_SEL_MAX', 10);
  28
  29 /**
  30  * @param mixed $start UNDOCUMENTED
  31  */
  32 function elapsed($start)
  33 {
  34    $end = microtime();
  35    list($start2, $start1) = explode(" ", $start);
  36    list($end2, $end1) = explode(" ", $end);
  37   $diff1 = $end1 - $start1;
  38    $diff2 = $end2 - $start2;
  39    if( $diff2 < 0 ){
  40        $diff1 -= 1;
  41        $diff2 += 1.0;
  42   }
  43    return $diff2 + $diff1;
  44 }
  45
  46 function printMessageInfo($imapConnection, $t, $not_last=true, $key, $mailbox,
  47                           $start_msg, $where, $what) {
  48     global $checkall,
  49            $color, $msgs, $msort, $td_str, $msg,
  50            $default_use_priority,
  51            $message_highlight_list,
  52            $index_order,
  53            $indent_array,         /* indent subject by */
  54            $pos,                  /* Search postion (if any)  */
  55            $thread_sort_messages, /* thread sorting on/off */
  56            $server_sort_order,    /* sort value when using server-sorting */
  57            $row_count,
  58            $allow_server_sort,    /* enable/disable server-side sorting */
  59            $truncate_sender,      /* number of characters for From/To field (<= 0 for unchanged) */
  60            $email_address,
  61            $show_recipient_instead;     /* show recipient name instead of default identity */
  62
  63     $color_string = $color[4];
  64
  65     if ($GLOBALS['alt_index_colors']) {
  66         if (!isset($row_count)) {
  67             $row_count = 0;
  68         }
  69         $row_count++;
  70         if ($row_count % 2) {
  71             if (!isset($color[12])) {
  72                 $color[12] = '#EAEAEA';
  73             }
  74             $color_string = $color[12];
  75         }
  76     }
  77     $msg = $msgs[$key];
  78
  79     if($mailbox == 'None') {
  80         $boxes   = sqimap_mailbox_list($imapConnection);
  81         $mailbox = $boxes[0]['unformatted'];
  82         unset($boxes);
  83     }
  84     $urlMailbox = urlencode($mailbox);
  85
  86     $bSentFolder = handleAsSent($mailbox);
  87     if ((!$bSentFolder) && ($show_recipient_instead)) {
  88         // If the From address is the same as $email_address, then handle as Sent
  89         $from_array = parseAddress($msg['FROM'], 1);
  90         if (!isset($email_address)) {
  91             global $datadir, $username;
  92             $email_address = getPref($datadir, $username, 'email_address');
  93         }
  94         $bHandleAsSent = ((isset($from_array[0][0])) && ($from_array[0][0] == $email_address));
  95     }
  96     else
  97         $bHandleAsSent = $bSentFolder;
  98     // If this is a Sent message, display To address instead of From
  99     if ($bHandleAsSent)
 100        $msg['FROM'] = $msg['TO'];
 101     // Passing 1 below results in only 1 address being parsed, thus defeating the following code
 102     $msg['FROM'] = parseAddress($msg['FROM']/*,1*/);
 103
 104        /*
 105         * This is done in case you're looking into Sent folders,
 106         * because you can have multiple receivers.
 107         */
 108     $senderNames = $msg['FROM'];
 109     $senderName  = '';
 110     $senderAddress = '';
 111     if (sizeof($senderNames)){
 112         foreach ($senderNames as $senderNames_part) {
 113             if ($senderName != '') {
 114                 $senderName .= ', ';
 115                 $senderAddress .= ', ';
 116             }
 117             $sender_address_part = htmlspecialchars($senderNames_part[0]);
 118             $sender_name_part = str_replace('&nbsp;',' ', decodeHeader($senderNames_part[1]));
 119             if ($sender_name_part) {
 120                 $senderName .= $sender_name_part;
 121                 $senderAddress .= $sender_name_part . ' <' . $sender_address_part . '>';
 122             } else {
 123                 $senderName .= $sender_address_part;
 124                 $senderAddress .= $sender_address_part;
 125             }
 126         }
 127     }
 128     // If Sent, prefix with To: but only if not Sent folder
 129     if ($bHandleAsSent ^ $bSentFolder) {
 130         $senderName = _("To:") . ' ' . $senderName;
 131         $senderAddress = _("To:") . ' ' . $senderAddress;
 132     }
 133
 134     if ($truncate_sender > 0)
 135        $senderName = truncateWithEntities($senderName, $truncate_sender);
 136
 137     echo html_tag( 'tr','','','','VALIGN="top"') . "\n";
 138
 139     if (isset($msg['FLAG_FLAGGED']) && ($msg['FLAG_FLAGGED'] == true)) {
 140         $flag = "<font color=\"$color[2]\">";
 141         $flag_end = '</font>';
 142     } else {
 143         $flag = '';
 144         $flag_end = '';
 145     }
 146     if (!isset($msg['FLAG_SEEN']) || ($msg['FLAG_SEEN'] == false)) {
 147         $bold = '<b>';
 148         $bold_end = '</b>';
 149     } else {
 150         $bold = '';
 151         $bold_end = '';
 152     }
 153     if ($bHandleAsSent) {
 154         $italic = '<i>';
 155         $italic_end = '</i>';
 156     } else {
 157         $italic = '';
 158         $italic_end = '';
 159     }
 160     if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED']) {
 161         $fontstr = "<font color=\"$color[9]\">";
 162         $fontstr_end = '</font>';
 163     } else {
 164         $fontstr = '';
 165         $fontstr_end = '';
 166     }
 167
 168     if ($where && $what) {
 169         $searchstr = '&amp;where='.$where.'&amp;what='.$what;
 170     } else {
 171         $searchstr = '';
 172     }
 173
 174     if (is_array($message_highlight_list) && count($message_highlight_list)) {
 175         $msg['TO'] = parseAddress($msg['TO']);
 176         $msg['CC'] = parseAddress($msg['CC']);
 177         foreach ($message_highlight_list as $message_highlight_list_part) {
 178             if (trim($message_highlight_list_part['value']) != '') {
 179                 $high_val   = strtolower($message_highlight_list_part['value']);
 180                 $match_type = strtoupper($message_highlight_list_part['match_type']);
 181                 if($match_type == 'TO_CC') {
 182                     $match = array('TO', 'CC');
 183                 } else {
 184                     $match = array($match_type);
 185                 }
 186                 foreach($match as $match_type) {
 187                     switch($match_type) {
 188                         case('TO'):
 189                         case('CC'):
 190                         case('FROM'):
 191                             foreach ($msg[$match_type] as $address) {
 192                                 $address[0] = decodeHeader($address[0], true, false);
 193                                 $address[1] = decodeHeader($address[1], true, false);
 194                                 if (strstr('^^' . strtolower($address[0]), $high_val) ||
 195                                     strstr('^^' . strtolower($address[1]), $high_val)) {
 196                                     $hlt_color = $message_highlight_list_part['color'];
 197                                     break 4;
 198                                 }
 199                             }
 200                             break;
 201                         default:
 202                             $headertest = strtolower(decodeHeader($msg[$match_type], true, false));
 203                             if (strstr('^^' . $headertest, $high_val)) {
 204                                 $hlt_color = $message_highlight_list_part['color'];
 205                                 break 3;
 206                             }
 207                             break;
 208                     }
 209                 }
 210             }
 211         }
 212     }
 213
 214     if (!isset($hlt_color)) {
 215         $hlt_color = $color_string;
 216     }
 217     $checked = ($checkall == 1) ? ' CHECKED' : '';
 218     $col = 0;
 219     $msg['SUBJECT'] = str_replace('&nbsp;', ' ', decodeHeader($msg['SUBJECT']));
 220     $subject = processSubject($msg['SUBJECT'], $indent_array[$msg['ID']]);
 221     if (sizeof($index_order)) {
 222         foreach ($index_order as $index_order_part) {
 223             switch ($index_order_part) {
 224             case 1: /* checkbox */
 225                 echo html_tag( 'td',
 226                                "<input type=checkbox name=\"msg[$t]\" value=\"".$msg['ID']."\"$checked>",
 227                                'center',
 228                                $hlt_color );
 229                 break;
 230             case 2: /* from */
 231                 if ($senderAddress != $senderName) {
 232                     $senderAddress = strtr($senderAddress, array_flip(get_html_translation_table(HTML_SPECIALCHARS)));
 233                     $title = ' title="' . str_replace('"', "''", $senderAddress) . '"';
 234                 }
 235                 else
 236                     $title = '';
 237                 echo html_tag( 'td',
 238                                $italic . $bold . $flag . $fontstr . $senderName .
 239                                $fontstr_end . $flag_end . $bold_end . $italic_end,
 240                                'left',
 241                                $hlt_color, $title );
 242                 break;
 243             case 3: /* date */
 244                 $date_string = $msg['DATE_STRING'] . '';
 245                 if ($date_string == '') {
 246                     $date_string = _("Unknown date");
 247                 }
 248                 echo html_tag( 'td',
 249                                $bold . $flag . $fontstr . $date_string .
 250                                $fontstr_end . $flag_end . $bold_end,
 251                                'center',
 252                                $hlt_color,
 253                                'nowrap' );
 254                 break;
 255             case 4: /* subject */
 256                 $td_str = $bold;
 257                 if ($thread_sort_messages == 1) {
 258                     if (isset($indent_array[$msg['ID']])) {
 259                         $td_str .= str_repeat("&nbsp;&nbsp;&nbsp;&nbsp;",$indent_array[$msg['ID']]);
 260                     }
 261                 }
 262                 $td_str .= '<a href="read_body.php?mailbox='.$urlMailbox
 263                         .  '&amp;passed_id='. $msg["ID"]
 264                         .  '&amp;startMessage='.$start_msg.$searchstr.'"';
 265                 $td_str .= ' ' .concat_hook_function('subject_link', array($start_msg, $searchstr));
 266                 if ($subject != $msg['SUBJECT']) {
 267                     $title = get_html_translation_table(HTML_SPECIALCHARS);
 268                     $title = array_flip($title);
 269                     $title = strtr($msg['SUBJECT'], $title);
 270                     $title = str_replace('"', "''", $title);
 271                     $td_str .= " title=\"$title\"";
 272                 }
 273                 $td_str .= ">$flag$subject$flag_end</a>$bold_end";
 274                 echo html_tag( 'td', $td_str, 'left', $hlt_color );
 275                 break;
 276             case 5: /* flags */
 277                 $stuff = false;
 278                 $td_str = "<b><small>";
 279
 280                 if (isset($msg['FLAG_ANSWERED']) && $msg['FLAG_ANSWERED'] == true) {
 281                     $td_str .= _("A");
 282                     $stuff = true;
 283                 }
 284                 if ($msg['TYPE0'] == 'multipart') {
 285                     $td_str .= '+';
 286                     $stuff = true;
 287                 }
 288                 if ($default_use_priority) {
 289                     if ( ($msg['PRIORITY'] == 1) || ($msg['PRIORITY'] == 2) ) {
 290                         $td_str .= "<font color=\"$color[1]\">!</font>";
 291                         $stuff = true;
 292                     }
 293                     if ($msg['PRIORITY'] == 5) {
 294                         $td_str .= "<font color=\"$color[8]\">?</font>";
 295                         $stuff = true;
 296                     }
 297                 }
 298                 if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED'] == true) {
 299                     $td_str .= "<font color=\"$color[1]\">D</font>";
 300                     $stuff = true;
 301                 }
 302                 if (!$stuff) {
 303                     $td_str .= '&nbsp;';
 304                 }
 305                 do_hook("msg_envelope");
 306                 $td_str .= '</small></b>';
 307                 echo html_tag( 'td',
 308                                $td_str,
 309                                'center',
 310                                $hlt_color,
 311                                'nowrap' );
 312                 break;
 313             case 6: /* size */
 314                 echo html_tag( 'td',
 315                                $bold . $fontstr . show_readable_size($msg['SIZE']) .
 316                                $fontstr_end . $bold_end,
 317                                'right',
 318                                $hlt_color );
 319                 break;
 320             }
 321             ++$col;
 322         }
 323     }
 324     if ($not_last) {
 325         echo '</tr>' . "\n" . '<tr><td COLSPAN="' . $col . '" BGCOLOR="' .
 326              $color[0] . '" HEIGHT="1"></td></tr>' . "\n";
 327     } else {
 328         echo '</tr>'."\n";
 329     }
 330 }
 331
 332 function getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id) {
 333     if ($id != 'no') {
 334         $id = array_slice($id, ($start_msg-1), $show_num);
 335         $end = $start_msg + $show_num - 1;
 336         if ($num_msgs < $show_num) {
 337             $end_loop = $num_msgs;
 338         } else if ($end > $num_msgs) {
 339             $end_loop = $num_msgs - $start_msg + 1;
 340         } else {
 341             $end_loop = $show_num;
 342         }
 343         return fillMessageArray($imapConnection,$id,$end_loop,$show_num);
 344     } else {
 345         return false;
 346     }
 347 }
 348
 349 function getThreadMessages($imapConnection, $start_msg, $show_num, $num_msgs) {
 350     $id = get_thread_sort($imapConnection);
 351     return getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id);
 352 }
 353
 354 function getServerSortMessages($imapConnection, $start_msg, $show_num,
 355                                $num_msgs, $server_sort_order, $mbxresponse) {
 356     $id = sqimap_get_sort_order($imapConnection, $server_sort_order,$mbxresponse);
 357     return getServerMessages($imapConnection, $start_msg, $show_num, $num_msgs, $id);
 358 }
 359
 360 function getSelfSortMessages($imapConnection, $start_msg, $show_num,
 361                               $num_msgs, $sort, $mbxresponse) {
 362     $msgs = array();
 363     if ($num_msgs >= 1) {
 364         $id = sqimap_get_php_sort_order ($imapConnection, $mbxresponse);
 365         if ($sort < 6 ) {
 366             $end = $num_msgs;
 367             $end_loop = $end;
 368             /* set shownum to 999999 to fool sqimap_get_small_header_list
 369                and rebuild the msgs_str to 1:* */
 370             $show_num = 999999;
 371         } else {
 372             /* if it's not sorted */
 373             if ($start_msg + ($show_num - 1) < $num_msgs) {
 374                 $end_msg = $start_msg + ($show_num - 1);
 375             } else {
 376                 $end_msg = $num_msgs;
 377             }
 378             if ($end_msg < $start_msg) {
 379                 $start_msg = $start_msg - $show_num;
 380                 if ($start_msg < 1) {
 381                     $start_msg = 1;
 382                 }
 383             }
 384             $id = array_slice(array_reverse($id), ($start_msg-1), $show_num);
 385             $end = $start_msg + $show_num - 1;
 386             if ($num_msgs < $show_num) {
 387                 $end_loop = $num_msgs;
 388             } else if ($end > $num_msgs) {
 389                 $end_loop = $num_msgs - $start_msg + 1;
 390             } else {
 391                 $end_loop = $show_num;
 392             }
 393         }
 394         $msgs = fillMessageArray($imapConnection,$id,$end_loop, $show_num);
 395     }
 396     return $msgs;
 397 }
 398
 399
 400
 401 /*
 402  * This function loops through a group of messages in the mailbox
 403  * and shows them to the user.
 404  */
 405 function showMessagesForMailbox($imapConnection, $mailbox, $num_msgs,
 406                                 $start_msg, $sort, $color, $show_num,
 407                                 $use_cache, $mode='') {
 408     global $msgs, $msort, $auto_expunge, $thread_sort_messages,
 409            $allow_server_sort, $server_sort_order;
 410
 411     /*
 412      * For some reason, on PHP 4.3+, this being unset, and set in the session causes havoc
 413      * so setting it to an empty array beforehand seems to clean up the issue, and stopping the
 414      * "Your script possibly relies on a session side-effect which existed until PHP 4.2.3" error
 415      */
 416
 417     if (!isset($msort)) {
 418         $msort = array();
 419     }
 420
 421     if (!isset($msgs)) {
 422         $msgs = array();
 423     }
 424
 425     //$start = microtime();
 426     /* If autoexpunge is turned on, then do it now. */
 427     $mbxresponse = sqimap_mailbox_select($imapConnection, $mailbox);
 428     $srt = $sort;
 429     /* If autoexpunge is turned on, then do it now. */
 430     if ($auto_expunge == true) {
 431         $exp_cnt = sqimap_mailbox_expunge($imapConnection, $mailbox, false, '');
 432         $mbxresponse['EXISTS'] = $mbxresponse['EXISTS'] - $exp_cnt;
 433         $num_msgs = $mbxresponse['EXISTS'];
 434     }
 435
 436     if ($mbxresponse['EXISTS'] > 0) {
 437         /* if $start_msg is lower than $num_msgs, we probably deleted all messages
 438          * in the last page. We need to re-adjust the start_msg
 439          */
 440
 441         if($start_msg > $num_msgs) {
 442             $start_msg -= $show_num;
 443             if($start_msg < 1) {
 444                 $start_msg = 1;
 445             }
 446         }
 447
 448         /* This code and the next if() block check for
 449          * server-side sorting methods. The $id array is
 450          * formatted and $sort is set to 6 to disable
 451          * SM internal sorting
 452          */
 453
 454         if ($thread_sort_messages == 1) {
 455             $mode = 'thread';
 456         } elseif ($allow_server_sort == 1) {
 457             $mode = 'serversort';
 458         } else {
 459             $mode = '';
 460         }
 461
 462         if ($use_cache) {
 463             sqgetGlobalVar('msgs', $msgs, SQ_SESSION);
 464             sqgetGlobalVar('msort', $msort, SQ_SESSION);
 465         } else {
 466             sqsession_unregister('msort');
 467             sqsession_unregister('msgs');       }
 468         switch ($mode) {
 469             case 'thread':
 470                 $msgs = getThreadMessages($imapConnection, $start_msg, $show_num, $num_msgs);
 471                 if ($msgs === false) {
 472                     echo '<b><small><center><font color=red>' .
 473                          _("Thread sorting is not supported by your IMAP server.<br>Please report this to the system administrator.").
 474                          '</center></small></b>';
 475                     $thread_sort_messages = 0;
 476                     $msort = $msgs = array();
 477                 } else {
 478                     $msort= $msgs;
 479                     $sort = 6;
 480                 }
 481                 break;
 482             case 'serversort':
 483                 $msgs = getServerSortMessages($imapConnection, $start_msg, $show_num,
 484                                               $num_msgs, $sort, $mbxresponse);
 485                 if ($msgs === false) {
 486                     echo '<b><small><center><font color=red>' .
 487                          _( "Server-side sorting is not supported by your IMAP server.<br>Please report this to the system administrator.").
 488                          '</center></small></b>';
 489                     $sort = $server_sort_order;
 490                     $allow_server_sort = FALSE;
 491                     $msort = $msgs = array();
 492                     $id = array();
 493                 } else {
 494                     $msort = $msgs;
 495                     $sort = 6;
 496                 }
 497                 break;
 498             default:
 499                 if (!$use_cache) {
 500                     $msgs = getSelfSortMessages($imapConnection, $start_msg, $show_num,
 501                                                 $num_msgs, $sort, $mbxresponse);
 502                     $msort = calc_msort($msgs, $sort);
 503                 } /* !use cache */
 504                 break;
 505         } // switch
 506         sqsession_register($msort, 'msort');
 507         sqsession_register($msgs,  'msgs');
 508
 509     } /* if exists > 0 */
 510
 511     $res = getEndMessage($start_msg, $show_num, $num_msgs);
 512     $start_msg = $res[0];
 513     $end_msg   = $res[1];
 514
 515     $paginator_str = get_paginator_str($mailbox, $start_msg, $end_msg,
 516                                        $num_msgs, $show_num, $sort);
 517
 518     $msg_cnt_str = get_msgcnt_str($start_msg, $end_msg, $num_msgs);
 519
 520     do_hook('mailbox_index_before');
 521 ?>
 522 <table border="0" width="100%" cellpadding="0" cellspacing="0">
 523   <tr>
 524     <td>
 525       <?php mail_message_listing_beginning($imapConnection, $mailbox, $sort,
 526                                            $msg_cnt_str, $paginator_str, $start_msg); ?>
 527     </td>
 528   </tr>
 529   <tr><td HEIGHT="5" BGCOLOR="<?php echo $color[4]; ?>"></td></tr>
 530   <tr>
 531     <td>
 532       <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="<?php echo $color[9]; ?>">
 533         <tr>
 534           <td>
 535             <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="<?php echo $color[5]; ?>">
 536               <tr>
 537                 <td>
 538                   <?php
 539                     printHeader($mailbox, $srt, $color, !$thread_sort_messages, $start_msg);
 540                     displayMessageArray($imapConnection, $num_msgs, $start_msg,
 541                                                 $msort, $mailbox, $sort, $color, $show_num,0,0);
 542                   ?>
 543                 </td>
 544               </tr>
 545             </table>
 546           </td>
 547         </tr>
 548       </table>
 549       <?php
 550         mail_message_listing_end($num_msgs, $paginator_str, $msg_cnt_str, $color);
 551       ?>
 552     </td>
 553   </tr>
 554 </table>
 555 <?php
 556     //$t = elapsed($start);
 557     //echo("elapsed time = $t seconds\n");
 558 }
 559
 560 function calc_msort($msgs, $sort) {
 561
 562     /*
 563      * 0 = Date (up)
 564      * 1 = Date (dn)
 565      * 2 = Name (up)
 566      * 3 = Name (dn)
 567      * 4 = Subject (up)
 568      * 5 = Subject (dn)
 569      */
 570
 571     if (($sort == 0) || ($sort == 1)) {
 572         foreach ($msgs as $item) {
 573             $msort[] = $item['TIME_STAMP'];
 574         }
 575     } elseif (($sort == 2) || ($sort == 3)) {
 576         foreach ($msgs as $item) {
 577             $msort[] = $item['FROM-SORT'];
 578         }
 579     } elseif (($sort == 4) || ($sort == 5)) {
 580         foreach ($msgs as $item) {
 581             $msort[] = $item['SUBJECT-SORT'];
 582         }
 583     } else {
 584         $msort = $msgs;
 585     }
 586     if ($sort < 6) {
 587         if ($sort % 2) {
 588             asort($msort);
 589         } else {
 590             arsort($msort);
 591         }
 592     }
 593     return $msort;
 594 }
 595
 596 function fillMessageArray($imapConnection, $id, $count, $show_num=false) {
 597     return sqimap_get_small_header_list($imapConnection, $id, $show_num);
 598 }
 599
 600
 601 /* Generic function to convert the msgs array into an HTML table. */
 602 function displayMessageArray($imapConnection, $num_msgs, $start_msg,
 603                              $msort, $mailbox, $sort, $color,
 604                              $show_num, $where=0, $what=0) {
 605     global $imapServerAddress, $use_mailbox_cache, $index_order,
 606            $indent_array, $thread_sort_messages, $allow_server_sort,
 607            $server_sort_order, $PHP_SELF;
 608
 609     $res = getEndMessage($start_msg, $show_num, $num_msgs);
 610     $start_msg = $res[0];
 611     $end_msg   = $res[1];
 612
 613     $urlMailbox = urlencode($mailbox);
 614
 615     /* get indent level for subject display */
 616     if ($thread_sort_messages == 1 && $num_msgs) {
 617         $indent_array = get_parent_level($imapConnection);
 618     }
 619
 620     $real_startMessage = $start_msg;
 621     if ($sort == 6) {
 622         if ($end_msg - $start_msg < $show_num - 1) {
 623             $end_msg = $end_msg - $start_msg + 1;
 624             $start_msg = 1;
 625         } else if ($start_msg > $show_num) {
 626             $end_msg = $show_num;
 627             $start_msg = 1;
 628         }
 629     }
 630     $endVar = $end_msg + 1;
 631
 632     /*
 633      * Loop through and display the info for each message.
 634      * ($t is used for the checkbox number)
 635      */
 636     $t = 0;
 637
 638     /* messages display */
 639
 640     if (!$num_msgs) {
 641     /* if there's no messages in this folder */
 642         echo html_tag( 'tr',
 643                 html_tag( 'td',
 644                           "<BR><b>" . _("THIS FOLDER IS EMPTY") . "</b><BR>&nbsp;",
 645                           'center',
 646                           $color[4],
 647                           'COLSPAN="' . count($index_order) . '"'
 648                 )
 649         );
 650     } elseif ($start_msg == $end_msg) {
 651     /* if there's only one message in the box, handle it differently. */
 652         if ($sort != 6) {
 653             $i = $start_msg;
 654         } else {
 655             $i = 1;
 656         }
 657         reset($msort);
 658         $k = 0;
 659         do {
 660             $key = key($msort);
 661             next($msort);
 662             $k++;
 663         } while (isset ($key) && ($k < $i));
 664         printMessageInfo($imapConnection, $t, true, $key, $mailbox,
 665                          $real_startMessage, $where, $what);
 666     } else {
 667         $i = $start_msg;
 668         reset($msort);
 669         $k = 0;
 670         do {
 671             $key = key($msort);
 672             next($msort);
 673             $k++;
 674         } while (isset ($key) && ($k < $i));
 675         $not_last = true;
 676         do {
 677             if (!$i || $i == $endVar-1) $not_last = false;
 678                 printMessageInfo($imapConnection, $t, $not_last, $key, $mailbox,
 679                                  $real_startMessage, $where, $what);
 680             $key = key($msort);
 681             $t++;
 682             $i++;
 683             next($msort);
 684         } while ($i && $i < $endVar);
 685     }
 686 }
 687
 688 /*
 689  * Displays the standard message list header. To finish the table,
 690  * you need to do a "</table></table>";
 691  *
 692  * $moveURL is the URL to submit the delete/move form to
 693  * $mailbox is the current mailbox
 694  * $sort is the current sorting method (-1 for no sorting available [searches])
 695  * $Message is a message that is centered on top of the list
 696  * $More is a second line that is left aligned
 697  */
 698
 699 function mail_message_listing_beginning ($imapConnection,
 700                                          $mailbox = '', $sort = -1,
 701                                          $msg_cnt_str = '',
 702                                          $paginator = '&nbsp;',
 703                                          $start_msg = 1) {
 704     global $color, $auto_expunge, $base_uri,
 705            $allow_server_sort, $server_sort_order,
 706            $PHP_SELF, $allow_thread_sort, $thread_sort_messages;
 707
 708     $php_self = $PHP_SELF;
 709     /* fix for incorrect $PHP_SELF */
 710     if (strpos($php_self, 'move_messages.php')) {
 711         $php_self = str_replace('move_messages.php', 'right_main.php', $php_self);
 712     }
 713     $urlMailbox = urlencode($mailbox);
 714
 715     if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
 716         $source_url = $regs[1];
 717     } else {
 718         $source_url = $php_self;
 719     }
 720
 721     if (!isset($msg)) {
 722         $msg = '';
 723     }
 724
 725     if (!strpos($php_self,'?')) {
 726         $location = $php_self.'?mailbox=INBOX&amp;startMessage=1';
 727     } else {
 728         $location = $php_self;
 729     }
 730
 731     $moveFields = '<input type="hidden" name="msg" value="'.htmlspecialchars($msg).'">' .
 732                           '<input type="hidden" name="mailbox" value="'.htmlspecialchars($mailbox).'">' .
 733                           '<input type="hidden" name="startMessage" value="'.htmlspecialchars($start_msg).'">'.
 734                   '<input type="hidden" name="location" value="'.$location.'">';
 735
 736     /*
 737      * This is the beginning of the message list table.
 738      * It wraps around all messages
 739      */
 740     $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $mailbox);
 741     $form_name = "FormMsgs" . $safe_name;
 742     echo '<form name="' . $form_name . '" method="post" action="move_messages.php">' ."\n"
 743              . $moveFields;
 744 ?>
 745       <table width="100%" cellpadding="1"  cellspacing="0" style="border: 1px solid <?php echo $color[0]; ?>">
 746         <tr>
 747           <td>
 748             <table bgcolor="<?php echo $color[4]; ?>" border="0" width="100%" cellpadding="1"  cellspacing="0">
 749               <tr>
 750                 <td align="left"><small><?php echo $paginator; ?></small></td>
 751                 <td align="right"><small><?php echo $msg_cnt_str; ?></small></td>
 752               </tr>
 753             </table>
 754           </td>
 755         </tr>
 756         <tr width="100%" cellpadding="1"  cellspacing="0" border="0" bgcolor="<?php echo $color[0]; ?>">
 757           <td>
 758             <table border="0" width="100%" cellpadding="1"  cellspacing="0">
 759               <tr>
 760                 <td align="left">
 761                   <small><?php
 762                     echo getButton('SUBMIT', 'markRead',_("Read"));
 763                     echo '&nbsp;';
 764                     echo getButton('SUBMIT', 'markUnread',_("Unread"));
 765                     echo '&nbsp;';
 766                     echo getButton('SUBMIT', 'attache',_("Forward"));
 767                     echo '&nbsp;';
 768                     echo getButton('SUBMIT', 'delete',_("Delete"));
 769                     echo '<input type="checkbox" name="bypass_trash">' . _("Bypass Trash");
 770                     echo '&nbsp;';
 771                     if (!$auto_expunge) {
 772                       echo getButton('SUBMIT', 'expungeButton',_("Expunge"))  .'&nbsp;' . _("mailbox") . "\n";
 773                       echo '&nbsp;';
 774                     }
 775                     do_hook('mailbox_display_buttons');
 776                   ?></small>
 777                 </td>
 778                 <td align="right">
 779                   <small><?php
 780                     /* draws thread sorting links */
 781                     if ($allow_thread_sort == TRUE) {
 782                       if ($thread_sort_messages == 1 ) {
 783                         $set_thread = 2;
 784                         $thread_name = _("Unthread View");
 785                       } elseif ($thread_sort_messages == 0) {
 786                         $set_thread = 1;
 787                         $thread_name = _("Thread View");
 788                       }
 789                       echo '&nbsp;&nbsp;<small>[<a href="' . $source_url . '?sort='
 790                            . $sort . '&start_messages=1&set_thread=' . $set_thread
 791                            . '&mailbox=' . urlencode($mailbox) . '">' . $thread_name
 792                            . '</a>]</small>';
 793                     }
 794                     getMbxList($imapConnection);
 795                     echo getButton('SUBMIT', 'moveButton',_("Move")) . "\n";
 796                   ?></small>
 797                 </td>
 798               </tr>
 799             </table>
 800           </td>
 801         </tr>
 802       </table>
 803
 804 <?php
 805     do_hook('mailbox_form_before');
 806
 807     /* if using server sort we highjack the
 808      * the $sort var and use $server_sort_order
 809      * instead. but here we reset sort for a bit
 810      * since its easy
 811      */
 812     if ($allow_server_sort == TRUE) {
 813         $sort = $server_sort_order;
 814     }
 815 }
 816
 817 function mail_message_listing_end($num_msgs, $paginator_str, $msg_cnt_str, $color) {
 818   if ($num_msgs) {
 819     /* space between list and footer */
 820 ?>
 821   <tr><td HEIGHT="5" BGCOLOR="<?php echo $color[4]; ?>" COLSPAN="1"></td></tr>
 822   <tr>
 823     <td>
 824       <table width="100%" cellpadding="1"  cellspacing="0" style="border: 1px solid <?php echo $color[0]; ?>">
 825         <tr>
 826           <td>
 827             <table bgcolor="<?php echo $color[4]; ?>" border="0" width="100%" cellpadding="1"  cellspacing="0">
 828               <tr>
 829                 <td align="left"><small><?php echo $paginator_str; ?></small></td>
 830                 <td align="right"><small><?php echo $msg_cnt_str; ?></small></td>
 831               </tr>
 832             </table>
 833           </td>
 834         </tr>
 835       </table>
 836     </td>
 837   </tr>
 838 <?php
 839   }
 840     /* End of message-list table */
 841
 842     do_hook('mailbox_index_after');
 843     echo "</FORM>\n";
 844 }
 845
 846 function printHeader($mailbox, $sort, $color, $showsort=true, $start_msg=1) {
 847     global $index_order;
 848     echo html_tag( 'tr' ,'' , 'center', $color[5] );
 849
 850     /* calculate the width of the subject column based on the
 851      * widths of the other columns */
 852     $widths = array(1=>1,2=>25,3=>5,4=>0,5=>1,6=>5);
 853     $subjectwidth = 100;
 854     foreach($index_order as $item) {
 855         $subjectwidth -= $widths[$item];
 856     }
 857
 858     foreach ($index_order as $item) {
 859         switch ($item) {
 860         case 1: /* checkbox */
 861             echo html_tag( 'td',get_selectall_link($start_msg, $sort) , '', '', 'width="1%"' );
 862             break;
 863         case 5: /* flags */
 864             echo html_tag( 'td','' , '', '', 'width="1%"' );
 865             break;
 866         case 2: /* from */
 867             if (handleAsSent($mailbox)) {
 868                 echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
 869                      . '<b>' . _("To") . '</b>';
 870             } else {
 871                 echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
 872                      . '<b>' . _("From") . '</b>';
 873             }
 874             if ($showsort) {
 875                 ShowSortButton($sort, $mailbox, 2, 3);
 876             }
 877             echo "</td>\n";
 878             break;
 879         case 3: /* date */
 880             echo html_tag( 'td' ,'' , 'left', '', 'width="5%" nowrap' )
 881                  . '<b>' . _("Date") . '</b>';
 882             if ($showsort) {
 883                 ShowSortButton($sort, $mailbox, 0, 1);
 884             }
 885             echo "</td>\n";
 886             break;
 887         case 4: /* subject */
 888             echo html_tag( 'td' ,'' , 'left', '', 'width="'.$subjectwidth.'%"' )
 889                  . '<b>' . _("Subject") . '</b>';
 890             if ($showsort) {
 891                 ShowSortButton($sort, $mailbox, 4, 5);
 892             }
 893             echo "</td>\n";
 894             break;
 895         case 6: /* size */
 896             echo html_tag( 'td', '<b>' . _("Size") . '</b>', 'center', '', 'width="5%" nowrap' );
 897             break;
 898         }
 899     }
 900     echo "</tr>\n";
 901 }
 902
 903
 904 /*
 905  * This function shows the sort button. Isn't this a good comment?
 906  */
 907 function ShowSortButton($sort, $mailbox, $Down, $Up ) {
 908     global $PHP_SELF;
 909
 910     /* Figure out which image we want to use. */
 911     if ($sort != $Up && $sort != $Down) {
 912         $img = 'sort_none.png';
 913         $which = $Up;
 914     } elseif ($sort == $Up) {
 915         $img = 'up_pointer.png';
 916         $which = $Down;
 917     } else {
 918         $img = 'down_pointer.png';
 919         $which = 6;
 920     }
 921
 922     if (preg_match('/^(.+)\?.+$/',$PHP_SELF,$regs)) {
 923         $source_url = $regs[1];
 924     } else {
 925         $source_url = $PHP_SELF;
 926     }
 927
 928     /* Now that we have everything figured out, show the actual button. */
 929     echo ' <a href="' . $source_url .'?newsort=' . $which
 930          . '&amp;startMessage=1&amp;mailbox=' . urlencode($mailbox)
 931          . '"><img src="../images/' . $img
 932          . '" border="0" width="12" height="10" alt="sort" title="'
 933          . _("Click here to change the sorting of the message list") .'"></a>';
 934 }
 935
 936 function get_selectall_link($start_msg, $sort) {
 937     global $checkall, $what, $where, $mailbox, $javascript_on;
 938     global $PHP_SELF, $PG_SHOWNUM;
 939
 940     $result = '';
 941     if ($javascript_on) {
 942         $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $mailbox);
 943         $func_name = "CheckAll" . $safe_name;
 944         $form_name = "FormMsgs" . $safe_name;
 945         $result = '<script language="JavaScript" type="text/javascript">'
 946                 . "\n<!-- \n"
 947                 . "function " . $func_name . "() {\n"
 948                 . "  for (var i = 0; i < document." . $form_name . ".elements.length; i++) {\n"
 949                 . "    if(document." . $form_name . ".elements[i].type == 'checkbox' && "
 950                 . "document." . $form_name . ".elements[i].name != 'bypass_trash'){\n"
 951                 . "      document." . $form_name . ".elements[i].checked = "
 952                 . "        !(document." . $form_name . ".elements[i].checked);\n"
 953                 . "    }\n"
 954                 . "  }\n"
 955                 . "}\n"
 956                 . "//-->\n"
 957                 . '</script>'
 958                 . '<input type="checkbox" name="toggleAll" title="'._("Toggle All").'" onclick="'.$func_name.'();">';
 959 //                . <a href="javascript:void(0)" onClick="' . $func_name . '();">' . _("Toggle All")
 960 //                . "</a>\n";
 961     } else {
 962         if (strpos($PHP_SELF, "?")) {
 963             $result .= "<a href=\"$PHP_SELF&amp;mailbox=" . urlencode($mailbox)
 964                     .  "&amp;startMessage=$start_msg&amp;sort=$sort&amp;checkall=";
 965         } else {
 966             $result .= "<a href=\"$PHP_SELF?mailbox=" . urlencode($mailbox)
 967                     .  "&amp;startMessage=$start_msg&amp;sort=$sort&amp;checkall=";
 968         }
 969         if (isset($checkall) && $checkall == '1') {
 970             $result .= '0';
 971         } else {
 972             $result .= '1';
 973         }
 974
 975         if (isset($where) && isset($what)) {
 976             $result .= '&amp;where=' . urlencode($where)
 977                     .  '&amp;what=' . urlencode($what);
 978         }
 979         $result .= "\">";
 980
 981         if (isset($checkall) && ($checkall == '1')) {
 982             $result .= _("Unselect All");
 983         } else {
 984             $result .= _("Select All");
 985         }
 986         $result .= "</A>\n";
 987     }
 988
 989     /* Return our final result. */
 990     return ($result);
 991 }
 992
 993 /*
 994  * This function computes the "Viewing Messages..." string.
 995  */
 996 function get_msgcnt_str($start_msg, $end_msg, $num_msgs) {
 997     /* Compute the $msg_cnt_str. */
 998     $result = '';
 999     if ($start_msg < $end_msg) {
1000         $result = sprintf(_("Viewing Messages: <B>%s</B> to <B>%s</B> (%s total)"),
1001                           $start_msg, $end_msg, $num_msgs);
1002     } else if ($start_msg == $end_msg) {
1003         $result = sprintf(_("Viewing Message: <B>%s</B> (1 total)"), $start_msg);
1004     } else {
1005         $result = '<br>';
1006     }
1007     /* Return our result string. */
1008     return ($result);
1009 }
1010
1011 /*
1012  * Generate a paginator link.
1013  */
1014 function get_paginator_link($box, $start_msg, $use, $text) {
1015     global $PHP_SELF;
1016
1017     $result = "<A HREF=\"right_main.php?use_mailbox_cache=$use"
1018             . "&amp;startMessage=$start_msg&amp;mailbox=$box\" "
1019             . ">$text</A>";
1020     return ($result);
1021 /*
1022     if (preg_match('/^(.+)\?.+$/',$PHP_SELF,$regs)) {
1023         $source_url = $regs[1];
1024     } else {
1025         $source_url = $PHP_SELF;
1026     }
1027
1028     $result = '<A HREF="'. $source_url . "?use_mailbox_cache=$use"
1029             . "&amp;startMessage=$start_msg&amp;mailbox=$box\" "
1030             . ">$text</A>";
1031     return ($result);
1032 */
1033 }
1034
1035 /*
1036  * This function computes the paginator string.
1037  */
1038 function get_paginator_str($box, $start_msg, $end_msg, $num_msgs,
1039                            $show_num, $sort) {
1040     global $username, $data_dir, $use_mailbox_cache, $color, $PG_SHOWNUM;
1041
1042     /* Initialize paginator string chunks. */
1043     $prv_str = '';
1044     $nxt_str = '';
1045     $pg_str  = '';
1046     $all_str = '';
1047
1048     $box = urlencode($box);
1049
1050     /* Create simple strings that will be creating the paginator. */
1051     $spc = '&nbsp;';     /* This will be used as a space. */
1052     $sep = '|';          /* This will be used as a seperator. */
1053
1054     /* Get some paginator preference values. */
1055     $pg_sel = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
1056     $pg_max = getPref($data_dir, $username, 'page_selector_max', PG_SEL_MAX);
1057
1058     /* Make sure that our start message number is not too big. */
1059     $start_msg = min($start_msg, $num_msgs);
1060
1061     /* Decide whether or not we will use the mailbox cache. */
1062     /* Not sure why $use_mailbox_cache is even passed in.   */
1063     if ($sort == 6) {
1064         $use = 0;
1065     } else {
1066         $use = 1;
1067     }
1068
1069     /* Compute the starting message of the previous and next page group. */
1070     $next_grp = $start_msg + $show_num;
1071     $prev_grp = $start_msg - $show_num;
1072
1073     /* Compute the basic previous and next strings. */
1074     if (($next_grp <= $num_msgs) && ($prev_grp >= 0)) {
1075         $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
1076         $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
1077     } else if (($next_grp > $num_msgs) && ($prev_grp >= 0)) {
1078         $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
1079         $nxt_str = _("Next");
1080     } else if (($next_grp <= $num_msgs) && ($prev_grp < 0)) {
1081         $prv_str = _("Previous");
1082         $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
1083     }
1084
1085     /* Page selector block. Following code computes page links. */
1086     if ($pg_sel && ($num_msgs > $show_num)) {
1087         /* Most importantly, what is the current page!!! */
1088         $cur_pg = intval($start_msg / $show_num) + 1;
1089
1090         /* Compute total # of pages and # of paginator page links. */
1091         $tot_pgs = ceil($num_msgs / $show_num);  /* Total number of Pages */
1092         $vis_pgs = min($pg_max, $tot_pgs - 1);   /* Visible Pages    */
1093
1094         /* Compute the size of the four quarters of the page links. */
1095
1096         /* If we can, just show all the pages. */
1097         if (($tot_pgs - 1) <= $pg_max) {
1098             $q1_pgs = $cur_pg - 1;
1099             $q2_pgs = $q3_pgs = 0;
1100             $q4_pgs = $tot_pgs - $cur_pg;
1101
1102         /* Otherwise, compute some magic to choose the four quarters. */
1103         } else {
1104             /*
1105              * Compute the magic base values. Added together,
1106              * these values will always equal to the $pag_pgs.
1107              * NOTE: These are DEFAULT values and do not take
1108              * the current page into account. That is below.
1109              */
1110             $q1_pgs = floor($vis_pgs/4);
1111             $q2_pgs = round($vis_pgs/4, 0);
1112             $q3_pgs = ceil($vis_pgs/4);
1113             $q4_pgs = round(($vis_pgs - $q2_pgs)/3, 0);
1114
1115             /* Adjust if the first quarter contains the current page. */
1116             if (($cur_pg - $q1_pgs) < 1) {
1117                 $extra_pgs = ($q1_pgs - ($cur_pg - 1)) + $q2_pgs;
1118                 $q1_pgs = $cur_pg - 1;
1119                 $q2_pgs = 0;
1120                 $q3_pgs += ceil($extra_pgs / 2);
1121                 $q4_pgs += floor($extra_pgs / 2);
1122
1123             /* Adjust if the first and second quarters intersect. */
1124             } else if (($cur_pg - $q2_pgs - ceil($q2_pgs/3)) <= $q1_pgs) {
1125                 $extra_pgs = $q2_pgs;
1126                 $extra_pgs -= ceil(($cur_pg - $q1_pgs - 1) * 3/4);
1127                 $q2_pgs = ceil(($cur_pg - $q1_pgs - 1) * 3/4);
1128                 $q3_pgs += ceil($extra_pgs / 2);
1129                 $q4_pgs += floor($extra_pgs / 2);
1130
1131             /* Adjust if the fourth quarter contains the current page. */
1132             } else if (($cur_pg + $q4_pgs) >= $tot_pgs) {
1133                 $extra_pgs = ($q4_pgs - ($tot_pgs - $cur_pg)) + $q3_pgs;
1134                 $q3_pgs = 0;
1135                 $q4_pgs = $tot_pgs - $cur_pg;
1136                 $q1_pgs += floor($extra_pgs / 2);
1137                 $q2_pgs += ceil($extra_pgs / 2);
1138
1139             /* Adjust if the third and fourth quarter intersect. */
1140             } else if (($cur_pg + $q3_pgs + 1) >= ($tot_pgs - $q4_pgs + 1)) {
1141                 $extra_pgs = $q3_pgs;
1142                 $extra_pgs -= ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
1143                 $q3_pgs = ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
1144                 $q1_pgs += floor($extra_pgs / 2);
1145                 $q2_pgs += ceil($extra_pgs / 2);
1146             }
1147         }
1148
1149         /*
1150          * I am leaving this debug code here, commented out, because
1151          * it is a really nice way to see what the above code is doing.
1152          * echo "qts =  $q1_pgs/$q2_pgs/$q3_pgs/$q4_pgs = "
1153          *    . ($q1_pgs + $q2_pgs + $q3_pgs + $q4_pgs) . '<br>';
1154          */
1155
1156         /* Print out the page links from the compute page quarters. */
1157
1158         /* Start with the first quarter. */
1159         if (($q1_pgs == 0) && ($cur_pg > 1)) {
1160             $pg_str .= "...$spc";
1161         } else {
1162             for ($pg = 1; $pg <= $q1_pgs; ++$pg) {
1163                 $start = (($pg-1) * $show_num) + 1;
1164                 $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
1165             }
1166             if ($cur_pg - $q2_pgs - $q1_pgs > 1) {
1167                 $pg_str .= "...$spc";
1168             }
1169         }
1170
1171         /* Continue with the second quarter. */
1172         for ($pg = $cur_pg - $q2_pgs; $pg < $cur_pg; ++$pg) {
1173             $start = (($pg-1) * $show_num) + 1;
1174             $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
1175         }
1176
1177         /* Now print the current page. */
1178         $pg_str .= $cur_pg . $spc;
1179
1180         /* Next comes the third quarter. */
1181         for ($pg = $cur_pg + 1; $pg <= $cur_pg + $q3_pgs; ++$pg) {
1182             $start = (($pg-1) * $show_num) + 1;
1183             $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
1184         }
1185
1186         /* And last, print the forth quarter page links. */
1187         if (($q4_pgs == 0) && ($cur_pg < $tot_pgs)) {
1188             $pg_str .= "...$spc";
1189         } else {
1190             if (($tot_pgs - $q4_pgs) > ($cur_pg + $q3_pgs)) {
1191                 $pg_str .= "...$spc";
1192             }
1193             for ($pg = $tot_pgs - $q4_pgs + 1; $pg <= $tot_pgs; ++$pg) {
1194                 $start = (($pg-1) * $show_num) + 1;
1195                 $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
1196             }
1197         }
1198     } else if ($PG_SHOWNUM == 999999) {
1199         $pg_str = "<A HREF=\"right_main.php?PG_SHOWALL=0"
1200                 . "&amp;use_mailbox_cache=$use&amp;startMessage=1&amp;mailbox=$box\" "
1201                 . ">" ._("Paginate") . '</A>';
1202     }
1203
1204     /* Put all the pieces of the paginator string together. */
1205     /**
1206      * Hairy code... But let's leave it like it is since I am not certain
1207      * a different approach would be any easier to read. ;)
1208      */
1209     $result = '';
1210     if ( $prv_str != '' || $nxt_str != '' )
1211     {
1212       $result .= '[';
1213       $result .= ($prv_str != '' ? $prv_str . $spc . $sep . $spc : '');
1214       $result .= ($nxt_str != '' ? $nxt_str : '');
1215       $result .= ']' . $spc ;
1216
1217       /* Compute the 'show all' string. */
1218       $all_str = "<A HREF=\"right_main.php?PG_SHOWALL=1"
1219                  . "&amp;use_mailbox_cache=$use&amp;startMessage=1&amp;mailbox=$box\" "
1220                  . ">" . _("Show All") . '</A>';
1221     }
1222
1223     $result .= ($pg_str  != '' ? $spc . '['.$spc.$pg_str.']' .  $spc : '');
1224     $result .= ($all_str != '' ? $spc . '['.$all_str.']' . $spc . $spc : '');
1225
1226     /* If the resulting string is blank, return a non-breaking space. */
1227     if ($result == '') {
1228         $result = '&nbsp;';
1229     }
1230
1231     /* Return our final magical paginator string. */
1232     return ($result);
1233 }
1234
1235 function truncateWithEntities($subject, $trim_at)
1236 {
1237     $ent_strlen = strlen($subject);
1238     if (($trim_at <= 0) || ($ent_strlen <= $trim_at))
1239         return $subject;
1240
1241     global $languages, $squirrelmail_language;
1242
1243     /*
1244      * see if this is entities-encoded string
1245      * If so, Iterate through the whole string, find out
1246      * the real number of characters, and if more
1247      * than $trim_at, substr with an updated trim value.
1248      */
1249     $trim_val = $trim_at;
1250     $ent_offset = 0;
1251     $ent_loc = 0;
1252     while ( $ent_loc < $trim_val && (($ent_loc = strpos($subject, '&', $ent_offset)) !== false) &&
1253             (($ent_loc_end = strpos($subject, ';', $ent_loc+3)) !== false) ) {
1254         $trim_val += ($ent_loc_end-$ent_loc);
1255         $ent_offset  = $ent_loc_end+1;
1256     }
1257     if (($trim_val > $trim_at) && ($ent_strlen > $trim_val) && (strpos($subject,';',$trim_val) < ($trim_val + 6))) {
1258         $i = strpos($subject,';',$trim_val);
1259         if ($i) {
1260             $trim_val = strpos($subject,';',$trim_val);
1261         }
1262     }
1263     // only print '...' when we're actually dropping part of the subject
1264     if ($ent_strlen <= $trim_val)
1265         return $subject;
1266
1267     if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
1268         function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
1269         return $languages[$squirrelmail_language]['XTRA_CODE']('strimwidth', $subject, $trim_val);
1270     }
1271
1272     return substr_replace($subject, '...', $trim_val);
1273 }
1274
1275 function processSubject($subject, $threadlevel = 0) {
1276     /* Shouldn't ever happen -- caught too many times in the IMAP functions */
1277     if ($subject == '') {
1278         return _("(no subject)");
1279     }
1280
1281     global $truncate_subject;     /* number of characters for Subject field (<= 0 for unchanged) */
1282     $trim_at = $truncate_subject;
1283
1284     /* if this is threaded, subtract two chars per indentlevel */
1285     if (($threadlevel > 0) && ($threadlevel <= 10))
1286         $trim_at -= (2*$threadlevel);
1287
1288     return truncateWithEntities($subject, $trim_at);
1289 }
1290
1291 function getMbxList($imapConnection, $boxes = 0) {
1292     global $lastTargetMailbox;
1293     echo  '         <small>&nbsp;<tt><select name="targetMailbox">';
1294     echo sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes);
1295     echo '         </SELECT></TT>&nbsp;';
1296 }
1297
1298 function getButton($type, $name, $value) {
1299     return '<INPUT TYPE="'.$type.'" NAME="'.$name.'" VALUE="'.$value . '" style="padding: 0px; margin: 0px">';
1300 }
1301
1302 function getSmallStringCell($string, $align) {
1303     return html_tag('td',
1304                     '<small>' . $string . ':&nbsp; </small>',
1305                     $align,
1306                     '',
1307                     'nowrap' );
1308 }
1309
1310 function getEndMessage($start_msg, $show_num, $num_msgs) {
1311     if ($start_msg + ($show_num - 1) < $num_msgs){
1312         $end_msg = $start_msg + ($show_num - 1);
1313     } else {
1314         $end_msg = $num_msgs;
1315     }
1316
1317     if ($end_msg < $start_msg) {
1318         $start_msg = $start_msg - $show_num;
1319         if ($start_msg < 1) {
1320             $start_msg = 1;
1321         }
1322     }
1323     return (array($start_msg,$end_msg));
1324 }
1325
1326 // This should go in imap_mailbox.php
1327 function handleAsSent($mailbox) {
1328     global $handleAsSent_result;
1329
1330     /* First check if this is the sent or draft folder. */
1331     $handleAsSent_result = isSentMailbox($mailbox) || isDraftMailbox($mailbox);
1332
1333     /* Then check the result of the handleAsSent hook. */
1334     do_hook('check_handleAsSent_result', $mailbox);
1335
1336     /* And return the result. */
1337     return $handleAsSent_result;
1338 }
1339
1340 ?>