Merge branch 'spamlist-wildcards' into 'main'

spamlist wildcards

See merge request etke.cc/postmoogle!35

README.md

@@ -256,9 +256,7 @@ If you want to change them - check available options in the help message (`!pm h
 
 * **!pm spamcheck:mx** - only accept email from servers which seem prepared to receive it (those having valid MX records) (`true` - enable, `false` - disable)
 * **!pm spamcheck:smtp** - only accept email from servers which seem prepared to receive it (those listening on an SMTP port) (`true` - enable, `false` - disable)
-* **!pm spamlist:emails** - Get or set `spamlist:emails` of the room (comma-separated list), eg: `spammer@example.com,sspam@example.org`
+* **!pm spamlist** - Get or set `spamlist` of the room (comma-separated list), eg: `spammer@example.com,*@spammer.org,noreply@*`
-* **!pm spamlist:hosts** - Get or set `spamlist:hosts` of the room (comma-separated list), eg: `spammer.com,scammer.com,morespam.com`
-* **!pm spamlist:mailboxes** - Get or set `spamlist:mailboxes` of the room (comma-separated list), eg: `notspam,noreply,no-reply`
 
 ---
 

bot/command.go

@@ -157,28 +157,10 @@ func (b *Bot) initCommands() commandList {
 			allowed:     b.allowOwner,
 		},
 		{
-			key: roomOptionSpamlistEmails,
+			key: roomOptionSpamlist,
 			description: fmt.Sprintf(
-				"Get or set `%s` of the room (comma-separated list), eg: `spammer@example.com,sspam@example.org`",
+				"Get or set `%s` of the room (comma-separated list), eg: `spammer@example.com,*@spammer.org,spam@*`",
-				roomOptionSpamlistEmails,
+				roomOptionSpamlist,
-			),
-			sanitizer: utils.SanitizeStringSlice,
-			allowed:   b.allowOwner,
-		},
-		{
-			key: roomOptionSpamlistHosts,
-			description: fmt.Sprintf(
-				"Get or set `%s` of the room (comma-separated list), eg: `spammer.com,scammer.com,morespam.com`",
-				roomOptionSpamlistHosts,
-			),
-			sanitizer: utils.SanitizeStringSlice,
-			allowed:   b.allowOwner,
-		},
-		{
-			key: roomOptionSpamlistLocalparts,
-			description: fmt.Sprintf(
-				"Get or set `%s` of the room (comma-separated list), eg: `notspam,noreply,no-reply`",
-				roomOptionSpamlistLocalparts,
 			),
 			sanitizer: utils.SanitizeStringSlice,
 			allowed:   b.allowOwner,

bot/data.go

@@ -41,6 +41,7 @@ func (b *Bot) syncRooms() error {
 		if serr != nil {
 			continue
 		}
+		b.migrateRoomSettings(roomID)
 		mailbox := cfg.Mailbox()
 		if mailbox != "" {
 			b.rooms.Store(mailbox, roomID)

bot/settings_room.go

@@ -25,9 +25,7 @@ const (
 	roomOptionPassword      = "password"
 	roomOptionSpamcheckSMTP = "spamcheck:smtp"
 	roomOptionSpamcheckMX   = "spamcheck:mx"
-	roomOptionSpamlistEmails     = "spamlist:emails"
+	roomOptionSpamlist      = "spamlist"
-	roomOptionSpamlistHosts      = "spamlist:hosts"
-	roomOptionSpamlistLocalparts = "spamlist:mailboxes"
 )
 
 type roomSettings map[string]string
@@ -90,16 +88,53 @@ func (s roomSettings) SpamcheckMX() bool {
 	return utils.Bool(s.Get(roomOptionSpamcheckMX))
 }
 
-func (s roomSettings) SpamlistEmails() []string {
+func (s roomSettings) Spamlist() []string {
-	return utils.StringSlice(s.Get(roomOptionSpamlistEmails))
+	return utils.StringSlice(s.Get(roomOptionSpamlist))
 }
 
-func (s roomSettings) SpamlistHosts() []string {
+func (s roomSettings) migrateSpamlistSettings() {
-	return utils.StringSlice(s.Get(roomOptionSpamlistHosts))
+	uniq := map[string]struct{}{}
+	emails := utils.StringSlice(s.Get("spamlist:emails"))
+	localparts := utils.StringSlice(s.Get("spamlist:localparts"))
+	hosts := utils.StringSlice(s.Get("spamlist:hosts"))
+	list := utils.StringSlice(s.Get(roomOptionSpamlist))
+	delete(s, "spamlist:emails")
+	delete(s, "spamlist:localparts")
+	delete(s, "spamlist:hosts")
+
+	for _, email := range emails {
+		if email == "" {
+			continue
+		}
+		uniq[email] = struct{}{}
 	}
 
-func (s roomSettings) SpamlistLocalparts() []string {
+	for _, localpart := range localparts {
-	return utils.StringSlice(s.Get(roomOptionSpamlistLocalparts))
+		if localpart == "" {
+			continue
+		}
+		uniq[localpart+"@*"] = struct{}{}
+	}
+
+	for _, host := range hosts {
+		if host == "" {
+			continue
+		}
+		uniq["*@"+host] = struct{}{}
+	}
+
+	for _, item := range list {
+		if item == "" {
+			continue
+		}
+		uniq[item] = struct{}{}
+	}
+
+	spamlist := make([]string, 0, len(uniq))
+	for item := range uniq {
+		spamlist = append(spamlist, item)
+	}
+	s.Set(roomOptionSpamlist, strings.Join(spamlist, ","))
 }
 
 // ContentOptions converts room display settings to content options
@@ -130,3 +165,20 @@ func (b *Bot) getRoomSettings(roomID id.RoomID) (roomSettings, error) {
 func (b *Bot) setRoomSettings(roomID id.RoomID, cfg roomSettings) error {
 	return utils.UnwrapError(b.lp.SetRoomAccountData(roomID, acRoomSettingsKey, cfg))
 }
+
+func (b *Bot) migrateRoomSettings(roomID id.RoomID) {
+	cfg, err := b.getRoomSettings(roomID)
+	if err != nil {
+		b.log.Error("cannot retrieve room settings: %v", err)
+		return
+	}
+
+	if cfg["spamlist:emails"] == "" && cfg["spamlist:localparts"] == "" && cfg["spamlist:hosts"] == "" {
+		return
+	}
+	cfg.migrateSpamlistSettings()
+	err = b.setRoomSettings(roomID, cfg)
+	if err != nil {
+		b.log.Error("cannot migrate room settings: %v", err)
+	}
+}

go.mod

@@ -19,7 +19,7 @@ require (
 	gitlab.com/etke.cc/go/mxidwc v1.0.0
 	gitlab.com/etke.cc/go/secgen v1.1.1
 	gitlab.com/etke.cc/go/trysmtp v1.0.0
-	gitlab.com/etke.cc/go/validator v1.0.1
+	gitlab.com/etke.cc/go/validator v1.0.2
 	gitlab.com/etke.cc/linkpearl v0.0.0-20221012104738-a977907db8b9
 	golang.org/x/net v0.0.0-20221014081412-f15817d10f9b
 	maunium.net/go/mautrix v0.12.2

go.sum

@@ -97,8 +97,8 @@ gitlab.com/etke.cc/go/secgen v1.1.1 h1:RmKOki725HIhWJHzPtAc9X4YvBneczndchpMgoDkE
 gitlab.com/etke.cc/go/secgen v1.1.1/go.mod h1:3pJqRGeWApzx7qXjABqz2o2SMCNpKSZao/gXVdasqE8=
 gitlab.com/etke.cc/go/trysmtp v1.0.0 h1:f/7gSmzohKniVeLSLevI+ZsySYcPUGkT9cRlOTwjOr8=
 gitlab.com/etke.cc/go/trysmtp v1.0.0/go.mod h1:KqRuIB2IPElEEbAxXmFyKtm7S5YiuEb4lxwWthccqyE=
-gitlab.com/etke.cc/go/validator v1.0.1 h1:xp1tAzgCu9A1pga8rFUo7hODaEcCR1nkkodw96+dYuA=
+gitlab.com/etke.cc/go/validator v1.0.2 h1:7iVHG9sh1Hz6YcNT+tTLDm60B2PVSz6eh9nh6KOx7LI=
-gitlab.com/etke.cc/go/validator v1.0.1/go.mod h1:3vdssRG4LwgdTr9IHz9MjGSEO+3/FO9hXPGMuSeweJ8=
+gitlab.com/etke.cc/go/validator v1.0.2/go.mod h1:3vdssRG4LwgdTr9IHz9MjGSEO+3/FO9hXPGMuSeweJ8=
 gitlab.com/etke.cc/linkpearl v0.0.0-20221012104738-a977907db8b9 h1:CJyYRf4KGmaFJDBJS5NXkt9v5ICi/AHrJIIOinQD/os=
 gitlab.com/etke.cc/linkpearl v0.0.0-20221012104738-a977907db8b9/go.mod h1:HkUHUkhbkDueEJVc7h/zBfz2hjhl4xxjQKv9Itrdf9k=
 golang.org/x/crypto v0.0.0-20220518034528-6f7dac969898/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=

smtp/msasession.go

@@ -82,16 +82,12 @@ func (s *msasession) parseAttachments(parts []*enmime.Part) []*utils.File {
 }
 
 func (s *msasession) validate(options utils.IncomingFilteringOptions) bool {
-	spam := validator.Spam{
-		Emails:     options.SpamlistEmails(),
-		Hosts:      options.SpamlistHosts(),
-		Localparts: options.SpamlistLocalparts(),
-	}
 	enforce := validator.Enforce{
+		Email: true,
 		MX:    options.SpamcheckMX(),
 		SMTP:  options.SpamcheckMX(),
 	}
-	v := validator.New(spam, enforce, s.to, s.log)
+	v := validator.New(options.Spamlist(), enforce, s.to, s.log)
 
 	return v.Email(s.from)
 }

utils/email.go

@@ -23,9 +23,7 @@ type MTA interface {
 type IncomingFilteringOptions interface {
 	SpamcheckSMTP() bool
 	SpamcheckMX() bool
-	SpamlistEmails() []string
+	Spamlist() []string
-	SpamlistHosts() []string
-	SpamlistLocalparts() []string
 }
 
 // Email object