nextcloud / server

apps/dav/lib/CardDAV/CardDavBackend.php

Indentation +1171 added lines, -1171 removed lines

@@ -55,1175 +55,1175 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class CardDavBackend implements BackendInterface, SyncSupport {
-	public const PERSONAL_ADDRESSBOOK_URI = 'contacts';
-	public const PERSONAL_ADDRESSBOOK_NAME = 'Contacts';
-
-	/** @var Principal */
-	private $principalBackend;
-
-	/** @var string */
-	private $dbCardsTable = 'cards';
-
-	/** @var string */
-	private $dbCardsPropertiesTable = 'cards_properties';
-
-	/** @var IDBConnection */
-	private $db;
-
-	/** @var Backend */
-	private $sharingBackend;
-
-	/** @var array properties to index */
-	public static $indexProperties = [
-		'BDAY', 'UID', 'N', 'FN', 'TITLE', 'ROLE', 'NOTE', 'NICKNAME',
-		'ORG', 'CATEGORIES', 'EMAIL', 'TEL', 'IMPP', 'ADR', 'URL', 'GEO', 'CLOUD'];
-
-	/**
-	 * @var string[] Map of uid => display name
-	 */
-	protected $userDisplayNames;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var EventDispatcherInterface */
-	private $dispatcher;
-
-	/**
-	 * CardDavBackend constructor.
-	 *
-	 * @param IDBConnection $db
-	 * @param Principal $principalBackend
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(IDBConnection $db,
-								Principal $principalBackend,
-								IUserManager $userManager,
-								IGroupManager $groupManager,
-								EventDispatcherInterface $dispatcher) {
-		$this->db = $db;
-		$this->principalBackend = $principalBackend;
-		$this->userManager = $userManager;
-		$this->dispatcher = $dispatcher;
-		$this->sharingBackend = new Backend($this->db, $this->userManager, $groupManager, $principalBackend, 'addressbook');
-	}
-
-	/**
-	 * Return the number of address books for a principal
-	 *
-	 * @param $principalUri
-	 * @return int
-	 */
-	public function getAddressBooksForUserCount($principalUri) {
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select($query->func()->count('*'))
-			->from('addressbooks')
-			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		return (int)$query->execute()->fetchColumn();
-	}
-
-	/**
-	 * Returns the list of address books for a specific user.
-	 *
-	 * Every addressbook should have the following properties:
-	 *   id - an arbitrary unique id
-	 *   uri - the 'basename' part of the url
-	 *   principaluri - Same as the passed parameter
-	 *
-	 * Any additional clark-notation property may be passed besides this. Some
-	 * common ones are :
-	 *   {DAV:}displayname
-	 *   {urn:ietf:params:xml:ns:carddav}addressbook-description
-	 *   {http://calendarserver.org/ns/}getctag
-	 *
-	 * @param string $principalUri
-	 * @return array
-	 */
-	public function getAddressBooksForUser($principalUri) {
-		$principalUriOriginal = $principalUri;
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		$addressBooks = [];
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		// query for shared addressbooks
-		$principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
-		$principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
-
-		$principals = array_map(function ($principal) {
-			return urldecode($principal);
-		}, $principals);
-		$principals[]= $principalUri;
-
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
-			->from('dav_shares', 's')
-			->join('s', 'addressbooks', 'a', $query->expr()->eq('s.resourceid', 'a.id'))
-			->where($query->expr()->in('s.principaluri', $query->createParameter('principaluri')))
-			->andWhere($query->expr()->eq('s.type', $query->createParameter('type')))
-			->setParameter('type', 'addressbook')
-			->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
-			->execute();
-
-		$readOnlyPropertyName = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only';
-		while ($row = $result->fetch()) {
-			if ($row['principaluri'] === $principalUri) {
-				continue;
-			}
-
-			$readOnly = (int) $row['access'] === Backend::ACCESS_READ;
-			if (isset($addressBooks[$row['id']])) {
-				if ($readOnly) {
-					// New share can not have more permissions then the old one.
-					continue;
-				}
-				if (isset($addressBooks[$row['id']][$readOnlyPropertyName]) &&
-					$addressBooks[$row['id']][$readOnlyPropertyName] === 0) {
-					// Old share is already read-write, no more permissions can be gained
-					continue;
-				}
-			}
-
-			list(, $name) = \Sabre\Uri\split($row['principaluri']);
-			$uri = $row['uri'] . '_shared_by_' . $name;
-			$displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
-
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $uri,
-				'principaluri' => $principalUriOriginal,
-				'{DAV:}displayname' => $displayName,
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-				'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
-				$readOnlyPropertyName => $readOnly,
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		return array_values($addressBooks);
-	}
-
-	public function getUsersOwnAddressBooks($principalUri) {
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			  ->from('addressbooks')
-			  ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		$addressBooks = [];
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		return array_values($addressBooks);
-	}
-
-	private function getUserDisplayName($uid) {
-		if (!isset($this->userDisplayNames[$uid])) {
-			$user = $this->userManager->get($uid);
-
-			if ($user instanceof IUser) {
-				$this->userDisplayNames[$uid] = $user->getDisplayName();
-			} else {
-				$this->userDisplayNames[$uid] = $uid;
-			}
-		}
-
-		return $this->userDisplayNames[$uid];
-	}
-
-	/**
-	 * @param int $addressBookId
-	 */
-	public function getAddressBookById($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if ($row === false) {
-			return null;
-		}
-
-		$addressBook = [
-			'id'  => $row['id'],
-			'uri' => $row['uri'],
-			'principaluri' => $row['principaluri'],
-			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-		];
-
-		$this->addOwnerPrincipal($addressBook);
-
-		return $addressBook;
-	}
-
-	/**
-	 * @param $addressBookUri
-	 * @return array|null
-	 */
-	public function getAddressBooksByUri($principal, $addressBookUri) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('uri', $query->createNamedParameter($addressBookUri)))
-			->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($principal)))
-			->setMaxResults(1)
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if ($row === false) {
-			return null;
-		}
-
-		$addressBook = [
-			'id'  => $row['id'],
-			'uri' => $row['uri'],
-			'principaluri' => $row['principaluri'],
-			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-		];
-
-		$this->addOwnerPrincipal($addressBook);
-
-		return $addressBook;
-	}
-
-	/**
-	 * Updates properties for an address book.
-	 *
-	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-	 * To do the actual updates, you must tell this object which properties
-	 * you're going to process with the handle() method.
-	 *
-	 * Calling the handle method is like telling the PropPatch object "I
-	 * promise I can handle updating this property".
-	 *
-	 * Read the PropPatch documentation for more info and examples.
-	 *
-	 * @param string $addressBookId
-	 * @param \Sabre\DAV\PropPatch $propPatch
-	 * @return void
-	 */
-	public function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
-		$supportedProperties = [
-			'{DAV:}displayname',
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description',
-		];
-
-		/**
-		 * @suppress SqlInjectionChecker
-		 */
-		$propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
-			$updates = [];
-			foreach ($mutations as $property=>$newValue) {
-				switch ($property) {
-					case '{DAV:}displayname':
-						$updates['displayname'] = $newValue;
-						break;
-					case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
-						$updates['description'] = $newValue;
-						break;
-				}
-			}
-			$query = $this->db->getQueryBuilder();
-			$query->update('addressbooks');
-
-			foreach ($updates as $key=>$value) {
-				$query->set($key, $query->createNamedParameter($value));
-			}
-			$query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-			$this->addChange($addressBookId, "", 2);
-
-			return true;
-		});
-	}
-
-	/**
-	 * Creates a new address book
-	 *
-	 * @param string $principalUri
-	 * @param string $url Just the 'basename' of the url.
-	 * @param array $properties
-	 * @return int
-	 * @throws BadRequest
-	 */
-	public function createAddressBook($principalUri, $url, array $properties) {
-		$values = [
-			'displayname' => null,
-			'description' => null,
-			'principaluri' => $principalUri,
-			'uri' => $url,
-			'synctoken' => 1
-		];
-
-		foreach ($properties as $property=>$newValue) {
-			switch ($property) {
-				case '{DAV:}displayname':
-					$values['displayname'] = $newValue;
-					break;
-				case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
-					$values['description'] = $newValue;
-					break;
-				default:
-					throw new BadRequest('Unknown property: ' . $property);
-			}
-		}
-
-		// Fallback to make sure the displayname is set. Some clients may refuse
-		// to work with addressbooks not having a displayname.
-		if (is_null($values['displayname'])) {
-			$values['displayname'] = $url;
-		}
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('addressbooks')
-			->values([
-				'uri' => $query->createParameter('uri'),
-				'displayname' => $query->createParameter('displayname'),
-				'description' => $query->createParameter('description'),
-				'principaluri' => $query->createParameter('principaluri'),
-				'synctoken' => $query->createParameter('synctoken'),
-			])
-			->setParameters($values)
-			->execute();
-
-		return $query->getLastInsertId();
-	}
-
-	/**
-	 * Deletes an entire addressbook and all its contents
-	 *
-	 * @param mixed $addressBookId
-	 * @return void
-	 */
-	public function deleteAddressBook($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete($this->dbCardsTable)
-			->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
-			->setParameter('addressbookid', $addressBookId)
-			->execute();
-
-		$query->delete('addressbookchanges')
-			->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
-			->setParameter('addressbookid', $addressBookId)
-			->execute();
-
-		$query->delete('addressbooks')
-			->where($query->expr()->eq('id', $query->createParameter('id')))
-			->setParameter('id', $addressBookId)
-			->execute();
-
-		$this->sharingBackend->deleteAllShares($addressBookId);
-
-		$query->delete($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->execute();
-	}
-
-	/**
-	 * Returns all cards for a specific addressbook id.
-	 *
-	 * This method should return the following properties for each card:
-	 *   * carddata - raw vcard data
-	 *   * uri - Some unique url
-	 *   * lastmodified - A unix timestamp
-	 *
-	 * It's recommended to also return the following properties:
-	 *   * etag - A unique etag. This must change every time the card changes.
-	 *   * size - The size of the card in bytes.
-	 *
-	 * If these last two properties are provided, less time will be spent
-	 * calculating them. If they are specified, you can also ommit carddata.
-	 * This may speed up certain requests, especially with large cards.
-	 *
-	 * @param mixed $addressBookId
-	 * @return array
-	 */
-	public function getCards($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from($this->dbCardsTable)
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$cards = [];
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$row['etag'] = '"' . $row['etag'] . '"';
-
-			$modified = false;
-			$row['carddata'] = $this->readBlob($row['carddata'], $modified);
-			if ($modified) {
-				$row['size'] = strlen($row['carddata']);
-			}
-
-			$cards[] = $row;
-		}
-		$result->closeCursor();
-
-		return $cards;
-	}
-
-	/**
-	 * Returns a specific card.
-	 *
-	 * The same set of properties must be returned as with getCards. The only
-	 * exception is that 'carddata' is absolutely required.
-	 *
-	 * If the card does not exist, you must return false.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @return array
-	 */
-	public function getCard($addressBookId, $cardUri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from($this->dbCardsTable)
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->setMaxResults(1);
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		if (!$row) {
-			return false;
-		}
-		$row['etag'] = '"' . $row['etag'] . '"';
-
-		$modified = false;
-		$row['carddata'] = $this->readBlob($row['carddata'], $modified);
-		if ($modified) {
-			$row['size'] = strlen($row['carddata']);
-		}
-
-		return $row;
-	}
-
-	/**
-	 * Returns a list of cards.
-	 *
-	 * This method should work identical to getCard, but instead return all the
-	 * cards in the list as an array.
-	 *
-	 * If the backend supports this, it may allow for some speed-ups.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string[] $uris
-	 * @return array
-	 */
-	public function getMultipleCards($addressBookId, array $uris) {
-		if (empty($uris)) {
-			return [];
-		}
-
-		$chunks = array_chunk($uris, 100);
-		$cards = [];
-
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from($this->dbCardsTable)
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->in('uri', $query->createParameter('uri')));
-
-		foreach ($chunks as $uris) {
-			$query->setParameter('uri', $uris, IQueryBuilder::PARAM_STR_ARRAY);
-			$result = $query->execute();
-
-			while ($row = $result->fetch()) {
-				$row['etag'] = '"' . $row['etag'] . '"';
-
-				$modified = false;
-				$row['carddata'] = $this->readBlob($row['carddata'], $modified);
-				if ($modified) {
-					$row['size'] = strlen($row['carddata']);
-				}
-
-				$cards[] = $row;
-			}
-			$result->closeCursor();
-		}
-		return $cards;
-	}
-
-	/**
-	 * Creates a new card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag is for the
-	 * newly created resource, and must be enclosed with double quotes (that
-	 * is, the string itself must contain the double quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 * @return string
-	 */
-	public function createCard($addressBookId, $cardUri, $cardData) {
-		$etag = md5($cardData);
-		$uid = $this->getUID($cardData);
-
-		$q = $this->db->getQueryBuilder();
-		$q->select('uid')
-			->from($this->dbCardsTable)
-			->where($q->expr()->eq('addressbookid', $q->createNamedParameter($addressBookId)))
-			->andWhere($q->expr()->eq('uid', $q->createNamedParameter($uid)))
-			->setMaxResults(1);
-		$result = $q->execute();
-		$count = (bool) $result->fetchColumn();
-		$result->closeCursor();
-		if ($count) {
-			throw new \Sabre\DAV\Exception\BadRequest('VCard object with uid already exists in this addressbook collection.');
-		}
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('cards')
-			->values([
-				'carddata' => $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB),
-				'uri' => $query->createNamedParameter($cardUri),
-				'lastmodified' => $query->createNamedParameter(time()),
-				'addressbookid' => $query->createNamedParameter($addressBookId),
-				'size' => $query->createNamedParameter(strlen($cardData)),
-				'etag' => $query->createNamedParameter($etag),
-				'uid' => $query->createNamedParameter($uid),
-			])
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 1);
-		$this->updateProperties($addressBookId, $cardUri, $cardData);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::createCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri,
-				'cardData' => $cardData]));
-
-		return '"' . $etag . '"';
-	}
-
-	/**
-	 * Updates a card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag should
-	 * match that of the updated resource, and must be enclosed with double
-	 * quotes (that is: the string itself must contain the actual quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 * @return string
-	 */
-	public function updateCard($addressBookId, $cardUri, $cardData) {
-		$uid = $this->getUID($cardData);
-		$etag = md5($cardData);
-		$query = $this->db->getQueryBuilder();
-		$query->update($this->dbCardsTable)
-			->set('carddata', $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB))
-			->set('lastmodified', $query->createNamedParameter(time()))
-			->set('size', $query->createNamedParameter(strlen($cardData)))
-			->set('etag', $query->createNamedParameter($etag))
-			->set('uid', $query->createNamedParameter($uid))
-			->where($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 2);
-		$this->updateProperties($addressBookId, $cardUri, $cardData);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::updateCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri,
-				'cardData' => $cardData]));
-
-		return '"' . $etag . '"';
-	}
-
-	/**
-	 * Deletes a card
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @return bool
-	 */
-	public function deleteCard($addressBookId, $cardUri) {
-		try {
-			$cardId = $this->getCardId($addressBookId, $cardUri);
-		} catch (\InvalidArgumentException $e) {
-			$cardId = null;
-		}
-		$query = $this->db->getQueryBuilder();
-		$ret = $query->delete($this->dbCardsTable)
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 3);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::deleteCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri]));
-
-		if ($ret === 1) {
-			if ($cardId !== null) {
-				$this->purgeProperties($addressBookId, $cardId);
-			}
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * The getChanges method returns all the changes that have happened, since
-	 * the specified syncToken in the specified address book.
-	 *
-	 * This function should return an array, such as the following:
-	 *
-	 * [
-	 *   'syncToken' => 'The current synctoken',
-	 *   'added'   => [
-	 *      'new.txt',
-	 *   ],
-	 *   'modified'   => [
-	 *      'modified.txt',
-	 *   ],
-	 *   'deleted' => [
-	 *      'foo.php.bak',
-	 *      'old.txt'
-	 *   ]
-	 * ];
-	 *
-	 * The returned syncToken property should reflect the *current* syncToken
-	 * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
-	 * property. This is needed here too, to ensure the operation is atomic.
-	 *
-	 * If the $syncToken argument is specified as null, this is an initial
-	 * sync, and all members should be reported.
-	 *
-	 * The modified property is an array of nodenames that have changed since
-	 * the last token.
-	 *
-	 * The deleted property is an array with nodenames, that have been deleted
-	 * from collection.
-	 *
-	 * The $syncLevel argument is basically the 'depth' of the report. If it's
-	 * 1, you only have to report changes that happened only directly in
-	 * immediate descendants. If it's 2, it should also include changes from
-	 * the nodes below the child collections. (grandchildren)
-	 *
-	 * The $limit argument allows a client to specify how many results should
-	 * be returned at most. If the limit is not specified, it should be treated
-	 * as infinite.
-	 *
-	 * If the limit (infinite or not) is higher than you're willing to return,
-	 * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
-	 *
-	 * If the syncToken is expired (due to data cleanup) or unknown, you must
-	 * return null.
-	 *
-	 * The limit is 'suggestive'. You are free to ignore it.
-	 *
-	 * @param string $addressBookId
-	 * @param string $syncToken
-	 * @param int $syncLevel
-	 * @param int $limit
-	 * @return array
-	 */
-	public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
-		// Current synctoken
-		$stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
-		$stmt->execute([ $addressBookId ]);
-		$currentToken = $stmt->fetchColumn(0);
-
-		if (is_null($currentToken)) {
-			return null;
-		}
-
-		$result = [
-			'syncToken' => $currentToken,
-			'added'     => [],
-			'modified'  => [],
-			'deleted'   => [],
-		];
-
-		if ($syncToken) {
-			$query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
-			if ($limit>0) {
-				$query .= " LIMIT " . (int)$limit;
-			}
-
-			// Fetching all changes
-			$stmt = $this->db->prepare($query);
-			$stmt->execute([$syncToken, $currentToken, $addressBookId]);
-
-			$changes = [];
-
-			// This loop ensures that any duplicates are overwritten, only the
-			// last change on a node is relevant.
-			while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-				$changes[$row['uri']] = $row['operation'];
-			}
-
-			foreach ($changes as $uri => $operation) {
-				switch ($operation) {
-					case 1:
-						$result['added'][] = $uri;
-						break;
-					case 2:
-						$result['modified'][] = $uri;
-						break;
-					case 3:
-						$result['deleted'][] = $uri;
-						break;
-				}
-			}
-		} else {
-			// No synctoken supplied, this is the initial sync.
-			$query = "SELECT `uri` FROM `*PREFIX*cards` WHERE `addressbookid` = ?";
-			$stmt = $this->db->prepare($query);
-			$stmt->execute([$addressBookId]);
-
-			$result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
-		}
-		return $result;
-	}
-
-	/**
-	 * Adds a change record to the addressbookchanges table.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $objectUri
-	 * @param int $operation 1 = add, 2 = modify, 3 = delete
-	 * @return void
-	 */
-	protected function addChange($addressBookId, $objectUri, $operation) {
-		$sql = 'INSERT INTO `*PREFIX*addressbookchanges`(`uri`, `synctoken`, `addressbookid`, `operation`) SELECT ?, `synctoken`, ?, ? FROM `*PREFIX*addressbooks` WHERE `id` = ?';
-		$stmt = $this->db->prepare($sql);
-		$stmt->execute([
-			$objectUri,
-			$addressBookId,
-			$operation,
-			$addressBookId
-		]);
-		$stmt = $this->db->prepare('UPDATE `*PREFIX*addressbooks` SET `synctoken` = `synctoken` + 1 WHERE `id` = ?');
-		$stmt->execute([
-			$addressBookId
-		]);
-	}
-
-	/**
-	 * @param resource|string $cardData
-	 * @param bool $modified
-	 * @return string
-	 */
-	private function readBlob($cardData, &$modified=false) {
-		if (is_resource($cardData)) {
-			$cardData = stream_get_contents($cardData);
-		}
-
-		$cardDataArray = explode("\r\n", $cardData);
-
-		$cardDataFiltered = [];
-		$removingPhoto = false;
-		foreach ($cardDataArray as $line) {
-			if (strpos($line, 'PHOTO:data:') === 0
-				&& strpos($line, 'PHOTO:data:image/') !== 0) {
-				// Filter out PHOTO data of non-images
-				$removingPhoto = true;
-				$modified = true;
-				continue;
-			}
-
-			if ($removingPhoto) {
-				if (strpos($line, ' ') === 0) {
-					continue;
-				}
-				// No leading space means this is a new property
-				$removingPhoto = false;
-			}
-
-			$cardDataFiltered[] = $line;
-		}
-
-		return implode("\r\n", $cardDataFiltered);
-	}
-
-	/**
-	 * @param IShareable $shareable
-	 * @param string[] $add
-	 * @param string[] $remove
-	 */
-	public function updateShares(IShareable $shareable, $add, $remove) {
-		$this->sharingBackend->updateShares($shareable, $add, $remove);
-	}
-
-	/**
-	 * search contact
-	 *
-	 * @param int $addressBookId
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @param array $options = array() to define the search behavior
-	 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped, otherwise they are
-	 * @return array an array of contacts which are arrays of key-value-pairs
-	 */
-	public function search($addressBookId, $pattern, $searchProperties, $options = []) {
-		$query = $this->db->getQueryBuilder();
-		$query2 = $this->db->getQueryBuilder();
-
-		$query2->selectDistinct('cp.cardid')->from($this->dbCardsPropertiesTable, 'cp');
-		$query2->andWhere($query2->expr()->eq('cp.addressbookid', $query->createNamedParameter($addressBookId)));
-		$or = $query2->expr()->orX();
-		foreach ($searchProperties as $property) {
-			$or->add($query2->expr()->eq('cp.name', $query->createNamedParameter($property)));
-		}
-		$query2->andWhere($or);
-
-		// No need for like when the pattern is empty
-		if ('' !== $pattern) {
-			if (\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
-				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter($pattern)));
-			} else {
-				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
-			}
-		}
-		if (isset($options['limit'])) {
-			$query2->setMaxResults($options['limit']);
-		}
-		if (isset($options['offset'])) {
-			$query2->setFirstResult($options['offset']);
-		}
-
-		$query->select('c.carddata', 'c.uri')->from($this->dbCardsTable, 'c')
-			->where($query->expr()->in('c.id', $query->createFunction($query2->getSQL())));
-
-		$result = $query->execute();
-		$cards = $result->fetchAll();
-
-		$result->closeCursor();
-
-		return array_map(function ($array) {
-			$modified = false;
-			$array['carddata'] = $this->readBlob($array['carddata'], $modified);
-			if ($modified) {
-				$array['size'] = strlen($array['carddata']);
-			}
-			return $array;
-		}, $cards);
-	}
-
-	/**
-	 * @param int $bookId
-	 * @param string $name
-	 * @return array
-	 */
-	public function collectCardProperties($bookId, $name) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->selectDistinct('value')
-			->from($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('name', $query->createNamedParameter($name)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($bookId)))
-			->execute();
-
-		$all = $result->fetchAll(PDO::FETCH_COLUMN);
-		$result->closeCursor();
-
-		return $all;
-	}
-
-	/**
-	 * get URI from a given contact
-	 *
-	 * @param int $id
-	 * @return string
-	 */
-	public function getCardUri($id) {
-		$query = $this->db->getQueryBuilder();
-		$query->select('uri')->from($this->dbCardsTable)
-				->where($query->expr()->eq('id', $query->createParameter('id')))
-				->setParameter('id', $id);
-
-		$result = $query->execute();
-		$uri = $result->fetch();
-		$result->closeCursor();
-
-		if (!isset($uri['uri'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $id);
-		}
-
-		return $uri['uri'];
-	}
-
-	/**
-	 * return contact with the given URI
-	 *
-	 * @param int $addressBookId
-	 * @param string $uri
-	 * @returns array
-	 */
-	public function getContact($addressBookId, $uri) {
-		$result = [];
-		$query = $this->db->getQueryBuilder();
-		$query->select('*')->from($this->dbCardsTable)
-				->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
-				->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-		$queryResult = $query->execute();
-		$contact = $queryResult->fetch();
-		$queryResult->closeCursor();
-
-		if (is_array($contact)) {
-			$modified = false;
-			$contact['etag'] = '"' . $contact['etag'] . '"';
-			$contact['carddata'] = $this->readBlob($contact['carddata'], $modified);
-			if ($modified) {
-				$contact['size'] = strlen($contact['carddata']);
-			}
-
-			$result = $contact;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Returns the list of people whom this address book is shared with.
-	 *
-	 * Every element in this array should have the following properties:
-	 *   * href - Often a mailto: address
-	 *   * commonName - Optional, for example a first + last name
-	 *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
-	 *   * readOnly - boolean
-	 *   * summary - Optional, a description for the share
-	 *
-	 * @return array
-	 */
-	public function getShares($addressBookId) {
-		return $this->sharingBackend->getShares($addressBookId);
-	}
-
-	/**
-	 * update properties table
-	 *
-	 * @param int $addressBookId
-	 * @param string $cardUri
-	 * @param string $vCardSerialized
-	 */
-	protected function updateProperties($addressBookId, $cardUri, $vCardSerialized) {
-		$cardId = $this->getCardId($addressBookId, $cardUri);
-		$vCard = $this->readCard($vCardSerialized);
-
-		$this->purgeProperties($addressBookId, $cardId);
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert($this->dbCardsPropertiesTable)
-			->values(
-				[
-					'addressbookid' => $query->createNamedParameter($addressBookId),
-					'cardid' => $query->createNamedParameter($cardId),
-					'name' => $query->createParameter('name'),
-					'value' => $query->createParameter('value'),
-					'preferred' => $query->createParameter('preferred')
-				]
-			);
-
-		foreach ($vCard->children() as $property) {
-			if (!in_array($property->name, self::$indexProperties)) {
-				continue;
-			}
-			$preferred = 0;
-			foreach ($property->parameters as $parameter) {
-				if ($parameter->name === 'TYPE' && strtoupper($parameter->getValue()) === 'PREF') {
-					$preferred = 1;
-					break;
-				}
-			}
-			$query->setParameter('name', $property->name);
-			$query->setParameter('value', mb_substr($property->getValue(), 0, 254));
-			$query->setParameter('preferred', $preferred);
-			$query->execute();
-		}
-	}
-
-	/**
-	 * read vCard data into a vCard object
-	 *
-	 * @param string $cardData
-	 * @return VCard
-	 */
-	protected function readCard($cardData) {
-		return  Reader::read($cardData);
-	}
-
-	/**
-	 * delete all properties from a given card
-	 *
-	 * @param int $addressBookId
-	 * @param int $cardId
-	 */
-	protected function purgeProperties($addressBookId, $cardId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('cardid', $query->createNamedParameter($cardId)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-		$query->execute();
-	}
-
-	/**
-	 * get ID from a given contact
-	 *
-	 * @param int $addressBookId
-	 * @param string $uri
-	 * @return int
-	 */
-	protected function getCardId($addressBookId, $uri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select('id')->from($this->dbCardsTable)
-			->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$result = $query->execute();
-		$cardIds = $result->fetch();
-		$result->closeCursor();
-
-		if (!isset($cardIds['id'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $uri);
-		}
-
-		return (int)$cardIds['id'];
-	}
-
-	/**
-	 * For shared address books the sharee is set in the ACL of the address book
-	 * @param $addressBookId
-	 * @param $acl
-	 * @return array
-	 */
-	public function applyShareAcl($addressBookId, $acl) {
-		return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
-	}
-
-	private function convertPrincipal($principalUri, $toV2) {
-		if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
-			list(, $name) = \Sabre\Uri\split($principalUri);
-			if ($toV2 === true) {
-				return "principals/users/$name";
-			}
-			return "principals/$name";
-		}
-		return $principalUri;
-	}
-
-	private function addOwnerPrincipal(&$addressbookInfo) {
-		$ownerPrincipalKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal';
-		$displaynameKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}owner-displayname';
-		if (isset($addressbookInfo[$ownerPrincipalKey])) {
-			$uri = $addressbookInfo[$ownerPrincipalKey];
-		} else {
-			$uri = $addressbookInfo['principaluri'];
-		}
-
-		$principalInformation = $this->principalBackend->getPrincipalByPath($uri);
-		if (isset($principalInformation['{DAV:}displayname'])) {
-			$addressbookInfo[$displaynameKey] = $principalInformation['{DAV:}displayname'];
-		}
-	}
-
-	/**
-	 * Extract UID from vcard
-	 *
-	 * @param string $cardData the vcard raw data
-	 * @return string the uid
-	 * @throws BadRequest if no UID is available
-	 */
-	private function getUID($cardData) {
-		if ($cardData != '') {
-			$vCard = Reader::read($cardData);
-			if ($vCard->UID) {
-				$uid = $vCard->UID->getValue();
-				return $uid;
-			}
-			// should already be handled, but just in case
-			throw new BadRequest('vCards on CardDAV servers MUST have a UID property');
-		}
-		// should already be handled, but just in case
-		throw new BadRequest('vCard can not be empty');
-	}
+    public const PERSONAL_ADDRESSBOOK_URI = 'contacts';
+    public const PERSONAL_ADDRESSBOOK_NAME = 'Contacts';
+
+    /** @var Principal */
+    private $principalBackend;
+
+    /** @var string */
+    private $dbCardsTable = 'cards';
+
+    /** @var string */
+    private $dbCardsPropertiesTable = 'cards_properties';
+
+    /** @var IDBConnection */
+    private $db;
+
+    /** @var Backend */
+    private $sharingBackend;
+
+    /** @var array properties to index */
+    public static $indexProperties = [
+        'BDAY', 'UID', 'N', 'FN', 'TITLE', 'ROLE', 'NOTE', 'NICKNAME',
+        'ORG', 'CATEGORIES', 'EMAIL', 'TEL', 'IMPP', 'ADR', 'URL', 'GEO', 'CLOUD'];
+
+    /**
+     * @var string[] Map of uid => display name
+     */
+    protected $userDisplayNames;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+
+    /**
+     * CardDavBackend constructor.
+     *
+     * @param IDBConnection $db
+     * @param Principal $principalBackend
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(IDBConnection $db,
+                                Principal $principalBackend,
+                                IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                EventDispatcherInterface $dispatcher) {
+        $this->db = $db;
+        $this->principalBackend = $principalBackend;
+        $this->userManager = $userManager;
+        $this->dispatcher = $dispatcher;
+        $this->sharingBackend = new Backend($this->db, $this->userManager, $groupManager, $principalBackend, 'addressbook');
+    }
+
+    /**
+     * Return the number of address books for a principal
+     *
+     * @param $principalUri
+     * @return int
+     */
+    public function getAddressBooksForUserCount($principalUri) {
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select($query->func()->count('*'))
+            ->from('addressbooks')
+            ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        return (int)$query->execute()->fetchColumn();
+    }
+
+    /**
+     * Returns the list of address books for a specific user.
+     *
+     * Every addressbook should have the following properties:
+     *   id - an arbitrary unique id
+     *   uri - the 'basename' part of the url
+     *   principaluri - Same as the passed parameter
+     *
+     * Any additional clark-notation property may be passed besides this. Some
+     * common ones are :
+     *   {DAV:}displayname
+     *   {urn:ietf:params:xml:ns:carddav}addressbook-description
+     *   {http://calendarserver.org/ns/}getctag
+     *
+     * @param string $principalUri
+     * @return array
+     */
+    public function getAddressBooksForUser($principalUri) {
+        $principalUriOriginal = $principalUri;
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        $addressBooks = [];
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $this->convertPrincipal($row['principaluri'], false),
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        // query for shared addressbooks
+        $principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
+        $principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
+
+        $principals = array_map(function ($principal) {
+            return urldecode($principal);
+        }, $principals);
+        $principals[]= $principalUri;
+
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
+            ->from('dav_shares', 's')
+            ->join('s', 'addressbooks', 'a', $query->expr()->eq('s.resourceid', 'a.id'))
+            ->where($query->expr()->in('s.principaluri', $query->createParameter('principaluri')))
+            ->andWhere($query->expr()->eq('s.type', $query->createParameter('type')))
+            ->setParameter('type', 'addressbook')
+            ->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
+            ->execute();
+
+        $readOnlyPropertyName = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only';
+        while ($row = $result->fetch()) {
+            if ($row['principaluri'] === $principalUri) {
+                continue;
+            }
+
+            $readOnly = (int) $row['access'] === Backend::ACCESS_READ;
+            if (isset($addressBooks[$row['id']])) {
+                if ($readOnly) {
+                    // New share can not have more permissions then the old one.
+                    continue;
+                }
+                if (isset($addressBooks[$row['id']][$readOnlyPropertyName]) &&
+                    $addressBooks[$row['id']][$readOnlyPropertyName] === 0) {
+                    // Old share is already read-write, no more permissions can be gained
+                    continue;
+                }
+            }
+
+            list(, $name) = \Sabre\Uri\split($row['principaluri']);
+            $uri = $row['uri'] . '_shared_by_' . $name;
+            $displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
+
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $uri,
+                'principaluri' => $principalUriOriginal,
+                '{DAV:}displayname' => $displayName,
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+                '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
+                $readOnlyPropertyName => $readOnly,
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        return array_values($addressBooks);
+    }
+
+    public function getUsersOwnAddressBooks($principalUri) {
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+                ->from('addressbooks')
+                ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        $addressBooks = [];
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $this->convertPrincipal($row['principaluri'], false),
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        return array_values($addressBooks);
+    }
+
+    private function getUserDisplayName($uid) {
+        if (!isset($this->userDisplayNames[$uid])) {
+            $user = $this->userManager->get($uid);
+
+            if ($user instanceof IUser) {
+                $this->userDisplayNames[$uid] = $user->getDisplayName();
+            } else {
+                $this->userDisplayNames[$uid] = $uid;
+            }
+        }
+
+        return $this->userDisplayNames[$uid];
+    }
+
+    /**
+     * @param int $addressBookId
+     */
+    public function getAddressBookById($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if ($row === false) {
+            return null;
+        }
+
+        $addressBook = [
+            'id'  => $row['id'],
+            'uri' => $row['uri'],
+            'principaluri' => $row['principaluri'],
+            '{DAV:}displayname' => $row['displayname'],
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+            '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+            '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+        ];
+
+        $this->addOwnerPrincipal($addressBook);
+
+        return $addressBook;
+    }
+
+    /**
+     * @param $addressBookUri
+     * @return array|null
+     */
+    public function getAddressBooksByUri($principal, $addressBookUri) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($addressBookUri)))
+            ->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($principal)))
+            ->setMaxResults(1)
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if ($row === false) {
+            return null;
+        }
+
+        $addressBook = [
+            'id'  => $row['id'],
+            'uri' => $row['uri'],
+            'principaluri' => $row['principaluri'],
+            '{DAV:}displayname' => $row['displayname'],
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+            '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+            '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+        ];
+
+        $this->addOwnerPrincipal($addressBook);
+
+        return $addressBook;
+    }
+
+    /**
+     * Updates properties for an address book.
+     *
+     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+     * To do the actual updates, you must tell this object which properties
+     * you're going to process with the handle() method.
+     *
+     * Calling the handle method is like telling the PropPatch object "I
+     * promise I can handle updating this property".
+     *
+     * Read the PropPatch documentation for more info and examples.
+     *
+     * @param string $addressBookId
+     * @param \Sabre\DAV\PropPatch $propPatch
+     * @return void
+     */
+    public function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
+        $supportedProperties = [
+            '{DAV:}displayname',
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description',
+        ];
+
+        /**
+         * @suppress SqlInjectionChecker
+         */
+        $propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
+            $updates = [];
+            foreach ($mutations as $property=>$newValue) {
+                switch ($property) {
+                    case '{DAV:}displayname':
+                        $updates['displayname'] = $newValue;
+                        break;
+                    case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
+                        $updates['description'] = $newValue;
+                        break;
+                }
+            }
+            $query = $this->db->getQueryBuilder();
+            $query->update('addressbooks');
+
+            foreach ($updates as $key=>$value) {
+                $query->set($key, $query->createNamedParameter($value));
+            }
+            $query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+            $this->addChange($addressBookId, "", 2);
+
+            return true;
+        });
+    }
+
+    /**
+     * Creates a new address book
+     *
+     * @param string $principalUri
+     * @param string $url Just the 'basename' of the url.
+     * @param array $properties
+     * @return int
+     * @throws BadRequest
+     */
+    public function createAddressBook($principalUri, $url, array $properties) {
+        $values = [
+            'displayname' => null,
+            'description' => null,
+            'principaluri' => $principalUri,
+            'uri' => $url,
+            'synctoken' => 1
+        ];
+
+        foreach ($properties as $property=>$newValue) {
+            switch ($property) {
+                case '{DAV:}displayname':
+                    $values['displayname'] = $newValue;
+                    break;
+                case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
+                    $values['description'] = $newValue;
+                    break;
+                default:
+                    throw new BadRequest('Unknown property: ' . $property);
+            }
+        }
+
+        // Fallback to make sure the displayname is set. Some clients may refuse
+        // to work with addressbooks not having a displayname.
+        if (is_null($values['displayname'])) {
+            $values['displayname'] = $url;
+        }
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('addressbooks')
+            ->values([
+                'uri' => $query->createParameter('uri'),
+                'displayname' => $query->createParameter('displayname'),
+                'description' => $query->createParameter('description'),
+                'principaluri' => $query->createParameter('principaluri'),
+                'synctoken' => $query->createParameter('synctoken'),
+            ])
+            ->setParameters($values)
+            ->execute();
+
+        return $query->getLastInsertId();
+    }
+
+    /**
+     * Deletes an entire addressbook and all its contents
+     *
+     * @param mixed $addressBookId
+     * @return void
+     */
+    public function deleteAddressBook($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete($this->dbCardsTable)
+            ->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
+            ->setParameter('addressbookid', $addressBookId)
+            ->execute();
+
+        $query->delete('addressbookchanges')
+            ->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
+            ->setParameter('addressbookid', $addressBookId)
+            ->execute();
+
+        $query->delete('addressbooks')
+            ->where($query->expr()->eq('id', $query->createParameter('id')))
+            ->setParameter('id', $addressBookId)
+            ->execute();
+
+        $this->sharingBackend->deleteAllShares($addressBookId);
+
+        $query->delete($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->execute();
+    }
+
+    /**
+     * Returns all cards for a specific addressbook id.
+     *
+     * This method should return the following properties for each card:
+     *   * carddata - raw vcard data
+     *   * uri - Some unique url
+     *   * lastmodified - A unix timestamp
+     *
+     * It's recommended to also return the following properties:
+     *   * etag - A unique etag. This must change every time the card changes.
+     *   * size - The size of the card in bytes.
+     *
+     * If these last two properties are provided, less time will be spent
+     * calculating them. If they are specified, you can also ommit carddata.
+     * This may speed up certain requests, especially with large cards.
+     *
+     * @param mixed $addressBookId
+     * @return array
+     */
+    public function getCards($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from($this->dbCardsTable)
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $cards = [];
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $row['etag'] = '"' . $row['etag'] . '"';
+
+            $modified = false;
+            $row['carddata'] = $this->readBlob($row['carddata'], $modified);
+            if ($modified) {
+                $row['size'] = strlen($row['carddata']);
+            }
+
+            $cards[] = $row;
+        }
+        $result->closeCursor();
+
+        return $cards;
+    }
+
+    /**
+     * Returns a specific card.
+     *
+     * The same set of properties must be returned as with getCards. The only
+     * exception is that 'carddata' is absolutely required.
+     *
+     * If the card does not exist, you must return false.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @return array
+     */
+    public function getCard($addressBookId, $cardUri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from($this->dbCardsTable)
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->setMaxResults(1);
+
+        $result = $query->execute();
+        $row = $result->fetch();
+        if (!$row) {
+            return false;
+        }
+        $row['etag'] = '"' . $row['etag'] . '"';
+
+        $modified = false;
+        $row['carddata'] = $this->readBlob($row['carddata'], $modified);
+        if ($modified) {
+            $row['size'] = strlen($row['carddata']);
+        }
+
+        return $row;
+    }
+
+    /**
+     * Returns a list of cards.
+     *
+     * This method should work identical to getCard, but instead return all the
+     * cards in the list as an array.
+     *
+     * If the backend supports this, it may allow for some speed-ups.
+     *
+     * @param mixed $addressBookId
+     * @param string[] $uris
+     * @return array
+     */
+    public function getMultipleCards($addressBookId, array $uris) {
+        if (empty($uris)) {
+            return [];
+        }
+
+        $chunks = array_chunk($uris, 100);
+        $cards = [];
+
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from($this->dbCardsTable)
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->in('uri', $query->createParameter('uri')));
+
+        foreach ($chunks as $uris) {
+            $query->setParameter('uri', $uris, IQueryBuilder::PARAM_STR_ARRAY);
+            $result = $query->execute();
+
+            while ($row = $result->fetch()) {
+                $row['etag'] = '"' . $row['etag'] . '"';
+
+                $modified = false;
+                $row['carddata'] = $this->readBlob($row['carddata'], $modified);
+                if ($modified) {
+                    $row['size'] = strlen($row['carddata']);
+                }
+
+                $cards[] = $row;
+            }
+            $result->closeCursor();
+        }
+        return $cards;
+    }
+
+    /**
+     * Creates a new card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag is for the
+     * newly created resource, and must be enclosed with double quotes (that
+     * is, the string itself must contain the double quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     * @return string
+     */
+    public function createCard($addressBookId, $cardUri, $cardData) {
+        $etag = md5($cardData);
+        $uid = $this->getUID($cardData);
+
+        $q = $this->db->getQueryBuilder();
+        $q->select('uid')
+            ->from($this->dbCardsTable)
+            ->where($q->expr()->eq('addressbookid', $q->createNamedParameter($addressBookId)))
+            ->andWhere($q->expr()->eq('uid', $q->createNamedParameter($uid)))
+            ->setMaxResults(1);
+        $result = $q->execute();
+        $count = (bool) $result->fetchColumn();
+        $result->closeCursor();
+        if ($count) {
+            throw new \Sabre\DAV\Exception\BadRequest('VCard object with uid already exists in this addressbook collection.');
+        }
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('cards')
+            ->values([
+                'carddata' => $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB),
+                'uri' => $query->createNamedParameter($cardUri),
+                'lastmodified' => $query->createNamedParameter(time()),
+                'addressbookid' => $query->createNamedParameter($addressBookId),
+                'size' => $query->createNamedParameter(strlen($cardData)),
+                'etag' => $query->createNamedParameter($etag),
+                'uid' => $query->createNamedParameter($uid),
+            ])
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 1);
+        $this->updateProperties($addressBookId, $cardUri, $cardData);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::createCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri,
+                'cardData' => $cardData]));
+
+        return '"' . $etag . '"';
+    }
+
+    /**
+     * Updates a card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag should
+     * match that of the updated resource, and must be enclosed with double
+     * quotes (that is: the string itself must contain the actual quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     * @return string
+     */
+    public function updateCard($addressBookId, $cardUri, $cardData) {
+        $uid = $this->getUID($cardData);
+        $etag = md5($cardData);
+        $query = $this->db->getQueryBuilder();
+        $query->update($this->dbCardsTable)
+            ->set('carddata', $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB))
+            ->set('lastmodified', $query->createNamedParameter(time()))
+            ->set('size', $query->createNamedParameter(strlen($cardData)))
+            ->set('etag', $query->createNamedParameter($etag))
+            ->set('uid', $query->createNamedParameter($uid))
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 2);
+        $this->updateProperties($addressBookId, $cardUri, $cardData);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::updateCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri,
+                'cardData' => $cardData]));
+
+        return '"' . $etag . '"';
+    }
+
+    /**
+     * Deletes a card
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @return bool
+     */
+    public function deleteCard($addressBookId, $cardUri) {
+        try {
+            $cardId = $this->getCardId($addressBookId, $cardUri);
+        } catch (\InvalidArgumentException $e) {
+            $cardId = null;
+        }
+        $query = $this->db->getQueryBuilder();
+        $ret = $query->delete($this->dbCardsTable)
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 3);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::deleteCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri]));
+
+        if ($ret === 1) {
+            if ($cardId !== null) {
+                $this->purgeProperties($addressBookId, $cardId);
+            }
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * The getChanges method returns all the changes that have happened, since
+     * the specified syncToken in the specified address book.
+     *
+     * This function should return an array, such as the following:
+     *
+     * [
+     *   'syncToken' => 'The current synctoken',
+     *   'added'   => [
+     *      'new.txt',
+     *   ],
+     *   'modified'   => [
+     *      'modified.txt',
+     *   ],
+     *   'deleted' => [
+     *      'foo.php.bak',
+     *      'old.txt'
+     *   ]
+     * ];
+     *
+     * The returned syncToken property should reflect the *current* syncToken
+     * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
+     * property. This is needed here too, to ensure the operation is atomic.
+     *
+     * If the $syncToken argument is specified as null, this is an initial
+     * sync, and all members should be reported.
+     *
+     * The modified property is an array of nodenames that have changed since
+     * the last token.
+     *
+     * The deleted property is an array with nodenames, that have been deleted
+     * from collection.
+     *
+     * The $syncLevel argument is basically the 'depth' of the report. If it's
+     * 1, you only have to report changes that happened only directly in
+     * immediate descendants. If it's 2, it should also include changes from
+     * the nodes below the child collections. (grandchildren)
+     *
+     * The $limit argument allows a client to specify how many results should
+     * be returned at most. If the limit is not specified, it should be treated
+     * as infinite.
+     *
+     * If the limit (infinite or not) is higher than you're willing to return,
+     * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
+     *
+     * If the syncToken is expired (due to data cleanup) or unknown, you must
+     * return null.
+     *
+     * The limit is 'suggestive'. You are free to ignore it.
+     *
+     * @param string $addressBookId
+     * @param string $syncToken
+     * @param int $syncLevel
+     * @param int $limit
+     * @return array
+     */
+    public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
+        // Current synctoken
+        $stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
+        $stmt->execute([ $addressBookId ]);
+        $currentToken = $stmt->fetchColumn(0);
+
+        if (is_null($currentToken)) {
+            return null;
+        }
+
+        $result = [
+            'syncToken' => $currentToken,
+            'added'     => [],
+            'modified'  => [],
+            'deleted'   => [],
+        ];
+
+        if ($syncToken) {
+            $query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
+            if ($limit>0) {
+                $query .= " LIMIT " . (int)$limit;
+            }
+
+            // Fetching all changes
+            $stmt = $this->db->prepare($query);
+            $stmt->execute([$syncToken, $currentToken, $addressBookId]);
+
+            $changes = [];
+
+            // This loop ensures that any duplicates are overwritten, only the
+            // last change on a node is relevant.
+            while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+                $changes[$row['uri']] = $row['operation'];
+            }
+
+            foreach ($changes as $uri => $operation) {
+                switch ($operation) {
+                    case 1:
+                        $result['added'][] = $uri;
+                        break;
+                    case 2:
+                        $result['modified'][] = $uri;
+                        break;
+                    case 3:
+                        $result['deleted'][] = $uri;
+                        break;
+                }
+            }
+        } else {
+            // No synctoken supplied, this is the initial sync.
+            $query = "SELECT `uri` FROM `*PREFIX*cards` WHERE `addressbookid` = ?";
+            $stmt = $this->db->prepare($query);
+            $stmt->execute([$addressBookId]);
+
+            $result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
+        }
+        return $result;
+    }
+
+    /**
+     * Adds a change record to the addressbookchanges table.
+     *
+     * @param mixed $addressBookId
+     * @param string $objectUri
+     * @param int $operation 1 = add, 2 = modify, 3 = delete
+     * @return void
+     */
+    protected function addChange($addressBookId, $objectUri, $operation) {
+        $sql = 'INSERT INTO `*PREFIX*addressbookchanges`(`uri`, `synctoken`, `addressbookid`, `operation`) SELECT ?, `synctoken`, ?, ? FROM `*PREFIX*addressbooks` WHERE `id` = ?';
+        $stmt = $this->db->prepare($sql);
+        $stmt->execute([
+            $objectUri,
+            $addressBookId,
+            $operation,
+            $addressBookId
+        ]);
+        $stmt = $this->db->prepare('UPDATE `*PREFIX*addressbooks` SET `synctoken` = `synctoken` + 1 WHERE `id` = ?');
+        $stmt->execute([
+            $addressBookId
+        ]);
+    }
+
+    /**
+     * @param resource|string $cardData
+     * @param bool $modified
+     * @return string
+     */
+    private function readBlob($cardData, &$modified=false) {
+        if (is_resource($cardData)) {
+            $cardData = stream_get_contents($cardData);
+        }
+
+        $cardDataArray = explode("\r\n", $cardData);
+
+        $cardDataFiltered = [];
+        $removingPhoto = false;
+        foreach ($cardDataArray as $line) {
+            if (strpos($line, 'PHOTO:data:') === 0
+                && strpos($line, 'PHOTO:data:image/') !== 0) {
+                // Filter out PHOTO data of non-images
+                $removingPhoto = true;
+                $modified = true;
+                continue;
+            }
+
+            if ($removingPhoto) {
+                if (strpos($line, ' ') === 0) {
+                    continue;
+                }
+                // No leading space means this is a new property
+                $removingPhoto = false;
+            }
+
+            $cardDataFiltered[] = $line;
+        }
+
+        return implode("\r\n", $cardDataFiltered);
+    }
+
+    /**
+     * @param IShareable $shareable
+     * @param string[] $add
+     * @param string[] $remove
+     */
+    public function updateShares(IShareable $shareable, $add, $remove) {
+        $this->sharingBackend->updateShares($shareable, $add, $remove);
+    }
+
+    /**
+     * search contact
+     *
+     * @param int $addressBookId
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @param array $options = array() to define the search behavior
+     * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped, otherwise they are
+     * @return array an array of contacts which are arrays of key-value-pairs
+     */
+    public function search($addressBookId, $pattern, $searchProperties, $options = []) {
+        $query = $this->db->getQueryBuilder();
+        $query2 = $this->db->getQueryBuilder();
+
+        $query2->selectDistinct('cp.cardid')->from($this->dbCardsPropertiesTable, 'cp');
+        $query2->andWhere($query2->expr()->eq('cp.addressbookid', $query->createNamedParameter($addressBookId)));
+        $or = $query2->expr()->orX();
+        foreach ($searchProperties as $property) {
+            $or->add($query2->expr()->eq('cp.name', $query->createNamedParameter($property)));
+        }
+        $query2->andWhere($or);
+
+        // No need for like when the pattern is empty
+        if ('' !== $pattern) {
+            if (\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
+                $query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter($pattern)));
+            } else {
+                $query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
+            }
+        }
+        if (isset($options['limit'])) {
+            $query2->setMaxResults($options['limit']);
+        }
+        if (isset($options['offset'])) {
+            $query2->setFirstResult($options['offset']);
+        }
+
+        $query->select('c.carddata', 'c.uri')->from($this->dbCardsTable, 'c')
+            ->where($query->expr()->in('c.id', $query->createFunction($query2->getSQL())));
+
+        $result = $query->execute();
+        $cards = $result->fetchAll();
+
+        $result->closeCursor();
+
+        return array_map(function ($array) {
+            $modified = false;
+            $array['carddata'] = $this->readBlob($array['carddata'], $modified);
+            if ($modified) {
+                $array['size'] = strlen($array['carddata']);
+            }
+            return $array;
+        }, $cards);
+    }
+
+    /**
+     * @param int $bookId
+     * @param string $name
+     * @return array
+     */
+    public function collectCardProperties($bookId, $name) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->selectDistinct('value')
+            ->from($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('name', $query->createNamedParameter($name)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($bookId)))
+            ->execute();
+
+        $all = $result->fetchAll(PDO::FETCH_COLUMN);
+        $result->closeCursor();
+
+        return $all;
+    }
+
+    /**
+     * get URI from a given contact
+     *
+     * @param int $id
+     * @return string
+     */
+    public function getCardUri($id) {
+        $query = $this->db->getQueryBuilder();
+        $query->select('uri')->from($this->dbCardsTable)
+                ->where($query->expr()->eq('id', $query->createParameter('id')))
+                ->setParameter('id', $id);
+
+        $result = $query->execute();
+        $uri = $result->fetch();
+        $result->closeCursor();
+
+        if (!isset($uri['uri'])) {
+            throw new \InvalidArgumentException('Card does not exists: ' . $id);
+        }
+
+        return $uri['uri'];
+    }
+
+    /**
+     * return contact with the given URI
+     *
+     * @param int $addressBookId
+     * @param string $uri
+     * @returns array
+     */
+    public function getContact($addressBookId, $uri) {
+        $result = [];
+        $query = $this->db->getQueryBuilder();
+        $query->select('*')->from($this->dbCardsTable)
+                ->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
+                ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+        $queryResult = $query->execute();
+        $contact = $queryResult->fetch();
+        $queryResult->closeCursor();
+
+        if (is_array($contact)) {
+            $modified = false;
+            $contact['etag'] = '"' . $contact['etag'] . '"';
+            $contact['carddata'] = $this->readBlob($contact['carddata'], $modified);
+            if ($modified) {
+                $contact['size'] = strlen($contact['carddata']);
+            }
+
+            $result = $contact;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Returns the list of people whom this address book is shared with.
+     *
+     * Every element in this array should have the following properties:
+     *   * href - Often a mailto: address
+     *   * commonName - Optional, for example a first + last name
+     *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
+     *   * readOnly - boolean
+     *   * summary - Optional, a description for the share
+     *
+     * @return array
+     */
+    public function getShares($addressBookId) {
+        return $this->sharingBackend->getShares($addressBookId);
+    }
+
+    /**
+     * update properties table
+     *
+     * @param int $addressBookId
+     * @param string $cardUri
+     * @param string $vCardSerialized
+     */
+    protected function updateProperties($addressBookId, $cardUri, $vCardSerialized) {
+        $cardId = $this->getCardId($addressBookId, $cardUri);
+        $vCard = $this->readCard($vCardSerialized);
+
+        $this->purgeProperties($addressBookId, $cardId);
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert($this->dbCardsPropertiesTable)
+            ->values(
+                [
+                    'addressbookid' => $query->createNamedParameter($addressBookId),
+                    'cardid' => $query->createNamedParameter($cardId),
+                    'name' => $query->createParameter('name'),
+                    'value' => $query->createParameter('value'),
+                    'preferred' => $query->createParameter('preferred')
+                ]
+            );
+
+        foreach ($vCard->children() as $property) {
+            if (!in_array($property->name, self::$indexProperties)) {
+                continue;
+            }
+            $preferred = 0;
+            foreach ($property->parameters as $parameter) {
+                if ($parameter->name === 'TYPE' && strtoupper($parameter->getValue()) === 'PREF') {
+                    $preferred = 1;
+                    break;
+                }
+            }
+            $query->setParameter('name', $property->name);
+            $query->setParameter('value', mb_substr($property->getValue(), 0, 254));
+            $query->setParameter('preferred', $preferred);
+            $query->execute();
+        }
+    }
+
+    /**
+     * read vCard data into a vCard object
+     *
+     * @param string $cardData
+     * @return VCard
+     */
+    protected function readCard($cardData) {
+        return  Reader::read($cardData);
+    }
+
+    /**
+     * delete all properties from a given card
+     *
+     * @param int $addressBookId
+     * @param int $cardId
+     */
+    protected function purgeProperties($addressBookId, $cardId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('cardid', $query->createNamedParameter($cardId)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+        $query->execute();
+    }
+
+    /**
+     * get ID from a given contact
+     *
+     * @param int $addressBookId
+     * @param string $uri
+     * @return int
+     */
+    protected function getCardId($addressBookId, $uri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select('id')->from($this->dbCardsTable)
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $result = $query->execute();
+        $cardIds = $result->fetch();
+        $result->closeCursor();
+
+        if (!isset($cardIds['id'])) {
+            throw new \InvalidArgumentException('Card does not exists: ' . $uri);
+        }
+
+        return (int)$cardIds['id'];
+    }
+
+    /**
+     * For shared address books the sharee is set in the ACL of the address book
+     * @param $addressBookId
+     * @param $acl
+     * @return array
+     */
+    public function applyShareAcl($addressBookId, $acl) {
+        return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
+    }
+
+    private function convertPrincipal($principalUri, $toV2) {
+        if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
+            list(, $name) = \Sabre\Uri\split($principalUri);
+            if ($toV2 === true) {
+                return "principals/users/$name";
+            }
+            return "principals/$name";
+        }
+        return $principalUri;
+    }
+
+    private function addOwnerPrincipal(&$addressbookInfo) {
+        $ownerPrincipalKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal';
+        $displaynameKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}owner-displayname';
+        if (isset($addressbookInfo[$ownerPrincipalKey])) {
+            $uri = $addressbookInfo[$ownerPrincipalKey];
+        } else {
+            $uri = $addressbookInfo['principaluri'];
+        }
+
+        $principalInformation = $this->principalBackend->getPrincipalByPath($uri);
+        if (isset($principalInformation['{DAV:}displayname'])) {
+            $addressbookInfo[$displaynameKey] = $principalInformation['{DAV:}displayname'];
+        }
+    }
+
+    /**
+     * Extract UID from vcard
+     *
+     * @param string $cardData the vcard raw data
+     * @return string the uid
+     * @throws BadRequest if no UID is available
+     */
+    private function getUID($cardData) {
+        if ($cardData != '') {
+            $vCard = Reader::read($cardData);
+            if ($vCard->UID) {
+                $uid = $vCard->UID->getValue();
+                return $uid;
+            }
+            // should already be handled, but just in case
+            throw new BadRequest('vCards on CardDAV servers MUST have a UID property');
+        }
+        // should already be handled, but just in case
+        throw new BadRequest('vCard can not be empty');
+    }
 }

