X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fmailbox_display.php;h=d16679a4d6373132154b04c6897a288e2b73e0cc;hp=26290e6813d059359eefd48b301f9e703ee530fb;hb=f830c8ed3e1a20bd9a4d8abf638a311294826ed3;hpb=6ab20f61072b628bcad085244158aaa7ca3265ec diff --git a/functions/mailbox_display.php b/functions/mailbox_display.php index 26290e68..d16679a4 100644 --- a/functions/mailbox_display.php +++ b/functions/mailbox_display.php @@ -1,26 +1,16 @@ $aValue) { + if (!isset($aValue['UID'])) { + unset($aMailbox['MSG_HEADERS'][$iUid]); + } + } $aUidCached = array_keys($aMailbox['MSG_HEADERS']); } else { $aMailbox['MSG_HEADERS'] = array(); @@ -412,7 +414,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, $preselected; + /* retrieve the properties */ $my_email_address = (isset($aProps['email'])) ? $aProps['email'] : false; $highlight_list = (isset($aProps['config']['highlight_list'])) ? $aProps['config']['highlight_list'] : false; @@ -501,7 +517,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) { @@ -515,7 +531,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"); @@ -553,7 +569,7 @@ function prepareMessageList(&$aMailbox, $aProps) { $sTrunc = truncateWithEntities($sTmp, $aColumnDesc[$k]['truncate']); if ($sTrunc != $sTmp) { if (!$title) { - $title = htmlspecialchars($sTmp); + $title = $sTmp; } else if ($title_maybe) { $title = $title .', '.$title_maybe; $title = substr($title,0,-2); // strip ', '; @@ -584,6 +600,14 @@ function prepareMessageList(&$aMailbox, $aProps) { if ($aQuery) { // TODO, $sTargetModule should be a query parameter so that we can use a single entrypoint $link = $sTargetModule.'.php?' . implode('&',$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) + $temp = array(&$iPageOffset, &$sSearch, &$aSearch, $aMsg); + do_hook('subject_link', $temp); } $value = (trim($value)) ? $value : _("(no subject)"); /* add thread indentation */ @@ -600,17 +624,19 @@ function prepareMessageList(&$aMailbox, $aProps) { $aFlagColumn = array('seen' => false, 'deleted'=>false, 'answered'=>false, + 'forwarded'=>false, 'flagged' => false, 'draft' => false); - - if(!is_array($value)) $value = array(); - foreach ($value as $sFlag => $value) { + + if(!is_array($value)) $value = array(); + foreach ($value as $sFlag => $v) { switch ($sFlag) { - case '\\seen' : $aFlagColumn['seen'] = true; break; - case '\\deleted' : $aFlagColumn['deleted'] = true; break; - case '\\answered': $aFlagColumn['answered'] = true; break; - case '\\flagged' : $aFlagColumn['flagged'] = true; break; - case '\\draft' : $aFlagColumn['draft'] = true; break; + case '\\seen' : $aFlagColumn['seen'] = true; break; + case '\\deleted' : $aFlagColumn['deleted'] = true; break; + case '\\answered': $aFlagColumn['answered'] = true; break; + case '$forwarded': $aFlagColumn['forwarded'] = true; break; + case '\\flagged' : $aFlagColumn['flagged'] = true; break; + case '\\draft' : $aFlagColumn['draft'] = true; break; default: break; } } @@ -623,13 +649,15 @@ function prepareMessageList(&$aMailbox, $aProps) { $value = (is_array($value) && $value[0] == 'multipart' && $value[1] == 'mixed') ? true : false; break; case SQM_COL_CHECK: - $value = $checkall; + $value = ($checkall || in_array($iUid, $preselected)); 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 @@ -649,7 +677,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; @@ -696,14 +734,15 @@ 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); @@ -750,13 +789,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: @@ -799,55 +839,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]); @@ -885,10 +894,61 @@ 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, $show_copy_buttons; + + $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; + + /* allows to control copy button in function call. If array key is not set, code follows user preferences */ + if (isset($aProps['config']['show_copy_buttons'])) + $show_copy_buttons = $aProps['config']['show_copy_buttons']; + + $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) { @@ -915,7 +975,7 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { $source_url = $php_self; } - $baseurl = $source_url.'?mailbox=' . urlencode($aMailbox['NAME']) .'&account='.$aMailbox['ACCOUNT']; + $baseurl = $source_url.'?mailbox=' . urlencode($aMailbox['NAME']) .'&account='.$aMailbox['ACCOUNT'] . (strpos($source_url, 'src/search.php') ? '&smtoken=' . sm_generate_security_token() : ''); $where = urlencode($aMailbox['SEARCH'][$iSetIndx][0]); $what = urlencode($aMailbox['SEARCH'][$iSetIndx][1]); $baseurl .= '&where=' . $where . '&what=' . $what; @@ -930,11 +990,11 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { $thread_name = _("Thread View"); $newsort = $aMailbox['SORT'] + SQSORT_THREAD; } - $thread_link_str = '[' . $thread_name - . ']'; + $thread_link_uri = $baseurl . '&srt=' . $newsort + . '&startMessage=1'; } else { - $thread_link_str =''; + $thread_link_uri =''; + $thread_name = ''; } $sort = $aMailbox['SORT']; @@ -943,10 +1003,9 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { /* future admin control over displayable buttons */ - $aAdminControl = array( - 'markUnflagged' => 1, 'markFlagged' => 1, + 'markUnflagged' => 1, 'markRead' => 1, 'markUnread' => 1, 'forward' => 1, @@ -954,13 +1013,15 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { 'undeleteButton'=> 1, 'bypass_trash' => 1, 'expungeButton' => 1, - 'moveButton' => 1 + 'moveButton' => 1, + 'copyButton' => 1 ); + /* user prefs control */ $aUserControl = array ( - 'markUnflagged' => $show_flag_buttons, 'markFlagged' => $show_flag_buttons, + 'markUnflagged' => $show_flag_buttons, 'markRead' => 1, 'markUnread' => 1, 'forward' => 1, @@ -968,7 +1029,8 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { 'undeleteButton'=> 1, 'bypass_trash' => 1, 'expungeButton' => 1, - 'moveButton' => 1 + 'moveButton' => 1, + 'copyButton' => $show_copy_buttons ); @@ -983,6 +1045,8 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { $showMove = ($aMailbox['RIGHTS'] != 'READ-ONLY') ? true : false; $showExpunge = (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY' && in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) ? true : false; + + /* Button options that depend on IMAP server and selected folder */ $aImapControl = array ( 'markUnflagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true), 'markFlagged' => in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true), @@ -993,19 +1057,42 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { 'undeleteButton'=> $showUndelete, 'bypass_trash' => $showByPassTrash, 'expungeButton' => $showExpunge, - 'moveButton' => $showMove + 'moveButton' => $showMove, + 'copyButton' => 1 ); + /* Button strings */ $aButtonStrings = array( - 'markUnflagged' => _("Unflag"), - 'markFlagged' => _("Flag"), - 'markRead' => _("Read"), - 'markUnread' => _("Unread"), - 'forward' => _("Forward"), - 'delete' => _("Delete"), - 'undeleteButton' => _("Undelete"), - 'bypass_trash' => _("Bypass Trash"), - 'expungeButton' => _("Expunge"), - 'moveButton' => _("Move") + 'markFlagged' => _("Flag"), + 'markUnflagged' => _("Unflag"), + 'markRead' => _("Read"), + 'markUnread' => _("Unread"), + 'forward' => _("Forward"), + 'delete' => _("Delete"), + 'undeleteButton' => _("Undelete"), + 'bypass_trash' => _("Bypass Trash"), + 'expungeButton' => _("Expunge"), + 'moveButton' => _("Move"), + 'copyButton' => _("Copy") + ); + /* Button access keys */ + global $accesskey_mailbox_flag, $accesskey_mailbox_unflag, + $accesskey_mailbox_read, $accesskey_mailbox_unread, + $accesskey_mailbox_forward, $accesskey_mailbox_delete, + $accesskey_mailbox_undelete, $accesskey_mailbox_bypass_trash, + $accesskey_mailbox_expunge, $accesskey_mailbox_move, + $accesskey_mailbox_copy, $accesskey_mailbox_move_to; + $aButtonAccessKeys = array( + 'markFlagged' => $accesskey_mailbox_flag, + 'markUnflagged' => $accesskey_mailbox_unflag, + 'markRead' => $accesskey_mailbox_read, + 'markUnread' => $accesskey_mailbox_unread, + 'forward' => $accesskey_mailbox_forward, + 'delete' => $accesskey_mailbox_delete, + 'undeleteButton' => $accesskey_mailbox_undelete, + 'bypass_trash' => $accesskey_mailbox_bypass_trash, + 'expungeButton' => $accesskey_mailbox_expunge, + 'moveButton' => $accesskey_mailbox_move, + 'copyButton' => $accesskey_mailbox_copy, ); @@ -1017,35 +1104,44 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { foreach($aAdminControl as $k => $v) { if ($v & $aUserControl[$k] & $aImapControl[$k]) { switch ($k) { - case 'markUnflagged': case 'markFlagged': + case 'markUnflagged': case 'markRead': case 'markUnread': case 'delete': case 'undeleteButton': case 'expungeButton': case 'forward': - $aFormElements[$k] = array($aButtonStrings[$k],'submit'); + $aFormElements[$k] + = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE')); break; case 'bypass_trash': - $aFormElements[$k] = array($aButtonStrings[$k],'checkbox'); + $aFormElements[$k] + = array('value' => $aButtonStrings[$k], 'type' => 'checkbox', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE')); break; case 'moveButton': - $aFormElements['targetMailbox'] = - array(sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes),'select'); - $aFormElements['mailbox'] = array($aMailbox['NAME'],'hidden'); - $aFormElements['startMessage'] = array($aMailbox['PAGEOFFSET'],'hidden'); - $aFormElements[$k] = array($aButtonStrings[$k],'submit'); + case 'copyButton': + $aFormElements['targetMailbox'] + = array('options_list' => sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes), + 'type' => 'select', + 'accesskey' => $accesskey_mailbox_move_to); + $aFormElements['mailbox'] + = array('value' => $aMailbox['NAME'], 'type' => 'hidden'); + $aFormElements['startMessage'] + = array('value' => $aMailbox['PAGEOFFSET'], 'type' => 'hidden'); + $aFormElements[$k] + = array('value' => $aButtonStrings[$k], 'type' => 'submit', 'accesskey' => (isset($aButtonAccessKeys[$k]) ? $aButtonAccessKeys[$k] : 'NONE')); break; } } - $aFormElements['account'] = array($iAccount,'hidden'); + $aFormElements['account'] = array('value' => $iAccount,'type' => 'hidden'); } + do_hook('message_list_controls', $aFormElements); /* - * 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; @@ -1056,7 +1152,8 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { /* finally set the template vars */ - // FIX ME, before we support multiple templates we must review the names of the vars +// FIXME, before we support multiple templates we must review the names of the vars +// BUMP! $aTemplate['color'] = $color; @@ -1078,9 +1175,11 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { $aTemplate['trash_folder'] = $trash_folder; $aTemplate['sent_folder'] = $sent_folder; $aTemplate['draft_folder'] = $draft_folder; - $aTemplate['thread_link_str'] = $thread_link_str; + $aTemplate['thread_link_uri'] = $thread_link_uri; + $aTemplate['thread_name'] = $thread_name; $aTemplate['php_self'] = str_replace('&','&',$php_self); $aTemplate['mailbox'] = $sMailbox; +//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! $aTemplate['javascript_on'] = (isset($aProps['config']['javascript_on'])) ? $aProps['config']['javascript_on'] : false; $aTemplate['enablesort'] = (isset($aProps['config']['enablesort'])) ? $aProps['config']['enablesort'] : false; $aTemplate['icon_theme'] = (isset($aProps['config']['icon_theme'])) ? $aProps['config']['icon_theme'] : false; @@ -1089,17 +1188,78 @@ function showMessagesForMailbox($imapConnection, &$aMailbox,$aProps, &$iError) { $aTemplate['fancy_index_highlite'] = $fancy_index_highlite; + /** + * Set up sort possibilities; one could argue that this is best + * placed in the template, but most template authors won't understand + * or need to understand it, so some advanced templates can override + * it if they do something different. + */ + if (!($aTemplate['sort'] & SQSORT_THREAD) && $aTemplate['enablesort']) { + $aTemplate['aSortSupported'] + = array(SQM_COL_SUBJ => array(SQSORT_SUBJ_ASC , SQSORT_SUBJ_DESC), + SQM_COL_DATE => array(SQSORT_DATE_DESC , SQSORT_DATE_ASC), + SQM_COL_INT_DATE => array(SQSORT_INT_DATE_DESC, SQSORT_INT_DATE_ASC), + SQM_COL_FROM => array(SQSORT_FROM_ASC , SQSORT_FROM_DESC), + SQM_COL_TO => array(SQSORT_TO_ASC , SQSORT_TO_DESC), + SQM_COL_CC => array(SQSORT_CC_ASC , SQSORT_CC_DESC), + SQM_COL_SIZE => array(SQSORT_SIZE_ASC , SQSORT_SIZE_DESC)); + } else { + $aTemplate['aSortSupported'] = array(); + } + + + /** + * Figure out which columns should serve as labels for checkbox: + * we try to grab the two columns before and after the checkbox, + * except the subject column, since it is the link that opens + * the message view + * + * if $javascript_on is set, then the highlighting code takes + * care of this; just skip it + * + * This code also might be more appropriate in a template file, but + * we are moving this complex stuff out of the way of template + * authors; advanced template sets are always free to override + * the resultant values. + * + */ + $show_label_columns = array(); + $index_order_part = array(); + if (!($aTemplate['javascript_on'] && $aTemplate['fancy_index_highlite'])) { + $get_next_two = 0; + $last_order_part = 0; + $last_last_order_part = 0; + foreach ($aTemplate['aOrder'] as $index_order_part) { + if ($index_order_part == SQM_COL_CHECK) { + $get_next_two = 1; + if ($last_last_order_part != SQM_COL_SUBJ) + $show_label_columns[] = $last_last_order_part; + if ($last_order_part != SQM_COL_SUBJ) + $show_label_columns[] = $last_order_part; + + } else if ($get_next_two > 0 && $get_next_two < 3 && $index_order_part != SQM_COL_SUBJ) { + $show_label_columns[] = $index_order_part; + $get_next_two++; + } + $last_last_order_part = $last_order_part; + $last_order_part = $index_order_part; + } + } + $aTemplate['show_label_columns'] = $show_label_columns; + + 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; @@ -1112,11 +1272,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; @@ -1140,50 +1300,38 @@ function truncateWithEntities($s, $iTrimAt) { } -/** -* This should go in imap_mailbox.php -* @param string $mailbox -*/ -function handleAsSent($mailbox) { - global $handleAsSent_result; - - /* First check if this is the sent or draft folder. */ - $handleAsSent_result = isSentMailbox($mailbox) || isDraftMailbox($mailbox); - - /* Then check the result of the handleAsSent hook. */ - do_hook('check_handleAsSent_result', $mailbox); - - /* And return the result. */ - return $handleAsSent_result; -} - /** * Process messages list form and handle the cache gracefully. If $sButton and * $aUid are provided as argument then you can fake a message list submit and * use it i.e. in read_body.php for del move next and update the cache * * @param resource $imapConnection imap connection - * @param array $aMailbox (reference) cached mailbox - * @param string $sButton fake a submit button - * @param array $aUid fake the $msg array + * @param array $aMailbox (reference) cached mailbox + * @param string $sButton fake a submit button + * @param array $aUid fake the $msg array + * @param string $targetMailbox fake the target mailbox for move operations + * @param boolean $bypass_trash fake the bypass trash checkbox for delete operations * @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()) { +function handleMessageListForm($imapConnection, &$aMailbox, $sButton='', + $aUid = array(), $targetMailbox='', $bypass_trash=NULL) { /* incoming formdata */ - $sButton = (sqgetGlobalVar('moveButton', $sTmp, SQ_POST)) ? 'move' : $sButton; - $sButton = (sqgetGlobalVar('expungeButton', $sTmp, SQ_POST)) ? 'expunge' : $sButton; - $sButton = (sqgetGlobalVar('forward', $sTmp, SQ_POST)) ? 'forward' : $sButton; - $sButton = (sqgetGlobalVar('delete', $sTmp, SQ_POST)) ? 'setDeleted' : $sButton; - $sButton = (sqgetGlobalVar('undeleteButton', $sTmp, SQ_POST)) ? 'unsetDeleted' : $sButton; - $sButton = (sqgetGlobalVar('markRead', $sTmp, SQ_POST)) ? 'setSeen' : $sButton; - $sButton = (sqgetGlobalVar('markUnread', $sTmp, SQ_POST)) ? 'unsetSeen' : $sButton; - $sButton = (sqgetGlobalVar('markFlagged', $sTmp, SQ_POST)) ? 'setFlagged' : $sButton; - $sButton = (sqgetGlobalVar('markUnflagged', $sTmp, SQ_POST)) ? 'unsetFlagged' : $sButton; - sqgetGlobalVar('targetMailbox', $targetMailbox, SQ_POST); - sqgetGlobalVar('bypass_trash', $bypass_trash, SQ_POST); - sqgetGlobalVar('msg', $msg, SQ_POST); - if (sqgetGlobalVar('account', $iAccount, SQ_POST) === false) { + $sButton = (sqgetGlobalVar('moveButton', $sTmp, SQ_FORM)) ? 'move' : $sButton; + $sButton = (sqgetGlobalVar('copyButton', $sTmp, SQ_FORM)) ? 'copy' : $sButton; + $sButton = (sqgetGlobalVar('expungeButton', $sTmp, SQ_FORM)) ? 'expunge' : $sButton; + $sButton = (sqgetGlobalVar('forward', $sTmp, SQ_FORM)) ? 'forward' : $sButton; + $sButton = (sqgetGlobalVar('delete', $sTmp, SQ_FORM)) ? 'setDeleted' : $sButton; + $sButton = (sqgetGlobalVar('undeleteButton', $sTmp, SQ_FORM)) ? 'unsetDeleted' : $sButton; + $sButton = (sqgetGlobalVar('markRead', $sTmp, SQ_FORM)) ? 'setSeen' : $sButton; + $sButton = (sqgetGlobalVar('markUnread', $sTmp, SQ_FORM)) ? 'unsetSeen' : $sButton; + $sButton = (sqgetGlobalVar('markFlagged', $sTmp, SQ_FORM)) ? 'setFlagged' : $sButton; + $sButton = (sqgetGlobalVar('markUnflagged', $sTmp, SQ_FORM)) ? 'unsetFlagged' : $sButton; + if (empty($targetMailbox)) sqgetGlobalVar('targetMailbox', $targetMailbox, SQ_FORM); + if (is_null($bypass_trash)) sqgetGlobalVar('bypass_trash', $bypass_trash, SQ_FORM); + sqgetGlobalVar('msg', $msg, SQ_FORM); + if (sqgetGlobalVar('account', $iAccount, SQ_FORM) === false) { $iAccount = 0; } $sError = ''; @@ -1192,6 +1340,16 @@ function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = ar /* retrieve the check boxes */ $aUid = (isset($msg) && is_array($msg)) ? array_values($msg) : $aUid; if (count($aUid) && $sButton != 'expunge') { + + // don't do anything to any messages until we have done security check + // FIXME: not sure this code really belongs here, but there's nowhere else to put it with this architecture + sqgetGlobalVar('smtoken', $submitted_token, SQ_FORM, ''); + sm_validate_security_token($submitted_token, 3600, TRUE); + + // make sure message UIDs are sanitized (BIGINT) + foreach ($aUid as $i => $uid) + $aUid[$i] = (preg_match('/^[0-9]+$/', $uid) ? $uid : '0'); + $aUpdatedMsgs = false; $bExpunge = false; switch ($sButton) { @@ -1216,10 +1374,16 @@ 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; + case 'copy': + // sqimap_msgs_list_copy returns true or false. + // If error happens - fourth argument handles it inside function. + sqimap_msgs_list_copy($imapConnection,$aUid,$targetMailbox,true); + sqsession_register($targetMailbox,'lastTargetMailbox'); + break; case 'forward': $aMsgHeaders = array(); foreach ($aUid as $iUid) { @@ -1228,18 +1392,20 @@ function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = ar if (count($aMsgHeaders)) { $composesession = attachSelectedMessages($imapConnection,$aMsgHeaders); // dirty hack, add info to $aMailbox - $aMailbox['FORWARD_SESSION'] = $composesession; + $aMailbox['FORWARD_SESSION']['SESSION_NUMBER'] = $composesession; + $aMailbox['FORWARD_SESSION']['UIDS'] = $aUid; } break; default: // Hook for plugin buttons - do_hook_function('mailbox_display_button_action', $aUid); + $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], &$aUid); + do_hook('mailbox_display_button_action', $temp); break; } /** - * Updates messages is an array containing the result of the untagged + * $aUpdatedMsgs is an array containing the result of the untagged * fetch responses send by the imap server due to a flag change. That - * response is parsed in a array with msg arrays by the parseFetch function + * response is parsed in an array with msg arrays by the parseFetch function */ if ($aUpdatedMsgs) { // Update the message headers cache @@ -1253,6 +1419,34 @@ function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = ar if (isset($aMailbox['MSG_HEADERS'][$iUid])) { $aMailbox['MSG_HEADERS'][$iUid]['FLAGS'] = $aMsg['FLAGS']; } + /** + * Also update flags in message object + */ +//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. + if (isset($aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'])) { + $message = $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT']; + $message->is_seen = false; + $message->is_answered = false; + $message->is_forwarded = false; + $message->is_deleted = false; + $message->is_flagged = false; + $message->is_mdnsent = false; + foreach ($aMsg['FLAGS'] as $flag => $value) { + if (strtolower($flag) == '\\seen' && $value) + $message->is_seen = true; + else if (strtolower($flag) == '\\answered' && $value) + $message->is_answered = true; + else if (strtolower($flag) == '$forwarded' && $value) + $message->is_forwarded = true; + else if (strtolower($flag) == '\\deleted' && $value) + $message->is_deleted = true; + else if (strtolower($flag) == '\\flagged' && $value) + $message->is_flagged = true; + else if (strtolower($flag) == '$mdnsent' && $value) + $message->is_mdnsent = true; + } + $aMailbox['MSG_HEADERS'][$iUid]['MESSAGE_OBJECT'] = $message; + } /** * Count the messages with the \Delete flag set so we can determine * if the number of expunged messages equals the number of flagged @@ -1308,7 +1502,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 @@ -1317,7 +1511,15 @@ function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = ar sqimap_run_command($imapConnection,'CLOSE',false,$result,$message); $aMailbox = sqm_api_mailbox_select($imapConnection,$iAccount, $aMailbox['NAME'],array(),array()); } else { - if ($sButton) { + // this is the same hook as above, but here it is called in the + // context of not having had any messages selected and if any + // plugin handles the situation, it should return TRUE so we + // know this was not an erroneous user action + // + global $null; + $temp = array(&$sButton, &$aMailbox, $iAccount, $aMailbox['NAME'], $null); + if (!boolean_hook_function('mailbox_display_button_action', $temp, 1) + && $sButton) { $sError = _("No messages were selected."); } } @@ -1325,10 +1527,15 @@ 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; - sqgetGlobalVar('composesession', $composesession, SQ_SESSION); sqgetGlobalVar('compose_messages', $compose_messages, SQ_SESSION); @@ -1345,8 +1552,6 @@ function attachSelectedMessages($imapConnection,$aMsgHeaders) { sqsession_register($composesession,'composesession'); } - $hashed_attachment_dir = getHashedDir($username, $attachment_dir); - $composeMessage = new Message(); $rfc822_header = new Rfc822Header(); $composeMessage->rfc822_header = $rfc822_header; @@ -1366,14 +1571,14 @@ function attachSelectedMessages($imapConnection,$aMsgHeaders) { $body = implode('', $body_a); $body .= "\r\n"; - $localfilename = GenerateRandomString(32, 'FILE', 7); - $full_localfilename = "$hashed_attachment_dir/$localfilename"; - - $fp = fopen( $full_localfilename, 'wb'); + global $username, $attachment_dir; + $filename = sq_get_attach_tempfile(); + $fullpath = getHashedDir($username, $attachment_dir) . '/' . $filename; + $fp = fopen($fullpath, 'wb'); fwrite ($fp, $body); fclose($fp); - $composeMessage->initAttachment('message/rfc822',$subject.'.msg', - $full_localfilename); + + $composeMessage->initAttachment('message/rfc822', $subject . '.eml', $filename); } } @@ -1382,4 +1587,3 @@ function attachSelectedMessages($imapConnection,$aMsgHeaders) { return $composesession; } -?>