Source for file mailbox_display.php

Documentation is available at mailbox_display.php

  1. <?php
  2.  
  3. /**
  4.  * mailbox_display.php
  5.  *
  6.  * This contains functions that display mailbox information, such as the
  7.  * table row that has sender, date, subject, etc...
  8.  *
  9.  * @copyright 1999-2020 The SquirrelMail Project Team
  10.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11.  * @version $Id: mailbox_display.php 14845 2020-01-07 08:09:34Z pdontthink $
  12.  * @package squirrelmail
  13.  */
  14.  
  15.  
  16. /**
  17.  * Selects a mailbox for header retrieval.
  18.  * Cache control for message headers is embedded.
  19.  *
  20.  * @param resource $imapConnection imap socket handle
  21.  * @param string   $mailbox mailbox to select and retrieve message headers from
  22.  * @param array    $aConfig array with system config settings and incoming vars
  23.  * @param array    $aProps mailbox specific properties
  24.  * @param boolean  $handle_errors When TRUE, IMAP errors
  25.  *                                 are handled herein, causing
  26.  *                                 an error to be displayed on
  27.  *                                 screen and execution to stop
  28.  *                                 and when FALSE, error status
  29.  *                                 is returned to the caller
  30.  *                                 (OPTIONAL; default is TRUE)
  31.  *
  32.  * @return array   $aMailbox mailbox array with all relevant information
  33.  *                            (if $handle_errors is false and there was an
  34.  *                            error, the array will be empty)
  35.  *
  36.  * @since 1.5.1
  37.  * @author Marc Groot Koerkamp
  38.  */
  39. function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aProps,$handle_errors=true) {
  40.  
  41.     /**
  42.      * NB: retrieve this from the session before accessing this function
  43.      * and make sure you write it back at the end of the script after
  44.      * the aMailbox var is added so that the headers are added to the cache
  45.      */
  46.     global $mailbox_cache;
  47.  
  48.     $aDefaultConfigProps = array(
  49. //                'charset'           => 'US-ASCII',
  50.                 'user'              => false, /* no pref storage if false */
  51.                 'setindex'          => 0,
  52. //                'search'            => 'ALL',
  53.                 'max_cache_size'    => SQM_MAX_MBX_IN_CACHE
  54.                 );
  55.  
  56.     $aConfig = array_merge($aDefaultConfigProps,$aConfig);
  57.  
  58.     $iSetIndx = $aConfig['setindex'];
  59.  
  60.     $aMbxResponse = sqimap_mailbox_select($imapConnection, $mailbox, $handle_errors);
  61.     if (empty($aMbxResponse))
  62.        return $aMbxResponse;
  63.  
  64.     if ($mailbox_cache) {
  65.         if (isset($mailbox_cache[$account.'_'.$mailbox])) {
  66.             $aCachedMailbox = $mailbox_cache[$account.'_'.$mailbox];
  67.         } else {
  68.             $aCachedMailbox = false;
  69.         }
  70.             /* cleanup cache */
  71.         if (count($mailbox_cache) > $aConfig['max_cache_size'] -1) {
  72.             $aTime = array();
  73.             foreach($mailbox_cache as $cachedmailbox => $aVal) {
  74.                 $aTime[$aVal['TIMESTAMP']] = $cachedmailbox;
  75.             }
  76.             if (ksort($aTime,SORT_NUMERIC)) {
  77.                 for ($i=0,$iCnt=count($mailbox_cache);$i<($iCnt-$aConfig['max_cache_size']);++$i) {
  78.                     $sOldestMbx = array_shift($aTime);
  79.                     /**
  80.                      * Remove only the UIDSET and MSG_HEADERS from cache because those can
  81.                      * contain large amounts of data.
  82.                      */
  83.                     if (isset($mailbox_cache[$sOldestMbx]['UIDSET'])) {
  84.                         $mailbox_cache[$sOldestMbx]['UIDSET']= false;
  85.                     }
  86.                     if (isset($mailbox_cache[$sOldestMbx]['MSG_HEADERS'])) {
  87.                         $mailbox_cache[$sOldestMbx]['MSG_HEADERS'] = false;
  88.                     }
  89.                 }
  90.             }
  91.         }
  92.  
  93.     } else {
  94.         $aCachedMailbox = false;
  95.     }
  96.  
  97.     /**
  98.      * Deal with imap servers that do not return the required UIDNEXT or
  99.      * UIDVALIDITY response
  100.      * from a SELECT call (since rfc 3501 it's required).
  101.      */
  102.     if (!isset($aMbxResponse['UIDNEXT']) || !isset($aMbxResponse['UIDVALIDITY'])) {
  103.         $aStatus = sqimap_status_messages($imapConnection,$mailbox,
  104.                                         array('UIDNEXT','UIDVALIDITY'));
  105.         $aMbxResponse['UIDNEXT'] = $aStatus['UIDNEXT'];
  106.         $aMbxResponse['UIDVALIDTY'] = $aStatus['UIDVALIDITY'];
  107.     }
  108.  
  109.     $aMailbox['ACCOUNT'] = $account;
  110.     $aMailbox['UIDSET'][$iSetIndx] = false;
  111.     $aMailbox['ID'] = false;
  112.     $aMailbox['SETINDEX'] = $iSetIndx;
  113.     $aMailbox['MSG_HEADERS'] = false;
  114.  
  115.     if ($aCachedMailbox) {
  116.         /**
  117.          * Validate integrity of cached data
  118.          */
  119.         if ($aCachedMailbox['EXISTS'] == $aMbxResponse['EXISTS'] &&
  120.             $aMbxResponse['EXISTS'] &&
  121.             $aCachedMailbox['UIDVALIDITY'] == $aMbxResponse['UIDVALIDITY'] &&
  122.             $aCachedMailbox['UIDNEXT']  == $aMbxResponse['UIDNEXT'] &&
  123.             isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
  124.             (!isset($aConfig['search']) || /* always set search from the searchpage */
  125.              $aCachedMailbox['SEARCH'][$iSetIndx] == $aConfig['search'])) {
  126.             if (isset($aCachedMailbox['MSG_HEADERS'])) {
  127.                 $aMailbox['MSG_HEADERS'] = $aCachedMailbox['MSG_HEADERS'];
  128.             }
  129.             $aMailbox['ID'] =  $aCachedMailbox['ID'];
  130.             if (isset($aCachedMailbox['UIDSET'][$iSetIndx]) && $aCachedMailbox['UIDSET'][$iSetIndx]) {
  131.                 if (isset($aProps[MBX_PREF_SORT]) &&  $aProps[MBX_PREF_SORT] != $aCachedMailbox['SORT'] ) {
  132.                     $newsort = $aProps[MBX_PREF_SORT];
  133.                     $oldsort = $aCachedMailbox['SORT'];
  134.                     /**
  135.                      * If it concerns a reverse sort we do not need to invalidate
  136.                      * the cached sorted UIDSET, a reverse is sufficient.
  137.                      */
  138.                     if ((($newsort % 2) && ($newsort + 1 == $oldsort)) ||
  139.                         (!($newsort % 2) && ($newsort - 1 == $oldsort))) {
  140.                         $aMailbox['UIDSET'][$iSetIndx] = array_reverse($aCachedMailbox['UIDSET'][$iSetIndx]);
  141.                     } else {
  142.                         $server_sort_array = false;
  143.                         $aMailbox['MSG_HEADERS'] = false;
  144.                         $aMailbox['ID'] = false;
  145.                     }
  146.                     // store the new sort value in the mailbox pref
  147.                     if ($aConfig['user']) {
  148.                         // FIXME, in ideal situation, we write back the
  149.                         // prefs at the end of the script
  150.                         setUserPref($aConfig['user'],'pref_'.$account.'_'.$mailbox,serialize($aProps));
  151.                     }
  152.                 } else {
  153.                     $aMailbox['UIDSET'][$iSetIndx] = $aCachedMailbox['UIDSET'][$iSetIndx];
  154.                 }
  155.             }
  156.         }
  157.     }
  158.     /**
  159.      * Restore the offset in the paginator if no new offset is provided.
  160.      */
  161.     if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['offset']) && $aCachedMailbox['OFFSET']) {
  162.         $aMailbox['OFFSET'] =  $aCachedMailbox['OFFSET'];
  163.         $aMailbox['PAGEOFFSET'] =  $aCachedMailbox['PAGEOFFSET'];
  164.     } else {
  165.         $aMailbox['OFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] -1 : 0;
  166.         $aMailbox['PAGEOFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] : 1;
  167.     }
  168.     /**
  169.      * Restore the number of messages in the result set
  170.      */
  171.     if (isset($aCachedMailbox['TOTAL'][$iSetIndx]) && $aCachedMailbox['TOTAL'][$iSetIndx]) {
  172.         $aMailbox['TOTAL'][$iSetIndx] =  $aCachedMailbox['TOTAL'][$iSetIndx];
  173.     }
  174.  
  175.     /**
  176.      * Restore the showall value no new showall value is provided.
  177.      */
  178.     if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['showall']) &&
  179.         isset($aCachedMailbox['SHOWALL'][$iSetIndx]) && $aCachedMailbox['SHOWALL'][$iSetIndx]) {
  180.         $aMailbox['SHOWALL'][$iSetIndx] =  $aCachedMailbox['SHOWALL'][$iSetIndx];
  181.     } else {
  182.         $aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ? 1 : 0;
  183.     }
  184.  
  185.     /**
  186.      * Restore the sort order if no new sort order is provided.
  187.      */
  188.     if (!isset($aProps[MBX_PREF_SORT]) && isset($aCachedMailbox['SORT'])) {
  189.         $aMailbox['SORT'] = $aCachedMailbox['SORT'];
  190.     } else {
  191.         $aMailbox['SORT'] =  (isset($aProps[MBX_PREF_SORT])) ? $aProps[MBX_PREF_SORT] : 0;
  192.     }
  193.  
  194.     /**
  195.      * Restore the number of message to show per page when no new limit is provided
  196.      */
  197.     if (!isset($aProps[MBX_PREF_LIMIT]) && isset($aCachedMailbox['LIMIT'])) {
  198.         $aMailbox['LIMIT'] = $aCachedMailbox['LIMIT'];
  199.     } else {
  200.         $aMailbox['LIMIT'] =  (isset($aProps[MBX_PREF_LIMIT])) ? $aProps[MBX_PREF_LIMIT] : 15;
  201.     }
  202.  
  203.     /**
  204.      * Restore the ordered columns to show when no new ordered columns are provided
  205.      */
  206.     if (!isset($aProps[MBX_PREF_COLUMNS]) && isset($aCachedMailbox['COLUMNS'])) {
  207.         $aMailbox['COLUMNS'] = $aCachedMailbox['COLUMNS'];
  208.     } else {
  209.         $aMailbox['COLUMNS'] =  (isset($aProps[MBX_PREF_COLUMNS])) ? $aProps[MBX_PREF_COLUMNS] :
  210.             array(SQM_COL_FLAGS,SQM_COL_FROM, SQM_COL_SUBJ, SQM_COL_FLAGS);
  211.     }
  212.  
  213.     /**
  214.      * Restore the headers we fetch the last time. Saves intitialisation stuff in read_body.
  215.      */
  216.     $aMailbox['FETCHHEADERS'] = (isset($aCachedMailbox['FETCHHEADERS'])) ? $aCachedMailbox['FETCHHEADERS'] : null;
  217.  
  218.     if (!isset($aProps[MBX_PREF_AUTO_EXPUNGE]) && isset($aCachedMailbox['AUTO_EXPUNGE'])) {
  219.         $aMailbox['AUTO_EXPUNGE'] = $aCachedMailbox['AUTO_EXPUNGE'];
  220.     } else {
  221.         $aMailbox['AUTO_EXPUNGE'] =  (isset($aProps[MBX_PREF_AUTO_EXPUNGE])) ? $aProps[MBX_PREF_AUTO_EXPUNGE] : false;
  222.     }
  223.     if (!isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx])) {
  224.         $aMailbox['SEARCH'][$iSetIndx] = $aCachedMailbox['SEARCH'][$iSetIndx];
  225.     } else if (isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
  226.         $aConfig['search'] != $aCachedMailbox['SEARCH'][$iSetIndx]) {
  227.         // reset the pageindex
  228.         $aMailbox['SEARCH'][$iSetIndx] = $aConfig['search'];
  229.         $aMailbox['OFFSET'] = 0;
  230.         $aMailbox['PAGEOFFSET'] = 1;
  231.     } else {
  232.         $aMailbox['SEARCH'][$iSetIndx] =  (isset($aConfig['search'])) ? $aConfig['search'] : 'ALL';
  233.     }
  234.     if (!isset($aConfig['charset']) && isset($aCachedMailbox['CHARSET'][$iSetIndx])) {
  235.         $aMailbox['CHARSET'][$iSetIndx] = $aCachedMailbox['CHARSET'][$iSetIndx];
  236.     } else {
  237.         $aMailbox['CHARSET'][$iSetIndx] =  (isset($aConfig['charset'])) ? $aConfig['charset'] : 'US-ASCII';
  238.     }
  239.  
  240.     $aMailbox['NAME'] = $mailbox;
  241.     $aMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
  242.     $aMailbox['SEEN'] = (isset($aMbxResponse['SEEN'])) ? $aMbxResponse['SEEN'] : $aMbxResponse['EXISTS'];
  243.     $aMailbox['RECENT'] = (isset($aMbxResponse['RECENT'])) ? $aMbxResponse['RECENT'] : 0;
  244.     $aMailbox['UIDVALIDITY'] = $aMbxResponse['UIDVALIDITY'];
  245.     $aMailbox['UIDNEXT'] = $aMbxResponse['UIDNEXT'];
  246.     $aMailbox['PERMANENTFLAGS'] = $aMbxResponse['PERMANENTFLAGS'];
  247.     $aMailbox['RIGHTS'] = $aMbxResponse['RIGHTS'];
  248.  
  249.     /* decide if we are thread sorting or not */
  250.     if ($aMailbox['SORT'] & SQSORT_THREAD) {
  251.         if (!sqimap_capability($imapConnection,'THREAD')) {
  252.             $aMailbox['SORT'] ^= SQSORT_THREAD;
  253.         } else {
  254.             $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT'];
  255.         }
  256.     } else {
  257.         $aMailbox['THREAD_INDENT'] = false;
  258.     }
  259.  
  260.     /* set a timestamp for cachecontrol */
  261.     $aMailbox['TIMESTAMP'] = time();
  262.     return $aMailbox;
  263. }
  264.  
  265. /**
  266.  * Fetch the message headers for a mailbox. Settings are part of the aMailbox
  267.  * array. Dependent of the mailbox settings it deals with sort, thread and search
  268.  * If server sort is supported then SORT is also used for retrieving sorted search results
  269.  *
  270.  * @param resource $imapConnection imap socket handle
  271.  * @param array    $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
  272.  * @return error   $error error number
  273.  * @since 1.5.1
  274.  * @author Marc Groot Koerkamp
  275.  */
  276. function fetchMessageHeaders($imapConnection, &$aMailbox) {
  277.  
  278.     /* FIX ME, this function is kind of big, maybe we can split it up in
  279.        a couple of functions. Make sure the functions are private and starts with _
  280.        Also make sure that the error codes are propagated */
  281.  
  282.     /**
  283.      * Retrieve the UIDSET.
  284.      * Setindex is used to be able to store multiple uid sets. That will make it
  285.      * possible to display the mailbox multiple times in different sort order
  286.      * or to store serach results separate from normal mailbox view.
  287.      */
  288.     $iSetIndx =  (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
  289.  
  290.     $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
  291.     /**
  292.      * Adjust the start_msg
  293.      */
  294.     $start_msg = $aMailbox['PAGEOFFSET'];
  295.     if($aMailbox['PAGEOFFSET'] > $aMailbox['EXISTS']) {
  296.         $start_msg -= $aMailbox['LIMIT'];
  297.         if($start_msg < 1) {
  298.             $start_msg = 1;
  299.         }
  300.     }
  301.  
  302.     if (is_array($aMailbox['UIDSET'])) {
  303.         $aUid =& $aMailbox['UIDSET'][$iSetIndx];
  304.     } else {
  305.         $aUid = false;
  306.     }
  307.     $aFetchHeaders = $aMailbox['FETCHHEADERS'];
  308.  
  309.     $iError = 0;
  310.     $aFetchItems = $aHeaderItems = array();
  311.     // initialize the fields we want to retrieve:
  312.     $aHeaderFields = array();
  313.     foreach ($aFetchHeaders as $v) {
  314.       switch ($v) {
  315.         case SQM_COL_DATE:       $aHeaderFields[] = 'Date';         break;
  316.         case SQM_COL_TO:         $aHeaderFields[] = 'To';           break;
  317.         case SQM_COL_CC:         $aHeaderFields[] = 'Cc';           break;
  318.         case SQM_COL_FROM:       $aHeaderFields[] = 'From';         break;
  319.         case SQM_COL_SUBJ:       $aHeaderFields[] = 'Subject';      break;
  320.         case SQM_COL_PRIO:       $aHeaderFields[] = 'X-Priority';   break;
  321.         case SQM_COL_ATTACHMENT: $aHeaderFields[] = 'Content-Type'; break;
  322.         case SQM_COL_INT_DATE:   $aFetchItems[]   = 'INTERNALDATE'; break;
  323.         case SQM_COL_FLAGS:      $aFetchItems[]   = 'FLAGS';        break;
  324.         case SQM_COL_SIZE:       $aFetchItems[]   = 'RFC822.SIZE';  break;
  325.         default: break;
  326.       }
  327.     }
  328.  
  329.     /**
  330.      * A uidset with sorted uid's is available. We can use the cache
  331.      */
  332.     if (isset($aUid) && $aUid ) {
  333.         // limit the cache to SQM_MAX_PAGES_IN_CACHE
  334.         if (!$aMailbox['SHOWALL'][$iSetIndx] && isset($aMailbox['MSG_HEADERS'])) {
  335.             $iMaxMsgs = $iLimit * SQM_MAX_PAGES_IN_CACHE;
  336.             $iCacheSize = count($aMailbox['MSG_HEADERS']);
  337.             if ($iCacheSize > $iMaxMsgs) {
  338.                 $iReduce = $iCacheSize - $iMaxMsgs;
  339.                 foreach ($aMailbox['MSG_HEADERS'] as $iUid => $value) {
  340.                     if ($iReduce) {
  341.                         unset($aMailbox['MSG_HEADERS'][$iUid]);
  342.                     } else {
  343.                         break;
  344.                     }
  345.                     --$iReduce;
  346.                 }
  347.             }
  348.         }
  349.  
  350.         $id_slice = array_slice($aUid,$start_msg-1,$iLimit);
  351.         /* do some funky cache checks */
  352.         if (isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) {
  353.             // temp code, read_body del / next links fo not update fields.
  354.             foreach ($aMailbox['MSG_HEADERS'] as $iUid => $aValue) {
  355.                 if (!isset($aValue['UID'])) {
  356.                     unset($aMailbox['MSG_HEADERS'][$iUid]);
  357.                 }
  358.             }
  359.             $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
  360.         } else {
  361.             $aMailbox['MSG_HEADERS'] = array();
  362.             $aUidCached = array();
  363.         }
  364.         $aUidNotCached = array_values(array_diff($id_slice,$aUidCached));
  365.  
  366.         /**
  367.          * $aUidNotCached contains an array with UID's which need to be fetched to
  368.          * complete the needed message headers.
  369.          */
  370.         if (count($aUidNotCached)) {
  371.             $aMsgs = sqimap_get_small_header_list($imapConnection,$aUidNotCached,
  372.                                                     $aHeaderFields,$aFetchItems);
  373.             // append the msgs to the existend headers
  374.             $aMailbox['MSG_HEADERS'] += $aMsgs;
  375.         }
  376.     } else {
  377.         /**
  378.          * Initialize the sorted UID list or initiate a UID list with search
  379.          * results and fetch the visible message headers
  380.          */
  381.  
  382.         if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') { // in case of a search request
  383.  
  384.             if ($aMailbox['SEARCH'][$iSetIndx] && $aMailbox['SORT'] == 0) {
  385.                 $aUid = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
  386.             } else {
  387.  
  388.                 $iError = 0;
  389.                 $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
  390.                 $aUid = $aMailbox['UIDSET'][$iSetIndx];
  391.             }
  392.             if (!$iError) {
  393.                 /**
  394.                  * Number of messages is the resultset
  395.                  */
  396.                 $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
  397.                 $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
  398.                 if (count($id_slice)) {
  399.                     $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
  400.                         $aHeaderFields,$aFetchItems);
  401.                 } else {
  402.                     $iError = 1; // FIX ME, define an error code
  403.                 }
  404.             }
  405.         } else { //
  406.             $iError = 0;
  407.             $iError = _get_sorted_msgs_list($imapConnection,$aMailbox,$iError);
  408.             $aUid = $aMailbox['UIDSET'][$iSetIndx];
  409.  
  410.             if (!$iError) {
  411.                 /**
  412.                  * Number of messages is the resultset
  413.                  */
  414.                 $aMailbox['TOTAL'][$iSetIndx] = count($aUid);
  415.                 $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
  416.                 if (count($id_slice)) {
  417.                     $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
  418.                         $aHeaderFields,$aFetchItems);
  419.                 } else {
  420.                     $iError = 1; // FIX ME, define an error code
  421.                 }
  422.             }
  423.         }
  424.     }
  425.     return $iError;
  426. }
  427.  
  428. /**
  429.  * Prepares the message headers for display inside a template. The links are calculated,
  430.  * color for row highlighting is calculated and optionally the strings are truncated.
  431.  *
  432.  * @param array    $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
  433.  * @param array    $aProps properties
  434.  * @return array   $aFormattedMessages array with message headers and format info
  435.  * @since 1.5.1
  436.  * @author Marc Groot Koerkamp
  437.  */
  438. function prepareMessageList(&$aMailbox, $aProps) {
  439.  
  440.     /* Globalize link attributes so plugins can share in modifying them */
  441.     global $link, $title, $target, $onclick, $link_extra, $preselected;
  442.  
  443.     /* retrieve the properties */
  444.     $my_email_address = (isset($aProps['email'])) ? $aProps['email'] : false;
  445.     $highlight_list   = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
  446.     $aColumnDesc      = (isset($aProps['columns'])) ? $aProps['columns'] : false;
  447.     $aExtraColumns    = (isset($aProps['extra_columns'])) ? $aProps['extra_columns'] : array();
  448.     $iAccount         = (isset($aProps['account'])) ? (int) $aProps['account'] : 0;
  449.     $sMailbox         = (isset($aProps['mailbox'])) ? $aProps['mailbox'] : false;
  450.     $sTargetModule    = (isset($aProps['module'])) ? $aProps['module'] : 'read_body';
  451.  
  452.     /*
  453.      * TODO 1, retrieve array with identity email addresses in order to match against to,cc and set a flag
  454.      * $aFormattedMessages[$iUid]['match_identity'] = true
  455.      * The template can show some image if there is a match.
  456.      * TODO 2, makes sure the matching is done fast by doing a strpos call on the returned $value
  457.      */
  458.  
  459.     /**
  460.      * Only retrieve values for displayable columns
  461.      */
  462.     foreach ($aColumnDesc as $k => $v) {
  463.         switch ($k) {
  464.           case SQM_COL_FROM:       $aCol[SQM_COL_FROM]       = 'from';         break;
  465.           case SQM_COL_DATE:       $aCol[SQM_COL_DATE]       = 'date';         break;
  466.           case SQM_COL_SUBJ:       $aCol[SQM_COL_SUBJ]       = 'subject';      break;
  467.           case SQM_COL_FLAGS:      $aCol[SQM_COL_FLAGS]      = 'FLAGS';        break;
  468.           case SQM_COL_SIZE:       $aCol[SQM_COL_SIZE]       = 'SIZE';         break;
  469.           case SQM_COL_PRIO:       $aCol[SQM_COL_PRIO]       = 'x-priority';   break;
  470.           case SQM_COL_ATTACHMENT: $aCol[SQM_COL_ATTACHMENT] = 'content-type'; break;
  471.           case SQM_COL_INT_DATE:   $aCol[SQM_COL_INT_DATE]   = 'INTERNALDATE'; break;
  472.           case SQM_COL_TO:         $aCol[SQM_COL_TO]         = 'to';           break;
  473.           case SQM_COL_CC:         $aCol[SQM_COL_CC]         = 'cc';           break;
  474.           case SQM_COL_BCC:        $aCol[SQM_COL_BCC]        = 'bcc';          break;
  475.           default: break;
  476.         }
  477.     }
  478.     $aExtraHighLightColumns = array();
  479.     foreach ($aExtraColumns as $v) {
  480.         switch ($v) {
  481.           case SQM_COL_FROM:       $aExtraHighLightColumns[] = 'from';         break;
  482.           case SQM_COL_SUBJ:       $aExtraHighLightColumns[] = 'subject';      break;
  483.           case SQM_COL_TO:         $aExtraHighLightColumns[] = 'to';           break;
  484.           case SQM_COL_CC:         $aExtraHighLightColumns[] = 'cc';           break;
  485.           case SQM_COL_BCC:        $aExtraHighLightColumns[] = 'bcc';          break;
  486.           default: break;
  487.         }
  488.     }
  489.     $aFormattedMessages = array();
  490.  
  491.  
  492.     $iSetIndx    =  $aMailbox['SETINDEX'];
  493.     $aId         =  $aMailbox['UIDSET'][$iSetIndx];
  494.     $aHeaders    =& $aMailbox['MSG_HEADERS']; /* use a reference to avoid a copy.
  495.                                                  MSG_HEADERS can contain large amounts of data */
  496.     $iOffset     =  $aMailbox['OFFSET'];
  497.     $sort        =  $aMailbox['SORT'];
  498.     $iPageOffset =  $aMailbox['PAGEOFFSET'];
  499.     $sMailbox    =  $aMailbox['NAME'];
  500.     $sSearch     =  (isset($aMailbox['SEARCH'][$aMailbox['SETINDEX']]) &&
  501.                     $aMailbox['SEARCH'][$aMailbox['SETINDEX']] != 'ALL') ? $aMailbox['SEARCH'][$aMailbox['SETINDEX']] : false;
  502.     $aSearch     =  ($sSearch) ? array('search.php',$aMailbox['SETINDEX']) : null;
  503.     /* avoid improper usage */
  504.     if ($sMailbox && isset($iAccount) && $sTargetModule) {
  505.         $aInitQuery  = array("account=$iAccount",'mailbox='.urlencode($sMailbox));
  506.     } else {
  507.         $aInitQuery = false;
  508.     }
  509.  
  510.     if ($aMailbox['SORT'] & SQSORT_THREAD) {
  511.         $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']];
  512.         $bThread = true;
  513.     } else {
  514.         $bThread = false;
  515.     }
  516.     /*
  517.      * Retrieve value for checkbox column
  518.      */
  519.     if (!sqgetGlobalVar('checkall',$checkall,SQ_GET)) {
  520.         $checkall = false;
  521.     }
  522.  
  523.     /*
  524.      * Loop through and display the info for each message.
  525.      */
  526.     $iEnd = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $iOffset + $aMailbox['LIMIT'];
  527.     for ($i=$iOffset,$t=0;$i<$iEnd;++$i) {
  528.         if (isset($aId[$i])) {
  529.  
  530.             $bHighLight = false;
  531.             $value = $title = $link = $target = $onclick = $link_extra = '';
  532.             $aQuery = ($aInitQuery !== false) ? $aInitQuery : false;
  533.             $aMsg = $aHeaders[$aId[$i]];
  534.             if (isset($aSearch) && count($aSearch) > 1 && $aQuery) {
  535.                 $aQuery[] = "where=". $aSearch[0];
  536.                 $aQuery[] = "what=" . $aSearch[1];
  537.             }
  538.             $iUid      = (isset($aMsg['UID'])) ? $aMsg['UID'] : $aId[$i];
  539.             if ($aQuery) {
  540.                 $aQuery[] = "passed_id=$aId[$i]";
  541.                 $aQuery[] = "startMessage=$iPageOffset";
  542.             }
  543.  
  544.             foreach ($aCol as $k => $v) {
  545.                 $title = $link = $target = $onclick = $link_extra = '';
  546.                 $aColumns[$k] = array();
  547.                 $value = (isset($aMsg[$v]))  ? $aMsg[$v]  : '';
  548.                 $sUnknown = _("Unknown recipient");
  549.                 switch ($k) {
  550.                 case SQM_COL_FROM:
  551.                     $sUnknown = _("Unknown sender");
  552.                 case SQM_COL_TO:
  553.                 case SQM_COL_CC:
  554.                 case SQM_COL_BCC:
  555.                     $sTmp = false;
  556.                     if ($value) {
  557.                         if ($highlight_list && !$bHighLight) {
  558.                             $bHighLight = highlightMessage($aCol[$k], $value, $highlight_list,$aFormattedMessages[$iUid]);
  559.                         }
  560.                         $aAddressList = parseRFC822Address($value);
  561.                         $sTmp = getAddressString($aAddressList,array('best' => true));
  562.                         $title = $title_maybe = '';
  563.                         foreach ($aAddressList as $aAddr) {
  564.                             $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL])) ? $aAddr[SQM_ADDR_PERSONAL] : '';
  565.                             $sMailbox  = (isset($aAddr[SQM_ADDR_MAILBOX]))  ? $aAddr[SQM_ADDR_MAILBOX]  : '';
  566.                             $sHost     = (isset($aAddr[SQM_ADDR_HOST]))     ? $aAddr[SQM_ADDR_HOST]     : '';
  567.                             if ($sPersonal) {
  568.                                 $title .= sm_encode_html_special_chars($sMailbox.'@'.$sHost).', ';
  569.                             } else {
  570.                                 // if $value gets truncated we need to add the addresses with no
  571.                                 // personal name as well
  572.                                 $title_maybe .= sm_encode_html_special_chars($sMailbox.'@'.$sHost).', ';
  573.                             }
  574.                         }
  575.                         if ($title) {
  576.                             $title = substr($title,0,-2); // strip ', ';
  577.                         }
  578.                         $sTmp = decodeHeader($sTmp);
  579.                         if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
  580.                             $sTrunc = sm_truncate_string($sTmp, $aColumnDesc[$k]['truncate'], '...', TRUE);
  581.                             if ($sTrunc != $sTmp) {
  582.                                 if (!$title) {
  583.                                     $title = $sTmp;
  584.                                 } else if ($title_maybe) {
  585.                                     $title = $title .', '.$title_maybe;
  586.                                     $title = substr($title,0,-2); // strip ', ';
  587.                                 }
  588.                             }
  589.                             $sTmp = $sTrunc;
  590.                         }
  591.                     }
  592.                     $value = ($sTmp) ? (substr($sTmp, 0, 6) == '&quot;' && substr($sTmp, -6) == '&quot;' ? substr(substr($sTmp, 0, -6), 6) : $sTmp) : $sUnknown;
  593.                     break;
  594.                 case SQM_COL_SUBJ:
  595.                     // subject is mime encoded, decode it.
  596.                     // value is sanitized in decoding function.
  597.                     // TODO, verify if it should be done before or after the highlighting
  598.                     $value=decodeHeader($value);
  599.                     if ($highlight_list && !$bHighLight) {
  600.                         $bHighLight = highlightMessage('SUBJECT', $value, $highlight_list, $aFormattedMessages[$iUid]);
  601.                     }
  602.                     $iIndent = (isset($aIndentArray[$aId[$i]])) ? $aIndentArray[$aId[$i]] : 0;
  603.                     // FIXME: don't break 8bit symbols and html entities during truncation
  604.                     if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
  605.                         $sTmp = sm_truncate_string($value, $aColumnDesc[$k]['truncate']-$iIndent, '...', TRUE);
  606.                         // drop any double spaces since these will be displayed in the title
  607.                         // Nah, it's nice to always have a roll-over
  608.                         //$title = ($sTmp != $value) ? preg_replace('/\s{2,}/', ' ', $value) : '';
  609.                         $title = preg_replace('/\s{2,}/', ' ', $value);
  610.                         $value = $sTmp;
  611.                     }
  612.                     /* generate the link to the message */
  613.                     if ($aQuery) {
  614.                         // TODO, $sTargetModule should be a query parameter so that we can use a single entrypoint
  615.                         $link = $sTargetModule.'.php?' . implode('&amp;',$aQuery);
  616.  
  617.                         // see top of this function for which attributes are available
  618.                         // in the global scope for plugin use (like $link, $target,
  619.                         // $onclick, $link_extra, $title, and so forth)
  620.                         // plugins are responsible for sharing nicely (such as for
  621.                         // setting the target, etc)
  622.                         $temp = array(&$iPageOffset, &$sSearch, &$aSearch, $aMsg);
  623.                         do_hook('subject_link', $temp);
  624.                     }
  625.                     $value = (trim($value)) ? $value : _("(no subject)");
  626.                     /* add thread indentation */
  627.                     $aColumns[$k]['indent']  = $iIndent;
  628.                     break;
  629.                 case SQM_COL_SIZE:
  630.                     $value = show_readable_size($value);
  631.                     break;
  632.                 case SQM_COL_DATE:
  633.                 case SQM_COL_INT_DATE:
  634.                     $value = getTimeStamp(explode(' ',trim($value)));
  635.                     $title = getDateString($value, TRUE);
  636.                     $value = getDateString($value);
  637.                     break;
  638.                 case SQM_COL_FLAGS:
  639.                     $aFlagColumn = array('seen' => false,
  640.                                          'deleted'=>false,
  641.                                          'answered'=>false,
  642.                                          'forwarded'=>false,
  643.                                          'flagged' => false,
  644.                                          'draft' => false);
  645.  
  646.                     if(!is_array($value)) $value = array();
  647.                     foreach ($value as $sFlag => $v) {
  648.                         switch ($sFlag) {
  649.                           case '\\seen'    : $aFlagColumn['seen']      = true; break;
  650.                           case '\\deleted' : $aFlagColumn['deleted']   = true; break;
  651.                           case '\\answered': $aFlagColumn['answered']  = true; break;
  652.                           case '$forwarded': $aFlagColumn['forwarded'] = true; break;
  653.                           case '\\flagged' : $aFlagColumn['flagged']   = true; break;
  654.                           case '\\draft'   : $aFlagColumn['draft']     = true; break;
  655.                           default:  break;
  656.                         }
  657.                     }
  658.                     $value = $aFlagColumn;
  659.                     break;
  660.                 case SQM_COL_PRIO:
  661.                     $value = ($value) ? (int) $value : 3;
  662.                     break;
  663.                 case SQM_COL_ATTACHMENT:
  664.                     $value = (is_array($value) && $value[0] == 'multipart' && $value[1] == 'mixed') ? true : false;
  665.                     break;
  666.                 case SQM_COL_CHECK:
  667.                     $value = ($checkall || in_array($iUid, $preselected));
  668.                     break;
  669.                 default : break;
  670.                 }
  671.                 if ($title)      { $aColumns[$k]['title']      = $title;      }
  672.                 if ($link)       { $aColumns[$k]['link']       = $link;       }
  673.                 if ($link_extra) { $aColumns[$k]['link_extra'] = $link_extra; }
  674.                 if ($onclick)    { $aColumns[$k]['onclick']    = $onclick;    }
  675.                 if ($target)     { $aColumns[$k]['target']     = $target;     }
  676.                 $aColumns[$k]['value']  = $value;
  677.             }
  678.             /* columns which will not be displayed but should be inspected
  679.                because the highlight list contains rules with those columns */
  680.             foreach ($aExtraHighLightColumns as $v) {
  681.                 if ($highlight_list && !$bHighLight && isset($aMsg[$v])) {
  682.                     $bHighLight = highlightMessage($v, $aMsg[$v], $highlight_list,$aFormattedMessages[$iUid]);
  683.                 }
  684.             }
  685.             $aFormattedMessages[$iUid]['columns'] = $aColumns;
  686.  
  687.         } else {
  688.             break;
  689.         }
  690.     }
  691.     return $aFormattedMessages;
  692. }
  693.  
  694.  
  695. /**
  696.  * Sets the row color if the provided column value pair  matches a hightlight rule
  697.  *
  698.  * @param string   $sCol column name
  699.  * @param string   $sVal column value
  700.  * @param array    $highlight_list highlight rules
  701.  * @param array    $aFormat (reference) array where row color info is stored
  702.  * @return bool     match found
  703.  * @since 1.5.1
  704.  * @author Marc Groot Koerkamp
  705.  */
  706. function highlightMessage($sCol, $sVal, $highlight_list, &$aFormat) {
  707.     if (!is_array($highlight_list) && count($highlight_list) == 0) {
  708.         return false;
  709.     }
  710.     $hlt_color = false;
  711.     $sCol = strtoupper($sCol);
  712.  
  713.     foreach ($highlight_list as $highlight_list_part) {
  714.         if (trim($highlight_list_part['value'])) {
  715.             $high_val   = strtolower($highlight_list_part['value']);
  716.             $match_type = strtoupper($highlight_list_part['match_type']);
  717.             if($match_type == 'TO_CC') {
  718.                 if ($sCol == 'TO' || $sCol == 'CC') {
  719.                     $match_type = $sCol;
  720.                 } else {
  721.                     continue;
  722.                 }
  723.             } else {
  724.                 if ($match_type != $sCol) {
  725.                     continue;
  726.                 }
  727.             }
  728.             if (strpos(strtolower($sVal),$high_val) !== false) {
  729.                  $hlt_color = $highlight_list_part['color'];
  730.                  break;
  731.             }
  732.         }
  733.     }
  734.     if ($hlt_color) {
  735.         // Bug in highlight color???
  736.         if ($hlt_color{0} != '#') {
  737.             $hlt_color = '#'. $hlt_color;
  738.         }
  739.         $aFormat['row']['color'] = $hlt_color;
  740.         return true;
  741.     } else {
  742.         return false;
  743.     }
  744. }
  745.  
  746. function setUserPref($username, $pref, $value) {
  747.     global $data_dir;
  748.     setPref($data_dir,$username,$pref,$value);
  749. }
  750.  
  751. /**
  752.  * Execute the sorting for a mailbox
  753.  *
  754.  * @param  resource $imapConnection Imap connection
  755.  * @param  array    $aMailbox (reference) Mailbox retrieved with sqm_api_mailbox_select
  756.  * @return int      $error (reference) Error number
  757.  * @private
  758.  * @since 1.5.1
  759.  * @author Marc Groot Koerkamp
  760.  */
  761. function _get_sorted_msgs_list($imapConnection,&$aMailbox) {
  762.     $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
  763.     $bDirection = !($aMailbox['SORT'] % 2);
  764.     $error = 0;
  765.     if (!$aMailbox['SEARCH'][$iSetIndx]) {
  766.         $aMailbox['SEARCH'][$iSetIndx] = 'ALL';
  767.     }
  768.     if (($aMailbox['SORT'] & SQSORT_THREAD) && sqimap_capability($imapConnection,'THREAD')) {
  769.         $aRes = get_thread_sort($imapConnection,$aMailbox['SEARCH'][$iSetIndx]);
  770.         if ($aRes === false) {
  771.             $aMailbox['SORT'] -= SQSORT_THREAD;
  772.             $error = 1; // fix me, define an error code;
  773.         } else {
  774.             $aMailbox['UIDSET'][$iSetIndx] = $aRes[0];
  775.             $aMailbox['THREAD_INDENT'][$iSetIndx] = $aRes[1];
  776.         }
  777.     } else if ($aMailbox['SORT'] === SQSORT_NONE) {
  778.         $id = sqimap_run_search($imapConnection, 'ALL' , '');
  779.         if ($id === false) {
  780.             $error = 1; // fix me, define an error code
  781.         } else {
  782.             $aMailbox['UIDSET'][$iSetIndx] = array_reverse($id);
  783.             $aMailbox['TOTAL'][$iSetIndx] = $aMailbox['EXISTS'];
  784.         }
  785.     } else {
  786.         if (sqimap_capability($imapConnection,'SORT')) {
  787.              $sSortField = _getSortField($aMailbox['SORT'],true);
  788.              $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection, $aMailbox['SEARCH'][$iSetIndx]);
  789.              if ($id === false) {
  790.                  $error = 1; // fix me, define an error code
  791.              } else {
  792.                 $aMailbox['UIDSET'][$iSetIndx] = $id;
  793.              }
  794.         } else {
  795.              $id = NULL;
  796.              if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') {
  797.                 $id = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
  798.              }
  799.              $sSortField = _getSortField($aMailbox['SORT'],false);
  800.              $aMailbox['UIDSET'][$iSetIndx] = get_squirrel_sort($imapConnection, $sSortField, $bDirection, $id);
  801.         }
  802.     }
  803.     return $error;
  804. }
  805.  
  806. /**
  807.  * Does the $srt $_GET var to field mapping
  808.  *
  809.  * @param int $srt Field to sort on
  810.  * @param bool $bServerSort Server sorting is true
  811.  * @return string $sSortField Field to sort on
  812.  * @since 1.5.1
  813.  * @private
  814.  */
  815. function _getSortField($sort,$bServerSort) {
  816.     switch($sort) {
  817.         case SQSORT_NONE:
  818.             $sSortField = 'UID';
  819.             break;
  820.         case SQSORT_DATE_ASC:
  821.         case SQSORT_DATE_DESC:
  822.             $sSortField = 'DATE';
  823.             break;
  824.         case SQSORT_FROM_ASC:
  825.         case SQSORT_FROM_DESC:
  826.             $sSortField = 'FROM';
  827.             break;
  828.         case SQSORT_SUBJ_ASC:
  829.         case SQSORT_SUBJ_DESC:
  830.             $sSortField = 'SUBJECT';
  831.             break;
  832.         case SQSORT_SIZE_ASC:
  833.         case SQSORT_SIZE_DESC:
  834.             $sSortField = ($bServerSort) ? 'SIZE' : 'RFC822.SIZE';
  835.             break;
  836.         case SQSORT_TO_ASC:
  837.         case SQSORT_TO_DESC:
  838.             $sSortField = 'TO';
  839.             break;
  840.         case SQSORT_CC_ASC:
  841.         case SQSORT_CC_DESC:
  842.             $sSortField = 'CC';
  843.             break;
  844.         case SQSORT_INT_DATE_ASC:
  845.         case SQSORT_INT_DATE_DESC:
  846.             $sSortField = ($bServerSort) ? 'ARRIVAL' : 'INTERNALDATE';
  847.             break;
  848.         case SQSORT_THREAD:
  849.             break;
  850.         default: $sSortField = 'UID';
  851.             break;
  852.  
  853.     }
  854.     return $sSortField;
  855. }
  856.  
  857. /**
  858.  * This function is a utility function for setting which headers should be
  859.  * fetched. It takes into account the highlight list which requires extra
  860.  * headers to be fetch in order to make those rules work. It's called before
  861.  * the headers are fetched which happens in showMessagesForMailbox and when
  862.  * the next and prev links in read_body.php are used.
  863.  *
  864.  * @param array    $aMailbox associative array with mailbox related vars
  865.  * @param array    $aProps 
  866.  * @return void 
  867.  * @since 1.5.1
  868.  */
  869.  
  870. function calcFetchColumns(&$aMailbox, &$aProps) {
  871.  
  872.     $highlight_list    = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
  873.     $aColumnsDesc      = (isset($aProps['columns'])) ? $aProps['columns'] : false;
  874.  
  875.     $aFetchColumns = $aColumnsDesc;
  876.     if (isset($aFetchColumns[SQM_COL_CHECK])) {
  877.         unset($aFetchColumns[SQM_COL_CHECK]);
  878.     }
  879.  
  880.     /*
  881.      * Before we fetch the message headers, check if we need to fetch extra columns
  882.      * to make the message highlighting work
  883.      */
  884.     if (is_array($highlight_list) && count($highlight_list)) {
  885.         $aHighlightColumns = array();
  886.         foreach ($highlight_list as $highlight_list_part) {
  887.             if (trim($highlight_list_part['value'])) {
  888.                 $match_type = strtoupper($highlight_list_part['match_type']);
  889.                 switch ($match_type) {
  890.                     case 'TO_CC':
  891.                         $aHighlightColumns[SQM_COL_TO] = true;
  892.                         $aHighlightColumns[SQM_COL_CC] = true;
  893.                         break;
  894.                     case 'TO':     $aHighlightColumns[SQM_COL_TO] = true; break;
  895.                     case 'CC':     $aHighlightColumns[SQM_COL_CC] = true; break;
  896.                     case 'FROM':   $aHighlightColumns[SQM_COL_FROM] = true; break;
  897.                     case 'SUBJECT':$aHighlightColumns[SQM_COL_SUBJ] = true; break;
  898.                 }
  899.             }
  900.         }
  901.         $aExtraColumns = array();
  902.         foreach ($aHighlightColumns as $k => $v) {
  903.             if (!isset($aFetchColumns[$k])) {
  904.                 $aExtraColumns[]  = $k;
  905.                 $aFetchColumns[$k] = true;
  906.             }
  907.         }
  908.         if (count($aExtraColumns)) {
  909.             $aProps['extra_columns'] = $aExtraColumns;
  910.         }
  911.     }
  912.     $aMailbox['FETCHHEADERS'] =  array_keys($aFetchColumns);
  913. }
  914.  
  915.  
  916. /**
  917.  * This function loops through a group of messages in the mailbox
  918.  * and shows them to the user.
  919.  *
  920.  * @param resource $imapConnection 
  921.  * @param array    $aMailbox associative array with mailbox related vars
  922.  * @param array    $aProps 
  923.  * @param int      $iError error code, 0 is no error
  924.  */
  925. function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
  926.     global $PHP_SELF;
  927.     global $boxes, $show_copy_buttons;
  928.  
  929.     $highlight_list    = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
  930.     $fancy_index_highlite = (isset($aProps['config']['fancy_index_highlite'])) ? $aProps['config']['fancy_index_highlite'] : true;
  931.     $aColumnsDesc      = (isset($aProps['columns'])) ? $aProps['columns'] : false;
  932.     $iAccount          = (isset($aProps['account'])) ? (int) $aProps['account'] : 0;
  933.     $sMailbox          = (isset($aProps['mailbox'])) ? $aProps['mailbox'] : false;
  934.     $sTargetModule     = (isset($aProps['module'])) ? $aProps['module'] : 'read_body';
  935.     $show_flag_buttons = (isset($aProps['config']['show_flag_buttons'])) ? $aProps['config']['show_flag_buttons'] : true;
  936.  
  937.     /* allows to control copy button in function call. If array key is not set, code follows user preferences */
  938.     if (isset($aProps['config']['show_copy_buttons']))
  939.         $show_copy_buttons = $aProps['config']['show_copy_buttons'];
  940.  
  941.     $lastTargetMailbox = (isset($aProps['config']['lastTargetMailbox'])) ? $aProps['config']['lastTargetMailbox'] : '';
  942.     $aOrder = array_keys($aProps['columns']);
  943.     $trash_folder      = (isset($aProps['config']['trash_folder']) && $aProps['config']['trash_folder'])
  944.                           ? $aProps['config']['trash_folder'] : false;
  945.     $sent_folder       = (isset($aProps['config']['sent_folder']) && $aProps['config']['sent_folder'])
  946.                           ? $aProps['config']['sent_folder'] : false;
  947.     $draft_folder      = (isset($aProps['config']['draft_folder']) && $aProps['config']['draft_folder'])
  948.                           ? $aProps['config']['draft_folder'] : false;
  949.     $page_selector     = (isset($aProps['config']['page_selector'])) ? $aProps['config']['page_selector'] : false;
  950.     $page_selector_max = (isset($aProps['config']['page_selector_max'])) ? $aProps['config']['page_selector_max'] : 10;
  951.     $color             = $aProps['config']['color'];
  952.  
  953.  
  954.     /*
  955.      * Form ID
  956.      */
  957.     static $iFormId;
  958.  
  959.     if (!isset($iFormId)) {
  960.         $iFormId=1;
  961.     } else {
  962.         ++$iFormId;
  963.     }
  964.     // store the columns to fetch so we can pick them up in read_body
  965.     // where we validate the cache.
  966.     calcFetchColumns($aMailbox  ,$aProps);
  967.  
  968.     $iError = fetchMessageHeaders($imapConnection, $aMailbox);
  969.     if ($iError) {
  970.         return array();
  971.     } else {
  972.         $aMessages = prepareMessageList($aMailbox, $aProps);
  973.     }
  974.  
  975.     $iSetIndx = $aMailbox['SETINDEX'];
  976.     $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
  977.     $iEnd = ($aMailbox['PAGEOFFSET'] + ($iLimit - 1) < $aMailbox['EXISTS']) ?
  978.              $aMailbox['PAGEOFFSET'] + $iLimit - 1 : $aMailbox['EXISTS'];
  979.  
  980.     $iNumberOfMessages = $aMailbox['TOTAL'][$iSetIndx];
  981.     $iEnd = min ( $iEnd, $iNumberOfMessages );
  982.  
  983.     $php_self = $PHP_SELF;
  984.  
  985.     $urlMailbox = urlencode($aMailbox['NAME']);
  986.  
  987.     if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
  988.         $source_url = $regs[1];
  989.     } else {
  990.         $source_url = $php_self;
  991.     }
  992.  
  993.     $baseurl = $source_url.'?mailbox=' . urlencode($aMailbox['NAME']) .'&amp;account='.$aMailbox['ACCOUNT'] . (strpos($source_url, 'src/search.php') ? '&amp;smtoken=' . sm_generate_security_token() : '');
  994.     $where = urlencode($aMailbox['SEARCH'][$iSetIndx][0]);
  995.     $what = urlencode($aMailbox['SEARCH'][$iSetIndx][1]);
  996.     $baseurl .= '&amp;where=' . $where .  '&amp;what=' .  $what;
  997.  
  998.     /* build thread sorting links */
  999.     $newsort = $aMailbox['SORT'];
  1000.     if (sqimap_capability($imapConnection,'THREAD')) {
  1001.         if ($aMailbox['SORT'] & SQSORT_THREAD) {
  1002.             $newsort -= SQSORT_THREAD;
  1003.             $thread_name = _("Unthread View");
  1004.         } else {
  1005.             $thread_name = _("Thread View");
  1006.             $newsort = $aMailbox['SORT'] + SQSORT_THREAD;
  1007.         }
  1008.         $thread_link_uri = $baseurl . '&amp;srt=' . $newsort 
  1009.                          . '&amp;startMessage=1';
  1010.     } else {
  1011.         $thread_link_uri ='';
  1012.         $thread_name = '';
  1013.     }
  1014.     $sort = $aMailbox['SORT'];
  1015.  
  1016.     /* FIX ME ADD CHECKBOX CONTROL. No checkbox => no buttons */
  1017.  
  1018.  
  1019.  
  1020.     /* future admin control over displayable buttons */
  1021.     $aAdminControl = array(
  1022.                            'markFlagged'   => 1,
  1023.                            'markUnflagged' => 1,
  1024.                            'markRead'      => 1,
  1025.                            'markUnread'    => 1,
  1026.                            'forward'       => 1,
  1027.                            'delete'        => 1,
  1028.                            'undeleteButton'=> 1,
  1029.                            'bypass_trash'  => 1,
  1030.                            'expungeButton' => 1,
  1031.                            'moveButton'    => 1,
  1032.                            'copyButton'    => 1
  1033.                            );
  1034.  
  1035.     /* user prefs control */
  1036.     $aUserControl = array (
  1037.  
  1038.                            'markFlagged'   => $show_flag_buttons,
  1039.                            'markUnflagged' => $show_flag_buttons,
  1040.                            'markRead'      => 1,
  1041.                            'markUnread'    => 1,
  1042.                            'forward'       => 1,
  1043.                            'delete'        => 1,
  1044.                            'undeleteButton'=> 1,
  1045.                            'bypass_trash'  => 1,
  1046.                            'expungeButton' => 1,
  1047.                            'moveButton'    => 1,
  1048.                            'copyButton'    => $show_copy_buttons
  1049.  
  1050.                           );
  1051.  
  1052.     $showDelete = ($aMailbox['RIGHTS'] != 'READ-ONLY' &&
  1053.                    in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ? true : false;
  1054.     $showByPassTrash = (($aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
  1055.                    in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) &&
  1056.                    $trash_folder) ? true : false; //
  1057.  
  1058.     $showUndelete = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
  1059.                    in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true) /* trash folder unrelated methinks: && !$trash_folder*/) ? true : false;
  1060.     $showMove   = ($aMailbox['RIGHTS'] != 'READ-ONLY') ? true : false;
  1061.     $showExpunge = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' &&
  1062.                    in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ? true : false;
  1063.  
  1064.     /* Button options that depend on IMAP server and selected folder */
  1065.     $aImapControl = array (
  1066.                            'markUnflagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true),
  1067.                            'markFlagged'   => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true),
  1068.                            'markRead'      => in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true),
  1069.                            'markUnread'    => in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true),
  1070.                            'forward'       => 1,
  1071.                            'delete'        => $showDelete,
  1072.                            'undeleteButton'=> $showUndelete,
  1073.                            'bypass_trash'  => $showByPassTrash,
  1074.                            'expungeButton' => $showExpunge,
  1075.                            'moveButton'    => $showMove,
  1076.                            'copyButton'    => 1
  1077.                           );
  1078.     /* Button strings */
  1079.     $aButtonStrings = array(
  1080.                            'markFlagged'    => _("Flag"),
  1081.                            'markUnflagged'  => _("Unflag"),
  1082.                            'markRead'       => _("Read"),
  1083.                            'markUnread'     => _("Unread"),
  1084.                            'forward'        => _("Forward"),
  1085.                            'delete'         => _("Delete"),
  1086.                            'undeleteButton' => _("Undelete"),
  1087.                            'bypass_trash'   => _("Bypass Trash"),
  1088.                            'expungeButton'  => _("Expunge"),
  1089.                            'moveButton'     => _("Move"),
  1090.                            'copyButton'     => _("Copy")
  1091.                            );
  1092.     /* Button access keys */
  1093.     global $accesskey_mailbox_flag, $accesskey_mailbox_unflag,
  1094.            $accesskey_mailbox_read, $accesskey_mailbox_unread,
  1095.            $accesskey_mailbox_forward, $accesskey_mailbox_delete,
  1096.            $accesskey_mailbox_undelete, $accesskey_mailbox_bypass_trash,
  1097.            $accesskey_mailbox_expunge, $accesskey_mailbox_move,
  1098.            $accesskey_mailbox_copy, $accesskey_mailbox_move_to;
  1099.     $aButtonAccessKeys = array(
  1100.                            'markFlagged'    => $accesskey_mailbox_flag,
  1101.                            'markUnflagged'  => $accesskey_mailbox_unflag,
  1102.                            'markRead'       => $accesskey_mailbox_read,
  1103.                            'markUnread'     => $accesskey_mailbox_unread,
  1104.                            'forward'        => $accesskey_mailbox_forward,
  1105.                            'delete'         => $accesskey_mailbox_delete,
  1106.                            'undeleteButton' => $accesskey_mailbox_undelete,
  1107.                            'bypass_trash'   => $accesskey_mailbox_bypass_trash,
  1108.                            'expungeButton'  => $accesskey_mailbox_expunge,
  1109.                            'moveButton'     => $accesskey_mailbox_move,
  1110.                            'copyButton'     => $accesskey_mailbox_copy,
  1111.                            );
  1112.  
  1113.  
  1114.     /**
  1115.      * Register buttons in order to an array
  1116.      * The key is the "name", the first element of the value array is the "value", second argument is the type.
  1117.      */
  1118.     $aFormElements = array();
  1119.     foreach($aAdminControl as $k => $v) {
  1120.         if ($v & $aUserControl[$k] & $aImapControl[$k]) {
  1121.             switch ($k) {
  1122.               case 'markFlagged':
  1123.               case 'markUnflagged':
  1124.               case 'markRead':
  1125.               case 'markUnread':
  1126.               case 'delete':
  1127.               case 'undeleteButton':
  1128.               case 'expungeButton':
  1129.               case 'forward':
  1130.                 $aFormElements[$k] 
  1131.                     = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
  1132.                 break;
  1133.               case 'bypass_trash':
  1134.                 $aFormElements[$k] 
  1135.                     = array('value' => $aButtonStrings[$k], 'type' => 'checkbox', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
  1136.                 break;
  1137.               case 'moveButton':
  1138.               case 'copyButton':
  1139.                 $aFormElements['targetMailbox']
  1140.                     = array('options_list' => sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes),
  1141.                             'type' => 'select',
  1142.                             'accesskey' => $accesskey_mailbox_move_to);
  1143.                 $aFormElements['mailbox']       
  1144.                     = array('value' => $aMailbox['NAME'], 'type' => 'hidden');
  1145.                 $aFormElements['startMessage']  
  1146.                     = array('value' => $aMailbox['PAGEOFFSET'], 'type' => 'hidden');
  1147.                 $aFormElements[$k]              
  1148.                     = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE'));
  1149.                 break;
  1150.             }
  1151.         }
  1152.         $aFormElements['account']  = array('value' => $iAccount,'type' => 'hidden');
  1153.     }
  1154.     do_hook('message_list_controls', $aFormElements);
  1155.  
  1156.     /*
  1157.      * This is the beginning of the message list table.
  1158.      * It wraps around all messages
  1159.      */
  1160.     $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
  1161.     $form_name = "FormMsgs" . $safe_name;
  1162.  
  1163.     //if (!sqgetGlobalVar('align',$align,SQ_SESSION)) {
  1164.         $align = array('left' => 'left', 'right' => 'right');
  1165.     //}
  1166.     //sm_print_r($align);
  1167.  
  1168.     /* finally set the template vars */
  1169.  
  1170. // FIXME, before we support multiple templates we must review the names of the vars
  1171. // BUMP!
  1172.  
  1173.  
  1174.     $aTemplate['color']     = $color;
  1175.     $aTemplate['form_name'] = "FormMsgs" . $safe_name;
  1176.     $aTemplate['form_id']   = 'mbx_'.$iFormId;
  1177.     $aTemplate['page_selector'] = $page_selector;
  1178.     $aTemplate['page_selector_max'] = $page_selector_max;
  1179.     $aTemplate['messagesPerPage'] = $aMailbox['LIMIT'];
  1180.     $aTemplate['showall'] = $aMailbox['SHOWALL'][$iSetIndx];
  1181.     $aTemplate['end_msg'] = $iEnd;
  1182.     $aTemplate['align'] = $align;
  1183.     $aTemplate['iNumberOfMessages'] = $iNumberOfMessages;
  1184.     $aTemplate['aOrder'] = $aOrder;
  1185.     $aTemplate['aFormElements'] = $aFormElements;
  1186.     $aTemplate['sort'] = $sort;
  1187.     $aTemplate['pageOffset'] = $aMailbox['PAGEOFFSET'];
  1188.     $aTemplate['baseurl'] = $baseurl;
  1189.     $aTemplate['aMessages'] =& $aMessages;
  1190.     $aTemplate['trash_folder'] = $trash_folder;
  1191.     $aTemplate['sent_folder'] = $sent_folder;
  1192.     $aTemplate['draft_folder'] = $draft_folder;
  1193.     $aTemplate['thread_link_uri'] = $thread_link_uri;
  1194.     $aTemplate['thread_name'] = $thread_name;
  1195.     $aTemplate['php_self'] = str_replace('&','&amp;',$php_self);
  1196.     $aTemplate['mailbox'] = $sMailbox;
  1197. //FIXME: javascript_on is always assigned to the template object in places like init.php; is there some reason to reassign it here?  is there some chance that it was changed?  if not, please remove this line!
  1198.     $aTemplate['javascript_on'] = (isset($aProps['config']['javascript_on'])) ? $aProps['config']['javascript_on'] : false;
  1199.     $aTemplate['enablesort'] = (isset($aProps['config']['enablesort'])) ? $aProps['config']['enablesort'] : false;
  1200.     $aTemplate['icon_theme'] = (isset($aProps['config']['icon_theme'])) ? $aProps['config']['icon_theme'] : false;
  1201.     $aTemplate['use_icons'] = (isset($aProps['config']['use_icons'])) ? $aProps['config']['use_icons'] : false;
  1202.     $aTemplate['alt_index_colors'] = (isset($aProps['config']['alt_index_colors'])) ? $aProps['config']['alt_index_colors'] : false;
  1203.     $aTemplate['fancy_index_highlite'] = $fancy_index_highlite;
  1204.  
  1205.  
  1206.     /**
  1207.       * Set up sort possibilities; one could argue that this is best
  1208.       * placed in the template, but most template authors won't understand
  1209.       * or need to understand it, so some advanced templates can override 
  1210.       * it if they do something different.
  1211.       */
  1212.     if (!($aTemplate['sort'] & SQSORT_THREAD) && $aTemplate['enablesort']) {
  1213.         $aTemplate['aSortSupported']
  1214.             = array(SQM_COL_SUBJ =>     array(SQSORT_SUBJ_ASC     , SQSORT_SUBJ_DESC),
  1215.                     SQM_COL_DATE =>     array(SQSORT_DATE_DESC    , SQSORT_DATE_ASC),
  1216.                     SQM_COL_INT_DATE => array(SQSORT_INT_DATE_DESC, SQSORT_INT_DATE_ASC),
  1217.                     SQM_COL_FROM =>     array(SQSORT_FROM_ASC     , SQSORT_FROM_DESC),
  1218.                     SQM_COL_TO =>       array(SQSORT_TO_ASC       , SQSORT_TO_DESC),
  1219.                     SQM_COL_CC =>       array(SQSORT_CC_ASC       , SQSORT_CC_DESC),
  1220.                     SQM_COL_SIZE =>     array(SQSORT_SIZE_ASC     , SQSORT_SIZE_DESC));
  1221.     } else {
  1222.         $aTemplate['aSortSupported'] = array();
  1223.     }
  1224.  
  1225.  
  1226.     /**
  1227.       * Figure out which columns should serve as labels for checkbox:
  1228.       * we try to grab the two columns before and after the checkbox,
  1229.       * except the subject column, since it is the link that opens
  1230.       * the message view
  1231.       *
  1232.       * if $javascript_on is set, then the highlighting code takes
  1233.       * care of this; just skip it
  1234.       *
  1235.       * This code also might be more appropriate in a template file, but
  1236.       * we are moving this complex stuff out of the way of template 
  1237.       * authors; advanced template sets are always free to override
  1238.       * the resultant values.
  1239.       *
  1240.       */
  1241.     $show_label_columns = array();
  1242.     $index_order_part = array();
  1243.     if (!($aTemplate['javascript_on'] && $aTemplate['fancy_index_highlite'])) {
  1244.         $get_next_two = 0;
  1245.         $last_order_part = 0;
  1246.         $last_last_order_part = 0;
  1247.         foreach ($aTemplate['aOrder'] as $index_order_part) {
  1248.             if ($index_order_part == SQM_COL_CHECK) {
  1249.                 $get_next_two = 1;
  1250.                 if ($last_last_order_part != SQM_COL_SUBJ)
  1251.                     $show_label_columns[] = $last_last_order_part;
  1252.                 if ($last_order_part != SQM_COL_SUBJ)
  1253.                     $show_label_columns[] = $last_order_part;
  1254.     
  1255.             } else if ($get_next_two > 0 && $get_next_two < 3 && $index_order_part != SQM_COL_SUBJ) {
  1256.                 $show_label_columns[] = $index_order_part;
  1257.                 $get_next_two++;
  1258.             }
  1259.             $last_last_order_part = $last_order_part;
  1260.             $last_order_part = $index_order_part;
  1261.         }
  1262.     }
  1263.     $aTemplate['show_label_columns'] = $show_label_columns;
  1264.  
  1265.  
  1266.     return $aTemplate;
  1267.  
  1268. }
  1269.  
  1270.  
  1271. /**
  1272.  * Process messages list form and handle the cache gracefully. If $sButton and
  1273.  * $aUid are provided as argument then you can fake a message list submit and
  1274.  * use it i.e. in read_body.php for del move next and update the cache
  1275.  *
  1276.  * @param  resource $imapConnection imap connection
  1277.  * @param  array    $aMailbox       (reference) cached mailbox
  1278.  * @param  string   $sButton        fake a submit button
  1279.  * @param  array    $aUid           fake the $msg array
  1280.  * @param  string   $targetMailbox  fake the target mailbox for move operations
  1281.  * @param  boolean  $bypass_trash   fake the bypass trash checkbox for delete operations
  1282.  * @return string $sError error string in case of an error
  1283.  * @since 1.5.1
  1284.  * @author Marc Groot Koerkamp
  1285.  */
  1286. function handleMessageListForm($imapConnection, &$aMailbox, $sButton='',
  1287.                                $aUid = array(), $targetMailbox='', $bypass_trash=NULL) {
  1288.     /* incoming formdata */
  1289.     $sButton = (sqgetGlobalVar('moveButton',      $sTmp, SQ_FORM)) ? 'move'         : $sButton;
  1290.     $sButton = (sqgetGlobalVar('copyButton',      $sTmp, SQ_FORM)) ? 'copy'         : $sButton;
  1291.     $sButton = (sqgetGlobalVar('expungeButton',   $sTmp, SQ_FORM)) ? 'expunge'      : $sButton;
  1292.     $sButton = (sqgetGlobalVar('forward',         $sTmp, SQ_FORM)) ? 'forward'      : $sButton;
  1293.     $sButton = (sqgetGlobalVar('delete',          $sTmp, SQ_FORM)) ? 'setDeleted'   : $sButton;
  1294.     $sButton = (sqgetGlobalVar('undeleteButton',  $sTmp, SQ_FORM)) ? 'unsetDeleted'   : $sButton;
  1295.     $sButton = (sqgetGlobalVar('markRead',        $sTmp, SQ_FORM)) ? 'setSeen'      : $sButton;
  1296.     $sButton = (sqgetGlobalVar('markUnread',      $sTmp, SQ_FORM)) ? 'unsetSeen'    : $sButton;
  1297.     $sButton = (sqgetGlobalVar('markFlagged',     $sTmp, SQ_FORM)) ? 'setFlagged'   : $sButton;
  1298.     $sButton = (sqgetGlobalVar('markUnflagged',   $sTmp, SQ_FORM)) ? 'unsetFlagged' : $sButton;
  1299.     if (empty($targetMailbox)) sqgetGlobalVar('targetMailbox', $targetMailbox,   SQ_FORM);
  1300.     if (is_null($bypass_trash)) sqgetGlobalVar('bypass_trash',  $bypass_trash,    SQ_FORM);
  1301.     sqgetGlobalVar('msg',           $msg,             SQ_FORM);
  1302.     if (sqgetGlobalVar('account',       $iAccount,        SQ_FORM) === false) {
  1303.         $iAccount = 0;
  1304.     }
  1305.     $sError = '';
  1306.     $mailbox = $aMailbox['NAME'];
  1307.  
  1308.     /* retrieve the check boxes */
  1309.     $aUid = (isset($msg) && is_array($msg)) ? array_values($msg) : $aUid;
  1310.     if (count($aUid) && $sButton != 'expunge') {
  1311.  
  1312.         // don't do anything to any messages until we have done security check
  1313.         // FIXME: not sure this code really belongs here, but there's nowhere else to put it with this architecture
  1314.         sqgetGlobalVar('smtoken', $submitted_token, SQ_FORM, '');
  1315.         sm_validate_security_token($submitted_token, -1, TRUE);
  1316.  
  1317.         // make sure message UIDs are sanitized (BIGINT)
  1318.         foreach ($aUid as $i => $uid)
  1319.            $aUid[$i] = (preg_match('/^[0-9]+$/', $uid) ? $uid : '0');
  1320.  
  1321.         $aUpdatedMsgs = false;
  1322.         $bExpunge = false;
  1323.         switch ($sButton) {
  1324.           case 'setDeleted':
  1325.             // check if id exists in case we come from read_body
  1326.             if (count($aUid) == 1 && is_array($aMailbox['UIDSET'][$aMailbox['SETINDEX']]) &&
  1327.                 !in_array($aUid[0],$aMailbox['UIDSET'][$aMailbox['SETINDEX']])) {
  1328.                 break;
  1329.             }
  1330.             $aUpdatedMsgs = sqimap_msgs_list_delete($imapConnection, $mailbox, $aUid,$bypass_trash);
  1331.             $bExpunge = true;
  1332.             //}
  1333.             break;
  1334.           case 'unsetDeleted':
  1335.           case 'setSeen':
  1336.           case 'unsetSeen':
  1337.           case 'setFlagged':
  1338.           case 'unsetFlagged':
  1339.             // get flag
  1340.             $sFlag = (substr($sButton,0,3) == 'set') ? '\\'.substr($sButton,3) : '\\'.substr($sButton,5);
  1341.             $bSet  = (substr($sButton,0,3) == 'set') ? true : false;
  1342.             $aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
  1343.             break;
  1344.           case 'move':
  1345.             $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox,true,$mailbox);
  1346.             sqsession_register($targetMailbox,'lastTargetMailbox');
  1347.             $bExpunge = true;
  1348.             break;
  1349.           case 'copy':
  1350.             // sqimap_msgs_list_copy returns true or false.
  1351.             // If error happens - fourth argument handles it inside function.
  1352.             sqimap_msgs_list_copy($imapConnection,$aUid,$targetMailbox,true);
  1353.             sqsession_register($targetMailbox,'lastTargetMailbox');
  1354.             break;
  1355.           case 'forward':
  1356.             $aMsgHeaders = array();
  1357.             foreach ($aUid as $iUid) {
  1358.                 $aMsgHeaders[$iUid] = $aMailbox['MSG_HEADERS'][$iUid];
  1359.             }
  1360.             if (count($aMsgHeaders)) {
  1361.                 $composesession = attachSelectedMessages($imapConnection,$aMsgHeaders);
  1362.                 // dirty hack, add info to $aMailbox
  1363.                 $aMailbox['FORWARD_SESSION']['SESSION_NUMBER'] = $composesession;
  1364.                 $aMailbox['FORWARD_SESSION']['UIDS'] = $aUid;
  1365.             }
  1366.             break;
  1367.           default:
  1368.              // Hook for plugin buttons
  1369.              $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], &$aUid);
  1370.              do_hook('mailbox_display_button_action', $temp);
  1371.              break;
  1372.         }
  1373.         /**
  1374.          * $aUpdatedMsgs is an array containing the result of the untagged
  1375.          * fetch responses send by the imap server due to a flag change. That
  1376.          * response is parsed in an array with msg arrays by the parseFetch function
  1377.          */
  1378.         if ($aUpdatedMsgs) {
  1379.             // Update the message headers cache
  1380.             $aDeleted = array();
  1381.             foreach ($aUpdatedMsgs as $iUid => $aMsg) {
  1382.                 if (isset($aMsg['FLAGS'])) {
  1383.                     /**
  1384.                      * Only update the cached headers if the header is
  1385.                      * cached.
  1386.                      */
  1387.                     if (isset($aMailbox['MSG_HEADERS'][$iUid])) {
  1388.                         $aMailbox['MSG_HEADERS'][$iUid]['FLAGS'] = $aMsg['FLAGS'];
  1389.                     }
  1390.                     /**
  1391.                      * Also update flags in message object
  1392.                      */
  1393. //FIXME: WHY are we keeping flags in TWO places?!?  This is error-prone and some core code uses the is_xxxx message object values while other code uses the flags array above.  That's a mess.
  1394.                     if (isset($aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'])) {
  1395.                         $message = $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'];
  1396.                         $message->is_seen = false;
  1397.                         $message->is_answered = false;
  1398.                         $message->is_forwarded = false;
  1399.                         $message->is_deleted = false;
  1400.                         $message->is_flagged = false;
  1401.                         $message->is_mdnsent = false;
  1402.                         foreach ($aMsg['FLAGS'] as $flag => $value) {
  1403.                             if (strtolower($flag) == '\\seen' && $value)
  1404.                                 $message->is_seen = true;
  1405.                             else if (strtolower($flag) == '\\answered' && $value)
  1406.                                 $message->is_answered = true;
  1407.                             else if (strtolower($flag) == '$forwarded' && $value)
  1408.                                 $message->is_forwarded = true;
  1409.                             else if (strtolower($flag) == '\\deleted' && $value)
  1410.                                 $message->is_deleted = true;
  1411.                             else if (strtolower($flag) == '\\flagged' && $value)
  1412.                                 $message->is_flagged = true;
  1413.                             else if (strtolower($flag) == '$mdnsent' && $value)
  1414.                                 $message->is_mdnsent = true;
  1415.                         }
  1416.                         $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'] = $message;
  1417.                     }
  1418.                     /**
  1419.                      * Count the messages with the \Delete flag set so we can determine
  1420.                      * if the number of expunged messages equals the number of flagged
  1421.                      * messages for deletion.
  1422.                      */
  1423.                     if (isset($aMsg['FLAGS']['\\deleted']) && $aMsg['FLAGS']['\\deleted']) {
  1424.                         $aDeleted[] = $iUid;
  1425.                     }
  1426.                 }
  1427.             }
  1428.             if ($bExpunge && $aMailbox['AUTO_EXPUNGE'] &&
  1429.                 $iExpungedMessages = sqimap_mailbox_expunge($imapConnection, $aMailbox['NAME'], true))
  1430.                 {
  1431.                 if (count($aDeleted) != $iExpungedMessages) {
  1432.                     // there are more messages deleted permanently then we expected
  1433.                     // invalidate the cache
  1434.                     $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = false;
  1435.                     $aMailbox['MSG_HEADERS'] = false;
  1436.                 } else {
  1437.                     // remove expunged messages from cache
  1438.                     $aUidSet = $aMailbox['UIDSET'][$aMailbox['SETINDEX']];
  1439.                     if (is_array($aUidSet)) {
  1440.                         // create a UID => array index temp array
  1441.                         $aUidSetDummy = array_flip($aUidSet);
  1442.                         foreach ($aDeleted as $iUid) {
  1443.                             // get the id as well in case of SQM_SORT_NONE
  1444.                             if ($aMailbox['SORT'] == SQSORT_NONE) {
  1445.                                 $aMailbox['ID'] = false;
  1446.                                 //$iId = $aMailbox['MSG_HEADERS'][$iUid]['ID'];
  1447.                                 //unset($aMailbox['ID'][$iId]);
  1448.                             }
  1449.                             // unset the UID and message header
  1450.                             unset($aUidSetDummy[$iUid]);
  1451.                             unset($aMailbox['MSG_HEADERS'][$iUid]);
  1452.                         }
  1453.                         $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = array_keys($aUidSetDummy);
  1454.                     }
  1455.                 }
  1456.                 // update EXISTS info
  1457.                 if ($iExpungedMessages) {
  1458.                     $aMailbox['EXISTS'] -= (int) $iExpungedMessages;
  1459.                     $aMailbox['TOTAL'][$aMailbox['SETINDEX']] -= (int) $iExpungedMessages;
  1460.                 }
  1461.                 if (($aMailbox['PAGEOFFSET']-1) >= $aMailbox['EXISTS']) {
  1462.                     $aMailbox['PAGEOFFSET'] = ($aMailbox['PAGEOFFSET'] > $aMailbox['LIMIT']) ?
  1463.                         $aMailbox['PAGEOFFSET'] - $aMailbox['LIMIT'] : 1;
  1464.                      $aMailbox['OFFSET'] = $aMailbox['PAGEOFFSET'] - 1 ;
  1465.                 }
  1466.             }
  1467.         }
  1468.     } else {
  1469.         if ($sButton == 'expunge') {
  1470.             /**
  1471.              * on expunge we do not know which messages will be deleted
  1472.              * so it's useless to try to sync the cache
  1473.              *
  1474.              * Close the mailbox so we do not need to parse the untagged expunge
  1475.              * responses which do not contain uid info.
  1476.              * NB: Closing a mailbox is faster then expunge because the imap
  1477.              * server does not need to generate the untagged expunge responses
  1478.              */
  1479.             sqimap_run_command($imapConnection,'CLOSE',false,$result,$message);
  1480.             $aMailbox = sqm_api_mailbox_select($imapConnection,$iAccount, $aMailbox['NAME'],array(),array());
  1481.         } else {
  1482.             // this is the same hook as above, but here it is called in the
  1483.             // context of not having had any messages selected and if any
  1484.             // plugin handles the situation, it should return TRUE so we
  1485.             // know this was not an erroneous user action
  1486.             //
  1487.             global $null;
  1488.             $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], $null);
  1489.             if (!boolean_hook_function('mailbox_display_button_action', $temp, 1)
  1490.              && $sButton) {
  1491.                 $sError = _("No messages were selected.");
  1492.             }
  1493.         }
  1494.     }
  1495.     return $sError;
  1496. }
  1497.  
  1498. /**
  1499.  * Attach messages to a compose session
  1500.  *
  1501.  * @param  resource $imapConnection imap connection
  1502.  * @param  array $aMsgHeaders 
  1503.  * @return int $composesession unique compose_session_id where the attached messages belong to
  1504.  * @author Marc Groot Koerkamp
  1505.  */
  1506. function attachSelectedMessages($imapConnection,$aMsgHeaders) {
  1507.  
  1508.     sqgetGlobalVar('composesession', $composesession, SQ_SESSION);
  1509.     sqgetGlobalVar('compose_messages', $compose_messages, SQ_SESSION);
  1510.     if (!isset($compose_messages)|| is_null($compose_messages)) {
  1511.         $compose_messages = array();
  1512.         sqsession_register($compose_messages,'compose_messages');
  1513.     }
  1514.  
  1515.     if (!$composesession) {
  1516.         $composesession = 1;
  1517.         sqsession_register($composesession,'composesession');
  1518.     } else {
  1519.         $composesession++;
  1520.         sqsession_register($composesession,'composesession');
  1521.     }
  1522.  
  1523.     $composeMessage = new Message();
  1524.     $rfc822_header = new Rfc822Header();
  1525.     $composeMessage->rfc822_header = $rfc822_header;
  1526.     $composeMessage->reply_rfc822_header = '';
  1527.  
  1528.     foreach($aMsgHeaders as $iUid => $aMsgHeader) {
  1529.         /**
  1530.          * Retrieve the full message
  1531.          */
  1532.         $body_a = sqimap_run_command($imapConnection, "FETCH $iUid RFC822", true, $response, $readmessage, TRUE);
  1533.         if ($response == 'OK') {
  1534.  
  1535.             $subject = (isset($aMsgHeader['subject'])) ? $aMsgHeader['subject'] : $iUid;
  1536.  
  1537.             array_shift($body_a);
  1538.             array_pop($body_a);
  1539.             $body = implode('', $body_a);
  1540.             $body .= "\r\n";
  1541.  
  1542.             global $username, $attachment_dir;
  1543.             $filename = sq_get_attach_tempfile();
  1544.             $fullpath = getHashedDir($username, $attachment_dir) . '/' . $filename;
  1545.             $fp = fopen($fullpath, 'wb');
  1546.             fwrite ($fp, $body);
  1547.             fclose($fp);
  1548.  
  1549.             $composeMessage->initAttachment('message/rfc822', $subject . '.eml', $filename);
  1550.  
  1551.             // create subject for new message
  1552.             //
  1553.             $subject = decodeHeader($subject,false,false,true);
  1554.             $subject = str_replace('"', "'", $subject);
  1555.             $subject = trim($subject);
  1556.             if (substr(strtolower($subject), 0, 4) != 'fwd:') {
  1557.                 $subject = 'Fwd: ' . $subject;
  1558.             }
  1559.             $composeMessage->rfc822_header->subject = $subject;
  1560.  
  1561.         }
  1562.     }
  1563.  
  1564.     $compose_messages[$composesession] = $composeMessage;
  1565.     sqsession_register($compose_messages,'compose_messages');
  1566.     return $composesession;
  1567. }

Documentation generated on Mon, 13 Jan 2020 04:23:01 +0100 by phpDocumentor 1.4.3