Implement +version list.

Author: Seraphim R.P

i18n/languages.go

@@ -10,7 +10,7 @@ import (
 //go:embed english/english.json
 var englishRawObjectFile []byte
 
-// ImportLanguages imports the old JSON database into the new PGSQL one.
+// ImportLanguages simply imports any defined languages and returns them in a map.
 func ImportLanguages() map[string]models.Language {
 	languages := make(map[string]models.Language)
 

models/language.go

@@ -2,15 +2,12 @@ package models
 
 import (
 	"reflect"
+	"regexp"
 	"strings"
-
-	"gorm.io/gorm"
-	"internal.kerygma.digital/kerygma-digital/biblebot/backend/utils/slices"
 )
 
 // Language is a type describing an interface language.
 type Language struct {
-	gorm.Model
 	Name      string
 	RawName   string
 	RawObject RawLanguage
@@ -209,45 +206,45 @@ type args struct {
 	False   string `json:"false"`
 }
 
-func (lng Language) GetString(ctx *Context, str string, params []string) string {
-	// TODO: Infer params from raw string, as they are always surrounded by <>. Making it a parameter is mildly inconvenient.
-	rawStr := lng.GetRawString(str)
+func (lng Language) GetString(ctx *Context, str string) string {
+	return lng.TranslatePlaceholdersInString(ctx, lng.GetRawString(str))
+}
 
-	if params == nil {
-		return rawStr
+func (lng Language) GetRawString(str string) string {
+	v := reflect.ValueOf(lng.RawObject)
+
+	for i := 0; i < v.NumField(); i++ {
+		if v.Type().Field(i).Name == str && !stringInSlice(str, []string{"Commands", "Arguments"}) {
+			return v.Field(i).String()
+		}
 	}
 
-	for _, replaceQuery := range params {
-		origQuery := replaceQuery
+	return str
+}
+
+func (lng Language) TranslatePlaceholdersInString(ctx *Context, str string) string {
+	placeholderRegex, _ := regexp.Compile("<([^<>]+)>")
+	placeholders := placeholderRegex.FindAllString(str, -1)
+
+	for _, placeholder := range placeholders {
+		tmpPlaceholder := placeholder
 
-		switch replaceQuery {
+		switch placeholder {
 		case "<+>":
-			replaceQuery = ctx.GuildPrefs.Prefix
+			placeholder = ctx.GuildPrefs.Prefix
 		default:
-			purifiedQuery := strings.Title(replaceQuery[1 : len(replaceQuery)-1])
+			purifiedQuery := strings.Title(placeholder[1 : len(placeholder)-1])
 			possibleCommand := lng.GetCommandTranslation(purifiedQuery)
 			possibleArgument := lng.GetArgumentTranslation(purifiedQuery)
 
 			if possibleCommand != purifiedQuery {
-				replaceQuery = possibleCommand
+				placeholder = possibleCommand
 			} else if possibleArgument != purifiedQuery {
-				replaceQuery = possibleArgument
+				placeholder = possibleArgument
 			}
 		}
 
-		rawStr = strings.ReplaceAll(rawStr, origQuery, replaceQuery)
-	}
-
-	return rawStr
-}
-
-func (lng Language) GetRawString(str string) string {
-	v := reflect.ValueOf(lng.RawObject)
-
-	for i := 0; i < v.NumField(); i++ {
-		if v.Type().Field(i).Name == str && !slices.StringInSlice(str, []string{"Commands", "Arguments"}) {
-			return v.Field(i).String()
-		}
+		str = strings.ReplaceAll(str, tmpPlaceholder, placeholder)
 	}
 
 	return str
@@ -300,3 +297,12 @@ func (lng Language) GetArgumentTranslation(str string) string {
 
 	return str
 }
+
+func stringInSlice(a string, list []string) bool {
+	for _, b := range list {
+		if b == a {
+			return true
+		}
+	}
+	return false
+}

models/response.go

@@ -2,9 +2,10 @@ package models
 
 // CommandResponse is a model for command output.
 type CommandResponse struct {
-	OK      bool            `json:"ok"`
-	Content *DiscordEmbed   `json:"content"`
-	Pages   []*DiscordEmbed `json:"pages"`
+	OK       bool            `json:"ok"`
+	Language *Language       `json:"language"`
+	Content  *DiscordEmbed   `json:"content"`
+	Pages    []*DiscordEmbed `json:"pages"`
 }
 
 // VerseResponse is a model for command output.

routes/commands/settings/versions.go

@@ -2,7 +2,10 @@ package settings
 
 import (
 	"fmt"
+	"math"
 	"sort"
+	"strconv"
+	"strings"
 	"sync"
 
 	"internal.kerygma.digital/kerygma-digital/biblebot/backend/models"
@@ -27,7 +30,7 @@ func NewVersionCommandRouter() *VersionCommandRouter {
 	versionOnce.Do(func() {
 		versionInstance = &VersionCommandRouter{
 			DefaultCommand: verDefault,
-			Commands:       []models.Command{verSet, verSetServer},
+			Commands:       []models.Command{verSet, verSetServer, verList},
 		}
 	})
 
@@ -86,6 +89,8 @@ var verDefault = models.Command{
 var verSet = models.Command{
 	Command: "set",
 	Process: func(params []string, ctx *models.Context) *models.CommandResponse {
+		lng := ctx.Language
+
 		var idealVersion models.Version
 		var idealUser models.UserPreference
 
@@ -106,10 +111,10 @@ var verSet = models.Command{
 			}
 
 			response.OK = true
-			response.Content = embedify.Embedify("", "+version set", ctx.Language.GetString(ctx, "SetVersionSuccess", nil), false, "")
+			response.Content = embedify.Embedify("", lng.TranslatePlaceholdersInString(ctx, "<+><version> <set>"), lng.GetString(ctx, "SetVersionSuccess"), false, "")
 		} else {
 			response.OK = false
-			response.Content = embedify.Embedify("", "+version set", ctx.Language.GetString(ctx, "SetVersionFail", []string{"<+>", "<version>", "<list>"}), false, "")
+			response.Content = embedify.Embedify("", lng.TranslatePlaceholdersInString(ctx, "<+><version> <set>"), lng.GetString(ctx, "SetVersionFail"), false, "")
 		}
 
 		return &response
@@ -119,6 +124,8 @@ var verSet = models.Command{
 var verSetServer = models.Command{
 	Command: "setserver",
 	Process: func(params []string, ctx *models.Context) *models.CommandResponse {
+		lng := ctx.Language
+
 		var idealVersion models.Version
 		var idealGuild models.GuildPreference
 
@@ -139,10 +146,10 @@ var verSetServer = models.Command{
 			}
 
 			response.OK = true
-			response.Content = embedify.Embedify("", "+version setserver", ctx.Language.GetString(ctx, "SetGuildVersionSuccess", nil), false, "")
+			response.Content = embedify.Embedify("", lng.TranslatePlaceholdersInString(ctx, "<+><version> <setserver>"), lng.GetString(ctx, "SetGuildVersionSuccess"), false, "")
 		} else {
 			response.OK = false
-			response.Content = embedify.Embedify("", "+version setserver", ctx.Language.GetString(ctx, "SetGuildVersionFail", []string{"<+>", "<version>", "<list>"}), false, "")
+			response.Content = embedify.Embedify("", lng.TranslatePlaceholdersInString(ctx, "<+><version> <setserver>"), lng.GetString(ctx, "SetGuildVersionFail"), false, "")
 		}
 
 		return &response
@@ -160,19 +167,46 @@ var verList = models.Command{
 			return versions[i].Name < versions[j].Name
 		})
 
-		/*var pages []string
+		var pages []*models.DiscordEmbed
 		var maxResultsPerPage = 25
 		var versionsUsed []models.Version
-		totalPages := math.Ceil(len(versions) / maxResultsPerPage)
+		totalPages := int(math.Ceil(float64(len(versions)) / float64(maxResultsPerPage)))
 
 		if totalPages == 0 {
 			totalPages = 1
 		}
 
-		for i := range totalPages {
-			// TODO, finish this once languages are implemented
-		}*/
+		for i := 0; i < totalPages; i++ {
+			pageCounter := ctx.Language.GetString(ctx, "PageOf")
+			pageCounter = strings.ReplaceAll(pageCounter, "<num>", strconv.Itoa(i+1))
+			pageCounter = strings.ReplaceAll(pageCounter, "<total>", strconv.Itoa(totalPages))
+
+			title := fmt.Sprintf("%s - %s", ctx.Language.TranslatePlaceholdersInString(ctx, "<+><version> <list>"), pageCounter)
+			embed := embedify.Embedify("", title, "", false, "")
 
-		return &models.CommandResponse{}
+			count := 0
+			versionList := ""
+
+			for _, version := range versions {
+				if count < maxResultsPerPage {
+					if !slices.VersionInSlice(version, versionsUsed) {
+						versionList += fmt.Sprintf("%s\n", version.Name)
+
+						versionsUsed = append(versionsUsed, version)
+						versions = versions[1:]
+						count++
+					}
+				}
+			}
+
+			embed.Description = versionList
+			pages = append(pages, embed)
+		}
+
+		return &models.CommandResponse{
+			OK:       true,
+			Language: &ctx.Language,
+			Pages:    pages,
+		}
 	},
 }

utils/slices/slices.go

@@ -2,6 +2,8 @@ package slices
 
 import (
 	"reflect"
+
+	"internal.kerygma.digital/kerygma-digital/biblebot/backend/models"
 )
 
 // Index finds index of string in []string, otherwise returns -1
@@ -53,6 +55,16 @@ func IntInSlice(a int, list []int) bool {
 	return false
 }
 
+// VersionInSlice returns whether a is in list.
+func VersionInSlice(a models.Version, list []models.Version) bool {
+	for _, b := range list {
+		if b == a {
+			return true
+		}
+	}
+	return false
+}
+
 // IndexRune finds index of rune in []rune, otherwise returns -1
 func IndexRune(vs []rune, t rune) int {
 	for i, v := range vs {