Merge pull request #6637 from nextcloud/contactsstore_public_api

Make ContactsStore a public API
nextcloud · Dec 11, 2017 · 179be8d · 179be8d
2 parents bd80795 + cecfc28
commit 179be8d
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 1 deletion.
diff --git a/apps/dav/appinfo/app.php b/apps/dav/appinfo/app.php
@@ -53,6 +53,8 @@ function(GenericEvent $event) use ($app) {
 	$user = \OC::$server->getUserSession()->getUser();
 	if (!is_null($user)) {
 		$app->setupContactsProvider($cm, $user->getUID());
+	} else {
+		$app->setupSystemContactsProvider($cm);
 	}
 });
 

diff --git a/apps/dav/lib/AppInfo/Application.php b/apps/dav/lib/AppInfo/Application.php
@@ -75,6 +75,16 @@ public function setupContactsProvider(IContactsManager $contactsManager, $userID
 		$cm->setupContactsProvider($contactsManager, $userID, $urlGenerator);
 	}
 
+	/**
+	 * @param IManager $contactsManager
+	 */
+	public function setupSystemContactsProvider(IContactsManager $contactsManager) {
+		/** @var ContactsManager $cm */
+		$cm = $this->getContainer()->query(ContactsManager::class);
+		$urlGenerator = $this->getContainer()->getServer()->getURLGenerator();
+		$cm->setupSystemContactsProvider($contactsManager, $urlGenerator);
+	}
+
 	/**
 	 * @param ICalendarManager $calendarManager
 	 * @param string $userId

diff --git a/apps/dav/lib/CardDAV/ContactsManager.php b/apps/dav/lib/CardDAV/ContactsManager.php
@@ -55,6 +55,14 @@ public function __construct(CardDavBackend $backend, IL10N $l10n) {
 	public function setupContactsProvider(IManager $cm, $userId, IURLGenerator $urlGenerator) {
 		$addressBooks = $this->backend->getAddressBooksForUser("principals/users/$userId");
 		$this->register($cm, $addressBooks, $urlGenerator);
+		$this->setupSystemContactsProvider($cm, $urlGenerator);
+	}
+
+	/**
+	 * @param IManager $cm
+	 * @param IURLGenerator $urlGenerator
+	 */
+	public function setupSystemContactsProvider(IManager $cm, IURLGenerator $urlGenerator) {
 		$addressBooks = $this->backend->getAddressBooksForUser("principals/system/system");
 		$this->register($cm, $addressBooks, $urlGenerator);
 	}

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
@@ -93,6 +93,7 @@
     'OCP\\Contacts' => $baseDir . '/lib/public/Contacts.php',
     'OCP\\Contacts\\ContactsMenu\\IAction' => $baseDir . '/lib/public/Contacts/ContactsMenu/IAction.php',
     'OCP\\Contacts\\ContactsMenu\\IActionFactory' => $baseDir . '/lib/public/Contacts/ContactsMenu/IActionFactory.php',
+    'OCP\\Contacts\\ContactsMenu\\IContactsStore' => $baseDir . '/lib/public/Contacts/ContactsMenu/IContactsStore.php',
     'OCP\\Contacts\\ContactsMenu\\IEntry' => $baseDir . '/lib/public/Contacts/ContactsMenu/IEntry.php',
     'OCP\\Contacts\\ContactsMenu\\ILinkAction' => $baseDir . '/lib/public/Contacts/ContactsMenu/ILinkAction.php',
     'OCP\\Contacts\\ContactsMenu\\IProvider' => $baseDir . '/lib/public/Contacts/ContactsMenu/IProvider.php',

diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
@@ -123,6 +123,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OCP\\Contacts' => __DIR__ . '/../../..' . '/lib/public/Contacts.php',
         'OCP\\Contacts\\ContactsMenu\\IAction' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IAction.php',
         'OCP\\Contacts\\ContactsMenu\\IActionFactory' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IActionFactory.php',
+        'OCP\\Contacts\\ContactsMenu\\IContactsStore' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IContactsStore.php',
         'OCP\\Contacts\\ContactsMenu\\IEntry' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IEntry.php',
         'OCP\\Contacts\\ContactsMenu\\ILinkAction' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/ILinkAction.php',
         'OCP\\Contacts\\ContactsMenu\\IProvider' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IProvider.php',

diff --git a/lib/private/Contacts/ContactsMenu/ContactsStore.php b/lib/private/Contacts/ContactsMenu/ContactsStore.php
@@ -35,8 +35,9 @@
 use OCP\IUser;
 use OCP\IUserManager;
 use OCP\IUserSession;
+use OCP\Contacts\ContactsMenu\IContactsStore;
 
-class ContactsStore {
+class ContactsStore implements IContactsStore {
 
 	/** @var IManager */
 	private $contactsManager;

diff --git a/lib/private/Server.php b/lib/private/Server.php
@@ -63,6 +63,7 @@
 use OC\Collaboration\Collaborators\UserPlugin;
 use OC\Command\CronBus;
 use OC\Contacts\ContactsMenu\ActionFactory;
+use OC\Contacts\ContactsMenu\ContactsStore;
 use OC\Diagnostics\EventLogger;
 use OC\Diagnostics\QueryLogger;
 use OC\Federation\CloudIdManager;
@@ -114,6 +115,7 @@
 use OCP\App\IAppManager;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\Collaboration\AutoComplete\IManager;
+use OCP\Contacts\ContactsMenu\IContactsStore;
 use OCP\Defaults;
 use OCA\Theming\Util;
 use OCP\Federation\ICloudIdManager;
@@ -1129,6 +1131,16 @@ public function __construct($webRoot, \OC\Config $config) {
 			return new InstanceFactory($memcacheFactory->createLocal('remoteinstance.'), $c->getHTTPClientService());
 		});
 
+		$this->registerService(IContactsStore::class, function(Server $c) {
+			return new ContactsStore(
+				$c->getContactsManager(),
+				$c->getConfig(),
+				$c->getUserManager(),
+				$c->getGroupManager()
+			);
+		});
+		$this->registerAlias(IContactsStore::class, ContactsStore::class);
+
 		$this->connectDispatcher();
 	}
 

diff --git a/lib/public/Contacts/ContactsMenu/IContactsStore.php b/lib/public/Contacts/ContactsMenu/IContactsStore.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace OCP\Contacts\ContactsMenu;
+
+use OCP\IUser;
+
+/**
+ * @since 13.0.0
+ */
+interface IContactsStore {
+
+
+	/**
+	 * @param IUser $user
+	 * @param $filter
+	 * @return IEntry[]
+	 * @since 13.0.0
+	 */
+	public function getContacts(IUser $user, $filter);
+
+	/**
+	 * @brief finds a contact by specifying the property to search on ($shareType) and the value ($shareWith)
+	 * @param IUser $user
+	 * @param integer $shareType
+	 * @param string $shareWith
+	 * @return IEntry|null
+	 * @since 13.0.0
+	 */
+	public function findOne(IUser $user, $shareType, $shareWith);
+
+}