tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/cal_dav/principal.rb

@@ -0,0 +1,12 @@
+module Tilia
+  module CalDav
+    module Principal
+      require 'tilia/cal_dav/principal/collection'
+      require 'tilia/cal_dav/principal/i_proxy_read'
+      require 'tilia/cal_dav/principal/i_proxy_write'
+      require 'tilia/cal_dav/principal/proxy_read'
+      require 'tilia/cal_dav/principal/proxy_write'
+      require 'tilia/cal_dav/principal/user'
+    end
+  end
+end

data/lib/tilia/cal_dav/principal/collection.rb

@@ -0,0 +1,21 @@
+module Tilia
+  module CalDav
+    module Principal
+      # Principal collection
+      #
+      # This is an alternative collection to the standard ACL principal collection.
+      # This collection adds support for the calendar-proxy-read and
+      # calendar-proxy-write sub-principals, as defined by the caldav-proxy
+      # specification.
+      class Collection < DavAcl::PrincipalCollection
+        # Returns a child object based on principal information
+        #
+        # @param array principal_info
+        # @return User
+        def child_for_principal(principal_info)
+          User.new(@principal_backend, principal_info)
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/principal/i_proxy_read.rb

@@ -0,0 +1,13 @@
+module Tilia
+  module CalDav
+    module Principal
+      # ProxyRead principal interface
+      #
+      # Any principal node implementing this interface will be picked up as a 'proxy
+      # principal group'.
+      module IProxyRead
+        include DavAcl::IPrincipal
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/principal/i_proxy_write.rb

@@ -0,0 +1,13 @@
+module Tilia
+  module CalDav
+    module Principal
+      # ProxyWrite principal interface
+      #
+      # Any principal node implementing this interface will be picked up as a 'proxy
+      # principal group'.
+      module IProxyWrite
+        include DavAcl::IPrincipal
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/principal/proxy_read.rb

@@ -0,0 +1,127 @@
+module Tilia
+  module CalDav
+    module Principal
+      # ProxyRead principal
+      #
+      # This class represents a principal group, hosted under the main principal.
+      # This is needed to implement 'Calendar delegation' support. This class is
+      # instantiated by User.
+      class ProxyRead
+        include IProxyRead
+
+        # @!attribute [r] principal_info
+        #   @!visibility private
+        #   Principal information from the parent principal.
+        #
+        #   @var array
+
+        # @!attribute [r] principal_backend
+        #   @!visibility private
+        #   Principal backend
+        #
+        #   @var DAVACL\PrincipalBackend\BackendInterface
+
+        # Creates the object.
+        #
+        # Note that you MUST supply the parent principal information.
+        #
+        # @param DAVACL\PrincipalBackend\BackendInterface principal_backend
+        # @param array principal_info
+        def initialize(principal_backend, principal_info)
+          @principal_info = principal_info
+          @principal_backend = principal_backend
+        end
+
+        # Returns this principals name.
+        #
+        # @return string
+        def name
+          'calendar-proxy-read'
+        end
+
+        # Returns the last modification time
+        #
+        # @return null
+        def last_modified
+          nil
+        end
+
+        # Deletes the current node
+        #
+        # @throws DAV\Exception\Forbidden
+        # @return void
+        def delete
+          fail Dav::Exception::Forbidden, 'Permission denied to delete node'
+        end
+
+        # Renames the node
+        #
+        # @throws DAV\Exception\Forbidden
+        # @param string name The new name
+        # @return void
+        def name=(_name)
+          fail Dav::Exception::Forbidden, 'Permission denied to rename file'
+        end
+
+        # Returns a list of alternative urls for a principal
+        #
+        # This can for example be an email address, or ldap url.
+        #
+        # @return array
+        def alternate_uri_set
+          []
+        end
+
+        # Returns the full principal url
+        #
+        # @return string
+        def principal_url
+          @principal_info['uri'] + '/' + name
+        end
+
+        # Returns the list of group members
+        #
+        # If this principal is a group, this function should return
+        # all member principal uri's for the group.
+        #
+        # @return array
+        def group_member_set
+          @principal_backend.group_member_set(principal_url)
+        end
+
+        # Returns the list of groups this principal is member of
+        #
+        # If this principal is a member of a (list of) groups, this function
+        # should return a list of principal uri's for it's members.
+        #
+        # @return array
+        def group_membership
+          @principal_backend.group_membership(principal_url)
+        end
+
+        # Sets a list of group members
+        #
+        # If this principal is a group, this method sets all the group members.
+        # The list of members is always overwritten, never appended to.
+        #
+        # This method should throw an exception if the members could not be set.
+        #
+        # @param array principals
+        # @return void
+        def group_member_set=(principals)
+          @principal_backend.update_group_member_set(principal_url, principals)
+        end
+
+        # Returns the displayname
+        #
+        # This should be a human readable name for the principal.
+        # If none is available, return the nodename.
+        #
+        # @return string
+        def display_name
+          name
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/principal/proxy_write.rb

