fileMonitor

README

go-fileMonitor

Note if using SMB mount on linux, ensure that cifs-utils or equivalent is installed. Typically installed with: sudo apt install cifs-utils

Documentation

Index

• Constants
• func SmbMount(username, password, server, shareName string) error
• func SmbRemove(server, shareName string) error
• type Copier
• type CopierAlias
  • func (c *CopierAlias) GetCopier() (Copier, error)
  • func (c *CopierAlias) UnmarshalJSON(data []byte) error
• type CopierFtp
  • func (c *CopierFtp) Copy(inFilePath, monitorDir string) error
  • func (c *CopierFtp) GetType() CopierType
  • func (f *CopierFtp) MarshalJSON() ([]byte, error)
• type CopierLocal
  • func (c *CopierLocal) Copy(filePath, monitorDir string) error
  • func (c *CopierLocal) GetType() CopierType
  • func (c *CopierLocal) MarshalJSON() ([]byte, error)
• type CopierType
• type Dir
  • func (d *Dir) Monitor() error
  • func (d *Dir) UnmarshalJSON(input []byte) error
• type FileMonitor
  • func NewFileMonitor(parentCtx context.Context, logger zerolog.Logger, configPath string) (*FileMonitor, error)
  • func (f *FileMonitor) AddAllDirPublisher(publisher Publisher)
  • func (f *FileMonitor) AddDir(dir *Dir) error
  • func (f *FileMonitor) Connected() bool
  • func (f *FileMonitor) GetDirs() []string
  • func (f *FileMonitor) GetStats() *Stats
  • func (f *FileMonitor) NewDir(name, monitorFolder, publishLocation string, monitorFreq time.Duration, ...) (*Dir, error)
  • func (f *FileMonitor) RemoveDir(dir *Dir) error
  • func (f *FileMonitor) Start() error
  • func (f *FileMonitor) Update() error
• type MatchGroup
  • func (m *MatchGroup) Match(filePath string) (match bool, err error)
• type Processor
  • func (p *Processor) UnmarshalJSON(data []byte) error
• type ProcessorExecutor
• type ProcessorType
• type Publisher
• type Stats
  • func (s *Stats) Add(other *Stats)
  • func (s *Stats) Inc(totalBytes uint64)
  • func (s *Stats) Reset()
  • func (s *Stats) String() string
  • func (s *Stats) Sub(other *Stats)

Constants

const (
	CopierTypeNull = iota
	CopierTypeLocal
	CopierTypeFTP
)

Functions

func SmbMount

func SmbMount(username, password, server, shareName string) error

func SmbRemove

func SmbRemove(server, shareName string) error

Types

type Copier

type Copier interface {
	Copy(dir, monitorDir string) error
	GetType() CopierType
	MarshalJSON() ([]byte, error) // Must inject type into object
}

type CopierAlias

type CopierAlias struct {
	Type    CopierType
	Details json.RawMessage
}

func (*CopierAlias) GetCopier

func (c *CopierAlias) GetCopier() (Copier, error)

func (*CopierAlias) UnmarshalJSON

func (c *CopierAlias) UnmarshalJSON(data []byte) error

type CopierFtp

type CopierFtp struct {
	Server      string
	Username    string
	Password    string // Does not store the password directly and only stores encrypted using the encryptionFunc
	Destination string

	EncryptionFunc func(string) (string, error) `json:"-"` // Not stored in JSON
	DecryptionFunc func(string) (string, error) `json:"-"` // Not stored in JSON
}

func (*CopierFtp) Copy

func (c *CopierFtp) Copy(inFilePath, monitorDir string) error

func (*CopierFtp) GetType

func (c *CopierFtp) GetType() CopierType

func (*CopierFtp) MarshalJSON

func (f *CopierFtp) MarshalJSON() ([]byte, error)

type CopierLocal

type CopierLocal struct {
	Destination string
}

func (*CopierLocal) Copy

func (c *CopierLocal) Copy(filePath, monitorDir string) error

