tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/card_dav/vcf_export_plugin.rb

@@ -0,0 +1,122 @@
+module Tilia
+  module CardDav
+    # VCF Exporter
+    #
+    # This plugin adds the ability to export entire address books as .vcf files.
+    # This is useful for clients that don't support CardDAV yet. They often do
+    # support vcf files.
+    class VcfExportPlugin < Dav::ServerPlugin
+      protected
+
+      # Reference to Server class
+      #
+      # @var Sabre\DAV\Server
+      attr_accessor :server
+
+      public
+
+      # Initializes the plugin and registers event handlers
+      #
+      # @param DAV\Server server
+      # @return void
+      def setup(server)
+        @server = server
+        @server.on('method:GET', method(:http_get), 90)
+        server.on(
+          'browserButtonActions',
+          lambda do |path, node, actions|
+            if node.is_a?(IAddressBook)
+              actions.value << "<a href=\"#{CGI.escapeHTML(path)}?export\"><span class=\"oi\" data-glyph=\"book\"></span></a>"
+            end
+          end
+        )
+      end
+
+      # Intercepts GET requests on addressbook urls ending with ?export.
+      #
+      # @param RequestInterface request
+      # @param ResponseInterface response
+      # @return bool
+      def http_get(request, response)
+        query_params = request.query_parameters
+        return true unless query_params.key?('export')
+
+        path = request.path
+
+        node = @server.tree.node_for_path(path)
+
+        return true unless node.is_a?(IAddressBook)
+
+        @server.transaction_type = 'get-addressbook-export'
+
+        # Checking ACL, if available.
+        acl_plugin = @server.plugin('acl')
+        acl_plugin.check_privileges(path, '{DAV:}read') if acl_plugin
+
+        response.update_header('Content-Type', 'text/directory')
+        response.status = 200
+
+        nodes = @server.properties_for_path(
+          path,
+          ["{#{Plugin::NS_CARDDAV}}address-data"],
+          1
+        )
+
+        response.body = generate_vcf(nodes)
+
+        # Returning false to break the event chain
+        false
+      end
+
+      # Merges all vcard objects, and builds one big vcf export
+      #
+      # @param array nodes
+      # @return string
+      def generate_vcf(nodes)
+        output = ''
+
+        nodes.each do |node|
+          next unless node[200].key?("{#{Plugin::NS_CARDDAV}}address-data")
+
+          node_data = node[200]["{#{Plugin::NS_CARDDAV}}address-data"]
+
+          # Parsing this node so VObject can clean up the output.
+          vcard = VObject::Reader.read(node_data)
+          output << vcard.serialize
+
+          # Destroy circular references to PHP will GC the object.
+          vcard.destroy
+        end
+
+        output
+      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
+        'vcf-export'
+      end
+
+      # 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' => 'Adds the ability to export CardDAV addressbooks as a single vCard file.',
+          'link'        => 'http://sabre.io/dav/vcf-export-plugin/'
+        }
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/xml.rb

@@ -0,0 +1,9 @@
+module Tilia
+  module CardDav
+    module Xml
+      require 'tilia/card_dav/xml/filter'
+      require 'tilia/card_dav/xml/property'
+      require 'tilia/card_dav/xml/request'
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Filter
+        require 'tilia/card_dav/xml/filter/address_data'
+        require 'tilia/card_dav/xml/filter/param_filter'
+        require 'tilia/card_dav/xml/filter/prop_filter'
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/xml/filter/address_data.rb

@@ -0,0 +1,50 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Filter
+        # AddressData parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:carddav}address-data XML
+        # element, as defined in:
+        #
+        # http://tools.ietf.org/html/rfc6352#section-10.4
+        #
+        # This element is used in two distinct places, but this one specifically
+        # encodes the address-data element as it appears in the addressbook-query
+        # adressbook-multiget REPORT requests.
+        class AddressData
+          include Tilia::Xml::XmlDeserializable
+
+          # 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)
+            result = {
+              'contentType' => reader.get_attribute('content-type') || 'text/vcard',
+              'version'     => reader.get_attribute('version') || '3.0'
+            }
+
+            reader.next
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/xml/filter/param_filter.rb

@@ -0,0 +1,71 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Filter
+        # ParamFilter parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:carddav}param-filter XML
+        # element, as defined in:
+        #
+        # http://tools.ietf.org/html/rfc6352#section-10.5.2
+        #
+        # The result will be spit out as an array.
+        class ParamFilter
+          include Tilia::Xml::Element
+
+          # 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)
+            result = {
+              'name'           => nil,
+              'is-not-defined' => false,
+              'text-match'     => nil
+            }
+
+            att = reader.parse_attributes
+            result['name'] = att['name']
+
+            elems = reader.parse_inner_tree
+
+            (elems || []).each do |elem|
+              case elem['name']
+              when "{#{Plugin::NS_CARDDAV}}is-not-defined"
+                result['is-not-defined'] = true
+              when "{#{Plugin::NS_CARDDAV}}text-match"
+                match_type = elem['attributes'].key?('match-type') ? elem['attributes']['match-type'] : 'contains'
+
+                fail Dav::Exception::BadRequest, "Unknown match-type: #{match_type}" unless %w(contains equals starts-with ends-with).include?(match_type)
+
+                result['text-match'] = {
+                  'negate-condition' => elem['attributes'].key?('negate-condition') && elem['attributes']['negate-condition'] == 'yes',
+                  'collation'        => elem['attributes'].key?('collation') ? elem['attributes']['collation'] : 'i;unicode-casemap',
+                  'value'            => elem['value'],
+                  'match-type'       => match_type
+                }
+              end
+            end
+
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/xml/filter/prop_filter.rb

