forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kbfs_ops.go
2099 lines (1820 loc) · 60.6 KB
/
kbfs_ops.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
// Copyright 2016 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.
package libkbfs
import (
"fmt"
"sync"
"time"
"github.com/keybase/client/go/kbfs/data"
"github.com/keybase/client/go/kbfs/env"
"github.com/keybase/client/go/kbfs/favorites"
"github.com/keybase/client/go/kbfs/idutil"
"github.com/keybase/client/go/kbfs/kbfscrypto"
"github.com/keybase/client/go/kbfs/kbfsedits"
"github.com/keybase/client/go/kbfs/kbfsmd"
"github.com/keybase/client/go/kbfs/kbfssync"
"github.com/keybase/client/go/kbfs/tlf"
"github.com/keybase/client/go/kbfs/tlfhandle"
"github.com/keybase/client/go/logger"
"github.com/keybase/client/go/protocol/chat1"
"github.com/keybase/client/go/protocol/keybase1"
"github.com/pkg/errors"
"golang.org/x/net/context"
)
const (
quotaUsageStaleTolerance = 10 * time.Second
initEditBlockTimeout = 500 * time.Millisecond
)
// KBFSOpsStandard implements the KBFSOps interface, and is go-routine
// safe by forwarding requests to individual per-folder-branch
// handlers that are go-routine-safe.
type KBFSOpsStandard struct {
appStateUpdater env.AppStateUpdater
config Config
log logger.Logger
deferLog logger.Logger
ops map[data.FolderBranch]*folderBranchOps
opsByFav map[favorites.Folder]*folderBranchOps
opsLock sync.RWMutex
// reIdentifyControlChan controls reidentification.
// Sending a value to this channel forces all fbos
// to be marked for revalidation.
// Closing this channel will shutdown the reidentification
// watcher.
reIdentifyControlChan chan chan<- struct{}
initDoneCh <-chan struct{}
favs *Favorites
editActivity kbfssync.RepeatedWaitGroup
editLock sync.Mutex
editShutdown bool
currentStatus *kbfsCurrentStatus
quotaUsage *EventuallyConsistentQuotaUsage
longOperationDebugDumper *ImpatientDebugDumper
initLock sync.Mutex
initEditCancel context.CancelFunc
initEditReq chan struct{}
initEditDone chan struct{}
initSyncCancel context.CancelFunc
}
var _ KBFSOps = (*KBFSOpsStandard)(nil)
const longOperationDebugDumpDuration = time.Minute
type ctxKBFSOpsSkipEditHistoryBlockType int
// This context key indicates that we should not block on TLF edit
// history initialization, as it would cause a deadlock.
const ctxKBFSOpsSkipEditHistoryBlock ctxKBFSOpsSkipEditHistoryBlockType = 1
// NewKBFSOpsStandard constructs a new KBFSOpsStandard object.
// `initDone` should be closed when the rest of initialization (such
// as journal initialization) has completed.
func NewKBFSOpsStandard(
appStateUpdater env.AppStateUpdater, config Config,
initDoneCh <-chan struct{}) *KBFSOpsStandard {
log := config.MakeLogger("")
quLog := config.MakeLogger(QuotaUsageLogModule("KBFSOps"))
kops := &KBFSOpsStandard{
appStateUpdater: appStateUpdater,
config: config,
log: log,
deferLog: log.CloneWithAddedDepth(1),
ops: make(map[data.FolderBranch]*folderBranchOps),
opsByFav: make(map[favorites.Folder]*folderBranchOps),
reIdentifyControlChan: make(chan chan<- struct{}),
initDoneCh: initDoneCh,
favs: NewFavorites(config),
quotaUsage: NewEventuallyConsistentQuotaUsage(
config, quLog, config.MakeVLogger(quLog)),
longOperationDebugDumper: NewImpatientDebugDumper(
config, longOperationDebugDumpDuration),
currentStatus: &kbfsCurrentStatus{},
}
kops.currentStatus.Init()
go kops.markForReIdentifyIfNeededLoop()
return kops
}
func (fs *KBFSOpsStandard) markForReIdentifyIfNeededLoop() {
maxValid := fs.config.TLFValidDuration()
// Tests and some users fail to set this properly.
if maxValid <= 10*time.Second || maxValid > 24*365*time.Hour {
maxValid = tlfValidDurationDefault
}
// Tick ten times the rate of valid duration allowing only overflows of +-10%
ticker := time.NewTicker(maxValid / 10)
for {
var now time.Time
var returnCh chan<- struct{}
var ok bool
select {
// Normal case: feed the current time from config and mark fbos needing
// validation.
case <-ticker.C:
now = fs.config.Clock().Now()
// Mark everything for reidentification via now being the empty value or
// quit.
case returnCh, ok = <-fs.reIdentifyControlChan:
if !ok {
ticker.Stop()
return
}
}
fs.markForReIdentifyIfNeeded(now, maxValid)
if returnCh != nil {
returnCh <- struct{}{}
}
}
}
func (fs *KBFSOpsStandard) markForReIdentifyIfNeeded(
now time.Time, maxValid time.Duration) {
fs.opsLock.Lock()
defer fs.opsLock.Unlock()
for _, fbo := range fs.ops {
fbo.markForReIdentifyIfNeeded(now, maxValid)
}
}
func (fs *KBFSOpsStandard) shutdownEdits(ctx context.Context) error {
fs.editLock.Lock()
fs.editShutdown = true
fs.editLock.Unlock()
err := fs.editActivity.Wait(ctx)
if err != nil {
return err
}
return nil
}
// Shutdown safely shuts down any background goroutines that may have
// been launched by KBFSOpsStandard.
func (fs *KBFSOpsStandard) Shutdown(ctx context.Context) error {
defer fs.longOperationDebugDumper.Shutdown() // shut it down last
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
err := fs.shutdownEdits(ctx)
if err != nil {
return err
}
close(fs.reIdentifyControlChan)
var errors []error
if err := fs.favs.Shutdown(); err != nil {
errors = append(errors, err)
}
for _, ops := range fs.ops {
if err := ops.Shutdown(ctx); err != nil {
errors = append(errors, err)
// Continue on and try to shut down the other FBOs.
}
}
if len(errors) == 1 {
return errors[0]
} else if len(errors) > 1 {
// Aggregate errors
return fmt.Errorf("Multiple errors on shutdown: %v", errors)
}
return nil
}
// PushConnectionStatusChange pushes human readable connection status changes.
func (fs *KBFSOpsStandard) PushConnectionStatusChange(
service string, newStatus error) {
fs.currentStatus.PushConnectionStatusChange(service, newStatus)
if fs.config.KeybaseService() == nil {
return
}
switch service {
case KeybaseServiceName, GregorServiceName:
default:
return
}
fs.opsLock.Lock()
defer fs.opsLock.Unlock()
for _, fbo := range fs.ops {
fbo.PushConnectionStatusChange(service, newStatus)
}
if newStatus == nil {
fs.log.CDebugf(
context.TODO(), "Asking for an edit re-init after reconnection")
fs.editActivity.Add(1)
go fs.initTlfsForEditHistories()
go fs.initSyncedTlfs()
}
}
// PushStatusChange forces a new status be fetched by status listeners.
func (fs *KBFSOpsStandard) PushStatusChange() {
fs.currentStatus.PushStatusChange()
fs.log.CDebugf(
context.TODO(), "Asking for an edit re-init after status change")
fs.editActivity.Add(1)
go fs.initTlfsForEditHistories()
go fs.initSyncedTlfs()
}
// ClearPrivateFolderMD implements the KBFSOps interface for
// KBFSOpsStandard.
func (fs *KBFSOpsStandard) ClearPrivateFolderMD(ctx context.Context) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
fs.opsLock.Lock()
defer fs.opsLock.Unlock()
// Block until all private folders have been reset. TODO:
// parallelize these, as they can block for a while waiting for
// the lock.
for _, fbo := range fs.ops {
// This call is a no-op for public folders.
fbo.ClearPrivateFolderMD(ctx)
}
}
// ForceFastForward implements the KBFSOps interface for
// KBFSOpsStandard.
func (fs *KBFSOpsStandard) ForceFastForward(ctx context.Context) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
fs.opsLock.Lock()
defer fs.opsLock.Unlock()
fs.log.CDebugf(ctx, "Forcing fast-forwards for %d folders", len(fs.ops))
for _, fbo := range fs.ops {
fbo.ForceFastForward(ctx)
}
}
// InvalidateNodeAndChildren implements the KBFSOps interface for
// KBFSOpsStandard.
func (fs *KBFSOpsStandard) InvalidateNodeAndChildren(
ctx context.Context, node Node) error {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
ops := fs.getOpsByNode(ctx, node)
return ops.InvalidateNodeAndChildren(ctx, node)
}
func (fs *KBFSOpsStandard) waitForEditHistoryInitialization(
ctx context.Context) {
if !fs.config.Mode().TLFEditHistoryEnabled() ||
ctx.Value(ctxKBFSOpsSkipEditHistoryBlock) != nil {
return
}
reqChan, doneChan := func() (chan<- struct{}, <-chan struct{}) {
fs.initLock.Lock()
defer fs.initLock.Unlock()
return fs.initEditReq, fs.initEditDone
}()
// There hasn't been a logged-in event yet, so don't wait for the
// edit history to be initialized.
if reqChan == nil {
return
}
// Send a request to unblock, if needed.
select {
case reqChan <- struct{}{}:
default:
}
select {
case <-doneChan:
// Avoid printing the log message if we don't need to wait at all.
return
default:
}
fs.log.CDebugf(ctx, "Waiting for the edit history to initialize")
// Don't wait too long for the edit history to be initialized, in
// case we are offline and someone is just trying to get the
// cached favorites.
ctx, cancel := context.WithTimeout(ctx, initEditBlockTimeout)
defer cancel()
// Wait for the initialization to complete.
select {
case <-doneChan:
case <-ctx.Done():
}
}
// GetFavorites implements the KBFSOps interface for
// KBFSOpsStandard.
func (fs *KBFSOpsStandard) GetFavorites(ctx context.Context) (
[]favorites.Folder, error) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
fs.waitForEditHistoryInitialization(ctx)
favs, err := fs.favs.Get(ctx)
if err != nil {
return nil, err
}
// Add the conflict status for any folders in a conflict state to
// the favorite struct.
journalManager, err := GetJournalManager(fs.config)
if err != nil {
// Journaling not enabled.
return favs, nil
}
_, cleared, err := journalManager.GetJournalsInConflict(ctx)
if err != nil {
return nil, err
}
for _, c := range cleared {
favs = append(favs, favorites.Folder{
Name: string(c.Name),
Type: c.Type,
})
}
return favs, nil
}
// GetFavoritesAll implements the KBFSOps interface for
// KBFSOpsStandard.
func (fs *KBFSOpsStandard) GetFavoritesAll(ctx context.Context) (
keybase1.FavoritesResult, error) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
fs.waitForEditHistoryInitialization(ctx)
favs, err := fs.favs.GetAll(ctx)
if err != nil {
return keybase1.FavoritesResult{}, err
}
tlfIDs := fs.config.GetAllSyncedTlfs()
// If we have any synced TLFs, create a quick-index map for
// favorites based on name+type.
type mapKey struct {
name string
t keybase1.FolderType
}
var indexedFavs map[mapKey]int
if len(tlfIDs) > 0 {
indexedFavs = make(map[mapKey]int, len(favs.FavoriteFolders))
for i, fav := range favs.FavoriteFolders {
indexedFavs[mapKey{fav.Name, fav.FolderType}] = i
}
}
// Add the sync config mode to each favorite.
for _, id := range tlfIDs {
config, err := fs.GetSyncConfig(ctx, id)
if err != nil {
return keybase1.FavoritesResult{}, err
}
if config.Mode == keybase1.FolderSyncMode_DISABLED {
panic(fmt.Sprintf(
"Folder %s has sync unexpectedly disabled", id))
}
fb := data.FolderBranch{Tlf: id, Branch: data.MasterBranch}
_, h, err := fs.GetRootNodeMetadata(ctx, fb)
if err != nil {
return keybase1.FavoritesResult{}, err
}
name := string(h.GetCanonicalName())
i, ok := indexedFavs[mapKey{name, id.Type().FolderType()}]
if ok {
favs.FavoriteFolders[i].SyncConfig = &config
}
}
for i, fav := range favs.FavoriteFolders {
if fav.SyncConfig != nil {
continue
}
favs.FavoriteFolders[i].SyncConfig = &keybase1.FolderSyncConfig{
Mode: keybase1.FolderSyncMode_DISABLED,
}
}
// Add the conflict status for any folders in a conflict state to
// the favorite struct.
journalManager, err := GetJournalManager(fs.config)
if err != nil {
// Journaling not enabled.
return favs, nil
}
conflicts, cleared, err := journalManager.GetJournalsInConflict(ctx)
if err != nil {
return keybase1.FavoritesResult{}, err
}
if len(conflicts) == 0 && len(cleared) == 0 {
return favs, nil
}
clearedMap := make(map[string][]keybase1.Path)
for _, c := range cleared {
cs := keybase1.NewConflictStateWithManualresolvinglocalview(
keybase1.FolderConflictManualResolvingLocalView{
NormalView: c.ServerViewPath,
})
favs.FavoriteFolders = append(favs.FavoriteFolders,
keybase1.Folder{
Name: string(c.Name),
FolderType: c.Type.FolderType(),
Private: c.Type != tlf.Public,
ResetMembers: []keybase1.User{},
ConflictState: &cs,
})
clearedMap[c.ServerViewPath.String()] = append(
clearedMap[c.ServerViewPath.String()], c.LocalViewPath)
}
conflictMap := make(map[ConflictJournalRecord]tlf.ID, len(conflicts))
for _, c := range conflicts {
conflictMap[ConflictJournalRecord{Name: c.Name, Type: c.Type}] = c.ID
}
found := 0
for i, f := range favs.FavoriteFolders {
name := tlf.CanonicalName(f.Name)
t := tlf.TypeFromFolderType(f.FolderType)
c := ConflictJournalRecord{
Name: name,
Type: t,
}
folderNormalView := keybase1.FolderNormalView{}
currentFavFound := false
// First check for any current automatically-resolving
// conflicts, and whether we're stuck.
tlfID, ok := conflictMap[c]
if ok {
fb := data.FolderBranch{Tlf: tlfID, Branch: data.MasterBranch}
ops := fs.getOps(ctx, fb, FavoritesOpNoChange)
s, err := ops.FolderConflictStatus(ctx)
if err != nil {
return keybase1.FavoritesResult{}, err
}
if s != keybase1.FolderConflictType_NONE {
folderNormalView.ResolvingConflict = true
folderNormalView.StuckInConflict =
s == keybase1.FolderConflictType_IN_CONFLICT_AND_STUCK
currentFavFound = true
}
}
// Then check whether this favorite has any local conflict views.
p := tlfhandle.BuildProtocolPathForTlfName(t, name)
localViews, ok := clearedMap[p.String()]
if ok {
folderNormalView.LocalViews = localViews
currentFavFound = true
}
if currentFavFound {
conflictState :=
keybase1.NewConflictStateWithNormalview(folderNormalView)
favs.FavoriteFolders[i].ConflictState = &conflictState
found++
}
if found == len(conflictMap)+len(clearedMap) {
// Short-circuit the loop if we've already found all the conflicts.
break
}
}
return favs, nil
}
// RefreshCachedFavorites implements the KBFSOps interface for
// KBFSOpsStandard.
func (fs *KBFSOpsStandard) RefreshCachedFavorites(ctx context.Context,
mode FavoritesRefreshMode) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
fs.favs.RefreshCache(ctx, mode)
}
// ClearCachedFavorites implements the KBFSOps interface for
// KBFSOpsStandard.
func (fs *KBFSOpsStandard) ClearCachedFavorites(ctx context.Context) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
fs.favs.ClearCache(ctx)
}
// AddFavorite implements the KBFSOps interface for KBFSOpsStandard.
func (fs *KBFSOpsStandard) AddFavorite(ctx context.Context,
fav favorites.Folder, data favorites.Data) error {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
kbpki := fs.config.KBPKI()
_, err := kbpki.GetCurrentSession(ctx)
isLoggedIn := err == nil
if isLoggedIn {
err := fs.favs.Add(ctx, favorites.ToAdd{
Folder: fav,
Data: data,
Created: false,
})
if err != nil {
return err
}
}
return nil
}
// SetFavoritesHomeTLFInfo implements the KBFSOps interface for KBFSOpsStandard.
func (fs *KBFSOpsStandard) SetFavoritesHomeTLFInfo(ctx context.Context,
info homeTLFInfo) {
fs.favs.setHomeTLFInfo(ctx, info)
}
func (fs *KBFSOpsStandard) getOpsByFav(fav favorites.Folder) *folderBranchOps {
fs.opsLock.Lock()
defer fs.opsLock.Unlock()
return fs.opsByFav[fav]
}
// RefreshEditHistory implements the KBFSOps interface for KBFSOpsStandard
func (fs *KBFSOpsStandard) RefreshEditHistory(fav favorites.Folder) {
fbo := fs.getOpsByFav(fav)
if fbo != nil {
fbo.refreshEditHistory()
}
}
// DeleteFavorite implements the KBFSOps interface for
// KBFSOpsStandard.
func (fs *KBFSOpsStandard) DeleteFavorite(ctx context.Context,
fav favorites.Folder) error {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
kbpki := fs.config.KBPKI()
_, err := kbpki.GetCurrentSession(ctx)
isLoggedIn := err == nil
// Let this ops remove itself, if we have one available.
ops := fs.getOpsByFav(fav)
if ops != nil {
err := ops.doFavoritesOp(ctx, FavoritesOpRemove, nil)
if _, ok := err.(OpsCantHandleFavorite); !ok {
return err
}
// If the ops couldn't handle the delete, fall through to
// going directly via Favorites.
}
if isLoggedIn {
err := fs.favs.Delete(ctx, fav)
if err != nil {
return err
}
}
// TODO: Shut down the running folderBranchOps, if one exists?
// What about open file handles?
return nil
}
func (fs *KBFSOpsStandard) getOpsNoAdd(
ctx context.Context, fb data.FolderBranch) *folderBranchOps {
if fb == (data.FolderBranch{}) {
panic("zero FolderBranch in getOps")
}
fs.opsLock.RLock()
if ops, ok := fs.ops[fb]; ok {
fs.opsLock.RUnlock()
return ops
}
fs.opsLock.RUnlock()
fs.opsLock.Lock()
defer fs.opsLock.Unlock()
// look it up again in case someone else got the lock
ops, ok := fs.ops[fb]
if !ok {
bType := standard
if fb.Branch.IsArchived() {
bType = archive
} else if fb.Branch.IsLocalConflict() {
bType = conflict
}
var quotaUsage *EventuallyConsistentQuotaUsage
if fb.Tlf.Type() != tlf.SingleTeam {
// If this is a non-team TLF, pass in a shared quota usage
// object, since the status of each non-team TLF will show
// the same quota usage. TODO: for team TLFs, we should
// also pass in a shared instance (see
// `ConfigLocal.quotaUsage`).
quotaUsage = fs.quotaUsage
}
ops = newFolderBranchOps(
ctx, fs.appStateUpdater, fs.config, fb, bType, quotaUsage,
fs.currentStatus, fs.favs)
fs.ops[fb] = ops
}
return ops
}
func (fs *KBFSOpsStandard) getOpsIfExists(
ctx context.Context, fb data.FolderBranch) *folderBranchOps {
if fb == (data.FolderBranch{}) {
panic("zero FolderBranch in getOps")
}
fs.opsLock.RLock()
defer fs.opsLock.RUnlock()
return fs.ops[fb]
}
func (fs *KBFSOpsStandard) getOps(ctx context.Context,
fb data.FolderBranch, fop FavoritesOp) *folderBranchOps {
ops := fs.getOpsNoAdd(ctx, fb)
if err := ops.doFavoritesOp(ctx, fop, nil); err != nil {
// Failure to favorite shouldn't cause a failure. Just log
// and move on.
fs.log.CDebugf(ctx, "Couldn't add favorite: %v", err)
}
return ops
}
func (fs *KBFSOpsStandard) getOpsByNode(ctx context.Context,
node Node) *folderBranchOps {
return fs.getOps(ctx, node.GetFolderBranch(), FavoritesOpAdd)
}
func (fs *KBFSOpsStandard) getOpsByHandle(ctx context.Context,
handle *tlfhandle.Handle, fb data.FolderBranch, fop FavoritesOp) *folderBranchOps {
ops := fs.getOpsNoAdd(ctx, fb)
if err := ops.doFavoritesOp(ctx, fop, handle); err != nil {
// Failure to favorite shouldn't cause a failure. Just log
// and move on.
fs.log.CDebugf(ctx, "Couldn't add favorite: %+v", err)
}
fs.opsLock.Lock()
defer fs.opsLock.Unlock()
fav := handle.ToFavorite()
_, ok := fs.opsByFav[fav]
if ok {
// Already added.
return ops
}
// Track under its name, so we can later tell it to remove itself
// from the favorites list.
fs.opsByFav[fav] = ops
err := ops.RegisterForChanges(&kbfsOpsFavoriteObserver{
kbfsOps: fs,
currFav: fav,
})
if err != nil {
fs.log.CDebugf(ctx, "Couldn't register for changes: %+v", err)
}
return ops
}
func (fs *KBFSOpsStandard) resetTlfID(
ctx context.Context, h *tlfhandle.Handle, newTlfID *tlf.ID) error {
if !h.IsBackedByTeam() {
return errors.WithStack(NonExistentTeamForHandleError{h})
}
teamID, err := h.FirstResolvedWriter().AsTeam()
if err != nil {
return err
}
var tlfID tlf.ID
if newTlfID != nil {
tlfID = *newTlfID
fs.log.CDebugf(ctx, "Resetting to TLF ID %s for TLF %s, %s",
tlfID, teamID, h.GetCanonicalName())
} else {
matches, epoch, err := h.TlfID().GetEpochFromTeamTLF(teamID)
if err != nil {
return err
}
if matches {
epoch++
} else {
epoch = 0
}
// When creating a new TLF for an implicit team, always start with
// epoch 0. A different path will handle TLF resets with an
// increased epoch, if necessary.
tlfID, err = tlf.MakeIDFromTeam(h.Type(), teamID, epoch)
if err != nil {
return err
}
fs.log.CDebugf(ctx, "Creating new TLF ID %s for TLF %s, %s",
tlfID, teamID, h.GetCanonicalName())
}
err = fs.config.KBPKI().CreateTeamTLF(ctx, teamID, tlfID)
if err != nil {
return err
}
h.SetTlfID(tlfID)
return fs.config.MDCache().PutIDForHandle(h, tlfID)
}
// createAndStoreTlfIDIfNeeded creates a TLF ID for a team-backed
// handle that doesn't have one yet, and associates it in the service
// with the team. If it returns a `nil` error, it may have modified
// `h` to include the new TLF ID.
func (fs *KBFSOpsStandard) createAndStoreTlfIDIfNeeded(
ctx context.Context, h *tlfhandle.Handle) error {
if h.TlfID() != tlf.NullID {
return nil
}
return fs.resetTlfID(ctx, h, nil)
}
func (fs *KBFSOpsStandard) transformReadError(
ctx context.Context, h *tlfhandle.Handle, err error) error {
if errors.Cause(err) != context.DeadlineExceeded {
return err
}
if _, ok := errors.Cause(err).(OfflineUnsyncedError); ok {
return err
}
if fs.config.IsSyncedTlf(h.TlfID()) {
fs.log.CWarningf(ctx, "Got a read timeout on a synced TLF: %+v", err)
return err
}
// For unsynced TLFs, return a specific error to let the system
// know to show a sync recommendation.
return errors.WithStack(OfflineUnsyncedError{h})
}
func (fs *KBFSOpsStandard) getOrInitializeNewMDMaster(ctx context.Context,
mdops MDOps, h *tlfhandle.Handle, fb data.FolderBranch, create bool, fop FavoritesOp) (
initialized bool, md ImmutableRootMetadata, id tlf.ID, err error) {
defer func() {
err = fs.transformReadError(ctx, h, err)
if tlfhandle.GetExtendedIdentify(ctx).Behavior.AlwaysRunIdentify() &&
!initialized && err == nil {
kbpki := fs.config.KBPKI()
// We are not running identify for existing TLFs in
// KBFS. This makes sure if requested, identify runs even
// for existing TLFs.
err = tlfhandle.IdentifyHandle(ctx, kbpki, kbpki, fs.config, h)
}
}()
err = fs.createAndStoreTlfIDIfNeeded(ctx, h)
if err != nil {
return false, ImmutableRootMetadata{}, tlf.NullID, err
}
if rev, isRevBranch := fb.Branch.RevisionIfSpecified(); isRevBranch {
fs.log.CDebugf(ctx, "Getting archived revision %d for branch %s",
rev, fb.Branch)
// Make sure that rev hasn't been garbage-collected yet.
rmd, err := fs.getMDByHandle(ctx, h, FavoritesOpNoChange)
if err != nil {
return false, ImmutableRootMetadata{}, tlf.NullID, err
}
if rmd != (ImmutableRootMetadata{}) && rmd.IsReadable() {
// `rev` is still readable even if it matches
// `rmd.data.LastGCRevision`, since the GC process just
// removes the unref'd blocks in that revision; the actual
// data represented by the revision is still readable.
if rev < rmd.data.LastGCRevision {
return false, ImmutableRootMetadata{}, tlf.NullID,
RevGarbageCollectedError{rev, rmd.data.LastGCRevision}
}
}
md, err = getSingleMD(
ctx, fs.config, h.TlfID(), kbfsmd.NullBranchID, rev,
kbfsmd.Merged, nil)
// This will error if there's no corresponding MD, which is
// what we want since that means the user input an incorrect
// MD revision.
if err != nil {
return false, ImmutableRootMetadata{}, tlf.NullID, err
}
return false, md, h.TlfID(), nil
}
md, err = mdops.GetForTLF(ctx, h.TlfID(), nil)
if err != nil {
return false, ImmutableRootMetadata{}, tlf.NullID, err
}
if md != (ImmutableRootMetadata{}) {
return false, md, h.TlfID(), nil
}
if !create {
return false, ImmutableRootMetadata{}, h.TlfID(), nil
}
// Init new MD.
fops := fs.getOpsByHandle(ctx, h, fb, fop)
err = fops.SetInitialHeadToNew(ctx, h.TlfID(), h)
// Someone else initialized the TLF out from under us, so we
// didn't initialize it.
_, alreadyExisted := errors.Cause(err).(RekeyConflictError)
if err != nil && !alreadyExisted {
return false, ImmutableRootMetadata{}, tlf.NullID, err
}
md, err = mdops.GetForTLF(ctx, h.TlfID(), nil)
if err != nil {
return false, ImmutableRootMetadata{}, tlf.NullID, err
}
return !alreadyExisted, md, h.TlfID(), err
}
func (fs *KBFSOpsStandard) getMDByHandle(ctx context.Context,
tlfHandle *tlfhandle.Handle, fop FavoritesOp) (rmd ImmutableRootMetadata, err error) {
fbo := fs.getOpsByFav(tlfHandle.ToFavorite())
if fbo != nil {
lState := makeFBOLockState()
rmd, err = fbo.getMDForReadNeedIdentifyOnMaybeFirstAccess(ctx, lState)
if err != nil {
return ImmutableRootMetadata{}, err
}
}
if rmd != (ImmutableRootMetadata{}) {
return rmd, nil
}
err = fs.createAndStoreTlfIDIfNeeded(ctx, tlfHandle)
if err != nil {
return ImmutableRootMetadata{}, err
}
// Check for an unmerged MD first if necessary.
if fs.config.Mode().UnmergedTLFsEnabled() {
rmd, err = fs.config.MDOps().GetUnmergedForTLF(
ctx, tlfHandle.TlfID(), kbfsmd.NullBranchID)
if err != nil {
return ImmutableRootMetadata{}, err
}
}
fb := data.FolderBranch{Tlf: tlfHandle.TlfID(), Branch: data.MasterBranch}
if rmd == (ImmutableRootMetadata{}) {
if fop == FavoritesOpAdd {
_, rmd, _, err = fs.getOrInitializeNewMDMaster(
ctx, fs.config.MDOps(), tlfHandle, fb, true,
FavoritesOpAddNewlyCreated)
} else {
_, rmd, _, err = fs.getOrInitializeNewMDMaster(
ctx, fs.config.MDOps(), tlfHandle, fb, true, fop)
}
if err != nil {
return ImmutableRootMetadata{}, err
}
}
// Make sure fbo exists and head is set so that next time we use this we
// don't need to hit server even when there isn't any FS activity.
if fbo == nil {
fbo = fs.getOpsByHandle(ctx, tlfHandle, fb, fop)
}
if err = fbo.SetInitialHeadFromServer(ctx, rmd); err != nil {
return ImmutableRootMetadata{}, err
}
return rmd, nil
}
// GetTLFCryptKeys implements the KBFSOps interface for
// KBFSOpsStandard
func (fs *KBFSOpsStandard) GetTLFCryptKeys(
ctx context.Context, tlfHandle *tlfhandle.Handle) (
keys []kbfscrypto.TLFCryptKey, id tlf.ID, err error) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
fs.log.CDebugf(ctx, "GetTLFCryptKeys(%s)", tlfHandle.GetCanonicalPath())
defer func() { fs.deferLog.CDebugf(ctx, "Done: %+v", err) }()
rmd, err := fs.getMDByHandle(ctx, tlfHandle, FavoritesOpNoChange)
if err != nil {
return nil, tlf.ID{}, err
}
keys, err = fs.config.KeyManager().GetTLFCryptKeyOfAllGenerations(ctx, rmd)
return keys, rmd.TlfID(), err
}
// GetTLFID implements the KBFSOps interface for KBFSOpsStandard.
func (fs *KBFSOpsStandard) GetTLFID(ctx context.Context,
tlfHandle *tlfhandle.Handle) (id tlf.ID, err error) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
fs.log.CDebugf(ctx, "GetTLFID(%s)", tlfHandle.GetCanonicalPath())
defer func() { fs.deferLog.CDebugf(ctx, "Done: %+v", err) }()
rmd, err := fs.getMDByHandle(ctx, tlfHandle, FavoritesOpNoChange)
if err != nil {
return tlf.ID{}, err
}
return rmd.TlfID(), err
}
// GetTLFHandle implements the KBFSOps interface for KBFSOpsStandard.
func (fs *KBFSOpsStandard) GetTLFHandle(ctx context.Context, node Node) (
*tlfhandle.Handle, error) {
timeTrackerDone := fs.longOperationDebugDumper.Begin(ctx)
defer timeTrackerDone()
ops := fs.getOpsByNode(ctx, node)
return ops.GetTLFHandle(ctx, node)
}
// getMaybeCreateRootNode is called for GetOrCreateRootNode and GetRootNode.
func (fs *KBFSOpsStandard) getMaybeCreateRootNode(
ctx context.Context, h *tlfhandle.Handle, branch data.BranchName, create bool) (
node Node, ei data.EntryInfo, err error) {
fs.log.CDebugf(ctx, "getMaybeCreateRootNode(%s, %v, %v)",
h.GetCanonicalPath(), branch, create)
defer func() {
err = fs.transformReadError(ctx, h, err)
fs.deferLog.CDebugf(ctx, "Done: %+v", err)
}()
if branch != data.MasterBranch && create {
return nil, data.EntryInfo{}, errors.Errorf(
"Can't create a root node for branch %s", branch)
}
err = fs.createAndStoreTlfIDIfNeeded(ctx, h)
if err != nil {
return nil, data.EntryInfo{}, err
}
// Check if we already have the MD cached, before contacting any
// servers.