add /logs endpoint

Author: iloveicedgreentea

.gitignore

@@ -2,6 +2,7 @@ build
 .DS_Store
 *config.json
 media.*.priv*
+docker/data
 
 # Binaries for programs and plugins
 *.exe

Makefile

@@ -1,5 +1,5 @@
 .PHONY: build test run docker-run docker-build
-
+SHELL := /bin/bash
 build: 
 	cd cmd && go build -o ../build/server
 
@@ -16,7 +16,7 @@ docker-build:
 	docker buildx build --load --tag plex-webhook-automation-local .
 docker-push:
 	docker buildx build --push --platform linux/amd64 --tag ghcr.io/iloveicedgreentea/plex-webhook-automation:test . 
-docker-run: docker-build
-	docker run -p 9999:9999 -e LOG_LEVEL=debug plex-webhook-automation-local
+docker-run:
+	docker run -p 9999:9999 -e LOG_LEVEL=debug -v $(shell pwd)/docker/data:/data plex-webhook-automation-local
 run: build
-	LOG_LEVEL=debug ./build/server
+	LOG_FILE=false LOG_LEVEL=debug ./build/server

api/handlers.go

@@ -13,14 +13,14 @@ import (
 
 var log = logger.GetLogger()
 
-func GenConfigPaths() (string, string){
+func GenConfigPaths() (string, string) {
 	ex, err := os.Executable()
 	if err != nil {
 		log.Error(err)
 	}
 
 	exPath := filepath.Dir(ex)
-	configPath1 := "/config.json" // docker
+	configPath1 := "/data/config.json"                     // docker
 	configPath2 := filepath.Join(exPath, "../config.json") // Fallback path (for local)
 
 	log.Debugf("Config paths: %s, %s", configPath1, configPath2)
@@ -51,6 +51,16 @@ func ConfigExists(c *gin.Context) {
 	c.JSON(200, gin.H{"exists": err == nil})
 }
 
+// Route for getting logs
+func GetLogs(c *gin.Context) {
+	logFile, err := os.ReadFile("/data/application.log")
+	if err != nil {
+		c.JSON(500, gin.H{"error": "unable to read log file: " + err.Error()})
+		return
+	}
+	c.Data(200, "text/plain", logFile)
+}
+
 // GetConfig returns the config for the API
 func GetConfig(c *gin.Context) {
 	path, err := GetConfigPath()

api/routes.go

@@ -4,7 +4,9 @@ import (
     "github.com/gin-gonic/gin"
 )
 
+// RegisterRoutes registers the routes for the API contained in handlers.go
 func RegisterRoutes(router *gin.Engine) {
 	router.GET("/config", GetConfig)
 	router.POST("/config", SaveConfig)
+	router.GET("/logs", GetLogs)
 }

changelog.txt

@@ -26,4 +26,11 @@ HDMI Sync automation in testing
 *Breaking changes* All config fields are lowercase now
 
 10-9-23
-Modify UUID filter to accept comma for multiple
+Modify UUID filter to accept comma for multiple
+
+12-sometime-23
+* Breaking change - volume must now be /data
+* log to a file
+* add /logs endpoint
+* add prelim jellyfin support
+* new name

cmd/main.go

@@ -2,7 +2,7 @@ package main
 
 import (
 	"fmt"
-
+	"os"
 	"github.com/gin-gonic/gin"
 	"github.com/iloveicedgreentea/go-plex/api"
 	"github.com/iloveicedgreentea/go-plex/internal/config"
@@ -26,6 +26,12 @@ func main() {
 	###############################
 	Setups
 	############################## */
+
+	// truncate old logs
+	err := os.Remove("/data/application.log")
+    if err != nil && !os.IsNotExist(err) {
+        panic(err)
+    }
 	log := logger.GetLogger()
 	log.Info("Starting up...")
 	log.Debug("Starting in debug mode...")
@@ -35,7 +41,7 @@ func main() {
 	r.Use(noCache())
 
 	log.Info("Checking if a config exists...")
-	_, err := api.GetConfigPath()
+	_, err = api.GetConfigPath()
 	if err != nil {
 		log.Info("Config not found. Creating a new config file...")
 		err = api.CreateConfig(&gin.Context{})

docker/watch.py

@@ -2,22 +2,31 @@
 import os
 from hashlib import md5
 
+FILEPATH = "/data/config.json"
+
 def file_checksum(filepath):
-    with open(filepath, 'rb') as f:
-        return md5(f.read()).hexdigest()
+    """Return the MD5 checksum of a file. Try until the file exists."""
+    while True:
+        try:
+            with open(filepath, 'rb') as f:
+                return md5(f.read()).hexdigest()
+        except FileNotFoundError:
+            print("File not found, waiting for it to appear.")
+            time.sleep(5)
+            continue
 
 def restart_service():
     os.system("supervisorctl restart app")
 
 if __name__ == "__main__":
-    last_checksum = file_checksum("/config.json")
+    last_checksum = file_checksum(FILEPATH)
 
     while True:
-        current_checksum = file_checksum("/config.json")
+        current_checksum = file_checksum(FILEPATH)
 
         if last_checksum != current_checksum:
-            print("Configuration file changed, restarting the app.")
+            print("Watcher Service: Configuration file changed, restarting the app.")
             restart_service()
             last_checksum = current_checksum
 
-        time.sleep(5)  # Poll every 5 seconds
+        time.sleep(3)  # Poll every 5 seconds

internal/config/config.go

@@ -22,10 +22,10 @@ func init() {
 	}
 
 	exPath := filepath.Dir(ex)
-	configPath1 := filepath.Join(exPath, "../config.json")
-
-	// Fallback path (for Docker)
-	configPath2 := "/config.json"
+	// docker path
+	configPath1 := "/data/config.json"
+	// local
+	configPath2 := filepath.Join(exPath, "../config.json")
 
 	var found bool
 

internal/logger/logger.go

@@ -10,14 +10,25 @@ import (
 func GetLogger() *log.Logger {
 	logger := log.New()
 
+	// log to file if LOG_FILE is not false
+	if os.Getenv("LOG_FILE") != "false" {
+		// Open a file for logging
+		file, err := os.OpenFile("/data/application.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
+		if err != nil {
+			log.Fatalf("Failed to open log file: %v", err)
+		}
+
+		// Set logger output to the file
+		logger.SetOutput(file)
+	}
 	// log level
 	if strings.ToLower(os.Getenv("LOG_LEVEL")) == "debug" {
 		logger.SetLevel(log.DebugLevel)
 	}
 	if os.Getenv("SUPER_DEBUG") == "true" {
 		logger.SetReportCaller(true)
 	}
-	
+
 	logger.SetFormatter(&log.TextFormatter{
 		TimestampFormat: "01-02-2006 15:04:05", FullTimestamp: true,
 	})

readme.md

@@ -83,13 +83,14 @@ Configure this application via the Plex section and it "should work" but no prom
 > ℹ  If you need help deploying with Docker, refer to the [Docker documentation](https://docs.docker.com/get-docker/).
 
 1) Deploy the latest version `ghcr.io/iloveicedgreentea/plex-webhook-automation:latest`. I recommend running this in an orchestrator like Unraid, Docker-Compose, etc
-2) Configure the application via web ui -> `http://(you-server-ip):9999`
+2) You must mount a volume to `/data` to persist data
+3) Configure the application via web ui -> `http://(you-server-ip):9999`
    * can get your player UUID from `https://plex.tv/devices.xml` while logged in
-3) Set up Plex to send webhooks to your server IP, `listenPort`, and the handler endpoint of `/plexwebhook`
+4) Set up Plex to send webhooks to your server IP, `listenPort`, and the handler endpoint of `/plexwebhook`
     * e.g `(your-server-ip):9999/plexwebhook`
-3) Whitelist your server IP in Plex so it can call the API without authentication. [Docs](https://support.plex.tv/articles/200890058-authentication-for-local-network-access/)
-4) Play a movie and check server logs. It should say what it loaded and you should see whatever options you enabled work
-5) The Application will restart within 5 seconds when config is saved in the UI
+5) Whitelist your server IP in Plex so it can call the API without authentication. [Docs](https://support.plex.tv/articles/200890058-authentication-for-local-network-access/)
+6) Play a movie and check server logs. It should say what it loaded and you should see whatever options you enabled work
+6) The Application will restart within 5 seconds when config is saved in the UI
 
 ### Non-Docker Setup
 I don't recommend this as it is more work and you will need to set up systemd or something to keep it running. I don't provide support for this method but if you know what you are doing, it is very easy to build the binary and run it.