onedrive

package
v1.66.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 10, 2024 License: MIT Imports: 38 Imported by: 11

Documentation

Overview

Package onedrive provides an interface to the Microsoft OneDrive object storage system.

Index

Constants

This section is empty.

Variables

View Source 
var (

	// QuickXorHashType is the hash.Type for OneDrive
	QuickXorHashType hash.Type
)

Globals

Functions

func Config added in v1.56.0 

func Config(ctx context.Context, name string, m configmap.Mapper, config fs.ConfigIn) (*fs.ConfigOut, error)

Config the backend

func NewFs 

func NewFs(ctx context.Context, name, root string, m configmap.Mapper) (fs.Fs, error)

NewFs constructs an Fs from the path, container:path

Types

type Directory added in v1.66.0 

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

Directory describes a OneDrive directory

func (*Directory) Fs added in v1.66.0 

func (d *Directory) Fs() fs.Info

Fs returns read only access to the Fs that this object is part of

func (*Directory) ID added in v1.66.0 

func (d *Directory) ID() string

ID gets the optional ID

func (*Directory) Items added in v1.66.0 

func (d *Directory) Items() int64

Items returns the count of items in this directory or this directory and subdirectories if known, -1 for unknown

func (*Directory) Metadata added in v1.66.0 

func (d *Directory) Metadata(ctx context.Context) (metadata fs.Metadata, err error)

Metadata returns metadata for a DirEntry

It should return nil if there is no Metadata

func (*Directory) MimeType added in v1.66.0 

func (d *Directory) MimeType(ctx context.Context) string

MimeType returns the content type of the Object if known, or "" if not

func (*Directory) ModTime added in v1.66.0 

func (d *Directory) ModTime(ctx context.Context) time.Time

ModTime returns the modification date of the file

If one isn't available it returns the configured --default-dir-time

func (*Directory) Remote added in v1.66.0 

func (d *Directory) Remote() string

Remote returns the remote path

func (*Directory) SetMetadata added in v1.66.0 

func (d *Directory) SetMetadata(ctx context.Context, metadata fs.Metadata) error

SetMetadata sets metadata for a Directory

It should return fs.ErrorNotImplemented if it can't set metadata

func (*Directory) SetModTime added in v1.66.0 

func (d *Directory) SetModTime(ctx context.Context, t time.Time) error

SetModTime sets the metadata on the DirEntry to set the modification date

If there is any other metadata it does not overwrite it.

func (*Directory) Size added in v1.66.0 

func (d *Directory) Size() int64

Size returns the size of the file

func (*Directory) String added in v1.66.0 

func (d *Directory) String() string

String returns the name

type Fs 

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

Fs represents a remote OneDrive

func (*Fs) About 

func (f *Fs) About(ctx context.Context) (usage *fs.Usage, err error)

About gets quota information

func (*Fs) ChangeNotify added in v1.59.0 

