-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
/
mailru.go
2458 lines (2196 loc) · 63.9 KB
/
mailru.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Package mailru provides an interface to the Mail.ru Cloud storage system.
package mailru
import (
"bytes"
"context"
"errors"
"fmt"
gohash "hash"
"io"
"path"
"path/filepath"
"sort"
"strconv"
"strings"
"sync"
"time"
"encoding/hex"
"encoding/json"
"net/http"
"net/url"
"github.com/rclone/rclone/backend/mailru/api"
"github.com/rclone/rclone/backend/mailru/mrhash"
"github.com/rclone/rclone/fs"
"github.com/rclone/rclone/fs/config"
"github.com/rclone/rclone/fs/config/configmap"
"github.com/rclone/rclone/fs/config/configstruct"
"github.com/rclone/rclone/fs/config/obscure"
"github.com/rclone/rclone/fs/fserrors"
"github.com/rclone/rclone/fs/fshttp"
"github.com/rclone/rclone/fs/hash"
"github.com/rclone/rclone/fs/object"
"github.com/rclone/rclone/fs/operations"
"github.com/rclone/rclone/lib/encoder"
"github.com/rclone/rclone/lib/oauthutil"
"github.com/rclone/rclone/lib/pacer"
"github.com/rclone/rclone/lib/readers"
"github.com/rclone/rclone/lib/rest"
"golang.org/x/oauth2"
)
// Global constants
const (
minSleepPacer = 100 * time.Millisecond
maxSleepPacer = 5 * time.Second
decayConstPacer = 2 // bigger for slower decay, exponential
metaExpirySec = 20 * 60 // meta server expiration time
serverExpirySec = 3 * 60 // download server expiration time
shardExpirySec = 30 * 60 // upload server expiration time
maxServerLocks = 4 // maximum number of locks per single download server
maxInt32 = 2147483647 // used as limit in directory list request
speedupMinSize = 512 // speedup is not optimal if data is smaller than average packet
)
// Global errors
var (
ErrorDirAlreadyExists = errors.New("directory already exists")
ErrorDirSourceNotExists = errors.New("directory source does not exist")
ErrorInvalidName = errors.New("invalid characters in object name")
// MrHashType is the hash.Type for Mailru
MrHashType hash.Type
)
// Description of how to authorize
var oauthConfig = &oauth2.Config{
ClientID: api.OAuthClientID,
ClientSecret: "",
Endpoint: oauth2.Endpoint{
AuthURL: api.OAuthURL,
TokenURL: api.OAuthURL,
AuthStyle: oauth2.AuthStyleInParams,
},
}
// Register with Fs
func init() {
MrHashType = hash.RegisterHash("mailru", "MailruHash", 40, mrhash.New)
fs.Register(&fs.RegInfo{
Name: "mailru",
Description: "Mail.ru Cloud",
NewFs: NewFs,
Options: append(oauthutil.SharedOptions, []fs.Option{{
Name: "user",
Help: "User name (usually email).",
Required: true,
Sensitive: true,
}, {
Name: "pass",
Help: `Password.
This must be an app password - rclone will not work with your normal
password. See the Configuration section in the docs for how to make an
app password.
`,
Required: true,
IsPassword: true,
}, {
Name: "speedup_enable",
Default: true,
Advanced: false,
Help: `Skip full upload if there is another file with same data hash.
This feature is called "speedup" or "put by hash". It is especially efficient
in case of generally available files like popular books, video or audio clips,
because files are searched by hash in all accounts of all mailru users.
It is meaningless and ineffective if source file is unique or encrypted.
Please note that rclone may need local memory and disk space to calculate
content hash in advance and decide whether full upload is required.
Also, if rclone does not know file size in advance (e.g. in case of
streaming or partial uploads), it will not even try this optimization.`,
Examples: []fs.OptionExample{{
Value: "true",
Help: "Enable",
}, {
Value: "false",
Help: "Disable",
}},
}, {
Name: "speedup_file_patterns",
Default: "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf",
Advanced: true,
Help: `Comma separated list of file name patterns eligible for speedup (put by hash).
Patterns are case insensitive and can contain '*' or '?' meta characters.`,
Examples: []fs.OptionExample{{
Value: "",
Help: "Empty list completely disables speedup (put by hash).",
}, {
Value: "*",
Help: "All files will be attempted for speedup.",
}, {
Value: "*.mkv,*.avi,*.mp4,*.mp3",
Help: "Only common audio/video files will be tried for put by hash.",
}, {
Value: "*.zip,*.gz,*.rar,*.pdf",
Help: "Only common archives or PDF books will be tried for speedup.",
}},
}, {
Name: "speedup_max_disk",
Default: fs.SizeSuffix(3 * 1024 * 1024 * 1024),
Advanced: true,
Help: `This option allows you to disable speedup (put by hash) for large files.
Reason is that preliminary hashing can exhaust your RAM or disk space.`,
Examples: []fs.OptionExample{{
Value: "0",
Help: "Completely disable speedup (put by hash).",
}, {
Value: "1G",
Help: "Files larger than 1Gb will be uploaded directly.",
}, {
Value: "3G",
Help: "Choose this option if you have less than 3Gb free on local disk.",
}},
}, {
Name: "speedup_max_memory",
Default: fs.SizeSuffix(32 * 1024 * 1024),
Advanced: true,
Help: `Files larger than the size given below will always be hashed on disk.`,
Examples: []fs.OptionExample{{
Value: "0",
Help: "Preliminary hashing will always be done in a temporary disk location.",
}, {
Value: "32M",
Help: "Do not dedicate more than 32Mb RAM for preliminary hashing.",
}, {
Value: "256M",
Help: "You have at most 256Mb RAM free for hash calculations.",
}},
}, {
Name: "check_hash",
Default: true,
Advanced: true,
Help: "What should copy do if file checksum is mismatched or invalid.",
Examples: []fs.OptionExample{{
Value: "true",
Help: "Fail with error.",
}, {
Value: "false",
Help: "Ignore and continue.",
}},
}, {
Name: "user_agent",
Default: "",
Advanced: true,
Hide: fs.OptionHideBoth,
Help: `HTTP user agent used internally by client.
Defaults to "rclone/VERSION" or "--user-agent" provided on command line.`,
}, {
Name: "quirks",
Default: "",
Advanced: true,
Hide: fs.OptionHideBoth,
Help: `Comma separated list of internal maintenance flags.
This option must not be used by an ordinary user. It is intended only to
facilitate remote troubleshooting of backend issues. Strict meaning of
flags is not documented and not guaranteed to persist between releases.
Quirks will be removed when the backend grows stable.
Supported quirks: atomicmkdir binlist unknowndirs`,
}, {
Name: config.ConfigEncoding,
Help: config.ConfigEncodingHelp,
Advanced: true,
// Encode invalid UTF-8 bytes as json doesn't handle them properly.
Default: (encoder.Display |
encoder.EncodeWin | // :?"*<>|
encoder.EncodeBackSlash |
encoder.EncodeInvalidUtf8),
}}...),
})
}
// Options defines the configuration for this backend
type Options struct {
Username string `config:"user"`
Password string `config:"pass"`
UserAgent string `config:"user_agent"`
CheckHash bool `config:"check_hash"`
SpeedupEnable bool `config:"speedup_enable"`
SpeedupPatterns string `config:"speedup_file_patterns"`
SpeedupMaxDisk fs.SizeSuffix `config:"speedup_max_disk"`
SpeedupMaxMem fs.SizeSuffix `config:"speedup_max_memory"`
Quirks string `config:"quirks"`
Enc encoder.MultiEncoder `config:"encoding"`
}
// 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 response and err
// deserve to be retried. It returns the err as a convenience.
// Retries password authorization (once) in a special case of access denied.
func shouldRetry(ctx context.Context, res *http.Response, err error, f *Fs, opts *rest.Opts) (bool, error) {
if fserrors.ContextError(ctx, &err) {
return false, err
}
if res != nil && res.StatusCode == 403 && f.opt.Password != "" && !f.passFailed {
reAuthErr := f.reAuthorize(opts, err)
return reAuthErr == nil, err // return an original error
}
return fserrors.ShouldRetry(err) || fserrors.ShouldRetryHTTP(res, retryErrorCodes), err
}
// errorHandler parses a non 2xx error response into an error
func errorHandler(res *http.Response) (err error) {
data, err := rest.ReadBody(res)
if err != nil {
return err
}
fileError := &api.FileErrorResponse{}
err = json.NewDecoder(bytes.NewReader(data)).Decode(fileError)
if err == nil {
fileError.Message = fileError.Body.Home.Error
return fileError
}
serverError := &api.ServerErrorResponse{}
err = json.NewDecoder(bytes.NewReader(data)).Decode(serverError)
if err == nil {
return serverError
}
serverError.Message = string(data)
if serverError.Message == "" || strings.HasPrefix(serverError.Message, "{") {
// Replace empty or JSON response with a human-readable text.
serverError.Message = res.Status
}
serverError.Status = res.StatusCode
return serverError
}
// Fs represents a remote mail.ru
type Fs struct {
name string
root string // root path
opt Options // parsed options
ci *fs.ConfigInfo // global config
speedupGlobs []string // list of file name patterns eligible for speedup
speedupAny bool // true if all file names are eligible for speedup
features *fs.Features // optional features
srv *rest.Client // REST API client
cli *http.Client // underlying HTTP client (for authorize)
m configmap.Mapper // config reader (for authorize)
source oauth2.TokenSource // OAuth token refresher
pacer *fs.Pacer // pacer for API calls
metaMu sync.Mutex // lock for meta server switcher
metaURL string // URL of meta server
metaExpiry time.Time // time to refresh meta server
shardMu sync.Mutex // lock for upload shard switcher
shardURL string // URL of upload shard
shardExpiry time.Time // time to refresh upload shard
fileServers serverPool // file server dispatcher
authMu sync.Mutex // mutex for authorize()
passFailed bool // true if authorize() failed after 403
quirks quirks // internal maintenance flags
}
// NewFs constructs an Fs from the path, container:path
func NewFs(ctx context.Context, name, root string, m configmap.Mapper) (fs.Fs, error) {
// fs.Debugf(nil, ">>> NewFs %q %q", name, root)
// Parse config into Options struct
opt := new(Options)
err := configstruct.Set(m, opt)
if err != nil {
return nil, err
}
if opt.Password != "" {
opt.Password = obscure.MustReveal(opt.Password)
}
// Trailing slash signals us to optimize out one file check
rootIsDir := strings.HasSuffix(root, "/")
// However the f.root string should not have leading or trailing slashes
root = strings.Trim(root, "/")
ci := fs.GetConfig(ctx)
f := &Fs{
name: name,
root: root,
opt: *opt,
ci: ci,
m: m,
}
if err := f.parseSpeedupPatterns(opt.SpeedupPatterns); err != nil {
return nil, err
}
f.quirks.parseQuirks(opt.Quirks)
f.pacer = fs.NewPacer(ctx, pacer.NewDefault(pacer.MinSleep(minSleepPacer), pacer.MaxSleep(maxSleepPacer), pacer.DecayConstant(decayConstPacer)))
f.features = (&fs.Features{
CaseInsensitive: true,
CanHaveEmptyDirectories: true,
// Can copy/move across mailru configs (almost, thus true here), but
// only when they share common account (this is checked in Copy/Move).
ServerSideAcrossConfigs: true,
}).Fill(ctx, f)
// Override few config settings and create a client
newCtx, clientConfig := fs.AddConfig(ctx)
if opt.UserAgent != "" {
clientConfig.UserAgent = opt.UserAgent
}
clientConfig.NoGzip = true // Mimic official client, skip sending "Accept-Encoding: gzip"
f.cli = fshttp.NewClient(newCtx)
f.srv = rest.NewClient(f.cli)
f.srv.SetRoot(api.APIServerURL)
f.srv.SetHeader("Accept", "*/*") // Send "Accept: */*" with every request like official client
f.srv.SetErrorHandler(errorHandler)
if err = f.authorize(ctx, false); err != nil {
return nil, err
}
f.fileServers = serverPool{
pool: make(pendingServerMap),
fs: f,
path: "/d",
expirySec: serverExpirySec,
}
if !rootIsDir {
_, dirSize, err := f.readItemMetaData(ctx, f.root)
rootIsDir = (dirSize >= 0)
// Ignore non-existing item and other errors
if err == nil && !rootIsDir {
root = path.Dir(f.root)
if root == "." {
root = ""
}
f.root = root
// Return fs that points to the parent and signal rclone to do filtering
return f, fs.ErrorIsFile
}
}
return f, nil
}
// Internal maintenance flags (to be removed when the backend matures).
// Primarily intended to facilitate remote support and troubleshooting.
type quirks struct {
binlist bool
atomicmkdir bool
unknowndirs bool
}
func (q *quirks) parseQuirks(option string) {
for _, flag := range strings.Split(option, ",") {
switch strings.ToLower(strings.TrimSpace(flag)) {
case "binlist":
// The official client sometimes uses a so called "bin" protocol,
// implemented in the listBin file system method below. This method
// is generally faster than non-recursive listM1 but results in
// sporadic deserialization failures if total size of tree data
// approaches 8Kb (?). The recursive method is normally disabled.
// This quirk can be used to enable it for further investigation.
// Remove this quirk when the "bin" protocol support is complete.
q.binlist = true
case "atomicmkdir":
// At the moment rclone requires Mkdir to return success if the
// directory already exists. However, such programs as borgbackup
// use mkdir as a locking primitive and depend on its atomicity.
// Remove this quirk when the above issue is investigated.
q.atomicmkdir = true
case "unknowndirs":
// Accepts unknown resource types as folders.
q.unknowndirs = true
default:
// Ignore unknown flags
}
}
}
// Note: authorize() is not safe for concurrent access as it updates token source
func (f *Fs) authorize(ctx context.Context, force bool) (err error) {
var t *oauth2.Token
if !force {
t, err = oauthutil.GetToken(f.name, f.m)
}
if err != nil || !tokenIsValid(t) {
fs.Infof(f, "Valid token not found, authorizing.")
ctx := oauthutil.Context(ctx, f.cli)
t, err = oauthConfig.PasswordCredentialsToken(ctx, f.opt.Username, f.opt.Password)
}
if err == nil && !tokenIsValid(t) {
err = errors.New("invalid token")
}
if err != nil {
return fmt.Errorf("failed to authorize: %w", err)
}
if err = oauthutil.PutToken(f.name, f.m, t, false); err != nil {
return err
}
// Mailru API server expects access token not in the request header but
// in the URL query string, so we must use a bare token source rather than
// client provided by oauthutil.
//
// WARNING: direct use of the returned token source triggers a bug in the
// `(*token != *ts.token)` comparison in oauthutil.TokenSource.Token()
// crashing with panic `comparing uncomparable type map[string]interface{}`
// As a workaround, mimic oauth2.NewClient() wrapping token source in
// oauth2.ReuseTokenSource
_, ts, err := oauthutil.NewClientWithBaseClient(ctx, f.name, f.m, oauthConfig, f.cli)
if err == nil {
f.source = oauth2.ReuseTokenSource(nil, ts)
}
return err
}
func tokenIsValid(t *oauth2.Token) bool {
return t.Valid() && t.RefreshToken != "" && t.Type() == "Bearer"
}
// reAuthorize is called after getting 403 (access denied) from the server.
// It handles the case when user has changed password since a previous
// rclone invocation and obtains a new access token, if needed.
func (f *Fs) reAuthorize(opts *rest.Opts, origErr error) error {
// lock and recheck the flag to ensure authorize() is attempted only once
f.authMu.Lock()
defer f.authMu.Unlock()
if f.passFailed {
return origErr
}
ctx := context.Background() // Note: reAuthorize is called by ShouldRetry, no context!
fs.Debugf(f, "re-authorize with new password")
if err := f.authorize(ctx, true); err != nil {
f.passFailed = true
return err
}
// obtain new token, if needed
tokenParameter := ""
if opts != nil && opts.Parameters.Get("token") != "" {
tokenParameter = "token"
}
if opts != nil && opts.Parameters.Get("access_token") != "" {
tokenParameter = "access_token"
}
if tokenParameter != "" {
token, err := f.accessToken()
if err != nil {
f.passFailed = true
return err
}
opts.Parameters.Set(tokenParameter, token)
}
return nil
}
// accessToken() returns OAuth token and possibly refreshes it
func (f *Fs) accessToken() (string, error) {
token, err := f.source.Token()
if err != nil {
return "", fmt.Errorf("cannot refresh access token: %w", err)
}
return token.AccessToken, nil
}
// absPath converts root-relative remote to absolute home path
func (f *Fs) absPath(remote string) string {
return path.Join("/", f.root, remote)
}
// relPath converts absolute home path to root-relative remote
// Note that f.root can not have leading and trailing slashes
func (f *Fs) relPath(absPath string) (string, error) {
target := strings.Trim(absPath, "/")
if f.root == "" {
return target, nil
}
if target == f.root {
return "", nil
}
if strings.HasPrefix(target+"/", f.root+"/") {
return target[len(f.root)+1:], nil
}
return "", fmt.Errorf("path %q should be under %q", absPath, f.root)
}
// metaServer returns URL of current meta server
func (f *Fs) metaServer(ctx context.Context) (string, error) {
f.metaMu.Lock()
defer f.metaMu.Unlock()
if f.metaURL != "" && time.Now().Before(f.metaExpiry) {
return f.metaURL, nil
}
opts := rest.Opts{
RootURL: api.DispatchServerURL,
Method: "GET",
Path: "/m",
}
var (
res *http.Response
url string
err error
)
err = f.pacer.Call(func() (bool, error) {
res, err = f.srv.Call(ctx, &opts)
if err == nil {
url, err = readBodyWord(res)
}
return fserrors.ShouldRetry(err), err
})
if err != nil {
closeBody(res)
return "", err
}
f.metaURL = url
f.metaExpiry = time.Now().Add(metaExpirySec * time.Second)
fs.Debugf(f, "new meta server: %s", f.metaURL)
return f.metaURL, nil
}
// readBodyWord reads the single line response to completion
// and extracts the first word from the first line.
func readBodyWord(res *http.Response) (word string, err error) {
var body []byte
body, err = rest.ReadBody(res)
if err == nil {
line := strings.Trim(string(body), " \r\n")
word = strings.Split(line, " ")[0]
}
if word == "" {
return "", errors.New("empty reply from dispatcher")
}
return word, nil
}
// readItemMetaData returns a file/directory info at given full path
// If it can't be found it fails with fs.ErrorObjectNotFound
// For the return value `dirSize` please see Fs.itemToEntry()
func (f *Fs) readItemMetaData(ctx context.Context, path string) (entry fs.DirEntry, dirSize int, err error) {
token, err := f.accessToken()
if err != nil {
return nil, -1, err
}
opts := rest.Opts{
Method: "GET",
Path: "/api/m1/file",
Parameters: url.Values{
"access_token": {token},
"home": {f.opt.Enc.FromStandardPath(path)},
"offset": {"0"},
"limit": {strconv.Itoa(maxInt32)},
},
}
var info api.ItemInfoResponse
err = f.pacer.Call(func() (bool, error) {
res, err := f.srv.CallJSON(ctx, &opts, nil, &info)
return shouldRetry(ctx, res, err, f, &opts)
})
if err != nil {
if apiErr, ok := err.(*api.FileErrorResponse); ok {
switch apiErr.Status {
case 404:
err = fs.ErrorObjectNotFound
case 400:
fs.Debugf(f, "object %q status %d (%s)", path, apiErr.Status, apiErr.Message)
err = fs.ErrorObjectNotFound
}
}
return
}
entry, dirSize, err = f.itemToDirEntry(ctx, &info.Body)
return
}
// itemToEntry converts API item to rclone directory entry
// The dirSize return value is:
//
// <0 - for a file or in case of error
// =0 - for an empty directory
// >0 - for a non-empty directory
func (f *Fs) itemToDirEntry(ctx context.Context, item *api.ListItem) (entry fs.DirEntry, dirSize int, err error) {
remote, err := f.relPath(f.opt.Enc.ToStandardPath(item.Home))
if err != nil {
return nil, -1, err
}
modTime := time.Unix(int64(item.Mtime), 0)
isDir, err := f.isDir(item.Kind, remote)
if err != nil {
return nil, -1, err
}
if isDir {
dir := fs.NewDir(remote, modTime).SetSize(item.Size)
return dir, item.Count.Files + item.Count.Folders, nil
}
binHash, err := mrhash.DecodeString(item.Hash)
if err != nil {
return nil, -1, err
}
file := &Object{
fs: f,
remote: remote,
hasMetaData: true,
size: item.Size,
mrHash: binHash,
modTime: modTime,
}
return file, -1, nil
}
// isDir returns true for directories, false for files
func (f *Fs) isDir(kind, path string) (bool, error) {
switch kind {
case "":
return false, errors.New("empty resource type")
case "file":
return false, nil
case "folder":
// fall thru
case "camera-upload", "mounted", "shared":
fs.Debugf(f, "[%s]: folder has type %q", path, kind)
default:
if !f.quirks.unknowndirs {
return false, fmt.Errorf("unknown resource type %q", kind)
}
fs.Errorf(f, "[%s]: folder has unknown type %q", path, kind)
}
return true, 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.
func (f *Fs) List(ctx context.Context, dir string) (entries fs.DirEntries, err error) {
// fs.Debugf(f, ">>> List: %q", dir)
if f.quirks.binlist {
entries, err = f.listBin(ctx, f.absPath(dir), 1)
} else {
entries, err = f.listM1(ctx, f.absPath(dir), 0, maxInt32)
}
if err == nil && f.ci.LogLevel >= fs.LogLevelDebug {
names := []string{}
for _, entry := range entries {
names = append(names, entry.Remote())
}
sort.Strings(names)
// fs.Debugf(f, "List(%q): %v", dir, names)
}
return
}
// list using protocol "m1"
func (f *Fs) listM1(ctx context.Context, dirPath string, offset int, limit int) (entries fs.DirEntries, err error) {
token, err := f.accessToken()
if err != nil {
return nil, err
}
params := url.Values{}
params.Set("access_token", token)
params.Set("offset", strconv.Itoa(offset))
params.Set("limit", strconv.Itoa(limit))
data := url.Values{}
data.Set("home", f.opt.Enc.FromStandardPath(dirPath))
opts := rest.Opts{
Method: "POST",
Path: "/api/m1/folder",
Parameters: params,
Body: strings.NewReader(data.Encode()),
ContentType: api.BinContentType,
}
var (
info api.FolderInfoResponse
res *http.Response
)
err = f.pacer.Call(func() (bool, error) {
res, err = f.srv.CallJSON(ctx, &opts, nil, &info)
return shouldRetry(ctx, res, err, f, &opts)
})
if err != nil {
apiErr, ok := err.(*api.FileErrorResponse)
if ok && apiErr.Status == 404 {
return nil, fs.ErrorDirNotFound
}
return nil, err
}
isDir, err := f.isDir(info.Body.Kind, dirPath)
if err != nil {
return nil, err
}
if !isDir {
return nil, fs.ErrorIsFile
}
for _, item := range info.Body.List {
entry, _, err := f.itemToDirEntry(ctx, &item)
if err == nil {
entries = append(entries, entry)
} else {
fs.Debugf(f, "Excluding path %q from list: %v", item.Home, err)
}
}
return entries, nil
}
// list using protocol "bin"
func (f *Fs) listBin(ctx context.Context, dirPath string, depth int) (entries fs.DirEntries, err error) {
options := api.ListOptDefaults
req := api.NewBinWriter()
req.WritePu16(api.OperationFolderList)
req.WriteString(f.opt.Enc.FromStandardPath(dirPath))
req.WritePu32(int64(depth))
req.WritePu32(int64(options))
req.WritePu32(0)
token, err := f.accessToken()
if err != nil {
return nil, err
}
metaURL, err := f.metaServer(ctx)
if err != nil {
return nil, err
}
opts := rest.Opts{
Method: "POST",
RootURL: metaURL,
Parameters: url.Values{
"client_id": {api.OAuthClientID},
"token": {token},
},
ContentType: api.BinContentType,
Body: req.Reader(),
}
var res *http.Response
err = f.pacer.Call(func() (bool, error) {
res, err = f.srv.Call(ctx, &opts)
return shouldRetry(ctx, res, err, f, &opts)
})
if err != nil {
closeBody(res)
return nil, err
}
r := api.NewBinReader(res.Body)
defer closeBody(res)
// read status
switch status := r.ReadByteAsInt(); status {
case api.ListResultOK:
// go on...
case api.ListResultNotExists:
return nil, fs.ErrorDirNotFound
default:
return nil, fmt.Errorf("directory list error %d", status)
}
t := &treeState{
f: f,
r: r,
options: options,
rootDir: parentDir(dirPath),
lastDir: "",
level: 0,
}
t.currDir = t.rootDir
// read revision
if err := t.revision.Read(r); err != nil {
return nil, err
}
// read space
if (options & api.ListOptTotalSpace) != 0 {
t.totalSpace = int64(r.ReadULong())
}
if (options & api.ListOptUsedSpace) != 0 {
t.usedSpace = int64(r.ReadULong())
}
t.fingerprint = r.ReadBytesByLength()
// deserialize
for {
entry, err := t.NextRecord()
if err != nil {
break
}
if entry != nil {
entries = append(entries, entry)
}
}
if err != nil && err != fs.ErrorListAborted {
fs.Debugf(f, "listBin failed at offset %d: %v", r.Count(), err)
return nil, err
}
return entries, nil
}
func (t *treeState) NextRecord() (fs.DirEntry, error) {
r := t.r
parseOp := r.ReadByteAsShort()
if r.Error() != nil {
return nil, r.Error()
}
switch parseOp {
case api.ListParseDone:
return nil, fs.ErrorListAborted
case api.ListParsePin:
if t.lastDir == "" {
return nil, errors.New("last folder is null")
}
t.currDir = t.lastDir
t.level++
return nil, nil
case api.ListParsePinUpper:
if t.currDir == t.rootDir {
return nil, nil
}
if t.level <= 0 {
return nil, errors.New("no parent folder")
}
t.currDir = parentDir(t.currDir)
t.level--
return nil, nil
case api.ListParseUnknown15:
skip := int(r.ReadPu32())
for i := 0; i < skip; i++ {
r.ReadPu32()
r.ReadPu32()
}
return nil, nil
case api.ListParseReadItem:
// get item (see below)
default:
return nil, fmt.Errorf("unknown parse operation %d", parseOp)
}
// get item
head := r.ReadIntSpl()
itemType := head & 3
if (head & 4096) != 0 {
t.dunnoNodeID = r.ReadNBytes(api.DunnoNodeIDLength)
}
name := t.f.opt.Enc.FromStandardPath(string(r.ReadBytesByLength()))
t.dunno1 = int(r.ReadULong())
t.dunno2 = 0
t.dunno3 = 0
if r.Error() != nil {
return nil, r.Error()
}
var (
modTime time.Time
size int64
binHash []byte
dirSize int64
isDir = true
)
switch itemType {
case api.ListItemMountPoint:
t.treeID = r.ReadNBytes(api.TreeIDLength)
t.dunno2 = int(r.ReadULong())
t.dunno3 = int(r.ReadULong())
case api.ListItemFolder:
t.dunno2 = int(r.ReadULong())
case api.ListItemSharedFolder:
t.dunno2 = int(r.ReadULong())
t.treeID = r.ReadNBytes(api.TreeIDLength)
case api.ListItemFile:
isDir = false
modTime = r.ReadDate()
size = int64(r.ReadULong())
binHash = r.ReadNBytes(mrhash.Size)
default:
return nil, fmt.Errorf("unknown item type %d", itemType)
}
if isDir {
t.lastDir = path.Join(t.currDir, name)
if (t.options & api.ListOptDelete) != 0 {
t.dunnoDel1 = int(r.ReadPu32())
t.dunnoDel2 = int(r.ReadPu32())
}
if (t.options & api.ListOptFolderSize) != 0 {
dirSize = int64(r.ReadULong())
}
}
if r.Error() != nil {
return nil, r.Error()
}
if t.f.ci.LogLevel >= fs.LogLevelDebug {
ctime, _ := modTime.MarshalJSON()
fs.Debugf(t.f, "binDir %d.%d %q %q (%d) %s", t.level, itemType, t.currDir, name, size, ctime)
}
if t.level != 1 {
// TODO: implement recursion and ListR
// Note: recursion is broken because maximum buffer size is 8K
return nil, nil
}
remote, err := t.f.relPath(path.Join(t.currDir, name))
if err != nil {
return nil, err
}
if isDir {
return fs.NewDir(remote, modTime).SetSize(dirSize), nil
}
obj := &Object{
fs: t.f,
remote: remote,
hasMetaData: true,
size: size,
mrHash: binHash,
modTime: modTime,
}
return obj, nil
}