tilia-vobject 4.0.0.pre.alpha2

data/lib/tilia/v_object/parser/parser.rb

@@ -0,0 +1,61 @@
+module Tilia
+  module VObject
+    module Parser
+      # Abstract parser.
+      #
+      # This class serves as a base-class for the different parsers.
+      class Parser
+        # Turning on this option makes the parser more forgiving.
+        #
+        # In the case of the MimeDir parser, this means that the parser will
+        # accept slashes and underscores in property names, and it will also
+        # attempt to fix Microsoft vCard 2.1's broken line folding.
+        OPTION_FORGIVING ||= 1
+
+        # If this option is turned on, any lines we cannot parse will be ignored
+        # by the reader.
+        OPTION_IGNORE_INVALID_LINES ||= 2
+
+        # Bitmask of parser options.
+        #
+        # @var int
+        # RUBY: attr_accessor :options
+
+        # Creates the parser.
+        #
+        # Optionally, it's possible to parse the input stream here.
+        #
+        # @param mixed input
+        # @param int options Any parser options (OPTION constants).
+        #
+        # @return void
+        def initialize(input = nil, options = 0)
+          self.input = input unless input.nil?
+          @options = options
+        end
+
+        # This method starts the parsing process.
+        #
+        # If the input was not supplied during construction, it's possible to pass
+        # it here instead.
+        #
+        # If either input or options are not supplied, the defaults will be used.
+        #
+        # @param mixed input
+        # @param int options
+        #
+        # @return array
+        def parse(_input = nil, _options = 0)
+        end
+
+        # Sets the input data.
+        #
+        # @param mixed input
+        #
+        # @return void
+        def input=(_input)
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/parser/xml/element/key_value.rb

@@ -0,0 +1,60 @@
+module Tilia
+  module VObject
+    module Parser
+      class Xml
+        module Element
+          # Our own sabre/xml key-value element.
+          #
+          # It just removes the clark notation.
+          class KeyValue < Tilia::Xml::Element::KeyValue
+            # The deserialize method is called during xml parsing.
+            #
+            # This method is called staticly, 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.
+            #
+            # Important note 2: 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 XML\Reader reader
+            #
+            # @return mixed
+            def self.xml_deserialize(reader)
+              # If there's no children, we don't do anything.
+              if reader.empty_element?
+                reader.next
+                return {}
+              end
+
+              values = {}
+              reader.read
+
+              loop do
+                if reader.node_type == ::LibXML::XML::Reader::TYPE_ELEMENT
+                  name = reader.local_name
+                  values[name] = reader.parse_current_element['value']
+                else
+                  reader.read
+                end
+
+                break if reader.node_type == ::LibXML::XML::Reader::TYPE_END_ELEMENT
+              end
+
+              reader.read
+
+              values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/parser/xml/element.rb

@@ -0,0 +1,11 @@
+module Tilia
+  module VObject
+    module Parser
+      class Xml
+        module Element
+          require 'tilia/v_object/parser/xml/element/key_value'
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/parser/xml.rb

