tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/cal_dav/xml/request/free_busy_query_report.rb

@@ -0,0 +1,70 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Request
+        # FreeBusyQueryReport
+        #
+        # This class parses the {DAV:}free-busy-query REPORT, as defined in:
+        #
+        # http://tools.ietf.org/html/rfc3253#section-3.8
+        class FreeBusyQueryReport
+          include Tilia::Xml::XmlDeserializable
+
+          # Starttime of report
+          #
+          # @var DateTime|null
+          attr_accessor :start
+
+          # End time of report
+          #
+          # @var DateTime|null
+          attr_accessor :end
+
+          # 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)
+            time_range = "{#{Plugin::NS_CALDAV}}time-range"
+
+            start = nil
+            ending = nil
+
+            (reader.parse_inner_tree({}) || []).each do |elem|
+              next unless elem['name'] == time_range
+
+              start =  elem['attributes']['start']
+              ending = elem['attributes']['end']
+            end
+
+            fail Dav::Exception::BadRequest.new('The freebusy report must have a time-range element') if !start && !ending
+
+            start = VObject::DateTimeParser.parse_date_time(start) if start
+            ending = VObject::DateTimeParser.parse_date_time(ending) if ending
+
+            result = new
+            result.start = start
+            result.end = ending
+
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/request/invite_reply.rb

@@ -0,0 +1,110 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Request
+        # Invite-reply POST request parser
+        #
+        # This class parses the invite-reply POST request, as defined in:
+        #
+        # http://svn.calendarserver.org/repository/calendarserver/CalendarServer/trunk/doc/Extensions/caldav-sharing.txt
+        class InviteReply
+          include Tilia::Xml::XmlDeserializable
+
+          # The sharee calendar user address.
+          #
+          # This is the address that the original invite was set to
+          #
+          # @var string
+          attr_accessor :href
+
+          # The uri to the calendar that was being shared.
+          #
+          # @var string
+          attr_accessor :calendar_uri
+
+          # The id of the invite message that's being responded to
+          #
+          # @var string
+          attr_accessor :in_reply_to
+
+          # An optional message
+          #
+          # @var string
+          attr_accessor :summary
+
+          # Either SharingPlugin::STATUS_ACCEPTED or SharingPlugin::STATUS_DECLINED.
+          #
+          # @var int
+          attr_accessor :status
+
+          # Constructor
+          #
+          # @param string href
+          # @param string calendar_uri
+          # @param string in_reply_to
+          # @param string summary
+          # @param int status
+          def initialize(href, calendar_uri, in_reply_to, summary, status)
+            @href = href
+            @calendar_uri = calendar_uri
+            @in_reply_to = in_reply_to
+            @summary = summary
+            @status = status
+          end
+
+          # 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)
+            elems = Tilia::Xml::Element::KeyValue.xml_deserialize(reader)
+
+            href = nil
+            calendar_uri = nil
+            in_reply_to = nil
+            summary = nil
+            status = nil
+
+            elems.each do |name, value|
+              case name
+              when "{#{Plugin::NS_CALENDARSERVER}}hosturl"
+                value.each do |bla|
+                  calendar_uri = bla['value'] if bla['name'] == '{DAV:}href'
+                end
+              when "{#{Plugin::NS_CALENDARSERVER}}invite-accepted"
+                status = SharingPlugin::STATUS_ACCEPTED
+              when "{#{Plugin::NS_CALENDARSERVER}}invite-declined"
+                status = SharingPlugin::STATUS_DECLINED
+              when "{#{Plugin::NS_CALENDARSERVER}}in-reply-to"
+                in_reply_to = value
+              when "{#{Plugin::NS_CALENDARSERVER}}summary"
+                summary = value
+              when '{DAV:}href'
+                href = value
+              end
+            end
+
+            fail Dav::Exception::BadRequest, 'The {http://calendarserver.org/ns/}hosturl/{DAV:}href element must exist' unless calendar_uri
+
+            new(href, calendar_uri, in_reply_to, summary, status)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/request/mk_calendar.rb

@@ -0,0 +1,67 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Request
+        # MKCALENDAR parser.
+        #
+        # This class parses the MKCALENDAR request, as defined in:
+        #
+        # https://tools.ietf.org/html/rfc4791#section-5.3.1
+        class MkCalendar
+          include Tilia::Xml::XmlDeserializable
+
+          # The list of properties that will be set.
+          #
+          # @var array
+          attr_accessor :properties
+
+          # Returns the list of properties the calendar will be initialized with.
+          #
+          # @return array
+          # attr_reader :properties
+
+          # 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)
+            instance = new
+
+            element_map = reader.element_map
+            element_map['{DAV:}prop']   = Dav::Xml::Element::Prop
+            element_map['{DAV:}set']    = Tilia::Xml::Element::KeyValue
+            elems = reader.parse_inner_tree(element_map)
+
+            elems.each do |elem|
+              if elem['name'] == '{DAV:}set'
+                instance.properties = instance.properties.merge(elem['value']['{DAV:}prop'])
+              end
+            end
+
+            instance
+          end
+
+          # initialize instance vars
+          def initialize
+            @properties = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/request/share.rb

