6abaf20f2b
* 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>
98 lines
2.9 KiB
Go
98 lines
2.9 KiB
Go
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"
|
|
)
|
|
|
|
var _hasWarnedSVGLogo = false
|
|
|
|
// GetLogo will return the logo image as a response.
|
|
func GetLogo(w http.ResponseWriter, r *http.Request) {
|
|
configRepository := configrepository.Get()
|
|
imageFilename := configRepository.GetLogoPath()
|
|
if imageFilename == "" {
|
|
returnDefault(w)
|
|
return
|
|
}
|
|
imagePath := filepath.Join(config.DataDirectory, imageFilename)
|
|
imageBytes, err := getImage(imagePath)
|
|
if err != nil {
|
|
returnDefault(w)
|
|
return
|
|
}
|
|
|
|
contentType := "image/jpeg"
|
|
if filepath.Ext(imageFilename) == ".svg" {
|
|
contentType = "image/svg+xml"
|
|
} else if filepath.Ext(imageFilename) == ".gif" {
|
|
contentType = "image/gif"
|
|
} else if filepath.Ext(imageFilename) == ".png" {
|
|
contentType = "image/png" //nolint:goconst
|
|
}
|
|
|
|
cacheTime := utils.GetCacheDurationSecondsForPath(imagePath)
|
|
writeBytesAsImage(imageBytes, contentType, w, cacheTime)
|
|
}
|
|
|
|
// GetCompatibleLogo will return the logo unless it's a SVG
|
|
// and in that case will return a default placeholder.
|
|
// Used for sharing to external social networks that generally
|
|
// don't support SVG.
|
|
func GetCompatibleLogo(w http.ResponseWriter, r *http.Request) {
|
|
configRepository := configrepository.Get()
|
|
imageFilename := configRepository.GetLogoPath()
|
|
|
|
// If the logo image is not a SVG then we can return it
|
|
// without any problems.
|
|
if imageFilename != "" && filepath.Ext(imageFilename) != ".svg" {
|
|
GetLogo(w, r)
|
|
return
|
|
}
|
|
|
|
// Otherwise use a fallback logo.png.
|
|
imagePath := filepath.Join(config.DataDirectory, "logo.png")
|
|
contentType := "image/png"
|
|
imageBytes, err := getImage(imagePath)
|
|
if err != nil {
|
|
returnDefault(w)
|
|
return
|
|
}
|
|
|
|
cacheTime := utils.GetCacheDurationSecondsForPath(imagePath)
|
|
writeBytesAsImage(imageBytes, contentType, w, cacheTime)
|
|
|
|
if !_hasWarnedSVGLogo {
|
|
log.Warnf("an external site requested your logo. because many social networks do not support SVGs we returned a placeholder instead. change your current logo to a png or jpeg to be most compatible with external social networking sites.")
|
|
_hasWarnedSVGLogo = true
|
|
}
|
|
}
|
|
|
|
func returnDefault(w http.ResponseWriter) {
|
|
imageBytes := static.GetLogo()
|
|
cacheTime := utils.GetCacheDurationSecondsForPath("logo.png")
|
|
writeBytesAsImage(imageBytes, "image/png", w, cacheTime)
|
|
}
|
|
|
|
func writeBytesAsImage(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 image.")
|
|
}
|
|
}
|
|
|
|
func getImage(path string) ([]byte, error) {
|
|
return os.ReadFile(path) // nolint
|
|
}
|