mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 16:22:05 -05:00
597e418cb0
The main motivation of this commit is to add a `page.Page` interface to replace the very file-oriented `hugolib.Page` struct. This is all a preparation step for issue #5074, "pages from other data sources". But this also fixes a set of annoying limitations, especially related to custom output formats, and shortcodes. Most notable changes: * The inner content of shortcodes using the `{{%` as the outer-most delimiter will now be sent to the content renderer, e.g. Blackfriday. This means that any markdown will partake in the global ToC and footnote context etc. * The Custom Output formats are now "fully virtualized". This removes many of the current limitations. * The taxonomy list type now has a reference to the `Page` object. This improves the taxonomy template `.Title` situation and make common template constructs much simpler. See #5074 Fixes #5763 Fixes #5758 Fixes #5090 Fixes #5204 Fixes #4695 Fixes #5607 Fixes #5707 Fixes #5719 Fixes #3113 Fixes #5706 Fixes #5767 Fixes #5723 Fixes #5769 Fixes #5770 Fixes #5771 Fixes #5759 Fixes #5776 Fixes #5777 Fixes #5778
92 lines
2.5 KiB
Go
92 lines
2.5 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 hugofs
|
|
|
|
import (
|
|
"crypto/md5"
|
|
"encoding/hex"
|
|
"hash"
|
|
"os"
|
|
|
|
"github.com/spf13/afero"
|
|
)
|
|
|
|
var (
|
|
_ afero.Fs = (*md5HashingFs)(nil)
|
|
)
|
|
|
|
// FileHashReceiver will receive the filename an the content's MD5 sum on file close.
|
|
type FileHashReceiver interface {
|
|
OnFileClose(name, md5sum string)
|
|
}
|
|
|
|
type md5HashingFs struct {
|
|
afero.Fs
|
|
hashReceiver FileHashReceiver
|
|
}
|
|
|
|
// NewHashingFs creates a new filesystem that will receive MD5 checksums of
|
|
// any written file content on Close. Note that this is probably not a good
|
|
// idea for "full build" situations, but when doing fast render mode, the amount
|
|
// of files published is low, and it would be really nice to know exactly which
|
|
// of these files where actually changed.
|
|
// Note that this will only work for file operations that use the io.Writer
|
|
// to write content to file, but that is fine for the "publish content" use case.
|
|
func NewHashingFs(delegate afero.Fs, hashReceiver FileHashReceiver) afero.Fs {
|
|
return &md5HashingFs{Fs: delegate, hashReceiver: hashReceiver}
|
|
}
|
|
|
|
func (fs *md5HashingFs) Create(name string) (afero.File, error) {
|
|
f, err := fs.Fs.Create(name)
|
|
if err == nil {
|
|
f = fs.wrapFile(f)
|
|
}
|
|
return f, err
|
|
}
|
|
|
|
func (fs *md5HashingFs) OpenFile(name string, flag int, perm os.FileMode) (afero.File, error) {
|
|
f, err := fs.Fs.OpenFile(name, flag, perm)
|
|
if err == nil && isWrite(flag) {
|
|
f = fs.wrapFile(f)
|
|
}
|
|
return f, err
|
|
}
|
|
|
|
func (fs *md5HashingFs) wrapFile(f afero.File) afero.File {
|
|
return &hashingFile{File: f, h: md5.New(), hashReceiver: fs.hashReceiver}
|
|
}
|
|
|
|
func (fs *md5HashingFs) Name() string {
|
|
return "md5HashingFs"
|
|
}
|
|
|
|
type hashingFile struct {
|
|
hashReceiver FileHashReceiver
|
|
h hash.Hash
|
|
afero.File
|
|
}
|
|
|
|
func (h *hashingFile) Write(p []byte) (n int, err error) {
|
|
n, err = h.File.Write(p)
|
|
if err != nil {
|
|
return
|
|
}
|
|
return h.h.Write(p)
|
|
}
|
|
|
|
func (h *hashingFile) Close() error {
|
|
sum := hex.EncodeToString(h.h.Sum(nil))
|
|
h.hashReceiver.OnFileClose(h.Name(), sum)
|
|
return h.File.Close()
|
|
}
|