tilia-dav 3.1.0.pre.alpha2

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

@@ -0,0 +1,156 @@
+module Tilia
+  module CalDav
+    module Schedule
+      # iMIP handler.
+      #
+      # This class is responsible for sending out iMIP messages. iMIP is the
+      # email-based transport for iTIP. iTIP deals with scheduling operations for
+      # iCalendar objects.
+      #
+      # If you want to customize the email that gets sent out, you can do so by
+      # extending this class and overriding the sendMessage method.
+      class IMipPlugin < Dav::ServerPlugin
+        # @!attribute [r] sender_email
+        #   @!visibility private
+        #   Email address used in From: header.
+        #
+        #   @var string
+
+        # @!attribute [r] itip_message
+        #   @!visibility private
+        #   ITipMessage
+        #
+        #   @var ITip\Message
+
+        # Creates the email handler.
+        #
+        # @param string sender_email. The 'senderEmail' is the email that shows up
+        #                             in the 'From:' address. This should
+        #                             generally be some kind of no-reply email
+        #                             address you own.
+        def initialize(sender_email)
+          @sender_email = sender_email
+        end
+
+        # 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 DAV\Server server
+        # @return void
+        def setup(server)
+          server.on('schedule', method(:schedule), 120)
+        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
+          'imip'
+        end
+
+        # Event handler for the 'schedule' event.
+        #
+        # @param ITip\Message i_tip_message
+        # @return void
+        def schedule(i_tip_message)
+          # Not sending any emails if the system considers the update
+          # insignificant.
+          unless i_tip_message.significant_change
+            unless i_tip_message.schedule_status
+              i_tip_message.schedule_status = '1.0;We got the message, but it\'s not significant enough to warrant an email'
+            end
+            return nil
+          end
+
+          summary = i_tip_message.message['VEVENT']['SUMMARY'].to_s
+
+          return nil unless Uri.parse(i_tip_message.sender)['scheme'] == 'mailto'
+          return nil unless Uri.parse(i_tip_message.recipient)['scheme'] == 'mailto'
+
+          sender = i_tip_message.sender[7..-1]
+          recipient = i_tip_message.recipient[7..-1]
+
+          sender = "#{i_tip_message.sender_name} <#{sender}>" if i_tip_message.sender_name
+          recipient = "#{i_tip_message.recipient_name} <#{recipient}>" if i_tip_message.recipient_name
+
+          subject = 'SabreDAV iTIP message'
+          case i_tip_message.method.upcase
+          when 'REPLY'
+            subject = 'Re: ' + summary
+          when 'REQUEST'
+            subject = summary
+          when 'CANCEL'
+            subject = 'Cancelled: ' + summary
+          end
+
+          headers = {
+            'Reply-To' => sender,
+            'From' => @sender_email,
+            'Content-Type' => "text/calendar; charset=UTF-8; method=#{i_tip_message.method}"
+          }
+
+          headers['X-Sabre-Version'] = Dav::Version::VERSION if Dav::Server.expose_version
+
+          mail(
+            recipient,
+            subject,
+            i_tip_message.message.serialize,
+            headers
+          )
+          i_tip_message.schedule_status = '1.1; Scheduling message is sent via iMip'
+        end
+
+        protected
+
+        # This is deemed untestable in a reasonable manner
+
+        # This function is responsible for sending the actual email.
+        #
+        # @param string to Recipient email address
+        # @param string subject Subject of the email
+        # @param string body iCalendar body
+        # @param array headers List of headers
+        # @return void
+        def mail(to, subject, body, headers)
+          headers['to'] = to
+
+          mail = Mail.new
+          mail.subject = subject
+          mail.body = body
+
+          headers.each do |_key, value|
+            mail[header] = value
+          end
+
+          mail.deliver!
+        end
+
+        public
+
+        # 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' => 'Email delivery (rfc6037) for CalDAV scheduling',
+            'link'        => 'http://sabre.io/dav/scheduling/'
+          }
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,10 @@
+module Tilia
+  module CalDav
+    module Schedule
+      # The SchedulingObject represents a scheduling object in the Inbox collection
+      module ISchedulingObject
+        include ICalendarObject
+      end
+    end
+  end
+end

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

