squirrelmail/functions/mailbox_display.php

<?php

/**
 * mailbox_display.php
 *
 * Copyright (c) 1999-2002 The SquirrelMail Project Team
 * Licensed under the GNU GPL. For full terms see the file COPYING.
 *
 * This contains functions that display mailbox information, such as the
 * table row that has sender, date, subject, etc...
 *
 * $Id$
 */

require_once('../functions/strings.php');
require_once('../functions/imap_utf7_decode_local.php');
require_once('../functions/html.php');

/* Default value for page_selector_max. */
define('PG_SEL_MAX', 10);

function printMessageInfo($imapConnection, $t, $i, $key, $mailbox, $sort,
                          $start_msg, $where, $what){
    global $checkall,
           $color, $msgs, $msort,
           $sent_folder, $draft_folder,
           $default_use_priority,
           $message_highlight_list,
           $index_order,
           $indent_array,   /* indent subject by */
           $pos,            /* Search postion (if any)  */
           $thread_sort_messages, /* thread sorting on/off */
           $server_sort_order, /* sort value when using server-sorting */
           $row_count,
           $allow_server_sort; /* enable/disable server-side sorting */
           $color_string = $color[4];

    if ($GLOBALS['alt_index_colors']) {
        if (!isset($row_count)) {
            $row_count = 0;
        }
        $row_count++;
        if ($row_count % 2) {
            if (!isset($color[12])) {
                $color[12] = '#EAEAEA';
            }
            $color_string = $color[12];
        }
    }
    $msg = $msgs[$key];

    /*
    * This is done in case you're looking into Sent folders,
    * because you can have multiple receivers.
    */
    $senderNames = explode(',', $msg['FROM']);
    $senderName = '';
    if (sizeof($senderNames)){
        foreach ($senderNames as $senderNames_part) {
            if ($senderName != '') {
                $senderName .= ', ';
            }
            $senderName .= sqimap_find_displayable_name($senderNames_part);
        }
    }

    if( $mailbox == 'None' ) {
        $boxes = sqimap_mailbox_list($imapConnection);
        $mailbox = $boxes[0]['unformatted'];
        unset( $boxes );
    }
    $urlMailbox = urlencode($mailbox);
    $subject = processSubject($msg['SUBJECT']);
    echo "<TR>\n";

    if (isset($msg['FLAG_FLAGGED']) && ($msg['FLAG_FLAGGED'] == true)) {
        $flag = "<font color=\"$color[2]\">";
        $flag_end = '</font>';
    } else {
        $flag = '';
        $flag_end = '';
    }
    if (!isset($msg['FLAG_SEEN']) || ($msg['FLAG_SEEN'] == false)) {
        $bold = '<b>';
        $bold_end = '</b>';
    } else {
        $bold = '';
        $bold_end = '';
    }
    if (handleAsSent($mailbox)) {
        $italic = '<i>';
        $italic_end = '</i>';
    } else {
        $italic = '';
        $italic_end = '';
    }
    if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED']) {
        $fontstr = "<font color=\"$color[9]\">";
        $fontstr_end = '</font>';
    } else {
        $fontstr = '';
        $fontstr_end = '';
    }

    /**
    * AAAAH! Make my eyes stop bleeding!
    * Who wrote this?!
    */
    if (sizeof($message_highlight_list)){
        foreach ($message_highlight_list as $message_highlight_list_part) {
            if (trim($message_highlight_list_part['value']) != '') {
                if ($message_highlight_list_part['match_type'] == 'to_cc') {
                    if (strstr('^^' . strtolower($msg['TO']),
                    strtolower($message_highlight_list_part['value']))
                    || strstr('^^'.strtolower($msg['CC']),
                    strtolower($message_highlight_list_part['value']))) {
                        $hlt_color = $message_highlight_list_part['color'];
                        continue;
                    }
                } else
                if (strstr('^^' . strtolower($msg[strtoupper($message_highlight_list_part['match_type'])]),
                strtolower($message_highlight_list_part['value']))) {
                    $hlt_color = $message_highlight_list_part['color'];
                    continue;
                }
            }
        }
    }

    if (!isset($hlt_color)) {
        $hlt_color = $color_string;
    }

    if ($where && $what) {
        if(!isset($pos) || $pos == '') {
            $pos = '0';
        }
        $search_stuff = "&amp;pos=" . urlencode($pos)
        . "&amp;where=" . urlencode($where) . '&amp;what=' . urlencode($what);
    } else {
        $search_stuff = '';
    }

    $checked = ($checkall == 1) ? ' checked' : '';

    if (sizeof($index_order)){
        foreach ($index_order as $index_order_part) {
            switch ($index_order_part) {
            case 1: /* checkbox */
                echo html_tag( 'td',
                               "<input type=checkbox name=\"msg[$t]\" value=\"".$msg['ID']."\"$checked>",
                               'center', 
                               $hlt_color );
                break;
            case 2: /* from */
                echo html_tag( 'td',
                               $italic . $bold . $flag . $fontstr . $senderName . 
                               $fontstr_end . $flag_end . $bold_end . $italic_end,
                               'left',
                               $hlt_color );
                break;
            case 3: /* date */
                echo html_tag( 'td',
                               $bold . $flag . $fontstr . $msg['DATE_STRING'] .
                               $fontstr_end . $flag_end . $bold_end,
                               'center',
                               $hlt_color,
                               'nowrap' );
                break;
            case 4: /* subject */
                $td_str = $bold;
                if ($thread_sort_messages == 1) {
                    if (isset($indent_array[$msg["ID"]])) {
                        $td_str .= str_repeat("&nbsp;&nbsp;&nbsp;&nbsp;",$indent_array[$msg['ID']]);
                    }
                }
                $td_str .= "<a href=\"read_body.php?mailbox=$urlMailbox&amp;passed_id="
                           . $msg["ID"]
                           . "&amp;startMessage=$start_msg&amp;show_more=0$search_stuff\"";
                do_hook("subject_link");
                if ($subject != $msg['SUBJECT']) {
                    $title = get_html_translation_table(HTML_SPECIALCHARS);
                    $title = array_flip($title);
                    $title = strtr($msg['SUBJECT'], $title);
                    $title = str_replace('"', "''", $title);
                    $td_str .= " title=\"$title\"";
                }
                $td_str .= ">$flag$subject$flag_end</a>$bold_end";
                echo html_tag( 'td', $td_str, 'left', $hlt_color );
                break;
            case 5: /* flags */
                $stuff = false;
                $td_str = "<b><small>";
                
                if (isset($msg['FLAG_ANSWERED']) && $msg['FLAG_ANSWERED'] == true) {
                    $td_str .= _("A");
                    $stuff = true;
                }
                if ($msg['TYPE0'] == 'multipart') {
                    $td_str .= '+';
                    $stuff = true;
                }
                if ($default_use_priority) {
                    if ( ($msg['PRIORITY'] == 1) || ($msg['PRIORITY'] == 2) ) {
                        $td_str .= "<font color=\"$color[1]\">!</font>";
                        $stuff = true;
                    }
                    if ($msg['PRIORITY'] == 5) {
                        $td_str .= "<font color=\"$color[8]\">?</font>";
                        $stuff = true;
                    }
                }
                if (isset($msg['FLAG_DELETED']) && $msg['FLAG_DELETED'] == true) {
                    $td_str .= "<font color=\"$color[1]\">D</font>";
                    $stuff = true;
                }
                if (!$stuff) {
                    $td_str .= '&nbsp;';
                }
                $td_str .= '</small></b>';
                echo html_tag( 'td',
                               $td_str,
                               'center',
                               $hlt_color,
                               'nowrap' );
                break;
            case 6: /* size */

                echo html_tag( 'td',
                               $bold . $fontstr . show_readable_size($msg['SIZE']) .  
                               $fontstr_end . $bold_end,
                               'right',
                               $hlt_color );
                break;
            }
        }
    }
    echo "</tr>\n";
}

