storage

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

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

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

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

type NewStorageFunc func(ctx context.Context, cfg *setting.Storage) (ObjectStorage, error)

type Object interface {
	io.ReadCloser
	io.Seeker
	Stat() (os.FileInfo, error)
}

type ObjectStorage interface {
	Open(path string) (Object, error)

	// Save store an object, if size is unknown set -1
	// NOTICE: Some storage SDK will close the Reader after saving if it is also a Closer,
	// DO NOT use the reader anymore after Save, or wrap it to a non-Closer reader.
	Save(path string, r io.Reader, size int64) (int64, error)

	Stat(path string) (os.FileInfo, error)
	Delete(path string) error

	// ServeDirectURL generates a "serve-direct" URL for the specified blob storage file,
	// end user (browser) will use this URL to access the file directly from the object storage, bypassing Gitea server.
	// Usually the link is time-limited (a few minutes) and contains a signature to ensure security.
	// The generated URL must NOT use the same origin as Gitea server, otherwise it will cause security issues.
	// * method defines which HTTP method is permitted for certain storage providers (e.g., MinIO).
	// * opt allows customizing the Content-Type and Content-Disposition headers.
	// TODO: need to merge "ServeDirect()" check into this function, avoid duplicate code and potential inconsistency.
	ServeDirectURL(path, name, method string, opt *ServeDirectOptions) (*url.URL, error)

	// IterateObjects calls the iterator function for each object in the storage with the given path as prefix
	// The "fullPath" argument in callback is the full path in this storage.
	// * IterateObjects("", ...): iterate all objects in this storage
	// * IterateObjects("sub-path", ...): iterate all objects with "sub-path" as prefix in this storage, the "fullPath" will be like "sub-path/xxx"
	IterateObjects(basePath string, iterator func(fullPath string, obj Object) error) error
}

type ServeDirectOptions struct {
	// Overrides the automatically detected MIME type.
	ContentType string
}

type Type = setting.StorageType