privmsg.go

package main

import (
	"context"
	"log/slog"
	"math/rand/v2"
	"regexp"
	"strings"
	"time"
	"unicode"
	"unicode/utf8"

	"gitlab.com/zephyrtronium/tmi"

	"github.com/zephyrtronium/robot/brain"
	"github.com/zephyrtronium/robot/channel"
	"github.com/zephyrtronium/robot/command"
	"github.com/zephyrtronium/robot/message"
	"github.com/zephyrtronium/robot/privacy"
	"github.com/zephyrtronium/robot/userhash"
)

// tmiMessage processes a PRIVMSG from TMI.
func (robo *Robot) tmiMessage(ctx context.Context, send chan<- *tmi.Message, msg *tmi.Message) {
	robo.metrics.TMIMsgsCount.Observe(1)
	ch, _ := robo.channels.Load(msg.To())
	if ch == nil {
		// TMI gives a WHISPER for a direct message, so this is a message to a
		// channel that isn't configured. Ignore it.
		return
	}
	room, _ := msg.Tag("room-id")
	source, ok := msg.Tag("source-room-id")
	// TODO(zeph): This prevents commands from any shared chat, even if the bot
	// isn't in the source room. We should still allow commands from shared
	// chats that we aren't in.
	shared := ok && room != source
	m := message.FromTMI(msg)
	log := slog.With(slog.String("trace", m.ID), slog.String("in", ch.Name))
	log.InfoContext(ctx, "privmsg", slog.Duration("bias", time.Since(m.Time())))
	defer log.InfoContext(ctx, "end")
	perms := ch.Permissions[m.Sender.ID]
	if ch.Block.MatchString(m.Text) && !ch.Meme.MatchString(m.Text) {
		log.InfoContext(ctx, "blocked message", slog.String("text", m.Text), slog.Bool("meme", false))
		return
	}
	if cmd, ok := parseCommand(robo.tmi.name, m.Text); ok {
		if perms.DisableCommands {
			log.InfoContext(ctx, "commands disabled for user")
			return
		}
		if shared {
			log.InfoContext(ctx, "ignore shared chat command")
			return
		}
		robo.command(ctx, log, ch, m, cmd)
		return
	}
	ch.History.Add(m.Time(), m)
	// Check for the channel being silent. This prevents learning, copypasta,
	// and random speaking (among other things), which happens to be all the
	// rest of this function.
	if s := ch.SilentTime(); msg.Time().Before(s) {
		log.DebugContext(ctx, "channel is silent", slog.Time("until", s))
		return
	}
	// If the message is a reply to e.g. Bocchi, TMI adds @Bocchi to the
	// start of the message text.
	// That's helpful for commands, which we've already processed, but
	// otherwise we probably don't want to see it. Remove it.
	if _, ok := msg.Tag("reply-parent-msg-id"); ok && strings.HasPrefix(m.Text, "@") {
		_, t, _ := strings.Cut(m.Text, " ")
		log.DebugContext(ctx, "stripped reply mention", slog.String("text", t))
		m.Text = t
	}
	if !perms.DisableLearn {
		robo.learn(ctx, log, ch, robo.hashes(), m)
	}
	if !perms.DisableMemes {
		switch err := ch.Memery.Check(m.Time(), m.Sender.ID, m.Text); err {
		case channel.ErrNotCopypasta: // do nothing
		case nil:
			// Meme detected. Copypasta.
			t := time.Now()
			r := ch.Rate.ReserveN(t, 1)
			if d := r.DelayFrom(t); d > 0 {
				// But we can't meme it. Restore it so we can next time.
				log.InfoContext(ctx, "rate limited",
					slog.String("action", "copypasta"),
					slog.String("delay", d.String()),
				)
				ch.Memery.Unblock(m.Text)
				r.CancelAt(t)
				return
			}
			f := ch.Effects.Pick(rand.Uint32())
			s := command.Effect(log, f, m.Text)
			if ch.Block.MatchString(s) && !ch.Meme.MatchString(s) {
				// We would copypasta something that is blocked.
				// Note that since we reached here at all, that implies the
				// effect made it unacceptable.
				log.WarnContext(ctx, "blocked copypasta", slog.String("text", s), slog.String("effect", f))
				return
			}
			ch.Memery.Block(m.Time(), s)
			log.InfoContext(ctx, "copypasta",
				slog.String("text", s),
				slog.String("effect", f),
			)
			msg := message.Format("%s", s).SendTo(ch.Name)
			robo.sendTMI(ctx, send, msg)
			return
		default:
			log.ErrorContext(ctx, "failed copypasta check", slog.Any("err", err))
			// Continue on.
		}
	}
	// If this is a shared chat, we don't want to respond unprompted, so that
	// we don't get double probability if we're in multiple shared chats.
	if shared {
		return
	}
	if perms.DisableSpeak || rand.Float64() > ch.Responses {
		return
	}
	start := time.Now()
	s, trace, err := brain.Think(ctx, robo.brain, ch.Send, "")
	cost := time.Since(start)
	if err != nil {
		log.ErrorContext(ctx, "wanted to think but failed", slog.Any("err", err), slog.Duration("cost", cost))
		return
	}
	if s == "" {
		log.InfoContext(ctx, "thought nothing", slog.String("tag", ch.Send), slog.Duration("cost", cost))
		return
	}
	x := rand.Uint64()
	e := ch.Emotes.Pick(uint32(x))
	f := ch.Effects.Pick(uint32(x >> 32))
	log.InfoContext(ctx, "speak",
		slog.String("text", s),
		slog.String("emote", e),
		slog.String("effect", f),
		slog.Duration("cost", cost),
	)
	se := strings.TrimSpace(s + " " + e)
	sef := command.Effect(log, f, se)
	if err := robo.spoken.Record(ctx, ch.Send, sef, trace, time.Now(), cost, s, e, f); err != nil {
		log.ErrorContext(ctx, "record trace failed", slog.Any("err", err))
		return
	}
	if ch.Block.MatchString(se) || ch.Block.MatchString(sef) {
		log.WarnContext(ctx, "wanted to send blocked message", slog.String("text", sef), slog.Any("ids", trace))
		return
	}
	// Now that we've done all the work, which might take substantial time,
	// check whether we can use it.
	t := time.Now()
	r := ch.Rate.ReserveN(t, 1)
	if d := r.DelayFrom(t); d > 0 {
		log.InfoContext(ctx, "rate limited",
			slog.String("action", "speak"),
			slog.String("delay", d.String()),
		)
		r.CancelAt(t)
		return
	}
	robo.metrics.SpeakLatency.Observe(time.Since(start).Seconds(), ch.Send, "true")
	robo.metrics.UsedMessagesForGeneration.Observe(float64(len(trace)))
	out := message.Format("%s", sef).SendTo(ch.Name)
	robo.sendTMI(ctx, send, out)
}

