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
|
package fs
import (
"errors"
"fmt"
"os"
"path/filepath"
"strings"
"sync"
"time"
"github.com/hanwen/go-fuse/v2/fuse"
"github.com/jstaf/onedriver/fs/graph"
"github.com/rs/zerolog/log"
bolt "go.etcd.io/bbolt"
)
// Filesystem is the actual FUSE filesystem and uses the go analogy of the
// "low-level" FUSE API here:
// https://github.com/libfuse/libfuse/blob/master/include/fuse_lowlevel.h
type Filesystem struct {
fuse.RawFileSystem
metadata sync.Map
db *bolt.DB
content *LoopbackCache
auth *graph.Auth
root string // the id of the filesystem's root item
deltaLink string
uploads *UploadManager
sync.RWMutex
offline bool
lastNodeID uint64
inodes []string
// tracks currently open directories
opendirsM sync.RWMutex
opendirs map[uint64][]*Inode
}
// boltdb buckets
var (
bucketContent = []byte("content")
bucketMetadata = []byte("metadata")
bucketDelta = []byte("delta")
bucketVersion = []byte("version")
)
// so we can tell what format the db has
const fsVersion = "1"
// NewFilesystem creates a new filesystem
func NewFilesystem(auth *graph.Auth, cacheDir string) *Filesystem {
// prepare cache directory
if _, err := os.Stat(cacheDir); err != nil {
if err = os.Mkdir(cacheDir, 0700); err != nil {
log.Fatal().Err(err).Msg("Could not create cache directory.")
}
}
db, err := bolt.Open(
filepath.Join(cacheDir, "onedriver.db"),
0600,
&bolt.Options{Timeout: time.Second * 5},
)
if err != nil {
log.Fatal().Err(err).Msg("Could not open DB. Is it already in use by another mount?")
}
content := NewLoopbackCache(filepath.Join(cacheDir, "content"))
db.Update(func(tx *bolt.Tx) error {
tx.CreateBucketIfNotExists(bucketMetadata)
tx.CreateBucketIfNotExists(bucketDelta)
versionBucket, _ := tx.CreateBucketIfNotExists(bucketVersion)
// migrate old content bucket to the local filesystem
b := tx.Bucket(bucketContent)
if b != nil {
oldVersion := "0"
log.Info().
Str("oldVersion", oldVersion).
Str("version", fsVersion).
Msg("Migrating to new db format.")
err := b.ForEach(func(k []byte, v []byte) error {
log.Info().Bytes("key", k).Msg("Migrating file content.")
if err := content.Insert(string(k), v); err != nil {
return err
}
return b.Delete(k)
})
if err != nil {
log.Error().Err(err).Msg("Migration failed.")
}
tx.DeleteBucket(bucketContent)
log.Info().
Str("oldVersion", oldVersion).
Str("version", fsVersion).
Msg("Migrations complete.")
}
return versionBucket.Put([]byte("version"), []byte(fsVersion))
})
// ok, ready to start fs
fs := &Filesystem{
RawFileSystem: fuse.NewDefaultRawFileSystem(),
content: content,
db: db,
auth: auth,
opendirs: make(map[uint64][]*Inode),
}
rootItem, err := graph.GetItem("root", auth)
root := NewInodeDriveItem(rootItem)
if err != nil {
if graph.IsOffline(err) {
// no network, load from db if possible and go to read-only state
fs.Lock()
fs.offline = true
fs.Unlock()
if root = fs.GetID("root"); root == nil {
log.Fatal().Msg(
"We are offline and could not fetch the filesystem root item from disk.",
)
}
// when offline, we load the cache deltaLink from disk
fs.db.View(func(tx *bolt.Tx) error {
if link := tx.Bucket(bucketDelta).Get([]byte("deltaLink")); link != nil {
fs.deltaLink = string(link)
} else {
// Only reached if a previous online session never survived
// long enough to save its delta link. We explicitly disallow these
// types of startups as it's possible for things to get out of sync
// this way.
log.Fatal().Msg("Cannot perform an offline startup without a valid " +
"delta link from a previous session.")
}
return nil
})
} else {
log.Fatal().Err(err).Msg("Could not fetch root item of filesystem!")
}
}
// root inode is inode 1
fs.root = root.ID()
fs.InsertID(fs.root, root)
fs.uploads = NewUploadManager(2*time.Second, db, fs, auth)
if !fs.IsOffline() {
// .Trash-UID is used by "gio trash" for user trash, create it if it
// does not exist
trash := fmt.Sprintf(".Trash-%d", os.Getuid())
if child, _ := fs.GetChild(fs.root, trash, auth); child == nil {
item, err := graph.Mkdir(trash, fs.root, auth)
if err != nil {
log.Error().Err(err).
Msg("Could not create trash folder. " +
"Trashing items through the file browser may result in errors.")
} else {
fs.InsertID(item.ID, NewInodeDriveItem(item))
}
}
// using token=latest because we don't care about existing items - they'll
// be downloaded on-demand by the cache
fs.deltaLink = "/me/drive/root/delta?token=latest"
}
// deltaloop is started manually
return fs
}
// IsOffline returns whether or not the cache thinks its offline.
func (f *Filesystem) IsOffline() bool {
f.RLock()
defer f.RUnlock()
return f.offline
}
// TranslateID returns the DriveItemID for a given NodeID
func (f *Filesystem) TranslateID(nodeID uint64) string {
f.RLock()
defer f.RUnlock()
if nodeID > f.lastNodeID || nodeID == 0 {
return ""
}
return f.inodes[nodeID-1]
}
// GetNodeID fetches the inode for a particular inode ID.
func (f *Filesystem) GetNodeID(nodeID uint64) *Inode {
id := f.TranslateID(nodeID)
if id == "" {
return nil
}
return f.GetID(id)
}
// InsertNodeID assigns a numeric inode ID used by the kernel if one is not
// already assigned.
func (f *Filesystem) InsertNodeID(inode *Inode) uint64 {
nodeID := inode.NodeID()
if nodeID == 0 {
// lock ordering is to satisfy deadlock detector
inode.Lock()
f.Lock()
f.lastNodeID++
f.inodes = append(f.inodes, inode.DriveItem.ID)
nodeID = f.lastNodeID
inode.nodeID = nodeID
f.Unlock()
inode.Unlock()
}
return nodeID
}
// GetID gets an inode from the cache by ID. No API fetching is performed.
// Result is nil if no inode is found.
func (f *Filesystem) GetID(id string) *Inode {
entry, exists := f.metadata.Load(id)
if !exists {
// we allow fetching from disk as a fallback while offline (and it's also
// necessary while transitioning from offline->online)
var found *Inode
f.db.View(func(tx *bolt.Tx) error {
data := tx.Bucket(bucketMetadata).Get([]byte(id))
var err error
if data != nil {
found, err = NewInodeJSON(data)
}
return err
})
if found != nil {
f.InsertNodeID(found)
f.metadata.Store(id, found) // move to memory for next time
}
return found
}
return entry.(*Inode)
}
// InsertID inserts a single item into the filesystem by ID and sets its parent
// using the Inode.Parent.ID, if set. Must be called after DeleteID, if being
// used to rename/move an item. This is the main way new Inodes are added to the
// filesystem. Returns the Inode's numeric NodeID.
func (f *Filesystem) InsertID(id string, inode *Inode) uint64 {
f.metadata.Store(id, inode)
nodeID := f.InsertNodeID(inode)
if id != inode.ID() {
// we update the inode IDs here in case they do not match/changed
inode.Lock()
inode.DriveItem.ID = id
inode.Unlock()
f.Lock()
if nodeID <= f.lastNodeID {
f.inodes[nodeID-1] = id
} else {
log.Error().
Uint64("nodeID", nodeID).
Uint64("lastNodeID", f.lastNodeID).
Msg("NodeID exceeded maximum node ID! Ignoring ID change.")
}
f.Unlock()
}
parentID := inode.ParentID()
if parentID == "" {
// root item, or parent not set
return nodeID
}
parent := f.GetID(parentID)
if parent == nil {
log.Error().
Str("parentID", parentID).
Str("childID", id).
Str("childName", inode.Name()).
Msg("Parent item could not be found when setting parent.")
return nodeID
}
// check if the item has already been added to the parent
// Lock order is super key here, must go parent->child or the deadlock
// detector screams at us.
parent.Lock()
defer parent.Unlock()
for _, child := range parent.children {
if child == id {
// exit early, child cannot be added twice
return nodeID
}
}
// add to parent
if inode.IsDir() {
parent.subdir++
}
parent.children = append(parent.children, id)
return nodeID
}
// InsertChild adds an item as a child of a specified parent ID.
func (f *Filesystem) InsertChild(parentID string, child *Inode) uint64 {
child.Lock()
// should already be set, just double-checking here.
child.DriveItem.Parent.ID = parentID
id := child.DriveItem.ID
child.Unlock()
return f.InsertID(id, child)
}
// DeleteID deletes an item from the cache, and removes it from its parent. Must
// be called before InsertID if being used to rename/move an item.
func (f *Filesystem) DeleteID(id string) {
if inode := f.GetID(id); inode != nil {
parent := f.GetID(inode.ParentID())
parent.Lock()
for i, childID := range parent.children {
if childID == id {
parent.children = append(parent.children[:i], parent.children[i+1:]...)
if inode.IsDir() {
parent.subdir--
}
break
}
}
parent.Unlock()
}
f.metadata.Delete(id)
f.uploads.CancelUpload(id)
}
// GetChild fetches a named child of an item. Wraps GetChildrenID.
func (f *Filesystem) GetChild(id string, name string, auth *graph.Auth) (*Inode, error) {
children, err := f.GetChildrenID(id, auth)
if err != nil {
return nil, err
}
for _, child := range children {
if strings.EqualFold(child.Name(), name) {
return child, nil
}
}
return nil, errors.New("child does not exist")
}
// GetChildrenID grabs all DriveItems that are the children of the given ID. If
// items are not found, they are fetched.
func (f *Filesystem) GetChildrenID(id string, auth *graph.Auth) (map[string]*Inode, error) {
// fetch item and catch common errors
inode := f.GetID(id)
children := make(map[string]*Inode)
if inode == nil {
log.Error().Str("id", id).Msg("Inode not found in cache")
return children, errors.New(id + " not found in cache")
} else if !inode.IsDir() {
// Normal files are treated as empty folders. This only gets called if
// we messed up and tried to get the children of a plain-old file.
log.Warn().
Str("id", id).
Str("path", inode.Path()).
Msg("Attepted to get children of ordinary file")
return children, nil
}
// If item.children is not nil, it means we have the item's children
// already and can fetch them directly from the cache
inode.RLock()
if inode.children != nil {
// can potentially have out-of-date child metadata if started offline, but since
// changes are disallowed while offline, the children will be back in sync after
// the first successful delta fetch (which also brings the fs back online)
for _, childID := range inode.children {
child := f.GetID(childID)
if child == nil {
// will be nil if deleted or never existed
continue
}
children[strings.ToLower(child.Name())] = child
}
inode.RUnlock()
return children, nil
}
inode.RUnlock()
// We haven't fetched the children for this item yet, get them from the server.
fetched, err := graph.GetItemChildren(id, auth)
if err != nil {
if graph.IsOffline(err) {
log.Warn().Str("id", id).
Msg("We are offline, and no children found in cache. " +
"Pretending there are no children.")
return children, nil
}
// something else happened besides being offline
return nil, err
}
inode.Lock()
inode.children = make([]string, 0)
for _, item := range fetched {
// we will always have an id after fetching from the server
child := NewInodeDriveItem(item)
f.InsertNodeID(child)
f.metadata.Store(child.DriveItem.ID, child)
// store in result map
children[strings.ToLower(child.Name())] = child
// store id in parent item and increment parents subdirectory count
inode.children = append(inode.children, child.DriveItem.ID)
if child.IsDir() {
inode.subdir++
}
}
inode.Unlock()
return children, nil
}
// GetChildrenPath grabs all DriveItems that are the children of the resource at
// the path. If items are not found, they are fetched.
func (f *Filesystem) GetChildrenPath(path string, auth *graph.Auth) (map[string]*Inode, error) {
inode, err := f.GetPath(path, auth)
if err != nil {
return make(map[string]*Inode), err
}
return f.GetChildrenID(inode.ID(), auth)
}
// GetPath fetches a given DriveItem in the cache, if any items along the way are
// not found, they are fetched.
func (f *Filesystem) GetPath(path string, auth *graph.Auth) (*Inode, error) {
lastID := f.root
if path == "/" {
return f.GetID(lastID), nil
}
// from the root directory, traverse the chain of items till we reach our
// target ID.
path = strings.TrimSuffix(strings.ToLower(path), "/")
split := strings.Split(path, "/")[1:] //omit leading "/"
var inode *Inode
for i := 0; i < len(split); i++ {
// fetches children
children, err := f.GetChildrenID(lastID, auth)
if err != nil {
return nil, err
}
var exists bool // if we use ":=", item is shadowed
inode, exists = children[split[i]]
if !exists {
// the item still doesn't exist after fetching from server. it
// doesn't exist
return nil, errors.New(strings.Join(split[:i+1], "/") +
" does not exist on server or in local cache")
}
lastID = inode.ID()
}
return inode, nil
}
// DeletePath an item from the cache by path. Must be called before Insert if
// being used to move/rename an item.
func (f *Filesystem) DeletePath(key string) {
inode, _ := f.GetPath(strings.ToLower(key), nil)
if inode != nil {
f.DeleteID(inode.ID())
}
}
// InsertPath lets us manually insert an item to the cache (like if it was
// created locally). Overwrites a cached item if present. Must be called after
// delete if being used to move/rename an item.
func (f *Filesystem) InsertPath(key string, auth *graph.Auth, inode *Inode) (uint64, error) {
key = strings.ToLower(key)
// set the item.Parent.ID properly if the item hasn't been in the cache
// before or is being moved.
parent, err := f.GetPath(filepath.Dir(key), auth)
if err != nil {
return 0, err
} else if parent == nil {
const errMsg string = "parent of key was nil"
log.Error().
Str("key", key).
Str("path", inode.Path()).
Msg(errMsg)
return 0, errors.New(errMsg)
}
// Coded this way to make sure locks are in the same order for the deadlock
// detector (lock ordering needs to be the same as InsertID: Parent->Child).
parentID := parent.ID()
inode.Lock()
inode.DriveItem.Parent.ID = parentID
id := inode.DriveItem.ID
inode.Unlock()
return f.InsertID(id, inode), nil
}
// MoveID moves an item to a new ID name. Also responsible for handling the
// actual overwrite of the item's IDInternal field
func (f *Filesystem) MoveID(oldID string, newID string) error {
inode := f.GetID(oldID)
if inode == nil {
// It may have already been renamed. This is not an error. We assume
// that IDs will never collide. Re-perform the op if this is the case.
if inode = f.GetID(newID); inode == nil {
// nope, it just doesn't exist
return errors.New("Could not get item: " + oldID)
}
}
// need to rename the child under the parent
parent := f.GetID(inode.ParentID())
parent.Lock()
for i, child := range parent.children {
if child == oldID {
parent.children[i] = newID
break
}
}
parent.Unlock()
// now actually perform the metadata+content move
f.DeleteID(oldID)
f.InsertID(newID, inode)
if inode.IsDir() {
return nil
}
f.content.Move(oldID, newID)
return nil
}
// MovePath moves an item to a new position.
func (f *Filesystem) MovePath(oldParent, newParent, oldName, newName string, auth *graph.Auth) error {
inode, err := f.GetChild(oldParent, oldName, auth)
if err != nil {
return err
}
id := inode.ID()
f.DeleteID(id)
// this is the actual move op
inode.SetName(newName)
parent := f.GetID(newParent)
inode.Parent.ID = parent.DriveItem.ID
f.InsertID(id, inode)
return nil
}
// SerializeAll dumps all inode metadata currently in the cache to disk. This
// metadata is only used later if an item could not be found in memory AND the
// cache is offline. Old metadata is not removed, only overwritten (to avoid an
// offline session from wiping all metadata on a subsequent serialization).
func (f *Filesystem) SerializeAll() {
log.Debug().Msg("Serializing cache metadata to disk.")
allItems := make(map[string][]byte)
f.metadata.Range(func(k interface{}, v interface{}) bool {
// cannot occur within bolt transaction because acquiring the inode lock
// with AsJSON locks out other boltdb transactions
id := fmt.Sprint(k)
allItems[id] = v.(*Inode).AsJSON()
return true
})
/*
One transaction to serialize them all,
One transaction to find them,
One transaction to bring them all
and in the darkness write them.
*/
f.db.Batch(func(tx *bolt.Tx) error {
b := tx.Bucket(bucketMetadata)
for k, v := range allItems {
b.Put([]byte(k), v)
if k == f.root {
// root item must be updated manually (since there's actually
// two copies)
b.Put([]byte("root"), v)
}
}
return nil
})
}
|