rfusefs 1.0.2.RC0 → 1.0.2.RC1

data/lib/fusefs/pathmapper.rb

@@ -1,3 +1,4 @@
+require 'ffi-xattr'
 
 module FuseFS
 
@@ -8,24 +9,71 @@ module FuseFS
 
         # Represents a mappted file or directory
         class MNode
-            
+
+            # Merge extended attributes with the ones from the underlying file
+            class XAttr
+
+                attr_reader :node, :file_xattr
+
+                def initialize(node)
+                    @node = node
+                    @file_xattr = ::Xattr.new(node.real_path.to_s) if node.file?
+                end
+
+                def [](key)
+                    additional[key] || (file_xattr && file_xattr[key])
+                end
+
+                def []=(key,value)
+                    raise Errno::EACCES if additional.has_key?(key) || node.directory?
+                    file_xattr[key] = value
+                end
+
+                def delete(key)
+                    raise Errno::EACCES if additional.has_key?(key) || node.directory?
+                    file_xattr.remove(key)
+                end
+
+                def keys
+                    if file_xattr
+                        additional.keys + file_xattr.list
+                    else
+                        additional.keys
+                    end
+                end
+
+
+                def additional
+                    @node[:xattr] || {}
+                end
+
+            end
+
             # @return [Hash<String,MNode>] list of files in a directory, nil for file nodes
             attr_reader :files
 
+            # Useful when mapping a file to store attributes against the
+            # parent directory
             # @return [MNode] parent directory
             attr_reader :parent
 
+            #
             # @return [Hash] metadata for this node
             attr_reader :options
 
+            #
             # @return [String] path to backing file, or nil for directory nodes
             attr_reader :real_path
 
+
             # @!visibility private
-            def initialize(parent_dir)
+            def initialize(parent_dir,stats)
                 @parent = parent_dir
                 @files = {}
                 @options = {}
+                @stats = stats
+                @stats_size = 0
+                @stats.adjust(0,1)
             end
 
             # @!visibility private
@@ -33,6 +81,7 @@ module FuseFS
                 @options.merge!(options)
                 @real_path = real_path
                 @files = nil
+                updated
                 self
             end
 
@@ -76,9 +125,24 @@ module FuseFS
             def[]=(key,value)
                 options[key]=value
             end
+
+            def xattr
+                @xattr ||= XAttr.new(self)
+            end
+
+            def deleted
+                @stats.adjust(-@stats_size,-1)
+                @stats_size = 0
+            end
+
+            def updated
+                new_size = File.size(real_path)
+                @stats.adjust(new_size - @stats_size)
+                @stats_size = new_size
+            end
         end
 
-        # Convert FuseFS raw_mode strings to IO open mode strings
+        # Convert FuseFS raw_mode strings back to IO open mode strings
         def self.open_mode(raw_mode)
             case raw_mode
             when "r"
@@ -106,6 +170,10 @@ module FuseFS
         #     default is false
         attr_accessor  :allow_write
 
+        #
+        # @return [StatsHelper] accumulated filesystem statistics
+        attr_reader :stats
+        
         # Creates a new Path Mapper filesystem over an existing directory
         # @param [String] dir
         # @param [Hash] options
@@ -114,8 +182,8 @@ module FuseFS
         # @see #initialize
         # @see #map_directory
         def PathMapperFS.create(dir,options={ },&block)
-            pm_fs = PathMapperFS.new(options)
-            pm_fs.map_directory(dir,&block) 
+            pm_fs = self.new(options)
+            pm_fs.map_directory(dir,&block)
             return pm_fs
         end
 
@@ -123,8 +191,13 @@ module FuseFS
         # @param [Hash]  options
         # @option options [Boolean] :use_raw_file_access
         # @option options [Boolean] :allow_write
+        # @option options [Integer] :max_space available space for writes (for df)
+        # @option options [Integer] :max_nodes available nodes for writes (for df)
         def initialize(options = { })
-            @root = MNode.new(nil)
+            @stats = StatsHelper.new()
+            @stats.max_space = options[:max_space]
+            @stats.max_nodes = options[:max_nodes]
+            @root = MNode.new(nil,@stats)
             @use_raw_file_access = options[:use_raw_file_access]
             @allow_write = options[:allow_write]
         end
@@ -230,9 +303,9 @@ module FuseFS
 
         # @!visibility private
         def write_to(path,contents)