Spacing +39 added lines, -39 removed lines

@@ -123,7 +123,7 @@ 
 			->from('addressbooks')
 			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
 
-		return (int)$query->execute()->fetchColumn();
+		return (int) $query->execute()->fetchColumn();
 	}
 
 	/**
@@ -160,9 +160,9 @@ 
 				'uri' => $row['uri'],
 				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
 				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 			];
 
 			$this->addOwnerPrincipal($addressBooks[$row['id']]);
@@ -173,10 +173,10 @@ 
 		$principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
 		$principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
 
-		$principals = array_map(function ($principal) {
+		$principals = array_map(function($principal) {
 			return urldecode($principal);
 		}, $principals);
-		$principals[]= $principalUri;
+		$principals[] = $principalUri;
 
 		$query = $this->db->getQueryBuilder();
 		$result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
@@ -188,7 +188,7 @@ 
 			->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
 			->execute();
 
-		$readOnlyPropertyName = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only';
+		$readOnlyPropertyName = '{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}read-only';
 		while ($row = $result->fetch()) {
 			if ($row['principaluri'] === $principalUri) {
 				continue;
@@ -208,18 +208,18 @@ 
 			}
 
 			list(, $name) = \Sabre\Uri\split($row['principaluri']);
-			$uri = $row['uri'] . '_shared_by_' . $name;
-			$displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
+			$uri = $row['uri'].'_shared_by_'.$name;
+			$displayName = $row['displayname'].' ('.$this->getUserDisplayName($name).')';
 
 			$addressBooks[$row['id']] = [
 				'id'  => $row['id'],
 				'uri' => $uri,
 				'principaluri' => $principalUriOriginal,
 				'{DAV:}displayname' => $displayName,
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-				'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
+				'{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}owner-principal' => $row['principaluri'],
 				$readOnlyPropertyName => $readOnly,
 			];
 
@@ -246,9 +246,9 @@ 
 				'uri' => $row['uri'],
 				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
 				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 			];
 
 			$this->addOwnerPrincipal($addressBooks[$row['id']]);
@@ -293,9 +293,9 @@ 
 			'uri' => $row['uri'],
 			'principaluri' => $row['principaluri'],
 			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+			'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+			'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 		];
 
 		$this->addOwnerPrincipal($addressBook);
@@ -327,9 +327,9 @@ 
 			'uri' => $row['uri'],
 			'principaluri' => $row['principaluri'],
 			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+			'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+			'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 		];
 
 		$this->addOwnerPrincipal($addressBook);
@@ -356,20 +356,20 @@ 
 	public function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
 		$supportedProperties = [
 			'{DAV:}displayname',
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description',
+			'{'.Plugin::NS_CARDDAV.'}addressbook-description',
 		];
 
 		/**
 		 * @suppress SqlInjectionChecker
 		 */
