tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/card_dav/xml/request.rb

@@ -0,0 +1,10 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Request
+        require 'tilia/card_dav/xml/request/address_book_multi_get_report'
+        require 'tilia/card_dav/xml/request/address_book_query_report'
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/xml/request/address_book_multi_get_report.rb

@@ -0,0 +1,91 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Request
+        # AddressBookMultiGetReport request parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:carddav}addressbook-multiget
+        # REPORT, as defined in:
+        #
+        # http://tools.ietf.org/html/rfc6352#section-8.7
+        class AddressBookMultiGetReport
+          include Tilia::Xml::XmlDeserializable
+
+          # An array with requested properties.
+          #
+          # @var array
+          attr_accessor :properties
+
+          # This is an array with the urls that are being requested.
+          #
+          # @var array
+          attr_accessor :hrefs
+
+          # The mimetype of the content that should be returend. Usually
+          # text/vcard.
+          #
+          # @var string
+          attr_accessor :content_type
+
+          # The version of vcard data that should be returned. Usually 3.0,
+          # referring to vCard 3.0.
+          #
+          # @var string
+          attr_accessor :version
+
+          # 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(
+              '{urn:ietf:params:xml:ns:carddav}address-data' => Filter::AddressData,
+              '{DAV:}prop'                                   => Tilia::Xml::Element::KeyValue
+            )
+
+            new_props = {
+              'hrefs'      => [],
+              'properties' => []
+            }
+
+            elems.each do |elem|
+              case elem['name']
+              when '{DAV:}prop'
+                new_props['properties'] = elem['value'].keys
+                if elem['value'].key?("{#{Plugin::NS_CARDDAV}}address-data")
+                  new_props = new_props.merge(elem['value']["{#{Plugin::NS_CARDDAV}}address-data"])
+                end
+              when '{DAV:}href'
+                new_props['hrefs'] << Uri.resolve(reader.context_uri, elem['value'])
+              end
+            end
+
+            obj = new
+            new_props.each do |key, value|
+              key = key.underscore
+              next unless %w(properties hrefs content_type version).include?(key)
+              obj.send("#{key}=".to_sym, value)
+            end
+
+            obj
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/xml/request/address_book_query_report.rb

@@ -0,0 +1,156 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Request
+        # AddressBookQueryReport request parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:carddav}addressbook-query
+        # REPORT, as defined in:
+        #
+        # http://tools.ietf.org/html/rfc6352#section-8.6
+        class AddressBookQueryReport
+          include Tilia::Xml::XmlDeserializable
+
+          # An array with requested properties.
+          #
+          # @var array
+          attr_accessor :properties
+
+          # List of property/component filters.
+          #
+          # This is an array with filters. Every item is a property filter. Every
+          # property filter has the following keys:
+          #   * name - name of the component to filter on
+          #   * test - anyof or allof
+          #   * is-not-defined - Test for non-existence
+          #   * param-filters - A list of parameter filters on the property
+          #   * text-matches - A list of text values the filter needs to match
+          #
+          # Each param-filter has the following keys:
+          #   * name - name of the parameter
+          #   * is-not-defined - Test for non-existence
+          #   * text-match - Match the parameter value
+          #
+          # Each text-match in property filters, and the single text-match in
+          # param-filters have the following keys:
+          #
+          #   * value - value to match
+          #   * match-type - contains, starts-with, ends-with, equals
+          #   * negate-condition - Do the opposite match
+          #   * collation - Usually i;unicode-casemap
+          #
+          # @var array
+          attr_accessor :filters
+
+          # The number of results the client wants
+          #
+          # null means it wasn't specified, which in most cases means 'all results'.
+          #
+          # @var int|null
+          attr_accessor :limit
+
+          # Either 'anyof' or 'allof'
+          #
+          # @var string
+          attr_accessor :test
+
+          # The mimetype of the content that should be returend. Usually
+          # text/vcard.
+          #
+          # @var string
+          attr_accessor :content_type
+
+          # The version of vcard data that should be returned. Usually 3.0,
+          # referring to vCard 3.0.
+          #
+          # @var string
+          attr_accessor :version
+
+          # 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(
+              '{urn:ietf:params:xml:ns:carddav}prop-filter'  => Filter::PropFilter,
+              '{urn:ietf:params:xml:ns:carddav}param-filter' => Filter::ParamFilter,
+              '{urn:ietf:params:xml:ns:carddav}address-data' => Filter::AddressData,
+              '{DAV:}prop'                                   => Tilia::Xml::Element::KeyValue
+            )
+
+            new_props = {
+              'filters'    => nil,
+              'properties' => [],
+              'test'       => 'anyof',
+              'limit'      => nil
+            }
+
+            (elems || []).each do |elem|
+              case elem['name']
+              when '{DAV:}prop'
+                new_props['properties'] = elem['value'].keys
+                if elem['value'].key?("{#{Plugin::NS_CARDDAV}}address-data")
+                  new_props = new_props.merge(elem['value']["{#{Plugin::NS_CARDDAV}}address-data"])
+                end
+              when "{#{Plugin::NS_CARDDAV}}filter"
+                fail Dav::Exception::BadRequest, "You can only include 1 {#{Plugin::NS_CARDDAV}}filter element" unless new_props['filters'].nil?
+
+                if elem['attributes'].key?('test')
+                  new_props['test'] = elem['attributes']['test']
+                  if new_props['test'] != 'allof' && new_props['test'] != 'anyof'
+                    fail Dav::Exception::BadRequest, 'The "test" attribute must be one of "allof" or "anyof"'
+                  end
+                end
+
+                new_props['filters'] = []
+                (elem['value'] || []).each do |sub_elem|
+                  if sub_elem['name'] == "{#{Plugin::NS_CARDDAV}}prop-filter"
+                    new_props['filters'] << sub_elem['value']
+                  end
+                end
+              when "{#{Plugin::NS_CARDDAV}}limit"
+                elem['value'].each do |child|
+                  if child['name'] == "{#{Plugin::NS_CARDDAV}}nresults"
+                    new_props['limit'] = child['value'].to_i
+                  end
+                end
+              end
+            end
+
+            if new_props['filters'].nil?
+              # We are supposed to throw this error, but KDE sometimes does not
+              # include the filter element, and we need to treat it as if no
+              # filters are supplied
+              # throw new Bad_request('The {#{Plugin::NS_CARDDAV}}filter element is required for this request')
+              new_props['filters'] = []
+            end
+
+            obj = new
+            new_props.each do |key, value|
+              key = key.underscore
+              next unless %w(version content_type test limit filters properties).include?(key)
+              obj.send("#{key}=".to_sym, value)
+            end
+
+            obj
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav.rb

