tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/dav_acl/exception/need_privileges.rb

@@ -0,0 +1,65 @@
+module Tilia
+  module DavAcl
+    module Exception
+      # NeedPrivileges
+      #
+      # The 403-need privileges is thrown when a user didn't have the appropriate
+      # permissions to perform an operation
+      class NeedPrivileges < Dav::Exception::Forbidden
+        protected
+
+        # The relevant uri
+        #
+        # @var string
+        attr_accessor :uri
+
+        # The privileges the user didn't have.
+        #
+        # @var array
+        attr_accessor :privileges
+
+        public
+
+        # Constructor
+        #
+        # @param string uri
+        # @param array privileges
+        def initialize(uri, privileges)
+          @uri = uri
+          @privileges = privileges
+        end
+
+        # TODO: document
+        def to_s
+          "User did not have the required privileges (#{@privileges.join(', ')}) for path \"#{@uri}\""
+        end
+
+        # Adds in extra information in the xml response.
+        #
+        # This method adds the {DAV:}need-privileges element as defined in rfc3744
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(server, error_node)
+          error = LibXML::XML::Node.new('d:need-privileges')
+          error_node << error
+
+          @privileges.each do |privilege|
+            resource = LibXML::XML::Node.new('d:resource')
+            error << resource
+
+            href = LibXML::XML::Node.new('d:href', "#{server.base_uri}#{@uri}")
+            resource << href
+
+            priv = LibXML::XML::Node.new('d:privilege')
+            resource << priv
+
+            privilege_parts = /^{([^}]*)}(.*)$/.match(privilege)
+            priv << LibXML::XML::Node.new("d:#{privilege_parts[2]}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav_acl/exception/no_abstract.rb

@@ -0,0 +1,21 @@
+module Tilia
+  module DavAcl
+    module Exception
+      # This exception is thrown when a user tries to set a privilege that's marked
+      # as abstract.
+      class NoAbstract < Dav::Exception::PreconditionFailed
+        # Adds in extra information in the xml response.
+        #
+        # This method adds the {DAV:}no-ace-conflict element as defined in rfc3744
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          error = LibXML::XML::Node.new('d:no-abstract')
+          error_node << error
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav_acl/exception/not_recognized_principal.rb

@@ -0,0 +1,21 @@
+module Tilia
+  module DavAcl
+    module Exception
+      # If a client tried to set a privilege assigned to a non-existant principal,
+      # this exception will be thrown.
+      class NotRecognizedPrincipal < Dav::Exception::PreconditionFailed
+        # Adds in extra information in the xml response.
+        #
+        # This method adds the {DAV:}no-ace-conflict element as defined in rfc3744
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          error = LibXML::XML::Node.new('d:recognized-principal')
+          error_node << error
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav_acl/exception/not_supported_privilege.rb

@@ -0,0 +1,21 @@
+module Tilia
+  module DavAcl
+    module Exception
+      # If a client tried to set a privilege that doesn't exist, this exception will
+      # be thrown.
+      class NotSupportedPrivilege < Dav::Exception::PreconditionFailed
+        # Adds in extra information in the xml response.
+        #
+        # This method adds the {DAV:}no-ace-conflict element as defined in rfc3744
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          error = LibXML::XML::Node.new('d:not-supported-privilege')
+          error_node << error
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav_acl/fs.rb

@@ -0,0 +1,9 @@
+module Tilia
+  module DavAcl
+    module Fs
+      require 'tilia/dav_acl/fs/collection'
+      require 'tilia/dav_acl/fs/file'
+      require 'tilia/dav_acl/fs/home_collection'
+    end
+  end
+end

data/lib/tilia/dav_acl/fs/collection.rb

@@ -0,0 +1,108 @@
+module Tilia
+  module DavAcl
+    module Fs
+      # This is an ACL-enabled collection.
+      class Collection < Dav::FsExt::Directory
+        include IAcl
+
+        protected
+
+        # A list of ACL rules.
+        #
+        # @var array
+        attr_accessor :acl
+
+        # Owner uri, or null for no owner.
+        #
+        # @var string|null
+        attr_accessor :owner
+
+        public
+
+        # Constructor
+        #
+        # @param string path on-disk path.
+        # @param array acl ACL rules.
+        # @param string|null owner principal owner string.
+        def initialize(path, acl, owner = nil)
+          super(path)
+          @acl = acl
+          @owner = owner
+        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}"
+
+          fail Dav::Exception::NotFound, 'File could not be located' unless ::File.exist?(path)
+          fail Dav::Exception::Forbidden, 'Permission denied to . and ..' if name == '.' || name == '..'
+
+          if ::File.directory?(path)
+            return Collection.new(path, @acl.deep_dup, @owner)
+          else
+            return File.new(path, @acl.deep_dup, @owner)
+          end
+        end
+
+        # Returns the owner principal
+        #
+        # This must be a url to a principal, or null if there's no owner
+        #
+        # @return string|null
+        attr_reader :owner
+
+        # Returns a group principal
+        #
+        # This must be a url to a principal, or null if there's no owner
+        #
+        # @return string|null
+        def group
+          nil
+        end
+
+        # Returns a list of ACE's for this node.
+        #
+        # Each ACE has the following properties:
+        #   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
+        #     currently the only supported privileges
+        #   * 'principal', a url to the principal who owns the node
+        #   * 'protected' (optional), indicating that this ACE is not allowed to
+        #      be updated.
+        #
+        # @return array
+        attr_reader :acl
+
+        # Updates the ACL
+        #
+        # This method will receive a list of new ACE's as an array argument.
+        #
+        # @param array acl
+        # @return void
+        def acl=(_acl)
+          fail Dav::Exception::Forbidden, 'Setting ACL is not allowed here'
+        end
+
+        # Returns the list of supported privileges for this node.
+        #
+        # The returned data structure is a list of nested privileges.
+        # See Tilia::DavAcl::Plugin::getDefaultSupportedPrivilegeSet for a simple
+        # standard structure.
+        #
+        # If null is returned from this method, the default privilege set is used,
+        # which is fine for most common usecases.
+        #
+        # @return array|null
+        def supported_privilege_set
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+module Tilia
+  module DavAcl
+    module Fs
+      # This is an ACL-enabled file node.
+      class File < Dav::FsExt::File
+        include IAcl
+
+        protected
+
+        # A list of ACL rules.
+        #
+        # @var array
+        attr_accessor :acl
+
+        # Owner uri, or null for no owner.
+        #
+        # @var string|null
+        attr_accessor :owner
+
+        public
+
+        # Constructor
+        #
+        # @param string path on-disk path.
+        # @param array acl ACL rules.
+        # @param string|null owner principal owner string.
+        def initialize(path, acl, owner = nil)
+          super(path)
+          @acl = acl
+          @owner = owner
+        end
+
+        # Returns the owner principal
+        #
+        # This must be a url to a principal, or null if there's no owner
+        #
+        # @return string|null
+        attr_reader :owner
+
+        # Returns a group principal
+        #
+        # This must be a url to a principal, or null if there's no owner
+        #
+        # @return string|null
+        def group
+          nil
+        end
+
+        # Returns a list of ACE's for this node.
+        #
+        # Each ACE has the following properties:
+        #   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
+        #     currently the only supported privileges
+        #   * 'principal', a url to the principal who owns the node
+        #   * 'protected' (optional), indicating that this ACE is not allowed to
+        #      be updated.
+        #
+        # @return array
+        attr_reader :acl
+
+        # Updates the ACL
+        #
+        # This method will receive a list of new ACE's as an array argument.
+        #
+        # @param array acl
+        # @return void
+        def acl=(_acl)
+          fail Dav::Exception::Forbidden, 'Setting ACL is not allowed here'
+        end
+
+        # Returns the list of supported privileges for this node.
+        #
+        # The returned data structure is a list of nested privileges.
+        # See Tilia::DavAcl::Plugin::getDefaultSupportedPrivilegeSet for a simple
+        # standard structure.
+        #
+        # If null is returned from this method, the default privilege set is used,
+        # which is fine for most common usecases.
+        #
+        # @return array|null
+        def supported_privilege_set
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav_acl/fs/home_collection.rb

