homefs 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e7cfe031385f0f670f29e70b5ae08d070650c43
-  data.tar.gz: cf1e7caed614cc7ebf1b89f0736f07154477ed7f
+  metadata.gz: 1d24a895d9cbda06b225d6646ec3e04d959b9c85
+  data.tar.gz: c2d59bc728d9dd65f9d4b736d6e54f5a6a74970d
 SHA512:
-  metadata.gz: c6e960d37bf0ee81d94c11d7ba79394419330a2520109843978f9b5c6c4cd5d0fc5156c6ec4a965eb41e2f2263f5fc73e3aca19fac82be1c0ddd60cab21eb32a
-  data.tar.gz: 134af7962e87f1b89972a9b4431b0eb81c5d2a8fdc0b880d19c3c6e2b6d3f3b1ca505f9f3fe264c1960ad6763756994e85cf962eb91f3202186fd5969255732a
+  metadata.gz: a7ebb4625f918fd4a0049517df744df0d681322d42dab5512f640b1f46273dbeab8cab7b350d6ad1307b762d825561b110163edcc669ab34fb7a5162a63fca83
+  data.tar.gz: b161c74a6ee23f2349104926603697fad01f179d747e7131923a2e2d17a380d0632dfd6777e67886ee38480458b9526f85a141e460b16a82f5e823baa9fb517c

data/bin/homefs

@@ -1,67 +1,127 @@
 #!/usr/bin/env ruby
 
 require 'homefs'
+require 'etc'
+require 'optparse'
 
-DEBUG = false
+HELPSTRING = <<EOF
+Usage: homefs [-h]
+       homefs [OPTION]... relative_directory mountpoint
+       homefs [OPTION]... -r relative_directory mountpoint
+       homefs [OPTION]... -s directory [relative_directory] mountpoint
+       homefs [OPTION]... -s directory [-r relative_directory] mountpoint
 
-if ARGV.size < 2
-    warn "Usage:\n\t#{File.basename($0)} relative_directory mountpoint [options...]"
-    exit 1
-end
+Mount HomeFS on the specified mountpoint, using the specified directory
+    relative to each user's home directory
 
-# Return immediately
-unless DEBUG
-    if fork
-        exit 0
+    -h                     print this help string
+    -d                     enable debug mode
+    -r relative_directory  specify the relative directory. If -r is given
+                           multiple times, the last given path is taken
+    -s directory           instead of using users' home directories, append
+                           each user's username to the given directory
+
+    -o no_allow_other      disable allow_other, which is default
+    -o debug               enable debug mode
+
+Options accepted by FUSE are also understood.
+EOF
+
+def process_arguments(argv)
+    options = []
+
+    parser = OptionParser.new do |opts|
+        opts.on '-d' do
+            @debug = true
+        end
+        opts.on '-oOPTION' do |option|
+            options += option.split(',')
+        end
+        opts.on '-rDIRECTORY' do |directory|
+            @reldir = directory
+        end
+        opts.on '-sDIRECTORY' do |directory|
+            @basedir = directory
+        end
+        opts.on '-h' do
+            print_help
+            exit 0
+        end
+    end
+
+    begin
+        args = parser.parse(argv)
+    rescue OptionParser::InvalidOption => e
+        warn "Option '#{e.args.first}' not understood."
+        puts
+        print_help
+        exit 1
+    end
+
+    @reldir = args.shift unless @reldir
+    @mountpoint = args.shift unless @mountpoint
+
+    if !args.empty?
+        warn "Extra arguments '#{args.join("', '")}' not understood."
+        exit 1
+    end
+
+    if !@reldir && !@basedir
+        warn "You must specify a relative directory for HomeFS!"
+        exit 1
     end
-end
 
-reldir = ARGV.shift
+    if !@mountpoint
+        warn "You must specify a mountpoint!"
+        exit 1
+    end
 
-fs = HomeFS.new(reldir)
+    # We use #delete here to prune options that we understand, but
+    # FUSE doesn't.
+    options.unshift 'allow_other' unless options.delete 'no_allow_other'
+    options.unshift 'dev'         unless options.delete 'nodev'
+    options.unshift 'suid'        unless options.delete 'nosuid'
 