func (robo *Robot) command(ctx context.Context, log *slog.Logger, ch *channel.Channel, m *message.Received[message.User], cmd string) {
	robo.metrics.TMICommandCount.Observe(1)
	var c *twitchCommand
	var args map[string]string
	level := "any"
	switch {
	case m.Sender.ID == robo.tmi.owner:
		c, args = findTwitch(twitchOwner, cmd)
		if c != nil {
			level = "owner"
			break
		}
		fallthrough
	case ch.Permissions[m.Sender.ID].Moderator, m.IsModerator:
		c, args = findTwitch(twitchMod, cmd)
		if c != nil {
			level = "mod"
			break
		}
		fallthrough
	default:
		c, args = findTwitch(twitchAny, cmd)
	}
	if c == nil {
		return
	}
	log.InfoContext(ctx, "command",
		slog.String("level", level),
		slog.String("name", c.name),
		slog.Any("args", args),
	)
	r := command.Robot{
		Log:      log.With(slog.String("command", c.name), slog.Any("args", args)),
		Channels: robo.channels,
		Brain:    robo.brain,
		Pet:      &robo.pet,
		Privacy:  robo.privacy,
		Spoken:   robo.spoken,
		Owner:    robo.owner,
		Contact:  robo.ownerContact,
		Metrics:  robo.metrics,
	}
	inv := command.Invocation{
		Channel: ch,
		Message: m,
		Args:    args,
	}
	c.fn(ctx, &r, &inv)
}

