ocfl

type Extension interface {
	GetName() string
	SetFS(fsys fs.FS)
	GetFS() fs.FS
	SetParams(params map[string]string) error
	WriteConfig() error
	//GetConfigString() string
	GetConfig() any
	IsRegistered() bool
}

type ExtensionArea interface {
	Extension
	GetAreaPath(object Object, area string) (string, error)
}

type ExtensionConfig struct {
	ExtensionName string `json:"extensionName"`
}

type ExtensionContentChange interface {
	Extension
	AddFileBefore(object Object, sourceFS fs.FS, source string, dest string, area string, isDir bool) error
	UpdateFileBefore(object Object, sourceFS fs.FS, source, dest, area string, isDir bool) error
	DeleteFileBefore(object Object, dest string, area string) error
	AddFileAfter(object Object, sourceFS fs.FS, source []string, internalPath, digest, area string, isDir bool) error
	UpdateFileAfter(object Object, sourceFS fs.FS, source, dest, area string, isDir bool) error
	DeleteFileAfter(object Object, dest string, area string) error
}

type ExtensionExternalParam struct {
	ExtensionName string
	Functions     []string
	Param         string
	//	File          string
	Description string
	Default     string
}

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

type ExtensionFixityDigest interface {
	Extension
	GetFixityDigests() []checksum.DigestAlgorithm
}

type ExtensionInitial interface {
	Extension
	GetExtension() string
	SetExtension(ext string)
}

type ExtensionManager interface {
	Extension
	ExtensionStorageRootPath
	ExtensionObjectContentPath
	ExtensionObjectStatePath
	ExtensionContentChange
	ExtensionObjectChange
	ExtensionFixityDigest
	ExtensionObjectExtractPath
	ExtensionMetadata
	ExtensionArea
	ExtensionStream
	ExtensionNewVersion
	GetConfig() any
	GetExtensions() []Extension
	Add(ext Extension) error
	Finalize()
	GetConfigName(extName string) (any, error)
	GetFSName(extName string) (fs.FS, error)
	StoreRootLayout(fsys fs.FS) error
	SetInitial(initial ExtensionInitial)
}

type ExtensionManagerConfig struct {
	*ExtensionConfig
	Sort      map[string][]string   `json:"sort"`
	Exclusion map[string][][]string `json:"exclusion"`
}

type ExtensionMetadata interface {
	Extension
	GetMetadata(object Object) (map[string]any, error)
}

type ExtensionNewVersion interface {
	Extension
	NeedNewVersion(object Object) (bool, error)
	DoNewVersion(object Object) error
}

type ExtensionObjectChange interface {
	Extension
	UpdateObjectBefore(object Object) error
	UpdateObjectAfter(object Object) error
}

type ExtensionObjectContentPath interface {
	Extension
	BuildObjectManifestPath(object Object, originalPath string, area string) (string, error)
}

type ExtensionObjectExtractPath interface {
	Extension
	BuildObjectExtractPath(object Object, originalPath string, area string) (string, error)
}

type ExtensionObjectStatePath interface {
	Extension
	BuildObjectStatePath(object Object, originalPath string, area string) (string, error)
}

type ExtensionStorageRootPath interface {
	Extension
	WriteLayout(fsys fs.FS) error
	BuildStorageRootPath(storageRoot StorageRoot, id string) (string, error)
}

type ExtensionStream interface {
	Extension
	StreamObject(object Object, reader io.Reader, stateFiles []string, dest string) error
}

type FileMetadata struct {
	Checksums    map[checksum.DigestAlgorithm]string
	InternalName []string
	VersionName  map[string][]string
	Extension    map[string]any
}

type Fixity map[checksum.DigestAlgorithm]map[string][]string

type InitialDummy struct {
	*ExtensionManagerConfig
}

type Inventory interface {
	Finalize(inCreation bool) error
	IsEqual(i2 Inventory) bool
	Init(id string, digest checksum.DigestAlgorithm, fixity []checksum.DigestAlgorithm) error
	GetID() string
	GetContentDir() string
	GetRealContentDir() string
	GetHead() string
	GetSpec() InventorySpec
	CheckFiles(fileManifest map[checksum.DigestAlgorithm]map[string][]string) error

	DeleteFile(stateFilename string) error
	RenameFile(stateSource, stateDest string) error
	//Rename(oldVirtualFilename, newVirtualFilename string) error
	AddFile(stateFilenames []string, manifestFilename string, checksums map[checksum.DigestAlgorithm]string) error
	CopyFile(dest string, digest string) error

	IterateStateFiles(version string, fn StateFileCallback) error
	GetStateFiles(version string, cs string) ([]string, error)

	//GetContentDirectory() string
	GetVersionStrings() []string
	GetVersions() map[string]*Version
	GetFiles() map[string][]string
	GetManifest() map[string][]string
	GetFixity() Fixity
	GetFilesFlat() []string
	GetDigestAlgorithm() checksum.DigestAlgorithm
	GetFixityDigestAlgorithm() []checksum.DigestAlgorithm
	IsWriteable() bool
	IsModified() bool
	BuildManifestName(stateFilename string) string
	BuildManifestNameVersion(stateFilename string, version string) string
	NewVersion(msg, UserName, UserAddress string) error
	GetDuplicates(checksum string) []string
	AlreadyExists(stateFilename, checksum string) (bool, error)
	//	IsUpdate(virtualFilename, checksum string) (bool, error)
	Clean() error

	VersionLessOrEqual(v1, v2 string) bool
	// contains filtered or unexported methods
}

