X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fmailbox_display.php;h=f17071d347bdee5c56311df01c3b4b3681331a45;hb=4e38bc70577f553a97a320bbd0a1d0c5dac70b6e;hp=3fc5a2b8153d2560867376b7b53fa36694a95f94;hpb=d7112bcb8203caa0d5e57aa83ccb7e4f015f7d79;p=squirrelmail.git

diff --git a/functions/mailbox_display.php b/functions/mailbox_display.php
index 3fc5a2b8..f17071d3 100644
--- a/functions/mailbox_display.php
+++ b/functions/mailbox_display.php
@@ -1,26 +1,16 @@
 <?php
 
 /**
-* mailbox_display.php
-*
-* Copyright (c) 1999-2005 The SquirrelMail Project Team
-* Licensed under the GNU GPL. For full terms see the file COPYING.
-*
-* This contains functions that display mailbox information, such as the
-* table row that has sender, date, subject, etc...
-*
-* @version $Id$
-* @package squirrelmail
-*/
-
-/** The standard includes.. */
-require_once(SM_PATH . 'functions/strings.php');
-require_once(SM_PATH . 'functions/html.php');
-require_once(SM_PATH . 'functions/imap_mailbox.php');
-require_once(SM_PATH . 'functions/imap_messages.php');
-require_once(SM_PATH . 'functions/imap_asearch.php');
-require_once(SM_PATH . 'functions/mime.php');
-require_once(SM_PATH . 'functions/forms.php');
+ * mailbox_display.php
+ *
+ * This contains functions that display mailbox information, such as the
+ * table row that has sender, date, subject, etc...
+ *
+ * @copyright &copy; 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ */
 
 
 /**
@@ -32,6 +22,7 @@ require_once(SM_PATH . 'functions/forms.php');
  * @param array    $aConfig array with system config settings and incoming vars
  * @param array    $aProps mailbox specific properties
  * @return array   $aMailbox mailbox array with all relevant information
+ * @since 1.5.1
  * @author Marc Groot Koerkamp
  */
 function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aProps) {
@@ -106,6 +97,7 @@ function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aPro
     $aMailbox['UIDSET'][$iSetIndx] = false;
     $aMailbox['ID'] = false;
     $aMailbox['SETINDEX'] = $iSetIndx;
+    $aMailbox['MSG_HEADERS'] = false;
 
     if ($aCachedMailbox) {
         /**
@@ -217,6 +209,12 @@ function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aPro
     }
     if (!isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx])) {
         $aMailbox['SEARCH'][$iSetIndx] = $aCachedMailbox['SEARCH'][$iSetIndx];
+    } else if (isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
+        $aConfig['search'] != $aCachedMailbox['SEARCH'][$iSetIndx]) {
+        // reset the pageindex
+        $aMailbox['SEARCH'][$iSetIndx] = $aConfig['search'];
+        $aMailbox['OFFSET'] = 0;
+        $aMailbox['PAGEOFFSET'] = 1;
     } else {
         $aMailbox['SEARCH'][$iSetIndx] =  (isset($aConfig['search'])) ? $aConfig['search'] : 'ALL';
     }
@@ -253,11 +251,13 @@ function sqm_api_mailbox_select($imapConnection,$account,$mailbox,$aConfig,$aPro
 
 /**
  * Fetch the message headers for a mailbox. Settings are part of the aMailbox
- * array.
+ * array. Dependent of the mailbox settings it deals with sort, thread and search
+ * If server sort is supported then SORT is also used for retrieving sorted search results
  *
  * @param resource $imapConnection imap socket handle
  * @param array    $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
  * @return error   $error error number
+ * @since 1.5.1
  * @author Marc Groot Koerkamp
  */
 function fetchMessageHeaders($imapConnection, &$aMailbox) {
@@ -296,6 +296,7 @@ function fetchMessageHeaders($imapConnection, &$aMailbox) {
     $iError = 0;
     $aFetchItems = $aHeaderItems = array();
     // initialize the fields we want to retrieve:
+    $aHeaderFields = array();
     foreach ($aFetchHeaders as $v) {
       switch ($v) {
         case SQM_COL_DATE:       $aHeaderFields[] = 'Date';         break;
@@ -335,7 +336,13 @@ function fetchMessageHeaders($imapConnection, &$aMailbox) {
 
         $id_slice = array_slice($aUid,$start_msg-1,$iLimit);
         /* do some funky cache checks */
-        if (isset($aMailbox['MSG_HEADERS'])) {
+        if (isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) {
+            // temp code, read_body del / next links fo not update fields.
+            foreach ($aMailbox['MSG_HEADERS'] as $iUid => $aValue) {
+                if (!isset($aValue['UID'])) {
+                    unset($aMailbox['MSG_HEADERS'][$iUid]);
+                }
+            }
             $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
         } else {
             $aMailbox['MSG_HEADERS'] = array();
@@ -405,7 +412,21 @@ function fetchMessageHeaders($imapConnection, &$aMailbox) {
     return $iError;
 }
 
+/**
+ * Prepares the message headers for display inside a template. The links are calculated,
+ * color for row highlighting is calculated and optionally the strings are truncated.
+ *
+ * @param array    $aMailbox (reference) mailbox retrieved from sqm_api_mailbox_select
+ * @param array    $aProps properties
+ * @return array   $aFormattedMessages array with message headers and format info
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
+ */
 function prepareMessageList(&$aMailbox, $aProps) {
+
+    /* Globalize link attributes so plugins can share in modifying them */
+    global $link, $title, $target, $onclick, $link_extra;
+
     /* retrieve the properties */
     $my_email_address = (isset($aProps['email'])) ? $aProps['email'] : false;
     $highlight_list   = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
@@ -494,7 +515,7 @@ function prepareMessageList(&$aMailbox, $aProps) {
         if (isset($aId[$i])) {
 
             $bHighLight = false;
-            $value = $title = $link = $target = '';
+            $value = $title = $link = $target = $onclick = $link_extra = '';
             $aQuery = ($aInitQuery !== false) ? $aInitQuery : false;
             $aMsg = $aHeaders[$aId[$i]];
             if (isset($aSearch) && count($aSearch) > 1 && $aQuery) {
@@ -508,7 +529,7 @@ function prepareMessageList(&$aMailbox, $aProps) {
             }
 
             foreach ($aCol as $k => $v) {
-                $link = $target = $title = '';
+                $title = $link = $target = $onclick = $link_extra = '';
                 $aColumns[$k] = array();
                 $value = (isset($aMsg[$v]))  ? $aMsg[$v]  : '';
                 $sUnknown = _("Unknown recipient");
@@ -569,13 +590,21 @@ function prepareMessageList(&$aMailbox, $aProps) {
                     // FIXME: don't break 8bit symbols and html entities during truncation
                     if (isset($aColumnDesc[$k]['truncate']) && $aColumnDesc[$k]['truncate']) {
                         $sTmp = truncateWithEntities($value, $aColumnDesc[$k]['truncate']-$iIndent);
-                        $title = ($sTmp != $value) ? $value : '';
+                        // drop any double spaces since these will be displayed in the title
+                        $title = ($sTmp != $value) ? preg_replace('/\s{2,}/', ' ', $value) : '';
                         $value = $sTmp;
                     }
                     /* generate the link to the message */
                     if ($aQuery) {
                         // TODO, $sTargetModule should be a query parameter so that we can use a single entrypoint
                         $link = $sTargetModule.'.php?' . implode('&amp;',$aQuery);
+
+                        // see top of this function for which attributes are available
+                        // in the global scope for plugin use (like $link, $target,
+                        // $onclick, $link_extra, $title, and so forth)
+                        // plugins are responsible for sharing nicely (such as for
+                        // setting the target, etc)
+                        do_hook('subject_link', array($iPageOffset, $sSearch, $aSearch));
                     }
                     $value = (trim($value)) ? $value : _("(no subject)");
                     /* add thread indentation */
@@ -594,6 +623,8 @@ function prepareMessageList(&$aMailbox, $aProps) {
                                          'answered'=>false,
                                          'flagged' => false,
                                          'draft' => false);
+
+                    if(!is_array($value)) $value = array();
                     foreach ($value as $sFlag => $value) {
                         switch ($sFlag) {
                           case '\\seen'    : $aFlagColumn['seen']     = true; break;
@@ -617,9 +648,11 @@ function prepareMessageList(&$aMailbox, $aProps) {
                     break;
                 default : break;
                 }
-                if ($title)  { $aColumns[$k]['title']  = $title;  }
-                if ($link)   { $aColumns[$k]['link']   = $link;   }
-                if ($target) { $aColumns[$k]['target'] = $target; }
+                if ($title)      { $aColumns[$k]['title']      = $title;      }
+                if ($link)       { $aColumns[$k]['link']       = $link;       }
+                if ($link_extra) { $aColumns[$k]['link_extra'] = $link_extra; }
+                if ($onclick)    { $aColumns[$k]['onclick']    = $onclick;    }
+                if ($target)     { $aColumns[$k]['target']     = $target;     }
                 $aColumns[$k]['value']  = $value;
             }
             /* columns which will not be displayed but should be inspected
@@ -639,7 +672,17 @@ function prepareMessageList(&$aMailbox, $aProps) {
 }
 
 
-
+/**
+ * Sets the row color if the provided column value pair  matches a hightlight rule
+ *
+ * @param string   $sCol column name
+ * @param string   $sVal column value
+ * @param array    $highlight_list highlight rules
+ * @param array    $aFormat (reference) array where row color info is stored
+ * @return bool     match found
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
+ */
 function highlightMessage($sCol, $sVal, $highlight_list, &$aFormat) {
     if (!is_array($highlight_list) && count($highlight_list) == 0) {
         return false;
@@ -686,17 +729,18 @@ function setUserPref($username, $pref, $value) {
 }
 
 /**
-* Execute the sorting for a mailbox
-*
-* @param  resource $imapConnection Imap connection
-* @param  array    $aMailbox (reference) Mailbox retrieved with sqm_api_mailbox_select
-* @return int      $error (reference) Error number
-* @private
-* @author Marc Groot Koerkamp
-*/
+ * Execute the sorting for a mailbox
+ *
+ * @param  resource $imapConnection Imap connection
+ * @param  array    $aMailbox (reference) Mailbox retrieved with sqm_api_mailbox_select
+ * @return int      $error (reference) Error number
+ * @private
+ * @since 1.5.1
+ * @author Marc Groot Koerkamp
+ */
 function _get_sorted_msgs_list($imapConnection,&$aMailbox) {
     $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
-    $bDirection = ($aMailbox['SORT'] % 2);
+    $bDirection = !($aMailbox['SORT'] % 2);
     $error = 0;
     if (!$aMailbox['SEARCH'][$iSetIndx]) {
         $aMailbox['SEARCH'][$iSetIndx] = 'ALL';
@@ -740,13 +784,14 @@ function _get_sorted_msgs_list($imapConnection,&$aMailbox) {
 }
 
 /**
-* Does the $srt $_GET var to field mapping
-*
-* @param int $srt Field to sort on
-* @param bool $bServerSort Server sorting is true
-* @return string $sSortField Field to sort on
-* @private
-*/
+ * Does the $srt $_GET var to field mapping
+ *
+ * @param int $srt Field to sort on
+ * @param bool $bServerSort Server sorting is true
+ * @return string $sSortField Field to sort on
+ * @since 1.5.1
+ * @private
+ */
 function _getSortField($sort,$bServerSort) {
     switch($sort) {
         case SQSORT_NONE:
@@ -789,55 +834,24 @@ function _getSortField($sort,$bServerSort) {
     return $sSortField;
 }
 
-
-
-
 /**
-* This function loops through a group of messages in the mailbox
-* and shows them to the user.
-*
-* @param resource $imapConnection
-* @param array    $aMailbox associative array with mailbox related vars
-* @param array    $aProps
-* @param int      $iError error code, 0 is no error
-*/
-function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
-    global $PHP_SELF;
-    global $boxes;
+ * This function is a utility function for setting which headers should be
+ * fetched. It takes into account the highlight list which requires extra
+ * headers to be fetch in order to make those rules work. It's called before
+ * the headers are fetched which happens in showMessagesForMailbox and when
+ * the next and prev links in read_body.php are used.
+ *
+ * @param array    $aMailbox associative array with mailbox related vars
+ * @param array    $aProps
+ * @return void
+ * @since 1.5.1
+ */
+
+function calcFetchColumns(&$aMailbox, &$aProps) {
 
     $highlight_list    = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
-    $fancy_index_highlite = (isset($aProps['config']['fancy_index_highlite'])) ? $aProps['config']['fancy_index_highlite'] : true;
     $aColumnsDesc      = (isset($aProps['columns'])) ? $aProps['columns'] : false;
-    $iAccount          = (isset($aProps['account'])) ? (int) $aProps['account'] : 0;
-    $sMailbox          = (isset($aProps['mailbox'])) ? $aProps['mailbox'] : false;
-    $sTargetModule     = (isset($aProps['module'])) ? $aProps['module'] : 'read_body';
-    $show_flag_buttons = (isset($aProps['config']['show_flag_buttons'])) ? $aProps['config']['show_flag_buttons'] : true;
-    $lastTargetMailbox = (isset($aProps['config']['lastTargetMailbox'])) ? $aProps['config']['lastTargetMailbox'] : '';
-    $aOrder = array_keys($aProps['columns']);
-    $trash_folder      = (isset($aProps['config']['trash_folder']) && $aProps['config']['trash_folder'])
-                          ? $aProps['config']['trash_folder'] : false;
-    $sent_folder       = (isset($aProps['config']['sent_folder']) && $aProps['config']['sent_folder'])
-                          ? $aProps['config']['sent_folder'] : false;
-    $draft_folder      = (isset($aProps['config']['draft_folder']) && $aProps['config']['draft_folder'])
-                          ? $aProps['config']['draft_folder'] : false;
-    $page_selector     = (isset($aProps['config']['page_selector'])) ? $aProps['config']['page_selector'] : false;
-    $page_selector_max = (isset($aProps['config']['page_selector_max'])) ? $aProps['config']['page_selector_max'] : 10;
-    $color             = $aProps['config']['color'];
-
-
-    /*
-     * Form ID
-     */
-    static $iFormId;
 
-    if (!isset($iFormId)) {
-        $iFormId=1;
-    } else {
-        ++$iFormId;
-    }
-    /*
-     * Remove the checkbox column because we cannot fetch it from the imap server
-     */
     $aFetchColumns = $aColumnsDesc;
     if (isset($aFetchColumns[SQM_COL_CHECK])) {
         unset($aFetchColumns[SQM_COL_CHECK]);
@@ -875,10 +889,56 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
             $aProps['extra_columns'] = $aExtraColumns;
         }
     }
-    $aFetchColumns = array_keys($aFetchColumns);
+    $aMailbox['FETCHHEADERS'] =  array_keys($aFetchColumns);
+}
+
+
+/**
+ * This function loops through a group of messages in the mailbox
+ * and shows them to the user.
+ *
+ * @param resource $imapConnection
+ * @param array    $aMailbox associative array with mailbox related vars
+ * @param array    $aProps
+ * @param int      $iError error code, 0 is no error
+ */
+function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
+    global $PHP_SELF;
+    global $boxes;
+
+    $highlight_list    = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false;
+    $fancy_index_highlite = (isset($aProps['config']['fancy_index_highlite'])) ? $aProps['config']['fancy_index_highlite'] : true;
+    $aColumnsDesc      = (isset($aProps['columns'])) ? $aProps['columns'] : false;
+    $iAccount          = (isset($aProps['account'])) ? (int) $aProps['account'] : 0;
+    $sMailbox          = (isset($aProps['mailbox'])) ? $aProps['mailbox'] : false;
+    $sTargetModule     = (isset($aProps['module'])) ? $aProps['module'] : 'read_body';
+    $show_flag_buttons = (isset($aProps['config']['show_flag_buttons'])) ? $aProps['config']['show_flag_buttons'] : true;
+    $lastTargetMailbox = (isset($aProps['config']['lastTargetMailbox'])) ? $aProps['config']['lastTargetMailbox'] : '';
+    $aOrder = array_keys($aProps['columns']);
+    $trash_folder      = (isset($aProps['config']['trash_folder']) && $aProps['config']['trash_folder'])
+                          ? $aProps['config']['trash_folder'] : false;
+    $sent_folder       = (isset($aProps['config']['sent_folder']) && $aProps['config']['sent_folder'])
+                          ? $aProps['config']['sent_folder'] : false;
+    $draft_folder      = (isset($aProps['config']['draft_folder']) && $aProps['config']['draft_folder'])
+                          ? $aProps['config']['draft_folder'] : false;
+    $page_selector     = (isset($aProps['config']['page_selector'])) ? $aProps['config']['page_selector'] : false;
+    $page_selector_max = (isset($aProps['config']['page_selector_max'])) ? $aProps['config']['page_selector_max'] : 10;
+    $color             = $aProps['config']['color'];
+
+
+    /*
+     * Form ID
+     */
+    static $iFormId;
+
+    if (!isset($iFormId)) {
+        $iFormId=1;
+    } else {
+        ++$iFormId;
+    }
     // store the columns to fetch so we can pick them up in read_body
     // where we validate the cache.
-    $aMailbox['FETCHHEADERS'] = $aFetchColumns;
+    calcFetchColumns($aMailbox  ,$aProps);
 
     $iError = fetchMessageHeaders($imapConnection, $aMailbox);
     if ($iError) {
@@ -893,6 +953,7 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
              $aMailbox['PAGEOFFSET'] + $iLimit - 1 : $aMailbox['EXISTS'];
 
     $iNumberOfMessages = $aMailbox['TOTAL'][$iSetIndx];
+    $iEnd = min ( $iEnd, $iNumberOfMessages );
 
     $php_self = $PHP_SELF;
 
@@ -1032,9 +1093,9 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
     }
 
     /*
-    * This is the beginning of the message list table.
-    * It wraps around all messages
-    */
+     * This is the beginning of the message list table.
+     * It wraps around all messages
+     */
     $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
     $form_name = "FormMsgs" . $safe_name;
 
@@ -1048,7 +1109,6 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
     // FIX ME, before we support multiple templates we must review the names of the vars
 
 
-
     $aTemplate['color']     = $color;
     $aTemplate['form_name'] = "FormMsgs" . $safe_name;
     $aTemplate['form_id']   = 'mbx_'.$iFormId;
@@ -1078,17 +1138,18 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) {
     $aTemplate['alt_index_colors'] = (isset($aProps['config']['alt_index_colors'])) ? $aProps['config']['alt_index_colors'] : false;
     $aTemplate['fancy_index_highlite'] = $fancy_index_highlite;
 
+
     return $aTemplate;
 }
 
 
 /**
-* Truncates a string and take care of html encoded characters
-*
-* @param string  $s string to truncate
-* @param int $iTrimAt Trim at nn characters
-* @return string  Trimmed string
-*/
+ * Truncates a string and take care of html encoded characters
+ *
+ * @param string  $s string to truncate
+ * @param int $iTrimAt Trim at nn characters
+ * @return string  Trimmed string
+ */
 function truncateWithEntities($s, $iTrimAt) {
     global $languages, $squirrelmail_language;
 
@@ -1101,11 +1162,11 @@ function truncateWithEntities($s, $iTrimAt) {
         return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth', $s, $iTrimAt);
     } else {
         /*
-        * see if this is entities-encoded string
-        * If so, Iterate through the whole string, find out
-        * the real number of characters, and if more
-        * than $iTrimAt, substr with an updated trim value.
-        */
+         * see if this is entities-encoded string
+         * If so, Iterate through the whole string, find out
+         * the real number of characters, and if more
+         * than $iTrimAt, substr with an updated trim value.
+         */
         $trim_val = $iTrimAt;
         $ent_offset = 0;
         $ent_loc = 0;
@@ -1130,9 +1191,9 @@ function truncateWithEntities($s, $iTrimAt) {
 
 
 /**
-* This should go in imap_mailbox.php
-* @param string $mailbox
-*/
+ * This should go in imap_mailbox.php
+ * @param string $mailbox
+ */
 function handleAsSent($mailbox) {
     global $handleAsSent_result;
 
@@ -1156,6 +1217,7 @@ function handleAsSent($mailbox) {
  * @param  string $sButton fake a submit button
  * @param  array  $aUid    fake the $msg array
  * @return string $sError error string in case of an error
+ * @since 1.5.1
  * @author Marc Groot Koerkamp
  */
 function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = array()) {
@@ -1205,7 +1267,7 @@ function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = ar
             $aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
             break;
           case 'move':
-            $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox);
+            $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox,true,$mailbox);
             sqsession_register($targetMailbox,'lastTargetMailbox');
             $bExpunge = true;
             break;
@@ -1297,7 +1359,7 @@ function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = ar
             /**
              * on expunge we do not know which messages will be deleted
              * so it's useless to try to sync the cache
-
+             *
              * Close the mailbox so we do not need to parse the untagged expunge
              * responses which do not contain uid info.
              * NB: Closing a mailbox is faster then expunge because the imap
@@ -1314,6 +1376,14 @@ function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = ar
     return $sError;
 }
 
+/**
+ * Attach messages to a compose session
+ *
+ * @param  resource $imapConnection imap connection
+ * @param  array $aMsgHeaders
+ * @return int $composesession unique compose_session_id where the attached messages belong to
+ * @author Marc Groot Koerkamp
+ */
 function attachSelectedMessages($imapConnection,$aMsgHeaders) {
     global $username, $attachment_dir,
            $data_dir;
@@ -1371,4 +1441,4 @@ function attachSelectedMessages($imapConnection,$aMsgHeaders) {
     return $composesession;
 }
 
-?>
\ No newline at end of file
+?>