@@ -0,0 +1,94 @@
+class Object
+  def scalar?
+    is_a?(Numeric) ||
+      is_a?(FalseClass) ||
+      is_a?(TrueClass) ||
+      is_a?(String)
+  end
+end
+
+module Tilia
+  # Load active support core extensions
+  require 'active_support'
+  require 'active_support/core_ext'
+
+  # Filesystem helpers (for quota)
+  require 'sys/filesystem'
+
+  # XML lib
+  require 'libxml'
+
+  # Time helper parse('tomorrow')
+  require 'chronic'
+
+  # mail helper
+  require 'mail'
+
+  # Tilia libraries
+  require 'tilia/vobject'
+  require 'tilia/event'
+  require 'tilia/xml'
+  require 'tilia/http'
+  require 'tilia/uri'
+
+  module Dav
+    # Interfaces
+    require 'tilia/dav/i_node'
+    require 'tilia/dav/i_collection'
+    require 'tilia/dav/i_extended_collection'
+    require 'tilia/dav/i_file'
+    require 'tilia/dav/i_move_target'
+    require 'tilia/dav/i_multi_get'
+    require 'tilia/dav/i_properties'
+    require 'tilia/dav/i_quota'
+
+    # core components
+    require 'tilia/dav/node'
+    require 'tilia/dav/collection'
+    require 'tilia/dav/exception'
+    require 'tilia/dav/file'
+    require 'tilia/dav/prop_patch'
+    require 'tilia/dav/mk_col'
+    require 'tilia/dav/prop_find'
+    require 'tilia/dav/server_plugin'
+    require 'tilia/dav/server'
+    require 'tilia/dav/simple_collection'
+    require 'tilia/dav/simple_file'
+    require 'tilia/dav/string_util'
+    require 'tilia/dav/tree'
+    require 'tilia/dav/uuid_util'
+    require 'tilia/dav/version'
+
+    # Stuff
+    require 'tilia/dav/client'
+
+    # Plugins
+    require 'tilia/dav/auth'
+    require 'tilia/dav/browser'
+    require 'tilia/dav/core_plugin'
+    require 'tilia/dav/locks'
+    require 'tilia/dav/mount'
+    require 'tilia/dav/partial_update'
+    require 'tilia/dav/property_storage'
+    require 'tilia/dav/sync'
+    require 'tilia/dav/temporary_file_filter_plugin'
+
+    # Filesystem examples
+    require 'tilia/dav/fs'
+    require 'tilia/dav/fs_ext'
+
+    require 'tilia/dav/xml'
+  end
+
+  require 'tilia/dav_acl'
+  require 'tilia/cal_dav'
+  require 'tilia/card_dav'
+
+  class Box
+    attr_accessor :value
+
+    def initialize(v = nil)
+      @value = v
+    end
+  end
+end