type InventoryBase struct {
	Id               string                                           `json:"id"`
	Type             InventorySpec                                    `json:"type"`
	DigestAlgorithm  checksum.DigestAlgorithm                         `json:"digestAlgorithm"`
	Head             *OCFLString                                      `json:"head"`
	ContentDirectory string                                           `json:"contentDirectory,omitempty"`
	Manifest         *OCFLManifest                                    `json:"manifest,omitempty"`
	Versions         *OCFLVersions                                    `json:"versions"`
	Fixity           map[checksum.DigestAlgorithm]map[string][]string `json:"fixity,omitempty"`
	// contains filtered or unexported fields
}

type InventorySpec string

type InventoryV1_0 struct {
	*InventoryBase
}

type InventoryV1_1 struct {
	*InventoryBase
}

type NamesStruct struct {
	ExternalPaths []string
	InternalPath  string
	ManifestPath  string
}

type OCFLManifest struct {
	Manifest map[string][]string
	// contains filtered or unexported fields
}

type OCFLState struct {
	State map[string][]string
	// contains filtered or unexported fields
}

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

type OCFLTime struct {
	time.Time
	// contains filtered or unexported fields
}

type OCFLUser struct {
	User
	// contains filtered or unexported fields
}

type OCFLVersion string

type OCFLVersions struct {
	Versions map[string]*Version
	// contains filtered or unexported fields
}

type Object interface {
	LoadInventory(folder string) (Inventory, error)
	CreateInventory(id string, digest checksum.DigestAlgorithm, fixity []checksum.DigestAlgorithm) (Inventory, error)
	StoreInventory(version bool, objectRoot bool) error
	GetInventory() Inventory
	StoreExtensions() error
	Init(id string, digest checksum.DigestAlgorithm, fixity []checksum.DigestAlgorithm, manager ExtensionManager) error
	Load() error
	StartUpdate(sourceFS fs.FS, msg string, UserName string, UserAddress string, echo bool) (fs.FS, error)
	EndUpdate() error
	BeginArea(area string)
	EndArea() error
	AddFolder(fsys fs.FS, versionFS fs.FS, checkDuplicate bool, area string) error
	AddFile(fsys fs.FS, versionFS fs.FS, path string, checkDuplicate bool, area string, noExtensionHook bool, isDir bool) error
	AddData(data []byte, path string, checkDuplicate bool, area string, noExtensionHook bool, isDir bool) error
	AddReader(r io.ReadCloser, files []string, area string, noExtensionHook bool, isDir bool) (string, error)
	DeleteFile(virtualFilename string, digest string) error
	RenameFile(virtualFilenameSource, virtualFilenameDest string, digest string) error
	GetID() string
	GetVersion() OCFLVersion
	Check() error
	Close() error
	GetFS() fs.FS
	IsModified() bool
	Stat(w io.Writer, statInfo []StatInfo) error
	Extract(fsys fs.FS, version string, withManifest bool, area string) error
	GetMetadata() (*ObjectMetadata, error)
	GetAreaPath(area string) (string, error)
	GetExtensionManager() ExtensionManager
	BuildNames(files []string, area string) (*NamesStruct, error)
}

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

type ObjectMetadata struct {
	ID              string
	DigestAlgorithm checksum.DigestAlgorithm
	Head            string
	Versions        map[string]*VersionMetadata
	Files           map[string]*FileMetadata
	Extension       any
}

type ObjectV1_0 struct {
	*ObjectBase
}

type ObjectV1_1 struct {
	*ObjectBase
}

type ObjectV2_0 struct {
	*ObjectBase
}

type StatInfo int64

type StateFileCallback func(internal []string, external []string, digest string) error

type StorageRoot interface {
	fmt.Stringer
	GetDigest() checksum.DigestAlgorithm
	SetDigest(digest checksum.DigestAlgorithm)
	GetFiles() ([]string, error)
	GetFolders() ([]string, error)
	GetObjectFolders() ([]string, error)
	ObjectExists(id string) (bool, error)
	LoadObjectByFolder(folder string) (Object, error)
	LoadObjectByID(id string) (Object, error)
	CreateObject(id string, version OCFLVersion, digest checksum.DigestAlgorithm, fixity []checksum.DigestAlgorithm, manager ExtensionManager) (Object, error)
	CreateExtension(fsys fs.FS) (Extension, error)
	CreateExtensions(fsys fs.FS, validation Validation) (ExtensionManager, error)
	Check() error
	CheckObjectByFolder(objectFolder string) error
	CheckObjectByID(objectID string) error
	Init(version OCFLVersion, digest checksum.DigestAlgorithm, manager ExtensionManager) error
	Load() error
	IsModified() bool

	GetVersion() OCFLVersion
	Stat(w io.Writer, path string, id string, statInfo []StatInfo) error
	Extract(fsys fs.FS, path, id, version string, withManifest bool, area string) error
	ExtractMeta(path, id string) (*StorageRootMetadata, error)
	// contains filtered or unexported methods
}

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

type StorageRootMetadata struct {
	Objects map[string]*ObjectMetadata
}

type StorageRootV1_0 struct {
	*StorageRootBase
}

type StorageRootV1_1 struct {
	*StorageRootBase
}

type StorageRootV2_0 struct {
	*StorageRootBase
}

type User struct {
	Address *OCFLString `json:"address,omitempty"`
	Name    *OCFLString `json:"name"`
}

type Validation interface {
	// contains filtered or unexported methods
}

type ValidationError struct {
	Code         ValidationErrorCode
	Description  string
	Ref          string
	Description2 string
	Context      string
}

type ValidationErrorCode string

type ValidationStatus struct {
	Errors []*ValidationError
}

type Version struct {
	Created *OCFLTime   `json:"created"`
	Message *OCFLString `json:"message"`
	State   *OCFLState  `json:"state"`
	User    *OCFLUser   `json:"user"`
}

type VersionMetadata struct {
	Created time.Time
	Message string
	Name    string
	Address string
}