tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/cal_dav/subscriptions.rb

@@ -0,0 +1,9 @@
+module Tilia
+  module CalDav
+    module Subscriptions
+      require 'tilia/cal_dav/subscriptions/i_subscription'
+      require 'tilia/cal_dav/subscriptions/plugin'
+      require 'tilia/cal_dav/subscriptions/subscription'
+    end
+  end
+end

data/lib/tilia/cal_dav/subscriptions/i_subscription.rb

@@ -0,0 +1,37 @@
+module Tilia
+  module CalDav
+    module Subscriptions
+      # ISubscription
+      #
+      # Nodes implementing this interface represent calendar subscriptions.
+      #
+      # The subscription node doesn't do much, other than returning and updating
+      # subscription-related properties.
+      #
+      # The following properties should be supported:
+      #
+      # 1. {DAV:}displayname
+      # 2. {http://apple.com/ns/ical/}refreshrate
+      # 3. {http://calendarserver.org/ns/}subscribed-strip-todos (omit if todos
+      #    should not be stripped).
+      # 4. {http://calendarserver.org/ns/}subscribed-strip-alarms (omit if alarms
+      #    should not be stripped).
+      # 5. {http://calendarserver.org/ns/}subscribed-strip-attachments (omit if
+      #    attachments should not be stripped).
+      # 6. {http://calendarserver.org/ns/}source (Must be a
+      #     Sabre\DAV\Property\Href).
+      # 7. {http://apple.com/ns/ical/}calendar-color
+      # 8. {http://apple.com/ns/ical/}calendar-order
+      #
+      # It is recommended to support every property.
+      #
+      # @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
+      # @author Evert Pot (http://evertpot.com/)
+      # @license http://sabre.io/license/ Modified BSD License
+      module ISubscription
+        include Dav::ICollection
+        include Dav::IProperties
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/subscriptions/plugin.rb

