hooks: add flag-changed

Add the flag-changed hook.

References: https://todo.sr.ht/~rjarry/aerc/136
Changelog-added: New `flag-changed` hook.
Signed-off-by: Bence Ferdinandy <bence@ferdinandy.com>
Acked-by: Robin Jarry <robin@jarry.cc>

5 files changed, 73 insertions, 1 deletions

diff --git a/app/account.go b/app/account.go
index 99739f01..ab5793bc 100644
--- a/app/account.go
+++ b/app/account.go
@@ -292,6 +292,16 @@ func (acct *AccountView) newStore(name string) *lib.MessageStore {
 				msg := fmt.Sprintf("tag-modified hook: %s", err)
 				PushError(msg)
 			}
+		}, func(flagname string) {
+			err := hooks.RunHook(&hooks.FlagChanged{
+				Account:  acct.Name(),
+				Folder:   acct.SelectedDirectory(),
+				FlagName: flagname,
+			})
+			if err != nil {
+				msg := fmt.Sprintf("flag-changed hook: %s", err)
+				PushError(msg)
+			}
 		},
 		acct.updateSplitView,
 		acct.dirlist.UiConfig(name).ThreadContext,
diff --git a/config/hooks.go b/config/hooks.go
index bd053e95..ea291e92 100644
--- a/config/hooks.go
+++ b/config/hooks.go
@@ -8,6 +8,7 @@ import (
 type HooksConfig struct {
 	AercStartup  string `ini:"aerc-startup"`
 	AercShutdown string `ini:"aerc-shutdown"`
+	FlagChanged  string `ini:"flag-changed"`
 	MailReceived string `ini:"mail-received"`
 	MailDeleted  string `ini:"mail-deleted"`
 	MailAdded    string `ini:"mail-added"`
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 3912b3da..d7eb81ee 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -1265,6 +1265,19 @@ They are configured in the *[hooks]* section of aerc.conf.
 	- *AERC_TAG_ADDED*
 	- *AERC_TAG_REMOVED*
 
+*flag-changed* = _<command>_
+	Executed when flags are changed on a message.
+
+	Variables:
+
+	- *AERC_ACCOUNT*
+	- *AERC_FOLDER*
+	- *AERC_FLAG*
+
+	Example:
+
+		*mail-added* = _mbsync "$AERC_ACCOUNT:$AERC_FOLDER"_
+
 # TEMPLATES
 
 Template files are used to populate the body of an email. The *:compose*,
diff --git a/lib/hooks/flag-changed.go b/lib/hooks/flag-changed.go
new file mode 100644
index 00000000..aaeff014
--- /dev/null
+++ b/lib/hooks/flag-changed.go
@@ -0,0 +1,27 @@
+package hooks
+
+import (
+	"fmt"
+
+	"git.sr.ht/~rjarry/aerc/config"
+)
+
+type FlagChanged struct {
+	Account  string
+	Folder   string
+	FlagName string
+}
+
+func (m *FlagChanged) Cmd() string {
+	return config.Hooks.FlagChanged
+}
+
+func (m *FlagChanged) Env() []string {
+	env := []string{
+		fmt.Sprintf("AERC_ACCOUNT=%s", m.Account),
+		fmt.Sprintf("AERC_FOLDER=%s", m.Folder),
+		fmt.Sprintf("AERC_FLAG=%s", m.FlagName),
+	}
+
+	return env
+}
diff --git a/lib/msgstore.go b/lib/msgstore.go
index a906d0cc..f1399e4e 100644
--- a/lib/msgstore.go
+++ b/lib/msgstore.go
@@ -71,6 +71,7 @@ type MessageStore struct {
 	triggerMailDeleted     func()
 	triggerMailAdded       func(string)
 	triggerTagModified     func([]string, []string)
+	triggerFlagChanged     func(string)
 
 	threadBuilderDebounce *time.Timer
 	threadBuilderDelay    time.Duration
@@ -92,6 +93,7 @@ func NewMessageStore(worker *types.Worker,
 	triggerNewEmail func(*models.MessageInfo),
 	triggerDirectoryChange func(), triggerMailDeleted func(),
 	triggerMailAdded func(string), triggerTagModified func([]string, []string),
+	triggerFlagChanged func(string),
 	onSelect func(*models.MessageInfo),
 	threadContext bool,
 ) *MessageStore {
@@ -132,6 +134,7 @@ func NewMessageStore(worker *types.Worker,
 		triggerMailDeleted:     triggerMailDeleted,
 		triggerMailAdded:       triggerMailAdded,
 		triggerTagModified:     triggerTagModified,
+		triggerFlagChanged:     triggerFlagChanged,
 
 		threadBuilderDelay: clientThreadsDelay,
 
@@ -685,7 +688,25 @@ func (store *MessageStore) Flag(uids []uint32, flags models.Flags,
 		Enable: enable,
 		Flags:  flags,
 		Uids:   uids,
-	}, cb)
+	}, func(msg types.WorkerMessage) {
+		var flagName string
+		switch flags {
+		case models.SeenFlag:
+			flagName = "seen"
+		case models.AnsweredFlag:
+			flagName = "answered"
+		case models.FlaggedFlag:
+			flagName = "flagged"
+		case models.DraftFlag:
+			flagName = "draft"
+		}
+		if _, ok := msg.(*types.Done); ok {
+			store.triggerFlagChanged(flagName)
+		}
+		if cb != nil {
+			cb(msg)
+		}
+	})
 }
 
 func (store *MessageStore) Answered(uids []uint32, answered bool,