-            File.open(unmap(path),"w") do |f|
-                f.print(contents)
-            end
+            node = node(path)
+            File.open(node.real_path,"w") { |f| f.print(contents) }
+            node.updated
         end
 
         # @!visibility private
@@ -254,7 +327,7 @@ module FuseFS
 
         # @!visibility private
         def xattr(path)
-            result = node(path).options[:xattr] || {}
+            result = node(path).xattr
         end
 
         # @!visibility private
@@ -300,33 +373,61 @@ module FuseFS
             file.sysseek(offset)
             file.syswrite(buf[0,sz])
         end
+        
+        # @!visibility private
+        def raw_sync(path,datasync,file=nil)
+            file = @openfiles[path] unless file
+            if datasync
+                file.fdatasync
+            else
+                file.sync
+            end
+        end
 
         # @!visibility private
         def raw_close(path,file=nil)
-            unless file
-                file = @openfiles.delete(path)
+            file = @openfiles.delete(path) unless file
+           
+            if file && !file.closed?
+                begin
+                    flags = file.fcntl(Fcntl::F_GETFL) & Fcntl::O_ACCMODE
+                    if flags == Fcntl::O_WRONLY || flags == Fcntl::O_RDWR
+                        #update stats
+                        node = node(path)
+                        node.updated if node
+                    end
+                ensure
+                    file.close
+                end
             end
-            file.close if file
+
+        end
+
+        # @!visibility private
+        def statistics(path)
+            @stats.to_statistics
         end
 
         private
-       
+
         def make_node(path)
-            #split path into components 
+            #split path into components
             components = path.to_s.scan(/[^\/]+/)
             components.inject(@root) { |parent_dir, file|
-                parent_dir.files[file] ||= MNode.new(parent_dir)
+                parent_dir.files[file] ||= MNode.new(parent_dir,@stats)
             }
         end
-        
+
         def recursive_cleanup(dir_node,&block)
-            dir_node.files.delete_if do |path,child| 
-                if child.file?
+            dir_node.files.delete_if do |path,child|
+                del = if child.file?
                     yield child
                 else
-                    recursive_cleanup(child,&block) 
+                    recursive_cleanup(child,&block)
                     child.files.size == 0
                 end
+                child.deleted if del
+                del
             end
         end
     end

data/lib/rfusefs/version.rb

@@ -1,3 +1,3 @@
 module RFuseFS
-    VERSION="1.0.2.RC0"
+    VERSION="1.0.2.RC1"
 end

data/lib/rfusefs.rb

@@ -177,9 +177,12 @@ module FuseFS
         Thread.current[:fusefs_reader_gid]
     end
 
-    # Not supported in RFuseFS (yet). The original FuseFS had special handling for editor
-    # swap/backup but this does not seem to be required, eg for the demo filesystems.
-    # If it is required it can be implemented in a filesystem
+    # Not supported in RFuseFS.
+    #
+    # The original FuseFS had special handling for editor swap/backup files
+    # which appears to be a workaround for a bug where zero length files
+    # where never written to. This "bug" is fixed since RFuseFS 1.0.2
+    #
     # @deprecated
     def self.handle_editor(bool)
         #do nothing

data/rfusefs.gemspec

@@ -20,10 +20,12 @@ Gem::Specification.new do |s|
   s.has_rdoc = 'yard'
   s_extra_rdoc_files = 'History.rdoc'
 
-  s.add_dependency("rfuse", ">= 1.0.4")
+  s.add_dependency("rfuse", ">= 1.0.5RC0")
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec")
   s.add_development_dependency("yard")
   s.add_development_dependency("redcarpet")
   s.add_development_dependency("sqlite3")
+  s.add_development_dependency("sys-filesystem")
+  s.add_development_dependency("ffi-xattr", ">= 0.1.1")
 end

data/samples/demo.rb

@@ -6,6 +6,9 @@ require 'fusefs/dirlink'
 include FuseFS
 
 root = MetaDir.new
+root.stats.total_space = 1024*1024
+root.stats.total_nodes = 1024
+root.stats.strict = true
 
 class Counter
   def initialize