/*
* This function loops through a group of messages in the mailbox
* and shows them to the user.
*/
function showMessagesForMailbox($imapConnection, $mailbox, $num_msgs,
$start_msg, $sort, $color, $show_num,
$use_cache) {
    global $msgs, $msort,
    $sent_folder, $draft_folder,
    $message_highlight_list,
    $auto_expunge, $thread_sort_messages, $allow_server_sort,
    $data_dir, $username, $server_sort_order;

    /* if $start_msg is lower than $num_msgs, we probably deleted all messages
    * in the last page. We need to re-adjust the start_msg
    */

    if($start_msg > $num_msgs) {
        $start_msg -= $show_num;
        if($start_msg < 1) {
            $start_msg = 1;
        }
    }

    /* This code and the next if() block check for
    * server-side sorting methods. The $id array is
    * formatted and $sort is set to 6 to disable
    * SM internal sorting
    */
    if ($thread_sort_messages == 1) {
        $id = get_thread_sort($imapConnection);
        if ($id == 'no') {
            echo '<b><small><center><font color=red>' . 
                 _("Thread sorting is not supported by your IMAP server.<br>Please report this to the system administrator.").
                 '</center></small></b>';
            $thread_sort_messages = 0;
            $id = array();
        }
        else {
            $sort = 6;
            if ($start_msg + ($show_num - 1) < $num_msgs) {
                $end_msg = $start_msg + ($show_num-1);
            }
            else {
                $end_msg = $num_msgs;
            }
            $id = array_slice($id, ($start_msg-1), ($end_msg));
        }
    }

    if ($allow_server_sort == TRUE && $thread_sort_messages != 1) {
        $server_sort_order = $sort;
        $id = sqimap_get_sort_order($imapConnection, $server_sort_order);
        if ($id == 'no') {
            echo '<b><small><center><font color=red>' .
                 _( "Server-side sorting is not supported by your IMAP server.<br>Please report this to the system administrator.").
                 '</center></small></b>';
            $sort = $server_sort_order;
            $allow_server_sort = FALSE;
            $id = array();
        }
        else {
            $sort = 6;
            if ($start_msg + ($show_num - 1) < $num_msgs) {
                $end_msg = $start_msg + ($show_num-1);
            }
            else {
                $end_msg = $num_msgs;
            }
            $id = array_slice($id, ($start_msg-1), ($end_msg));
        }
    }

    /* If autoexpunge is turned on, then do it now. */
    if ($auto_expunge == true) {
        sqimap_mailbox_expunge($imapConnection, $mailbox, false);
    }
    sqimap_mailbox_select($imapConnection, $mailbox);
    $issent = handleAsSent($mailbox);
    if (!$use_cache) {
        /* If it is sorted... */
        if ($num_msgs >= 1) {
            if ($sort < 6 ) {
                $id = range(1, $num_msgs);
            }
            elseif ($thread_sort_messages != 1 && $allow_server_sort != TRUE && $sort == 6) {
                /* if it's not sorted */
                if ($start_msg + ($show_num - 1) < $num_msgs){
                    $end_msg = $start_msg + ($show_num - 1);
                } else {
                    $end_msg = $num_msgs;
                }
                if ($end_msg < $start_msg) {
                    $start_msg = $start_msg - $show_num;
                    if ($start_msg < 1) {
                        $start_msg = 1;
                    }
                }

                $real_startMessage = $num_msgs - $start_msg + 1;
                $real_endMessage = $num_msgs - $start_msg - $show_num + 2;
                if ($real_endMessage <= 0) {
                    $real_endMessage = 1;
                }
                $id = array_reverse(range($real_endMessage, $real_startMessage));
            }
            $msgs_list = sqimap_get_small_header_list($imapConnection, $id, $issent);
            //      $flags = sqimap_get_flags_list($imapConnection, $id, $issent);
            if (sizeof($msgs_list)){
                foreach ($msgs_list as $hdr) {
                    $from[] = $hdr->from;
                    $date[] = $hdr->date;
                    $subject[] = $hdr->subject;
                    $to[] = $hdr->to;
                    $priority[] = $hdr->priority;
                    $cc[] = $hdr->cc;
                    $size[] = $hdr->size;
                    $type[] = $hdr->type0;
                    $flag_deleted[] = $hdr->flag_deleted;
                    $flag_answered[] = $hdr->flag_answered;
                    $flag_seen[] = $hdr->flag_seen;
                    $flag_flagged[] = $hdr->flag_flagged;
                }
            }
        }
        $j = 0;
        if ($sort == 6) {
            $end = $start_msg + $show_num - 1;
            if ($num_msgs < $show_num) {
                $end_loop = $num_msgs;
            } else if ($end > $num_msgs) {
                $end_loop = $num_msgs - $start_msg + 1;
            } else {
                $end_loop = $show_num;
            }
        } else {
            $end = $num_msgs;
            $end_loop = $end;
        }
        while ($j < $end_loop) {
            if (isset($date[$j])) {
                $date[$j] = str_replace('  ', ' ', $date[$j]);
                $tmpdate = explode(' ', trim($date[$j]));
            } else {
                $tmpdate = $date = array('', '', '', '', '', '');
            }

            $messages[$j]['TIME_STAMP'] = getTimeStamp($tmpdate);
            $messages[$j]['DATE_STRING'] =
            getDateString($messages[$j]['TIME_STAMP']);
            $messages[$j]['ID'] = $id[$j];
            $messages[$j]['FROM'] = decodeHeader($from[$j]);
            $messages[$j]['FROM-SORT'] =
            strtolower(sqimap_find_displayable_name(decodeHeader($from[$j])));
            $messages[$j]['SUBJECT'] = decodeHeader($subject[$j]);
            $messages[$j]['SUBJECT-SORT'] = strtolower(decodeHeader($subject[$j]));
            $messages[$j]['TO'] = decodeHeader($to[$j]);
            $messages[$j]['PRIORITY'] = $priority[$j];
            $messages[$j]['CC'] = $cc[$j];
            $messages[$j]['SIZE'] = $size[$j];
            $messages[$j]['TYPE0'] = $type[$j];
            $messages[$j]['FLAG_DELETED'] = $flag_deleted[$j];
            $messages[$j]['FLAG_ANSWERED'] = $flag_answered[$j];
            $messages[$j]['FLAG_SEEN'] = $flag_seen[$j];
            $messages[$j]['FLAG_FLAGGED'] = $flag_flagged[$j];


            /*
            * fix SUBJECT-SORT to remove Re:
            *     vedr|sv  (Danish)
            *     re|aw (English)
            *
            * TODO: i18n should be incorporated here. E.g. we catch the ones
            * we know about, but also define in i18n what the localized
            * "Re: " is for this or that locale.
            */
            if (preg_match("/^(vedr|sv|re|aw):\s*(.*)$/si",
            $messages[$j]['SUBJECT-SORT'], $matches)){
                $messages[$j]['SUBJECT-SORT'] = $matches[2];
            }
            /*
            $num = 0;
            while ($num < count($flags[$j])) {
            if ($flags[$j][$num] == 'Deleted') {
            $messages[$j]['FLAG_DELETED'] = true;
            } else if ($flags[$j][$num] == 'Answered') {
            $messages[$j]['FLAG_ANSWERED'] = true;
            } else if ($flags[$j][$num] == 'Seen') {
            $messages[$j]['FLAG_SEEN'] = true;
            } else if ($flags[$j][$num] == 'Flagged') {
            $messages[$j]['FLAG_FLAGGED'] = true;
            }
            $num++;
            }
            */
            $j++;

        }

        /*
        * Only ignore messages flagged as deleted if we are
        * using a trash folder or auto_expunge
        */
        if (((isset($move_to_trash) && $move_to_trash)
        || (isset($auto_expunge) && $auto_expunge))
        && $sort != 6) {

            /* Find and remove the ones that are deleted */
            $i = 0;
            $j = 0;

            while ($j < $num_msgs) {
                if (isset($messages[$j]['FLAG_DELETED'])
                && $messages[$j]['FLAG_DELETED'] == true) {
                    $j++;
                    continue;
                }
                $msgs[$i] = $messages[$j];

                $i++;
                $j++;
            }
            $num_msgs = $i;
        } else {
            if (!isset($messages)) {
                $messages = array();
            }
            $msgs = $messages;
        }
    }

    /* There's gotta be messages in the array for it to sort them. */
    if (($num_msgs > 0) && (!$use_cache)) {
        /*
        * 0 = Date (up)
        * 1 = Date (dn)
        * 2 = Name (up)
        * 3 = Name (dn)
        * 4 = Subject (up)
        * 5 = Subject (dn)
        */
        session_unregister('msgs');
        if (($sort == 0) || ($sort == 1)) {
            $msort = array_cleave ($msgs, 'TIME_STAMP');
        } elseif (($sort == 2) || ($sort == 3)) {
            $msort = array_cleave ($msgs, 'FROM-SORT');
        } elseif (($sort == 4) || ($sort == 5)) {
            $msort = array_cleave ($msgs, 'SUBJECT-SORT');
        } else {
            $msort = $msgs;
        }

        if ($sort < 6) {
            if ($sort % 2) {
                asort($msort);
            } else {
                arsort($msort);
            }
        }
        session_register('msort');
    } elseif ($thread_sort_messages == 1 || $allow_server_sort == TRUE) {
        $msort = $msgs;
        session_unregister('msgs');
        session_register('msort');
    }
    displayMessageArray($imapConnection, $num_msgs, $start_msg, $msgs,
    $msort, $mailbox, $sort, $color,$show_num);
    /**
    * TODO: Switch to using $_SESSION[] whenever we ditch the 4.0.x series.
    */
    session_register('msgs');
}

