vfs

type ActionForCandidateVersion int

type Archive struct {
	Name   string   `json:"name"`
	Secret string   `json:"-"`
	IDs    []string `json:"ids"`
	Files  []string `json:"files"`
	// contains filtered or unexported fields
}

type ArchiveEntry struct {
	Dir  *DirDoc
	File *FileDoc
	// contains filtered or unexported fields
}

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

type CozyMetadataPatch struct {
	Favorite *bool `json:"favorite,omitempty"`
}

type CreateOptions int

type DirDoc struct {
	// Type of document. Useful to (de)serialize and filter the data
	// from couch.
	Type string `json:"type"`
	// Qualified file identifier
	DocID string `json:"_id,omitempty"`
	// Directory revision
	DocRev string `json:"_rev,omitempty"`
	// Directory name
	DocName string `json:"name,omitempty"`
	// Parent directory identifier
	DirID       string `json:"dir_id,omitempty"`
	RestorePath string `json:"restore_path,omitempty"`

	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
	Tags      []string  `json:"tags,omitempty"`

	// Directory path on VFS.
	// Fullpath should always be present. It is marked "omitempty" because
	// DirDoc is the base of the DirOrFile struct.
	Fullpath string `json:"path,omitempty"`

	ReferencedBy      []couchdb.DocReference `json:"referenced_by,omitempty"`
	NotSynchronizedOn []couchdb.DocReference `json:"not_synchronized_on,omitempty"`

	Metadata     Metadata           `json:"metadata,omitempty"`
	CozyMetadata *FilesCozyMetadata `json:"cozyMetadata,omitempty"`
}

type DirIterator interface {
	Next() (*DirDoc, *FileDoc, error)
}

type DirOrFileDoc struct {
	*DirDoc

	// fields from FileDoc not contained in DirDoc
	ByteSize   int64  `json:"size,string"`
	MD5Sum     []byte `json:"md5sum,omitempty"`
	Mime       string `json:"mime,omitempty"`
	Class      string `json:"class,omitempty"`
	Executable bool   `json:"executable,omitempty"`
	Trashed    bool   `json:"trashed,omitempty"`
	Encrypted  bool   `json:"encrypted,omitempty"`
	InternalID string `json:"internal_vfs_id,omitempty"`
}

type DiskThresholder interface {
	// DiskQuota returns the total number of bytes allowed to be stored in the
	// VFS. If minus or equal to zero, it is considered without limit.
	DiskQuota() int64
}

type DocPatch struct {
	Name        *string    `json:"name,omitempty"`
	DirID       *string    `json:"dir_id,omitempty"`
	RestorePath *string    `json:"restore_path,omitempty"`
	Tags        *[]string  `json:"tags,omitempty"`
	UpdatedAt   *time.Time `json:"updated_at,omitempty"`
	Executable  *bool      `json:"executable,omitempty"`
	Encrypted   *bool      `json:"encrypted,omitempty"`
	Class       *string    `json:"class,omitempty"`

	CozyMetadata CozyMetadataPatch `json:"cozyMetadata"`
}

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

type Fetcher interface {
	permission.Fetcher

	Path(fs FilePather) (string, error)
	Parent(fs VFS) (*DirDoc, error)
	// contains filtered or unexported methods
}

type File interface {
	io.Reader
	io.ReaderAt
	io.Seeker
	io.Writer
	io.Closer
}

