strimertul/twitch/bot.go

package twitch

import (
	"strings"
	"text/template"
	"time"

	"git.sr.ht/~hamcha/containers/sync"
	"github.com/Masterminds/sprig/v3"
	irc "github.com/gempir/go-twitch-irc/v3"
	"go.uber.org/zap"

	"github.com/strimertul/strimertul/database"
	"github.com/strimertul/strimertul/utils"
)

type Bot struct {
	Client *irc.Client
	Config BotConfig

	api         *Client
	username    string
	logger      *zap.Logger
	lastMessage *sync.RWSync[time.Time]
	chatHistory *sync.Slice[irc.PrivateMessage]

	commands        *sync.Map[string, BotCommand]
	customCommands  *sync.Map[string, BotCustomCommand]
	customTemplates *sync.Map[string, *template.Template]
	customFunctions template.FuncMap

	OnConnect *utils.PubSub[BotConnectHandler]
	OnMessage *utils.PubSub[BotMessageHandler]

	cancelUpdateSub   database.CancelFunc
	cancelWriteRPCSub database.CancelFunc

	// Module specific vars
	Timers *BotTimerModule
	Alerts *BotAlertsModule
}

type BotConnectHandler interface {
	utils.Comparable
	HandleBotConnect()
}

type BotMessageHandler interface {
	utils.Comparable
	HandleBotMessage(message irc.PrivateMessage)
}

func (b *Bot) Migrate(old *Bot) {
	utils.MergeSyncMap(b.commands, old.commands)
	// Get registered commands and handlers from old bot
	b.OnConnect.Copy(old.OnConnect)
	b.OnMessage.Copy(old.OnMessage)
}

func newBot(api *Client, config BotConfig) *Bot {
	// Create client
	client := irc.NewClient(config.Username, config.Token)

	bot := &Bot{
		Client: client,
		Config: config,

		username:        strings.ToLower(config.Username), // Normalize username
		logger:          api.logger,
		api:             api,
		lastMessage:     sync.NewRWSync(time.Now()),
		commands:        sync.NewMap[string, BotCommand](),
		customCommands:  sync.NewMap[string, BotCustomCommand](),
		customTemplates: sync.NewMap[string, *template.Template](),
		chatHistory:     sync.NewSlice[irc.PrivateMessage](),

		OnConnect: utils.NewPubSub[BotConnectHandler](),
		OnMessage: utils.NewPubSub[BotMessageHandler](),
	}

	client.OnConnect(func() {
		for _, handler := range bot.OnConnect.Subscribers() {
			if handler != nil {
				handler.HandleBotConnect()
			}
		}
	})

	client.OnPrivateMessage(func(message irc.PrivateMessage) {
		for _, handler := range bot.OnMessage.Subscribers() {
			if handler != nil {
				handler.HandleBotMessage(message)
			}
		}

		// Ignore messages for a while or twitch will get mad!
		if message.Time.Before(bot.lastMessage.Get().Add(time.Second * 2)) {
			bot.logger.Debug("message received too soon, ignoring")
			return
		}

		lowercaseMessage := strings.ToLower(message.Message)

		// Check if it's a command
		if strings.HasPrefix(message.Message, "!") {
			// Run through supported commands
			for cmd, data := range bot.commands.Copy() {
				if !data.Enabled {
					continue
				}
				if !strings.HasPrefix(lowercaseMessage, cmd) {
					continue
				}
				parts := strings.SplitN(lowercaseMessage, " ", 2)
				if parts[0] != cmd {
					continue
				}
				go data.Handler(bot, message)
				bot.lastMessage.Set(time.Now())
			}
		}

		// Run through custom commands
		for cmd, data := range bot.customCommands.Get() {
			if !data.Enabled {
				continue
			}
			lc := strings.ToLower(cmd)
			if !strings.HasPrefix(lowercaseMessage, lc) {
				continue
			}
			parts := strings.SplitN(lowercaseMessage, " ", 2)
			if parts[0] != lc {
				continue
			}
			go cmdCustom(bot, cmd, data, message)
			bot.lastMessage.Set(time.Now())
		}

		err := bot.api.db.PutJSON(ChatEventKey, message)
		if err != nil {
			bot.logger.Warn("could not save chat message to key", zap.String("key", ChatEventKey), zap.Error(err))
		}
		if bot.Config.ChatHistory > 0 {
			history := bot.chatHistory.Get()
			if len(history) >= bot.Config.ChatHistory {
				history = history[len(history)-bot.Config.ChatHistory+1:]
			}
			bot.chatHistory.Set(append(history, message))
			err = bot.api.db.PutJSON(ChatHistoryKey, bot.chatHistory.Get())
			if err != nil {
				bot.logger.Warn("could not save message to chat history", zap.Error(err))
			}
		}

		if bot.Timers != nil {
			go bot.Timers.OnMessage(message)
		}
	})

	client.OnUserJoinMessage(func(message irc.UserJoinMessage) {
		if strings.ToLower(message.User) == bot.username {
			bot.logger.Info("joined channel", zap.String("channel", message.Channel))
		} else {
			bot.logger.Debug("user joined channel", zap.String("channel", message.Channel), zap.String("username", message.User))
		}
	})

	client.OnUserPartMessage(func(message irc.UserPartMessage) {
		if strings.ToLower(message.User) == bot.username {
			bot.logger.Info("left channel", zap.String("channel", message.Channel))
		} else {
			bot.logger.Debug("user left channel", zap.String("channel", message.Channel), zap.String("username", message.User))
		}
	})

	bot.Client.Join(config.Channel)
	bot.setupFunctions()

	// Load modules
	bot.Timers = SetupTimers(bot)
	bot.Alerts = SetupAlerts(bot)

	// Load custom commands
	var customCommands map[string]BotCustomCommand
	err := api.db.GetJSON(CustomCommandsKey, &customCommands)
	if err != nil {
		bot.logger.Error("failed to load custom commands", zap.Error(err))
	}
	bot.customCommands.Set(customCommands)

	err = bot.updateTemplates()
	if err != nil {
		bot.logger.Error("failed to parse custom commands", zap.Error(err))
	}
	err, bot.cancelUpdateSub = api.db.SubscribeKey(CustomCommandsKey, bot.updateCommands)
	if err != nil {
		bot.logger.Error("could not set-up bot command reload subscription", zap.Error(err))
	}
	err, bot.cancelWriteRPCSub = api.db.SubscribeKey(WriteMessageRPC, bot.handleWriteMessageRPC)
	if err != nil {
		bot.logger.Error("could not set-up bot command reload subscription", zap.Error(err))
	}

	return bot
}