-		$propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
+		$propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
 			$updates = [];
 			foreach ($mutations as $property=>$newValue) {
 				switch ($property) {
 					case '{DAV:}displayname':
 						$updates['displayname'] = $newValue;
 						break;
-					case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
+					case '{'.Plugin::NS_CARDDAV.'}addressbook-description':
 						$updates['description'] = $newValue;
 						break;
 				}
@@ -412,11 +412,11 @@ 
 				case '{DAV:}displayname':
 					$values['displayname'] = $newValue;
 					break;
-				case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
+				case '{'.Plugin::NS_CARDDAV.'}addressbook-description':
 					$values['description'] = $newValue;
 					break;
 				default:
-					throw new BadRequest('Unknown property: ' . $property);
+					throw new BadRequest('Unknown property: '.$property);
 			}
 		}
 
@@ -500,7 +500,7 @@ 
 
 		$result = $query->execute();
 		while ($row = $result->fetch()) {
-			$row['etag'] = '"' . $row['etag'] . '"';
+			$row['etag'] = '"'.$row['etag'].'"';
 
 			$modified = false;
 			$row['carddata'] = $this->readBlob($row['carddata'], $modified);
@@ -540,7 +540,7 @@ 
 		if (!$row) {
 			return false;
 		}
-		$row['etag'] = '"' . $row['etag'] . '"';
+		$row['etag'] = '"'.$row['etag'].'"';
 
 		$modified = false;
 		$row['carddata'] = $this->readBlob($row['carddata'], $modified);
@@ -582,7 +582,7 @@ 
 			$result = $query->execute();
 
 			while ($row = $result->fetch()) {
-				$row['etag'] = '"' . $row['etag'] . '"';
+				$row['etag'] = '"'.$row['etag'].'"';
 
 				$modified = false;
 				$row['carddata'] = $this->readBlob($row['carddata'], $modified);
@@ -661,7 +661,7 @@ 
 				'cardUri' => $cardUri,
 				'cardData' => $cardData]));
 
