[WIP] Introduce public calendar api

lib/private/calendarmanager.php

@@ -0,0 +1,151 @@
+<?php
+/**
+ * ownCloud
+ *
+ * @author Thomas Müller
+ * @copyright 2014 Thomas Müller thomas.mueller@tmit.eu
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC {
+
+	class CalendarManager implements \OCP\Calendar\IManager {
+
+		/**
+		 * @var \OCP\ICalendar[]
+		 */
+		private $calendars = [];
+
+		/**
+		 * @var \Closure[] to call to load/register calendars
+		 */
+		private $calendarLoaders = [];
+
+		public function search($pattern, $searchProperties = array(), $options = array()) {
+			$this->loadCalendars();
+			$result = array();
+			foreach($this->calendars as $cal) {
+				$r = $cal->search($pattern, $searchProperties, $options);
+				$contacts = array();
+				foreach($r as $c){
+					$c['calendar-key'] = $cal->getKey();
+					$contacts[] = $c;
+				}
+				$result = array_merge($result, $contacts);
+			}
+
+			return $result;
+		}
+
+		/**
+		 * This function can be used to delete the contact identified by the given id
+		 *
+		 * @param object $id the unique identifier to an event/task
+		 * @param string $calendarKey identifier of the calendar in which the task/event shall be deleted
+		 * @return bool successful or not
+		 */
+		public function delete($id, $calendarKey) {
+			$cal = $this->getCalendar($calendarKey);
+			if (!$cal) {
+				return null;
+			}
+
+			if ($cal->getPermissions() & \OCP\Constants::PERMISSION_DELETE) {
+				return $cal->delete($id);
+			}
+
+			return null;
+		}
+
+		/**
+		 * @param array $properties this array if key-value-pairs defines a task/event
+		 * @param string $calendarKey identifier of the calendar in which the task/event shall be created or updated
+		 * @return array an array representing the task/event just created or updated
+		 */
+		public function createOrUpdate($properties, $calendarKey) {
+			$cal = $this->getCalendar($calendarKey);
+			if (!$cal) {
+				return null;
+			}
+
+			if ($cal->getPermissions() & \OCP\Constants::PERMISSION_CREATE) {
+				return $cal->createOrUpdate($properties);
+			}
+
+			return null;
+		}
+
+		/**
+		 * @return bool true if enabled, false if not
+		 */
+		public function isEnabled() {
+			return !empty($this->calendars) || !empty($this->calendarLoaders);
+		}
+
+		/**
+		 * @param \OCP\ICalendar $calendar
+		 */
+		public function registerCalendar(\OCP\ICalendar $calendar) {
+			$this->calendars[$calendar->getKey()] = $calendar;
+		}
+
+		/**
+		 * @param \OCP\ICalendar $calendar
+		 */
+		public function unregisterCalendar(\OCP\ICalendar $calendar) {
+			unset($this->calendars[$calendar->getKey()]);
+		}
+
+		/**
+		 * @return \OCP\ICalendar[]
+		 */
+		public function getCalendars() {
+			$this->loadCalendars();
+			$result = array();
+			foreach($this->calendars as $cal) {
+				$result[$cal->getKey()] = $cal->getDisplayName();
+			}
+
+			return $result;
+		}
+
+		public function clear() {
+			$this->calendars = array();
+			$this->calendarLoaders = array();
+		}
+
+		/**
+		 * @param \Closure $callable
+		 */
+		public function register(\Closure $callable)
+		{
+			$this->calendarLoaders[] = $callable;
+		}
+
+		/**
+		 * @param string $calendarKey
+		 * @return \OCP\ICalendar
+		 */
+		protected function getCalendar($calendarKey)
+		{
+			$this->loadCalendars();
+			if (!array_key_exists($calendarKey, $this->calendars)) {
+				return null;
+			}
+
+			return $this->calendars[$calendarKey];
+		}
+
+		protected function loadCalendars()
+		{
+			foreach($this->calendarLoaders as $callable) {
+				$callable($this);
+			}
+			$this->calendarLoaders = array();
+		}
+
+	}
+}