// learn learns a given message's text if it passes ch's filters.
func (robo *Robot) learn(ctx context.Context, log *slog.Logger, ch *channel.Channel, hasher userhash.Hasher, msg *message.Received[message.User]) {
	if !ch.Enabled.Load() {
		log.DebugContext(ctx, "not learning in disabled channel")
		return
	}
	switch err := robo.privacy.Check(ctx, msg.Sender.ID); err {
	case nil: // do nothing
	case privacy.ErrPrivate:
		log.DebugContext(ctx, "private sender")
		return
	default:
		log.ErrorContext(ctx, "failed to check privacy", slog.Any("err", err))
		return
	}
	if ch.Block.MatchString(msg.Text) {
		log.DebugContext(ctx, "blocked message", slog.String("text", msg.Text), slog.Bool("meme", true))
		return
	}
	if ch.Learn == "" {
		log.DebugContext(ctx, "no learn tag")
		return
	}
	user := hasher.Hash(msg.Sender.ID, msg.To, msg.Time())
	m := brain.Message{
		ID:          msg.ID,
		To:          msg.To,
		Sender:      user,
		Text:        msg.Text,
		Timestamp:   msg.Timestamp,
		IsModerator: msg.IsModerator,
		IsElevated:  msg.IsElevated,
	}
	start := time.Now()
	err := brain.Learn(ctx, robo.brain, ch.Learn, &m)
	cost := time.Since(start)
	if err != nil {
		log.ErrorContext(ctx, "failed to learn", slog.Any("err", err))
		return
	}
	robo.metrics.LearnLatency.Observe(cost.Seconds(), ch.Learn)
	robo.metrics.LearnedCount.Observe(1)
	log.InfoContext(ctx, "learned", slog.Duration("cost", cost))
}

// sendTMI sends a message to TMI after waiting for the global rate limit.
// The caller should verify that it is safe to send the message.
func (robo *Robot) sendTMI(ctx context.Context, send chan<- *tmi.Message, msg message.Sent) {
	// TODO(zeph): this should take the logger to use so that we can trace
	t := time.Now()
	r := robo.tmi.rate.ReserveN(t, 1)
	d := r.DelayFrom(t)
	switch {
	case !r.OK():
		slog.ErrorContext(ctx, "infinite wait to send to TMI")
		return
	case d <= 0: // do nothing
	default:
		tm := time.NewTimer(d)
		slog.InfoContext(ctx, "wait to send to TMI",
			slog.Any("sleep", d),
			slog.String("in", msg.To),
			slog.String("text", msg.Text),
		)
		robo.metrics.TMISendWait.Observe(d.Seconds())
		select {
		case <-ctx.Done():
			return
		case <-tm.C:
		}
	}
	resp := message.ToTMI(msg)
	select {
	case <-ctx.Done():
		return
	case send <- resp:
		slog.InfoContext(ctx, "sent to TMI", slog.String("in", msg.To), slog.String("text", msg.Text))
	}
}

func parseCommand(name, text string) (string, bool) {
	text = strings.TrimSpace(text)
	text, _ = strings.CutPrefix(text, "@")
	// TODO(zeph): not quite right if our name contains one of those handful of
	// code points that has a different size between cases
	if len(text) < len(name) {
		return "", false
	}
	if strings.EqualFold(text[:len(name)], name) {
		text = text[len(name):]
		r, _ := utf8.DecodeRuneInString(text)
		if unicode.IsLetter(r) || unicode.IsNumber(r) {
			// Our name is a prefix of a word.
			return "", false
		}
		// This is a command. Skip to the next whitespace to get the text. If
		// there is no whitespace, the text is empty.
		k := strings.IndexFunc(text, unicode.IsSpace)
		if k < 0 {
			k = len(text)
		}
		return strings.TrimSpace(text[k:]), true
	}
	if strings.EqualFold(text[len(text)-len(name):], name) {
		text = text[:len(text)-len(name)]
		r, _ := utf8.DecodeLastRuneInString(text)
		if unicode.IsLetter(r) || unicode.IsNumber(r) {
			// Our name is a suffix of a word.
			return "", false
		}
		// This is a command. Trim off after the preceding whitespace to get
		// the text. Even though we already checked the start-of-text case,
		// there can still be no preceding whitespace in a case like "...name".
		k := strings.LastIndexFunc(text, unicode.IsSpace)
		if k < 0 {
			k = 0
		}
		return strings.TrimSpace(text[:k]), true
	}
	return "", false
}