@@ -0,0 +1,322 @@
+module Tilia
+  module VObject
+    module Parser
+      # XML Parser.
+      #
+      # This parser parses both the xCal and xCard formats.
+      class Xml < Parser
+        require 'tilia/v_object/parser/xml/element'
+
+        XCAL_NAMESPACE ||= 'urn:ietf:params:xml:ns:icalendar-2.0'
+        XCARD_NAMESPACE ||= 'urn:ietf:params:xml:ns:vcard-4.0'
+
+        # The input data.
+        #
+        # @var array
+        # RUBY: attr_accessor :input
+
+        # A pointer/reference to the input.
+        #
+        # @var array
+        # RUBY: attr_accessor :pointer
+
+        # Document, root component.
+        #
+        # @var Sabre\VObject\Document
+        # RUBY: attr_accessor :root
+
+        # Creates the parser.
+        #
+        # Optionally, it's possible to parse the input stream here.
+        #
+        # @param mixed input
+        # @param int options Any parser options (OPTION constants).
+        #
+        # @return void
+        def initialize(input = nil, options = 0)
+          @input = nil
+          @pointer = nil
+          @root = nil
+
+          options = self.class::OPTION_FORGIVING if options == 0
+
+          super(input, options)
+        end
+
+        # Parse xCal or xCard.
+        #
+        # @param resource|string input
+        # @param int options
+        #
+        # @throws \Exception
+        #
+        # @return Sabre\VObject\Document
+        def parse(input = nil, options = 0)
+          self.input = input unless input.nil?
+          @options = options if options != 0
+          if @input.nil?
+            fail Tilia::VObject::EofException, 'End of input stream, or no input supplied'
+          end
+
+          case @input['name']
+          when "{#{self.class::XCAL_NAMESPACE}}icalendar"
+            @root = Tilia::VObject::Component::VCalendar.new({}, false)
+            @pointer = @input['value'][0]
+            parse_v_calendar_components(@root)
+          when "{#{self.class::XCARD_NAMESPACE}}vcards"
+            @input['value'].each do |v_card|
+              @root = Tilia::VObject::Component::VCard.new({ 'version' => '4.0' }, false)
+              @pointer = v_card
+              parse_v_card_components(@root)
+
+              # We just parse the first <vcard /> element.
+              break
+            end
+          else
+            fail Tilia::VObject::ParseException, 'Unsupported XML standard'
+          end
+
+          @root
+        end
+
+        protected
+
+        # Parse a xCalendar component.
+        #
+        # @param Component parent_component
+        #
+        # @return void
+        def parse_v_calendar_components(parent_component)
+          components = @pointer['value'] ? @pointer['value'] : []
+
+          components.each do |children|
+            case self.class.tag_name(children['name'])
+            when 'properties'
+              @pointer = children['value']
+              parse_properties(parent_component)
+            when 'components'
+              @pointer = children
+              parse_component(parent_component)
+            end
+          end
+        end
+
+        # Parse a xCard component.
+        #
+        # @param Component parent_component
+        #
+        # @return void
+        def parse_v_card_components(parent_component)
+          @pointer = @pointer['value']
+          parse_properties(parent_component)
+        end
+
+        # Parse xCalendar and xCard properties.
+        #
+        # @param Component parent_component
+        # @param string  property_name_prefix
+        #
+        # @return void
+        def parse_properties(parent_component, property_name_prefix = '')
+          properties = @pointer ? @pointer : {}
+
+          properties.each do |xml_property|
+            (namespace, tag_name) = Tilia::Xml::Service.parse_clark_notation(xml_property['name'])
+
+            property_name       = tag_name
+            property_value      = nil
+            property_parameters = {}
+            property_type       = 'text'
+
+            # A property which is not part of the standard.
+            if namespace != Tilia::VObject::Parser::Xml::XCAL_NAMESPACE && namespace != Tilia::VObject::Parser::Xml::XCARD_NAMESPACE
+              property_name = 'xml'
+              value = "<#{tag_name} xmlns=\"#{namespace}\""
+
+              xml_property['attributes'].each do |attribute_name, attribute_value|
+                value += " #{attribute_name}=\"#{attribute_value.gsub('"', '\\"')}\""
+              end
+              value += ">#{xml_property['value']}</#{tag_name}>"
+
+              property_value = [value]
+
+              create_property(
+                parent_component,
+                property_name,
+                property_parameters,
+                property_type,
+                property_value
+              )
+
+              next
+            end
+
+            # xCard group.
+            if property_name == 'group'
+              next unless xml_property['attributes'].key?('name')
+
+              @pointer = xml_property['value']
+              parse_properties(
+                parent_component,
+                xml_property['attributes']['name'].upcase + '.'
+              )
+
+              next
+            end
+
+            # Collect parameters.
+            xml_property['value'] = xml_property['value'].map do |xml_property_child|
+              if !xml_property_child.is_a?(Hash) || 'parameters' != self.class.tag_name(xml_property_child['name'])
+                xml_property_child
+              else
+                xml_parameters = xml_property_child['value']
+
+                xml_parameters.each do |xml_parameter|
+                  property_parameter_values = []
+
+                  xml_parameter['value'].each do |xml_parameter_values|
+                    property_parameter_values << xml_parameter_values['value']
+                  end
+
+                  property_parameters[self.class.tag_name(xml_parameter['name'])] = property_parameter_values.join(',')
+                end
+
+                nil # We will delete this with compact()
+              end
+            end
+
+            xml_property['value'].compact!
+
+            property_name_extended = (@root.is_a?(Tilia::VObject::Component::VCalendar) ? 'xcal' : 'xcard') + ':' + property_name
+
+            case property_name_extended
+            when 'xcal:geo'
+              property_type = 'float'
+              property_value ||= {}
+              property_value['latitude']  = 0.0
+              property_value['longitude'] = 0.0
+
+              xml_property['value'].each do |xml_request_child|
+                property_value[self.class.tag_name(xml_request_child['name'])] = xml_request_child['value']
+              end
+            when 'xcal:request-status'
+              property_type = 'text'
+
+              property_value ||= {}
+              xml_property['value'].each do |xml_request_child|
+                property_value[self.class.tag_name(xml_request_child['name'])] = xml_request_child['value']
+              end
+            when 'xcal:freebusy', 'xcal:categories', 'xcal:resources', 'xcal:exdate'
+              property_type = 'freebusy' if property_name_extended == 'xcal:freebusy'
+              # We don't break because we only want to set
+              # another property type.
+
+              xml_property['value'].each do |special_child|
+                property_value ||= {}
+                property_value[self.class.tag_name(special_child['name'])] = special_child['value']
+              end
+            when 'xcal:rdate'
+              property_type = 'date-time'
+              property_value ||= []
+
+              xml_property['value'].each do |special_child|
+                tag_name = self.class.tag_name(special_child['name'])
+
+                if 'period' == tag_name
+                  property_parameters['value'] = 'PERIOD'
+                  property_value << special_child['value'].values.join('/')
+                else
+                  property_value << special_child['value']
+                end
+              end
+            else
+              property_type  = self.class.tag_name(xml_property['value'][0]['name'])
+
+              property_value ||= []
+              xml_property['value'].each do |value|
+                property_value << value['value']
+              end
+
+              property_parameters['value'] = 'DATE' if 'date' == property_type
+            end
+
+            create_property(
+              parent_component,
+              property_name_prefix + property_name,
+              property_parameters,
+              property_type,
+              property_value
+            )
+          end
+        end
+
+        # Parse a component.
+        #
+        # @param Component parent_component
+        #
+        # @return void
+        def parse_component(parent_component)
+          components = @pointer['value'] ? @pointer['value'] : []
+
+          components.each do |component|
+            component_name    = self.class.tag_name(component['name'])
+            current_component = @root.create_component(component_name, nil, false)
+
+            @pointer = component
+            parse_v_calendar_components(current_component)
+
+            parent_component.add(current_component)
+          end
+        end
+
+        # Create a property.
+        #
+        # @param Component parent_component
+        # @param string name
+        # @param array parameters
+        # @param string type
+        # @param mixed value
+        #
+        # @return void
+        def create_property(parent_component, name, parameters, type, value)
+          property = @root.create_property(name, nil, parameters, type)
+          parent_component.add(property)
+          property.xml_value = value
+        end
+
+        public
+
+        # Sets the input data.
+        #
+        # @param resource|string input
+        #
+        # @return void
+        def input=(input)
+          input = input.readlines.join('') if input.respond_to?(:readlines)
+
+          if input.is_a?(String)
+            reader = Tilia::Xml::Reader.new
+            reader.element_map["{#{self.class::XCAL_NAMESPACE}}period"] = Tilia::VObject::Parser::Xml::Element::KeyValue
+            reader.element_map["{#{self.class::XCAL_NAMESPACE}}recur"] = Tilia::VObject::Parser::Xml::Element::KeyValue
+            reader.xml(input)
+            input = reader.parse
+          end
+
+          @input = input
+        end
+
+        protected
+
+        # Get tag name from a Clark notation.
+        #
+        # @param string clarked_tag_name
+        #
+        # @return string
+        def self.tag_name(clarked_tag_name)
+          (_, tag_name) = Tilia::Xml::Service.parse_clark_notation(clarked_tag_name)
+          tag_name
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/parser.rb

