This thread contains a patchset. You're looking at the original emails,
but you may wish to use the patch review UI.
Review patch
[PATCH v2] imap: add sort support
---
Changed: Removed useless error declaration, no functional changes
go.mod | 1 +
go.sum | 6 ++++++
worker/imap/open.go | 49 +++++++++++++++++++++++++++++++++++++++++--
worker/imap/worker.go | 4 +++-
4 files changed, 57 insertions(+), 3 deletions(-)
diff --git a/go.mod b/go.mod
index 1dacc3b..ce9ac2e 100644
--- a/go.mod
+++ b/go.mod
@@ -9,6 +9,7 @@ require (
github.com/ddevault/go-libvterm v0.0.0-20190526194226-b7d861da3810
github.com/emersion/go-imap v1.0.4
github.com/emersion/go-imap-idle v0.0.0-20190519112320-2704abd7050e
+ github.com/emersion/go-imap-sortthread v1.1.0
github.com/emersion/go-maildir v0.2.0
github.com/emersion/go-message v0.12.1-0.20200824204225-9094bd0b8bc0
github.com/emersion/go-pgpmail v0.0.0-20200303213726-db035a3a4139
diff --git a/go.sum b/go.sum
index 147ad50..125c012 100644
--- a/go.sum
+++ b/go.sum
@@ -15,18 +15,23 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/ddevault/go-libvterm v0.0.0-20190526194226-b7d861da3810 h1:VlHKuIrEvuGlED53TkovT4AVUjrqTyeCt3wiqw1OsFc=
github.com/ddevault/go-libvterm v0.0.0-20190526194226-b7d861da3810/go.mod h1:Ow1oE1Hr4xE7eWY2/Ih2kbcOyyXDH7G0XKv/I4yiCYs=
+github.com/emersion/go-imap v1.0.0/go.mod h1:MEiDDwwQFcZ+L45Pa68jNGv0qU9kbW+SJzwDpvSfX1s=
github.com/emersion/go-imap v1.0.4 h1:uiCAIHM6Z5Jwkma1zdNDWWXxSCqb+/xHBkHflD7XBro=
github.com/emersion/go-imap v1.0.4/go.mod h1:yKASt+C3ZiDAiCSssxg9caIckWF/JG7ZQTO7GAmvicU=
github.com/emersion/go-imap-idle v0.0.0-20190519112320-2704abd7050e h1:L7bswVJZcf2YHofgom49oFRwVqmBj/qZqDy9/SJpZMY=
github.com/emersion/go-imap-idle v0.0.0-20190519112320-2704abd7050e/go.mod h1:o14zPKCmEH5WC1vU5SdPoZGgNvQx7zzKSnxPQlobo78=
+github.com/emersion/go-imap-sortthread v1.1.0 h1:uRbmnQkeRny5ihKfLWBPJ/1jJdTZnCdh1zYpOagbubw=
+github.com/emersion/go-imap-sortthread v1.1.0/go.mod h1:opHOzblOHZKQM1JEy+GPk1217giNLa7kleyWTN06qnc=
github.com/emersion/go-maildir v0.2.0 h1:fC4+UVGl8GcQGbFF7AWab2JMf4VbKz+bMNv07xxhzs8=
github.com/emersion/go-maildir v0.2.0/go.mod h1:I2j27lND/SRLgxROe50Vam81MSaqPFvJ0OHNnDZ7n84=
+github.com/emersion/go-message v0.10.4-0.20190609165112-592ace5bc1ca/go.mod h1:3h+HsGTCFHmk4ngJ2IV/YPhdlaOcR6hcgqM3yca9v7c=
github.com/emersion/go-message v0.11.1 h1:0C/S4JIXDTSfXB1vpqdimAYyK4+79fgEAMQ0dSL+Kac=
github.com/emersion/go-message v0.11.1/go.mod h1:C4jnca5HOTo4bGN9YdqNQM9sITuT3Y0K6bSUw9RklvY=
github.com/emersion/go-message v0.12.1-0.20200824204225-9094bd0b8bc0 h1:G2VV/Wp2opDvR0ecue3UY/IX1/8OlTmMKKi+ENe1nG0=
github.com/emersion/go-message v0.12.1-0.20200824204225-9094bd0b8bc0/go.mod h1:C4jnca5HOTo4bGN9YdqNQM9sITuT3Y0K6bSUw9RklvY=
github.com/emersion/go-pgpmail v0.0.0-20200303213726-db035a3a4139 h1:JTUbkRuQFtDrl5KHWR2jrh9SUeSDEEEjUcHJkXdAE2Q=
github.com/emersion/go-pgpmail v0.0.0-20200303213726-db035a3a4139/go.mod h1:+Ovy1VQCUKPdjWkOiWvFoiFaWXkqn1PA793VvfEYWQU=
+github.com/emersion/go-sasl v0.0.0-20190520160400-47d427600317/go.mod h1:G/dpzLu16WtQpBfQ/z3LYiYJn3ZhKSGWn83fyoyQe/k=
github.com/emersion/go-sasl v0.0.0-20190817083125-240c8404624e/go.mod h1:G/dpzLu16WtQpBfQ/z3LYiYJn3ZhKSGWn83fyoyQe/k=
github.com/emersion/go-sasl v0.0.0-20191210011802-430746ea8b9b h1:uhWtEWBHgop1rqEk2klKaxPAkVDCXexai6hSuRQ7Nvs=
github.com/emersion/go-sasl v0.0.0-20191210011802-430746ea8b9b/go.mod h1:G/dpzLu16WtQpBfQ/z3LYiYJn3ZhKSGWn83fyoyQe/k=
@@ -58,6 +63,7 @@ github.com/kyoh86/xdg v1.2.0/go.mod h1:/mg8zwu1+qe76oTFUBnyS7rJzk7LLC0VGEzJyJ19D
github.com/lucasb-eyer/go-colorful v1.0.2/go.mod h1:0MS4r+7BZKSJ5mw4/S5MPN+qHFF1fYclkSPilDOKW0s=
github.com/lucasb-eyer/go-colorful v1.0.3 h1:QIbQXiugsb+q10B+MI+7DI1oQLdmnep86tWFlaaUAac=
github.com/lucasb-eyer/go-colorful v1.0.3/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
+github.com/martinlindhe/base36 v0.0.0-20190418230009-7c6542dfbb41/go.mod h1:+AtEs8xrBpCeYgSLoY/aJ6Wf37jtBuR0s35750M27+8=
github.com/martinlindhe/base36 v1.0.0 h1:eYsumTah144C0A8P1T/AVSUk5ZoLnhfYFM3OGQxB52A=
github.com/martinlindhe/base36 v1.0.0/go.mod h1:+AtEs8xrBpCeYgSLoY/aJ6Wf37jtBuR0s35750M27+8=
github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
diff --git a/worker/imap/open.go b/worker/imap/open.go
index 0602a7f..4605eb9 100644
--- a/worker/imap/open.go
+++ b/worker/imap/open.go
@@ -2,6 +2,7 @@ package imap
import (
"github.com/emersion/go-imap"
+ sortthread "github.com/emersion/go-imap-sortthread"
"git.sr.ht/~sircmpwn/aerc/worker/types"
)
@@ -30,9 +31,29 @@ func (imapw *IMAPWorker) handleFetchDirectoryContents(
seqSet := &imap.SeqSet{}
seqSet.AddRange(1, imapw.selected.Messages)
- uids, err := imapw.client.UidSearch(&imap.SearchCriteria{
+
+ searchCriteria := &imap.SearchCriteria{
SeqNum: seqSet,
- })
+ }
+ sortCriteria := translageSortCriterions(msg.SortCriteria)
+
+ var uids []uint32
+
+ // If the server supports the SORT extension, do the sorting server side
+ ok, err := imapw.client.sort.SupportSort()
+ if err == nil && ok && len(sortCriteria) > 0 {
+ uids, err = imapw.client.sort.UidSort(sortCriteria, searchCriteria)
+ // copy in reverse as msgList displays backwards
+ for i, j := 0, len(uids)-1; i < j; i, j = i+1, j-1 {
+ uids[i], uids[j] = uids[j], uids[i]
+ }
+ } else {
+ if err != nil {
+ // Non fatal, but we do want to print to get some debug info
+ imapw.worker.Logger.Printf("can't check for SORT support: %v", err)
+ }
+ uids, err = imapw.client.UidSearch(searchCriteria)
+ }
if err != nil {
imapw.worker.PostMessage(&types.Error{
Message: types.RespondTo(msg),
@@ -50,3 +71,27 @@ func (imapw *IMAPWorker) handleFetchDirectoryContents(
imapw.worker.PostMessage(&types.Done{types.RespondTo(msg)}, nil)
}
}
+
+type sortFieldMapT map[types.SortField]sortthread.SortField
+
+// caution, incomplete mapping
+var sortFieldMap sortFieldMapT = sortFieldMapT{
+ types.SortArrival: sortthread.SortArrival,
+ types.SortCc: sortthread.SortCc,
+ types.SortDate: sortthread.SortDate,
+ types.SortFrom: sortthread.SortFrom,
+ types.SortSize: sortthread.SortSize,
+ types.SortSubject: sortthread.SortSubject,
+ types.SortTo: sortthread.SortTo,
+}
+
+func translageSortCriterions(
+ cs []*types.SortCriterion) []sortthread.SortCriterion {
+ result := make([]sortthread.SortCriterion, 0, len(cs))
+ for _, c := range cs {
+ if f, ok := sortFieldMap[c.Field]; ok {
+ result = append(result, sortthread.SortCriterion{f, c.Reverse})
+ }
+ }
+ return result
+}
diff --git a/worker/imap/worker.go b/worker/imap/worker.go
index c016af6..dab0afb 100644
--- a/worker/imap/worker.go
+++ b/worker/imap/worker.go
@@ -8,6 +8,7 @@ import (
"github.com/emersion/go-imap"
idle "github.com/emersion/go-imap-idle"
+ sortthread "github.com/emersion/go-imap-sortthread"
"github.com/emersion/go-imap/client"
"golang.org/x/oauth2"
@@ -27,6 +28,7 @@ var errUnsupported = fmt.Errorf("unsupported command")
type imapClient struct {
*client.Client
idle *idle.IdleClient
+ sort *sortthread.SortClient
}
type IMAPWorker struct {
@@ -155,7 +157,7 @@ func (w *IMAPWorker) handleMessage(msg types.WorkerMessage) error {
}
c.Updates = w.updates
- w.client = &imapClient{c, idle.NewClient(c)}
+ w.client = &imapClient{c, idle.NewClient(c), sortthread.NewSortClient(c)}
w.worker.PostMessage(&types.Done{types.RespondTo(msg)}, nil)
case *types.ListDirectories:
w.handleListDirectories(msg)
--
2.28.0
So far so good. I'll continue to mess with it though and see if any
badness happens.
On Sat Sep 12, 2020 at 2:16 PM BST, Reto Brunner wrote:
> ---
> Changed: Removed useless error declaration, no functional changes
>
> go.mod | 1 +
> go.sum | 6 ++++++
> worker/imap/open.go | 49 +++++++++++++++++++++++++++++++++++++++++--
> worker/imap/worker.go | 4 +++-
> 4 files changed, 57 insertions(+), 3 deletions(-)
>
> diff --git a/go.mod b/go.mod
> index 1dacc3b..ce9ac2e 100644
> --- a/go.mod
> +++ b/go.mod
> @@ -9,6 +9,7 @@ require (
> github.com/ddevault/go-libvterm v0.0.0-20190526194226-b7d861da3810
> github.com/emersion/go-imap v1.0.4
> github.com/emersion/go-imap-idle v0.0.0-20190519112320-2704abd7050e
> + github.com/emersion/go-imap-sortthread v1.1.0
> github.com/emersion/go-maildir v0.2.0
> github.com/emersion/go-message v0.12.1-0.20200824204225-9094bd0b8bc0
> github.com/emersion/go-pgpmail v0.0.0-20200303213726-db035a3a4139
> diff --git a/go.sum b/go.sum
> index 147ad50..125c012 100644
> --- a/go.sum
> +++ b/go.sum
> @@ -15,18 +15,23 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
> github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
> github.com/ddevault/go-libvterm v0.0.0-20190526194226-b7d861da3810 h1:VlHKuIrEvuGlED53TkovT4AVUjrqTyeCt3wiqw1OsFc=
> github.com/ddevault/go-libvterm v0.0.0-20190526194226-b7d861da3810/go.mod h1:Ow1oE1Hr4xE7eWY2/Ih2kbcOyyXDH7G0XKv/I4yiCYs=
> +github.com/emersion/go-imap v1.0.0/go.mod h1:MEiDDwwQFcZ+L45Pa68jNGv0qU9kbW+SJzwDpvSfX1s=
> github.com/emersion/go-imap v1.0.4 h1:uiCAIHM6Z5Jwkma1zdNDWWXxSCqb+/xHBkHflD7XBro=
> github.com/emersion/go-imap v1.0.4/go.mod h1:yKASt+C3ZiDAiCSssxg9caIckWF/JG7ZQTO7GAmvicU=
> github.com/emersion/go-imap-idle v0.0.0-20190519112320-2704abd7050e h1:L7bswVJZcf2YHofgom49oFRwVqmBj/qZqDy9/SJpZMY=
> github.com/emersion/go-imap-idle v0.0.0-20190519112320-2704abd7050e/go.mod h1:o14zPKCmEH5WC1vU5SdPoZGgNvQx7zzKSnxPQlobo78=
> +github.com/emersion/go-imap-sortthread v1.1.0 h1:uRbmnQkeRny5ihKfLWBPJ/1jJdTZnCdh1zYpOagbubw=
> +github.com/emersion/go-imap-sortthread v1.1.0/go.mod h1:opHOzblOHZKQM1JEy+GPk1217giNLa7kleyWTN06qnc=
d020d96306b3e5b63736fc90a1a8d881b3c71838 fixes a bug and would be
helpful to include
> github.com/emersion/go-maildir v0.2.0 h1:fC4+UVGl8GcQGbFF7AWab2JMf4VbKz+bMNv07xxhzs8=
> github.com/emersion/go-maildir v0.2.0/go.mod h1:I2j27lND/SRLgxROe50Vam81MSaqPFvJ0OHNnDZ7n84=
> +github.com/emersion/go-message v0.10.4-0.20190609165112-592ace5bc1ca/go.mod h1:3h+HsGTCFHmk4ngJ2IV/YPhdlaOcR6hcgqM3yca9v7c=
> github.com/emersion/go-message v0.11.1 h1:0C/S4JIXDTSfXB1vpqdimAYyK4+79fgEAMQ0dSL+Kac=
> github.com/emersion/go-message v0.11.1/go.mod h1:C4jnca5HOTo4bGN9YdqNQM9sITuT3Y0K6bSUw9RklvY=
> github.com/emersion/go-message v0.12.1-0.20200824204225-9094bd0b8bc0 h1:G2VV/Wp2opDvR0ecue3UY/IX1/8OlTmMKKi+ENe1nG0=
> github.com/emersion/go-message v0.12.1-0.20200824204225-9094bd0b8bc0/go.mod h1:C4jnca5HOTo4bGN9YdqNQM9sITuT3Y0K6bSUw9RklvY=
> github.com/emersion/go-pgpmail v0.0.0-20200303213726-db035a3a4139 h1:JTUbkRuQFtDrl5KHWR2jrh9SUeSDEEEjUcHJkXdAE2Q=
> github.com/emersion/go-pgpmail v0.0.0-20200303213726-db035a3a4139/go.mod h1:+Ovy1VQCUKPdjWkOiWvFoiFaWXkqn1PA793VvfEYWQU=
> +github.com/emersion/go-sasl v0.0.0-20190520160400-47d427600317/go.mod h1:G/dpzLu16WtQpBfQ/z3LYiYJn3ZhKSGWn83fyoyQe/k=
> github.com/emersion/go-sasl v0.0.0-20190817083125-240c8404624e/go.mod h1:G/dpzLu16WtQpBfQ/z3LYiYJn3ZhKSGWn83fyoyQe/k=
> github.com/emersion/go-sasl v0.0.0-20191210011802-430746ea8b9b h1:uhWtEWBHgop1rqEk2klKaxPAkVDCXexai6hSuRQ7Nvs=
> github.com/emersion/go-sasl v0.0.0-20191210011802-430746ea8b9b/go.mod h1:G/dpzLu16WtQpBfQ/z3LYiYJn3ZhKSGWn83fyoyQe/k=
> @@ -58,6 +63,7 @@ github.com/kyoh86/xdg v1.2.0/go.mod h1:/mg8zwu1+qe76oTFUBnyS7rJzk7LLC0VGEzJyJ19D
> github.com/lucasb-eyer/go-colorful v1.0.2/go.mod h1:0MS4r+7BZKSJ5mw4/S5MPN+qHFF1fYclkSPilDOKW0s=
> github.com/lucasb-eyer/go-colorful v1.0.3 h1:QIbQXiugsb+q10B+MI+7DI1oQLdmnep86tWFlaaUAac=
> github.com/lucasb-eyer/go-colorful v1.0.3/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
> +github.com/martinlindhe/base36 v0.0.0-20190418230009-7c6542dfbb41/go.mod h1:+AtEs8xrBpCeYgSLoY/aJ6Wf37jtBuR0s35750M27+8=
> github.com/martinlindhe/base36 v1.0.0 h1:eYsumTah144C0A8P1T/AVSUk5ZoLnhfYFM3OGQxB52A=
> github.com/martinlindhe/base36 v1.0.0/go.mod h1:+AtEs8xrBpCeYgSLoY/aJ6Wf37jtBuR0s35750M27+8=
> github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
> diff --git a/worker/imap/open.go b/worker/imap/open.go
> index 0602a7f..4605eb9 100644
> --- a/worker/imap/open.go
> +++ b/worker/imap/open.go
> @@ -2,6 +2,7 @@ package imap
>
> import (
> "github.com/emersion/go-imap"
> + sortthread "github.com/emersion/go-imap-sortthread"
>
> "git.sr.ht/~sircmpwn/aerc/worker/types"
> )
> @@ -30,9 +31,29 @@ func (imapw *IMAPWorker) handleFetchDirectoryContents(
>
> seqSet := &imap.SeqSet{}
> seqSet.AddRange(1, imapw.selected.Messages)
> - uids, err := imapw.client.UidSearch(&imap.SearchCriteria{
> +
> + searchCriteria := &imap.SearchCriteria{
> SeqNum: seqSet,
> - })
> + }
> + sortCriteria := translageSortCriterions(msg.SortCriteria)
"translageSortCriterions" -> "translateSortCriterions"
> +
> + var uids []uint32
> +
> + // If the server supports the SORT extension, do the sorting server side
> + ok, err := imapw.client.sort.SupportSort()
> + if err == nil && ok && len(sortCriteria) > 0 {
> + uids, err = imapw.client.sort.UidSort(sortCriteria, searchCriteria)
> + // copy in reverse as msgList displays backwards
> + for i, j := 0, len(uids)-1; i < j; i, j = i+1, j-1 {
> + uids[i], uids[j] = uids[j], uids[i]
> + }
> + } else {
> + if err != nil {
> + // Non fatal, but we do want to print to get some debug info
> + imapw.worker.Logger.Printf("can't check for SORT support: %v", err)
> + }
> + uids, err = imapw.client.UidSearch(searchCriteria)
> + }
> if err != nil {
> imapw.worker.PostMessage(&types.Error{
> Message: types.RespondTo(msg),
> @@ -50,3 +71,27 @@ func (imapw *IMAPWorker) handleFetchDirectoryContents(
> imapw.worker.PostMessage(&types.Done{types.RespondTo(msg)}, nil)
> }
> }
> +
> +type sortFieldMapT map[types.SortField]sortthread.SortField
> +
> +// caution, incomplete mapping
> +var sortFieldMap sortFieldMapT = sortFieldMapT{
> + types.SortArrival: sortthread.SortArrival,
> + types.SortCc: sortthread.SortCc,
> + types.SortDate: sortthread.SortDate,
> + types.SortFrom: sortthread.SortFrom,
> + types.SortSize: sortthread.SortSize,
> + types.SortSubject: sortthread.SortSubject,
> + types.SortTo: sortthread.SortTo,
> +}
> +
> +func translageSortCriterions(
"translageSortCriterions" -> "translateSortCriterions"
> + cs []*types.SortCriterion) []sortthread.SortCriterion {
> + result := make([]sortthread.SortCriterion, 0, len(cs))
> + for _, c := range cs {
> + if f, ok := sortFieldMap[c.Field]; ok {
> + result = append(result, sortthread.SortCriterion{f, c.Reverse})
> + }
> + }
> + return result
> +}
> diff --git a/worker/imap/worker.go b/worker/imap/worker.go
> index c016af6..dab0afb 100644
> --- a/worker/imap/worker.go
> +++ b/worker/imap/worker.go
> @@ -8,6 +8,7 @@ import (
>
> "github.com/emersion/go-imap"
> idle "github.com/emersion/go-imap-idle"
> + sortthread "github.com/emersion/go-imap-sortthread"
> "github.com/emersion/go-imap/client"
> "golang.org/x/oauth2"
>
> @@ -27,6 +28,7 @@ var errUnsupported = fmt.Errorf("unsupported command")
> type imapClient struct {
> *client.Client
> idle *idle.IdleClient
> + sort *sortthread.SortClient
> }
>
> type IMAPWorker struct {
> @@ -155,7 +157,7 @@ func (w *IMAPWorker) handleMessage(msg types.WorkerMessage) error {
> }
>
> c.Updates = w.updates
> - w.client = &imapClient{c, idle.NewClient(c)}
> + w.client = &imapClient{c, idle.NewClient(c), sortthread.NewSortClient(c)}
> w.worker.PostMessage(&types.Done{types.RespondTo(msg)}, nil)
> case *types.ListDirectories:
> w.handleListDirectories(msg)
> --
> 2.28.0