dav4rack_ext 0.0.2

data/lib/dav4rack_ext/carddav/app.rb

@@ -0,0 +1,78 @@
+require 'http_router'
+
+module DAV4Rack
+  module Carddav
+    
+    DAV_EXTENSIONS = ["access-control", "addressbook"].freeze
+    
+    def self.app(root_path = '/', opts = {})
+      logger = opts.delete(:logger) || ::Logger.new('/dev/null')
+      current_user = opts.delete(:current_user)
+      root_uri_path = opts.delete(:root_uri_path) || root_path
+      
+      if root_path[-1] != '/'
+        root_path << '/'
+      end
+      
+      raise "unknown options: #{opts}" unless opts.empty?
+      
+      HttpRouter.new do |r|
+        # try to help iOS
+        r.add("#{root_path}/.well_known/carddav/").to do |env|
+          root = env['REQUEST_PATH']
+          pos = root.index('.well_known')
+          [302, {'Location' => root[0...pos]}, []]
+        end
+
+        r.add("#{root_path}").to DAV4RackExt::Handler.new(
+            :logger                   => logger,
+            :dav_extensions           => DAV_EXTENSIONS,
+            :alway_include_dav_header => true,
+            :pretty_xml               => true,
+            :root_uri_path            => root_uri_path,
+            :resource_class           => DAV4Rack::Carddav::PrincipalResource,
+            :controller_class         => DAV4Rack::Carddav::Controller,
+            :current_user             => current_user,
+            
+            # resource options
+            :books_collection         => "/books/"
+          )
+        
+        r.add("#{root_path}books/").to DAV4RackExt::Handler.new(
+            :logger                   => logger,
+            :dav_extensions           => DAV_EXTENSIONS,
+            :alway_include_dav_header => true,
+            :pretty_xml               => true,
+            :root_uri_path            => root_uri_path,
+            :resource_class           => DAV4Rack::Carddav::AddressbookCollectionResource,
+            :controller_class         => DAV4Rack::Carddav::Controller,
+            :current_user             => current_user
+          )
+        
+        r.add("#{root_path}books/:book_id/:contact_id(.vcf)").to DAV4RackExt::Handler.new(
+            :logger                   => logger,
+            :dav_extensions           => DAV_EXTENSIONS,
+            :alway_include_dav_header => true,
+            :pretty_xml               => true,
+            :root_uri_path            => root_uri_path,
+            :resource_class           => DAV4Rack::Carddav::ContactResource,
+            :controller_class         => DAV4Rack::Carddav::Controller,
+            :current_user             => current_user
+          )
+        
+        r.add("#{root_path}books/:book_id").to DAV4RackExt::Handler.new(
+            :logger                   => logger,
+            :dav_extensions           => DAV_EXTENSIONS,
+            :alway_include_dav_header => true,
+            :pretty_xml               => true,
+            :root_uri_path            => root_uri_path,
+            :resource_class           => DAV4Rack::Carddav::AddressbookResource,
+            :controller_class         => DAV4Rack::Carddav::Controller,
+            :current_user             => current_user
+          )
+        
+      end
+    end
+    
+  end
+end

data/lib/dav4rack_ext/carddav/controller.rb

