52fb936773
Replace #25892 Close #21942 Close #25464 Major changes: 1. Serve "robots.txt" and ".well-known/security.txt" in the "public" custom path * All files in "public/.well-known" can be served, just like "public/assets" 3. Add a test for ".well-known/security.txt" 4. Simplify the "FileHandlerFunc" logic, now the paths are consistent so the code can be simpler 5. Add CORS header for ".well-known" endpoints 6. Add logs to tell users they should move some of their legacy custom public files ``` 2023/07/19 13:00:37 cmd/web.go:178:serveInstalled() [E] Found legacy public asset "img" in CustomPath. Please move it to /work/gitea/custom/public/assets/img 2023/07/19 13:00:37 cmd/web.go:182:serveInstalled() [E] Found legacy public asset "robots.txt" in CustomPath. Please move it to /work/gitea/custom/public/robots.txt ``` This PR is not breaking. --------- Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: Giteabot <teabot@gitea.io>
119 lines
3.5 KiB
Go
119 lines
3.5 KiB
Go
// Copyright 2016 The Gitea Authors. All rights reserved.
|
||
// SPDX-License-Identifier: MIT
|
||
|
||
package public
|
||
|
||
import (
|
||
"bytes"
|
||
"io"
|
||
"net/http"
|
||
"os"
|
||
"path"
|
||
"strings"
|
||
"time"
|
||
|
||
"code.gitea.io/gitea/modules/assetfs"
|
||
"code.gitea.io/gitea/modules/container"
|
||
"code.gitea.io/gitea/modules/httpcache"
|
||
"code.gitea.io/gitea/modules/log"
|
||
"code.gitea.io/gitea/modules/setting"
|
||
"code.gitea.io/gitea/modules/util"
|
||
)
|
||
|
||
func CustomAssets() *assetfs.Layer {
|
||
return assetfs.Local("custom", setting.CustomPath, "public")
|
||
}
|
||
|
||
func AssetFS() *assetfs.LayeredFS {
|
||
return assetfs.Layered(CustomAssets(), BuiltinAssets())
|
||
}
|
||
|
||
// FileHandlerFunc implements the static handler for serving files in "public" assets
|
||
func FileHandlerFunc() http.HandlerFunc {
|
||
assetFS := AssetFS()
|
||
return func(resp http.ResponseWriter, req *http.Request) {
|
||
if req.Method != "GET" && req.Method != "HEAD" {
|
||
resp.WriteHeader(http.StatusNotFound)
|
||
return
|
||
}
|
||
handleRequest(resp, req, assetFS, req.URL.Path)
|
||
}
|
||
}
|
||
|
||
// parseAcceptEncoding parse Accept-Encoding: deflate, gzip;q=1.0, *;q=0.5 as compress methods
|
||
func parseAcceptEncoding(val string) container.Set[string] {
|
||
parts := strings.Split(val, ";")
|
||
types := make(container.Set[string])
|
||
for _, v := range strings.Split(parts[0], ",") {
|
||
types.Add(strings.TrimSpace(v))
|
||
}
|
||
return types
|
||
}
|
||
|
||
// setWellKnownContentType will set the Content-Type if the file is a well-known type.
|
||
// See the comments of detectWellKnownMimeType
|
||
func setWellKnownContentType(w http.ResponseWriter, file string) {
|
||
mimeType := detectWellKnownMimeType(path.Ext(file))
|
||
if mimeType != "" {
|
||
w.Header().Set("Content-Type", mimeType)
|
||
}
|
||
}
|
||
|
||
func handleRequest(w http.ResponseWriter, req *http.Request, fs http.FileSystem, file string) {
|
||
// actually, fs (http.FileSystem) is designed to be a safe interface, relative paths won't bypass its parent directory, it's also fine to do a clean here
|
||
f, err := fs.Open(util.PathJoinRelX(file))
|
||
if err != nil {
|
||
if os.IsNotExist(err) {
|
||
w.WriteHeader(http.StatusNotFound)
|
||
return
|
||
}
|
||
w.WriteHeader(http.StatusInternalServerError)
|
||
log.Error("[Static] Open %q failed: %v", file, err)
|
||
return
|
||
}
|
||
defer f.Close()
|
||
|
||
fi, err := f.Stat()
|
||
if err != nil {
|
||
w.WriteHeader(http.StatusInternalServerError)
|
||
log.Error("[Static] %q exists, but fails to open: %v", file, err)
|
||
return
|
||
}
|
||
|
||
// need to serve index file? (no at the moment)
|
||
if fi.IsDir() {
|
||
w.WriteHeader(http.StatusNotFound)
|
||
return
|
||
}
|
||
|
||
serveContent(w, req, fi, fi.ModTime(), f)
|
||
}
|
||
|
||
type GzipBytesProvider interface {
|
||
GzipBytes() []byte
|
||
}
|
||
|
||
// serveContent serve http content
|
||
func serveContent(w http.ResponseWriter, req *http.Request, fi os.FileInfo, modtime time.Time, content io.ReadSeeker) {
|
||
setWellKnownContentType(w, fi.Name())
|
||
|
||
encodings := parseAcceptEncoding(req.Header.Get("Accept-Encoding"))
|
||
if encodings.Contains("gzip") {
|
||
// try to provide gzip content directly from bindata (provided by vfsgen۰CompressedFileInfo)
|
||
if compressed, ok := fi.(GzipBytesProvider); ok {
|
||
rdGzip := bytes.NewReader(compressed.GzipBytes())
|
||
// all gzipped static files (from bindata) are managed by Gitea, so we can make sure every file has the correct ext name
|
||
// then we can get the correct Content-Type, we do not need to do http.DetectContentType on the decompressed data
|
||
if w.Header().Get("Content-Type") == "" {
|
||
w.Header().Set("Content-Type", "application/octet-stream")
|
||
}
|
||
w.Header().Set("Content-Encoding", "gzip")
|
||
httpcache.ServeContentWithCacheControl(w, req, fi.Name(), modtime, rdGzip)
|
||
return
|
||
}
|
||
}
|
||
|
||
httpcache.ServeContentWithCacheControl(w, req, fi.Name(), modtime, content)
|
||
return
|
||
}
|