2015-09-22 17:47:16 +00:00
// Package drive interfaces with the Google Drive object storage system
2013-06-27 19:13:07 +00:00
package drive
2013-01-14 23:38:18 +00:00
// FIXME need to deal with some corner cases
// * multiple files with the same name
// * files can be in multiple directories
// * can have directory loops
2013-01-20 11:56:56 +00:00
// * files with / in name
2013-01-14 23:38:18 +00:00
import (
2018-07-26 13:45:41 +00:00
"bytes"
2013-01-14 23:38:18 +00:00
"fmt"
"io"
2017-11-29 21:34:19 +00:00
"io/ioutil"
2015-08-18 07:55:09 +00:00
"log"
2018-02-07 11:53:46 +00:00
"mime"
2013-01-14 23:38:18 +00:00
"net/http"
2018-01-23 23:46:41 +00:00
"net/url"
2017-11-29 21:34:19 +00:00
"os"
2016-11-25 21:52:43 +00:00
"path"
2017-07-06 14:32:57 +00:00
"strconv"
2013-01-14 23:38:18 +00:00
"strings"
2018-01-31 20:03:02 +00:00
"sync"
2018-08-21 10:51:36 +00:00
"text/template"
2013-01-14 23:38:18 +00:00
"time"
2014-03-15 16:06:11 +00:00
"github.com/ncw/rclone/fs"
2018-01-12 16:30:54 +00:00
"github.com/ncw/rclone/fs/config"
2018-05-14 17:06:57 +00:00
"github.com/ncw/rclone/fs/config/configmap"
"github.com/ncw/rclone/fs/config/configstruct"
2018-01-18 20:19:55 +00:00
"github.com/ncw/rclone/fs/config/obscure"
2018-01-12 16:30:54 +00:00
"github.com/ncw/rclone/fs/fserrors"
"github.com/ncw/rclone/fs/fshttp"
"github.com/ncw/rclone/fs/hash"
2018-07-26 13:45:41 +00:00
"github.com/ncw/rclone/fs/walk"
2018-01-11 16:29:20 +00:00
"github.com/ncw/rclone/lib/dircache"
"github.com/ncw/rclone/lib/oauthutil"
"github.com/ncw/rclone/lib/pacer"
2016-06-12 14:06:02 +00:00
"github.com/pkg/errors"
2016-06-12 14:06:27 +00:00
"golang.org/x/oauth2"
"golang.org/x/oauth2/google"
2018-09-18 10:29:05 +00:00
drive_v2 "google.golang.org/api/drive/v2"
2018-03-28 18:33:39 +00:00
drive "google.golang.org/api/drive/v3"
2016-06-12 14:06:27 +00:00
"google.golang.org/api/googleapi"
2014-03-15 16:06:11 +00:00
)
2013-06-29 11:15:31 +00:00
2014-03-16 14:01:17 +00:00
// Constants
const (
2016-02-28 19:57:19 +00:00
rcloneClientID = "202264815644.apps.googleusercontent.com"
2016-08-14 11:04:43 +00:00
rcloneEncryptedClientSecret = "eX8GpZTVx3vxMWVkuuBdDWmAUE6rGhTwVrvG9GhllYccSdj2-mvHVg"
2016-02-28 19:57:19 +00:00
driveFolderType = "application/vnd.google-apps.folder"
timeFormatIn = time . RFC3339
timeFormatOut = "2006-01-02T15:04:05.000000000Z07:00"
minSleep = 10 * time . Millisecond
2018-08-19 14:16:11 +00:00
defaultExportExtensions = "docx,xlsx,pptx,svg"
2018-01-23 13:36:20 +00:00
scopePrefix = "https://www.googleapis.com/auth/"
defaultScope = "drive"
2018-05-14 17:06:57 +00:00
// chunkSize is the size of the chunks created during a resumable upload and should be a power of two.
// 1<<18 is the minimum size supported by the Google uploader, and there is no maximum.
defaultChunkSize = fs . SizeSuffix ( 8 * 1024 * 1024 )
2018-09-01 11:16:01 +00:00
partialFields = "id,name,size,md5Checksum,trashed,modifiedTime,createdTime,mimeType,parents,webViewLink"
2014-03-16 14:01:17 +00:00
)
// Globals
var (
2014-07-13 16:53:11 +00:00
// Description of how to auth for this app
2015-08-18 07:55:09 +00:00
driveConfig = & oauth2 . Config {
2018-01-23 13:36:20 +00:00
Scopes : [ ] string { scopePrefix + "drive" } ,
2015-08-18 07:55:09 +00:00
Endpoint : google . Endpoint ,
ClientID : rcloneClientID ,
2018-01-18 20:19:55 +00:00
ClientSecret : obscure . MustReveal ( rcloneEncryptedClientSecret ) ,
2015-08-18 07:55:09 +00:00
RedirectURL : oauthutil . TitleBarRedirectURL ,
2014-07-13 16:53:11 +00:00
}
2018-02-07 11:53:46 +00:00
_mimeTypeToExtensionDuplicates = map [ string ] string {
"application/x-vnd.oasis.opendocument.presentation" : ".odp" ,
"application/x-vnd.oasis.opendocument.spreadsheet" : ".ods" ,
"application/x-vnd.oasis.opendocument.text" : ".odt" ,
"image/jpg" : ".jpg" ,
"image/x-bmp" : ".bmp" ,
"image/x-png" : ".png" ,
"text/rtf" : ".rtf" ,
}
_mimeTypeToExtension = map [ string ] string {
"application/epub+zip" : ".epub" ,
"application/json" : ".json" ,
"application/msword" : ".doc" ,
"application/pdf" : ".pdf" ,
"application/rtf" : ".rtf" ,
"application/vnd.ms-excel" : ".xls" ,
"application/vnd.oasis.opendocument.presentation" : ".odp" ,
"application/vnd.oasis.opendocument.spreadsheet" : ".ods" ,
"application/vnd.oasis.opendocument.text" : ".odt" ,
"application/vnd.openxmlformats-officedocument.presentationml.presentation" : ".pptx" ,
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" : ".xlsx" ,
"application/vnd.openxmlformats-officedocument.wordprocessingml.document" : ".docx" ,
"application/x-msmetafile" : ".wmf" ,
"application/zip" : ".zip" ,
"image/bmp" : ".bmp" ,
"image/jpeg" : ".jpg" ,
"image/pjpeg" : ".pjpeg" ,
"image/png" : ".png" ,
"image/svg+xml" : ".svg" ,
"text/csv" : ".csv" ,
"text/html" : ".html" ,
"text/plain" : ".txt" ,
"text/tab-separated-values" : ".tsv" ,
2016-01-26 16:52:53 +00:00
}
2018-08-21 10:51:36 +00:00
_mimeTypeToExtensionLinks = map [ string ] string {
"application/x-link-desktop" : ".desktop" ,
"application/x-link-html" : ".link.html" ,
"application/x-link-url" : ".url" ,
"application/x-link-webloc" : ".webloc" ,
}
2018-08-30 16:03:48 +00:00
_mimeTypeCustomTransform = map [ string ] string {
"application/vnd.google-apps.script+json" : "application/json" ,
}
2018-08-21 10:51:36 +00:00
fetchFormatsOnce sync . Once // make sure we fetch the export/import formats only once
_exportFormats map [ string ] [ ] string // allowed export MIME type conversions
_importFormats map [ string ] [ ] string // allowed import MIME type conversions
templatesOnce sync . Once // parse link templates only once
_linkTemplates map [ string ] * template . Template // available link types
2014-03-16 14:01:17 +00:00
)
2013-06-29 11:15:31 +00:00
// Register with Fs
func init ( ) {
2016-02-18 11:35:25 +00:00
fs . Register ( & fs . RegInfo {
2016-02-15 18:11:53 +00:00
Name : "drive" ,
Description : "Google Drive" ,
NewFs : NewFs ,
2018-05-14 17:06:57 +00:00
Config : func ( name string , m configmap . Mapper ) {
// Parse config into Options struct
opt := new ( Options )
err := configstruct . Set ( m , opt )
if err != nil {
fs . Errorf ( nil , "Couldn't parse config into struct: %v" , err )
return
}
2018-01-23 13:36:20 +00:00
// Fill in the scopes
2018-05-14 17:06:57 +00:00
if opt . Scope == "" {
opt . Scope = defaultScope
2018-01-23 13:36:20 +00:00
}
driveConfig . Scopes = nil
2018-05-14 17:06:57 +00:00
for _ , scope := range strings . Split ( opt . Scope , "," ) {
2018-01-23 13:36:20 +00:00
driveConfig . Scopes = append ( driveConfig . Scopes , scopePrefix + strings . TrimSpace ( scope ) )
// Set the root_folder_id if using drive.appfolder
if scope == "drive.appfolder" {
2018-05-14 17:06:57 +00:00
m . Set ( "root_folder_id" , "appDataFolder" )
2018-01-23 13:36:20 +00:00
}
}
2018-05-14 17:06:57 +00:00
if opt . ServiceAccountFile == "" {
err = oauthutil . Config ( "drive" , name , m , driveConfig )
2017-11-29 21:34:19 +00:00
if err != nil {
log . Fatalf ( "Failed to configure token: %v" , err )
}
2015-08-18 07:55:09 +00:00
}
2018-05-14 17:06:57 +00:00
err = configTeamDrive ( opt , m , name )
2017-06-01 19:12:11 +00:00
if err != nil {
log . Fatalf ( "Failed to configure team drive: %v" , err )
}
2014-07-13 16:53:11 +00:00
} ,
2014-03-15 16:06:11 +00:00
Options : [ ] fs . Option { {
2018-01-12 16:30:54 +00:00
Name : config . ConfigClientID ,
2018-05-14 17:06:57 +00:00
Help : "Google Application Client Id\nLeave blank normally." ,
2014-03-15 16:06:11 +00:00
} , {
2018-01-12 16:30:54 +00:00
Name : config . ConfigClientSecret ,
2018-05-14 17:06:57 +00:00
Help : "Google Application Client Secret\nLeave blank normally." ,
2018-01-23 13:36:20 +00:00
} , {
Name : "scope" ,
Help : "Scope that rclone should use when requesting access from drive." ,
Examples : [ ] fs . OptionExample { {
Value : "drive" ,
Help : "Full access all files, excluding Application Data Folder." ,
} , {
Value : "drive.readonly" ,
Help : "Read-only access to file metadata and file contents." ,
} , {
Value : "drive.file" ,
Help : "Access to files created by rclone only.\nThese are visible in the drive website.\nFile authorization is revoked when the user deauthorizes the app." ,
} , {
Value : "drive.appfolder" ,
Help : "Allows read and write access to the Application Data folder.\nThis is not visible in the drive website." ,
} , {
Value : "drive.metadata.readonly" ,
Help : "Allows read-only access to file metadata but\ndoes not allow any access to read or download file content." ,
} } ,
} , {
Name : "root_folder_id" ,
2018-05-14 17:06:57 +00:00
Help : "ID of the root folder\nLeave blank normally.\nFill in to access \"Computers\" folders. (see docs)." ,
2017-11-29 21:34:19 +00:00
} , {
Name : "service_account_file" ,
2018-05-14 17:06:57 +00:00
Help : "Service Account Credentials JSON file path \nLeave blank normally.\nNeeded only if you want use SA instead of interactive login." ,
} , {
Name : "service_account_credentials" ,
Help : "Service Account Credentials JSON blob\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login." ,
Hide : fs . OptionHideBoth ,
Advanced : true ,
} , {
Name : "team_drive" ,
Help : "ID of the Team Drive" ,
Hide : fs . OptionHideBoth ,
Advanced : true ,
} , {
Name : "auth_owner_only" ,
Default : false ,
Help : "Only consider files owned by the authenticated user." ,
Advanced : true ,
} , {
Name : "use_trash" ,
Default : true ,
Help : "Send files to the trash instead of deleting permanently." ,
Advanced : true ,
} , {
Name : "skip_gdocs" ,
Default : false ,
Help : "Skip google documents in all listings." ,
Advanced : true ,
} , {
Name : "shared_with_me" ,
Default : false ,
Help : "Only show files that are shared with me" ,
Advanced : true ,
} , {
Name : "trashed_only" ,
Default : false ,
Help : "Only show files that are in the trash" ,
Advanced : true ,
} , {
Name : "formats" ,
2018-08-19 14:16:11 +00:00
Default : "" ,
Help : "Deprecated: see export_formats" ,
Advanced : true ,
Hide : fs . OptionHideConfigurator ,
} , {
Name : "export_formats" ,
Default : defaultExportExtensions ,
2018-05-14 17:06:57 +00:00
Help : "Comma separated list of preferred formats for downloading Google docs." ,
Advanced : true ,
2018-08-19 14:16:11 +00:00
} , {
Name : "import_formats" ,
Default : "" ,
Help : "Comma separated list of preferred formats for uploading Google docs." ,
Advanced : true ,
} , {
Name : "allow_import_name_change" ,
Default : false ,
Help : "Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time." ,
Advanced : true ,
2018-05-14 17:06:57 +00:00
} , {
Name : "use_created_date" ,
Default : false ,
Help : "Use created date instead of modified date." ,
Advanced : true ,
} , {
Name : "list_chunk" ,
Default : 1000 ,
Help : "Size of listing chunk 100-1000. 0 to disable." ,
Advanced : true ,
} , {
Name : "impersonate" ,
Default : "" ,
Help : "Impersonate this user when using a service account." ,
Advanced : true ,
} , {
Name : "alternate_export" ,
Default : false ,
Help : "Use alternate export URLs for google documents export." ,
Advanced : true ,
} , {
Name : "upload_cutoff" ,
Default : defaultChunkSize ,
Help : "Cutoff for switching to chunked upload" ,
Advanced : true ,
} , {
Name : "chunk_size" ,
Default : defaultChunkSize ,
Help : "Upload chunk size. Must a power of 2 >= 256k." ,
Advanced : true ,
} , {
Name : "acknowledge_abuse" ,
Default : false ,
Help : "Set to allow files which return cannotDownloadAbusiveFile to be downloaded." ,
Advanced : true ,
} , {
Name : "keep_revision_forever" ,
Default : false ,
Help : "Keep new head revision forever." ,
Advanced : true ,
2018-09-18 10:29:05 +00:00
} , {
Name : "v2_download_min_size" ,
Default : fs . SizeSuffix ( - 1 ) ,
Help : "If Object's are greater, use drive v2 API to download." ,
Advanced : true ,
2014-03-15 16:06:11 +00:00
} } ,
} )
2016-02-06 09:22:52 +00:00
2018-02-07 11:53:46 +00:00
// register duplicate MIME types first
// this allows them to be used with mime.ExtensionsByType() but
// mime.TypeByExtension() will return the later registered MIME type
2018-08-21 10:51:36 +00:00
for _ , m := range [ ] map [ string ] string {
_mimeTypeToExtensionDuplicates , _mimeTypeToExtension , _mimeTypeToExtensionLinks ,
} {
2018-02-07 11:53:46 +00:00
for mimeType , extension := range m {
if err := mime . AddExtensionType ( extension , mimeType ) ; err != nil {
log . Fatalf ( "Failed to register MIME type %q: %v" , mimeType , err )
}
}
2016-02-06 09:22:52 +00:00
}
2013-06-29 11:15:31 +00:00
}
2018-05-14 17:06:57 +00:00
// Options defines the configuration for this backend
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" `
SharedWithMe bool ` config:"shared_with_me" `
TrashedOnly bool ` config:"trashed_only" `
Extensions string ` config:"formats" `
2018-08-19 14:16:11 +00:00
ExportExtensions string ` config:"export_formats" `
ImportExtensions string ` config:"import_formats" `
AllowImportNameChange bool ` config:"allow_import_name_change" `
2018-05-14 17:06:57 +00:00
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" `
2018-09-18 10:29:05 +00:00
V2DownloadMinSize fs . SizeSuffix ` config:"v2_download_min_size" `
2018-05-14 17:06:57 +00:00
}
2015-11-07 11:14:46 +00:00
// Fs represents a remote drive server
type Fs struct {
2018-08-19 14:16:11 +00:00
name string // name of this remote
root string // the path we are working on
opt Options // parsed options
features * fs . Features // optional features
svc * drive . Service // the connection to the drive server
v2Svc * drive_v2 . Service // used to create download links for the v2 api
client * http . Client // authorized client
rootFolderID string // the id of the root folder
dirCache * dircache . DirCache // Map of directory path to directory id
pacer * pacer . Pacer // To pace the API calls
exportExtensions [ ] string // preferred extensions to download docs
importMimeTypes [ ] string // MIME types to convert to docs
isTeamDrive bool // true if this is a team drive
2013-01-14 23:38:18 +00:00
}
2018-08-21 10:49:33 +00:00
type baseObject struct {
fs * Fs // what this object is part of
remote string // The remote path
id string // Drive Id of this object
modifiedDate string // RFC3339 time it was last modified
mimeType string // The object MIME type
bytes int64 // size of the object
}
type documentObject struct {
baseObject
url string // Download URL of this object
documentMimeType string // the original document MIME type
extLen int // The length of the added export extension
}
2018-08-21 10:51:36 +00:00
type linkObject struct {
baseObject
content [ ] byte // The file content generated by a link template
extLen int // The length of the added export extension
}
2018-08-21 10:49:33 +00:00
2015-11-07 11:14:46 +00:00
// Object describes a drive object
type Object struct {
2018-08-21 10:49:33 +00:00
baseObject
url string // Download URL of this object
md5sum string // md5sum of the object
v2Download bool // generate v2 download link ondemand
2013-01-14 23:38:18 +00:00
}
// ------------------------------------------------------------
2015-09-22 17:47:16 +00:00
// Name of the remote (as passed into NewFs)
2015-11-07 11:14:46 +00:00
func ( f * Fs ) Name ( ) string {
2015-08-22 15:53:11 +00:00
return f . name
}
2015-09-22 17:47:16 +00:00
// Root of the remote (as passed into NewFs)
2015-11-07 11:14:46 +00:00
func ( f * Fs ) Root ( ) string {
2015-09-01 19:45:27 +00:00
return f . root
}
2015-11-07 11:14:46 +00:00
// String converts this Fs to a string
func ( f * Fs ) String ( ) string {
2013-01-14 23:38:18 +00:00
return fmt . Sprintf ( "Google drive root '%s'" , f . root )
}
2017-01-13 17:21:47 +00:00
// Features returns the optional features of this Fs
func ( f * Fs ) Features ( ) * fs . Features {
return f . features
}
2015-09-11 18:18:41 +00:00
// shouldRetry determines whehter a given err rates being retried
2018-09-01 11:16:01 +00:00
func shouldRetry ( err error ) ( bool , error ) {
if err == nil {
return false , nil
}
if fserrors . ShouldRetry ( err ) {
return true , err
}
switch gerr := err . ( type ) {
case * googleapi . Error :
if gerr . Code >= 500 && gerr . Code < 600 {
// All 5xx errors should be retried
return true , err
}
if len ( gerr . Errors ) > 0 {
reason := gerr . Errors [ 0 ] . Reason
if reason == "rateLimitExceeded" || reason == "userRateLimitExceeded" {
return true , err
2015-02-02 17:29:08 +00:00
}
}
}
2018-09-01 11:16:01 +00:00
return false , err
2015-02-02 17:29:08 +00:00
}
2013-01-14 23:38:18 +00:00
// parseParse parses a drive 'url'
func parseDrivePath ( path string ) ( root string , err error ) {
2014-03-27 17:49:36 +00:00
root = strings . Trim ( path , "/" )
2013-01-14 23:38:18 +00:00
return
}
2017-06-11 21:43:31 +00:00
// User function to process a File item from list
2013-01-20 11:56:56 +00:00
//
// Should return true to finish processing
2017-06-11 21:43:31 +00:00
type listFn func ( * drive . File ) bool
2013-01-20 11:56:56 +00:00
2018-07-24 15:14:23 +00:00
func containsString ( slice [ ] string , s string ) bool {
for _ , e := range slice {
if e == s {
return true
}
}
return false
}
2013-01-20 11:56:56 +00:00
// Lists the directory required calling the user function on each item found
//
// If the user fn ever returns true then it early exits with found = true
2013-01-14 23:38:18 +00:00
//
// Search params: https://developers.google.com/drive/search-parameters
2018-09-01 11:16:01 +00:00
func ( f * Fs ) list ( dirIDs [ ] string , title string , directoriesOnly , filesOnly , includeAll bool , fn listFn ) ( found bool , err error ) {
2017-02-16 12:29:37 +00:00
var query [ ] string
2017-07-06 14:32:57 +00:00
if ! includeAll {
2018-05-14 17:06:57 +00:00
q := "trashed=" + strconv . FormatBool ( f . opt . TrashedOnly )
if f . opt . TrashedOnly {
2017-07-19 13:35:58 +00:00
q = fmt . Sprintf ( "(mimeType='%s' or %s)" , driveFolderType , q )
}
query = append ( query , q )
2017-02-16 12:29:37 +00:00
}
2017-03-25 16:16:56 +00:00
// Search with sharedWithMe will always return things listed in "Shared With Me" (without any parents)
// We must not filter with parent when we try list "ROOT" with drive-shared-with-me
// If we need to list file inside those shared folders, we must search it without sharedWithMe
2018-07-26 13:45:41 +00:00
parentsQuery := bytes . NewBufferString ( "(" )
for _ , dirID := range dirIDs {
if dirID == "" {
continue
}
if parentsQuery . Len ( ) > 1 {
_ , _ = parentsQuery . WriteString ( " or " )
}
if f . opt . SharedWithMe && dirID == f . rootFolderID {
_ , _ = parentsQuery . WriteString ( "sharedWithMe=true" )
} else {
_ , _ = fmt . Fprintf ( parentsQuery , "'%s' in parents" , dirID )
}
2017-03-25 16:16:56 +00:00
}
2018-07-26 13:45:41 +00:00
if parentsQuery . Len ( ) > 1 {
_ = parentsQuery . WriteByte ( ')' )
query = append ( query , parentsQuery . String ( ) )
2013-01-23 21:19:26 +00:00
}
2018-08-21 10:54:12 +00:00
var stems [ ] string
2013-01-14 23:38:18 +00:00
if title != "" {
// Escaping the backslash isn't documented but seems to work
2018-01-29 09:18:34 +00:00
searchTitle := strings . Replace ( title , ` \ ` , ` \\ ` , - 1 )
searchTitle = strings . Replace ( searchTitle , ` ' ` , ` \' ` , - 1 )
2017-06-20 14:11:53 +00:00
// Convert / to / for search
2018-01-29 09:18:34 +00:00
searchTitle = strings . Replace ( searchTitle , "/" , "/" , - 1 )
2018-07-24 15:14:23 +00:00
2018-08-21 10:54:12 +00:00
var titleQuery bytes . Buffer
_ , _ = fmt . Fprintf ( & titleQuery , "(name='%s'" , searchTitle )
if ! directoriesOnly && ! f . opt . SkipGdocs {
// If the search title has an extension that is in the export extensions add a search
// for the filename without the extension.
// Assume that export extensions don't contain escape sequences.
for _ , ext := range f . exportExtensions {
if strings . HasSuffix ( searchTitle , ext ) {
stems = append ( stems , title [ : len ( title ) - len ( ext ) ] )
_ , _ = fmt . Fprintf ( & titleQuery , " or name='%s'" , searchTitle [ : len ( searchTitle ) - len ( ext ) ] )
}
}
2018-07-24 15:14:23 +00:00
}
2018-08-21 10:54:12 +00:00
_ = titleQuery . WriteByte ( ')' )
query = append ( query , titleQuery . String ( ) )
2013-01-14 23:38:18 +00:00
}
if directoriesOnly {
2017-02-16 12:29:37 +00:00
query = append ( query , fmt . Sprintf ( "mimeType='%s'" , driveFolderType ) )
2013-01-14 23:38:18 +00:00
}
if filesOnly {
2017-02-16 12:29:37 +00:00
query = append ( query , fmt . Sprintf ( "mimeType!='%s'" , driveFolderType ) )
2013-01-14 23:38:18 +00:00
}
2017-02-16 12:29:37 +00:00
list := f . svc . Files . List ( )
if len ( query ) > 0 {
2018-01-23 13:36:20 +00:00
list . Q ( strings . Join ( query , " and " ) )
2017-07-19 13:35:58 +00:00
// fmt.Printf("list Query = %q\n", query)
2017-02-16 12:29:37 +00:00
}
2018-05-14 17:06:57 +00:00
if f . opt . ListChunk > 0 {
list . PageSize ( f . opt . ListChunk )
2016-12-29 18:04:37 +00:00
}
2017-06-01 19:12:11 +00:00
if f . isTeamDrive {
2018-05-14 17:06:57 +00:00
list . TeamDriveId ( f . opt . TeamDriveID )
2017-06-01 19:12:11 +00:00
list . SupportsTeamDrives ( true )
list . IncludeTeamDriveItems ( true )
list . Corpora ( "teamDrive" )
}
2018-01-23 13:36:20 +00:00
// If using appDataFolder then need to add Spaces
if f . rootFolderID == "appDataFolder" {
list . Spaces ( "appDataFolder" )
}
2017-04-23 19:12:28 +00:00
2017-04-27 09:00:04 +00:00
var fields = partialFields
2017-04-23 19:12:28 +00:00
2018-05-14 17:06:57 +00:00
if f . opt . AuthOwnerOnly {
2017-04-27 09:00:04 +00:00
fields += ",owners"
2017-04-23 19:12:28 +00:00
}
2017-04-27 09:00:04 +00:00
2018-01-23 23:46:41 +00:00
fields = fmt . Sprintf ( "files(%s),nextPageToken" , fields )
2017-04-27 09:00:04 +00:00
2013-01-20 11:56:56 +00:00
OUTER :
2013-01-14 23:38:18 +00:00
for {
2015-02-02 17:29:08 +00:00
var files * drive . FileList
2015-09-11 18:18:41 +00:00
err = f . pacer . Call ( func ( ) ( bool , error ) {
2017-04-27 09:00:04 +00:00
files , err = list . Fields ( googleapi . Field ( fields ) ) . Do ( )
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
2015-02-02 17:29:08 +00:00
} )
2013-01-14 23:38:18 +00:00
if err != nil {
2016-06-12 14:06:02 +00:00
return false , errors . Wrap ( err , "couldn't list directory" )
2013-01-20 11:56:56 +00:00
}
2018-01-23 23:46:41 +00:00
for _ , item := range files . Files {
2017-06-20 14:11:53 +00:00
// Convert / to / for listing purposes
2018-01-23 23:46:41 +00:00
item . Name = strings . Replace ( item . Name , "/" , "/" , - 1 )
2018-06-09 11:00:50 +00:00
// Check the case of items is correct since
// the `=` operator is case insensitive.
2018-07-24 15:14:23 +00:00
2018-01-29 09:18:34 +00:00
if title != "" && title != item . Name {
2018-08-21 10:54:12 +00:00
found := false
for _ , stem := range stems {
if stem == item . Name {
found = true
break
}
}
if ! found {
2018-07-24 15:14:23 +00:00
continue
}
_ , exportName , _ , _ := f . findExportFormat ( item )
if exportName == "" || exportName != title {
continue
}
2018-01-29 09:18:34 +00:00
}
2013-01-20 11:56:56 +00:00
if fn ( item ) {
found = true
break OUTER
}
2013-01-14 23:38:18 +00:00
}
if files . NextPageToken == "" {
break
}
list . PageToken ( files . NextPageToken )
}
return
}
2015-03-14 17:55:38 +00:00
// Returns true of x is a power of 2 or zero
func isPowerOfTwo ( x int64 ) bool {
switch {
case x == 0 :
return true
case x < 0 :
return false
default :
return ( x & ( x - 1 ) ) == 0
}
}
2018-02-07 11:53:46 +00:00
// add a charset parameter to all text/* MIME types
func fixMimeType ( mimeType string ) string {
mediaType , param , err := mime . ParseMediaType ( mimeType )
if err != nil {
return mimeType
}
if strings . HasPrefix ( mimeType , "text/" ) && param [ "charset" ] == "" {
param [ "charset" ] = "utf-8"
mimeType = mime . FormatMediaType ( mediaType , param )
}
return mimeType
}
func fixMimeTypeMap ( m map [ string ] [ ] string ) map [ string ] [ ] string {
for _ , v := range m {
for i , mt := range v {
fixed := fixMimeType ( mt )
if fixed == "" {
panic ( errors . Errorf ( "unable to fix MIME type %q" , mt ) )
}
v [ i ] = fixed
2016-01-26 16:52:53 +00:00
}
2018-02-07 11:53:46 +00:00
}
return m
}
func isInternalMimeType ( mimeType string ) bool {
return strings . HasPrefix ( mimeType , "application/vnd.google-apps." )
}
2018-08-21 10:51:36 +00:00
func isLinkMimeType ( mimeType string ) bool {
return strings . HasPrefix ( mimeType , "application/x-link-" )
}
2018-02-07 11:53:46 +00:00
// parseExtensions parses a list of comma separated extensions
2018-08-19 14:16:11 +00:00
// into a list of unique extensions with leading "." and a list of associated MIME types
func parseExtensions ( extensionsIn ... string ) ( extensions , mimeTypes [ ] string , err error ) {
for _ , extensionText := range extensionsIn {
2018-02-07 11:53:46 +00:00
for _ , extension := range strings . Split ( extensionText , "," ) {
extension = strings . ToLower ( strings . TrimSpace ( extension ) )
2018-08-19 14:16:11 +00:00
if extension == "" {
continue
}
2018-02-07 11:53:46 +00:00
if len ( extension ) > 0 && extension [ 0 ] != '.' {
extension = "." + extension
}
2018-08-19 14:16:11 +00:00
mt := mime . TypeByExtension ( extension )
if mt == "" {
return extensions , mimeTypes , errors . Errorf ( "couldn't find MIME type for extension %q" , extension )
2018-02-07 11:53:46 +00:00
}
2018-09-01 11:16:01 +00:00
if ! containsString ( extensions , extension ) {
2018-08-19 14:16:11 +00:00
extensions = append ( extensions , extension )
mimeTypes = append ( mimeTypes , mt )
2016-01-26 16:52:53 +00:00
}
}
2018-02-07 11:53:46 +00:00
}
2018-08-19 14:16:11 +00:00
return
2016-01-26 16:52:53 +00:00
}
2017-06-01 19:12:11 +00:00
// Figure out if the user wants to use a team drive
2018-05-14 17:06:57 +00:00
func configTeamDrive ( opt * Options , m configmap . Mapper , name string ) error {
if opt . TeamDriveID == "" {
2017-06-01 19:12:11 +00:00
fmt . Printf ( "Configure this as a team drive?\n" )
} else {
2018-05-14 17:06:57 +00:00
fmt . Printf ( "Change current team drive ID %q?\n" , opt . TeamDriveID )
2017-06-01 19:12:11 +00:00
}
2018-05-16 08:10:09 +00:00
if ! config . ConfirmWithDefault ( false ) {
2017-06-01 19:12:11 +00:00
return nil
}
2018-05-14 17:06:57 +00:00
client , err := createOAuthClient ( opt , name , m )
2017-06-01 19:12:11 +00:00
if err != nil {
2018-01-20 18:04:23 +00:00
return errors . Wrap ( err , "config team drive failed to create oauth client" )
2017-06-01 19:12:11 +00:00
}
svc , err := drive . New ( client )
if err != nil {
return errors . Wrap ( err , "config team drive failed to make drive client" )
}
fmt . Printf ( "Fetching team drive list...\n" )
var driveIDs , driveNames [ ] string
2018-01-23 23:46:41 +00:00
listTeamDrives := svc . Teamdrives . List ( ) . PageSize ( 100 )
2017-06-01 19:12:11 +00:00
for {
var teamDrives * drive . TeamDriveList
err = newPacer ( ) . Call ( func ( ) ( bool , error ) {
teamDrives , err = listTeamDrives . Do ( )
return shouldRetry ( err )
} )
if err != nil {
return errors . Wrap ( err , "list team drives failed" )
}
2018-01-23 23:46:41 +00:00
for _ , drive := range teamDrives . TeamDrives {
2017-06-01 19:12:11 +00:00
driveIDs = append ( driveIDs , drive . Id )
driveNames = append ( driveNames , drive . Name )
}
if teamDrives . NextPageToken == "" {
break
}
listTeamDrives . PageToken ( teamDrives . NextPageToken )
}
var driveID string
if len ( driveIDs ) == 0 {
fmt . Printf ( "No team drives found in your account" )
} else {
2018-01-12 16:30:54 +00:00
driveID = config . Choose ( "Enter a Team Drive ID" , driveIDs , driveNames , true )
2017-06-01 19:12:11 +00:00
}
2018-05-14 17:06:57 +00:00
m . Set ( "team_drive" , driveID )
opt . TeamDriveID = driveID
2017-06-01 19:12:11 +00:00
return nil
}
// newPacer makes a pacer configured for drive
func newPacer ( ) * pacer . Pacer {
return pacer . New ( ) . SetMinSleep ( minSleep ) . SetPacer ( pacer . GoogleDrivePacer )
}
2018-05-14 17:06:57 +00:00
func getServiceAccountClient ( opt * Options , credentialsData [ ] byte ) ( * http . Client , error ) {
2018-04-27 15:07:37 +00:00
conf , err := google . JWTConfigFromJSON ( credentialsData , driveConfig . Scopes ... )
2017-11-29 21:34:19 +00:00
if err != nil {
return nil , errors . Wrap ( err , "error processing credentials" )
}
2018-05-14 17:06:57 +00:00
if opt . Impersonate != "" {
conf . Subject = opt . Impersonate
2018-02-01 10:10:51 +00:00
}
2018-01-12 16:30:54 +00:00
ctxWithSpecialClient := oauthutil . Context ( fshttp . NewClient ( fs . Config ) )
2017-11-29 21:34:19 +00:00
return oauth2 . NewClient ( ctxWithSpecialClient , conf . TokenSource ( ctxWithSpecialClient ) ) , nil
}
2018-05-14 17:06:57 +00:00
func createOAuthClient ( opt * Options , name string , m configmap . Mapper ) ( * http . Client , error ) {
2017-11-29 21:34:19 +00:00
var oAuthClient * http . Client
var err error
2018-04-27 15:07:37 +00:00
// try loading service account credentials from env variable, then from a file
2018-05-14 17:06:57 +00:00
if len ( opt . ServiceAccountCredentials ) == 0 && opt . ServiceAccountFile != "" {
loadedCreds , err := ioutil . ReadFile ( os . ExpandEnv ( opt . ServiceAccountFile ) )
2018-04-27 15:07:37 +00:00
if err != nil {
return nil , errors . Wrap ( err , "error opening service account credentials file" )
}
2018-05-14 17:06:57 +00:00
opt . ServiceAccountCredentials = string ( loadedCreds )
2018-04-27 15:07:37 +00:00
}
2018-05-14 17:06:57 +00:00
if opt . ServiceAccountCredentials != "" {
oAuthClient , err = getServiceAccountClient ( opt , [ ] byte ( opt . ServiceAccountCredentials ) )
2017-11-29 21:34:19 +00:00
if err != nil {
2018-01-20 18:04:23 +00:00
return nil , errors . Wrap ( err , "failed to create oauth client from service account" )
2017-11-29 21:34:19 +00:00
}
} else {
2018-05-14 17:06:57 +00:00
oAuthClient , _ , err = oauthutil . NewClient ( name , m , driveConfig )
2017-11-29 21:34:19 +00:00
if err != nil {
2018-01-20 18:04:23 +00:00
return nil , errors . Wrap ( err , "failed to create oauth client" )
2017-11-29 21:34:19 +00:00
}
}
return oAuthClient , nil
}
2015-11-07 11:14:46 +00:00
// NewFs contstructs an Fs from the path, container:path
2018-05-14 17:06:57 +00:00
func NewFs ( name , path string , m configmap . Mapper ) ( fs . Fs , error ) {
// Parse config into Options struct
opt := new ( Options )
err := configstruct . Set ( m , opt )
if err != nil {
return nil , err
}
if ! isPowerOfTwo ( int64 ( opt . ChunkSize ) ) {
return nil , errors . Errorf ( "drive: chunk size %v isn't a power of two" , opt . ChunkSize )
2015-03-14 17:55:38 +00:00
}
2018-05-14 17:06:57 +00:00
if opt . ChunkSize < 256 * 1024 {
return nil , errors . Errorf ( "drive: chunk size can't be less than 256k - was %v" , opt . ChunkSize )
2015-03-14 17:55:38 +00:00
}
2018-05-14 17:06:57 +00:00
oAuthClient , err := createOAuthClient ( opt , name , m )
2018-01-20 18:04:23 +00:00
if err != nil {
return nil , errors . Wrap ( err , "drive: failed when making oauth client" )
}
2013-01-14 23:38:18 +00:00
2014-03-16 14:01:17 +00:00
root , err := parseDrivePath ( path )
if err != nil {
return nil , err
2013-01-14 23:38:18 +00:00
}
2014-07-13 16:53:11 +00:00
2015-11-07 11:14:46 +00:00
f := & Fs {
2015-09-11 18:18:41 +00:00
name : name ,
root : root ,
2018-05-14 17:06:57 +00:00
opt : * opt ,
2017-06-01 19:12:11 +00:00
pacer : newPacer ( ) ,
2014-05-05 18:52:52 +00:00
}
2018-05-14 17:06:57 +00:00
f . isTeamDrive = opt . TeamDriveID != ""
2017-08-09 14:27:43 +00:00
f . features = ( & fs . Features {
DuplicateFiles : true ,
ReadMimeType : true ,
WriteMimeType : true ,
CanHaveEmptyDirectories : true ,
} ) . Fill ( f )
2013-01-14 23:38:18 +00:00
// Create a new authorized Drive client.
2015-08-18 07:55:09 +00:00
f . client = oAuthClient
2013-01-14 23:38:18 +00:00
f . svc , err = drive . New ( f . client )
if err != nil {
2016-06-12 14:06:02 +00:00
return nil , errors . Wrap ( err , "couldn't create Drive client" )
2013-01-14 23:38:18 +00:00
}
2018-09-18 10:29:05 +00:00
if f . opt . V2DownloadMinSize >= 0 {
f . v2Svc , err = drive_v2 . New ( f . client )
if err != nil {
return nil , errors . Wrap ( err , "couldn't create Drive v2 client" )
}
}
2018-01-23 23:46:41 +00:00
// set root folder for a team drive or query the user root folder
if f . isTeamDrive {
2018-05-14 17:06:57 +00:00
f . rootFolderID = f . opt . TeamDriveID
2018-01-23 23:46:41 +00:00
} else {
f . rootFolderID = "root"
}
2018-01-23 13:36:20 +00:00
// override root folder if set in the config
2018-05-14 17:06:57 +00:00
if opt . RootFolderID != "" {
f . rootFolderID = opt . RootFolderID
2018-01-23 13:36:20 +00:00
}
2018-01-23 23:46:41 +00:00
f . dirCache = dircache . New ( root , f . rootFolderID , f )
2016-01-26 16:52:53 +00:00
// Parse extensions
2018-08-19 14:16:11 +00:00
if opt . Extensions != "" {
if opt . ExportExtensions != defaultExportExtensions {
return nil , errors . New ( "only one of 'formats' and 'export_formats' can be specified" )
}
opt . Extensions , opt . ExportExtensions = "" , opt . Extensions
}
f . exportExtensions , _ , err = parseExtensions ( opt . ExportExtensions , defaultExportExtensions )
if err != nil {
return nil , err
}
_ , f . importMimeTypes , err = parseExtensions ( opt . ImportExtensions )
2016-02-06 09:22:52 +00:00
if err != nil {
return nil , err
}
2016-01-26 16:52:53 +00:00
2014-05-05 18:52:52 +00:00
// Find the current root
2015-09-03 20:25:55 +00:00
err = f . dirCache . FindRoot ( false )
2014-05-05 18:52:52 +00:00
if err != nil {
// Assume it is a file
2015-09-03 20:25:55 +00:00
newRoot , remote := dircache . SplitPath ( root )
2018-03-28 18:33:39 +00:00
tempF := * f
tempF . dirCache = dircache . New ( newRoot , f . rootFolderID , & tempF )
tempF . root = newRoot
2014-05-05 18:52:52 +00:00
// Make new Fs which is the parent
2018-03-28 18:33:39 +00:00
err = tempF . dirCache . FindRoot ( false )
2014-05-05 18:52:52 +00:00
if err != nil {
// No root so return old f
return f , nil
}
2018-07-24 15:14:23 +00:00
_ , err := tempF . NewObject ( remote )
2014-05-05 18:52:52 +00:00
if err != nil {
2018-01-25 14:39:03 +00:00
// unable to list folder so return old f
2014-05-05 18:52:52 +00:00
return f , nil
}
2018-07-24 15:14:23 +00:00
// XXX: update the old f here instead of returning tempF, since
// `features` were already filled with functions having *f as a receiver.
// See https://github.com/ncw/rclone/issues/2182
f . dirCache = tempF . dirCache
f . root = tempF . root
return f , fs . ErrorIsFile
2014-05-05 18:52:52 +00:00
}
2015-09-03 20:25:55 +00:00
// fmt.Printf("Root id %s", f.dirCache.RootID())
2013-01-14 23:38:18 +00:00
return f , nil
}
2018-08-21 10:49:33 +00:00
func ( f * Fs ) newBaseObject ( remote string , info * drive . File ) baseObject {
modifiedDate := info . ModifiedTime
if f . opt . UseCreatedDate {
modifiedDate = info . CreatedTime
2013-01-14 23:38:18 +00:00
}
2018-08-21 10:49:33 +00:00
return baseObject {
fs : f ,
remote : remote ,
id : info . Id ,
modifiedDate : modifiedDate ,
mimeType : info . MimeType ,
bytes : info . Size ,
}
}
// newRegularObject creates a fs.Object for a normal drive.File
func ( f * Fs ) newRegularObject ( remote string , info * drive . File ) fs . Object {
return & Object {
baseObject : f . newBaseObject ( remote , info ) ,
url : fmt . Sprintf ( "%sfiles/%s?alt=media" , f . svc . BasePath , info . Id ) ,
md5sum : strings . ToLower ( info . Md5Checksum ) ,
v2Download : f . opt . V2DownloadMinSize != - 1 && info . Size >= int64 ( f . opt . V2DownloadMinSize ) ,
2013-01-14 23:38:18 +00:00
}
2014-05-05 18:52:52 +00:00
}
2018-08-21 10:49:33 +00:00
// newDocumentObject creates a fs.Object for a google docs drive.File
func ( f * Fs ) newDocumentObject ( remote string , info * drive . File , extension , exportMimeType string ) ( fs . Object , error ) {
mediaType , _ , err := mime . ParseMediaType ( exportMimeType )
2018-08-19 14:16:11 +00:00
if err != nil {
return nil , err
}
2018-08-21 10:49:33 +00:00
url := fmt . Sprintf ( "%sfiles/%s/export?mimeType=%s" , f . svc . BasePath , info . Id , url . QueryEscape ( mediaType ) )
if f . opt . AlternateExport {
switch info . MimeType {
case "application/vnd.google-apps.drawing" :
url = fmt . Sprintf ( "https://docs.google.com/drawings/d/%s/export/%s" , info . Id , extension [ 1 : ] )
case "application/vnd.google-apps.document" :
url = fmt . Sprintf ( "https://docs.google.com/document/d/%s/export?format=%s" , info . Id , extension [ 1 : ] )
case "application/vnd.google-apps.spreadsheet" :
url = fmt . Sprintf ( "https://docs.google.com/spreadsheets/d/%s/export?format=%s" , info . Id , extension [ 1 : ] )
case "application/vnd.google-apps.presentation" :
url = fmt . Sprintf ( "https://docs.google.com/presentation/d/%s/export/%s" , info . Id , extension [ 1 : ] )
}
}
baseObject := f . newBaseObject ( remote + extension , info )
baseObject . bytes = - 1
baseObject . mimeType = exportMimeType
return & documentObject {
baseObject : baseObject ,
url : url ,
documentMimeType : info . MimeType ,
extLen : len ( extension ) ,
} , nil
}
2018-08-21 10:51:36 +00:00
// newLinkObject creates a fs.Object that represents a link a google docs drive.File
func ( f * Fs ) newLinkObject ( remote string , info * drive . File , extension , exportMimeType string ) ( fs . Object , error ) {
t := linkTemplate ( exportMimeType )
if t == nil {
return nil , errors . Errorf ( "unsupported link type %s" , exportMimeType )
}
var buf bytes . Buffer
err := t . Execute ( & buf , struct {
URL , Title string
} {
info . WebViewLink , info . Name ,
} )
if err != nil {
return nil , errors . Wrap ( err , "executing template failed" )
}
baseObject := f . newBaseObject ( remote + extension , info )
baseObject . bytes = int64 ( buf . Len ( ) )
baseObject . mimeType = exportMimeType
return & linkObject {
baseObject : baseObject ,
content : buf . Bytes ( ) ,
extLen : len ( extension ) ,
} , nil
}
2018-08-21 10:49:33 +00:00
// newObjectWithInfo creates a fs.Object for any drive.File
//
// When the drive.File cannot be represented as a fs.Object it will return (nil, nil).
func ( f * Fs ) newObjectWithInfo ( remote string , info * drive . File ) ( fs . Object , error ) {
// If item has MD5 sum or a length it is a file stored on drive
if info . Md5Checksum != "" || info . Size > 0 {
return f . newRegularObject ( remote , info ) , nil
}
extension , exportName , exportMimeType , isDocument := f . findExportFormat ( info )
return f . newObjectWithExportInfo ( remote , info , extension , exportName , exportMimeType , isDocument )
}
// newObjectWithExportInfo creates a fs.Object for any drive.File and the result of findExportFormat
//
// When the drive.File cannot be represented as a fs.Object it will return (nil, nil).
func ( f * Fs ) newObjectWithExportInfo (
remote string , info * drive . File ,
extension , exportName , exportMimeType string , isDocument bool ) ( fs . Object , error ) {
switch {
case info . Md5Checksum != "" || info . Size > 0 :
// If item has MD5 sum or a length it is a file stored on drive
return f . newRegularObject ( remote , info ) , nil
case f . opt . SkipGdocs :
fs . Debugf ( remote , "Skipping google document type %q" , info . MimeType )
return nil , nil
default :
// If item MimeType is in the ExportFormats then it is a google doc
if ! isDocument {
fs . Debugf ( remote , "Ignoring unknown document type %q" , info . MimeType )
return nil , nil
}
if extension == "" {
fs . Debugf ( remote , "No export formats found for %q" , info . MimeType )
return nil , nil
}
2018-08-21 10:51:36 +00:00
if isLinkMimeType ( exportMimeType ) {
return f . newLinkObject ( remote , info , extension , exportMimeType )
}
2018-08-21 10:49:33 +00:00
return f . newDocumentObject ( remote , info , extension , exportMimeType )
}
2018-08-19 14:16:11 +00:00
}
2016-06-25 20:23:20 +00:00
// NewObject finds the Object at remote. If it can't be found
// it returns the error fs.ErrorObjectNotFound.
func ( f * Fs ) NewObject ( remote string ) ( fs . Object , error ) {
2018-08-21 10:49:33 +00:00
info , extension , exportName , exportMimeType , isDocument , err := f . getRemoteInfoWithExport ( remote )
if err != nil {
return nil , err
}
remote = remote [ : len ( remote ) - len ( extension ) ]
obj , err := f . newObjectWithExportInfo ( remote , info , extension , exportName , exportMimeType , isDocument )
switch {
case err != nil :
return nil , err
case obj == nil :
return nil , fs . ErrorObjectNotFound
default :
return obj , nil
}
2013-01-14 23:38:18 +00:00
}
2015-09-22 17:47:16 +00:00
// FindLeaf finds a directory of name leaf in the folder with ID pathID
2015-11-07 11:14:46 +00:00
func ( f * Fs ) FindLeaf ( pathID , leaf string ) ( pathIDOut string , found bool , err error ) {
2015-09-22 17:47:16 +00:00
// Find the leaf in pathID
2018-07-26 13:45:41 +00:00
found , err = f . list ( [ ] string { pathID } , leaf , true , false , false , func ( item * drive . File ) bool {
2018-07-24 15:14:23 +00:00
if ! f . opt . SkipGdocs {
2018-08-21 10:49:33 +00:00
_ , exportName , _ , isDocument := f . findExportFormat ( item )
2018-07-24 15:14:23 +00:00
if exportName == leaf {
pathIDOut = item . Id
return true
}
2018-08-21 10:49:33 +00:00
if isDocument {
return false
}
}
if item . Name == leaf {
pathIDOut = item . Id
return true
2018-07-24 15:14:23 +00:00
}
2015-09-03 20:25:55 +00:00
return false
} )
2015-09-22 17:47:16 +00:00
return pathIDOut , found , err
2015-09-03 20:25:55 +00:00
}
2015-09-22 17:47:16 +00:00
// CreateDir makes a directory with pathID as parent and name leaf
2015-11-07 11:14:46 +00:00
func ( f * Fs ) CreateDir ( pathID , leaf string ) ( newID string , err error ) {
2015-09-03 20:25:55 +00:00
// fmt.Println("Making", path)
// Define the metadata for the directory we are going to create.
createInfo := & drive . File {
2018-01-23 23:46:41 +00:00
Name : leaf ,
2015-09-03 20:25:55 +00:00
Description : leaf ,
MimeType : driveFolderType ,
2018-01-23 23:46:41 +00:00
Parents : [ ] string { pathID } ,
2015-09-03 20:25:55 +00:00
}
var info * drive . File
2015-09-11 18:18:41 +00:00
err = f . pacer . Call ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
info , err = f . svc . Files . Create ( createInfo ) .
2018-09-01 11:16:01 +00:00
Fields ( "id" ) .
2018-08-05 10:27:17 +00:00
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
2015-09-03 20:25:55 +00:00
} )
if err != nil {
return "" , err
}
return info . Id , nil
}
2016-02-06 09:22:52 +00:00
// isAuthOwned checks if any of the item owners is the authenticated owner
func isAuthOwned ( item * drive . File ) bool {
for _ , owner := range item . Owners {
2018-01-23 23:46:41 +00:00
if owner . Me {
2016-02-06 09:22:52 +00:00
return true
}
}
return false
}
2018-08-21 10:51:36 +00:00
// linkTemplate returns the Template for a MIME type or nil if the
// MIME type does not represent a link
func linkTemplate ( mt string ) * template . Template {
templatesOnce . Do ( func ( ) {
_linkTemplates = map [ string ] * template . Template {
"application/x-link-desktop" : template . Must (
template . New ( "application/x-link-desktop" ) . Parse ( desktopTemplate ) ) ,
"application/x-link-html" : template . Must (
template . New ( "application/x-link-html" ) . Parse ( htmlTemplate ) ) ,
"application/x-link-url" : template . Must (
template . New ( "application/x-link-url" ) . Parse ( urlTemplate ) ) ,
"application/x-link-webloc" : template . Must (
template . New ( "application/x-link-webloc" ) . Parse ( weblocTemplate ) ) ,
}
} )
return _linkTemplates [ mt ]
}
2018-08-19 14:16:11 +00:00
func ( f * Fs ) fetchFormats ( ) {
fetchFormatsOnce . Do ( func ( ) {
2018-01-31 20:03:02 +00:00
var about * drive . About
var err error
err = f . pacer . Call ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
about , err = f . svc . About . Get ( ) .
2018-08-19 14:16:11 +00:00
Fields ( "exportFormats,importFormats" ) .
2018-08-05 10:27:17 +00:00
Do ( )
2018-01-31 20:03:02 +00:00
return shouldRetry ( err )
} )
if err != nil {
2018-08-19 14:16:11 +00:00
fs . Errorf ( f , "Failed to get Drive exportFormats and importFormats: %v" , err )
2018-01-31 20:03:02 +00:00
_exportFormats = map [ string ] [ ] string { }
2018-08-19 14:16:11 +00:00
_importFormats = map [ string ] [ ] string { }
2018-01-31 20:03:02 +00:00
return
}
2018-02-07 11:53:46 +00:00
_exportFormats = fixMimeTypeMap ( about . ExportFormats )
2018-08-19 14:16:11 +00:00
_importFormats = fixMimeTypeMap ( about . ImportFormats )
2018-01-31 20:03:02 +00:00
} )
2018-08-19 14:16:11 +00:00
}
// exportFormats returns the export formats from drive, fetching them
// if necessary.
//
// if the fetch fails then it will not export any drive formats
func ( f * Fs ) exportFormats ( ) map [ string ] [ ] string {
f . fetchFormats ( )
2018-01-31 20:03:02 +00:00
return _exportFormats
}
2018-08-19 14:16:11 +00:00
// importFormats returns the import formats from drive, fetching them
// if necessary.
//
// if the fetch fails then it will not import any drive formats
func ( f * Fs ) importFormats ( ) map [ string ] [ ] string {
f . fetchFormats ( )
return _importFormats
}
// findExportFormatByMimeType works out the optimum export settings
// for the given MIME type.
2016-02-06 09:22:52 +00:00
//
2018-08-19 14:16:11 +00:00
// Look through the exportExtensions and find the first format that can be
// converted. If none found then return ("", "", false)
func ( f * Fs ) findExportFormatByMimeType ( itemMimeType string ) (
extension , mimeType string , isDocument bool ) {
exportMimeTypes , isDocument := f . exportFormats ( ) [ itemMimeType ]
2018-07-24 15:14:23 +00:00
if isDocument {
2018-08-19 14:16:11 +00:00
for _ , _extension := range f . exportExtensions {
2018-02-07 11:53:46 +00:00
_mimeType := mime . TypeByExtension ( _extension )
2018-08-21 10:51:36 +00:00
if isLinkMimeType ( _mimeType ) {
return _extension , _mimeType , true
}
2018-07-24 15:14:23 +00:00
for _ , emt := range exportMimeTypes {
2018-02-07 11:53:46 +00:00
if emt == _mimeType {
2018-08-30 16:03:48 +00:00
return _extension , emt , true
}
if _mimeType == _mimeTypeCustomTransform [ emt ] {
return _extension , emt , true
2018-07-24 15:14:23 +00:00
}
2018-01-23 23:46:41 +00:00
}
2016-02-06 09:22:52 +00:00
}
}
// else return empty
2018-08-19 14:16:11 +00:00
return "" , "" , isDocument
}
// findExportFormatByMimeType works out the optimum export settings
// for the given drive.File.
//
// Look through the exportExtensions and find the first format that can be
// converted. If none found then return ("", "", "", false)
func ( f * Fs ) findExportFormat ( item * drive . File ) ( extension , filename , mimeType string , isDocument bool ) {
extension , mimeType , isDocument = f . findExportFormatByMimeType ( item . MimeType )
if extension != "" {
filename = item . Name + extension
}
return
}
// findImportFormat finds the matching upload MIME type for a file
// If the given MIME type is in importMimeTypes, the matching upload
// MIME type is returned
//
// When no match is found "" is returned.
func ( f * Fs ) findImportFormat ( mimeType string ) string {
mimeType = fixMimeType ( mimeType )
ifs := f . importFormats ( )
for _ , mt := range f . importMimeTypes {
if mt == mimeType {
importMimeTypes := ifs [ mimeType ]
if l := len ( importMimeTypes ) ; l > 0 {
if l > 1 {
fs . Infof ( f , "found %d import formats for %q: %q" , l , mimeType , importMimeTypes )
}
return importMimeTypes [ 0 ]
}
}
}
return ""
2016-02-06 09:22:52 +00:00
}
2017-06-11 21:43:31 +00:00
// 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 ( f * Fs ) List ( dir string ) ( entries fs . DirEntries , err error ) {
err = f . dirCache . FindRoot ( false )
if err != nil {
return nil , err
}
directoryID , err := f . dirCache . FindDir ( dir , false )
if err != nil {
return nil , err
}
var iErr error
2018-07-26 13:45:41 +00:00
_ , err = f . list ( [ ] string { directoryID } , "" , false , false , false , func ( item * drive . File ) bool {
entry , err := f . itemToDirEntry ( path . Join ( dir , item . Name ) , item )
if err != nil {
2018-09-01 11:16:01 +00:00
iErr = err
2018-07-26 13:45:41 +00:00
return true
}
if entry != nil {
entries = append ( entries , entry )
}
return false
} )
if err != nil {
return nil , err
}
if iErr != nil {
return nil , iErr
}
return entries , nil
}
// listRRunner will read dirIDs from the in channel, perform the file listing an call cb with each DirEntry.
//
// In each cycle, will wait up to 10ms to read up to grouping entries from the in channel.
// If an error occurs it will be send to the out channel and then return. Once the in channel is closed,
// nil is send to the out channel and the function returns.
func ( f * Fs ) listRRunner ( wg * sync . WaitGroup , in <- chan string , out chan <- error , cb func ( fs . DirEntry ) error , grouping int ) {
var dirs [ ] string
for dir := range in {
dirs = append ( dirs [ : 0 ] , dir )
wait := time . After ( 10 * time . Millisecond )
waitloop :
for i := 1 ; i < grouping ; i ++ {
select {
case d , ok := <- in :
if ! ok {
break waitloop
}
dirs = append ( dirs , d )
case <- wait :
break waitloop
}
}
var iErr error
_ , err := f . list ( dirs , "" , false , false , false , func ( item * drive . File ) bool {
parentPath := ""
if len ( item . Parents ) > 0 {
p , ok := f . dirCache . GetInv ( item . Parents [ 0 ] )
if ok {
parentPath = p
}
}
remote := path . Join ( parentPath , item . Name )
entry , err := f . itemToDirEntry ( remote , item )
2016-06-25 20:23:20 +00:00
if err != nil {
2017-06-11 21:43:31 +00:00
iErr = err
2016-06-25 20:23:20 +00:00
return true
2016-02-06 09:22:52 +00:00
}
2018-07-26 13:45:41 +00:00
err = cb ( entry )
2018-01-31 20:03:02 +00:00
if err != nil {
iErr = err
return true
}
2018-07-26 13:45:41 +00:00
return false
} )
for range dirs {
wg . Done ( )
2013-01-14 23:38:18 +00:00
}
2018-07-26 13:45:41 +00:00
if iErr != nil {
out <- iErr
return
}
if err != nil {
out <- err
return
}
}
out <- nil
}
// 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 ( f * Fs ) ListR ( dir string , callback fs . ListRCallback ) ( err error ) {
const (
grouping = 50
inputBuffer = 1000
)
err = f . dirCache . FindRoot ( false )
2017-06-11 21:43:31 +00:00
if err != nil {
2018-07-26 13:45:41 +00:00
return err
2017-06-11 21:43:31 +00:00
}
2018-07-26 13:45:41 +00:00
directoryID , err := f . dirCache . FindDir ( dir , false )
if err != nil {
return err
2017-06-11 21:43:31 +00:00
}
2018-07-26 13:45:41 +00:00
mu := sync . Mutex { } // protects in and overflow
wg := sync . WaitGroup { }
in := make ( chan string , inputBuffer )
out := make ( chan error , fs . Config . Checkers )
list := walk . NewListRHelper ( callback )
overfflow := [ ] string { }
cb := func ( entry fs . DirEntry ) error {
mu . Lock ( )
defer mu . Unlock ( )
if d , isDir := entry . ( * fs . Dir ) ; isDir && in != nil {
select {
case in <- d . ID ( ) :
wg . Add ( 1 )
default :
overfflow = append ( overfflow , d . ID ( ) )
}
}
return list . Add ( entry )
}
wg . Add ( 1 )
in <- directoryID
for i := 0 ; i < fs . Config . Checkers ; i ++ {
go f . listRRunner ( & wg , in , out , cb , grouping )
}
go func ( ) {
// wait until the all directories are processed
wg . Wait ( )
// if the input channel overflowed add the collected entries to the channel now
for len ( overfflow ) > 0 {
mu . Lock ( )
l := len ( overfflow )
// only fill half of the channel to prevent entries beeing put into overfflow again
if l > inputBuffer / 2 {
l = inputBuffer / 2
}
wg . Add ( l )
for _ , d := range overfflow [ : l ] {
in <- d
}
overfflow = overfflow [ l : ]
mu . Unlock ( )
// wait again for the completion of all directories
wg . Wait ( )
}
mu . Lock ( )
if in != nil {
// notify all workers to exit
close ( in )
in = nil
}
mu . Unlock ( )
} ( )
// wait until the all workers to finish
for i := 0 ; i < fs . Config . Checkers ; i ++ {
e := <- out
mu . Lock ( )
// if one worker returns an error early, close the input so all other workers exit
if e != nil && in != nil {
err = e
close ( in )
in = nil
}
mu . Unlock ( )
}
close ( out )
if err != nil {
return err
}
return list . Flush ( )
}
2018-08-21 10:49:33 +00:00
// itemToDirEntry converts a drive.File to a fs.DirEntry.
// When the drive.File cannot be represented as a fs.DirEntry
// (nil, nil) is returned.
2018-07-26 13:45:41 +00:00
func ( f * Fs ) itemToDirEntry ( remote string , item * drive . File ) ( fs . DirEntry , error ) {
switch {
case item . MimeType == driveFolderType :
// cache the directory ID for later lookups
f . dirCache . Put ( remote , item . Id )
when , _ := time . Parse ( timeFormatIn , item . ModifiedTime )
d := fs . NewDir ( remote , when ) . SetID ( item . Id )
return d , nil
case f . opt . AuthOwnerOnly && ! isAuthOwned ( item ) :
// ignore object
default :
2018-08-21 10:49:33 +00:00
return f . newObjectWithInfo ( remote , item )
2018-07-26 13:45:41 +00:00
}
return nil , nil
2013-01-23 22:43:20 +00:00
}
2018-08-21 10:49:33 +00:00
// Creates a drive.File info from the parameters passed in.
2013-01-14 23:38:18 +00:00
//
2015-02-14 18:48:08 +00:00
// Used to create new objects
2018-08-21 10:49:33 +00:00
func ( f * Fs ) createFileInfo ( remote string , modTime time . Time ) ( * drive . File , error ) {
2017-03-15 20:55:05 +00:00
leaf , directoryID , err := f . dirCache . FindRootAndPath ( remote , true )
2014-04-18 16:46:57 +00:00
if err != nil {
2018-08-21 10:49:33 +00:00
return nil , err
2014-04-18 16:46:57 +00:00
}
// Define the metadata for the file we are going to create.
2015-02-02 17:29:08 +00:00
createInfo := & drive . File {
2018-01-23 23:46:41 +00:00
Name : leaf ,
2014-04-18 16:46:57 +00:00
Description : leaf ,
2018-01-23 23:46:41 +00:00
Parents : [ ] string { directoryID } ,
2016-09-21 21:13:24 +00:00
MimeType : fs . MimeTypeFromName ( remote ) ,
2018-01-23 23:46:41 +00:00
ModifiedTime : modTime . Format ( timeFormatOut ) ,
2014-04-18 16:46:57 +00:00
}
2018-08-21 10:49:33 +00:00
return createInfo , nil
2015-02-14 18:48:08 +00:00
}
// 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
2017-05-28 11:44:22 +00:00
func ( f * Fs ) Put ( in io . Reader , src fs . ObjectInfo , options ... fs . OpenOption ) ( fs . Object , error ) {
2018-08-21 10:49:33 +00:00
exisitingObj , err := f . NewObject ( src . Remote ( ) )
2016-06-12 14:06:27 +00:00
switch err {
case nil :
2017-07-05 21:16:07 +00:00
return exisitingObj , exisitingObj . Update ( in , src , options ... )
2016-06-25 20:23:20 +00:00
case fs . ErrorObjectNotFound :
2016-06-12 14:06:27 +00:00
// Not found so create it
2017-07-05 21:16:07 +00:00
return f . PutUnchecked ( in , src , options ... )
2016-06-12 14:06:27 +00:00
default :
return nil , err
}
}
2017-08-03 19:42:35 +00:00
// PutStream uploads to the remote path with the modTime given of indeterminate size
func ( f * Fs ) PutStream ( in io . Reader , src fs . ObjectInfo , options ... fs . OpenOption ) ( fs . Object , error ) {
return f . Put ( in , src , options ... )
}
2016-06-12 14:06:27 +00:00
// 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.
2017-05-28 11:44:22 +00:00
func ( f * Fs ) PutUnchecked ( in io . Reader , src fs . ObjectInfo , options ... fs . OpenOption ) ( fs . Object , error ) {
2016-02-18 11:35:25 +00:00
remote := src . Remote ( )
size := src . Size ( )
modTime := src . ModTime ( )
2018-08-19 14:16:11 +00:00
srcMimeType := fs . MimeTypeFromName ( remote )
srcExt := path . Ext ( remote )
exportExt := ""
importMimeType := ""
if f . importMimeTypes != nil && ! f . opt . SkipGdocs {
importMimeType = f . findImportFormat ( srcMimeType )
if isInternalMimeType ( importMimeType ) {
remote = remote [ : len ( remote ) - len ( srcExt ) ]
2018-08-21 10:49:33 +00:00
exportExt , _ , _ = f . findExportFormatByMimeType ( importMimeType )
2018-08-19 14:16:11 +00:00
if exportExt == "" {
return nil , errors . Errorf ( "No export format found for %q" , importMimeType )
}
if exportExt != srcExt && ! f . opt . AllowImportNameChange {
return nil , errors . Errorf ( "Can't convert %q to a document with a different export filetype (%q)" , srcExt , exportExt )
}
}
}
2016-02-18 11:35:25 +00:00
2018-08-21 10:49:33 +00:00
createInfo , err := f . createFileInfo ( remote , modTime )
2015-02-14 18:48:08 +00:00
if err != nil {
return nil , err
}
2018-08-19 14:16:11 +00:00
if importMimeType != "" {
createInfo . MimeType = importMimeType
}
2014-04-18 16:46:57 +00:00
2015-02-02 17:29:08 +00:00
var info * drive . File
2018-05-14 17:06:57 +00:00
if size == 0 || size < int64 ( f . opt . UploadCutoff ) {
2015-03-02 09:05:23 +00:00
// Make the API request to upload metadata and file data.
// Don't retry, return a retry error instead
2015-09-11 18:18:41 +00:00
err = f . pacer . CallNoRetry ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
info , err = f . svc . Files . Create ( createInfo ) .
2018-08-19 14:16:11 +00:00
Media ( in , googleapi . ContentType ( srcMimeType ) ) .
2018-09-01 11:16:01 +00:00
Fields ( partialFields ) .
2018-08-05 10:27:17 +00:00
SupportsTeamDrives ( f . isTeamDrive ) .
KeepRevisionForever ( f . opt . KeepRevisionForever ) .
Do ( )
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
} )
2015-03-02 09:05:23 +00:00
if err != nil {
2018-08-21 10:49:33 +00:00
return nil , err
2015-03-02 09:05:23 +00:00
}
} else {
// Upload the file in chunks
2018-09-01 11:16:01 +00:00
info , err = f . Upload ( in , size , srcMimeType , "" , remote , createInfo )
2015-03-02 09:05:23 +00:00
if err != nil {
2018-08-21 10:49:33 +00:00
return nil , err
2015-03-02 09:05:23 +00:00
}
2014-04-18 16:46:57 +00:00
}
2018-08-21 10:49:33 +00:00
return f . newObjectWithInfo ( remote , info )
2013-01-14 23:38:18 +00:00
}
2017-08-02 15:51:24 +00:00
// MergeDirs merges the contents of all the directories passed
// in into the first one and rmdirs the other directories.
func ( f * Fs ) MergeDirs ( dirs [ ] fs . Directory ) error {
if len ( dirs ) < 2 {
return nil
}
dstDir := dirs [ 0 ]
for _ , srcDir := range dirs [ 1 : ] {
// list the the objects
infos := [ ] * drive . File { }
2018-07-26 13:45:41 +00:00
_ , err := f . list ( [ ] string { srcDir . ID ( ) } , "" , false , false , true , func ( info * drive . File ) bool {
2017-08-02 15:51:24 +00:00
infos = append ( infos , info )
return false
} )
if err != nil {
return errors . Wrapf ( err , "MergeDirs list failed on %v" , srcDir )
}
// move them into place
for _ , info := range infos {
2018-01-23 23:46:41 +00:00
fs . Infof ( srcDir , "merging %q" , info . Name )
2017-08-02 15:51:24 +00:00
// Move the file into the destination
err = f . pacer . Call ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
_ , err = f . svc . Files . Update ( info . Id , nil ) .
RemoveParents ( srcDir . ID ( ) ) .
AddParents ( dstDir . ID ( ) ) .
Fields ( "" ) .
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2017-08-02 15:51:24 +00:00
return shouldRetry ( err )
} )
if err != nil {
2018-01-23 23:46:41 +00:00
return errors . Wrapf ( err , "MergDirs move failed on %q in %v" , info . Name , srcDir )
2017-08-02 15:51:24 +00:00
}
}
// rmdir (into trash) the now empty source directory
2018-04-12 17:01:57 +00:00
fs . Infof ( srcDir , "removing empty directory" )
2017-08-02 15:51:24 +00:00
err = f . rmdir ( srcDir . ID ( ) , true )
if err != nil {
return errors . Wrapf ( err , "MergDirs move failed to rmdir %q" , srcDir )
}
}
return nil
}
2013-01-14 23:38:18 +00:00
// Mkdir creates the container if it doesn't exist
2016-11-25 21:52:43 +00:00
func ( f * Fs ) Mkdir ( dir string ) error {
err := f . dirCache . FindRoot ( true )
if err != nil {
return err
}
if dir != "" {
_ , err = f . dirCache . FindDir ( dir , true )
}
return err
2013-01-14 23:38:18 +00:00
}
2017-08-02 15:51:24 +00:00
// Rmdir deletes a directory unconditionally by ID
func ( f * Fs ) rmdir ( directoryID string , useTrash bool ) error {
return f . pacer . Call ( func ( ) ( bool , error ) {
var err error
if useTrash {
2018-01-23 23:46:41 +00:00
info := drive . File {
Trashed : true ,
}
2018-08-05 10:27:17 +00:00
_ , err = f . svc . Files . Update ( directoryID , & info ) .
Fields ( "" ) .
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2017-08-02 15:51:24 +00:00
} else {
2018-08-05 10:27:17 +00:00
err = f . svc . Files . Delete ( directoryID ) .
Fields ( "" ) .
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2017-08-02 15:51:24 +00:00
}
return shouldRetry ( err )
} )
}
2017-02-16 12:29:37 +00:00
// Rmdir deletes a directory
2013-01-14 23:38:18 +00:00
//
// Returns an error if it isn't empty
2016-11-25 21:52:43 +00:00
func ( f * Fs ) Rmdir ( dir string ) error {
root := path . Join ( f . root , dir )
dc := f . dirCache
2017-02-16 12:29:37 +00:00
directoryID , err := dc . FindDir ( dir , false )
2013-01-14 23:38:18 +00:00
if err != nil {
return err
}
2017-02-16 12:29:37 +00:00
var trashedFiles = false
2018-07-26 13:45:41 +00:00
found , err := f . list ( [ ] string { directoryID } , "" , false , false , true , func ( item * drive . File ) bool {
2018-01-23 23:46:41 +00:00
if ! item . Trashed {
fs . Debugf ( dir , "Rmdir: contains file: %q" , item . Name )
2017-02-16 12:29:37 +00:00
return true
}
2018-01-23 23:46:41 +00:00
fs . Debugf ( dir , "Rmdir: contains trashed file: %q" , item . Name )
2017-02-16 12:29:37 +00:00
trashedFiles = true
return false
2015-02-02 17:29:08 +00:00
} )
2013-01-14 23:38:18 +00:00
if err != nil {
return err
}
2017-02-16 12:29:37 +00:00
if found {
return errors . Errorf ( "directory not empty" )
2013-01-14 23:38:18 +00:00
}
2016-11-25 21:52:43 +00:00
if root != "" {
2017-08-02 15:51:24 +00:00
// trash the directory if it had trashed files
// in or the user wants to trash, otherwise
// delete it.
2018-05-14 17:06:57 +00:00
err = f . rmdir ( directoryID , trashedFiles || f . opt . UseTrash )
2013-01-18 17:01:47 +00:00
if err != nil {
return err
}
}
2016-11-25 21:52:43 +00:00
f . dirCache . FlushDir ( dir )
if err != nil {
return err
}
2013-01-18 17:01:47 +00:00
return nil
}
2015-09-22 17:47:16 +00:00
// Precision of the object storage system
2015-11-07 11:14:46 +00:00
func ( f * Fs ) Precision ( ) time . Duration {
2013-01-18 23:21:02 +00:00
return time . Millisecond
}
2015-02-14 18:48:08 +00:00
// 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
2015-11-07 11:14:46 +00:00
func ( f * Fs ) Copy ( src fs . Object , remote string ) ( fs . Object , error ) {
2018-08-21 10:49:33 +00:00
var srcObj * baseObject
ext := ""
switch src := src . ( type ) {
case * Object :
srcObj = & src . baseObject
case * documentObject :
2018-09-01 11:16:01 +00:00
srcObj , ext = & src . baseObject , src . ext ( )
2018-08-21 10:51:36 +00:00
case * linkObject :
2018-09-01 11:16:01 +00:00
srcObj , ext = & src . baseObject , src . ext ( )
2018-08-21 10:49:33 +00:00
default :
2017-02-09 11:01:20 +00:00
fs . Debugf ( src , "Can't copy - not same remote type" )
2015-02-14 18:48:08 +00:00
return nil , fs . ErrorCantCopy
}
2018-08-21 10:49:33 +00:00
if ext != "" {
if ! strings . HasSuffix ( remote , ext ) {
fs . Debugf ( src , "Can't copy - not same document type" )
return nil , fs . ErrorCantCopy
}
remote = remote [ : len ( remote ) - len ( ext ) ]
2016-02-28 09:35:28 +00:00
}
2015-02-14 18:48:08 +00:00
2018-08-21 10:49:33 +00:00
createInfo , err := f . createFileInfo ( remote , src . ModTime ( ) )
2015-02-14 18:48:08 +00:00
if err != nil {
return nil , err
}
var info * drive . File
2018-08-21 10:49:33 +00:00
err = f . pacer . Call ( func ( ) ( bool , error ) {
info , err = f . svc . Files . Copy ( srcObj . id , createInfo ) .
2018-09-01 11:16:01 +00:00
Fields ( partialFields ) .
2018-08-05 10:27:17 +00:00
SupportsTeamDrives ( f . isTeamDrive ) .
KeepRevisionForever ( f . opt . KeepRevisionForever ) .
Do ( )
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
2015-02-14 18:48:08 +00:00
} )
if err != nil {
return nil , err
}
2018-08-21 10:49:33 +00:00
return f . newObjectWithInfo ( remote , info )
2015-02-14 18:48:08 +00:00
}
2013-01-18 17:01:47 +00:00
// Purge deletes all the files and the container
//
2014-07-13 08:30:14 +00:00
// 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()
2015-11-07 11:14:46 +00:00
func ( f * Fs ) Purge ( ) error {
2013-01-18 17:01:47 +00:00
if f . root == "" {
2016-06-12 14:06:02 +00:00
return errors . New ( "can't purge root directory" )
2013-01-18 17:01:47 +00:00
}
2015-09-03 20:25:55 +00:00
err := f . dirCache . FindRoot ( false )
2013-01-18 17:01:47 +00:00
if err != nil {
return err
}
2015-09-11 18:18:41 +00:00
err = f . pacer . Call ( func ( ) ( bool , error ) {
2018-05-14 17:06:57 +00:00
if f . opt . UseTrash {
2018-01-23 23:46:41 +00:00
info := drive . File {
Trashed : true ,
}
2018-08-05 10:27:17 +00:00
_ , err = f . svc . Files . Update ( f . dirCache . RootID ( ) , & info ) .
Fields ( "" ) .
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2015-08-16 13:49:58 +00:00
} else {
2018-08-05 10:27:17 +00:00
err = f . svc . Files . Delete ( f . dirCache . RootID ( ) ) .
Fields ( "" ) .
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2015-08-16 13:49:58 +00:00
}
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
2015-02-02 17:29:08 +00:00
} )
2015-09-03 20:25:55 +00:00
f . dirCache . ResetRoot ( )
2013-01-14 23:38:18 +00:00
if err != nil {
return err
}
return nil
}
2017-09-01 17:54:14 +00:00
// CleanUp empties the trash
func ( f * Fs ) CleanUp ( ) error {
err := f . pacer . Call ( func ( ) ( bool , error ) {
err := f . svc . Files . EmptyTrash ( ) . Do ( )
return shouldRetry ( err )
} )
if err != nil {
return err
}
return nil
}
2018-02-09 20:48:32 +00:00
// About gets quota information
2018-04-16 21:19:25 +00:00
func ( f * Fs ) About ( ) ( * fs . Usage , error ) {
2018-05-03 07:51:08 +00:00
if f . isTeamDrive {
// Teamdrives don't appear to have a usage API so just return empty
return & fs . Usage { } , nil
}
2018-02-09 20:48:32 +00:00
var about * drive . About
var err error
err = f . pacer . Call ( func ( ) ( bool , error ) {
about , err = f . svc . About . Get ( ) . Fields ( "storageQuota" ) . Do ( )
return shouldRetry ( err )
} )
if err != nil {
2018-04-16 21:19:25 +00:00
return nil , errors . Wrap ( err , "failed to get Drive storageQuota" )
2018-02-09 20:48:32 +00:00
}
2018-04-16 21:19:25 +00:00
q := about . StorageQuota
usage := & fs . Usage {
Used : fs . NewUsageValue ( q . UsageInDrive ) , // bytes in use
Trashed : fs . NewUsageValue ( q . UsageInDriveTrash ) , // bytes in trash
Other : fs . NewUsageValue ( q . Usage - q . UsageInDrive ) , // other usage eg gmail in drive
}
if q . Limit > 0 {
usage . Total = fs . NewUsageValue ( q . Limit ) // quota of bytes that can be used
usage . Free = fs . NewUsageValue ( q . Limit - q . Usage ) // bytes which can be uploaded before reaching the quota
}
return usage , nil
2018-02-09 20:48:32 +00:00
}
2015-08-31 20:05:51 +00:00
// 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
2015-11-07 11:14:46 +00:00
func ( f * Fs ) Move ( src fs . Object , remote string ) ( fs . Object , error ) {
2018-08-21 10:49:33 +00:00
var srcObj * baseObject
ext := ""
switch src := src . ( type ) {
case * Object :
srcObj = & src . baseObject
case * documentObject :
2018-09-01 11:16:01 +00:00
srcObj , ext = & src . baseObject , src . ext ( )
2018-08-21 10:51:36 +00:00
case * linkObject :
2018-09-01 11:16:01 +00:00
srcObj , ext = & src . baseObject , src . ext ( )
2018-08-21 10:49:33 +00:00
default :
2017-02-09 11:01:20 +00:00
fs . Debugf ( src , "Can't move - not same remote type" )
2015-08-31 20:05:51 +00:00
return nil , fs . ErrorCantMove
}
2018-08-21 10:49:33 +00:00
if ext != "" {
if ! strings . HasSuffix ( remote , ext ) {
fs . Debugf ( src , "Can't move - not same document type" )
return nil , fs . ErrorCantMove
}
remote = remote [ : len ( remote ) - len ( ext ) ]
2016-02-28 09:35:28 +00:00
}
2018-08-21 10:49:33 +00:00
2018-01-23 23:46:41 +00:00
_ , srcParentID , err := srcObj . fs . dirCache . FindPath ( src . Remote ( ) , false )
if err != nil {
return nil , err
}
2015-08-31 20:05:51 +00:00
2016-06-25 20:58:34 +00:00
// Temporary Object under construction
2018-08-21 10:49:33 +00:00
dstInfo , err := f . createFileInfo ( remote , src . ModTime ( ) )
2015-08-31 20:05:51 +00:00
if err != nil {
return nil , err
}
2018-01-23 23:46:41 +00:00
dstParents := strings . Join ( dstInfo . Parents , "," )
dstInfo . Parents = nil
2015-08-31 20:05:51 +00:00
// Do the move
2016-03-06 17:36:05 +00:00
var info * drive . File
err = f . pacer . Call ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
info , err = f . svc . Files . Update ( srcObj . id , dstInfo ) .
RemoveParents ( srcParentID ) .
AddParents ( dstParents ) .
2018-09-01 11:16:01 +00:00
Fields ( partialFields ) .
2018-08-05 10:27:17 +00:00
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2016-03-06 17:36:05 +00:00
return shouldRetry ( err )
} )
2015-08-31 20:05:51 +00:00
if err != nil {
return nil , err
}
2018-08-21 10:49:33 +00:00
return f . newObjectWithInfo ( remote , info )
2015-08-31 20:05:51 +00:00
}
2018-03-29 07:10:19 +00:00
// PublicLink adds a "readable by anyone with link" permission on the given file or folder.
func ( f * Fs ) PublicLink ( remote string ) ( link string , err error ) {
id , err := f . dirCache . FindDir ( remote , false )
if err == nil {
fs . Debugf ( f , "attempting to share directory '%s'" , remote )
} else {
fs . Debugf ( f , "attempting to share single file '%s'" , remote )
2018-08-21 10:49:33 +00:00
o , err := f . NewObject ( remote )
if err != nil {
return "" , err
2018-03-29 07:10:19 +00:00
}
2018-08-21 10:49:33 +00:00
id = o . ( fs . IDer ) . ID ( )
2018-03-29 07:10:19 +00:00
}
permission := & drive . Permission {
AllowFileDiscovery : false ,
Role : "reader" ,
Type : "anyone" ,
}
err = f . pacer . Call ( func ( ) ( bool , error ) {
// TODO: On TeamDrives this might fail if lacking permissions to change ACLs.
// Need to either check `canShare` attribute on the object or see if a sufficient permission is already present.
2018-08-05 10:27:17 +00:00
_ , err = f . svc . Permissions . Create ( id , permission ) .
2018-09-01 11:16:01 +00:00
Fields ( "" ) .
2018-08-05 10:27:17 +00:00
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2018-03-29 07:10:19 +00:00
return shouldRetry ( err )
} )
if err != nil {
return "" , err
}
return fmt . Sprintf ( "https://drive.google.com/open?id=%s" , id ) , nil
}
2017-02-05 21:20:56 +00:00
// DirMove moves src, srcRemote to this remote at dstRemote
// using server side move operations.
2015-08-31 20:05:51 +00:00
//
// 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
2017-02-05 21:20:56 +00:00
func ( f * Fs ) DirMove ( src fs . Fs , srcRemote , dstRemote string ) error {
2015-11-07 11:14:46 +00:00
srcFs , ok := src . ( * Fs )
2015-08-31 20:05:51 +00:00
if ! ok {
2017-02-09 11:01:20 +00:00
fs . Debugf ( srcFs , "Can't move directory - not same remote type" )
2015-08-31 20:05:51 +00:00
return fs . ErrorCantDirMove
}
2017-02-05 21:20:56 +00:00
srcPath := path . Join ( srcFs . root , srcRemote )
dstPath := path . Join ( f . root , dstRemote )
2015-08-31 20:05:51 +00:00
2016-12-09 15:41:09 +00:00
// Refuse to move to or from the root
2017-02-05 21:20:56 +00:00
if srcPath == "" || dstPath == "" {
2017-02-09 11:01:20 +00:00
fs . Debugf ( src , "DirMove error: Can't move root" )
2016-12-09 15:41:09 +00:00
return errors . New ( "can't move root directory" )
}
2017-02-05 21:20:56 +00:00
// find the root src directory
err := srcFs . dirCache . FindRoot ( false )
if err != nil {
return err
}
// find the root dst directory
if dstRemote != "" {
err = f . dirCache . FindRoot ( true )
if err != nil {
return err
}
} else {
if f . dirCache . FoundRoot ( ) {
return fs . ErrorDirExists
}
}
// Find ID of dst parent, creating subdirs if necessary
2018-01-23 23:46:41 +00:00
var leaf , dstDirectoryID string
2017-02-05 21:20:56 +00:00
findPath := dstRemote
if dstRemote == "" {
findPath = f . root
}
2018-01-23 23:46:41 +00:00
leaf , dstDirectoryID , err = f . dirCache . FindPath ( findPath , true )
2017-02-05 21:20:56 +00:00
if err != nil {
return err
}
// Check destination does not exist
if dstRemote != "" {
_ , err = f . dirCache . FindDir ( dstRemote , false )
if err == fs . ErrorDirNotFound {
// OK
} else if err != nil {
return err
} else {
return fs . ErrorDirExists
}
}
2018-01-23 23:46:41 +00:00
// Find ID of src parent
2018-04-14 16:15:00 +00:00
var srcDirectoryID string
if srcRemote == "" {
srcDirectoryID , err = srcFs . dirCache . RootParentID ( )
} else {
_ , srcDirectoryID , err = srcFs . dirCache . FindPath ( srcRemote , false )
}
2018-01-23 23:46:41 +00:00
if err != nil {
return err
}
2018-04-14 16:15:00 +00:00
2017-02-05 21:20:56 +00:00
// Find ID of src
srcID , err := srcFs . dirCache . FindDir ( srcRemote , false )
2015-08-31 20:05:51 +00:00
if err != nil {
2015-09-03 20:25:55 +00:00
return err
2015-08-31 20:05:51 +00:00
}
// Do the move
patch := drive . File {
2018-01-23 23:46:41 +00:00
Name : leaf ,
2015-08-31 20:05:51 +00:00
}
2016-03-06 17:36:05 +00:00
err = f . pacer . Call ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
_ , err = f . svc . Files . Update ( srcID , & patch ) .
RemoveParents ( srcDirectoryID ) .
AddParents ( dstDirectoryID ) .
Fields ( "" ) .
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2016-03-06 17:36:05 +00:00
return shouldRetry ( err )
} )
2015-08-31 20:05:51 +00:00
if err != nil {
return err
}
2017-02-05 21:20:56 +00:00
srcFs . dirCache . FlushDir ( srcRemote )
2015-08-31 20:05:51 +00:00
return nil
}
2018-03-08 20:03:34 +00:00
// ChangeNotify calls the passed function with a path that has had changes.
// If the implementation uses polling, it should adhere to the given interval.
2017-05-25 21:05:49 +00:00
//
// Automatically restarts itself in case of unexpected behaviour of the remote.
//
// Close the returned channel to stop being notified.
2018-08-25 19:28:57 +00:00
func ( f * Fs ) ChangeNotify ( notifyFunc func ( string , fs . EntryType ) , pollIntervalChan <- chan time . Duration ) {
2017-05-25 21:05:49 +00:00
go func ( ) {
2018-08-25 19:28:57 +00:00
// get the StartPageToken early so all changes from now on get processed
startPageToken , err := f . changeNotifyStartPageToken ( )
if err != nil {
fs . Infof ( f , "Failed to get StartPageToken: %s" , err )
}
var ticker * time . Ticker
var tickerC <- chan time . Time
for {
select {
case pollInterval , ok := <- pollIntervalChan :
if ! ok {
if ticker != nil {
ticker . Stop ( )
}
return
}
if ticker != nil {
ticker . Stop ( )
ticker , tickerC = nil , nil
}
if pollInterval != 0 {
ticker = time . NewTicker ( pollInterval )
tickerC = ticker . C
}
case <- tickerC :
if startPageToken == "" {
startPageToken , err = f . changeNotifyStartPageToken ( )
if err != nil {
fs . Infof ( f , "Failed to get StartPageToken: %s" , err )
continue
}
}
fs . Debugf ( f , "Checking for changes on remote" )
startPageToken , err = f . changeNotifyRunner ( notifyFunc , startPageToken )
if err != nil {
fs . Infof ( f , "Change notify listener failure: %s" , err )
}
2017-05-25 21:05:49 +00:00
}
}
} ( )
}
2018-08-25 19:28:57 +00:00
func ( f * Fs ) changeNotifyStartPageToken ( ) ( pageToken string , err error ) {
2017-05-25 21:05:49 +00:00
var startPageToken * drive . StartPageToken
err = f . pacer . Call ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
startPageToken , err = f . svc . Changes . GetStartPageToken ( ) .
SupportsTeamDrives ( f . isTeamDrive ) .
Do ( )
2017-05-25 21:05:49 +00:00
return shouldRetry ( err )
} )
if err != nil {
return
}
2018-08-25 19:28:57 +00:00
return startPageToken . StartPageToken , nil
}
2017-05-25 21:05:49 +00:00
2018-08-25 19:28:57 +00:00
func ( f * Fs ) changeNotifyRunner ( notifyFunc func ( string , fs . EntryType ) , startPageToken string ) ( newStartPageToken string , err error ) {
pageToken := startPageToken
2017-05-25 21:05:49 +00:00
for {
2018-03-08 20:03:34 +00:00
var changeList * drive . ChangeList
2017-05-25 21:05:49 +00:00
err = f . pacer . Call ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
changesCall := f . svc . Changes . List ( pageToken ) .
Fields ( "nextPageToken,newStartPageToken,changes(fileId,file(name,parents,mimeType))" )
2018-05-14 17:06:57 +00:00
if f . opt . ListChunk > 0 {
changesCall . PageSize ( f . opt . ListChunk )
2017-05-25 21:05:49 +00:00
}
2018-06-07 10:35:55 +00:00
if f . isTeamDrive {
2018-05-14 17:06:57 +00:00
changesCall . TeamDriveId ( f . opt . TeamDriveID )
2018-06-07 10:35:55 +00:00
changesCall . SupportsTeamDrives ( true )
changesCall . IncludeTeamDriveItems ( true )
}
changeList , err = changesCall . Do ( )
2017-05-25 21:05:49 +00:00
return shouldRetry ( err )
} )
if err != nil {
return
}
2018-03-08 20:03:34 +00:00
type entryType struct {
path string
entryType fs . EntryType
}
var pathsToClear [ ] entryType
2018-01-23 23:46:41 +00:00
for _ , change := range changeList . Changes {
2017-05-25 21:05:49 +00:00
if path , ok := f . dirCache . GetInv ( change . FileId ) ; ok {
2018-03-08 20:03:34 +00:00
if change . File != nil && change . File . MimeType != driveFolderType {
pathsToClear = append ( pathsToClear , entryType { path : path , entryType : fs . EntryObject } )
} else {
pathsToClear = append ( pathsToClear , entryType { path : path , entryType : fs . EntryDirectory } )
}
continue
2017-05-25 21:05:49 +00:00
}
2018-05-02 13:12:47 +00:00
if change . File != nil {
changeType := fs . EntryDirectory
if change . File . MimeType != driveFolderType {
changeType = fs . EntryObject
}
2018-03-08 20:03:34 +00:00
// translate the parent dir of this object
if len ( change . File . Parents ) > 0 {
2018-09-25 15:50:33 +00:00
if parentPath , ok := f . dirCache . GetInv ( change . File . Parents [ 0 ] ) ; ok {
2018-03-08 20:03:34 +00:00
// and append the drive file name to compute the full file name
2018-09-25 15:50:33 +00:00
newPath := path . Join ( parentPath , change . File . Name )
2018-03-08 20:03:34 +00:00
// this will now clear the actual file too
2018-09-25 15:50:33 +00:00
pathsToClear = append ( pathsToClear , entryType { path : newPath , entryType : changeType } )
2017-05-25 21:05:49 +00:00
}
2018-03-08 20:03:34 +00:00
} else { // a true root object that is changed
2018-05-02 13:12:47 +00:00
pathsToClear = append ( pathsToClear , entryType { path : change . File . Name , entryType : changeType } )
2017-05-25 21:05:49 +00:00
}
}
}
2018-03-08 20:03:34 +00:00
2018-09-25 15:50:33 +00:00
visitedPaths := make ( map [ string ] struct { } )
2018-03-08 20:03:34 +00:00
for _ , entry := range pathsToClear {
if _ , ok := visitedPaths [ entry . path ] ; ok {
2017-05-25 21:05:49 +00:00
continue
}
2018-09-25 15:50:33 +00:00
visitedPaths [ entry . path ] = struct { } { }
2018-03-08 20:03:34 +00:00
notifyFunc ( entry . path , entry . entryType )
2017-05-25 21:05:49 +00:00
}
2018-08-25 19:28:57 +00:00
switch {
case changeList . NewStartPageToken != "" :
return changeList . NewStartPageToken , nil
case changeList . NextPageToken != "" :
2017-05-25 21:05:49 +00:00
pageToken = changeList . NextPageToken
2018-08-25 19:28:57 +00:00
default :
2017-05-25 21:05:49 +00:00
return
}
}
}
2016-12-09 15:39:29 +00:00
// DirCacheFlush resets the directory cache - used in testing as an
// optional interface
func ( f * Fs ) DirCacheFlush ( ) {
f . dirCache . ResetRoot ( )
}
2016-01-11 12:39:33 +00:00
// Hashes returns the supported hash sets.
2018-01-12 16:30:54 +00:00
func ( f * Fs ) Hashes ( ) hash . Set {
2018-01-18 20:27:52 +00:00
return hash . Set ( hash . MD5 )
2016-01-11 12:39:33 +00:00
}
2013-01-14 23:38:18 +00:00
// ------------------------------------------------------------
2015-09-22 17:47:16 +00:00
// Fs returns the parent Fs
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) Fs ( ) fs . Info {
2015-11-07 11:14:46 +00:00
return o . fs
2014-03-28 17:56:04 +00:00
}
2018-08-21 10:49:33 +00:00
// Return a string version
func ( o * baseObject ) String ( ) string {
return o . remote
}
2014-03-28 17:56:04 +00:00
// Return a string version
2015-11-07 11:14:46 +00:00
func ( o * Object ) String ( ) string {
2014-03-28 17:56:04 +00:00
if o == nil {
return "<nil>"
}
return o . remote
}
2015-09-22 17:47:16 +00:00
// Remote returns the remote path
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) Remote ( ) string {
2013-06-27 19:13:07 +00:00
return o . remote
2013-01-14 23:38:18 +00:00
}
2016-01-11 12:39:33 +00:00
// Hash returns the Md5sum of an object returning a lowercase hex string
2018-01-12 16:30:54 +00:00
func ( o * Object ) Hash ( t hash . Type ) ( string , error ) {
2018-01-18 20:27:52 +00:00
if t != hash . MD5 {
return "" , hash . ErrUnsupported
2016-01-11 12:39:33 +00:00
}
2013-06-27 19:13:07 +00:00
return o . md5sum , nil
2013-01-14 23:38:18 +00:00
}
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) Hash ( t hash . Type ) ( string , error ) {
if t != hash . MD5 {
return "" , hash . ErrUnsupported
}
return "" , nil
}
2013-01-14 23:38:18 +00:00
// Size returns the size of an object in bytes
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) Size ( ) int64 {
2013-06-27 19:13:07 +00:00
return o . bytes
2013-01-19 10:11:55 +00:00
}
2018-08-21 10:49:33 +00:00
// getRemoteInfo returns a drive.File for the remote
func ( f * Fs ) getRemoteInfo ( remote string ) ( info * drive . File , err error ) {
info , _ , _ , _ , _ , err = f . getRemoteInfoWithExport ( remote )
return
2018-07-24 15:14:23 +00:00
}
2018-08-21 10:49:33 +00:00
// getRemoteInfoWithExport returns a drive.File and the export settings for the remote
func ( f * Fs ) getRemoteInfoWithExport ( remote string ) (
info * drive . File , extension , exportName , exportMimeType string , isDocument bool , err error ) {
leaf , directoryID , err := f . dirCache . FindRootAndPath ( remote , false )
2013-01-14 23:38:18 +00:00
if err != nil {
2016-06-25 20:23:20 +00:00
if err == fs . ErrorDirNotFound {
2018-08-21 10:49:33 +00:00
return nil , "" , "" , "" , false , fs . ErrorObjectNotFound
2016-06-25 20:23:20 +00:00
}
2018-08-21 10:49:33 +00:00
return nil , "" , "" , "" , false , err
2013-01-14 23:38:18 +00:00
}
2018-08-21 10:49:33 +00:00
found , err := f . list ( [ ] string { directoryID } , leaf , false , true , false , func ( item * drive . File ) bool {
if ! f . opt . SkipGdocs {
extension , exportName , exportMimeType , isDocument = f . findExportFormat ( item )
2018-07-24 15:14:23 +00:00
if exportName == leaf {
2018-08-21 10:49:33 +00:00
info = item
2018-07-24 15:14:23 +00:00
return true
}
2018-08-21 10:49:33 +00:00
if isDocument {
return false
}
}
if item . Name == leaf {
info = item
return true
2018-07-24 15:14:23 +00:00
}
2013-01-20 11:56:56 +00:00
return false
} )
2013-01-14 23:38:18 +00:00
if err != nil {
2018-08-21 10:49:33 +00:00
return nil , "" , "" , "" , false , err
2013-01-14 23:38:18 +00:00
}
2013-01-20 11:56:56 +00:00
if ! found {
2018-08-21 10:49:33 +00:00
return nil , "" , "" , "" , false , fs . ErrorObjectNotFound
2013-01-14 23:38:18 +00:00
}
2018-08-21 10:49:33 +00:00
return
2013-01-14 23:38:18 +00:00
}
// 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
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) ModTime ( ) time . Time {
2014-07-29 16:50:07 +00:00
modTime , err := time . Parse ( timeFormatIn , o . modifiedDate )
2013-01-14 23:38:18 +00:00
if err != nil {
2017-02-09 17:08:51 +00:00
fs . Debugf ( o , "Failed to read mtime from object: %v" , err )
2013-01-14 23:38:18 +00:00
return time . Now ( )
}
return modTime
}
2015-09-22 17:47:16 +00:00
// SetModTime sets the modification time of the drive fs object
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) SetModTime ( modTime time . Time ) error {
2013-01-19 10:11:55 +00:00
// New metadata
2015-02-02 17:29:08 +00:00
updateInfo := & drive . File {
2018-01-23 23:46:41 +00:00
ModifiedTime : modTime . Format ( timeFormatOut ) ,
2013-01-19 10:11:55 +00:00
}
2013-01-14 23:38:18 +00:00
// Set modified date
2015-02-02 17:29:08 +00:00
var info * drive . File
2018-08-21 10:49:33 +00:00
err := o . fs . pacer . Call ( func ( ) ( bool , error ) {
var err error
2018-08-05 10:27:17 +00:00
info , err = o . fs . svc . Files . Update ( o . id , updateInfo ) .
2018-09-01 11:16:01 +00:00
Fields ( partialFields ) .
2018-08-05 10:27:17 +00:00
SupportsTeamDrives ( o . fs . isTeamDrive ) .
Do ( )
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
2015-02-02 17:29:08 +00:00
} )
2013-01-14 23:38:18 +00:00
if err != nil {
2016-03-22 15:07:10 +00:00
return err
2013-01-14 23:38:18 +00:00
}
2015-01-04 23:19:59 +00:00
// Update info from read data
2018-08-21 10:49:33 +00:00
o . modifiedDate = info . ModifiedTime
2016-03-22 15:07:10 +00:00
return nil
2013-01-14 23:38:18 +00:00
}
2015-09-22 17:47:16 +00:00
// Storable returns a boolean as to whether this object is storable
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) Storable ( ) bool {
2013-01-14 23:38:18 +00:00
return true
}
2018-08-21 10:49:33 +00:00
// httpResponse gets an http.Response object for the object
// using the url and method passed in
func ( o * baseObject ) httpResponse ( url , method string , options [ ] fs . OpenOption ) ( req * http . Request , res * http . Response , err error ) {
if url == "" {
2016-09-10 10:29:57 +00:00
return nil , nil , errors . New ( "forbidden to download - check sharing permission" )
2015-08-16 13:11:21 +00:00
}
2018-08-21 10:49:33 +00:00
req , err = http . NewRequest ( method , url , nil )
2014-07-15 10:15:48 +00:00
if err != nil {
2016-09-10 10:29:57 +00:00
return req , nil , err
2014-07-15 10:15:48 +00:00
}
2016-09-10 10:29:57 +00:00
fs . OpenOptionAddHTTPHeaders ( req . Header , options )
2015-11-07 11:14:46 +00:00
err = o . fs . pacer . Call ( func ( ) ( bool , error ) {
res , err = o . fs . client . Do ( req )
2018-04-11 19:46:50 +00:00
if err == nil {
err = googleapi . CheckResponse ( res )
if err != nil {
_ = res . Body . Close ( ) // ignore error
}
}
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
2015-02-02 17:29:08 +00:00
} )
2013-01-14 23:38:18 +00:00
if err != nil {
2016-09-10 10:29:57 +00:00
return req , nil , err
2013-01-14 23:38:18 +00:00
}
2016-09-10 10:29:57 +00:00
return req , res , nil
2016-01-26 16:52:53 +00:00
}
2018-08-21 10:49:33 +00:00
// openDocumentFile represents an documentObject open for reading.
// Updates the object size after read successfully.
type openDocumentFile struct {
o * documentObject // Object we are reading for
in io . ReadCloser // reading from here
bytes int64 // number of bytes read on this connection
eof bool // whether we have read end of file
errored bool // whether we have encountered an error during reading
2016-01-26 16:52:53 +00:00
}
// Read bytes from the object - see io.Reader
2018-08-21 10:49:33 +00:00
func ( file * openDocumentFile ) Read ( p [ ] byte ) ( n int , err error ) {
2016-01-26 16:52:53 +00:00
n , err = file . in . Read ( p )
file . bytes += int64 ( n )
2018-01-23 23:46:41 +00:00
if err != nil && err != io . EOF {
file . errored = true
}
2016-01-26 16:52:53 +00:00
if err == io . EOF {
file . eof = true
}
return
}
// Close the object and update bytes read
2018-08-21 10:49:33 +00:00
func ( file * openDocumentFile ) Close ( ) ( err error ) {
2016-01-26 16:52:53 +00:00
// If end of file, update bytes read
2018-01-23 23:46:41 +00:00
if file . eof && ! file . errored {
fs . Debugf ( file . o , "Updating size of doc after download to %v" , file . bytes )
2016-01-26 16:52:53 +00:00
file . o . bytes = file . bytes
}
return file . in . Close ( )
}
// Check it satisfies the interfaces
2018-08-21 10:49:33 +00:00
var _ io . ReadCloser = ( * openDocumentFile ) ( nil )
2016-01-26 16:52:53 +00:00
2018-06-08 15:05:25 +00:00
// Checks to see if err is a googleapi.Error with of type what
func isGoogleError ( err error , what string ) bool {
if gerr , ok := err . ( * googleapi . Error ) ; ok {
for _ , error := range gerr . Errors {
if error . Reason == what {
return true
}
}
}
return false
}
2018-08-21 10:49:33 +00:00
// open a url for reading
func ( o * baseObject ) open ( url string , options ... fs . OpenOption ) ( in io . ReadCloser , err error ) {
_ , res , err := o . httpResponse ( url , "GET" , options )
2016-01-26 16:52:53 +00:00
if err != nil {
2018-06-08 15:05:25 +00:00
if isGoogleError ( err , "cannotDownloadAbusiveFile" ) {
2018-05-14 17:06:57 +00:00
if o . fs . opt . AcknowledgeAbuse {
2018-06-08 15:05:25 +00:00
// Retry acknowledging abuse
2018-08-21 10:49:33 +00:00
if strings . ContainsRune ( url , '?' ) {
url += "&"
2018-06-08 15:05:25 +00:00
} else {
2018-08-21 10:49:33 +00:00
url += "?"
2018-06-08 15:05:25 +00:00
}
2018-08-21 10:49:33 +00:00
url += "acknowledgeAbuse=true"
_ , res , err = o . httpResponse ( url , "GET" , options )
2018-06-08 15:05:25 +00:00
} else {
err = errors . Wrap ( err , "Use the --drive-acknowledge-abuse flag to download this file" )
}
}
if err != nil {
return nil , errors . Wrap ( err , "open file failed" )
}
2013-01-14 23:38:18 +00:00
}
return res . Body , nil
}
2018-08-21 10:49:33 +00:00
// Open an object for read
func ( o * Object ) Open ( options ... fs . OpenOption ) ( in io . ReadCloser , err error ) {
if o . v2Download {
var v2File * drive_v2 . File
err = o . fs . pacer . Call ( func ( ) ( bool , error ) {
v2File , err = o . fs . v2Svc . Files . Get ( o . id ) .
Fields ( "downloadUrl" ) .
SupportsTeamDrives ( o . fs . isTeamDrive ) .
Do ( )
return shouldRetry ( err )
} )
if err == nil {
fs . Debugf ( o , "Using v2 download: %v" , v2File . DownloadUrl )
o . url = v2File . DownloadUrl
o . v2Download = false
}
2014-04-18 16:04:21 +00:00
}
2018-08-21 10:49:33 +00:00
return o . baseObject . open ( o . url , options ... )
}
func ( o * documentObject ) Open ( options ... fs . OpenOption ) ( in io . ReadCloser , err error ) {
// Update the size with what we are reading as it can change from
// the HEAD in the listing to this GET. This stops rclone marking
// the transfer as corrupted.
for _ , o := range options {
// https://developers.google.com/drive/v3/web/manage-downloads#partial_download
if _ , ok := o . ( * fs . RangeOption ) ; ok {
return nil , errors . New ( "partial downloads are not supported while exporting Google Documents" )
2018-08-19 14:16:11 +00:00
}
}
2018-08-21 10:49:33 +00:00
in , err = o . baseObject . open ( o . url , options ... )
if in != nil {
in = & openDocumentFile { o : o , in : in }
}
return
}
2018-08-21 10:51:36 +00:00
func ( o * linkObject ) Open ( options ... fs . OpenOption ) ( in io . ReadCloser , err error ) {
var offset , limit int64 = 0 , - 1
var data = o . content
for _ , option := range options {
switch x := option . ( type ) {
case * fs . SeekOption :
offset = x . Offset
case * fs . RangeOption :
offset , limit = x . Decode ( int64 ( len ( data ) ) )
default :
if option . Mandatory ( ) {
fs . Logf ( o , "Unsupported mandatory option: %v" , option )
}
}
}
if l := int64 ( len ( data ) ) ; offset > l {
offset = l
}
data = data [ offset : ]
if limit != - 1 && limit < int64 ( len ( data ) ) {
data = data [ : limit ]
}
return ioutil . NopCloser ( bytes . NewReader ( data ) ) , nil
}
2018-08-19 14:16:11 +00:00
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) update ( updateInfo * drive . File , uploadMimeType string , in io . Reader ,
src fs . ObjectInfo ) ( info * drive . File , err error ) {
2014-04-18 16:46:57 +00:00
// Make the API request to upload metadata and file data.
2018-08-21 10:49:33 +00:00
size := src . Size ( )
2018-05-14 17:06:57 +00:00
if size == 0 || size < int64 ( o . fs . opt . UploadCutoff ) {
2015-03-02 09:05:23 +00:00
// Don't retry, return a retry error instead
2015-11-07 11:14:46 +00:00
err = o . fs . pacer . CallNoRetry ( func ( ) ( bool , error ) {
2018-08-05 10:27:17 +00:00
info , err = o . fs . svc . Files . Update ( o . id , updateInfo ) .
2018-08-21 10:49:33 +00:00
Media ( in , googleapi . ContentType ( uploadMimeType ) ) .
2018-09-01 11:16:01 +00:00
Fields ( partialFields ) .
2018-08-05 10:27:17 +00:00
SupportsTeamDrives ( o . fs . isTeamDrive ) .
KeepRevisionForever ( o . fs . opt . KeepRevisionForever ) .
Do ( )
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
} )
2018-08-21 10:49:33 +00:00
return
2014-04-18 16:04:21 +00:00
}
2018-08-21 10:49:33 +00:00
// Upload the file in chunks
2018-09-01 11:16:01 +00:00
return o . fs . Upload ( in , size , uploadMimeType , o . id , o . remote , updateInfo )
2018-08-21 10:49:33 +00:00
}
// 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
func ( o * Object ) Update ( in io . Reader , src fs . ObjectInfo , options ... fs . OpenOption ) error {
srcMimeType := fs . MimeType ( src )
updateInfo := & drive . File {
MimeType : srcMimeType ,
ModifiedTime : src . ModTime ( ) . Format ( timeFormatOut ) ,
}
info , err := o . baseObject . update ( updateInfo , srcMimeType , in , src )
if err != nil {
return err
}
newO , err := o . fs . newObjectWithInfo ( src . Remote ( ) , info )
switch newO := newO . ( type ) {
case * Object :
* o = * newO
default :
return errors . New ( "object type changed by update" )
}
return nil
}
func ( o * documentObject ) Update ( in io . Reader , src fs . ObjectInfo , options ... fs . OpenOption ) error {
srcMimeType := fs . MimeType ( src )
importMimeType := ""
updateInfo := & drive . File {
MimeType : srcMimeType ,
ModifiedTime : src . ModTime ( ) . Format ( timeFormatOut ) ,
}
if o . fs . importMimeTypes == nil || o . fs . opt . SkipGdocs {
return errors . Errorf ( "can't update google document type without --drive-import-formats" )
}
importMimeType = o . fs . findImportFormat ( updateInfo . MimeType )
if importMimeType == "" {
return errors . Errorf ( "no import format found for %q" , srcMimeType )
}
if importMimeType != o . documentMimeType {
return errors . Errorf ( "can't change google document type (o: %q, src: %q, import: %q)" , o . documentMimeType , srcMimeType , importMimeType )
}
updateInfo . MimeType = importMimeType
info , err := o . baseObject . update ( updateInfo , srcMimeType , in , src )
if err != nil {
return err
}
remote := src . Remote ( )
remote = remote [ : len ( remote ) - o . extLen ]
newO , err := o . fs . newObjectWithInfo ( remote , info )
switch newO := newO . ( type ) {
case * documentObject :
* o = * newO
default :
return errors . New ( "object type changed by update" )
2018-08-19 14:16:11 +00:00
}
2014-04-18 16:04:21 +00:00
return nil
}
2018-08-21 10:51:36 +00:00
func ( o * linkObject ) Update ( in io . Reader , src fs . ObjectInfo , options ... fs . OpenOption ) error {
return errors . New ( "cannot update link files" )
}
2013-01-14 23:38:18 +00:00
// Remove an object
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) Remove ( ) error {
2015-02-02 17:29:08 +00:00
var err error
2015-11-07 11:14:46 +00:00
err = o . fs . pacer . Call ( func ( ) ( bool , error ) {
2018-05-14 17:06:57 +00:00
if o . fs . opt . UseTrash {
2018-01-23 23:46:41 +00:00
info := drive . File {
Trashed : true ,
}
2018-08-05 10:27:17 +00:00
_ , err = o . fs . svc . Files . Update ( o . id , & info ) .
Fields ( "" ) .
SupportsTeamDrives ( o . fs . isTeamDrive ) .
Do ( )
2015-08-16 13:49:58 +00:00
} else {
2018-08-05 10:27:17 +00:00
err = o . fs . svc . Files . Delete ( o . id ) .
Fields ( "" ) .
SupportsTeamDrives ( o . fs . isTeamDrive ) .
Do ( )
2015-08-16 13:49:58 +00:00
}
2015-09-11 18:18:41 +00:00
return shouldRetry ( err )
2015-02-02 17:29:08 +00:00
} )
return err
2013-01-14 23:38:18 +00:00
}
2016-09-21 21:13:24 +00:00
// MimeType of an Object if known, "" otherwise
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) MimeType ( ) string {
2016-09-21 21:13:24 +00:00
return o . mimeType
}
2018-05-13 08:16:56 +00:00
// ID returns the ID of the Object if known, or "" if not
2018-08-21 10:49:33 +00:00
func ( o * baseObject ) ID ( ) string {
2018-05-13 08:16:56 +00:00
return o . id
}
2018-09-01 11:16:01 +00:00
func ( o * documentObject ) ext ( ) string {
return o . baseObject . remote [ len ( o . baseObject . remote ) - o . extLen : ]
}
func ( o * linkObject ) ext ( ) string {
return o . baseObject . remote [ len ( o . baseObject . remote ) - o . extLen : ]
}
2018-08-21 10:51:36 +00:00
// templates for document link files
const (
urlTemplate = ` [ InternetShortcut ] { { "\r" } }
URL = { { . URL } } { { "\r" } }
`
weblocTemplate = ` < ? xml version = "1.0" encoding = "UTF-8" ? >
< ! DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd" >
< plist version = "1.0" >
< dict >
< key > URL < / key >
< string > { { . URL } } < / string >
< / dict >
< / plist >
`
desktopTemplate = ` [ Desktop Entry ]
Encoding = UTF - 8
Name = { { . Title } }
URL = { { . URL } }
Icon = text - html
Type = Link
`
htmlTemplate = ` < html >
< head >
< meta http - equiv = "refresh" content = "0; url={{ .URL }}" / >
< title > { { . Title } } < / title >
< / head >
< body >
Loading < a href = "{{ .URL }}" > { { . Title } } < / a >
< / body >
< / html >
`
)
2013-01-14 23:38:18 +00:00
// Check the interfaces are satisfied
2015-08-31 20:05:51 +00:00
var (
2018-03-08 20:03:34 +00:00
_ fs . Fs = ( * Fs ) ( nil )
_ fs . Purger = ( * Fs ) ( nil )
_ fs . CleanUpper = ( * Fs ) ( nil )
_ fs . PutStreamer = ( * Fs ) ( nil )
_ fs . Copier = ( * Fs ) ( nil )
_ fs . Mover = ( * Fs ) ( nil )
_ fs . DirMover = ( * Fs ) ( nil )
_ fs . DirCacheFlusher = ( * Fs ) ( nil )
_ fs . ChangeNotifier = ( * Fs ) ( nil )
_ fs . PutUncheckeder = ( * Fs ) ( nil )
2018-03-29 07:10:19 +00:00
_ fs . PublicLinker = ( * Fs ) ( nil )
2018-07-26 13:45:41 +00:00
_ fs . ListRer = ( * Fs ) ( nil )
2018-03-08 20:03:34 +00:00
_ fs . MergeDirser = ( * Fs ) ( nil )
2018-04-16 21:19:25 +00:00
_ fs . Abouter = ( * Fs ) ( nil )
2018-03-08 20:03:34 +00:00
_ fs . Object = ( * Object ) ( nil )
2018-04-16 21:19:25 +00:00
_ fs . MimeTyper = ( * Object ) ( nil )
2018-05-13 08:16:56 +00:00
_ fs . IDer = ( * Object ) ( nil )
2018-08-21 10:49:33 +00:00
_ fs . Object = ( * documentObject ) ( nil )
_ fs . MimeTyper = ( * documentObject ) ( nil )
_ fs . IDer = ( * documentObject ) ( nil )
2018-08-21 10:51:36 +00:00
_ fs . Object = ( * linkObject ) ( nil )
_ fs . MimeTyper = ( * linkObject ) ( nil )
_ fs . IDer = ( * linkObject ) ( nil )
2015-08-31 20:05:51 +00:00
)