mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
d8fdffb552
When doing something like this with the same image from a partial used in, say, both the home page and the single page: ```bash {{ with $img }} {{ $big := .Fill "1024x512 top" }} {{ $small := $big.Resize "512x" }} {{ end }} ``` There would be timing issues making Hugo in some cases try to process the same image with the same instructions in parallel. You would experience errors of type: ```bash png: invalid format: not enough pixel data ``` This commit works around that by adding a mutex per image. This should also improve the performance, sligthly, as it avoids duplicate work. The current workaround before this fix is to always operate on the original: ```bash {{ with $img }} {{ $big := .Fill "1024x512 top" }} {{ $small := .Fill "512x256 top" }} {{ end }} ``` Fixes #4404
127 lines
3.1 KiB
Go
127 lines
3.1 KiB
Go
// Copyright 2017-present 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 resource
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/gohugoio/hugo/helpers"
|
|
)
|
|
|
|
type imageCache struct {
|
|
absPublishDir string
|
|
absCacheDir string
|
|
pathSpec *helpers.PathSpec
|
|
mu sync.RWMutex
|
|
|
|
store map[string]*Image
|
|
}
|
|
|
|
func (c *imageCache) isInCache(key string) bool {
|
|
c.mu.RLock()
|
|
_, found := c.store[key]
|
|
c.mu.RUnlock()
|
|
return found
|
|
}
|
|
|
|
func (c *imageCache) deleteByPrefix(prefix string) {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
for k, _ := range c.store {
|
|
if strings.HasPrefix(k, prefix) {
|
|
delete(c.store, k)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (c *imageCache) getOrCreate(
|
|
parent *Image, key string, create func(resourceCacheFilename string) (*Image, error)) (*Image, error) {
|
|
|
|
relTargetFilename := key
|
|
|
|
if c.pathSpec.Language != nil {
|
|
// Avoid do and store more work than needed. The language versions will in
|
|
// most cases be duplicates of the same image files.
|
|
key = strings.TrimPrefix(key, "/"+c.pathSpec.Language.Lang)
|
|
}
|
|
|
|
// First check the in-memory store, then the disk.
|
|
c.mu.RLock()
|
|
img, found := c.store[key]
|
|
c.mu.RUnlock()
|
|
|
|
if found {
|
|
return img, nil
|
|
}
|
|
|
|
// Now look in the file cache.
|
|
// Multiple Go routines can invoke same operation on the same image, so
|
|
// we need to make sure this is serialized per source image.
|
|
parent.createMu.Lock()
|
|
defer parent.createMu.Unlock()
|
|
|
|
cacheFilename := filepath.Join(c.absCacheDir, key)
|
|
|
|
// The definition of this counter is not that we have processed that amount
|
|
// (e.g. resized etc.), it can be fetched from file cache,
|
|
// but the count of processed image variations for this site.
|
|
c.pathSpec.ProcessingStats.Incr(&c.pathSpec.ProcessingStats.ProcessedImages)
|
|
|
|
exists, err := helpers.Exists(cacheFilename, c.pathSpec.Fs.Source)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if exists {
|
|
img = parent.clone()
|
|
img.relTargetPath = relTargetFilename
|
|
img.absSourceFilename = cacheFilename
|
|
} else {
|
|
img, err = create(cacheFilename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
c.mu.Lock()
|
|
if img2, found := c.store[key]; found {
|
|
c.mu.Unlock()
|
|
return img2, nil
|
|
}
|
|
|
|
c.store[key] = img
|
|
|
|
c.mu.Unlock()
|
|
|
|
if !exists {
|
|
// File already written to destination
|
|
return img, nil
|
|
}
|
|
|
|
return img, img.copyToDestination(cacheFilename)
|
|
|
|
}
|
|
|
|
func newImageCache(ps *helpers.PathSpec, absCacheDir, absPublishDir string) *imageCache {
|
|
return &imageCache{pathSpec: ps, store: make(map[string]*Image), absCacheDir: absCacheDir, absPublishDir: absPublishDir}
|
|
}
|
|
|
|
func timeTrack(start time.Time, name string) {
|
|
elapsed := time.Since(start)
|
|
fmt.Printf("%s took %s\n", name, elapsed)
|
|
}
|