filestorage

Documentation

Index

• Variables
• func Join(parts ...string) string
• type File
  • func (f *File) IsFolder() bool
• type FileMetadata
• type FileStorage
  • func NewCdkBlobStorage(log log.Logger, bucket *blob.Bucket, rootFolder string, ...) FileStorage
  • func NewDbStorage(log log.Logger, db *sqlstore.SQLStore, pathFilters *PathFilters, ...) FileStorage
• type ListOptions
• type ListResponse
• type Paging
• type PathFilters
  • func NewPathFilters(allowedPrefixes []string, allowedPaths []string, disallowedPrefixes []string, ...) *PathFilters
  • func (f *PathFilters) IsAllowed(path string) bool
• type UpsertFileCommand

Variables

var (
	ErrRelativePath          = errors.New("path cant be relative")
	ErrNonCanonicalPath      = errors.New("path must be canonical")
	ErrPathTooLong           = errors.New("path is too long")
	ErrPathInvalid           = errors.New("path is invalid")
	ErrPathEndsWithDelimiter = errors.New("path can not end with delimiter")
	Delimiter                = "/"
	DirectoryMimeType        = "directory"
)

Functions

func Join

func Join(parts ...string) string

Types

type File

type File struct {
	Contents []byte
	FileMetadata
}

func (*File) IsFolder

func (f *File) IsFolder() bool

type FileMetadata

type FileMetadata struct {
	Name       string
	FullPath   string
	MimeType   string
	Modified   time.Time
	Created    time.Time
	Size       int64
	Properties map[string]string
}

type FileStorage

type FileStorage interface {
	Get(ctx context.Context, path string) (*File, error)
	Delete(ctx context.Context, path string) error
	Upsert(ctx context.Context, command *UpsertFileCommand) error

	// List lists only files without content by default
	List(ctx context.Context, folderPath string, paging *Paging, options *ListOptions) (*ListResponse, error)

	CreateFolder(ctx context.Context, path string) error
	DeleteFolder(ctx context.Context, path string) error
	// contains filtered or unexported methods
}

func NewCdkBlobStorage

func NewCdkBlobStorage(log log.Logger, bucket *blob.Bucket, rootFolder string, pathFilters *PathFilters) FileStorage

func NewDbStorage

func NewDbStorage(log log.Logger, db *sqlstore.SQLStore, pathFilters *PathFilters, rootFolder string) FileStorage

type ListOptions

type ListOptions struct {
	Recursive    bool
	WithFiles    bool
	WithFolders  bool
	WithContents bool
	*PathFilters
}

type ListResponse

type ListResponse struct {
	Files    []*File
	HasMore  bool
	LastPath string
}

type Paging

type Paging struct {
	After string
	First int
}

type PathFilters

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

func NewPathFilters

func NewPathFilters(allowedPrefixes []string, allowedPaths []string, disallowedPrefixes []string, disallowedPaths []string) *PathFilters

func (*PathFilters) IsAllowed

func (f *PathFilters) IsAllowed(path string) bool

type UpsertFileCommand

type UpsertFileCommand struct {
	Path       string
	MimeType   string
	Contents   *[]byte
	Properties map[string]string
}