-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
tlf.go
290 lines (251 loc) · 7.69 KB
/
tlf.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
// 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 libdokan
import (
"sync"
"time"
"github.com/keybase/client/go/kbfs/data"
"github.com/keybase/client/go/kbfs/dokan"
"github.com/keybase/client/go/kbfs/libfs"
"github.com/keybase/client/go/kbfs/libkbfs"
"github.com/keybase/client/go/kbfs/tlf"
"github.com/keybase/client/go/kbfs/tlfhandle"
"github.com/keybase/client/go/libkb"
"golang.org/x/net/context"
)
// TLF represents the root directory of a TLF. It wraps a lazy-loaded
// Dir.
type TLF struct {
refcount refcount
folder *Folder
dirLock sync.RWMutex
dir *Dir
emptyFile
}
func newTLF(fl *FolderList, h *tlfhandle.Handle,
name tlf.PreferredName) *TLF {
folder := newFolder(fl, h, name)
tlf := &TLF{
folder: folder,
}
tlf.refcount.Increase()
return tlf
}
func (tlf *TLF) getStoredDir() *Dir {
tlf.dirLock.RLock()
defer tlf.dirLock.RUnlock()
return tlf.dir
}
func (tlf *TLF) loadDirHelper(ctx context.Context, info string,
mode libkbfs.ErrorModeType, branch data.BranchName, filterErr bool) (
dir *Dir, exitEarly bool, err error) {
dir = tlf.getStoredDir()
if dir != nil {
return dir, false, nil
}
tlf.dirLock.Lock()
defer tlf.dirLock.Unlock()
// Need to check for nilness again to avoid racing with other
// calls to loadDir().
if tlf.dir != nil {
return tlf.dir, false, nil
}
name := tlf.folder.name()
tlf.folder.fs.log.CDebugf(ctx, "Loading root directory for folder %s "+
"(type: %s, filter error: %t) for %s",
name, tlf.folder.list.tlfType, filterErr, info)
defer func() {
if filterErr {
exitEarly, err = libfs.FilterTLFEarlyExitError(ctx, err, tlf.folder.fs.log, name)
}
tlf.folder.reportErr(ctx, mode, err)
}()
handle, err := tlf.folder.resolve(ctx)
if err != nil {
return nil, false, err
}
if branch == data.MasterBranch {
conflictBranch, isLocalConflictBranch :=
data.MakeConflictBranchName(handle)
if isLocalConflictBranch {
branch = conflictBranch
}
}
var rootNode libkbfs.Node
if filterErr {
rootNode, _, err = tlf.folder.fs.config.KBFSOps().GetRootNode(
ctx, handle, branch)
if err != nil {
return nil, false, err
}
// If not fake an empty directory.
if rootNode == nil {
return nil, false, libfs.TlfDoesNotExist{}
}
} else {
rootNode, _, err = tlf.folder.fs.config.KBFSOps().GetOrCreateRootNode(
ctx, handle, branch)
if err != nil {
return nil, false, err
}
}
err = tlf.folder.setFolderBranch(rootNode.GetFolderBranch())
if err != nil {
return nil, false, err
}
tlf.folder.nodes[rootNode.GetID()] = tlf
tlf.dir = newDir(tlf.folder, rootNode, string(name), nil)
// TLFs should be cached.
tlf.dir.refcount.Increase()
tlf.folder.lockedAddNode(rootNode, tlf.dir)
return tlf.dir, false, nil
}
func (tlf *TLF) loadDir(ctx context.Context, info string) (*Dir, error) {
dir, _, err := tlf.loadDirHelper(
ctx, info, libkbfs.WriteMode, data.MasterBranch, false)
return dir, err
}
// loadDirAllowNonexistent loads a TLF if it's not already loaded. If
// the TLF doesn't yet exist, it still returns a nil error and
// indicates that the calling function should pretend it's an empty
// folder.
func (tlf *TLF) loadDirAllowNonexistent(ctx context.Context, info string) (
*Dir, bool, error) {
return tlf.loadDirHelper(
ctx, info, libkbfs.ReadMode, data.MasterBranch, true)
}
func (tlf *TLF) loadArchivedDir(
ctx context.Context, info string, branch data.BranchName) (
*Dir, bool, error) {
// Always filter errors for archive TLF directories, so that we
// don't try to initialize them.
return tlf.loadDirHelper(ctx, info, libkbfs.ReadMode, branch, true)
}
// SetFileTime sets mtime for FSOs (File and Dir).
func (tlf *TLF) SetFileTime(ctx context.Context, fi *dokan.FileInfo, creation time.Time, lastAccess time.Time, lastWrite time.Time) (err error) {
tlf.folder.fs.logEnter(ctx, "TLF SetFileTime")
dir, err := tlf.loadDir(ctx, "TLF SetFileTime")
if err != nil {
return err
}
return dir.SetFileTime(ctx, fi, creation, lastAccess, lastWrite)
}
// SetFileAttributes for Dokan.
func (tlf *TLF) SetFileAttributes(ctx context.Context, fi *dokan.FileInfo, fileAttributes dokan.FileAttribute) error {
tlf.folder.fs.logEnter(ctx, "TLF SetFileAttributes")
dir, err := tlf.loadDir(ctx, "TLF SetFileAttributes")
if err != nil {
return err
}
return dir.SetFileAttributes(ctx, fi, fileAttributes)
}
// GetFileInformation for dokan.
func (tlf *TLF) GetFileInformation(ctx context.Context, fi *dokan.FileInfo) (st *dokan.Stat, err error) {
dir := tlf.getStoredDir()
if dir == nil {
return defaultDirectoryInformation()
}
return dir.GetFileInformation(ctx, fi)
}
// open tries to open a file.
func (tlf *TLF) open(ctx context.Context, oc *openContext, path []string) (
dokan.File, dokan.CreateStatus, error) {
if len(path) == 0 {
if err := oc.ReturningDirAllowed(); err != nil {
return nil, 0, err
}
tlf.refcount.Increase()
return tlf, dokan.ExistingDir, nil
}
mode := libkbfs.ReadMode
if oc.isCreation() {
mode = libkbfs.WriteMode
}
// If it is a creation then we need the dir for real.
dir, exitEarly, err :=
tlf.loadDirHelper(
ctx, "open", mode, data.MasterBranch, !oc.isCreation())
if err != nil {
return nil, 0, err
}
if exitEarly {
specialNode := handleTLFSpecialFile(lastStr(path), tlf.folder)
if specialNode != nil {
return specialNode, dokan.ExistingFile, nil
}
return nil, 0, dokan.ErrObjectNameNotFound
}
branch, isArchivedBranch := libfs.BranchNameFromArchiveRefDir(path[0])
if isArchivedBranch {
archivedTLF := newTLF(
tlf.folder.list, tlf.folder.h, tlf.folder.hPreferredName)
_, _, err := archivedTLF.loadArchivedDir(ctx, "open", branch)
if err != nil {
return nil, 0, err
}
return archivedTLF.open(ctx, oc, path[1:])
}
linkTarget, isArchivedTimeLink, err := libfs.LinkTargetFromTimeString(
ctx, tlf.folder.fs.config, tlf.folder.h, path[0])
if err != nil {
return nil, 0, err
}
if isArchivedTimeLink {
if len(path) == 1 && oc.isOpenReparsePoint() {
// TODO handle dir/non-dir here, semantics?
return &Alias{canon: linkTarget}, dokan.ExistingDir, nil
}
path[0] = linkTarget
return tlf.open(ctx, oc, path)
}
_, isRelTimeLink, err := libfs.FileDataFromRelativeTimeString(
ctx, tlf.folder.fs.config, tlf.folder.h, path[0])
if err != nil {
return nil, 0, err
}
if isRelTimeLink {
return NewArchiveRelTimeFile(tlf.folder.fs, tlf.folder.h, path[0]),
dokan.ExistingFile, nil
}
return dir.open(ctx, oc, path)
}
// FindFiles does readdir for dokan.
func (tlf *TLF) FindFiles(ctx context.Context, fi *dokan.FileInfo, pattern string, callback func(*dokan.NamedStat) error) (err error) {
tlf.folder.fs.logEnter(ctx, "TLF FindFiles")
dir, exitEarly, err := tlf.loadDirAllowNonexistent(ctx, "FindFiles")
if err != nil {
return errToDokan(err)
}
if exitEarly {
return dokan.ErrObjectNameNotFound
}
return dir.FindFiles(ctx, fi, pattern, callback)
}
// CanDeleteDirectory - return just nil because tlfs
// can always be removed from favorites.
func (tlf *TLF) CanDeleteDirectory(ctx context.Context, fi *dokan.FileInfo) (err error) {
return nil
}
// Cleanup - forget references, perform deletions etc.
func (tlf *TLF) Cleanup(ctx context.Context, fi *dokan.FileInfo) {
var err error
if fi != nil && fi.IsDeleteOnClose() {
tlf.folder.handleMu.Lock()
fav := tlf.folder.h.ToFavorite()
tlf.folder.handleMu.Unlock()
tlf.folder.fs.vlog.CLogf(
ctx, libkb.VLog1, "TLF Removing favorite %q", fav.Name)
defer func() {
tlf.folder.reportErr(ctx, libkbfs.WriteMode, err)
}()
err = tlf.folder.fs.config.KBFSOps().DeleteFavorite(ctx, fav)
}
if tlf.refcount.Decrease() {
dir := tlf.getStoredDir()
if dir == nil {
return
}
dir.Cleanup(ctx, fi)
}
}