summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2017-11-16 21:10:35 +0100
committerGitHub <noreply@github.com>2017-11-16 21:10:35 +0100
commitf32fbbca2e90559458460be40df6850903b1168e (patch)
treeeff22898eba04034d7e83cc50a12337d44a9dc45
parent44b423be355b9fdf1f8354b3c62a2344c53b141c (diff)
parent7784672cc00c83f1bfce57fc61eebe40c8f8c8a8 (diff)
downloadnextcloud-server-f32fbbca2e90559458460be40df6850903b1168e.tar.gz
nextcloud-server-f32fbbca2e90559458460be40df6850903b1168e.zip
Merge pull request #6840 from nextcloud/feature/5282/calendar_api
Calendar API for apps
-rw-r--r--apps/dav/appinfo/app.php8
-rw-r--r--apps/dav/composer/composer/autoload_classmap.php2
-rw-r--r--apps/dav/composer/composer/autoload_static.php2
-rw-r--r--apps/dav/lib/AppInfo/Application.php17
-rw-r--r--apps/dav/lib/CalDAV/CalDavBackend.php171
-rw-r--r--apps/dav/lib/CalDAV/CalendarImpl.php119
-rw-r--r--apps/dav/lib/CalDAV/CalendarManager.php71
-rw-r--r--apps/dav/tests/unit/CalDAV/CalDavBackendTest.php109
-rw-r--r--apps/dav/tests/unit/CalDAV/CalendarImplTest.php126
-rw-r--r--apps/dav/tests/unit/CalDAV/CalendarManagerTest.php81
-rw-r--r--lib/composer/composer/autoload_classmap.php3
-rw-r--r--lib/composer/composer/autoload_static.php3
-rw-r--r--lib/private/Calendar/Manager.php140
-rw-r--r--lib/private/Server.php10
-rw-r--r--lib/public/Calendar/ICalendar.php71
-rw-r--r--lib/public/Calendar/IManager.php121
-rw-r--r--lib/public/IServerContainer.php9
-rw-r--r--tests/lib/Calendar/ManagerTest.php214
18 files changed, 1274 insertions, 3 deletions
diff --git a/apps/dav/appinfo/app.php b/apps/dav/appinfo/app.php
index e312b48d0b8..8a534a75970 100644
--- a/apps/dav/appinfo/app.php
+++ b/apps/dav/appinfo/app.php
@@ -55,3 +55,11 @@ $cm->register(function() use ($cm, $app) {
$app->setupContactsProvider($cm, $user->getUID());
}
});
+
+$calendarManager = \OC::$server->getCalendarManager();
+$calendarManager->register(function() use ($calendarManager, $app) {
+ $user = \OC::$server->getUserSession()->getUser();
+ if ($user !== null) {
+ $app->setupCalendarProvider($calendarManager, $user->getUID());
+ }
+});
diff --git a/apps/dav/composer/composer/autoload_classmap.php b/apps/dav/composer/composer/autoload_classmap.php
index f29e3a7b293..24a6b885029 100644
--- a/apps/dav/composer/composer/autoload_classmap.php
+++ b/apps/dav/composer/composer/autoload_classmap.php
@@ -25,6 +25,8 @@ return array(
'OCA\\DAV\\CalDAV\\CalDavBackend' => $baseDir . '/../lib/CalDAV/CalDavBackend.php',
'OCA\\DAV\\CalDAV\\Calendar' => $baseDir . '/../lib/CalDAV/Calendar.php',
'OCA\\DAV\\CalDAV\\CalendarHome' => $baseDir . '/../lib/CalDAV/CalendarHome.php',
+ 'OCA\\DAV\\CalDAV\\CalendarImpl' => $baseDir . '/../lib/CalDAV/CalendarImpl.php',
+ 'OCA\\DAV\\CalDAV\\CalendarManager' => $baseDir . '/../lib/CalDAV/CalendarManager.php',
'OCA\\DAV\\CalDAV\\CalendarObject' => $baseDir . '/../lib/CalDAV/CalendarObject.php',
'OCA\\DAV\\CalDAV\\CalendarRoot' => $baseDir . '/../lib/CalDAV/CalendarRoot.php',
'OCA\\DAV\\CalDAV\\Plugin' => $baseDir . '/../lib/CalDAV/Plugin.php',
diff --git a/apps/dav/composer/composer/autoload_static.php b/apps/dav/composer/composer/autoload_static.php
index 412666a8aa7..1c768482221 100644
--- a/apps/dav/composer/composer/autoload_static.php
+++ b/apps/dav/composer/composer/autoload_static.php
@@ -40,6 +40,8 @@ class ComposerStaticInitDAV
'OCA\\DAV\\CalDAV\\CalDavBackend' => __DIR__ . '/..' . '/../lib/CalDAV/CalDavBackend.php',
'OCA\\DAV\\CalDAV\\Calendar' => __DIR__ . '/..' . '/../lib/CalDAV/Calendar.php',
'OCA\\DAV\\CalDAV\\CalendarHome' => __DIR__ . '/..' . '/../lib/CalDAV/CalendarHome.php',
+ 'OCA\\DAV\\CalDAV\\CalendarImpl' => __DIR__ . '/..' . '/../lib/CalDAV/CalendarImpl.php',
+ 'OCA\\DAV\\CalDAV\\CalendarManager' => __DIR__ . '/..' . '/../lib/CalDAV/CalendarManager.php',
'OCA\\DAV\\CalDAV\\CalendarObject' => __DIR__ . '/..' . '/../lib/CalDAV/CalendarObject.php',
'OCA\\DAV\\CalDAV\\CalendarRoot' => __DIR__ . '/..' . '/../lib/CalDAV/CalendarRoot.php',
'OCA\\DAV\\CalDAV\\Plugin' => __DIR__ . '/..' . '/../lib/CalDAV/Plugin.php',
diff --git a/apps/dav/lib/AppInfo/Application.php b/apps/dav/lib/AppInfo/Application.php
index ae08e50d607..a6ca99bfff5 100644
--- a/apps/dav/lib/AppInfo/Application.php
+++ b/apps/dav/lib/AppInfo/Application.php
@@ -29,13 +29,15 @@ use OC\AppFramework\Utility\SimpleContainer;
use OCA\DAV\CalDAV\Activity\Backend;
use OCA\DAV\CalDAV\Activity\Provider\Event;
use OCA\DAV\CalDAV\BirthdayService;
+use OCA\DAV\CalDAV\CalendarManager;
use OCA\DAV\Capabilities;
use OCA\DAV\CardDAV\ContactsManager;
use OCA\DAV\CardDAV\PhotoCache;
use OCA\DAV\CardDAV\SyncService;
use OCA\DAV\HookManager;
use \OCP\AppFramework\App;
-use OCP\Contacts\IManager;
+use OCP\Contacts\IManager as IContactsManager;
+use OCP\Calendar\IManager as ICalendarManager;
use OCP\IUser;
use Symfony\Component\EventDispatcher\GenericEvent;
@@ -63,16 +65,25 @@ class Application extends App {
}
/**
- * @param IManager $contactsManager
+ * @param IContactsManager $contactsManager
* @param string $userID
*/
- public function setupContactsProvider(IManager $contactsManager, $userID) {
+ public function setupContactsProvider(IContactsManager $contactsManager, $userID) {
/** @var ContactsManager $cm */
$cm = $this->getContainer()->query(ContactsManager::class);
$urlGenerator = $this->getContainer()->getServer()->getURLGenerator();
$cm->setupContactsProvider($contactsManager, $userID, $urlGenerator);
}
+ /**
+ * @param ICalendarManager $calendarManager
+ * @param string $userId
+ */
+ public function setupCalendarProvider(ICalendarManager $calendarManager, $userId) {
+ $cm = $this->getContainer()->query(CalendarManager::class);
+ $cm->setupCalendarProvider($calendarManager, $userId);
+ }
+
public function registerHooks() {
/** @var HookManager $hm */
$hm = $this->getContainer()->query(HookManager::class);
diff --git a/apps/dav/lib/CalDAV/CalDavBackend.php b/apps/dav/lib/CalDAV/CalDavBackend.php
index 9505a00ea55..9045a62cde4 100644
--- a/apps/dav/lib/CalDAV/CalDavBackend.php
+++ b/apps/dav/lib/CalDAV/CalDavBackend.php
@@ -51,8 +51,12 @@ use Sabre\DAV\Exception\Forbidden;
use Sabre\DAV\Exception\NotFound;
use Sabre\DAV\PropPatch;
use Sabre\HTTP\URLUtil;
+use Sabre\VObject\Component;
use Sabre\VObject\Component\VCalendar;
+use Sabre\VObject\Component\VEvent;
+use Sabre\VObject\Component\VTimeZone;
use Sabre\VObject\DateTimeParser;
+use Sabre\VObject\Property;
use Sabre\VObject\Reader;
use Sabre\VObject\Recur\EventIterator;
use Sabre\Uri;
@@ -1345,6 +1349,173 @@ class CalDavBackend extends AbstractBackend implements SyncSupport, Subscription
}
/**
+ * used for Nextcloud's calendar API
+ *
+ * @param array $calendarInfo
+ * @param string $pattern
+ * @param array $searchProperties
+ * @param array $options
+ * @param integer|null $limit
+ * @param integer|null $offset
+ *
+ * @return array
+ */
+ public function search(array $calendarInfo, $pattern, array $searchProperties,
+ array $options, $limit, $offset) {
+ $outerQuery = $this->db->getQueryBuilder();
+ $innerQuery = $this->db->getQueryBuilder();
+
+ $innerQuery->selectDistinct('op.objectid')
+ ->from($this->dbObjectPropertiesTable, 'op')
+ ->andWhere($innerQuery->expr()->eq('op.calendarid',
+ $outerQuery->createNamedParameter($calendarInfo['id'])));
+
+ // only return public items for shared calendars for now
+ if ($calendarInfo['principaluri'] !== $calendarInfo['{http://owncloud.org/ns}owner-principal']) {
+ $innerQuery->andWhere($innerQuery->expr()->eq('c.classification',
+ $outerQuery->createNamedParameter(self::CLASSIFICATION_PUBLIC)));
+ }
+
+ $or = $innerQuery->expr()->orX();
+ foreach($searchProperties as $searchProperty) {
+ $or->add($innerQuery->expr()->eq('op.name',
+ $outerQuery->createNamedParameter($searchProperty)));
+ }
+ $innerQuery->andWhere($or);
+
+ if ($pattern !== '') {
+ $innerQuery->andWhere($innerQuery->expr()->iLike('op.value',
+ $outerQuery->createNamedParameter('%' .
+ $this->db->escapeLikeParameter($pattern) . '%')));
+ }
+
+ $outerQuery->select('c.id', 'c.calendardata', 'c.componenttype', 'c.uid', 'c.uri')
+ ->from('calendarobjects', 'c');
+
+ if (isset($options['timerange'])) {
+ if (isset($options['timerange']['start'])) {
+ $outerQuery->andWhere($outerQuery->expr()->gt('lastoccurence',
+ $outerQuery->createNamedParameter($options['timerange']['start']->getTimeStamp)));
+
+ }
+ if (isset($options['timerange']['end'])) {
+ $outerQuery->andWhere($outerQuery->expr()->lt('firstoccurence',
+ $outerQuery->createNamedParameter($options['timerange']['end']->getTimeStamp)));
+ }
+ }
+
+ if (isset($options['types'])) {
+ $or = $outerQuery->expr()->orX();
+ foreach($options['types'] as $type) {
+ $or->add($outerQuery->expr()->eq('componenttype',
+ $outerQuery->createNamedParameter($type)));
+ }
+ $outerQuery->andWhere($or);
+ }
+
+ $outerQuery->andWhere($outerQuery->expr()->in('c.id',
+ $outerQuery->createFunction($innerQuery->getSQL())));
+
+ if ($offset) {
+ $outerQuery->setFirstResult($offset);
+ }
+ if ($limit) {
+ $outerQuery->setMaxResults($limit);
+ }
+
+ $result = $outerQuery->execute();
+ $calendarObjects = $result->fetchAll();
+
+ return array_map(function($o) {
+ $calendarData = Reader::read($o['calendardata']);
+ $comps = $calendarData->getComponents();
+ $objects = [];
+ $timezones = [];
+ foreach($comps as $comp) {
+ if ($comp instanceof VTimeZone) {
+ $timezones[] = $comp;
+ } else {
+ $objects[] = $comp;
+ }
+ }
+
+ return [
+ 'id' => $o['id'],
+ 'type' => $o['componenttype'],
+ 'uid' => $o['uid'],
+ 'uri' => $o['uri'],
+ 'objects' => array_map(function($c) {
+ return $this->transformSearchData($c);
+ }, $objects),
+ 'timezones' => array_map(function($c) {
+ return $this->transformSearchData($c);
+ }, $timezones),
+ ];
+ }, $calendarObjects);
+ }
+
+ /**
+ * @param Component $comp
+ * @return array
+ */
+ private function transformSearchData(Component $comp) {
+ $data = [];
+ /** @var Component[] $subComponents */
+ $subComponents = $comp->getComponents();
+ /** @var Property[] $properties */
+ $properties = array_filter($comp->children(), function($c) {
+ return $c instanceof Property;
+ });
+ $validationRules = $comp->getValidationRules();
+
+ foreach($subComponents as $subComponent) {
+ $name = $subComponent->name;
+ if (!isset($data[$name])) {
+ $data[$name] = [];
+ }
+ $data[$name][] = $this->transformSearchData($subComponent);
+ }
+
+ foreach($properties as $property) {
+ $name = $property->name;
+ if (!isset($validationRules[$name])) {
+ $validationRules[$name] = '*';
+ }
+
+ $rule = $validationRules[$property->name];
+ if ($rule === '+' || $rule === '*') { // multiple
+ if (!isset($data[$name])) {
+ $data[$name] = [];
+ }
+
+ $data[$name][] = $this->transformSearchProperty($property);
+ } else { // once
+ $data[$name] = $this->transformSearchProperty($property);
+ }
+ }
+
+ return $data;
+ }
+
+ /**
+ * @param Property $prop
+ * @return array
+ */
+ private function transformSearchProperty(Property $prop) {
+ // No need to check Date, as it extends DateTime
+ if ($prop instanceof Property\ICalendar\DateTime) {
+ $value = $prop->getDateTime();
+ } else {
+ $value = $prop->getValue();
+ }
+
+ return [
+ $value,
+ $prop->parameters()
+ ];
+ }
+
+ /**
* Searches through all of a users calendars and calendar objects to find
* an object with a specific UID.
*
diff --git a/apps/dav/lib/CalDAV/CalendarImpl.php b/apps/dav/lib/CalDAV/CalendarImpl.php
new file mode 100644
index 00000000000..cfdf821a563
--- /dev/null
+++ b/apps/dav/lib/CalDAV/CalendarImpl.php
@@ -0,0 +1,119 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\DAV\CalDAV;
+
+use OCP\Constants;
+use OCP\Calendar\ICalendar;
+
+class CalendarImpl implements ICalendar {
+
+ /** @var CalDavBackend */
+ private $backend;
+
+ /** @var Calendar */
+ private $calendar;
+
+ /** @var array */
+ private $calendarInfo;
+
+ /**
+ * CalendarImpl constructor.
+ *
+ * @param Calendar $calendar
+ * @param array $calendarInfo
+ * @param CalDavBackend $backend
+ */
+ public function __construct(Calendar $calendar, array $calendarInfo,
+ CalDavBackend $backend) {
+ $this->calendar = $calendar;
+ $this->calendarInfo = $calendarInfo;
+ $this->backend = $backend;
+ }
+
+ /**
+ * @return string defining the technical unique key
+ * @since 13.0.0
+ */
+ public function getKey() {
+ return $this->calendarInfo['id'];
+ }
+
+ /**
+ * In comparison to getKey() this function returns a human readable (maybe translated) name
+ * @return null|string
+ * @since 13.0.0
+ */
+ public function getDisplayName() {
+ return $this->calendarInfo['{DAV:}displayname'];
+ }
+
+ /**
+ * Calendar color
+ * @return null|string
+ * @since 13.0.0
+ */
+ public function getDisplayColor() {
+ return $this->calendarInfo['{http://apple.com/ns/ical/}calendar-color'];
+ }
+
+ /**
+ * @param string $pattern which should match within the $searchProperties
+ * @param array $searchProperties defines the properties within the query pattern should match
+ * @param array $options - optional parameters:
+ * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]]
+ * @param integer|null $limit - limit number of search results
+ * @param integer|null $offset - offset for paging of search results
+ * @return array an array of events/journals/todos which are arrays of key-value-pairs
+ * @since 13.0.0
+ */
+ public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null) {
+ return $this->backend->search($this->calendarInfo, $pattern,
+ $searchProperties, $options, $limit, $offset);
+ }
+
+ /**
+ * @return integer build up using \OCP\Constants
+ * @since 13.0.0
+ */
+ public function getPermissions() {
+ $permissions = $this->calendar->getACL();
+ $result = 0;
+ foreach ($permissions as $permission) {
+ switch($permission['privilege']) {
+ case '{DAV:}read':
+ $result |= Constants::PERMISSION_READ;
+ break;
+ case '{DAV:}write':
+ $result |= Constants::PERMISSION_CREATE;
+ $result |= Constants::PERMISSION_UPDATE;
+ break;
+ case '{DAV:}all':
+ $result |= Constants::PERMISSION_ALL;
+ break;
+ }
+ }
+
+ return $result;
+ }
+}
diff --git a/apps/dav/lib/CalDAV/CalendarManager.php b/apps/dav/lib/CalDAV/CalendarManager.php
new file mode 100644
index 00000000000..a183ecbdf45
--- /dev/null
+++ b/apps/dav/lib/CalDAV/CalendarManager.php
@@ -0,0 +1,71 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\DAV\CalDAV;
+
+use OCP\Calendar\IManager;
+use OCP\IL10N;
+
+class CalendarManager {
+
+ /** @var CalDavBackend */
+ private $backend;
+
+ /** @var IL10N */
+ private $l10n;
+
+ /**
+ * CalendarManager constructor.
+ *
+ * @param CalDavBackend $backend
+ * @param IL10N $l10n
+ */
+ public function __construct(CalDavBackend $backend, IL10N $l10n) {
+ $this->backend = $backend;
+ $this->l10n = $l10n;
+ }
+
+ /**
+ * @param IManager $cm
+ * @param string $userId
+ */
+ public function setupCalendarProvider(IManager $cm, $userId) {
+ $calendars = $this->backend->getCalendarsForUser("principals/users/$userId");
+ $this->register($cm, $calendars);
+ }
+
+ /**
+ * @param IManager $cm
+ * @param array $calendars
+ */
+ private function register(IManager $cm, array $calendars) {
+ foreach($calendars as $calendarInfo) {
+ $calendar = new Calendar($this->backend, $calendarInfo, $this->l10n);
+ $cm->registerCalendar(new CalendarImpl(
+ $calendar,
+ $calendarInfo,
+ $this->backend
+ ));
+ }
+ }
+}
diff --git a/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php b/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php
index fae2156a6b4..fc34a7af952 100644
--- a/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php
+++ b/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php
@@ -721,4 +721,113 @@ EOD;
]);
$this->assertEquals(count($search5), 0);
}
+
+ /**
+ * @dataProvider searchDataProvider
+ */
+ public function testSearch($isShared, $count) {
+ $calendarId = $this->createTestCalendar();
+
+ $uris = [];
+ $calData = [];
+
+ $uris[] = static::getUniqueID('calobj');
+ $calData[] = <<<EOD
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:Nextcloud Calendar
+BEGIN:VEVENT
+CREATED;VALUE=DATE-TIME:20130910T125139Z
+UID:47d15e3ec8-1
+LAST-MODIFIED;VALUE=DATE-TIME:20130910T125139Z
+DTSTAMP;VALUE=DATE-TIME:20130910T125139Z
+SUMMARY:Test Event
+DTSTART;VALUE=DATE-TIME:20130912T130000Z
+DTEND;VALUE=DATE-TIME:20130912T140000Z
+CLASS:PUBLIC
+END:VEVENT
+END:VCALENDAR
+EOD;
+
+ $uris[] = static::getUniqueID('calobj');
+ $calData[] = <<<EOD
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:Nextcloud Calendar
+BEGIN:VEVENT
+CREATED;VALUE=DATE-TIME:20130910T125139Z
+UID:47d15e3ec8-2
+LAST-MODIFIED;VALUE=DATE-TIME:20130910T125139Z
+DTSTAMP;VALUE=DATE-TIME:20130910T125139Z
+SUMMARY:123
+LOCATION:Test
+DTSTART;VALUE=DATE-TIME:20130912T130000Z
+DTEND;VALUE=DATE-TIME:20130912T140000Z
+CLASS:PUBLIC
+END:VEVENT
+END:VCALENDAR
+EOD;
+
+ $uris[] = static::getUniqueID('calobj');
+ $calData[] = <<<EOD
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:Nextcloud Calendar
+BEGIN:VEVENT
+CREATED;VALUE=DATE-TIME:20130910T125139Z
+UID:47d15e3ec8-3
+LAST-MODIFIED;VALUE=DATE-TIME:20130910T125139Z
+DTSTAMP;VALUE=DATE-TIME:20130910T125139Z
+SUMMARY:123
+ATTENDEE;CN=test:mailto:foo@bar.com
+DTSTART;VALUE=DATE-TIME:20130912T130000Z
+DTEND;VALUE=DATE-TIME:20130912T140000Z
+CLASS:PRIVATE
+END:VEVENT
+END:VCALENDAR
+EOD;
+
+ $uris[] = static::getUniqueID('calobj');
+ $calData[] = <<<EOD
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:Nextcloud Calendar
+BEGIN:VEVENT
+CREATED;VALUE=DATE-TIME:20130910T125139Z
+UID:47d15e3ec8-4
+LAST-MODIFIED;VALUE=DATE-TIME:20130910T125139Z
+DTSTAMP;VALUE=DATE-TIME:20130910T125139Z
+SUMMARY:123
+ATTENDEE;CN=foobar:mailto:test@bar.com
+DTSTART;VALUE=DATE-TIME:20130912T130000Z
+DTEND;VALUE=DATE-TIME:20130912T140000Z
+CLASS:CONFIDENTIAL
+END:VEVENT
+END:VCALENDAR
+EOD;
+
+ $uriCount = count($uris);
+ for ($i=0; $i < $uriCount; $i++) {
+ $this->backend->createCalendarObject($calendarId,
+ $uris[$i], $calData[$i]);
+ }
+
+ $calendarInfo = [
+ 'id' => $calendarId,
+ 'principaluri' => 'user1',
+ '{http://owncloud.org/ns}owner-principal' => $isShared ? 'user2' : 'user1',
+ ];
+
+ $result = $this->backend->search($calendarInfo, 'Test',
+ ['SUMMARY', 'LOCATION', 'ATTENDEE'], [], null, null);
+
+ $this->assertCount($count, $result);
+ }
+
+ public function searchDataProvider() {
+ return [
+ [false, 4],
+ [true, 2],
+ ];
+ }
}
diff --git a/apps/dav/tests/unit/CalDAV/CalendarImplTest.php b/apps/dav/tests/unit/CalDAV/CalendarImplTest.php
new file mode 100644
index 00000000000..ca3256773b3
--- /dev/null
+++ b/apps/dav/tests/unit/CalDAV/CalendarImplTest.php
@@ -0,0 +1,126 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\DAV\Tests\unit\CalDAV;
+
+use OCA\DAV\CalDAV\CalDavBackend;
+use OCA\DAV\CalDAV\Calendar;
+use OCA\DAV\CalDAV\CalendarImpl;
+
+class CalendarImplTest extends \Test\TestCase {
+
+ /** @var CalendarImpl */
+ private $calendarImpl;
+
+ /** @var Calendar | \PHPUnit_Framework_MockObject_MockObject */
+ private $calendar;
+
+ /** @var array */
+ private $calendarInfo;
+
+ /** @var CalDavBackend | \PHPUnit_Framework_MockObject_MockObject */
+ private $backend;
+
+ protected function setUp() {
+ parent::setUp();
+
+ $this->calendar = $this->createMock(Calendar::class);
+ $this->calendarInfo = [
+ 'id' => 'fancy_id_123',
+ '{DAV:}displayname' => 'user readable name 123',
+ '{http://apple.com/ns/ical/}calendar-color' => '#AABBCC',
+ ];
+ $this->backend = $this->createMock(CalDavBackend::class);
+
+ $this->calendarImpl = new CalendarImpl($this->calendar,
+ $this->calendarInfo, $this->backend);
+ }
+
+
+ public function testGetKey() {
+ $this->assertEquals($this->calendarImpl->getKey(), 'fancy_id_123');
+ }
+
+ public function testGetDisplayname() {
+ $this->assertEquals($this->calendarImpl->getDisplayName(),'user readable name 123');
+ }
+
+ public function testGetDisplayColor() {
+ $this->assertEquals($this->calendarImpl->getDisplayColor(), '#AABBCC');
+ }
+
+ public function testSearch() {
+ $this->backend->expects($this->once())
+ ->method('search')
+ ->with($this->calendarInfo, 'abc', ['def'], ['ghi'], 42, 1337)
+ ->will($this->returnValue(['SEARCHRESULTS']));
+
+ $result = $this->calendarImpl->search('abc', ['def'], ['ghi'], 42, 1337);
+ $this->assertEquals($result, ['SEARCHRESULTS']);
+ }
+
+ public function testGetPermissionRead() {
+ $this->calendar->expects($this->once())
+ ->method('getACL')
+ ->with()
+ ->will($this->returnValue([
+ ['privilege' => '{DAV:}read']
+ ]));
+
+ $this->assertEquals(1, $this->calendarImpl->getPermissions());
+ }
+
+ public function testGetPermissionWrite() {
+ $this->calendar->expects($this->once())
+ ->method('getACL')
+ ->with()
+ ->will($this->returnValue([
+ ['privilege' => '{DAV:}write']
+ ]));
+
+ $this->assertEquals(6, $this->calendarImpl->getPermissions());
+ }
+
+ public function testGetPermissionReadWrite() {
+ $this->calendar->expects($this->once())
+ ->method('getACL')
+ ->with()
+ ->will($this->returnValue([
+ ['privilege' => '{DAV:}read'],
+ ['privilege' => '{DAV:}write']
+ ]));
+
+ $this->assertEquals(7, $this->calendarImpl->getPermissions());
+ }
+
+ public function testGetPermissionAll() {
+ $this->calendar->expects($this->once())
+ ->method('getACL')
+ ->with()
+ ->will($this->returnValue([
+ ['privilege' => '{DAV:}all']
+ ]));
+
+ $this->assertEquals(31, $this->calendarImpl->getPermissions());
+ }
+}
diff --git a/apps/dav/tests/unit/CalDAV/CalendarManagerTest.php b/apps/dav/tests/unit/CalDAV/CalendarManagerTest.php
new file mode 100644
index 00000000000..db8c536da53
--- /dev/null
+++ b/apps/dav/tests/unit/CalDAV/CalendarManagerTest.php
@@ -0,0 +1,81 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\DAV\Tests\unit\CalDAV;
+
+use OC\Calendar\Manager;
+use OCA\DAV\CalDAV\CalDavBackend;
+use OCA\DAV\CalDAV\CalendarImpl;
+use OCA\DAV\CalDAV\CalendarManager;
+use OCP\Calendar\IManager;
+use OCP\IL10N;
+
+class CalendarManagerTest extends \Test\TestCase {
+
+ /** @var CalDavBackend | \PHPUnit_Framework_MockObject_MockObject */
+ private $backend;
+
+ /** @var IL10N | \PHPUnit_Framework_MockObject_MockObject */
+ private $l10n;
+
+ /** @var CalendarManager */
+ private $manager;
+
+ protected function setUp() {
+ parent::setUp();
+ $this->backend = $this->createMock(CalDavBackend::class);
+ $this->l10n = $this->createMock(IL10N::class);
+ $this->manager = new CalendarManager($this->backend,
+ $this->l10n);
+ }
+
+ public function testSetupCalendarProvider() {
+ $this->backend->expects($this->once())
+ ->method('getCalendarsForUser')
+ ->with('principals/users/user123')
+ ->will($this->returnValue([
+ ['id' => 123, 'uri' => 'blablub1'],
+ ['id' => 456, 'uri' => 'blablub2'],
+ ]));
+
+ /** @var IManager | \PHPUnit_Framework_MockObject_MockObject $calendarManager */
+ $calendarManager = $this->createMock(Manager::class);
+ $calendarManager->expects($this->at(0))
+ ->method('registerCalendar')
+ ->will($this->returnCallback(function() {
+ $parameter = func_get_arg(0);
+ $this->assertInstanceOf(CalendarImpl::class, $parameter);
+ $this->assertEquals(123, $parameter->getKey());
+ }));
+
+ $calendarManager->expects($this->at(1))
+ ->method('registerCalendar')
+ ->will($this->returnCallback(function() {
+ $parameter = func_get_arg(0);
+ $this->assertInstanceOf(CalendarImpl::class, $parameter);
+ $this->assertEquals(456, $parameter->getKey());
+ }));
+
+ $this->manager->setupCalendarProvider($calendarManager, 'user123');
+ }
+}
diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index 863199dfb93..93c139b7bbe 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -66,6 +66,8 @@ return array(
'OCP\\BackgroundJob' => $baseDir . '/lib/public/BackgroundJob.php',
'OCP\\BackgroundJob\\IJob' => $baseDir . '/lib/public/BackgroundJob/IJob.php',
'OCP\\BackgroundJob\\IJobList' => $baseDir . '/lib/public/BackgroundJob/IJobList.php',
+ 'OCP\\Calendar\\ICalendar' => $baseDir . '/lib/public/Calendar/ICalendar.php',
+ 'OCP\\Calendar\\IManager' => $baseDir . '/lib/public/Calendar/IManager.php',
'OCP\\Capabilities\\ICapability' => $baseDir . '/lib/public/Capabilities/ICapability.php',
'OCP\\Capabilities\\IPublicCapability' => $baseDir . '/lib/public/Capabilities/IPublicCapability.php',
'OCP\\Collaboration\\AutoComplete\\IManager' => $baseDir . '/lib/public/Collaboration/AutoComplete/IManager.php',
@@ -394,6 +396,7 @@ return array(
'OC\\BackgroundJob\\TimedJob' => $baseDir . '/lib/private/BackgroundJob/TimedJob.php',
'OC\\Cache\\CappedMemoryCache' => $baseDir . '/lib/private/Cache/CappedMemoryCache.php',
'OC\\Cache\\File' => $baseDir . '/lib/private/Cache/File.php',
+ 'OC\\Calendar\\Manager' => $baseDir . '/lib/private/Calendar/Manager.php',
'OC\\CapabilitiesManager' => $baseDir . '/lib/private/CapabilitiesManager.php',
'OC\\Collaboration\\AutoComplete\\Manager' => $baseDir . '/lib/private/Collaboration/AutoComplete/Manager.php',
'OC\\Collaboration\\Collaborators\\GroupPlugin' => $baseDir . '/lib/private/Collaboration/Collaborators/GroupPlugin.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index e52ee329e24..c073d43ca14 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -96,6 +96,8 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OCP\\BackgroundJob' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob.php',
'OCP\\BackgroundJob\\IJob' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/IJob.php',
'OCP\\BackgroundJob\\IJobList' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/IJobList.php',
+ 'OCP\\Calendar\\ICalendar' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendar.php',
+ 'OCP\\Calendar\\IManager' => __DIR__ . '/../../..' . '/lib/public/Calendar/IManager.php',
'OCP\\Capabilities\\ICapability' => __DIR__ . '/../../..' . '/lib/public/Capabilities/ICapability.php',
'OCP\\Capabilities\\IPublicCapability' => __DIR__ . '/../../..' . '/lib/public/Capabilities/IPublicCapability.php',
'OCP\\Collaboration\\AutoComplete\\IManager' => __DIR__ . '/../../..' . '/lib/public/Collaboration/AutoComplete/IManager.php',
@@ -424,6 +426,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OC\\BackgroundJob\\TimedJob' => __DIR__ . '/../../..' . '/lib/private/BackgroundJob/TimedJob.php',
'OC\\Cache\\CappedMemoryCache' => __DIR__ . '/../../..' . '/lib/private/Cache/CappedMemoryCache.php',
'OC\\Cache\\File' => __DIR__ . '/../../..' . '/lib/private/Cache/File.php',
+ 'OC\\Calendar\\Manager' => __DIR__ . '/../../..' . '/lib/private/Calendar/Manager.php',
'OC\\CapabilitiesManager' => __DIR__ . '/../../..' . '/lib/private/CapabilitiesManager.php',
'OC\\Collaboration\\AutoComplete\\Manager' => __DIR__ . '/../../..' . '/lib/private/Collaboration/AutoComplete/Manager.php',
'OC\\Collaboration\\Collaborators\\GroupPlugin' => __DIR__ . '/../../..' . '/lib/private/Collaboration/Collaborators/GroupPlugin.php',
diff --git a/lib/private/Calendar/Manager.php b/lib/private/Calendar/Manager.php
new file mode 100644
index 00000000000..85d501f8ea0
--- /dev/null
+++ b/lib/private/Calendar/Manager.php
@@ -0,0 +1,140 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Calendar;
+
+use OCP\Calendar\ICalendar;
+
+class Manager implements \OCP\Calendar\IManager {
+
+ /**
+ * @var ICalendar[] holds all registered calendars
+ */
+ private $calendars=[];
+
+ /**
+ * @var \Closure[] to call to load/register calendar providers
+ */
+ private $calendarLoaders=[];
+
+ /**
+ * This function is used to search and find objects within the user's calendars.
+ * In case $pattern is empty all events/journals/todos will be returned.
+ *
+ * @param string $pattern which should match within the $searchProperties
+ * @param array $searchProperties defines the properties within the query pattern should match
+ * @param array $options - optional parameters:
+ * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]]
+ * @param integer|null $limit - limit number of search results
+ * @param integer|null $offset - offset for paging of search results
+ * @return array an array of events/journals/todos which are arrays of arrays of key-value-pairs
+ * @since 13.0.0
+ */
+ public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null) {
+ $this->loadCalendars();
+ $result = [];
+ foreach($this->calendars as $calendar) {
+ $r = $calendar->search($pattern, $searchProperties, $options, $limit, $offset);
+ foreach($r as $o) {
+ $o['calendar-key'] = $calendar->getKey();
+ $result[] = $o;
+ }
+ }
+
+ return $result;
+ }
+
+ /**
+ * Check if calendars are available
+ *
+ * @return bool true if enabled, false if not
+ * @since 13.0.0
+ */
+ public function isEnabled() {
+ return !empty($this->calendars) || !empty($this->calendarLoaders);
+ }
+
+ /**
+ * Registers a calendar
+ *
+ * @param ICalendar $calendar
+ * @return void
+ * @since 13.0.0
+ */
+ public function registerCalendar(ICalendar $calendar) {
+ $this->calendars[$calendar->getKey()] = $calendar;
+ }
+
+ /**
+ * Unregisters a calendar
+ *
+ * @param ICalendar $calendar
+ * @return void
+ * @since 13.0.0
+ */
+ public function unregisterCalendar(ICalendar $calendar) {
+ unset($this->calendars[$calendar->getKey()]);
+ }
+
+ /**
+ * In order to improve lazy loading a closure can be registered which will be called in case
+ * calendars are actually requested
+ *
+ * @param \Closure $callable
+ * @return void
+ * @since 13.0.0
+ */
+ public function register(\Closure $callable) {
+ $this->calendarLoaders[] = $callable;
+ }
+
+ /**
+ * @return ICalendar[]
+ * @since 13.0.0
+ */
+ public function getCalendars() {
+ $this->loadCalendars();
+
+ return array_values($this->calendars);
+ }
+
+ /**
+ * removes all registered calendar instances
+ * @return void
+ * @since 13.0.0
+ */
+ public function clear() {
+ $this->calendars = [];
+ $this->calendarLoaders = [];
+ }
+
+ /**
+ * loads all calendars
+ */
+ private function loadCalendars() {
+ foreach($this->calendarLoaders as $callable) {
+ $callable($this);
+ }
+ $this->calendarLoaders = [];
+ }
+}
diff --git a/lib/private/Server.php b/lib/private/Server.php
index 1e3ac3de271..faa0ce2f2ac 100644
--- a/lib/private/Server.php
+++ b/lib/private/Server.php
@@ -153,6 +153,9 @@ class Server extends ServerContainer implements IServerContainer {
return $c;
});
+ $this->registerAlias(\OCP\Calendar\IManager::class, \OC\Calendar\Manager::class);
+ $this->registerAlias('CalendarManager', \OC\Calendar\Manager::class);
+
$this->registerAlias(\OCP\Contacts\IManager::class, \OC\ContactsManager::class);
$this->registerAlias('ContactsManager', \OCP\Contacts\IManager::class);
@@ -1099,6 +1102,13 @@ class Server extends ServerContainer implements IServerContainer {
}
/**
+ * @return \OCP\Calendar\IManager
+ */
+ public function getCalendarManager() {
+ return $this->query('CalendarManager');
+ }
+
+ /**
* @return \OCP\Contacts\IManager
*/
public function getContactsManager() {
diff --git a/lib/public/Calendar/ICalendar.php b/lib/public/Calendar/ICalendar.php
new file mode 100644
index 00000000000..359e40f6f1f
--- /dev/null
+++ b/lib/public/Calendar/ICalendar.php
@@ -0,0 +1,71 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Calendar;
+
+/**
+ * Interface ICalendar
+ *
+ * @package OCP
+ * @since 13.0.0
+ */
+interface ICalendar {
+
+ /**
+ * @return string defining the technical unique key
+ * @since 13.0.0
+ */
+ public function getKey();
+
+ /**
+ * In comparison to getKey() this function returns a human readable (maybe translated) name
+ * @return null|string
+ * @since 13.0.0
+ */
+ public function getDisplayName();
+
+ /**
+ * Calendar color
+ * @return null|string
+ * @since 13.0.0
+ */
+ public function getDisplayColor();
+
+ /**
+ * @param string $pattern which should match within the $searchProperties
+ * @param array $searchProperties defines the properties within the query pattern should match
+ * @param array $options - optional parameters:
+ * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]]
+ * @param integer|null $limit - limit number of search results
+ * @param integer|null $offset - offset for paging of search results
+ * @return array an array of events/journals/todos which are arrays of key-value-pairs
+ * @since 13.0.0
+ */
+ public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null);
+
+ /**
+ * @return integer build up using \OCP\Constants
+ * @since 13.0.0
+ */
+ public function getPermissions();
+}
diff --git a/lib/public/Calendar/IManager.php b/lib/public/Calendar/IManager.php
new file mode 100644
index 00000000000..05ccd96c414
--- /dev/null
+++ b/lib/public/Calendar/IManager.php
@@ -0,0 +1,121 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Calendar;
+
+/**
+ * This class provides access to the Nextcloud CalDAV backend.
+ * Use this class exclusively if you want to access calendars.
+ *
+ * Events/Journals/Todos in general will be expressed as an array of key-value-pairs.
+ * The keys will match the property names defined in https://tools.ietf.org/html/rfc5545
+ *
+ * [
+ * 'id' => 123,
+ * 'type' => 'VEVENT',
+ * 'calendar-key' => 42,
+ * 'objects' => [
+ * [
+ * 'SUMMARY' => ['FooBar', []],
+ * 'DTSTART' => ['20171001T123456', ['TZID' => 'EUROPE/BERLIN']],
+ * 'DURATION' => ['P1D', []],
+ * 'ATTENDEE' => [
+ * ['mailto:bla@blub.com', ['CN' => 'Mr. Bla Blub']]
+ * ],
+ * 'VALARM' => [
+ * [
+ * 'TRIGGER' => ['19980101T050000Z', ['VALUE' => DATE-TIME]]
+ * ]
+ * ]
+ * ],
+ * ]
+ * ]
+ *
+ * @since 13.0.0
+ */
+interface IManager {
+
+ /**
+ * This function is used to search and find objects within the user's calendars.
+ * In case $pattern is empty all events/journals/todos will be returned.
+ *
+ * @param string $pattern which should match within the $searchProperties
+ * @param array $searchProperties defines the properties within the query pattern should match
+ * @param array $options - optional parameters:
+ * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]]
+ * @param integer|null $limit - limit number of search results
+ * @param integer|null $offset - offset for paging of search results
+ * @return array an array of events/journals/todos which are arrays of arrays of key-value-pairs
+ * @since 13.0.0
+ */
+ public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null);
+
+ /**
+ * Check if calendars are available
+ *
+ * @return bool true if enabled, false if not
+ * @since 13.0.0
+ */
+ public function isEnabled();
+
+ /**
+ * Registers a calendar
+ *
+ * @param ICalendar $calendar
+ * @return void
+ * @since 13.0.0
+ */
+ public function registerCalendar(ICalendar $calendar);
+
+ /**
+ * Unregisters a calendar
+ *
+ * @param ICalendar $calendar
+ * @return void
+ * @since 13.0.0
+ */
+ public function unregisterCalendar(ICalendar $calendar);
+
+ /**
+ * In order to improve lazy loading a closure can be registered which will be called in case
+ * calendars are actually requested
+ *
+ * @param \Closure $callable
+ * @return void
+ * @since 13.0.0
+ */
+ public function register(\Closure $callable);
+
+ /**
+ * @return ICalendar[]
+ * @since 13.0.0
+ */
+ public function getCalendars();
+
+ /**
+ * removes all registered calendar instances
+ * @return void
+ * @since 13.0.0
+ */
+ public function clear();
+}
diff --git a/lib/public/IServerContainer.php b/lib/public/IServerContainer.php
index 13abd0ff43b..8c33a765d5e 100644
--- a/lib/public/IServerContainer.php
+++ b/lib/public/IServerContainer.php
@@ -58,6 +58,15 @@ use Symfony\Component\EventDispatcher\EventDispatcherInterface;
interface IServerContainer extends IContainer {
/**
+ * The calendar manager will act as a broker between consumers for calendar information and
+ * providers which actual deliver the calendar information.
+ *
+ * @return \OCP\Calendar\IManager
+ * @since 13.0.0
+ */
+ public function getCalendarManager();
+
+ /**
* The contacts manager will act as a broker between consumers for contacts information and
* providers which actual deliver the contact information.
*
diff --git a/tests/lib/Calendar/ManagerTest.php b/tests/lib/Calendar/ManagerTest.php
new file mode 100644
index 00000000000..657a50a3d88
--- /dev/null
+++ b/tests/lib/Calendar/ManagerTest.php
@@ -0,0 +1,214 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Test\Calendar;
+
+use \OC\Calendar\Manager;
+use OCP\Calendar\ICalendar;
+use \Test\TestCase;
+
+class ManagerTest extends TestCase {
+
+ /** @var Manager */
+ private $manager;
+
+ protected function setUp() {
+ parent::setUp();
+
+ $this->manager = new Manager();
+ }
+
+ /**
+ * @dataProvider searchProvider
+ */
+ public function testSearch($search1, $search2, $expected) {
+ /** @var ICalendar | \PHPUnit_Framework_MockObject_MockObject $calendar1 */
+ $calendar1 = $this->createMock(ICalendar::class);
+ $calendar1->method('getKey')->will($this->returnValue('simple:1'));
+ $calendar1->expects($this->once())
+ ->method('search')
+ ->with('', [], [], null, null)
+ ->will($this->returnValue($search1));
+
+ /** @var ICalendar | PHPUnit_Framework_MockObject_MockObject $calendar2 */
+ $calendar2 = $this->createMock(ICalendar::class);
+ $calendar2->method('getKey')->will($this->returnValue('simple:2'));
+ $calendar2->expects($this->once())
+ ->method('search')
+ ->with('', [], [], null, null)
+ ->will($this->returnValue($search2));
+
+ $this->manager->registerCalendar($calendar1);
+ $this->manager->registerCalendar($calendar2);
+
+ $result = $this->manager->search('');
+ $this->assertEquals($expected, $result);
+ }
+
+ /**
+ * @dataProvider searchProvider
+ */
+ public function testSearchOptions($search1, $search2, $expected) {
+ /** @var ICalendar | \PHPUnit_Framework_MockObject_MockObject $calendar1 */
+ $calendar1 = $this->createMock(ICalendar::class);
+ $calendar1->method('getKey')->will($this->returnValue('simple:1'));
+ $calendar1->expects($this->once())
+ ->method('search')
+ ->with('searchTerm', ['SUMMARY', 'DESCRIPTION'],
+ ['timerange' => ['start' => null, 'end' => null]], 5, 20)
+ ->will($this->returnValue($search1));
+
+ /** @var ICalendar | PHPUnit_Framework_MockObject_MockObject $calendar2 */
+ $calendar2 = $this->createMock(ICalendar::class);
+ $calendar2->method('getKey')->will($this->returnValue('simple:2'));
+ $calendar2->expects($this->once())
+ ->method('search')
+ ->with('searchTerm', ['SUMMARY', 'DESCRIPTION'],
+ ['timerange' => ['start' => null, 'end' => null]], 5, 20)
+ ->will($this->returnValue($search2));
+
+ $this->manager->registerCalendar($calendar1);
+ $this->manager->registerCalendar($calendar2);
+
+ $result = $this->manager->search('searchTerm', ['SUMMARY', 'DESCRIPTION'],
+ ['timerange' => ['start' => null, 'end' => null]], 5, 20);
+ $this->assertEquals($expected, $result);
+ }
+
+ public function searchProvider() {
+ $search1 = [
+ [
+ 'id' => 1,
+ 'data' => 'foobar',
+ ],
+ [
+ 'id' => 2,
+ 'data' => 'barfoo',
+ ]
+ ];
+ $search2 = [
+ [
+ 'id' => 3,
+ 'data' => 'blablub',
+ ],
+ [
+ 'id' => 4,
+ 'data' => 'blubbla',
+ ]
+ ];
+
+ $expected = [
+ [
+ 'id' => 1,
+ 'data' => 'foobar',
+ 'calendar-key' => 'simple:1',
+ ],
+ [
+ 'id' => 2,
+ 'data' => 'barfoo',
+ 'calendar-key' => 'simple:1',
+ ],
+ [
+ 'id' => 3,
+ 'data' => 'blablub',
+ 'calendar-key' => 'simple:2',
+ ],
+ [
+ 'id' => 4,
+ 'data' => 'blubbla',
+ 'calendar-key' => 'simple:2',
+ ]
+ ];
+
+ return [
+ [
+ $search1,
+ $search2,
+ $expected
+ ]
+ ];
+ }
+
+ public function testRegisterUnregister() {
+ /** @var ICalendar | \PHPUnit_Framework_MockObject_MockObject $calendar1 */
+ $calendar1 = $this->createMock(ICalendar::class);
+ $calendar1->method('getKey')->will($this->returnValue('key1'));
+
+ /** @var ICalendar | \PHPUnit_Framework_MockObject_MockObject $calendar2 */
+ $calendar2 = $this->createMock(ICalendar::class);
+ $calendar2->method('getKey')->will($this->returnValue('key2'));
+
+ $this->manager->registerCalendar($calendar1);
+ $this->manager->registerCalendar($calendar2);
+
+ $result = $this->manager->getCalendars();
+ $this->assertCount(2, $result);
+ $this->assertContains($calendar1, $result);
+ $this->assertContains($calendar2, $result);
+
+ $this->manager->unregisterCalendar($calendar1);
+
+ $result = $this->manager->getCalendars();
+ $this->assertCount(1, $result);
+ $this->assertContains($calendar2, $result);
+ }
+
+ public function testGetCalendars() {
+ /** @var ICalendar | \PHPUnit_Framework_MockObject_MockObject $calendar1 */
+ $calendar1 = $this->createMock(ICalendar::class);
+ $calendar1->method('getKey')->will($this->returnValue('key1'));
+
+ /** @var ICalendar | \PHPUnit_Framework_MockObject_MockObject $calendar2 */
+ $calendar2 = $this->createMock(ICalendar::class);
+ $calendar2->method('getKey')->will($this->returnValue('key2'));
+
+ $this->manager->registerCalendar($calendar1);
+ $this->manager->registerCalendar($calendar2);
+
+ $result = $this->manager->getCalendars();
+ $this->assertCount(2, $result);
+ $this->assertContains($calendar1, $result);
+ $this->assertContains($calendar2, $result);
+
+ $this->manager->clear();
+
+ $result = $this->manager->getCalendars();
+
+ $this->assertCount(0, $result);
+ }
+
+ public function testEnabledIfNot() {
+ $isEnabled = $this->manager->isEnabled();
+ $this->assertFalse($isEnabled);
+ }
+
+ public function testIfEnabledIfSo() {
+ /** @var ICalendar | \PHPUnit_Framework_MockObject_MockObject $calendar */
+ $calendar = $this->createMock(ICalendar::class);
+ $this->manager->registerCalendar($calendar);
+
+ $isEnabled = $this->manager->isEnabled();
+ $this->assertTrue($isEnabled);
+ }
+
+}