@@ -0,0 +1,148 @@
+require 'fileutils'
+
+module Tilia
+  module DavAcl
+    module Fs
+      # This collection contains a collection for every principal.
+      # It is similar to /home on many unix systems.
+      #
+      # The per-user collections can only be accessed by the user who owns the
+      # collection.
+      class HomeCollection < AbstractPrincipalCollection
+        include IAcl
+
+        # Name of this collection.
+        #
+        # @var string
+        attr_accessor :collection_name
+
+        protected
+
+        # Path to where the users' files are actually stored.
+        #
+        # @var string
+        attr_accessor :storage_path
+
+        public
+
+        # Creates the home collection.
+        #
+        # @param BackendInterface principal_backend
+        # @param string storage_path Where the actual files are stored.
+        # @param string principal_prefix list of principals to iterate.
+        def initialize(principal_backend, storage_path, principal_prefix = 'principals')
+          @collection_name = 'home'
+          super(principal_backend, principal_prefix)
+          @storage_path = storage_path
+        end
+
+        # Returns the name of the node.
+        #
+        # This is used to generate the url.
+        #
+        # @return string
+        def name
+          @collection_name
+        end
+
+        # Returns a principals' collection of files.
+        #
+        # The passed array contains principal information, and is guaranteed to
+        # at least contain a uri item. Other properties may or may not be
+        # supplied by the authentication backend.
+        #
+        # @param array principal_info
+        # @return void
+        def child_for_principal(principal_info)
+          owner = principal_info['uri']
+          acl = [
+            {
+              'privilege' => '{DAV:}read',
+              'principal' => owner,
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}write',
+              'principal' => owner,
+              'protected' => true
+            }
+          ]
+
+          principal_base_name = Uri.split(owner)[1]
+
+          path = "#{@storage_path}/#{principal_base_name}"
+
+          FileUtils.mkdir_p(path) unless ::File.directory?(path)
+
+          Collection.new(
+            path,
+            acl,
+            owner
+          )
+        end
+
+        # Returns the owner principal
+        #
+        # This must be a url to a principal, or null if there's no owner
+        #
+        # @return string|null
+        def owner
+          nil
+        end
+
+        # Returns a group principal
+        #
+        # This must be a url to a principal, or null if there's no owner
+        #
+        # @return string|null
+        def group
+          nil
+        end
+
+        # Returns a list of ACE's for this node.
+        #
+        # Each ACE has the following properties:
+        #   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
+        #     currently the only supported privileges
+        #   * 'principal', a url to the principal who owns the node
+        #   * 'protected' (optional), indicating that this ACE is not allowed to
+        #      be updated.
+        #
+        # @return array
+        def acl
+          [
+            {
+              'principal' => '{DAV:}authenticated',
+              'privilege' => '{DAV:}read',
+              'protected' => true
+            }
+          ]
+        end
+
+        # Updates the ACL
+        #
+        # This method will receive a list of new ACE's as an array argument.
+        #
+        # @param array acl
+        # @return void
+        def acl=(_acl)
+          fail Dav::Exception::Forbidden, 'Setting ACL is not allowed here'
+        end
+
+        # Returns the list of supported privileges for this node.
+        #
+        # The returned data structure is a list of nested privileges.
+        # See Tilia::DavAcl::Plugin::getDefaultSupportedPrivilegeSet for a simple
+        # standard structure.
+        #
+        # If null is returned from this method, the default privilege set is used,
+        # which is fine for most common usecases.
+        #
+        # @return array|null
+        def supported_privilege_set
+          nil
+        end
+      end
+    end
+  end
+end