@@ -0,0 +1,127 @@
+module Tilia
+  module CalDav
+    module Principal
+      # ProxyWrite principal
+      #
+      # This class represents a principal group, hosted under the main principal.
+      # This is needed to implement 'Calendar delegation' support. This class is
+      # instantiated by User.
+      class ProxyWrite
+        include IProxyWrite
+
+        # @!attribute [r] principal_info
+        #   @!visibility private
+        #   Parent principal information
+        #
+        #   @var array
+
+        # @!attribute [r] principal_backend
+        #   @!visibility private
+        #   Principal Backend
+        #
+        #   @var DAVACL\PrincipalBackend\BackendInterface
+
+        # Creates the object
+        #
+        # Note that you MUST supply the parent principal information.
+        #
+        # @param DAVACL\PrincipalBackend\BackendInterface principal_backend
+        # @param array principal_info
+        def initialize(principal_backend, principal_info)
+          @principal_info = principal_info
+          @principal_backend = principal_backend
+        end
+
+        # Returns this principals name.
+        #
+        # @return string
+        def name
+          'calendar-proxy-write'
+        end
+
+        # Returns the last modification time
+        #
+        # @return null
+        def last_modified
+          nil
+        end
+
+        # Deletes the current node
+        #
+        # @throws DAV\Exception\Forbidden
+        # @return void
+        def delete
+          fail Dav::Exception::Forbidden, 'Permission denied to delete node'
+        end
+
+        # Renames the node
+        #
+        # @throws DAV\Exception\Forbidden
+        # @param string name The new name
+        # @return void
+        def name=(_name)
+          fail Dav::Exception::Forbidden, 'Permission denied to rename file'
+        end
+
+        # Returns a list of alternative urls for a principal
+        #
+        # This can for example be an email address, or ldap url.
+        #
+        # @return array
+        def alternate_uri_set
+          []
+        end
+
+        # Returns the full principal url
+        #
+        # @return string
+        def principal_url
+          @principal_info['uri'] + '/' + name
+        end
+
+        # Returns the list of group members
+        #
+        # If this principal is a group, this function should return
+        # all member principal uri's for the group.
+        #
+        # @return array
+        def group_member_set
+          @principal_backend.group_member_set(principal_url)
+        end
+
+        # Returns the list of groups this principal is member of
+        #
+        # If this principal is a member of a (list of) groups, this function
+        # should return a list of principal uri's for it's members.
+        #
+        # @return array
+        def group_membership
+          @principal_backend.group_membership(principal_url)
+        end
+
+        # Sets a list of group members
+        #
+        # If this principal is a group, this method sets all the group members.
+        # The list of members is always overwritten, never appended to.
+        #
+        # This method should throw an exception if the members could not be set.
+        #
+        # @param array principals
+        # @return void
+        def group_member_set=(principals)
+          @principal_backend.update_group_member_set(principal_url, principals)
+        end
+
+        # Returns the displayname
+        #
+        # This should be a human readable name for the principal.
+        # If none is available, return the nodename.
+        #
+        # @return string
+        def display_name
+          name
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/principal/user.rb

