Merge pull request #1977 from edenhaus/preload-list

Add get request to preload endpoint for listing them

api/openapi.yaml

@@ -238,6 +238,14 @@ paths:
 
 
   /api/preload:
+    get:
+      summary: Get all preloaded streams
+      tags: [ Streams list ]
+      responses:
+        "200":
+          description: ""
+          content:
+            application/json: { example: { camera1: "video&audio", camera2: "video" } }
     put:
       summary: Preload new stream
       tags: [ Streams list ]

internal/streams/api.go

@@ -130,16 +130,15 @@ func apiStreamsDOT(w http.ResponseWriter, r *http.Request) {
 }
 
 func apiPreload(w http.ResponseWriter, r *http.Request) {
-	query := r.URL.Query()
-	src := query.Get("src")
-
-	// check if stream exists
-	stream := Get(src)
-	if stream == nil {
-		http.Error(w, "", http.StatusNotFound)
+	// GET - return all preloads
+	if r.Method == "GET" {
+		api.ResponseJSON(w, GetPreloads())
 		return
 	}
 
+	query := r.URL.Query()
+	src := query.Get("src")
+
 	switch r.Method {
 	case "PUT":
 		// it's safe to delete from map while iterating
@@ -153,7 +152,7 @@ func apiPreload(w http.ResponseWriter, r *http.Request) {
 
 		rawQuery := query.Encode()
 
-		if err := AddPreload(stream, rawQuery); err != nil {
+		if err := AddPreload(src, rawQuery); err != nil {
 			http.Error(w, err.Error(), http.StatusInternalServerError)
 			return
 		}
@@ -163,7 +162,7 @@ func apiPreload(w http.ResponseWriter, r *http.Request) {
 		}
 
 	case "DELETE":
-		if err := DelPreload(stream); err != nil {
+		if err := DelPreload(src); err != nil {
 			http.Error(w, err.Error(), http.StatusInternalServerError)
 			return
 		}

internal/streams/preload.go

@@ -1,23 +1,24 @@
 package streams
 
 import (
-	"errors"
+	"fmt"
+	"maps"
 	"net/url"
 	"sync"
 
 	"github.com/AlexxIT/go2rtc/pkg/probe"
 )
 
-var preloads = map[*Stream]*probe.Probe{}
-var preloadsMu sync.Mutex
-
-func Preload(stream *Stream, rawQuery string) {
-	if err := AddPreload(stream, rawQuery); err != nil {
-		log.Error().Err(err).Caller().Send()
-	}
+type Preload struct {
+	stream *Stream      // Don't output the stream to JSON to not worry about its secrets.
+	Cons   *probe.Probe `json:"consumer"`
+	Query  string       `json:"query"`
 }
 
-func AddPreload(stream *Stream, rawQuery string) error {
+var preloads = map[string]*Preload{}
+var preloadsMu sync.Mutex
+
+func AddPreload(name, rawQuery string) error {
 	if rawQuery == "" {
 		rawQuery = "video&audio"
 	}
@@ -30,29 +31,39 @@ func AddPreload(stream *Stream, rawQuery string) error {
 	preloadsMu.Lock()
 	defer preloadsMu.Unlock()
 
-	if cons := preloads[stream]; cons != nil {
-		stream.RemoveConsumer(cons)
+	if p := preloads[name]; p != nil {
+		p.stream.RemoveConsumer(p.Cons)
 	}
 
+	stream := Get(name)
+	if stream == nil {
+		return fmt.Errorf("streams: stream not found: %s", name)
+	}
 	cons := probe.Create("preload", query)
 
 	if err = stream.AddConsumer(cons); err != nil {
 		return err
 	}
 
-	preloads[stream] = cons
+	preloads[name] = &Preload{stream: stream, Cons: cons, Query: rawQuery}
 	return nil
 }
 
-func DelPreload(stream *Stream) error {
+func DelPreload(name string) error {
 	preloadsMu.Lock()
 	defer preloadsMu.Unlock()
 
-	if cons := preloads[stream]; cons != nil {
-		stream.RemoveConsumer(cons)
-		delete(preloads, stream)
+	if p := preloads[name]; p != nil {
+		p.stream.RemoveConsumer(p.Cons)
+		delete(preloads, name)
 		return nil
 	}
 
-	return errors.New("streams: preload not found")
+	return fmt.Errorf("streams: preload not found: %s", name)
+}
+
+func GetPreloads() map[string]*Preload {
+	preloadsMu.Lock()
+	defer preloadsMu.Unlock()
+	return maps.Clone(preloads)
 }

internal/streams/streams.go

@@ -43,8 +43,8 @@ func Init() {
 			}
 		}
 		for name, rawQuery := range cfg.Preload {
-			if stream := Get(name); stream != nil {
-				Preload(stream, rawQuery)
+			if err := AddPreload(name, rawQuery); err != nil {
+				log.Error().Err(err).Caller().Send()
 			}
 		}
 	})