diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-01-02 12:33:26 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-03-23 18:51:22 +0100 |
commit | 597e418cb02883418f2cebb41400e8e61413f651 (patch) | |
tree | 177ad9c540b2583b6dab138c9f0490d28989c7f7 /hugofs/createcounting_fs.go | |
parent | 44f5c1c14cb1f42cc5f01739c289e9cfc83602af (diff) |
Make Page an interface
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
Diffstat (limited to 'hugofs/createcounting_fs.go')
-rw-r--r-- | hugofs/createcounting_fs.go | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/hugofs/createcounting_fs.go b/hugofs/createcounting_fs.go new file mode 100644 index 000000000..802806b7a --- /dev/null +++ b/hugofs/createcounting_fs.go @@ -0,0 +1,99 @@ +// 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 ( + "fmt" + "os" + "sort" + "strings" + "sync" + + "github.com/spf13/afero" +) + +// Reseter is implemented by some of the stateful filesystems. +type Reseter interface { + Reset() +} + +// DuplicatesReporter reports about duplicate filenames. +type DuplicatesReporter interface { + ReportDuplicates() string +} + +func NewCreateCountingFs(fs afero.Fs) afero.Fs { + return &createCountingFs{Fs: fs, fileCount: make(map[string]int)} +} + +// ReportDuplicates reports filenames written more than once. +func (c *createCountingFs) ReportDuplicates() string { + c.mu.Lock() + defer c.mu.Unlock() + + var dupes []string + + for k, v := range c.fileCount { + if v > 1 { + dupes = append(dupes, fmt.Sprintf("%s (%d)", k, v)) + } + } + + if len(dupes) == 0 { + return "" + } + + sort.Strings(dupes) + + return strings.Join(dupes, ", ") +} + +// createCountingFs counts filenames of created files or files opened +// for writing. +type createCountingFs struct { + afero.Fs + + mu sync.Mutex + fileCount map[string]int +} + +func (c *createCountingFs) Reset() { + c.mu.Lock() + defer c.mu.Unlock() + + c.fileCount = make(map[string]int) +} + +func (fs *createCountingFs) onCreate(filename string) { + fs.mu.Lock() + defer fs.mu.Unlock() + + fs.fileCount[filename] = fs.fileCount[filename] + 1 +} + +func (fs *createCountingFs) Create(name string) (afero.File, error) { + f, err := fs.Fs.Create(name) + if err == nil { + fs.onCreate(name) + } + return f, err +} + +func (fs *createCountingFs) OpenFile(name string, flag int, perm os.FileMode) (afero.File, error) { + f, err := fs.Fs.OpenFile(name, flag, perm) + if err == nil && isWrite(flag) { + fs.onCreate(name) + } + return f, err +} |