Implement route for exporting cache & auth for access to cache managing routes (#49)

Author: man90es

README.md

@@ -2,7 +2,7 @@
 Scraper for Black Desert Online community data with a built-in API server. It currently supports EU, NA, SA and KR regions. Support for other regions might be added in the future.
 
 ## Projects using this API
-- ~~BDO Leaderboards ([Website](https://bdo.hemlo.cc/leaderboards), [sources](https://github.com/man90es/BDO-Leaderboards)): web-based leaderboards for Black Desert Online.~~
+- ~~BDO Leaderboards ([Sources](https://github.com/man90es/BDO-Leaderboards)): web-based leaderboards for Black Desert Online.~~
 - Ikusa ([Website](https://ikusa.site), [sources](https://github.com/sch-28/ikusa_api)): powerful tool that allows you to analyze your game logs and gain valuable insights into your combat performance.
 - GuildYapper ([Discord server](https://discord.gg/x2nKYuu2Z2)): Discord bot with various features for BDO guilds such as guild and player history logging, and automatic trial Discord management (more features TBA).
 - BDO Guild Bosses - Alliance [EU] ([Discord server](https://discord.gg/735bYrQWKr)): Discord bot for organising events in a guild bosses alliance.
@@ -21,6 +21,10 @@ API documentation can be viewed [here](https://man90es.github.io/BDO-REST-API/).
 If you host the API yourself, either via Docker or natively, you can control some of its features by executing it with flags.
 
 Available flags:
+- `-admintoken`
+	- Specifies an admin token that gives access to certain endpoints
+	- Type: string
+	- Default value: none
 - `-cachettl`
 	- Specifies cache TTL in minutes
 	- Type: unsigned integer

cache/cache.go

@@ -14,9 +14,9 @@ import (
 )
 
 type CacheEntry[T any] struct {
-	Data   T
-	Date   time.Time
-	Status int
+	Data   T         `json:"data"`
+	Date   time.Time `json:"date"`
+	Status int       `json:"status"`
 }
 
 type cache[T any] struct {
@@ -72,6 +72,17 @@ func (c *cache[T]) GetKeys() []string {
 	return maps.Keys(c.internalCache.Items())
 }
 
+func (c *cache[T]) GetValues() []CacheEntry[T] {
+	items := c.internalCache.Items()
+	result := make([]CacheEntry[T], 0, len(items))
+
+	for _, item := range items {
+		result = append(result, item.Object.(CacheEntry[T]))
+	}
+
+	return result
+}
+
 var GuildProfiles = newCache[models.GuildProfile]()
 var GuildSearch = newCache[[]models.GuildProfile]()
 var Profiles = newCache[models.Profile]()

handlers/ListenAndServe.go

@@ -17,7 +17,8 @@ func ListenAndServe() {
 	mux.HandleFunc("GET /v1", getStatus)
 	mux.HandleFunc("GET /v1/adventurer", getAdventurer)
 	mux.HandleFunc("GET /v1/adventurer/search", getAdventurerSearch)
-	mux.HandleFunc("GET /v1/cache", getCache)
+	mux.HandleFunc("GET /v1/cache", getCacheSummary)
+	mux.HandleFunc("GET /v1/cache/{cacheType}", getCache)
 	mux.HandleFunc("GET /v1/guild", getGuild)
 	mux.HandleFunc("GET /v1/guild/search", getGuildSearch)
 	mux.HandleFunc("/", catchall)

handlers/getCache.go

@@ -4,49 +4,35 @@ import (
 	"bdo-rest-api/cache"
 	"encoding/json"
 	"net/http"
-	"strings"
 
-	sf "github.com/sa-/slicefunk"
+	"github.com/spf13/viper"
 )
 
-func getParseCacheKey(cacheType string) func(string) map[string]interface{} {
-	return func(key string) map[string]interface{} {
-		parts := strings.Split(key, ",")
-
-		switch cacheType {
-		case "/adventurer":
-			return map[string]interface{}{
-				"region":        parts[0],
-				"profileTarget": parts[1],
-			}
-		case "/adventurer/search":
+func getCache(w http.ResponseWriter, r *http.Request) {
+	if token := viper.GetString("admintoken"); len(token) > 0 {
+		providedToken := r.Header.Get("Authorization")
 
-			return map[string]interface{}{
-				"region":    parts[0],
-				"query":     parts[1],
-				"searhType": parts[2],
-			}
-		case "/guild":
-			return map[string]interface{}{
-				"region":    parts[0],
-				"guildName": parts[1],
-			}
-		case "/guild/search":
-			return map[string]interface{}{
-				"region": parts[0],
-				"query":  parts[1],
-			}
-		default:
-			return nil
+		if providedToken != "Bearer "+token {
+			w.WriteHeader(http.StatusUnauthorized)
+			return
 		}
 	}
-}
 
-func getCache(w http.ResponseWriter, r *http.Request) {
-	json.NewEncoder(w).Encode(map[string]interface{}{
-		"/adventurer":        sf.Map(cache.Profiles.GetKeys(), getParseCacheKey("/adventurer")),
-		"/adventurer/search": sf.Map(cache.ProfileSearch.GetKeys(), getParseCacheKey("/adventurer/search")),
-		"/guild":             sf.Map(cache.GuildProfiles.GetKeys(), getParseCacheKey("/guild")),
-		"/guild/search":      sf.Map(cache.GuildSearch.GetKeys(), getParseCacheKey("/guild/search")),
-	})
+	cacheType := r.PathValue("cacheType")
+
+	if len(cacheType) == 0 {
+		w.WriteHeader(http.StatusBadRequest)
+		return
+	}
+
+	switch cacheType {
+	case "adventurer":
+		w.WriteHeader(http.StatusOK)
+		json.NewEncoder(w).Encode(cache.Profiles.GetValues())
+	case "guild":
+		w.WriteHeader(http.StatusOK)
+		json.NewEncoder(w).Encode(cache.GuildProfiles.GetValues())
+	default:
+		w.WriteHeader(http.StatusBadRequest)
+	}
 }

handlers/getCacheSummary.go

@@ -0,0 +1,62 @@
+package handlers
+
+import (
+	"bdo-rest-api/cache"
+	"encoding/json"
+	"net/http"
+	"strings"
+
+	sf "github.com/sa-/slicefunk"
+	"github.com/spf13/viper"
+)
+
+func getParseCacheKey(cacheType string) func(string) map[string]interface{} {
+	return func(key string) map[string]interface{} {
+		parts := strings.Split(key, ",")
+
+		switch cacheType {
+		case "/adventurer":
+			return map[string]interface{}{
+				"region":        parts[0],
+				"profileTarget": parts[1],
+			}
+		case "/adventurer/search":
+
+			return map[string]interface{}{
+				"region":    parts[0],
+				"query":     parts[1],
+				"searhType": parts[2],
+			}
+		case "/guild":
+			return map[string]interface{}{
+				"region":    parts[0],
+				"guildName": parts[1],
+			}
+		case "/guild/search":
+			return map[string]interface{}{
+				"region": parts[0],
+				"query":  parts[1],
+			}
+		default:
+			return nil
+		}
+	}
+}
+
+func getCacheSummary(w http.ResponseWriter, r *http.Request) {
+	if token := viper.GetString("admintoken"); len(token) > 0 {
+		providedToken := r.Header.Get("Authorization")
+
+		if providedToken != "Bearer "+token {
+			w.WriteHeader(http.StatusUnauthorized)
+			return
+		}
+	}
+
+	json.NewEncoder(w).Encode(map[string]interface{}{
+		"/adventurer":        sf.Map(cache.Profiles.GetKeys(), getParseCacheKey("/adventurer")),
+		"/adventurer/search": sf.Map(cache.ProfileSearch.GetKeys(), getParseCacheKey("/adventurer/search")),
+		"/guild":             sf.Map(cache.GuildProfiles.GetKeys(), getParseCacheKey("/guild")),
+		"/guild/search":      sf.Map(cache.GuildSearch.GetKeys(), getParseCacheKey("/guild/search")),
+	})
+}

handlers/getStatus.go

@@ -12,7 +12,7 @@ import (
 )
 
 var initTime = time.Now()
-var version = "1.12.5"
+var version = "1.13.0"
 
 func getStatus(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(map[string]interface{}{

main.go

@@ -15,6 +15,7 @@ import (
 )
 
 func main() {
+	flagAdminToken := flag.String("admintoken", "", "Admin token to allow certain endpoints")
 	flagCacheTTL := flag.Uint("cachettl", 180, "Cache TTL in minutes")
 	flagMaintenanceTTL := flag.Uint("maintenancettl", 5, "Allows to limit how frequently scraper can check for maintenance end in minutes")
 	flagMongo := flag.String("mongo", "", "MongoDB connection string for loggig")
@@ -46,6 +47,7 @@ func main() {
 		viper.Set("proxy", strings.Fields(os.Getenv("PROXY")))
 	}
 
+	viper.Set("admintoken", *flagAdminToken)
 	viper.Set("cachettl", time.Duration(*flagCacheTTL)*time.Minute)
 	viper.Set("maintenancettl", time.Duration(*flagMaintenanceTTL)*time.Minute)
 	viper.Set("maxtasksperclient", int(*flagMaxTasksPerClient))