summaryrefslogtreecommitdiffstats
path: root/apps/contacts/lib/share/addressbook.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/contacts/lib/share/addressbook.php')
-rw-r--r--apps/contacts/lib/share/addressbook.php93
1 files changed, 93 insertions, 0 deletions
diff --git a/apps/contacts/lib/share/addressbook.php b/apps/contacts/lib/share/addressbook.php
new file mode 100644
index 00000000000..62799696d95
--- /dev/null
+++ b/apps/contacts/lib/share/addressbook.php
@@ -0,0 +1,93 @@
+<?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_Share_Backend_Addressbook implements OCP\Share_Backend_Collection {
+ const FORMAT_ADDRESSBOOKS = 1;
+
+ /**
+ * @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 isValidSource($itemSource, $uidOwner) {
+ $addressbook = OC_Contacts_Addressbook::find( $itemSource );
+ if( $addressbook === false || $addressbook['userid'] != $uidOwner) {
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * @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($itemSource, $shareWith, $exclude = null) {
+ $addressbook = OC_Contacts_Addressbook::find( $itemSource );
+ $user_addressbooks = array();
+ foreach(OC_Contacts_Addressbook::all($uid) as $user_addressbook) {
+ $user_addressbooks[] = $user_addressbook['displayname'];
+ }
+ $name = $addressbook['userid']."'s ".$addressbook['displayname'];
+ $suffix = '';
+ while (in_array($name.$suffix, $user_addressbooks)) {
+ $suffix++;
+ }
+
+ return $name.$suffix;
+ }
+
+ /**
+ * @brief Converts the shared item sources back into the item in the specified format
+ * @param array Shared items
+ * @param int Format
+ * @return ?
+ *
+ * The items array is a 3-dimensional array with the item_source as the first key and the share id as the second key to an array with the share info.
+ * The key/value pairs included in the share info depend on the function originally called:
+ * If called by getItem(s)Shared: id, item_type, item, item_source, share_type, share_with, permissions, stime, file_source
+ * If called by getItem(s)SharedWith: id, item_type, item, item_source, item_target, share_type, share_with, permissions, stime, file_source, file_target
+ * 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)Shared(With) functions.
+ */
+ public function formatItems($items, $format, $parameters = null) {
+ $addressbooks = array();
+ if ($format == self::FORMAT_ADDRESSBOOKS) {
+ foreach ($items as $item) {
+ $addressbook = OC_Contacts_Addressbook::find($item['item_source']);
+ if ($addressbook) {
+ $addressbook['displayname'] = $item['item_target'];
+ $addressbooks[] = $addressbook;
+ }
+ }
+ }
+ return $addressbooks;
+ }
+
+ public function getChildren($itemSource) {
+ $query = OCP\DB::prepare('SELECT id FROM *PREFIX*contacts_cards WHERE addressbookid = ?');
+ $result = $query->execute(array($itemSource));
+ $sources = array();
+ while ($contact = $result->fetchRow()) {
+ $sources[] = $contact['id'];
+ }
+ return $sources;
+ }
+
+}