tilia-vobject 4.0.0.pre.alpha2

data/lib/tilia/v_object/recur.rb

@@ -0,0 +1,10 @@
+module Tilia
+  module VObject
+    module Recur
+      require 'tilia/v_object/recur/no_instances_exception'
+      require 'tilia/v_object/recur/event_iterator'
+      require 'tilia/v_object/recur/r_date_iterator'
+      require 'tilia/v_object/recur/r_rule_iterator'
+    end
+  end
+end

data/lib/tilia/v_object/settings.rb

@@ -0,0 +1,32 @@
+module Tilia
+  module VObject
+    # This class provides a list of global defaults for vobject.
+    #
+    # Some of these started to appear in various classes, so it made a bit more
+    # sense to centralize them, so it's easier for user to find and change these.
+    #
+    # The global nature of them does mean that changing the settings for one
+    # instance has a global influence.
+    class Settings
+      # The minimum date we accept for various calculations with dates, such as
+      # recurrences.
+      #
+      # The choice of 1900 is pretty arbitrary, but it covers most common
+      # use-cases. In particular, it covers birthdates for virtually everyone
+      # alive on earth, which is less than 5 people at the time of writing.
+      @min_date = '1900-01-01'
+
+      # The maximum date we accept for various calculations with dates, such as
+      # recurrences.
+      #
+      # The choice of 2100 is pretty arbitrary, but should cover most
+      # appointments made for many years to come.
+      @max_date = '2100-01-01'
+
+      class << self
+        attr_accessor :min_date
+        attr_accessor :max_date
+      end
+    end
+  end
+end

data/lib/tilia/v_object/splitter/i_calendar.rb

@@ -0,0 +1,95 @@
+require 'digest'
+module Tilia
+  module VObject
+    module Splitter
+      # Splitter.
+      #
+      # This class is responsible for splitting up iCalendar objects.
+      #
+      # This class expects a single VCALENDAR object with one or more
+      # calendar-objects inside. Objects with identical UID's will be combined into
+      # a single object.
+      class ICalendar
+        include SplitterInterface
+
+        # Timezones.
+        #
+        # @var array
+        # RUBY: attr_accessor :vtimezones
+
+        # iCalendar objects.
+        #
+        # @var array
+        # RUBY: attr_accessor :objects
+
+        # Constructor.
+        #
+        # The splitter should receive an readable file stream as it's input.
+        #
+        # @param resource input
+        # @param int options Parser options, see the OPTIONS constants.
+        def initialize(input, options = 0)
+          @vtimezones = {}
+          @objects = {}
+
+          data = Reader.read(input, options)
+
+          unless data.is_a?(Component::VCalendar)
+            fail ParseException, 'Supplied input could not be parsed as VCALENDAR.'
+          end
+
+          data.children.each do |component|
+            next unless component.is_a? Component
+
+            if component.name == 'VTIMEZONE'
+              @vtimezones[component['TZID'].to_s] = component
+              next
+            end
+
+            # Get component UID for recurring Events search
+            if component['UID'].blank?
+              component['UID'] = "#{Digest::SHA1.hexdigest(Time.now.to_s + rand.to_s)}-vobjectimport"
+            end
+
+            uid = component['UID'].to_s
+
+            # Take care of recurring events
+            @objects[uid] = Component::VCalendar.new unless @objects.key?(uid)
+
+            @objects[uid].add(component.dup)
+          end
+        end
+
+        # Every time self.next is called, a new object will be parsed, until we
+        # hit the end of the stream.
+        #
+        # When the end is reached, null will be returned.
+        #
+        # @return Sabre\VObject\Component|null
+        def next
+          key = @objects.keys.first
+
+          if key
+            object = @objects.delete(key)
+
+            # create our baseobject
+            object['VERSION'] = '2.0'
+            object['PRODID'] = "-//Tilia//Tilia VObject #{Version::VERSION}//EN"
+            object['CALSCALE'] = 'GREGORIAN'
+
+            # add vtimezone information to obj (if we have it)
+            @vtimezones.keys.each do |vtimezone|
+              object.add(@vtimezones[vtimezone])
+            end
+
+            return object
+          else
+            return nil
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/splitter/splitter_interface.rb

