tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/dav/exception/report_not_supported.rb

@@ -0,0 +1,21 @@
+module Tilia
+  module Dav
+    class Exception
+      # ReportNotSupported
+      #
+      # This exception is thrown when the client requested an unknown report through
+      # the REPORT method
+      class ReportNotSupported < UnsupportedMediaType
+        # This method allows the exception to include additional information into the WebDAV error response
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          error = LibXML::XML::Node.new('d:supported-report')
+          error_node << error
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/requested_range_not_satisfiable.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # RequestedRangeNotSatisfiable
+      #
+      # This exception is normally thrown when the user
+      # request a range that is out of the entity bounds.
+      class RequestedRangeNotSatisfiable < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          416
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/service_unavailable.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # ServiceUnavailable
+      #
+      # This exception is thrown in case the service
+      # is currently not available (e.g. down for maintenance).
+      class ServiceUnavailable < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          503
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/too_many_matches.rb

@@ -0,0 +1,21 @@
+module Tilia
+  module Dav
+    class Exception
+      # TooManyMatches
+      #
+      # This exception is emited for the {DAV:}number-of-matches-within-limits
+      # post-condition, as defined in rfc6578, section 3.2.
+      class TooManyMatches < Forbidden
+        # This method allows the exception to include additional information into the WebDAV error response
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          error = LibXML::XML::Node.new('d:number-of-matches-within-limits')
+          error_node << error
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/unsupported_media_type.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # UnsupportedMediaType
+      #
+      # The 415 Unsupported Media Type status code is generally sent back when the client
+      # tried to call an HTTP method, with a body the server didn't understand
+      class UnsupportedMediaType < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          415
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/file.rb

@@ -0,0 +1,58 @@
+module Tilia
+  module Dav
+    # File class
+    #
+    # This is a helper class, that should aid in getting file classes setup.
+    # Most of its methods are implemented, and throw permission denied exceptions
+    class File < Node
+      include IFile
+
+      # Updates the data
+      #
+      # data is a readable stream resource.
+      #
+      # @param resource data
+      # @return void
+      def put(_data)
+        fail Exception::Forbidden, 'Permission denied to change data'
+      end
+
+      # Returns the data
+      #
+      # This method may either return a string or a readable stream resource
+      #
+      # @return mixed
+      def get
+        fail Exception::Forbidden, 'Permission denied to read this file'
+      end
+
+      # Returns the size of the file, in bytes.
+      #
+      # @return int
+      def size
+        0
+      end
+
+      # Returns the ETag for a file
+      #
+      # An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change.
+      # The ETag is an arbitrary string, but MUST be surrounded by double-quotes.
+      #
+      # Return null if the ETag can not effectively be determined
+      #
+      # @return string|null
+      def etag
+        nil
+      end
+
+      # Returns the mime-type for a file
+      #
+      # If null is returned, we'll assume application/octet-stream
+      #
+      # @return string|null
+      def content_type
+        nil
+      end
+    end
+  end
+end

data/lib/tilia/dav/fs.rb

@@ -0,0 +1,9 @@
+module Tilia
+  module Dav
+    module Fs
+      require 'tilia/dav/fs/node'
+      require 'tilia/dav/fs/directory'
+      require 'tilia/dav/fs/file'
+    end
+  end
+end

data/lib/tilia/dav/fs/directory.rb

