heimoshuiyu/postmoogle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'hide-sender-address-support' into 'main'

Browse Source 
Add ability to hide sender's email address (hide-sender-address setting)

See merge request etke.cc/postmoogle!5
This commit is contained in:
Aine
2022-08-23 19:16:34 +00:00
parent 0178c3cff3 85fc06cfce
commit bd92e54614
10 changed files with 216 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.golangci.yml
View File

@@ -53,7 +53,7 @@ linters-settings:
sections:
- standard
- default
- prefix(gitlab.com/etke.cc/int/scheduler)
- prefix(gitlab.com/etke.cc/postmoogle)
section-separators:
- newLine
linters:

19
bot/bot.go
View File

@@ -10,10 +10,11 @@ import (
"github.com/getsentry/sentry-go"
"gitlab.com/etke.cc/go/logger"
"gitlab.com/etke.cc/linkpearl"
"gitlab.com/etke.cc/postmoogle/utils"
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/format"
"maunium.net/go/mautrix/id"
"gitlab.com/etke.cc/postmoogle/utils"
)
// Bot represents matrix bot
@@ -61,10 +62,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{
MsgType: event.MsgNotice,
Body: fmt.Sprintf(message, args...),
})
content := format.RenderMarkdown(fmt.Sprintf(message, args...), true, true)
content.MsgType = event.MsgNotice
_, err := b.lp.Send(roomID, &content)
if err != nil {
if sentry.HasHubOnContext(ctx) {
sentry.GetHubFromContext(ctx).CaptureException(err)
@@ -96,10 +96,17 @@ func (b *Bot) Send(ctx context.Context, from, to, subject, plaintext, html strin
return errors.New("room not found")
}
settings, err := b.getSettings(ctx, roomID)
if err != nil {
b.Error(ctx, roomID, "cannot get settings: %v", err)
}
var text strings.Builder
if !utils.Bool(settings.Get("nosender")) {
text.WriteString("From: ")
text.WriteString(from)
text.WriteString("\n\n")
}
text.WriteString("# ")
text.WriteString(subject)
text.WriteString("\n\n")
@@ -110,7 +117,7 @@ func (b *Bot) Send(ctx context.Context, from, to, subject, plaintext, html strin
}
content := format.RenderMarkdown(text.String(), true, true)
_, err := b.lp.Send(roomID, content)
_, err = b.lp.Send(roomID, content)
if err != nil {
return err
}

109
bot/command.go
View File

@@ -8,13 +8,29 @@ import (
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/format"
"maunium.net/go/mautrix/id"
"gitlab.com/etke.cc/postmoogle/utils"
)
var commands = map[string]string{
type sanitizerFunc func(string) string
var (
commands = map[string]string{
// special commands
"help": "Get help",
// options commands
"mailbox": "Get or set mailbox of that room",
"owner": "Get or set owner of that room",
"help": "Get help",
}
"nosender": "Get or set `nosender` of that room (`true` - hide email sender; `false` - show email sender)",
}
// sanitizers is map of option name => sanitizer function
sanitizers = map[string]sanitizerFunc{
"mailbox": utils.Mailbox,
"nosender": utils.SanitizeBoolString,
}
)
func (b *Bot) handleCommand(ctx context.Context, evt *event.Event, command []string) {
if _, ok := commands[command[0]]; !ok {
@@ -29,10 +45,8 @@ func (b *Bot) handleCommand(ctx context.Context, evt *event.Event, command []str
switch command[0] {
case "help":
b.sendHelp(ctx, evt.RoomID)
case "owner":
b.handleOwner(ctx, evt, command)
case "mailbox":
b.handleMailbox(ctx, evt, command)
default:
b.handleOption(ctx, evt, command)
}
}
@@ -46,7 +60,7 @@ func (b *Bot) parseCommand(message string) []string {
return nil
}
message = strings.TrimSpace(strings.Replace(message, b.prefix, "", 1))
message = strings.ToLower(strings.TrimSpace(strings.Replace(message, b.prefix, "", 1)))
return strings.Split(message, " ")
}
@@ -71,3 +85,82 @@ func (b *Bot) sendHelp(ctx context.Context, roomID id.RoomID) {
b.Error(span.Context(), roomID, "cannot send message: %v", err)
}
}
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)
}