@@ -0,0 +1,96 @@
+module Tilia
+  module CalDav
+    module Principal
+      # CalDAV principal
+      #
+      # This is a standard user-principal for CalDAV. This principal is also a
+      # collection and returns the caldav-proxy-read and caldav-proxy-write child
+      # principals.
+      class User < DavAcl::Principal
+        include Dav::ICollection
+
+        # Creates a new file in the directory
+        #
+        # @param string name Name of the file
+        # @param resource data Initial payload, passed as a readable stream resource.
+        # @throws DAV\Exception\Forbidden
+        # @return void
+        def create_file(name, _data = nil)
+          fail Dav::Exception::Forbidden, "Permission denied to create file (filename #{name})"
+        end
+
+        # Creates a new subdirectory
+        #
+        # @param string name
+        # @throws DAV\Exception\Forbidden
+        # @return void
+        def create_directory(_name)
+          fail Dav::Exception::Forbidden, 'Permission denied to create directory'
+        end
+
+        # Returns a specific child node, referenced by its name
+        #
+        # @param string name
+        # @return DAV\INode
+        def child(name)
+          principal = @principal_backend.principal_by_path(principal_url + '/' + name)
+
+          fail Dav::Exception::NotFound, "Node with name #{name} was not found" unless principal
+
+          return ProxyRead.new(@principal_backend, @principal_properties) if name == 'calendar-proxy-read'
+          return ProxyWrite.new(@principal_backend, @principal_properties) if name == 'calendar-proxy-write'
+
+          fail Dav::Exception::NotFound, "Node with name #{name} was not found"
+        end
+
+        # Returns an array with all the child nodes
+        #
+        # @return DAV\INode[]
+        def children
+          r = []
+
+          r << ProxyRead.new(@principal_backend, @principal_properties) if @principal_backend.principal_by_path(principal_url + '/calendar-proxy-read')
+          r << ProxyWrite.new(@principal_backend, @principal_properties) if @principal_backend.principal_by_path(principal_url + '/calendar-proxy-write')
+
+          r
+        end
+
+        # Returns whether or not the child node exists
+        #
+        # @param string name
+        # @return bool
+        def child_exists(name)
+          child(name)
+          return true
+        rescue Dav::Exception::NotFound
+          return false
+        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
+          acl = super
+          acl << {
+            'privilege' => '{DAV:}read',
+            'principal' => @principal_properties['uri'] + '/calendar-proxy-read',
+            'protected' => true
+          }
+          acl << {
+            'privilege' => '{DAV:}read',
+            'principal' => @principal_properties['uri'] + '/calendar-proxy-write',
+            'protected' => true
+          }
+          acl
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/schedule.rb

@@ -0,0 +1,14 @@
+module Tilia
+  module CalDav
+    module Schedule
+      require 'tilia/cal_dav/schedule/i_inbox'
+      require 'tilia/cal_dav/schedule/i_mip_plugin'
+      require 'tilia/cal_dav/schedule/inbox'
+      require 'tilia/cal_dav/schedule/i_outbox'
+      require 'tilia/cal_dav/schedule/i_scheduling_object'
+      require 'tilia/cal_dav/schedule/outbox'
+      require 'tilia/cal_dav/schedule/plugin'
+      require 'tilia/cal_dav/schedule/scheduling_object'
+    end
+  end
+end

data/lib/tilia/cal_dav/schedule/i_inbox.rb

@@ -0,0 +1,12 @@
+module Tilia
+  module CalDav
+    module Schedule
+      # Implement this interface to have a node be recognized as a CalDAV scheduling
+      # inbox.
+      module IInbox
+        include ICalendarObjectContainer
+        include DavAcl::IAcl
+      end
+    end
+  end
+end