type twitchCommand struct {
	parse *regexp.Regexp
	fn    command.Func
	name  string
}

func findTwitch(cmds []twitchCommand, text string) (*twitchCommand, map[string]string) {
	for i := range cmds {
		c := &cmds[i]
		u := c.parse.FindStringSubmatch(text)
		switch len(u) {
		case 0:
			continue
		case 1:
			return c, nil
		default:
			m := make(map[string]string, len(u)-1)
			s := c.parse.SubexpNames()
			for k, v := range u[1:] {
				m[s[k+1]] = v
			}
			return c, m
		}
	}
	return nil, nil
}

var twitchOwner = []twitchCommand{
	{
		parse: regexp.MustCompile(`^(?i:in\s+(?<in>#\S+)[,:]?\s+echo)\s+(?<msg>.*)`),
		fn:    command.EchoIn,
		name:  "echo-in",
	},
}

var twitchMod = []twitchCommand{
	{
		parse: regexp.MustCompile(`^(?i:echo)\s+(?<msg>.*)`),
		fn:    command.Echo,
		name:  "echo",
	},
	{
		parse: regexp.MustCompile(`(?i)^(?:tell\s+me|talk)?\s*(?:about)?\s*(?:ranked)?\s*(?:competitive)?\s*marriage`),
		fn:    command.DescribeMarriage,
		name:  "describe-marriage",
	},
	{
		parse: regexp.MustCompile(`(?i)^forgr?[eo]?r?t\s+(?:everything$|(?<term>.+))`),
		fn:    command.Forget,
		name:  "forget",
	},
	{
		parse: regexp.MustCompile(`(?i)^(?:be\s+quiet|shut\s*up|stfu)(?:\s+for\s+(?P<dur>(?:\d+[hms]){1,3}|an\s+h(?:ou)?r|\d+\s+h(?:ou)?rs?|a\s+min(?:ute)?|\d+\s+min(?:ute)?s?)|\s+until\s+(?P<until>tomorrow))?$`),
		fn:    command.Quiet,
		name:  "quiet",
	},
}