@@ -0,0 +1,10 @@
+module Tilia
+  module VObject
+    module Parser
+      require 'tilia/v_object/parser/parser'
+      require 'tilia/v_object/parser/mime_dir'
+      require 'tilia/v_object/parser/json'
+      require 'tilia/v_object/parser/xml'
+    end
+  end
+end

data/lib/tilia/v_object/property/binary.rb

@@ -0,0 +1,96 @@
+require 'base64'
+module Tilia
+  module VObject
+    class Property
+      # BINARY property.
+      #
+      # This object represents BINARY values.
+      #
+      # Binary values are most commonly used by the iCalendar ATTACH property, and
+      # the vCard PHOTO property.
+      #
+      # This property will transparently encode and decode to base64.
+      class Binary < Property
+        # In case this is a multi-value property. This string will be used as a
+        # delimiter.
+        #
+        # @var string|null
+        attr_accessor :delimiter
+
+        # Updates the current value.
+        #
+        # This may be either a single, or multiple strings in an array.
+        #
+        # @param string|array value
+        #
+        # @return void
+        def value=(value)
+          if value.is_a?(Array)
+            if value.size == 1
+              @value = value.first
+            else
+              fail ArgumentError, 'The argument must either be a string or an array with only one child'
+            end
+          else
+            @value = value
+          end
+        end
+
+        # Sets a raw value coming from a mimedir (iCalendar/vCard) file.
+        #
+        # This has been 'unfolded', so only 1 line will be passed. Unescaping is
+        # not yet done, but parameters are not included.
+        #
+        # @param string val
+        #
+        # @return void
+        def raw_mime_dir_value=(val)
+          @value = Base64.decode64(val)
+        end
+
+        # Returns a raw mime-dir representation of the value.
+        #
+        # @return string
+        def raw_mime_dir_value
+          Base64.strict_encode64(@value)
+        end
+
+        # Returns the type of value.
+        #
+        # This corresponds to the VALUE= parameter. Every property also has a
+        # 'default' valueType.
+        #
+        # @return string
+        def value_type
+          'BINARY'
+        end
+
+        # Returns the value, in the format it should be encoded for json.
+        #
+        # This method must always return an array.
+        #
+        # @return array
+        def json_value
+          [Base64.strict_encode64(value)]
+        end
+
+        # Sets the json value, as it would appear in a jCard or jCal object.
+        #
+        # The value must always be an array.
+        #
+        # @param array value
+        #
+        # @return void
+        def json_value=(value)
+          value = value.map { |v| Base64.decode64(v) }
+          super(value)
+        end
+
+        def initialize(*args)
+          super(*args)
+          @delimiter = nil
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/property/boolean.rb

