Compare commits
No commits in common. "main" and "v0.4.0" have entirely different histories.
@ -58,10 +58,7 @@ import (
|
||||
func main() {
|
||||
//bolt defaults the command indicator to '.' however that can be changed with the options
|
||||
//Example: bolt.New(bolt.WithIndicator('!')) would support commands like !ping
|
||||
b, err := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd))
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
b := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd))
|
||||
|
||||
b.AddCommands(
|
||||
// basic ping pong command, .ping can be run at anytime by anyone and will reply "pong"
|
||||
@ -98,12 +95,11 @@ func main() {
|
||||
)
|
||||
|
||||
//start is a blocking call that handles safe-shutdown, all configuration and setup should be done before calling Start()
|
||||
err = b.Start()
|
||||
err := b.Start()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
156
bolt.go
156
bolt.go
@ -20,8 +20,7 @@ const (
|
||||
dg.IntentGuildMembers |
|
||||
dg.IntentGuildPresences |
|
||||
dg.IntentMessageContent |
|
||||
dg.IntentsGuildMessages |
|
||||
dg.IntentGuildMessageReactions
|
||||
dg.IntentsGuildMessages
|
||||
)
|
||||
|
||||
// basic bot structure containing discordgo connection as well as the command map
|
||||
@ -38,23 +37,27 @@ type Bolt interface {
|
||||
//filtered methods
|
||||
stop() error
|
||||
messageHandler(s *dg.Session, msg *dg.MessageCreate)
|
||||
handleCommand(msgEvent *MessageCreateEvent, s *dg.Session, lg int) error
|
||||
handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Guild, channel *dg.Channel, lg int) error
|
||||
createReply(content, message, channel, guild string) *dg.MessageSend
|
||||
getRemainingTimeout(timeout time.Time) string
|
||||
roleCheck(guild string, roles []string, s *dg.Session, run Command) (bool, error)
|
||||
timeoutCheck(msgID, channelID, guildID string, s *dg.Session, run Command) (bool, error)
|
||||
roleCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error)
|
||||
timeoutCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error)
|
||||
}
|
||||
|
||||
// setup
|
||||
func init() {
|
||||
//validate environment variables
|
||||
_, check := os.LookupEnv(TOKEN_ENV_VAR)
|
||||
if !check {
|
||||
log.Fatalf("the %s environment variable must be set", TOKEN_ENV_VAR)
|
||||
}
|
||||
}
|
||||
|
||||
// create a new bolt interface
|
||||
func New(opts ...Option) (Bolt, error) {
|
||||
_, check := os.LookupEnv(TOKEN_ENV_VAR)
|
||||
if !check {
|
||||
return nil, fmt.Errorf("environment variable %s must be set", TOKEN_ENV_VAR)
|
||||
}
|
||||
|
||||
func New(opts ...Option) Bolt {
|
||||
bot, err := dg.New(fmt.Sprintf("Bot %s", os.Getenv(TOKEN_ENV_VAR)))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create Discord session: %e", err)
|
||||
log.Fatal(err)
|
||||
}
|
||||
bot.Identify.Intents = BOT_INTENTS
|
||||
|
||||
@ -66,23 +69,23 @@ func New(opts ...Option) (Bolt, error) {
|
||||
//set default command indicator
|
||||
b.indicator = "."
|
||||
|
||||
//apply options
|
||||
//apply options to bolt
|
||||
for _, opt := range opts {
|
||||
opt(b)
|
||||
}
|
||||
|
||||
return b, nil
|
||||
return b
|
||||
}
|
||||
|
||||
// starts the bot, commands are added and the connection to Discord is opened, this is a BLOCKING call
|
||||
// that handles safe shutdown of the bot
|
||||
// starts the bot, commands are added and the connection to Discord is opened, this is a BLOCKING
|
||||
// call that handles safe shutdown of the bot
|
||||
func (b *bolt) Start() error {
|
||||
//register commands and open connection
|
||||
b.AddHandler(b.messageHandler)
|
||||
|
||||
err := b.Open()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to open websocket connection with Discord: %e", err)
|
||||
return err
|
||||
}
|
||||
|
||||
//safe shutdown handler
|
||||
@ -109,18 +112,17 @@ func (b *bolt) AddCommands(cmd ...Command) {
|
||||
}
|
||||
}
|
||||
|
||||
// handler function that parses message data, handles logging the message based on logLevel, and executes
|
||||
// the payload function in a goroutine
|
||||
// handler function that parses message data and executes any command payloads
|
||||
func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
|
||||
//get server information
|
||||
server, err := s.Guild(msg.GuildID)
|
||||
if err != nil {
|
||||
log.Printf("failed to get guild: %e\n", err)
|
||||
log.Println(err)
|
||||
return
|
||||
}
|
||||
channel, err := s.Channel(msg.ChannelID)
|
||||
if err != nil {
|
||||
log.Printf("failed to get channel from guild: %e\n", err)
|
||||
log.Println(err)
|
||||
return
|
||||
}
|
||||
|
||||
@ -130,61 +132,48 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
|
||||
msg.Content = "[Embedded Content]"
|
||||
}
|
||||
|
||||
//the bot will ignore it's own messages to prevent command loops
|
||||
if msg.Author.ID == s.State.User.ID {
|
||||
if b.logLvl == LogLevelCmd || b.logLvl == LogLevelAll {
|
||||
//log command responses
|
||||
log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if b.logLvl == LogLevelAll {
|
||||
//log message
|
||||
log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
|
||||
}
|
||||
|
||||
//the bot will ignore it's own messages to prevent command loops
|
||||
if msg.Author.ID == s.State.User.ID {
|
||||
if b.logLvl == LogLevelCmd {
|
||||
//log commands
|
||||
log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
//does the message have the command indicator
|
||||
lg := len(b.indicator)
|
||||
if msg.Content[:lg] == b.indicator {
|
||||
mCreate := &MessageCreateEvent{
|
||||
AuthorUsername: msg.Author.Username,
|
||||
AuthorID: msg.Author.ID,
|
||||
AuthorRoles: msg.Member.Roles,
|
||||
MsgID: msg.ID,
|
||||
Msg: msg.Content,
|
||||
MsgChanID: msg.ChannelID,
|
||||
MsgGuildID: msg.GuildID,
|
||||
MsgAttachments: msg.Attachments,
|
||||
err := b.handleCommand(msg, s, server, channel, lg)
|
||||
if err != nil {
|
||||
log.Println(err)
|
||||
return
|
||||
}
|
||||
|
||||
if b.logLvl == LogLevelCmd {
|
||||
//log commands
|
||||
log.Printf("< %s | %s | %s > %s\n", mCreate.MsgGuildName, mCreate.MsgChanName, mCreate.AuthorUsername, mCreate.Msg)
|
||||
}
|
||||
|
||||
//handled in its own goroutine to allow for async commands
|
||||
go func() {
|
||||
err := b.handleCommand(mCreate, s, lg)
|
||||
if err != nil {
|
||||
log.Println(err)
|
||||
}
|
||||
}()
|
||||
}
|
||||
}
|
||||
|
||||
// parses command from message and handles timeout checks, role checks, and command execution. All command responses are sent back to Discord
|
||||
func (b *bolt) handleCommand(msgEvent *MessageCreateEvent, s *dg.Session, lg int) error {
|
||||
words := strings.Split(msgEvent.Msg, " ")
|
||||
func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Guild, channel *dg.Channel, lg int) error {
|
||||
if b.logLvl == LogLevelCmd {
|
||||
//log commands
|
||||
log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
|
||||
}
|
||||
|
||||
words := strings.Split(msg.Content, " ")
|
||||
run, ok := b.commands[words[0][lg:]]
|
||||
if !ok {
|
||||
return nil //command doesn't exist, maybe log or respond to author
|
||||
}
|
||||
|
||||
//has command met its timeout requirements
|
||||
tc, err := b.timeoutCheck(msgEvent.MsgID, msgEvent.MsgChanID, msgEvent.MsgGuildID, s, run)
|
||||
tc, err := b.timeoutCheck(msg, s, run)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to calculate timeout for %s\n%e", run.Trigger, err)
|
||||
return err
|
||||
}
|
||||
if !tc {
|
||||
return nil
|
||||
@ -192,38 +181,32 @@ func (b *bolt) handleCommand(msgEvent *MessageCreateEvent, s *dg.Session, lg int
|
||||
|
||||
//does user have correct permissions
|
||||
if run.Roles != nil {
|
||||
check, err := b.roleCheck(msgEvent.MsgGuildID, msgEvent.AuthorRoles, s, run)
|
||||
check, err := b.roleCheck(msg, s, run)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to perform permission checks for %s\n%e", run.Trigger, err)
|
||||
return err
|
||||
}
|
||||
if !check {
|
||||
reply := b.createReply("you do not have permissions to run that command", msgEvent.MsgID, msgEvent.MsgChanID, msgEvent.MsgGuildID)
|
||||
_, err := s.ChannelMessageSendComplex(msgEvent.MsgChanID, reply)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
//populate message struct exposed to client
|
||||
plMsg := Message{
|
||||
Author: msgEvent.AuthorUsername,
|
||||
ID: msgEvent.AuthorID,
|
||||
msgID: msgEvent.MsgID,
|
||||
Author: msg.Author.Username,
|
||||
ID: msg.Author.ID,
|
||||
msgID: msg.ID,
|
||||
Words: words,
|
||||
Content: msgEvent.Msg,
|
||||
Channel: msgEvent.MsgChanName,
|
||||
channelID: msgEvent.MsgChanID,
|
||||
Server: msgEvent.MsgGuildName,
|
||||
serverID: msgEvent.MsgGuildID,
|
||||
Content: msg.Content,
|
||||
Channel: channel.Name,
|
||||
channelID: msg.ChannelID,
|
||||
Server: server.Name,
|
||||
serverID: server.ID,
|
||||
sesh: b,
|
||||
}
|
||||
|
||||
//check for file attachments
|
||||
if len(msgEvent.MsgAttachments) > 0 {
|
||||
if len(msg.Attachments) > 0 {
|
||||
var att []MessageAttachment
|
||||
for _, a := range msgEvent.MsgAttachments {
|
||||
for _, a := range msg.Attachments {
|
||||
att = append(att, MessageAttachment{
|
||||
ID: a.ID,
|
||||
URL: a.URL,
|
||||
@ -243,7 +226,7 @@ func (b *bolt) handleCommand(msgEvent *MessageCreateEvent, s *dg.Session, lg int
|
||||
//run command payload
|
||||
err = run.Payload(plMsg)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to execute payload function: %e", err)
|
||||
return err
|
||||
}
|
||||
|
||||
//update run time
|
||||
@ -288,15 +271,15 @@ func (b *bolt) getRemainingTimeout(timeout time.Time) string {
|
||||
}
|
||||
|
||||
// checks if the author of msg has the correct role to run the requested command
|
||||
func (b *bolt) roleCheck(guild string, roles []string, s *dg.Session, run Command) (bool, error) {
|
||||
func (b *bolt) roleCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error) {
|
||||
var found bool
|
||||
//loop thru author roles, there may be a better way to check for this UNION
|
||||
//TODO: improve role search performance to support bigger lists
|
||||
for _, r := range roles {
|
||||
for _, r := range msg.Member.Roles {
|
||||
//get role name from ID
|
||||
n, err := s.State.Role(guild, r)
|
||||
n, err := s.State.Role(msg.GuildID, r)
|
||||
if err != nil {
|
||||
return false, fmt.Errorf("failed to get role from ID %s\n%e", guild, err)
|
||||
return false, err
|
||||
}
|
||||
//does this role exist in command roles
|
||||
check := slices.Contains(run.Roles, n.Name)
|
||||
@ -306,8 +289,13 @@ func (b *bolt) roleCheck(guild string, roles []string, s *dg.Session, run Comman
|
||||
}
|
||||
}
|
||||
|
||||
//can't find role, don't run command
|
||||
//can't find role, don't run command, alert user of missing permissions
|
||||
if !found {
|
||||
reply := b.createReply("you do not have permissions to run that command", msg.ID, msg.ChannelID, msg.GuildID)
|
||||
_, err := s.ChannelMessageSendComplex(msg.ChannelID, reply)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return false, nil
|
||||
}
|
||||
|
||||
@ -315,13 +303,13 @@ func (b *bolt) roleCheck(guild string, roles []string, s *dg.Session, run Comman
|
||||
}
|
||||
|
||||
// check if the command timeout has been met, responding with remaining time if timeout has not been met yet.
|
||||
func (b *bolt) timeoutCheck(msgID, channelID, guildID string, s *dg.Session, run Command) (bool, error) {
|
||||
func (b *bolt) timeoutCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error) {
|
||||
wait := run.lastRun.Add(run.Timeout)
|
||||
if !time.Now().After(wait) {
|
||||
reply := b.createReply(fmt.Sprintf("that command cannot be run for another %s", b.getRemainingTimeout(wait)), msgID, channelID, guildID)
|
||||
_, err := s.ChannelMessageSendComplex(channelID, reply)
|
||||
reply := b.createReply(fmt.Sprintf("that command cannot be run for another %s", b.getRemainingTimeout(wait)), msg.ID, msg.ChannelID, msg.GuildID)
|
||||
_, err := s.ChannelMessageSendComplex(msg.ChannelID, reply)
|
||||
if err != nil {
|
||||
return false, fmt.Errorf("failed to send timeout response: %e", err)
|
||||
return false, err
|
||||
}
|
||||
return false, nil
|
||||
}
|
||||
|
||||
61
message.go
61
message.go
@ -1,62 +1,21 @@
|
||||
package bolt
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
import "fmt"
|
||||
|
||||
dg "github.com/bwmarrin/discordgo"
|
||||
)
|
||||
|
||||
// built-in Discord reactions
|
||||
//built-in Discord reactions
|
||||
type Reaction string
|
||||
|
||||
// a few easy-to-use emojis, Discordgo/Discord API requires them to be saved like this.
|
||||
const (
|
||||
ReactionThumbsUp Reaction = "👍"
|
||||
ReactionThumbsDown Reaction = "👎"
|
||||
ReactionHundred Reaction = "💯"
|
||||
ReactionHeart Reaction = "❤️"
|
||||
ReactionPinkHeart Reaction = "🩷"
|
||||
ReactionOrangeHeart Reaction = "🧡"
|
||||
ReactionYellowHeart Reaction = "💛"
|
||||
ReactionGreenHeart Reaction = "💚"
|
||||
ReactionBlueHeart Reaction = "💙"
|
||||
ReactionBlackHeart Reaction = "🖤"
|
||||
ReactionPointUp Reaction = "☝️"
|
||||
ReactionPointDown Reaction = "👇"
|
||||
ReactionHotdog Reaction = "🌭"
|
||||
ReactionDog Reaction = "🐶"
|
||||
ReactionCat Reaction = "🐱"
|
||||
ReactionMonkey Reaction = "🐒"
|
||||
ReactionGiraffe Reaction = "🦒"
|
||||
ReactionDuck Reaction = "🦆"
|
||||
ReactionGoose Reaction = "🪿"
|
||||
ReactionWatermelon Reaction = "🍉"
|
||||
ReactionHoney Reaction = "🍯"
|
||||
ReactionSandwich Reaction = "🥪"
|
||||
ReactionPepper Reaction = "🌶️"
|
||||
ReactionNoPedestrians Reaction = "🚷"
|
||||
ReactionExclamation Reaction = "❗"
|
||||
ReactionDoubleExclamation Reaction = "‼️"
|
||||
ReactionSkull Reaction = "💀"
|
||||
ReactionSpeakingHead Reaction = "🗣️"
|
||||
ReactionGreenCheck Reaction = "✅"
|
||||
ReactionDragon Reaction = "🐉"
|
||||
ReactionThumbsUp Reaction = ":+1:"
|
||||
ReactionThumbsDown Reaction = ":-1:"
|
||||
ReactionPointUp Reaction = ":point_up:"
|
||||
ReactionPointDown Reaction = ":point_down:"
|
||||
ReactionHotdog Reaction = ":hotdog:"
|
||||
ReactionGiraffe Reaction = ":giraffe:"
|
||||
ReactionWatermelon Reaction = ":watermelon:"
|
||||
ReactionNoPedestrians Reaction = ":no_pedestrian:"
|
||||
)
|
||||
|
||||
// struct containing message event fields to prevent passing MessageCreate events and holding up routines
|
||||
type MessageCreateEvent struct {
|
||||
AuthorUsername string
|
||||
AuthorID string
|
||||
AuthorRoles []string
|
||||
MsgID string
|
||||
Msg string
|
||||
MsgChanID string
|
||||
MsgChanName string
|
||||
MsgGuildID string
|
||||
MsgGuildName string
|
||||
MsgAttachments []*dg.MessageAttachment
|
||||
}
|
||||
|
||||
// information about attachments to messages
|
||||
type MessageAttachment struct {
|
||||
ID string
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user