@@ -0,0 +1,31 @@
+module Tilia
+  module VObject
+    module Splitter
+      # VObject splitter.
+      #
+      # The splitter is responsible for reading a large vCard or iCalendar object,
+      # and splitting it into multiple objects.
+      #
+      # This is for example for Card and CalDAV, which require every event and vcard
+      # to exist in their own objects, instead of one large one.
+      module SplitterInterface
+        # Constructor.
+        #
+        # The splitter should receive an readable file stream as it's input.
+        #
+        # @param resource input
+        def initialize(_input)
+        end
+
+        # Every time self.next is called, a new object will be parsed, until we
+        # hit the end of the stream.
+        #
+        # When the end is reached, null will be returned.
+        #
+        # @return Sabre\VObject\Component|null
+        def next
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/splitter/v_card.rb

@@ -0,0 +1,56 @@
+module Tilia
+  module VObject
+    module Splitter
+      # Splitter.
+      #
+      # This class is responsible for splitting up VCard objects.
+      #
+      # It is assumed that the input stream contains 1 or more VCARD objects. This
+      # class checks for BEGIN:VCARD and END:VCARD and parses each encountered
+      # component individually.
+      class VCard
+        include SplitterInterface
+        # File handle.
+        #
+        # @var resource
+        # RUBY: attr_accessor :input
+
+        # Persistent parser.
+        #
+        # @var MimeDir
+        # RUBY: attr_accessor :parser
+
+        # Constructor.
+        #
+        # The splitter should receive an readable file stream as it's input.
+        #
+        # @param resource input
+        # @param int options Parser options, see the OPTIONS constants.
+        def initialize(input, options = 0)
+          @input = input
+          @parser = Parser::MimeDir.new(input, options)
+        end
+
+        # Every time self.next is called, a new object will be parsed, until we
+        # hit the end of the stream.
+        #
+        # When the end is reached, null will be returned.
+        #
+        # @return Sabre\VObject\Component|null
+        def next
+          begin
+            object = @parser.parse
+
+            unless object.is_a?(Component::VCard)
+              fail ParseException, 'The supplied input contained non-VCARD data.'
+            end
+          rescue EofException
+            return nil
+          end
+
+          object
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/splitter.rb

@@ -0,0 +1,9 @@
+module Tilia
+  module VObject
+    module Splitter
+      require 'tilia/v_object/splitter/splitter_interface'
+      require 'tilia/v_object/splitter/i_calendar'
+      require 'tilia/v_object/splitter/v_card'
+    end
+  end
+end

data/lib/tilia/v_object/string_util.rb

@@ -0,0 +1,58 @@
+module Tilia
+  module VObject
+    # Useful utilities for working with various strings.
+    class StringUtil
+      # Returns true or false depending on if a string is valid UTF-8.
+      #
+      # @param string str
+      #
+      # @return bool
+      def self.utf8?(str)
+        fail ArgumentError, 'str needs to be a String' unless str.is_a?(String)
+        # Control characters
+        return false if str =~ /[\x00-\x08\x0B-\x0C\x0E\x0F]/
+
+        str.encoding.to_s == 'UTF-8' && str.valid_encoding?
+      end
+
+      # This method tries its best to convert the input string to UTF-8.
+      #
+      # Currently only ISO-5991-1 input and UTF-8 input is supported, but this
+      # may be expanded upon if we receive other examples.
+      #
+      # @param string str
+      #
+      # @return string
+      def self.convert_to_utf8(str)
+        cd = CharDet.detect(str)
+
+        # Best solution I could find ...
+        if cd['confidence'] > 0.4 && cd['encoding'] =~ /(?:windows|iso)/i
+          str = str.encode('UTF-8', cd['encoding'])
+        end
+
+        # Removing any control characters
+        str.gsub(/(?:[\x00-\x08\x0B-\x0C\x0E-\x1F\x7F])/, '')
+      end
+
+      # TODO: document
+      def self.mb_strcut(string, length)
+        return '' if string == ''
+
+        string = string.clone
+        tmp = ''
+        while tmp.bytesize <= length
+          tmp += string[0]
+          string[0] = ''
+        end
+
+        # Last char was utf-8 multibyte
+        if tmp.bytesize > length
+          string[0] = tmp[-1] + string[0].to_s
+          tmp[-1] = ''
+        end
+        tmp
+      end
+    end
+  end
+end