/* Generic function to convert the msgs array into an HTML table. */
function displayMessageArray($imapConnection, $num_msgs, $start_msg,
&$msgs, $msort, $mailbox, $sort, $color,
$show_num) {

    global $folder_prefix, $sent_folder,
    $imapServerAddress, $data_dir, $username, $use_mailbox_cache,
    $index_order, $real_endMessage, $real_startMessage, $checkall,
    $indent_array, $thread_sort_messages, $allow_server_sort,
    $server_sort_order;

    /* If cache isn't already set, do it now. */
    if (!session_is_registered('msgs')) {
        session_register('msgs');
    }
    if (!session_is_registered('msort')) {
        session_register('msort');
    }

    if ($start_msg + ($show_num - 1) < $num_msgs){
        $end_msg = $start_msg + ($show_num - 1);
    } else {
        $end_msg = $num_msgs;
    }

    if ($end_msg < $start_msg) {
        $start_msg = $start_msg - $show_num;
        if ($start_msg < 1) {
            $start_msg = 1;
        }
    }

    $urlMailbox = urlencode($mailbox);

    do_hook('mailbox_index_before');

    $msg_cnt_str = get_msgcnt_str($start_msg, $end_msg, $num_msgs);
    $paginator_str = get_paginator_str($urlMailbox, $start_msg, $end_msg,
    $num_msgs, $show_num, $sort);

    if (!isset($msg)) {
        $msg = '';
    }

    /* get indent level for subject display */
    if ($thread_sort_messages == 1 ) {
        $indent_array = get_parent_level($imapConnection);
    }
    $fstring = "move_messages.php?msg=$msg&amp;mailbox=$urlMailbox"
    . "&amp;startMessage=$start_msg";
    mail_message_listing_beginning($imapConnection, $fstring,
    $mailbox, $sort, $msg_cnt_str,
    $paginator_str, $start_msg);

    $groupNum = $start_msg % ($show_num - 1);
    $real_startMessage = $start_msg;
    if ($sort == 6) {
        if ($end_msg - $start_msg < $show_num - 1) {
            $end_msg = $end_msg - $start_msg + 1;
            $start_msg = 1;
        } else if ($start_msg > $show_num) {
            $end_msg = $show_num;
            $start_msg = 1;
        }
    }
    $endVar = $end_msg + 1;

    /*
    * Loop through and display the info for each message.
    * ($t is used for the checkbox number)
    */
    $t = 0;
    if ($num_msgs == 0) {
        /* if there's no messages in this folder */
        echo html_tag( 'tr',
                html_tag( 'td',
                          "<BR><B>" . _("THIS FOLDER IS EMPTY") . "</B><BR>&nbsp;",
                          'center',
                          $color[4],
                          'COLSPAN="' . count($index_order) . '"'
                )
            );

    } elseif ($start_msg == $end_msg) {
        /* if there's only one message in the box, handle it differently. */
        if ($sort != 6){
            $i = $start_msg;
        } else {
            $i = 1;
        }
        reset($msort);
        $k = 0;
        do {
            $key = key($msort);
            next($msort);
            $k++;
        } while (isset ($key) && ($k < $i));
        printMessageInfo($imapConnection, $t, $i, $key, $mailbox, $sort,
        $real_startMessage, 0, 0);
    } else {
        $i = $start_msg;
        reset($msort);
        $k = 0;
        do {
            $key = key($msort);
            next($msort);
            $k++;
        } while (isset ($key) && ($k < $i));
        do {
            printMessageInfo($imapConnection, $t, $i, $key, $mailbox,
            $sort, $real_startMessage, 0, 0);
            $key = key($msort);
            $t++;
            $i++;
            next($msort);
        } while ($i && $i < $endVar);
    }

    echo '</table>';

    echo html_tag( 'table',
            html_tag( 'tr',
                html_tag( 'td',
                    html_tag( 'table',
                        html_tag( 'tr',
                            html_tag( 'td', $paginator_str ) .
                            html_tag( 'td', $msg_cnt_str, 'right' )
                        )
                    , '', $color[4], 'width="100%" cellpadding="1" cellspacing="1"' )
                )
            , '', $color[4] )
        , '', $color[9], 'width="100%" cellpadding="1"  cellspacing="1"' );

    /* End of message-list table */

    do_hook('mailbox_index_after');
    echo "</TABLE></FORM>\n";
}

