OwncloudContactsOfficial/js/storage.js

OC.Contacts = OC.Contacts || {};

/**
 * TODO: Use $.Deferred.
 */

(function(window, $, OC) {
	'use strict';

	var JSONResponse = function(response) {
		if(!response || !response.status || response.status === 'error') {
			this.error = true;
			this.message = response.data.message || 'Unknown error.';
		} else {
			this.error = false;
			if(response.data) {
				this.data = response.data;
			}
		}
	}

	/**
	* An object for saving contact data to backends
	*
	* All methods returns a jQuery.Deferred object which resolves
	* to either the requested response or an error object:
	* {
	*	status: 'error',
	*	message: The error message
	* }
	*
	* @param string user The user to query for. Defaults to current user
	*/
	var Storage = function(user) {
		this.user = user ? user : OC.currentUser;
		this.contactPhoto = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAACBCAQAAACcYtfuAAAAAnNCSVQICFXsRgQAAAAJcEhZcwAADsQAAA7EAZUrDhsAABMnSURBVHjazZx7jFzVfcc/5947j32za3vt9foJGANtgDaQxm1ValEimqQBAoWQBEhaJWlDI6WkTWhS1Y3UVEmkqo+ghjSqSqGhxVJUBwgKUIGiVgWqRDxjMCb4sazXa3tfnp33vffXP+bOPefM3NnH7M7iOxp75z5/3/N7nt/vd66iA9tjg+4vqivYLRvViIywEZhUE3KSSQ7xQvDqB2dW/5lqNW+2z3n3kPcedS2/yna1HjfhlEDOcEyeVU9Vn//p9FfDcxLIj4bkdj7JZWpJ95SX+Bf14HXT5xiQR0fdD/A5tYvMMi4qy2F1r//Y74yfM0B+eKW6l19S6eVfKRX1QvhHH/jJOQDkmWz+D9Wfq6GkW6fw8EgBVXx8qkjSLab5q65v7y29o0Ae26S+rD5Bn703RReDrCeDi4MLBIQElDnDDEWqjbfJyf3y1x88+Y4BeXJz9R/V9fa+LCNspC/RZAEE5JhkgkYGyA/Cu1aiLSsAcqDPe4APKk/v6WYj28mgFritAEKZY0xSMPcHPOrfcUOuXWrcdi98pNu7h08p4/ohLmWUFA4qIrj16HkMcR4Finqfw25XPvLcv1fXFMg+Z8s96s+IueGxnUvpWSKDBVBkGUbIEXtFpd6rwl3//WNphyKnPSBXXS13SVrfZDcX4CUQLAghYfRX/aPhn89ugwRJy2evuro9ipz2tEPuZoO+xQ62kGrihk+ZAvPMkyPHPEXL/NYAeYyy0yRig9x9oK8dmry2LMT1cp1SEsn7NnZaIAShSpWAMFJtif4HlywZkwfAdgKO1iEquc65gQfXhCOPjqq7tK0aZLvFDSGgSJkAiayXMqyYT45ZypaQuWxjUA+Spz776OiaAAl/lyvrhHicT9awUUKFEmFEfrKdrzIbq3gNTIadpLQOXSm3rI2O3KgFciPnWYpdwbfINuEo4/8C8wQG/AGGTXG/Yfn+bdlA9o+q92ovvhnPGusgJl4LlEr0u0UKhv44bCarxXPPo5s7DiR9U5iqC0G/EWQJQQRjaeGDUIjClBqUbvq15qSCmzsM5EAfe/WvdbiGfvgxya1CFHtvSCGyayC4rDMP7l2uEV4mELWR3ajauLmsjy6vu72leHRzq1CJOQJDuJonF/mbOgrE74m1m25SlvszPcbSogyJLByRc+zRRwbdno46RNWtgdQcWy1uCmMhIRYWsexZ8lYljMdSoaeYakC6OwtkfZitS3oahUSRrk2sxGCS+SCWiXDi32kNPuus72yIMqJzJKk4XFdNQGgSsmSumOELhqgqJSMdBSK9jYSYHFGGYCULWTPPbID6b9XbWdGaFsPmCKppxMXgiU1ws1jRoFXmnCqc66jVCqdNOxU2iIs0wcCKw2jikDIASxTeRNtsRznizAR+PfKtWIoqCSPcii/JZ4fGfEVkuUCWyZFqWWcM/HjmZ46qPRNsVvtWGiOEJkcqxnS+I569xLwdIpIAw+ZGs9qLNXevn2UBKUi5o6LlloK8CURaBiDS9E22ZPqMAF/vLVDpKJCwTF6LVhCNqR0QSgsoC/GlpiOBvkdRdRZIodg1J3HOsESvEdlKglFdWO0F1zjiU9FXz1dLHdWRrWc5LfpphLF2KEs/pOFXK7V3jHNLRvwsU5VcR4HsLYXH9K88geHVzYjLhkSDAdBgHMNmmQlUJt6a66hogXpdLCCuMZ0Nm3zDYmqvYnghBUMsw7e+6nc6r3VY/1miSiomRyXYrVYw6jN1DSuwHIfzRucTdAe1Qlco0dWk7gvbLlO8FMQTqyol4/rgYMeTD7eckRltgAuWQpOg5pLIE82ROk/M8o/4wc87n9cSXtbpg3kriJcEKK1DFwybFVIwgKhDt59diwTdTzRJ8/iE0acmKJL4SdYVB4muCJk3rg3/b21Spq+Kr9W9suDMj4TIS3NQ87BqqLqIemFNgDhvckY7sVI8qqYv0SLTmj/KOKNMUR+dDl5bEyD+2+FUbF3IG6PsJJKc5Brr4UkdbtGMfM/4x9cEyOi4c0KLUJ4g1hInJo6mLFej2rt4BpC8md47ueHYmgDZ64cvaxJmqRjkeQnilaTytdRP/VPlrKnqL7+/vCZAQL2oA8ccpw0i6tmuxoCx0TCnLA2ZJWeq+k/boak9IM9ySuKEwdtMx8IVIqQaIDTzxMMjjGHkOIGvz5hU/7NmQF4f40FtgouMRcU0GsY7SeXBNdRc8JnQczUkkP9wx9oaXNra7r/Ae1pt0zfZxDbM5qAgzog0zgOdSPjq8/TTHDdmhkyoaz/6s3YoarNh4MDMh3PsrXdnCQV8+i32KqP2of9VkeDVv1O8bcZYZb72sUfao6jNhgFIP8xDWuUDTjNuSjrKEqC6YHmW3swzgWWgni7/K9IePStoqnmgx3lGrtR3cNnKiDUyQTTaEs8ZHON3kaPkTLpPOb/+scPtUuO0D+SOfPg5ecUke5xJKyixueJYJrfChAVDpuXL7cNYERC44/nw8zJh5CE5zozh6XVgCCoOYGo8Ocm0CUPUt4oPrIQWlxVtlx8felP26qxQSI5MNGsUIzRUUdm0Hg+c5oRpq3weyv7FnYV3EMiP5bI3hnyu1lPmgDxdRu2pBsWxEnhzjJu2Snil+pnbJ1dGySp0mT7SXXywdKN5pyw7aV2nyfOW1Qiojqtbb39upVQ4KwfyoULv4S5rT4nj5FoEjkWON/Qzdv14yyq0y64CEHCP9RoNGLVRP05SzrPKuE7nA9BNz9G9/jkChCOKPjLWyOc5QqGBGwFvM2Pt6aIHjq0GCasCRMbAoQ+7FXuecarWtHeaKctxp+nBQZ1cDRq81biJOluLageYs8oaswhDpPAICchz2oLh0Y8LOLlzB0i5nqfqp0TOgnI2Mr1m9aNm9/uih0vpnBGtQqVuyz1+gX47eYQfdTjamxbE8NwBkjEyB11cRXaBeXvN328iGzuec4gj7joMy7SOCxbxsz0Mm4m67DmjI9WtZgjicBHznKTUIpToZ5dl38J15wiQfZ66VM85HCDDlRQ5wVHycV7YwSXNMFs4jywnTPu1ZZ+z8tVWKwayP93zae7WZKWif1P00c8cVXwCFC49bIk1I2UGlV94d44DK7acK7n4gZ6hPfJFdbWWFMWeuPQTcNryKmmG48fN8IKZ8S5wv/+t699Q8g4AeaTbuUL+lF/TPfKg6OXd8cygwjSBMdFNoVf0lXnOaqFRgfyMh1P3PTvbrpC1BeTxfv9afo9rVMMat352cV48JywyZ2VQHAbjRXEh4xxpWqIkh9R3w3+7fnINgDzS7W93blI3qIuk115vqBhil7WCZC62W3We9EbHaxmtWd4wUnNxQugI+9UPSq/dUuwYkP3p1G+p2/hNNdp8VYqtbCVt9F+FTFn9XLXp7jqjJ1jIc5iphBiU0/K4erj81C3BKgP5+8y2S9T1fIQLrA7y2PANcRHdEKUdal0lBUpNjX6KPrJRs7mDg0vIJEetCnsdjKrK68E/u/91w8FVAbLPuaJf9qhPqPfI9uZzFR7nsZXBqJzgU4oW6hWiYrOGoqJMSk8ExSUbXZVnIgr4E+ZhR3mM77mvfaiwIiD7tzkfcT6srkoOZFxG2MygdYsKs5QpUI07gSVahFF7mMKhiy7SDMSrTgTI8zaTJJdFpKSe5CGeuHG2DSDf6R66wvt4eJ3aYrVbxxd1s5EReq3sSI2oIqeYjWu9JkcU4KDwGGQTGUNXanaszASnokadpm2eY+F3w6dmDn+mugwg+y91Pq9uahjsmA/r2cAGuhIOClUqBMwzTS7q5wqNBJ3CpZchekjRHfkUu1uiwhQnrNSdNSM4ygH5h5uPLQnI/nepO53PSrbxSJos/WxgiGwL/AEVY51OhWlyFKKlMR4psvQyFDFYUKRJN6y2ql9b4DjTTaY5OjzNA3z7lZ83Ok5lG1h1i3zF2SWueYJDhiHW0093gtGqNzD7UcuTLS6VaFWJgx
	}

	/**
	 * Get all address books registered for this user.
	 *
	 * @return An array containing object of address book metadata e.g.:
	 * {
	 * 	backend:'database',
	 * 	id:'1234'
	 * 	permissions:31,
	 * 	displayname:'Contacts'
	 * }
	 */
	Storage.prototype.getAddressBooksForUser = function() {
		return this.requestRoute(
			'contacts_address_books_for_user',
			'GET',
			{user: this.user}
		);
	}

	/**
	 * Add an address book to a specific backend
	 *
	 * @param string backend - currently defaults to 'database'
	 * @param object params An object {displayname:"My contacts", description:""}
	 * @return An array containing contact data e.g.:
	 * {
	 * 	metadata:
	 * 		{
	 * 		id:'1234'
	 * 		permissions:31,
	 * 		displayname:'My contacts',
	 * 		lastmodified: (unix timestamp),
	 * 		owner: 'joye',
	 * }
	 */
	Storage.prototype.addAddressBook = function(backend, parameters) {
		console.log('Storage.addAddressBook', backend);
		return this.requestRoute(
			'contacts_address_book_add',
			'POST',
			{user: this.user, backend: 'database'},
			parameters
		);
	}

	/**
	 * Delete an address book from a specific backend
	 *
	 * @param string backend
	 * @param string addressbookid Address book ID
	 */
	Storage.prototype.deleteAddressBook = function(backend, addressbookid) {
		console.log('Storage.deleteAddressBook', backend, addressbookid);
		return this.requestRoute(
			'contacts_address_book_delete',
			'POST',
			{user: this.user, backend: 'database', addressbookid: addressbookid}
		);
	}

	/**
	 * Get contacts from an address book from a specific backend
	 *
	 * @param string backend
	 * @param string addressbookid Address book ID
	 * @return An array containing contact data e.g.:
	 * {
	 * 	metadata:
	 * 		{
	 * 		id:'1234'
	 * 		permissions:31,
	 * 		displayname:'John Q. Public',
	 * 		lastmodified: (unix timestamp),
	 * 		owner: 'joye',
	 * 		parent: (id of the parent address book)
	 * 	data: //array of VCard data
	 * }
	 */
	Storage.prototype.getContacts = function(backend, addressbookid) {
		return this.requestRoute(
			'contacts_address_book_collection',
			'GET',
			{user: this.user, backend: backend, addressbookid: addressbookid}
		);
	}

	/**
	 * Add a contact to an address book from a specific backend
	 *
	 * @param string backend
	 * @param string addressbookid Address book ID
	 * @return An array containing contact data e.g.:
	 * {
	 * 	metadata:
	 * 		{
	 * 		id:'1234'
	 * 		permissions:31,
	 * 		displayname:'John Q. Public',
	 * 		lastmodified: (unix timestamp),
	 * 		owner: 'joye',
	 * 		parent: (id of the parent address book)
	 * 	data: //array of VCard data
	 * }
	 */
	Storage.prototype.addContact = function(backend, addressbookid) {
		console.log('Storage.addContact', backend, addressbookid);
		return this.requestRoute(
			'contacts_address_book_add_contact',
			'POST',
			{user: this.user, backend: backend, addressbookid: addressbookid}
		);
	}

	/**
	 * Delete a contact from an address book from a specific backend
	 *
	 * @param string backend
	 * @param string addressbookid Address book ID
	 * @param string contactid Address book ID
	 */
	Storage.prototype.deleteContact = function(backend, addressbookid, contactid) {
		console.log('Storage.deleteContact', backend, addressbookid, contactid);
		return this.requestRoute(
			'contacts_address_book_delete_contact',
			'POST',
			{user: this.user, backend: backend, addressbookid: addressbookid, contactid: contactid}
		);
	}

	/**
	 * Delete a single property.
	 *
	 * @param string backend
	 * @param string addressbookid Address book ID
	 * @param string contactid Contact ID
	 * @param object params An object with the following properties:
	 * @param string name The name of the property e.g. EMAIL.
	 * @param string checksum For non-singular properties such as email this must contain
	 * 	an 8 character md5 checksum of the serialized \Sabre\Property
	 */
	Storage.prototype.deleteProperty = function(backend, addressbookid, contactid, params) {
		return this.requestRoute(
			'contacts_contact_delete_property',
			'POST',
			{user: this.user, backend: backend, addressbookid: addressbookid, contactid: contactid},
			params
		);
	}

	/**
	 * Save a property.
	 *
	 * @param string backend
	 * @param string addressbookid Address book ID
	 * @param string contactid Contact ID
	 * @param object params An object with the following properties:
	 * @param string name The name of the property e.g. EMAIL.
	 * @param string|array value The of the property
	 * @param array parameters Optional parameters for the property
	 * @param string checksum For non-singular properties such as email this must contain
	 * 	an 8 character md5 checksum of the serialized \Sabre\Property
	 */
	Storage.prototype.saveProperty = function(backend, addressbookid, contactid, params) {
		return this.requestRoute(
			'contacts_contact_save_property',
			'POST',
			{user: this.user, backend: backend, addressbookid: addressbookid, contactid: contactid},
			params
		);
	}

	/**
	 * Get all groups for this user.
	 *
	 * @return An array containing the groups, the favorites, any shared
	 * address books, the last selected group and the sort order of the groups.
	 * {
	 * 	'categories': [{'id':1',Family'}, {...}],
	 * 	'favorites': [123,456],
	 * 	'shared': [],
	 * 	'lastgroup':'1',
	 * 	'sortorder':'3,2,4'
	 * }
	 */
	Storage.prototype.getGroupsForUser = function() {
		console.log('getGroupsForUser');
		return this.requestRoute(
			'contacts_categories_list',
			'GET',
			{user: this.user}
		);
	}

	/**
	 * Add a group
	 *
	 * @param string name
	 * @return A JSON object containing the (maybe sanitized) group name and its ID:
	 * {
	 * 	'id':1234,
	 * 	'name':'My group'
	 * }
	 */
	Storage.prototype.addGroup = function(name) {
		console.log('Storage.addGroup', name);
		return this.requestRoute(
			'contacts_categories_add',
			'POST',
			{user: this.user},
			{name: name}
		);
	}

	/**
	 * Delete a group
	 *
	 * @param string name
	 */
	Storage.prototype.deleteGroup = function(name) {
		return this.requestRoute(
			'contacts_categories_delete',
			'POST',
			{user: this.user},
			{name: name}
		);
	}

	/**
	 * Add contacts to a group
	 *
	 * @param array contactids
	 */
	Storage.prototype.addToGroup = function(contactids, categoryid) {
		console.log('Storage.addToGroup', contactids, categoryid);
		return this.requestRoute(
			'contacts_categories_addto',
			'POST',
			{user: this.user, categoryid: categoryid},
			{contactids: contactids}
		);
	}

	/**
	 * Remove contacts from a group
	 *
	 * @param array contactids
	 */
	Storage.prototype.removeFromGroup = function(contactids, categoryid) {
		console.log('Storage.addToGroup', contactids, categoryid);
		return this.requestRoute(
			'contacts_categories_removefrom',
			'POST',
			{user: this.user, categoryid: categoryid},
			{contactids: contactids}
		);
	}

	/**
	 * Set a user preference
	 *
	 * @param string key
	 * @param string value
	 */
	Storage.prototype.setPreference = function(key, value) {
		return this.requestRoute(
			'contacts_setpreference',
			'POST',
			{user: this.user},
			{key: key, value:value}
		);
	}

	Storage.prototype.requestRoute = function(route, type, routeParams, params) {
		var self = this;
		var url = OC.Router.generate(route, routeParams);
		var ajaxParams = {type: type, url: url, dataType: 'json'};
		if(typeof params === 'object') {
			ajaxParams['data'] = params;
		}
		var defer = $.Deferred();
		$.when($.ajax(ajaxParams)).then(function(response) {
			//console.log('response', response);
			defer.resolve(new JSONResponse(response));
		}).fail(function(jqxhr, textStatus, error) {
			defer.reject(
				new JSONResponse({
					status:'error',
					data:{message:t('contacts', 'Failed loading address books: {error}', {error:textStatus + ', ' + error})}
				})
			);
		});
		return defer.promise();
	}

	OC.Contacts.Storage = Storage;

})(window, jQuery, OC);