drive

Documentation

Overview

Package drive interfaces with the Google Drive object storage system

Index

• func NewFs(name, path string, m configmap.Mapper) (fs.Fs, error)
• type Fs
  • func (f *Fs) About() (*fs.Usage, error)
  • func (f *Fs) ChangeNotify(notifyFunc func(string, fs.EntryType), pollIntervalChan <-chan time.Duration)
  • func (f *Fs) CleanUp() error
  • func (f *Fs) Copy(src fs.Object, remote string) (fs.Object, error)
  • func (f *Fs) CreateDir(pathID, leaf string) (newID string, err error)
  • func (f *Fs) DirCacheFlush()
  • func (f *Fs) DirMove(src fs.Fs, srcRemote, dstRemote string) error
  • func (f *Fs) Features() *fs.Features
  • func (f *Fs) FindLeaf(pathID, leaf string) (pathIDOut string, found bool, err error)
  • func (f *Fs) Hashes() hash.Set
  • func (f *Fs) List(dir string) (entries fs.DirEntries, err error)
  • func (f *Fs) ListR(dir string, callback fs.ListRCallback) (err error)
  • func (f *Fs) MergeDirs(dirs []fs.Directory) error
  • func (f *Fs) Mkdir(dir string) error
  • func (f *Fs) Move(src fs.Object, remote string) (fs.Object, error)
  • func (f *Fs) Name() string
  • func (f *Fs) NewObject(remote string) (fs.Object, error)
  • func (f *Fs) Precision() time.Duration
  • func (f *Fs) PublicLink(remote string) (link string, err error)
  • func (f *Fs) Purge() error
  • func (f *Fs) Put(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
  • func (f *Fs) PutStream(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
  • func (f *Fs) PutUnchecked(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
  • func (f *Fs) Rmdir(dir string) error
  • func (f *Fs) Root() string
  • func (f *Fs) ShouldSupportTeamDrives(src fs.Object) (bool, error)
  • func (f *Fs) String() string
  • func (f *Fs) Upload(in io.Reader, size int64, contentType, fileID, remote string, info *drive.File) (*drive.File, error)
• type Object
  • func (o *Object) Fs() fs.Info
  • func (o *Object) Hash(t hash.Type) (string, error)
  • func (o *Object) ID() string
  • func (o *Object) MimeType() string
  • func (o *Object) ModTime() time.Time
  • func (o *Object) Open(options ...fs.OpenOption) (in io.ReadCloser, err error)
  • func (o *Object) Remote() string
  • func (o *Object) Remove() error
  • func (o *Object) SetModTime(modTime time.Time) error
  • func (o *Object) Size() int64
  • func (o *Object) Storable() bool
  • func (o *Object) String() string
  • func (o *Object) Update(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) error
• type Options

Functions

func NewFs

func NewFs(name, path string, m configmap.Mapper) (fs.Fs, error)

NewFs constructs an Fs from the path, container:path

Types

type Fs

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

Fs represents a remote drive server

func (*Fs) About

func (f *Fs) About() (*fs.Usage, error)

About gets quota information

func (*Fs) ChangeNotify

func (f *Fs) ChangeNotify(notifyFunc func(string, fs.EntryType), pollIntervalChan <-chan time.Duration)

ChangeNotify calls the passed function with a path that has had changes. If the implementation uses polling, it should adhere to the given interval.

Automatically restarts itself in case of unexpected behavior of the remote.

Close the returned channel to stop being notified.

func (*Fs) CleanUp

func (f *Fs) CleanUp() error

CleanUp empties the trash

func (*Fs) Copy

func (f *Fs) Copy(src fs.Object, remote string) (fs.Object, error)

Copy src to this remote using server side copy operations.

This is stored with the remote path given

It returns the destination Object and a possible error

Will only be called if src.Fs().Name() == f.Name()

If it isn't possible then return fs.ErrorCantCopy

func (*Fs) CreateDir

func (f *Fs) CreateDir(pathID, leaf string) (newID string, err error)

CreateDir makes a directory with pathID as parent and name leaf

func (*Fs) DirCacheFlush

func (f *Fs) DirCacheFlush()

DirCacheFlush resets the directory cache - used in testing as an optional interface

func (*Fs) DirMove

func (f *Fs) DirMove(src fs.Fs, srcRemote, dstRemote string) error

DirMove moves src, srcRemote to this remote at dstRemote using server side move operations.

Will only be called if src.Fs().Name() == f.Name()

If it isn't possible then return fs.ErrorCantDirMove

If destination exists then return fs.ErrorDirExists

func (*Fs) Features

func (f *Fs) Features() *fs.Features

Features returns the optional features of this Fs

func (*Fs) FindLeaf

func (f *Fs) FindLeaf(pathID, leaf string) (pathIDOut string, found bool, err error)

FindLeaf finds a directory of name leaf in the folder with ID pathID

func (*Fs) Hashes

func (f *Fs) Hashes() hash.Set

Hashes returns the supported hash sets.

func (*Fs) List

func (f *Fs) List(dir string) (entries fs.DirEntries, err error)

List the objects and directories in dir into entries. The entries can be returned in any order but should be for a complete directory.

dir should be "" to list the root, and should not have trailing slashes.

This should return ErrDirNotFound if the directory isn't found.

func (*Fs) ListR

func (f *Fs) ListR(dir string, callback fs.ListRCallback) (err error)

ListR lists the objects and directories of the Fs starting from dir recursively into out.

dir should be "" to start from the root, and should not have trailing slashes.

This should return ErrDirNotFound if the directory isn't found.

It should call callback for each tranche of entries read. These need not be returned in any particular order. If callback returns an error then the listing will stop immediately.

Don't implement this unless you have a more efficient way of listing recursively that doing a directory traversal.

func (*Fs) MergeDirs

func (f *Fs) MergeDirs(dirs []fs.Directory) error

MergeDirs merges the contents of all the directories passed in into the first one and rmdirs the other directories.

func (*Fs) Mkdir

func (f *Fs) Mkdir(dir string) error

Mkdir creates the container if it doesn't exist

func (*Fs) Move

func (f *Fs) Move(src fs.Object, remote string) (fs.Object, error)

Move src to this remote using server side move operations.

This is stored with the remote path given

It returns the destination Object and a possible error

Will only be called if src.Fs().Name() == f.Name()

If it isn't possible then return fs.ErrorCantMove

func (*Fs) Name

func (f *Fs) Name() string

Name of the remote (as passed into NewFs)

func (*Fs) NewObject

func (f *Fs) NewObject(remote string) (fs.Object, error)

NewObject finds the Object at remote. If it can't be found it returns the error fs.ErrorObjectNotFound.

func (*Fs) Precision

func (f *Fs) Precision() time.Duration

Precision of the object storage system

func (*Fs) PublicLink

func (f *Fs) PublicLink(remote string) (link string, err error)

PublicLink adds a "readable by anyone with link" permission on the given file or folder.

func (*Fs) Purge

func (f *Fs) Purge() error

Purge deletes all the files and the container

Optional interface: Only implement this if you have a way of deleting all the files quicker than just running Remove() on the result of List()

func (*Fs) Put

func (f *Fs) Put(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

Put the object

Copy the reader in to the new object which is returned

The new object may have been created if an error is returned

func (*Fs) PutStream

func (f *Fs) PutStream(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

PutStream uploads to the remote path with the modTime given of indeterminate size

func (*Fs) PutUnchecked

func (f *Fs) PutUnchecked(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

PutUnchecked uploads the object

This will create a duplicate if we upload a new file without checking to see if there is one already - use Put() for that.

func (*Fs) Rmdir

func (f *Fs) Rmdir(dir string) error

Rmdir deletes a directory

Returns an error if it isn't empty

func (*Fs) Root

func (f *Fs) Root() string

Root of the remote (as passed into NewFs)

func (*Fs) ShouldSupportTeamDrives

func (f *Fs) ShouldSupportTeamDrives(src fs.Object) (bool, error)

ShouldSupportTeamDrives returns the request should support TeamDrives

func (*Fs) String

func (f *Fs) String() string

String converts this Fs to a string

func (*Fs) Upload

func (f *Fs) Upload(in io.Reader, size int64, contentType, fileID, remote string, info *drive.File) (*drive.File, error)

Upload the io.Reader in of size bytes with contentType and info

type Object

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

Object describes a drive object

func (*Object) Fs

func (o *Object) Fs() fs.Info

Fs returns the parent Fs

func (*Object) Hash

func (o *Object) Hash(t hash.Type) (string, error)

Hash returns the Md5sum of an object returning a lowercase hex string

func (*Object) ID

func (o *Object) ID() string

ID returns the ID of the Object if known, or "" if not

func (*Object) MimeType

func (o *Object) MimeType() string

MimeType of an Object if known, "" otherwise

func (*Object) ModTime

func (o *Object) ModTime() time.Time

ModTime returns the modification time of the object

It attempts to read the objects mtime and if that isn't present the LastModified returned in the http headers

func (*Object) Open

func (o *Object) Open(options ...fs.OpenOption) (in io.ReadCloser, err error)

Open an object for read

func (*Object) Remote

func (o *Object) Remote() string

Remote returns the remote path

func (*Object) Remove

func (o *Object) Remove() error

Remove an object

func (*Object) SetModTime

func (o *Object) SetModTime(modTime time.Time) error

SetModTime sets the modification time of the drive fs object

func (*Object) Size

func (o *Object) Size() int64

Size returns the size of an object in bytes

func (*Object) Storable

func (o *Object) Storable() bool

Storable returns a boolean as to whether this object is storable

func (*Object) String

func (o *Object) String() string

Return a string version

func (*Object) Update

func (o *Object) Update(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) error

Update the already existing object

Copy the reader into the object updating modTime and size

The new object may have been created if an error is returned

type Options

type Options struct {
	Scope                     string        `config:"scope"`
	RootFolderID              string        `config:"root_folder_id"`
	ServiceAccountFile        string        `config:"service_account_file"`
	ServiceAccountCredentials string        `config:"service_account_credentials"`
	TeamDriveID               string        `config:"team_drive"`
	AuthOwnerOnly             bool          `config:"auth_owner_only"`
	UseTrash                  bool          `config:"use_trash"`
	SkipGdocs                 bool          `config:"skip_gdocs"`
	SkipChecksumGphotos       bool          `config:"skip_checksum_gphotos"`
	SharedWithMe              bool          `config:"shared_with_me"`
	TrashedOnly               bool          `config:"trashed_only"`
	Extensions                string        `config:"formats"`
	ExportExtensions          string        `config:"export_formats"`
	ImportExtensions          string        `config:"import_formats"`
	AllowImportNameChange     bool          `config:"allow_import_name_change"`
	UseCreatedDate            bool          `config:"use_created_date"`
	ListChunk                 int64         `config:"list_chunk"`
	Impersonate               string        `config:"impersonate"`
	AlternateExport           bool          `config:"alternate_export"`
	UploadCutoff              fs.SizeSuffix `config:"upload_cutoff"`
	ChunkSize                 fs.SizeSuffix `config:"chunk_size"`
	AcknowledgeAbuse          bool          `config:"acknowledge_abuse"`
	KeepRevisionForever       bool          `config:"keep_revision_forever"`
	V2DownloadMinSize         fs.SizeSuffix `config:"v2_download_min_size"`
	PacerMinSleep             fs.Duration   `config:"pacer_min_sleep"`
	PacerBurst                int           `config:"pacer_burst"`
}

Options defines the configuration for this backend