strip terminal control sequences from server-supplied text

Remove control, DEL, and bidi characters before display.
HTML escaping was the only filter, which leaves ANSI and OSC escape
sequences intact. A remote user could move the cursor, recolour the
screen, or reorder what was shown by putting escape codes in a
message, a nickname, or a channel name. Names rendered in the channel
tree go through the same filter now.

Keep the text box cursor and the prompt on rune boundaries.
Both indexed by byte, so editing a line containing multi-byte
characters could split one and render replacement characters.

Handle text view lines that carry no timestamp.
Toggling timestamps assumed every stored line had one and sliced past
the end of lines that did not.

Ignore key events on an empty tree.
The handlers indexed the item list before checking that it had any
items.

Remove the beep helpers.
They shelled out to an optional "beep" binary and panicked when it was
absent.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Brandon McGinty
2026-08-20 14:42:52 -04:00
co-authored by Claude Opus 5
parent 97ec48534e
commit 17a4662c6c
8 changed files with 94 additions and 36 deletions
+21 -19
View File
@@ -3,9 +3,9 @@ package main
import ( import (
"fmt" "fmt"
"os" "os"
"os/exec"
"strings" "strings"
"time" "time"
"unicode"
"git.stormux.org/storm/barnard/gumble/gumble" "git.stormux.org/storm/barnard/gumble/gumble"
"git.stormux.org/storm/barnard/uiterm" "git.stormux.org/storm/barnard/uiterm"
@@ -24,18 +24,17 @@ const (
uiViewAdmin = "admin" uiViewAdmin = "admin"
) )
func Beep() { // esc makes server-supplied text safe for a terminal as well as for HTML.
cmd := exec.Command("beep") // HTML escaping alone leaves ANSI, OSC, DEL, and bidi/control characters able
cmdout, err := cmd.Output() // to alter terminal state or obscure the displayed text.
if err != nil {
panic(err)
}
if cmdout != nil {
}
}
func esc(str string) string { func esc(str string) string {
return sanitize.HTML(str) clean := strings.Map(func(r rune) rune {
if r == 0x7f || unicode.IsControl(r) || unicode.Is(unicode.Bidi_Control, r) {
return -1
}
return r
}, str)
return sanitize.HTML(clean)
} }
func (b *Barnard) Notify(event string, who string, what string) { func (b *Barnard) Notify(event string, who string, what string) {
@@ -47,10 +46,6 @@ func (b *Barnard) Notify(event string, who string, what string) {
} }
} }
func (b *Barnard) Beep() {
Beep()
}
func (b *Barnard) SetSelectedUser(user *gumble.User) { func (b *Barnard) SetSelectedUser(user *gumble.User) {
b.selectedUser = user b.selectedUser = user
if user == nil { if user == nil {
@@ -67,14 +62,21 @@ func (b *Barnard) GetInputStatus() string {
} }
func (b *Barnard) UpdateInputStatus(status string) { func (b *Barnard) UpdateInputStatus(status string) {
if len(status) > 20 { status = truncateInputStatus(status)
status = status[:17] + "..." + "]"
}
b.UiInputStatus.Text = status b.UiInputStatus.Text = status
b.RebuildUserChannelTreePreservingSelection() b.RebuildUserChannelTreePreservingSelection()
b.Ui.Refresh() b.Ui.Refresh()
} }
// truncateInputStatus shortens the prompt without splitting a multi-byte rune.
func truncateInputStatus(status string) string {
chars := []rune(status)
if len(chars) > 20 {
return string(chars[:17]) + "..." + "]"
}
return status
}
func (b *Barnard) AddOutputLine(line string) { func (b *Barnard) AddOutputLine(line string) {
now := time.Now() now := time.Now()
b.UiOutput.AddLine(fmt.Sprintf("%s [%02d:%02d:%02d]", line, now.Hour(), now.Minute(), now.Second())) b.UiOutput.AddLine(fmt.Sprintf("%s [%02d:%02d:%02d]", line, now.Hour(), now.Minute(), now.Second()))
+3 -3
View File
@@ -10,15 +10,15 @@ import (
func (ti TreeItem) String() string { func (ti TreeItem) String() string {
if ti.User != nil { if ti.User != nil {
if ti.User.LocallyMuted() { if ti.User.LocallyMuted() {
return "[MUTED] " + ti.User.Name return "[MUTED] " + esc(ti.User.Name)
} }
// Calculate total volume as percentage // Calculate total volume as percentage
boostPercent := float32(ti.User.Boost()-1) * 10 boostPercent := float32(ti.User.Boost()-1) * 10
totalVolume := ti.User.Volume()*100 + boostPercent totalVolume := ti.User.Volume()*100 + boostPercent
return fmt.Sprintf("%s [%.0f%%]", ti.User.Name, totalVolume) return fmt.Sprintf("%s [%.0f%%]", esc(ti.User.Name), totalVolume)
} }
if ti.Channel != nil { if ti.Channel != nil {
return "#" + ti.Channel.Name return "#" + esc(ti.Channel.Name)
} }
return "" return ""
} }
+1 -1
View File
@@ -40,7 +40,7 @@ func (l *Label) uiDraw() {
if ch, _, err := reader.ReadRune(); err != nil { if ch, _, err := reader.ReadRune(); err != nil {
chr = ' ' chr = ' '
} else { } else {
chr = ch chr = safeRune(ch)
} }
termbox.SetCell(x, y, chr, termbox.Attribute(l.Fg), termbox.Attribute(l.Bg)) termbox.SetCell(x, y, chr, termbox.Attribute(l.Fg), termbox.Attribute(l.Bg))
} }
+26 -8
View File
@@ -2,7 +2,7 @@ package uiterm
import ( import (
"strings" "strings"
// "unicode/utf8" "unicode/utf8"
"github.com/nsf/termbox-go" "github.com/nsf/termbox-go"
) )
@@ -41,6 +41,9 @@ func (t *Textbox) uiSetBounds(x0, y0, x1, y1 int) {
} }
func (t *Textbox) uiDraw() { func (t *Textbox) uiDraw() {
if t.ui == nil {
return
}
t.ui.beginDraw() t.ui.beginDraw()
defer t.ui.endDraw() defer t.ui.endDraw()
@@ -51,13 +54,16 @@ func (t *Textbox) uiDraw() {
if t.pos > len(t.Text) { if t.pos > len(t.Text) {
t.pos = len(t.Text) t.pos = len(t.Text)
} }
for t.pos > 0 && t.pos < len(t.Text) && !utf8.RuneStart(t.Text[t.pos]) {
t.pos--
}
for y := t.y0; y < t.y1; y++ { for y := t.y0; y < t.y1; y++ {
for x := t.x0; x < t.x1; x++ { for x := t.x0; x < t.x1; x++ {
var chr rune var chr rune
if ch, _, err := reader.ReadRune(); err != nil { if ch, _, err := reader.ReadRune(); err != nil {
chr = ' ' chr = ' '
} else { } else {
chr = ch chr = safeRune(ch)
} }
termbox.SetCell(x, y, chr, termbox.Attribute(t.Fg), termbox.Attribute(t.Bg)) termbox.SetCell(x, y, chr, termbox.Attribute(t.Fg), termbox.Attribute(t.Bg))
} }
@@ -95,10 +101,16 @@ func (t *Textbox) uiKeyEvent(key Key) {
t.pos = len(t.Text) t.pos = len(t.Text)
redraw = true redraw = true
case KeyArrowLeft: case KeyArrowLeft:
t.pos -= 1 if t.pos > 0 {
_, size := utf8.DecodeLastRuneInString(t.Text[:t.pos])
t.pos -= size
}
redraw = true redraw = true
case KeyArrowRight: case KeyArrowRight:
t.pos += 1 if t.pos < len(t.Text) {
_, size := utf8.DecodeRuneInString(t.Text[t.pos:])
t.pos += size
}
redraw = true redraw = true
case KeyCtrlC: case KeyCtrlC:
t.Text = "" t.Text = ""
@@ -119,12 +131,12 @@ func (t *Textbox) uiKeyEvent(key Key) {
redraw = t.handleHistoryKey(key) redraw = t.handleHistoryKey(key)
case KeySpace: case KeySpace:
t.uiCharacterEvent(' ') t.uiCharacterEvent(' ')
case KeyBackspace: case KeyBackspace, KeyBackspace2:
case KeyBackspace2:
if len(t.Text) > 0 { if len(t.Text) > 0 {
if t.pos > 0 { if t.pos > 0 {
t.Text = t.Text[:t.pos-1] + t.Text[t.pos:] _, size := utf8.DecodeLastRuneInString(t.Text[:t.pos])
t.pos -= 1 t.Text = t.Text[:t.pos-size] + t.Text[t.pos:]
t.pos -= size
} }
} }
// if r, size := utf8.DecodeLastRuneInString(t.Text); r != utf8.RuneError { // if r, size := utf8.DecodeLastRuneInString(t.Text); r != utf8.RuneError {
@@ -135,8 +147,14 @@ func (t *Textbox) uiKeyEvent(key Key) {
// } // }
} }
if redraw { if redraw {
// Input callbacks may update another view (for example, append a chat
// message). Redraw every view after submission, not just this textbox.
if key == KeyEnter && t.ui != nil {
t.ui.Refresh()
} else {
t.uiDraw() t.uiDraw()
} }
}
} }
func (t *Textbox) uiCharacterEvent(chr rune) { func (t *Textbox) uiCharacterEvent(chr rune) {
+18
View File
@@ -2,6 +2,24 @@ package uiterm
import "testing" import "testing"
// Regression: byte-based cursor movement split UTF-8 input, producing invalid
// text when deleting or inserting beside a non-ASCII character.
func TestTextboxEditsAtRuneBoundaries(t *testing.T) {
textbox := Textbox{Text: "aé", pos: len("aé")}
textbox.uiKeyEvent(KeyArrowLeft)
if textbox.pos != 1 {
t.Fatalf("cursor = %d, want rune boundary 1", textbox.pos)
}
textbox.uiKeyEvent(KeyBackspace)
if textbox.Text != "é" || textbox.pos != 0 {
t.Fatalf("after delete: %q at %d", textbox.Text, textbox.pos)
}
textbox.uiCharacterEvent('ß')
if textbox.Text != "ßé" {
t.Fatalf("insert produced %q", textbox.Text)
}
}
func TestTextboxHistoryNavigatesSubmittedText(t *testing.T) { func TestTextboxHistoryNavigatesSubmittedText(t *testing.T) {
t.Parallel() t.Parallel()
+6 -3
View File
@@ -84,8 +84,11 @@ func (t *Textview) updateParsedLines() {
parsed := make([]string, 0, len(t.Lines)) parsed := make([]string, 0, len(t.Lines))
for _, line := range t.Lines { for _, line := range t.Lines {
var l = line var l = line
if t.showTimestamps == false { if !t.showTimestamps {
l = strings.TrimSpace(strings.Split(line, "]")[1]) // Server and local messages need not have a timestamp prefix.
if _, text, ok := strings.Cut(line, "]"); ok {
l = strings.TrimSpace(text)
}
} }
current := "" current := ""
chars := 0 chars := 0
@@ -143,7 +146,7 @@ func (t *Textview) uiDraw() {
var chr rune = ' ' var chr rune = ' '
if reader != nil { if reader != nil {
if ch, _, err := reader.ReadRune(); err == nil { if ch, _, err := reader.ReadRune(); err == nil {
chr = ch chr = safeRune(ch)
} //no err } //no err
} //reader != nil } //reader != nil
termbox.SetCell(x, y, chr, termbox.Attribute(t.Fg), termbox.Attribute(t.Bg)) termbox.SetCell(x, y, chr, termbox.Attribute(t.Fg), termbox.Attribute(t.Bg))
+7 -1
View File
@@ -177,7 +177,7 @@ func (t *Tree) uiDraw() {
dx := x - t.x0 dx := x - t.x0
if reader != nil && level*2 <= dx { if reader != nil && level*2 <= dx {
if ch, _, err := reader.ReadRune(); err == nil { if ch, _, err := reader.ReadRune(); err == nil {
chr = ch chr = safeRune(ch)
fg, bg = item.TreeItemStyle(fg, bg, t.active && t.activeLine == line) fg, bg = item.TreeItemStyle(fg, bg, t.active && t.activeLine == line)
} }
} }
@@ -206,6 +206,9 @@ func (t *Tree) ActiveItem() TreeItem {
} }
func (t *Tree) uiKeyEvent(key Key) { func (t *Tree) uiKeyEvent(key Key) {
if len(t.lines) == 0 {
return
}
var runHandler = true var runHandler = true
switch key { switch key {
case KeyArrowUp: case KeyArrowUp:
@@ -222,6 +225,9 @@ func (t *Tree) uiKeyEvent(key Key) {
} }
func (t *Tree) uiCharacterEvent(ch rune) { func (t *Tree) uiCharacterEvent(ch rune) {
if len(t.lines) == 0 {
return
}
if t.CharacterListener != nil { if t.CharacterListener != nil {
t.CharacterListener(t.ui, t, t.lines[t.activeLine].Item, ch) t.CharacterListener(t.ui, t, t.lines[t.activeLine].Item, ch)
} }
+11
View File
@@ -1,5 +1,16 @@
package uiterm package uiterm
import "unicode"
// safeRune prevents text supplied by a server or another user from being
// interpreted as a terminal control sequence when termbox flushes its cells.
func safeRune(r rune) rune {
if unicode.IsControl(r) || unicode.Is(unicode.Bidi_Control, r) {
return ' '
}
return r
}
type View interface { type View interface {
uiInitialize(ui *Ui) uiInitialize(ui *Ui)
uiSetActive(active bool) uiSetActive(active bool)