@@ -0,0 +1,83 @@
+module Tilia
+  module CalDav
+    module Subscriptions
+      # This plugin adds calendar-subscription support to your CalDAV server.
+      #
+      # Some clients support 'managed subscriptions' server-side. This is basically
+      # a list of subscription urls a user is using.
+      class Plugin < Dav::ServerPlugin
+        # This initializes the plugin.
+        #
+        # This function is called by Sabre\DAV\Server, after
+        # addPlugin is called.
+        #
+        # This method should set up the required event subscriptions.
+        #
+        # @param Server server
+        # @return void
+        def setup(server)
+          server.resource_type_mapping[ISubscription] = '{http://calendarserver.org/ns/}subscribed'
+          server.xml.element_map['{http://calendarserver.org/ns/}source'] = Dav::Xml::Property::Href
+
+          server.on('propFind', method(:prop_find), 150)
+        end
+
+        # This method should return a list of server-features.
+        #
+        # This is for example 'versioning' and is added to the DAV: header
+        # in an OPTIONS response.
+        #
+        # @return array
+        def features
+          ['calendarserver-subscribed']
+        end
+
+        # Triggered after properties have been fetched.
+        #
+        # @param PropFind prop_find
+        # @param INode node
+        # @return void
+        def prop_find(prop_find, _node)
+          # There's a bunch of properties that must appear as a self-closing
+          # xml-element. This event handler ensures that this will be the case.
+          props = [
+            '{http://calendarserver.org/ns/}subscribed-strip-alarms',
+            '{http://calendarserver.org/ns/}subscribed-strip-attachments',
+            '{http://calendarserver.org/ns/}subscribed-strip-todos'
+          ]
+
+          props.each do |prop|
+            prop_find.set(prop, '', 200) if prop_find.status(prop) == 200
+          end
+        end
+
+        # Returns a plugin name.
+        #
+        # Using this name other plugins will be able to access other plugins
+        # using \Sabre\DAV\Server::getPlugin
+        #
+        # @return string
+        def plugin_name
+          'subscriptions'
+        end
+
+        # Returns a bunch of meta-data about the plugin.
+        #
+        # Providing this information is optional, and is mainly displayed by the
+        # Browser plugin.
+        #
+        # The description key in the returned array may contain html and will not
+        # be sanitized.
+        #
+        # @return array
+        def plugin_info
+          {
+            'name'        => plugin_name,
+            'description' => 'This plugin allows users to store iCalendar subscriptions in their calendar-home.',
+            'link'        => nil
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/subscriptions/subscription.rb

@@ -0,0 +1,205 @@
+module Tilia
+  module CalDav
+    module Subscriptions
+      # Subscription Node
+      #
+      # This node represents a subscription.
+      class Subscription < Dav::Collection
+        include ISubscription
+        include DavAcl::IAcl
+
+        # @!attribute [r] caldav_backend
+        #   @!visibility private
+        #   caldavBackend
+        #
+        #   @var SupportsSubscriptions
+
+        # @!attribute [r] subscription_info
+        #   @!visibility private
+        #   subscriptionInfo
+        #
+        #   @var array
+
+        # Constructor
+        #
+        # @param SubscriptionSupport caldav_backend
+        # @param array calendar_info
+        def initialize(caldav_backend, subscription_info)
+          @caldav_backend = caldav_backend
+          @subscription_info = subscription_info
+
+          required = [
+            'id',
+            'uri',
+            'principaluri',
+            'source'
+          ]
+
+          required.each do |r|
+            fail ArgumentError, "The #{r} field is required when creating a subscription node" unless subscription_info.key?(r)
+          end
+        end
+
+        # Returns the name of the node.
+        #
+        # This is used to generate the url.
+        #
+        # @return string
+        def name
+          @subscription_info['uri']
+        end
+
+        # Returns the last modification time
+        #
+        # @return int
+        def last_modified
+          return @subscription_info['lastmodified'] if @subscription_info.key?('lastmodified')
+          nil
+        end
+
+        # Deletes the current node
+        #
+        # @return void
+        def delete
+          @caldav_backend.delete_subscription(@subscription_info['id'])
+        end
+
+        # Returns an array with all the child nodes
+        #
+        # @return DAV\INode[]
+        def children
+          []
+        end
+
+        # 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 prop_patch
+        # @return void
+        def prop_patch(prop_patch)
+          @caldav_backend.update_subscription(
+            @subscription_info['id'],
+            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 void
+        def properties(properties)
+          r = {}
+
+          properties.each do |prop|
+            case prop
+            when '{http://calendarserver.org/ns/}source'
+              r[prop] = Dav::Xml::Property:: Href.new(@subscription_info['source'], false)
+            else
+              if @subscription_info.key?(prop)
+                r[prop] = @subscription_info[prop]
+              end
+            end
+          end
+
+          r
+        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
+          @subscription_info['principaluri']
+        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
+          [
+            {
+              'privilege' => '{DAV:}read',
+              'principal' => owner,
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}write',
+              'principal' => owner,
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}read',
+              'principal' => owner + '/calendar-proxy-write',
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}write',
+              'principal' => owner + '/calendar-proxy-write',
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}read',
+              'principal' => owner + '/calendar-proxy-read',
+              'protected' => true
+            }
+          ]
+        end
+
+        # Updates the ACL.
+        #
+        # This method will receive a list of new ACE's.
+        #
+        # @param array acl
+        # @return void
+        def acl=(_acl)
+          fail Dav::Exception::MethodNotAllowed, 'Changing ACL is not yet supported'
+        end
+
+        # Returns the list of supported privileges for this node.
+        #
+        # The returned data structure is a list of nested privileges.
+        # See \Sabre\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/cal_dav/xml.rb

@@ -0,0 +1,10 @@
+module Tilia
+  module CalDav
+    module Xml
+      require 'tilia/cal_dav/xml/filter'
+      require 'tilia/cal_dav/xml/notification'
+      require 'tilia/cal_dav/xml/property'
+      require 'tilia/cal_dav/xml/request'
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/filter.rb

@@ -0,0 +1,12 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Filter
+        require 'tilia/cal_dav/xml/filter/calendar_data'
+        require 'tilia/cal_dav/xml/filter/comp_filter'
+        require 'tilia/cal_dav/xml/filter/param_filter'
+        require 'tilia/cal_dav/xml/filter/prop_filter'
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/filter/calendar_data.rb

