tree

Documentation

Index

• type Blobstore
• type EventAction
• type GpfsFileAuditLoggingWatcher
  • func NewGpfsFileAuditLoggingWatcher(tree *Tree, auditLogFile string) (*GpfsFileAuditLoggingWatcher, error)
  • func (w *GpfsFileAuditLoggingWatcher) Watch(path string)
• type GpfsWatchFolderWatcher
  • func NewGpfsWatchFolderWatcher(tree *Tree, kafkaBrokers []string) (*GpfsWatchFolderWatcher, error)
  • func (w *GpfsWatchFolderWatcher) Watch(topic string)
• type InotifyWatcher
  • func NewInotifyWatcher(tree *Tree) *InotifyWatcher
  • func (iw *InotifyWatcher) Watch(path string)
• type PermissionCheckFunc
• type ScanDebouncer
  • func NewScanDebouncer(d time.Duration, f func(item scanItem)) *ScanDebouncer
  • func (d *ScanDebouncer) Debounce(item scanItem)
  • func (d *ScanDebouncer) InProgress(path string) bool
• type Tree
  • func New(lu node.PathLookup, bs Blobstore, um usermapper.Mapper, ...) (*Tree, error)
  • func (t *Tree) BuildSpaceIDIndexEntry(spaceID, nodeID string) string
  • func (t *Tree) CreateDir(ctx context.Context, n *node.Node) (err error)
  • func (t *Tree) Delete(ctx context.Context, n *node.Node) error
  • func (t *Tree) DeleteBlob(node *node.Node) error
  • func (t *Tree) GetMD(ctx context.Context, n *node.Node) (os.FileInfo, error)
  • func (t *Tree) HandleFileDelete(path string) error
  • func (t *Tree) InitNewNode(ctx context.Context, n *node.Node, fsize uint64) (metadata.UnlockFunc, error)
  • func (t *Tree) ListFolder(ctx context.Context, n *node.Node) ([]*node.Node, error)
  • func (t *Tree) Move(ctx context.Context, oldNode *node.Node, newNode *node.Node) (err error)
  • func (t *Tree) Propagate(ctx context.Context, n *node.Node, _ int64) (err error)
  • func (t *Tree) PublishEvent(ev interface{})
  • func (t *Tree) PurgeRecycleItemFunc(ctx context.Context, spaceid, key string, path string) (*node.Node, func() error, error)
  • func (t *Tree) ReadBlob(node *node.Node) (io.ReadCloser, error)
  • func (t *Tree) ResolveSpaceIDIndexEntry(spaceid, entry string) (string, string, error)
  • func (t *Tree) RestoreRecycleItemFunc(ctx context.Context, spaceid, key, trashPath string, targetNode *node.Node) (*node.Node, *node.Node, func() error, error)
  • func (t *Tree) Scan(path string, action EventAction, isDir bool, recurse bool) error
  • func (t *Tree) Setup() error
  • func (t *Tree) TouchFile(ctx context.Context, n *node.Node, markprocessing bool, mtime string) error
  • func (t *Tree) WarmupIDCache(root string, assimilate bool) error
  • func (t *Tree) WriteBlob(node *node.Node, source string) error
• type Watcher

Types

type Blobstore

type Blobstore interface {
	Upload(node *node.Node, source string) error
	Download(node *node.Node) (io.ReadCloser, error)
	Delete(node *node.Node) error
}

Blobstore defines an interface for storing blobs in a blobstore

type EventAction

type EventAction int

const (
	ActionCreate EventAction = iota
	ActionUpdate
	ActionMove
	ActionDelete
)

type GpfsFileAuditLoggingWatcher

type GpfsFileAuditLoggingWatcher struct {
	// contains filtered or unexported fields
}

func NewGpfsFileAuditLoggingWatcher

func NewGpfsFileAuditLoggingWatcher(tree *Tree, auditLogFile string) (*GpfsFileAuditLoggingWatcher, error)

func (*GpfsFileAuditLoggingWatcher) Watch

func (w *GpfsFileAuditLoggingWatcher) Watch(path string)

type GpfsWatchFolderWatcher

type GpfsWatchFolderWatcher struct {
	// contains filtered or unexported fields
}

func NewGpfsWatchFolderWatcher

func NewGpfsWatchFolderWatcher(tree *Tree, kafkaBrokers []string) (*GpfsWatchFolderWatcher, error)

func (*GpfsWatchFolderWatcher) Watch

func (w *GpfsWatchFolderWatcher) Watch(topic string)

type InotifyWatcher

type InotifyWatcher struct {
	// contains filtered or unexported fields
}

func NewInotifyWatcher

func NewInotifyWatcher(tree *Tree) *InotifyWatcher

