Music Bot functionality

Author: bela333

README.md

@@ -35,6 +35,6 @@ replace | Hidden. Sends `Hello` then after a short while replaces the text with
 
 ## Roadmap
 - [ ] Documentation
-- [ ] Errors that are sent to the user
+- [x] Errors that are sent to the user
 - [x] Menu system with Reactions
-- [ ] Music Bot
+- [x] Music Bot

commands/module.go

@@ -2,11 +2,13 @@ package commands
 
 import (
 	"fmt"
+	"github.com/bela333/Vigne/errors"
 	"github.com/bela333/Vigne/messages"
 	"github.com/bela333/Vigne/server"
 	"github.com/bwmarrin/discordgo"
 	"regexp"
 	"strings"
+	"time"
 )
 
 type CommandsModule struct {
@@ -78,7 +80,21 @@ func (module *CommandsModule) handleCommands(s *discordgo.Session, m *discordgo.
 				err = commandHandler.Action(m, args, c)
 				//Handle command error
 				if err != nil {
-					fmt.Printf("%s (%s) has failed to execute %s. Reason: %s\n", m.Author.Username, m.Author.ID, m.Content, err)
+					//Check if err is Public error
+					publicErr, ok := err.(*errors.PublicError)
+					if ok {
+						c := messenger.NewMessageCreator(m.ChannelID)
+						msg := c.NewMessage()
+						msg.SetContent(fmt.Sprintf("<@%s>, %s", m.Author.ID, publicErr.PublicPart))
+						msg.SetExpiry(time.Second*10)
+						c.Send()
+						private := publicErr.Error()
+						if private != "" {
+							fmt.Printf("%s (%s) has failed to execute %s. Reason: %s\n", m.Author.Username, m.Author.ID, m.Content, private)
+						}
+					}else {
+						fmt.Printf("%s (%s) has failed to execute %s. Reason: %s\n", m.Author.Username, m.Author.ID, m.Content, err)
+					}
 					return
 				}
 				err = c.Send()

database/Music.go

@@ -0,0 +1,43 @@
+package database
+
+import (
+	"github.com/bela333/Vigne/errors"
+)
+
+type MusicDatabase struct {
+	d *Database
+}
+
+func (d *Database) Music() (*MusicDatabase, error) {
+	if !d.Redis.HExists(d.Decorate("config"), "musicChannel").Val() {
+		return nil, errors.NoMusic
+	}
+	if !d.Redis.HExists(d.Decorate("config"), "musicVoiceChannel").Val() {
+		return nil, errors.NoMusic
+	}
+	return &MusicDatabase{d}, nil
+}
+
+func (d MusicDatabase) GetChannel() string {
+	return d.d.Redis.HGet(d.d.Decorate("config"), "musicChannel").Val()
+}
+
+func (d MusicDatabase) PopNext() string {
+	return d.d.Redis.LPop(d.d.Decorate("musicQueue")).Val()
+}
+
+func (d MusicDatabase) AddSong(data []byte) error {
+	return d.d.Redis.RPush(d.d.Decorate("musicQueue"), string(data)).Err()
+}
+
+func (d MusicDatabase) IsValidExtractor(extractor string) bool {
+	if d.d.Redis.Exists(d.d.Decorate("validExtractors")).Val() == 0 {
+		//If validExtractors doesn't exist, we accept the extractor anyway
+		return true
+	}
+	return d.d.Redis.SIsMember(d.d.Decorate("validExtractors"), extractor).Val()
+}
+
+func (d MusicDatabase) GetVoiceChannel() string {
+	return d.d.Redis.HGet(d.d.Decorate("config"), "musicVoiceChannel").Val()
+}

errors/errors.go

@@ -7,4 +7,9 @@ var NoRoles = errors.New("couldn't find role command configuration in the databa
 var CreatedConfig = errors.New("couldn't find configuration in the database. Created default one")
 var NoModule = errors.New("couldn't find registered module")
 var MessageNotSent = errors.New("couldn't replace message, since it doesn't exist")
-var NoWelcomer = errors.New("couldn't find welcomer:main, welcomer:text:after or welcomer:text:before in the database")
+var NoWelcomer = errors.New("couldn't find welcomer:main, welcomer:text:after or welcomer:text:before in the database")
+var InvalidExtractor = errors.New("music can't be played from this site")
+
+//Public errors
+var NoCommand = New("", "Couldn't find this command")
+var NoMusic = New("couldn't find musicChannel and musicVoiceChannel in the config. Music bot functionality will be unavailable", "The Music Bot is unavailable")

errors/publicError.go

@@ -0,0 +1,17 @@
+package errors
+
+import "errors"
+
+type PublicError struct {
+	PublicPart string
+	error
+}
+
+
+//Returns a new error
+func New(private string, public string) error {
+	e := PublicError{}
+	e.error = errors.New(private)
+	e.PublicPart = public
+	return &e
+}

messages/MessageBuilder.go

@@ -12,7 +12,7 @@ type MessageBuilder struct {
 	content   string
 	expiry    time.Duration
 
-	module *MessagesModule
+	Module *MessagesModule
 
 	embedBuilder *EmbedBuilder
 
@@ -56,14 +56,14 @@ func (b *MessageBuilder) afterSend(message *discordgo.Message)  {
 	if b.reactions != nil {
 		//Run this in another thread as adding reactions can take some time
 		go func() {
-			handlers, ok := b.module.Callbacks[message.ID]
+			handlers, ok := b.Module.Callbacks[message.ID]
 			if !ok {
-				b.module.Callbacks[message.ID] = map[string]*ReactionObject{}
-				handlers = b.module.Callbacks[message.ID]
+				b.Module.Callbacks[message.ID] = map[string]*ReactionObject{}
+				handlers = b.Module.Callbacks[message.ID]
 			}
 			for name, handler := range b.reactions  {
 				handlers[name] = handler
-				err := b.module.server.Session.MessageReactionAdd(message.ChannelID, message.ID, name)
+				err := b.Module.server.Session.MessageReactionAdd(message.ChannelID, message.ID, name)
 				if err != nil {
 					fmt.Printf("Error in Reactions thread: %s.\n", err)
 					return
@@ -84,7 +84,7 @@ func (b *MessageBuilder) afterSend(message *discordgo.Message)  {
 func (b *MessageBuilder) Send() error {
 	if !b.deleted {
 		m := b.getMessageSend()
-		msg, err := b.module.server.Session.ChannelMessageSendComplex(b.ChannelID, m)
+		msg, err := b.Module.server.Session.ChannelMessageSendComplex(b.ChannelID, m)
 		if err != nil {
 			return err
 		}
@@ -112,10 +112,10 @@ func (b *MessageBuilder) Delete() error{
 	b.deleted = true
 	if b.sent {
 		//Remove message from the reaction callback map
-		delete(b.module.Callbacks, b.message.ID)
+		delete(b.Module.Callbacks, b.message.ID)
 		if b.afterBuilder != nil {
 			//Remove all reactions from message
-			err := b.module.server.Session.MessageReactionsRemoveAll(b.message.ChannelID, b.message.ID)
+			err := b.Module.server.Session.MessageReactionsRemoveAll(b.message.ChannelID, b.message.ID)
 			if err != nil {
 				return err
 			}
@@ -125,7 +125,7 @@ func (b *MessageBuilder) Delete() error{
 				return err
 			}
 		}else {
-			err := b.module.server.Session.ChannelMessageDelete(b.message.ChannelID, b.message.ID)
+			err := b.Module.server.Session.ChannelMessageDelete(b.message.ChannelID, b.message.ID)
 			if err != nil {
 				return err
 			}
@@ -139,7 +139,7 @@ func (b *MessageBuilder) Delete() error{
 //Replaces the content of the MessageBuilder with message
 func (b *MessageBuilder) ReplaceMessage(message *MessageBuilder) error {
 	if b.sent {
-		msg, err := b.module.server.Session.ChannelMessageEditComplex(message.getMessageEdit(b.message.ChannelID, b.message.ID))
+		msg, err := b.Module.server.Session.ChannelMessageEditComplex(message.getMessageEdit(b.message.ChannelID, b.message.ID))
 		if err != nil {
 			return err
 		}
@@ -156,7 +156,7 @@ func (b *MessageBuilder) GetAfter() *MessageBuilder {
 	if b.afterBuilder == nil {
 		ba := MessageBuilder{}
 		ba.ChannelID = b.ChannelID
-		ba.module = b.module
+		ba.Module = b.Module
 		b.afterBuilder = &ba
 		return &ba
 	}else{

messages/MessageCreator.go

@@ -9,7 +9,7 @@ type MessageCreator struct {
 func (c *MessageCreator) NewMessage() *MessageBuilder {
 	b := &MessageBuilder{}
 	b.ChannelID = c.ChannelID
-	b.module = c.module
+	b.Module = c.module
 	c.Builders = append(c.Builders, b)
 	return b
 }

modules/help/helpCommand.go

@@ -3,6 +3,7 @@ package help
 import (
 	"fmt"
 	"github.com/bela333/Vigne/commands"
+	"github.com/bela333/Vigne/errors"
 	"github.com/bela333/Vigne/messages"
 	"github.com/bwmarrin/discordgo"
 	"time"
@@ -29,10 +30,7 @@ func (c *HelpCommand) Action(m *discordgo.MessageCreate, args []string, creator
 			}
 		}
 		if cmd == nil {
-			//TODO: Public error
-			msg.SetContent("Couldn't find this command")
-			msg.SetExpiry(time.Second*10)
-			return nil
+			return errors.NoCommand
 		}
 		entry := cmd.GetHelpPageEntry()
 		embed := msg.GetEmbedBuilder()

modules/music/embedGenerator.go

@@ -0,0 +1,28 @@
+package music
+
+import (
+	"fmt"
+	"github.com/bela333/Vigne/messages"
+	"github.com/bwmarrin/discordgo"
+)
+
+func EmbedGenerator(embed *messages.EmbedBuilder, info *Music, author *discordgo.User, title string, color int)  {
+	embed.SetTitle("**" + title + "**")
+	nameField := embed.NewField()
+	nameField.SetName("Title")
+	nameField.SetValue(info.Title)
+	embed.SetURL(info.URL)
+	if info.Uploader != "" {
+		uploaderField := embed.NewField()
+		uploaderField.SetName("By")
+		uploaderField.SetValue(info.Uploader)
+	}
+	timeField := embed.NewField()
+	timeField.SetName("Length")
+	timeField.SetValue(FormatTime(info.Duration))
+	embed.SetColor(color)
+	embed.SetImage(info.Thumbnail)
+	embed.SetAuthor(fmt.Sprintf("Requested by %s#%s", author.Username, author.Discriminator),
+		"",
+		fmt.Sprintf("https://cdn.discordapp.com/avatars/%s/%s.png", author.ID, author.Avatar))
+}

modules/music/module.go

@@ -1,16 +1,27 @@
 package music
 
-import "github.com/bela333/Vigne/server"
+import (
+	"github.com/bela333/Vigne/commands"
+	"github.com/bela333/Vigne/server"
+)
 
 type MusicModule struct {
-
+	Player *MusicPlayer
 }
 
 func (MusicModule) GetName() string {
 	return "music"
 }
 
-func (MusicModule) Init(server *server.Server) error {
+func (m *MusicModule) Init(server *server.Server) error {
+	m.Player = &MusicPlayer{server:server}
+	//Get command handler module
+	cmdInterface, err := server.GetModuleByName("Commands")
+	if err != nil {
+		return err
+	}
+	cmd := (cmdInterface).(*commands.CommandsModule)
+	cmd.RegisterCommand(&PlayCommand{server:server, module:m})
 	return nil
 }