tilia-dav 3.1.0.pre.alpha2

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

@@ -0,0 +1,118 @@
+module Tilia
+  module Dav
+    module FsExt
+      # File class
+      class File < Fs::Node
+        include PartialUpdate::IPatchSupport
+
+        # Updates the data
+        #
+        # Data is a readable stream resource.
+        #
+        # @param resource|string data
+        # @return string
+        def put(data)
+          ::File.open(@path, 'w') do |file|
+            if data.is_a?(String)
+              file.write(data.to_s)
+            else
+              ::File.copy_stream(data, file)
+            end
+          end
+          etag
+        end
+
+        # Updates the file based on a range specification.
+        #
+        # The first argument is the data, which is either a readable stream
+        # resource or a string.
+        #
+        # The second argument is the type of update we're doing.
+        # This is either:
+        # * 1. append
+        # * 2. update based on a start byte
+        # * 3. update based on an end byte
+        #
+        # The third argument is the start or end byte.
+        #
+        # After a successful put operation, you may choose to return an ETag. The
+        # ETAG must always be surrounded by double-quotes. These quotes must
+        # appear in the actual string you're returning.
+        #
+        # Clients may use the ETag from a PUT request to later on make sure that
+        # when they update the file, the contents haven't changed in the mean
+        # time.
+        #
+        # @param resource|string data
+        # @param int range_type
+        # @param int offset
+        # @return string|null
+        def patch(data, range_type, offset = nil)
+          case range_type
+          when 1
+            f = ::File.open(@path, 'a')
+          when 2
+            f = ::File.open(@path, 'r+') # TODO: php 'c' vs. ruby 'w'?
+            f.seek(offset)
+          when 3
+            f = ::File.open(@path, 'r+')
+            f.seek(offset, IO::SEEK_END)
+          end
+
+          if data.is_a?(String)
+            f.write(data)
+          else
+            IO.copy_stream(data, f)
+          end
+
+          f.close
+
+          etag
+        end
+
+        # Returns the data
+        #
+        # @return resource
+        def get
+          ::File.open(@path, 'r')
+        end
+
+        # Delete the current file
+        #
+        # @return bool
+        def delete
+          ::File.unlink(@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 string|null
+        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 string|null
+        def content_type
+          nil
+        end
+
+        # Returns the size of the file, in bytes
+        #
+        # @return int
+        def size
+          ::File.size(@path)
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/i_collection.rb

@@ -0,0 +1,65 @@
+module Tilia
+  module Dav
+    # The ICollection Interface
+    #
+    # This interface should be implemented by each class that represents a collection
+    module ICollection
+      include INode
+
+      # 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 nil|string
+      def create_file(name, data = nil)
+      end
+
+      # Creates a new subdirectory
+      #
+      # @param string name
+      # @return void
+      def create_directory(name)
+      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
+      # @return DAV\INode
+      def child(name)
+      end
+
+      # Returns an array with all the child nodes
+      #
+      # @return DAV\INode[]
+      def children
+      end
+
+      # Checks if a child-node with the specified name exists
+      #
+      # @param string name
+      # @return bool
+      def child_exists(name)
+      end
+    end
+  end
+end

data/lib/tilia/dav/i_extended_collection.rb

@@ -0,0 +1,36 @@
+module Tilia
+  module Dav
+    # The IExtendedCollection interface.
+    #
+    # This interface can be used to create special-type of collection-resources
+    # as defined by RFC 5689.
+    module IExtendedCollection
+      include ICollection
+
+      # Creates a new collection.
+      #
+      # This method will receive a MkCol object with all the information about
+      # the new collection that's being created.
+      #
+      # The MkCol object contains information about the resourceType of the new
+      # collection. If you don't support the specified resourceType, you should
+      # throw Exception\InvalidResourceType.
+      #
+      # The object also contains a list of WebDAV properties for the new
+      # collection.
+      #
+      # You should call the handle() method on this object to specify exactly
+      # which properties you are storing. This allows the system to figure out
+      # exactly which properties you didn't store, which in turn allows other
+      # plugins (such as the propertystorage plugin) to handle storing the
+      # property for you.
+      #
+      # @param string name
+      # @param MkCol mkCol
+      # @throws Exception\InvalidResourceType
+      # @return void
+      def create_extended_collection(name, mkCol)
+      end
+    end
+  end
+end

data/lib/tilia/dav/i_file.rb

@@ -0,0 +1,70 @@
+module Tilia
+  module Dav
+    # This interface represents a file in the directory tree
+    #
+    # A file is a bit of a broad definition. In general it implies that on
+    # this specific node a PUT or GET method may be performed, to either update,
+    # or retrieve the contents of the file.
+    module IFile
+      include INode
+
+      # Replaces the contents of the file.
+      #
+      # The data argument is a readable stream resource.
+      #
+      # After a succesful put operation, you may choose to return an ETag. The
+      # etag must always be surrounded by double-quotes. These quotes must
+      # appear in the actual string you're returning.
+      #
+      # Clients may use the ETag from a PUT request to later on make sure that
+      # when they update the file, the contents haven't changed in the mean
+      # time.
+      #
+      # If you don't plan to store the file byte-by-byte, and you return a
+      # different object on a subsequent GET you are strongly recommended to not
+      # return an ETag, and just return null.
+      #
+      # @param resource data
+      # @return string|null
+      def put(data)
+      end
+
+      # Returns the data
+      #
+      # This method may either return a string or a readable stream resource
+      #
+      # @return mixed
+      def get
+      end
+
+      # Returns the mime-type for a file
+      #
+      # If null is returned, we'll assume application/octet-stream
+      #
+      # @return string|null
+      def content_type
+      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.
+      #
+      # Return null if the ETag can not effectively be determined.
+      #
+      # The ETag must be surrounded by double-quotes, so something like this
+      # would make a valid ETag:
+      #
+      #   return '"someetag"';
+      #
+      # @return string|null
+      def etag
+      end
+
+      # Returns the size of the node, in bytes
+      #
+      # @return int
+      def size
+      end
+    end
+  end
+end

data/lib/tilia/dav/i_move_target.rb

@@ -0,0 +1,37 @@
+module Tilia
+  module Dav
+    # By implementing this interface, a collection can effectively say "other
+    # nodes may be moved into this collection".
+    #
+    # The benefit of this, is that sabre/dav will by default perform a move, by
+    # tranfersing an entire directory tree, copying every collection, and deleting
+    # every item.
+    #
+    # If a backend supports a better optimized move operation, this can trigger
+    # some huge speed gains.
+    module IMoveTarget
+      include ICollection
+
+      # 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 targetName New local file/collection name.
+      # @param string sourcePath Full path to source node
+      # @param INode sourceNode Source node itself
+      # @return bool
+      def move_into(tarname, source_path, source_node)
+      end
+    end
+  end
+end

data/lib/tilia/dav/i_multi_get.rb

@@ -0,0 +1,29 @@
+module Tilia
+  module Dav
+    # IMultiGet
+    #
+    # This interface adds a tiny bit of functionality to collections.
+    #
+    # There a certain situations, in particular in relation to WebDAV-Sync, CalDAV
+    # and CardDAV, where information for a list of items will be requested.
+    #
+    # Because the getChild() call is the main abstraction method, this can in
+    # reality result in many database calls, which could potentially be
+    # optimized.
+    #
+    # The MultiGet interface is used by the server in these cases.
+    module IMultiGet
+      include ICollection
+
+      # This method receives a list of paths in it's first argument.
+      # It must return an array with Node objects.
+      #
+      # If any children are not found, you do not have to return them.
+      #
+      # @param string[] paths
+      # @return array
+      def multiple_children(paths)
+      end
+    end
+  end
+end

data/lib/tilia/dav/i_node.rb

@@ -0,0 +1,33 @@
+module Tilia
+  module Dav
+    # The INode interface is the base interface, and the parent class of both ICollection and IFile
+    module INode
+      # Deleted the current node
+      #
+      # @return void
+      def delete
+      end
+
+      # Returns the name of the node.
+      #
+      # This is used to generate the url.
+      #
+      # @return string
+      def name
+      end
+
+      # Renames the node
+      #
+      # @param string name The new name
+      # @return void
+      def name=(name)
+      end
+
+      # Returns the last modification time, as a unix timestamp
+      #
+      # @return int
+      def last_modified
+      end
+    end
+  end
+end

data/lib/tilia/dav/i_properties.rb

@@ -0,0 +1,39 @@
+module Tilia
+  module Dav
+    #  IProperties interface
+    #
+    #  Implement this interface to support custom WebDAV properties requested and sent from clients.
+    module IProperties
+      include INode
+
+      # Updates properties on this node.
+      #
+      # This method received a PropPatch object, which contains all the
+      # information about the update.
+      #
+      # To update specific properties, call the 'handle' method on this object.
+      # Read the PropPatch documentation for more information.
+      #
+      # @param PropPatch propPatch
+      # @return void
+      def prop_patch(prop_patch)
+      end
+
+      # Returns a list of properties for this nodes.
+      #
+      # The properties list is a list of propertynames the client requested,
+      # encoded in clark-notation {xmlnamespace}tagname
+      #
+      # If the array is empty, it means 'all properties' were requested.
+      #
+      # Note that it's fine to liberally give properties back, instead of
+      # conforming to the list of requested properties.
+      # The Server class will filter out the extra.
+      #
+      # @param array properties
+      # @return array
+      def properties(properties)
+      end
+    end
+  end
+end

data/lib/tilia/dav/i_quota.rb

@@ -0,0 +1,19 @@
+module Tilia
+  module Dav
+    # IQuota interface
+    #
+    # Implement this interface to add the ability to return quota information. The ObjectTree
+    # will check for quota information on any given node. If the information is not available it will
+    # attempt to fetch the information from the root node.
+    module IQuota
+      include ICollection
+
+      #  Returns the quota information
+      #
+      #  This method MUST return an array with 2 values, the first being the total used space,
+      #  the second the available space (in bytes)
+      def quota_info
+      end
+    end
+  end
+end