1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
// 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"
"io/fs"
"path/filepath"
"sort"
"strings"
"github.com/gohugoio/hugo/common/herrors"
"github.com/gohugoio/hugo/common/loggers"
"github.com/gohugoio/hugo/common/paths"
"github.com/spf13/afero"
)
type (
WalkFunc func(path string, info FileMetaInfo) error
WalkHook func(dir FileMetaInfo, path string, readdir []FileMetaInfo) ([]FileMetaInfo, error)
)
type Walkway struct {
logger loggers.Logger
// Prevent a walkway to be walked more than once.
walked bool
// Config from client.
cfg WalkwayConfig
}
type WalkwayConfig struct {
// The filesystem to walk.
Fs afero.Fs
// The root to start from in Fs.
Root string
// The logger to use.
Logger loggers.Logger
// One or both of these may be pre-set.
Info FileMetaInfo // The start info.
DirEntries []FileMetaInfo // The start info's dir entries.
// Will be called in order.
HookPre WalkHook // Optional.
WalkFn WalkFunc
HookPost WalkHook // Optional.
// Some optional flags.
FailOnNotExist bool // If set, return an error if a directory is not found.
SortDirEntries bool // If set, sort the dir entries by Name before calling the WalkFn, default is ReaDir order.
}
func NewWalkway(cfg WalkwayConfig) *Walkway {
if cfg.Fs == nil {
panic("fs must be set")
}
logger := cfg.Logger
if logger == nil {
logger = loggers.NewDefault()
}
return &Walkway{
cfg: cfg,
logger: logger,
}
}
func (w *Walkway) Walk() error {
if w.walked {
panic("this walkway is already walked")
}
w.walked = true
if w.cfg.Fs == NoOpFs {
return nil
}
return w.walk(w.cfg.Root, w.cfg.Info, w.cfg.DirEntries)
}
// checkErr returns true if the error is handled.
func (w *Walkway) checkErr(filename string, err error) bool {
if herrors.IsNotExist(err) && !w.cfg.FailOnNotExist {
// The file may be removed in process.
// This may be a ERROR situation, but it is not possible
// to determine as a general case.
w.logger.Warnf("File %q not found, skipping.", filename)
return true
}
return false
}
// walk recursively descends path, calling walkFn.
func (w *Walkway) walk(path string, info FileMetaInfo, dirEntries []FileMetaInfo) error {
pathRel := strings.TrimPrefix(path, w.cfg.Root)
if info == nil {
var err error
fi, err := w.cfg.Fs.Stat(path)
if err != nil {
if path == w.cfg.Root && herrors.IsNotExist(err) {
return nil
}
if w.checkErr(path, err) {
return nil
}
return fmt.Errorf("walk: stat: %s", err)
}
info = fi.(FileMetaInfo)
}
err := w.cfg.WalkFn(path, info)
if err != nil {
if info.IsDir() && err == filepath.SkipDir {
return nil
}
return err
}
if !info.IsDir() {
return nil
}
if dirEntries == nil {
f, err := w.cfg.Fs.Open(path)
if err != nil {
if w.checkErr(path, err) {
return nil
}
return fmt.Errorf("walk: open: path: %q filename: %q: %s", path, info.Meta().Filename, err)
}
fis, err := f.(fs.ReadDirFile).ReadDir(-1)
f.Close()
if err != nil {
if w.checkErr(path, err) {
return nil
}
return fmt.Errorf("walk: Readdir: %w", err)
}
dirEntries = DirEntriesToFileMetaInfos(fis)
for _, fi := range dirEntries {
if fi.Meta().PathInfo == nil {
fi.Meta().PathInfo = paths.Parse("", filepath.Join(pathRel, fi.Name()))
}
}
if w.cfg.SortDirEntries {
sort.Slice(dirEntries, func(i, j int) bool {
return dirEntries[i].Name() < dirEntries[j].Name()
})
}
}
if w.cfg.HookPre != nil {
var err error
dirEntries, err = w.cfg.HookPre(info, path, dirEntries)
if err != nil {
if err == filepath.SkipDir {
return nil
}
return err
}
}
for _, fim := range dirEntries {
nextPath := filepath.Join(path, fim.Name())
err := w.walk(nextPath, fim, nil)
if err != nil {
if !fim.IsDir() || err != filepath.SkipDir {
return err
}
}
}
if w.cfg.HookPost != nil {
var err error
dirEntries, err = w.cfg.HookPost(info, path, dirEntries)
if err != nil {
if err == filepath.SkipDir {
return nil
}
return err
}
}
return nil
}
|
