stash/pkg/file/fs.go

package file

import (
	"io"
	"io/fs"
	"os"

	"github.com/stashapp/stash/pkg/fsutil"
)

// Opener provides an interface to open a file.
type Opener interface {
	Open() (io.ReadCloser, error)
}

type fsOpener struct {
	fs   FS
	name string
}

func (o *fsOpener) Open() (io.ReadCloser, error) {
	return o.fs.Open(o.name)
}

// FS represents a file system.
type FS interface {
	Stat(name string) (fs.FileInfo, error)
	Lstat(name string) (fs.FileInfo, error)
	Open(name string) (fs.ReadDirFile, error)
	OpenZip(name string) (*ZipFS, error)
	IsPathCaseSensitive(path string) (bool, error)
}

// OsFS is a file system backed by the OS.
type OsFS struct{}

func (f *OsFS) Create(name string) (*os.File, error) {
	return os.Create(name)
}

func (f *OsFS) MkdirAll(path string, perm fs.FileMode) error {
	return os.MkdirAll(path, perm)
}

func (f *OsFS) Remove(name string) error {
	return os.Remove(name)
}

func (f *OsFS) Rename(oldpath, newpath string) error {
	return os.Rename(oldpath, newpath)
}

func (f *OsFS) RemoveAll(path string) error {
	return os.RemoveAll(path)
}

func (f *OsFS) Stat(name string) (fs.FileInfo, error) {
	return os.Stat(name)
}

func (f *OsFS) Lstat(name string) (fs.FileInfo, error) {
	return os.Lstat(name)
}

func (f *OsFS) Open(name string) (fs.ReadDirFile, error) {
	return os.Open(name)
}

func (f *OsFS) OpenZip(name string) (*ZipFS, error) {
	info, err := f.Lstat(name)
	if err != nil {
		return nil, err
	}

	return newZipFS(f, name, info)
}

func (f *OsFS) IsPathCaseSensitive(path string) (bool, error) {
	return fsutil.IsFsPathCaseSensitive(path)
}