Compare commits
No commits in common. "master" and "v1.8.0" have entirely different histories.
3
.gitignore
vendored
3
.gitignore
vendored
@ -29,9 +29,6 @@
|
||||
# Test binary, built with `go test -c`
|
||||
*.test
|
||||
|
||||
# Test file
|
||||
fsutils/testfile
|
||||
|
||||
# Output of the go coverage tool, specifically when used with LiteIDE
|
||||
*.out
|
||||
|
||||
|
||||
@ -1 +0,0 @@
|
||||
This module is still under work.
|
||||
@ -7,35 +7,3 @@ const (
|
||||
augInclTfm string = "incl" // The transformer keyword for Augeas includes.
|
||||
augAppendSuffix string = "[last()+1]"
|
||||
)
|
||||
|
||||
var (
|
||||
dstPtrTrue bool = true
|
||||
dstPtrFalse bool = false
|
||||
)
|
||||
|
||||
var (
|
||||
// PtrTrue and PtrFalse are convenience references for constructing an AugFlags if needed. It is recommended you do not change these values if you do not like being confused.
|
||||
PtrTrue *bool = &dstPtrTrue
|
||||
PtrFalse *bool = &dstPtrFalse
|
||||
)
|
||||
|
||||
/*
|
||||
IncludeOptNone is the default include recursion option for Aug.RecursiveInclude.
|
||||
* No special behavior is defined
|
||||
* All include directives are assumed to refer:
|
||||
* Explicitly/exclusively to file paths
|
||||
* That must exist
|
||||
*/
|
||||
const IncludeOptNone includeOpt = 0
|
||||
const (
|
||||
// IncludeOptNoExist specifies that inclusions are allowed to not exist, otherwise an error will be raised while attempting to parse them.
|
||||
IncludeOptNoExist includeOpt = 1 << iota
|
||||
// IncludeOptGlobbing indicates that the inclusion system supports globbing (as supported by (github.com/gobwas/glob).Match).
|
||||
IncludeOptGlobbing
|
||||
// IncludeOptRegex indicates that the inclusion system supports matching by regex (as supported by regexp).
|
||||
IncludeOptRegex
|
||||
// IncludeOptDirs indicates that the inclusion system supports matching by directory.
|
||||
IncludeOptDirs
|
||||
// IncludeOptDirsRecursive indicates that the inclusion system also recurses into subdirectories of matched directories. Only used if IncludeOptDirs is also set.
|
||||
IncludeOptDirsRecursive
|
||||
)
|
||||
|
||||
@ -4,55 +4,15 @@ import (
|
||||
`io/fs`
|
||||
`os`
|
||||
`strings`
|
||||
|
||||
`honnef.co/go/augeas`
|
||||
`r00t2.io/goutils/bitmask`
|
||||
)
|
||||
|
||||
/*
|
||||
NewAuger returns an auger.Aug.
|
||||
|
||||
See:
|
||||
https://pkg.go.dev/honnef.co/go/augeas#readme-examples
|
||||
https://pkg.go.dev/honnef.co/go/augeas#New
|
||||
for the `root` and `loadPath` parameters
|
||||
(and, by extension, the `flags` paraemter; note that the `flags`
|
||||
is an auger.AugFlags, not an augeas.Flag!).
|
||||
|
||||
`flags` may be nil.
|
||||
*/
|
||||
func NewAuger(root, loadPath string, flags *AugFlags) (aug *Aug, err error) {
|
||||
|
||||
aug = new(Aug)
|
||||
|
||||
if aug.aug, err = augeas.New(root, loadPath, flags.Eval()); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// NewAugerFromAugeas returns a wrapped auger.Aug from a (honnef.co/go/augeas).Augeas.
|
||||
func NewAugerFromAugeas(orig augeas.Augeas) (aug *Aug) {
|
||||
|
||||
aug = new(Aug)
|
||||
aug.aug = orig
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
/*
|
||||
AugpathToFspath returns the filesystem path (i.e. an existing file) from an Augeas path.
|
||||
AugpathToFspath returns the filesystem path from an Augeas path.
|
||||
|
||||
It is *required* and expected that the Augeas standard /files prefix be removed first;
|
||||
if not, it is assumed to be part of the filesystem path.
|
||||
|
||||
If a valid path cannot be determined, fsPath will be empty.
|
||||
|
||||
To be clear, a file must exist for fsPath to not be empty;
|
||||
the way AugpathToFsPath works is it recurses bottom-up a
|
||||
given path and checks for the existence of a file,
|
||||
continuing upwards if not found.
|
||||
*/
|
||||
func AugpathToFspath(augPath string) (fsPath string, err error) {
|
||||
|
||||
@ -101,11 +61,3 @@ func dedupePaths(new, existing []string) (missing []string) {
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// getInclPaths applies path options to inclusions.
|
||||
func getInclPaths(pathSpec string, inclFlags *bitmask.MaskBit) (fpaths []string, err error) {
|
||||
|
||||
// TODO
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@ -12,7 +12,6 @@ import (
|
||||
`github.com/davecgh/go-spew/spew`
|
||||
`github.com/google/shlex`
|
||||
`honnef.co/go/augeas`
|
||||
`r00t2.io/goutils/bitmask`
|
||||
`r00t2.io/sysutils/paths`
|
||||
)
|
||||
|
||||
@ -147,21 +146,10 @@ breakCmd:
|
||||
An error will be returned if augLens is a nonexistent or not-loaded Augeas lens module.
|
||||
|
||||
Depending on how many files there are and whether globs vs. explicit filepaths are included, this may take a while.
|
||||
|
||||
optFlags may be nil, multiple includeOpt (see the IncludeOpt* constants) as variadic parameters/expanded slice,
|
||||
bitwise-OR'd together, or multiple non-OR'd and OR'd together (all will be combined to a single value).
|
||||
*/
|
||||
func (a *Aug) RecursiveInclude(augLens, includeDirective, fsRoot string, optFlags ...includeOpt) (err error) {
|
||||
func (a *Aug) RecursiveInclude(augLens, includeDirective, fsRoot string) (err error) {
|
||||
|
||||
var flags *bitmask.MaskBit = bitmask.NewMaskBit()
|
||||
|
||||
if optFlags != nil && len(optFlags) > 0 {
|
||||
for _, f := range optFlags {
|
||||
flags.AddFlag(f.toMb())
|
||||
}
|
||||
}
|
||||
|
||||
if err = a.addIncl(includeDirective, augLens, fsRoot, nil, flags); err != nil {
|
||||
if err = a.addIncl(includeDirective, augLens, fsRoot, nil); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
@ -176,16 +164,14 @@ func (a *Aug) RecursiveInclude(augLens, includeDirective, fsRoot string, optFlag
|
||||
newInclPaths are new filesystem paths/Augeas-compatible glob patterns to load into the filetree and recurse into.
|
||||
They may be nil, especially if the first run.
|
||||
*/
|
||||
func (a *Aug) addIncl(includeDirective, augLens string, fsRoot string, newInclPaths []string, inclFlags *bitmask.MaskBit) (err error) {
|
||||
func (a *Aug) addIncl(includeDirective, augLens string, fsRoot string, newInclPaths []string) (err error) {
|
||||
|
||||
var matches []string // Passed around set of Augeas matches.
|
||||
var exists bool // Used to indicate if the include path exists.
|
||||
var includes []string // Filepath(s)/glob(s) from fetching includeDirective in lensInclPath. These are internal to the application but are recursed.
|
||||
var lensInclPath string // The path of the included paths in the tree. These are internal to Augeas, not the application.
|
||||
var appendPath string // The path for new Augeas includes.
|
||||
var match []string // A placeholder for iterating when populating includes.
|
||||
var fpath string // A placeholder for finding the path of a conf file that contains an includeDirective.
|
||||
var normalizedIncludes []string // A temporary slice to hold normalization operations and other dynamic building.
|
||||
var lensPath string = fmt.Sprintf(augLensTpl, augLens) // The path of the lens (augLens) itself.
|
||||
var augErr *augeas.Error = new(augeas.Error) // We use this to skip "nonexistent" lens.
|
||||
|
||||
@ -207,7 +193,7 @@ func (a *Aug) addIncl(includeDirective, augLens string, fsRoot string, newInclPa
|
||||
|
||||
// First canonize paths.
|
||||
if newInclPaths != nil && len(newInclPaths) > 0 {
|
||||
// Existing includes. We don't return on an empty lensInclPath.
|
||||
// Existing includes. We don't return on an empty lensInclPath because
|
||||
if matches, err = a.aug.Match(lensInclPath); err != nil {
|
||||
if errors.As(err, augErr) && augErr.Code == augeas.NoMatch {
|
||||
err = nil
|
||||
@ -235,17 +221,6 @@ func (a *Aug) addIncl(includeDirective, augLens string, fsRoot string, newInclPa
|
||||
// We don't want to bother adding multiple incl's for the same path(s); it can negatively affect Augeas loads.
|
||||
newInclPaths = dedupePaths(newInclPaths, matches)
|
||||
|
||||
// And then apply things like recursion, globbing, etc.
|
||||
normalizedIncludes = make([]string, 0, len(newInclPaths))
|
||||
if inclFlags.HasFlag(IncludeOptGlobbing.toMb()) {
|
||||
// TODO
|
||||
/*
|
||||
if strings.Contains(newInclPaths[idx], "*") {
|
||||
|
||||
}
|
||||
*/
|
||||
}
|
||||
|
||||
// Add the new path(s) as Augeas include entries.
|
||||
if newInclPaths != nil {
|
||||
for _, fsPath := range newInclPaths {
|
||||
@ -310,13 +285,10 @@ func (a *Aug) addIncl(includeDirective, augLens string, fsRoot string, newInclPa
|
||||
}
|
||||
|
||||
if matches != nil && len(matches) != 0 {
|
||||
if err = a.addIncl(includeDirective, augLens, fsRoot, matches, inclFlags); err != nil {
|
||||
if err = a.addIncl(includeDirective, augLens, fsRoot, matches); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// TODO
|
||||
_, _ = exists, normalizedIncludes
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@ -7,10 +7,6 @@ import (
|
||||
// Eval returns an evaluated set of flags.
|
||||
func (a *AugFlags) Eval() (augFlags augeas.Flag) {
|
||||
|
||||
if a == nil {
|
||||
return
|
||||
}
|
||||
|
||||
augFlags = augeas.None
|
||||
|
||||
if a.Backup != nil && *a.Backup {
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
package auger
|
||||
|
||||
import (
|
||||
`r00t2.io/goutils/bitmask`
|
||||
)
|
||||
|
||||
// toMb returns a bitmask.MaskBit of this includeOpt.
|
||||
func (i includeOpt) toMb() (mb bitmask.MaskBit) {
|
||||
|
||||
mb = bitmask.MaskBit(i)
|
||||
|
||||
return
|
||||
}
|
||||
@ -1,39 +0,0 @@
|
||||
package auger
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
`honnef.co/go/augeas`
|
||||
)
|
||||
|
||||
func TestNewAuger(t *testing.T) {
|
||||
|
||||
var aug *Aug
|
||||
var augUnder augeas.Augeas
|
||||
var err error
|
||||
|
||||
if aug, err = NewAuger("/", "", nil); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
augUnder = aug.aug
|
||||
|
||||
aug = NewAugerFromAugeas(augUnder)
|
||||
|
||||
_ = aug
|
||||
}
|
||||
|
||||
func TestRecursiveInclude(t *testing.T) {
|
||||
|
||||
var aug *Aug
|
||||
var err error
|
||||
|
||||
if aug, err = NewAuger("/", "", &AugFlags{DryRun: PtrTrue}); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// This requires Nginx to be installed and with a particularly complex nested include system.
|
||||
if err = aug.RecursiveInclude("Nginx", "include", "/etc/nginx"); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
@ -2,11 +2,8 @@ package auger
|
||||
|
||||
import (
|
||||
`honnef.co/go/augeas`
|
||||
`r00t2.io/goutils/bitmask`
|
||||
)
|
||||
|
||||
type includeOpt bitmask.MaskBit
|
||||
|
||||
// Aug is a wrapper around (honnef.co/go/)augeas.Augeas. Remember to call Aug.Close().
|
||||
type Aug struct {
|
||||
aug augeas.Augeas
|
||||
|
||||
@ -3,4 +3,3 @@
|
||||
|
||||
It is now its own module: r00t2.io/cryptparse
|
||||
*/
|
||||
package cryptparse
|
||||
|
||||
@ -159,7 +159,7 @@ func GetPidEnvMap(pid uint32) (envMap map[string]string, err error) {
|
||||
var procPath string
|
||||
var exists bool
|
||||
|
||||
envMap = make(map[string]string)
|
||||
envMap = make(map[string]string, 0)
|
||||
|
||||
procPath = fmt.Sprintf("/proc/%v/environ", pid)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ func envListToMap(envs []string) (envMap map[string]string) {
|
||||
var kv []string
|
||||
var k, v string
|
||||
|
||||
envMap = make(map[string]string)
|
||||
envMap = make(map[string]string, 0)
|
||||
|
||||
for _, ev := range envs {
|
||||
kv = strings.SplitN(ev, "=", 2)
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
- XATTRS
|
||||
(see FS_XFLAG_* in fs.h, FS_IOC_FSGETXATTR/FS_IOC_FSSETXATTR)
|
||||
- fs label, UUID? (fs.h)
|
||||
@ -1,36 +1,101 @@
|
||||
package fsutils
|
||||
|
||||
import (
|
||||
`github.com/g0rbe/go-chattr`
|
||||
)
|
||||
|
||||
// https://github.com/torvalds/linux/blob/master/include/uapi/linux/fs.h
|
||||
const (
|
||||
SecureDelete uint32 = chattr.FS_SECRM_FL // Secure deletion
|
||||
UnDelete = chattr.FS_UNRM_FL // Undelete
|
||||
CompressFile = chattr.FS_COMPR_FL // Compress file
|
||||
SyncUpdatechattr = chattr.FS_SYNC_FL // Synchronous updates
|
||||
Immutable = chattr.FS_IMMUTABLE_FL // Immutable file
|
||||
AppendOnly = chattr.FS_APPEND_FL // Writes to file may only append
|
||||
NoDumpFile = chattr.FS_NODUMP_FL // Do not dump file
|
||||
NoUpdateAtime = chattr.FS_NOATIME_FL // Do not update atime
|
||||
IsDirty = chattr.FS_DIRTY_FL // Nobody knows what this does, lol.
|
||||
CompressedClusters = chattr.FS_COMPRBLK_FL // One or more compressed clusters
|
||||
NoCompress = chattr.FS_NOCOMP_FL // Don't compress
|
||||
EncFile = chattr.FS_ENCRYPT_FL // Encrypted file
|
||||
BtreeFmt = chattr.FS_BTREE_FL // Btree format dir
|
||||
HashIdxDir = chattr.FS_INDEX_FL // Hash-indexed directory
|
||||
AfsDir = chattr.FS_IMAGIC_FL // AFS directory
|
||||
ReservedExt3 = chattr.FS_JOURNAL_DATA_FL // Reserved for ext3
|
||||
NoMergeTail = chattr.FS_NOTAIL_FL // File tail should not be merged
|
||||
DirSync = chattr.FS_DIRSYNC_FL // dirsync behaviour (directories only)
|
||||
DirTop = chattr.FS_TOPDIR_FL // Top of directory hierarchies
|
||||
ReservedExt4a = chattr.FS_HUGE_FILE_FL // Reserved for ext4
|
||||
Extents = chattr.FS_EXTENT_FL // Extents
|
||||
LargeEaInode = chattr.FS_EA_INODE_FL // Inode used for large EA
|
||||
ReservedExt4b = chattr.FS_EOFBLOCKS_FL // Reserved for ext4
|
||||
NoCOWFile = chattr.FS_NOCOW_FL // Do not cow file
|
||||
ReservedExt4c = chattr.FS_INLINE_DATA_FL // Reserved for ext4
|
||||
UseParentProjId = chattr.FS_PROJINHERIT_FL // Create with parents projid
|
||||
ReservedExt2 = chattr.FS_RESERVED_FL // Reserved for ext2 lib
|
||||
)
|
||||
|
||||
var (
|
||||
// AttrNameValueMap contains a mapping of attribute names (as designated by this package) to their flag values.
|
||||
AttrNameValueMap map[string]uint32 = map[string]uint32{
|
||||
"SecureDelete": SecureDelete,
|
||||
"UnDelete": UnDelete,
|
||||
"CompressFile": CompressFile,
|
||||
"SyncUpdatechattr": SyncUpdatechattr,
|
||||
"Immutable": Immutable,
|
||||
"AppendOnly": AppendOnly,
|
||||
"NoDumpFile": NoDumpFile,
|
||||
"NoUpdateAtime": NoUpdateAtime,
|
||||
"IsDirty": IsDirty,
|
||||
"CompressedClusters": CompressedClusters,
|
||||
"NoCompress": NoCompress,
|
||||
"EncFile": EncFile,
|
||||
"BtreeFmt": BtreeFmt,
|
||||
"HashIdxDir": HashIdxDir,
|
||||
"AfsDir": AfsDir,
|
||||
"ReservedExt3": ReservedExt3,
|
||||
"NoMergeTail": NoMergeTail,
|
||||
"DirSync": DirSync,
|
||||
"DirTop": DirTop,
|
||||
"ReservedExt4a": ReservedExt4a,
|
||||
"Extents": Extents,
|
||||
"LargeEaInode": LargeEaInode,
|
||||
"ReservedExt4b": ReservedExt4b,
|
||||
"NoCOWFile": NoCOWFile,
|
||||
"ReservedExt4c": ReservedExt4c,
|
||||
"UseParentProjId": UseParentProjId,
|
||||
"ReservedExt2": ReservedExt2,
|
||||
}
|
||||
/*
|
||||
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.
|
||||
AttrValueNameMap contains a mapping of attribute flags to their names (as designated by this package).
|
||||
Note the oddball here, BtreeFmt and HashIdxDir are actually the same value, so be forewarned.
|
||||
*/
|
||||
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",
|
||||
AttrValueNameMap map[uint32]string = map[uint32]string{
|
||||
SecureDelete: "SecureDelete",
|
||||
UnDelete: "UnDelete",
|
||||
CompressFile: "CompressFile",
|
||||
SyncUpdatechattr: "SyncUpdatechattr",
|
||||
Immutable: "Immutable",
|
||||
AppendOnly: "AppendOnly",
|
||||
NoDumpFile: "NoDumpFile",
|
||||
NoUpdateAtime: "NoUpdateAtime",
|
||||
IsDirty: "IsDirty",
|
||||
CompressedClusters: "CompressedClusters",
|
||||
NoCompress: "NoCompress",
|
||||
EncFile: "EncFile",
|
||||
BtreeFmt: "BtreeFmt|HashIdxDir", // Well THIS is silly and seems like an oversight. Both FS_BTREE_FL and FS_INDEX_FL have the same flag. Confirmed in kernel source.
|
||||
AfsDir: "AfsDir",
|
||||
ReservedExt3: "ReservedExt3",
|
||||
NoMergeTail: "NoMergeTail",
|
||||
DirSync: "DirSync",
|
||||
DirTop: "DirTop",
|
||||
ReservedExt4a: "ReservedExt4a",
|
||||
Extents: "Extents",
|
||||
LargeEaInode: "LargeEaInode",
|
||||
ReservedExt4b: "ReservedExt4b",
|
||||
NoCOWFile: "NoCOWFile",
|
||||
ReservedExt4c: "ReservedExt4c",
|
||||
UseParentProjId: "UseParentProjId",
|
||||
ReservedExt2: "ReservedExt2",
|
||||
}
|
||||
)
|
||||
|
||||
@ -1,127 +0,0 @@
|
||||
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.
|
||||
*/
|
||||
const (
|
||||
SecureDelete fsAttr = 1 << iota // Secure deletion
|
||||
UnDelete // Undelete
|
||||
CompressFile // Compress file
|
||||
SyncUpdate // Synchronous updates
|
||||
Immutable // Immutable file
|
||||
AppendOnly // Writes to file may only append
|
||||
NoDumpFile // Do not dump file
|
||||
NoUpdateAtime // Do not update atime
|
||||
IsDirty // Nobody knows what this does, lol.
|
||||
CompressedClusters // One or more compressed clusters
|
||||
NoCompress // Don't compress
|
||||
EncFile // Encrypted file
|
||||
BtreeFmt // Btree format dir
|
||||
AfsDir // AFS directory
|
||||
ReservedExt3 // Reserved for ext3
|
||||
NoMergeTail // File tail should not be merged
|
||||
DirSync // dirsync behaviour (directories only)
|
||||
DirTop // Top of directory hierarchies
|
||||
ReservedExt4a // Reserved for ext4
|
||||
Extents // Extents
|
||||
VerityProtected // Verity-protected inode
|
||||
LargeEaInode // Inode used for large EA
|
||||
ReservedExt4b // Reserved for ext4
|
||||
NoCOWFile // Do not cow file
|
||||
_ // (Unused)
|
||||
DAX // Inode is DAX
|
||||
_ // (Unused)
|
||||
_ // (Unused)
|
||||
ReservedExt4c // Reserved for ext4
|
||||
UseParentProjId // Create with parents projid
|
||||
CaseInsensitive // Folder is case-insensitive
|
||||
ReservedExt2 // Reserved for ext2 lib
|
||||
)
|
||||
|
||||
// These are the same value. For some reason.
|
||||
const (
|
||||
HashIdxDir fsAttr = BtreeFmt // Hash-indexed directory
|
||||
)
|
||||
|
||||
var (
|
||||
// AttrNameValueMap contains a mapping of attribute names (as designated by this package) to their flag values.
|
||||
AttrNameValueMap map[string]fsAttr = map[string]fsAttr{
|
||||
"SecureDelete": SecureDelete,
|
||||
"UnDelete": UnDelete,
|
||||
"CompressFile": CompressFile,
|
||||
"SyncUpdate": SyncUpdate,
|
||||
"Immutable": Immutable,
|
||||
"AppendOnly": AppendOnly,
|
||||
"NoDumpFile": NoDumpFile,
|
||||
"NoUpdateAtime": NoUpdateAtime,
|
||||
"IsDirty": IsDirty,
|
||||
"CompressedClusters": CompressedClusters,
|
||||
"NoCompress": NoCompress,
|
||||
"EncFile": EncFile,
|
||||
"BtreeFmt": BtreeFmt,
|
||||
"HashIdxDir": HashIdxDir,
|
||||
"AfsDir": AfsDir,
|
||||
"ReservedExt3": ReservedExt3,
|
||||
"NoMergeTail": NoMergeTail,
|
||||
"DirSync": DirSync,
|
||||
"DirTop": DirTop,
|
||||
"ReservedExt4a": ReservedExt4a,
|
||||
"Extents": Extents,
|
||||
"VerityProtected": VerityProtected,
|
||||
"LargeEaInode": LargeEaInode,
|
||||
"ReservedExt4b": ReservedExt4b,
|
||||
"NoCOWFile": NoCOWFile,
|
||||
"DAX": DAX,
|
||||
"ReservedExt4c": ReservedExt4c,
|
||||
"UseParentProjId": UseParentProjId,
|
||||
"CaseInsensitive": CaseInsensitive,
|
||||
"ReservedExt2": ReservedExt2,
|
||||
}
|
||||
|
||||
/*
|
||||
AttrValueNameMap contains a mapping of attribute flags to their names (as designated by this package).
|
||||
Note the oddball here, BtreeFmt and HashIdxDir are actually the same value, so their string value is unpredictable.
|
||||
*/
|
||||
AttrValueNameMap map[fsAttr]string = invertMap(AttrNameValueMap)
|
||||
|
||||
// KernelNameValueMap allows lookups using the symbol name as used in the Linux kernel source.
|
||||
KernelNameValueMap map[string]fsAttr = map[string]fsAttr{
|
||||
"FS_SECRM_FL": SecureDelete,
|
||||
"FS_UNRM_FL": UnDelete,
|
||||
"FS_COMPR_FL": CompressFile,
|
||||
"FS_SYNC_FL": SyncUpdate,
|
||||
"FS_IMMUTABLE_FL": Immutable,
|
||||
"FS_APPEND_FL": AppendOnly,
|
||||
"FS_NODUMP_FL": NoDumpFile,
|
||||
"FS_NOATIME_FL": NoUpdateAtime,
|
||||
"FS_DIRTY_FL": IsDirty,
|
||||
"FS_COMPRBLK_FL": CompressedClusters,
|
||||
"FS_NOCOMP_FL": NoCompress,
|
||||
"FS_ENCRYPT_FL": EncFile,
|
||||
"FS_BTREE_FL": BtreeFmt,
|
||||
"FS_INDEX_FL": HashIdxDir,
|
||||
"FS_IMAGIC_FL": AfsDir,
|
||||
"FS_JOURNAL_DATA_FL": ReservedExt3,
|
||||
"FS_NOTAIL_FL": NoMergeTail,
|
||||
"FS_DIRSYNC_FL": DirSync,
|
||||
"FS_TOPDIR_FL": DirTop,
|
||||
"FS_HUGE_FILE_FL": ReservedExt4a,
|
||||
"FS_EXTENT_FL": Extents,
|
||||
"FS_VERITY_FL": VerityProtected,
|
||||
"FS_EA_INODE_FL": LargeEaInode,
|
||||
"FS_EOFBLOCKS_FL": ReservedExt4b,
|
||||
"FS_NOCOW_FL": NoCOWFile,
|
||||
"FS_DAX_FL": DAX,
|
||||
"FS_INLINE_DATA_FL": ReservedExt4c,
|
||||
"FS_PROJINHERIT_FL": UseParentProjId,
|
||||
"FS_CASEFOLD_FL": CaseInsensitive,
|
||||
"FS_RESERVED_FL": ReservedExt2,
|
||||
}
|
||||
|
||||
/*
|
||||
KernelValueNameMap contains a mapping of attribute flags to their kernel source symbol name.
|
||||
Note the oddball here, BtreeFmt and HashIdxDir are actually the same value, so their string value is unpredictable.
|
||||
*/
|
||||
KernelValueNameMap map[fsAttr]string = invertMap(KernelNameValueMap)
|
||||
)
|
||||
@ -1,7 +0,0 @@
|
||||
/*
|
||||
fsutils is a collection of filesystem-related functions, types, etc.
|
||||
|
||||
Currently it's only a (fixed/actually working) reimplementation of github.com/g0rbe/go-chattr.
|
||||
(Note to library maintainers, if someone reports an integer overflow and even tells you how to fix it, you should probably fix it.)
|
||||
*/
|
||||
package fsutils
|
||||
@ -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 +1,44 @@
|
||||
package fsutils
|
||||
|
||||
// invertMap returns some handy consts remapping for easier lookups.
|
||||
func invertMap(origMap map[string]fsAttr) (newMap map[fsAttr]string) {
|
||||
import (
|
||||
`os`
|
||||
`reflect`
|
||||
|
||||
if origMap == nil {
|
||||
`github.com/g0rbe/go-chattr`
|
||||
`r00t2.io/sysutils/paths`
|
||||
)
|
||||
|
||||
func GetAttrs(path string) (attrs *FsAttrs, err error) {
|
||||
|
||||
var f *os.File
|
||||
var evalAttrs FsAttrs
|
||||
var attrVal uint32
|
||||
var reflectVal reflect.Value
|
||||
var field reflect.Value
|
||||
var myPath string = path
|
||||
|
||||
if err = paths.RealPath(&myPath); err != nil {
|
||||
return
|
||||
}
|
||||
newMap = make(map[fsAttr]string)
|
||||
|
||||
for k, v := range origMap {
|
||||
newMap[v] = k
|
||||
if f, err = os.Open(myPath); err != nil {
|
||||
return
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
reflectVal = reflect.ValueOf(&evalAttrs).Elem()
|
||||
|
||||
if attrVal, err = chattr.GetAttrs(f); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
for attrNm, attrInt := range AttrNameValueMap {
|
||||
field = reflectVal.FieldByName(attrNm)
|
||||
field.SetBool((attrVal & attrInt) != 0)
|
||||
}
|
||||
|
||||
attrs = new(FsAttrs)
|
||||
*attrs = evalAttrs
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@ -1,96 +1,43 @@
|
||||
package fsutils
|
||||
|
||||
import (
|
||||
`os`
|
||||
`reflect`
|
||||
`strings`
|
||||
|
||||
`github.com/g0rbe/go-chattr`
|
||||
`r00t2.io/sysutils/paths`
|
||||
)
|
||||
|
||||
/*
|
||||
String returns a string representation (comparable to lsattr(1)) of an FsAttrs.
|
||||
func (f *FsAttrs) Apply(path string) (err error) {
|
||||
|
||||
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 file *os.File
|
||||
var reflectVal reflect.Value
|
||||
var fieldVal reflect.Value
|
||||
var tagVal string
|
||||
var sb strings.Builder
|
||||
|
||||
if f == nil {
|
||||
s = strings.Repeat("-", len(linuxFsAttrsListOrder))
|
||||
var myPath string = path
|
||||
|
||||
if err = paths.RealPath(&myPath); err != nil {
|
||||
return
|
||||
}
|
||||
if file, err = os.Open(myPath); err != nil {
|
||||
return
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
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)
|
||||
reflectVal = reflect.ValueOf(*f)
|
||||
|
||||
for attrNm, attrVal := range AttrNameValueMap {
|
||||
fieldVal = reflectVal.FieldByName(attrNm)
|
||||
if fieldVal.Bool() {
|
||||
sb.WriteString(tagVal)
|
||||
if err = chattr.SetAttr(file, attrVal); err != nil {
|
||||
return
|
||||
}
|
||||
} else {
|
||||
sb.WriteString("-")
|
||||
if err = chattr.UnsetAttr(file, attrVal); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
@ -1,46 +0,0 @@
|
||||
//go:build linux
|
||||
|
||||
package fsutils
|
||||
|
||||
import (
|
||||
`os`
|
||||
`reflect`
|
||||
|
||||
`r00t2.io/sysutils/paths`
|
||||
)
|
||||
|
||||
func (f *FsAttrs) Apply(path string) (err error) {
|
||||
|
||||
var file *os.File
|
||||
var reflectVal reflect.Value
|
||||
var fieldVal reflect.Value
|
||||
|
||||
if f == nil {
|
||||
return
|
||||
}
|
||||
|
||||
if err = paths.RealPath(&path); err != nil {
|
||||
return
|
||||
}
|
||||
if file, err = os.Open(path); err != nil {
|
||||
return
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
reflectVal = reflect.ValueOf(*f)
|
||||
|
||||
for attrNm, attrVal := range AttrNameValueMap {
|
||||
fieldVal = reflectVal.FieldByName(attrNm)
|
||||
if fieldVal.Bool() {
|
||||
if err = setAttrs(file, attrVal); err != nil {
|
||||
return
|
||||
}
|
||||
} else {
|
||||
if err = unsetAttrs(file, attrVal); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
@ -1,134 +0,0 @@
|
||||
//go:build linux
|
||||
|
||||
package fsutils
|
||||
|
||||
import (
|
||||
`os`
|
||||
`reflect`
|
||||
`unsafe`
|
||||
|
||||
`golang.org/x/sys/unix`
|
||||
`r00t2.io/goutils/bitmask`
|
||||
`r00t2.io/sysutils/paths`
|
||||
)
|
||||
|
||||
func GetAttrs(path string) (attrs *FsAttrs, err error) {
|
||||
|
||||
var f *os.File
|
||||
var evalAttrs FsAttrs
|
||||
var attrVal fsAttr
|
||||
var attrValBit bitmask.MaskBit
|
||||
var reflectVal reflect.Value
|
||||
var field reflect.Value
|
||||
var myPath string = path
|
||||
|
||||
if err = paths.RealPath(&myPath); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if f, err = os.Open(myPath); err != nil {
|
||||
return
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
reflectVal = reflect.ValueOf(&evalAttrs).Elem()
|
||||
|
||||
if attrVal, err = getAttrs(f); err != nil {
|
||||
return
|
||||
}
|
||||
attrValBit = bitmask.MaskBit(attrVal)
|
||||
|
||||
for attrNm, attrInt := range AttrNameValueMap {
|
||||
field = reflectVal.FieldByName(attrNm)
|
||||
field.SetBool(attrValBit.HasFlag(bitmask.MaskBit(attrInt)))
|
||||
}
|
||||
|
||||
attrs = new(FsAttrs)
|
||||
*attrs = evalAttrs
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// getAttrs is the unexported low-level syscall to get attributes.
|
||||
func getAttrs(f *os.File) (attrVal fsAttr, err error) {
|
||||
|
||||
var u uint
|
||||
var curFlags int
|
||||
// var errNo syscall.Errno
|
||||
|
||||
/*
|
||||
if _, _, errNo = unix.Syscall(unix.SYS_IOCTL, f.Fd(), unix.FS_IOC_GETFLAGS, uintptr(unsafe.Pointer(&curFlags))); errNo != 0 {
|
||||
err = os.NewSyscallError("ioctl: FS_IOC_GETFLAGS", errNo)
|
||||
return
|
||||
}
|
||||
*/
|
||||
if curFlags, err = unix.IoctlGetInt(int(f.Fd()), unix.FS_IOC_GETFLAGS); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
u = uint(curFlags)
|
||||
|
||||
attrVal = fsAttr(u)
|
||||
|
||||
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) {
|
||||
|
||||
var curAttrs fsAttr
|
||||
var ab bitmask.MaskBit
|
||||
var errNo unix.Errno
|
||||
var val uint
|
||||
|
||||
if curAttrs, err = getAttrs(f); err != nil {
|
||||
return
|
||||
}
|
||||
ab = bitmask.MaskBit(curAttrs)
|
||||
|
||||
if ab.HasFlag(bitmask.MaskBit(attrs)) {
|
||||
return
|
||||
}
|
||||
|
||||
ab.AddFlag(bitmask.MaskBit(attrs))
|
||||
|
||||
val = ab.Value()
|
||||
|
||||
/*
|
||||
if err = unix.IoctlSetInt(int(f.Fd()), unix.FS_IOC_SETFLAGS, int(ab.Value())); err != nil {
|
||||
return
|
||||
}
|
||||
*/
|
||||
if _, _, errNo = unix.Syscall(unix.SYS_IOCTL, f.Fd(), unix.FS_IOC_SETFLAGS, uintptr(unsafe.Pointer(&val))); errNo != 0 {
|
||||
err = os.NewSyscallError("ioctl: SYS_IOCTL", errNo)
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// unsetAttrs is the unexported low-level syscall to remove attributes. attrs may be OR'd.
|
||||
func unsetAttrs(f *os.File, attrs fsAttr) (err error) {
|
||||
|
||||
var curAttrs fsAttr
|
||||
var ab bitmask.MaskBit
|
||||
|
||||
if curAttrs, err = getAttrs(f); err != nil {
|
||||
return
|
||||
}
|
||||
ab = bitmask.MaskBit(curAttrs)
|
||||
|
||||
if !ab.HasFlag(bitmask.MaskBit(attrs)) {
|
||||
return
|
||||
}
|
||||
|
||||
ab.ClearFlag(bitmask.MaskBit(attrs))
|
||||
|
||||
/*
|
||||
if err = unix.IoctlSetInt(int(f.Fd()), unix.FS_IOC_SETFLAGS, int(ab.Value())); err != nil {
|
||||
return
|
||||
}
|
||||
*/
|
||||
|
||||
return
|
||||
}
|
||||
@ -1,5 +1,3 @@
|
||||
//go:build linux
|
||||
|
||||
package fsutils
|
||||
|
||||
import (
|
||||
@ -9,13 +7,12 @@ import (
|
||||
`os/user`
|
||||
`testing`
|
||||
|
||||
`github.com/davecgh/go-spew/spew`
|
||||
`r00t2.io/sysutils/paths`
|
||||
)
|
||||
|
||||
var (
|
||||
testFilename string = "testfile"
|
||||
testErrBadUser error = errors.New("test must be run as root")
|
||||
testErrBadUser error = errors.New("test must be run as root, on Linux")
|
||||
)
|
||||
|
||||
func testChkUser() (err error) {
|
||||
@ -39,18 +36,12 @@ func TestSetAttrs(t *testing.T) {
|
||||
if attrs, err = GetAttrs(testFilename); err != nil {
|
||||
t.Fatalf("Failed to get attrs for %v: %v", testFilename, err)
|
||||
}
|
||||
t.Logf("Attrs for %v (before):\n%s", testFilename, spew.Sdump(attrs))
|
||||
t.Logf("Attrs for %v:\n%#v", testFilename, attrs)
|
||||
attrs.CompressFile = true
|
||||
attrs.SyncUpdate = true
|
||||
attrs.SecureDelete = true
|
||||
if err = attrs.Apply(testFilename); err != nil {
|
||||
t.Fatalf("Failed to apply attrs to %v: %v", testFilename, err)
|
||||
}
|
||||
t.Logf("Applied new attrs to %v:\n%#v", testFilename, attrs)
|
||||
if attrs, err = GetAttrs(testFilename); err != nil {
|
||||
t.Fatalf("Failed to get attrs for %v: %v", testFilename, err)
|
||||
}
|
||||
t.Logf("Attrs for %v (after):\n%s", testFilename, spew.Sdump(attrs))
|
||||
}
|
||||
|
||||
func TestMain(t *testing.M) {
|
||||
@ -1,44 +1,32 @@
|
||||
package fsutils
|
||||
|
||||
import (
|
||||
`r00t2.io/goutils/bitmask`
|
||||
)
|
||||
|
||||
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 convenience struct around github.com/g0rbe/go-chattr.
|
||||
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
|
||||
SyncUpdatechattr 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
|
||||
LargeEaInode bool
|
||||
ReservedExt4b bool
|
||||
NoCOWFile bool
|
||||
ReservedExt4c bool
|
||||
UseParentProjId bool
|
||||
ReservedExt2 bool
|
||||
}
|
||||
|
||||
24
go.mod
24
go.mod
@ -1,13 +1,27 @@
|
||||
module r00t2.io/sysutils
|
||||
module r00t2.io/sysutils/v2
|
||||
|
||||
go 1.23.2
|
||||
|
||||
require (
|
||||
github.com/Luzifer/go-dhparam v1.2.0
|
||||
github.com/davecgh/go-spew v1.1.1
|
||||
github.com/djherbis/times v1.6.0
|
||||
github.com/g0rbe/go-chattr v1.0.1
|
||||
github.com/go-playground/validator/v10 v10.22.0
|
||||
github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
|
||||
golang.org/x/sync v0.9.0
|
||||
golang.org/x/sys v0.26.0
|
||||
golang.org/x/sys v0.19.0
|
||||
honnef.co/go/augeas v0.0.0-20161110001225-ca62e35ed6b8
|
||||
r00t2.io/goutils v1.7.1
|
||||
r00t2.io/goutils v1.6.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/gabriel-vasile/mimetype v1.4.3 // indirect
|
||||
github.com/go-playground/locales v0.14.1 // indirect
|
||||
github.com/go-playground/universal-translator v0.18.1 // indirect
|
||||
github.com/leodido/go-urn v1.4.0 // indirect
|
||||
golang.org/x/crypto v0.19.0 // indirect
|
||||
golang.org/x/net v0.21.0 // indirect
|
||||
golang.org/x/text v0.14.0 // indirect
|
||||
)
|
||||
|
||||
// Pending https://github.com/g0rbe/go-chattr/pull/3
|
||||
replace github.com/g0rbe/go-chattr => github.com/johnnybubonic/go-chattr v0.0.0-20240126141003-459f46177b13
|
||||
|
||||
41
go.sum
41
go.sum
@ -1,19 +1,42 @@
|
||||
github.com/Luzifer/go-dhparam v1.2.0 h1:YwDf15FTsVriTynCv1qF+1Inh6E8Dg1+28tPEA3pvFo=
|
||||
github.com/Luzifer/go-dhparam v1.2.0/go.mod h1:hnazoxBTsXnRvGXAosio70Tb1lWowquyhVdvsXdlIPc=
|
||||
github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/djherbis/times v1.6.0 h1:w2ctJ92J8fBvWPxugmXIv7Nz7Q3iDMKNx9v5ocVH20c=
|
||||
github.com/djherbis/times v1.6.0/go.mod h1:gOHeRAz2h+VJNZ5Gmc/o7iD9k4wW7NMVqieYCY99oc0=
|
||||
github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0=
|
||||
github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk=
|
||||
github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s=
|
||||
github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
|
||||
github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA=
|
||||
github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY=
|
||||
github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY=
|
||||
github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
|
||||
github.com/go-playground/validator/v10 v10.22.0 h1:k6HsTZ0sTnROkhS//R0O+55JgM8C4Bx7ia+JlgcnOao=
|
||||
github.com/go-playground/validator/v10 v10.22.0/go.mod h1:dbuPbCMFw/DrkbEynArYaCwl3amGuJotoKCe95atGMM=
|
||||
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=
|
||||
github.com/johnnybubonic/go-chattr v0.0.0-20240126141003-459f46177b13 h1:tgEbuE4bNVjaCWWIB1u9lDzGqH/ZdBTg33+4vNW2rjg=
|
||||
github.com/johnnybubonic/go-chattr v0.0.0-20240126141003-459f46177b13/go.mod h1:yQc6VPJfpDDC1g+W2t47+yYmzBNioax/GLiyJ25/IOs=
|
||||
github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ=
|
||||
github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
|
||||
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
|
||||
golang.org/x/crypto v0.19.0 h1:ENy+Az/9Y1vSrlrvBSyna3PITt4tiZLf7sgCjZBX7Wo=
|
||||
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
|
||||
golang.org/x/net v0.21.0 h1:AQyQV4dYCvJ7vGmJyKki9+PBdyvhkSd8EIx/qb0AYv4=
|
||||
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
|
||||
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=
|
||||
golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
|
||||
golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
honnef.co/go/augeas v0.0.0-20161110001225-ca62e35ed6b8 h1:FW42yWB1sGClqswyHIB68wo0+oPrav1IuQ+Tdy8Qp8E=
|
||||
honnef.co/go/augeas v0.0.0-20161110001225-ca62e35ed6b8/go.mod h1:44w9OfBSQ9l3o59rc2w3AnABtE44bmtNnRMNC7z+oKE=
|
||||
r00t2.io/goutils v1.7.1 h1:Yzl9rxX1sR9WT0FcjK60qqOgBoFBOGHYKZVtReVLoQc=
|
||||
r00t2.io/goutils v1.7.1/go.mod h1:9ObJI9S71wDLTOahwoOPs19DhZVYrOh4LEHmQ8SW4Lk=
|
||||
r00t2.io/goutils v1.6.0 h1:oBC6PgBv0y/fdHeCmWgORHpBiU8uWw7IfFQJX5rIuzY=
|
||||
r00t2.io/goutils v1.6.0/go.mod h1:9ObJI9S71wDLTOahwoOPs19DhZVYrOh4LEHmQ8SW4Lk=
|
||||
r00t2.io/sysutils v1.1.1/go.mod h1:Wlfi1rrJpoKBOjWiYM9rw2FaiZqraD6VpXyiHgoDo/o=
|
||||
|
||||
@ -1,42 +0,0 @@
|
||||
package paths
|
||||
|
||||
import (
|
||||
"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"
|
||||
)
|
||||
|
||||
// Times
|
||||
const TimeAny pathTimeType = 0
|
||||
const (
|
||||
// TimeAccessed == atime
|
||||
TimeAccessed pathTimeType = 1 << iota
|
||||
// TimeCreated == "birth" time (*NOT* ctime! See TimeChanged)
|
||||
TimeCreated
|
||||
// TimeChanged == ctime
|
||||
TimeChanged
|
||||
// TimeModified == mtime
|
||||
TimeModified
|
||||
)
|
||||
@ -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")
|
||||
)
|
||||
241
paths/funcs.go
241
paths/funcs.go
@ -19,22 +19,14 @@
|
||||
package paths
|
||||
|
||||
import (
|
||||
`context`
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"os"
|
||||
"os/user"
|
||||
"path/filepath"
|
||||
`sort`
|
||||
"strings"
|
||||
`sync`
|
||||
`time`
|
||||
|
||||
// "syscall"
|
||||
|
||||
`github.com/djherbis/times`
|
||||
`r00t2.io/goutils/bitmask`
|
||||
)
|
||||
|
||||
/*
|
||||
@ -274,236 +266,3 @@ 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) {
|
||||
|
||||
var matched *FsSearchResult
|
||||
var missed *FsSearchResult
|
||||
|
||||
if err = RealPath(&matcher.Root); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if err = filepath.WalkDir(
|
||||
matcher.Root,
|
||||
func(path string, d fs.DirEntry, inErr error) (outErr error) {
|
||||
|
||||
if inErr != nil {
|
||||
outErr = inErr
|
||||
return
|
||||
}
|
||||
|
||||
if matched, missed, outErr = matcher.Match(path, d, nil); outErr != nil {
|
||||
return
|
||||
}
|
||||
if matched != nil && !matcher.NoMatch {
|
||||
found = append(found, matched)
|
||||
}
|
||||
if missed != nil && !matcher.NoMismatch {
|
||||
miss = append(miss, missed)
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
/*
|
||||
filterTimes checks a times.Timespec of a file using:
|
||||
* an age specified by the caller
|
||||
* an ageType bitmask for types of times to compare
|
||||
* an olderThan bool (if false, the file must be younger than)
|
||||
* an optional "now" timestamp for the age derivation.
|
||||
*/
|
||||
func filterTimes(tspec times.Timespec, age *time.Duration, ageType *pathTimeType, olderThan bool, now *time.Time) (include bool) {
|
||||
|
||||
var curAge time.Duration
|
||||
var mask *bitmask.MaskBit
|
||||
var tfunc func(t *time.Duration) (match bool) = func(t *time.Duration) (match bool) {
|
||||
if olderThan {
|
||||
match = *t > *age
|
||||
} else {
|
||||
match = *t < *age
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if tspec == nil || age == nil || ageType == nil {
|
||||
return
|
||||
}
|
||||
|
||||
mask = ageType.Mask()
|
||||
|
||||
if now == nil {
|
||||
now = new(time.Time)
|
||||
*now = time.Now()
|
||||
}
|
||||
|
||||
// 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
|
||||
}
|
||||
}
|
||||
// MTIME
|
||||
if mask.HasFlag(bitmask.MaskBit(TimeAny)) || mask.HasFlag(bitmask.MaskBit(TimeModified)) {
|
||||
curAge = now.Sub(tspec.ModTime())
|
||||
if include = tfunc(&curAge); include {
|
||||
return
|
||||
}
|
||||
}
|
||||
// CTIME (if supported)
|
||||
if tspec.HasChangeTime() && (mask.HasFlag(bitmask.MaskBit(TimeAny)) || mask.HasFlag(bitmask.MaskBit(TimeChanged))) {
|
||||
curAge = now.Sub(tspec.ChangeTime())
|
||||
if include = tfunc(&curAge); include {
|
||||
return
|
||||
}
|
||||
}
|
||||
// ATIME
|
||||
if mask.HasFlag(bitmask.MaskBit(TimeAny)) || mask.HasFlag(bitmask.MaskBit(TimeAccessed)) {
|
||||
curAge = now.Sub(tspec.AccessTime())
|
||||
if include = tfunc(&curAge); include {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
package paths
|
||||
|
||||
import (
|
||||
`r00t2.io/goutils/bitmask`
|
||||
)
|
||||
|
||||
// Mask returns a bitmask.MaskBit from a pathTimeType.
|
||||
func (p *pathTimeType) Mask() (mask *bitmask.MaskBit) {
|
||||
|
||||
mask = bitmask.NewMaskBitExplicit(uint(*p))
|
||||
|
||||
return
|
||||
}
|
||||
136
paths/types.go
136
paths/types.go
@ -1,136 +0,0 @@
|
||||
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