@@ -0,0 +1,57 @@
+module Tilia
+  module VObject
+    class Property
+      # Boolean property.
+      #
+      # This object represents BOOLEAN values. These are always the case-insenstive
+      # string TRUE or FALSE.
+      #
+      # Automatic conversion to PHP's true and false are done.
+      class Boolean < Property
+        # Sets a raw value coming from a mimedir (iCalendar/vCard) file.
+        #
+        # This has been 'unfolded', so only 1 line will be passed. Unescaping is
+        # not yet done, but parameters are not included.
+        #
+        # @param string val
+        #
+        # @return void
+        def raw_mime_dir_value=(val)
+          val = val.upcase == 'TRUE' ? true : false
+          self.value = val
+        end
+
+        # Returns a raw mime-dir representation of the value.
+        #
+        # @return string
+        def raw_mime_dir_value
+          @value ? 'TRUE' : 'FALSE'
+        end
+
+        # Returns the type of value.
+        #
+        # This corresponds to the VALUE= parameter. Every property also has a
+        # 'default' valueType.
+        #
+        # @return string
+        def value_type
+          'BOOLEAN'
+        end
+
+        # Hydrate data from a XML subtree, as it would appear in a xCard or xCal
+        # object.
+        #
+        # @param array value
+        #
+        # @return void
+        def xml_value=(value)
+          value = value.map do |v|
+            'true' == v
+          end
+
+          super(value)
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/property/flat_text.rb

@@ -0,0 +1,52 @@
+module Tilia
+  module VObject
+    class Property
+      # FlatText property.
+      #
+      # This object represents certain TEXT values.
+      #
+      # Specifically, this property is used for text values where there is only 1
+      # part. Semi-colons and colons will be de-escaped when deserializing, but if
+      # any semi-colons or commas appear without a backslash, we will not assume
+      # that they are delimiters.
+      #
+      # vCard 2.1 specifically has a whole bunch of properties where this may
+      # happen, as it only defines a delimiter for a few properties.
+      #
+      # vCard 4.0 states something similar. An unescaped semi-colon _may_ be a
+      # delimiter, depending on the property.
+      class FlatText < Property::Text
+        # Field separator.
+        #
+        # @var string
+        attr_accessor :delimiter
+
+        # Sets the value as a quoted-printable encoded string.
+        #
+        # Overriding this so we're not splitting on a ; delimiter.
+        #
+        # @param string val
+        #
+        # @return void
+        def quoted_printable_value=(val)
+          val = Mail::Encodings::QuotedPrintable.decode(val)
+          val = val.gsub(/\n/, "\r\n").gsub(/\r\r/, "\r")
+
+          # force the correct encoding
+          begin
+            val.force_encoding(Encoding.find(@parameters['CHARSET'].to_s))
+          rescue
+            val.force_encoding(Encoding::UTF_8)
+          end
+
+          self.value = val
+        end
+
+        def initialize(*args)
+          super(*args)
+          @delimiter = ','
+        end
+      end
+    end
+  end
+end