/*
* Displays the standard message list header. To finish the table,
* you need to do a "</table></table>";
*
* $moveURL is the URL to submit the delete/move form to
* $mailbox is the current mailbox
* $sort is the current sorting method (-1 for no sorting available [searches])
* $Message is a message that is centered on top of the list
* $More is a second line that is left aligned
*/

function mail_message_listing_beginning ($imapConnection, $moveURL,
                                         $mailbox = '', $sort = -1,
                                         $msg_cnt_str = '',
                                         $paginator = '&nbsp;',
                                         $start_msg = 1) {
    global $color, $index_order, $auto_expunge, $move_to_trash, $base_uri,
           $checkall, $sent_folder, $draft_folder, $thread_sort_messages,
           $allow_thread_sort, $allow_server_sort, $server_sort_order,
           $lastTargetMailbox;

    $urlMailbox = urlencode($mailbox);

    /*
    * This is the beginning of the message list table.
    * It wraps around all messages
    */
    echo "<FORM name=\"messageList\" method=post action=\"$moveURL\">\n"
        . html_tag( 'table' ,'' , '', '', 'border="0" width="100%" cellpadding="1"  cellspacing="0"' ) .
            html_tag( 'tr',
                html_tag( 'td' ,
                    html_tag( 'table' ,
                        html_tag( 'tr',
                            html_tag( 'td', $paginator, 'left' ) .
                            html_tag( 'td', $msg_cnt_str, 'right' ) 
                        )
                    , '', $color[4], 'border="0" width="100%" cellpadding="2"  cellspacing="0"' ) 
                , 'left', '', '' )
            , '', $color[0] )
        . '<TR>'
        . html_tag( 'td' ,'' , 'left', $color[0], '' )
        . html_tag( 'table' ,'' , '', $color[0], 'border="0" width="100%" cellpadding="0"  cellspacing="0"' )
            . html_tag( 'tr',
                html_tag( 'td', 
                            '<SMALL>&nbsp;' . _("Move Selected To:") . '</SMALL>',
                            'left',
                            '',
                            'valign="middle" nowrap' ) .
                html_tag( 'td',            
                            '<SMALL>' . _("Transform Selected Messages") . ': &nbsp; </SMALL><BR>',
                            'right',
                            '',
                            'nowrap' )
            )
        . "   <TR>\n"
        . html_tag( 'td', '', 'left', '', 'valign="middle" nowrap' )
        . '         <SMALL>&nbsp;<TT><SELECT NAME="targetMailbox">';

    $boxes = sqimap_mailbox_list($imapConnection);
    foreach ($boxes as $boxes_part) {
        if (!in_array('noselect', $boxes_part['flags'])) {
            $box = $boxes_part['unformatted'];
            $box2 = str_replace(' ', '&nbsp;', imap_utf7_decode_local($boxes_part['unformatted-disp']));
            if( $box2 == 'INBOX' ) {
                $box2 = _("INBOX");
            }
            if ($lastTargetMailbox == $box) {
                echo "       <OPTION VALUE=\"$box\" SELECTED>$box2</OPTION>\n";
            }
            else {
                echo "         <OPTION VALUE=\"$box\">$box2</OPTION>\n";
            }
        }
    }
    echo '         </SELECT></TT>&nbsp;'
    . '<INPUT TYPE="SUBMIT" NAME="moveButton" VALUE="' . _("Move") . '">&nbsp;'
    . '<INPUT TYPE="SUBMIT" NAME="attache" VALUE="' . _("Forward")
    . "\">&nbsp;\n" . "</SMALL>\n";

    echo "      </TD>\n"
    . "      <TD ALIGN=\"RIGHT\" NOWRAP>";
    if (!$auto_expunge) {
        echo '<INPUT TYPE=SUBMIT NAME="expungeButton" VALUE="' . _("Expunge")
        . '">&nbsp;' . _("mailbox") . '&nbsp;';
    }
    echo '<INPUT TYPE="SUBMIT" NAME="markRead" VALUE="' . _("Read") . '">'
    . '<INPUT TYPE="SUBMIT" NAME="markUnread" VALUE="' . _("Unread") . '">'
    . '<INPUT TYPE="SUBMIT" VALUE="' . _("Delete") . '">&nbsp;'
    . "</TD>\n"
    . "   </TR>\n";

    /* draws thread sorting links */
    if ($allow_thread_sort == TRUE) {
        if ($thread_sort_messages == 1 ) {
            $set_thread = 2;
            $thread_name = _("Unthread View");
        }
        elseif ($thread_sort_messages == 0) {
            $set_thread = 1;
            $thread_name = _("Thread View");
        }
        echo html_tag( 'tr' ,
                    html_tag( 'td' ,
                              '&nbsp;<a href=' . "$base_uri" . 'src/right_main.php?sort='
                              . "$sort" . '&start_messages=1&set_thread=' . "$set_thread"
                              . '&mailbox=' . urlencode($mailbox) . '><small>' . $thread_name
                              . '</a></small>&nbsp;'
                     , '', '', '' )
                 , '', '', '' );
    }

    echo "</TABLE>\n";
    do_hook('mailbox_form_before');
    echo '</TD></TR><TR>'
    . html_tag( 'td' ,'' , '', $color[0], '' );
    if ($GLOBALS['alt_index_colors']){
        $cellspacing =  '0';
    } else {
        $cellspacing = '1';
    }
    echo html_tag( 'table' ,'' , '', $color[0], 'border="0" width="100%" cellpadding="2"  cellspacing="'. $cellspacing .'"' )
    . "<TR BGCOLOR=\"$color[5]\" ALIGN=\"center\">";
    /* if using server sort we highjack the
    * the $sort var and use $server_sort_order
    * instead. but here we reset sort for a bit
    * since its easy
    */
    if ($allow_server_sort == TRUE) {
        $sort = $server_sort_order;
    }
    /* Print the headers. */
    for ($i=1; $i <= count($index_order); $i++) {
        switch ($index_order[$i]) {
        case 1: /* checkbox */
        case 5: /* flags */
            echo '   <TD WIDTH="1%"></TD>';
            break;
        case 2: /* from */
            if (handleAsSent($mailbox)) {
                echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
                . '<b>' . _("To") . '</b>';
            } else {
                echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
                . '<b>' . _("From") . '</b>';
            }
            if ($allow_thread_sort != TRUE || $thread_sort_messages != 1) {
                ShowSortButton($sort, $mailbox, 2, 3);
            }
            echo "</TD>\n";
            break;
        case 3: /* date */
            echo html_tag( 'td' ,'' , 'left', '', 'width="5%" nowrap' )
            . '<b>' . _("Date") . '</b>';
            if ($allow_thread_sort != TRUE || $thread_sort_messages != 1) {
                ShowSortButton($sort, $mailbox, 0, 1);
            }
            echo "</td>\n";
            break;
            case 4: /* subject */
            echo html_tag( 'td' ,'' , 'left', '', '' )
            . '<b>' . _("Subject") . '</b>';
            if ($allow_thread_sort != TRUE || $thread_sort_messages != 1) {
                ShowSortButton($sort, $mailbox, 4, 5);
            }
            echo "</TD>\n";
            break;
        case 6: /* size */
            echo html_tag( 'td', '<b>' . _("Size") . '</b>', 'center', '', 'width="5%"' );
            break;
        }
    }
    /* if using server-sorting,
    * send sort back to 6
    */
    if ($allow_server_sort == TRUE) {
        $sort = 6;
    }
    echo "</TR>\n";
}

