Merge pull request #3 from tensor-dev/calendar-query-support

Calendar query support

lib/CalDAV/calendar.js

@@ -0,0 +1,320 @@
+/*
+ * @package jsDAV
+ * @subpackage CalDAV
+ * @copyright Copyright(c) 2013 Mike de Boer. <info AT mikedeboer DOT nl>
+ * @author Mike de Boer <info AT mikedeboer DOT nl>
+ * @license http://github.com/mikedeboer/jsDAV/blob/master/LICENSE MIT License
+ */
+"use strict";
+
+var jsDAV_Collection = require("./../DAV/collection");
+var jsCalDAV_iCalendar = require("./interfaces/iCalendar");
+var jsDAV_iProperties = require("./../DAV/interfaces/iProperties");
+var jsDAVACL_iAcl = require("./../DAVACL/interfaces/iAcl");
+var jsCalDAV_CalendarObject = require("./calendarObject");
+
+var Exc = require("./../shared/exceptions");
+
+/**
+ * The Calendar class represents a CalDAV calendar, owned by a specific user
+ *
+ * The Calendar can contain multiple calendar objects
+ */
+var jsCalDAV_Calendar = module.exports = jsDAV_Collection.extend(jsCalDAV_iCalendar, jsDAV_iProperties, jsDAVACL_iAcl, {
+    /**
+     * This is an array with calendar information
+     *
+     * @var array
+     */
+    calendarInfo: {},
+
+    /**
+     * CalDAV backend
+     *
+     * @var jsCalDAV_iBackend
+     */
+    caldavBackend: null,
+
+    /**
+     * Constructor
+     *
+     * @param jsCalDAV_iBackend caldavBackend
+     * @param {Object} calendarInfo
+     */
+    initialize: function(caldavBackend, calendarInfo) {
+        this.caldavBackend = caldavBackend;
+        this.calendarInfo = calendarInfo;
+    },
+
+    /**
+     * Returns the name of the addressbook
+     *
+     * @return string
+     */
+    getName: function() {
+        return this.calendarInfo.uri;
+    },
+
+    /**
+     * Returns a Calendar Object
+     *
+     * @param {String} name
+     * @return \ICard
+     */
+    getChild: function(name, callback) {
+        var self = this;
+        this.caldavBackend.getCalendarObject(this.calendarInfo.id, name, function(err, obj) {
+            if (!obj)
+                return callback(new Exc.NotFound("Calendar object not found"));
+            callback(null, jsCalDAV_CalendarObject.new(self.caldavBackend, self.calendarInfo, obj));
+        });
+    },
+
+    /**
+     * Returns the full list of Calendar Objects
+     *
+     * @return array
+     */
+    getChildren: function(callback) {
+        var self = this;
+        this.caldavBackend.getCalendarObjects(this.calendarInfo.id, function(err, objs) {
+            if (err)
+                return callback(err);
+
+            var children = objs.map(function(obj) {
+                return jsCalDAV_CalendarObject.new(self.caldavBackend, self.calendarInfo, obj);
+            });
+            callback(null, children);
+        });
+    },
+
+    /**
+     * Creates a new directory
+     *
+     * We actually block this, as subdirectories are not allowed in addressbooks.
+     *
+     * @param {String} name
+     * @return void
+     */
+    createDirectory: function(name, callback) {
+        callback(new Exc.MethodNotAllowed("Creating collections in addressbooks is not allowed"));
+    },
+
+    /**
+     * Creates a new file
+     *
+     * The contents of the new file must be a valid ICAL.
+     *
+     * This method may return an ETag.
+     *
+     * @param {String} name
+     * @param resource icalData
+     * @return string|null
+     */
+    createFile: function(name, icalData, enc, callback) {
+        if (Buffer.isBuffer(icalData))
+            icalData = icalData.toString("utf8");
+        this.caldavBackend.createCalendarObject(this.calendarInfo.id, name, icalData, callback);
+    },
+
+    /**
+     * Deletes the entire addressbook.
+     *
+     * @return void
+     */
+    "delete": function(callback) {
+        this.caldavBackend.deleteCalendar(this.calendarInfo.id, callback);
+    },
+
+    /**
+     * Renames the addressbook
+     *
+     * @param {String} newName
+     * @return void
+     */
+    setName: function(newName, callback) {
+        callback(new Exc.MethodNotAllowed("Renaming addressbooks is not yet supported"));
+    },
+
+    /**
+     * Returns the last modification date as a unix timestamp.
+     *
+     * @return void
+     */
+    getLastModified: function(callback) {
+        callback(null, null);
+    },
+
+    /**
+     * Updates properties on this node,
+     *
+     * The properties array uses the propertyName in clark-notation as key,
+     * and the array value for the property value. In the case a property
+     * should be deleted, the property value will be null.
+     *
+     * This method must be atomic. If one property cannot be changed, the
+     * entire operation must fail.
+     *
+     * If the operation was successful, true can be returned.
+     * If the operation failed, false can be returned.
+     *
+     * Deletion of a non-existent property is always successful.
+     *
+     * Lastly, it is optional to return detailed information about any
+     * failures. In this case an array should be returned with the following
+     * structure:
+     *
+     * {
+     *   "403" : {
+     *      "{DAV:}displayname" : null,
+     *   },
+     *   "424" : {
+     *      "{DAV:}owner" : null,
+     *   }
+     * }
+     *
+     * In this example it was forbidden to update {DAV:}displayname.
+     * (403 Forbidden), which in turn also caused {DAV:}owner to fail
+     * (424 Failed Dependency) because the request needs to be atomic.
+     *
+     * @param {Object} mutations
+     * @return bool|array
+     */
+    updateProperties: function(mutations, callback) {
+        if(!callback) return false;
+        this.caldavBackend.updateCalendar(this.calendarInfo.id, mutations, callback);
+    },
+
+    /**
+     * Returns a list of properties for this nodes.
+     *
+     * The properties list is a list of propertynames the client requested,
+     * encoded in clark-notation {xmlnamespace}tagname
+     *
+     * If the array is empty, it means 'all properties' were requested.
+     *
+     * @param {Array} properties
+     * @return array
+     */
+    getProperties: function(properties, callback) {
+        var response = {};
+        var self = this;
+
+        properties.forEach(function(propertyName) {
+
+            if (self.calendarInfo[propertyName])
+                response[propertyName] = self.calendarInfo[propertyName];
+
+        });
+
+        callback(null, response);
+    },
+
+    /**
+     * Returns the owner principal
+     *
+     * This must be a url to a principal, or null if there's no owner
+     *
+     * @return string|null
+     */
+    getOwner: function() {
+        return this.calendarInfo.principaluri;
+    },
+
+    /**
+     * Returns a group principal
+     *
+     * This must be a url to a principal, or null if there's no owner
+     *
+     * @return string|null
+     */
+    getGroup: function() {
+        return null;
+    },
+
+    /**
+     * Returns a list of ACE's for this node.
+     *
+     * Each ACE has the following properties:
+     *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
+     *     currently the only supported privileges
+     *   * 'principal', a url to the principal who owns the node
+     *   * 'protected' (optional), indicating that this ACE is not allowed to
+     *      be updated.
+     *
+     * @return array
+     */
+    getACL: function() {
+        return [
+            {
+                "privilege" : "{DAV:}read",
+                "principal" : this.calendarInfo.principaluri,
+                "protected" : true
+            },
+            {
+                "privilege" : "{DAV:}write",
+                "principal" : this.calendarInfo.principaluri,
+                "protected" : true
+            }
+        ];
+    },
+
+    /**
+     * Updates the ACL
+     *
+     * This method will receive a list of new ACE's.
+     *
+     * @param {Array} acl
+     * @return void
+     */
+    setACL: function(acl, callback) {
+        callback(new Exc.MethodNotAllowed("Changing ACL is not yet supported"));
+    },
+
+    /**
+     * Returns the list of supported privileges for this node.
+     *
+     * The returned data structure is a list of nested privileges.
+     * See jsDAVACL_Plugin.getDefaultSupportedPrivilegeSet for a simple
+     * standard structure.
+     *
+     * If null is returned from this method, the default privilege set is used,
+     * which is fine for most common usecases.
+     *
+     * @return array|null
+     */
+    getSupportedPrivilegeSet: function() {
+        return null;
+    },
+
+    /**
+     * 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.
+     *
+     * @param {Array} filters
+     * @param {Function} callback
+     */
+    calendarQuery: function(filters, callback) {
+
+        var self = this;
+        this.caldavBackend.calendarQuery(this.calendarInfo.id, filters, function(err, objs) {
+            if (err)
+                return callback(err);
+
+            var children = objs.map(function(obj) {
+                return jsCalDAV_CalendarObject.new(self.caldavBackend, self.calendarInfo, obj);
+            });
+            callback(null, children);
+        });
+    }
+});