// Copyright 2020 The Gitea Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. package httpcache import ( "encoding/base64" "fmt" "net/http" "os" "strconv" "strings" "time" "code.gitea.io/gitea/modules/setting" ) // AddCacheControlToHeader adds suitable cache-control headers to response func AddCacheControlToHeader(h http.Header, d time.Duration) { if setting.IsProd { h.Set("Cache-Control", "private, max-age="+strconv.Itoa(int(d.Seconds()))) } else { h.Set("Cache-Control", "no-store") // to remind users they are using non-prod setting. // some users may be confused by "Cache-Control: no-store" in their setup if they did wrong to `RUN_MODE` in `app.ini`. h.Add("X-Gitea-Debug", "RUN_MODE="+setting.RunMode) h.Add("X-Gitea-Debug", "CacheControl=no-store") } } // generateETag generates an ETag based on size, filename and file modification time func generateETag(fi os.FileInfo) string { etag := fmt.Sprint(fi.Size()) + fi.Name() + fi.ModTime().UTC().Format(http.TimeFormat) return `"` + base64.StdEncoding.EncodeToString([]byte(etag)) + `"` } // HandleTimeCache handles time-based caching for a HTTP request func HandleTimeCache(req *http.Request, w http.ResponseWriter, fi os.FileInfo) (handled bool) { AddCacheControlToHeader(w.Header(), setting.StaticCacheTime) ifModifiedSince := req.Header.Get("If-Modified-Since") if ifModifiedSince != "" { t, err := time.Parse(http.TimeFormat, ifModifiedSince) if err == nil && fi.ModTime().Unix() <= t.Unix() { w.WriteHeader(http.StatusNotModified) return true } } w.Header().Set("Last-Modified", fi.ModTime().Format(http.TimeFormat)) return false } // HandleFileETagCache handles ETag-based caching for a HTTP request func HandleFileETagCache(req *http.Request, w http.ResponseWriter, fi os.FileInfo) (handled bool) { etag := generateETag(fi) return HandleGenericETagCache(req, w, etag) } // HandleGenericETagCache handles ETag-based caching for a HTTP request. // It returns true if the request was handled. func HandleGenericETagCache(req *http.Request, w http.ResponseWriter, etag string) (handled bool) { if len(etag) > 0 { w.Header().Set("Etag", etag) if checkIfNoneMatchIsValid(req, etag) { w.WriteHeader(http.StatusNotModified) return true } } AddCacheControlToHeader(w.Header(), setting.StaticCacheTime) return false } // checkIfNoneMatchIsValid tests if the header If-None-Match matches the ETag func checkIfNoneMatchIsValid(req *http.Request, etag string) bool { ifNoneMatch := req.Header.Get("If-None-Match") if len(ifNoneMatch) > 0 { for _, item := range strings.Split(ifNoneMatch, ",") { item = strings.TrimSpace(item) if item == etag { return true } } } return false }