rfusefs 1.0.3 → 1.1.0.rc202009.34

data/lib/fusefs/dirlink.rb

@@ -1,46 +0,0 @@
-module FuseFS
-
-  # A FuseFS over an existing directory 
-  class DirLink < FuseDir
-
-    def initialize(dir)
-      File.directory?(dir) or raise ArgumentError, "DirLink.initialize expects a valid directory!"
-      @base = dir
-    end
-
-    def directory?(path)
-      File.directory?(File.join(@base,path))
-    end
-
-    def file?(path)
-      File.file?(File.join(@base,path))
-    end
-
-    def size(path)
-      File.size(File.join(@base,path))
-    end
-
-    def contents(path)
-      fn = File.join(@base,path)
-      Dir.entries(fn).map { |file|
-      file = file.sub(/^#{fn}\/?/,'')
-      if ['..','.'].include?(file)
-        nil
-      else
-        file
-      end
-      }.compact.sort
-    end
-
-    def read_file(path)
-      fn = File.join(@base,path)
-      if File.file?(fn)
-        IO.read(fn)
-      else
-        'No such file'
-      end
-    end
-
-  end
-  
-end

data/lib/fusefs/metadir.rb

@@ -1,287 +0,0 @@
-module FuseFS
-
-    # A full in-memory filesystem defined with hashes. It is writable to the
-    # user that mounted it
-    # may create and edit files within it, as well as the programmer
-    # === Usage
-    #   root = Metadir.new()
-    #   root.mkdir("/hello")
-    #   root.write_to("/hello/world","Hello World!\n")
-    #   root.write_to("/hello/everybody","Hello Everyone!\n")
-    #
-    #   FuseFS.start(mntpath,root)
-    #
-    # Because Metadir is fully recursive, you can mount your own or other defined
-    # directory structures under it. For example, to mount a dictionary filesystem
-    # (see samples/dictfs.rb), use:
-    #
-    #   root.mkdir("/dict",DictFS.new())
-    #
-    class MetaDir
-
-        DEFAULT_FS = FuseDir.new()
-
-        # @return [StatsHelper] helper for filesystem accounting (df etc)
-        attr_reader :stats
-
-        def initialize(stats = nil)
-            @subdirs  = Hash.new(nil)
-            @files    = Hash.new(nil)
-            @xattr   = Hash.new() { |h,k| h[k] = Hash.new }
-            @stats = stats || StatsHelper.new()
-            @stats.adjust(0,1)
-        end
-
-        def split_path(path)
-            DEFAULT_FS.split_path(path)
-        end
-
-        def scan_path
-            DEFAULT_FS.scan_path(path)
-        end
-
-        def directory?(path)
-            pathmethod(:directory?,path) do |filename|
-                !filename || filename == "/" || @subdirs.has_key?(filename)
-            end
-        end
-
-        def file?(path)
-            pathmethod(:file?,path) do |filename|
-                @files.has_key?(filename)
-            end
-        end
-
-        #List directory contents
-        def contents(path)
-            pathmethod(:contents,path) do | filename |
-                if !filename
-                    (@files.keys + @subdirs.keys).sort.uniq
-                else
-                    @subdirs[filename].contents("/")
-                end
-            end
-        end
-
-        # Extended attributes
-        def xattr(path)
-            pathmethod(:xattr,path) do | path |
-               @xattr[path]
-            end
-        end
-
-        def read_file(path)
-            pathmethod(:read_file,path) do |filename|
-                @files[filename].to_s
-            end
-        end
-
-        def size(path)
-            pathmethod(:size,path) do | filename |
-                return @files[filename].to_s.length
-            end
-        end
-
-        #can_write only applies to files... see can_mkdir for directories...
-        def can_write?(path)
-            pathmethod(:can_write?,path) do |filename|
-                return mount_user?
-            end
-        end
-
-        def write_to(path,contents)
-            pathmethod(:write_to,path,contents) do |filename, filecontents |
-                adj_size = filecontents.to_s.length
-                adj_nodes = 1
-                if @files.has_key?(filename)
-                    adj_size = adj_size - @files[filename].to_s.length
-                    adj_nodes = 0
-                end
-                @stats.adjust(adj_size,adj_nodes)
-
-                @files[filename] = filecontents
-            end
-        end
-
-        # Delete a file
-        def can_delete?(path)
-            pathmethod(:can_delete?,path) do |filename|
-                return mount_user?
-            end
-        end
-
-        def delete(path)
-            pathmethod(:delete,path) do |filename|
-                contents = @files.delete(filename)
-                @stats.adjust(-contents.to_s.length,-1)
-            end
-        end
-
-        #mkdir - does not make intermediate dirs!
-        def can_mkdir?(path)
-            pathmethod(:can_mkdir?,path) do |dirname|
-                return mount_user?
-            end
-        end
-
-        def mkdir(path,dir=nil)
-            pathmethod(:mkdir,path,dir) do | dirname,dirobj |
-                dirobj ||= MetaDir.new(@stats)
-                @subdirs[dirname] = dirobj
-            end
-        end
-
-        # Delete an existing directory make sure it is not empty
-        def can_rmdir?(path)
-            pathmethod(:can_rmdir?,path) do |dirname|
-                return mount_user? && @subdirs.has_key?(dirname) && @subdirs[dirname].contents("/").empty?
-            end
-        end
-
-        def rmdir(path)
-            pathmethod(:rmdir,path) do |dirname|
-                @subdirs.delete(dirname)
-                @stats.adjust(0,-1)
-            end
-        end
-
-        def rename(from_path,to_path,to_fusefs = self)
-
-            from_base,from_rest = split_path(from_path)
-
-            case
-            when !from_base
-                # Shouldn't ever happen.
-                raise Errno::EACCES.new("Can't move root")
-            when !from_rest
-                # So now we have a file or directory to move
-                if @files.has_key?(from_base)
-                    return false unless can_delete?(from_base) && to_fusefs.can_write?(to_path)
-                    to_fusefs.write_to(to_path,@files[from_base])
-                    to_fusefs.xattr(to_path).merge!(@xattr[from_base])
-                    @xattr.delete(from_base)
-                    @files.delete(from_base)
-                elsif @subdirs.has_key?(from_base)
-                    # we don't check can_rmdir? because that would prevent us 
-                    # moving non empty directories
-                    return false unless mount_user? && to_fusefs.can_mkdir?(to_path)
-                    begin
-                        to_fusefs.mkdir(to_path,@subdirs[from_base])
-                        to_fusefs.xattr(to_path).merge!(@xattr[from_base])
-                        @xattr.delete(from_base)
-                        @subdirs.delete(from_base)
-                        @stats.adjust(0,-1)
-                        return true
-                    rescue ArgumentError
-                        # to_rest does not support mkdir with an arbitrary object
-                        return false
-                    end
-                else
-                    #We shouldn't get this either
-                    return false
-                end
-            when @subdirs.has_key?(from_base)
-                begin
-                    if to_fusefs != self
-                        #just keep recursing..
-                        return @subdirs[from_base].rename(from_rest,to_path,to_fusefs)
-                    else
-                        to_base,to_rest = split_path(to_path)
-                        if from_base == to_base
-                            #mv within a subdir, just pass it on
-                            return @subdirs[from_base].rename(from_rest,to_rest)
-                        else
-                            #OK, this is the tricky part, we want to move something further down
-                            #our tree into something in another part of the tree.
-                            #from this point on we keep a reference to the fusefs that owns
-                            #to_path (ie us) and pass it down, but only if the eventual path
-                            #is writable anyway!
-                            if (file?(to_path))
-                                return false unless can_write?(to_path)
-                            else
-                                return false unless can_mkdir?(to_path)
-                            end
-
-                            return @subdirs[from_base].rename(from_rest,to_path,self)
-                        end
-                    end
-                rescue NoMethodError
-                    #sub dir doesn't support rename
-                    return false
-                rescue ArgumentError
-                    #sub dir doesn't support rename with additional to_fusefs argument
-                    return false
-                end
-            else
-                return false
-            end
-        end
-
-        # path is ignored? - recursively calculate for all subdirs - but cache and then rely on fuse to keep count
-        def statistics(path)
-            pathmethod(:statistics,path) do |stats_path|
-                if @subdirs.has_key?(stats_path)
-                    #unlike all the other functions where this metadir applies
-                    #the function to @subdirs - we need to pass it on
-                    @subdirs[stats_path].statistics("/")
-                else
-                    @stats.to_statistics
-                end
-            end
-        end
-
-        default_methods = FuseDir.public_instance_methods.select { |m|
-            ![:mounted,:unmounted].include?(m) &&
-                !self.public_method_defined?(m) && FuseDir.instance_method(m).owner == FuseDir
-        }
-
-        default_methods.each do |m|
-            define_method(m) do |*args|
-                pathmethod(m,*args) { |*args| DEFAULT_FS.send(m,*args) }
-            end
-        end
-
-        private
-        # is the accessing user the same as the user that mounted our FS?, used for
-        # all write activity
-        def mount_user?
-            return Process.uid == FuseFS.reader_uid
-        end
-
-        #All our FuseFS methods follow the same pattern...
-        def pathmethod(method, path,*args)
-            base,rest = split_path(path)
-
-            case
-            when ! base
-                #request for the root of our fs
-                yield(nil,*args)
-            when ! rest
-                #base is the filename, no more directories to traverse
-                yield(base,*args)
-            when @subdirs.has_key?(base)
-                #base is a subdirectory, pass it on if we can
-                begin
-                    @subdirs[base].send(method,rest,*args)
-                rescue NoMethodError
-                    #Oh well
-                    return DEFAULT_FS.send(method,rest,*args)
-                rescue ArgumentError
-                    #can_mkdir,mkdir
-                    if args.pop.nil?
-                        #possibly a default arg, try sending again with one fewer arg
-                        @subdirs[base].send(method,rest,*args)
-                    else
-                        #definitely not a default arg, reraise
-                        Kernel.raise
-                    end
-                end
-            else
-                #return the default response
-                return DEFAULT_FS.send(method,path,*args)
-            end
-        end
-
-
-    end
-end

data/lib/fusefs/pathmapper.rb

@@ -1,442 +0,0 @@
-
-module FuseFS
-  begin
-    require 'ffi-xattr'
-    HAS_FFI_XATTR = true
-  rescue LoadError
-    warn "ffi-xattr not available, extended attributes will not be mapped"
-    HAS_FFI_XATTR = false
-  end
-
-    # A FuseFS that maps files from their original location into a new path
-    # eg tagged audio files can be mapped by title etc...
-    #
-    class PathMapperFS < FuseDir
-
-        # Represents a mapped 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? && HAS_FFI_XATTR
-                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 if file_xattr
-                end
-
-                def delete(key)
-                    raise Errno::EACCES if additional.has_key?(key) || node.directory?
-                    file_xattr.remove(key) if file_xattr
-                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,stats)
-                @parent = parent_dir
-                @files = {}
-                @options = {}
-                @stats = stats
-                @stats_size = 0
-                @stats.adjust(0,1)
-            end
-
-            # @!visibility private
-            def init_file(real_path,options)
-                @options.merge!(options)
-                @real_path = real_path
-                @files = nil
-                updated
-                self
-            end
-
-            def init_dir(options)
-                @options.merge!(options)
-                self
-            end
-
-            # @return [Boolean] true if node represents a file, otherwise false
-            def file?
-                real_path && true
-            end
-
-            # @return [Boolean] true if node represents a directory, otherwise false
-            def directory?
-                files && true
-            end
-
-            # @return [Boolean] true if node is the root directory
-            def root?
-                @parent.nil?
-            end
-
-            # Compatibility and convenience method
-            # @param [:pm_real_path,String,Symbol] key
-            # @return [String] {#real_path} if key == :pm_real_path
-            # @return [MNode] the node representing the file named key
-            # @return [Object] shortcut for {#options}[key]
-            def[](key)
-                case key
-                when :pm_real_path
-                    real_path
-                when String
-                    files[key]
-                else
-                    options[key]
-                end
-            end
-
-            # Convenience method to set metadata into {#options}
-            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 back to IO open mode strings
-        def self.open_mode(raw_mode)
-            case raw_mode
-            when "r"
-                "r"
-            when "ra"
-                "r" #not really sensible..
-            when "rw"
-                "r+"
-            when "rwa"
-                "a+"
-            when "w"
-                "w"
-            when "wa"
-                "a"
-            end
-        end
-
-        # should raw file access should be used - useful for binary files
-        # @return [Boolean]
-        #   default is false
-        attr_accessor :use_raw_file_access
-
-        # should filesystem support writing through to the real files
-        # @return [Boolean]
-        #     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
-        # @yieldparam [String] file path to map
-        # @yieldreturn [String]
-        # @see #initialize
-        # @see #map_directory
-        def PathMapperFS.create(dir,options={ },&block)
-            pm_fs = self.new(options)
-            pm_fs.map_directory(dir,&block)
-            return pm_fs
-        end
-
-        # Create a new Path Mapper filesystem
-        # @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 = { })
-            @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
-
-        # Recursively find all files and map according to the given block
-        # @param [String...] dirs directories to list
-        # @yieldparam [String] file path to map
-        # @yieldreturn [String] the mapped path
-        # @yieldreturn nil to skip mapping this file
-        def map_directory(*dirs)
-            require 'find'
-            Find.find(*dirs) do |file|
-                new_path = yield file
-                map_file(file,new_path) if new_path
-            end
-        end
-        alias :mapDirectory :map_directory
-
-
-        # Add (or replace) a mapped file
-        #
-        # @param [String] real_path pointing at the real file location
-        # @param [String] new_path the mapped path
-        # @param [Hash<Symbol,Object>] options metadata for this path
-        # @option options [Hash<String,String>] :xattr hash to be used as extended attributes
-        # @return [MNode]
-        #    a node representing the mapped path. See {#node}
-        def map_file(real_path,new_path,options = {})
-            make_node(new_path).init_file(real_path,options)
-        end
-        alias :mapFile :map_file
-
-        # Retrieve in memory node for a mapped path
-        #
-        # @param [String] path
-        # @return [MNode] in memory node at path
-        # @return nil if path does not exist in the filesystem
-        def node(path)
-            path_components = scan_path(path)
-
-            #not actually injecting anything here, we're just following the hash of hashes...
-            path_components.inject(@root) { |dir,file|
-                break unless dir.files[file]
-                dir.files[file]
-            }
-        end
-
-        # Takes a mapped file name and returns the original real_path
-        def unmap(path)
-            node = node(path)
-            (node && node.file?) ? node.real_path : nil
-        end
-
-        # Deletes files and directories.
-        # Yields each {#node} in the filesystem and deletes it if the block returns true
-        #
-        # Useful if your filesystem is periodically remapping the entire contents and you need
-        # to delete entries that have not been touched in the latest scan
-        #
-        # @yieldparam [Hash] filesystem node
-        # @yieldreturn [true,false] should this node be deleted
-        def cleanup(&block)
-           recursive_cleanup(@root,&block)
-        end
-
-
-        # @!visibility private
-        def directory?(path)
-            possible_dir = node(path)
-            possible_dir && possible_dir.directory?
-        end
-
-        # @!visibility private
-        def contents(path)
-            node(path).files.keys
-        end
-
-        # @!visibility private
-        def file?(path)
-            filename = unmap(path)
-            filename && File.file?(filename)
-        end
-
-        # @!visibility private
-        # only called if option :raw_reads is not set
-        def read_file(path)
-            IO.read(unmap(path))
-        end
-
-        # @!visibility private
-        # We can only write to existing files
-        # because otherwise we don't have anything to back it
-        def can_write?(path)
-            @allow_write && file?(path)
-        end
-
-        # Note we don't impleemnt can_mkdir? so this can
-        # only be called by code. Really only useful to
-        # create empty directories
-        def mkdir(path,options = {})
-            make_node(path).init_dir(options)
-        end
-
-        # @!visibility private
-        def write_to(path,contents)
-            node = node(path)
-            File.open(node.real_path,"w") { |f| f.print(contents) }
-            node.updated
-        end
-
-        # @!visibility private
-        def size(path)
-            File.size(unmap(path))
-        end
-
-        # @!visibility private
-        def times(path)
-            realpath = unmap(path)
-            if (realpath)
-                stat = File.stat(realpath)
-                return [ stat.atime, stat.mtime, stat.ctime ]
-            else
-                # We're a directory
-                return [0,0,0]
-            end
-        end
-
-        # @!visibility private
-        def xattr(path)
-            result = node(path).xattr
-        end
-
-        # @!visibility private
-        # Will create, store and return a File object for the underlying file
-        # for subsequent use with the raw_read/raw_close methods
-        # expects file? to return true before this method is called
-        def raw_open(path,mode,rfusefs = nil)
-
-            return false unless @use_raw_file_access
-
-            return false if mode.include?("w") && (!@allow_write)
-
-            @openfiles ||= Hash.new() unless rfusefs
-
-            real_path = unmap(path)
-
-            unless real_path
-                if rfusefs
-                    raise Errno::ENOENT.new(path)
-                else
-                    #fusefs will go on to call file?
-                    return false
-                end
-            end
-
-            file =  File.new(real_path,PathMapperFS.open_mode(mode))
-
-            @openfiles[path] = file unless rfusefs
-
-            return file
-        end
-
-        # @!visibility private
-        def raw_read(path,off,sz,file=nil)
-            file = @openfiles[path] unless file
-            file.sysseek(off)
-            file.sysread(sz)
-        end
-
-        # @!visibility private
-        def raw_write(path,offset,sz,buf,file=nil)
-            file = @openfiles[path] unless file
-            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)
-            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
-
-        end
-
-        # @!visibility private
-        def statistics(path)
-            @stats.to_statistics
-        end
-
-        private
-
-        def make_node(path)
-            #split path into components
-            components = path.to_s.scan(/[^\/]+/)
-            components.inject(@root) { |parent_dir, file|
-                parent_dir.files[file] ||= MNode.new(parent_dir,@stats)
-            }
-        end
-
-        def recursive_cleanup(dir_node,&block)
-            dir_node.files.delete_if do |path,child|
-                del = if child.file?
-                    yield child
-                else
-                    recursive_cleanup(child,&block)
-                    child.files.size == 0
-                end
-                child.deleted if del
-                del
-            end
-        end
-    end
-
-end
-