@@ -0,0 +1,93 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Request
+        # Share POST request parser
+        #
+        # This class parses the share POST request, as defined in:
+        #
+        # http://svn.calendarserver.org/repository/calendarserver/CalendarServer/trunk/doc/Extensions/caldav-sharing.txt
+        class Share
+          include Tilia::Xml::XmlDeserializable
+
+          # The list of new people added or updated.
+          #
+          # Every element has the following keys:
+          # 1. href - An email address
+          # 2. commonName - Some name
+          # 3. summary - An optional description of the share
+          # 4. readOnly - true or false
+          #
+          # @var array
+          attr_accessor :set
+
+          # List of people removed from the share list.
+          #
+          # The list is a flat list of email addresses (including mailto:).
+          #
+          # @var array
+          attr_accessor :remove
+
+          # Constructor
+          #
+          # @param array set
+          # @param array remove
+          def initialize(set, remove)
+            @set = set
+            @remove = remove
+          end
+
+          # 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)
+            elems = reader.parse_inner_tree(
+              "{#{Plugin::NS_CALENDARSERVER}}set"    => Tilia::Xml::Element::KeyValue,
+              "{#{Plugin::NS_CALENDARSERVER}}remove" => Tilia::Xml::Element::KeyValue
+            )
+
+            set = []
+            remove = []
+
+            elems.each do |elem|
+              case elem['name']
+              when "{#{Plugin::NS_CALENDARSERVER}}set"
+                sharee = elem['value']
+
+                sum_elem = "{#{Plugin::NS_CALENDARSERVER}}summary"
+                common_name = "{#{Plugin::NS_CALENDARSERVER}}common-name"
+
+                set << {
+                  'href'       => sharee['{DAV:}href'],
+                  'commonName' => sharee[common_name],
+                  'summary'    => sharee[sum_elem],
+                  'readOnly'   => !sharee.key?("{#{Plugin::NS_CALENDARSERVER}}read-write")
+                }
+              when "{#{Plugin::NS_CALENDARSERVER}}remove"
+                remove << elem['value']['{DAV:}href']
+              end
+            end
+
+            new(set, remove)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/card_dav.rb

@@ -0,0 +1,17 @@
+module Tilia
+  module CardDav
+    require 'tilia/card_dav/i_address_book'
+    require 'tilia/card_dav/i_card'
+    require 'tilia/card_dav/i_directory'
+
+    require 'tilia/card_dav/address_book_home'
+    require 'tilia/card_dav/address_book'
+    require 'tilia/card_dav/address_book_root'
+    require 'tilia/card_dav/backend'
+    require 'tilia/card_dav/card'
+    require 'tilia/card_dav/xml'
+
+    require 'tilia/card_dav/plugin'
+    require 'tilia/card_dav/vcf_export_plugin'
+  end
+end

data/lib/tilia/card_dav/address_book.rb

