tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/card_dav/address_book_home.rb

@@ -0,0 +1,192 @@
+module Tilia
+  module CardDav
+    # AddressBook Home class
+    #
+    # This collection contains a list of addressbooks associated with one user.
+    class AddressBookHome < Dav::Collection
+      include Dav::IExtendedCollection
+      include DavAcl::IAcl
+
+      protected
+
+      # Principal uri
+      #
+      # @var array
+      attr_accessor :principal_uri
+
+      # carddavBackend
+      #
+      # @var Backend\BackendInterface
+      attr_accessor :carddav_backend
+
+      public
+
+      # Constructor
+      #
+      # @param Backend\BackendInterface carddav_backend
+      # @param string principal_uri
+      def initialize(carddav_backend, principal_uri)
+        @carddav_backend = carddav_backend
+        @principal_uri = principal_uri
+      end
+
+      # Returns the name of this object
+      #
+      # @return string
+      def name
+        name = Uri.split(@principal_uri)[1]
+        name
+      end
+
+      # Updates the name of this object
+      #
+      # @param string name
+      # @return void
+      def name=(_name)
+        fail Dav::Exception::MethodNotAllowed
+      end
+
+      # Deletes this object
+      #
+      # @return void
+      def delete
+        fail Dav::Exception::MethodNotAllowed
+      end
+
+      # Returns the last modification date
+      #
+      # @return int
+      def last_modified
+        nil
+      end
+
+      # Creates a new file under this object.
+      #
+      # This is currently not allowed
+      #
+      # @param string filename
+      # @param resource data
+      # @return void
+      def create_file(_filename, _data = nil)
+        fail Dav::Exception::MethodNotAllowed, 'Creating new files in this collection is not supported'
+      end
+
+      # Creates a new directory under this object.
+      #
+      # This is currently not allowed.
+      #
+      # @param string filename
+      # @return void
+      def create_directory(_filename)
+        fail Dav::Exception::MethodNotAllowed, 'Creating new collections in this collection is not supported'
+      end
+
+      # Returns a single addressbook, by name
+      #
+      # @param string name
+      # @todo needs optimizing
+      # @return \AddressBook
+      def child(name)
+        children.each do |child|
+          return child if name == child.name
+        end
+
+        fail Dav::Exception::NotFound, "Addressbook with name '#{name}' could not be found"
+      end
+
+      # Returns a list of addressbooks
+      #
+      # @return array
+      def children
+        addressbooks = @carddav_backend.address_books_for_user(@principal_uri)
+
+        objs = []
+        addressbooks.each do |addressbook|
+          objs << AddressBook.new(@carddav_backend, addressbook)
+        end
+        objs
+      end
+
+      # Creates a new address book.
+      #
+      # @param string name
+      # @param MkCol mk_col
+      # @throws DAV\Exception\InvalidResourceType
+      # @return void
+      def create_extended_collection(name, mk_col)
+        fail Dav::Exception::InvalidResourceType, 'Unknown resourceType for this collection' unless mk_col.resource_type?("{#{Plugin::NS_CARDDAV}}addressbook")
+
+        properties = mk_col.remaining_values
+        mk_col.remaining_result_code = 201
+        @carddav_backend.create_address_book(@principal_uri, name, properties)
+      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' => @principal_uri,
+            'protected' => true
+          },
+          {
+            'privilege' => '{DAV:}write',
+            'principal' => @principal_uri,
+            '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

data/lib/tilia/card_dav/address_book_root.rb

@@ -0,0 +1,58 @@
+module Tilia
+  module CardDav
+    # AddressBook rootnode
+    #
+    # This object lists a collection of users, which can contain addressbooks.
+    class AddressBookRoot < DavAcl::AbstractPrincipalCollection
+      protected
+
+      # Principal Backend
+      #
+      # @var Sabre\DAVACL\PrincipalBackend\BackendInteface
+      attr_accessor :principal_backend
+
+      # CardDAV backend
+      #
+      # @var Backend\BackendInterface
+      attr_accessor :carddav_backend
+
+      public
+
+      # Constructor
+      #
+      # This constructor needs both a principal and a carddav backend.
+      #
+      # By default this class will show a list of addressbook collections for
+      # principals in the 'principals' collection. If your main principals are
+      # actually located in a different path, use the principal_prefix argument
+      # to override this.
+      #
+      # @param DAVACL\PrincipalBackend\BackendInterface principal_backend
+      # @param Backend\BackendInterface carddav_backend
+      # @param string principal_prefix
+      def initialize(principal_backend, carddav_backend, principal_prefix = 'principals')
+        @carddav_backend = carddav_backend
+        super(principal_backend, principal_prefix)
+      end
+
+      # Returns the name of the node
+      #
+      # @return string
+      def name
+        Plugin::ADDRESSBOOK_ROOT
+      end
+
+      # This method returns a node for a principal.
+      #
+      # 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
+      # @return \Sabre\DAV\INode
+      def child_for_principal(principal)
+        AddressBookHome.new(@carddav_backend, principal['uri'])
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/backend.rb

@@ -0,0 +1,12 @@
+module Tilia
+  module CardDav
+    module Backend
+      require 'tilia/card_dav/backend/backend_interface'
+      require 'tilia/card_dav/backend/sync_support'
+
+      require 'tilia/card_dav/backend/abstract_backend'
+
+      require 'tilia/card_dav/backend/sequel'
+    end
+  end
+end

data/lib/tilia/card_dav/backend/abstract_backend.rb

@@ -0,0 +1,30 @@
+module Tilia
+  module CardDav
+    module Backend
+      # CardDAV abstract Backend
+      #
+      # This class serves as a base-class for addressbook backends
+      #
+      # This class doesn't do much, but it was added for consistency.
+      class AbstractBackend
+        include BackendInterface
+
+        # Returns a list of cards.
+        #
+        # This method should work identical to getCard, but instead return all the
+        # cards in the list as an array.
+        #
+        # If the backend supports this, it may allow for some speed-ups.
+        #
+        # @param mixed address_book_id
+        # @param array uris
+        # @return array
+        def multiple_cards(address_book_id, uris)
+          uris.map do |uri|
+            card(address_book_id, uri)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/backend/backend_interface.rb

@@ -0,0 +1,175 @@
+module Tilia
+  module CardDav
+    module Backend
+      # CardDAV Backend Interface
+      #
+      # Any CardDAV backend must implement this interface.
+      #
+      # Note that there are references to 'addressBookId' scattered throughout the
+      # class. The value of the addressBookId is completely up to you, it can be any
+      # arbitrary value you can use as an unique identifier.
+      #
+      # @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 BackendInterface
+        # Returns the list of addressbooks for a specific user.
+        #
+        # Every addressbook should have the following properties:
+        #   id - an arbitrary unique id
+        #   uri - the 'basename' part of the url
+        #   principaluri - Same as the passed parameter
+        #
+        # Any additional clark-notation property may be passed besides this. Some
+        # common ones are :
+        #   {DAV:}displayname
+        #   {urn:ietf:params:xml:ns:carddav}addressbook-description
+        #   {http://calendarserver.org/ns/}getctag
+        #
+        # @param string principal_uri
+        # @return array
+        def address_books_for_user(principal_uri)
+        end
+
+        # Updates properties for an address book.
+        #
+        # The list of mutations is stored in a Sabre\DAV\PropPatch object.
+        # To do the actual updates, you must tell this object which properties
+        # you're going to process with the handle method.
+        #
+        # Calling the handle method is like telling the PropPatch object "I
+        # promise I can handle updating this property".
+        #
+        # Read the PropPatch documenation for more info and examples.
+        #
+        # @param string address_book_id
+        # @param \Sabre\DAV\PropPatch prop_patch
+        # @return void
+        def update_address_book(address_book_id, prop_patch)
+        end
+
+        # Creates a new address book
+        #
+        # @param string principal_uri
+        # @param string url Just the 'basename' of the url.
+        # @param array properties
+        # @return void
+        def create_address_book(principal_uri, url, properties)
+        end
+
+        # Deletes an entire addressbook and all its contents
+        #
+        # @param mixed address_book_id
+        # @return void
+        def delete_address_book(address_book_id)
+        end
+
+        # Returns all cards for a specific addressbook id.
+        #
+        # This method should return the following properties for each card:
+        #   * carddata - raw vcard data
+        #   * uri - Some unique url
+        #   * lastmodified - A unix timestamp
+        #
+        # It's recommended to also return the following properties:
+        #   * etag - A unique etag. This must change every time the card changes.
+        #   * size - The size of the card in bytes.
+        #
+        # If these last two properties are provided, less time will be spent
+        # calculating them. If they are specified, you can also ommit carddata.
+        # This may speed up certain requests, especially with large cards.
+        #
+        # @param mixed addressbook_id
+        # @return array
+        def cards(addressbook_id)
+        end
+
+        # Returns a specfic card.
+        #
+        # The same set of properties must be returned as with getCards. The only
+        # exception is that 'carddata' is absolutely required.
+        #
+        # If the card does not exist, you must return false.
+        #
+        # @param mixed address_book_id
+        # @param string card_uri
+        # @return array
+        def card(address_book_id, card_uri)
+        end
+
+        # Returns a list of cards.
+        #
+        # This method should work identical to getCard, but instead return all the
+        # cards in the list as an array.
+        #
+        # If the backend supports this, it may allow for some speed-ups.
+        #
+        # @param mixed address_book_id
+        # @param array uris
+        # @return array
+        def multiple_cards(address_book_id, uris)
+        end
+
+        # Creates a new card.
+        #
+        # The addressbook id will be passed as the first argument. This is the
+        # same id as it is returned from the getAddressBooksForUser method.
+        #
+        # The cardUri is a base uri, and doesn't include the full path. The
+        # cardData argument is the vcard body, and is passed as a string.
+        #
+        # It is possible to return an ETag from this method. This ETag is for the
+        # newly created resource, and must be enclosed with double quotes (that
+        # is, the string itself must contain the double quotes).
+        #
+        # You should only return the ETag if you store the carddata as-is. If a
+        # subsequent GET request on the same card does not have the same body,
+        # byte-by-byte and you did return an ETag here, clients tend to get
+        # confused.
+        #
+        # If you don't return an ETag, you can just return null.
+        #
+        # @param mixed address_book_id
+        # @param string card_uri
+        # @param string card_data
+        # @return string|null
+        def create_card(address_book_id, card_uri, card_data)
+        end
+
+        # Updates a card.
+        #
+        # The addressbook id will be passed as the first argument. This is the
+        # same id as it is returned from the getAddressBooksForUser method.
+        #
+        # The cardUri is a base uri, and doesn't include the full path. The
+        # cardData argument is the vcard body, and is passed as a string.
+        #
+        # It is possible to return an ETag from this method. This ETag should
+        # match that of the updated resource, and must be enclosed with double
+        # quotes (that is: the string itself must contain the actual quotes).
+        #
+        # You should only return the ETag if you store the carddata as-is. If a
+        # subsequent GET request on the same card does not have the same body,
+        # byte-by-byte and you did return an ETag here, clients tend to get
+        # confused.
+        #
+        # If you don't return an ETag, you can just return null.
+        #
+        # @param mixed address_book_id
+        # @param string card_uri
+        # @param string card_data
+        # @return string|null
+        def update_card(address_book_id, card_uri, card_data)
+        end
+
+        # Deletes a card
+        #
+        # @param mixed address_book_id
+        # @param string card_uri
+        # @return bool
+        def delete_card(address_book_id, card_uri)
+        end
+      end
+    end
+  end
+end