data/lib/tilia/v_object/time_zone_data/exchange_zones.rb

@@ -0,0 +1,96 @@
+module Tilia
+  module VObject
+    module TimeZoneData
+      # Microsoft exchange timezones
+      # Source:
+      # http://msdn.microsoft.com/en-us/library/ms988620%28v=exchg.65%29.aspx.
+      #
+      # Correct timezones deduced with help from:
+      # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+      module ExchangeZones
+        def self.list
+          {
+            'Universal Coordinated Time'                               => 'UTC',
+            'Casablanca, Monrovia'                                     => 'Africa/Casablanca',
+            'Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London'   => 'Europe/Lisbon',
+            'Greenwich Mean Time; Dublin, Edinburgh, London'           => 'Europe/London',
+            'Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna'         => 'Europe/Berlin',
+            'Belgrade, Pozsony, Budapest, Ljubljana, Prague'           => 'Europe/Prague',
+            'Brussels, Copenhagen, Madrid, Paris'                      => 'Europe/Paris',
+            'Paris, Madrid, Brussels, Copenhagen'                      => 'Europe/Paris',
+            'Prague, Central Europe'                                   => 'Europe/Prague',
+            'Sarajevo, Skopje, Sofija, Vilnius, Warsaw, Zagreb'        => 'Europe/Sarajevo',
+            'West Central Africa'                                      => 'Africa/Luanda', # This was a best guess
+            'Athens, Istanbul, Minsk'                                  => 'Europe/Athens',
+            'Bucharest'                                                => 'Europe/Bucharest',
+            'Cairo'                                                    => 'Africa/Cairo',
+            'Harare, Pretoria'                                         => 'Africa/Harare',
+            'Helsinki, Riga, Tallinn'                                  => 'Europe/Helsinki',
+            'Israel, Jerusalem Standard Time'                          => 'Asia/Jerusalem',
+            'Baghdad'                                                  => 'Asia/Baghdad',
+            'Arab, Kuwait, Riyadh'                                     => 'Asia/Kuwait',
+            'Moscow, St. Petersburg, Volgograd'                        => 'Europe/Moscow',
+            'East Africa, Nairobi'                                     => 'Africa/Nairobi',
+            'Tehran'                                                   => 'Asia/Tehran',
+            'Abu Dhabi, Muscat'                                        => 'Asia/Muscat', # Best guess
+            'Baku, Tbilisi, Yerevan'                                   => 'Asia/Baku',
+            'Kabul'                                                    => 'Asia/Kabul',
+            'Ekaterinburg'                                             => 'Asia/Yekaterinburg',
+            'Islamabad, Karachi, Tashkent'                             => 'Asia/Karachi',
+            'Kolkata, Chennai, Mumbai, New Delhi, India Standard Time' => 'Asia/Calcutta',
+            'Kathmandu, Nepal'                                         => 'Asia/Kathmandu',
+            'Almaty, Novosibirsk, North Central Asia'                  => 'Asia/Almaty',
+            'Astana, Dhaka'                                            => 'Asia/Dhaka',
+            'Sri Jayawardenepura, Sri Lanka'                           => 'Asia/Colombo',
+            'Rangoon'                                                  => 'Asia/Rangoon',
+            'Bangkok, Hanoi, Jakarta'                                  => 'Asia/Bangkok',
+            'Krasnoyarsk'                                              => 'Asia/Krasnoyarsk',
+            'Beijing, Chongqing, Hong Kong SAR, Urumqi'                => 'Asia/Shanghai',
+            'Irkutsk, Ulaan Bataar'                                    => 'Asia/Irkutsk',
+            'Kuala Lumpur, Singapore'                                  => 'Asia/Singapore',
+            'Perth, Western Australia'                                 => 'Australia/Perth',
+            'Taipei'                                                   => 'Asia/Taipei',
+            'Osaka, Sapporo, Tokyo'                                    => 'Asia/Tokyo',
+            'Seoul, Korea Standard time'                               => 'Asia/Seoul',
+            'Yakutsk'                                                  => 'Asia/Yakutsk',
+            'Adelaide, Central Australia'                              => 'Australia/Adelaide',
+            'Darwin'                                                   => 'Australia/Darwin',
+            'Brisbane, East Australia'                                 => 'Australia/Brisbane',
+            'Canberra, Melbourne, Sydney, Hobart (year 2000 only)'     => 'Australia/Sydney',
+            'Guam, Port Moresby'                                       => 'Pacific/Guam',
+            'Hobart, Tasmania'                                         => 'Australia/Hobart',
+            'Vladivostok'                                              => 'Asia/Vladivostok',
+            'Magadan, Solomon Is., New Caledonia'                      => 'Asia/Magadan',
+            'Auckland, Wellington'                                     => 'Pacific/Auckland',
+            'Fiji Islands, Kamchatka, Marshall Is.'                    => 'Pacific/Fiji',
+            'Nuku\'alofa, Tonga'                                       => 'Pacific/Tongatapu',
+            'Azores'                                                   => 'Atlantic/Azores',
+            'Cape Verde Is.'                                           => 'Atlantic/Cape_Verde',
+            'Mid-Atlantic'                                             => 'America/Noronha',
+            'Brasilia'                                                 => 'America/Sao_Paulo', # Best guess
+            'Buenos Aires'                                             => 'America/Argentina/Buenos_Aires',
+            'Greenland'                                                => 'America/Godthab',
+            'Newfoundland'                                             => 'America/St_Johns',
+            'Atlantic Time (Canada)'                                   => 'America/Halifax',
+            'Caracas, La Paz'                                          => 'America/Caracas',
+            'Santiago'                                                 => 'America/Santiago',
+            'Bogota, Lima, Quito'                                      => 'America/Bogota',
+            'Eastern Time (US & Canada)'                               => 'America/New_York',
+            'Indiana (East)'                                           => 'America/Indiana/Indianapolis',
+            'Central America'                                          => 'America/Guatemala',
+            'Central Time (US & Canada)'                               => 'America/Chicago',
+            'Mexico City, Tegucigalpa'                                 => 'America/Mexico_City',
+            'Saskatchewan'                                             => 'America/Edmonton',
+            'Arizona'                                                  => 'America/Phoenix',
+            'Mountain Time (US & Canada)'                              => 'America/Denver', # Best guess
+            'Pacific Time (US & Canada); Tijuana'                      => 'America/Los_Angeles', # Best guess
+            'Alaska'                                                   => 'America/Anchorage',
+            'Hawaii'                                                   => 'Pacific/Honolulu',
+            'Midway Island, Samoa'                                     => 'Pacific/Midway',
+            'Eniwetok, Kwajalein, Dateline Time'                       => 'Pacific/Kwajalein'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/time_zone_data/lotus_zones.rb

@@ -0,0 +1,104 @@
+module Tilia
+  module VObject
+    module TimeZoneData
+      # The following list are timezone names that could be generated by
+      # Lotus / Domino.
+      module LotusZones
+        def self.list
+          {
+            'Dateline'               => 'Etc/GMT-12',
+            'Samoa'                  => 'Pacific/Apia',
+            'Hawaiian'               => 'Pacific/Honolulu',
+            'Alaskan'                => 'America/Anchorage',
+            'Pacific'                => 'America/Los_Angeles',
+            'Pacific Standard Time'  => 'America/Los_Angeles',
+            'Mexico Standard Time 2' => 'America/Chihuahua',
+            'Mountain'               => 'America/Denver',
+            # 'Mountain Standard Time' => 'America/Chihuahua', # conflict with windows timezones.
+            'US Mountain'            => 'America/Phoenix',
+            'Canada Central'         => 'America/Edmonton',
+            'Central America'        => 'America/Guatemala',
+            'Central'                => 'America/Chicago',
+            # 'Central Standard Time'  => 'America/Mexico_City', # conflict with windows timezones.
+            'Mexico'                 => 'America/Mexico_City',
+            'Eastern'                => 'America/New_York',
+            'SA Pacific'             => 'America/Bogota',
+            'US Eastern'             => 'America/Indiana/Indianapolis',
+            'Venezuela'              => 'America/Caracas',
+            'Atlantic'               => 'America/Halifax',
+            'Central Brazilian'      => 'America/Manaus',
+            'Pacific SA'             => 'America/Santiago',
+            'SA Western'             => 'America/La_Paz',
+            'Newfoundland'           => 'America/St_Johns',
+            'Argentina'              => 'America/Argentina/Buenos_Aires',
+            'E. South America'       => 'America/Belem',
+            'Greenland'              => 'America/Godthab',
+            'Montevideo'             => 'America/Montevideo',
+            'SA Eastern'             => 'America/Belem',
+            # 'Mid-Atlantic'           => 'Etc/GMT-2', # conflict with windows timezones.
+            'Azores'                 => 'Atlantic/Azores',
+            'Cape Verde'             => 'Atlantic/Cape_Verde',
+            'Greenwich'              => 'Atlantic/Reykjavik', # No I'm serious.. Greenwich is not GMT.
+            'Morocco'                => 'Africa/Casablanca',
+            'Central Europe'         => 'Europe/Prague',
+            'Central European'       => 'Europe/Sarajevo',
+            'Romance'                => 'Europe/Paris',
+            'W. Central Africa'      => 'Africa/Lagos', # Best guess
+            'W. Europe'              => 'Europe/Amsterdam',
+            'E. Europe'              => 'Europe/Minsk',
+            'Egypt'                  => 'Africa/Cairo',
+            'FLE'                    => 'Europe/Helsinki',
+            'GTB'                    => 'Europe/Athens',
+            'Israel'                 => 'Asia/Jerusalem',
+            'Jordan'                 => 'Asia/Amman',
+            'Middle East'            => 'Asia/Beirut',
+            'Namibia'                => 'Africa/Windhoek',
+            'South Africa'           => 'Africa/Harare',
+            'Arab'                   => 'Asia/Kuwait',
+            'Arabic'                 => 'Asia/Baghdad',
+            'E. Africa'              => 'Africa/Nairobi',
+            'Georgian'               => 'Asia/Tbilisi',
+            'Russian'                => 'Europe/Moscow',
+            'Iran'                   => 'Asia/Tehran',
+            'Arabian'                => 'Asia/Muscat',
+            'Armenian'               => 'Asia/Yerevan',
+            'Azerbijan'              => 'Asia/Baku',
+            'Caucasus'               => 'Asia/Yerevan',
+            'Mauritius'              => 'Indian/Mauritius',
+            'Afghanistan'            => 'Asia/Kabul',
+            'Ekaterinburg'           => 'Asia/Yekaterinburg',
+            'Pakistan'               => 'Asia/Karachi',
+            'West Asia'              => 'Asia/Tashkent',
+            'India'                  => 'Asia/Calcutta',
+            'Sri Lanka'              => 'Asia/Colombo',
+            'Nepal'                  => 'Asia/Kathmandu',
+            'Central Asia'           => 'Asia/Dhaka',
+            'N. Central Asia'        => 'Asia/Almaty',
+            'Myanmar'                => 'Asia/Rangoon',
+            'North Asia'             => 'Asia/Krasnoyarsk',
+            'SE Asia'                => 'Asia/Bangkok',
+            'China'                  => 'Asia/Shanghai',
+            'North Asia East'        => 'Asia/Irkutsk',
+            'Singapore'              => 'Asia/Singapore',
+            'Taipei'                 => 'Asia/Taipei',
+            'W. Australia'           => 'Australia/Perth',
+            'Korea'                  => 'Asia/Seoul',
+            'Tokyo'                  => 'Asia/Tokyo',
+            'Yakutsk'                => 'Asia/Yakutsk',
+            'AUS Central'            => 'Australia/Darwin',
+            'Cen. Australia'         => 'Australia/Adelaide',
+            'AUS Eastern'            => 'Australia/Sydney',
+            'E. Australia'           => 'Australia/Brisbane',
+            'Tasmania'               => 'Australia/Hobart',
+            'Vladivostok'            => 'Asia/Vladivostok',
+            'West Pacific'           => 'Pacific/Guam',
+            'Central Pacific'        => 'Asia/Magadan',
+            'Fiji'                   => 'Pacific/Fiji',
+            'New Zealand'            => 'Pacific/Auckland',
+            'Tonga'                  => 'Pacific/Tongatapu'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tilia/v_object/time_zone_data/php_zones.rb

@@ -0,0 +1,49 @@
+module Tilia
+  module VObject
+    module TimeZoneData
+      # A list of PHP timezones that were supported until 5.5.9, removed in
+      # PHP 5.5.10 and re-introduced in PHP 5.5.17.
+      #
+      # DateTimeZone::list_identifiers(DateTimeZone::ALL_WITH_BC) returns them,
+      # but they are invalid for new Date_time_zone. Fixed in PHP 5.5.17.
+      # https://bugs.php.net/bug.php?id=66985
+      #
+      # Some more info here:
+      # http://evertpot.com/php-5-5-10-timezone-changes/
+      module PhpZones
+        def self.list
+          {
+            'CST6CDT'   => 'America/Chicago',
+            'Cuba'      => 'America/Havana',
+            'Egypt'     => 'Africa/Cairo',
+            'Eire'      => 'Europe/Dublin',
+            'EST5EDT'   => 'America/New_York',
+            'Factory'   => 'UTC',
+            'GB-Eire'   => 'Europe/London',
+            'GMT0'      => 'UTC',
+            'Greenwich' => 'UTC',
+            'Hongkong'  => 'Asia/Hong_Kong',
+            'Iceland'   => 'Atlantic/Reykjavik',
+            'Iran'      => 'Asia/Tehran',
+            'Israel'    => 'Asia/Jerusalem',
+            'Jamaica'   => 'America/Jamaica',
+            'Japan'     => 'Asia/Tokyo',
+            'Kwajalein' => 'Pacific/Kwajalein',
+            'Libya'     => 'Africa/Tripoli',
+            'MST7MDT'   => 'America/Denver',
+            'Navajo'    => 'America/Denver',
+            'NZ-CHAT'   => 'Pacific/Chatham',
+            'Poland'    => 'Europe/Warsaw',
+            'Portugal'  => 'Europe/Lisbon',
+            'PST8PDT'   => 'America/Los_Angeles',
+            'Singapore' => 'Asia/Singapore',
+            'Turkey'    => 'Europe/Istanbul',
+            'Universal' => 'UTC',
+            'W-SU'      => 'Europe/Moscow',
+            'Zulu'      => 'UTC'
+          }
+        end
+      end
+    end
+  end
+end