@@ -51,9 +54,4 @@ root.write_to('/animal',Randwords.new('duck','dog','cat','duck billed platypus',
 
 root.mkdir("/#{ENV['USER']}",FuseFS::DirLink.new(ENV['HOME']))
 
-unless ARGV.length > 0 && File.directory?(ARGV[0])
-  puts "Usage: #{$0} <mountpoint> <mountoptions>"
-  exit
-end
-
-FuseFS.start(root, *ARGV)
+FuseFS.main(ARGV) { | options | root }

data/samples/hello.rb

@@ -11,12 +11,9 @@ class HelloDir
     "Hello, World!\n"
   end
 
-  def size(path)
-    read_file(path).size
-  end
 end
 
-if __FILE__ == $0	
+if __FILE__ == $0
 	require 'rfusefs'
 	hellodir = HelloDir.new
     FuseFS.start(hellodir,*ARGV)

data/spec/metadir_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 require 'tmpdir'
+require 'sys/filesystem'
+require 'ffi-xattr'
 
 describe FuseFS::MetaDir do
   
@@ -38,6 +40,10 @@ describe FuseFS::MetaDir do
       it "should indicate the size of a file" do
         @metadir.size("/test/hello/hello.txt").should be "Hello World!\n".length
       end
+
+      it "should report filesystem statistics" do
+          @metadir.statistics("/").should == [ 13, 5, nil, nil ]
+      end
     end
     
     context "with write access" do
@@ -102,6 +108,15 @@ describe FuseFS::MetaDir do
         @metadir.read_file("/test/other/more/hello/hello.txt").should == "Hello World!\n"
       end
 
+      it "should maintain filesystem statistics" do
+        # remove a directory
+        @metadir.rmdir("/test/hello/emptydir")
+
+        # replace text for (the only)  existing file
+        @metadir.write_to("/test/hello/hello.txt","new text")
+        
+        @metadir.statistics("/").should == [ 8, 4, nil, nil ]
+      end
     end
     
     context "with readonly access" do
@@ -216,6 +231,17 @@ describe FuseFS::MetaDir do
         @metadir.rename("/test/aDir","/test/fusefs/newpath/to/dir").should be_false
       end
 
+      it "should pass on #statistics" do
+        @fusefs.should_receive(:statistics).with("/path/to/file")
+
+        @metadir.statistics("test/fusefs/path/to/file")
+      end
+
+      it "should pass on #statistics for root" do
+        @fusefs.should_receive(:statistics).with("/")
+
+        @metadir.statistics("test/fusefs")
+      end
     end
     
   end
@@ -229,6 +255,8 @@ describe FuseFS::MetaDir do
 	before(:all) do
         metadir.mkdir("/test")
         metadir.write_to("/test/hello.txt","Hello World!\n")
+        metadir.xattr("/test/hello.txt")["user.test"] = "an extended attribute"
+        metadir.xattr("/test")["user.test"] = "a dir attribute"
 		FuseFS.mount(metadir,mountpoint)
 		#Give FUSE some time to get started 
 		sleep(0.5)
@@ -249,6 +277,25 @@ describe FuseFS::MetaDir do
 		testfile.read().should == "Hello World!\n"
     end
 
+    it "should read and write extended attributes from files" do
+        x = Xattr.new(testfile.to_s)
+        x["user.test"].should == "an extended attribute"
+
+        x["user.new"] = "new"
+        
+        Xattr.new(testfile.to_s)["user.new"].should == "new"
+    end
+
+    it "should write extended attributes for directories" do
+        x = Xattr.new(testdir.to_s)
+
+        x["user.test"].should == "a dir attribute"
+        x["user.new"] = "new dir"
+        
+        Xattr.new(testdir.to_s)["user.new"].should == "new dir"
+    end
+
+
     it "should create directories" do
         newdir = testdir + "newdir"
         newdir.mkdir()
@@ -290,6 +337,28 @@ describe FuseFS::MetaDir do
         movefile.read.should == "Hello World!\n"
     end
 
+
+    it "should report filesystem statistics" do
+        bigfile = testdir + "bigfile"
+        bigfile.open("w") do |file|
+            file << ("x" * 2048)
+        end
+      
+        statfs = Sys::Filesystem.stat(mountpoint.to_s)
+
+        # These are fixed
+        statfs.block_size.should == 1024
+        statfs.fragment_size.should == 1024
+
+        # These are dependant on the tests above creating files/directories
+        statfs.files.should == 8
+        statfs.files_available == 8
+
+        # assume test are less than 1 block, so dependant on bigfile above
+        statfs.blocks.should == 2
+        statfs.blocks_available.should == 0
+        statfs.blocks_free.should == 0
+    end
   end
   
 end