/*
* This function shows the sort button. Isn't this a good comment?
*/
function ShowSortButton($sort, $mailbox, $Up, $Down) {
    /* Figure out which image we want to use. */
    if ($sort != $Up && $sort != $Down) {
        $img = 'sort_none.png';
        $which = $Up;
    } elseif ($sort == $Up) {
        $img = 'up_pointer.png';
        $which = $Down;
    } else {
        $img = 'down_pointer.png';
        $which = 6;
    }

    /* Now that we have everything figured out, show the actual button. */
    echo ' <a href="right_main.php?newsort=' . $which
    . '&amp;startMessage=1&amp;mailbox=' . urlencode($mailbox)
    . '"><IMG SRC="../images/' . $img
    . '" BORDER=0 WIDTH=12 HEIGHT=10 ALT="sort"></a>';
}

function get_selectall_link($start_msg, $sort) {
    global $checkall, $what, $where, $mailbox, $javascript_on;
    global $PHP_SELF, $PG_SHOWNUM;

    $result = '';
    if ($javascript_on) {
        $result =
        '<script language="JavaScript" type="text/javascript">'
        . "\n<!-- \n"
        . "function CheckAll() {\n"
        . "  for (var i = 0; i < document.messageList.elements.length; i++) {\n"
        . "    if(document.messageList.elements[i].type == 'checkbox'){\n"
        . "      document.messageList.elements[i].checked = "
        . "        !(document.messageList.elements[i].checked);\n"
        . "    }\n"
        . "  }\n"
        . "}\n"
        . "//-->\n"
        . '</script><a href="#" onClick="CheckAll();">' . _("Toggle All")
        . "</a>\n";
    } else {
        if (strpos($PHP_SELF, "?")) {
            $result .= "<a href=\"$PHP_SELF&amp;mailbox=" . urlencode($mailbox)
            . "&amp;startMessage=$start_msg&amp;sort=$sort&amp;checkall=";
        } else {
            $result .= "<a href=\"$PHP_SELF?mailbox=" . urlencode($mailbox)
            . "&amp;startMessage=$start_msg&amp;sort=$sort&amp;checkall=";
        }
        if (isset($checkall) && $checkall == '1') {
            $result .= '0';
        } else {
            $result .= '1';
        }

        if (isset($where) && isset($what)) {
            $result .= '&amp;where=' . urlencode($where)
            . '&amp;what=' . urlencode($what);
        }

        $result .= "\">";

        if (isset($checkall) && ($checkall == '1')) {
            $result .= _("Unselect All");
        } else {
            $result .= _("Select All");
        }

        $result .= "</A>\n";
    }

    /* Return our final result. */
    return ($result);
}

