From b9e1033563b534faa75b0e0562f441b4eaf83a7d Mon Sep 17 00:00:00 2001
From: Bart Visscher <bartv@thisnet.nl>
Date: Mon, 25 Jun 2012 22:51:42 +0200
Subject: [PATCH] Basic framework for contacts sharing

---
 apps/contacts/appinfo/app.php |  2 ++
 apps/contacts/lib/share.php   | 54 +++++++++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 apps/contacts/lib/share.php

diff --git a/apps/contacts/appinfo/app.php b/apps/contacts/appinfo/app.php
index 64fe00eef1..f27db13ca7 100644
--- a/apps/contacts/appinfo/app.php
+++ b/apps/contacts/appinfo/app.php
@@ -3,6 +3,7 @@ OC::$CLASSPATH['OC_Contacts_App'] = 'apps/contacts/lib/app.php';
 OC::$CLASSPATH['OC_Contacts_Addressbook'] = 'apps/contacts/lib/addressbook.php';
 OC::$CLASSPATH['OC_Contacts_VCard'] = 'apps/contacts/lib/vcard.php';
 OC::$CLASSPATH['OC_Contacts_Hooks'] = 'apps/contacts/lib/hooks.php';
+OC::$CLASSPATH['OC_Contacts_Share'] = 'apps/contacts/lib/share.php';
 OC::$CLASSPATH['OC_Connector_Sabre_CardDAV'] = 'apps/contacts/lib/connector_sabre.php';
 OC::$CLASSPATH['OC_Search_Provider_Contacts'] = 'apps/contacts/lib/search.php';
 OCP\Util::connectHook('OC_User', 'post_createUser', 'OC_Contacts_Hooks', 'createUser');
@@ -21,3 +22,4 @@ OCP\App::addNavigationEntry( array(
 OCP\App::registerPersonal('contacts','settings');
 OCP\Util::addscript('contacts', 'loader');
 OC_Search::registerProvider('OC_Search_Provider_Contacts');
+OCP\Share::registerBackend('addressbook', new OC_Contacts_Share());
diff --git a/apps/contacts/lib/share.php b/apps/contacts/lib/share.php
new file mode 100644
index 0000000000..d304042edd
--- /dev/null
+++ b/apps/contacts/lib/share.php
@@ -0,0 +1,54 @@
+<?php
+/**
+ * Copyright (c) 2012 Bart Visscher <bartv@thisnet.nl>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+class OC_Contacts_Share extends OCP\Share_Backend {
+	/**
+	* @brief Get the source of the item to be stored in the database
+	* @param string Item
+	* @param string Owner of the item
+	* @return mixed|array|false Source
+	*
+	* Return an array if the item is file dependent, the array needs two keys: 'item' and 'file'
+	* Return false if the item does not exist for the user
+	*
+	* The formatItems() function will translate the source returned back into the item
+	*/
+	public function getSource($item, $uid) {
+		$addressbook = OC_Contacts_Addressbook::find( $item );
+		if( $addressbook === false || $addressbook['userid'] != $uid) {
+			return false;
+		}
+		return $item;
+	}
+
+	/**
+	* @brief Get a unique name of the item for the specified user
+	* @param string Item
+	* @param string|false User the item is being shared with
+	* @param array|null List of similar item names already existing as shared items
+	* @return string Target name
+	*
+	* This function needs to verify that the user does not already have an item with this name.
+	* If it does generate a new name e.g. name_#
+	*/
+	public function generateTarget($item, $uid, $exclude = null) {
+	}
+
+	/**
+	* @brief Converts the shared item sources back into the item in the specified format
+	* @param array Sources of shared items
+	* @param int Format 
+	* @return ?
+	* 
+	* The items array is formatted with the sources as the keys to an array with the following keys: item_target, permissions, stime
+	* This function allows the backend to control the output of shared items with custom formats.
+	* It is only called through calls to the public getItem(s)SharedWith functions.
+	*/
+	public function formatItems($items, $format) {
+	}
+}