@@ -0,0 +1,64 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Filter
+        # CalendarData parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:caldav}calendar-data XML
+        # element, as defined in:
+        #
+        # https://tools.ietf.org/html/rfc4791#section-9.6
+        #
+        # This element is used in three distinct places in the caldav spec, but in
+        # this case, this element class only implements the calendar-data element as
+        # it appears in a DAV:prop element, in a calendar-query or calendar-multiget
+        # REPORT request.
+        class CalendarData
+          include Tilia::Xml::XmlDeserializable
+
+          # The deserialize method is called during xml parsing.
+          #
+          # This method is called statictly, this is because in theory this method
+          # may be used as a type of constructor, or factory method.
+          #
+          # Often you want to return an instance of the current class, but you are
+          # free to return other data as well.
+          #
+          # You are responsible for advancing the reader to the next element. Not
+          # doing anything will result in a never-ending loop.
+          #
+          # If you just want to skip parsing for this element altogether, you can
+          # just call reader.next
+          #
+          # reader.parse_inner_tree will parse the entire sub-tree, and advance to
+          # the next element.
+          #
+          # @param Reader reader
+          # @return mixed
+          def self.xml_deserialize(reader)
+            result = {
+              'contentType' => reader['content-type'] || 'text/calendar',
+              'version'     => reader['version'] || '2.0'
+            }
+
+            elems = reader.parse_inner_tree || []
+            elems.each do |elem|
+              case elem['name']
+              when "{#{Plugin::NS_CALDAV}}expand"
+                result['expand'] = {
+                  'start' => elem['attributes'].key?('start') ? VObject::DateTimeParser.parse_date_time(elem['attributes']['start']) : nil,
+                  'end'   => elem['attributes'].key?('end') ? VObject::DateTimeParser.parse_date_time(elem['attributes']['end']) : nil
+                }
+
+                fail Dav::Exception::BadRequest, 'The "start" and "end" attributes are required when expanding calendar-data' unless result['expand']['start'] && result['expand']['end']
+                fail Dav::Exception::BadRequest, 'The end-date must be larger than the start-date when expanding calendar-data' if result['expand']['end'] <= result['expand']['start']
+              end
+            end
+
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/filter/comp_filter.rb

@@ -0,0 +1,79 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Filter
+        # CompFilter parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:caldav}comp-filter XML
+        # element, as defined in:
+        #
+        # https://tools.ietf.org/html/rfc4791#section-9.6
+        #
+        # The result will be spit out as an array.
+        class CompFilter
+          include Tilia::Xml::XmlDeserializable
+
+          # The deserialize method is called during xml parsing.
+          #
+          # This method is called statictly, this is because in theory this method
+          # may be used as a type of constructor, or factory method.
+          #
+          # Often you want to return an instance of the current class, but you are
+          # free to return other data as well.
+          #
+          # You are responsible for advancing the reader to the next element. Not
+          # doing anything will result in a never-ending loop.
+          #
+          # If you just want to skip parsing for this element altogether, you can
+          # just call reader.next
+          #
+          # reader.parse_inner_tree will parse the entire sub-tree, and advance to
+          # the next element.
+          #
+          # @param Reader reader
+          # @return mixed
+          def self.xml_deserialize(reader)
+            result = {
+              'name'           => nil,
+              'is-not-defined' => false,
+              'comp-filters'   => [],
+              'prop-filters'   => [],
+              'time-range'     => false
+            }
+
+            att = reader.parse_attributes
+            result['name'] = att['name']
+
+            elems = reader.parse_inner_tree || []
+
+            elems.each do |elem|
+              case elem['name']
+              when "{#{Plugin::NS_CALDAV}}comp-filter"
+                result['comp-filters'] << elem['value']
+              when "{#{Plugin::NS_CALDAV}}prop-filter"
+                result['prop-filters'] << elem['value']
+              when "{#{Plugin::NS_CALDAV}}is-not-defined"
+                result['is-not-defined'] = true
+              when "{#{Plugin::NS_CALDAV}}time-range"
+                fail Dav::Exception::BadRequest, 'You cannot add time-range filters on the VCALENDAR component' if result['name'] == 'VCALENDAR'
+
+                result['time-range'] = {
+                  'start' => elem['attributes'].key?('start') ? VObject::DateTimeParser.parse_date_time(elem['attributes']['start']) : nil,
+                  'end'   => elem['attributes'].key?('end') ? VObject::DateTimeParser.parse_date_time(elem['attributes']['end']) : nil
+                }
+
+                if result['time-range']['start'] &&
+                   result['time-range']['end'] &&
+                   result['time-range']['end'] <= result['time-range']['start']
+                  fail Dav::Exception::BadRequest, 'The end-date must be larger than the start-date'
+                end
+              end
+            end
+
+            result
+          end
+        end
+      end
+    end
+  end
+end