2016-07-18 06:03:23 +08:00
// Package mount implents a FUSE mounting system for rclone remotes.
// +build linux darwin freebsd
package mount
import (
2016-09-09 15:39:19 +08:00
"log"
"os"
2017-03-17 18:20:28 +08:00
"os/signal"
"syscall"
2016-10-18 21:44:16 +08:00
"time"
2016-09-09 15:39:19 +08:00
2016-07-18 06:03:23 +08:00
"bazil.org/fuse"
"github.com/ncw/rclone/cmd"
"github.com/ncw/rclone/fs"
"github.com/pkg/errors"
"github.com/spf13/cobra"
2016-09-09 15:39:19 +08:00
"golang.org/x/sys/unix"
2016-07-18 06:03:23 +08:00
)
// Globals
var (
2016-10-18 21:44:16 +08:00
noModTime = false
debugFUSE = false
noSeek = false
dirCacheTime = 5 * 60 * time . Second
2016-09-09 15:39:19 +08:00
// mount options
readOnly = false
allowNonEmpty = false
allowRoot = false
allowOther = false
defaultPermissions = false
writebackCache = false
maxReadAhead fs . SizeSuffix = 128 * 1024
umask = 0
uid = uint32 ( unix . Geteuid ( ) )
gid = uint32 ( unix . Getegid ( ) )
// foreground = false
// default permissions for directories - modified by umask in Mount
dirPerms = os . FileMode ( 0777 )
filePerms = os . FileMode ( 0666 )
2016-07-18 06:03:23 +08:00
)
func init ( ) {
2016-09-09 15:39:19 +08:00
umask = unix . Umask ( 0 ) // read the umask
unix . Umask ( umask ) // set it back to what it was
2016-10-22 19:05:45 +08:00
cmd . Root . AddCommand ( commandDefintion )
commandDefintion . Flags ( ) . BoolVarP ( & noModTime , "no-modtime" , "" , noModTime , "Don't read the modification time (can speed things up)." )
commandDefintion . Flags ( ) . BoolVarP ( & debugFUSE , "debug-fuse" , "" , debugFUSE , "Debug the FUSE internals - needs -v." )
commandDefintion . Flags ( ) . BoolVarP ( & noSeek , "no-seek" , "" , noSeek , "Don't allow seeking in files." )
commandDefintion . Flags ( ) . DurationVarP ( & dirCacheTime , "dir-cache-time" , "" , dirCacheTime , "Time to cache directory entries for." )
2016-09-09 15:39:19 +08:00
// mount options
2016-10-22 19:05:45 +08:00
commandDefintion . Flags ( ) . BoolVarP ( & readOnly , "read-only" , "" , readOnly , "Mount read-only." )
commandDefintion . Flags ( ) . BoolVarP ( & allowNonEmpty , "allow-non-empty" , "" , allowNonEmpty , "Allow mounting over a non-empty directory." )
commandDefintion . Flags ( ) . BoolVarP ( & allowRoot , "allow-root" , "" , allowRoot , "Allow access to root user." )
commandDefintion . Flags ( ) . BoolVarP ( & allowOther , "allow-other" , "" , allowOther , "Allow access to other users." )
commandDefintion . Flags ( ) . BoolVarP ( & defaultPermissions , "default-permissions" , "" , defaultPermissions , "Makes kernel enforce access control based on the file mode." )
commandDefintion . Flags ( ) . BoolVarP ( & writebackCache , "write-back-cache" , "" , writebackCache , "Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used." )
commandDefintion . Flags ( ) . VarP ( & maxReadAhead , "max-read-ahead" , "" , "The number of bytes that can be prefetched for sequential reads." )
commandDefintion . Flags ( ) . IntVarP ( & umask , "umask" , "" , umask , "Override the permission bits set by the filesystem." )
commandDefintion . Flags ( ) . Uint32VarP ( & uid , "uid" , "" , uid , "Override the uid field set by the filesystem." )
commandDefintion . Flags ( ) . Uint32VarP ( & gid , "gid" , "" , gid , "Override the gid field set by the filesystem." )
//commandDefintion.Flags().BoolVarP(&foreground, "foreground", "", foreground, "Do not detach.")
2016-07-18 06:03:23 +08:00
}
2016-10-22 19:05:45 +08:00
var commandDefintion = & cobra . Command {
2016-07-18 06:03:23 +08:00
Use : "mount remote:path /path/to/mountpoint" ,
Short : ` Mount the remote as a mountpoint. **EXPERIMENTAL** ` ,
Long : `
2016-08-22 23:46:08 +08:00
rclone mount allows Linux , FreeBSD and macOS to mount any of Rclone ' s
cloud storage systems as a file system with FUSE .
2016-07-18 06:03:23 +08:00
This is * * EXPERIMENTAL * * - use with care .
First set up your remote using ` + " ` rclone config ` " + ` . Check it works with ` + " ` rclone ls ` " + ` etc .
2017-03-17 18:20:28 +08:00
Start the mount like this
2016-07-18 06:03:23 +08:00
2017-03-17 18:20:28 +08:00
rclone mount remote : path / to / files / path / to / local / mount
2016-07-18 06:03:23 +08:00
2017-03-17 18:20:28 +08:00
When the program ends , either via Ctrl + C or receiving a SIGINT or SIGTERM signal ,
the mount is automatically stopped .
2016-07-18 06:03:23 +08:00
2017-03-17 18:20:28 +08:00
The umount operation can fail , for example when the mountpoint is busy .
When that happens , it is the user ' s responsibility to stop the mount manually with
2016-07-18 06:03:23 +08:00
2017-03-17 18:20:28 +08:00
# Linux
fusermount - u / path / to / local / mount
# OS X
2017-01-31 02:16:53 +08:00
umount / path / to / local / mount
2016-07-18 06:03:23 +08:00
# # # Limitations # # #
2016-09-11 05:25:26 +08:00
This can only write files seqentially , it can only seek when reading .
2017-01-06 19:24:22 +08:00
This means that many applications won ' t work with their files on an
rclone mount .
The bucket based remotes ( eg Swift , S3 , Google Compute Storage , B2 ,
Hubic ) won ' t work from the root - you will need to specify a bucket ,
or a path within the bucket . So ` + " ` swift : ` " + ` won ' t work whereas
` + " ` swift : bucket ` " + ` will as will ` + " ` swift : bucket / path ` " + ` .
None of these support the concept of directories , so empty
directories will have a tendency to disappear once they fall out of
the directory cache .
2016-07-18 06:03:23 +08:00
2016-08-22 23:46:08 +08:00
Only supported on Linux , FreeBSD and OS X at the moment .
2016-07-18 06:03:23 +08:00
# # # rclone mount vs rclone sync / copy # #
File systems expect things to be 100 % reliable , whereas cloud storage
systems are a long way from 100 % reliable . The rclone sync / copy
commands cope with this with lots of retries . However rclone mount
can ' t use retries in the same way without making local copies of the
uploads . This might happen in the future , but for the moment rclone
mount won ' t do that , so will be less reliable than the rclone command .
2017-02-16 07:26:40 +08:00
# # # Filters # # #
Note that all the rclone filters can be used to select a subset of the
files to be visible in the mount .
2016-07-18 06:03:23 +08:00
# # # Bugs # # #
* All the remotes should work for read , but some may not for write
2016-11-19 18:54:37 +08:00
* those which need to know the size in advance won ' t - eg B2
2016-07-18 06:03:23 +08:00
* maybe should pass in size as - 1 to mean work it out
2016-10-24 04:46:48 +08:00
* Or put in an an upload cache to cache the files on disk first
2016-07-18 06:03:23 +08:00
# # # TODO # # #
* Check hashes on upload / download
* Preserve timestamps
* Move directories
` ,
2016-09-09 15:39:19 +08:00
Run : func ( command * cobra . Command , args [ ] string ) {
2016-07-18 06:03:23 +08:00
cmd . CheckArgs ( 2 , 2 , command , args )
fdst := cmd . NewFsDst ( args )
2016-09-09 15:39:19 +08:00
err := Mount ( fdst , args [ 1 ] )
if err != nil {
log . Fatalf ( "Fatal error: %v" , err )
}
2016-07-18 06:03:23 +08:00
} ,
}
// Mount mounts the remote at mountpoint.
//
// If noModTime is set then it
func Mount ( f fs . Fs , mountpoint string ) error {
if debugFUSE {
fuse . Debug = func ( msg interface { } ) {
2017-02-09 19:01:20 +08:00
fs . Debugf ( "fuse" , "%v" , msg )
2016-07-18 06:03:23 +08:00
}
}
2016-09-09 15:39:19 +08:00
// Set permissions
dirPerms = 0777 &^ os . FileMode ( umask )
filePerms = 0666 &^ os . FileMode ( umask )
2016-12-16 01:40:17 +08:00
// Show stats if the user has specifically requested them
if cmd . ShowStats ( ) {
stopStats := cmd . StartStats ( )
defer close ( stopStats )
}
2016-12-01 16:49:47 +08:00
2016-07-18 06:03:23 +08:00
// Mount it
errChan , err := mount ( f , mountpoint )
if err != nil {
return errors . Wrap ( err , "failed to mount FUSE fs" )
}
2017-03-17 18:20:28 +08:00
sigChan := make ( chan os . Signal , 1 )
signal . Notify ( sigChan , syscall . SIGINT , syscall . SIGTERM )
select {
// umount triggered outside the app
case err = <- errChan :
break
// Program abort: umount
case <- sigChan :
err = fuse . Unmount ( mountpoint )
}
2016-07-18 06:03:23 +08:00
if err != nil {
return errors . Wrap ( err , "failed to umount FUSE fs" )
}
return nil
}