lib/public/calendar/imanager.php

@@ -0,0 +1,96 @@
+<?php
+/**
+ * ownCloud
+ *
+ * @author Thomas Müller
+ * @copyright 2014 Thomas Müller thomas.mueller@tmit.eu
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Calendar {
+
+	/**
+	 * This class provides access to any calendar source within ownCloud.
+	 * Use this class exclusively if you want to access tasks/events.
+	 *
+	 */
+	interface IManager {
+
+		/**
+		 * @param string $pattern which should match within the $searchProperties
+		 * @param array $searchProperties defines the properties within the query pattern should match
+		 * @param array $options
+		 * 		'from' 	: defines the starting point in time for the query
+		 * 		'to'	: defines the end
+		 *
+		 * @return array of events/tasks which are arrays of key-value-pairs
+		 */
+		public function search($pattern, $searchProperties, $options);
+
+
+		/**
+		 * This function can be used to delete the task/event identified by the given id
+		 *
+		 * @param object $id the unique identifier to an event/task
+		 * @param string $calendarKey identifier of the calendar in which the task/event shall be deleted
+		 * @return bool successful or not
+		 */
+		function delete($id, $calendarKey);
+
+		/**
+		 * This function is used to create a new task/event if 'id' is not given or not present.
+		 * Otherwise the task/event will be updated by replacing the entire data set.
+		 *
+		 * @param array $properties this array if key-value-pairs defines a task/event
+		 * @param string $calendarKey identifier of the calendar in which the task/event shall be created or updated
+		 * @return array an array representing the task/event just created or updated
+		 */
+		function createOrUpdate($properties, $calendarKey);
+
+		/**
+		 * Check if task/events are available (e.g. task/events app enabled)
+		 *
+		 * @return bool true if enabled, false if not
+		 */
+		function isEnabled();
+
+		/**
+		 * Registers a calendar
+		 *
+		 * @param \OCP\ICalendar $calendar
+		 * @return void
+		 */
+		function registerCalendar(\OCP\ICalendar $calendar);
+
+		/**
+		 * Unregisters an calendar
+		 *
+		 * @param \OCP\ICalendar $calendar
+		 * @return void
+		 */
+		function unregisterCalendar(\OCP\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
+		 */
+		function register(\Closure $callable);
+
+		/**
+		 * @return \OCP\ICalendar[]
+		 */
+		function getCalendars();
+
+		/**
+		 * removes all registered calendars
+		 * @return void
+		 */
+		function clear();
+	}
+}

lib/public/icalendar.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * ownCloud
+ *
+ * @author Thomas Müller
+ * @copyright 2014 Thomas Müller thomas.mueller@tmit.eu
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCP {
+
+	interface ICalendar {
+
+		/**
+		 * @param string $pattern which should match within the $searchProperties
+		 * @param array $searchProperties defines the properties within the query pattern should match
+		 * @param array $options
+		 * 		'from' 	: defines the starting point in time for the query
+		 * 		'to'	: defines the end
+		 *
+		 * @return array of events/journals/tasks which are arrays of key-value-pairs
+		 */
+		public function search($pattern, $searchProperties, $options);
+
+		/**
+		 * @return string defining the technical unique key
+		 */
+		public function getKey();
+
+		/**
+		 * In comparison to getKey() this function returns a human readable (maybe translated) name
+		 * @return string
+		 */
+		public function getDisplayName();
+
+		/**
+		 * @param array $properties this array if key-value-pairs defines a event/task
+		 * @return array an array representing the event/task just created or updated
+		 */
+		public function createOrUpdate($properties);
+
+		/**
+		 * @return mixed
+		 */
+		public function getPermissions();
+
+		/**
+		 * @param object $id the unique identifier to an event/task
+		 * @return bool successful or not
+		 */
+		public function delete($id);
+	}
+}