pushing code for channel lockdowns

- honestly not sure if its worth adding

bolt.go

@@ -14,7 +14,9 @@ import (
 )
 
 const (
-	TOKEN_ENV_VAR = "DISCORD_TOKEN" //label for token environment variable
+	//Discord auth token must be saved as an environment variable using this label/name
+	//in order for bolt to detect it
+	TOKEN_ENV_VAR = "DISCORD_TOKEN"
 
 	BOT_INTENTS = dg.IntentGuilds |
 		dg.IntentGuildMembers |
@@ -24,12 +26,12 @@ const (
 		dg.IntentGuildMessageReactions
 )
 
-// basic bot structure containing discordgo connection as well as the command map
 type bolt struct {
 	*dg.Session                    //holds discordgo internals
 	commands    map[string]Command //maps trigger phrase to command struct for fast lookup
 	indicator   string             //the indicator used to detect whether a message is a command
 	logLvl      LogLevel           //determines how much the bot logs
+	channels    []string           //optional list of channels that the bot listens in, all channels are used if list is empty
 }
 
 type Bolt interface {
@@ -45,7 +47,7 @@ type Bolt interface {
 	timeoutCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error)
 }
 
-// create a new bolt interface
+// creates and returns a new bolt interface after ensuring token is present and applying option functions
 func New(opts ...Option) (Bolt, error) {
 	_, check := os.LookupEnv(TOKEN_ENV_VAR)
 	if !check {
@@ -75,9 +77,9 @@ func New(opts ...Option) (Bolt, error) {
 }
 
 // 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
+// call that handles safe shutdown
 func (b *bolt) Start() error {
-	//register commands and open connection
+	//registers the message handler used internally to detect commands
 	b.AddHandler(b.messageHandler)
 
 	err := b.Open()
@@ -104,25 +106,43 @@ func (b *bolt) stop() error {
 
 // adds commands to bot command map for use
 func (b *bolt) AddCommands(cmd ...Command) {
+	//command trigger words are mapped directly to payload functions to prevent
+	//extra loops when searching for the appropriate payload
 	for _, c := range cmd {
 		b.commands[c.Trigger] = c
 	}
 }
 
-// handler function that parses message data and executes any command payloads
+// internal message handler function. Ensure's the message is a message the bot should interpret
+// and checks to see if it contains a command then executes the proper payload function
 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)
-		return
-	}
+	//get channel name to, idk if i like this
 	channel, err := s.Channel(msg.ChannelID)
 	if err != nil {
 		log.Printf("failed to get channel from guild: %e\n", err)
 		return
 	}
 
+	if len(b.channels) > 0 {
+		var check bool
+		for _, c := range b.channels {
+			if channel.Name == c {
+				check = true
+			}
+		}
+
+		//not a channel we care about
+		if !check {
+			return
+		}
+	}
+
+	server, err := s.Guild(msg.GuildID)
+	if err != nil {
+		log.Printf("failed to get guild: %e\n", err)
+		return
+	}
+
 	//if there is no content it is likely an image, gif, or sticker, updating message content for
 	//better logging and to avoid confusion
 	if len(msg.Content) == 0 {

message.go

@@ -5,36 +5,40 @@ import "fmt"
 //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 = ":+1:"
-	ReactionThumbsDown        Reaction = ":-1:"
-	ReactionHundred           Reaction = ":100:"
-	ReactionHeart             Reaction = ":heart:"
-	ReactionPinkHeart         Reaction = ":pink_heart:"
-	ReactionOrangeHeart       Reaction = ":orange_heart:"
-	ReactionYellowHeart       Reaction = ":yellow_heart:"
-	ReactionGreenHeart        Reaction = ":green_heart:"
-	ReactionBlueHeart         Reaction = ":blue_heart:"
-	ReactionBlackHeart        Reaction = ":black_heart:"
-	ReactionPointUp           Reaction = ":point_up:"
-	ReactionPointDown         Reaction = ":point_down:"
-	ReactionHotdog            Reaction = ":hotdog:"
-	ReactionDog               Reaction = ":dog:"
-	ReactionCat               Reaction = ":cat:"
-	ReactionMonkey            Reaction = ":monkey:"
-	ReactionGiraffe           Reaction = ":giraffe:"
-	ReactionDuck              Reaction = ":duck:"
-	ReactionGoose             Reaction = ":goose:"
-	ReactionWatermelon        Reaction = ":watermelon:"
-	ReactionHoney             Reaction = ":honey_pot:"
-	ReactionSandwich          Reaction = ":sandwich:"
-	ReactionPepper            Reaction = ":hot_pepper:"
-	ReactionNoPedestrians     Reaction = ":no_pedestrian:"
-	ReactionExclamation       Reaction = ":exclamation:"
-	ReactionDoubleExclamation Reaction = ":bangbang:"
-	ReactionSkull             Reaction = ":skull:"
-	ReactionSpeakingHead      Reaction = ":speaking_head:"
-	ReactionGreenCheck        Reaction = ":white_check_mark:"
+	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 = "🐉"
+	ReactionLizard            Reaction = "🦎"
+	ReactionTakeAKnee         Reaction = "🧎‍♂️‍➡️"
 )
 
 // information about attachments to messages

option.go

@@ -23,3 +23,10 @@ func WithLogLevel(lvl LogLevel) Option {
 		b.logLvl = lvl
 	}
 }
+
+// restrict the channels the bot listens in and responds to, must be a list of channel names
+func WithListenChannels(channels []string) Option {
+	return func(b *bolt) {
+		b.channels = channels
+	}
+}