2017-06-19 12:44:49 +00:00
package mountlib
import (
2017-11-09 00:37:27 +00:00
"io"
2017-06-19 12:44:49 +00:00
"log"
2017-11-09 00:37:27 +00:00
"os"
2017-11-16 12:20:53 +00:00
"runtime"
2017-06-19 12:44:49 +00:00
"github.com/ncw/rclone/cmd"
"github.com/ncw/rclone/fs"
2018-01-12 16:30:54 +00:00
"github.com/ncw/rclone/fs/config/flags"
2017-11-13 17:54:21 +00:00
"github.com/ncw/rclone/vfs"
2017-10-29 11:00:56 +00:00
"github.com/ncw/rclone/vfs/vfsflags"
2017-11-09 00:37:27 +00:00
"github.com/pkg/errors"
2017-06-19 12:44:49 +00:00
"github.com/spf13/cobra"
)
// Options set by command line flags
var (
2017-10-28 19:01:34 +00:00
DebugFUSE = false
2017-06-19 12:44:49 +00:00
AllowNonEmpty = false
AllowRoot = false
AllowOther = false
DefaultPermissions = false
WritebackCache = false
MaxReadAhead fs . SizeSuffix = 128 * 1024
2017-11-07 17:09:08 +00:00
ExtraOptions [ ] string
ExtraFlags [ ] string
2017-06-19 12:44:49 +00:00
)
2017-11-09 00:37:27 +00:00
// Check is folder is empty
func checkMountEmpty ( mountpoint string ) error {
fp , fpErr := os . Open ( mountpoint )
if fpErr != nil {
return errors . Wrap ( fpErr , "Can not open: " + mountpoint )
}
defer fs . CheckClose ( fp , & fpErr )
_ , fpErr = fp . Readdirnames ( 1 )
// directory is not empty
if fpErr != io . EOF {
var e error
var errorMsg = "Directory is not empty: " + mountpoint + " If you want to mount it anyway use: --allow-non-empty option"
if fpErr == nil {
e = errors . New ( errorMsg )
} else {
e = errors . Wrap ( fpErr , errorMsg )
}
return e
}
return nil
}
2017-06-19 12:44:49 +00:00
// NewMountCommand makes a mount command with the given name and Mount function
func NewMountCommand ( commandName string , Mount func ( f fs . Fs , mountpoint string ) error ) * cobra . Command {
var commandDefintion = & cobra . Command {
Use : commandName + " remote:path /path/to/mountpoint" ,
Short : ` Mount the remote as a mountpoint. **EXPERIMENTAL** ` ,
Long : `
rclone ` + commandName + ` allows Linux , FreeBSD , macOS and Windows to
mount any of Rclone ' s cloud storage systems as a file system with
FUSE .
This is * * EXPERIMENTAL * * - use with care .
First set up your remote using ` + " ` rclone config ` " + ` . Check it works with ` + " ` rclone ls ` " + ` etc .
Start the mount like this
rclone ` + commandName + ` remote : path / to / files / path / to / local / mount
Or on Windows like this where X : is an unused drive letter
rclone ` + commandName + ` remote : path / to / files X :
When the program ends , either via Ctrl + C or receiving a SIGINT or SIGTERM signal ,
the mount is automatically stopped .
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
# Linux
fusermount - u / path / to / local / mount
# OS X
umount / path / to / local / mount
2018-01-18 19:16:21 +00:00
# # # Installing on Windows
2017-07-23 11:13:29 +00:00
To run rclone ` + commandName + ` on Windows , you will need to
download and install [ WinFsp ] ( http : //www.secfs.net/winfsp/).
WinFsp is an [ open source ] ( https : //github.com/billziss-gh/winfsp)
Windows File System Proxy which makes it easy to write user space file
systems for Windows . It provides a FUSE emulation layer which rclone
uses combination with
[ cgofuse ] ( https : //github.com/billziss-gh/cgofuse). Both of these
packages are by Bill Zissimopoulos who was very helpful during the
implementation of rclone ` + commandName + ` for Windows .
2018-01-18 19:16:21 +00:00
# # # # Windows caveats
2017-07-26 20:08:24 +00:00
Note that drives created as Administrator are not visible by other
accounts ( including the account that was elevated as
Administrator ) . So if you start a Windows drive from an Administrative
Command Prompt and then try to access the same drive from Explorer
( which does not run as Administrator ) , you will not be able to see the
new drive .
The easiest way around this is to start the drive from a normal
command prompt . It is also possible to start a drive from the SYSTEM
account ( using [ the WinFsp . Launcher
infrastructure ] ( https : //github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture))
which creates drives accessible for everyone on the system .
2018-01-18 19:16:21 +00:00
# # # Limitations
2017-06-19 12:44:49 +00:00
2018-02-10 09:28:20 +00:00
Without the use of "--vfs-cache-mode" this can only write files
sequentially , it can only seek when reading . This means that many
applications won ' t work with their files on an rclone mount without
"--vfs-cache-mode writes" or "--vfs-cache-mode full" . See the [ File
Caching ] ( # file - caching ) section for more info .
2017-06-19 12:44:49 +00:00
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 .
Only supported on Linux , FreeBSD , OS X and Windows at the moment .
2018-01-18 19:16:21 +00:00
# # # rclone ` + commandName + ` vs rclone sync / copy
2017-06-19 12:44:49 +00:00
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 ` + commandName + `
can ' t use retries in the same way without making local copies of the
2018-01-18 19:16:21 +00:00
uploads . Look at the * * EXPERIMENTAL * * [ file caching ] ( # file - caching )
for solutions to make ` + commandName + ` mount more reliable .
2017-06-19 12:44:49 +00:00
2018-01-18 19:16:21 +00:00
# # # Filters
2017-06-19 12:44:49 +00:00
Note that all the rclone filters can be used to select a subset of the
files to be visible in the mount .
2018-01-18 19:16:21 +00:00
# # # systemd
2017-11-19 22:03:49 +00:00
When running rclone ` + commandName + ` as a systemd service , it is possible
2018-01-18 19:16:21 +00:00
to use Type = notify . In this case the service will enter the started state
2017-11-19 22:03:49 +00:00
after the mountpoint has been successfully set up .
Units having the rclone ` + commandName + ` service specified as a requirement
will see all files and folders immediately in this mode .
2017-11-13 17:54:21 +00:00
` + vfs . Help ,
2017-06-19 12:44:49 +00:00
Run : func ( command * cobra . Command , args [ ] string ) {
cmd . CheckArgs ( 2 , 2 , command , args )
fdst := cmd . NewFsDst ( args )
// Show stats if the user has specifically requested them
if cmd . ShowStats ( ) {
stopStats := cmd . StartStats ( )
defer close ( stopStats )
}
2017-11-16 12:20:53 +00:00
// Skip checkMountEmpty if --allow-non-empty flag is used or if
// the Operating System is Windows
if ! AllowNonEmpty && runtime . GOOS != "windows" {
2017-11-09 00:37:27 +00:00
err := checkMountEmpty ( args [ 1 ] )
if err != nil {
log . Fatalf ( "Fatal error: %v" , err )
}
}
2017-06-19 12:44:49 +00:00
err := Mount ( fdst , args [ 1 ] )
if err != nil {
log . Fatalf ( "Fatal error: %v" , err )
}
} ,
}
// Register the command
cmd . Root . AddCommand ( commandDefintion )
// Add flags
2018-01-12 16:30:54 +00:00
flagSet := commandDefintion . Flags ( )
flags . BoolVarP ( flagSet , & DebugFUSE , "debug-fuse" , "" , DebugFUSE , "Debug the FUSE internals - needs -v." )
2017-06-19 12:44:49 +00:00
// mount options
2018-01-12 16:30:54 +00:00
flags . BoolVarP ( flagSet , & AllowNonEmpty , "allow-non-empty" , "" , AllowNonEmpty , "Allow mounting over a non-empty directory." )
flags . BoolVarP ( flagSet , & AllowRoot , "allow-root" , "" , AllowRoot , "Allow access to root user." )
flags . BoolVarP ( flagSet , & AllowOther , "allow-other" , "" , AllowOther , "Allow access to other users." )
flags . BoolVarP ( flagSet , & DefaultPermissions , "default-permissions" , "" , DefaultPermissions , "Makes kernel enforce access control based on the file mode." )
flags . BoolVarP ( flagSet , & WritebackCache , "write-back-cache" , "" , WritebackCache , "Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used." )
flags . FVarP ( flagSet , & MaxReadAhead , "max-read-ahead" , "" , "The number of bytes that can be prefetched for sequential reads." )
flags . StringArrayVarP ( flagSet , & ExtraOptions , "option" , "o" , [ ] string { } , "Option for libfuse/WinFsp. Repeat if required." )
flags . StringArrayVarP ( flagSet , & ExtraFlags , "fuse-flag" , "" , [ ] string { } , "Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required." )
//flags.BoolVarP(flagSet, &foreground, "foreground", "", foreground, "Do not detach.")
2017-06-19 12:44:49 +00:00
2017-10-24 20:06:06 +00:00
// Add in the generic flags
2018-01-12 16:30:54 +00:00
vfsflags . AddFlags ( flagSet )
2017-10-24 20:06:06 +00:00
2017-06-19 12:44:49 +00:00
return commandDefintion
}