mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-30 22:02:24 +00:00
7285e74090
There are some breaking changes in this commit, see #11455. Closes #11455 Closes #11549 This fixes a set of bugs (see issue list) and it is also paying some technical debt accumulated over the years. We now build with Staticcheck enabled in the CI build. The performance should be about the same as before for regular sized Hugo sites, but it should perform and scale much better to larger data sets, as objects that uses lots of memory (e.g. rendered Markdown, big JSON files read into maps with transform.Unmarshal etc.) will now get automatically garbage collected if needed. Performance on partial rebuilds when running the server in fast render mode should be the same, but the change detection should be much more accurate. A list of the notable new features: * A new dependency tracker that covers (almost) all of Hugo's API and is used to do fine grained partial rebuilds when running the server. * A new and simpler tree document store which allows fast lookups and prefix-walking in all dimensions (e.g. language) concurrently. * You can now configure an upper memory limit allowing for much larger data sets and/or running on lower specced PCs. We have lifted the "no resources in sub folders" restriction for branch bundles (e.g. sections). Memory Limit * Hugos will, by default, set aside a quarter of the total system memory, but you can set this via the OS environment variable HUGO_MEMORYLIMIT (in gigabytes). This is backed by a partitioned LRU cache used throughout Hugo. A cache that gets dynamically resized in low memory situations, allowing Go's Garbage Collector to free the memory. New Dependency Tracker: Hugo has had a rule based coarse grained approach to server rebuilds that has worked mostly pretty well, but there have been some surprises (e.g. stale content). This is now revamped with a new dependency tracker that can quickly calculate the delta given a changed resource (e.g. a content file, template, JS file etc.). This handles transitive relations, e.g. $page -> js.Build -> JS import, or $page1.Content -> render hook -> site.GetPage -> $page2.Title, or $page1.Content -> shortcode -> partial -> site.RegularPages -> $page2.Content -> shortcode ..., and should also handle changes to aggregated values (e.g. site.Lastmod) effectively. This covers all of Hugo's API with 2 known exceptions (a list that may not be fully exhaustive): Changes to files loaded with template func os.ReadFile may not be handled correctly. We recommend loading resources with resources.Get Changes to Hugo objects (e.g. Page) passed in the template context to lang.Translate may not be detected correctly. We recommend having simple i18n templates without too much data context passed in other than simple types such as strings and numbers. Note that the cachebuster configuration (when A changes then rebuild B) works well with the above, but we recommend that you revise that configuration, as it in most situations should not be needed. One example where it is still needed is with TailwindCSS and using changes to hugo_stats.json to trigger new CSS rebuilds. Document Store: Previously, a little simplified, we split the document store (where we store pages and resources) in a tree per language. This worked pretty well, but the structure made some operations harder than they needed to be. We have now restructured it into one Radix tree for all languages. Internally the language is considered to be a dimension of that tree, and the tree can be viewed in all dimensions concurrently. This makes some operations re. language simpler (e.g. finding translations is just a slice range), but the idea is that it should also be relatively inexpensive to add more dimensions if needed (e.g. role). Fixes #10169 Fixes #10364 Fixes #10482 Fixes #10630 Fixes #10656 Fixes #10694 Fixes #10918 Fixes #11262 Fixes #11439 Fixes #11453 Fixes #11457 Fixes #11466 Fixes #11540 Fixes #11551 Fixes #11556 Fixes #11654 Fixes #11661 Fixes #11663 Fixes #11664 Fixes #11669 Fixes #11671 Fixes #11807 Fixes #11808 Fixes #11809 Fixes #11815 Fixes #11840 Fixes #11853 Fixes #11860 Fixes #11883 Fixes #11904 Fixes #7388 Fixes #7425 Fixes #7436 Fixes #7544 Fixes #7882 Fixes #7960 Fixes #8255 Fixes #8307 Fixes #8863 Fixes #8927 Fixes #9192 Fixes #9324
348 lines
8.8 KiB
Go
348 lines
8.8 KiB
Go
// Copyright 2019 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package media contains Media Type (MIME type) related types and functions.
|
|
package media
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
)
|
|
|
|
var zero Type
|
|
|
|
const (
|
|
DefaultDelimiter = "."
|
|
)
|
|
|
|
// MediaType (also known as MIME type and content type) is a two-part identifier for
|
|
// file formats and format contents transmitted on the Internet.
|
|
// For Hugo's use case, we use the top-level type name / subtype name + suffix.
|
|
// One example would be application/svg+xml
|
|
// If suffix is not provided, the sub type will be used.
|
|
// <docsmeta>{ "name": "MediaType" }</docsmeta>
|
|
type Type struct {
|
|
// The full MIME type string, e.g. "application/rss+xml".
|
|
Type string `json:"-"`
|
|
|
|
// The top-level type name, e.g. "application".
|
|
MainType string `json:"mainType"`
|
|
// The subtype name, e.g. "rss".
|
|
SubType string `json:"subType"`
|
|
// The delimiter before the suffix, e.g. ".".
|
|
Delimiter string `json:"delimiter"`
|
|
|
|
// FirstSuffix holds the first suffix defined for this MediaType.
|
|
FirstSuffix SuffixInfo `json:"-"`
|
|
|
|
// This is the optional suffix after the "+" in the MIME type,
|
|
// e.g. "xml" in "application/rss+xml".
|
|
mimeSuffix string
|
|
|
|
// E.g. "jpg,jpeg"
|
|
// Stored as a string to make Type comparable.
|
|
// For internal use only.
|
|
SuffixesCSV string `json:"-"`
|
|
}
|
|
|
|
// SuffixInfo holds information about a Media Type's suffix.
|
|
type SuffixInfo struct {
|
|
// Suffix is the suffix without the delimiter, e.g. "xml".
|
|
Suffix string `json:"suffix"`
|
|
|
|
// FullSuffix is the suffix with the delimiter, e.g. ".xml".
|
|
FullSuffix string `json:"fullSuffix"`
|
|
}
|
|
|
|
// FromContent resolve the Type primarily using http.DetectContentType.
|
|
// If http.DetectContentType resolves to application/octet-stream, a zero Type is returned.
|
|
// If http.DetectContentType resolves to text/plain or application/xml, we try to get more specific using types and ext.
|
|
func FromContent(types Types, extensionHints []string, content []byte) Type {
|
|
t := strings.Split(http.DetectContentType(content), ";")[0]
|
|
if t == "application/octet-stream" {
|
|
return zero
|
|
}
|
|
|
|
var found bool
|
|
m, found := types.GetByType(t)
|
|
if !found {
|
|
if t == "text/xml" {
|
|
// This is how it's configured in Hugo by default.
|
|
m, found = types.GetByType("application/xml")
|
|
}
|
|
}
|
|
|
|
if !found {
|
|
return zero
|
|
}
|
|
|
|
var mm Type
|
|
|
|
for _, extension := range extensionHints {
|
|
extension = strings.TrimPrefix(extension, ".")
|
|
mm, _, found = types.GetFirstBySuffix(extension)
|
|
if found {
|
|
break
|
|
}
|
|
}
|
|
|
|
if found {
|
|
if m == mm {
|
|
return m
|
|
}
|
|
|
|
if m.IsText() && mm.IsText() {
|
|
// http.DetectContentType isn't brilliant when it comes to common text formats, so we need to do better.
|
|
// For now we say that if it's detected to be a text format and the extension/content type in header reports
|
|
// it to be a text format, then we use that.
|
|
return mm
|
|
}
|
|
|
|
// E.g. an image with a *.js extension.
|
|
return zero
|
|
}
|
|
|
|
return m
|
|
}
|
|
|
|
// FromStringAndExt creates a Type from a MIME string and a given extension.
|
|
func FromStringAndExt(t, ext string) (Type, error) {
|
|
tp, err := FromString(t)
|
|
if err != nil {
|
|
return tp, err
|
|
}
|
|
tp.SuffixesCSV = strings.TrimPrefix(ext, ".")
|
|
tp.Delimiter = DefaultDelimiter
|
|
tp.init()
|
|
return tp, nil
|
|
}
|
|
|
|
// FromString creates a new Type given a type string on the form MainType/SubType and
|
|
// an optional suffix, e.g. "text/html" or "text/html+html".
|
|
func FromString(t string) (Type, error) {
|
|
t = strings.ToLower(t)
|
|
parts := strings.Split(t, "/")
|
|
if len(parts) != 2 {
|
|
return Type{}, fmt.Errorf("cannot parse %q as a media type", t)
|
|
}
|
|
mainType := parts[0]
|
|
subParts := strings.Split(parts[1], "+")
|
|
|
|
subType := strings.Split(subParts[0], ";")[0]
|
|
|
|
var suffix string
|
|
|
|
if len(subParts) > 1 {
|
|
suffix = subParts[1]
|
|
}
|
|
|
|
var typ string
|
|
if suffix != "" {
|
|
typ = mainType + "/" + subType + "+" + suffix
|
|
} else {
|
|
typ = mainType + "/" + subType
|
|
}
|
|
|
|
return Type{Type: typ, MainType: mainType, SubType: subType, mimeSuffix: suffix}, nil
|
|
}
|
|
|
|
// For internal use.
|
|
func (m Type) String() string {
|
|
return m.Type
|
|
}
|
|
|
|
// Suffixes returns all valid file suffixes for this type.
|
|
func (m Type) Suffixes() []string {
|
|
if m.SuffixesCSV == "" {
|
|
return nil
|
|
}
|
|
|
|
return strings.Split(m.SuffixesCSV, ",")
|
|
}
|
|
|
|
// IsText returns whether this Type is a text format.
|
|
// Note that this may currently return false negatives.
|
|
// TODO(bep) improve
|
|
// For internal use.
|
|
func (m Type) IsText() bool {
|
|
if m.MainType == "text" {
|
|
return true
|
|
}
|
|
switch m.SubType {
|
|
case "javascript", "json", "rss", "xml", "svg", "toml", "yml", "yaml":
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
func InitMediaType(m *Type) {
|
|
m.init()
|
|
}
|
|
|
|
func (m *Type) init() {
|
|
m.FirstSuffix.FullSuffix = ""
|
|
m.FirstSuffix.Suffix = ""
|
|
if suffixes := m.Suffixes(); suffixes != nil {
|
|
m.FirstSuffix.Suffix = suffixes[0]
|
|
m.FirstSuffix.FullSuffix = m.Delimiter + m.FirstSuffix.Suffix
|
|
}
|
|
}
|
|
|
|
func newMediaType(main, sub string, suffixes []string) Type {
|
|
t := Type{MainType: main, SubType: sub, SuffixesCSV: strings.Join(suffixes, ","), Delimiter: DefaultDelimiter}
|
|
t.init()
|
|
return t
|
|
}
|
|
|
|
func newMediaTypeWithMimeSuffix(main, sub, mimeSuffix string, suffixes []string) Type {
|
|
mt := newMediaType(main, sub, suffixes)
|
|
mt.mimeSuffix = mimeSuffix
|
|
mt.init()
|
|
return mt
|
|
}
|
|
|
|
// Types is a slice of media types.
|
|
// <docsmeta>{ "name": "MediaTypes" }</docsmeta>
|
|
type Types []Type
|
|
|
|
func (t Types) Len() int { return len(t) }
|
|
func (t Types) Swap(i, j int) { t[i], t[j] = t[j], t[i] }
|
|
func (t Types) Less(i, j int) bool { return t[i].Type < t[j].Type }
|
|
|
|
// GetByType returns a media type for tp.
|
|
func (t Types) GetByType(tp string) (Type, bool) {
|
|
for _, tt := range t {
|
|
if strings.EqualFold(tt.Type, tp) {
|
|
return tt, true
|
|
}
|
|
}
|
|
|
|
if !strings.Contains(tp, "+") {
|
|
// Try with the main and sub type
|
|
parts := strings.Split(tp, "/")
|
|
if len(parts) == 2 {
|
|
return t.GetByMainSubType(parts[0], parts[1])
|
|
}
|
|
}
|
|
|
|
return Type{}, false
|
|
}
|
|
|
|
// BySuffix will return all media types matching a suffix.
|
|
func (t Types) BySuffix(suffix string) []Type {
|
|
suffix = strings.ToLower(suffix)
|
|
var types []Type
|
|
for _, tt := range t {
|
|
if tt.hasSuffix(suffix) {
|
|
types = append(types, tt)
|
|
}
|
|
}
|
|
return types
|
|
}
|
|
|
|
// GetFirstBySuffix will return the first type matching the given suffix.
|
|
func (t Types) GetFirstBySuffix(suffix string) (Type, SuffixInfo, bool) {
|
|
suffix = strings.ToLower(suffix)
|
|
for _, tt := range t {
|
|
if tt.hasSuffix(suffix) {
|
|
return tt, SuffixInfo{
|
|
FullSuffix: tt.Delimiter + suffix,
|
|
Suffix: suffix,
|
|
}, true
|
|
}
|
|
}
|
|
return Type{}, SuffixInfo{}, false
|
|
}
|
|
|
|
// GetBySuffix gets a media type given as suffix, e.g. "html".
|
|
// It will return false if no format could be found, or if the suffix given
|
|
// is ambiguous.
|
|
// The lookup is case insensitive.
|
|
func (t Types) GetBySuffix(suffix string) (tp Type, si SuffixInfo, found bool) {
|
|
suffix = strings.ToLower(suffix)
|
|
for _, tt := range t {
|
|
if tt.hasSuffix(suffix) {
|
|
if found {
|
|
// ambiguous
|
|
found = false
|
|
return
|
|
}
|
|
tp = tt
|
|
si = SuffixInfo{
|
|
FullSuffix: tt.Delimiter + suffix,
|
|
Suffix: suffix,
|
|
}
|
|
found = true
|
|
}
|
|
}
|
|
return
|
|
}
|
|
|
|
func (t Types) IsTextSuffix(suffix string) bool {
|
|
suffix = strings.ToLower(suffix)
|
|
for _, tt := range t {
|
|
if tt.hasSuffix(suffix) {
|
|
return tt.IsText()
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (m Type) hasSuffix(suffix string) bool {
|
|
return strings.Contains(","+m.SuffixesCSV+",", ","+suffix+",")
|
|
}
|
|
|
|
// GetByMainSubType gets a media type given a main and a sub type e.g. "text" and "plain".
|
|
// It will return false if no format could be found, or if the combination given
|
|
// is ambiguous.
|
|
// The lookup is case insensitive.
|
|
func (t Types) GetByMainSubType(mainType, subType string) (tp Type, found bool) {
|
|
for _, tt := range t {
|
|
if strings.EqualFold(mainType, tt.MainType) && strings.EqualFold(subType, tt.SubType) {
|
|
if found {
|
|
// ambiguous
|
|
found = false
|
|
return
|
|
}
|
|
|
|
tp = tt
|
|
found = true
|
|
}
|
|
}
|
|
return
|
|
}
|
|
|
|
// IsZero reports whether this Type represents a zero value.
|
|
// For internal use.
|
|
func (m Type) IsZero() bool {
|
|
return m.SubType == ""
|
|
}
|
|
|
|
// MarshalJSON returns the JSON encoding of m.
|
|
// For internal use.
|
|
func (m Type) MarshalJSON() ([]byte, error) {
|
|
type Alias Type
|
|
return json.Marshal(&struct {
|
|
Alias
|
|
Type string `json:"type"`
|
|
String string `json:"string"`
|
|
Suffixes []string `json:"suffixes"`
|
|
}{
|
|
Alias: (Alias)(m),
|
|
Type: m.Type,
|
|
String: m.String(),
|
|
Suffixes: strings.Split(m.SuffixesCSV, ","),
|
|
})
|
|
}
|