Compare commits
No commits in common. "master" and "v1.10.0" have entirely different histories.
@ -1,3 +0,0 @@
|
||||
- XATTRS
|
||||
(see FS_XFLAG_* in fs.h, FS_IOC_FSGETXATTR/FS_IOC_FSSETXATTR)
|
||||
- fs label, UUID? (fs.h)
|
||||
@ -1,36 +0,0 @@
|
||||
package fsutils
|
||||
|
||||
var (
|
||||
/*
|
||||
linuxFsAttrsListOrder defines the order the attributes are printed in per e2fsprogs.
|
||||
|
||||
See flags_name at https://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git/tree/lib/e2p/pf.c for order.
|
||||
Up to date as of e2fsprogs v1.47.1, Linux 6.12-rc7.
|
||||
|
||||
The below are the struct field names for easier reflection.
|
||||
*/
|
||||
linuxFsAttrsListOrder []string = []string{
|
||||
"SecureDelete",
|
||||
"UnDelete",
|
||||
"SyncUpdate",
|
||||
"DirSync",
|
||||
"Immutable",
|
||||
"AppendOnly",
|
||||
"NoDumpFile",
|
||||
"NoUpdateAtime",
|
||||
"CompressFile",
|
||||
"EncFile",
|
||||
"ReservedExt3",
|
||||
"HashIdxDir",
|
||||
"NoMergeTail",
|
||||
"DirTop",
|
||||
"Extents",
|
||||
"NoCOWFile",
|
||||
"DAX",
|
||||
"CaseInsensitive",
|
||||
"ReservedExt4c",
|
||||
"UseParentProjId",
|
||||
"VerityProtected",
|
||||
"NoCompress",
|
||||
}
|
||||
)
|
||||
@ -1,9 +1,8 @@
|
||||
//go:build linux
|
||||
|
||||
package fsutils
|
||||
|
||||
/*
|
||||
https://github.com/torvalds/linux/blob/master/include/uapi/linux/fs.h "Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)"
|
||||
Up to date as of Linux 6.12-rc7.
|
||||
*/
|
||||
// https://github.com/torvalds/linux/blob/master/include/uapi/linux/fs.h "Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)"
|
||||
const (
|
||||
SecureDelete fsAttr = 1 << iota // Secure deletion
|
||||
UnDelete // Undelete
|
||||
@ -1,11 +0,0 @@
|
||||
package fsutils
|
||||
|
||||
import (
|
||||
`syscall`
|
||||
)
|
||||
|
||||
var (
|
||||
// Yes, I know. "Why ENOTTY?" I don't know, ask Linus.
|
||||
// If you see "inappropriate ioctl for device", it's this'un.
|
||||
ErrFsAttrsUnsupported error = syscall.ENOTTY
|
||||
)
|
||||
@ -1,16 +0,0 @@
|
||||
package fsutils
|
||||
|
||||
// invertMap returns some handy consts remapping for easier lookups.
|
||||
func invertMap(origMap map[string]fsAttr) (newMap map[fsAttr]string) {
|
||||
|
||||
if origMap == nil {
|
||||
return
|
||||
}
|
||||
newMap = make(map[fsAttr]string)
|
||||
|
||||
for k, v := range origMap {
|
||||
newMap[v] = k
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
@ -1,96 +0,0 @@
|
||||
package fsutils
|
||||
|
||||
import (
|
||||
`reflect`
|
||||
`strings`
|
||||
)
|
||||
|
||||
/*
|
||||
String returns a string representation (comparable to lsattr(1)) of an FsAttrs.
|
||||
|
||||
Not all flags are represented, as this aims for compatibility with e2fsprogs/lsattr output.
|
||||
*/
|
||||
func (f *FsAttrs) String() (s string) {
|
||||
|
||||
// Flags have their short name printed if set, otherwise a '-' placeholder is used.
|
||||
// https://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git/tree/lib/e2p/pf.c
|
||||
|
||||
var refType reflect.Type
|
||||
var refVal reflect.Value
|
||||
var refField reflect.StructField
|
||||
var fieldVal reflect.Value
|
||||
var tagVal string
|
||||
var sb strings.Builder
|
||||
|
||||
if f == nil {
|
||||
s = strings.Repeat("-", len(linuxFsAttrsListOrder))
|
||||
return
|
||||
}
|
||||
|
||||
refVal = reflect.ValueOf(*f)
|
||||
refType = refVal.Type()
|
||||
for _, fn := range linuxFsAttrsListOrder {
|
||||
refField, _ = refType.FieldByName(fn)
|
||||
tagVal = refField.Tag.Get("fsAttrShort")
|
||||
if tagVal == "" || tagVal == "-" {
|
||||
continue
|
||||
}
|
||||
fieldVal = refVal.FieldByName(fn)
|
||||
if fieldVal.Bool() {
|
||||
sb.WriteString(tagVal)
|
||||
} else {
|
||||
sb.WriteString("-")
|
||||
}
|
||||
}
|
||||
|
||||
s = sb.String()
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
/*
|
||||
StringLong returns a more extensive/"human-friendly" representation (comparable to lsattr(1) wiih -l) of an Fsattrs.
|
||||
|
||||
Not all flags are represented, as this aims for compatibility with e2fsprogs/lsattr output.
|
||||
*/
|
||||
func (f *FsAttrs) StringLong() (s string) {
|
||||
|
||||
// The long names are separated via a commma then a space.
|
||||
// If no attrs are set, the string "---" is used.
|
||||
// https://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git/tree/lib/e2p/pf.c
|
||||
|
||||
var refType reflect.Type
|
||||
var refVal reflect.Value
|
||||
var refField reflect.StructField
|
||||
var fieldVal reflect.Value
|
||||
var tagVal string
|
||||
var out []string
|
||||
|
||||
if f == nil {
|
||||
s = strings.Repeat("-", 3)
|
||||
return
|
||||
}
|
||||
|
||||
refVal = reflect.ValueOf(*f)
|
||||
refType = refVal.Type()
|
||||
for _, fn := range linuxFsAttrsListOrder {
|
||||
refField, _ = refType.FieldByName(fn)
|
||||
tagVal = refField.Tag.Get("fsAttrLong")
|
||||
if tagVal == "" || tagVal == "-" {
|
||||
continue
|
||||
}
|
||||
fieldVal = refVal.FieldByName(fn)
|
||||
if fieldVal.Bool() {
|
||||
out = append(out, tagVal)
|
||||
}
|
||||
}
|
||||
|
||||
if out == nil || len(out) == 0 {
|
||||
s = strings.Repeat("-", 3)
|
||||
return
|
||||
}
|
||||
|
||||
s = strings.Join(out, ", ")
|
||||
|
||||
return
|
||||
}
|
||||
@ -15,14 +15,12 @@ func (f *FsAttrs) Apply(path string) (err error) {
|
||||
var reflectVal reflect.Value
|
||||
var fieldVal reflect.Value
|
||||
|
||||
if f == nil {
|
||||
return
|
||||
}
|
||||
var myPath string = path
|
||||
|
||||
if err = paths.RealPath(&path); err != nil {
|
||||
if err = paths.RealPath(&myPath); err != nil {
|
||||
return
|
||||
}
|
||||
if file, err = os.Open(path); err != nil {
|
||||
if file, err = os.Open(myPath); err != nil {
|
||||
return
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
@ -73,6 +73,21 @@ func getAttrs(f *os.File) (attrVal fsAttr, err error) {
|
||||
return
|
||||
}
|
||||
|
||||
// invertMap returns some handy consts remapping for easier lookups.
|
||||
func invertMap(origMap map[string]fsAttr) (newMap map[fsAttr]string) {
|
||||
|
||||
if origMap == nil {
|
||||
return
|
||||
}
|
||||
newMap = make(map[fsAttr]string)
|
||||
|
||||
for k, v := range origMap {
|
||||
newMap[v] = k
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// setAttrs is the unexported low-level syscall to set attributes. attrs may be OR'd.
|
||||
func setAttrs(f *os.File, attrs fsAttr) (err error) {
|
||||
|
||||
|
||||
@ -6,39 +6,36 @@ import (
|
||||
|
||||
type fsAttr bitmask.MaskBit
|
||||
|
||||
/*
|
||||
FsAttrs is a struct representation of filesystem attributes on Linux.
|
||||
Up to date as of Linux 6.12-rc7.
|
||||
*/
|
||||
// FsAttrs is a struct representation of filesystem attributes on Linux.
|
||||
type FsAttrs struct {
|
||||
SecureDelete bool `fsAttrShort:"s" fsAttrLong:"Secure_Deletion" fsAttrKern:"FS_SECRM_FL" json:"secure_delete" toml:"SecureDelete" yaml:"Secure Delete" xml:"secureDelete,attr"`
|
||||
UnDelete bool `fsAttrShort:"u" fsAttrLong:"Undelete" fsAttrKern:"FS_UNRM_FL" json:"undelete" toml:"Undelete" yaml:"Undelete" xml:"undelete,attr"`
|
||||
CompressFile bool `fsAttrShort:"c" fsAttrLong:"Compression_Requested" fsAttrKern:"FS_COMPR_FL" json:"compress" toml:"Compress" yaml:"Compress" xml:"compress,attr"`
|
||||
SyncUpdate bool `fsAttrShort:"S" fsAttrLong:"Synchronous_Updates" fsAttrKern:"FS_SYNC_FL" json:"sync" toml:"SyncUpdate" yaml:"Synchronized Update" xml:"syncUpdate,attr"`
|
||||
Immutable bool `fsAttrShort:"i" fsAttrLong:"Immutable" fsAttrKern:"FS_IMMUTABLE_FL" json:"immutable" toml:"Immutable" yaml:"Immutable" xml:"immutable,attr"`
|
||||
AppendOnly bool `fsAttrShort:"a" fsAttrLong:"Append_Only" fsAttrKern:"FS_APPEND_FL" json:"append_only" toml:"AppendOnly" yaml:"Append Only" xml:"appendOnly,attr"`
|
||||
NoDumpFile bool `fsAttrShort:"d" fsAttrLong:"No_Dump" fsAttrKern:"FS_NODUMP_FL" json:"no_dump" toml:"NoDump" yaml:"Disable Dumping" xml:"noDump,attr"`
|
||||
NoUpdateAtime bool `fsAttrShort:"A" fsAttrLong:"No_Atime" fsAttrKern:"FS_NOATIME_FL" json:"no_atime" toml:"DisableAtime" yaml:"Disable Atime Updating" xml:"noAtime,attr"`
|
||||
IsDirty bool `fsAttrShort:"-" fsAttrLong:"-" fsAttrKern:"FS_DIRTY_FL" json:"dirty" toml:"Dirty" yaml:"Dirty" xml:"dirty,attr"`
|
||||
CompressedClusters bool `fsAttrShort:"-" fsAttrLong:"-" fsAttrKern:"FS_COMPRBLK_FL" json:"compress_clst" toml:"CompressedClusters" yaml:"Compressed Clusters" xml:"compressClst,attr"`
|
||||
NoCompress bool `fsAttrShort:"m" fsAttrLong:"Dont_Compress" fsAttrKern:"FS_NOCOMP_FL" json:"no_compress" toml:"DisableCompression" yaml:"Disable Compression" xml:"noCompress,attr"`
|
||||
EncFile bool `fsAttrShort:"E" fsAttrLong:"Encrypted" fsAttrKern:"FS_ENCRYPT_FL" json:"enc" toml:"Encrypted" yaml:"Encrypted" xml:"enc,attr"`
|
||||
BtreeFmt bool `fsAttrShort:"-" fsAttrLong:"-" fsAttrKern:"FS_BTREE_FL" json:"btree" toml:"Btree" yaml:"Btree" xml:"btree,attr"`
|
||||
HashIdxDir bool `fsAttrShort:"I" fsAttrLong:"Indexed_directory" fsAttrKern:"FS_INDEX_FL" json:"idx_dir" toml:"IdxDir" yaml:"Indexed Directory" xml:"idxDir,attr"`
|
||||
AfsDir bool `fsAttrShort:"-" fsAttrLong:"-" fsAttrKern:"FS_IMAGIC_FL" json:"afs" toml:"AFS" yaml:"AFS" xml:"afs,attr"`
|
||||
ReservedExt3 bool `fsAttrShort:"j" fsAttrLong:"Journaled_Data" fsAttrKern:"FS_JOURNAL_DATA_FL" json:"res_ext3" toml:"ReservedExt3" yaml:"Reserved Ext3" xml:"resExt3,attr"`
|
||||
NoMergeTail bool `fsAttrShort:"t" fsAttrLong:"No_Tailmerging" fsAttrKern:"FS_NOTAIL_FL" json:"no_merge_tail" toml:"DisableTailmerging" yaml:"Disable Tailmerging" xml:"noMergeTail,attr"`
|
||||
DirSync bool `fsAttrShort:"D" fsAttrLong:"Synchronous_Directory_Updates" fsAttrKern:"FS_DIRSYNC_FL" json:"dir_sync" toml:"DirSync" yaml:"Synchronized Directory Updates" xml:"dirSync,attr"`
|
||||
DirTop bool `fsAttrShort:"T" fsAttrLong:"Top_of_Directory_Hierarchies" fsAttrKern:"FS_TOPDIR_FL" json:"dir_top" toml:"DirTop" yaml:"Top of Directory Hierarchies" xml:"dirTop,attr"`
|
||||
ReservedExt4a bool `fsAttrShort:"-" fsAttrLong:"-" fsAttrKern:"FS_HUGE_FILE_FL" json:"res_ext4a" toml:"ReservedExt4A" yaml:"Reserved Ext4 A" xml:"resExt4a,attr"`
|
||||
Extents bool `fsAttrShort:"e" fsAttrLong:"Extents" fsAttrKern:"FS_EXTENT_FL" json:"extents" toml:"Extents" yaml:"Extents" xml:"extents,attr"`
|
||||
VerityProtected bool `fsAttrShort:"V" fsAttrLong:"Verity" fsAttrKern:"FS_VERITY_FL" json:"verity" toml:"Verity" yaml:"Verity Protected" xml:"verity,attr"`
|
||||
LargeEaInode bool `fsAttrShort:"-" fsAttrLong:"-" fsAttrKern:"FS_EA_INODE_FL" json:"ea" toml:"EAInode" yaml:"EA Inode" xml:"ea,attr"`
|
||||
ReservedExt4b bool `fsAttrShort:"-" fsAttrLong:"-" fsAttrKern:"FS_EOFBLOCKS_FL" json:"res_ext4b" toml:"ReservedExt4B" yaml:"Reserved Ext4 B" xml:"resExt4b,attr"`
|
||||
NoCOWFile bool `fsAttrShort:"C" fsAttrLong:"No_COW" fsAttrKern:"FS_NOCOW_FL" json:"no_cow" toml:"NoCOW" yaml:"Disable COW" xml:"noCOW,attr"`
|
||||
DAX bool `fsAttrShort:"x" fsAttrLong:"DAX" fsAttrKern:"FS_DAX_FL" json:"dax" toml:"DAX" yaml:"DAX" xml:"DAX,attr"`
|
||||
ReservedExt4c bool `fsAttrShort:"N" fsAttrLong:"Inline_Data" fsAttrKern:"FS_INLINE_DATA_FL" json:"res_ext4c" toml:"ReservedExt4C" yaml:"Reserved Ext4 C" xml:"resExt4c,attr"`
|
||||
UseParentProjId bool `fsAttrShort:"P" fsAttrLong:"Project_Hierarchy" fsAttrKern:"FS_PROJINHERIT_FL" json:"parent_proj_id" toml:"ParentProjId" yaml:"Use Parent Project ID" xml:"parentProjId,attr"`
|
||||
CaseInsensitive bool `fsAttrShort:"F" fsAttrLong:"Casefold" fsAttrKern:"FS_CASEFOLD_FL" json:"case_ins" toml:"CaseInsensitive" yaml:"Case Insensitive" xml:"caseIns,attr"`
|
||||
ReservedExt2 bool `fsAttrShort:"-" fsAttrLong:"-" fsAttrKern:"FS_RESERVED_FL" json:"res_ext2" toml:"ReservedExt2" yaml:"Reserved Ext2" xml:"resExt2,attr"`
|
||||
SecureDelete bool
|
||||
UnDelete bool
|
||||
CompressFile bool
|
||||
SyncUpdate bool
|
||||
Immutable bool
|
||||
AppendOnly bool
|
||||
NoDumpFile bool
|
||||
NoUpdateAtime bool
|
||||
IsDirty bool
|
||||
CompressedClusters bool
|
||||
NoCompress bool
|
||||
EncFile bool
|
||||
BtreeFmt bool
|
||||
HashIdxDir bool
|
||||
AfsDir bool
|
||||
ReservedExt3 bool
|
||||
NoMergeTail bool
|
||||
DirSync bool
|
||||
DirTop bool
|
||||
ReservedExt4a bool
|
||||
Extents bool
|
||||
VerityProtected bool
|
||||
LargeEaInode bool
|
||||
ReservedExt4b bool
|
||||
NoCOWFile bool
|
||||
DAX bool
|
||||
ReservedExt4c bool
|
||||
UseParentProjId bool
|
||||
CaseInsensitive bool
|
||||
ReservedExt2 bool
|
||||
}
|
||||
|
||||
1
go.mod
1
go.mod
@ -6,7 +6,6 @@ require (
|
||||
github.com/davecgh/go-spew v1.1.1
|
||||
github.com/djherbis/times v1.6.0
|
||||
github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
|
||||
golang.org/x/sync v0.9.0
|
||||
golang.org/x/sys v0.26.0
|
||||
honnef.co/go/augeas v0.0.0-20161110001225-ca62e35ed6b8
|
||||
r00t2.io/goutils v1.7.1
|
||||
|
||||
2
go.sum
2
go.sum
@ -6,8 +6,6 @@ github.com/djherbis/times v1.6.0/go.mod h1:gOHeRAz2h+VJNZ5Gmc/o7iD9k4wW7NMVqieYC
|
||||
github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=
|
||||
github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
|
||||
github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
golang.org/x/sync v0.9.0 h1:fEo0HyrW1GIgZdpbhCRO0PkJajUS5H9IFUztCgEo2jQ=
|
||||
golang.org/x/sync v0.9.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20220615213510-4f61da869c0c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
|
||||
|
||||
@ -1,31 +1,20 @@
|
||||
package paths
|
||||
|
||||
import (
|
||||
"io/fs"
|
||||
`io/fs`
|
||||
)
|
||||
|
||||
// Mostly just for reference.
|
||||
const (
|
||||
// ModeDir | ModeSymlink | ModeNamedPipe | ModeSocket | ModeDevice | ModeCharDevice | ModeIrregular
|
||||
modeDir pathMode = pathMode(fs.ModeDir)
|
||||
modeSymlink pathMode = pathMode(fs.ModeSymlink)
|
||||
modePipe pathMode = pathMode(fs.ModeNamedPipe)
|
||||
modeSocket pathMode = pathMode(fs.ModeSocket)
|
||||
modeDev pathMode = pathMode(fs.ModeDevice)
|
||||
modeCharDev pathMode = pathMode(fs.ModeCharDevice)
|
||||
modeIrregular pathMode = pathMode(fs.ModeIrregular)
|
||||
modeAnyExceptRegular pathMode = modeDir | modeSymlink | modePipe | modeSocket | modeDev | modeCharDev | modeIrregular
|
||||
)
|
||||
|
||||
// Miss reasons
|
||||
const (
|
||||
MissNoMiss missReason = ""
|
||||
MissNoMeta missReason = "Could not determine metadata"
|
||||
MissBadBase missReason = "Base name does not match BasePtrn"
|
||||
MissBadPath missReason = "Path does not match PathPtrn"
|
||||
MissBadTime missReason = "Time(s) does not/do not match Age"
|
||||
MissFile missReason = "Object is a file and NoFiles is set"
|
||||
MissType missReason = "Object does not match TargetType"
|
||||
modeDir pathMode = pathMode(fs.ModeDir)
|
||||
modeSymlink pathMode = pathMode(fs.ModeSymlink)
|
||||
modePipe pathMode = pathMode(fs.ModeNamedPipe)
|
||||
modeSocket pathMode = pathMode(fs.ModeSocket)
|
||||
modeDev pathMode = pathMode(fs.ModeDevice)
|
||||
modeCharDev pathMode = pathMode(fs.ModeCharDevice)
|
||||
modeIrregular pathMode = pathMode(fs.ModeIrregular)
|
||||
modeAny pathMode = modeDir | modeSymlink | modePipe | modeSocket | modeDev | modeCharDev | modeIrregular
|
||||
)
|
||||
|
||||
// Times
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
package paths
|
||||
|
||||
import (
|
||||
`errors`
|
||||
)
|
||||
|
||||
var (
|
||||
ErrNilErrChan error = errors.New("an initialized error channel is required")
|
||||
ErrNilMatchChan error = errors.New("an initialized matches channel is required")
|
||||
ErrNilMismatchChan error = errors.New("an initialized mismatches channel is required")
|
||||
ErrNilWg error = errors.New("a non-nil sync.WaitGroup is required")
|
||||
)
|
||||
237
paths/funcs.go
237
paths/funcs.go
@ -19,16 +19,15 @@
|
||||
package paths
|
||||
|
||||
import (
|
||||
`context`
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"os"
|
||||
"os/user"
|
||||
"path/filepath"
|
||||
`sort`
|
||||
`regexp`
|
||||
`slices`
|
||||
"strings"
|
||||
`sync`
|
||||
`time`
|
||||
|
||||
// "syscall"
|
||||
@ -275,162 +274,108 @@ func RealPathExistsStat(path *string) (exists bool, stat os.FileInfo, err error)
|
||||
return
|
||||
}
|
||||
|
||||
// SearchFsPaths gets a file/directory/etc. path list based on the provided criteria.
|
||||
func SearchFsPaths(matcher FsSearchCriteria) (found, miss []*FsSearchResult, err error) {
|
||||
/*
|
||||
SearchPaths gets a file/directory path list based on the provided criteria.
|
||||
|
||||
var matched *FsSearchResult
|
||||
var missed *FsSearchResult
|
||||
targetType defines what should be included in the path list.
|
||||
It can consist of one or more (io/)fs.FileMode types OR'd together
|
||||
(ensure they are part of (io/)fs.ModeType).
|
||||
(You can use 0 as a shortcut to match anything/all paths.
|
||||
You can also use (io/)fs.ModeType itself to match anything/all paths.)
|
||||
|
||||
if err = RealPath(&matcher.Root); err != nil {
|
||||
basePtrn may be nil; if it isn't, it will be applied to *base names*
|
||||
(that is, quux.txt rather than /foo/bar/baz/quux.txt).
|
||||
|
||||
pathPtrn is like ptrn except it applies to the *entire* path,
|
||||
not just the basename, if not nil (e.g. /foo/bar/baz/quux.txt,
|
||||
not just quux.txt).
|
||||
|
||||
If age is not nil, it will be applied to the path object.
|
||||
It will match older files/directories/etc. if olderThan is true,
|
||||
otherwise it will match newer files/directories/etc.
|
||||
(olderThan is not used otherwise.)
|
||||
|
||||
ageType is one or more Time* constants OR'd together to describe which timestamp type to check.
|
||||
(Note that TimeCreated may not match if specified as it is only available on certain OSes,
|
||||
kernel versions, and filesystems. This would lead to files being excluded that may have otherwise
|
||||
been included.)
|
||||
(You can use TimeAny to specify any supported time.)
|
||||
*Any* matching timestamp of all specified (and supported) timestamp types matches,
|
||||
so be judicious with your selection.
|
||||
|
||||
olderThan (as mentioned above) will find paths *older* than age if true, otherwise *newer*.
|
||||
*/
|
||||
func SearchFsPaths(
|
||||
root string,
|
||||
targetType fs.FileMode,
|
||||
basePtrn, pathPtrn *regexp.Regexp,
|
||||
age *time.Duration, ageType pathTimeType, olderThan bool,
|
||||
) (foundPaths []string, err error) {
|
||||
|
||||
var now time.Time = time.Now()
|
||||
|
||||
if err = RealPath(&root); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if err = filepath.WalkDir(
|
||||
matcher.Root,
|
||||
root,
|
||||
func(path string, d fs.DirEntry, inErr error) (outErr error) {
|
||||
|
||||
var typeMode fs.FileMode
|
||||
var fi fs.FileInfo
|
||||
var tspec times.Timespec
|
||||
var typeFilter *bitmask.MaskBit = bitmask.NewMaskBitExplicit(uint(targetType))
|
||||
|
||||
if inErr != nil {
|
||||
outErr = inErr
|
||||
return
|
||||
}
|
||||
|
||||
if matched, missed, outErr = matcher.Match(path, d, nil); outErr != nil {
|
||||
return
|
||||
// patterns
|
||||
if pathPtrn != nil {
|
||||
if !pathPtrn.MatchString(path) {
|
||||
return
|
||||
}
|
||||
}
|
||||
if matched != nil && !matcher.NoMatch {
|
||||
found = append(found, matched)
|
||||
if basePtrn != nil {
|
||||
if !basePtrn.MatchString(filepath.Base(path)) {
|
||||
return
|
||||
}
|
||||
}
|
||||
if missed != nil && !matcher.NoMismatch {
|
||||
miss = append(miss, missed)
|
||||
|
||||
// age
|
||||
if age != nil {
|
||||
if tspec, outErr = times.Stat(path); outErr != nil {
|
||||
return
|
||||
}
|
||||
if !filterTimes(tspec, age, &ageType, olderThan, &now) {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// fs object type (file, dir, etc.)
|
||||
if targetType != 0 && uint(targetType) != uint(modeAny) {
|
||||
if fi, outErr = d.Info(); outErr != nil {
|
||||
return
|
||||
}
|
||||
typeMode = fi.Mode().Type()
|
||||
if !typeFilter.HasFlag(bitmask.MaskBit(typeMode)) {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// All filters passed at this point.
|
||||
foundPaths = append(foundPaths, path)
|
||||
|
||||
return
|
||||
},
|
||||
); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if found == nil || len(found) == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
// And sort them.
|
||||
sort.Slice(
|
||||
found,
|
||||
func(i, j int) (isLess bool) {
|
||||
isLess = found[i].Path < found[j].Path
|
||||
return
|
||||
},
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
/*
|
||||
SearchFsPathsAsync is exactly like SearchFsPaths, but dispatches off concurrent
|
||||
workers for the filtering logic instead of performing iteratively/recursively.
|
||||
It may, in some cases, be *slightly more* performant and *slightly less* in others.
|
||||
Note that unlike SearchFsPaths, the results written to the
|
||||
FsSearchCriteriaAsync.ResChan are not guaranteed to be in any predictable order.
|
||||
|
||||
All channels are expected to have already been initialized by the caller.
|
||||
They will not be closed by this function.
|
||||
*/
|
||||
func SearchFsPathsAsync(matcher FsSearchCriteriaAsync) {
|
||||
|
||||
var err error
|
||||
var wgLocal sync.WaitGroup
|
||||
var doneChan chan bool = make(chan bool, 1)
|
||||
|
||||
if matcher.ErrChan == nil {
|
||||
panic(ErrNilErrChan)
|
||||
return
|
||||
}
|
||||
|
||||
if matcher.WG == nil {
|
||||
matcher.ErrChan <- ErrNilWg
|
||||
return
|
||||
}
|
||||
|
||||
defer matcher.WG.Done()
|
||||
|
||||
if matcher.ResChan == nil && !matcher.NoMatch {
|
||||
matcher.ErrChan <- ErrNilMatchChan
|
||||
return
|
||||
}
|
||||
if matcher.MismatchChan == nil && !matcher.NoMismatch {
|
||||
matcher.ErrChan <- ErrNilMismatchChan
|
||||
return
|
||||
}
|
||||
|
||||
if err = RealPath(&matcher.Root); err != nil {
|
||||
matcher.ErrChan <- err
|
||||
return
|
||||
}
|
||||
|
||||
if matcher.Semaphore != nil && matcher.SemaphoreCtx == nil {
|
||||
matcher.SemaphoreCtx = context.Background()
|
||||
}
|
||||
|
||||
if err = filepath.WalkDir(
|
||||
matcher.Root,
|
||||
func(path string, de fs.DirEntry, inErr error) (outErr error) {
|
||||
|
||||
if inErr != nil {
|
||||
inErr = filterNoFileDir(inErr)
|
||||
if inErr != nil {
|
||||
outErr = inErr
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
wgLocal.Add(1)
|
||||
if matcher.Semaphore != nil {
|
||||
if err = matcher.Semaphore.Acquire(matcher.SemaphoreCtx, 1); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
go func(p string, d fs.DirEntry) {
|
||||
var pErr error
|
||||
var pResMatch *FsSearchResult
|
||||
var pResMiss *FsSearchResult
|
||||
|
||||
defer wgLocal.Done()
|
||||
|
||||
if matcher.Semaphore != nil {
|
||||
defer matcher.Semaphore.Release(1)
|
||||
}
|
||||
|
||||
if pResMatch, pResMiss, pErr = matcher.Match(p, d, nil); pErr != nil {
|
||||
matcher.ErrChan <- pErr
|
||||
return
|
||||
}
|
||||
|
||||
if pResMatch != nil && !matcher.NoMatch {
|
||||
matcher.ResChan <- pResMatch
|
||||
}
|
||||
if pResMiss != nil && !matcher.NoMismatch {
|
||||
matcher.MismatchChan <- pResMiss
|
||||
}
|
||||
}(path, de)
|
||||
|
||||
return
|
||||
},
|
||||
); err != nil {
|
||||
err = filterNoFileDir(err)
|
||||
if err != nil {
|
||||
matcher.ErrChan <- err
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
go func() {
|
||||
wgLocal.Wait()
|
||||
doneChan <- true
|
||||
}()
|
||||
|
||||
<-doneChan
|
||||
slices.Sort(foundPaths)
|
||||
|
||||
return
|
||||
}
|
||||
@ -466,9 +411,9 @@ func filterTimes(tspec times.Timespec, age *time.Duration, ageType *pathTimeType
|
||||
*now = time.Now()
|
||||
}
|
||||
|
||||
// BTIME (if supported)
|
||||
if tspec.HasBirthTime() && (mask.HasFlag(bitmask.MaskBit(TimeAny)) || mask.HasFlag(bitmask.MaskBit(TimeCreated))) {
|
||||
curAge = now.Sub(tspec.BirthTime())
|
||||
// ATIME
|
||||
if mask.HasFlag(bitmask.MaskBit(TimeAny)) || mask.HasFlag(bitmask.MaskBit(TimeAccessed)) {
|
||||
curAge = now.Sub(tspec.AccessTime())
|
||||
if include = tfunc(&curAge); include {
|
||||
return
|
||||
}
|
||||
@ -487,9 +432,9 @@ func filterTimes(tspec times.Timespec, age *time.Duration, ageType *pathTimeType
|
||||
return
|
||||
}
|
||||
}
|
||||
// ATIME
|
||||
if mask.HasFlag(bitmask.MaskBit(TimeAny)) || mask.HasFlag(bitmask.MaskBit(TimeAccessed)) {
|
||||
curAge = now.Sub(tspec.AccessTime())
|
||||
// BTIME (if supported)
|
||||
if tspec.HasBirthTime() && (mask.HasFlag(bitmask.MaskBit(TimeAny)) || mask.HasFlag(bitmask.MaskBit(TimeCreated))) {
|
||||
curAge = now.Sub(tspec.BirthTime())
|
||||
if include = tfunc(&curAge); include {
|
||||
return
|
||||
}
|
||||
@ -497,13 +442,3 @@ func filterTimes(tspec times.Timespec, age *time.Duration, ageType *pathTimeType
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func filterNoFileDir(err error) (filtered error) {
|
||||
|
||||
filtered = err
|
||||
if errors.Is(err, fs.ErrNotExist) {
|
||||
filtered = nil
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@ -1,125 +0,0 @@
|
||||
package paths
|
||||
|
||||
import (
|
||||
`io/fs`
|
||||
`os`
|
||||
`path/filepath`
|
||||
`time`
|
||||
|
||||
`github.com/djherbis/times`
|
||||
`r00t2.io/goutils/bitmask`
|
||||
)
|
||||
|
||||
/*
|
||||
Match returns match (a ptr to a FsSearchResult if the specified path matches, otherwise nil),
|
||||
miss (ptr the specified path does not match, otherwise nil), and an fs.DirEntry and fs.FileInfo
|
||||
for path. d and/or fi may be nil.
|
||||
|
||||
If err is not nil, it represents an unexpected error and as such, both match and miss should be nil.
|
||||
|
||||
Match, miss, and err will all be nil if the filesystem object/path does not exist.
|
||||
*/
|
||||
func (f *FsSearchCriteria) Match(path string, d fs.DirEntry, fi fs.FileInfo) (match, miss *FsSearchResult, err error) {
|
||||
|
||||
var typeMode fs.FileMode
|
||||
var m FsSearchResult
|
||||
var typeFilter *bitmask.MaskBit = bitmask.NewMaskBitExplicit(uint(f.TargetType))
|
||||
|
||||
m = FsSearchResult{
|
||||
Path: path,
|
||||
DirEntry: d,
|
||||
FileInfo: fi,
|
||||
Criteria: f,
|
||||
}
|
||||
|
||||
if f == nil {
|
||||
return
|
||||
}
|
||||
|
||||
// A DirEntry can be created from a FileInfo but not vice versa.
|
||||
if m.FileInfo == nil {
|
||||
if m.DirEntry != nil {
|
||||
if m.FileInfo, err = m.DirEntry.Info(); err != nil {
|
||||
err = filterNoFileDir(err)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if f.FollowSymlinks {
|
||||
if m.FileInfo, err = os.Stat(path); err != nil {
|
||||
err = filterNoFileDir(err)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if m.FileInfo, err = os.Lstat(path); err != nil {
|
||||
err = filterNoFileDir(err)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
m.DirEntry = fs.FileInfoToDirEntry(m.FileInfo)
|
||||
}
|
||||
}
|
||||
if m.DirEntry == nil {
|
||||
m.DirEntry = fs.FileInfoToDirEntry(m.FileInfo)
|
||||
}
|
||||
if m.DirEntry == nil || m.FileInfo == nil {
|
||||
m.MissReason = MissNoMeta
|
||||
miss = &m
|
||||
return
|
||||
}
|
||||
|
||||
if m.Times, err = times.Stat(path); err != nil {
|
||||
err = filterNoFileDir(err)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if f.PathPtrn != nil && !f.PathPtrn.MatchString(path) {
|
||||
m.MissReason = MissBadPath
|
||||
miss = &m
|
||||
return
|
||||
}
|
||||
if f.BasePtrn != nil && !f.BasePtrn.MatchString(filepath.Base(path)) {
|
||||
m.MissReason = MissBadBase
|
||||
miss = &m
|
||||
return
|
||||
}
|
||||
|
||||
// age
|
||||
if f.Age != nil {
|
||||
if f.Now == nil {
|
||||
f.Now = new(time.Time)
|
||||
*f.Now = time.Now()
|
||||
}
|
||||
if !filterTimes(m.Times, f.Age, &f.AgeType, f.OlderThan, f.Now) {
|
||||
m.MissReason = MissBadTime
|
||||
miss = &m
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// fs object type (file, dir, etc.)
|
||||
typeMode = m.FileInfo.Mode().Type()
|
||||
if typeMode == 0 && f.NoFiles {
|
||||
m.MissReason = MissFile
|
||||
miss = &m
|
||||
return
|
||||
} else if typeMode != 0 {
|
||||
if !typeFilter.HasFlag(bitmask.MaskBit(typeMode)) {
|
||||
m.MissReason = MissType
|
||||
miss = &m
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// If it gets to here, it matches.
|
||||
match = &m
|
||||
|
||||
return
|
||||
}
|
||||
127
paths/types.go
127
paths/types.go
@ -1,136 +1,9 @@
|
||||
package paths
|
||||
|
||||
import (
|
||||
`context`
|
||||
`io/fs`
|
||||
`regexp`
|
||||
`sync`
|
||||
`time`
|
||||
|
||||
`github.com/djherbis/times`
|
||||
`golang.org/x/sync/semaphore`
|
||||
`r00t2.io/goutils/bitmask`
|
||||
)
|
||||
|
||||
// FsSearchCriteria contains filter criteria for SearchFsPaths* functions.
|
||||
type FsSearchCriteria struct {
|
||||
// Root indicates the root to search.
|
||||
Root string `json:"root" toml:"RootPath" yaml:"Root Path" xml:"root,attr" validate:"dir"`
|
||||
// NoMatch, if true, will not return matches. If NoMatch and NoMismatch are both true, no results will be returned.
|
||||
NoMatch bool `json:"no_match" toml:"NoMatch" yaml:"No Matches" xml:"noMatch,attr"`
|
||||
// NoMismatch, if true, will not return mismatches. If NoMatch and NoMismatch are both true, no results will be returned.
|
||||
NoMismatch bool `json:"no_miss" toml:"NoMismatch" yaml:"No Mismatches" xml:"noMiss,attr"`
|
||||
/*
|
||||
TargetType defines what types of filesystem objects should be matched.
|
||||
It can consist of one or more (io/)fs.FileMode types OR'd together
|
||||
(ensure they are part of (io/)fs.ModeType).
|
||||
(You can use 0 to match regular files explicitly, and/or NoFiles = true to exclude them.)
|
||||
*/
|
||||
TargetType fs.FileMode `json:"type_tgt" toml:"TargetType" yaml:"Target Type" xml:"typeTgt,attr"`
|
||||
// NoFiles excludes files from TargetType-matching (as there isn't a way to explicitly exclude files otherwise if a non-zero mode is given).
|
||||
NoFiles bool `json:"no_file" toml:"ExcludeFiles" yaml:"Exclude Files" xml:"noFile,attr"`
|
||||
// FollowSymlinks, if true and a path being tested is a symlink, will use metadata (age, etc.) of the symlink itself rather than the link target.
|
||||
FollowSymlinks bool `json:"follow_sym" toml:"FollowSymlinks" yaml:"Follow Symlinks" xml:"followSym,attr"`
|
||||
// BasePtrn, if specified, will apply to the *base name (that is, quux.txt rather than /foo/bar/baz/quux.txt). See also PathPtrn.
|
||||
BasePtrn *regexp.Regexp `json:"ptrn_base,omitempty" toml:"BaseNamePattern,omitempty" yaml:"Base Name Pattern,omitempty" xml:"ptrnBase,attr,omitempty"`
|
||||
// PathPtrn, if specified, will apply to the *full path* (e.g. /foo/bar/baz/quux.txt, not just quux.txt). See also BasePtrn.
|
||||
PathPtrn *regexp.Regexp `json:"ptrn_path,omitempty" toml:"PathPattern,omitempty" yaml:"Path Pattern,omitempty" xml:"ptrnPath,attr,omitempty"`
|
||||
/*
|
||||
Age, if specified, indicates the comparison of Now againt the AgeType of filesystem objects.
|
||||
Use OlderThan to indicate if it should be older or newer.
|
||||
*/
|
||||
Age *time.Duration `json:"age,omitempty" toml:"Age,omitempty" yaml:"Age,omitempty" xml:"age,attr,omitempty"`
|
||||
/*
|
||||
AgeType can be one (or more, OR'd together) of the Time* constants in this package (TimeAny, TimeAccessed, TimeCreated,
|
||||
TimeChanged, TimeModified) to indicate what timestamp(s) to use for comparing Age.
|
||||
|
||||
The zero-value is TimeAny.
|
||||
|
||||
The first matching timestamp will pass all time comparisons.
|
||||
Be mindful of timestamp type support/limitations per OS/filesystem of Root.
|
||||
|
||||
Completely unused if Age is nil.
|
||||
*/
|
||||
AgeType pathTimeType `json:"type_age" toml:"AgeType" yaml:"Age Type" xml:"typeAge,attr"`
|
||||
/*
|
||||
OlderThan, if true (and Age is not nil), indicates that matching filesystem objects should have their
|
||||
AgeType older than Now. If false, their AgeType should be *newer* than Now.
|
||||
|
||||
Completely unused if Age is nil.
|
||||
*/
|
||||
OlderThan bool `json:"older" toml:"OlderThan" yaml:"Older Than" xml:"older,attr"`
|
||||
/*
|
||||
Now expresses a time to compare to Age via AgeType and OlderThan.
|
||||
Note that it may be any valid time, not necessarily "now".
|
||||
If Age is specified but Now is nil, it will be populated with time.Now() when the search is invoked.
|
||||
|
||||
Completely unused if Age is nil.
|
||||
*/
|
||||
Now *time.Time `json:"now,omitempty" toml:"Now,omitempty" yaml:"Now,omitempty" xml:"now,attr,omitempty"`
|
||||
}
|
||||
|
||||
// FsSearchCriteriaAsync extends FsSearchCriteria for use in an asynchronous (goroutine) manner.
|
||||
type FsSearchCriteriaAsync struct {
|
||||
FsSearchCriteria
|
||||
/*
|
||||
WG should be a non-nil pointer to a sync.WaitGroup.
|
||||
This is used to manage searching completion to the caller.
|
||||
|
||||
.Done() will be called once within the search function, but no .Add() will be called;
|
||||
.Add() should be done by the caller beforehand.
|
||||
*/
|
||||
WG *sync.WaitGroup
|
||||
// ResChan must be a non-nil channel for (positive) match results to be sent to.
|
||||
ResChan chan *FsSearchResult
|
||||
// MismatchChan, if not nil, will have negative matches/"misses" sent to it.
|
||||
MismatchChan chan *FsSearchResult
|
||||
/*
|
||||
ErrChan should be a non-nil error channel for any unexpected errors encountered.
|
||||
|
||||
If nil, a panic will be raised.
|
||||
*/
|
||||
ErrChan chan error
|
||||
/*
|
||||
Semaphore is completely optional, but if non-nil
|
||||
it will be used to limit concurrent filesystem
|
||||
object processing.
|
||||
|
||||
It is generally a Very Good Idea(TM) to use this,
|
||||
as the default is to dispatch all processing concurrently.
|
||||
This can lead to some heavy I/O and CPU wait.
|
||||
|
||||
(See https://pkg.go.dev/golang.org/x/sync/semaphore for details.)
|
||||
*/
|
||||
Semaphore *semaphore.Weighted
|
||||
/*
|
||||
SemaphoreCtx is the context.Context to use for Semaphore.
|
||||
If nil (but Sempaphore is not), one will be created locally/internally.
|
||||
*/
|
||||
SemaphoreCtx context.Context
|
||||
}
|
||||
|
||||
// FsSearchResult contains a match/miss result for FsSearchCriteria and FsSearchCriteriaAsync.
|
||||
type FsSearchResult struct {
|
||||
/*
|
||||
Path is the path to the object on the filesystem.
|
||||
It may or may not exist at the time of return,
|
||||
but will not be an empty string.
|
||||
*/
|
||||
Path string `json:"path" toml:"Path" yaml:"Path" xml:"path,attr"`
|
||||
// DirEntry is the fs.DirEntry for the Path; note that .Name() is the base name only. TODO: serialization?
|
||||
DirEntry fs.DirEntry `json:"-" toml:"-" yaml:"-" xml:"-"`
|
||||
// FileInfo is the fs.FileInfo for the Path; note that .Name() is the base name only. TODO: serialization?
|
||||
FileInfo fs.FileInfo `json:"-" toml:"-" yaml:"-" xml:"-"`
|
||||
// Criteria is the evaluated criteria specified that this FsSearchResult matched.
|
||||
Criteria *FsSearchCriteria `json:"criteria" toml:"Criteria" yaml:"Criteria" xml:"criteria"`
|
||||
// Times holds the mtime, ctime, etc. of the filesystem object (where supported). TODO: serialization?
|
||||
Times times.Timespec `json:"-" toml:"-" yaml:"-" xml:"-"`
|
||||
// MissReason contains the reason the result is a miss (MissNoMiss if a match); see the Miss* constants.
|
||||
MissReason missReason `json:"miss_reason" toml:"MissReason" yaml:"Miss Reason" xml:"miss,attr"`
|
||||
}
|
||||
|
||||
type missReason string
|
||||
|
||||
type pathMode bitmask.MaskBit
|
||||
|
||||
type pathTimeType bitmask.MaskBit
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user