* @copyright 2013-2014 Thomas Tanghus (thomas@tanghus.net) * * This file is licensed under the Affero General Public License version 3 or * later. * See the COPYING-README file. */ namespace OCA\Contacts\Share; use OCA\Contacts\App; class Addressbook implements \OCP\Share_Backend_Collection { const FORMAT_ADDRESSBOOKS = 1; const FORMAT_COLLECTION = 2; /** * @var \OCA\Contacts\App; */ public $app; public function __construct() { $this->app = new App(\OCP\User::getUser()); } /** * @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) { $app = new App($uidOwner); try { $app->getAddressBook('local', $itemSource); } catch(\Exception $e) { 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) { // Get app for the sharee $app = new App($shareWith); $backend = $app->getBackend('local'); // Get address book for the owner $addressBook = $this->app->getBackend('local')->getAddressBook($itemSource); $userAddressBooks = array(); foreach($backend->getAddressBooksForUser() as $userAddressBook) { $userAddressBooks[] = $userAddressBook['displayname']; } $name = $addressBook['displayname'] . '(' . $addressBook['owner'] . ')'; $suffix = ''; while (in_array($name.$suffix, $userAddressBooks)) { $suffix++; } $suffix = $suffix ? ' ' . $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, $include = false) { //\OCP\Util::writeLog('contacts', __METHOD__ // . ' ' . $include . ' ' . print_r($items, true), \OCP\Util::DEBUG); $addressBooks = array(); $backend = $this->app->getBackend('local'); if ($format === self::FORMAT_ADDRESSBOOKS) { foreach ($items as $item) { //\OCP\Util::writeLog('contacts', __METHOD__.' item_source: ' . $item['item_source'] . ' include: ' // . (int)$include, \OCP\Util::DEBUG); $addressBook = $backend->getAddressBook($item['item_source'], array('shared_by' => $item['uid_owner'])); if ($addressBook) { $addressBook['displayname'] = $addressBook['displayname'] . ' (' . $addressBook['owner'] . ')'; $addressBook['permissions'] = $item['permissions']; $addressBooks[] = $addressBook; } } } elseif ($format === self::FORMAT_COLLECTION) { foreach ($items as $item) { } } return $addressBooks; } public function getChildren($itemSource) { \OCP\Util::writeLog('contacts', __METHOD__.' item_source: ' . $itemSource, \OCP\Util::DEBUG); $contacts = $this->app->getBackend('local')->getContacts($itemSource); $children = array(); foreach($contacts as $contact) { $children[] = array('source' => $contact['id'], 'target' => $contact['displayname']); } return $children; } }