mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-02 23:30:00 +00:00
tpl/data: Move cache logic to separate file
This commit is contained in:
Cameron Moore
Bjørn Erik Pedersen
parent
5f095c27ea
commit
1cf2f3dc4f
83
tpl/data/cache.go
Normal file
83
tpl/data/cache.go
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
// Copyright 2017 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 data
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"net/url"
|
||||
"sync"
|
||||
|
||||
"github.com/spf13/afero"
|
||||
"github.com/spf13/hugo/config"
|
||||
"github.com/spf13/hugo/helpers"
|
||||
)
|
||||
|
||||
var cacheMu sync.RWMutex
|
||||
|
||||
// getCacheFileID returns the cache ID for a string.
|
||||
func getCacheFileID(cfg config.Provider, id string) string {
|
||||
return cfg.GetString("cacheDir") + url.QueryEscape(id)
|
||||
}
|
||||
|
||||
// getCache returns the content for an ID from the file cache or an error.
|
||||
// If the ID is not found, return nil,nil.
|
||||
func getCache(id string, fs afero.Fs, cfg config.Provider, ignoreCache bool) ([]byte, error) {
|
||||
if ignoreCache {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
cacheMu.RLock()
|
||||
defer cacheMu.RUnlock()
|
||||
|
||||
fID := getCacheFileID(cfg, id)
|
||||
isExists, err := helpers.Exists(fID, fs)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if !isExists {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
return afero.ReadFile(fs, fID)
|
||||
}
|
||||
|
||||
// writeCache writes bytes associated with an ID into the file cache.
|
||||
func writeCache(id string, c []byte, fs afero.Fs, cfg config.Provider, ignoreCache bool) error {
|
||||
if ignoreCache {
|
||||
return nil
|
||||
}
|
||||
|
||||
cacheMu.Lock()
|
||||
defer cacheMu.Unlock()
|
||||
|
||||
fID := getCacheFileID(cfg, id)
|
||||
f, err := fs.Create(fID)
|
||||
if err != nil {
|
||||
return errors.New("Error: " + err.Error() + ". Failed to create file: " + fID)
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
n, err := f.Write(c)
|
||||
if err != nil {
|
||||
return errors.New("Error: " + err.Error() + ". Failed to write to file: " + fID)
|
||||
}
|
||||
if n == 0 {
|
||||
return errors.New("No bytes written to file: " + fID)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func deleteCache(id string, fs afero.Fs, cfg config.Provider) error {
|
||||
return fs.Remove(getCacheFileID(cfg, id))
|
||||
}
|
||||
|
|
@ -20,7 +20,6 @@ import (
|
|||
"errors"
|
||||
"io/ioutil"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
|
|
@ -36,7 +35,6 @@ var (
|
|||
remoteURLLock = &remoteLock{m: make(map[string]*sync.Mutex)}
|
||||
resSleep = time.Second * 2 // if JSON decoding failed sleep for n seconds before retrying
|
||||
resRetries = 1 // number of retries to load the JSON from URL or local file system
|
||||
resCacheMu sync.RWMutex
|
||||
)
|
||||
|
||||
type remoteLock struct {
|
||||
|
|
@ -68,63 +66,6 @@ func (l *remoteLock) URLUnlock(url string) {
|
|||
}
|
||||
}
|
||||
|
||||
// getCacheFileID returns the cache ID for a string.
|
||||
func getCacheFileID(cfg config.Provider, id string) string {
|
||||
return cfg.GetString("cacheDir") + url.QueryEscape(id)
|
||||
}
|
||||
|
||||
// getCache returns the content for an ID from the file cache or an error.
|
||||
// If the ID is not found, return nil,nil.
|
||||
func getCache(id string, fs afero.Fs, cfg config.Provider, ignoreCache bool) ([]byte, error) {
|
||||
if ignoreCache {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
resCacheMu.RLock()
|
||||
defer resCacheMu.RUnlock()
|
||||
|
||||
fID := getCacheFileID(cfg, id)
|
||||
isExists, err := helpers.Exists(fID, fs)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if !isExists {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
return afero.ReadFile(fs, fID)
|
||||
}
|
||||
|
||||
// writeCache writes bytes associated with an ID into the file cache.
|
||||
func writeCache(id string, c []byte, fs afero.Fs, cfg config.Provider, ignoreCache bool) error {
|
||||
if ignoreCache {
|
||||
return nil
|
||||
}
|
||||
|
||||
resCacheMu.Lock()
|
||||
defer resCacheMu.Unlock()
|
||||
|
||||
fID := getCacheFileID(cfg, id)
|
||||
f, err := fs.Create(fID)
|
||||
if err != nil {
|
||||
return errors.New("Error: " + err.Error() + ". Failed to create file: " + fID)
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
n, err := f.Write(c)
|
||||
if err != nil {
|
||||
return errors.New("Error: " + err.Error() + ". Failed to write to file: " + fID)
|
||||
}
|
||||
if n == 0 {
|
||||
return errors.New("No bytes written to file: " + fID)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func deleteCache(id string, fs afero.Fs, cfg config.Provider) error {
|
||||
return fs.Remove(getCacheFileID(cfg, id))
|
||||
}
|
||||
|
||||
// getRemote loads the content of a remote file. This method is thread safe.
|
||||
func getRemote(url string, fs afero.Fs, cfg config.Provider, hc *http.Client) ([]byte, error) {
|
||||
c, err := getCache(url, fs, cfg, cfg.GetBool("ignoreCache"))
|
||||
|
|
|
|||
Loading…
Reference in a new issue