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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
|
package fsutil
import (
"context"
"io"
gofs "io/fs"
"os"
"path/filepath"
"strings"
"syscall"
"github.com/moby/patternmatcher"
"github.com/pkg/errors"
"github.com/tonistiigi/fsutil/types"
)
type FilterOpt struct {
// IncludePatterns requires that the path matches at least one of the
// specified patterns.
IncludePatterns []string
// ExcludePatterns requires that the path does not match any of the
// specified patterns.
ExcludePatterns []string
// FollowPaths contains symlinks that are resolved into IncludePatterns
// at the time of the call to NewFilterFS.
FollowPaths []string
// Map is called for each path that is included in the result.
// The function can modify the stat info for each element, while the result
// of the function controls both how Walk continues.
Map MapFunc
}
type MapFunc func(string, *types.Stat) MapResult
// The result of the walk function controls
// both how WalkDir continues and whether the path is kept.
type MapResult int
const (
// Keep the current path and continue.
MapResultKeep MapResult = iota
// Exclude the current path and continue.
MapResultExclude
// Exclude the current path, and skip the rest of the dir.
// If path is a dir, skip the current directory.
// If path is a file, skip the rest of the parent directory.
// (This matches the semantics of fs.SkipDir.)
MapResultSkipDir
)
type filterFS struct {
fs FS
includeMatcher *patternmatcher.PatternMatcher
excludeMatcher *patternmatcher.PatternMatcher
onlyPrefixIncludes bool
onlyPrefixExcludeExceptions bool
mapFn MapFunc
}
// NewFilterFS creates a new FS that filters the given FS using the given
// FilterOpt.
//
// The returned FS will not contain any paths that do not match the provided
// include and exclude patterns, or that are are excluded using the mapping
// function.
//
// The FS is assumed to be a snapshot of the filesystem at the time of the
// call to NewFilterFS. If the underlying filesystem changes, calls to the
// underlying FS may be inconsistent.
func NewFilterFS(fs FS, opt *FilterOpt) (FS, error) {
if opt == nil {
return fs, nil
}
var includePatterns []string
if opt.IncludePatterns != nil {
includePatterns = make([]string, len(opt.IncludePatterns))
copy(includePatterns, opt.IncludePatterns)
}
if opt.FollowPaths != nil {
targets, err := FollowLinks(fs, opt.FollowPaths)
if err != nil {
return nil, err
}
if targets != nil {
includePatterns = append(includePatterns, targets...)
includePatterns = dedupePaths(includePatterns)
}
}
patternChars := "*[]?^"
if filepath.Separator != '\\' {
patternChars += `\`
}
var (
includeMatcher *patternmatcher.PatternMatcher
excludeMatcher *patternmatcher.PatternMatcher
err error
onlyPrefixIncludes = true
onlyPrefixExcludeExceptions = true
)
if len(includePatterns) > 0 {
includeMatcher, err = patternmatcher.New(includePatterns)
if err != nil {
return nil, errors.Wrapf(err, "invalid includepatterns: %s", opt.IncludePatterns)
}
for _, p := range includeMatcher.Patterns() {
if !p.Exclusion() && strings.ContainsAny(patternWithoutTrailingGlob(p), patternChars) {
onlyPrefixIncludes = false
break
}
}
}
if len(opt.ExcludePatterns) > 0 {
excludeMatcher, err = patternmatcher.New(opt.ExcludePatterns)
if err != nil {
return nil, errors.Wrapf(err, "invalid excludepatterns: %s", opt.ExcludePatterns)
}
for _, p := range excludeMatcher.Patterns() {
if p.Exclusion() && strings.ContainsAny(patternWithoutTrailingGlob(p), patternChars) {
onlyPrefixExcludeExceptions = false
break
}
}
}
return &filterFS{
fs: fs,
includeMatcher: includeMatcher,
excludeMatcher: excludeMatcher,
onlyPrefixIncludes: onlyPrefixIncludes,
onlyPrefixExcludeExceptions: onlyPrefixExcludeExceptions,
mapFn: opt.Map,
}, nil
}
func (fs *filterFS) Open(p string) (io.ReadCloser, error) {
if fs.includeMatcher != nil {
m, err := fs.includeMatcher.MatchesOrParentMatches(p)
if err != nil {
return nil, err
}
if !m {
return nil, errors.Wrapf(os.ErrNotExist, "open %s", p)
}
}
if fs.excludeMatcher != nil {
m, err := fs.excludeMatcher.MatchesOrParentMatches(p)
if err != nil {
return nil, err
}
if m {
return nil, errors.Wrapf(os.ErrNotExist, "open %s", p)
}
}
return fs.fs.Open(p)
}
func (fs *filterFS) Walk(ctx context.Context, target string, fn gofs.WalkDirFunc) error {
type visitedDir struct {
entry gofs.DirEntry
pathWithSep string
includeMatchInfo patternmatcher.MatchInfo
excludeMatchInfo patternmatcher.MatchInfo
calledFn bool
skipFn bool
}
// used only for include/exclude handling
var parentDirs []visitedDir
return fs.fs.Walk(ctx, target, func(path string, dirEntry gofs.DirEntry, walkErr error) (retErr error) {
defer func() {
if retErr != nil && isNotExist(retErr) {
retErr = filepath.SkipDir
}
}()
var (
dir visitedDir
isDir bool
)
if dirEntry != nil {
isDir = dirEntry.IsDir()
}
if fs.includeMatcher != nil || fs.excludeMatcher != nil {
for len(parentDirs) != 0 {
lastParentDir := parentDirs[len(parentDirs)-1].pathWithSep
if strings.HasPrefix(path, lastParentDir) {
break
}
parentDirs = parentDirs[:len(parentDirs)-1]
}
if isDir {
dir = visitedDir{
entry: dirEntry,
pathWithSep: path + string(filepath.Separator),
}
}
}
skip := false
if fs.includeMatcher != nil {
var parentIncludeMatchInfo patternmatcher.MatchInfo
if len(parentDirs) != 0 {
parentIncludeMatchInfo = parentDirs[len(parentDirs)-1].includeMatchInfo
}
m, matchInfo, err := fs.includeMatcher.MatchesUsingParentResults(path, parentIncludeMatchInfo)
if err != nil {
return errors.Wrap(err, "failed to match includepatterns")
}
if isDir {
dir.includeMatchInfo = matchInfo
}
if !m {
if isDir && fs.onlyPrefixIncludes {
// Optimization: we can skip walking this dir if no include
// patterns could match anything inside it.
dirSlash := path + string(filepath.Separator)
for _, pat := range fs.includeMatcher.Patterns() {
if pat.Exclusion() {
continue
}
patStr := patternWithoutTrailingGlob(pat) + string(filepath.Separator)
if strings.HasPrefix(patStr, dirSlash) {
goto passedIncludeFilter
}
}
return filepath.SkipDir
}
passedIncludeFilter:
skip = true
}
}
if fs.excludeMatcher != nil {
var parentExcludeMatchInfo patternmatcher.MatchInfo
if len(parentDirs) != 0 {
parentExcludeMatchInfo = parentDirs[len(parentDirs)-1].excludeMatchInfo
}
m, matchInfo, err := fs.excludeMatcher.MatchesUsingParentResults(path, parentExcludeMatchInfo)
if err != nil {
return errors.Wrap(err, "failed to match excludepatterns")
}
if isDir {
dir.excludeMatchInfo = matchInfo
}
if m {
if isDir && fs.onlyPrefixExcludeExceptions {
// Optimization: we can skip walking this dir if no
// exceptions to exclude patterns could match anything
// inside it.
if !fs.excludeMatcher.Exclusions() {
return filepath.SkipDir
}
dirSlash := path + string(filepath.Separator)
for _, pat := range fs.excludeMatcher.Patterns() {
if !pat.Exclusion() {
continue
}
patStr := patternWithoutTrailingGlob(pat) + string(filepath.Separator)
if strings.HasPrefix(patStr, dirSlash) {
goto passedExcludeFilter
}
}
return filepath.SkipDir
}
passedExcludeFilter:
skip = true
}
}
if walkErr != nil {
if skip && errors.Is(walkErr, os.ErrPermission) {
return nil
}
return walkErr
}
if fs.includeMatcher != nil || fs.excludeMatcher != nil {
defer func() {
if isDir {
parentDirs = append(parentDirs, dir)
}
}()
}
if skip {
return nil
}
dir.calledFn = true
fi, err := dirEntry.Info()
if err != nil {
return err
}
stat, ok := fi.Sys().(*types.Stat)
if !ok {
return errors.WithStack(&os.PathError{Path: path, Err: syscall.EBADMSG, Op: "fileinfo without stat info"})
}
select {
case <-ctx.Done():
return ctx.Err()
default:
if fs.mapFn != nil {
result := fs.mapFn(stat.Path, stat)
if result == MapResultSkipDir {
return filepath.SkipDir
} else if result == MapResultExclude {
return nil
}
}
for i, parentDir := range parentDirs {
if parentDir.skipFn {
return filepath.SkipDir
}
if parentDir.calledFn {
continue
}
parentFi, err := parentDir.entry.Info()
if err != nil {
return err
}
parentStat, ok := parentFi.Sys().(*types.Stat)
if !ok {
return errors.WithStack(&os.PathError{Path: path, Err: syscall.EBADMSG, Op: "fileinfo without stat info"})
}
select {
case <-ctx.Done():
return ctx.Err()
default:
}
if fs.mapFn != nil {
result := fs.mapFn(parentStat.Path, parentStat)
if result == MapResultExclude {
continue
} else if result == MapResultSkipDir {
parentDirs[i].skipFn = true
return filepath.SkipDir
}
}
parentDirs[i].calledFn = true
if err := fn(parentStat.Path, &DirEntryInfo{Stat: parentStat}, nil); err == filepath.SkipDir {
parentDirs[i].skipFn = true
return filepath.SkipDir
} else if err != nil {
return err
}
}
if err := fn(stat.Path, &DirEntryInfo{Stat: stat}, nil); err != nil {
return err
}
}
return nil
})
}
func Walk(ctx context.Context, p string, opt *FilterOpt, fn filepath.WalkFunc) error {
f, err := NewFS(p)
if err != nil {
return err
}
f, err = NewFilterFS(f, opt)
if err != nil {
return err
}
return f.Walk(ctx, "/", func(path string, d gofs.DirEntry, err error) error {
var info gofs.FileInfo
if d != nil {
var err2 error
info, err2 = d.Info()
if err == nil {
err = err2
}
}
return fn(path, info, err)
})
}
func WalkDir(ctx context.Context, p string, opt *FilterOpt, fn gofs.WalkDirFunc) error {
f, err := NewFS(p)
if err != nil {
return err
}
f, err = NewFilterFS(f, opt)
if err != nil {
return err
}
return f.Walk(ctx, "/", fn)
}
func patternWithoutTrailingGlob(p *patternmatcher.Pattern) string {
patStr := p.String()
// We use filepath.Separator here because patternmatcher.Pattern patterns
// get transformed to use the native path separator:
// https://github.com/moby/patternmatcher/blob/130b41bafc16209dc1b52a103fdac1decad04f1a/patternmatcher.go#L52
patStr = strings.TrimSuffix(patStr, string(filepath.Separator)+"**")
patStr = strings.TrimSuffix(patStr, string(filepath.Separator)+"*")
return patStr
}
func isNotExist(err error) bool {
return errors.Is(err, os.ErrNotExist) || errors.Is(err, syscall.ENOTDIR)
}
|