tilia-dav 3.1.0.pre.alpha2

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
+[code-of-conduct]: http://todogroup.org/opencodeofconduct/#tilia-dav/tilia@jakobsack.de
+
+This library is a port of [sabre/dav](http://github.com/fruux/sabre-dav). The ruby code should match the php code as good as possible. For more information refer to the [coding guidelines](https://tilia.github.io/coding_guidelines).
+
+If you are having an issue [search the open issues](https://github.com/tilia/tilia-dav/issues) or create an issue and we'll help point you in the right direction.
+
+## Submitting a Pull Request
+
+* Fork the project on Github
+* Install development dependencies (`bundle install`)
+* Create a topic branch for your changes
+* Ensure that you provide *documentation* and *test coverage* for your changes (patches won't be accepted without)
+* Ensure that all tests pass (`bundle exec rake`)
+* Create a [pull request](https://github.com/tilia/tilia-dav/pulls) on Github (these are also a great place to start a conversation around a patch as early as possible)
+
+## Testing
+
+To run the tests:
+
+    $ rake
+
+If nothing complains, congratulations!

data/Gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+# Internal dependencies
+gem 'tilia-vobject', '>= 4.0.0-alpha4'
+gem 'tilia-event', '~> 2.0'
+gem 'tilia-xml', '~> 1.2'
+gem 'tilia-http', '~> 4.1'
+gem 'tilia-uri', '~> 1.0'
+
+# External dependencies
+gem 'activesupport', '~> 4.2'
+gem 'sys-filesystem', '~> 1.1'
+gem 'sequel', '~> 4.29'
+gem 'sqlite3', '~> 1.3'
+gem 'mysql2', '~> 0.4'
+gem 'chronic', '~> 0.10'
+gem 'mail', '~> 2.6'
+gem 'rchardet', '~>1.6'
+
+# Testing
+gem 'rake'
+gem 'minitest', '~> 5.8'
+gem 'simplecov', '~> 0.10'
+gem 'rubocop', '~> 0.34'
+gem 'yard', '~> 0.8'

data/Gemfile.lock

@@ -0,0 +1,103 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    chronic (0.10.2)
+    docile (1.1.5)
+    ethon (0.8.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.10)
+    i18n (0.7.0)
+    json (1.8.3)
+    libxml-ruby (2.8.0)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.99)
+    minitest (5.8.3)
+    mysql2 (0.4.2)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rchardet (1.6.1)
+    rubocop (0.35.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.3.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      tins (<= 1.6.0)
+    ruby-progressbar (1.7.5)
+    sequel (4.29.0)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sqlite3 (1.3.11)
+    sys-filesystem (1.1.5)
+      ffi
+    thread_safe (0.3.5)
+    tilia-event (2.0.2)
+      activesupport (~> 4.2)
+    tilia-http (4.1.0.5)
+      activesupport (~> 4.2)
+      rack (~> 1.6)
+      rchardet (~> 1.6)
+      tilia-event (~> 2.0)
+      tilia-uri (~> 1.0)
+      typhoeus (~> 0.8)
+    tilia-uri (1.0.1)
+      activesupport (~> 4.2)
+    tilia-vobject (4.0.0.pre.alpha4)
+      activesupport (~> 4.2)
+      mail (~> 2.6)
+      rchardet (~> 1.6)
+      tilia-xml (~> 1.1)
+      tzinfo (~> 1.2)
+    tilia-xml (1.2.0.2)
+      activesupport (~> 4.2)
+      libxml-ruby (~> 2.8)
+      tilia-uri (~> 1.0)
+    tins (1.6.0)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.2)
+  chronic (~> 0.10)
+  mail (~> 2.6)
+  minitest (~> 5.8)
+  mysql2 (~> 0.4)
+  rake
+  rchardet (~> 1.6)
+  rubocop (~> 0.34)
+  sequel (~> 4.29)
+  simplecov (~> 0.10)
+  sqlite3 (~> 1.3)
+  sys-filesystem (~> 1.1)
+  tilia-event (~> 2.0)
+  tilia-http (~> 4.1)
+  tilia-uri (~> 1.0)
+  tilia-vobject (>= 4.0.0.pre.alpha4)
+  tilia-xml (~> 1.2)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (C) 2015 Jakob Sack (tilia@jakobsack.de)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Tilia nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.sabre

@@ -0,0 +1,27 @@
+Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Sabre nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,40 @@
+tilia/dav
+======
+
+[![Build Status](https://travis-ci.org/tilia/tilia-dav.svg?branch=master)](https://travis-ci.org/tilia/tilia-dav)
+
+**tilia/dav is a port of [sabre/dav](https://github.com/fruux/sabre-dav)**
+
+SabreDAV is the most popular WebDAV framework for PHP. Use it to create WebDAV, CalDAV and CardDAV servers.
+
+Full documentation can be found on the website:
+
+http://sabre.io/
+
+
+Installation
+------------
+
+Simply add tilia-dav to your Gemfile and bundle it up:
+
+```ruby
+  gem 'tilia-dav', '~> 3.1'
+```
+
+
+Changes to sabre/dav
+--------------------
+
+The hook `afterResponse` does not exist in this implementation.
+
+
+Contributing
+------------
+
+See [Contributing](CONTRIBUTING.md)
+
+
+License
+-------
+
+tilia-dav is licensed under the terms of the [three-clause BSD-license](LICENSE).

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('test/**/*_test.rb')
+  t.libs << 'test'
+end
+RuboCop::RakeTask.new do |t|
+  t.options = ['--format', 'html', '--out', 'coverage/rubocop.html']
+end
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', '-', 'README.md']
+  t.options = ['--private']
+end
+
+task(default: :test)

data/database.sample.yml

@@ -0,0 +1,6 @@
+---
+:host: localhost
+:user: tilia
+:password: tilia
+:database: tilia
+:engine: MEMORY

data/examples/minimal.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# Expected to be called "bundle exec examples/minimal.rb"
+$LOAD_PATH.unshift './lib'
+
+require 'tilia/dav'
+require 'rack'
+
+Time.zone = 'Berlin'
+
+testserver_root = File.join(File.dirname(__FILE__), 'testserver_root')
+Dir.mkdir(testserver_root) unless File.exist?(testserver_root)
+
+fail "could not create root directory #{testserver_root}" unless File.directory?(testserver_root)
+
+app = proc do |env|
+  root = Tilia::Dav::Fs::Directory.new(testserver_root)
+  server = Tilia::Dav::Server.new(env, [root])
+
+  server.add_plugin(Tilia::Dav::Browser::Plugin.new)
+
+  server.exec
+end
+
+Rack::Handler::WEBrick.run app

data/lib/tilia/cal_dav.rb

@@ -0,0 +1,27 @@
+module Tilia
+  module CalDav
+    require 'tilia/cal_dav/i_calendar_object_container'
+    require 'tilia/cal_dav/i_calendar'
+    require 'tilia/cal_dav/i_calendar_object'
+    require 'tilia/cal_dav/i_shareable_calendar'
+    require 'tilia/cal_dav/i_shared_calendar'
+
+    require 'tilia/cal_dav/backend'
+    require 'tilia/cal_dav/calendar_object'
+    require 'tilia/cal_dav/calendar'
+    require 'tilia/cal_dav/exception'
+    require 'tilia/cal_dav/ics_export_plugin'
+    require 'tilia/cal_dav/plugin'
+    require 'tilia/cal_dav/schedule'
+    require 'tilia/cal_dav/shared_calendar'
+    require 'tilia/cal_dav/subscriptions'
+    require 'tilia/cal_dav/calendar_home'
+    require 'tilia/cal_dav/calendar_query_validator'
+    require 'tilia/cal_dav/calendar_root'
+    require 'tilia/cal_dav/notifications'
+    require 'tilia/cal_dav/principal'
+    require 'tilia/cal_dav/shareable_calendar'
+    require 'tilia/cal_dav/sharing_plugin'
+    require 'tilia/cal_dav/xml'
+  end
+end

data/lib/tilia/cal_dav/backend.rb

@@ -0,0 +1,17 @@
+module Tilia
+  module CalDav
+    module Backend
+      require 'tilia/cal_dav/backend/backend_interface'
+
+      require 'tilia/cal_dav/backend/notification_support'
+      require 'tilia/cal_dav/backend/sharing_support'
+      require 'tilia/cal_dav/backend/subscription_support'
+      require 'tilia/cal_dav/backend/scheduling_support'
+      require 'tilia/cal_dav/backend/sync_support'
+
+      require 'tilia/cal_dav/backend/abstract_backend'
+
+      require 'tilia/cal_dav/backend/sequel'
+    end
+  end
+end

data/lib/tilia/cal_dav/backend/abstract_backend.rb

@@ -0,0 +1,194 @@
+module Tilia
+  module CalDav
+    module Backend
+      # Abstract Calendaring backend. Extend this class to create your own backends.
+      #
+      # Checkout the BackendInterface for all the methods that must be implemented.
+      class AbstractBackend
+        include BackendInterface
+
+        # Updates properties for a calendar.
+        #
+        # The list of mutations is stored in a Sabre\DAV\PropPatch object.
+        # To do the actual updates, you must tell this object which properties
+        # you're going to process with the handle method.
+        #
+        # Calling the handle method is like telling the PropPatch object "I
+        # promise I can handle updating this property".
+        #
+        # Read the PropPatch documenation for more info and examples.
+        #
+        # @param string path
+        # @param \Sabre\DAV\PropPatch prop_patch
+        # @return void
+        def update_calendar(calendar_id, prop_patch)
+        end
+
+        # Returns a list of calendar objects.
+        #
+        # This method should work identical to getCalendarObject, but instead
+        # return all the calendar objects in the list as an array.
+        #
+        # If the backend supports this, it may allow for some speed-ups.
+        #
+        # @param mixed calendar_id
+        # @param array uris
+        # @return array
+        def multiple_calendar_objects(calendar_id, uris)
+          uris.map do |uri|
+            calendar_object(calendar_id, uri)
+          end
+        end
+
+        # Performs a calendar-query on the contents of this calendar.
+        #
+        # The calendar-query is defined in RFC4791 : CalDAV. Using the
+        # calendar-query it is possible for a client to request a specific set of
+        # object, based on contents of iCalendar properties, date-ranges and
+        # iCalendar component types (VTODO, VEVENT).
+        #
+        # This method should just return a list of (relative) urls that match this
+        # query.
+        #
+        # The list of filters are specified as an array. The exact array is
+        # documented by \Sabre\CalDAV\CalendarQueryParser.
+        #
+        # Note that it is extremely likely that getCalendarObject for every path
+        # returned from this method will be called almost immediately after. You
+        # may want to anticipate this to speed up these requests.
+        #
+        # This method provides a default implementation, which parses *all* the
+        # iCalendar objects in the specified calendar.
+        #
+        # This default may well be good enough for personal use, and calendars
+        # that aren't very large. But if you anticipate high usage, big calendars
+        # or high loads, you are strongly adviced to optimize certain paths.
+        #
+        # The best way to do so is override this method and to optimize
+        # specifically for 'common filters'.
+        #
+        # Requests that are extremely common are:
+        #   * requests for just VEVENTS
+        #   * requests for just VTODO
+        #   * requests with a time-range-filter on either VEVENT or VTODO.
+        #
+        # ..and combinations of these requests. It may not be worth it to try to
+        # handle every possible situation and just rely on the (relatively
+        # easy to use) CalendarQueryValidator to handle the rest.
+        #
+        # Note that especially time-range-filters may be difficult to parse. A
+        # time-range filter specified on a VEVENT must for instance also handle
+        # recurrence rules correctly.
+        # A good example of how to interprete all these filters can also simply
+        # be found in \Sabre\CalDAV\CalendarQueryFilter. This class is as correct
+        # as possible, so it gives you a good idea on what type of stuff you need
+        # to think of.
+        #
+        # @param mixed calendar_id
+        # @param array filters
+        # @return array
+        def calendar_query(calendar_id, filters)
+          result = []
+          objects = calendar_objects(calendar_id)
+
+          objects.each do |object|
+            result << object['uri'] if validate_filter_for_object(object, filters)
+          end
+
+          result
+        end
+
+        protected
+
+        # This method validates if a filter (as passed to calendarQuery) matches
+        # the given object.
+        #
+        # @param array object
+        # @param array filters
+        # @return bool
+        def validate_filter_for_object(object, filters)
+          # Unfortunately, setting the 'calendardata' here is optional. If
+          # it was excluded, we actually need another call to get this as
+          # well.
+
+          object = calendar_object(object['calendarid'], object['uri']) unless object.key?('calendardata')
+
+          v_object = VObject::Reader.read(object['calendardata'])
+
+          validator = CalendarQueryValidator.new
+          result = validator.validate(v_object, filters)
+
+          # Destroy circular references so PHP will GC the object.
+          v_object.destroy
+
+          result
+        end
+
+        public
+
+        # Searches through all of a users calendars and calendar objects to find
+        # an object with a specific UID.
+        #
+        # This method should return the path to this object, relative to the
+        # calendar home, so this path usually only contains two parts:
+        #
+        # calendarpath/objectpath.ics
+        #
+        # If the uid is not found, return null.
+        #
+        # This method should only consider * objects that the principal owns, so
+        # any calendars owned by other principals that also appear in this
+        # collection should be ignored.
+        #
+        # @param string principal_uri
+        # @param string uid
+        # @return string|null
+        def calendar_object_by_uid(principal_uri, uid)
+          # Note: this is a super slow naive implementation of this method. You
+          # are highly recommended to optimize it, if your backend allows it.
+          calendars_for_user(principal_uri).each do |calendar|
+            # We must ignore calendars owned by other principals.
+            next if calendar['principaluri'] != principal_uri
+
+            # Ignore calendars that are shared.
+            next if calendar.key?('{http://sabredav.org/ns}owner-principal') && calendar['{http://sabredav.org/ns}owner-principal'] != principal_uri
+
+            results = calendar_query(
+              calendar['id'],
+              'name'         => 'VCALENDAR',
+              'prop-filters' => [],
+              'comp-filters' => [
+                {
+                  'name'           => 'VEVENT',
+                  'is-not-defined' => false,
+                  'time-range'     => nil,
+                  'comp-filters'   => [],
+                  'prop-filters'   => [
+                    {
+                      'name'           => 'UID',
+                      'is-not-defined' => false,
+                      'time-range'     => nil,
+                      'text-match'     => {
+                        'value'            => uid,
+                        'negate-condition' => false,
+                        'collation'        => 'i;octet'
+                      },
+                      'param-filters' => []
+                    }
+                  ]
+                }
+              ]
+            )
+
+            if results.any?
+              # We have a match
+              return calendar['uri'] + '/' + results[0]
+            end
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end