-# Shut up
-unless DEBUG
-    $stdout = File.open("/dev/null", "w")
-    $stderr = File.open("/dev/null", "w")
+    if options.delete('debug')
+        @debug = true
+    end
+
+    options
 end
 
-if DEBUG
-    fs = HomeFS::Wrapper.new(fs)
+def print_help
+    puts HELPSTRING
 end
 
-begin
-    require 'rb-inotify'
+@debug = false
+
+fuse_options = process_arguments(ARGV)
+
+# Return immediately
+unless @debug
+    STDOUT.reopen("/dev/null")
+    STDERR.reopen("/dev/null")
+
     pid = fork
     if pid
-        # The child process will be the one actually handling the FuseFS,
-        # so we want to exit as soon as it dies
-        trap 'CLD' do
-            exit 0
-        end
+        Process.detach(pid)
+        exit 0
+    end
+end
 
-        # Set a watch for /etc/passwd, and update our hash of UIDs => homedirs
-        # when it changes
-        notifier = INotify::Notifier.new
-        notifier.watch('/etc/passwd', :modify) do
-            # Send a signal to the child process; it will catch USR1 and update
-            # the homedirs hash
-            Process::kill('USR1', pid)
-        end
-        notifier.run
-    else
-        # Here we trap the signal to be sent to us by our parent
-        # when /etc/passwd changes and update our hash accordingly
-        trap 'USR1' do
-            fs.read_passwd
-        end
+if @basedir
+    fs = HomeFS.new(@reldir || '') do |uid|
+        File.join(@basedir, Etc.getpwuid(uid).name)
     end
-rescue LoadError
-    # We don't have rb-inotify, and so don't watch for changes to
-    # /etc/passwd
+else
+    fs = HomeFS.new(@reldir)
 end
 
-# We set allow_other, because this filesystem doesn't really make sense
-# without it (why direct different users to different places if only one
-# user can access the filesystem?).
-RFuse.main(ARGV + ["-o", "allow_other"]) { fs }
+if @debug
+    fs = HomeFS::Wrapper.new(fs)
+end
+
+optstring = fuse_options.join(',')
+
+delegator = RFuse::FuseDelegator.new(fs, @mountpoint, '-o', optstring)
+delegator.run

data/lib/homefs/homefs.rb

@@ -1,4 +1,5 @@
 require 'rfuse'
+require 'etc'
 
 # An instance of HomeFS; this implements all FuseFS methods, and ultimately
 # handles reading, writing, and inspection of files.
@@ -17,41 +18,26 @@ class HomeFS
     # to RFuse, as it does nothing on its own. The path is relative to the
     # calling user's home directory, that is, the user interacting with the
     # filesystem through open(2), read(2), write(2), etc.
+    #
+    # This method may accept a block. If a block is given, it is expected to
+    # return the base path for the given UID. If no block is given, this is the
+    # home directory for that UID instead.
     # @param [String] path the path, relative to $HOME, to use as the root of
     # the file system.
-    def initialize(path, options = Hash.new)
+    # @yieldparam [Integer] uid the user ID of the current caller
+    # @yieldreturn [String] the path to use as the base path for the given user
+    def initialize(path, options = Hash.new, &blk)
         @relpath = path
-        read_passwd
-    end
-
-    # Read or re-read /etc/passwd to update the internal table of home
-    # directories for each UID. This method does not try to guess as to which
-    # user IDs are owned by actual users of the system, and which are utility
-    # accounts such as 'lp' or 'pulse'.
-    # @return [void]
-    def read_passwd
-        # Try to read from getent
-        passwd = `getent passwd`
-        if $? != 0
-            passwd = File.read('/etc/passwd')
+        @baseblock = blk || proc do |uid|
+            homedir(uid)
         end
+    end
 
