refactor options to be more generic

bot/bot.go

@@ -61,10 +61,9 @@ func (b *Bot) Error(ctx context.Context, roomID id.RoomID, message string, args
 
 // Notice sends a notice message to the matrix room
 func (b *Bot) Notice(ctx context.Context, roomID id.RoomID, message string, args ...interface{}) {
-	_, err := b.lp.Send(roomID, &event.MessageEventContent{
+	content := format.RenderMarkdown(fmt.Sprintf(message, args...), true, true)
-		MsgType: event.MsgNotice,
+	content.MsgType = event.MsgNotice
-		Body:    fmt.Sprintf(message, args...),
+	_, err := b.lp.Send(roomID, &content)
-	})
 	if err != nil {
 		if sentry.HasHubOnContext(ctx) {
 			sentry.GetHubFromContext(ctx).CaptureException(err)
@@ -102,7 +101,7 @@ func (b *Bot) Send(ctx context.Context, from, to, subject, plaintext, html strin
 	}
 
 	var text strings.Builder
-	if !settings.NoSender {
+	if !utils.Bool(settings.Get("nosender")) {
 		text.WriteString("From: ")
 		text.WriteString(from)
 		text.WriteString("\n\n")

bot/command.go

@@ -31,11 +31,11 @@ func (b *Bot) handleCommand(ctx context.Context, evt *event.Event, command []str
 	case "help":
 		b.sendHelp(ctx, evt.RoomID)
 	case "owner":
-		b.handleOwner(ctx, evt, command)
+		b.handleOption(ctx, evt, command)
 	case "mailbox":
-		b.handleMailbox(ctx, evt, command)
+		b.handleOption(ctx, evt, command)
 	case "nosender":
-		b.handleNoSender(ctx, evt, command)
+		b.handleOption(ctx, evt, command)
 	}
 }
 

bot/data.go

@@ -2,6 +2,7 @@ package bot
 
 import (
 	"context"
+	"strconv"
 	"strings"
 
 	"github.com/getsentry/sentry-go"
@@ -12,8 +13,10 @@ const settingskey = "cc.etke.postmoogle.settings"
 
 var migrations = []string{}
 
-// settings of a room
+type settings map[string]string
-type settings struct {
+
+// settingsStruct of a room
+type settingsOld struct {
 	Mailbox  string
 	Owner    id.UserID
 	NoSender bool
@@ -25,11 +28,22 @@ func (s settings) Allowed(noowner bool, userID id.UserID) bool {
 		return true
 	}
 
-	if s.Owner == "" {
+	owner := s.Get("owner")
+	if owner == "" {
 		return true
 	}
 
-	return s.Owner == userID
+	return owner == userID.String()
+}
+
+// Get option
+func (s settings) Get(key string) string {
+	return s[strings.ToLower(strings.TrimSpace(key))]
+}
+
+// Set option
+func (s settings) Set(key, value string) {
+	s[strings.ToLower(strings.TrimSpace(key))] = value
 }
 
 func (b *Bot) migrate() error {
@@ -73,19 +87,44 @@ func (b *Bot) syncRooms(ctx context.Context) error {
 	}
 	b.rooms = make(map[string]id.RoomID, len(resp.JoinedRooms))
 	for _, roomID := range resp.JoinedRooms {
+		b.migrateSettings(span.Context(), roomID)
 		cfg, serr := b.getSettings(span.Context(), roomID)
 		if serr != nil {
 			b.log.Warn("cannot get %s settings: %v", roomID, err)
 			continue
 		}
-		if cfg.Mailbox != "" {
+		mailbox := cfg.Get("mailbox")
-			b.rooms[cfg.Mailbox] = roomID
+		if mailbox != "" {
+			b.rooms[mailbox] = roomID
 		}
 	}
 
 	return nil
 }
 
+// TODO: remove after migration
+func (b *Bot) migrateSettings(ctx context.Context, roomID id.RoomID) {
+	var config settingsOld
+	err := b.lp.GetClient().GetRoomAccountData(roomID, settingskey, &config)
+	if err != nil {
+		// any error = no need to migrate
+		return
+	}
+
+	if config.Mailbox == "" {
+		return
+	}
+	cfg := settings{}
+	cfg.Set("mailbox", config.Mailbox)
+	cfg.Set("owner", config.Owner.String())
+	cfg.Set("nosender", strconv.FormatBool(config.NoSender))
+
+	err = b.setSettings(ctx, roomID, cfg)
+	if err != nil {
+		b.log.Error("cannot migrate settings: %v", err)
+	}
+}
+
 func (b *Bot) getSettings(ctx context.Context, roomID id.RoomID) (settings, error) {
 	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("getSettings"))
 	defer span.Finish()

bot/mailbox.go

@@ -1,86 +0,0 @@
-package bot
-
-import (
-	"context"
-
-	"github.com/getsentry/sentry-go"
-	"gitlab.com/etke.cc/postmoogle/utils"
-	"maunium.net/go/mautrix/event"
-	"maunium.net/go/mautrix/format"
-)
-
-func (b *Bot) handleMailbox(ctx context.Context, evt *event.Event, command []string) {
-	if len(command) == 1 {
-		b.getMailbox(ctx, evt)
-		return
-	}
-	b.setMailbox(ctx, evt, command[1])
-}
-
-func (b *Bot) getMailbox(ctx context.Context, evt *event.Event) {
-	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("getMailbox"))
-	defer span.Finish()
-
-	cfg, err := b.getSettings(span.Context(), evt.RoomID)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "failed to retrieve setting: %v", err)
-		return
-	}
-
-	if cfg.Mailbox == "" {
-		b.Notice(span.Context(), evt.RoomID, "mailbox name is not set")
-		return
-	}
-
-	content := format.RenderMarkdown("Mailbox of this room is **"+cfg.Mailbox+"@"+b.domain+"**", true, true)
-	content.MsgType = event.MsgNotice
-	_, err = b.lp.Send(evt.RoomID, content)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err)
-	}
-}
-
-func (b *Bot) setMailbox(ctx context.Context, evt *event.Event, mailbox string) {
-	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("setMailbox"))
-	defer span.Finish()
-
-	mailbox = utils.Mailbox(mailbox)
-	existingID, ok := b.GetMapping(ctx, mailbox)
-	if ok && existingID != "" && existingID != evt.RoomID {
-		content := format.RenderMarkdown("Mailbox "+mailbox+"@"+b.domain+" already taken", true, true)
-		content.MsgType = event.MsgNotice
-		_, err := b.lp.Send(evt.RoomID, content)
-		if err != nil {
-			b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err)
-		}
-	}
-	cfg, err := b.getSettings(span.Context(), evt.RoomID)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "failed to retrieve setting: %v", err)
-		return
-	}
-
-	if !cfg.Allowed(b.noowner, evt.Sender) {
-		b.Notice(span.Context(), evt.RoomID, "you don't have permission to do that")
-		return
-	}
-
-	cfg.Owner = evt.Sender
-	cfg.Mailbox = mailbox
-	err = b.setSettings(span.Context(), evt.RoomID, cfg)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot update settings: %v", err)
-		return
-	}
-
-	b.roomsmu.Lock()
-	b.rooms[mailbox] = evt.RoomID
-	b.roomsmu.Unlock()
-
-	content := format.RenderMarkdown("Mailbox of this room set to **"+cfg.Mailbox+"@"+b.domain+"**", true, true)
-	content.MsgType = event.MsgNotice
-	_, err = b.lp.Send(evt.RoomID, content)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err)
-	}
-}

