feat: add support for custom favicons (#4770)

* feat: add support for custom favicons * Commit updated API documentation * chore(i18n): add localization of text * fix(js): regenerate package lock file * chore(test): add favicon test * fix: max size not respected * Commit updated API documentation * fix: move favicon.ico to the static dir * fix: fix tests * fix: remove hard-coded content-type of icon * chore: update extracted translations * feat(admin): add support for resetting to default icon * chore: use a higher res default favicon * Commit updated API documentation --------- Co-authored-by: Owncast <owncast@owncast.online>
2026-01-28 18:07:19 -08:00
parent f8560db614
commit 6abaf20f2b
77 changed files with 981 additions and 177 deletions
@@ -0,0 +1,55 @@
+package handlers
+
+import (
+	"net/http"
+	"os"
+	"path/filepath"
+	"strconv"
+
+	"github.com/owncast/owncast/config"
+	"github.com/owncast/owncast/persistence/configrepository"
+	"github.com/owncast/owncast/static"
+	"github.com/owncast/owncast/utils"
+	log "github.com/sirupsen/logrus"
+)
+
+// GetFavicon will return the favicon image as a response.
+func GetFavicon(w http.ResponseWriter, r *http.Request) {
+	configRepository := configrepository.Get()
+	faviconFilename := configRepository.GetFaviconPath()
+	if faviconFilename == "" {
+		returnDefaultFavicon(w)
+		return
+	}
+
+	faviconPath := filepath.Join(config.DataDirectory, faviconFilename)
+	faviconBytes, err := os.ReadFile(faviconPath) //nolint:gosec
+	if err != nil {
+		returnDefaultFavicon(w)
+		return
+	}
+
+	contentType := "image/x-icon"
+	if filepath.Ext(faviconFilename) == ".png" {
+		contentType = "image/png" //nolint:goconst
+	}
+
+	cacheTime := utils.GetCacheDurationSecondsForPath(faviconPath)
+	writeFaviconResponse(faviconBytes, contentType, w, cacheTime)
+}
+
+func returnDefaultFavicon(w http.ResponseWriter) {
+	faviconBytes := static.GetFavicon()
+	cacheTime := utils.GetCacheDurationSecondsForPath("favicon.png")
+	writeFaviconResponse(faviconBytes, "image/png", w, cacheTime)
+}
+
+func writeFaviconResponse(data []byte, contentType string, w http.ResponseWriter, cacheSeconds int) {
+	w.Header().Set("Content-Type", contentType)
+	w.Header().Set("Content-Length", strconv.Itoa(len(data)))
+	w.Header().Set("Cache-Control", "public, max-age="+strconv.Itoa(cacheSeconds))
+
+	if _, err := w.Write(data); err != nil {
+		log.Println("unable to write favicon.")
+	}
+}