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

Make Notice() not do string formatting anymore

Browse Source 
In various places, we build messages using `Sprintf` before passing them
to `Notice()`.

If we let `Notice()` do string formatting, we run the chance of having
it try to format our already-preformatted text. If our text includes
format references (e.g. `%s`), it would cause a problem (`%s(MISSING)`).

One way to trigger it is to change the bot prefix from `!pm` to `%pm`.
Doing so, `sendHelp()` would create some help message which contains
`%pm` references. `Notice()` would then try to process them as well,
leading to a bunch of `%!p(MISSING)m` in the final text.
This commit is contained in:
Slavi Pantaleev
2022-08-25 10:49:52 +03:00
parent 7e1b7f5c08
commit 1babbb7169
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
bot/bot.go
View File

@@ -61,8 +61,8 @@ 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{}) {
content := format.RenderMarkdown(fmt.Sprintf(message, args...), true, true)
func (b *Bot) Notice(ctx context.Context, roomID id.RoomID, message string) {
content := format.RenderMarkdown(message, true, true)
content.MsgType = event.MsgNotice
_, err := b.lp.Send(roomID, &content)
if err != nil {

8
bot/command.go
View File

@@ -177,7 +177,7 @@ func (b *Bot) getOption(ctx context.Context, evt *event.Event, name string) {
value := cfg.Get(name)
if value == "" {
b.Notice(span.Context(), evt.RoomID, "`%s` is not set", name)
b.Notice(span.Context(), evt.RoomID, fmt.Sprintf("`%s` is not set", name))
return
}
@@ -185,7 +185,7 @@ func (b *Bot) getOption(ctx context.Context, evt *event.Event, name string) {
msg = msg + "@" + b.domain
}
b.Notice(span.Context(), evt.RoomID, msg, name, value)
b.Notice(span.Context(), evt.RoomID, fmt.Sprintf(msg, name, value))
}
func (b *Bot) setOption(ctx context.Context, evt *event.Event, name, value string) {
@@ -201,7 +201,7 @@ func (b *Bot) setOption(ctx context.Context, evt *event.Event, name, value strin
if name == optionMailbox {
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)
b.Notice(span.Context(), evt.RoomID, fmt.Sprintf("Mailbox `%s@%s` already taken", value, b.domain))
return
}
}
@@ -232,5 +232,5 @@ func (b *Bot) setOption(ctx context.Context, evt *event.Event, name, value strin
return
}
b.Notice(span.Context(), evt.RoomID, msg, name, value)
b.Notice(span.Context(), evt.RoomID, fmt.Sprintf(msg, name, value))
}