@@ -0,0 +1,117 @@
+module DAV4Rack
+  module Carddav
+    
+    class Controller < DAV4Rack::Controller
+      def initialize(*args, options, env)
+        super(*args, options.merge(env: env))
+      end
+      
+      def report
+        unless resource.exist?
+          return NotFound
+        end
+
+        if request_document.nil? or request_document.root.nil?
+          render_xml(:error) do |xml|
+            xml.send :'empty-request'
+          end
+          raise BadRequest
+        end
+
+        case request_document.root.name
+        when 'addressbook-multiget'
+          addressbook_multiget(request_document)
+        else
+          render_xml(:error) do |xml|
+            xml.send :'supported-report'
+          end
+          raise Forbidden
+        end
+      end
+      
+      
+    private
+      
+      def root_uri_path
+        tmp = @options[:root_uri_path]
+        tmp.respond_to?(:call) ? tmp.call(@options[:env]) : tmp
+      end
+      
+      def xpath_element(name, ns_uri=:dav)
+        case ns_uri
+        when :dav
+          ns_uri = 'DAV:'
+        when :carddav
+          ns_uri = 'urn:ietf:params:xml:ns:carddav'
+        end
+        "*[local-name()='#{name}' and namespace-uri()='#{ns_uri}']"
+      end
+      
+        include DAV4Rack::Utils
+        
+        def xpath_element(name, ns_uri=:dav)
+          case ns_uri
+          when :dav
+            ns_uri = 'DAV:'
+          when :carddav
+            ns_uri = 'urn:ietf:params:xml:ns:carddav'
+          end
+          "*[local-name()='#{name}' and namespace-uri()='#{ns_uri}']"
+        end
+        
+        def addressbook_multiget(request_document)
+          # TODO: Include a DAV:error response
+          # CardDAV §8.7 clearly states Depth must equal zero for this report
+          # But Apple's AddressBook.app sets the depth to infinity anyhow.
+          unless depth == 0 or depth == :infinity
+            render_xml(:error) do |xml|
+              xml.send :'invalid-depth'
+            end
+            raise BadRequest
+          end
+
+          props = request_document.xpath("/#{xpath_element('addressbook-multiget', :carddav)}/#{xpath_element('prop')}").children.find_all(&:element?).map{|n|
+            to_element_hash(n)
+          }
+          # Handle the address-data element
+          # - Check for child properties (vCard fields)
+          # - Check for mime-type and version.  If present they must match vCard 3.0 for now since we don't support anything else.
+          hrefs = request_document.xpath("/#{xpath_element('addressbook-multiget', :carddav)}/#{xpath_element('href')}").collect{|n| 
+            text = n.text
+            # TODO: Make sure that the hrefs passed into the report are either paths or fully qualified URLs with the right host+protocol+port prefix
+            path = URI.parse(text).path
+            Logger.debug "Scanned this HREF: #{text} PATH: #{path}"
+            text
+          }.compact
+          
+          if hrefs.empty?
+            xml_error(BadRequest) do |err|
+              err.send :'href-missing'
+            end
+          end
+
+          multistatus do |xml|
+            hrefs.each do |_href|
+              xml.response do
+                xml.href _href
+
+                path = File.split(URI.parse(_href).path).last
+                Logger.debug "Creating child w/ ORIG=#{resource.public_path} HREF=#{_href} FILE=#{path}!"
+                
+                cur_resource = resource.is_self?(_href) ? resource : resource.find_child(File.split(path).last)
+
+                if cur_resource && cur_resource.exist?
+                  propstats(xml, get_properties(cur_resource, props))
+                else
+                  xml.status "#{http_version} #{NotFound.status_line}"
+                end
+
+              end
+            end
+          end
+        end
+      
+    end
+    
+  end
+end

data/lib/dav4rack_ext/carddav/resource.rb

@@ -0,0 +1,140 @@
+module DAV4Rack
+  module Carddav
+    
+    class Resource < DAV4Rack::Resource
+      extend Helpers::Properties
+      
+      CARDAV_NS = 'urn:ietf:params:xml:ns:carddav'.freeze
+
+      PRIVILEGES = %w(read read-acl read-current-user-privilege-set)
+      
+      def initialize(*)
+        super
+        raise ArgumentError, "missing current_user lambda" unless options[:current_user]
+      end
+      
+      def current_user
+        @current_user ||= options[:current_user].call(env)
+      end
+      
+      def user_agent
+        env = options[:env]
+        if env
+          env['HTTP_USER_AGENT'] || ""
+        else
+          ""
+        end
+      end
+            
+      def router_params
+        env['router.params'] || {}
+      end
+      
+      def setup
+                
+        @propstat_relative_path = true
+        @root_xml_attributes = {
+          'xmlns:C' => CARDAV_NS, 
+          'xmlns:APPLE1' => 'http://calendarserver.org/ns/'
+        }
+      end
+
+      def is_self?(other_path)
+        ary = [@public_path]
+        ary.push(@public_path+'/') if @public_path[-1] != '/'
+        ary.push(@public_path[0..-2]) if @public_path[-1] == '/'
+        ary.include? other_path
+      end
+      
+      def get_property(element)
+        name = element[:name]
+        namespace = element[:ns_href]
+        
+        key = "#{namespace}*#{name}"
+        
+        handler = self.class.properties[key]
+        if handler
+          ret = instance_exec(element, &handler[0])
+          # TODO: find better than that
+          if ret.is_a?(String) && ret.include?('<')
+            Nokogiri::XML::DocumentFragment.parse(ret)
+          else
+            ret
+          end
+        else
+          Logger.debug("[#{self.class.name}] no handler for #{namespace}:#{name}")
+          super
+        end
+      end
+      
+      define_properties('DAV:') do
+        
+        property('current-user-privilege-set') do
+          <<-EOS
+            <D:current-user-privilege-set xmlns:D="DAV:">
+              #{get_privileges_aggregate}
+            </D:current-user-privilege-set>
+          EOS
+        end
+        
+        property('group') do
+          ""
+        end
+
+        property('owner') do
+          <<-EOS
+            <D:owner xmlns:D='DAV:'>
+              <D:href>#{root_uri_path}</D:href>
+            </D:owner>
+          EOS
+        end
+                
+      end
+
+      def properties
+        selected_properties = self.class.properties.reject{|key, arr| arr[1] == true }
+        ret = {}
+        selected_properties.keys.map do |key|
+          ns, name = key.split('*')
+          {:name => name, :ns_href => ns}
+        end
+      end
+      
+      def children
+        []
+      end
+
+
+    private
+      def env
+        options[:env] || {}
+      end
+
+      def root_uri_path
+        tmp = @options[:root_uri_path]
+        tmp.respond_to?(:call) ? tmp.call(env) : tmp
+      end
+      
+      def get_privileges_aggregate
+        privileges_aggregate = PRIVILEGES.inject('') do |ret, priv|
+          ret << '<D:privilege><%s /></privilege>' % priv
+        end
+      end
+      
+      def add_slashes(str)
+        "/#{str}/".squeeze('/')
+      end
+      
+      def child(child_class, child, parent = nil)
+        new_public = add_slashes(public_path)
+        new_path = add_slashes(path)
+
+        child_class.new("#{new_public}#{child.path}", "#{new_path}#{child.path}",
+            request, response, options.merge(_object_: child, _parent_: self)
+          )
+      end
+
+    end
+    
+  end
+end

