strimertul/loyalty/twitch-bot.go

361 lines
9.7 KiB
Go

package loyalty
import (
"fmt"
"strconv"
"strings"
"time"
"github.com/nicklaw5/helix/v2"
"git.sr.ht/~ashkeel/strimertul/twitch"
"git.sr.ht/~ashkeel/containers/sync"
irc "github.com/gempir/go-twitch-irc/v4"
"go.uber.org/zap"
)
const (
commandRedeem = "!redeem"
commandGoals = "!goals"
commandBalance = "!balance"
commandContribute = "!contribute"
)
func (m *Manager) SetupTwitch() {
bot := m.twitchManager.Client().Bot
if bot == nil {
m.logger.Warn("Twitch bot is offline or not configured, could not setup commands")
return
}
// Add loyalty-based commands
bot.RegisterCommand(commandRedeem, twitch.BotCommand{
Description: "Redeem a reward with loyalty points",
Usage: fmt.Sprintf("%s <reward-id> [request text]", commandRedeem),
AccessLevel: twitch.ALTEveryone,
Handler: m.cmdRedeemReward,
Enabled: true,
})
bot.RegisterCommand(commandBalance, twitch.BotCommand{
Description: "See your current point balance",
Usage: commandBalance,
AccessLevel: twitch.ALTEveryone,
Handler: m.cmdBalance,
Enabled: true,
})
bot.RegisterCommand(commandGoals, twitch.BotCommand{
Description: "Check currently active community goals",
Usage: commandGoals,
AccessLevel: twitch.ALTEveryone,
Handler: m.cmdGoalList,
Enabled: true,
})
bot.RegisterCommand(commandContribute, twitch.BotCommand{
Description: "Contribute points to a community goal",
Usage: fmt.Sprintf("%s <points> [<goal-id>]", commandContribute),
AccessLevel: twitch.ALTEveryone,
Handler: m.cmdContributeGoal,
Enabled: true,
})
// Setup message handler for tracking user activity
bot.OnMessage.Add(m)
// Setup handler for adding points over time
go func() {
config := m.Config.Get()
// Stop handler if loyalty system is disabled or there is no valid point interval
if !config.Enabled || config.Points.Interval <= 0 {
return
}
for {
// Wait for next poll
select {
case <-m.ctx.Done():
return
case <-m.restartTwitchHandler:
return
case <-time.After(time.Duration(config.Points.Interval) * time.Second):
}
client := m.twitchManager.Client()
// If stream is confirmed offline, don't give points away!
isOnline := client.IsLive()
if !isOnline {
continue
}
// Get user list
cursor := ""
var users []string
for {
userClient, err := client.GetUserClient(false)
if err != nil {
m.logger.Error("Could not get user api client for list of chatters", zap.Error(err))
return
}
res, err := userClient.GetChannelChatChatters(&helix.GetChatChattersParams{
BroadcasterID: client.User.ID,
ModeratorID: client.User.ID,
First: "1000",
After: cursor,
})
if err != nil {
m.logger.Error("Could not retrieve list of chatters", zap.Error(err))
return
}
for _, user := range res.Data.Chatters {
users = append(users, user.UserLogin)
}
cursor = res.Data.Pagination.Cursor
if cursor == "" {
break
}
}
// Iterate for each user in the list
pointsToGive := make(map[string]int64)
for _, user := range users {
// Check if user is blocked
if m.IsBanned(user) {
continue
}
// Check if user was active (chatting) for the bonus dingus
award := config.Points.Amount
if m.IsActive(user) {
award += config.Points.ActivityBonus
}
// Add to point pool if already on it, otherwise initialize
pointsToGive[user] = award
}
m.ResetActivity()
// If changes were made, save the pool!
if len(users) > 0 {
err := m.GivePoints(pointsToGive)
if err != nil {
m.logger.Error("Error awarding loyalty points to user", zap.Error(err))
}
}
}
}()
m.logger.Info("Loyalty system integration with Twitch is ready")
}
func (m *Manager) StopTwitch() {
bot := m.twitchManager.Client().Bot
if bot != nil {
bot.RemoveCommand(commandRedeem)
bot.RemoveCommand(commandBalance)
bot.RemoveCommand(commandGoals)
bot.RemoveCommand(commandContribute)
// Remove message handler
bot.OnMessage.Remove(m)
}
}
func (m *Manager) HandleBotMessage(message irc.PrivateMessage) {
m.activeUsers.SetKey(message.User.Name, true)
}
func (m *Manager) SetBanList(banned []string) {
m.banlist = make(map[string]bool)
for _, usr := range banned {
m.banlist[usr] = true
}
}
func (m *Manager) IsBanned(user string) bool {
banned, ok := m.banlist[user]
return ok && banned
}
func (m *Manager) IsActive(user string) bool {
active, ok := m.activeUsers.GetKey(user)
return ok && active
}
func (m *Manager) ResetActivity() {
m.activeUsers = sync.NewMap[string, bool]()
}
func (m *Manager) cmdBalance(bot *twitch.Bot, message irc.PrivateMessage) {
// Get user balance
balance := m.GetPoints(message.User.Name)
bot.Client.Say(message.Channel, fmt.Sprintf("%s: You have %d %s!", message.User.DisplayName, balance, m.Config.Get().Currency))
}
func (m *Manager) cmdRedeemReward(bot *twitch.Bot, message irc.PrivateMessage) {
parts := strings.Fields(message.Message)
if len(parts) < 2 {
return
}
redeemID := parts[1]
// Find reward
reward := m.GetReward(redeemID)
if reward.ID == "" {
return
}
// Reward not active, return early
if !reward.Enabled {
return
}
// Get user balance
balance := m.GetPoints(message.User.Name)
config := m.Config.Get()
// Check if user can afford the reward
if balance-reward.Price < 0 {
bot.Client.Say(message.Channel, fmt.Sprintf("I'm sorry %s but you cannot afford this (have %d %s, need %d)", message.User.DisplayName, balance, config.Currency, reward.Price))
return
}
text := ""
if len(parts) > 2 {
text = strings.Join(parts[2:], " ")
}
// Perform redeem
if err := m.PerformRedeem(Redeem{
Username: message.User.Name,
DisplayName: message.User.DisplayName,
When: time.Now(),
Reward: reward,
RequestText: text,
}); err != nil {
switch err {
case ErrRedeemInCooldown:
nextAvailable := m.GetRewardCooldown(reward.ID)
bot.Client.Say(message.Channel, fmt.Sprintf("%s: That reward is in cooldown (available in %s)", message.User.DisplayName,
time.Until(nextAvailable).Truncate(time.Second)))
default:
m.logger.Error("Error while performing redeem", zap.Error(err))
}
return
}
bot.Client.Say(message.Channel, fmt.Sprintf("HolidayPresent %s has redeemed %s! (new balance: %d %s)", message.User.DisplayName, reward.Name, m.GetPoints(message.User.Name), config.Currency))
}
func (m *Manager) cmdGoalList(bot *twitch.Bot, message irc.PrivateMessage) {
goals := m.Goals.Get()
if len(goals) < 1 {
bot.Client.Say(message.Channel, fmt.Sprintf("%s: There are no active community goals right now :(!", message.User.DisplayName))
return
}
msg := "Current goals: "
for _, goal := range goals {
if !goal.Enabled {
continue
}
msg += fmt.Sprintf("%s (%d/%d %s) [id: %s] | ", goal.Name, goal.Contributed, goal.TotalGoal, m.Config.Get().Currency, goal.ID)
}
msg += " Contribute with <!contribute POINTS GOALID>"
bot.Client.Say(message.Channel, msg)
}
func (m *Manager) cmdContributeGoal(bot *twitch.Bot, message irc.PrivateMessage) {
goals := m.Goals.Get()
// Set defaults if user doesn't provide them
points := int64(100)
goalIndex := -1
hasGoals := false
// Get first unreached goal for default
for index, goal := range goals {
if !goal.Enabled {
continue
}
hasGoals = true
if goal.Contributed < goal.TotalGoal {
goalIndex = index
break
}
}
// Do we not have any goal we can contribute to? Hooray I guess?
if goalIndex < 0 {
if hasGoals {
bot.Client.Say(message.Channel, fmt.Sprintf("%s: All active community goals have been reached already! NewRecord", message.User.DisplayName))
} else {
bot.Client.Say(message.Channel, fmt.Sprintf("%s: There are no active community goals right now :(!", message.User.DisplayName))
}
return
}
// Parse parameters if provided
parts := strings.Fields(message.Message)
if len(parts) > 1 {
newPoints, err := strconv.ParseInt(parts[1], 10, 64)
if err == nil {
if newPoints <= 0 {
bot.Client.Say(message.Channel, fmt.Sprintf("Nice try %s SoBayed", message.User.DisplayName))
return
}
points = newPoints
}
if len(parts) > 2 {
found := false
goalID := parts[2]
// Find Goal index
for index, goal := range goals {
if !goal.Enabled {
continue
}
if goal.ID == goalID {
goalIndex = index
found = true
break
}
}
// Invalid goal ID provided
if !found {
bot.Client.Say(message.Channel, fmt.Sprintf("%s: I couldn't find that goal ID :(", message.User.DisplayName))
return
}
}
}
// Get goal
selectedGoal := goals[goalIndex]
// Check if goal was reached already
if selectedGoal.Contributed >= selectedGoal.TotalGoal {
bot.Client.Say(message.Channel, fmt.Sprintf("%s: This goal was already reached! ヾ(•ω•`)o", message.User.DisplayName))
return
}
// Add points to goal
points, err := m.PerformContribution(selectedGoal, message.User.Name, points)
if err != nil {
m.logger.Error("Error while contributing to goal", zap.Error(err))
return
}
if points == 0 {
bot.Client.Say(message.Channel, fmt.Sprintf("%s: Sorry but you're broke", message.User.DisplayName))
return
}
selectedGoal = m.Goals.Get()[goalIndex]
config := m.Config.Get()
newRemaining := selectedGoal.TotalGoal - selectedGoal.Contributed
bot.Client.Say(message.Channel, fmt.Sprintf("NewRecord %s contributed %d %s to \"%s\"!! Only %d %s left!", message.User.DisplayName, points, config.Currency, selectedGoal.Name, newRemaining, config.Currency))
// Check if goal was reached!
// TODO Replace this with sub from loyalty system or something?
if newRemaining <= 0 {
bot.Client.Say(message.Channel, fmt.Sprintf("FallWinning The community goal \"%s\" was reached! FallWinning", selectedGoal.Name))
}
}