Compare commits
No commits in common. "main" and "v0.4.1" have entirely different histories.
@ -58,10 +58,7 @@ import (
|
|||||||
func main() {
|
func main() {
|
||||||
//bolt defaults the command indicator to '.' however that can be changed with the options
|
//bolt defaults the command indicator to '.' however that can be changed with the options
|
||||||
//Example: bolt.New(bolt.WithIndicator('!')) would support commands like !ping
|
//Example: bolt.New(bolt.WithIndicator('!')) would support commands like !ping
|
||||||
b, err := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd))
|
b := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd))
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
b.AddCommands(
|
b.AddCommands(
|
||||||
// basic ping pong command, .ping can be run at anytime by anyone and will reply "pong"
|
// 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()
|
//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 {
|
if err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
106
bolt.go
106
bolt.go
@ -20,8 +20,7 @@ const (
|
|||||||
dg.IntentGuildMembers |
|
dg.IntentGuildMembers |
|
||||||
dg.IntentGuildPresences |
|
dg.IntentGuildPresences |
|
||||||
dg.IntentMessageContent |
|
dg.IntentMessageContent |
|
||||||
dg.IntentsGuildMessages |
|
dg.IntentsGuildMessages
|
||||||
dg.IntentGuildMessageReactions
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// basic bot structure containing discordgo connection as well as the command map
|
// basic bot structure containing discordgo connection as well as the command map
|
||||||
@ -38,11 +37,11 @@ type Bolt interface {
|
|||||||
//filtered methods
|
//filtered methods
|
||||||
stop() error
|
stop() error
|
||||||
messageHandler(s *dg.Session, msg *dg.MessageCreate)
|
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
|
createReply(content, message, channel, guild string) *dg.MessageSend
|
||||||
getRemainingTimeout(timeout time.Time) string
|
getRemainingTimeout(timeout time.Time) string
|
||||||
roleCheck(guild string, roles []string, s *dg.Session, run Command) (bool, error)
|
roleCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error)
|
||||||
timeoutCheck(msgID, channelID, guildID string, s *dg.Session, run Command) (bool, error)
|
timeoutCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// create a new bolt interface
|
// create a new bolt interface
|
||||||
@ -66,7 +65,7 @@ func New(opts ...Option) (Bolt, error) {
|
|||||||
//set default command indicator
|
//set default command indicator
|
||||||
b.indicator = "."
|
b.indicator = "."
|
||||||
|
|
||||||
//apply options
|
//apply options to bolt
|
||||||
for _, opt := range opts {
|
for _, opt := range opts {
|
||||||
opt(b)
|
opt(b)
|
||||||
}
|
}
|
||||||
@ -74,8 +73,8 @@ func New(opts ...Option) (Bolt, error) {
|
|||||||
return b, nil
|
return b, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// starts the bot, commands are added and the connection to Discord is opened, this is a BLOCKING call
|
// starts the bot, commands are added and the connection to Discord is opened, this is a BLOCKING
|
||||||
// that handles safe shutdown of the bot
|
// call that handles safe shutdown of the bot
|
||||||
func (b *bolt) Start() error {
|
func (b *bolt) Start() error {
|
||||||
//register commands and open connection
|
//register commands and open connection
|
||||||
b.AddHandler(b.messageHandler)
|
b.AddHandler(b.messageHandler)
|
||||||
@ -109,8 +108,7 @@ func (b *bolt) AddCommands(cmd ...Command) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// handler function that parses message data, handles logging the message based on logLevel, and executes
|
// handler function that parses message data and executes any command payloads
|
||||||
// the payload function in a goroutine
|
|
||||||
func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
|
func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
|
||||||
//get server information
|
//get server information
|
||||||
server, err := s.Guild(msg.GuildID)
|
server, err := s.Guild(msg.GuildID)
|
||||||
@ -132,7 +130,7 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
|
|||||||
|
|
||||||
//the bot will ignore it's own messages to prevent command loops
|
//the bot will ignore it's own messages to prevent command loops
|
||||||
if msg.Author.ID == s.State.User.ID {
|
if msg.Author.ID == s.State.User.ID {
|
||||||
if b.logLvl == LogLevelCmd || b.logLvl == LogLevelAll {
|
if b.logLvl == LogLevelCmd {
|
||||||
//log command responses
|
//log command responses
|
||||||
log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
|
log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
|
||||||
}
|
}
|
||||||
@ -147,42 +145,29 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
|
|||||||
//does the message have the command indicator
|
//does the message have the command indicator
|
||||||
lg := len(b.indicator)
|
lg := len(b.indicator)
|
||||||
if msg.Content[:lg] == b.indicator {
|
if msg.Content[:lg] == b.indicator {
|
||||||
mCreate := &MessageCreateEvent{
|
err := b.handleCommand(msg, s, server, channel, lg)
|
||||||
AuthorUsername: msg.Author.Username,
|
if err != nil {
|
||||||
AuthorID: msg.Author.ID,
|
log.Println(err)
|
||||||
AuthorRoles: msg.Member.Roles,
|
return
|
||||||
MsgID: msg.ID,
|
|
||||||
Msg: msg.Content,
|
|
||||||
MsgChanID: msg.ChannelID,
|
|
||||||
MsgGuildID: msg.GuildID,
|
|
||||||
MsgAttachments: msg.Attachments,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
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
|
// 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 {
|
func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Guild, channel *dg.Channel, lg int) error {
|
||||||
words := strings.Split(msgEvent.Msg, " ")
|
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:]]
|
run, ok := b.commands[words[0][lg:]]
|
||||||
if !ok {
|
if !ok {
|
||||||
return nil //command doesn't exist, maybe log or respond to author
|
return nil //command doesn't exist, maybe log or respond to author
|
||||||
}
|
}
|
||||||
|
|
||||||
//has command met its timeout requirements
|
//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 {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to calculate timeout for %s\n%e", run.Trigger, err)
|
return fmt.Errorf("failed to calculate timeout for %s\n%e", run.Trigger, err)
|
||||||
}
|
}
|
||||||
@ -192,38 +177,32 @@ func (b *bolt) handleCommand(msgEvent *MessageCreateEvent, s *dg.Session, lg int
|
|||||||
|
|
||||||
//does user have correct permissions
|
//does user have correct permissions
|
||||||
if run.Roles != nil {
|
if run.Roles != nil {
|
||||||
check, err := b.roleCheck(msgEvent.MsgGuildID, msgEvent.AuthorRoles, s, run)
|
check, err := b.roleCheck(msg, s, run)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to perform permission checks for %s\n%e", run.Trigger, err)
|
return fmt.Errorf("failed to perform permission checks for %s\n%e", run.Trigger, err)
|
||||||
}
|
}
|
||||||
if !check {
|
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
|
return nil
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
//populate message struct exposed to client
|
|
||||||
plMsg := Message{
|
plMsg := Message{
|
||||||
Author: msgEvent.AuthorUsername,
|
Author: msg.Author.Username,
|
||||||
ID: msgEvent.AuthorID,
|
ID: msg.Author.ID,
|
||||||
msgID: msgEvent.MsgID,
|
msgID: msg.ID,
|
||||||
Words: words,
|
Words: words,
|
||||||
Content: msgEvent.Msg,
|
Content: msg.Content,
|
||||||
Channel: msgEvent.MsgChanName,
|
Channel: channel.Name,
|
||||||
channelID: msgEvent.MsgChanID,
|
channelID: msg.ChannelID,
|
||||||
Server: msgEvent.MsgGuildName,
|
Server: server.Name,
|
||||||
serverID: msgEvent.MsgGuildID,
|
serverID: server.ID,
|
||||||
sesh: b,
|
sesh: b,
|
||||||
}
|
}
|
||||||
|
|
||||||
//check for file attachments
|
//check for file attachments
|
||||||
if len(msgEvent.MsgAttachments) > 0 {
|
if len(msg.Attachments) > 0 {
|
||||||
var att []MessageAttachment
|
var att []MessageAttachment
|
||||||
for _, a := range msgEvent.MsgAttachments {
|
for _, a := range msg.Attachments {
|
||||||
att = append(att, MessageAttachment{
|
att = append(att, MessageAttachment{
|
||||||
ID: a.ID,
|
ID: a.ID,
|
||||||
URL: a.URL,
|
URL: a.URL,
|
||||||
@ -288,15 +267,15 @@ func (b *bolt) getRemainingTimeout(timeout time.Time) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// checks if the author of msg has the correct role to run the requested command
|
// 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
|
var found bool
|
||||||
//loop thru author roles, there may be a better way to check for this UNION
|
//loop thru author roles, there may be a better way to check for this UNION
|
||||||
//TODO: improve role search performance to support bigger lists
|
//TODO: improve role search performance to support bigger lists
|
||||||
for _, r := range roles {
|
for _, r := range msg.Member.Roles {
|
||||||
//get role name from ID
|
//get role name from ID
|
||||||
n, err := s.State.Role(guild, r)
|
n, err := s.State.Role(msg.GuildID, r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, fmt.Errorf("failed to get role from ID %s\n%e", guild, err)
|
return false, fmt.Errorf("failed to get role from ID %s\n%e", msg.GuildID, err)
|
||||||
}
|
}
|
||||||
//does this role exist in command roles
|
//does this role exist in command roles
|
||||||
check := slices.Contains(run.Roles, n.Name)
|
check := slices.Contains(run.Roles, n.Name)
|
||||||
@ -306,8 +285,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 {
|
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, fmt.Errorf("failed to send permission response: %e", err)
|
||||||
|
}
|
||||||
return false, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -315,11 +299,11 @@ 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.
|
// 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)
|
wait := run.lastRun.Add(run.Timeout)
|
||||||
if !time.Now().After(wait) {
|
if !time.Now().After(wait) {
|
||||||
reply := b.createReply(fmt.Sprintf("that command cannot be run for another %s", b.getRemainingTimeout(wait)), msgID, channelID, guildID)
|
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(channelID, reply)
|
_, err := s.ChannelMessageSendComplex(msg.ChannelID, reply)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, fmt.Errorf("failed to send timeout response: %e", err)
|
return false, fmt.Errorf("failed to send timeout response: %e", err)
|
||||||
}
|
}
|
||||||
|
61
message.go
61
message.go
@ -1,62 +1,21 @@
|
|||||||
package bolt
|
package bolt
|
||||||
|
|
||||||
import (
|
import "fmt"
|
||||||
"fmt"
|
|
||||||
|
|
||||||
dg "github.com/bwmarrin/discordgo"
|
//built-in Discord reactions
|
||||||
)
|
|
||||||
|
|
||||||
// built-in Discord reactions
|
|
||||||
type Reaction string
|
type Reaction string
|
||||||
|
|
||||||
// a few easy-to-use emojis, Discordgo/Discord API requires them to be saved like this.
|
|
||||||
const (
|
const (
|
||||||
ReactionThumbsUp Reaction = "👍"
|
ReactionThumbsUp Reaction = ":+1:"
|
||||||
ReactionThumbsDown Reaction = "👎"
|
ReactionThumbsDown Reaction = ":-1:"
|
||||||
ReactionHundred Reaction = "💯"
|
ReactionPointUp Reaction = ":point_up:"
|
||||||
ReactionHeart Reaction = "❤️"
|
ReactionPointDown Reaction = ":point_down:"
|
||||||
ReactionPinkHeart Reaction = "🩷"
|
ReactionHotdog Reaction = ":hotdog:"
|
||||||
ReactionOrangeHeart Reaction = "🧡"
|
ReactionGiraffe Reaction = ":giraffe:"
|
||||||
ReactionYellowHeart Reaction = "💛"
|
ReactionWatermelon Reaction = ":watermelon:"
|
||||||
ReactionGreenHeart Reaction = "💚"
|
ReactionNoPedestrians Reaction = ":no_pedestrian:"
|
||||||
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 = "🐉"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// 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
|
// information about attachments to messages
|
||||||
type MessageAttachment struct {
|
type MessageAttachment struct {
|
||||||
ID string
|
ID string
|
||||||
|
Loading…
x
Reference in New Issue
Block a user