2018-08-02 01:02:35 +02:00
package jottacloud
import (
2018-08-14 23:15:21 +02:00
"bytes"
2019-06-17 10:34:30 +02:00
"context"
2018-08-14 23:15:21 +02:00
"crypto/md5"
2019-11-20 00:10:38 +01:00
"encoding/base64"
2018-08-14 23:15:21 +02:00
"encoding/hex"
2019-11-20 00:10:38 +01:00
"encoding/json"
2018-08-02 01:02:35 +02:00
"fmt"
"io"
2018-08-14 23:15:21 +02:00
"io/ioutil"
2020-06-11 13:02:28 +02:00
"math/rand"
2018-08-02 01:02:35 +02:00
"net/http"
"net/url"
2018-08-14 23:15:21 +02:00
"os"
2018-08-02 01:02:35 +02:00
"path"
"strconv"
"strings"
"time"
"github.com/pkg/errors"
2019-07-28 19:47:38 +02:00
"github.com/rclone/rclone/backend/jottacloud/api"
"github.com/rclone/rclone/fs"
"github.com/rclone/rclone/fs/accounting"
"github.com/rclone/rclone/fs/config"
"github.com/rclone/rclone/fs/config/configmap"
"github.com/rclone/rclone/fs/config/configstruct"
2020-06-11 13:02:28 +02:00
"github.com/rclone/rclone/fs/config/obscure"
2019-07-28 19:47:38 +02:00
"github.com/rclone/rclone/fs/fserrors"
"github.com/rclone/rclone/fs/fshttp"
"github.com/rclone/rclone/fs/hash"
"github.com/rclone/rclone/fs/walk"
2020-01-14 18:33:35 +01:00
"github.com/rclone/rclone/lib/encoder"
2019-07-28 19:47:38 +02:00
"github.com/rclone/rclone/lib/oauthutil"
"github.com/rclone/rclone/lib/pacer"
"github.com/rclone/rclone/lib/rest"
2018-08-22 22:26:18 +02:00
"golang.org/x/oauth2"
2018-08-02 01:02:35 +02:00
)
// Globals
const (
2020-06-11 13:02:28 +02:00
minSleep = 10 * time . Millisecond
maxSleep = 2 * time . Second
decayConstant = 2 // bigger for slower decay, exponential
defaultDevice = "Jotta"
defaultMountpoint = "Archive"
2020-06-10 21:49:29 +02:00
rootURL = "https://jfs.jottacloud.com/jfs/"
2020-06-11 13:02:28 +02:00
apiURL = "https://api.jottacloud.com/"
baseURL = "https://www.jottacloud.com/"
cachePrefix = "rclone-jcmd5-"
configDevice = "device"
configMountpoint = "mountpoint"
configTokenURL = "tokenURL"
configClientID = "client_id"
configClientSecret = "client_secret"
2021-04-29 10:28:18 +02:00
configUsername = "username"
2020-06-11 13:02:28 +02:00
configVersion = 1
2021-05-04 15:13:12 +02:00
defaultTokenURL = "https://id.jottacloud.com/auth/realms/jottacloud/protocol/openid-connect/token"
defaultClientID = "jottacli"
legacyTokenURL = "https://api.jottacloud.com/auth/v1/token"
legacyRegisterURL = "https://api.jottacloud.com/auth/v1/register"
legacyClientID = "nibfk8biu12ju7hpqomr8b1e40"
legacyEncryptedClientSecret = "Vp8eAv7eVElMnQwN-kgU9cbhgApNDaMqWdlDi5qFydlQoji4JBxrGMF2"
legacyConfigVersion = 0
2021-01-17 02:38:57 +01:00
teliaCloudTokenURL = "https://cloud-auth.telia.se/auth/realms/telia_se/protocol/openid-connect/token"
teliaCloudAuthURL = "https://cloud-auth.telia.se/auth/realms/telia_se/protocol/openid-connect/auth"
teliaCloudClientID = "desktop"
2018-08-22 22:26:18 +02:00
)
2018-08-02 01:02:35 +02:00
// Register with Fs
func init ( ) {
2019-05-17 02:31:59 +02:00
// needs to be done early so we can use oauth during config
2018-08-02 01:02:35 +02:00
fs . Register ( & fs . RegInfo {
Name : "jottacloud" ,
2020-05-20 12:54:33 +02:00
Description : "Jottacloud" ,
2018-08-02 01:02:35 +02:00
NewFs : NewFs ,
2021-04-29 10:28:18 +02:00
Config : Config ,
2018-08-02 01:02:35 +02:00
Options : [ ] fs . Option { {
2018-08-14 23:15:21 +02:00
Name : "md5_memory_limit" ,
2018-08-20 16:38:21 +02:00
Help : "Files bigger than this will be cached on disk to calculate the MD5 if required." ,
2018-08-14 23:15:21 +02:00
Default : fs . SizeSuffix ( 10 * 1024 * 1024 ) ,
Advanced : true ,
2020-04-11 12:11:20 +02:00
} , {
Name : "trashed_only" ,
Help : "Only show files that are in the trash.\nThis will show trashed files in their original directory structure." ,
Default : false ,
Advanced : true ,
2018-09-07 13:58:18 +02:00
} , {
Name : "hard_delete" ,
Help : "Delete files permanently rather than putting them into the trash." ,
Default : false ,
Advanced : true ,
2018-08-22 22:26:18 +02:00
} , {
Name : "upload_resume_limit" ,
2019-02-07 18:41:17 +01:00
Help : "Files bigger than this can be resumed if the upload fail's." ,
2018-08-22 22:26:18 +02:00
Default : fs . SizeSuffix ( 10 * 1024 * 1024 ) ,
Advanced : true ,
2021-07-01 23:17:05 +02:00
} , {
Name : "no_versions" ,
Help : "Avoid server side versioning by deleting files and recreating files instead of overwriting them." ,
Default : false ,
Advanced : true ,
2020-01-14 18:33:35 +01:00
} , {
Name : config . ConfigEncoding ,
Help : config . ConfigEncodingHelp ,
Advanced : true ,
2020-01-14 22:51:49 +01:00
// Encode invalid UTF-8 bytes as xml doesn't handle them properly.
//
// Also: '*', '/', ':', '<', '>', '?', '\"', '\x00', '|'
Default : ( encoder . Display |
encoder . EncodeWin | // :?"*<>|
encoder . EncodeInvalidUtf8 ) ,
2018-08-02 01:02:35 +02:00
} } ,
} )
}
2021-04-29 10:28:18 +02:00
// Config runs the backend configuration protocol
func Config ( ctx context . Context , name string , m configmap . Mapper , config fs . ConfigIn ) ( * fs . ConfigOut , error ) {
switch config . State {
case "" :
2021-05-04 13:27:50 +02:00
return fs . ConfigChooseFixed ( "auth_type_done" , "config_type" , ` Authentication type ` , [ ] fs . OptionExample { {
2021-04-29 10:28:18 +02:00
Value : "standard" ,
Help : "Standard authentication - use this if you're a normal Jottacloud user." ,
} , {
Value : "legacy" ,
Help : "Legacy authentication - this is only required for certain whitelabel versions of Jottacloud and not recommended for normal users." ,
} , {
Value : "telia" ,
Help : "Telia Cloud authentication - use this if you are using Telia Cloud." ,
} } )
case "auth_type_done" :
// Jump to next state according to config chosen
return fs . ConfigGoto ( config . Result )
case "standard" : // configure a jottacloud backend using the modern JottaCli token based authentication
m . Set ( "configVersion" , fmt . Sprint ( configVersion ) )
2021-05-04 13:27:50 +02:00
return fs . ConfigInput ( "standard_token" , "config_login_token" , "Personal login token.\n\nGenerate here: https://www.jottacloud.com/web/secure" )
2021-04-29 10:28:18 +02:00
case "standard_token" :
loginToken := config . Result
2021-05-04 15:13:12 +02:00
m . Set ( configClientID , defaultClientID )
2021-04-29 10:28:18 +02:00
m . Set ( configClientSecret , "" )
srv := rest . NewClient ( fshttp . NewClient ( ctx ) )
2021-05-04 15:13:12 +02:00
token , tokenEndpoint , err := doTokenAuth ( ctx , srv , loginToken )
2021-04-29 10:28:18 +02:00
if err != nil {
return nil , errors . Wrap ( err , "failed to get oauth token" )
}
2021-05-04 15:13:12 +02:00
m . Set ( configTokenURL , tokenEndpoint )
2021-04-29 10:28:18 +02:00
err = oauthutil . PutToken ( name , m , & token , true )
if err != nil {
return nil , errors . Wrap ( err , "error while saving token" )
}
return fs . ConfigGoto ( "choose_device" )
case "legacy" : // configure a jottacloud backend using legacy authentication
2021-05-04 15:13:12 +02:00
m . Set ( "configVersion" , fmt . Sprint ( legacyConfigVersion ) )
2021-05-04 13:27:50 +02:00
return fs . ConfigConfirm ( "legacy_api" , false , "config_machine_specific" , ` Do you want to create a machine specific API key ?
2021-04-29 10:28:18 +02:00
Rclone has it ' s own Jottacloud API KEY which works fine as long as one
only uses rclone on a single machine . When you want to use rclone with
this account on more than one machine it ' s recommended to create a
machine specific API key . These keys can NOT be shared between
machines . ` )
case "legacy_api" :
srv := rest . NewClient ( fshttp . NewClient ( ctx ) )
if config . Result == "true" {
deviceRegistration , err := registerDevice ( ctx , srv )
if err != nil {
return nil , errors . Wrap ( err , "failed to register device" )
}
m . Set ( configClientID , deviceRegistration . ClientID )
m . Set ( configClientSecret , obscure . MustObscure ( deviceRegistration . ClientSecret ) )
fs . Debugf ( nil , "Got clientID %q and clientSecret %q" , deviceRegistration . ClientID , deviceRegistration . ClientSecret )
}
2021-05-04 15:13:12 +02:00
return fs . ConfigInput ( "legacy_username" , "config_username" , "Username (e-mail address)" )
2021-04-29 10:28:18 +02:00
case "legacy_username" :
m . Set ( configUsername , config . Result )
2021-05-04 15:13:12 +02:00
return fs . ConfigPassword ( "legacy_password" , "config_password" , "Password (only used in setup, will not be stored)" )
2021-04-29 10:28:18 +02:00
case "legacy_password" :
m . Set ( "password" , config . Result )
m . Set ( "auth_code" , "" )
return fs . ConfigGoto ( "legacy_do_auth" )
case "legacy_auth_code" :
authCode := strings . Replace ( config . Result , "-" , "" , - 1 ) // remove any "-" contained in the code so we have a 6 digit number
m . Set ( "auth_code" , authCode )
return fs . ConfigGoto ( "legacy_do_auth" )
case "legacy_do_auth" :
username , _ := m . Get ( configUsername )
password , _ := m . Get ( "password" )
2021-05-04 15:13:12 +02:00
password = obscure . MustReveal ( password )
2021-04-29 10:28:18 +02:00
authCode , _ := m . Get ( "auth_code" )
2021-05-04 15:13:12 +02:00
srv := rest . NewClient ( fshttp . NewClient ( ctx ) )
2021-04-29 10:28:18 +02:00
clientID , ok := m . Get ( configClientID )
if ! ok {
2021-05-04 15:13:12 +02:00
clientID = legacyClientID
2021-04-29 10:28:18 +02:00
}
clientSecret , ok := m . Get ( configClientSecret )
if ! ok {
2021-05-04 15:13:12 +02:00
clientSecret = legacyEncryptedClientSecret
2021-04-29 10:28:18 +02:00
}
2021-05-04 15:13:12 +02:00
oauthConfig := & oauth2 . Config {
Endpoint : oauth2 . Endpoint {
AuthURL : legacyTokenURL ,
} ,
ClientID : clientID ,
ClientSecret : obscure . MustReveal ( clientSecret ) ,
}
token , err := doLegacyAuth ( ctx , srv , oauthConfig , username , password , authCode )
2021-04-29 10:28:18 +02:00
if err == errAuthCodeRequired {
2021-05-04 13:27:50 +02:00
return fs . ConfigInput ( "legacy_auth_code" , "config_auth_code" , "Verification Code\nThis account uses 2 factor authentication you will receive a verification code via SMS." )
2021-04-29 10:28:18 +02:00
}
m . Set ( "password" , "" )
m . Set ( "auth_code" , "" )
if err != nil {
return nil , errors . Wrap ( err , "failed to get oauth token" )
}
err = oauthutil . PutToken ( name , m , & token , true )
if err != nil {
return nil , errors . Wrap ( err , "error while saving token" )
}
return fs . ConfigGoto ( "choose_device" )
case "telia" : // telia cloud config
m . Set ( "configVersion" , fmt . Sprint ( configVersion ) )
m . Set ( configClientID , teliaCloudClientID )
m . Set ( configTokenURL , teliaCloudTokenURL )
return oauthutil . ConfigOut ( "choose_device" , & oauthutil . Options {
OAuth2Config : & oauth2 . Config {
Endpoint : oauth2 . Endpoint {
AuthURL : teliaCloudAuthURL ,
TokenURL : teliaCloudTokenURL ,
} ,
ClientID : teliaCloudClientID ,
Scopes : [ ] string { "openid" , "jotta-default" , "offline_access" } ,
RedirectURL : oauthutil . RedirectLocalhostURL ,
} ,
} )
case "choose_device" :
2021-05-04 13:27:50 +02:00
return fs . ConfigConfirm ( "choose_device_query" , false , "config_non_standard" , "Use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client?" )
2021-04-29 10:28:18 +02:00
case "choose_device_query" :
if config . Result != "true" {
m . Set ( configDevice , "" )
m . Set ( configMountpoint , "" )
return fs . ConfigGoto ( "end" )
}
oAuthClient , _ , err := getOAuthClient ( ctx , name , m )
if err != nil {
return nil , err
}
srv := rest . NewClient ( oAuthClient ) . SetRoot ( rootURL )
apiSrv := rest . NewClient ( oAuthClient ) . SetRoot ( apiURL )
cust , err := getCustomerInfo ( ctx , apiSrv )
if err != nil {
return nil , err
}
m . Set ( configUsername , cust . Username )
acc , err := getDriveInfo ( ctx , srv , cust . Username )
if err != nil {
return nil , err
}
2021-05-04 13:27:50 +02:00
return fs . ConfigChoose ( "choose_device_result" , "config_device" , ` Please select the device to use. Normally this will be Jotta ` , len ( acc . Devices ) , func ( i int ) ( string , string ) {
2021-04-29 10:28:18 +02:00
return acc . Devices [ i ] . Name , ""
} )
case "choose_device_result" :
device := config . Result
m . Set ( configDevice , device )
oAuthClient , _ , err := getOAuthClient ( ctx , name , m )
if err != nil {
return nil , err
}
srv := rest . NewClient ( oAuthClient ) . SetRoot ( rootURL )
username , _ := m . Get ( configUsername )
dev , err := getDeviceInfo ( ctx , srv , path . Join ( username , device ) )
if err != nil {
return nil , err
}
2021-05-04 13:27:50 +02:00
return fs . ConfigChoose ( "choose_device_mountpoint" , "config_mountpoint" , ` Please select the mountpoint to use. Normally this will be Archive. ` , len ( dev . MountPoints ) , func ( i int ) ( string , string ) {
2021-04-29 10:28:18 +02:00
return dev . MountPoints [ i ] . Name , ""
} )
case "choose_device_mountpoint" :
mountpoint := config . Result
m . Set ( configMountpoint , mountpoint )
return fs . ConfigGoto ( "end" )
case "end" :
// All the config flows end up here in case we need to carry on with something
return nil , nil
}
return nil , fmt . Errorf ( "unknown state %q" , config . State )
}
2018-08-02 01:02:35 +02:00
// Options defines the configuration for this backend
type Options struct {
2020-01-14 18:33:35 +01:00
Device string ` config:"device" `
Mountpoint string ` config:"mountpoint" `
MD5MemoryThreshold fs . SizeSuffix ` config:"md5_memory_limit" `
2020-04-11 12:11:20 +02:00
TrashedOnly bool ` config:"trashed_only" `
2020-01-14 18:33:35 +01:00
HardDelete bool ` config:"hard_delete" `
2021-07-01 23:17:05 +02:00
NoVersions bool ` config:"no_versions" `
2020-01-14 18:33:35 +01:00
UploadThreshold fs . SizeSuffix ` config:"upload_resume_limit" `
Enc encoder . MultiEncoder ` config:"encoding" `
2018-08-02 01:02:35 +02:00
}
// Fs represents a remote jottacloud
type Fs struct {
2018-08-22 22:26:18 +02:00
name string
root string
user string
opt Options
features * fs . Features
endpointURL string
srv * rest . Client
apiSrv * rest . Client
2019-02-09 21:52:15 +01:00
pacer * fs . Pacer
2018-08-22 22:26:18 +02:00
tokenRenewer * oauthutil . Renew // renew the token on expiry
2018-08-02 01:02:35 +02:00
}
// Object describes a jottacloud object
//
// Will definitely have info but maybe not meta
type Object struct {
fs * Fs
remote string
hasMetaData bool
size int64
modTime time . Time
md5 string
2018-08-15 00:33:58 +02:00
mimeType string
2018-08-02 01:02:35 +02:00
}
// ------------------------------------------------------------
// Name of the remote (as passed into NewFs)
func ( f * Fs ) Name ( ) string {
return f . name
}
// Root of the remote (as passed into NewFs)
func ( f * Fs ) Root ( ) string {
return f . root
}
// String converts this Fs to a string
func ( f * Fs ) String ( ) string {
return fmt . Sprintf ( "jottacloud root '%s'" , f . root )
}
// Features returns the optional features of this Fs
func ( f * Fs ) Features ( ) * fs . Features {
return f . features
}
2021-05-31 09:31:35 +02:00
// joinPath joins two path/url elements
//
// Does not perform clean on the result like path.Join does,
// which breaks urls by changing prefix "https://" into "https:/".
func joinPath ( base string , rel string ) string {
if rel == "" {
return base
}
if strings . HasSuffix ( base , "/" ) {
return base + strings . TrimPrefix ( rel , "/" )
}
if strings . HasPrefix ( rel , "/" ) {
return strings . TrimSuffix ( base , "/" ) + rel
}
return base + "/" + rel
2018-08-02 01:02:35 +02:00
}
// retryErrorCodes is a slice of error codes that we will retry
var retryErrorCodes = [ ] int {
429 , // Too Many Requests.
500 , // Internal Server Error
502 , // Bad Gateway
503 , // Service Unavailable
504 , // Gateway Timeout
509 , // Bandwidth Limit Exceeded
}
// shouldRetry returns a boolean as to whether this resp and err
// deserve to be retried. It returns the err as a convenience
2021-03-11 15:44:01 +01:00
func shouldRetry ( ctx context . Context , resp * http . Response , err error ) ( bool , error ) {
if fserrors . ContextError ( ctx , & err ) {
return false , err
}
2018-08-02 01:02:35 +02:00
return fserrors . ShouldRetry ( err ) || fserrors . ShouldRetryHTTP ( resp , retryErrorCodes ) , err
}
2020-06-11 13:02:28 +02:00
// registerDevice register a new device for use with the jottacloud API
func registerDevice ( ctx context . Context , srv * rest . Client ) ( reg * api . DeviceRegistrationResponse , err error ) {
// random generator to generate random device names
seededRand := rand . New ( rand . NewSource ( time . Now ( ) . UnixNano ( ) ) )
randonDeviceNamePartLength := 21
randomDeviceNamePart := make ( [ ] byte , randonDeviceNamePartLength )
charset := "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
for i := range randomDeviceNamePart {
randomDeviceNamePart [ i ] = charset [ seededRand . Intn ( len ( charset ) ) ]
}
randomDeviceName := "rclone-" + string ( randomDeviceNamePart )
fs . Debugf ( nil , "Trying to register device '%s'" , randomDeviceName )
values := url . Values { }
values . Set ( "device_id" , randomDeviceName )
opts := rest . Opts {
Method : "POST" ,
2021-05-04 15:13:12 +02:00
RootURL : legacyRegisterURL ,
2020-06-11 13:02:28 +02:00
ContentType : "application/x-www-form-urlencoded" ,
ExtraHeaders : map [ string ] string { "Authorization" : "Bearer c2xrZmpoYWRsZmFramhkc2xma2phaHNkbGZramhhc2xkZmtqaGFzZGxrZmpobGtq" } ,
Parameters : values ,
}
var deviceRegistration * api . DeviceRegistrationResponse
_ , err = srv . CallJSON ( ctx , & opts , nil , & deviceRegistration )
return deviceRegistration , err
}
2021-04-29 10:28:18 +02:00
var errAuthCodeRequired = errors . New ( "auth code required" )
2021-05-04 15:13:12 +02:00
// doLegacyAuth runs the actual token request for V1 authentication
2021-04-29 10:28:18 +02:00
//
// Call this first with blank authCode. If errAuthCodeRequired is
// returned then call it again with an authCode
2021-05-04 15:13:12 +02:00
func doLegacyAuth ( ctx context . Context , srv * rest . Client , oauthConfig * oauth2 . Config , username , password , authCode string ) ( token oauth2 . Token , err error ) {
2020-06-11 13:02:28 +02:00
// prepare out token request with username and password
values := url . Values { }
values . Set ( "grant_type" , "PASSWORD" )
values . Set ( "password" , password )
values . Set ( "username" , username )
values . Set ( "client_id" , oauthConfig . ClientID )
values . Set ( "client_secret" , oauthConfig . ClientSecret )
opts := rest . Opts {
Method : "POST" ,
RootURL : oauthConfig . Endpoint . AuthURL ,
ContentType : "application/x-www-form-urlencoded" ,
Parameters : values ,
}
2021-04-29 10:28:18 +02:00
if authCode != "" {
opts . ExtraHeaders = make ( map [ string ] string )
opts . ExtraHeaders [ "X-Jottacloud-Otp" ] = authCode
}
2020-06-11 13:02:28 +02:00
// do the first request
var jsonToken api . TokenJSON
resp , err := srv . CallJSON ( ctx , & opts , nil , & jsonToken )
2021-04-29 10:28:18 +02:00
if err != nil && authCode == "" {
2020-06-11 13:02:28 +02:00
// if 2fa is enabled the first request is expected to fail. We will do another request with the 2fa code as an additional http header
if resp != nil {
if resp . Header . Get ( "X-JottaCloud-OTP" ) == "required; SMS" {
2021-04-29 10:28:18 +02:00
return token , errAuthCodeRequired
2020-06-11 13:02:28 +02:00
}
}
}
token . AccessToken = jsonToken . AccessToken
token . RefreshToken = jsonToken . RefreshToken
token . TokenType = jsonToken . TokenType
token . Expiry = time . Now ( ) . Add ( time . Duration ( jsonToken . ExpiresIn ) * time . Second )
return token , err
}
2021-05-04 15:13:12 +02:00
// doTokenAuth runs the actual token request for V2 authentication
func doTokenAuth ( ctx context . Context , apiSrv * rest . Client , loginTokenBase64 string ) ( token oauth2 . Token , tokenEndpoint string , err error ) {
2020-02-22 01:15:14 +01:00
loginTokenBytes , err := base64 . RawURLEncoding . DecodeString ( loginTokenBase64 )
2019-11-20 00:10:38 +01:00
if err != nil {
2021-05-04 15:13:12 +02:00
return token , "" , err
2019-08-14 19:39:19 +02:00
}
2019-12-28 17:45:04 +01:00
// decode login token
2019-11-20 00:10:38 +01:00
var loginToken api . LoginToken
decoder := json . NewDecoder ( bytes . NewReader ( loginTokenBytes ) )
err = decoder . Decode ( & loginToken )
if err != nil {
2021-05-04 15:13:12 +02:00
return token , "" , err
2019-11-20 00:10:38 +01:00
}
2019-08-14 19:39:19 +02:00
2019-12-28 17:45:04 +01:00
// retrieve endpoint urls
2018-08-02 01:02:35 +02:00
opts := rest . Opts {
2019-12-28 17:45:04 +01:00
Method : "GET" ,
RootURL : loginToken . WellKnownLink ,
2019-11-20 00:10:38 +01:00
}
2019-12-28 17:45:04 +01:00
var wellKnown api . WellKnown
2021-05-04 15:13:12 +02:00
_ , err = apiSrv . CallJSON ( ctx , & opts , nil , & wellKnown )
2019-11-20 00:10:38 +01:00
if err != nil {
2021-05-04 15:13:12 +02:00
return token , "" , err
2018-08-02 01:02:35 +02:00
}
2019-08-14 19:39:19 +02:00
// prepare out token request with username and password
values := url . Values { }
2021-05-04 15:13:12 +02:00
values . Set ( "client_id" , defaultClientID )
2019-11-20 00:10:38 +01:00
values . Set ( "grant_type" , "password" )
values . Set ( "password" , loginToken . AuthToken )
values . Set ( "scope" , "offline_access+openid" )
values . Set ( "username" , loginToken . Username )
values . Encode ( )
opts = rest . Opts {
2019-08-14 19:39:19 +02:00
Method : "POST" ,
2021-05-04 15:13:12 +02:00
RootURL : wellKnown . TokenEndpoint ,
2019-08-14 19:39:19 +02:00
ContentType : "application/x-www-form-urlencoded" ,
2019-11-20 00:10:38 +01:00
Body : strings . NewReader ( values . Encode ( ) ) ,
2019-08-14 19:39:19 +02:00
}
// do the first request
var jsonToken api . TokenJSON
2021-05-04 15:13:12 +02:00
_ , err = apiSrv . CallJSON ( ctx , & opts , nil , & jsonToken )
2019-08-14 19:39:19 +02:00
if err != nil {
2021-05-04 15:13:12 +02:00
return token , "" , err
2018-08-02 01:02:35 +02:00
}
2019-08-14 19:39:19 +02:00
token . AccessToken = jsonToken . AccessToken
token . RefreshToken = jsonToken . RefreshToken
token . TokenType = jsonToken . TokenType
token . Expiry = time . Now ( ) . Add ( time . Duration ( jsonToken . ExpiresIn ) * time . Second )
2021-05-04 15:13:12 +02:00
return token , wellKnown . TokenEndpoint , err
2019-08-14 19:39:19 +02:00
}
// getCustomerInfo queries general information about the account
2021-05-04 15:13:12 +02:00
func getCustomerInfo ( ctx context . Context , apiSrv * rest . Client ) ( info * api . CustomerInfo , err error ) {
2019-08-13 15:28:46 +02:00
opts := rest . Opts {
Method : "GET" ,
Path : "account/v1/customer" ,
}
2021-05-04 15:13:12 +02:00
_ , err = apiSrv . CallJSON ( ctx , & opts , nil , & info )
2019-08-13 15:28:46 +02:00
if err != nil {
2019-08-14 19:39:19 +02:00
return nil , errors . Wrap ( err , "couldn't get customer info" )
2019-08-13 15:28:46 +02:00
}
return info , nil
}
2019-08-14 19:39:19 +02:00
// getDriveInfo queries general information about the account and the available devices and mountpoints.
2019-09-04 21:00:37 +02:00
func getDriveInfo ( ctx context . Context , srv * rest . Client , username string ) ( info * api . DriveInfo , err error ) {
2018-08-02 01:02:35 +02:00
opts := rest . Opts {
Method : "GET" ,
2019-08-13 15:28:46 +02:00
Path : username ,
2018-08-02 01:02:35 +02:00
}
2019-09-04 21:00:37 +02:00
_ , err = srv . CallXML ( ctx , & opts , nil , & info )
2019-05-17 02:31:59 +02:00
if err != nil {
2019-08-14 19:39:19 +02:00
return nil , errors . Wrap ( err , "couldn't get drive info" )
2019-05-17 02:31:59 +02:00
}
return info , nil
}
// getDeviceInfo queries Information about a jottacloud device
2019-09-04 21:00:37 +02:00
func getDeviceInfo ( ctx context . Context , srv * rest . Client , path string ) ( info * api . JottaDevice , err error ) {
2019-05-17 02:31:59 +02:00
opts := rest . Opts {
Method : "GET" ,
Path : urlPathEscape ( path ) ,
}
2019-09-04 21:00:37 +02:00
_ , err = srv . CallXML ( ctx , & opts , nil , & info )
2018-08-02 01:02:35 +02:00
if err != nil {
2019-08-14 19:39:19 +02:00
return nil , errors . Wrap ( err , "couldn't get device info" )
2018-08-02 01:02:35 +02:00
}
2018-08-15 01:12:20 +02:00
return info , nil
}
2019-08-14 19:39:19 +02:00
// setEndpointURL generates the API endpoint URL
2019-08-13 15:28:46 +02:00
func ( f * Fs ) setEndpointURL ( ) {
2019-05-17 02:31:59 +02:00
if f . opt . Device == "" {
f . opt . Device = defaultDevice
}
if f . opt . Mountpoint == "" {
f . opt . Mountpoint = defaultMountpoint
}
2020-10-20 12:43:28 +02:00
f . endpointURL = path . Join ( f . user , f . opt . Device , f . opt . Mountpoint )
2018-08-02 01:02:35 +02:00
}
2019-08-14 19:39:19 +02:00
// readMetaDataForPath reads the metadata from the path
2019-09-04 21:00:37 +02:00
func ( f * Fs ) readMetaDataForPath ( ctx context . Context , path string ) ( info * api . JottaFile , err error ) {
2019-08-14 19:39:19 +02:00
opts := rest . Opts {
Method : "GET" ,
Path : f . filePath ( path ) ,
}
var result api . JottaFile
var resp * http . Response
err = f . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = f . srv . CallXML ( ctx , & opts , nil , & result )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2019-08-14 19:39:19 +02:00
} )
if apiErr , ok := err . ( * api . Error ) ; ok {
// does not exist
if apiErr . StatusCode == http . StatusNotFound {
return nil , fs . ErrorObjectNotFound
}
}
if err != nil {
return nil , errors . Wrap ( err , "read metadata failed" )
}
if result . XMLName . Local != "file" {
return nil , fs . ErrorNotAFile
}
return & result , nil
}
2018-08-02 01:02:35 +02:00
// errorHandler parses a non 2xx error response into an error
func errorHandler ( resp * http . Response ) error {
// Decode error response
errResponse := new ( api . Error )
err := rest . DecodeXML ( resp , & errResponse )
if err != nil {
fs . Debugf ( nil , "Couldn't decode error response: %v" , err )
}
if errResponse . Message == "" {
errResponse . Message = resp . Status
}
if errResponse . StatusCode == 0 {
errResponse . StatusCode = resp . StatusCode
}
return errResponse
}
2020-05-20 12:39:20 +02:00
// Jottacloud wants '+' to be URL encoded even though the RFC states it's not reserved
2018-09-16 22:30:20 +02:00
func urlPathEscape ( in string ) string {
return strings . Replace ( rest . URLPathEscape ( in ) , "+" , "%2B" , - 1 )
}
2018-09-06 15:13:38 +02:00
// filePathRaw returns an unescaped file path (f.root, file)
func ( f * Fs ) filePathRaw ( file string ) string {
2020-01-14 18:33:35 +01:00
return path . Join ( f . endpointURL , f . opt . Enc . FromStandardPath ( path . Join ( f . root , file ) ) )
2018-09-06 15:13:38 +02:00
}
2020-05-20 12:39:20 +02:00
// filePath returns an escaped file path (f.root, file)
2018-08-02 01:02:35 +02:00
func ( f * Fs ) filePath ( file string ) string {
2018-09-16 22:30:20 +02:00
return urlPathEscape ( f . filePathRaw ( file ) )
2018-08-02 01:02:35 +02:00
}
2020-06-11 13:02:28 +02:00
// Jottacloud requires the grant_type 'refresh_token' string
// to be uppercase and throws a 400 Bad Request if we use the
// lower case used by the oauth2 module
//
// This filter catches all refresh requests, reads the body,
// changes the case and then sends it on
func grantTypeFilter ( req * http . Request ) {
2021-05-04 15:13:12 +02:00
if legacyTokenURL == req . URL . String ( ) {
2020-06-11 13:02:28 +02:00
// read the entire body
refreshBody , err := ioutil . ReadAll ( req . Body )
if err != nil {
return
}
_ = req . Body . Close ( )
// make the refresh token upper case
refreshBody = [ ] byte ( strings . Replace ( string ( refreshBody ) , "grant_type=refresh_token" , "grant_type=REFRESH_TOKEN" , 1 ) )
// set the new ReadCloser (with a dummy Close())
req . Body = ioutil . NopCloser ( bytes . NewReader ( refreshBody ) )
}
}
2021-04-29 10:28:18 +02:00
func getOAuthClient ( ctx context . Context , name string , m configmap . Mapper ) ( oAuthClient * http . Client , ts * oauthutil . TokenSource , err error ) {
2019-12-28 17:45:04 +01:00
// Check config version
2020-06-11 13:02:28 +02:00
var ver int
version , ok := m . Get ( "configVersion" )
if ok {
ver , err = strconv . Atoi ( version )
2019-11-20 00:10:38 +01:00
if err != nil {
2021-04-29 10:28:18 +02:00
return nil , nil , errors . New ( "Failed to parse config version" )
2019-11-20 00:10:38 +01:00
}
2021-05-04 15:13:12 +02:00
ok = ( ver == configVersion ) || ( ver == legacyConfigVersion )
2019-04-07 16:12:32 +02:00
}
if ! ok {
2021-04-29 10:28:18 +02:00
return nil , nil , errors . New ( "Outdated config - please reconfigure this backend" )
2019-04-07 16:12:32 +02:00
}
2020-11-13 16:24:43 +01:00
baseClient := fshttp . NewClient ( ctx )
2021-05-04 15:13:12 +02:00
oauthConfig := & oauth2 . Config {
Endpoint : oauth2 . Endpoint {
AuthURL : defaultTokenURL ,
TokenURL : defaultTokenURL ,
} ,
}
2020-06-11 13:02:28 +02:00
if ver == configVersion {
2021-05-04 15:13:12 +02:00
oauthConfig . ClientID = defaultClientID
2020-06-11 13:02:28 +02:00
// if custom endpoints are set use them else stick with defaults
if tokenURL , ok := m . Get ( configTokenURL ) ; ok {
oauthConfig . Endpoint . TokenURL = tokenURL
// jottacloud is weird. we need to use the tokenURL as authURL
oauthConfig . Endpoint . AuthURL = tokenURL
}
2021-05-04 15:13:12 +02:00
} else if ver == legacyConfigVersion {
2020-06-11 13:02:28 +02:00
clientID , ok := m . Get ( configClientID )
if ! ok {
2021-05-04 15:13:12 +02:00
clientID = legacyClientID
2020-06-11 13:02:28 +02:00
}
clientSecret , ok := m . Get ( configClientSecret )
if ! ok {
2021-05-04 15:13:12 +02:00
clientSecret = legacyEncryptedClientSecret
2020-06-11 13:02:28 +02:00
}
oauthConfig . ClientID = clientID
oauthConfig . ClientSecret = obscure . MustReveal ( clientSecret )
2021-05-04 15:13:12 +02:00
oauthConfig . Endpoint . TokenURL = legacyTokenURL
oauthConfig . Endpoint . AuthURL = legacyTokenURL
2020-06-11 13:02:28 +02:00
// add the request filter to fix token refresh
if do , ok := baseClient . Transport . ( interface {
SetRequestFilter ( f func ( req * http . Request ) )
} ) ; ok {
do . SetRequestFilter ( grantTypeFilter )
} else {
fs . Debugf ( name + ":" , "Couldn't add request filter - uploads will fail" )
}
2019-12-28 17:45:04 +01:00
}
2019-11-20 00:10:38 +01:00
2019-12-28 17:45:04 +01:00
// Create OAuth Client
2021-04-29 10:28:18 +02:00
oAuthClient , ts , err = oauthutil . NewClientWithBaseClient ( ctx , name , m , oauthConfig , baseClient )
2018-08-22 22:26:18 +02:00
if err != nil {
2021-04-29 10:28:18 +02:00
return nil , nil , errors . Wrap ( err , "Failed to configure Jottacloud oauth client" )
}
return oAuthClient , ts , nil
}
// NewFs constructs an Fs from the path, container:path
func NewFs ( ctx context . Context , name , root 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
}
oAuthClient , ts , err := getOAuthClient ( ctx , name , m )
if err != nil {
return nil , err
2018-08-22 22:26:18 +02:00
}
2019-12-28 17:45:04 +01:00
rootIsDir := strings . HasSuffix ( root , "/" )
2021-05-31 09:31:35 +02:00
root = strings . Trim ( root , "/" )
2019-12-28 17:45:04 +01:00
2018-08-02 01:02:35 +02:00
f := & Fs {
2019-01-28 21:50:51 +01:00
name : name ,
root : root ,
opt : * opt ,
2018-12-30 00:53:18 +01:00
srv : rest . NewClient ( oAuthClient ) . SetRoot ( rootURL ) ,
2018-08-22 22:26:18 +02:00
apiSrv : rest . NewClient ( oAuthClient ) . SetRoot ( apiURL ) ,
2020-11-05 12:33:32 +01:00
pacer : fs . NewPacer ( ctx , pacer . NewDefault ( pacer . MinSleep ( minSleep ) , pacer . MaxSleep ( maxSleep ) , pacer . DecayConstant ( decayConstant ) ) ) ,
2018-08-02 01:02:35 +02:00
}
f . features = ( & fs . Features {
CaseInsensitive : true ,
CanHaveEmptyDirectories : true ,
2018-08-15 01:12:20 +02:00
ReadMimeType : true ,
2020-11-29 17:27:20 +01:00
WriteMimeType : false ,
2020-11-05 17:00:40 +01:00
} ) . Fill ( ctx , f )
2018-08-22 22:26:18 +02:00
f . srv . SetErrorHandler ( errorHandler )
2020-04-11 12:11:20 +02:00
if opt . TrashedOnly { // we cannot support showing Trashed Files when using ListR right now
f . features . ListR = nil
}
2018-08-22 22:26:18 +02:00
// Renew the token in the background
f . tokenRenewer = oauthutil . NewRenew ( f . String ( ) , ts , func ( ) error {
2019-09-04 21:00:37 +02:00
_ , err := f . readMetaDataForPath ( ctx , "" )
2021-01-12 18:09:44 +01:00
if err == fs . ErrorNotAFile {
err = nil
}
2018-08-22 22:26:18 +02:00
return err
} )
2019-09-04 21:00:37 +02:00
cust , err := getCustomerInfo ( ctx , f . apiSrv )
2018-08-02 01:02:35 +02:00
if err != nil {
2019-08-14 19:39:19 +02:00
return nil , err
2018-08-02 01:02:35 +02:00
}
2019-08-13 15:28:46 +02:00
f . user = cust . Username
f . setEndpointURL ( )
2018-08-02 01:02:35 +02:00
if root != "" && ! rootIsDir {
// Check to see if the root actually an existing file
remote := path . Base ( root )
f . root = path . Dir ( root )
if f . root == "." {
f . root = ""
}
2019-06-17 10:34:30 +02:00
_ , err := f . NewObject ( context . TODO ( ) , remote )
2018-08-02 01:02:35 +02:00
if err != nil {
if errors . Cause ( err ) == fs . ErrorObjectNotFound || errors . Cause ( err ) == fs . ErrorNotAFile {
// File doesn't exist so return old f
f . root = root
return f , nil
}
return nil , err
}
// return an error with an fs which points to the parent
return f , fs . ErrorIsFile
}
return f , nil
}
// Return an Object from a path
//
// If it can't be found it returns the error fs.ErrorObjectNotFound.
2019-09-04 21:00:37 +02:00
func ( f * Fs ) newObjectWithInfo ( ctx context . Context , remote string , info * api . JottaFile ) ( fs . Object , error ) {
2018-08-02 01:02:35 +02:00
o := & Object {
fs : f ,
remote : remote ,
}
var err error
if info != nil {
// Set info
err = o . setMetaData ( info )
} else {
2019-09-04 21:00:37 +02:00
err = o . readMetaData ( ctx , false ) // reads info and meta, returning an error
2018-08-02 01:02:35 +02:00
}
if err != nil {
return nil , err
}
return o , nil
}
// NewObject finds the Object at remote. If it can't be found
// it returns the error fs.ErrorObjectNotFound.
2019-06-17 10:34:30 +02:00
func ( f * Fs ) NewObject ( ctx context . Context , remote string ) ( fs . Object , error ) {
2019-09-04 21:00:37 +02:00
return f . newObjectWithInfo ( ctx , remote , nil )
2018-08-02 01:02:35 +02:00
}
// CreateDir makes a directory
2019-09-04 21:00:37 +02:00
func ( f * Fs ) CreateDir ( ctx context . Context , path string ) ( jf * api . JottaFolder , err error ) {
2018-08-02 01:02:35 +02:00
// fs.Debugf(f, "CreateDir(%q, %q)\n", pathID, leaf)
var resp * http . Response
opts := rest . Opts {
Method : "POST" ,
Path : f . filePath ( path ) ,
Parameters : url . Values { } ,
}
opts . Parameters . Set ( "mkDir" , "true" )
err = f . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = f . srv . CallXML ( ctx , & opts , nil , & jf )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-08-02 01:02:35 +02:00
} )
if err != nil {
//fmt.Printf("...Error %v\n", err)
return nil , err
}
// fmt.Printf("...Id %q\n", *info.Id)
return jf , nil
}
// 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.
2019-06-17 10:34:30 +02:00
func ( f * Fs ) List ( ctx context . Context , dir string ) ( entries fs . DirEntries , err error ) {
2018-08-02 01:02:35 +02:00
opts := rest . Opts {
Method : "GET" ,
Path : f . filePath ( dir ) ,
}
var resp * http . Response
var result api . JottaFolder
err = f . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = f . srv . CallXML ( ctx , & opts , nil , & result )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-08-02 01:02:35 +02:00
} )
if err != nil {
if apiErr , ok := err . ( * api . Error ) ; ok {
// does not exist
if apiErr . StatusCode == http . StatusNotFound {
return nil , fs . ErrorDirNotFound
}
}
return nil , errors . Wrap ( err , "couldn't list files" )
}
2020-04-11 12:11:20 +02:00
if bool ( result . Deleted ) && ! f . opt . TrashedOnly {
2018-08-02 01:02:35 +02:00
return nil , fs . ErrorDirNotFound
}
for i := range result . Folders {
item := & result . Folders [ i ]
2020-04-11 12:11:20 +02:00
if ! f . opt . TrashedOnly && bool ( item . Deleted ) {
2018-08-02 01:02:35 +02:00
continue
}
2020-01-14 18:33:35 +01:00
remote := path . Join ( dir , f . opt . Enc . ToStandardName ( item . Name ) )
2018-08-02 01:02:35 +02:00
d := fs . NewDir ( remote , time . Time ( item . ModifiedAt ) )
entries = append ( entries , d )
}
for i := range result . Files {
item := & result . Files [ i ]
2020-04-11 12:11:20 +02:00
if f . opt . TrashedOnly {
if ! item . Deleted || item . State != "COMPLETED" {
continue
}
} else {
if item . Deleted || item . State != "COMPLETED" {
continue
}
2018-08-02 01:02:35 +02:00
}
2020-01-14 18:33:35 +01:00
remote := path . Join ( dir , f . opt . Enc . ToStandardName ( item . Name ) )
2019-09-04 21:00:37 +02:00
o , err := f . newObjectWithInfo ( ctx , remote , item )
2018-08-02 01:02:35 +02:00
if err != nil {
continue
}
entries = append ( entries , o )
}
return entries , nil
}
2018-09-06 15:13:38 +02:00
// listFileDirFn is called from listFileDir to handle an object.
type listFileDirFn func ( fs . DirEntry ) error
// List the objects and directories into entries, from a
// special kind of JottaFolder representing a FileDirLis
2019-09-04 21:00:37 +02:00
func ( f * Fs ) listFileDir ( ctx context . Context , remoteStartPath string , startFolder * api . JottaFolder , fn listFileDirFn ) error {
2018-09-09 00:12:47 +02:00
pathPrefix := "/" + f . filePathRaw ( "" ) // Non-escaped prefix of API paths to be cut off, to be left with the remote path including the remoteStartPath
pathPrefixLength := len ( pathPrefix )
startPath := path . Join ( pathPrefix , remoteStartPath ) // Non-escaped API path up to and including remoteStartPath, to decide if it should be created as a new dir object
startPathLength := len ( startPath )
for i := range startFolder . Folders {
folder := & startFolder . Folders [ i ]
2018-09-06 15:13:38 +02:00
if folder . Deleted {
return nil
}
2020-01-14 18:33:35 +01:00
folderPath := f . opt . Enc . ToStandardPath ( path . Join ( folder . Path , folder . Name ) )
2018-10-14 20:17:41 +02:00
folderPathLength := len ( folderPath )
2018-09-06 15:13:38 +02:00
var remoteDir string
2018-10-14 20:17:41 +02:00
if folderPathLength > pathPrefixLength {
remoteDir = folderPath [ pathPrefixLength + 1 : ]
if folderPathLength > startPathLength {
2018-09-09 00:12:47 +02:00
d := fs . NewDir ( remoteDir , time . Time ( folder . ModifiedAt ) )
err := fn ( d )
if err != nil {
return err
}
2018-09-06 15:13:38 +02:00
}
}
for i := range folder . Files {
file := & folder . Files [ i ]
if file . Deleted || file . State != "COMPLETED" {
continue
}
2020-01-14 18:33:35 +01:00
remoteFile := path . Join ( remoteDir , f . opt . Enc . ToStandardName ( file . Name ) )
2019-09-04 21:00:37 +02:00
o , err := f . newObjectWithInfo ( ctx , remoteFile , file )
2018-09-06 15:13:38 +02:00
if err != nil {
return err
}
err = fn ( o )
if err != nil {
return err
}
}
}
return 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.
2019-06-17 10:34:30 +02:00
func ( f * Fs ) ListR ( ctx context . Context , dir string , callback fs . ListRCallback ) ( err error ) {
2018-09-06 15:13:38 +02:00
opts := rest . Opts {
Method : "GET" ,
Path : f . filePath ( dir ) ,
Parameters : url . Values { } ,
}
opts . Parameters . Set ( "mode" , "list" )
var resp * http . Response
var result api . JottaFolder // Could be JottaFileDirList, but JottaFolder is close enough
err = f . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = f . srv . CallXML ( ctx , & opts , nil , & result )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-09-06 15:13:38 +02:00
} )
if err != nil {
if apiErr , ok := err . ( * api . Error ) ; ok {
// does not exist
if apiErr . StatusCode == http . StatusNotFound {
return fs . ErrorDirNotFound
}
}
return errors . Wrap ( err , "couldn't list files" )
}
list := walk . NewListRHelper ( callback )
2019-09-04 21:00:37 +02:00
err = f . listFileDir ( ctx , dir , & result , func ( entry fs . DirEntry ) error {
2018-09-06 15:13:38 +02:00
return list . Add ( entry )
} )
if err != nil {
return err
}
return list . Flush ( )
}
2018-08-02 01:02:35 +02:00
// Creates from the parameters passed in a half finished Object which
// must have setMetaData called on it
//
// Used to create new objects
func ( f * Fs ) createObject ( remote string , modTime time . Time , size int64 ) ( o * Object ) {
// Temporary Object under construction
o = & Object {
fs : f ,
remote : remote ,
size : size ,
modTime : modTime ,
}
return o
}
// 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
2019-06-17 10:34:30 +02:00
func ( f * Fs ) Put ( ctx context . Context , in io . Reader , src fs . ObjectInfo , options ... fs . OpenOption ) ( fs . Object , error ) {
2019-05-17 02:31:59 +02:00
if f . opt . Device != "Jotta" {
return nil , errors . New ( "upload not supported for devices other than Jotta" )
}
2019-06-17 10:34:30 +02:00
o := f . createObject ( src . Remote ( ) , src . ModTime ( ctx ) , src . Size ( ) )
return o , o . Update ( ctx , in , src , options ... )
2018-08-02 01:02:35 +02:00
}
// mkParentDir makes the parent of the native path dirPath if
// necessary and any directories above that
2019-06-17 10:34:30 +02:00
func ( f * Fs ) mkParentDir ( ctx context . Context , dirPath string ) error {
2018-08-02 01:02:35 +02:00
// defer log.Trace(dirPath, "")("")
// chop off trailing / if it exists
if strings . HasSuffix ( dirPath , "/" ) {
dirPath = dirPath [ : len ( dirPath ) - 1 ]
}
parent := path . Dir ( dirPath )
if parent == "." {
parent = ""
}
2019-06-17 10:34:30 +02:00
return f . Mkdir ( ctx , parent )
2018-08-02 01:02:35 +02:00
}
// Mkdir creates the container if it doesn't exist
2019-06-17 10:34:30 +02:00
func ( f * Fs ) Mkdir ( ctx context . Context , dir string ) error {
2019-09-04 21:00:37 +02:00
_ , err := f . CreateDir ( ctx , dir )
2018-08-02 01:02:35 +02:00
return err
}
// purgeCheck removes the root directory, if check is set then it
// refuses to do so if it has anything in
2019-06-17 10:34:30 +02:00
func ( f * Fs ) purgeCheck ( ctx context . Context , dir string , check bool ) ( err error ) {
2018-08-02 01:02:35 +02:00
root := path . Join ( f . root , dir )
if root == "" {
return errors . New ( "can't purge root directory" )
}
// check that the directory exists
2019-06-17 10:34:30 +02:00
entries , err := f . List ( ctx , dir )
2018-08-02 01:02:35 +02:00
if err != nil {
return err
}
if check {
if len ( entries ) != 0 {
return fs . ErrorDirectoryNotEmpty
}
}
opts := rest . Opts {
Method : "POST" ,
Path : f . filePath ( dir ) ,
Parameters : url . Values { } ,
NoResponse : true ,
}
2018-09-07 13:58:18 +02:00
if f . opt . HardDelete {
opts . Parameters . Set ( "rmDir" , "true" )
} else {
opts . Parameters . Set ( "dlDir" , "true" )
}
2018-08-02 01:02:35 +02:00
var resp * http . Response
err = f . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = f . srv . Call ( ctx , & opts )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-08-02 01:02:35 +02:00
} )
if err != nil {
2018-09-04 21:02:35 +02:00
return errors . Wrap ( err , "couldn't purge directory" )
2018-08-02 01:02:35 +02:00
}
return nil
}
// Rmdir deletes the root folder
//
// Returns an error if it isn't empty
2019-06-17 10:34:30 +02:00
func ( f * Fs ) Rmdir ( ctx context . Context , dir string ) error {
return f . purgeCheck ( ctx , dir , true )
2018-08-02 01:02:35 +02:00
}
// Precision return the precision of this Fs
func ( f * Fs ) Precision ( ) time . Duration {
return time . Second
}
// Purge deletes all the files and the container
2020-06-04 23:25:14 +02:00
func ( f * Fs ) Purge ( ctx context . Context , dir string ) error {
return f . purgeCheck ( ctx , dir , false )
2018-08-02 01:02:35 +02:00
}
2019-02-07 18:41:17 +01:00
// copyOrMoves copies or moves directories or files depending on the method parameter
2019-09-04 21:00:37 +02:00
func ( f * Fs ) copyOrMove ( ctx context . Context , method , src , dest string ) ( info * api . JottaFile , err error ) {
2018-08-02 01:02:35 +02:00
opts := rest . Opts {
Method : "POST" ,
Path : src ,
Parameters : url . Values { } ,
}
2020-01-14 18:33:35 +01:00
opts . Parameters . Set ( method , "/" + path . Join ( f . endpointURL , f . opt . Enc . FromStandardPath ( path . Join ( f . root , dest ) ) ) )
2018-08-02 01:02:35 +02:00
var resp * http . Response
err = f . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = f . srv . CallXML ( ctx , & opts , nil , & info )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-08-02 01:02:35 +02:00
} )
if err != nil {
return nil , err
}
return info , nil
}
2020-10-13 23:43:40 +02:00
// Copy src to this remote using server-side copy operations.
2018-08-02 01:02:35 +02:00
//
// 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
2019-06-17 10:34:30 +02:00
func ( f * Fs ) Copy ( ctx context . Context , src fs . Object , remote string ) ( fs . Object , error ) {
2018-08-02 01:02:35 +02:00
srcObj , ok := src . ( * Object )
if ! ok {
fs . Debugf ( src , "Can't copy - not same remote type" )
return nil , fs . ErrorCantMove
}
2019-06-17 10:34:30 +02:00
err := f . mkParentDir ( ctx , remote )
2018-08-02 01:02:35 +02:00
if err != nil {
return nil , err
}
2019-09-04 21:00:37 +02:00
info , err := f . copyOrMove ( ctx , "cp" , srcObj . filePath ( ) , remote )
2018-08-02 01:02:35 +02:00
if err != nil {
2018-09-04 21:02:35 +02:00
return nil , errors . Wrap ( err , "couldn't copy file" )
2018-08-02 01:02:35 +02:00
}
2019-09-04 21:00:37 +02:00
return f . newObjectWithInfo ( ctx , remote , info )
2018-08-02 01:02:35 +02:00
//return f.newObjectWithInfo(remote, &result)
}
2020-10-13 23:43:40 +02:00
// Move src to this remote using server-side move operations.
2018-08-02 01:02:35 +02:00
//
// 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
2019-06-17 10:34:30 +02:00
func ( f * Fs ) Move ( ctx context . Context , src fs . Object , remote string ) ( fs . Object , error ) {
2018-08-02 01:02:35 +02:00
srcObj , ok := src . ( * Object )
if ! ok {
fs . Debugf ( src , "Can't move - not same remote type" )
return nil , fs . ErrorCantMove
}
2019-06-17 10:34:30 +02:00
err := f . mkParentDir ( ctx , remote )
2018-08-02 01:02:35 +02:00
if err != nil {
return nil , err
}
2019-09-04 21:00:37 +02:00
info , err := f . copyOrMove ( ctx , "mv" , srcObj . filePath ( ) , remote )
2018-08-02 01:02:35 +02:00
if err != nil {
2018-09-04 21:02:35 +02:00
return nil , errors . Wrap ( err , "couldn't move file" )
2018-08-02 01:02:35 +02:00
}
2019-09-04 21:00:37 +02:00
return f . newObjectWithInfo ( ctx , remote , info )
2018-08-02 01:02:35 +02:00
//return f.newObjectWithInfo(remote, result)
}
// DirMove moves src, srcRemote to this remote at dstRemote
2020-10-13 23:43:40 +02:00
// using server-side move operations.
2018-08-02 01:02:35 +02: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
2019-06-17 10:34:30 +02:00
func ( f * Fs ) DirMove ( ctx context . Context , src fs . Fs , srcRemote , dstRemote string ) error {
2018-08-02 01:02:35 +02:00
srcFs , ok := src . ( * Fs )
if ! ok {
fs . Debugf ( srcFs , "Can't move directory - not same remote type" )
return fs . ErrorCantDirMove
}
srcPath := path . Join ( srcFs . root , srcRemote )
dstPath := path . Join ( f . root , dstRemote )
// Refuse to move to or from the root
if srcPath == "" || dstPath == "" {
fs . Debugf ( src , "DirMove error: Can't move root" )
return errors . New ( "can't move root directory" )
}
//fmt.Printf("Move src: %s (FullPath %s), dst: %s (FullPath: %s)\n", srcRemote, srcPath, dstRemote, dstPath)
var err error
2019-06-17 10:34:30 +02:00
_ , err = f . List ( ctx , dstRemote )
2018-08-02 01:02:35 +02:00
if err == fs . ErrorDirNotFound {
// OK
} else if err != nil {
return err
} else {
return fs . ErrorDirExists
}
2020-01-14 18:33:35 +01:00
_ , err = f . copyOrMove ( ctx , "mvDir" , path . Join ( f . endpointURL , f . opt . Enc . FromStandardPath ( srcPath ) ) + "/" , dstRemote )
2018-08-02 01:02:35 +02:00
if err != nil {
2018-09-04 21:02:35 +02:00
return errors . Wrap ( err , "couldn't move directory" )
2018-08-02 01:02:35 +02:00
}
return nil
}
2018-09-04 21:02:35 +02:00
// PublicLink generates a public link to the remote path (usually readable by anyone)
2020-05-31 23:18:01 +02:00
func ( f * Fs ) PublicLink ( ctx context . Context , remote string , expire fs . Duration , unlink bool ) ( link string , err error ) {
2018-09-04 21:02:35 +02:00
opts := rest . Opts {
Method : "GET" ,
Path : f . filePath ( remote ) ,
Parameters : url . Values { } ,
}
2020-05-31 23:18:01 +02:00
if unlink {
2018-09-04 21:02:35 +02:00
opts . Parameters . Set ( "mode" , "disableShare" )
} else {
opts . Parameters . Set ( "mode" , "enableShare" )
}
var resp * http . Response
var result api . JottaFile
err = f . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = f . srv . CallXML ( ctx , & opts , nil , & result )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-09-04 21:02:35 +02:00
} )
if apiErr , ok := err . ( * api . Error ) ; ok {
// does not exist
if apiErr . StatusCode == http . StatusNotFound {
return "" , fs . ErrorObjectNotFound
}
}
if err != nil {
2020-05-31 23:18:01 +02:00
if unlink {
2018-09-04 21:02:35 +02:00
return "" , errors . Wrap ( err , "couldn't remove public link" )
}
return "" , errors . Wrap ( err , "couldn't create public link" )
}
2020-05-31 23:18:01 +02:00
if unlink {
2018-09-04 21:02:35 +02:00
if result . PublicSharePath != "" {
return "" , errors . Errorf ( "couldn't remove public link - %q" , result . PublicSharePath )
}
return "" , nil
}
if result . PublicSharePath == "" {
return "" , errors . New ( "couldn't create public link - no link path received" )
}
2021-05-31 09:31:35 +02:00
return joinPath ( baseURL , result . PublicSharePath ) , nil
2018-09-04 21:02:35 +02:00
}
2018-08-15 01:12:20 +02:00
// About gets quota information
2019-06-17 10:34:30 +02:00
func ( f * Fs ) About ( ctx context . Context ) ( * fs . Usage , error ) {
2019-09-04 21:00:37 +02:00
info , err := getDriveInfo ( ctx , f . srv , f . user )
2018-08-15 01:12:20 +02:00
if err != nil {
return nil , err
}
usage := & fs . Usage {
2018-09-06 15:13:38 +02:00
Used : fs . NewUsageValue ( info . Usage ) ,
2018-08-15 01:12:20 +02:00
}
2018-09-06 19:55:16 +02:00
if info . Capacity > 0 {
usage . Total = fs . NewUsageValue ( info . Capacity )
usage . Free = fs . NewUsageValue ( info . Capacity - info . Usage )
}
2018-08-15 01:12:20 +02:00
return usage , nil
}
2020-04-11 12:30:35 +02:00
// CleanUp empties the trash
func ( f * Fs ) CleanUp ( ctx context . Context ) error {
opts := rest . Opts {
Method : "POST" ,
Path : "files/v1/purge_trash" ,
}
var info api . TrashResponse
_ , err := f . apiSrv . CallJSON ( ctx , & opts , nil , & info )
if err != nil {
return errors . Wrap ( err , "couldn't empty trash" )
}
return nil
}
2018-08-02 01:02:35 +02:00
// Hashes returns the supported hash sets.
func ( f * Fs ) Hashes ( ) hash . Set {
return hash . Set ( hash . MD5 )
}
// ---------------------------------------------
// Fs returns the parent Fs
func ( o * Object ) Fs ( ) fs . Info {
return o . fs
}
// Return a string version
func ( o * Object ) String ( ) string {
if o == nil {
return "<nil>"
}
return o . remote
}
// Remote returns the remote path
func ( o * Object ) Remote ( ) string {
return o . remote
}
2020-05-20 12:39:20 +02:00
// filePath returns an escaped file path (f.root, remote)
2019-08-14 19:39:19 +02:00
func ( o * Object ) filePath ( ) string {
return o . fs . filePath ( o . remote )
}
2018-08-02 01:02:35 +02:00
// Hash returns the MD5 of an object returning a lowercase hex string
2019-06-17 10:34:30 +02:00
func ( o * Object ) Hash ( ctx context . Context , t hash . Type ) ( string , error ) {
2018-08-02 01:02:35 +02:00
if t != hash . MD5 {
return "" , hash . ErrUnsupported
}
return o . md5 , nil
}
// Size returns the size of an object in bytes
func ( o * Object ) Size ( ) int64 {
2019-09-04 21:00:37 +02:00
ctx := context . TODO ( )
err := o . readMetaData ( ctx , false )
2018-08-02 01:02:35 +02:00
if err != nil {
fs . Logf ( o , "Failed to read metadata: %v" , err )
return 0
}
return o . size
}
2018-08-15 00:33:58 +02:00
// MimeType of an Object if known, "" otherwise
2019-06-17 10:34:30 +02:00
func ( o * Object ) MimeType ( ctx context . Context ) string {
2018-08-15 00:33:58 +02:00
return o . mimeType
}
2018-08-02 01:02:35 +02:00
// setMetaData sets the metadata from info
func ( o * Object ) setMetaData ( info * api . JottaFile ) ( err error ) {
o . hasMetaData = true
2019-01-11 18:17:46 +01:00
o . size = info . Size
2018-08-02 01:02:35 +02:00
o . md5 = info . MD5
2018-08-15 00:33:58 +02:00
o . mimeType = info . MimeType
2018-08-02 01:02:35 +02:00
o . modTime = time . Time ( info . ModifiedAt )
return nil
}
2019-08-14 19:39:19 +02:00
// readMetaData reads and updates the metadata for an object
2019-09-04 21:00:37 +02:00
func ( o * Object ) readMetaData ( ctx context . Context , force bool ) ( err error ) {
2018-12-30 00:53:18 +01:00
if o . hasMetaData && ! force {
2018-08-02 01:02:35 +02:00
return nil
}
2019-09-04 21:00:37 +02:00
info , err := o . fs . readMetaDataForPath ( ctx , o . remote )
2018-08-02 01:02:35 +02:00
if err != nil {
return err
}
2020-04-11 12:11:20 +02:00
if bool ( info . Deleted ) && ! o . fs . opt . TrashedOnly {
2018-12-30 00:53:18 +01:00
return fs . ErrorObjectNotFound
}
2018-08-02 01:02:35 +02:00
return o . setMetaData ( info )
}
// 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
2019-06-17 10:34:30 +02:00
func ( o * Object ) ModTime ( ctx context . Context ) time . Time {
2019-09-04 21:00:37 +02:00
err := o . readMetaData ( ctx , false )
2018-08-02 01:02:35 +02:00
if err != nil {
fs . Logf ( o , "Failed to read metadata: %v" , err )
return time . Now ( )
}
return o . modTime
}
// SetModTime sets the modification time of the local fs object
2019-06-17 10:34:30 +02:00
func ( o * Object ) SetModTime ( ctx context . Context , modTime time . Time ) error {
2021-09-26 23:01:00 +02:00
// make sure metadata is available, we need its current size and md5
err := o . readMetaData ( ctx , false )
if err != nil {
fs . Logf ( o , "Failed to read metadata: %v" , err )
return err
}
// prepare allocate request with existing metadata but changed timestamps
var resp * http . Response
var options [ ] fs . OpenOption
opts := rest . Opts {
Method : "POST" ,
Path : "files/v1/allocate" ,
Options : options ,
ExtraHeaders : make ( map [ string ] string ) ,
}
fileDate := api . Time ( modTime ) . APIString ( )
var request = api . AllocateFileRequest {
Bytes : o . size ,
Created : fileDate ,
Modified : fileDate ,
Md5 : o . md5 ,
Path : path . Join ( o . fs . opt . Mountpoint , o . fs . opt . Enc . FromStandardPath ( path . Join ( o . fs . root , o . remote ) ) ) ,
}
// send it
err = o . fs . pacer . Call ( func ( ) ( bool , error ) {
resp , err = o . fs . apiSrv . CallJSON ( ctx , & opts , & request , nil )
return shouldRetry ( ctx , resp , err )
} )
if err != nil {
return err
}
// update local metadata
o . modTime = modTime
return nil
2018-08-02 01:02:35 +02:00
}
// Storable returns a boolean showing whether this object storable
func ( o * Object ) Storable ( ) bool {
return true
}
// Open an object for read
2019-06-17 10:34:30 +02:00
func ( o * Object ) Open ( ctx context . Context , options ... fs . OpenOption ) ( in io . ReadCloser , err error ) {
2018-08-02 01:02:35 +02:00
fs . FixRangeOption ( options , o . size )
var resp * http . Response
opts := rest . Opts {
Method : "GET" ,
Path : o . filePath ( ) ,
Parameters : url . Values { } ,
Options : options ,
}
opts . Parameters . Set ( "mode" , "bin" )
err = o . fs . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = o . fs . srv . Call ( ctx , & opts )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-08-02 01:02:35 +02:00
} )
if err != nil {
return nil , err
}
return resp . Body , err
}
2018-08-20 16:38:21 +02:00
// Read the md5 of in returning a reader which will read the same contents
//
// The cleanup function should be called when out is finished with
// regardless of whether this function returned an error or not.
func readMD5 ( in io . Reader , size , threshold int64 ) ( md5sum string , out io . Reader , cleanup func ( ) , err error ) {
2020-05-25 08:05:53 +02:00
// we need an MD5
2018-08-20 16:38:21 +02:00
md5Hasher := md5 . New ( )
2019-02-07 18:41:17 +01:00
// use the teeReader to write to the local file AND calculate the MD5 while doing so
2018-08-20 16:38:21 +02:00
teeReader := io . TeeReader ( in , md5Hasher )
// nothing to clean up by default
cleanup = func ( ) { }
// don't cache small files on disk to reduce wear of the disk
if size > threshold {
var tempFile * os . File
// create the cache file
tempFile , err = ioutil . TempFile ( "" , cachePrefix )
if err != nil {
return
}
_ = os . Remove ( tempFile . Name ( ) ) // Delete the file - may not work on Windows
// clean up the file after we are done downloading
cleanup = func ( ) {
// the file should normally already be close, but just to make sure
_ = tempFile . Close ( )
_ = os . Remove ( tempFile . Name ( ) ) // delete the cache file after we are done - may be deleted already
}
// copy the ENTIRE file to disc and calculate the MD5 in the process
if _ , err = io . Copy ( tempFile , teeReader ) ; err != nil {
return
}
// jump to the start of the local file so we can pass it along
if _ , err = tempFile . Seek ( 0 , 0 ) ; err != nil {
return
}
// replace the already read source with a reader of our cached file
out = tempFile
} else {
// that's a small file, just read it into memory
var inData [ ] byte
inData , err = ioutil . ReadAll ( teeReader )
if err != nil {
return
}
// set the reader to our read memory block
out = bytes . NewReader ( inData )
}
return hex . EncodeToString ( md5Hasher . Sum ( nil ) ) , out , cleanup , nil
}
2018-08-02 01:02:35 +02:00
// Update the object with the contents of the io.Reader, modTime and size
//
// If existing is set then it updates the object rather than creating a new one
//
// The new object may have been created if an error is returned
2019-06-17 10:34:30 +02:00
func ( o * Object ) Update ( ctx context . Context , in io . Reader , src fs . ObjectInfo , options ... fs . OpenOption ) ( err error ) {
2021-07-01 23:17:05 +02:00
if o . fs . opt . NoVersions {
err := o . readMetaData ( ctx , false )
if err == nil {
// if the object exists delete it
err = o . remove ( ctx , true )
if err != nil {
return errors . Wrap ( err , "failed to remove old object" )
}
}
// if the object does not exist we can just continue but if the error is something different we should report that
if err != fs . ErrorObjectNotFound {
return err
}
}
2020-12-20 17:29:57 +01:00
o . fs . tokenRenewer . Start ( )
defer o . fs . tokenRenewer . Stop ( )
2018-08-20 16:38:21 +02:00
size := src . Size ( )
2019-06-17 10:34:30 +02:00
md5String , err := src . Hash ( ctx , hash . MD5 )
2018-08-14 23:15:21 +02:00
if err != nil || md5String == "" {
2018-08-20 16:38:21 +02:00
// unwrap the accounting from the input, we use wrap to put it
// back on after the buffering
var wrap accounting . WrapFn
in , wrap = accounting . UnWrap ( in )
var cleanup func ( )
md5String , in , cleanup , err = readMD5 ( in , size , int64 ( o . fs . opt . MD5MemoryThreshold ) )
defer cleanup ( )
if err != nil {
return errors . Wrap ( err , "failed to calculate MD5" )
2018-08-14 23:15:21 +02:00
}
2018-08-20 16:38:21 +02:00
// Wrap the accounting back onto the stream
in = wrap ( in )
2018-08-14 23:15:21 +02:00
}
2018-08-22 22:26:18 +02:00
// use the api to allocate the file first and get resume / deduplication info
2018-12-30 00:53:18 +01:00
var resp * http . Response
2018-08-02 01:02:35 +02:00
opts := rest . Opts {
2018-08-22 22:26:18 +02:00
Method : "POST" ,
2019-08-13 15:28:46 +02:00
Path : "files/v1/allocate" ,
2020-03-21 22:54:00 +01:00
Options : options ,
2018-08-22 22:26:18 +02:00
ExtraHeaders : make ( map [ string ] string ) ,
}
2019-06-17 10:34:30 +02:00
fileDate := api . Time ( src . ModTime ( ctx ) ) . APIString ( )
2018-08-02 01:02:35 +02:00
2018-08-22 22:26:18 +02:00
// the allocate request
var request = api . AllocateFileRequest {
Bytes : size ,
Created : fileDate ,
Modified : fileDate ,
Md5 : md5String ,
2020-01-14 18:33:35 +01:00
Path : path . Join ( o . fs . opt . Mountpoint , o . fs . opt . Enc . FromStandardPath ( path . Join ( o . fs . root , o . remote ) ) ) ,
2018-08-22 22:26:18 +02:00
}
// send it
var response api . AllocateFileResponse
2018-08-02 01:02:35 +02:00
err = o . fs . pacer . CallNoRetry ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err = o . fs . apiSrv . CallJSON ( ctx , & opts , & request , & response )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-08-02 01:02:35 +02:00
} )
if err != nil {
return err
}
Spelling fixes
Fix spelling of: above, already, anonymous, associated,
authentication, bandwidth, because, between, blocks, calculate,
candidates, cautious, changelog, cleaner, clipboard, command,
completely, concurrently, considered, constructs, corrupt, current,
daemon, dependencies, deprecated, directory, dispatcher, download,
eligible, ellipsis, encrypter, endpoint, entrieslist, essentially,
existing writers, existing, expires, filesystem, flushing, frequently,
hierarchy, however, implementation, implements, inaccurate,
individually, insensitive, longer, maximum, metadata, modified,
multipart, namedirfirst, nextcloud, obscured, opened, optional,
owncloud, pacific, passphrase, password, permanently, persimmon,
positive, potato, protocol, quota, receiving, recommends, referring,
requires, revisited, satisfied, satisfies, satisfy, semver,
serialized, session, storage, strategies, stringlist, successful,
supported, surprise, temporarily, temporary, transactions, unneeded,
update, uploads, wrapped
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-09 02:17:24 +02:00
// If the file state is INCOMPLETE and CORRUPT, try to upload a then
2018-08-22 22:26:18 +02:00
if response . State != "COMPLETED" {
// how much do we still have to upload?
remainingBytes := size - response . ResumePos
opts = rest . Opts {
Method : "POST" ,
RootURL : response . UploadURL ,
ContentLength : & remainingBytes ,
2018-12-30 00:53:18 +01:00
ContentType : "application/octet-stream" ,
2018-08-22 22:26:18 +02:00
Body : in ,
ExtraHeaders : make ( map [ string ] string ) ,
}
if response . ResumePos != 0 {
opts . ExtraHeaders [ "Range" ] = "bytes=" + strconv . FormatInt ( response . ResumePos , 10 ) + "-" + strconv . FormatInt ( size - 1 , 10 )
}
// copy the already uploaded bytes into the trash :)
var result api . UploadResponse
_ , err = io . CopyN ( ioutil . Discard , in , response . ResumePos )
if err != nil {
return err
}
// send the remaining bytes
2019-09-04 21:00:37 +02:00
resp , err = o . fs . apiSrv . CallJSON ( ctx , & opts , nil , & result )
2018-08-22 22:26:18 +02:00
if err != nil {
return err
}
// finally update the meta data
o . hasMetaData = true
2019-01-11 18:17:46 +01:00
o . size = result . Bytes
2018-08-22 22:26:18 +02:00
o . md5 = result . Md5
o . modTime = time . Unix ( result . Modified / 1000 , 0 )
2018-12-30 00:53:18 +01:00
} else {
2019-08-14 19:39:19 +02:00
// If the file state is COMPLETE we don't need to upload it because the file was already found but we still ned to update our metadata
2019-09-04 21:00:37 +02:00
return o . readMetaData ( ctx , true )
2018-08-22 22:26:18 +02:00
}
return nil
2018-08-02 01:02:35 +02:00
}
2021-07-01 23:17:05 +02:00
func ( o * Object ) remove ( ctx context . Context , hard bool ) error {
2018-08-02 01:02:35 +02:00
opts := rest . Opts {
Method : "POST" ,
Path : o . filePath ( ) ,
Parameters : url . Values { } ,
2018-10-13 13:32:46 +02:00
NoResponse : true ,
2018-08-02 01:02:35 +02:00
}
2021-07-01 23:17:05 +02:00
if hard {
2018-09-07 13:58:18 +02:00
opts . Parameters . Set ( "rm" , "true" )
} else {
opts . Parameters . Set ( "dl" , "true" )
}
2018-08-02 01:02:35 +02:00
return o . fs . pacer . Call ( func ( ) ( bool , error ) {
2019-09-04 21:00:37 +02:00
resp , err := o . fs . srv . CallXML ( ctx , & opts , nil , nil )
2021-03-11 15:44:01 +01:00
return shouldRetry ( ctx , resp , err )
2018-08-02 01:02:35 +02:00
} )
}
2021-07-01 23:17:05 +02:00
// Remove an object
func ( o * Object ) Remove ( ctx context . Context ) error {
return o . remove ( ctx , o . fs . opt . HardDelete )
}
2018-08-02 01:02:35 +02:00
// Check the interfaces are satisfied
var (
2018-09-04 21:02:35 +02:00
_ fs . Fs = ( * Fs ) ( nil )
_ fs . Purger = ( * Fs ) ( nil )
_ fs . Copier = ( * Fs ) ( nil )
_ fs . Mover = ( * Fs ) ( nil )
_ fs . DirMover = ( * Fs ) ( nil )
_ fs . ListRer = ( * Fs ) ( nil )
_ fs . PublicLinker = ( * Fs ) ( nil )
_ fs . Abouter = ( * Fs ) ( nil )
2020-04-11 12:30:35 +02:00
_ fs . CleanUpper = ( * Fs ) ( nil )
2018-09-04 21:02:35 +02:00
_ fs . Object = ( * Object ) ( nil )
_ fs . MimeTyper = ( * Object ) ( nil )
2018-08-02 01:02:35 +02:00
)