func (b *Bot) Close() error {
	if b.cancelUpdateSub != nil {
		b.cancelUpdateSub()
	}
	if b.cancelWriteRPCSub != nil {
		b.cancelWriteRPCSub()
	}
	if b.Timers != nil {
		b.Timers.Close()
	}
	if b.Alerts != nil {
		b.Alerts.Close()
	}
	return b.Client.Disconnect()
}

func (b *Bot) updateCommands(value string) {
	err := utils.LoadJSONToWrapped[map[string]BotCustomCommand](value, b.customCommands)
	if err != nil {
		b.logger.Error("failed to decode new custom commands", zap.Error(err))
		return
	}
	// Recreate templates
	if err := b.updateTemplates(); err != nil {
		b.logger.Error("failed to update custom commands templates", zap.Error(err))
		return
	}
}

func (b *Bot) handleWriteMessageRPC(value string) {
	b.Client.Say(b.Config.Channel, value)
}

func (b *Bot) updateTemplates() error {
	for cmd, tmpl := range b.customCommands.Copy() {
		tpl, err := template.New("").Funcs(sprig.TxtFuncMap()).Funcs(b.customFunctions).Parse(tmpl.Response)
		if err != nil {
			return err
		}
		b.customTemplates.SetKey(cmd, tpl)
	}
	return nil
}

func (b *Bot) Connect() {
	err := b.Client.Connect()
	if err != nil {
		b.logger.Error("bot connection ended", zap.Error(err))
	}
}

func (b *Bot) WriteMessage(message string) {
	b.Client.Say(b.Config.Channel, message)
}

func (b *Bot) RegisterCommand(trigger string, command BotCommand) {
	b.commands.SetKey(trigger, command)
}

func (b *Bot) RemoveCommand(trigger string) {
	b.commands.DeleteKey(trigger)
}

func getUserAccessLevel(user irc.User) AccessLevelType {
	// Check broadcaster
	if _, ok := user.Badges["broadcaster"]; ok {
		return ALTStreamer
	}

	// Check mods
	if _, ok := user.Badges["moderator"]; ok {
		return ALTModerators
	}

	// Check VIP
	if _, ok := user.Badges["vip"]; ok {
		return ALTVIP
	}

	// Check subscribers
	if _, ok := user.Badges["subscriber"]; ok {
		return ALTSubscribers
	}

	return ALTEveryone
}