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