cloudstorage

type AccessLevel int

type AuthMethod string

type Config struct {
	// Type is StoreType [gcs,localfs,s3,azure]
	Type string
	// AuthMethod the methods of authenticating store.  Ie, where/how to
	// find auth tokens.
	AuthMethod AuthMethod
	// Cloud Bucket Project
	Project string
	// Region is the cloud region
	Region string
	// Endpoint is the api endpoint
	Endpoint string
	// Bucket is the "path" or named bucket in cloud
	Bucket string
	// the page size to use with api requests (default 1000)
	PageSize int
	// used by JWTKeySource
	JwtConf *JwtConf
	// JwtFile is the file-path to local auth-token file.
	JwtFile string `json:"jwtfile,omitempty"`
	// BaseUrl is the base-url path for customizing regions etc.  IE
	// AWS has different url paths per region on some situations.
	BaseUrl string `json:"baseurl,omitempty"`
	// Permissions scope
	Scope string `json:"scope,omitempty"`
	// LocalFS is filesystem path to use for the local files
	// for Type=localfs
	LocalFS string `json:"localfs,omitempty"`
	// The filesystem path to save locally cached files as they are
	// being read/written from cloud and need a staging area.
	TmpDir string `json:"tmpdir,omitempty"`
	// Settings are catch-all-bag to allow per-implementation over-rides
	Settings gou.JsonHelper `json:"settings,omitempty"`
	// LogPrefix Logging Prefix/Context message
	LogPrefix string
	// EnableCompression turns on transparent compression of objects
	// Reading pre-existing non-compressed objects continues to work
	EnableCompression bool `json:"enablecompression,omitempty"`
}

type Filter func(objects Objects) Objects

type JwtConf struct {
	// Unfortuneately we departed from the standard jwt service account field-naming
	// for reasons we forgot.  So, during load, we convert from bad->correct format.
	PrivateKeyDeprecated string `json:"private_keybase64,omitempty"`
	KeyTypeDeprecated    string `json:"keytype,omitempty"`

	// Jwt Service Account Fields
	ProjectID    string `json:"project_id,omitempty"`
	PrivateKeyID string `json:"private_key_id,omitempty"`
	PrivateKey   string `json:"private_key,omitempty"`
	ClientEmail  string `json:"client_email,omitempty"`
	ClientID     string `json:"client_id,omitempty"`
	Type         string `json:"type,omitempty"`
	// Scopes is list of what scope to use when the token is created.
	// for example https://github.com/google/google-api-go-client/blob/0d3983fb069cb6651353fc44c5cb604e263f2a93/storage/v1/storage-gen.go#L54
	Scopes []string `json:"scopes,omitempty"`
}

type Object interface {
	// Name of object/file.
	Name() string
	// String is default descriptor.
	String() string
	// Updated timestamp.
	Updated() time.Time
	// MetaData is map of arbitrary name/value pairs about object.
	MetaData() map[string]string
	// SetMetaData allows you to set key/value pairs.
	SetMetaData(meta map[string]string)
	// StorageSource is the type of store.
	StorageSource() string
	// Open copies the remote file to a local cache and opens the cached version
	// for read/writing.  Calling Close/Sync will push the copy back to the
	// backing store.
	Open(readonly AccessLevel) (*os.File, error)
	// Release will remove the locally cached copy of the file.  You most call Close
	// before releasing.  Release will call os.Remove(local_copy_file) so opened
	// filehandles need to be closed.
	Release() error
	// Implement io.ReadWriteCloser Open most be called before using these
	// functions.
	Read(p []byte) (n int, err error)
	Write(p []byte) (n int, err error)
	Sync() error
	Close() error
	// File returns the cached/local copy of the file
	File() *os.File
	// Delete removes the object from the cloud store and local cache.
	Delete() error
}

type ObjectIterator interface {
	// Next gets next object, returns google.golang.org/api/iterator iterator.Done error.
	Next() (Object, error)
	// Close this down (and or context.Close)
	Close()
}

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

type Objects []Object

type ObjectsResponse struct {
	Objects    Objects
	NextMarker string
}

type Opts struct {
	IfNotExists bool
}

type Query struct {
	Delimiter   string   // Delimiter is most likely "/"
	Prefix      string   // prefix (directory) to search for or object name if one file
	StartOffset string   // (gcs/localfs only) "bar/", Only list objects lexicographically >= "bar/"
	EndOffset   string   // (gcs/localfs only) "foo/", Only list objects lexicographically < "foo/"
	Marker      string   // Next Page Marker if provided is a start next page fetch bookmark.
	ShowHidden  bool     // Show hidden files?
	Filters     []Filter // Applied to the result sets to filter out Objects (i.e. remove objects by extension)
	PageSize    int      // PageSize defaults to global, or you can supply an override
}

type Store interface {
	StoreReader

	// NewWriter returns a io.Writer that writes to a Cloud object
	// associated with this backing Store object.
	//
	// A new object will be created if an object with this name already exists.
	// Otherwise any previous object with the same name will be replaced.
	// The object will not be available (and any previous object will remain)
	// until Close has been called
	NewWriter(o string, metadata map[string]string) (io.WriteCloser, error)
	// NewWriter but with context.
	NewWriterWithContext(ctx context.Context, o string, metadata map[string]string, opts ...Opts) (io.WriteCloser, error)

	// NewObject creates a new empty object backed by the cloud store
	// This new object isn't' synced/created in the backing store
	// until the object is Closed/Sync'ed.
	NewObject(o string) (Object, error)

	// Delete removes the object from the cloud store.
	Delete(ctx context.Context, o string) error
}

type StoreCopy interface {
	// Copy from object, to object
	Copy(ctx context.Context, src, dst Object) error
}

type StoreMove interface {
	// Move from object location, to object location.
	Move(ctx context.Context, src, dst Object) error
}

type StoreProvider func(*Config) (Store, error)

type StoreReader interface {
	// Type is he Store Type [google, s3, azure, localfs, etc]
	Type() string
	// Client gets access to the underlying native Client for Google, S3, etc
	Client() interface{}
	// Get returns an object (file) from the cloud store. The object
	// isn't opened already, see Object.Open()
	// ObjectNotFound will be returned if the object is not found.
	Get(ctx context.Context, o string) (Object, error)
	// Objects returns an object Iterator to allow paging through object
	// which keeps track of page cursors.  Query defines the specific set
	// of filters to apply to request.
	Objects(ctx context.Context, q Query) (ObjectIterator, error)
	// List file/objects filter by given query.  This just wraps the object-iterator
	// returning full list of objects.
	List(ctx context.Context, q Query) (*ObjectsResponse, error)
	// Folders creates list of folders
	Folders(ctx context.Context, q Query) ([]string, error)
	// NewReader creates a new Reader to read the contents of the object.
	// ErrObjectNotFound will be returned if the object is not found.
	NewReader(o string) (io.ReadCloser, error)
	// NewReader with context (for cancelation, etc)
	NewReaderWithContext(ctx context.Context, o string) (io.ReadCloser, error)
	// String default descriptor.
	String() string
}