paperless

type Cmd struct {
	Cmd []string
}

type CmdChain struct {

	//TODO remove this (this should come from outside)
	Environment

	Links []Link
}

type Environment struct {

	// Constants are variables that are defined before a command chain is run
	Constants map[string]string

	// Tempfiles are constants that house a name of a temporary file. The
	// files are created before the chain is run and they are removed at
	// the end.
	TempFiles []string

	// The directory where the commands are run. This is a created
	// temporary directory
	RootDir string

	// AllowedCommands contain the commands that are allowed. If this is
	// nil, all commands are allowed.
	AllowedCommands map[string]bool
	// contains filtered or unexported fields
}

type Image struct {
	// in img
	Id            int
	Checksum      string
	Fileid        string
	ScanDate      time.Time
	AddDate       time.Time
	InterpretDate time.Time
	ProcessLog    string
	Filename      string

	// in imgtext
	Text    string
	Comment string

	// in tags
	Tags []Tag
}

type ImageResult struct {
	PageResult
	Images []Image
}

type Job struct {
	Job      func()
	Finalize func()
}

type Link interface {
	Validate(*Environment) error
	Run(*Status) error
}

type Page struct {
	// Id that was the last of the previous page
	SinceId int

	// Count is the number of items in the page
	Count int
}

type PageResult struct {
	// Number of items returned by the whole search
	ResultCount int

	// IDs of the items that are the first of their page
	SinceIDs []int

	// Count is the number of items in the page
	Count int
}

type Query struct {
}

type Runner struct {
	RunnerCount int
	ChanBuffer  int
	Job         func(string)
	Finalize    func(string)
}

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

type Script struct {
	Id     int
	Name   string
	Script string
}

type Search struct {
	ID      int
	OrderBy string
	Match   string
	Tag     string
}

type Status struct {
	// The log output will be written to this
	Log io.Writer

	Environment
}

type Tag struct {
	Id      int
	Name    string
	Comment string
}

type Token struct {
	Type  TokenType
	Value string
	Pos   int
}

type TokenType int