-        @homedirs = Hash.new
-        @usernames = Hash.new
-
-        # Here we map each line in passwd to an array,
-        # which Hash interprets as a key, value pair.
-        passwd.each_line.map { |line|
-            next if line.strip.empty?
-            values = line.split(':')
-            # Username, UID, home directory
-            [values[0], Integer(values[2]), values[5]]
-        }.reject { |line|
-            line.nil?
-        }.each { |username, uid, home|
-            @homedirs[uid] = home
-            @usernames[username] = uid
-        }
+    # Get the home directory of the user with the UID _uid_.
+    # @param [Integer] uid the UID of the user
+    # @return [String] the path to the specified user's home directory
+    def homedir(uid)
+        Etc.getpwuid(uid).dir
     end
 
     # Return the path to the root of HomeFS relative to the underlying
@@ -63,7 +49,7 @@ class HomeFS
     #   filesystem, or if _path_ is specified, the path to that resource
     #   relative to the underlying filesystem.
     def homepath(uid, path = nil)
-        basepath = @homedirs[uid]
+        basepath = @baseblock[uid]
         # basepath shouldn't ever be nil, but fail gracefully just
         # in case.
         raise Errno::ENOENT if basepath == nil

data/man/homefs.1

@@ -0,0 +1,69 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "HOMEFS" "1" "November 2015" "" ""
+.
+.SH "NAME"
+\fBhomefs\fR \- FUSE filesystem that redirects filesystem calls to the calling user\'s home directory
+.
+.SH "SYNOPSIS"
+\fBhomefs\fR [\-h]
+.
+.br
+\fBhomefs\fR [OPTION]\.\.\. relative_directory mountpoint
+.
+.br
+\fBhomefs\fR [OPTION]\.\.\. \-r relative_directory mountpoint
+.
+.br
+\fBhomefs\fR [OPTION]\.\.\. \-s directory [relative_directory] mountpoint
+.
+.br
+\fBhomefs\fR [OPTION]\.\.\. \-s directory [\-r relative_directory] mountpoint
+.
+.br
+.
+.SH "DESCRIPTION"
+FUSE filesystem currently written in Ruby that directs filesystem calls to a directory relative to the calling user\'s home directory\.
+.
+.P
+If the filesystem is mounted on \fB/mnt/homefs\fR and is linked to the directory \'Documents\' relative to each user\'s home directory, the user Sarah doing ls \fB/mnt/homefs/\fR would see the contents of \fB/home/sarah/Documents,\fR and the user Tyler would see the contents of \fB/home/tyler/Documents\.\fR
+.
+.P
+Since HomeFS only makes sense when it\'s used to display different contents to different users, it by default passes the option \'allow_other\' to FUSE, which allows any user with the appropriate permissions to interact with the filesystem\.
+.
+.P
+Currently we do not support POSIX locking and creation of special device files such as FIFOs (though HomeFS can read and write to and from special device files)\. We do support extended filesystem attributes given that you install the ffi\-xattr gem, but you can use HomeFS without it if you do not need them\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fIrelative_directory\fR
+The directory relative to each user\'s home directory to redirect filesystem calls to\. That is, calls are directed to \fI$HOME\fR/\fIrelative_directory\fR where $HOME is the calling user\'s home directory\.
+.
+.TP
+\fImountpoint\fR
+The mountpoint where HomeFS is to be mounted
+.
+.TP
+\fB\-h\fR
+Print a short help string summarizing the options
+.
+.TP
+\fB\-d\fR
+Enable debug mode\. If debug mode is on, HomeFS will not return immediately, and will report any of its methods that are called\. Note that this does not enable FUSE debug mode\.
+.
+.TP
+\fB\-r\fR \fIrelative_directory\fR
+Specify the relative directory with a switch instead of a positional argument
+.
+.TP
+\fB\-o\fR \fIno_allow_other\fR
+Disable allow_other, which is default\. If specified, only the user mounting HomeFS can use it\. Considering the nature of HomeFS, using a symlink would probably be more appropiate\.
+.
+.TP
+\fB\-o\fR \fIdebug\fR
+Same as \fB\-d\fR\.
+.
+.P
+Options accepted by FUSE are passed onto FUSE\. See \fIfuse(8)\fR for a complete list and explanation of each option\.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: homefs
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Dylan Frese
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rfuse
@@ -38,6 +38,7 @@ files:
 - lib/homefs.rb
 - lib/homefs/debug.rb
 - lib/homefs/homefs.rb
+- man/homefs.1
 homepage: 
 licenses:
 - GPLv2