bot/nosender.go

@@ -1,68 +0,0 @@
-package bot
-
-import (
-	"context"
-	"fmt"
-
-	"github.com/getsentry/sentry-go"
-	"gitlab.com/etke.cc/postmoogle/utils"
-	"maunium.net/go/mautrix/event"
-	"maunium.net/go/mautrix/format"
-)
-
-func (b *Bot) handleNoSender(ctx context.Context, evt *event.Event, command []string) {
-	if len(command) == 1 {
-		b.getNoSender(ctx, evt)
-		return
-	}
-	b.setNoSender(ctx, evt, command[1])
-}
-
-func (b *Bot) getNoSender(ctx context.Context, evt *event.Event) {
-	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("getNoSender"))
-	defer span.Finish()
-
-	cfg, err := b.getSettings(span.Context(), evt.RoomID)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "failed to retrieve setting: %v", err)
-		return
-	}
-
-	content := format.RenderMarkdown(fmt.Sprintf("`nosender` of this room is **%t**", cfg.NoSender), true, true)
-	content.MsgType = event.MsgNotice
-	_, err = b.lp.Send(evt.RoomID, content)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err)
-	}
-}
-
-func (b *Bot) setNoSender(ctx context.Context, evt *event.Event, value string) {
-	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("setNoSender"))
-	defer span.Finish()
-
-	nosender := utils.Bool(value)
-	cfg, err := b.getSettings(span.Context(), evt.RoomID)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "failed to retrieve setting: %v", err)
-		return
-	}
-
-	if !cfg.Allowed(b.noowner, evt.Sender) {
-		b.Notice(span.Context(), evt.RoomID, "you don't have permission to do that")
-		return
-	}
-
-	cfg.NoSender = nosender
-	err = b.setSettings(span.Context(), evt.RoomID, cfg)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot update settings: %v", err)
-		return
-	}
-
-	content := format.RenderMarkdown(fmt.Sprintf("`nosender` of this room set to **%t**", nosender), true, true)
-	content.MsgType = event.MsgNotice
-	_, err = b.lp.Send(evt.RoomID, content)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err)
-	}
-}