data/lib/dav4rack_ext/carddav/resources/addressbook_collection_resource.rb

@@ -0,0 +1,23 @@
+module DAV4Rack
+  module Carddav
+    
+    class AddressbookCollectionResource < Resource
+      
+      def exist?
+        return true
+      end
+
+      def collection?
+        true
+      end
+
+      def children
+        current_user.all_addressbooks.map do |book|
+          child(AddressbookResource, book)
+        end
+      end
+            
+    end
+    
+  end
+end

data/lib/dav4rack_ext/carddav/resources/addressbook_resource.rb

@@ -0,0 +1,137 @@
+module DAV4Rack
+  module Carddav
+    
+    class AddressbookResource < Resource
+      
+      define_properties('DAV:') do
+        property('current-user-privilege-set') do
+          privileges = %w(read write write-properties write-content read-acl read-current-user-privilege-set)
+          s='<D:current-user-privilege-set xmlns:D="DAV:">%s</D:current-user-privilege-set>'
+
+          privileges_aggregate = privileges.inject('') do |ret, priv|
+            ret << '<D:privilege><%s /></privilege>' % priv
+          end
+
+          s % privileges_aggregate
+        end
+        
+        property('supported-report-set') do
+          reports = %w(addressbook-multiget)
+          s = "<supported-report-set>%s</supported-report-set>"
+          
+          reports_aggregate = reports.inject('') do |ret, report|
+            ret << "<report><C:%s xmlns:C='#{CARDAV_NS}'/></report>" % report
+          end
+          
+          s % reports_aggregate
+        end
+        
+        property('resourcetype') do
+          <<-EOS
+            <resourcetype>
+              <D:collection />
+              <C:addressbook xmlns:C="#{CARDAV_NS}"/>
+            </resourcetype>
+          EOS
+        end
+        
+        property('displayname') do
+          @address_book.name
+        end
+        
+        property('creationdate') do
+          @address_book.created_at
+        end
+        
+        property('getcontenttype') do
+          "httpd/unix-directory"
+        end
+
+        # property('getetag') do
+        #   '"None"'
+        # end
+
+        property('getlastmodified') do
+          @address_book.updated_at
+        end
+        
+      end
+      
+      
+      define_properties(CARDAV_NS) do
+        explicit do
+          property('max-resource-size') do
+            1024
+          end
+          
+          property('supported-address-data') do
+            <<-EOS
+              <C:supported-address-data xmlns:C='#{CARDAV_NS}'>
+                <C:address-data-type content-type='text/vcard' version='3.0' />
+              </C:supported-address-data>
+            EOS
+          end
+
+          property('addressbook-description') do
+            @address_book.name
+          end
+          
+          property('max-resource-size') do
+            
+          end
+          
+          # TODO: fill this
+          property('supported-collation-set') do
+            
+          end
+          
+        end
+        
+      end
+      
+      
+      define_properties('http://calendarserver.org/ns/') do
+        property('getctag') do
+          <<-EOS
+            <APPLE1:getctag xmlns:APPLE1='http://calendarserver.org/ns/'>
+              #{@address_book.updated_at.to_i}
+            </APPLE1:getctag>
+          EOS
+        end
+      end
+
+      def setup
+        super
+        @address_book = @options[:_object_] || current_user.current_addressbook()
+      end
+
+      def exist?
+        @address_book != nil
+      end
+
+      def collection?
+        true
+      end
+
+      def children
+        Logger.debug "ABR::children(#{public_path})"
+        @address_book.contacts.collect do |c|
+          Logger.debug "Trying to create this child (contact): #{c.uid.to_s}"
+          child(ContactResource, c, @address_book)
+        end
+      end
+            
+      def find_child(uid)
+        uid = File.basename(uid, '.vcf')
+        c = @address_book.find_contact(uid)
+        if c
+          child(ContactResource, c)
+        else
+          nil
+        end
+      end
+      
+    end
+    
+  end
+end