/*
* This function computes the "Viewing Messages..." string.
*/
function get_msgcnt_str($start_msg, $end_msg, $num_msgs) {
    /* Compute the $msg_cnt_str. */
    $result = '';
    if ($start_msg < $end_msg) {
        $result = sprintf(_("Viewing Messages: <B>%s</B> to <B>%s</B> (%s total)"),
        $start_msg, $end_msg, $num_msgs);
    } else if ($start_msg == $end_msg) {
        $result = sprintf(_("Viewing Message: <B>%s</B> (1 total)"), $start_msg);
    } else {
        $result = '<br>';
    }

    /* Return our result string. */
    return ($result);
}

/*
* Generate a paginator link.
*/
function get_paginator_link($box, $start_msg, $use, $text) {
    $result = "<A HREF=\"right_main.php?use_mailbox_cache=$use"
    . "&amp;startMessage=$start_msg&amp;mailbox=$box\" "
    . "TARGET=\"right\">$text</A>";
    return ($result);
}

/*
* This function computes the paginator string.
*/
function get_paginator_str($box, $start_msg, $end_msg, $num_msgs,
$show_num, $sort) {
    global $username, $data_dir, $use_mailbox_cache, $color, $PG_SHOWNUM;

    /* Initialize paginator string chunks. */
    $prv_str = '';
    $nxt_str = '';
    $pg_str = '';
    $all_str = '';
    $tgl_str = '';

    /* Create simple strings that will be creating the paginator. */
    $spc = '&nbsp;';     /* This will be used as a space. */
    $sep = '|';          /* This will be used as a seperator. */

    /* Get some paginator preference values. */
    $pg_sel = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
    $pg_max = getPref($data_dir, $username, 'page_selector_max', PG_SEL_MAX);

    /* Make sure that our start message number is not too big. */
    $start_msg = min($start_msg, $num_msgs);

    /* Decide whether or not we will use the mailbox cache. */
    /* Not sure why $use_mailbox_cache is even passed in.   */
    if ($sort == 6) {
        $use = 0;
    } else {
        $use = 1;
    }

    /* Compute the starting message of the previous and next page group. */
    $next_grp = $start_msg + $show_num;
    $prev_grp = $start_msg - $show_num;

    /* Compute the basic previous and next strings. */
    if (($next_grp <= $num_msgs) && ($prev_grp >= 0)) {
        $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
        $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
    } else if (($next_grp > $num_msgs) && ($prev_grp >= 0)) {
        $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
        $nxt_str = "<FONT COLOR=\"$color[9]\">"._("Next")."</FONT>\n";
    } else if (($next_grp <= $num_msgs) && ($prev_grp < 0)) {
        $prv_str = "<FONT COLOR=\"$color[9]\">"._("Previous") . '</FONT>';
        $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
    }

    /* Page selector block. Following code computes page links. */
    if ($pg_sel && ($num_msgs > $show_num)) {
        /* Most importantly, what is the current page!!! */
        $cur_pg = intval($start_msg / $show_num) + 1;

        /* Compute total # of pages and # of paginator page links. */
        $tot_pgs = ceil($num_msgs / $show_num);  /* Total number of Pages */
        $vis_pgs = min($pg_max, $tot_pgs - 1);   /* Visible Pages    */

        /* Compute the size of the four quarters of the page links. */

        /* If we can, just show all the pages. */
        if (($tot_pgs - 1) <= $pg_max) {
            $q1_pgs = $cur_pg - 1;
            $q2_pgs = $q3_pgs = 0;
            $q4_pgs = $tot_pgs - $cur_pg;

            /* Otherwise, compute some magic to choose the four quarters. */
        } else {
            /*
            * Compute the magic base values. Added together,
            * these values will always equal to the $pag_pgs.
            * NOTE: These are DEFAULT values and do not take
            * the current page into account. That is below.
            */
            $q1_pgs = floor($vis_pgs/4);
            $q2_pgs = round($vis_pgs/4, 0);
            $q3_pgs = ceil($vis_pgs/4);
            $q4_pgs = round(($vis_pgs - $q2_pgs)/3, 0);

            /* Adjust if the first quarter contains the current page. */
            if (($cur_pg - $q1_pgs) < 1) {
                $extra_pgs = ($q1_pgs - ($cur_pg - 1)) + $q2_pgs;
                $q1_pgs = $cur_pg - 1;
                $q2_pgs = 0;
                $q3_pgs += ceil($extra_pgs / 2);
                $q4_pgs += floor($extra_pgs / 2);

                /* Adjust if the first and second quarters intersect. */
            } else if (($cur_pg - $q2_pgs - ceil($q2_pgs/3)) <= $q1_pgs) {
                $extra_pgs = $q2_pgs;
                $extra_pgs -= ceil(($cur_pg - $q1_pgs - 1) * 0.75);
                $q2_pgs = ceil(($cur_pg - $q1_pgs - 1) * 0.75);
                $q3_pgs += ceil($extra_pgs / 2);
                $q4_pgs += floor($extra_pgs / 2);

                /* Adjust if the fourth quarter contains the current page. */
            } else if (($cur_pg + $q4_pgs) >= $tot_pgs) {
                $extra_pgs = ($q4_pgs - ($tot_pgs - $cur_pg)) + $q3_pgs;
                $q3_pgs = 0;
                $q4_pgs = $tot_pgs - $cur_pg;
                $q1_pgs += floor($extra_pgs / 2);
                $q2_pgs += ceil($extra_pgs / 2);

                /* Adjust if the third and fourth quarter intersect. */
            } else if (($cur_pg + $q3_pgs + 1) >= ($tot_pgs - $q4_pgs + 1)) {
                $extra_pgs = $q3_pgs;
                $extra_pgs -= ceil(($tot_pgs - $cur_pg - $q4_pgs) * 0.75);
                $q3_pgs = ceil(($tot_pgs - $cur_pg - $q4_pgs) * 0.75);
                $q1_pgs += floor($extra_pgs / 2);
                $q2_pgs += ceil($extra_pgs / 2);
            }
        }

        /*
        * I am leaving this debug code here, commented out, because
        * it is a really nice way to see what the above code is doing.
        * echo "qts =  $q1_pgs/$q2_pgs/$q3_pgs/$q4_pgs = "
        *    . ($q1_pgs + $q2_pgs + $q3_pgs + $q4_pgs) . '<br>';
        */

        /* Print out the page links from the compute page quarters. */

        /* Start with the first quarter. */
        if (($q1_pgs == 0) && ($cur_pg > 1)) {
            $pg_str .= "...$spc";
        } else {
            for ($pg = 1; $pg <= $q1_pgs; ++$pg) {
                $start = (($pg-1) * $show_num) + 1;
                $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
            }
            if ($cur_pg - $q2_pgs - $q1_pgs > 1) {
                $pg_str .= "...$spc";
            }
        }

        /* Continue with the second quarter. */
        for ($pg = $cur_pg - $q2_pgs; $pg < $cur_pg; ++$pg) {
            $start = (($pg-1) * $show_num) + 1;
            $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
        }

        /* Now print the current page. */
        $pg_str .= $cur_pg . $spc;

        /* Next comes the third quarter. */
        for ($pg = $cur_pg + 1; $pg <= $cur_pg + $q3_pgs; ++$pg) {
            $start = (($pg-1) * $show_num) + 1;
            $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
        }

        /* And last, print the forth quarter page links. */
        if (($q4_pgs == 0) && ($cur_pg < $tot_pgs)) {
            $pg_str .= "...$spc";
        } else {
            if (($tot_pgs - $q4_pgs) > ($cur_pg + $q3_pgs)) {
                $pg_str .= "...$spc";
            }
            for ($pg = $tot_pgs - $q4_pgs + 1; $pg <= $tot_pgs; ++$pg) {
                $start = (($pg-1) * $show_num) + 1;
                $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
            }
        }
    } else if ($PG_SHOWNUM == 999999) {
        $pg_str = "<A HREF=\"right_main.php?PG_SHOWALL=0"
        . "&amp;use_mailbox_cache=$use&amp;startMessage=1&amp;mailbox=$box\" "
        . "TARGET=\"right\">" ._("Paginate") . '</A>' . $spc;
    }

    /* If necessary, compute the 'show all' string. */
    if (($prv_str != '') || ($nxt_str != '')) {
        $all_str = "<A HREF=\"right_main.php?PG_SHOWALL=1"
        . "&amp;use_mailbox_cache=$use&amp;startMessage=1&amp;mailbox=$box\" "
        . "TARGET=\"right\">" . _("Show All") . '</A>';
    }

    /* Last but not least, get the value for the toggle all link. */
    $tgl_str = get_selectall_link($start_msg, $sort);

    /* Put all the pieces of the paginator string together. */
    /**
    * Hairy code... But let's leave it like it is since I am not certain
    * a different approach would be any easier to read. ;)
    */
    $result = '';
    $result .= ($prv_str != '' ? $prv_str . $spc . $sep . $spc : '');
    $result .= ($nxt_str != '' ? $nxt_str . $spc . $sep . $spc : '');
    $result .= ($pg_str != '' ? $pg_str : '');
    $result .= ($all_str != '' ? $sep . $spc . $all_str . $spc : '');
    $result .= ($result != '' ? $sep . $spc . $tgl_str: $tgl_str);

    /* If the resulting string is blank, return a non-breaking space. */
    if ($result == '') {
        $result = '&nbsp;';
    }

    /* Return our final magical paginator string. */
    return ($result);
}