@@ -0,0 +1,77 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Filter
+        # PropFilter parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:carddav}prop-filter XML
+        # element, as defined in:
+        #
+        # http://tools.ietf.org/html/rfc6352#section-10.5.1
+        #
+        # The result will be spit out as an array.
+        class PropFilter
+          include Tilia::Xml::XmlDeserializable
+
+          # 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)
+            result = {
+              'name'           => nil,
+              'test'           => 'anyof',
+              'is-not-defined' => false,
+              'param-filters'  => [],
+              'text-matches'   => []
+            }
+
+            att = reader.parse_attributes
+            result['name'] = att['name']
+
+            result['test'] = 'allof' if att['test'] == 'allof'
+
+            elems = reader.parse_inner_tree
+
+            (elems || []).each do |elem|
+              case elem['name']
+              when "{#{Plugin::NS_CARDDAV}}param-filter"
+                result['param-filters'] << elem['value']
+              when "{#{Plugin::NS_CARDDAV}}is-not-defined"
+                result['is-not-defined'] = true
+              when "{#{Plugin::NS_CARDDAV}}text-match"
+                match_type = elem['attributes'].key?('match-type') ? elem['attributes']['match-type'] : 'contains'
+
+                fail Dav::Exception::BadRequest, "Unknown match-type: #{match_type}" unless %w(contains equals starts-with ends-with).include?(match_type)
+
+                result['text-matches'] << {
+                  'negate-condition' => elem['attributes'].key?('negate-condition') && elem['attributes']['negate-condition'] == 'yes',
+                  'collation'        => elem['attributes'].key?('collation') ? elem['attributes']['collation'] : 'i;unicode-casemap',
+                  'value'            => elem['value'],
+                  'match-type'       => match_type
+                }
+              end
+            end
+
+            result
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Property
+        require 'tilia/card_dav/xml/property/supported_address_data'
+        require 'tilia/card_dav/xml/property/supported_collation_set'
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/xml/property/supported_address_data.rb

@@ -0,0 +1,67 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Property
+        # Supported-address-data property
+        #
+        # This property is a representation of the supported-address-data property
+        # in the CardDAV namespace.
+        #
+        # This property is defined in:
+        #
+        # http://tools.ietf.org/html/rfc6352#section-6.2.2
+        class SupportedAddressData
+          include Tilia::Xml::XmlSerializable
+
+          # @!attribute [rw] supported versions
+          #   @!visibility private
+          #
+          #   @return [Array]
+
+          # Creates the property
+          #
+          # @param array|null supported_data
+          def initialize(supported_data = nil)
+            if supported_data.nil?
+              supported_data = [
+                { 'contentType' => 'text/vcard', 'version' => '3.0' },
+                { 'contentType' => 'text/vcard', 'version' => '4.0' },
+                { 'contentType' => 'application/vcard+json', 'version' => '4.0' }
+              ]
+            end
+
+            @supported_data = supported_data
+          end
+
+          # The xmlSerialize metod is called during xml writing.
+          #
+          # Use the writer argument to write its own xml serialization.
+          #
+          # An important note: do _not_ create a parent element. Any element
+          # implementing XmlSerializble should only ever write what's considered
+          # its 'inner xml'.
+          #
+          # The parent of the current element is responsible for writing a
+          # containing element.
+          #
+          # This allows serializers to be re-used for different element names.
+          #
+          # If you are opening new elements, you must also close them again.
+          #
+          # @param Writer writer
+          # @return void
+          def xml_serialize(writer)
+            @supported_data.each do |supported|
+              writer.start_element("{#{Plugin::NS_CARDDAV}}address-data-type")
+              writer.write_attributes(
+                'content-type' => supported['contentType'],
+                'version'      => supported['version']
+              )
+              writer.end_element # address-data-type
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/card_dav/xml/property/supported_collation_set.rb

@@ -0,0 +1,38 @@
+module Tilia
+  module CardDav
+    module Xml
+      module Property
+        # supported-collation-set property
+        #
+        # This property is a representation of the supported-collation-set property
+        # in the CardDAV namespace.
+        class SupportedCollationSet
+          include Tilia::Xml::XmlSerializable
+
+          # The xmlSerialize metod is called during xml writing.
+          #
+          # Use the writer argument to write its own xml serialization.
+          #
+          # An important note: do _not_ create a parent element. Any element
+          # implementing XmlSerializble should only ever write what's considered
+          # its 'inner xml'.
+          #
+          # The parent of the current element is responsible for writing a
+          # containing element.
+          #
+          # This allows serializers to be re-used for different element names.
+          #
+          # If you are opening new elements, you must also close them again.
+          #
+          # @param Writer writer
+          # @return void
+          def xml_serialize(writer)
+            ['i;ascii-casemap', 'i;octet', 'i;unicode-casemap'].each do |coll|
+              writer.write_element('{urn:ietf:params:xml:ns:carddav}supported-collation', coll)
+            end
+          end
+        end
+      end
+    end
+  end
+end