bot/options.go

@@ -0,0 +1,96 @@
+package bot
+
+import (
+	"context"
+
+	"github.com/getsentry/sentry-go"
+	"gitlab.com/etke.cc/postmoogle/utils"
+	"maunium.net/go/mautrix/event"
+)
+
+type sanitizerFunc func(string) string
+
+// sanitizers is map of option name => sanitizer function
+var sanitizers = map[string]sanitizerFunc{
+	"mailbox":  utils.Mailbox,
+	"nosender": utils.SanitizeBoolString,
+}
+
+func (b *Bot) handleOption(ctx context.Context, evt *event.Event, command []string) {
+	if len(command) == 1 {
+		b.getOption(ctx, evt, command[0])
+		return
+	}
+	b.setOption(ctx, evt, command[0], command[1])
+}
+
+func (b *Bot) getOption(ctx context.Context, evt *event.Event, name string) {
+	msg := "`%s` of this room is %s"
+	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("getOption"))
+	defer span.Finish()
+
+	cfg, err := b.getSettings(span.Context(), evt.RoomID)
+	if err != nil {
+		b.Error(span.Context(), evt.RoomID, "failed to retrieve settings: %v", err)
+		return
+	}
+
+	value := cfg.Get(name)
+	if value == "" {
+		b.Notice(span.Context(), evt.RoomID, "`%s` is not set", name)
+		return
+	}
+
+	if name == "mailbox" {
+		msg = msg + "@" + b.domain
+	}
+
+	b.Notice(span.Context(), evt.RoomID, msg, name, value)
+}
+
+func (b *Bot) setOption(ctx context.Context, evt *event.Event, name, value string) {
+	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("setOption"))
+	defer span.Finish()
+	msg := "`%s` of this room set to %s"
+
+	sanitizer, ok := sanitizers[name]
+	if ok {
+		value = sanitizer(value)
+	}
+
+	if name == "mailbox" {
+		existingID, ok := b.GetMapping(ctx, value)
+		if ok && existingID != "" && existingID != evt.RoomID {
+			b.Notice(span.Context(), evt.RoomID, "Mailbox %s@%s already taken", value, b.domain)
+			return
+		}
+	}
+
+	cfg, err := b.getSettings(span.Context(), evt.RoomID)
+	if err != nil {
+		b.Error(span.Context(), evt.RoomID, "failed to retrieve settings: %v", err)
+		return
+	}
+
+	if !cfg.Allowed(b.noowner, evt.Sender) {
+		b.Notice(span.Context(), evt.RoomID, "you don't have permission to do that")
+		return
+	}
+
+	cfg.Set(name, value)
+	if name == "mailbox" {
+		msg = msg + "@" + b.domain
+		cfg.Set("owner", evt.Sender.String())
+		b.roomsmu.Lock()
+		b.rooms[value] = evt.RoomID
+		b.roomsmu.Unlock()
+	}
+
+	err = b.setSettings(span.Context(), evt.RoomID, cfg)
+	if err != nil {
+		b.Error(span.Context(), evt.RoomID, "cannot update settings: %v", err)
+		return
+	}
+
+	b.Notice(span.Context(), evt.RoomID, msg, name, value)
+}

