aboutsummaryrefslogtreecommitdiff
path: root/worker/notmuch
diff options
context:
space:
mode:
Diffstat (limited to 'worker/notmuch')
-rw-r--r--worker/notmuch/message.go123
-rw-r--r--worker/notmuch/worker.go393
2 files changed, 516 insertions, 0 deletions
diff --git a/worker/notmuch/message.go b/worker/notmuch/message.go
new file mode 100644
index 0000000..077fb92
--- /dev/null
+++ b/worker/notmuch/message.go
@@ -0,0 +1,123 @@
+//+build notmuch
+
+package notmuch
+
+import (
+ "bytes"
+ "fmt"
+ "io"
+ "io/ioutil"
+ "os"
+
+ "git.sr.ht/~sircmpwn/aerc/models"
+ "git.sr.ht/~sircmpwn/aerc/worker/lib"
+ "github.com/emersion/go-message"
+ _ "github.com/emersion/go-message/charset"
+ notmuch "github.com/zenhack/go.notmuch"
+)
+
+type Message struct {
+ uid uint32
+ key string
+ msg *notmuch.Message
+}
+
+// NewReader reads a message into memory and returns an io.Reader for it.
+func (m Message) NewReader() (io.Reader, error) {
+ f, err := os.Open(m.msg.Filename())
+ if err != nil {
+ return nil, err
+ }
+ defer f.Close()
+ b, err := ioutil.ReadAll(f)
+ if err != nil {
+ return nil, err
+ }
+ return bytes.NewReader(b), nil
+}
+
+// MessageInfo populates a models.MessageInfo struct for the message.
+func (m Message) MessageInfo() (*models.MessageInfo, error) {
+ return lib.MessageInfo(m)
+}
+
+// NewBodyPartReader creates a new io.Reader for the requested body part(s) of
+// the message.
+func (m Message) NewBodyPartReader(requestedParts []int) (io.Reader, error) {
+ f, err := os.Open(m.msg.Filename())
+ if err != nil {
+ return nil, err
+ }
+ defer f.Close()
+ msg, err := message.Read(f)
+ if err != nil {
+ return nil, fmt.Errorf("could not read message: %v", err)
+ }
+ return lib.FetchEntityPartReader(msg, requestedParts)
+}
+
+// MarkRead either adds or removes the maildir.FlagSeen flag from the message.
+func (m Message) MarkRead(seen bool) error {
+ haveUnread := false
+ for _, t := range m.tags() {
+ if t == "unread" {
+ haveUnread = true
+ break
+ }
+ }
+ if (haveUnread && !seen) || (!haveUnread && seen) {
+ // we already have the desired state
+ return nil
+ }
+
+ if haveUnread {
+ err := m.msg.RemoveTag("unread")
+ if err != nil {
+ return err
+ }
+ return nil
+ }
+
+ err := m.msg.AddTag("unread")
+ if err != nil {
+ return err
+ }
+ return nil
+}
+
+// tags returns the notmuch tags of a message
+func (m Message) tags() []string {
+ ts := m.msg.Tags()
+ var tags []string
+ var tag *notmuch.Tag
+ for ts.Next(&tag) {
+ tags = append(tags, tag.Value)
+ }
+ return tags
+}
+
+func (m Message) ModelFlags() ([]models.Flag, error) {
+ var flags []models.Flag
+ seen := true
+
+ for _, tag := range m.tags() {
+ switch tag {
+ case "replied":
+ flags = append(flags, models.AnsweredFlag)
+ case "flagged":
+ flags = append(flags, models.FlaggedFlag)
+ case "unread":
+ seen = false
+ default:
+ continue
+ }
+ }
+ if seen {
+ flags = append(flags, models.SeenFlag)
+ }
+ return flags, nil
+}
+
+func (m Message) UID() uint32 {
+ return m.uid
+}
diff --git a/worker/notmuch/worker.go b/worker/notmuch/worker.go
new file mode 100644
index 0000000..6187b24
--- /dev/null
+++ b/worker/notmuch/worker.go
@@ -0,0 +1,393 @@
+//+build notmuch
+
+package notmuch
+
+import (
+ "bufio"
+ "fmt"
+ "net/url"
+ "os"
+ "path/filepath"
+ "strings"
+
+ "git.sr.ht/~sircmpwn/aerc/config"
+ "git.sr.ht/~sircmpwn/aerc/lib/uidstore"
+ "git.sr.ht/~sircmpwn/aerc/models"
+ "git.sr.ht/~sircmpwn/aerc/worker/handlers"
+ "git.sr.ht/~sircmpwn/aerc/worker/types"
+ "github.com/mitchellh/go-homedir"
+ notmuch "github.com/zenhack/go.notmuch"
+)
+
+func init() {
+ handlers.RegisterWorkerFactory("notmuch", NewWorker)
+}
+
+var errUnsupported = fmt.Errorf("unsupported command")
+
+type worker struct {
+ w *types.Worker
+ pathToDB string
+ db *notmuch.DB
+ selected *notmuch.Query
+ uidStore *uidstore.Store
+ excludedTags []string
+ nameQueryMap map[string]string
+}
+
+// NewWorker creates a new maildir worker with the provided worker.
+func NewWorker(w *types.Worker) (types.Backend, error) {
+ return &worker{w: w}, nil
+}
+
+// Run starts the worker's message handling loop.
+func (w *worker) Run() {
+ for {
+ action := <-w.w.Actions
+ msg := w.w.ProcessAction(action)
+ if err := w.handleMessage(msg); err == errUnsupported {
+ w.w.PostMessage(&types.Unsupported{
+ Message: types.RespondTo(msg),
+ }, nil)
+ } else if err != nil {
+ w.w.PostMessage(&types.Error{
+ Message: types.RespondTo(msg),
+ Error: err,
+ }, nil)
+ }
+ }
+}
+
+func (w *worker) done(msg types.WorkerMessage) {
+ w.w.PostMessage(&types.Done{types.RespondTo(msg)}, nil)
+}
+
+func (w *worker) err(msg types.WorkerMessage, err error) {
+ w.w.PostMessage(&types.Error{
+ Message: types.RespondTo(msg),
+ Error: err,
+ }, nil)
+}
+func (w *worker) handleMessage(msg types.WorkerMessage) error {
+ switch msg := msg.(type) {
+ case *types.Unsupported:
+ // No-op
+ case *types.Configure:
+ return w.handleConfigure(msg)
+ case *types.Connect:
+ return w.handleConnect(msg)
+ case *types.ListDirectories:
+ return w.handleListDirectories(msg)
+ case *types.OpenDirectory:
+ return w.handleOpenDirectory(msg)
+ case *types.FetchDirectoryContents:
+ return w.handleFetchDirectoryContents(msg)
+ case *types.FetchMessageHeaders:
+ return w.handleFetchMessageHeaders(msg)
+ case *types.FetchMessageBodyPart:
+ return w.handleFetchMessageBodyPart(msg)
+ case *types.FetchFullMessages:
+ return w.handleFetchFullMessages(msg)
+ case *types.ReadMessages:
+ return w.handleReadMessages(msg)
+ // TODO
+ // return w.handleSearchDirectory(msg)
+ // case *types.DeleteMessages:
+
+ // not implemented, they are generally not used
+ // in a notmuch based workflow
+ // case *types.CopyMessages:
+ // return w.handleCopyMessages(msg)
+ // case *types.AppendMessage:
+ // return w.handleAppendMessage(msg)
+ // case *types.CreateDirectory:
+ // return w.handleCreateDirectory(msg)
+ }
+ return errUnsupported
+}
+
+func (w *worker) handleConfigure(msg *types.Configure) error {
+ u, err := url.Parse(msg.Config.Source)
+ if err != nil {
+ w.w.Logger.Printf("error configuring notmuch worker: %v", err)
+ return err
+ }
+ home, err := homedir.Expand(u.Hostname())
+ if err != nil {
+ return fmt.Errorf("could not resolve home directory: %v", err)
+ }
+ w.pathToDB = filepath.Join(home, u.Path)
+ w.uidStore = uidstore.NewStore()
+
+ if err = w.loadQueryMap(msg.Config); err != nil {
+ return fmt.Errorf("could not load query map: %v", err)
+ }
+ if err = w.loadExcludeTags(msg.Config); err != nil {
+ return fmt.Errorf("could not load excluded tags: %v", err)
+ }
+ w.w.Logger.Printf("configured db directory: %s", w.pathToDB)
+ return nil
+}
+
+func (w *worker) handleConnect(msg *types.Connect) error {
+ var err error
+ w.db, err = notmuch.Open(w.pathToDB, notmuch.DBReadWrite)
+ if err != nil {
+ return fmt.Errorf("could not connect to notmuch db: %v", err)
+ }
+ w.done(msg)
+ return nil
+}
+
+func (w *worker) handleListDirectories(msg *types.ListDirectories) error {
+ for name := range w.nameQueryMap {
+ w.w.PostMessage(&types.Directory{
+ Message: types.RespondTo(msg),
+ Dir: &models.Directory{
+ Name: name,
+ Attributes: []string{},
+ },
+ }, nil)
+ }
+ w.done(msg)
+ return nil
+}
+
+func (w *worker) handleOpenDirectory(msg *types.OpenDirectory) error {
+ w.w.Logger.Printf("opening %s", msg.Directory)
+ // try the friendly name first, if that fails assume it's a query
+ query, ok := w.nameQueryMap[msg.Directory]
+ if !ok {
+ query = msg.Directory
+ }
+ w.selected = w.db.NewQuery(query)
+ w.selected.SetExcludeScheme(notmuch.EXCLUDE_TRUE)
+ w.selected.SetSortScheme(notmuch.SORT_OLDEST_FIRST)
+ for _, t := range w.excludedTags {
+ err := w.selected.AddTagExclude(t)
+ if err != nil && err != notmuch.ErrIgnored {
+ return err
+ }
+ }
+ //TODO: why does this need to be sent twice??
+ info := &types.DirectoryInfo{
+ Info: &models.DirectoryInfo{
+ Name: msg.Directory,
+ Flags: []string{},
+ ReadOnly: false,
+ // total messages
+ Exists: w.selected.CountMessages(),
+ // new messages since mailbox was last opened
+ Recent: 0,
+ // total unread
+ Unseen: 0,
+ },
+ }
+ w.w.PostMessage(info, nil)
+ w.w.PostMessage(info, nil)
+ w.done(msg)
+ return nil
+}
+
+func (w *worker) handleFetchDirectoryContents(
+ msg *types.FetchDirectoryContents) error {
+ uids, err := w.uidsFromQuery(w.selected)
+ if err != nil {
+ w.w.Logger.Printf("error scanning uids: %v", err)
+ return err
+ }
+ w.w.PostMessage(&types.DirectoryContents{
+ Message: types.RespondTo(msg),
+ Uids: uids,
+ }, nil)
+ w.done(msg)
+ return nil
+}
+
+func (w *worker) handleFetchMessageHeaders(
+ msg *types.FetchMessageHeaders) error {
+ for _, uid := range msg.Uids {
+ m, err := w.msgFromUid(uid)
+ if err != nil {
+ w.w.Logger.Printf("could not get message: %v", err)
+ w.err(msg, err)
+ continue
+ }
+ info, err := m.MessageInfo()
+ if err != nil {
+ w.w.Logger.Printf("could not get message info: %v", err)
+ w.err(msg, err)
+ continue
+ }
+ w.w.PostMessage(&types.MessageInfo{
+ Message: types.RespondTo(msg),
+ Info: info,
+ }, nil)
+ }
+ w.done(msg)
+ return nil
+}
+
+func (w *worker) uidsFromQuery(query *notmuch.Query) ([]uint32, error) {
+ msgs, err := query.Messages()
+ if err != nil {
+ return nil, err
+ }
+ var msg *notmuch.Message
+ var uids []uint32
+ for msgs.Next(&msg) {
+ uid := w.uidStore.GetOrInsert(msg.ID())
+ uids = append(uids, uid)
+
+ }
+ return uids, nil
+}
+
+func (w *worker) msgFromUid(uid uint32) (*Message, error) {
+ key, ok := w.uidStore.GetKey(uid)
+ if !ok {
+ return nil, fmt.Errorf("Invalid uid: %v", uid)
+ }
+ nm, err := w.db.FindMessage(key)
+ if err != nil {
+ return nil, fmt.Errorf("Could not fetch message for key %q: %v", key, err)
+ }
+ msg := &Message{
+ key: key,
+ uid: uid,
+ msg: nm,
+ }
+ return msg, nil
+}
+
+func (w *worker) handleFetchMessageBodyPart(
+ msg *types.FetchMessageBodyPart) error {
+
+ m, err := w.msgFromUid(msg.Uid)
+ if err != nil {
+ w.w.Logger.Printf("could not get message %d: %v", msg.Uid, err)
+ return err
+ }
+ r, err := m.NewBodyPartReader(msg.Part)
+ if err != nil {
+ w.w.Logger.Printf(
+ "could not get body part reader for message=%d, parts=%#v: %v",
+ msg.Uid, msg.Part, err)
+ return err
+ }
+ w.w.PostMessage(&types.MessageBodyPart{
+ Message: types.RespondTo(msg),
+ Part: &models.MessageBodyPart{
+ Reader: r,
+ Uid: msg.Uid,
+ },
+ }, nil)
+
+ if err := m.MarkRead(true); err != nil {
+ w.w.Logger.Printf("could not mark message as read: %v", err)
+ return err
+ }
+
+ // send updated flags to ui
+ info, err := m.MessageInfo()
+ if err != nil {
+ w.w.Logger.Printf("could not fetch message info: %v", err)
+ return err
+ }
+ w.w.PostMessage(&types.MessageInfo{
+ Message: types.RespondTo(msg),
+ Info: info,
+ }, nil)
+ w.done(msg)
+ return nil
+}
+
+func (w *worker) handleFetchFullMessages(msg *types.FetchFullMessages) error {
+ for _, uid := range msg.Uids {
+ m, err := w.msgFromUid(uid)
+ if err != nil {
+ w.w.Logger.Printf("could not get message %d: %v", uid, err)
+ return err
+ }
+ r, err := m.NewReader()
+ if err != nil {
+ w.w.Logger.Printf("could not get message reader: %v", err)
+ return err
+ }
+ w.w.PostMessage(&types.FullMessage{
+ Message: types.RespondTo(msg),
+ Content: &models.FullMessage{
+ Uid: uid,
+ Reader: r,
+ },
+ }, nil)
+ }
+ w.done(msg)
+ return nil
+}
+
+func (w *worker) handleReadMessages(msg *types.ReadMessages) error {
+ for _, uid := range msg.Uids {
+ m, err := w.msgFromUid(uid)
+ if err != nil {
+ w.w.Logger.Printf("could not get message: %v", err)
+ w.err(msg, err)
+ continue
+ }
+ if err := m.MarkRead(msg.Read); err != nil {
+ w.w.Logger.Printf("could not mark message as read: %v", err)
+ w.err(msg, err)
+ continue
+ }
+ info, err := m.MessageInfo()
+ if err != nil {
+ w.w.Logger.Printf("could not get message info: %v", err)
+ w.err(msg, err)
+ continue
+ }
+ w.w.PostMessage(&types.MessageInfo{
+ Message: types.RespondTo(msg),
+ Info: info,
+ }, nil)
+ }
+ w.done(msg)
+ return nil
+}
+
+func (w *worker) loadQueryMap(acctConfig *config.AccountConfig) error {
+ raw, ok := acctConfig.Params["query-map"]
+ if !ok {
+ // nothing to do
+ return nil
+ }
+ file, err := homedir.Expand(raw)
+ if err != nil {
+ return err
+ }
+ f, err := os.Open(file)
+ if err != nil {
+ return err
+ }
+ defer f.Close()
+ w.nameQueryMap = make(map[string]string)
+ scanner := bufio.NewScanner(f)
+ for scanner.Scan() {
+ line := scanner.Text()
+ split := strings.SplitN(line, "=", 2)
+ if len(split) != 2 {
+ return fmt.Errorf("invalid line %q, want name=query", line)
+ }
+ w.nameQueryMap[split[0]] = split[1]
+ }
+ return nil
+}
+
+func (w *worker) loadExcludeTags(acctConfig *config.AccountConfig) error {
+ raw, ok := acctConfig.Params["exclude-tags"]
+ if !ok {
+ // nothing to do
+ return nil
+ }
+ w.excludedTags = strings.Split(raw, ",")
+ return nil
+}
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-16 13:17:46 +0000