func (*InotifyWatcher) Watch

func (iw *InotifyWatcher) Watch(path string)

type PermissionCheckFunc

type PermissionCheckFunc func(rp *provider.ResourcePermissions) bool

PermissionCheckFunc defined a function used to check resource permissions

type ScanDebouncer

type ScanDebouncer struct {
	// contains filtered or unexported fields
}

func NewScanDebouncer

func NewScanDebouncer(d time.Duration, f func(item scanItem)) *ScanDebouncer

NewScanDebouncer returns a new SpaceDebouncer instance

func (*ScanDebouncer) Debounce

func (d *ScanDebouncer) Debounce(item scanItem)

Debounce restarts the debounce timer for the given space

func (*ScanDebouncer) InProgress

func (d *ScanDebouncer) InProgress(path string) bool

InProgress returns true if the given path is currently being processed

type Tree

type Tree struct {
	// contains filtered or unexported fields
}

Tree manages a hierarchical tree

func New

func New(lu node.PathLookup, bs Blobstore, um usermapper.Mapper, trashbin *trashbin.Trashbin, o *options.Options, es events.Stream, cache store.Store) (*Tree, error)

New returns a new instance of Tree

func (*Tree) BuildSpaceIDIndexEntry

func (t *Tree) BuildSpaceIDIndexEntry(spaceID, nodeID string) string

BuildSpaceIDIndexEntry returns the entry for the space id index

func (*Tree) CreateDir

func (t *Tree) CreateDir(ctx context.Context, n *node.Node) (err error)

CreateDir creates a new directory entry in the tree

func (*Tree) Delete

func (t *Tree) Delete(ctx context.Context, n *node.Node) error

Delete deletes a node in the tree by moving it to the trash

func (*Tree) DeleteBlob

func (t *Tree) DeleteBlob(node *node.Node) error

DeleteBlob deletes a blob from the blobstore

func (*Tree) GetMD

func (t *Tree) GetMD(ctx context.Context, n *node.Node) (os.FileInfo, error)

GetMD returns the metadata of a node in the tree

func (*Tree) HandleFileDelete

func (t *Tree) HandleFileDelete(path string) error

func (*Tree) InitNewNode

func (t *Tree) InitNewNode(ctx context.Context, n *node.Node, fsize uint64) (metadata.UnlockFunc, error)

InitNewNode initializes a new node

func (*Tree) ListFolder

func (t *Tree) ListFolder(ctx context.Context, n *node.Node) ([]*node.Node, error)

ListFolder lists the content of a folder node

func (*Tree) Move

func (t *Tree) Move(ctx context.Context, oldNode *node.Node, newNode *node.Node) (err error)

Move replaces the target with the source

func (*Tree) Propagate

func (t *Tree) Propagate(ctx context.Context, n *node.Node, _ int64) (err error)

Propagate propagates changes to the root of the tree

func (*Tree) PublishEvent

func (t *Tree) PublishEvent(ev interface{})

func (*Tree) PurgeRecycleItemFunc

func (t *Tree) PurgeRecycleItemFunc(ctx context.Context, spaceid, key string, path string) (*node.Node, func() error, error)

PurgeRecycleItemFunc returns a node and a function to purge it from the trash

func (*Tree) ReadBlob

func (t *Tree) ReadBlob(node *node.Node) (io.ReadCloser, error)

ReadBlob reads a blob from the blobstore

func (*Tree) ResolveSpaceIDIndexEntry

func (t *Tree) ResolveSpaceIDIndexEntry(spaceid, entry string) (string, string, error)

ResolveSpaceIDIndexEntry returns the node id for the space id index entry

func (*Tree) RestoreRecycleItemFunc

func (t *Tree) RestoreRecycleItemFunc(ctx context.Context, spaceid, key, trashPath string, targetNode *node.Node) (*node.Node, *node.Node, func() error, error)

RestoreRecycleItemFunc returns a node and a function to restore it from the trash.

func (*Tree) Scan

func (t *Tree) Scan(path string, action EventAction, isDir bool, recurse bool) error

Scan scans the given path and updates the id chache

func (*Tree) Setup

func (t *Tree) Setup() error

Setup prepares the tree structure

func (*Tree) TouchFile

func (t *Tree) TouchFile(ctx context.Context, n *node.Node, markprocessing bool, mtime string) error

TouchFile creates a new empty file

func (*Tree) WarmupIDCache

func (t *Tree) WarmupIDCache(root string, assimilate bool) error

WarmupIDCache warms up the id cache

func (*Tree) WriteBlob

func (t *Tree) WriteBlob(node *node.Node, source string) error

WriteBlob writes a blob to the blobstore

type Watcher

type Watcher interface {
	Watch(path string)
}