data/lib/tilia/dav/auth.rb

@@ -0,0 +1,8 @@
+module Tilia
+  module Dav
+    module Auth
+      require 'tilia/dav/auth/backend'
+      require 'tilia/dav/auth/plugin'
+    end
+  end
+end

data/lib/tilia/dav/auth/backend.rb

@@ -0,0 +1,15 @@
+module Tilia
+  module Dav
+    module Auth
+      module Backend
+        require 'tilia/dav/auth/backend/backend_interface'
+        require 'tilia/dav/auth/backend/abstract_basic'
+        require 'tilia/dav/auth/backend/abstract_digest'
+        require 'tilia/dav/auth/backend/apache'
+        require 'tilia/dav/auth/backend/basic_call_back'
+        require 'tilia/dav/auth/backend/file'
+        require 'tilia/dav/auth/backend/sequel'
+      end
+    end
+  end
+end

data/lib/tilia/dav/auth/backend/abstract_basic.rb

@@ -0,0 +1,119 @@
+module Tilia
+  module Dav
+    module Auth
+      module Backend
+        # HTTP Basic authentication backend class
+        #
+        # This class can be used by authentication objects wishing to use HTTP Basic
+        # Most of the digest logic is handled, implementors just need to worry about
+        # the validateUserPass method.
+        class AbstractBasic
+          include BackendInterface
+
+          # Authentication Realm.
+          #
+          # The realm is often displayed by browser clients when showing the
+          # authentication dialog.
+          #
+          # @var string
+          # RUBY: attr_accessor :realm
+
+          # This is the prefix that will be used to generate principal urls.
+          #
+          # @var string
+          # RUBY: attr_accessor :principal_prefix
+
+          protected
+
+          # Validates a username and password
+          #
+          # This method should return true or false depending on if login
+          # succeeded.
+          #
+          # @param string username
+          # @param string password
+          # @return bool
+          def validate_user_pass(_username, _password)
+          end
+
+          public
+
+          # Sets the authentication realm for this backend.
+          #
+          # @param string realm
+          # @return void
+          attr_writer :realm
+
+          # When this method is called, the backend must check if authentication was
+          # successful.
+          #
+          # The returned value must be one of the following
+          #
+          # [true, "principals/username"]
+          # [false, "reason for failure"]
+          #
+          # If authentication was successful, it's expected that the authentication
+          # backend returns a so-called principal url.
+          #
+          # Examples of a principal url:
+          #
+          # principals/admin
+          # principals/user1
+          # principals/users/joe
+          # principals/uid/123457
+          #
+          # If you don't use WebDAV ACL (RFC3744) we recommend that you simply
+          # return a string such as:
+          #
+          # principals/users/[username]
+          #
+          # @param RequestInterface request
+          # @param ResponseInterface response
+          # @return array
+          def check(request, response)
+            auth = Http::Auth::Basic.new(@realm, request, response)
+
+            userpass = auth.credentials
+            if userpass.blank?
+              return [false, "No 'Authorization: Basic' header found. Either the client didn't send one, or the server is misconfigured"]
+            end
+            unless validate_user_pass(userpass[0], userpass[1])
+              return [false, 'Username or password was incorrect']
+            end
+            [true, @principal_prefix + userpass[0]]
+          end
+
+          # This method is called when a user could not be authenticated, and
+          # authentication was required for the current request.
+          #
+          # This gives you the opportunity to set authentication headers. The 401
+          # status code will already be set.
+          #
+          # In this case of Basic Auth, this would for example mean that the
+          # following header needs to be set:
+          #
+          # response.add_header('WWW-Authenticate', 'Basic realm=SabreDAV')
+          #
+          # Keep in mind that in the case of multiple authentication backends, other
+          # WWW-Authenticate headers may already have been set, and you'll want to
+          # append your own WWW-Authenticate header instead of overwriting the
+          # existing one.
+          #
+          # @param RequestInterface request
+          # @param ResponseInterface response
+          # @return void
+          def challenge(request, response)
+            auth = Http::Auth::Basic.new(@realm, request, response)
+            auth.require_login
+          end
+
+          # TODO: document
+          def initialize
+            @realm = 'sabre/dav'
+            @principal_prefix = 'principals/'
+          end
+        end
+      end
+    end
+  end
+end