func (f *Fs) ChangeNotify(ctx context.Context, 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.

The Onedrive implementation gives the whole hierarchy up to the top when an object is changed. For instance, if a/b/c is changed, this function will call notifyFunc with a, a/b and a/b/c.

func (*Fs) CleanUp added in v1.53.0 

func (f *Fs) CleanUp(ctx context.Context) error

CleanUp deletes all the hidden files.

func (*Fs) Copy 

func (f *Fs) Copy(ctx context.Context, 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(ctx context.Context, dirID, 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(ctx context.Context, 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) DirSetModTime added in v1.66.0 

func (f *Fs) DirSetModTime(ctx context.Context, dir string, modTime time.Time) error

DirSetModTime sets the directory modtime for dir

func (*Fs) Features 

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

Features returns the optional features of this Fs

func (*Fs) FindLeaf 

func (f *Fs) FindLeaf(ctx context.Context, 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(ctx context.Context, 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 added in v1.65.0 

func (f *Fs) ListR(ctx context.Context, 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 than doing a directory traversal.

func (*Fs) Mkdir 

func (f *Fs) Mkdir(ctx context.Context, dir string) error

Mkdir creates the container if it doesn't exist

func (*Fs) MkdirMetadata added in v1.66.0 

func (f *Fs) MkdirMetadata(ctx context.Context, dir string, metadata fs.Metadata) (fs.Directory, error)

MkdirMetadata makes the directory passed in as dir.

It shouldn't return an error if it already exists.

If the metadata is not nil it is set.

It returns the directory that was created.

func (*Fs) Move 

func (f *Fs) Move(ctx context.Context, 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(ctx context.Context, 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 return the precision of this Fs 

func (f *Fs) PublicLink(ctx context.Context, remote string, expire fs.Duration, unlink bool) (link string, err error)

PublicLink returns a link for downloading without account.

func (*Fs) Purge 

func (f *Fs) Purge(ctx context.Context, dir string) error

Purge deletes all the files in the directory

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(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

Put the object into the container

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) Rmdir 

func (f *Fs) Rmdir(ctx context.Context, dir string) error

Rmdir deletes the root folder

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) Shutdown added in v1.66.0 

func (f *Fs) Shutdown(ctx context.Context) error

Shutdown shutdown the fs

func (*Fs) String 

func (f *Fs) String() string

String converts this Fs to a string

type Metadata added in v1.66.0 

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

Metadata describes metadata properties shared by both Objects and Directories

func (*Metadata) Get added in v1.66.0 

func (m *Metadata) Get(ctx context.Context) (metadata fs.Metadata, err error)

Get retrieves the cached metadata and converts it to fs.Metadata. This is most typically used when OneDrive is the source (as opposed to the dest). If m.fs.opt.MetadataPermissions includes "read" then this will also include permissions, which requires an API call. Get does not use an API call otherwise.

func (*Metadata) RefreshPermissions added in v1.66.0 

func (m *Metadata) RefreshPermissions(ctx context.Context) (err error)

RefreshPermissions fetches the current permissions from the remote and caches them as Metadata

func (*Metadata) Set added in v1.66.0 

func (m *Metadata) Set(ctx context.Context, metadata fs.Metadata) (numSet int, err error)

Set takes fs.Metadata and parses/converts it to cached Metadata. This is most typically used when OneDrive is the destination (as opposed to the source). It does not actually update the remote (use Write for that.) It sets only the writeable metadata properties (i.e. read-only properties are skipped.) Permissions are included if m.fs.opt.MetadataPermissions includes "write". It returns errors if writeable properties can't be parsed. It does not return errors for unsupported properties that may be passed in. It returns the number of writeable properties set (if it is 0, we can skip the Write API call.)

func (*Metadata) Write added in v1.66.0 

func (m *Metadata) Write(ctx context.Context, updatePermissions bool) (*api.Item, error)

Write takes the cached Metadata and sets it on the remote, using API calls. If m.fs.opt.MetadataPermissions includes "write" and updatePermissions == true, permissions are also set. Calling Write without any writeable metadata will result in an error.

func (*Metadata) WritePermissions added in v1.66.0 

func (m *Metadata) WritePermissions(ctx context.Context) (err error)

WritePermissions sets the permissions (and no other metadata) on the remote. m.permissions (the existing perms) and m.queuedPermissions (the new perms to be set) must be set correctly before calling this. m.permissions == nil will not error, as it is valid to add permissions when there were previously none. If successful, m.permissions will be set with the new current permissions and m.queuedPermissions will be nil.

type Object 

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

Object describes a OneDrive object

Will definitely have info but maybe not meta

func (*Object) Fs 

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

Fs returns the parent Fs

func (*Object) Hash 

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

Hash returns the SHA-1 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) Metadata added in v1.66.0 

func (o *Object) Metadata(ctx context.Context) (metadata fs.Metadata, err error)

Metadata returns metadata for a DirEntry

It should return nil if there is no Metadata

func (*Object) MimeType 

func (o *Object) MimeType(ctx context.Context) string

MimeType of an Object if known, "" otherwise

func (*Object) ModTime 

func (o *Object) ModTime(ctx context.Context) 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(ctx context.Context, 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(ctx context.Context) error

Remove an object

func (*Object) SetModTime 

func (o *Object) SetModTime(ctx context.Context, modTime time.Time) error

SetModTime sets the modification time of the local 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 showing whether this object storable

func (*Object) String 

func (o *Object) String() string

Return a string version

func (*Object) Update 

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

Update the object with the contents of the io.Reader, modTime and size

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

type Options 

type Options struct {
	Region                  string               `config:"region"`
	ChunkSize               fs.SizeSuffix        `config:"chunk_size"`
	DriveID                 string               `config:"drive_id"`
	DriveType               string               `config:"drive_type"`
	RootFolderID            string               `config:"root_folder_id"`
	DisableSitePermission   bool                 `config:"disable_site_permission"`
	AccessScopes            fs.SpaceSepList      `config:"access_scopes"`
	ExposeOneNoteFiles      bool                 `config:"expose_onenote_files"`
	ServerSideAcrossConfigs bool                 `config:"server_side_across_configs"`
	ListChunk               int64                `config:"list_chunk"`
	NoVersions              bool                 `config:"no_versions"`
	LinkScope               string               `config:"link_scope"`
	LinkType                string               `config:"link_type"`
	LinkPassword            string               `config:"link_password"`
	HashType                string               `config:"hash_type"`
	AVOverride              bool                 `config:"av_override"`
	Delta                   bool                 `config:"delta"`
	Enc                     encoder.MultiEncoder `config:"encoding"`
	MetadataPermissions     rwChoice             `config:"metadata_permissions"`
}

Options defines the configuration for this backend

Source Files

View all Source files

Directories

Path Synopsis
Package api provides types used by the OneDrive API.
 Package api provides types used by the OneDrive API.
Package quickxorhash provides the quickXorHash algorithm which is a quick, simple non-cryptographic hash algorithm that works by XORing the bytes in a circular-shifting fashion.
 Package quickxorhash provides the quickXorHash algorithm which is a quick, simple non-cryptographic hash algorithm that works by XORing the bytes in a circular-shifting fashion.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.