From 176ecbd31199370b68e310aa0dc361a4e25a04ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20M=C3=BCller?= Date: Tue, 15 Jul 2014 17:13:34 +0200 Subject: [PATCH] ownCloud users are exported as address book --- lib/base.php | 9 ++ lib/private/contacts/localaddressbook.php | 104 ++++++++++++++++++++++ tests/lib/contacts/localadressbook.php | 95 ++++++++++++++++++++ 3 files changed, 208 insertions(+) create mode 100644 lib/private/contacts/localaddressbook.php create mode 100644 tests/lib/contacts/localadressbook.php diff --git a/lib/base.php b/lib/base.php index 840d904471..95e5ae17b4 100644 --- a/lib/base.php +++ b/lib/base.php @@ -585,6 +585,7 @@ class OC { self::registerPreviewHooks(); self::registerShareHooks(); self::registerLogRotate(); + self::registerLocalAddressBook(); //make sure temporary files are cleaned up register_shutdown_function(array('OC_Helper', 'cleanTmp')); @@ -596,6 +597,14 @@ class OC { } } + private static function registerLocalAddressBook() { + self::$server->getContactsManager()->register(function() { + $userManager = \OC::$server->getUserManager(); + \OC::$server->getContactsManager()->registerAddressBook( + new \OC\Contacts\LocalAddressBook($userManager)); + }); + } + /** * register hooks for the cache */ diff --git a/lib/private/contacts/localaddressbook.php b/lib/private/contacts/localaddressbook.php new file mode 100644 index 0000000000..483bbee83f --- /dev/null +++ b/lib/private/contacts/localaddressbook.php @@ -0,0 +1,104 @@ +deepdiver@owncloud.com> + * + */ + +namespace OC\Contacts; + +class LocalAddressBook implements \OCP\IAddressBook { + + /** + * @var \OCP\IUserManager + */ + private $userManager; + + /** + * @param $userManager + */ + public function __construct($userManager) { + $this->userManager = $userManager; + } + + /** + * @return string defining the technical unique key + */ + public function getKey() { + return 'local'; + } + + /** + * In comparison to getKey() this function returns a human readable (maybe translated) name + * + * @return mixed + */ + public function getDisplayName() { + return "Local users"; + } + + /** + * @param string $pattern which should match within the $searchProperties + * @param array $searchProperties defines the properties within the query pattern should match + * @param array $options - for future use. One should always have options! + * @return array an array of contacts which are arrays of key-value-pairs + */ + public function search($pattern, $searchProperties, $options) { + $users = array(); + if($pattern == '') { + // Fetch all contacts + $users = $this->userManager->search(''); + } else { + foreach($searchProperties as $property) { + $result = array(); + if($property === 'FN') { + $result = $this->userManager->searchDisplayName($pattern); + } else if ($property === 'id') { + $result = $this->userManager->search($pattern); + } + if (is_array($result)) { + $users = array_merge($users, $result); + } + } + } + + $contacts = array(); + foreach($users as $user){ + $contact = array( + "id" => $user->getUID(), + "FN" => $user->getDisplayname(), + "EMAIL" => array(), + "IMPP" => array( + "x-owncloud-handle:" . $user->getUID() + ) + ); + $contacts[] = $contact; + } + return $contacts; + } + + /** + * @param array $properties this array if key-value-pairs defines a contact + * @return array an array representing the contact just created or updated + */ + public function createOrUpdate($properties) { + return array(); + } + + /** + * @return int + */ + public function getPermissions() { + return \OCP\PERMISSION_READ; + } + + /** + * @param object $id the unique identifier to a contact + * @return bool successful or not + */ + public function delete($id) { + return false; + } +} diff --git a/tests/lib/contacts/localadressbook.php b/tests/lib/contacts/localadressbook.php new file mode 100644 index 0000000000..276863aeb6 --- /dev/null +++ b/tests/lib/contacts/localadressbook.php @@ -0,0 +1,95 @@ +. + */ + +class Test_LocalAddressBook extends PHPUnit_Framework_TestCase +{ + + public function testSearchFN() { + $stub = $this->getMockForAbstractClass('\OCP\IUserManager', array('searchDisplayName')); + + $stub->expects($this->any())->method('searchDisplayName')->will($this->return(array( + new SimpleUserForTesting('tom', 'Thomas'), + new SimpleUserForTesting('tomtom', 'Thomas T.'), + ))); + + $localAddressBook = new LocalAddressBook($stub); + + $result = $localAddressBook->search('tom', array('FN'), array()); + $this->assertEqual(2, count($result)); + } + + public function testSearchId() { + $stub = $this->getMockForAbstractClass('\OCP\IUserManager', array('searchDisplayName')); + + $stub->expects($this->any())->method('search')->will($this->return(array( + new SimpleUserForTesting('tom', 'Thomas'), + new SimpleUserForTesting('tomtom', 'Thomas T.'), + ))); + + $localAddressBook = new LocalAddressBook($stub); + + $result = $localAddressBook->search('tom', array('id'), array()); + $this->assertEqual(2, count($result)); + } +} + + +class SimpleUserForTesting implements \OCP\IUser { + + public function __construct($uid, $displayName) { + + $this->uid = $uid; + $this->displayName = $displayName; + } + + public function getUID() { + return $this->uid; + } + + public function getDisplayName() { + return $this->displayName; + } + + public function setDisplayName($displayName) { + } + + public function getLastLogin() { + } + + public function updateLastLoginTimestamp() { + } + + public function delete() { + } + + public function setPassword($password, $recoveryPassword) { + } + + public function getHome() { + } + + public function canChangeAvatar() { + } + + public function canChangePassword() { + } + + public function canChangeDisplayName() { + } + + public function isEnabled() { + } + + public function setEnabled($enabled) { + } +}