-		return '"' . $etag . '"';
+		return '"'.$etag.'"';
 	}
 
 	/**
@@ -712,7 +712,7 @@ 
 				'cardUri' => $cardUri,
 				'cardData' => $cardData]));
 
-		return '"' . $etag . '"';
+		return '"'.$etag.'"';
 	}
 
 	/**
@@ -810,7 +810,7 @@ 
 	public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
 		// Current synctoken
 		$stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
-		$stmt->execute([ $addressBookId ]);
+		$stmt->execute([$addressBookId]);
 		$currentToken = $stmt->fetchColumn(0);
 
 		if (is_null($currentToken)) {
@@ -826,8 +826,8 @@ 
 
 		if ($syncToken) {
 			$query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
-			if ($limit>0) {
-				$query .= " LIMIT " . (int)$limit;
+			if ($limit > 0) {
+				$query .= " LIMIT ".(int) $limit;
 			}
 
 			// Fetching all changes
@@ -894,7 +894,7 @@ 
 	 * @param bool $modified
 	 * @return string
 	 */
-	private function readBlob($cardData, &$modified=false) {
+	private function readBlob($cardData, &$modified = false) {
 		if (is_resource($cardData)) {
 			$cardData = stream_get_contents($cardData);
 		}
@@ -962,7 +962,7 @@ 
 			if (\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
 				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter($pattern)));
 			} else {
-				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
+				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%'.$this->db->escapeLikeParameter($pattern).'%')));
 			}
 		}
 		if (isset($options['limit'])) {
@@ -980,7 +980,7 @@ 
 
 		$result->closeCursor();
 
-		return array_map(function ($array) {
+		return array_map(function($array) {
 			$modified = false;
 			$array['carddata'] = $this->readBlob($array['carddata'], $modified);
 			if ($modified) {
@@ -1026,7 +1026,7 @@ 
 		$result->closeCursor();
 
 		if (!isset($uri['uri'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $id);
+			throw new \InvalidArgumentException('Card does not exists: '.$id);
 		}
 
 		return $uri['uri'];
@@ -1051,7 +1051,7 @@ 
 
 		if (is_array($contact)) {
 			$modified = false;
-			$contact['etag'] = '"' . $contact['etag'] . '"';
+			$contact['etag'] = '"'.$contact['etag'].'"';
 			$contact['carddata'] = $this->readBlob($contact['carddata'], $modified);
 			if ($modified) {
 				$contact['size'] = strlen($contact['carddata']);
@@ -1164,10 +1164,10 @@ 
 		$result->closeCursor();
 
 		if (!isset($cardIds['id'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $uri);
+			throw new \InvalidArgumentException('Card does not exists: '.$uri);
 		}
 
-		return (int)$cardIds['id'];
+		return (int) $cardIds['id'];
 	}
 
 	/**
@@ -1192,8 +1192,8 @@ 
 	}
 
 	private function addOwnerPrincipal(&$addressbookInfo) {
-		$ownerPrincipalKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal';
-		$displaynameKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}owner-displayname';
+		$ownerPrincipalKey = '{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}owner-principal';
+		$displaynameKey = '{'.\OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD.'}owner-displayname';
 		if (isset($addressbookInfo[$ownerPrincipalKey])) {
 			$uri = $addressbookInfo[$ownerPrincipalKey];
 		} else {

apps/dav/lib/CardDAV/AddressBookImpl.php

Indentation +269 added lines, -269 removed lines

@@ -40,273 +40,273 @@
 
 class AddressBookImpl implements IAddressBook {
 
-	/** @var CardDavBackend */
-	private $backend;
-
-	/** @var array */
-	private $addressBookInfo;
-
-	/** @var AddressBook */
-	private $addressBook;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/**
-	 * AddressBookImpl constructor.
-	 *
-	 * @param AddressBook $addressBook
-	 * @param array $addressBookInfo
-	 * @param CardDavBackend $backend
-	 * @param IUrlGenerator $urlGenerator
-	 */
-	public function __construct(
-			AddressBook $addressBook,
-			array $addressBookInfo,
-			CardDavBackend $backend,
-			IURLGenerator $urlGenerator) {
-		$this->addressBook = $addressBook;
-		$this->addressBookInfo = $addressBookInfo;
-		$this->backend = $backend;
-		$this->urlGenerator = $urlGenerator;
-	}
-
-	/**
-	 * @return string defining the technical unique key
-	 * @since 5.0.0
-	 */
-	public function getKey() {
-		return $this->addressBookInfo['id'];
-	}
-
-	/**
-	 * @return string defining the unique uri
-	 * @since 16.0.0
-	 * @return string
-	 */
-	public function getUri(): string {
-		return $this->addressBookInfo['uri'];
-	}
-
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 *
-	 * @return mixed
-	 * @since 5.0.0
-	 */
-	public function getDisplayName() {
-		return $this->addressBookInfo['{DAV:}displayname'];
-	}
-
-	/**
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @param array $options Options to define the output format and search behavior
-	 * 	- 'types' boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
-	 *    example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
-	 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
-	 * 	- 'limit' - Set a numeric limit for the search results
-	 * 	- 'offset' - Set the offset for the limited search results
-	 * @return array an array of contacts which are arrays of key-value-pairs
-	 *  example result:
-	 *  [
-	 *		['id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'],
-	 *		['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['d@e.f', 'g@h.i']]
-	 *	]
-	 * @since 5.0.0
-	 */
-	public function search($pattern, $searchProperties, $options) {
-		$results = $this->backend->search($this->getKey(), $pattern, $searchProperties, $options);
-
-		$withTypes = \array_key_exists('types', $options) && $options['types'] === true;
-
-		$vCards = [];
-		foreach ($results as $result) {
-			$vCards[] = $this->vCard2Array($result['uri'], $this->readCard($result['carddata']), $withTypes);
-		}
-
-		return $vCards;
-	}
-
-	/**
-	 * @param array $properties this array if key-value-pairs defines a contact
-	 * @return array an array representing the contact just created or updated
-	 * @since 5.0.0
-	 */
-	public function createOrUpdate($properties) {
-		$update = false;
-		if (!isset($properties['URI'])) { // create a new contact
-			$uid = $this->createUid();
-			$uri = $uid . '.vcf';
-			$vCard = $this->createEmptyVCard($uid);
-		} else { // update existing contact
-			$uri = $properties['URI'];
-			$vCardData = $this->backend->getCard($this->getKey(), $uri);
-			$vCard = $this->readCard($vCardData['carddata']);
-			$update = true;
-		}
-
-		foreach ($properties as $key => $value) {
-			$vCard->$key = $vCard->createProperty($key, $value);
-		}
-
-		if ($update) {
-			$this->backend->updateCard($this->getKey(), $uri, $vCard->serialize());
-		} else {
-			$this->backend->createCard($this->getKey(), $uri, $vCard->serialize());
-		}
-
-		return $this->vCard2Array($uri, $vCard);
-	}
-
-	/**
-	 * @return mixed
-	 * @since 5.0.0
-	 */
-	public function getPermissions() {
-		$permissions = $this->addressBook->getACL();
-		$result = 0;
-		foreach ($permissions as $permission) {
-			switch ($permission['privilege']) {
-				case '{DAV:}read':
-					$result |= Constants::PERMISSION_READ;
-					break;
-				case '{DAV:}write':
-					$result |= Constants::PERMISSION_CREATE;
-					$result |= Constants::PERMISSION_UPDATE;
-					break;
-				case '{DAV:}all':
-					$result |= Constants::PERMISSION_ALL;
-					break;
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * @param object $id the unique identifier to a contact
-	 * @return bool successful or not
-	 * @since 5.0.0
-	 */
-	public function delete($id) {
-		$uri = $this->backend->getCardUri($id);
-		return $this->backend->deleteCard($this->addressBookInfo['id'], $uri);
-	}
-
-	/**
-	 * read vCard data into a vCard object
-	 *
-	 * @param string $cardData
-	 * @return VCard
-	 */
-	protected function readCard($cardData) {
-		return  Reader::read($cardData);
-	}
-
-	/**
-	 * create UID for contact
-	 *
-	 * @return string
-	 */
-	protected function createUid() {
-		do {
-			$uid = $this->getUid();
-			$contact = $this->backend->getContact($this->getKey(), $uid . '.vcf');
-		} while (!empty($contact));
-
-		return $uid;
-	}
-
-	/**
-	 * getUid is only there for testing, use createUid instead
-	 */
-	protected function getUid() {
-		return UUIDUtil::getUUID();
-	}
-
-	/**
-	 * create empty vcard
-	 *
-	 * @param string $uid
-	 * @return VCard
-	 */
-	protected function createEmptyVCard($uid) {
-		$vCard = new VCard();
-		$vCard->UID = $uid;
-		return $vCard;
-	}
-
-	/**
-	 * create array with all vCard properties
-	 *
-	 * @param string $uri
-	 * @param VCard $vCard
-	 * @param boolean $withTypes (optional) return the values as arrays of value/type pairs
-	 * @return array
-	 */
-	protected function vCard2Array($uri, VCard $vCard, $withTypes = false) {
-		$result = [
-			'URI' => $uri,
-		];
-
-		foreach ($vCard->children() as $property) {
-			if ($property->name === 'PHOTO' && $property->getValueType() === 'BINARY') {
-				$url = $this->urlGenerator->getAbsoluteURL(
-					$this->urlGenerator->linkTo('', 'remote.php') . '/dav/');
-				$url .= implode('/', [
-					'addressbooks',
-					substr($this->addressBookInfo['principaluri'], 11), //cut off 'principals/'
-					$this->addressBookInfo['uri'],
-					$uri
-				]) . '?photo';
-
-				$result['PHOTO'] = 'VALUE=uri:' . $url;
-			} elseif (in_array($property->name, ['URL', 'GEO', 'CLOUD', 'ADR', 'EMAIL', 'IMPP', 'TEL', 'X-SOCIALPROFILE', 'RELATED', 'LANG', 'X-ADDRESSBOOKSERVER-MEMBER'])) {
-				if (!isset($result[$property->name])) {
-					$result[$property->name] = [];
-				}
-
-				$type = $this->getTypeFromProperty($property);
-				if ($withTypes) {
-					$result[$property->name][] = [
-						'type' => $type,
-						'value' => $property->getValue()
-					];
-				} else {
-					$result[$property->name][] = $property->getValue();
-				}
-			} else {
-				$result[$property->name] = $property->getValue();
-			}
-		}
-
-		if (
-			$this->addressBookInfo['principaluri'] === 'principals/system/system' && (
-				$this->addressBookInfo['uri'] === 'system' ||
-				$this->addressBookInfo['{DAV:}displayname'] === $this->urlGenerator->getBaseUrl()
-			)
-		) {
-			$result['isLocalSystemBook'] = true;
-		}
-		return $result;
-	}
-
-	/**
-	 * Get the type of the current property
-	 *
-	 * @param Property $property
-	 * @return null|string
-	 */
-	protected function getTypeFromProperty(Property $property) {
-		$parameters = $property->parameters();
-		// Type is the social network, when it's empty we don't need this.
-		if (isset($parameters['TYPE'])) {
-			/** @var \Sabre\VObject\Parameter $type */
-			$type = $parameters['TYPE'];
-			return $type->getValue();
-		}
-
-		return null;
-	}
+    /** @var CardDavBackend */
+    private $backend;
+
+    /** @var array */
+    private $addressBookInfo;
+
+    /** @var AddressBook */
+    private $addressBook;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /**
+     * AddressBookImpl constructor.
+     *
+     * @param AddressBook $addressBook
+     * @param array $addressBookInfo
+     * @param CardDavBackend $backend
+     * @param IUrlGenerator $urlGenerator
+     */
+    public function __construct(
+            AddressBook $addressBook,
+            array $addressBookInfo,
+            CardDavBackend $backend,
+            IURLGenerator $urlGenerator) {
+        $this->addressBook = $addressBook;
+        $this->addressBookInfo = $addressBookInfo;
+        $this->backend = $backend;
+        $this->urlGenerator = $urlGenerator;
+    }
+
+    /**
+     * @return string defining the technical unique key
+     * @since 5.0.0
+     */
+    public function getKey() {
+        return $this->addressBookInfo['id'];
+    }
+
+    /**
+     * @return string defining the unique uri
+     * @since 16.0.0
+     * @return string
+     */
+    public function getUri(): string {
+        return $this->addressBookInfo['uri'];
+    }
+
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     *
+     * @return mixed
+     * @since 5.0.0
+     */
+    public function getDisplayName() {
+        return $this->addressBookInfo['{DAV:}displayname'];
+    }
+
+    /**
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @param array $options Options to define the output format and search behavior
+     * 	- 'types' boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
+     *    example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
+     * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
+     * 	- 'limit' - Set a numeric limit for the search results
+     * 	- 'offset' - Set the offset for the limited search results
+     * @return array an array of contacts which are arrays of key-value-pairs
+     *  example result:
+     *  [
+     *		['id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'],
+     *		['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['d@e.f', 'g@h.i']]
+     *	]
+     * @since 5.0.0
+     */
+    public function search($pattern, $searchProperties, $options) {
+        $results = $this->backend->search($this->getKey(), $pattern, $searchProperties, $options);
+
+        $withTypes = \array_key_exists('types', $options) && $options['types'] === true;
+
+        $vCards = [];
+        foreach ($results as $result) {
+            $vCards[] = $this->vCard2Array($result['uri'], $this->readCard($result['carddata']), $withTypes);
+        }
+
+        return $vCards;
+    }
+
+    /**
+     * @param array $properties this array if key-value-pairs defines a contact
+     * @return array an array representing the contact just created or updated
+     * @since 5.0.0
+     */
+    public function createOrUpdate($properties) {
+        $update = false;
+        if (!isset($properties['URI'])) { // create a new contact
+            $uid = $this->createUid();
+            $uri = $uid . '.vcf';
+            $vCard = $this->createEmptyVCard($uid);
+        } else { // update existing contact
+            $uri = $properties['URI'];
+            $vCardData = $this->backend->getCard($this->getKey(), $uri);
+            $vCard = $this->readCard($vCardData['carddata']);
+            $update = true;
+        }
+
+        foreach ($properties as $key => $value) {
+            $vCard->$key = $vCard->createProperty($key, $value);
+        }
+
+        if ($update) {
+            $this->backend->updateCard($this->getKey(), $uri, $vCard->serialize());
+        } else {
+            $this->backend->createCard($this->getKey(), $uri, $vCard->serialize());
+        }
+
+        return $this->vCard2Array($uri, $vCard);
+    }
+
+    /**
+     * @return mixed
+     * @since 5.0.0
+     */
+    public function getPermissions() {
+        $permissions = $this->addressBook->getACL();
+        $result = 0;
+        foreach ($permissions as $permission) {
+            switch ($permission['privilege']) {
+                case '{DAV:}read':
+                    $result |= Constants::PERMISSION_READ;
+                    break;
+                case '{DAV:}write':
+                    $result |= Constants::PERMISSION_CREATE;
+                    $result |= Constants::PERMISSION_UPDATE;
+                    break;
+                case '{DAV:}all':
+                    $result |= Constants::PERMISSION_ALL;
+                    break;
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * @param object $id the unique identifier to a contact
+     * @return bool successful or not
+     * @since 5.0.0
+     */
+    public function delete($id) {
+        $uri = $this->backend->getCardUri($id);
+        return $this->backend->deleteCard($this->addressBookInfo['id'], $uri);
+    }
+
+    /**
+     * read vCard data into a vCard object
+     *
+     * @param string $cardData
+     * @return VCard
+     */
+    protected function readCard($cardData) {
+        return  Reader::read($cardData);
+    }
+
+    /**
+     * create UID for contact
+     *
+     * @return string
+     */
+    protected function createUid() {
+        do {
+            $uid = $this->getUid();
+            $contact = $this->backend->getContact($this->getKey(), $uid . '.vcf');
+        } while (!empty($contact));
+
+        return $uid;
+    }
+
+    /**
+     * getUid is only there for testing, use createUid instead
+     */
+    protected function getUid() {
+        return UUIDUtil::getUUID();
+    }
+
+    /**
+     * create empty vcard
+     *
+     * @param string $uid
+     * @return VCard
+     */
+    protected function createEmptyVCard($uid) {
+        $vCard = new VCard();
+        $vCard->UID = $uid;
+        return $vCard;
+    }
+
+    /**
+     * create array with all vCard properties
+     *
+     * @param string $uri
+     * @param VCard $vCard
+     * @param boolean $withTypes (optional) return the values as arrays of value/type pairs
+     * @return array
+     */
+    protected function vCard2Array($uri, VCard $vCard, $withTypes = false) {
+        $result = [
+            'URI' => $uri,
+        ];
+
+        foreach ($vCard->children() as $property) {
+            if ($property->name === 'PHOTO' && $property->getValueType() === 'BINARY') {
+                $url = $this->urlGenerator->getAbsoluteURL(
+                    $this->urlGenerator->linkTo('', 'remote.php') . '/dav/');
+                $url .= implode('/', [
+                    'addressbooks',
+                    substr($this->addressBookInfo['principaluri'], 11), //cut off 'principals/'
+                    $this->addressBookInfo['uri'],
+                    $uri
+                ]) . '?photo';
+
+                $result['PHOTO'] = 'VALUE=uri:' . $url;
+            } elseif (in_array($property->name, ['URL', 'GEO', 'CLOUD', 'ADR', 'EMAIL', 'IMPP', 'TEL', 'X-SOCIALPROFILE', 'RELATED', 'LANG', 'X-ADDRESSBOOKSERVER-MEMBER'])) {
+                if (!isset($result[$property->name])) {
+                    $result[$property->name] = [];
+                }
+
+                $type = $this->getTypeFromProperty($property);
+                if ($withTypes) {
+                    $result[$property->name][] = [
+                        'type' => $type,
+                        'value' => $property->getValue()
+                    ];
+                } else {
+                    $result[$property->name][] = $property->getValue();
+                }
+            } else {
+                $result[$property->name] = $property->getValue();
+            }
+        }
+
+        if (
+            $this->addressBookInfo['principaluri'] === 'principals/system/system' && (
+                $this->addressBookInfo['uri'] === 'system' ||
+                $this->addressBookInfo['{DAV:}displayname'] === $this->urlGenerator->getBaseUrl()
+            )
+        ) {
+            $result['isLocalSystemBook'] = true;
+        }
+        return $result;
+    }
+
+    /**
+     * Get the type of the current property
+     *
+     * @param Property $property
+     * @return null|string
+     */
+    protected function getTypeFromProperty(Property $property) {
+        $parameters = $property->parameters();
+        // Type is the social network, when it's empty we don't need this.
+        if (isset($parameters['TYPE'])) {
+            /** @var \Sabre\VObject\Parameter $type */
+            $type = $parameters['TYPE'];
+            return $type->getValue();
+        }
+
+        return null;
+    }
 }

lib/private/ContactsManager.php

Indentation +176 added lines, -176 removed lines

@@ -30,180 +30,180 @@
 
 namespace OC {
 
-	class ContactsManager implements \OCP\Contacts\IManager {
-
-		/**
-		 * This function is used to search and find contacts within the users address books.
-		 * In case $pattern is empty all contacts will be returned.
-		 *
-		 * @param string $pattern which should match within the $searchProperties
-		 * @param array $searchProperties defines the properties within the query pattern should match
-		 * @param array $options = array() to define the search behavior
-		 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
-		 * 	- 'limit' - Set a numeric limit for the search results
-		 * 	- 'offset' - Set the offset for the limited search results
-		 * @return array an array of contacts which are arrays of key-value-pairs
-		 */
-		public function search($pattern, $searchProperties = [], $options = []) {
-			$this->loadAddressBooks();
-			$result = [];
-			foreach ($this->addressBooks as $addressBook) {
-				$r = $addressBook->search($pattern, $searchProperties, $options);
-				$contacts = [];
-				foreach ($r as $c) {
-					$c['addressbook-key'] = $addressBook->getKey();
-					$contacts[] = $c;
-				}
-				$result = array_merge($result, $contacts);
-			}
-
-			return $result;
-		}
-
-		/**
-		 * This function can be used to delete the contact identified by the given id
-		 *
-		 * @param object $id the unique identifier to a contact
-		 * @param string $addressBookKey identifier of the address book in which the contact shall be deleted
-		 * @return bool successful or not
-		 */
-		public function delete($id, $addressBookKey) {
-			$addressBook = $this->getAddressBook($addressBookKey);
-			if (!$addressBook) {
-				return null;
-			}
-
-			if ($addressBook->getPermissions() & \OCP\Constants::PERMISSION_DELETE) {
-				return $addressBook->delete($id);
-			}
-
-			return null;
-		}
-
-		/**
-		 * This function is used to create a new contact if 'id' is not given or not present.
-		 * Otherwise the contact will be updated by replacing the entire data set.
-		 *
-		 * @param array $properties this array if key-value-pairs defines a contact
-		 * @param string $addressBookKey identifier of the address book in which the contact shall be created or updated
-		 * @return array representing the contact just created or updated
-		 */
-		public function createOrUpdate($properties, $addressBookKey) {
-			$addressBook = $this->getAddressBook($addressBookKey);
-			if (!$addressBook) {
-				return null;
-			}
-
-			if ($addressBook->getPermissions() & \OCP\Constants::PERMISSION_CREATE) {
-				return $addressBook->createOrUpdate($properties);
-			}
-
-			return null;
-		}
-
-		/**
-		 * Check if contacts are available (e.g. contacts app enabled)
-		 *
-		 * @return bool true if enabled, false if not
-		 */
-		public function isEnabled() {
-			return !empty($this->addressBooks) || !empty($this->addressBookLoaders);
-		}
-
-		/**
-		 * @param \OCP\IAddressBook $addressBook
-		 */
-		public function registerAddressBook(\OCP\IAddressBook $addressBook) {
-			$this->addressBooks[$addressBook->getKey()] = $addressBook;
-		}
-
-		/**
-		 * @param \OCP\IAddressBook $addressBook
-		 */
-		public function unregisterAddressBook(\OCP\IAddressBook $addressBook) {
-			unset($this->addressBooks[$addressBook->getKey()]);
-		}
-
-		/**
-		 * Return a list of the user's addressbooks display names
-		 * ! The addressBook displayName are not unique, please use getUserAddressBooks
-		 *
-		 * @return array
-		 * @since 6.0.0
-		 * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
-		 */
-		public function getAddressBooks() {
-			$this->loadAddressBooks();
-			$result = [];
-			foreach ($this->addressBooks as $addressBook) {
-				$result[$addressBook->getKey()] = $addressBook->getDisplayName();
-			}
-
-			return $result;
-		}
-
-		/**
-		 * Return a list of the user's addressbooks
-		 *
-		 * @return IAddressBook[]
-		 * @since 16.0.0
-		 */
-		public function getUserAddressBooks(): array {
-			$this->loadAddressBooks();
-			return $this->addressBooks;
-		}
-
-		/**
-		 * removes all registered address book instances
-		 */
-		public function clear() {
-			$this->addressBooks = [];
-			$this->addressBookLoaders = [];
-		}
-
-		/**
-		 * @var \OCP\IAddressBook[] which holds all registered address books
-		 */
-		private $addressBooks = [];
-
-		/**
-		 * @var \Closure[] to call to load/register address books
-		 */
-		private $addressBookLoaders = [];
-
-		/**
-		 * In order to improve lazy loading a closure can be registered which will be called in case
-		 * address books are actually requested
-		 *
-		 * @param \Closure $callable
-		 */
-		public function register(\Closure $callable) {
-			$this->addressBookLoaders[] = $callable;
-		}
-
-		/**
-		 * Get (and load when needed) the address book for $key
-		 *
-		 * @param string $addressBookKey
-		 * @return \OCP\IAddressBook
-		 */
-		protected function getAddressBook($addressBookKey) {
-			$this->loadAddressBooks();
-			if (!array_key_exists($addressBookKey, $this->addressBooks)) {
-				return null;
-			}
-
-			return $this->addressBooks[$addressBookKey];
-		}
-
-		/**
-		 * Load all address books registered with 'register'
-		 */
-		protected function loadAddressBooks() {
-			foreach ($this->addressBookLoaders as $callable) {
-				$callable($this);
-			}
-			$this->addressBookLoaders = [];
-		}
-	}
+    class ContactsManager implements \OCP\Contacts\IManager {
+
+        /**
+         * This function is used to search and find contacts within the users address books.
+         * In case $pattern is empty all contacts will be returned.
+         *
+         * @param string $pattern which should match within the $searchProperties
+         * @param array $searchProperties defines the properties within the query pattern should match
+         * @param array $options = array() to define the search behavior
+         * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
+         * 	- 'limit' - Set a numeric limit for the search results
+         * 	- 'offset' - Set the offset for the limited search results
+         * @return array an array of contacts which are arrays of key-value-pairs
+         */
+        public function search($pattern, $searchProperties = [], $options = []) {
+            $this->loadAddressBooks();
+            $result = [];
+            foreach ($this->addressBooks as $addressBook) {
+                $r = $addressBook->search($pattern, $searchProperties, $options);
+                $contacts = [];
+                foreach ($r as $c) {
+                    $c['addressbook-key'] = $addressBook->getKey();
+                    $contacts[] = $c;
+                }
+                $result = array_merge($result, $contacts);
+            }
+
+            return $result;
+        }
+
+        /**
+         * This function can be used to delete the contact identified by the given id
+         *
+         * @param object $id the unique identifier to a contact
+         * @param string $addressBookKey identifier of the address book in which the contact shall be deleted
+         * @return bool successful or not
+         */
+        public function delete($id, $addressBookKey) {
+            $addressBook = $this->getAddressBook($addressBookKey);
+            if (!$addressBook) {
+                return null;
+            }
+
+            if ($addressBook->getPermissions() & \OCP\Constants::PERMISSION_DELETE) {
+                return $addressBook->delete($id);
+            }
+
+            return null;
+        }
+
+        /**
+         * This function is used to create a new contact if 'id' is not given or not present.
+         * Otherwise the contact will be updated by replacing the entire data set.
+         *
+         * @param array $properties this array if key-value-pairs defines a contact
+         * @param string $addressBookKey identifier of the address book in which the contact shall be created or updated
+         * @return array representing the contact just created or updated
+         */
+        public function createOrUpdate($properties, $addressBookKey) {
+            $addressBook = $this->getAddressBook($addressBookKey);
+            if (!$addressBook) {
+                return null;
+            }
+
+            if ($addressBook->getPermissions() & \OCP\Constants::PERMISSION_CREATE) {
+                return $addressBook->createOrUpdate($properties);
+            }
+
+            return null;
+        }
+
+        /**
+         * Check if contacts are available (e.g. contacts app enabled)
+         *
+         * @return bool true if enabled, false if not
+         */
+        public function isEnabled() {
+            return !empty($this->addressBooks) || !empty($this->addressBookLoaders);
+        }
+
+        /**
+         * @param \OCP\IAddressBook $addressBook
+         */
+        public function registerAddressBook(\OCP\IAddressBook $addressBook) {
+            $this->addressBooks[$addressBook->getKey()] = $addressBook;
+        }
+
+        /**
+         * @param \OCP\IAddressBook $addressBook
+         */
+        public function unregisterAddressBook(\OCP\IAddressBook $addressBook) {
+            unset($this->addressBooks[$addressBook->getKey()]);
+        }
+
+        /**
+         * Return a list of the user's addressbooks display names
+         * ! The addressBook displayName are not unique, please use getUserAddressBooks
+         *
+         * @return array
+         * @since 6.0.0
+         * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
+         */
+        public function getAddressBooks() {
+            $this->loadAddressBooks();
+            $result = [];
+            foreach ($this->addressBooks as $addressBook) {
+                $result[$addressBook->getKey()] = $addressBook->getDisplayName();
+            }
+
+            return $result;
+        }
+
+        /**
+         * Return a list of the user's addressbooks
+         *
+         * @return IAddressBook[]
+         * @since 16.0.0
+         */
+        public function getUserAddressBooks(): array {
+            $this->loadAddressBooks();
+            return $this->addressBooks;
+        }
+
+        /**
+         * removes all registered address book instances
+         */
+        public function clear() {
+            $this->addressBooks = [];
+            $this->addressBookLoaders = [];
+        }
+
+        /**
+         * @var \OCP\IAddressBook[] which holds all registered address books
+         */
+        private $addressBooks = [];
+
+        /**
+         * @var \Closure[] to call to load/register address books
+         */
+        private $addressBookLoaders = [];
+
+        /**
+         * In order to improve lazy loading a closure can be registered which will be called in case
+         * address books are actually requested
+         *
+         * @param \Closure $callable
+         */
+        public function register(\Closure $callable) {
+            $this->addressBookLoaders[] = $callable;
+        }
+
+        /**
+         * Get (and load when needed) the address book for $key
+         *
+         * @param string $addressBookKey
+         * @return \OCP\IAddressBook
+         */
+        protected function getAddressBook($addressBookKey) {
+            $this->loadAddressBooks();
+            if (!array_key_exists($addressBookKey, $this->addressBooks)) {
+                return null;
+            }
+
+            return $this->addressBooks[$addressBookKey];
+        }
+
+        /**
+         * Load all address books registered with 'register'
+         */
+        protected function loadAddressBooks() {
+            foreach ($this->addressBookLoaders as $callable) {
+                $callable($this);
+            }
+            $this->addressBookLoaders = [];
+        }
+    }
 }

lib/private/Collaboration/Collaborators/RemotePlugin.php

Indentation +139 added lines, -139 removed lines

@@ -37,154 +37,154 @@
 use OCP\Share;
 
 class RemotePlugin implements ISearchPlugin {
-	protected $shareeEnumeration;
+    protected $shareeEnumeration;
 
-	/** @var IManager */
-	private $contactsManager;
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-	/** @var IConfig */
-	private $config;
-	/** @var IUserManager */
-	private $userManager;
-	/** @var string */
-	private $userId = '';
+    /** @var IManager */
+    private $contactsManager;
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
+    /** @var IConfig */
+    private $config;
+    /** @var IUserManager */
+    private $userManager;
+    /** @var string */
+    private $userId = '';
 
-	public function __construct(IManager $contactsManager, ICloudIdManager $cloudIdManager, IConfig $config, IUserManager $userManager, IUserSession $userSession) {
-		$this->contactsManager = $contactsManager;
-		$this->cloudIdManager = $cloudIdManager;
-		$this->config = $config;
-		$this->userManager = $userManager;
-		$user = $userSession->getUser();
-		if ($user !== null) {
-			$this->userId = $user->getUID();
-		}
-		$this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
-	}
+    public function __construct(IManager $contactsManager, ICloudIdManager $cloudIdManager, IConfig $config, IUserManager $userManager, IUserSession $userSession) {
+        $this->contactsManager = $contactsManager;
+        $this->cloudIdManager = $cloudIdManager;
+        $this->config = $config;
+        $this->userManager = $userManager;
+        $user = $userSession->getUser();
+        if ($user !== null) {
+            $this->userId = $user->getUID();
+        }
+        $this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
+    }
 
-	public function search($search, $limit, $offset, ISearchResult $searchResult) {
-		$result = ['wide' => [], 'exact' => []];
-		$resultType = new SearchResultType('remotes');
+    public function search($search, $limit, $offset, ISearchResult $searchResult) {
+        $result = ['wide' => [], 'exact' => []];
+        $resultType = new SearchResultType('remotes');
 
-		// Search in contacts
-		$addressBookContacts = $this->contactsManager->search($search, ['CLOUD', 'FN'], ['limit' => $limit, 'offset' => $offset]);
-		foreach ($addressBookContacts as $contact) {
-			if (isset($contact['isLocalSystemBook'])) {
-				continue;
-			}
-			if (isset($contact['CLOUD'])) {
-				$cloudIds = $contact['CLOUD'];
-				if (is_string($cloudIds)) {
-					$cloudIds = [$cloudIds];
-				}
-				$lowerSearch = strtolower($search);
-				foreach ($cloudIds as $cloudId) {
-					$cloudIdType = '';
-					if (\is_array($cloudId)) {
-						$cloudIdData = $cloudId;
-						$cloudId = $cloudIdData['value'];
-						$cloudIdType = $cloudIdData['type'];
-					}
-					try {
-						list($remoteUser, $serverUrl) = $this->splitUserRemote($cloudId);
-					} catch (\InvalidArgumentException $e) {
-						continue;
-					}
+        // Search in contacts
+        $addressBookContacts = $this->contactsManager->search($search, ['CLOUD', 'FN'], ['limit' => $limit, 'offset' => $offset]);
+        foreach ($addressBookContacts as $contact) {
+            if (isset($contact['isLocalSystemBook'])) {
+                continue;
+            }
+            if (isset($contact['CLOUD'])) {
+                $cloudIds = $contact['CLOUD'];
+                if (is_string($cloudIds)) {
+                    $cloudIds = [$cloudIds];
+                }
+                $lowerSearch = strtolower($search);
+                foreach ($cloudIds as $cloudId) {
+                    $cloudIdType = '';
+                    if (\is_array($cloudId)) {
+                        $cloudIdData = $cloudId;
+                        $cloudId = $cloudIdData['value'];
+                        $cloudIdType = $cloudIdData['type'];
+                    }
+                    try {
+                        list($remoteUser, $serverUrl) = $this->splitUserRemote($cloudId);
+                    } catch (\InvalidArgumentException $e) {
+                        continue;
+                    }
 
-					$localUser = $this->userManager->get($remoteUser);
-					/**
-					 * Add local share if remote cloud id matches a local user ones
-					 */
-					if ($localUser !== null && $remoteUser !== $this->userId && $cloudId === $localUser->getCloudId()) {
-						$result['wide'][] = [
-							'label' => $contact['FN'],
-							'uuid' => $contact['UID'],
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_USER,
-								'shareWith' => $remoteUser
-							]
-						];
-					}
+                    $localUser = $this->userManager->get($remoteUser);
+                    /**
+                     * Add local share if remote cloud id matches a local user ones
+                     */
+                    if ($localUser !== null && $remoteUser !== $this->userId && $cloudId === $localUser->getCloudId()) {
+                        $result['wide'][] = [
+                            'label' => $contact['FN'],
+                            'uuid' => $contact['UID'],
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_USER,
+                                'shareWith' => $remoteUser
+                            ]
+                        ];
+                    }
 
-					if (strtolower($contact['FN']) === $lowerSearch || strtolower($cloudId) === $lowerSearch) {
-						if (strtolower($cloudId) === $lowerSearch) {
-							$searchResult->markExactIdMatch($resultType);
-						}
-						$result['exact'][] = [
-							'label' => $contact['FN'] . " ($cloudId)",
-							'uuid' => $contact['UID'],
-							'name' => $contact['FN'],
-							'type' => $cloudIdType,
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_REMOTE,
-								'shareWith' => $cloudId,
-								'server' => $serverUrl,
-							],
-						];
-					} else {
-						$result['wide'][] = [
-							'label' => $contact['FN'] . " ($cloudId)",
-							'uuid' => $contact['UID'],
-							'name' => $contact['FN'],
-							'type' => $cloudIdType,
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_REMOTE,
-								'shareWith' => $cloudId,
-								'server' => $serverUrl,
-							],
-						];
-					}
-				}
-			}
-		}
+                    if (strtolower($contact['FN']) === $lowerSearch || strtolower($cloudId) === $lowerSearch) {
+                        if (strtolower($cloudId) === $lowerSearch) {
+                            $searchResult->markExactIdMatch($resultType);
+                        }
+                        $result['exact'][] = [
+                            'label' => $contact['FN'] . " ($cloudId)",
+                            'uuid' => $contact['UID'],
+                            'name' => $contact['FN'],
+                            'type' => $cloudIdType,
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_REMOTE,
+                                'shareWith' => $cloudId,
+                                'server' => $serverUrl,
+                            ],
+                        ];
+                    } else {
+                        $result['wide'][] = [
+                            'label' => $contact['FN'] . " ($cloudId)",
+                            'uuid' => $contact['UID'],
+                            'name' => $contact['FN'],
+                            'type' => $cloudIdType,
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_REMOTE,
+                                'shareWith' => $cloudId,
+                                'server' => $serverUrl,
+                            ],
+                        ];
+                    }
+                }
+            }
+        }
 
-		if (!$this->shareeEnumeration) {
-			$result['wide'] = [];
-		} else {
-			$result['wide'] = array_slice($result['wide'], $offset, $limit);
-		}
+        if (!$this->shareeEnumeration) {
+            $result['wide'] = [];
+        } else {
+            $result['wide'] = array_slice($result['wide'], $offset, $limit);
+        }
 
-		/**
-		 * Add generic share with remote item for valid cloud ids that are not users of the local instance
-		 */
-		if (!$searchResult->hasExactIdMatch($resultType) && $this->cloudIdManager->isValidCloudId($search) && $offset === 0) {
-			try {
-				list($remoteUser, $serverUrl) = $this->splitUserRemote($search);
-				$localUser = $this->userManager->get($remoteUser);
-				if ($localUser === null || $search !== $localUser->getCloudId()) {
-					$result['exact'][] = [
-						'label' => $remoteUser . " ($serverUrl)",
-						'uuid' => $remoteUser,
-						'name' => $remoteUser,
-						'value' => [
-							'shareType' => Share::SHARE_TYPE_REMOTE,
-							'shareWith' => $search,
-							'server' => $serverUrl,
-						],
-					];
-				}
-			} catch (\InvalidArgumentException $e) {
-			}
-		}
+        /**
+         * Add generic share with remote item for valid cloud ids that are not users of the local instance
+         */
+        if (!$searchResult->hasExactIdMatch($resultType) && $this->cloudIdManager->isValidCloudId($search) && $offset === 0) {
+            try {
+                list($remoteUser, $serverUrl) = $this->splitUserRemote($search);
+                $localUser = $this->userManager->get($remoteUser);
+                if ($localUser === null || $search !== $localUser->getCloudId()) {
+                    $result['exact'][] = [
+                        'label' => $remoteUser . " ($serverUrl)",
+                        'uuid' => $remoteUser,
+                        'name' => $remoteUser,
+                        'value' => [
+                            'shareType' => Share::SHARE_TYPE_REMOTE,
+                            'shareWith' => $search,
+                            'server' => $serverUrl,
+                        ],
+                    ];
+                }
+            } catch (\InvalidArgumentException $e) {
+            }
+        }
 
-		$searchResult->addResultSet($resultType, $result['wide'], $result['exact']);
+        $searchResult->addResultSet($resultType, $result['wide'], $result['exact']);
 
-		return true;
-	}
+        return true;
+    }
 
-	/**
-	 * split user and remote from federated cloud id
-	 *
-	 * @param string $address federated share address
-	 * @return array [user, remoteURL]
-	 * @throws \InvalidArgumentException
-	 */
-	public function splitUserRemote($address) {
-		try {
-			$cloudId = $this->cloudIdManager->resolveCloudId($address);
-			return [$cloudId->getUser(), $cloudId->getRemote()];
-		} catch (\InvalidArgumentException $e) {
-			throw new \InvalidArgumentException('Invalid Federated Cloud ID', 0, $e);
-		}
-	}
+    /**
+     * split user and remote from federated cloud id
+     *
+     * @param string $address federated share address
+     * @return array [user, remoteURL]
+     * @throws \InvalidArgumentException
+     */
+    public function splitUserRemote($address) {
+        try {
+            $cloudId = $this->cloudIdManager->resolveCloudId($address);
+            return [$cloudId->getUser(), $cloudId->getRemote()];
+        } catch (\InvalidArgumentException $e) {
+            throw new \InvalidArgumentException('Invalid Federated Cloud ID', 0, $e);
+        }
+    }
 }

lib/private/Collaboration/Collaborators/MailPlugin.php

Indentation +202 added lines, -202 removed lines

@@ -39,208 +39,208 @@
 use OCP\Share;
 
 class MailPlugin implements ISearchPlugin {
-	protected $shareeEnumeration;
-	protected $shareWithGroupOnly;
-
-	/** @var IManager */
-	private $contactsManager;
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-	/** @var IConfig */
-	private $config;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	public function __construct(IManager $contactsManager, ICloudIdManager $cloudIdManager, IConfig $config, IGroupManager $groupManager, IUserSession $userSession) {
-		$this->contactsManager = $contactsManager;
-		$this->cloudIdManager = $cloudIdManager;
-		$this->config = $config;
-		$this->groupManager = $groupManager;
-		$this->userSession = $userSession;
-
-		$this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
-		$this->shareWithGroupOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
-		$this->shareeEnumerationInGroupOnly = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
-	}
-
-	/**
-	 * @param $search
-	 * @param $limit
-	 * @param $offset
-	 * @param ISearchResult $searchResult
-	 * @return bool
-	 * @since 13.0.0
-	 */
-	public function search($search, $limit, $offset, ISearchResult $searchResult) {
-		$result = $userResults = ['wide' => [], 'exact' => []];
-		$userType = new SearchResultType('users');
-		$emailType = new SearchResultType('emails');
-
-		// Search in contacts
-		$addressBookContacts = $this->contactsManager->search($search, ['EMAIL', 'FN'], ['limit' => $limit, 'offset' => $offset]);
-		$lowerSearch = strtolower($search);
-		foreach ($addressBookContacts as $contact) {
-			if (isset($contact['EMAIL'])) {
-				$emailAddresses = $contact['EMAIL'];
-				if (\is_string($emailAddresses)) {
-					$emailAddresses = [$emailAddresses];
-				}
-				foreach ($emailAddresses as $type => $emailAddress) {
-					$displayName = $emailAddress;
-					$emailAddressType = null;
-					if (\is_array($emailAddress)) {
-						$emailAddressData = $emailAddress;
-						$emailAddress = $emailAddressData['value'];
-						$emailAddressType = $emailAddressData['type'];
-					}
-					if (isset($contact['FN'])) {
-						$displayName = $contact['FN'] . ' (' . $emailAddress . ')';
-					}
-					$exactEmailMatch = strtolower($emailAddress) === $lowerSearch;
-
-					if (isset($contact['isLocalSystemBook'])) {
-						if ($this->shareWithGroupOnly) {
-							/*
+    protected $shareeEnumeration;
+    protected $shareWithGroupOnly;
+
+    /** @var IManager */
+    private $contactsManager;
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
+    /** @var IConfig */
+    private $config;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var IUserSession */
+    private $userSession;
+
+    public function __construct(IManager $contactsManager, ICloudIdManager $cloudIdManager, IConfig $config, IGroupManager $groupManager, IUserSession $userSession) {
+        $this->contactsManager = $contactsManager;
+        $this->cloudIdManager = $cloudIdManager;
+        $this->config = $config;
+        $this->groupManager = $groupManager;
+        $this->userSession = $userSession;
+
+        $this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
+        $this->shareWithGroupOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
+        $this->shareeEnumerationInGroupOnly = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
+    }
+
+    /**
+     * @param $search
+     * @param $limit
+     * @param $offset
+     * @param ISearchResult $searchResult
+     * @return bool
+     * @since 13.0.0
+     */
+    public function search($search, $limit, $offset, ISearchResult $searchResult) {
+        $result = $userResults = ['wide' => [], 'exact' => []];
+        $userType = new SearchResultType('users');
+        $emailType = new SearchResultType('emails');
+
+        // Search in contacts
+        $addressBookContacts = $this->contactsManager->search($search, ['EMAIL', 'FN'], ['limit' => $limit, 'offset' => $offset]);
+        $lowerSearch = strtolower($search);
+        foreach ($addressBookContacts as $contact) {
+            if (isset($contact['EMAIL'])) {
+                $emailAddresses = $contact['EMAIL'];
+                if (\is_string($emailAddresses)) {
+                    $emailAddresses = [$emailAddresses];
+                }
+                foreach ($emailAddresses as $type => $emailAddress) {
+                    $displayName = $emailAddress;
+                    $emailAddressType = null;
+                    if (\is_array($emailAddress)) {
+                        $emailAddressData = $emailAddress;
+                        $emailAddress = $emailAddressData['value'];
+                        $emailAddressType = $emailAddressData['type'];
+                    }
+                    if (isset($contact['FN'])) {
+                        $displayName = $contact['FN'] . ' (' . $emailAddress . ')';
+                    }
+                    $exactEmailMatch = strtolower($emailAddress) === $lowerSearch;
+
+                    if (isset($contact['isLocalSystemBook'])) {
+                        if ($this->shareWithGroupOnly) {
+                            /*
 							 * Check if the user may share with the user associated with the e-mail of the just found contact
 							 */
-							$userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
-							$found = false;
-							foreach ($userGroups as $userGroup) {
-								if ($this->groupManager->isInGroup($contact['UID'], $userGroup)) {
-									$found = true;
-									break;
-								}
-							}
-							if (!$found) {
-								continue;
-							}
-						}
-						if ($exactEmailMatch) {
-							try {
-								$cloud = $this->cloudIdManager->resolveCloudId($contact['CLOUD'][0]);
-							} catch (\InvalidArgumentException $e) {
-								continue;
-							}
-
-							if (!$this->isCurrentUser($cloud) && !$searchResult->hasResult($userType, $cloud->getUser())) {
-								$singleResult = [[
-									'label' => $displayName,
-									'uuid' => $contact['UID'],
-									'name' => $contact['FN'],
-									'value' => [
-										'shareType' => Share::SHARE_TYPE_USER,
-										'shareWith' => $cloud->getUser(),
-									],
-								]];
-								$searchResult->addResultSet($userType, [], $singleResult);
-								$searchResult->markExactIdMatch($emailType);
-							}
-							return false;
-						}
-
-						if ($this->shareeEnumeration) {
-							try {
-								$cloud = $this->cloudIdManager->resolveCloudId($contact['CLOUD'][0]);
-							} catch (\InvalidArgumentException $e) {
-								continue;
-							}
-
-							$addToWide = !$this->shareeEnumerationInGroupOnly;
-							if ($this->shareeEnumerationInGroupOnly) {
-								$addToWide = false;
-								$userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
-								foreach ($userGroups as $userGroup) {
-									if ($this->groupManager->isInGroup($contact['UID'], $userGroup)) {
-										$addToWide = true;
-										break;
-									}
-								}
-							}
-							if ($addToWide && !$this->isCurrentUser($cloud) && !$searchResult->hasResult($userType, $cloud->getUser())) {
-								$userResults['wide'][] = [
-									'label' => $displayName,
-									'uuid' => $contact['UID'],
-									'name' => $contact['FN'],
-									'value' => [
-										'shareType' => Share::SHARE_TYPE_USER,
-										'shareWith' => $cloud->getUser(),
-									],
-								];
-								continue;
-							}
-						}
-						continue;
-					}
-
-					if ($exactEmailMatch
-						|| isset($contact['FN']) && strtolower($contact['FN']) === $lowerSearch) {
-						if ($exactEmailMatch) {
-							$searchResult->markExactIdMatch($emailType);
-						}
-						$result['exact'][] = [
-							'label' => $displayName,
-							'uuid' => $contact['UID'],
-							'name' => $contact['FN'],
-							'type' => $emailAddressType ?? '',
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_EMAIL,
-								'shareWith' => $emailAddress,
-							],
-						];
-					} else {
-						$result['wide'][] = [
-							'label' => $displayName,
-							'uuid' => $contact['UID'],
-							'name' => $contact['FN'],
-							'type' => $emailAddressType ?? '',
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_EMAIL,
-								'shareWith' => $emailAddress,
-							],
-						];
-					}
-				}
-			}
-		}
-
-		$reachedEnd = true;
-		if (!$this->shareeEnumeration) {
-			$result['wide'] = [];
-			$userResults['wide'] = [];
-		} else {
-			$reachedEnd = (count($result['wide']) < $offset + $limit) &&
-				(count($userResults['wide']) < $offset + $limit);
-
-			$result['wide'] = array_slice($result['wide'], $offset, $limit);
-			$userResults['wide'] = array_slice($userResults['wide'], $offset, $limit);
-		}
-
-
-		if (!$searchResult->hasExactIdMatch($emailType) && filter_var($search, FILTER_VALIDATE_EMAIL)) {
-			$result['exact'][] = [
-				'label' => $search,
-				'uuid' => $search,
-				'value' => [
-					'shareType' => Share::SHARE_TYPE_EMAIL,
-					'shareWith' => $search,
-				],
-			];
-		}
-
-		if (!empty($userResults['wide'])) {
-			$searchResult->addResultSet($userType, $userResults['wide'], []);
-		}
-		$searchResult->addResultSet($emailType, $result['wide'], $result['exact']);
-
-		return !$reachedEnd;
-	}
-
-	public function isCurrentUser(ICloudId $cloud): bool {
-		$currentUser = $this->userSession->getUser();
-		return $currentUser instanceof IUser ? $currentUser->getUID() === $cloud->getUser() : false;
-	}
+                            $userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
+                            $found = false;
+                            foreach ($userGroups as $userGroup) {
+                                if ($this->groupManager->isInGroup($contact['UID'], $userGroup)) {
+                                    $found = true;
+                                    break;
+                                }
+                            }
+                            if (!$found) {
+                                continue;
+                            }
+                        }
+                        if ($exactEmailMatch) {
+                            try {
+                                $cloud = $this->cloudIdManager->resolveCloudId($contact['CLOUD'][0]);
+                            } catch (\InvalidArgumentException $e) {
+                                continue;
+                            }
+
+                            if (!$this->isCurrentUser($cloud) && !$searchResult->hasResult($userType, $cloud->getUser())) {
+                                $singleResult = [[
+                                    'label' => $displayName,
+                                    'uuid' => $contact['UID'],
+                                    'name' => $contact['FN'],
+                                    'value' => [
+                                        'shareType' => Share::SHARE_TYPE_USER,
+                                        'shareWith' => $cloud->getUser(),
+                                    ],
+                                ]];
+                                $searchResult->addResultSet($userType, [], $singleResult);
+                                $searchResult->markExactIdMatch($emailType);
+                            }
+                            return false;
+                        }
+
+                        if ($this->shareeEnumeration) {
+                            try {
+                                $cloud = $this->cloudIdManager->resolveCloudId($contact['CLOUD'][0]);
+                            } catch (\InvalidArgumentException $e) {
+                                continue;
+                            }
+
+                            $addToWide = !$this->shareeEnumerationInGroupOnly;
+                            if ($this->shareeEnumerationInGroupOnly) {
+                                $addToWide = false;
+                                $userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
+                                foreach ($userGroups as $userGroup) {
+                                    if ($this->groupManager->isInGroup($contact['UID'], $userGroup)) {
+                                        $addToWide = true;
+                                        break;
+                                    }
+                                }
+                            }
+                            if ($addToWide && !$this->isCurrentUser($cloud) && !$searchResult->hasResult($userType, $cloud->getUser())) {
+                                $userResults['wide'][] = [
+                                    'label' => $displayName,
+                                    'uuid' => $contact['UID'],
+                                    'name' => $contact['FN'],
+                                    'value' => [
+                                        'shareType' => Share::SHARE_TYPE_USER,
+                                        'shareWith' => $cloud->getUser(),
+                                    ],
+                                ];
+                                continue;
+                            }
+                        }
+                        continue;
+                    }
+
+                    if ($exactEmailMatch
+                        || isset($contact['FN']) && strtolower($contact['FN']) === $lowerSearch) {
+                        if ($exactEmailMatch) {
+                            $searchResult->markExactIdMatch($emailType);
+                        }
+                        $result['exact'][] = [
+                            'label' => $displayName,
+                            'uuid' => $contact['UID'],
+                            'name' => $contact['FN'],
+                            'type' => $emailAddressType ?? '',
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_EMAIL,
+                                'shareWith' => $emailAddress,
+                            ],
+                        ];
+                    } else {
+                        $result['wide'][] = [
+                            'label' => $displayName,
+                            'uuid' => $contact['UID'],
+                            'name' => $contact['FN'],
+                            'type' => $emailAddressType ?? '',
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_EMAIL,
+                                'shareWith' => $emailAddress,
+                            ],
+                        ];
+                    }
+                }
+            }
+        }
+
+        $reachedEnd = true;
+        if (!$this->shareeEnumeration) {
+            $result['wide'] = [];
+            $userResults['wide'] = [];
+        } else {
+            $reachedEnd = (count($result['wide']) < $offset + $limit) &&
+                (count($userResults['wide']) < $offset + $limit);
+
+            $result['wide'] = array_slice($result['wide'], $offset, $limit);
+            $userResults['wide'] = array_slice($userResults['wide'], $offset, $limit);
+        }
+
+
+        if (!$searchResult->hasExactIdMatch($emailType) && filter_var($search, FILTER_VALIDATE_EMAIL)) {
+            $result['exact'][] = [
+                'label' => $search,
+                'uuid' => $search,
+                'value' => [
+                    'shareType' => Share::SHARE_TYPE_EMAIL,
+                    'shareWith' => $search,
+                ],
+            ];
+        }
+
+        if (!empty($userResults['wide'])) {
+            $searchResult->addResultSet($userType, $userResults['wide'], []);
+        }
+        $searchResult->addResultSet($emailType, $result['wide'], $result['exact']);
+
+        return !$reachedEnd;
+    }
+
+    public function isCurrentUser(ICloudId $cloud): bool {
+        $currentUser = $this->userSession->getUser();
+        return $currentUser instanceof IUser ? $currentUser->getUID() === $cloud->getUser() : false;
+    }
 }

lib/public/IAddressBook.php

Indentation +65 added lines, -65 removed lines

@@ -36,76 +36,76 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 
 namespace OCP {
-	/**
-	 * Interface IAddressBook
-	 *
-	 * @package OCP
-	 * @since 5.0.0
-	 */
-	interface IAddressBook {
+    /**
+     * Interface IAddressBook
+     *
+     * @package OCP
+     * @since 5.0.0
+     */
+    interface IAddressBook {
 
-		/**
-		 * @return string defining the technical unique key
-		 * @since 5.0.0
-		 */
-		public function getKey();
+        /**
+         * @return string defining the technical unique key
+         * @since 5.0.0
+         */
+        public function getKey();
 
-		/**
-		 * @return string defining the unique uri
-		 * @since 16.0.0
-		 * @return string
-		 */
-		public function getUri(): string;
+        /**
+         * @return string defining the unique uri
+         * @since 16.0.0
+         * @return string
+         */
+        public function getUri(): string;
 
-		/**
-		 * In comparison to getKey() this function returns a human readable (maybe translated) name
-		 * @return mixed
-		 * @since 5.0.0
-		 */
-		public function getDisplayName();
+        /**
+         * In comparison to getKey() this function returns a human readable (maybe translated) name
+         * @return mixed
+         * @since 5.0.0
+         */
+        public function getDisplayName();
 
-		/**
-		 * @param string $pattern which should match within the $searchProperties
-		 * @param array $searchProperties defines the properties within the query pattern should match
-		 * @param array $options Options to define the output format and search behavior
-		 * 	- 'types' boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
-		 *    example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
-		 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
-		 * 	- 'limit' - Set a numeric limit for the search results
-		 * 	- 'offset' - Set the offset for the limited search results
-		 * @return array an array of contacts which are arrays of key-value-pairs
-		 *  example result:
-		 *  [
-		 *		['id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'],
-		 *		['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['d@e.f', 'g@h.i']]
-		 *	]
-		 * @since 5.0.0
-		 */
-		public function search($pattern, $searchProperties, $options);
+        /**
+         * @param string $pattern which should match within the $searchProperties
+         * @param array $searchProperties defines the properties within the query pattern should match
+         * @param array $options Options to define the output format and search behavior
+         * 	- 'types' boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
+         *    example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
+         * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
+         * 	- 'limit' - Set a numeric limit for the search results
+         * 	- 'offset' - Set the offset for the limited search results
+         * @return array an array of contacts which are arrays of key-value-pairs
+         *  example result:
+         *  [
+         *		['id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'],
+         *		['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['d@e.f', 'g@h.i']]
+         *	]
+         * @since 5.0.0
+         */
+        public function search($pattern, $searchProperties, $options);
 
-		/**
-		 * @param array $properties this array if key-value-pairs defines a contact
-		 * @return array an array representing the contact just created or updated
-		 * @since 5.0.0
-		 */
-		public function createOrUpdate($properties);
-		//	// dummy
-		//	return array('id'    => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
-		//		     'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
-		//		     'ADR'   => ';;123 Main Street;Any Town;CA;91921-1234'
-		//	);
+        /**
+         * @param array $properties this array if key-value-pairs defines a contact
+         * @return array an array representing the contact just created or updated
+         * @since 5.0.0
+         */
+        public function createOrUpdate($properties);
+        //	// dummy
+        //	return array('id'    => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
+        //		     'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
+        //		     'ADR'   => ';;123 Main Street;Any Town;CA;91921-1234'
+        //	);
 
-		/**
-		 * @return mixed
-		 * @since 5.0.0
-		 */
-		public function getPermissions();
+        /**
+         * @return mixed
+         * @since 5.0.0
+         */
+        public function getPermissions();
 
-		/**
-		 * @param object $id the unique identifier to a contact
-		 * @return bool successful or not
-		 * @since 5.0.0
-		 */
-		public function delete($id);
-	}
+        /**
+         * @param object $id the unique identifier to a contact
+         * @return bool successful or not
+         * @since 5.0.0
+         */
+        public function delete($id);
+    }
 }

lib/public/Contacts/IManager.php

Indentation +121 added lines, -121 removed lines

@@ -54,134 +54,134 @@
  */
 interface IManager {
 
-	/**
-	 * This function is used to search and find contacts within the users address books.
-	 * In case $pattern is empty all contacts will be returned.
-	 *
-	 * Example:
-	 *  Following function shows how to search for contacts for the name and the email address.
-	 *
-	 *		public static function getMatchingRecipient($term) {
-	 *			$cm = \OC::$server->getContactsManager();
-	 *			// The API is not active -> nothing to do
-	 *			if (!$cm->isEnabled()) {
-	 *				return array();
-	 *			}
-	 *
-	 *			$result = $cm->search($term, array('FN', 'EMAIL'));
-	 *			$receivers = array();
-	 *			foreach ($result as $r) {
-	 *				$id = $r['id'];
-	 *				$fn = $r['FN'];
-	 *				$email = $r['EMAIL'];
-	 *				if (!is_array($email)) {
-	 *					$email = array($email);
-	 *				}
-	 *
-	 *				// loop through all email addresses of this contact
-	 *				foreach ($email as $e) {
-	 *				$displayName = $fn . " <$e>";
-	 *				$receivers[] = array(
-	 *					'id'    => $id,
-	 *					'label' => $displayName,
-	 *					'value' => $displayName);
-	 *				}
-	 *			}
-	 *
-	 *			return $receivers;
-	 *		}
-	 *
-	 *
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @param array $options = array() to define the search behavior
-	 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
-	 * 	- 'limit' - Set a numeric limit for the search results
-	 * 	- 'offset' - Set the offset for the limited search results
-	 * @return array an array of contacts which are arrays of key-value-pairs
-	 * @since 6.0.0
-	 */
-	public function search($pattern, $searchProperties = [], $options = []);
+    /**
+     * This function is used to search and find contacts within the users address books.
+     * In case $pattern is empty all contacts will be returned.
+     *
+     * Example:
+     *  Following function shows how to search for contacts for the name and the email address.
+     *
+     *		public static function getMatchingRecipient($term) {
+     *			$cm = \OC::$server->getContactsManager();
+     *			// The API is not active -> nothing to do
+     *			if (!$cm->isEnabled()) {
+     *				return array();
+     *			}
+     *
+     *			$result = $cm->search($term, array('FN', 'EMAIL'));
+     *			$receivers = array();
+     *			foreach ($result as $r) {
+     *				$id = $r['id'];
+     *				$fn = $r['FN'];
+     *				$email = $r['EMAIL'];
+     *				if (!is_array($email)) {
+     *					$email = array($email);
+     *				}
+     *
+     *				// loop through all email addresses of this contact
+     *				foreach ($email as $e) {
+     *				$displayName = $fn . " <$e>";
+     *				$receivers[] = array(
+     *					'id'    => $id,
+     *					'label' => $displayName,
+     *					'value' => $displayName);
+     *				}
+     *			}
+     *
+     *			return $receivers;
+     *		}
+     *
+     *
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @param array $options = array() to define the search behavior
+     * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
+     * 	- 'limit' - Set a numeric limit for the search results
+     * 	- 'offset' - Set the offset for the limited search results
+     * @return array an array of contacts which are arrays of key-value-pairs
+     * @since 6.0.0
+     */
+    public function search($pattern, $searchProperties = [], $options = []);
 
-	/**
-	 * This function can be used to delete the contact identified by the given id
-	 *
-	 * @param object $id the unique identifier to a contact
-	 * @param string $address_book_key identifier of the address book in which the contact shall be deleted
-	 * @return bool successful or not
-	 * @since 6.0.0
-	 */
-	public function delete($id, $address_book_key);
+    /**
+     * This function can be used to delete the contact identified by the given id
+     *
+     * @param object $id the unique identifier to a contact
+     * @param string $address_book_key identifier of the address book in which the contact shall be deleted
+     * @return bool successful or not
+     * @since 6.0.0
+     */
+    public function delete($id, $address_book_key);
 
-	/**
-	 * This function is used to create a new contact if 'id' is not given or not present.
-	 * Otherwise the contact will be updated by replacing the entire data set.
-	 *
-	 * @param array $properties this array if key-value-pairs defines a contact
-	 * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
-	 * @return array an array representing the contact just created or updated
-	 * @since 6.0.0
-	 */
-	public function createOrUpdate($properties, $address_book_key);
+    /**
+     * This function is used to create a new contact if 'id' is not given or not present.
+     * Otherwise the contact will be updated by replacing the entire data set.
+     *
+     * @param array $properties this array if key-value-pairs defines a contact
+     * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
+     * @return array an array representing the contact just created or updated
+     * @since 6.0.0
+     */
+    public function createOrUpdate($properties, $address_book_key);
 
-	/**
-	 * Check if contacts are available (e.g. contacts app enabled)
-	 *
-	 * @return bool true if enabled, false if not
-	 * @since 6.0.0
-	 */
-	public function isEnabled();
+    /**
+     * Check if contacts are available (e.g. contacts app enabled)
+     *
+     * @return bool true if enabled, false if not
+     * @since 6.0.0
+     */
+    public function isEnabled();
 
-	/**
-	 * Registers an address book
-	 *
-	 * @param \OCP\IAddressBook $address_book
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function registerAddressBook(\OCP\IAddressBook $address_book);
+    /**
+     * Registers an address book
+     *
+     * @param \OCP\IAddressBook $address_book
+     * @return void
+     * @since 6.0.0
+     */
+    public function registerAddressBook(\OCP\IAddressBook $address_book);
 
-	/**
-	 * Unregisters an address book
-	 *
-	 * @param \OCP\IAddressBook $address_book
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function unregisterAddressBook(\OCP\IAddressBook $address_book);
+    /**
+     * Unregisters an address book
+     *
+     * @param \OCP\IAddressBook $address_book
+     * @return void
+     * @since 6.0.0
+     */
+    public function unregisterAddressBook(\OCP\IAddressBook $address_book);
 
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * address books are actually requested
-	 *
-	 * @param \Closure $callable
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function register(\Closure $callable);
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * address books are actually requested
+     *
+     * @param \Closure $callable
+     * @return void
+     * @since 6.0.0
+     */
+    public function register(\Closure $callable);
 
-	/**
-	 * Return a list of the user's addressbooks display names
-	 *
-	 * @return array
-	 * @since 6.0.0
-	 * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
-	 */
-	public function getAddressBooks();
+    /**
+     * Return a list of the user's addressbooks display names
+     *
+     * @return array
+     * @since 6.0.0
+     * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
+     */
+    public function getAddressBooks();
 
-	/**
-	 * Return a list of the user's addressbooks
-	 *
-	 * @return IAddressBook[]
-	 * @since 16.0.0
-	 */
-	public function getUserAddressBooks();
+    /**
+     * Return a list of the user's addressbooks
+     *
+     * @return IAddressBook[]
+     * @since 16.0.0
+     */
+    public function getUserAddressBooks();
 
-	/**
-	 * removes all registered address book instances
-	 *
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function clear();
+    /**
+     * removes all registered address book instances
+     *
+     * @return void
+     * @since 6.0.0
+     */
+    public function clear();
 }