function processSubject($subject) {
    /* Shouldn't ever happen -- caught too many times in the IMAP functions */
    if ($subject == '')
    return _("(no subject)");

    if (strlen($subject) <= 55)
    return $subject;

    $ent_strlen=strlen($subject);
    $trim_val=50;
    $ent_offset=0;
    /*
    * see if this is entities-encoded string
    * If so, Iterate through the whole string, find out
    * the real number of characters, and if more
    * than 55, substr with an updated trim value.
    */
    while ( (($ent_loc = strpos($subject, '&', $ent_offset)) !== false) &&
    (($ent_loc_end = strpos($subject, ';', $ent_loc)) !== false) ) {
        $trim_val += ($ent_loc_end-$ent_loc)+1;
        $ent_strlen -= $ent_loc_end-$ent_loc;
        $ent_offset = $ent_loc_end+1;
    }

    if ($ent_strlen <= 55){
        return $subject;
    }

    return substr($subject, 0, $trim_val) . '...';
}

function handleAsSent($mailbox) {
    global $sent_folder, $draft_folder, $handleAsSent_result;

    /* First check if this is the sent or draft folder. */
    $handleAsSent_result = (($mailbox == $sent_folder)
    || ($mailbox == $draft_folder));

    /* Then check the result of the handleAsSent hook. */
    do_hook('check_handleAsSent_result', $mailbox);

    /* And return the result. */
    return ($handleAsSent_result);
}

?>