@@ -0,0 +1,338 @@
+module Tilia
+  module CardDav
+    # The AddressBook class represents a CardDAV addressbook, owned by a specific user
+    #
+    # The AddressBook can contain multiple vcards
+    class AddressBook < Dav::Collection
+      include IAddressBook
+      include Dav::IProperties
+      include DavAcl::IAcl
+      include Dav::Sync::ISyncCollection
+      include Dav::IMultiGet
+
+      protected
+
+      # This is an array with addressbook information
+      #
+      # @var array
+      attr_accessor :address_book_info
+
+      # CardDAV backend
+      #
+      # @var Backend\BackendInterface
+      attr_accessor :carddav_backend
+
+      public
+
+      # Constructor
+      #
+      # @param Backend\BackendInterface carddav_backend
+      # @param array address_book_info
+      def initialize(carddav_backend, address_book_info)
+        @carddav_backend = carddav_backend
+        @address_book_info = address_book_info
+      end
+
+      # Returns the name of the addressbook
+      #
+      # @return string
+      def name
+        @address_book_info['uri']
+      end
+
+      # Returns a card
+      #
+      # @param string name
+      # @return \ICard
+      def child(name)
+        obj = @carddav_backend.card(@address_book_info['id'], name)
+        fail Dav::Exception::NotFound, 'Card not found' unless obj
+
+        Card.new(@carddav_backend, @address_book_info, obj)
+      end
+
+      # Returns the full list of cards
+      #
+      # @return array
+      def children
+        objs = @carddav_backend.cards(@address_book_info['id'])
+        children = []
+        objs.each do |obj|
+          obj['acl'] = child_acl
+          children << Card.new(@carddav_backend, @address_book_info, obj)
+        end
+        children
+      end
+
+      # 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)
+        objs = @carddav_backend.multiple_cards(@address_book_info['id'], paths)
+
+        children = []
+        (objs || []).each do |obj|
+          obj['acl'] = child_acl
+          children << Card.new(@carddav_backend, @address_book_info, obj)
+        end
+
+        children
+      end
+
+      # Creates a new directory
+      #
+      # We actually block this, as subdirectories are not allowed in addressbooks.
+      #
+      # @param string name
+      # @return void
+      def create_directory(_name)
+        fail Dav::Exception::MethodNotAllowed, 'Creating collections in addressbooks is not allowed'
+      end
+
+      # Creates a new file
+      #
+      # The contents of the new file must be a valid VCARD.
+      #
+      # This method may return an ETag.
+      #
+      # @param string name
+      # @param resource vcard_data
+      # @return string|null
+      def create_file(name, vcard_data = '')
+        vcard_data = vcard_data.read unless vcard_data.is_a?(String)
+
+        # Converting to UTF-8, if needed
+        vcard_data = Dav::StringUtil.ensure_utf8(vcard_data)
+
+        @carddav_backend.create_card(@address_book_info['id'], name, vcard_data)
+      end
+
+      # Deletes the entire addressbook.
+      #
+      # @return void
+      def delete
+        @carddav_backend.delete_address_book(@address_book_info['id'])
+      end
+
+      # Renames the addressbook
+      #
+      # @param string new_name
+      # @return void
+      def name=(_new_name)
+        fail Dav::Exception::MethodNotAllowed, 'Renaming addressbooks is not yet supported'
+      end
+
+      # Returns the last modification date as a unix timestamp.
+      #
+      # @return void
+      def last_modified
+        nil
+      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 DAV\PropPatch prop_patch
+      # @return void
+      def prop_patch(prop_patch)
+        @carddav_backend.update_address_book(@address_book_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.
+      #
+      # @param array properties
+      # @return array
+      def properties(properties)
+        response = {}
+        properties.each do |property_name|
+          if @address_book_info.key?(property_name)
+            response[property_name] = @address_book_info[property_name]
+          end
+        end
+
+        response
+      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
+        @address_book_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
+          }
+        ]
+      end
+
+      # This method returns the ACL's for card nodes in this address book.
+      # The result of this method automatically gets passed to the
+      # card nodes in this address book.
+      #
+      # @return array
+      def child_acl
+        [
+          {
+            'privilege' => '{DAV:}read',
+            'principal' => owner,
+            'protected' => true
+          },
+          {
+            'privilege' => '{DAV:}write',
+            'principal' => owner,
+            '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
+
+      # This method returns the current sync-token for this collection.
+      # This can be any string.
+      #
+      # If null is returned from this function, the plugin assumes there's no
+      # sync information available.
+      #
+      # @return string|null
+      def sync_token
+        if @carddav_backend.is_a?(Backend::SyncSupport)
+          return @address_book_info['{DAV:}sync-token'] if @address_book_info.key?('{DAV:}sync-token')
+          return @address_book_info['{http://sabredav.org/ns}sync-token'] if @address_book_info.key?('{http://sabredav.org/ns}sync-token')
+        end
+
+        nil
+      end
+
+      # The getChanges method returns all the changes that have happened, since
+      # the specified syncToken and the current collection.
+      #
+      # This function should return an array, such as the following:
+      #
+      # [
+      #   'syncToken' => 'The current synctoken',
+      #   'added'   => [
+      #      'new.txt',
+      #   ],
+      #   'modified'   => [
+      #      'modified.txt',
+      #   ],
+      #   'deleted' => [
+      #      'foo.php.bak',
+      #      'old.txt'
+      #   ]
+      # ]
+      #
+      # The syncToken property should reflect the *current* syncToken of the
+      # collection, as reported get_sync_token. This is needed here too, to
+      # ensure the operation is atomic.
+      #
+      # If the syncToken is specified as null, this is an initial sync, and all
+      # members should be reported.
+      #
+      # The modified property is an array of nodenames that have changed since
+      # the last token.
+      #
+      # The deleted property is an array with nodenames, that have been deleted
+      # from collection.
+      #
+      # The second argument is basically the 'depth' of the report. If it's 1,
+      # you only have to report changes that happened only directly in immediate
+      # descendants. If it's 2, it should also include changes from the nodes
+      # below the child collections. (grandchildren)
+      #
+      # The third (optional) argument allows a client to specify how many
+      # results should be returned at most. If the limit is not specified, it
+      # should be treated as infinite.
+      #
+      # If the limit (infinite or not) is higher than you're willing to return,
+      # you should throw a Sabre\DAV\Exception\Too_much_matches exception.
+      #
+      # If the syncToken is expired (due to data cleanup) or unknown, you must
+      # return null.
+      #
+      # The limit is 'suggestive'. You are free to ignore it.
+      #
+      # @param string sync_token
+      # @param int sync_level
+      # @param int limit
+      # @return array
+      def changes(sync_token, sync_level, limit = nil)
+        return nil unless @carddav_backend.is_a?(Backend::SyncSupport)
+
+        @carddav_backend.changes_for_address_book(
+          @address_book_info['id'],
+          sync_token,
+          sync_level,
+          limit
+        )
+      end
+    end
+  end
+end