mediafiles

Documentation

Index

• Variables
• func Delete(path string) error
• func Exists(path string) (bool, error)
• func GetAlternateName(fileRoot, fileExt string) string
• func GetAvailableName(path string, retries int, max_length int) (string, error)
• func ListDir(path string) ([]string, error)
• func RegisterBackend(name string, backend Backend)
• func Save(path string, file io.Reader, maxLength ...int) (string, error)
• type Backend
  • func RetrieveBackend(name string) (Backend, bool)
  • func SetDefault(backend string) Backend
• type File
• type FileHeader
  • func Stat(path string) (FileHeader, error)
• type SimpleStoredObject
  • func (s *SimpleStoredObject) Name() string
  • func (s *SimpleStoredObject) Open() (File, error)
  • func (s *SimpleStoredObject) Path() string
  • func (s *SimpleStoredObject) Scan(value interface{}) error
  • func (s *SimpleStoredObject) String() string
  • func (s *SimpleStoredObject) Value() (driver.Value, error)
• type StoredObject
  • func Open(path string) (StoredObject, error)

Variables

var (
	// ErrNotImplemented is returned when an operation is not supported by the storage backend.
	ErrNotImplemented = errs.Error("unsupported operation for this storage backend")

	// ErrNotFound is returned when a file is not found.
	ErrNotFound = os.ErrNotExist

	// ErrExists is returned when a file already exists.
	ErrExists = os.ErrExist

	// ErrSuspiciousOperation is returned when an operation is considered suspicious.
	// For example, when a file is too large to be saved.
	ErrSuspiciousOperation = os.ErrInvalid
)

Functions

func Delete

func Delete(path string) error

Deletes the file referenced by name. If deletion is not supported on the target storage system this will return ErrNotImplemented.

func Exists

func Exists(path string) (bool, error)

Returns True if a file referenced by the given name already exists in the storage system.

func GetAlternateName

func GetAlternateName(fileRoot, fileExt string) string

Returns an alternative filename based on the file_root and file_ext parameters, an underscore plus a random 7 character alphanumeric string is appended to the filename before the extension.

func GetAvailableName

func GetAvailableName(path string, retries int, max_length int) (string, error)

Returns a filename based on the name parameter that’s free and available for new content to be written to on the target storage system.

The length of the filename will not exceed max_length, if provided. If a free unique filename cannot be found, ErrSuspiciousOperation will be returned.

func ListDir

func ListDir(path string) ([]string, error)

Lists the contents of the specified path, returning a 2-tuple of lists; the first item being directories, the second item being files. For storage systems that aren’t able to provide such a listing, this will return ErrNotImplemented.

func RegisterBackend

func RegisterBackend(name string, backend Backend)

func Save

func Save(path string, file io.Reader, maxLength ...int) (string, error)

Saves a new file using the storage system, preferably with the name specified. If there already exists a file with this name name, the storage system may modify the filename as necessary to get a unique name. The actual name of the stored file will be returned.

The maxLength parameter is passed to GetAvailableName() and is used to limit the length of the filename before saving. If the file is too large to be saved, this will raise a SuspiciousOperation exception.

Types

type Backend

type Backend interface {
	// Deletes the file referenced by name. If deletion is not supported on the target storage system this will return ErrNotImplemented.
	Delete(path string) error

	// Returns True if a file referenced by the given name already exists in the storage system.
	Exists(path string) (bool, error)

	// Returns an alternative filename based on the file_root and file_ext parameters, an underscore plus a random 7 character alphanumeric string is appended to the filename before the extension.
	GetAlternateName(fileRoot, fileExt string) string

	// Returns a filename based on the name parameter that’s free and available for new content to be written to on the target storage system.
	//
	// The length of the filename will not exceed max_length, if provided. If a free unique filename cannot be found, ErrSuspiciousOperation will be returned.
	GetAvailableName(path string, retries, maxLength int) (string, error)

	// Stat returns the FileInfo structure describing the file.
	Stat(path string) (FileHeader, error)

	// Lists the contents of the specified path, returning a 2-tuple of lists; the first item being directories, the second item being files.
	// For storage systems that aren’t able to provide such a listing, this will return ErrNotImplemented.
	ListDir(path string) ([]string, error)

	// Opens the file given by name. Note that although the returned file is guaranteed to be a StoredObject interface object, it might actually be some subclass.
	// In the case of remote file storage this means that reading/writing could be quite slow, so be warned.
	Open(path string) (StoredObject, error)

	// Saves a new file using the storage system, preferably with the name specified. If there already exists a file with this name name, the storage system may modify the filename as necessary to get a unique name.
	// The actual name of the stored file will be returned.
	//
	// The maxLength parameter is passed to GetAvailableName() and is used to limit the length of the filename before saving.
	// If the file is too large to be saved, this will raise a SuspiciousOperation exception.
	Save(path string, file io.Reader, maxLength ...int) (string, error)
}

func RetrieveBackend

func RetrieveBackend(name string) (Backend, bool)

func SetDefault

func SetDefault(backend string) Backend

type File

type File interface {
	// Reads content from the file.
	io.Reader

	// Closes the file.
	io.Closer

	// Returns the file header.
	Stat() (FileHeader, error)
}

type FileHeader

type FileHeader interface {
	Name() string
	Path() string
	Size() int64

	// Returns the time the file was last accessed.
	//
	// If the backend storage system does not support this operation, err will be ErrNotImplemented.
	TimeAccessed() (t time.Time, err error)

	// Returns the time the file was created.
	//
	// If the backend storage system does not support this operation, err will be ErrNotImplemented.
	TimeCreated() (t time.Time, err error)

	// Returns the time the file was last modified.
	//
	// If the file was never modified, the returned time will be the same as the time the file was created.
	//
	// If the backend storage system does not support this operation, err will be ErrNotImplemented.
	TimeModified() (t time.Time, err error)
}

func Stat

func Stat(path string) (FileHeader, error)

Returns the file header for the file referenced by path.

type SimpleStoredObject

type SimpleStoredObject struct {
	Filepath string
	OpenFn   func(path string) (File, error)
}

func (*SimpleStoredObject) Name

func (s *SimpleStoredObject) Name() string

func (*SimpleStoredObject) Open

func (s *SimpleStoredObject) Open() (File, error)

func (*SimpleStoredObject) Path

func (s *SimpleStoredObject) Path() string

func (*SimpleStoredObject) Scan

func (s *SimpleStoredObject) Scan(value interface{}) error

func (*SimpleStoredObject) String

func (s *SimpleStoredObject) String() string

func (*SimpleStoredObject) Value

func (s *SimpleStoredObject) Value() (driver.Value, error)

type StoredObject

type StoredObject interface {
	// Returns the name of the file, excluding path information.
	Name() string

	// Returns the full path of the file.
	Path() string

	// Returns the size of the file in bytes.
	Open() (File, error)
}

func Open

func Open(path string) (StoredObject, error)

Opens the file given by name. Note that although the returned file is guaranteed to be a StoredObject interface object, it might actually be some subclass. In the case of remote file storage this means that reading/writing could be quite slow, so be warned.