var twitchAny = []twitchCommand{
	{
		parse: regexp.MustCompile(`^(?i:give\s+me\s+privacy|ignore\s+me)`),
		fn:    command.Private,
		name:  "private",
	},
	{
		parse: regexp.MustCompile(`(?i)^(?:you\s+(?:can|may)\s+)?learn\s+from\s+me(?:\s+again)?|invade\s+my\s+privacy`),
		fn:    command.Unprivate,
		name:  "unprivate",
	},
	{
		parse: regexp.MustCompile(`(?i)^what\s+(?:info(?:rmation)?\s+)do\s+you\s+(?:collect|store)`),
		fn:    command.DescribePrivacy,
		name:  "describe-privacy",
	},
	{
		parse: regexp.MustCompile(`(?i)^[¿¡]*\s*(?:ple?a?se?\s+)?(?:will\s+y?o?u\s+)?(?:\s*ple?a?se?\s+)?(?:marry\s+me|be?\s+my\s+(?<partnership>wife|waifu|h[ua]su?bando?|partner|spouse|daddy|mommy))`),
		fn:    command.Marry,
		name:  "marry",
	},
	{
		parse: regexp.MustCompile(`^(?i)how\s+much\s+do\s+you\s+(?:like|love|luv)\s+me`),
		fn:    command.Affection,
		name:  "affection",
	},
	{
		parse: regexp.MustCompile(`^(?i)i?\s*love\s+y?o?u[^r]|^ILoveM?y?W`),
		fn:    command.ILoveMyWife,
		name:  "ILoveMyWife",
	},
	{
		parse: regexp.MustCompile(`(?i:\bim?\b.+\bseiso\b|\bseiso\b.+\bi\b|^seiso$)`),
		fn:    command.Seiso,
		name:  "seiso",
	},
	{
		parse: regexp.MustCompile(`^(?i:OwO|uwu)`),
		fn:    command.OwO,
		name:  "OwO",
	},
	{
		parse: regexp.MustCompile(`^(?i:how\s*[a']?re?\s+y?o?u?)|^A(?:A|\s)+$`),
		fn:    command.AAAAA,
		name:  "AAAAA",
	},
	{
		parse: regexp.MustCompile(`^(?i:r+o+a+r+|r+a+w+r+)`),
		fn:    command.Rawr,
		name:  "rawr",
	},
	{
		parse: regexp.MustCompile(`^(?i:where(?:'?s|\s+is)?\s+y?o?u'?re?\s+so?u?rce?(?:\s*code)?)`),
		fn:    command.Source,
		name:  "source",
	},
	{
		parse: regexp.MustCompile(`(?i)^[¿¡]*\s*(?:who\s+a?re?\s+y?o?u|how\s+do\s+y?o?u\s+w[oe]?rk)`),
		fn:    command.Who,
		name:  "who",
	},
	{
		parse: regexp.MustCompile(`(?i)^[¿¡.]*\s*(?:who'?s?e?\s+(?:is\s+)?(?:your\s+)?|(?:let?\s*m?me\s+|i\s+want\s+(?:to\s+))?(?:(?:speak|talk|complain)\s+(?:to|with)\s*)?your\s+)(?:manage[rs]?|op(?:erat[eo][rs]?)?|runs?|admin|administrator|administrates?|owns?|owner)`),
		fn:    command.Contact,
		name:  "contact",
	},
	{
		parse: regexp.MustCompile(`^(?i:(?:check)?\s*(?:current)?\s*status$)`),
		fn:    command.Tamagotchi,
		name:  "tamagotchi",
	},
	{
		parse: regexp.MustCompile(`^(?i:eat|(?:have|wh?at(?:'|\s*i)?s?)\s*(?:s[ou]me?|fo?r|4)?\s*(?:brea?kfa?st|lu?nch|din*e*r))`),
		fn:    command.Eat,
		name:  "eat",
	},
	{
		parse: regexp.MustCompile(`^(?i:(?:let(?:'|\s*u)s|go)?\s*clean)`),
		fn:    command.Clean,
		name:  "clean",
	},
	{
		parse: regexp.MustCompile(`^(?i:\**(?:head\s*)?p[ae]t|(?:chin\s*)scritch|(?:cheek|shoulder|back|foot)?\s*rub|(?:bi+g\s+)hug|g[ou]+d\s+(?:girl|gril|boy|bot|pet|wife|waifu|h[ua]su?bando?|partner|spouse|daddy|mommy))|^(?::?\w+P[aAeE][tT][sS]?:?\s*)+\W*$`),
		fn:    command.Pat,
		name:  "pat",
	},
	{
		parse: regexp.MustCompile(`(?i)^hap+y?\s+bir(?:f|th)(?:day)?`),
		fn:    command.HappyBirthdayToYou,
		name:  "birthday",
	},
	{
		parse: regexp.MustCompile(`^(?i:say|generate)\s*(?i:something)?\s*(?i:starting)?\s*(?i:with)?\s+(?<prompt>.*)`),
		fn:    command.Speak,
		name:  "speak",
	},
	{
		// NOTE(zeph): This command MUST be after the normal speak command,
		// because it would capture the correct spelling otherwise.
		parse: regexp.MustCompile(`^(?i:a*s[say]*|e*g[gen]*[er]*[ae]*[te]*)\s+(?<prompt>.*)`),
		fn:    command.Hte,
		name:  "hte",
	},
	{
		// NOTE(zeph): This command MUST be last, because it swallows all invocations.
		parse: regexp.MustCompile(``),
		fn:    command.Speak,
		name:  "speak",
	},
}