72
bot/data.go
View File

@@ -2,6 +2,7 @@ package bot
import (
"context"
"strconv"
"strings"
"github.com/getsentry/sentry-go"
@@ -13,9 +14,13 @@ const settingskey = "cc.etke.postmoogle.settings"
var migrations = []string{}
// settings of a room
type settings struct {
type settings map[string]string
// settingsOld of a room
type settingsOld struct {
Mailbox string
Owner id.UserID
NoSender bool
}
// Allowed checks if change is allowed
@@ -24,11 +29,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 {
@@ -60,6 +76,56 @@ func (b *Bot) migrate() error {
return nil
}
func (b *Bot) syncRooms(ctx context.Context) error {
b.roomsmu.Lock()
defer b.roomsmu.Unlock()
span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("syncRooms"))
defer span.Finish()
resp, err := b.lp.GetClient().JoinedRooms()
if err != nil {
return err
}
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
}
mailbox := cfg.Get("mailbox")
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()

112
bot/mailbox.go
View File

@@ -1,112 +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"
"maunium.net/go/mautrix/id"
)
func (b *Bot) syncRooms(ctx context.Context) error {
b.roomsmu.Lock()
defer b.roomsmu.Unlock()
span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("syncRooms"))
defer span.Finish()
resp, err := b.lp.GetClient().JoinedRooms()
if err != nil {
return err
}
b.rooms = make(map[string]id.RoomID, len(resp.JoinedRooms))
for _, roomID := range resp.JoinedRooms {
cfg, serr := b.getSettings(span.Context(), roomID)
if serr != nil {
b.log.Warn("cannot get %s settings: %v", roomID, err)
continue
}
if cfg.Mailbox != "" {
b.rooms[cfg.Mailbox] = roomID
}
}
return nil
}
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)
}
}

72
bot/owner.go
View File

@@ -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)
}
}

1
cmd/cmd.go
View File

@@ -13,6 +13,7 @@ import (
"gitlab.com/etke.cc/go/logger"
"gitlab.com/etke.cc/linkpearl"
lpcfg "gitlab.com/etke.cc/linkpearl/config"
"gitlab.com/etke.cc/postmoogle/bot"
"gitlab.com/etke.cc/postmoogle/config"
"gitlab.com/etke.cc/postmoogle/smtp"

1
smtp/session.go
View File

@@ -8,6 +8,7 @@ import (
"github.com/getsentry/sentry-go"
"github.com/jhillyerd/enmime"
"gitlab.com/etke.cc/go/logger"
"gitlab.com/etke.cc/postmoogle/utils"
)

3
smtp/smtp.go
View File

@@ -3,8 +3,9 @@ package smtp
import (
"context"
"gitlab.com/etke.cc/postmoogle/utils"
"maunium.net/go/mautrix/id"
"gitlab.com/etke.cc/postmoogle/utils"
)
// Client interface to send emails

22
utils/utils.go
View File

@@ -1,7 +1,11 @@
package utils
import "strings"
import (
"strconv"
"strings"
)
// Mailbox returns mailbox part from email address
func Mailbox(email string) string {
index := strings.LastIndex(email, "@")
if index == -1 {
@@ -10,6 +14,22 @@ func Mailbox(email string) string {
return email[:strings.LastIndex(email, "@")]
}
// Hostname returns hostname part from email address
func Hostname(email string) string {
return email[strings.LastIndex(email, "@")+1:]
}
// Bool converts string to boolean
func Bool(str string) bool {
str = strings.ToLower(str)
if str == "" {
return false
}
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))
}