feat: add user event log to admin page

server/bothandlers/sounds.go

@@ -10,6 +10,9 @@ import (
 	"sync"
 	"time"
 
+	"github.com/mgerb/go-discord-bot/server/db"
+	"github.com/mgerb/go-discord-bot/server/webserver/model"
+
 	"github.com/bwmarrin/discordgo"
 	"github.com/mgerb/go-discord-bot/server/config"
 	"github.com/mgerb/go-discord-bot/server/util"
@@ -104,10 +107,10 @@ func (conn *AudioConnection) handleMessage(m *discordgo.MessageCreate) {
 			conn.clipAudio(m)
 
 		case "random":
-			conn.PlayRandomAudio(m)
+			conn.PlayRandomAudio(m, nil)
 
 		default:
-			conn.PlayAudio(command, m)
+			conn.PlayAudio(command, m, nil)
 		}
 	}
 }
@@ -167,20 +170,20 @@ func (conn *AudioConnection) summon(m *discordgo.MessageCreate) {
 }
 
 // play a random sound clip
-func (conn *AudioConnection) PlayRandomAudio(m *discordgo.MessageCreate) {
+func (conn *AudioConnection) PlayRandomAudio(m *discordgo.MessageCreate, userID *string) {
 	files, _ := ioutil.ReadDir(config.Config.SoundsPath)
 	if len(files) > 0 {
 		randomIndex := rand.Intn(len(files))
 		arr := strings.Split(files[randomIndex].Name(), ".")
 		if len(arr) > 0 && arr[0] != "" {
-			conn.PlayAudio(arr[0], m)
+			conn.PlayAudio(arr[0], m, userID)
 		}
 	}
 }
 
 // PlayAudio - play audio in channel that user is in
 // if MessageCreate is null play in current channel
-func (conn *AudioConnection) PlayAudio(soundName string, m *discordgo.MessageCreate) {
+func (conn *AudioConnection) PlayAudio(soundName string, m *discordgo.MessageCreate, userID *string) {
 
 	// summon bot to channel if new message passed in
 	if m != nil {
@@ -204,6 +207,24 @@ func (conn *AudioConnection) PlayAudio(soundName string, m *discordgo.MessageCre
 	select {
 	case conn.SoundQueue <- soundName:
 
+		var newUserID string
+		fromWebUI := false
+
+		// from discord
+		if m != nil && m.Author != nil {
+			newUserID = m.Author.ID
+		} else {
+			fromWebUI = true
+			newUserID = *userID
+		}
+
+		// log event when user plays sound clip
+		err := model.LogSoundPlayedEvent(db.GetConn(), newUserID, soundName, fromWebUI)
+
+		if err != nil {
+			log.Error(err)
+		}
+
 	default:
 		break
 	}

server/webserver/middleware/jwt.go

@@ -20,7 +20,7 @@ const (
 
 // CustomClaims -
 type CustomClaims struct {
-	ID            string `json:"id"`
+	UserID        string `json:"id"`
 	Username      string `json:"username"`
 	Discriminator string `json:"discriminator"`
 	Email         string `json:"email"`

server/webserver/model/index.go

@@ -1,9 +1,11 @@
 package model
 
-var Migrations []interface{} = []interface{}{
+// Migrations - list of database migrations
+var Migrations = []interface{}{
 	&Message{},
 	&Attachment{},
 	&User{},
 	&VideoArchive{},
 	&Sound{},
+	&UserEventLog{},
 }

server/webserver/model/sound.go

@@ -17,11 +17,11 @@ type Sound struct {
 	User      User       `json:"user"`
 }
 
-func SoundCreate(conn *gorm.DB, sound *Sound) error {
+func SoundSave(conn *gorm.DB, sound *Sound) error {
 	return conn.Create(sound).Error
 }
 
-func SoundList(conn *gorm.DB) ([]Sound, error) {
+func SoundGet(conn *gorm.DB) ([]Sound, error) {
 	sound := []Sound{}
 	err := conn.Set("gorm:auto_preload", true).Find(&sound).Error
 	return sound, err

server/webserver/model/user_event_log.go

@@ -0,0 +1,51 @@
+package model
+
+import (
+	"time"
+
+	"github.com/jinzhu/gorm"
+)
+
+// UserEventLog - logger for user events
+type UserEventLog struct {
+	ID        uint       `gorm:"primary_key; auto_increment; not null" json:"id"`
+	CreatedAt time.Time  `json:"created_at"`
+	UpdatedAt time.Time  `json:"updated_at"`
+	DeletedAt *time.Time `json:"deleted_at"`
+	Content   string     `json:"content"`
+	User      User       `json:"user"`
+	UserID    string     `json:"user_id"`
+}
+
+// UserEventLogSave -
+func UserEventLogSave(conn *gorm.DB, m *UserEventLog) error {
+	return conn.Save(m).Error
+}
+
+// UserEventLogGet - returns all messages - must use paging
+func UserEventLogGet(conn *gorm.DB, page int) ([]*UserEventLog, error) {
+	userEventLog := []*UserEventLog{}
+	err := conn.Offset(page*100).Limit(100).Order("created_at desc", true).Preload("User").Find(&userEventLog).Error
+	return userEventLog, err
+}
+
+// LogSoundPlayedEvent - log event when user plays sound clip
+func LogSoundPlayedEvent(conn *gorm.DB, userID, soundName string, fromWebUI bool) error {
+
+	var content string
+
+	// from discord
+	if !fromWebUI {
+		content = "played sound clip: " + soundName
+	} else {
+		content = "played sound clip from web UI: " + soundName
+	}
+
+	// log play event
+	userEventLog := &UserEventLog{
+		UserID:  userID,
+		Content: content,
+	}
+
+	return UserEventLogSave(conn, userEventLog)
+}

server/webserver/routes/sound.go

@@ -23,7 +23,7 @@ func AddSoundRoutes(group *gin.RouterGroup) {
 }
 
 func listSoundHandler(c *gin.Context) {
-	archives, err := model.SoundList(db.GetConn())
+	archives, err := model.SoundGet(db.GetConn())
 
 	if err != nil {
 		response.InternalError(c, err)
@@ -36,6 +36,9 @@ func listSoundHandler(c *gin.Context) {
 func postSoundPlayHandler(c *gin.Context) {
 	connections := bothandlers.ActiveConnections
 
+	oc, _ := c.Get("claims")
+	claims, _ := oc.(*middleware.CustomClaims)
+
 	params := struct {
 		Name string `json:"name"`
 	}{}
@@ -47,9 +50,9 @@ func postSoundPlayHandler(c *gin.Context) {
 	if len(connections) == 1 && params.Name != "" {
 		for _, con := range connections {
 			if params.Name == "random" {
-				con.PlayRandomAudio(nil)
+				con.PlayRandomAudio(nil, &claims.UserID)
 			} else {
-				con.PlayAudio(params.Name, nil)
+				con.PlayAudio(params.Name, nil, &claims.UserID)
 			}
 		}
 	}
@@ -89,7 +92,7 @@ func postSoundHandler(c *gin.Context) {
 	log.Info(claims.Username, "uploaded", config.Config.SoundsPath+"/"+file.Filename)
 
 	// save who uploaded the clip into the database
-	uploadSaveDB(claims.ID, file.Filename)
+	uploadSaveDB(claims.UserID, file.Filename)
 
 	if err != nil {
 		log.Error(err)
@@ -106,7 +109,7 @@ func uploadSaveDB(userID, filename string) {
 	extension := splitFilename[len(splitFilename)-1]
 	name := strings.Join(splitFilename[:len(splitFilename)-1], ".")
 
-	model.SoundCreate(db.GetConn(), &model.Sound{
+	model.SoundSave(db.GetConn(), &model.Sound{
 		UserID:    userID,
 		Name:      name,
 		Extension: extension,

server/webserver/routes/user_event_log.go

@@ -0,0 +1,33 @@
+package routes
+
+import (
+	"strconv"
+
+	"github.com/gin-gonic/gin"
+	"github.com/mgerb/go-discord-bot/server/db"
+	"github.com/mgerb/go-discord-bot/server/webserver/middleware"
+	"github.com/mgerb/go-discord-bot/server/webserver/model"
+	"github.com/mgerb/go-discord-bot/server/webserver/response"
+)
+
+// AddUserEventLogRoutes -
+func AddUserEventLogRoutes(group *gin.RouterGroup) {
+	group.GET("/user-event-log", middleware.AuthorizedJWT(), middleware.AuthPermissions(middleware.PermAdmin), listEventLogHandler)
+}
+
+func listEventLogHandler(c *gin.Context) {
+
+	page, err := strconv.Atoi(c.Query("page"))
+
+	if err != nil {
+		page = 0
+	}
+
+	userEventLogs, err := model.UserEventLogGet(db.GetConn(), page)
+
+	if err != nil {
+		response.InternalError(c, err)
+	} else {
+		response.Success(c, userEventLogs)
+	}
+}

server/webserver/server.go

@@ -31,6 +31,7 @@ func getRouter() *gin.Engine {
 	routes.AddConfigRoutes(api)
 	routes.AddSoundRoutes(api)
 	routes.AddVideoArchiveRoutes(api)
+	routes.AddUserEventLogRoutes(api)
 
 	router.NoRoute(func(c *gin.Context) {
 		if strings.HasPrefix(c.Request.URL.String(), "/api/") {