func (*CopierLocal) GetType

func (c *CopierLocal) GetType() CopierType

func (*CopierLocal) MarshalJSON

func (c *CopierLocal) MarshalJSON() ([]byte, error)

type CopierType

type CopierType int

type Dir

type Dir struct {
	Name             string
	MonitorFolder    string
	MonitorFrequency time.Duration
	KeepEmptyDirs    bool
	Active           bool
	MatchGroups      []MatchGroup

	Processor  *Processor
	Publishers []Publisher `json:"-"`
	Copiers    []Copier

	// Copier to use if an error occurs after a match as original file will be delete
	ErrorCopiers []Copier

	Stats Stats
	// contains filtered or unexported fields
}

func (*Dir) Monitor

func (d *Dir) Monitor() error

func (*Dir) UnmarshalJSON

func (d *Dir) UnmarshalJSON(input []byte) error

type FileMonitor

type FileMonitor struct {
	Dirs       map[string]*Dir
	MaxJobs    uint // maximum number of jobs that can be buffered without waiting
	NumWorkers uint // number of workers processing files
	// contains filtered or unexported fields
}

func NewFileMonitor

func NewFileMonitor(parentCtx context.Context, logger zerolog.Logger, configPath string) (*FileMonitor, error)

func (*FileMonitor) AddAllDirPublisher

func (f *FileMonitor) AddAllDirPublisher(publisher Publisher)

func (*FileMonitor) AddDir

func (f *FileMonitor) AddDir(dir *Dir) error

func (*FileMonitor) Connected

func (f *FileMonitor) Connected() bool

func (*FileMonitor) GetDirs

func (f *FileMonitor) GetDirs() []string

func (*FileMonitor) GetStats

func (f *FileMonitor) GetStats() *Stats

func (*FileMonitor) NewDir

func (f *FileMonitor) NewDir(name, monitorFolder, publishLocation string, monitorFreq time.Duration, processor *Processor, overwriteExistingDir bool, matchGroups []MatchGroup) (*Dir, error)

Creates a new dir

Likely caller will want to add Publisher, Copiers, and/or ErrorCopiers

func (*FileMonitor) RemoveDir

func (f *FileMonitor) RemoveDir(dir *Dir) error

func (*FileMonitor) Start

func (f *FileMonitor) Start() error

func (*FileMonitor) Update

func (f *FileMonitor) Update() error

type MatchGroup

type MatchGroup struct {
	Expression string
	Exclude    bool // If true value must not exist. If false value must exist
	// contains filtered or unexported fields
}

Regex matching for file to be processed

Uses dir + file name with the separator guaranteed to be "/"

func (*MatchGroup) Match

func (m *MatchGroup) Match(filePath string) (match bool, err error)

type Processor

type Processor struct {
	Type     ProcessorType
	Executor ProcessorExecutor
}

func (*Processor) UnmarshalJSON

func (p *Processor) UnmarshalJSON(data []byte) error

type ProcessorExecutor

type ProcessorExecutor interface {
	Process(filepath string) (result [][]byte, id []string, err error)
}

type ProcessorType

type ProcessorType int

const (
	ProcessorTypeNull ProcessorType = iota
	ProcessorTypeCsv
)

type Publisher

type Publisher interface {
	Publish(dir *Dir, result [][]byte, id []string) error
}

type Stats

type Stats struct {
	TotalFiles atomic.Uint64
	TotalBytes atomic.Uint64
}

Stats stored with a connection

func (*Stats) Add

func (s *Stats) Add(other *Stats)

Adds the stats from the other stats

func (*Stats) Inc

func (s *Stats) Inc(totalBytes uint64)

Increments the stats

func (*Stats) Reset

func (s *Stats) Reset()

Resets the stats

func (*Stats) String

func (s *Stats) String() string

String representation of the stats

func (*Stats) Sub

func (s *Stats) Sub(other *Stats)

Subtracts the stats from the other stats