bot/owner.go

@@ -1,72 +0,0 @@
-package bot
-
-import (
-	"context"
-
-	"github.com/getsentry/sentry-go"
-	"maunium.net/go/mautrix/event"
-	"maunium.net/go/mautrix/format"
-	"maunium.net/go/mautrix/id"
-)
-
-func (b *Bot) handleOwner(ctx context.Context, evt *event.Event, command []string) {
-	if len(command) == 1 {
-		b.getOwner(ctx, evt)
-		return
-	}
-	b.setOwner(ctx, evt, command[1])
-}
-
-func (b *Bot) getOwner(ctx context.Context, evt *event.Event) {
-	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("getOwner"))
-	defer span.Finish()
-
-	cfg, err := b.getSettings(span.Context(), evt.RoomID)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "failed to retrieve setting: %v", err)
-		return
-	}
-
-	if cfg.Owner == "" {
-		b.Notice(span.Context(), evt.RoomID, "owner is not set yet")
-		return
-	}
-
-	content := format.RenderMarkdown("Owner of this room is "+cfg.Owner.String(), true, true)
-	content.MsgType = event.MsgNotice
-	_, err = b.lp.Send(evt.RoomID, content)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err)
-	}
-}
-
-func (b *Bot) setOwner(ctx context.Context, evt *event.Event, owner string) {
-	span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("setOwner"))
-	defer span.Finish()
-
-	ownerID := id.UserID(owner)
-	cfg, err := b.getSettings(span.Context(), evt.RoomID)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "failed to retrieve setting: %v", err)
-		return
-	}
-
-	if !cfg.Allowed(b.noowner, evt.Sender) {
-		b.Notice(span.Context(), evt.RoomID, "you don't have permission to do that")
-		return
-	}
-
-	cfg.Owner = ownerID
-	err = b.setSettings(span.Context(), evt.RoomID, cfg)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot update settings: %v", err)
-		return
-	}
-
-	content := format.RenderMarkdown("Owner of this room set to "+owner, true, true)
-	content.MsgType = event.MsgNotice
-	_, err = b.lp.Send(evt.RoomID, content)
-	if err != nil {
-		b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err)
-	}
-}

utils/utils.go

@@ -1,6 +1,9 @@
 package utils
 
-import "strings"
+import (
+	"strconv"
+	"strings"
+)
 
 // Mailbox returns mailbox part from email address
 func Mailbox(email string) string {
@@ -25,3 +28,8 @@ func Bool(str string) bool {
 
 	return (str == "1" || str == "true" || str == "yes")
 }
+
+// SanitizeBoolString converts string to boolean and back to string
+func SanitizeBoolString(str string) string {
+	return strconv.FormatBool(Bool(str))
+}