@@ -0,0 +1,119 @@
+module Tilia
+  module Dav
+    module Fs
+      # Directory class
+      class Directory < Node
+        include ICollection
+        include IQuota
+
+        # Creates a new file in the directory
+        #
+        # Data will either be supplied as a stream resource, or in certain cases
+        # as a string. Keep in mind that you may have to support either.
+        #
+        # After successful creation of the file, you may choose to return the ETag
+        # of the new file here.
+        #
+        # The returned ETag must be surrounded by double-quotes (The quotes should
+        # be part of the actual string).
+        #
+        # If you cannot accurately determine the ETag, you should not return it.
+        # If you don't store the file exactly as-is (you're transforming it
+        # somehow) you should also not return an ETag.
+        #
+        # This means that if a subsequent GET to this new file does not exactly
+        # return the same contents of what was submitted here, you are strongly
+        # recommended to omit the ETag.
+        #
+        # @param string name Name of the file
+        # @param resource|string data Initial payload
+        # @return null|string
+        def create_file(name, data = nil)
+          new_path = @path + '/' + name
+          ::File.open(new_path, 'w') do |file|
+            if data.is_a?(String)
+              file.write(data)
+            else
+              IO.copy_stream(data, file)
+            end
+          end
+
+          nil
+        end
+
+        # Creates a new subdirectory
+        #
+        # @param string name
+        # @return void
+        def create_directory(name)
+          new_path = @path + '/' + name
+          ::Dir.mkdir(new_path)
+        end
+
+        # Returns a specific child node, referenced by its name
+        #
+        # This method must throw DAV\Exception\NotFound if the node does not
+        # exist.
+        #
+        # @param string name
+        # @throws DAV\Exception\NotFound
+        # @return DAV\INode
+        def child(name)
+          path = @path + '/' + name
+
+          unless ::File.exist?(path)
+            fail Exception::NotFound, "File with name #{path} could not be located"
+          end
+
+          if ::File.directory?(path)
+            Directory.new(path)
+          else
+            File.new(path)
+          end
+        end
+
+        # Returns an array with all the child nodes
+        #
+        # @return DAV\INode[]
+        def children
+          nodes = []
+          Dir.foreach(@path) do |entry|
+            next if entry == '.' || entry == '..'
+
+            nodes << child(entry)
+          end
+
+          nodes
+        end
+
+        # Checks if a child exists.
+        #
+        # @param string name
+        # @return bool
+        def child_exists(name)
+          new_path = @path + '/' + name
+          ::File.exist?(new_path)
+        end
+
+        # Deletes all files in this directory, and then itself
+        #
+        # @return void
+        def delete
+          children.each(&:delete)
+          ::Dir.rmdir(@path)
+        end
+
+        # Returns available diskspace information
+        #
+        # @return array
+        def quota_info
+          stat = Sys::Filesystem.stat(@path)
+          [
+            stat.blocks_available,
+            stat.blocks_free
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/fs/file.rb

@@ -0,0 +1,69 @@
+require 'digest'
+
+module Tilia
+  module Dav
+    module Fs
+      # File class
+      class File < Node
+        include IFile
+
+        # Updates the data
+        #
+        # @param resource|string data
+        # @return void
+        def put(data)
+          ::File.open(@path, 'w') do |file|
+            if data.is_a?(String)
+              file.write(data)
+            else
+              IO.copy_stream(data, file)
+            end
+          end
+        end
+
+        # Returns the data
+        #
+        # @return resource
+        def get
+          ::File.open(@path, 'r')
+        end
+
+        # Delete the current file
+        #
+        # @return void
+        def delete
+          ::File.unlink(@path)
+        end
+
+        # Returns the size of the node, in bytes
+        #
+        # @return int
+        def size
+          ::File.size(@path)
+        end
+
+        # Returns the ETag for a file
+        #
+        # An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change.
+        # The ETag is an arbitrary string, but MUST be surrounded by double-quotes.
+        #
+        # Return null if the ETag can not effectively be determined
+        #
+        # @return mixed
+        def etag
+          stat = ::File.stat(@path)
+          '"' + Digest::SHA1.hexdigest(stat.ino.to_s + stat.size.to_s + stat.mtime.to_s) + '"'
+        end
+
+        # Returns the mime-type for a file
+        #
+        # If null is returned, we'll assume application/octet-stream
+        #
+        # @return mixed
+        def content_type
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/fs/node.rb

@@ -0,0 +1,57 @@
+module Tilia
+  module Dav
+    module Fs
+      # Base node-class
+      #
+      # The node class implements the method used by both the File and the Directory classes
+      class Node
+        include INode
+
+        protected
+
+        # The path to the current node
+        #
+        # @var string
+        attr_accessor :path
+
+        public
+
+        # Sets up the node, expects a full path name
+        #
+        # @param string path
+        def initialize(path)
+          @path = path
+        end
+
+        # Returns the name of the node
+        #
+        # @return string
+        def name
+          (_, name) = Http::UrlUtil.split_path(@path)
+          name
+        end
+
+        # Renames the node
+        #
+        # @param string name The new name
+        # @return void
+        def name=(name)
+          parent_path = Http::UrlUtil.split_path(@path).first
+          new_name = Http::UrlUtil.split_path(name).second
+
+          new_path = parent_path + '/' + new_name
+          ::File.rename(@path, new_path)
+
+          @path = new_path
+        end
+
+        # Returns the last modification time, as a unix timestamp
+        #
+        # @return int
+        def last_modified
+          ::File.mtime(@path)
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/fs_ext.rb

@@ -0,0 +1,8 @@
+module Tilia
+  module Dav
+    module FsExt
+      require 'tilia/dav/fs_ext/directory'
+      require 'tilia/dav/fs_ext/file'
+    end
+  end
+end

data/lib/tilia/dav/fs_ext/directory.rb

@@ -0,0 +1,175 @@
+module Tilia
+  module Dav
+    module FsExt
+      # Directory class
+      class Directory < Fs::Node
+        include Dav::ICollection
+        include Dav::IQuota
+        include Dav::IMoveTarget
+
+        # Creates a new file in the directory
+        #
+        # Data will either be supplied as a stream resource, or in certain cases
+        # as a string. Keep in mind that you may have to support either.
+        #
+        # After successful creation of the file, you may choose to return the ETag
+        # of the new file here.
+        #
+        # The returned ETag must be surrounded by double-quotes (The quotes should
+        # be part of the actual string).
+        #
+        # If you cannot accurately determine the ETag, you should not return it.
+        # If you don't store the file exactly as-is (you're transforming it
+        # somehow) you should also not return an ETag.
+        #
+        # This means that if a subsequent GET to this new file does not exactly
+        # return the same contents of what was submitted here, you are strongly
+        # recommended to omit the ETag.
+        #
+        # @param string name Name of the file
+        # @param resource|string data Initial payload
+        # @return null|string
+        def create_file(name, data = nil)
+          # We're not allowing dots
+          fail Exception::Forbidden, 'Permission denied to . and ..' if name == '.' || name == '..'
+
+          new_path = @path + '/' + name
+
+          ::File.open(new_path, 'w') do |file|
+            if data.is_a?(String)
+              file.write(data)
+            else
+              IO.copy_stream(data, file)
+            end
+          end
+
+          stat = ::File.stat(new_path)
+          '"' + Digest::SHA1.hexdigest(stat.ino.to_s + stat.size.to_s + stat.mtime.to_s) + '"'
+        end
+
+        # Creates a new subdirectory
+        #
+        # @param string name
+        # @return void
+        def create_directory(name)
+          # We're not allowing dots
+          fail Exception::Forbidden, 'Permission denied to . and ..' if name == '.' || name == '..'
+
+          new_path = @path + '/' + name
+          ::Dir.mkdir(new_path)
+        end
+
+        # Returns a specific child node, referenced by its name
+        #
+        # This method must throw Sabre\DAV\Exception\NotFound if the node does not
+        # exist.
+        #
+        # @param string name
+        # @throws DAV\Exception\NotFound
+        # @return DAV\INode
+        def child(name)
+          path = @path + '/' + name
+
+          unless ::File.exist?(path)
+            fail Exception::NotFound, "File with name #{path} could not be located"
+          end
+          fail Exception::Forbidden, 'Permission denied to . and ..' if name == '.' || name == '..'
+
+          if ::File.directory?(path)
+            Directory.new(path)
+          else
+            File.new(path)
+          end
+        end
+
+        # Checks if a child exists.
+        #
+        # @param string name
+        # @return bool
+        def child_exists(name)
+          fail Exception::Forbidden, 'Permission denied to . and ..' if name == '.' || name == '..'
+
+          path = @path + '/' + name
+          ::File.exist?(path)
+        end
+
+        # Returns an array with all the child nodes
+        #
+        # @return DAV\INode[]
+        def children
+          nodes = []
+          Dir.foreach(@path) do |entry|
+            next if entry == '.' || entry == '..'
+            next if entry == '.sabredav'
+
+            nodes << child(entry)
+          end
+
+          nodes
+        end
+
+        # Deletes all files in this directory, and then itself
+        #
+        # @return bool
+        def delete
+          # Deleting all children
+          children.each(&:delete)
+
+          # Removing resource info, if its still around
+          if ::File.exist?(@path + '/.sabredav')
+            ::File.unlink(@path + '/.sabredav')
+          end
+
+          # Removing the directory itself
+          ::Dir.rmdir(@path)
+
+          true
+        end
+
+        # Returns available diskspace information
+        #
+        # @return array
+        def quota_info
+          stat = Sys::Filesystem.stat(@path)
+          [
+            stat.blocks_available,
+            stat.blocks_free
+          ]
+        end
+
+        # Moves a node into this collection.
+        #
+        # It is up to the implementors to:
+        #   1. Create the new resource.
+        #   2. Remove the old resource.
+        #   3. Transfer any properties or other data.
+        #
+        # Generally you should make very sure that your collection can easily move
+        # the move.
+        #
+        # If you don't, just return false, which will trigger sabre/dav to handle
+        # the move itself. If you return true from this function, the assumption
+        # is that the move was successful.
+        #
+        # @param string target_name New local file/collection name.
+        # @param string source_path Full path to source node
+        # @param DAV\INode source_node Source node itself
+        # @return bool
+        def move_into(target_name, _source_path, source_node)
+          # We only support FSExt\Directory or FSExt\File objects, so
+          # anything else we want to quickly reject.
+          if !source_node.is_a?(self.class) && !source_node.is_a?(File)
+            return false
+          end
+
+          # PHP allows us to access protected properties from other objects, as
+          # long as they are defined in a class that has a shared inheritence
+          # with the current class.
+          ::File.rename(source_node.path, @path + '/' + target_name)
+
+          true
+        end
+      end
+    end
+  end
+end