summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorGeorg Ehrke <developer@georgehrke.com>2017-10-31 17:06:01 +0100
committerGeorg Ehrke <developer@georgehrke.com>2017-11-09 15:14:50 +0100
commit556b2a2b6facb147295abebb18d1b391afa3f184 (patch)
tree5284d59d23f46b75d35fab326b2b706c2b8d4c8c /lib
parent5d206eec69760afe33b9febcd3173dec2fab989d (diff)
downloadnextcloud-server-556b2a2b6facb147295abebb18d1b391afa3f184.tar.gz
nextcloud-server-556b2a2b6facb147295abebb18d1b391afa3f184.zip
implement CalendarManager
Signed-off-by: Georg Ehrke <developer@georgehrke.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/private/Calendar/Manager.php140
-rw-r--r--lib/private/Server.php10
-rw-r--r--lib/public/IServerContainer.php9
3 files changed, 159 insertions, 0 deletions
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 af18b1a3a11..867eee99b54 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);
@@ -1095,6 +1098,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/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.
*