From 781820627f1cb87df898d1a7b5f3b56c6fa20b77 Mon Sep 17 00:00:00 2001 From: Tim Culverhouse Date: Tue, 29 Aug 2023 13:15:46 -0500 Subject: notmuch: replace notmuch library with internal bindings Replace the notmuch library used with our internal bindings. Signed-off-by: Tim Culverhouse Acked-by: Robin Jarry --- worker/notmuch/eventhandlers.go | 5 + worker/notmuch/lib/database.go | 502 ++++++++++++++++------------------------ worker/notmuch/worker.go | 19 +- 3 files changed, 210 insertions(+), 316 deletions(-) (limited to 'worker') diff --git a/worker/notmuch/eventhandlers.go b/worker/notmuch/eventhandlers.go index a6ab7668..d4d75628 100644 --- a/worker/notmuch/eventhandlers.go +++ b/worker/notmuch/eventhandlers.go @@ -21,6 +21,11 @@ func (w *worker) handleNotmuchEvent(et eventType) error { } func (w *worker) handleUpdateDirCounts() error { + err := w.db.Connect() + if err != nil { + return err + } + defer w.db.Close() if w.store != nil { folders, err := w.store.FolderMap() if err != nil { diff --git a/worker/notmuch/lib/database.go b/worker/notmuch/lib/database.go index 6ca8b25c..501f39de 100644 --- a/worker/notmuch/lib/database.go +++ b/worker/notmuch/lib/database.go @@ -7,179 +7,128 @@ import ( "context" "errors" "fmt" - "time" + "git.sr.ht/~rjarry/aerc/lib/notmuch" "git.sr.ht/~rjarry/aerc/lib/uidstore" "git.sr.ht/~rjarry/aerc/log" "git.sr.ht/~rjarry/aerc/worker/types" - notmuch "github.com/zenhack/go.notmuch" ) -const MAX_DB_AGE time.Duration = 10 * time.Second - type DB struct { path string excludedTags []string - lastOpenTime time.Time - db *notmuch.DB + db *notmuch.Database uidStore *uidstore.Store } func NewDB(path string, excludedTags []string) *DB { + nm := ¬much.Database{ + Path: path, + } db := &DB{ path: path, excludedTags: excludedTags, uidStore: uidstore.NewStore(), + db: nm, } return db } func (db *DB) Connect() error { - // used as sanity check upon initial connect - err := db.connect(false) - return err + return db.db.Open(notmuch.MODE_READ_ONLY) } -func (db *DB) close() error { - if db.db == nil { - return nil - } - err := db.db.Close() - db.db = nil - return err -} - -func (db *DB) connect(writable bool) error { - var mode notmuch.DBMode = notmuch.DBReadOnly - if writable { - mode = notmuch.DBReadWrite - } - var err error - db.db, err = notmuch.Open(db.path, mode) - if err != nil { - return fmt.Errorf("could not connect to notmuch db: %w", err) - } - db.lastOpenTime = time.Now() - return nil +func (db *DB) Close() error { + return db.db.Close() } // Returns the DB path func (db *DB) Path() string { - return db.db.Path() -} - -// withConnection calls callback on the DB object, cleaning up upon return. -// the error returned is from the connection attempt, if not successful, -// or from the callback otherwise. -func (db *DB) withConnection(writable bool, cb func(*notmuch.DB) error) error { - too_old := time.Now().After(db.lastOpenTime.Add(MAX_DB_AGE)) - if db.db == nil || writable || too_old { - if cerr := db.close(); cerr != nil { - log.Errorf("failed to close the notmuch db: %v", cerr) - } - err := db.connect(writable) - if err != nil { - log.Errorf("failed to open the notmuch db: %v", err) - return err - } - } - err := cb(db.db) - if writable { - // we need to close to commit the changes, else we block others - if cerr := db.close(); cerr != nil { - log.Errorf("failed to close the notmuch db: %v", cerr) - } - } - return err + return db.db.ResolvedPath() } // ListTags lists all known tags -func (db *DB) ListTags() ([]string, error) { - var result []string - err := db.withConnection(false, func(ndb *notmuch.DB) error { - tags, err := ndb.Tags() - if err != nil { - return err - } - defer tags.Close() - var tag *notmuch.Tag - for tags.Next(&tag) { - result = append(result, tag.Value) - } - return nil - }) - return result, err +func (db *DB) ListTags() []string { + return db.db.Tags() } // getQuery returns a query based on the provided query string. // It also configures the query as specified on the worker -func (db *DB) newQuery(ndb *notmuch.DB, query string) (*notmuch.Query, error) { - q := ndb.NewQuery(query) - q.SetExcludeScheme(notmuch.EXCLUDE_ALL) - q.SetSortScheme(notmuch.SORT_OLDEST_FIRST) +func (db *DB) newQuery(query string) (*notmuch.Query, error) { + q, err := db.db.Query(query) + if err != nil { + return nil, err + } + q.Exclude(notmuch.EXCLUDE_ALL) + q.Sort(notmuch.SORT_OLDEST_FIRST) for _, t := range db.excludedTags { - err := q.AddTagExclude(t) - if err != nil && !errors.Is(err, notmuch.ErrIgnored) { + err := q.ExcludeTag(t) + if err != nil { return nil, err } } - return q, nil + return &q, nil } func (db *DB) MsgIDFromFilename(filename string) (string, error) { - var key string - - err := db.withConnection(false, func(ndb *notmuch.DB) error { - msg, err := ndb.FindMessageByFilename(filename) - if err != nil && !errors.Is(err, notmuch.ErrDuplicateMessageID) { - return err - } - defer msg.Close() - key = msg.ID() - return nil - }) - - return key, err + msg, err := db.db.FindMessageByFilename(filename) + if err != nil { + return "", err + } + defer msg.Close() + return msg.ID(), nil } func (db *DB) MsgIDsFromQuery(ctx context.Context, q string) ([]string, error) { + query, err := db.newQuery(q) + if err != nil { + return nil, err + } + defer query.Close() + messages, err := query.Messages() + if err != nil { + return nil, err + } + defer messages.Close() var msgIDs []string - err := db.withConnection(false, func(ndb *notmuch.DB) error { - query, err := db.newQuery(ndb, q) - if err != nil { - return err + for messages.Next() { + select { + case <-ctx.Done(): + return nil, context.Canceled + default: + msg := messages.Message() + defer msg.Close() + msgIDs = append(msgIDs, msg.ID()) } - defer query.Close() - msgIDs, err = msgIdsFromQuery(ctx, query) - return err - }) + } return msgIDs, err } func (db *DB) ThreadsFromQuery(ctx context.Context, q string) ([]*types.Thread, error) { + query, err := db.newQuery(q) + if err != nil { + return nil, err + } + defer query.Close() + threads, err := query.Threads() + if err != nil { + return nil, err + } + defer threads.Close() var res []*types.Thread - err := db.withConnection(false, func(ndb *notmuch.DB) error { - query, err := db.newQuery(ndb, q) - if err != nil { - return err - } - defer query.Close() - qMsgIDs, err := msgIdsFromQuery(ctx, query) - if err != nil { - return err - } - valid := make(map[string]struct{}) - for _, id := range qMsgIDs { - valid[id] = struct{}{} - } - threads, err := query.Threads() - if err != nil { - return err + for threads.Next() { + select { + case <-ctx.Done(): + return nil, context.Canceled + default: + thread := threads.Thread() + tlm := thread.TopLevelMessages() + root := db.makeThread(nil, &tlm) + res = append(res, root) + tlm.Close() + thread.Close() } - defer threads.Close() - res, err = db.enumerateThread(ctx, threads, valid) - return err - }) + } return res, err } @@ -189,180 +138,147 @@ type MessageCount struct { } func (db *DB) QueryCountMessages(q string) (MessageCount, error) { - var ( - exists int - unread int - ) - err := db.withConnection(false, func(ndb *notmuch.DB) error { - query, err := db.newQuery(ndb, q) - if err != nil { - return err - } - exists = query.CountMessages() - query.Close() - uq, err := db.newQuery(ndb, fmt.Sprintf("(%v) and (tag:unread)", q)) - if err != nil { - return err - } - defer uq.Close() - unread = uq.CountMessages() - return nil - }) - return MessageCount{ - Exists: exists, - Unread: unread, - }, err + count := MessageCount{} + query, err := db.newQuery(q) + if err != nil { + return count, err + } + defer query.Close() + count.Exists, err = query.CountMessages() + if err != nil { + return count, err + } + + unreadQuery, err := db.newQuery(fmt.Sprintf("(%v) and (tag:unread)", q)) + if err != nil { + return count, err + } + defer unreadQuery.Close() + count.Unread, err = unreadQuery.CountMessages() + if err != nil { + return count, err + } + + return count, nil } func (db *DB) MsgFilename(key string) (string, error) { - var filename string - err := db.withConnection(false, func(ndb *notmuch.DB) error { - msg, err := ndb.FindMessage(key) - if err != nil { - return err - } - defer msg.Close() - filename = msg.Filename() - return nil - }) - return filename, err + msg, err := db.db.FindMessageByID(key) + if err != nil { + return "", err + } + defer msg.Close() + return msg.Filename(), nil } func (db *DB) MsgTags(key string) ([]string, error) { - var tags []string - err := db.withConnection(false, func(ndb *notmuch.DB) error { - msg, err := ndb.FindMessage(key) - if err != nil { - return err - } - defer msg.Close() - ts := msg.Tags() - defer ts.Close() - var tag *notmuch.Tag - for ts.Next(&tag) { - tags = append(tags, tag.Value) - } - return nil - }) - return tags, err + msg, err := db.db.FindMessageByID(key) + if err != nil { + return nil, err + } + defer msg.Close() + return msg.Tags(), nil } func (db *DB) MsgFilenames(key string) ([]string, error) { - var filenames []string - - err := db.withConnection(false, func(ndb *notmuch.DB) error { - msg, err := ndb.FindMessage(key) - if err != nil { - return err - } - defer msg.Close() - - fns := msg.Filenames() - var filename string - for fns.Next(&filename) { - if err != nil && !errors.Is(err, notmuch.ErrDuplicateMessageID) { - return err - } - filenames = append(filenames, filename) - } - - return nil - }) - - return filenames, err + msg, err := db.db.FindMessageByID(key) + if err != nil { + return nil, err + } + defer msg.Close() + return msg.Filenames(), nil } func (db *DB) DeleteMessage(filename string) error { - return db.withConnection(true, func(ndb *notmuch.DB) error { - err := ndb.RemoveMessage(filename) - if err != nil && !errors.Is(err, notmuch.ErrDuplicateMessageID) { - return err + err := db.db.Reopen(notmuch.MODE_READ_WRITE) + if err != nil { + return err + } + defer func() { + if err := db.db.Reopen(notmuch.MODE_READ_ONLY); err != nil { + log.Errorf("couldn't reopen: %s", err) } - - return nil - }) + }() + err = db.db.BeginAtomic() + if err != nil { + return err + } + defer func() { + if err := db.db.EndAtomic(); err != nil { + log.Errorf("couldn't end atomic: %s", err) + } + }() + err = db.db.RemoveFile(filename) + if err != nil && errors.Is(err, notmuch.STATUS_DUPLICATE_MESSAGE_ID) { + return err + } + return nil } func (db *DB) IndexFile(filename string) (string, error) { - var key string - - err := db.withConnection(true, func(ndb *notmuch.DB) error { - msg, err := ndb.AddMessage(filename) - if err != nil && !errors.Is(err, notmuch.ErrDuplicateMessageID) { - return err + err := db.db.Reopen(notmuch.MODE_READ_WRITE) + if err != nil { + return "", err + } + defer func() { + if err := db.db.Reopen(notmuch.MODE_READ_ONLY); err != nil { + log.Errorf("couldn't reopen: %s", err) } - defer msg.Close() - if err := msg.MaildirFlagsToTags(); err != nil { - return err + }() + err = db.db.BeginAtomic() + if err != nil { + return "", err + } + defer func() { + if err := db.db.EndAtomic(); err != nil { + log.Errorf("couldn't end atomic: %s", err) } - key = msg.ID() - return nil - }) - return key, err + }() + msg, err := db.db.IndexFile(filename) + if err != nil { + return "", err + } + defer msg.Close() + return msg.ID(), nil } -func (db *DB) msgModify(key string, - cb func(*notmuch.Message) error, -) error { - err := db.withConnection(true, func(ndb *notmuch.DB) error { - msg, err := ndb.FindMessage(key) - if err != nil { - return err +func (db *DB) MsgModifyTags(key string, add, remove []string) error { + err := db.db.Reopen(notmuch.MODE_READ_WRITE) + if err != nil { + return err + } + defer func() { + if err := db.db.Reopen(notmuch.MODE_READ_ONLY); err != nil { + log.Errorf("couldn't reopen: %s", err) } - defer msg.Close() - - err = cb(msg) - if err != nil { - log.Warnf("callback failed: %v", err) + }() + err = db.db.BeginAtomic() + if err != nil { + return err + } + defer func() { + if err := db.db.EndAtomic(); err != nil { + log.Errorf("couldn't end atomic: %s", err) } - - err = msg.TagsToMaildirFlags() + }() + msg, err := db.db.FindMessageByID(key) + if err != nil { + return err + } + defer msg.Close() + for _, tag := range add { + err := msg.AddTag(tag) if err != nil { - log.Errorf("could not sync maildir flags: %v", err) + log.Warnf("failed to add tag: %v", err) } - return nil - }) - return err -} - -func (db *DB) MsgModifyTags(key string, add, remove []string) error { - err := db.msgModify(key, func(msg *notmuch.Message) error { - ierr := msg.Atomic(func(msg *notmuch.Message) { - for _, t := range add { - err := msg.AddTag(t) - if err != nil { - log.Warnf("failed to add tag: %v", err) - } - } - for _, t := range remove { - err := msg.RemoveTag(t) - if err != nil { - log.Warnf("failed to remove tag: %v", err) - } - } - }) - return ierr - }) - return err -} - -func msgIdsFromQuery(ctx context.Context, query *notmuch.Query) ([]string, error) { - var msgIDs []string - msgs, err := query.Messages() - if err != nil { - return nil, err } - defer msgs.Close() - var msg *notmuch.Message - for msgs.Next(&msg) { - select { - case <-ctx.Done(): - return nil, context.Canceled - default: - msgIDs = append(msgIDs, msg.ID()) + for _, tag := range remove { + err := msg.RemoveTag(tag) + if err != nil { + log.Warnf("failed to add tag: %v", err) } } - return msgIDs, nil + return msg.SyncTagsToMaildirFlags() } func (db *DB) UidFromKey(key string) uint32 { @@ -373,49 +289,27 @@ func (db *DB) KeyFromUid(uid uint32) (string, bool) { return db.uidStore.GetKey(uid) } -func (db *DB) enumerateThread(ctx context.Context, nt *notmuch.Threads, - valid map[string]struct{}, -) ([]*types.Thread, error) { - var res []*types.Thread - var thread *notmuch.Thread - for nt.Next(&thread) { - select { - case <-ctx.Done(): - return nil, context.Canceled - default: - root := db.makeThread(nil, thread.TopLevelMessages(), valid) - res = append(res, root) - } - } - return res, nil -} - -func (db *DB) makeThread(parent *types.Thread, msgs *notmuch.Messages, - valid map[string]struct{}, -) *types.Thread { +func (db *DB) makeThread(parent *types.Thread, msgs *notmuch.Messages) *types.Thread { var lastSibling *types.Thread - var msg *notmuch.Message - for msgs.Next(&msg) { + for msgs.Next() { + msg := msgs.Message() + defer msg.Close() msgID := msg.ID() - _, inQuery := valid[msgID] - var noReplies bool - replies, err := msg.Replies() - // Replies() returns an error if there are no replies + match, err := msg.Flag(notmuch.MESSAGE_FLAG_MATCH) if err != nil { - noReplies = true + log.Errorf("%s", err) + continue } - if !inQuery { - if noReplies { - continue - } - defer replies.Close() - parent = db.makeThread(parent, replies, valid) + replies := msg.Replies() + defer replies.Close() + if !match { + parent = db.makeThread(parent, &replies) continue } node := &types.Thread{ Uid: db.uidStore.GetOrInsert(msgID), Parent: parent, - Hidden: !inQuery, + Hidden: !match, } if parent != nil && parent.FirstChild == nil { parent.FirstChild = node @@ -429,11 +323,7 @@ func (db *DB) makeThread(parent *types.Thread, msgs *notmuch.Messages, lastSibling.NextSibling = node } lastSibling = node - if noReplies { - continue - } - defer replies.Close() - db.makeThread(node, replies, valid) + db.makeThread(node, &replies) } // We want to return the root node diff --git a/worker/notmuch/worker.go b/worker/notmuch/worker.go index 73aa0efe..51de6ccb 100644 --- a/worker/notmuch/worker.go +++ b/worker/notmuch/worker.go @@ -144,6 +144,13 @@ func (w *worker) handleMessage(msg types.WorkerMessage) error { return w.setupErr } } + if w.db != nil { + err := w.db.Connect() + if err != nil { + return err + } + defer w.db.Close() + } switch msg := msg.(type) { case *types.Unsupported: @@ -236,16 +243,12 @@ func (w *worker) handleConfigure(msg *types.Configure) error { } func (w *worker) handleConnect(msg *types.Connect) error { - err := w.db.Connect() - if err != nil { - return err - } w.done(msg) w.emitLabelList() // Watch all the files in the xapian folder for changes. We'll debounce // changes, so catching multiple is ok dbPath := path.Join(w.db.Path(), ".notmuch", "xapian") - err = w.watcher.Configure(dbPath) + err := w.watcher.Configure(dbPath) if err != nil { return err } @@ -714,11 +717,7 @@ func (w *worker) emitMessageInfo(m *Message, } func (w *worker) emitLabelList() { - tags, err := w.db.ListTags() - if err != nil { - w.w.Errorf("could not load tags: %v", err) - return - } + tags := w.db.ListTags() w.w.PostMessage(&types.LabelList{Labels: tags}, nil) } -- cgit