type FileDoc struct {
	// Type of document. Useful to (de)serialize and filter the data
	// from couch.
	Type string `json:"type"`
	// Qualified file identifier
	DocID string `json:"_id,omitempty"`
	// File revision
	DocRev string `json:"_rev,omitempty"`
	// File name
	DocName string `json:"name,omitempty"`
	// Parent directory identifier
	DirID       string `json:"dir_id,omitempty"`
	RestorePath string `json:"restore_path,omitempty"`

	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`

	ByteSize   int64    `json:"size,string"` // Serialized in JSON as a string, because JS has some issues with big numbers
	MD5Sum     []byte   `json:"md5sum,omitempty"`
	Mime       string   `json:"mime,omitempty"`
	Class      string   `json:"class,omitempty"`
	Executable bool     `json:"executable"`
	Trashed    bool     `json:"trashed"`
	Encrypted  bool     `json:"encrypted"`
	Tags       []string `json:"tags,omitempty"`

	Metadata     Metadata               `json:"metadata,omitempty"`
	ReferencedBy []couchdb.DocReference `json:"referenced_by,omitempty"`

	CozyMetadata *FilesCozyMetadata `json:"cozyMetadata,omitempty"`

	// InternalID is an identifier that can be used by the VFS, but must no be
	// used by clients. For example, it can be used to know the location in
	// Swift of a file.
	InternalID string `json:"internal_vfs_id,omitempty"`
	// contains filtered or unexported fields
}

type FilePather interface {
	FilePath(doc *FileDoc) (string, error)
}

type FilesCozyMetadata struct {
	metadata.CozyMetadata
	// Instance URL where the file has been created
	CreatedOn string `json:"createdOn,omitempty"`
	// Date of the last upload of a new content
	UploadedAt *time.Time `json:"uploadedAt,omitempty"`
	// Information about the last time the content was uploaded
	UploadedBy *UploadedByEntry `json:"uploadedBy,omitempty"`
	// Instance URL where the content has been changed the last time
	UploadedOn string `json:"uploadedOn,omitempty"`
}

type Fs interface {
	prefixer.Prefixer
	InitFs() error
	Delete() error

	// Maximum file size
	MaxFileSize() int64

	// OpenFile return a file handler for reading associated with the given file
	// document. The file handler implements io.ReadCloser and io.Seeker.
	OpenFile(doc *FileDoc) (File, error)
	// OpenFileVersion returns a file handler for reading the content of an old
	// version of the given file.
	OpenFileVersion(doc *FileDoc, version *Version) (File, error)
	// CreateDir is used to create a new directory from its document.
	CreateDir(doc *DirDoc) error
	// CreateFile creates a new file or update the content of an existing file.
	// The first argument contains the document of the new or update version of
	// the file. The second argument is the optional old document of the old
	// version of the file.
	//
	// Warning: you MUST call the Close() method and check for its error.
	CreateFile(newdoc, olddoc *FileDoc, opts ...CreateOptions) (File, error)
	// CopyFile creates a fresh copy of the source file with the given newdoc
	// attributes (e.g. a new name)
	CopyFile(olddoc, newdoc *FileDoc) error
	// DissociateFile creates a copy of the source file with the name and
	// directory of the destination file doc, and then remove the source file
	// with all of its version. It is used by the sharings to change the ID
	// of the document to avoid later conflicts.
	DissociateFile(src, dst *FileDoc) error
	// DissociateDir is like DissociateFile but for directories.
	DissociateDir(src, dst *DirDoc) error

	// DestroyDirContent destroys all directories and files contained in a
	// directory.
	DestroyDirContent(doc *DirDoc, push func(TrashJournal) error) error
	// DestroyDirAndContent destroys all directories and files contained in a
	// directory and the directory itself.
	DestroyDirAndContent(doc *DirDoc, push func(TrashJournal) error) error
	// DestroyFile destroys a file from the trash.
	DestroyFile(doc *FileDoc) error
	// EnsureErased remove the files in Swift if they still exist.
	EnsureErased(journal TrashJournal) error

	// RevertFileVersion restores the content of a file from an old version.
	// The current version of the content is not lost, but saved as another
	// version.
	RevertFileVersion(doc *FileDoc, version *Version) error
	// CleanOldVersion deletes an old version of a file.
	CleanOldVersion(fileID string, version *Version) error
	// ClearOldVersions deletes all the old versions of all files
	ClearOldVersions() error
	// ImportFileVersion returns a file handler that can be used to write a
	// version.
	ImportFileVersion(version *Version, content io.ReadCloser) error

	// CopyFileFromOtherFS creates or updates a file by copying the content of
	// a file in another Cozy. It is used for sharings, to optimize I/O when
	// two instances are on the same stack.
	CopyFileFromOtherFS(olddoc, newdoc *FileDoc, srcFS Fs, srcDoc *FileDoc) error

	// Fsck return the list of inconsistencies in the VFS
	Fsck(func(log *FsckLog), bool) (err error)
	CheckFilesConsistency(func(*FsckLog), bool) error
}

type FsckContentMismatch struct {
	SizeIndex   int64  `json:"size_index"`
	SizeFile    int64  `json:"size_file"`
	MD5SumIndex []byte `json:"md5sum_index"`
	MD5SumFile  []byte `json:"md5sum_file"`
}

type FsckLog struct {
	Type             FsckLogType          `json:"type"`
	FileDoc          *TreeFile            `json:"file_doc,omitempty"`
	DirDoc           *TreeFile            `json:"dir_doc,omitempty"`
	VersionDoc       *Version             `json:"version_doc,omitempty"`
	IsFile           bool                 `json:"is_file"`
	IsVersion        bool                 `json:"is_version"`
	ContentMismatch  *FsckContentMismatch `json:"content_mismatch,omitempty"`
	ExpectedFullpath string               `json:"expected_fullpath,omitempty"`
}

type FsckLogType string

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

type Indexer interface {
	InitIndex() error

	FilePather

	// DiskUsage computes the total size of the files contained in the VFS,
	// including versions.
	DiskUsage() (int64, error)
	// FilesUsage computes the total size of the files contained in the VFS,
	// excluding versions.
	FilesUsage() (int64, error)
	// VersionsUsage computes the total size of the old file versions contained
	// in the VFS, not including latest version.
	VersionsUsage() (int64, error)
	// TrashUsage computes the total size of the files contained in the trash.
	TrashUsage() (int64, error)
	// DirSize returns the size of a directory, including files in
	// subdirectories.
	DirSize(doc *DirDoc) (int64, error)

	// CreateFileDoc creates and add in the index a new file document.
	CreateFileDoc(doc *FileDoc) error
	// CreateNamedFileDoc creates and add in the index a new file document with
	// its id already set.
	CreateNamedFileDoc(doc *FileDoc) error
	// UpdateFileDoc is used to update the document of a file. It takes the
	// new file document that you want to create and the old document,
	// representing the current revision of the file.
	UpdateFileDoc(olddoc, newdoc *FileDoc) error
	// DeleteFileDoc removes from the index the specified file document.
	DeleteFileDoc(doc *FileDoc) error

	// CreateDirDoc creates and add in the index a new directory document.
	CreateDirDoc(doc *DirDoc) error
	// CreateNamedDirDoc creates and add in the index a new directory document
	// with its id already set.
	CreateNamedDirDoc(doc *DirDoc) error
	// UpdateDirDoc is used to update the document of a directory. It takes the
	// new directory document that you want to create and the old document,
	// representing the current revision of the directory.
	UpdateDirDoc(olddoc, newdoc *DirDoc) error
	// DeleteDirDoc removes from the index the specified directory document.
	DeleteDirDoc(doc *DirDoc) error
	// DeleteDirDocAndContent removes from the index the specified directory as
	// well all its children. It returns the list of the children files that
	// were removed.
	DeleteDirDocAndContent(doc *DirDoc, onlyContent bool) ([]*FileDoc, int64, error)

	// MoveDir is an internal call to update the fullpath of the subdirectories
	// of a renamed/moved directory. It is exported to allow the sharing
	// indexer to call this method on the couchdb indexer of the VFS.
	MoveDir(oldpath, newpath string) error

	// DirByID returns the directory document information associated with the
	// specified identifier.
	DirByID(fileID string) (*DirDoc, error)
	// DirByPath returns the directory document information associated with the
	// specified path.
	DirByPath(name string) (*DirDoc, error)

	// FileByID returns the file document information associated with the
	// specified identifier.
	FileByID(fileID string) (*FileDoc, error)
	// FileByPath returns the file document information associated with the
	// specified path.
	FileByPath(name string) (*FileDoc, error)

	// DirOrFileByID returns the document from its identifier without knowing in
	// advance its type. One of the returned argument is not nil.
	DirOrFileByID(fileID string) (*DirDoc, *FileDoc, error)
	// DirOrFileByPath returns the document from its path without knowing in
	// advance its type. One of the returned argument is not nil.
	DirOrFileByPath(name string) (*DirDoc, *FileDoc, error)

	// DirIterator returns an iterator over the children of the specified
	// directory.
	DirIterator(doc *DirDoc, opts *IteratorOptions) DirIterator

	// DirBatch returns a batch of documents
	DirBatch(*DirDoc, couchdb.Cursor) ([]DirOrFileDoc, error)
	DirLength(*DirDoc) (int, error)
	DirChildExists(dirID, filename string) (bool, error)
	BatchDelete([]couchdb.Doc) error

	// CreateVersion adds a version to the CouchDB index.
	CreateVersion(*Version) error
	// DeleteVersion removes a version from the CouchDB index.
	DeleteVersion(*Version) error
	AllVersions() ([]*Version, error)
	BatchDeleteVersions([]*Version) error

	ListNotSynchronizedOn(clientID string) ([]DirDoc, error)

	CheckIndexIntegrity(func(*FsckLog), bool) error
	CheckTreeIntegrity(*Tree, func(*FsckLog), bool) error
	BuildTree(each ...func(*TreeFile)) (tree *Tree, err error)
}

type IteratorOptions struct {
	AfterID string
	ByFetch int
}

type MetaExtractor interface {
	io.WriteCloser
	Abort(error)
	Result() Metadata
}

type Metadata map[string]interface{}

type Prefixer interface {
	prefixer.Prefixer
	GetContextName() string
}

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

type Store interface {
	AddFile(db prefixer.Prefixer, filePath string) (string, error)
	AddThumb(db prefixer.Prefixer, fileID string) (string, error)
	AddThumbs(db prefixer.Prefixer, fileIDs []string) (map[string]string, error)
	AddVersion(db prefixer.Prefixer, versionID string) (string, error)
	AddArchive(db prefixer.Prefixer, archive *Archive) (string, error)
	AddMetadata(db prefixer.Prefixer, metadata *Metadata) (string, error)
	GetFile(db prefixer.Prefixer, key string) (string, error)
	GetThumb(db prefixer.Prefixer, key string) (string, error)
	GetVersion(db prefixer.Prefixer, key string) (string, error)
	GetArchive(db prefixer.Prefixer, key string) (*Archive, error)
	GetMetadata(db prefixer.Prefixer, key string) (*Metadata, error)
}

type ThumbFiler interface {
	io.Writer
	Abort() error
	Commit() error
}

type Thumbser interface {
	ThumbExists(img *FileDoc, format string) (ok bool, err error)
	CreateThumb(img *FileDoc, format string) (ThumbFiler, error)
	RemoveThumbs(img *FileDoc, formats []string) error
	ServeThumbContent(w http.ResponseWriter, req *http.Request,
		img *FileDoc, format string) error

	CreateNoteThumb(id, mime, format string) (ThumbFiler, error)
	OpenNoteThumb(id, format string) (io.ReadCloser, error)
	RemoveNoteThumb(id string, formats []string) error
	ServeNoteThumbContent(w http.ResponseWriter, req *http.Request, id string) error
}

type TrashJournal struct {
	FileIDs     []string `json:"ids"`
	ObjectNames []string `json:"objects"`
}

type Tree struct {
	Root    *TreeFile
	DirsMap map[string]*TreeFile
	Orphans map[string][]*TreeFile
	Files   map[string]struct{}
}

type TreeFile struct {
	DirOrFileDoc
	FilesChildren     []*TreeFile `json:"children,omitempty"`
	FilesChildrenSize int64       `json:"children_size,omitempty"`
	DirsChildren      []*TreeFile `json:"directories,omitempty"`

	IsDir    bool `json:"is_dir"`
	IsOrphan bool `json:"is_orphan"`
	HasCycle bool `json:"has_cycle"`
	HasPath  bool `json:"-"`
}

type UploadedByEntry struct {
	Slug    string            `json:"slug,omitempty"`
	Version string            `json:"version,omitempty"`
	Client  map[string]string `json:"oauthClient,omitempty"`
}

type VFS interface {
	Indexer
	DiskThresholder
	Fs

	// UseSharingIndexer returns a new Fs with an overloaded indexer that can
	// be used for the special purpose of the sharing.
	UseSharingIndexer(Indexer) VFS

	// GetIndexer returns the indexer without the overloaded operations from
	// VFSAfero / VFSSwift. Its result can be used for FilePatherWithCache with
	// a VFS that is already locked.
	GetIndexer() Indexer
}

type Version struct {
	DocID        string            `json:"_id,omitempty"`
	DocRev       string            `json:"_rev,omitempty"`
	UpdatedAt    time.Time         `json:"updated_at"`
	ByteSize     int64             `json:"size,string"`
	MD5Sum       []byte            `json:"md5sum"`
	Tags         []string          `json:"tags"`
	Metadata     Metadata          `json:"metadata,omitempty"`
	CozyMetadata FilesCozyMetadata `json:"cozyMetadata,omitempty"`
	Rels         struct {
		File struct {
			Data struct {
				ID   string `json:"_id"`
				Type string `json:"_type"`
			} `json:"data"`
		} `json:"file"`
	} `json:"relationships"`
}

type WalkFn func(name string, dir *DirDoc, file *FileDoc, err error) error