@@ -0,0 +1,211 @@
+module Tilia
+  module CalDav
+    module Schedule
+      # The CalDAV scheduling inbox
+      class Inbox < Dav::Collection
+        include IInbox
+
+        # @!attribute [r] caldav_backend
+        #   @!visibility private
+        #   CalDAV backend
+        #
+        #   @var Backend\BackendInterface
+
+        # @!attribute [r] principal_uri
+        #   @!visibility private
+        #   The principal Uri
+        #
+        #   @var string
+
+        # Constructor
+        #
+        # @param Backend\SchedulingSupport caldav_backend
+        # @param string principal_uri
+        def initialize(caldav_backend, principal_uri)
+          @caldav_backend = caldav_backend
+          @principal_uri = principal_uri
+        end
+
+        # Returns the name of the node.
+        #
+        # This is used to generate the url.
+        #
+        # @return string
+        def name
+          'inbox'
+        end
+
+        # Returns an array with all the child nodes
+        #
+        # @return \Sabre\DAV\INode[]
+        def children
+          objs = @caldav_backend.scheduling_objects(@principal_uri)
+          children = []
+          objs.each do |obj|
+            # obj['acl'] = self.get_acl
+            obj['principaluri'] = @principal_uri
+            children << SchedulingObject.new(@caldav_backend, obj)
+          end
+
+          children
+        end
+
+        # 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 succesful 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)
+          @caldav_backend.create_scheduling_object(@principal_uri, name, data)
+        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
+          @principal_uri
+        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' => '{DAV:}authenticated',
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}write-properties',
+              'principal' => owner,
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}unbind',
+              'principal' => owner,
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}unbind',
+              'principal' => owner + '/calendar-proxy-write',
+              'protected' => true
+            },
+            {
+              'privilege' => "{#{Plugin::NS_CALDAV}}schedule-deliver-invite",
+              'principal' => '{DAV:}authenticated',
+              'protected' => true
+            },
+            {
+              'privilege' => "{#{Plugin::NS_CALDAV}}schedule-deliver-reply",
+              'principal' => '{DAV:}authenticated',
+              '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, 'You\'re not allowed to update the ACL'
+        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
+          ns = "{#{Plugin::NS_CALDAV}}"
+
+          default = DavAcl::Plugin.default_supported_privilege_set
+          default['aggregates'] << {
+            'privilege'  => "#{ns}schedule-deliver",
+            'aggregates' => [
+              { 'privilege' => "#{ns}schedule-deliver-invite" },
+              { 'privilege' => "#{ns}schedule-deliver-reply" }
+            ]
+          }
+
+          default
+        end
+
+        # Performs a calendar-query on the contents of this calendar.
+        #
+        # The calendar-query is defined in RFC4791 : CalDAV. Using the
+        # calendar-query it is possible for a client to request a specific set of
+        # object, based on contents of iCalendar properties, date-ranges and
+        # iCalendar component types (VTODO, VEVENT).
+        #
+        # This method should just return a list of (relative) urls that match this
+        # query.
+        #
+        # The list of filters are specified as an array. The exact array is
+        # documented by \Sabre\CalDAV\CalendarQueryParser.
+        #
+        # @param array filters
+        # @return array
+        def calendar_query(filters)
+          result = []
+          validator = CalendarQueryValidator.new
+
+          objects = @caldav_backend.scheduling_objects(@principal_uri)
+          objects.each do |object|
+            v_object = VObject::Reader.read(object['calendardata'])
+
+            result << object['uri'] if validator.validate(v_object, filters)
+
+            # Destroy circular references to PHP will GC the object.
+            v_object.destroy
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+module Tilia
+  module CalDav
+    module Schedule
+      # The CalDAV scheduling outbox
+      #
+      # The outbox is mainly used as an endpoint in the tree for a client to do
+      # free-busy requests. This functionality is completely handled by the
+      # Scheduling plugin, so this object is actually mostly static.
+      class Outbox < Dav::Collection
+        include IOutbox
+
+        # @!attribute [r] principal_uri
+        #   @!visibility private
+        #   The principal Uri
+        #
+        #   @var string
+
+        # Constructor
+        #
+        # @param string principal_uri
+        def initialize(principal_uri)
+          @principal_uri = principal_uri
+        end
+
+        # Returns the name of the node.
+        #
+        # This is used to generate the url.
+        #
+        # @return string
+        def name
+          'outbox'
+        end
+
+        # Returns an array with all the child nodes
+        #
+        # @return \Sabre\DAV\INode[]
+        def children
+          []
+        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
+          @principal_uri
+        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' => "{#{Plugin::NS_CALDAV}}schedule-query-freebusy",
+              'principal' => owner,
+              'protected' => true
+            },
+            {
+              'privilege' => "{#{Plugin::NS_CALDAV}}schedule-post-vevent",
+              'principal' => owner,
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}read',
+              'principal' => owner,
+              'protected' => true
+            },
+            {
+              'privilege' => "{#{Plugin::NS_CALDAV}}schedule-query-freebusy",
+              'principal' => owner + '/calendar-proxy-write',
+              'protected' => true
+            },
+            {
+              'privilege' => "{#{Plugin::NS_CALDAV}}schedule-post-vevent",
+              'principal' => owner + '/calendar-proxy-write',
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}read',
+              'principal' => owner + '/calendar-proxy-read',
+              'protected' => true
+            },
+            {
+              'privilege' => '{DAV:}read',
+              'principal' => owner + '/calendar-proxy-write',
+              '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, 'You\'re not allowed to update the ACL'
+        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
+          default = DavAcl::Plugin.default_supported_privilege_set
+          default['aggregates'] << {
+            'privilege' => "{#{Plugin::NS_CALDAV}}schedule-query-freebusy"
+          }
+          default['aggregates'] << {
+            'privilege' => "{#{Plugin::NS_CALDAV}}schedule-post-vevent"
+          }
+
+          default
+        end
+      end
+    end
+  end
+end