nextcloud / server

apps/dav/lib/CardDAV/CardDavBackend.php

Indentation +1118 added lines, -1118 removed lines

@@ -55,1122 +55,1122 @@
 
 class CardDavBackend implements BackendInterface, SyncSupport {
 
-	const PERSONAL_ADDRESSBOOK_URI = 'contacts';
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	function deleteAddressBook($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete('cards')
-			->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
-	 */
-	function getCards($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$cards = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$row['etag'] = '"' . $row['etag'] . '"';
-			$row['carddata'] = $this->readBlob($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
-	 */
-	function getCard($addressBookId, $cardUri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from('cards')
-			->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'] . '"';
-		$row['carddata'] = $this->readBlob($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
-	 */
-	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('cards')
-			->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'] . '"';
-				$row['carddata'] = $this->readBlob($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
-	 */
-	function createCard($addressBookId, $cardUri, $cardData) {
-		$etag = md5($cardData);
-		$uid = $this->getUID($cardData);
-
-		$q = $this->db->getQueryBuilder();
-		$q->select('uid')
-			->from('cards')
-			->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
-	 */
-	function updateCard($addressBookId, $cardUri, $cardData) {
-
-		$uid = $this->getUID($cardData);
-		$etag = md5($cardData);
-		$query = $this->db->getQueryBuilder();
-		$query->update('cards')
-			->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
-	 */
-	function deleteCard($addressBookId, $cardUri) {
-		try {
-			$cardId = $this->getCardId($addressBookId, $cardUri);
-		} catch (\InvalidArgumentException $e) {
-			$cardId = null;
-		}
-		$query = $this->db->getQueryBuilder();
-		$ret = $query->delete('cards')
-			->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
-	 */
-	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
-		]);
-	}
-
-	private function readBlob($cardData) {
-		if (is_resource($cardData)) {
-			return stream_get_contents($cardData);
-		}
-
-		return $cardData;
-	}
-
-	/**
-	 * @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) . '%')));
-			}
-		}
-
-		$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) {
-			$array['carddata'] = $this->readBlob($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)) {
-			$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');
-	}
+    const PERSONAL_ADDRESSBOOK_URI = 'contacts';
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    function deleteAddressBook($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete('cards')
+            ->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
+     */
+    function getCards($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $cards = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $row['etag'] = '"' . $row['etag'] . '"';
+            $row['carddata'] = $this->readBlob($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
+     */
+    function getCard($addressBookId, $cardUri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from('cards')
+            ->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'] . '"';
+        $row['carddata'] = $this->readBlob($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
+     */
+    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('cards')
+            ->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'] . '"';
+                $row['carddata'] = $this->readBlob($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
+     */
+    function createCard($addressBookId, $cardUri, $cardData) {
+        $etag = md5($cardData);
+        $uid = $this->getUID($cardData);
+
+        $q = $this->db->getQueryBuilder();
+        $q->select('uid')
+            ->from('cards')
+            ->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
+     */
+    function updateCard($addressBookId, $cardUri, $cardData) {
+
+        $uid = $this->getUID($cardData);
+        $etag = md5($cardData);
+        $query = $this->db->getQueryBuilder();
+        $query->update('cards')
+            ->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
+     */
+    function deleteCard($addressBookId, $cardUri) {
+        try {
+            $cardId = $this->getCardId($addressBookId, $cardUri);
+        } catch (\InvalidArgumentException $e) {
+            $cardId = null;
+        }
+        $query = $this->db->getQueryBuilder();
+        $ret = $query->delete('cards')
+            ->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
+     */
+    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
+        ]);
+    }
+
+    private function readBlob($cardData) {
+        if (is_resource($cardData)) {
+            return stream_get_contents($cardData);
+        }
+
+        return $cardData;
+    }
+
+    /**
+     * @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) . '%')));
+            }
+        }
+
+        $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) {
+            $array['carddata'] = $this->readBlob($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)) {
+            $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');
+    }
 }

apps/theming/appinfo/routes.php

Indentation +54 added lines, -54 removed lines

@@ -28,59 +28,59 @@
  */
 
 return ['routes' => [
-	[
-		'name' => 'Theming#updateStylesheet',
-		'url' => '/ajax/updateStylesheet',
-		'verb' => 'POST'
-	],
-	[
-		'name' => 'Theming#undo',
-		'url' => '/ajax/undoChanges',
-		'verb' => 'POST'
-	],
-	[
-		'name' => 'Theming#uploadImage',
-		'url' => '/ajax/uploadImage',
-		'verb' => 'POST'
-	],
-	[
-		'name' => 'Theming#getStylesheet',
-		'url' => '/styles',
-		'verb' => 'GET',
-	],
-	[
-		'name' => 'Theming#getImage',
-		'url' => '/image/{key}',
-		'verb' => 'GET',
-	],
-	[
-		'name' => 'Theming#getJavascript',
-		'url' => '/js/theming',
-		'verb' => 'GET',
-	],
-	[
-		'name' => 'Theming#getManifest',
-		'url' => '/manifest/{app}',
-		'verb' => 'GET',
-		'defaults' => ['app' => 'core']
-	],
-	[
-		'name'	=> 'Icon#getFavicon',
-		'url' => '/favicon/{app}',
-		'verb' => 'GET',
-		'defaults' => ['app' => 'core'],
-	],
-	[
-		'name'	=> 'Icon#getTouchIcon',
-		'url' => '/icon/{app}',
-		'verb' => 'GET',
-		'defaults' => ['app' => 'core'],
-	],
-	[
-		'name'	=> 'Icon#getThemedIcon',
-		'url' => '/img/{app}/{image}',
-		'verb' => 'GET',
-		'requirements' => ['image' => '.+']
-	],
+    [
+        'name' => 'Theming#updateStylesheet',
+        'url' => '/ajax/updateStylesheet',
+        'verb' => 'POST'
+    ],
+    [
+        'name' => 'Theming#undo',
+        'url' => '/ajax/undoChanges',
+        'verb' => 'POST'
+    ],
+    [
+        'name' => 'Theming#uploadImage',
+        'url' => '/ajax/uploadImage',
+        'verb' => 'POST'
+    ],
+    [
+        'name' => 'Theming#getStylesheet',
+        'url' => '/styles',
+        'verb' => 'GET',
+    ],
+    [
+        'name' => 'Theming#getImage',
+        'url' => '/image/{key}',
+        'verb' => 'GET',
+    ],
+    [
+        'name' => 'Theming#getJavascript',
+        'url' => '/js/theming',
+        'verb' => 'GET',
+    ],
+    [
+        'name' => 'Theming#getManifest',
+        'url' => '/manifest/{app}',
+        'verb' => 'GET',
+        'defaults' => ['app' => 'core']
+    ],
+    [
+        'name'	=> 'Icon#getFavicon',
+        'url' => '/favicon/{app}',
+        'verb' => 'GET',
+        'defaults' => ['app' => 'core'],
+    ],
+    [
+        'name'	=> 'Icon#getTouchIcon',
+        'url' => '/icon/{app}',
+        'verb' => 'GET',
+        'defaults' => ['app' => 'core'],
+    ],
+    [
+        'name'	=> 'Icon#getThemedIcon',
+        'url' => '/img/{app}/{image}',
+        'verb' => 'GET',
+        'requirements' => ['image' => '.+']
+    ],
 ]];
 

apps/theming/lib/Util.php

Indentation +210 added lines, -210 removed lines

@@ -38,215 +38,215 @@
 
 class Util {
 
-	/** @var IConfig */
-	private $config;
-
-	/** @var IAppManager */
-	private $appManager;
-
-	/** @var IAppData */
-	private $appData;
-
-	/**
-	 * Util constructor.
-	 *
-	 * @param IConfig $config
-	 * @param IAppManager $appManager
-	 * @param IAppData $appData
-	 */
-	public function __construct(IConfig $config, IAppManager $appManager, IAppData $appData) {
-		$this->config = $config;
-		$this->appManager = $appManager;
-		$this->appData = $appData;
-	}
-
-	/**
-	 * @param string $color rgb color value
-	 * @return bool
-	 */
-	public function invertTextColor($color) {
-		$l = $this->calculateLuma($color);
-		if($l>0.6) {
-			return true;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * get color for on-page elements:
-	 * theme color by default, grey if theme color is to bright
-	 * @param $color
-	 * @return string
-	 */
-	public function elementColor($color) {
-		$l = $this->calculateLuminance($color);
-		if($l>0.8) {
-			return '#aaaaaa';
-		}
-		return $color;
-	}
-
-	/**
-	 * @param string $color rgb color value
-	 * @return float
-	 */
-	public function calculateLuminance($color) {
-		list($red, $green, $blue) = $this->hexToRGB($color);
-		$compiler = new Compiler();
-		$hsl = $compiler->toHSL($red, $green, $blue);
-		return $hsl[3]/100;
-	}
-
-	/**
-	 * @param string $color rgb color value
-	 * @return float
-	 */
-	public function calculateLuma($color) {
-		list($red, $green, $blue) = $this->hexToRGB($color);
-		return (0.2126 * $red  + 0.7152 * $green + 0.0722 * $blue) / 255;
-	}
-
-	/**
-	 * @param string $color rgb color value
-	 * @return int[]
-	 */
-	public function hexToRGB($color) {
-		$hex = preg_replace("/[^0-9A-Fa-f]/", '', $color);
-		if (strlen($hex) === 3) {
-			$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
-		}
-		if (strlen($hex) !== 6) {
-			return 0;
-		}
-		return [
-			hexdec(substr($hex, 0, 2)),
-			hexdec(substr($hex, 2, 2)),
-			hexdec(substr($hex, 4, 2))
-		];
-	}
-
-	/**
-	 * @param $color
-	 * @return string base64 encoded radio button svg
-	 */
-	public function generateRadioButton($color) {
-		$radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' .
-			'<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>';
-		return base64_encode($radioButtonIcon);
-	}
-
-
-	/**
-	 * @param $app string app name
-	 * @return string|ISimpleFile path to app icon / file of logo
-	 */
-	public function getAppIcon($app) {
-		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
-		try {
-			$appPath = $this->appManager->getAppPath($app);
-			$icon = $appPath . '/img/' . $app . '.svg';
-			if (file_exists($icon)) {
-				return $icon;
-			}
-			$icon = $appPath . '/img/app.svg';
-			if (file_exists($icon)) {
-				return $icon;
-			}
-		} catch (AppPathNotFoundException $e) {}
-
-		if ($this->config->getAppValue('theming', 'logoMime', '') !== '') {
-			$logoFile = null;
-			try {
-				$folder = $this->appData->getFolder('images');
-				if ($folder !== null) {
-					return $folder->getFile('logo');
-				}
-			} catch (NotFoundException $e) {}
-		}
-		return \OC::$SERVERROOT . '/core/img/logo/logo.svg';
-	}
-
-	/**
-	 * @param $app string app name
-	 * @param $image string relative path to image in app folder
-	 * @return string|false absolute path to image
-	 */
-	public function getAppImage($app, $image) {
-		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
-		$image = str_replace(['\0', '\\', '..'], '', $image);
-		if ($app === "core") {
-			$icon = \OC::$SERVERROOT . '/core/img/' . $image;
-			if (file_exists($icon)) {
-				return $icon;
-			}
-		}
-
-		try {
-			$appPath = $this->appManager->getAppPath($app);
-		} catch (AppPathNotFoundException $e) {
-			return false;
-		}
-
-		$icon = $appPath . '/img/' . $image;
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.svg';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.png';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.gif';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.jpg';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-
-		return false;
-	}
-
-	/**
-	 * replace default color with a custom one
-	 *
-	 * @param $svg string content of a svg file
-	 * @param $color string color to match
-	 * @return string
-	 */
-	public function colorizeSvg($svg, $color) {
-		$svg = preg_replace('/#0082c9/i', $color, $svg);
-		return $svg;
-	}
-
-	/**
-	 * Check if a custom theme is set in the server configuration
-	 *
-	 * @return bool
-	 */
-	public function isAlreadyThemed() {
-		$theme = $this->config->getSystemValue('theme', '');
-		if ($theme !== '') {
-			return true;
-		}
-		return false;
-	}
-
-	public function isBackgroundThemed() {
-		$backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime',false);
-
-		$backgroundExists = true;
-		try {
-			$this->appData->getFolder('images')->getFile('background');
-		} catch (\Exception $e) {
-			$backgroundExists = false;
-		}
-		return $backgroundLogo && $backgroundLogo !== 'backgroundColor' && $backgroundExists;
-	}
+    /** @var IConfig */
+    private $config;
+
+    /** @var IAppManager */
+    private $appManager;
+
+    /** @var IAppData */
+    private $appData;
+
+    /**
+     * Util constructor.
+     *
+     * @param IConfig $config
+     * @param IAppManager $appManager
+     * @param IAppData $appData
+     */
+    public function __construct(IConfig $config, IAppManager $appManager, IAppData $appData) {
+        $this->config = $config;
+        $this->appManager = $appManager;
+        $this->appData = $appData;
+    }
+
+    /**
+     * @param string $color rgb color value
+     * @return bool
+     */
+    public function invertTextColor($color) {
+        $l = $this->calculateLuma($color);
+        if($l>0.6) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * get color for on-page elements:
+     * theme color by default, grey if theme color is to bright
+     * @param $color
+     * @return string
+     */
+    public function elementColor($color) {
+        $l = $this->calculateLuminance($color);
+        if($l>0.8) {
+            return '#aaaaaa';
+        }
+        return $color;
+    }
+
+    /**
+     * @param string $color rgb color value
+     * @return float
+     */
+    public function calculateLuminance($color) {
+        list($red, $green, $blue) = $this->hexToRGB($color);
+        $compiler = new Compiler();
+        $hsl = $compiler->toHSL($red, $green, $blue);
+        return $hsl[3]/100;
+    }
+
+    /**
+     * @param string $color rgb color value
+     * @return float
+     */
+    public function calculateLuma($color) {
+        list($red, $green, $blue) = $this->hexToRGB($color);
+        return (0.2126 * $red  + 0.7152 * $green + 0.0722 * $blue) / 255;
+    }
+
+    /**
+     * @param string $color rgb color value
+     * @return int[]
+     */
+    public function hexToRGB($color) {
+        $hex = preg_replace("/[^0-9A-Fa-f]/", '', $color);
+        if (strlen($hex) === 3) {
+            $hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
+        }
+        if (strlen($hex) !== 6) {
+            return 0;
+        }
+        return [
+            hexdec(substr($hex, 0, 2)),
+            hexdec(substr($hex, 2, 2)),
+            hexdec(substr($hex, 4, 2))
+        ];
+    }
+
+    /**
+     * @param $color
+     * @return string base64 encoded radio button svg
+     */
+    public function generateRadioButton($color) {
+        $radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' .
+            '<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>';
+        return base64_encode($radioButtonIcon);
+    }
+
+
+    /**
+     * @param $app string app name
+     * @return string|ISimpleFile path to app icon / file of logo
+     */
+    public function getAppIcon($app) {
+        $app = str_replace(['\0', '/', '\\', '..'], '', $app);
+        try {
+            $appPath = $this->appManager->getAppPath($app);
+            $icon = $appPath . '/img/' . $app . '.svg';
+            if (file_exists($icon)) {
+                return $icon;
+            }
+            $icon = $appPath . '/img/app.svg';
+            if (file_exists($icon)) {
+                return $icon;
+            }
+        } catch (AppPathNotFoundException $e) {}
+
+        if ($this->config->getAppValue('theming', 'logoMime', '') !== '') {
+            $logoFile = null;
+            try {
+                $folder = $this->appData->getFolder('images');
+                if ($folder !== null) {
+                    return $folder->getFile('logo');
+                }
+            } catch (NotFoundException $e) {}
+        }
+        return \OC::$SERVERROOT . '/core/img/logo/logo.svg';
+    }
+
+    /**
+     * @param $app string app name
+     * @param $image string relative path to image in app folder
+     * @return string|false absolute path to image
+     */
+    public function getAppImage($app, $image) {
+        $app = str_replace(['\0', '/', '\\', '..'], '', $app);
+        $image = str_replace(['\0', '\\', '..'], '', $image);
+        if ($app === "core") {
+            $icon = \OC::$SERVERROOT . '/core/img/' . $image;
+            if (file_exists($icon)) {
+                return $icon;
+            }
+        }
+
+        try {
+            $appPath = $this->appManager->getAppPath($app);
+        } catch (AppPathNotFoundException $e) {
+            return false;
+        }
+
+        $icon = $appPath . '/img/' . $image;
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.svg';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.png';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.gif';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.jpg';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+
+        return false;
+    }
+
+    /**
+     * replace default color with a custom one
+     *
+     * @param $svg string content of a svg file
+     * @param $color string color to match
+     * @return string
+     */
+    public function colorizeSvg($svg, $color) {
+        $svg = preg_replace('/#0082c9/i', $color, $svg);
+        return $svg;
+    }
+
+    /**
+     * Check if a custom theme is set in the server configuration
+     *
+     * @return bool
+     */
+    public function isAlreadyThemed() {
+        $theme = $this->config->getSystemValue('theme', '');
+        if ($theme !== '') {
+            return true;
+        }
+        return false;
+    }
+
+    public function isBackgroundThemed() {
+        $backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime',false);
+
+        $backgroundExists = true;
+        try {
+            $this->appData->getFolder('images')->getFile('background');
+        } catch (\Exception $e) {
+            $backgroundExists = false;
+        }
+        return $backgroundLogo && $backgroundLogo !== 'backgroundColor' && $backgroundExists;
+    }
 
 }

apps/encryption/templates/altmail.php

Indentation +2 added lines, -2 removed lines

@@ -4,8 +4,8 @@
 
 print_unescaped($l->t("Hey there,\n\nthe admin enabled server-side-encryption. Your files were encrypted using the password '%s'.\n\nPlease login to the web interface, go to the section 'basic encryption module' of your personal settings and update your encryption password by entering this password into the 'old log-in password' field and your current login-password.\n\n", [$_['password']]));
 if ( isset($_['expiration']) ) {
-	print_unescaped($l->t("The share will expire on %s.", [$_['expiration']]));
-	print_unescaped("\n\n");
+    print_unescaped($l->t("The share will expire on %s.", [$_['expiration']]));
+    print_unescaped("\n\n");
 }
 // TRANSLATORS term at the end of a mail
 p($l->t("Cheers!"));

apps/encryption/lib/Crypto/Encryption.php

Indentation +553 added lines, -553 removed lines

@@ -46,557 +46,557 @@
 
 class Encryption implements IEncryptionModule {
 
-	const ID = 'OC_DEFAULT_MODULE';
-	const DISPLAY_NAME = 'Default encryption module';
-
-	/**
-	 * @var Crypt
-	 */
-	private $crypt;
-
-	/** @var string */
-	private $cipher;
-
-	/** @var string */
-	private $path;
-
-	/** @var string */
-	private $user;
-
-	/** @var  array */
-	private $owner;
-
-	/** @var string */
-	private $fileKey;
-
-	/** @var string */
-	private $writeCache;
-
-	/** @var KeyManager */
-	private $keyManager;
-
-	/** @var array */
-	private $accessList;
-
-	/** @var boolean */
-	private $isWriteOperation;
-
-	/** @var Util */
-	private $util;
-
-	/** @var  Session */
-	private $session;
-
-	/** @var  ILogger */
-	private $logger;
-
-	/** @var IL10N */
-	private $l;
-
-	/** @var EncryptAll */
-	private $encryptAll;
-
-	/** @var  bool */
-	private $useMasterPassword;
-
-	/** @var DecryptAll  */
-	private $decryptAll;
-
-	/** @var int unencrypted block size if block contains signature */
-	private $unencryptedBlockSizeSigned = 6072;
-
-	/** @var int unencrypted block size */
-	private $unencryptedBlockSize = 6126;
-
-	/** @var int Current version of the file */
-	private $version = 0;
-
-	/** @var array remember encryption signature version */
-	private static $rememberVersion = [];
-
-
-	/**
-	 *
-	 * @param Crypt $crypt
-	 * @param KeyManager $keyManager
-	 * @param Util $util
-	 * @param Session $session
-	 * @param EncryptAll $encryptAll
-	 * @param DecryptAll $decryptAll
-	 * @param ILogger $logger
-	 * @param IL10N $il10n
-	 */
-	public function __construct(Crypt $crypt,
-								KeyManager $keyManager,
-								Util $util,
-								Session $session,
-								EncryptAll $encryptAll,
-								DecryptAll $decryptAll,
-								ILogger $logger,
-								IL10N $il10n) {
-		$this->crypt = $crypt;
-		$this->keyManager = $keyManager;
-		$this->util = $util;
-		$this->session = $session;
-		$this->encryptAll = $encryptAll;
-		$this->decryptAll = $decryptAll;
-		$this->logger = $logger;
-		$this->l = $il10n;
-		$this->owner = [];
-		$this->useMasterPassword = $util->isMasterKeyEnabled();
-	}
-
-	/**
-	 * @return string defining the technical unique id
-	 */
-	public function getId() {
-		return self::ID;
-	}
-
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 *
-	 * @return string
-	 */
-	public function getDisplayName() {
-		return self::DISPLAY_NAME;
-	}
-
-	/**
-	 * start receiving chunks from a file. This is the place where you can
-	 * perform some initial step before starting encrypting/decrypting the
-	 * chunks
-	 *
-	 * @param string $path to the file
-	 * @param string $user who read/write the file
-	 * @param string $mode php stream open mode
-	 * @param array $header contains the header data read from the file
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 *
-	 * @return array $header contain data as key-value pairs which should be
-	 *                       written to the header, in case of a write operation
-	 *                       or if no additional data is needed return a empty array
-	 */
-	public function begin($path, $user, $mode, array $header, array $accessList) {
-		$this->path = $this->getPathToRealFile($path);
-		$this->accessList = $accessList;
-		$this->user = $user;
-		$this->isWriteOperation = false;
-		$this->writeCache = '';
-
-		if($this->session->isReady() === false) {
-			// if the master key is enabled we can initialize encryption
-			// with a empty password and user name
-			if ($this->util->isMasterKeyEnabled()) {
-				$this->keyManager->init('', '');
-			}
-		}
-
-		if ($this->session->decryptAllModeActivated()) {
-			$encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path);
-			$shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid());
-			$this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
-				$shareKey,
-				$this->session->getDecryptAllKey());
-		} else {
-			$this->fileKey = $this->keyManager->getFileKey($this->path, $this->user);
-		}
-
-		// always use the version from the original file, also part files
-		// need to have a correct version number if they get moved over to the
-		// final location
-		$this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
-
-		if (
-			$mode === 'w'
-			|| $mode === 'w+'
-			|| $mode === 'wb'
-			|| $mode === 'wb+'
-		) {
-			$this->isWriteOperation = true;
-			if (empty($this->fileKey)) {
-				$this->fileKey = $this->crypt->generateFileKey();
-			}
-		} else {
-			// if we read a part file we need to increase the version by 1
-			// because the version number was also increased by writing
-			// the part file
-			if(Scanner::isPartialFile($path)) {
-				$this->version = $this->version + 1;
-			}
-		}
-
-		if ($this->isWriteOperation) {
-			$this->cipher = $this->crypt->getCipher();
-		} elseif (isset($header['cipher'])) {
-			$this->cipher = $header['cipher'];
-		} else {
-			// if we read a file without a header we fall-back to the legacy cipher
-			// which was used in <=oC6
-			$this->cipher = $this->crypt->getLegacyCipher();
-		}
-
-		return ['cipher' => $this->cipher, 'signed' => 'true'];
-	}
-
-	/**
-	 * last chunk received. This is the place where you can perform some final
-	 * operation and return some remaining data if something is left in your
-	 * buffer.
-	 *
-	 * @param string $path to the file
-	 * @param int $position
-	 * @return string remained data which should be written to the file in case
-	 *                of a write operation
-	 * @throws PublicKeyMissingException
-	 * @throws \Exception
-	 * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException
-	 */
-	public function end($path, $position = 0) {
-		$result = '';
-		if ($this->isWriteOperation) {
-			// in case of a part file we remember the new signature versions
-			// the version will be set later on update.
-			// This way we make sure that other apps listening to the pre-hooks
-			// still get the old version which should be the correct value for them
-			if (Scanner::isPartialFile($path)) {
-				self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1;
-			}
-			if (!empty($this->writeCache)) {
-				$result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position);
-				$this->writeCache = '';
-			}
-			$publicKeys = [];
-			if ($this->useMasterPassword === true) {
-				$publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
-			} else {
-				foreach ($this->accessList['users'] as $uid) {
-					try {
-						$publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
-					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning(
-							'no public key found for user "{uid}", user will not be able to read the file',
-							['app' => 'encryption', 'uid' => $uid]
-						);
-						// if the public key of the owner is missing we should fail
-						if ($uid === $this->user) {
-							throw $e;
-						}
-					}
-				}
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->getOwner($path));
-			$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys);
-			$this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles);
-		}
-		return $result;
-	}
-
-
-
-	/**
-	 * encrypt data
-	 *
-	 * @param string $data you want to encrypt
-	 * @param int $position
-	 * @return string encrypted data
-	 */
-	public function encrypt($data, $position = 0) {
-		// If extra data is left over from the last round, make sure it
-		// is integrated into the next block
-		if ($this->writeCache) {
-
-			// Concat writeCache to start of $data
-			$data = $this->writeCache . $data;
-
-			// Clear the write cache, ready for reuse - it has been
-			// flushed and its old contents processed
-			$this->writeCache = '';
-
-		}
-
-		$encrypted = '';
-		// While there still remains some data to be processed & written
-		while (strlen($data) > 0) {
-
-			// Remaining length for this iteration, not of the
-			// entire file (may be greater than 8192 bytes)
-			$remainingLength = strlen($data);
-
-			// If data remaining to be written is less than the
-			// size of 1 6126 byte block
-			if ($remainingLength < $this->unencryptedBlockSizeSigned) {
-
-				// Set writeCache to contents of $data
-				// The writeCache will be carried over to the
-				// next write round, and added to the start of
-				// $data to ensure that written blocks are
-				// always the correct length. If there is still
-				// data in writeCache after the writing round
-				// has finished, then the data will be written
-				// to disk by $this->flush().
-				$this->writeCache = $data;
-
-				// Clear $data ready for next round
-				$data = '';
-
-			} else {
-
-				// Read the chunk from the start of $data
-				$chunk = substr($data, 0, $this->unencryptedBlockSizeSigned);
-
-				$encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position);
-
-				// Remove the chunk we just processed from
-				// $data, leaving only unprocessed data in $data
-				// var, for handling on the next round
-				$data = substr($data, $this->unencryptedBlockSizeSigned);
-
-			}
-
-		}
-
-		return $encrypted;
-	}
-
-	/**
-	 * decrypt data
-	 *
-	 * @param string $data you want to decrypt
-	 * @param int $position
-	 * @return string decrypted data
-	 * @throws DecryptionFailedException
-	 */
-	public function decrypt($data, $position = 0) {
-		if (empty($this->fileKey)) {
-			$msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.';
-			$hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
-			$this->logger->error($msg);
-
-			throw new DecryptionFailedException($msg, $hint);
-		}
-
-		return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position);
-	}
-
-	/**
-	 * update encrypted file, e.g. give additional users access to the file
-	 *
-	 * @param string $path path to the file which should be updated
-	 * @param string $uid of the user who performs the operation
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 * @return boolean
-	 */
-	public function update($path, $uid, array $accessList) {
-
-		if (empty($accessList)) {
-			if (isset(self::$rememberVersion[$path])) {
-				$this->keyManager->setVersion($path, self::$rememberVersion[$path], new View());
-				unset(self::$rememberVersion[$path]);
-			}
-			return;
-		}
-
-		$fileKey = $this->keyManager->getFileKey($path, $uid);
-
-		if (!empty($fileKey)) {
-
-			$publicKeys = [];
-			if ($this->useMasterPassword === true) {
-				$publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
-			} else {
-				foreach ($accessList['users'] as $user) {
-					try {
-						$publicKeys[$user] = $this->keyManager->getPublicKey($user);
-					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
-					}
-				}
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->getOwner($path));
-
-			$encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
-
-			$this->keyManager->deleteAllFileKeys($path);
-
-			$this->keyManager->setAllFileKeys($path, $encryptedFileKey);
-
-		} else {
-			$this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted',
-				['file' => $path, 'app' => 'encryption']);
-
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * should the file be encrypted or not
-	 *
-	 * @param string $path
-	 * @return boolean
-	 */
-	public function shouldEncrypt($path) {
-		if ($this->util->shouldEncryptHomeStorage() === false) {
-			$storage = $this->util->getStorage($path);
-			if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
-				return false;
-			}
-		}
-		$parts = explode('/', $path);
-		if (count($parts) < 4) {
-			return false;
-		}
-
-		if ($parts[2] === 'files') {
-			return true;
-		}
-		if ($parts[2] === 'files_versions') {
-			return true;
-		}
-		if ($parts[2] === 'files_trashbin') {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get size of the unencrypted payload per block.
-	 * Nextcloud read/write files with a block size of 8192 byte
-	 *
-	 * @param bool $signed
-	 * @return int
-	 */
-	public function getUnencryptedBlockSize($signed = false) {
-		if ($signed === false) {
-			return $this->unencryptedBlockSize;
-		}
-
-		return $this->unencryptedBlockSizeSigned;
-	}
-
-	/**
-	 * check if the encryption module is able to read the file,
-	 * e.g. if all encryption keys exists
-	 *
-	 * @param string $path
-	 * @param string $uid user for whom we want to check if he can read the file
-	 * @return bool
-	 * @throws DecryptionFailedException
-	 */
-	public function isReadable($path, $uid) {
-		$fileKey = $this->keyManager->getFileKey($path, $uid);
-		if (empty($fileKey)) {
-			$owner = $this->util->getOwner($path);
-			if ($owner !== $uid) {
-				// if it is a shared file we throw a exception with a useful
-				// error message because in this case it means that the file was
-				// shared with the user at a point where the user didn't had a
-				// valid private/public key
-				$msg = 'Encryption module "' . $this->getDisplayName() .
-					'" is not able to read ' . $path;
-				$hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
-				$this->logger->warning($msg);
-				throw new DecryptionFailedException($msg, $hint);
-			}
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Initial encryption of all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output write some status information to the terminal during encryption
-	 */
-	public function encryptAll(InputInterface $input, OutputInterface $output) {
-		$this->encryptAll->encryptAll($input, $output);
-	}
-
-	/**
-	 * prepare module to perform decrypt all operation
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 * @param string $user
-	 * @return bool
-	 */
-	public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') {
-		return $this->decryptAll->prepare($input, $output, $user);
-	}
-
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	protected function getPathToRealFile($path) {
-		$realPath = $path;
-		$parts = explode('/', $path);
-		if ($parts[2] === 'files_versions') {
-			$realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
-			$length = strrpos($realPath, '.');
-			$realPath = substr($realPath, 0, $length);
-		}
-
-		return $realPath;
-	}
-
-	/**
-	 * remove .part file extension and the ocTransferId from the file to get the
-	 * original file name
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function stripPartFileExtension($path) {
-		if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
-			$pos = strrpos($path, '.', -6);
-			$path = substr($path, 0, $pos);
-		}
-
-		return $path;
-	}
-
-	/**
-	 * get owner of a file
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function getOwner($path) {
-		if (!isset($this->owner[$path])) {
-			$this->owner[$path] = $this->util->getOwner($path);
-		}
-		return $this->owner[$path];
-	}
-
-	/**
-	 * Check if the module is ready to be used by that specific user.
-	 * In case a module is not ready - because e.g. key pairs have not been generated
-	 * upon login this method can return false before any operation starts and might
-	 * cause issues during operations.
-	 *
-	 * @param string $user
-	 * @return boolean
-	 * @since 9.1.0
-	 */
-	public function isReadyForUser($user) {
-		return $this->keyManager->userHasKeys($user);
-	}
-
-	/**
-	 * We only need a detailed access list if the master key is not enabled
-	 *
-	 * @return bool
-	 */
-	public function needDetailedAccessList() {
-		return !$this->util->isMasterKeyEnabled();
-	}
+    const ID = 'OC_DEFAULT_MODULE';
+    const DISPLAY_NAME = 'Default encryption module';
+
+    /**
+     * @var Crypt
+     */
+    private $crypt;
+
+    /** @var string */
+    private $cipher;
+
+    /** @var string */
+    private $path;
+
+    /** @var string */
+    private $user;
+
+    /** @var  array */
+    private $owner;
+
+    /** @var string */
+    private $fileKey;
+
+    /** @var string */
+    private $writeCache;
+
+    /** @var KeyManager */
+    private $keyManager;
+
+    /** @var array */
+    private $accessList;
+
+    /** @var boolean */
+    private $isWriteOperation;
+
+    /** @var Util */
+    private $util;
+
+    /** @var  Session */
+    private $session;
+
+    /** @var  ILogger */
+    private $logger;
+
+    /** @var IL10N */
+    private $l;
+
+    /** @var EncryptAll */
+    private $encryptAll;
+
+    /** @var  bool */
+    private $useMasterPassword;
+
+    /** @var DecryptAll  */
+    private $decryptAll;
+
+    /** @var int unencrypted block size if block contains signature */
+    private $unencryptedBlockSizeSigned = 6072;
+
+    /** @var int unencrypted block size */
+    private $unencryptedBlockSize = 6126;
+
+    /** @var int Current version of the file */
+    private $version = 0;
+
+    /** @var array remember encryption signature version */
+    private static $rememberVersion = [];
+
+
+    /**
+     *
+     * @param Crypt $crypt
+     * @param KeyManager $keyManager
+     * @param Util $util
+     * @param Session $session
+     * @param EncryptAll $encryptAll
+     * @param DecryptAll $decryptAll
+     * @param ILogger $logger
+     * @param IL10N $il10n
+     */
+    public function __construct(Crypt $crypt,
+                                KeyManager $keyManager,
+                                Util $util,
+                                Session $session,
+                                EncryptAll $encryptAll,
+                                DecryptAll $decryptAll,
+                                ILogger $logger,
+                                IL10N $il10n) {
+        $this->crypt = $crypt;
+        $this->keyManager = $keyManager;
+        $this->util = $util;
+        $this->session = $session;
+        $this->encryptAll = $encryptAll;
+        $this->decryptAll = $decryptAll;
+        $this->logger = $logger;
+        $this->l = $il10n;
+        $this->owner = [];
+        $this->useMasterPassword = $util->isMasterKeyEnabled();
+    }
+
+    /**
+     * @return string defining the technical unique id
+     */
+    public function getId() {
+        return self::ID;
+    }
+
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     *
+     * @return string
+     */
+    public function getDisplayName() {
+        return self::DISPLAY_NAME;
+    }
+
+    /**
+     * start receiving chunks from a file. This is the place where you can
+     * perform some initial step before starting encrypting/decrypting the
+     * chunks
+     *
+     * @param string $path to the file
+     * @param string $user who read/write the file
+     * @param string $mode php stream open mode
+     * @param array $header contains the header data read from the file
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     *
+     * @return array $header contain data as key-value pairs which should be
+     *                       written to the header, in case of a write operation
+     *                       or if no additional data is needed return a empty array
+     */
+    public function begin($path, $user, $mode, array $header, array $accessList) {
+        $this->path = $this->getPathToRealFile($path);
+        $this->accessList = $accessList;
+        $this->user = $user;
+        $this->isWriteOperation = false;
+        $this->writeCache = '';
+
+        if($this->session->isReady() === false) {
+            // if the master key is enabled we can initialize encryption
+            // with a empty password and user name
+            if ($this->util->isMasterKeyEnabled()) {
+                $this->keyManager->init('', '');
+            }
+        }
+
+        if ($this->session->decryptAllModeActivated()) {
+            $encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path);
+            $shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid());
+            $this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
+                $shareKey,
+                $this->session->getDecryptAllKey());
+        } else {
+            $this->fileKey = $this->keyManager->getFileKey($this->path, $this->user);
+        }
+
+        // always use the version from the original file, also part files
+        // need to have a correct version number if they get moved over to the
+        // final location
+        $this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
+
+        if (
+            $mode === 'w'
+            || $mode === 'w+'
+            || $mode === 'wb'
+            || $mode === 'wb+'
+        ) {
+            $this->isWriteOperation = true;
+            if (empty($this->fileKey)) {
+                $this->fileKey = $this->crypt->generateFileKey();
+            }
+        } else {
+            // if we read a part file we need to increase the version by 1
+            // because the version number was also increased by writing
+            // the part file
+            if(Scanner::isPartialFile($path)) {
+                $this->version = $this->version + 1;
+            }
+        }
+
+        if ($this->isWriteOperation) {
+            $this->cipher = $this->crypt->getCipher();
+        } elseif (isset($header['cipher'])) {
+            $this->cipher = $header['cipher'];
+        } else {
+            // if we read a file without a header we fall-back to the legacy cipher
+            // which was used in <=oC6
+            $this->cipher = $this->crypt->getLegacyCipher();
+        }
+
+        return ['cipher' => $this->cipher, 'signed' => 'true'];
+    }
+
+    /**
+     * last chunk received. This is the place where you can perform some final
+     * operation and return some remaining data if something is left in your
+     * buffer.
+     *
+     * @param string $path to the file
+     * @param int $position
+     * @return string remained data which should be written to the file in case
+     *                of a write operation
+     * @throws PublicKeyMissingException
+     * @throws \Exception
+     * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException
+     */
+    public function end($path, $position = 0) {
+        $result = '';
+        if ($this->isWriteOperation) {
+            // in case of a part file we remember the new signature versions
+            // the version will be set later on update.
+            // This way we make sure that other apps listening to the pre-hooks
+            // still get the old version which should be the correct value for them
+            if (Scanner::isPartialFile($path)) {
+                self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1;
+            }
+            if (!empty($this->writeCache)) {
+                $result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position);
+                $this->writeCache = '';
+            }
+            $publicKeys = [];
+            if ($this->useMasterPassword === true) {
+                $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
+            } else {
+                foreach ($this->accessList['users'] as $uid) {
+                    try {
+                        $publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
+                    } catch (PublicKeyMissingException $e) {
+                        $this->logger->warning(
+                            'no public key found for user "{uid}", user will not be able to read the file',
+                            ['app' => 'encryption', 'uid' => $uid]
+                        );
+                        // if the public key of the owner is missing we should fail
+                        if ($uid === $this->user) {
+                            throw $e;
+                        }
+                    }
+                }
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->getOwner($path));
+            $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys);
+            $this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles);
+        }
+        return $result;
+    }
+
+
+
+    /**
+     * encrypt data
+     *
+     * @param string $data you want to encrypt
+     * @param int $position
+     * @return string encrypted data
+     */
+    public function encrypt($data, $position = 0) {
+        // If extra data is left over from the last round, make sure it
+        // is integrated into the next block
+        if ($this->writeCache) {
+
+            // Concat writeCache to start of $data
+            $data = $this->writeCache . $data;
+
+            // Clear the write cache, ready for reuse - it has been
+            // flushed and its old contents processed
+            $this->writeCache = '';
+
+        }
+
+        $encrypted = '';
+        // While there still remains some data to be processed & written
+        while (strlen($data) > 0) {
+
+            // Remaining length for this iteration, not of the
+            // entire file (may be greater than 8192 bytes)
+            $remainingLength = strlen($data);
+
+            // If data remaining to be written is less than the
+            // size of 1 6126 byte block
+            if ($remainingLength < $this->unencryptedBlockSizeSigned) {
+
+                // Set writeCache to contents of $data
+                // The writeCache will be carried over to the
+                // next write round, and added to the start of
+                // $data to ensure that written blocks are
+                // always the correct length. If there is still
+                // data in writeCache after the writing round
+                // has finished, then the data will be written
+                // to disk by $this->flush().
+                $this->writeCache = $data;
+
+                // Clear $data ready for next round
+                $data = '';
+
+            } else {
+
+                // Read the chunk from the start of $data
+                $chunk = substr($data, 0, $this->unencryptedBlockSizeSigned);
+
+                $encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position);
+
+                // Remove the chunk we just processed from
+                // $data, leaving only unprocessed data in $data
+                // var, for handling on the next round
+                $data = substr($data, $this->unencryptedBlockSizeSigned);
+
+            }
+
+        }
+
+        return $encrypted;
+    }
+
+    /**
+     * decrypt data
+     *
+     * @param string $data you want to decrypt
+     * @param int $position
+     * @return string decrypted data
+     * @throws DecryptionFailedException
+     */
+    public function decrypt($data, $position = 0) {
+        if (empty($this->fileKey)) {
+            $msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.';
+            $hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
+            $this->logger->error($msg);
+
+            throw new DecryptionFailedException($msg, $hint);
+        }
+
+        return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position);
+    }
+
+    /**
+     * update encrypted file, e.g. give additional users access to the file
+     *
+     * @param string $path path to the file which should be updated
+     * @param string $uid of the user who performs the operation
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     * @return boolean
+     */
+    public function update($path, $uid, array $accessList) {
+
+        if (empty($accessList)) {
+            if (isset(self::$rememberVersion[$path])) {
+                $this->keyManager->setVersion($path, self::$rememberVersion[$path], new View());
+                unset(self::$rememberVersion[$path]);
+            }
+            return;
+        }
+
+        $fileKey = $this->keyManager->getFileKey($path, $uid);
+
+        if (!empty($fileKey)) {
+
+            $publicKeys = [];
+            if ($this->useMasterPassword === true) {
+                $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
+            } else {
+                foreach ($accessList['users'] as $user) {
+                    try {
+                        $publicKeys[$user] = $this->keyManager->getPublicKey($user);
+                    } catch (PublicKeyMissingException $e) {
+                        $this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
+                    }
+                }
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->getOwner($path));
+
+            $encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
+
+            $this->keyManager->deleteAllFileKeys($path);
+
+            $this->keyManager->setAllFileKeys($path, $encryptedFileKey);
+
+        } else {
+            $this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted',
+                ['file' => $path, 'app' => 'encryption']);
+
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * should the file be encrypted or not
+     *
+     * @param string $path
+     * @return boolean
+     */
+    public function shouldEncrypt($path) {
+        if ($this->util->shouldEncryptHomeStorage() === false) {
+            $storage = $this->util->getStorage($path);
+            if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
+                return false;
+            }
+        }
+        $parts = explode('/', $path);
+        if (count($parts) < 4) {
+            return false;
+        }
+
+        if ($parts[2] === 'files') {
+            return true;
+        }
+        if ($parts[2] === 'files_versions') {
+            return true;
+        }
+        if ($parts[2] === 'files_trashbin') {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * get size of the unencrypted payload per block.
+     * Nextcloud read/write files with a block size of 8192 byte
+     *
+     * @param bool $signed
+     * @return int
+     */
+    public function getUnencryptedBlockSize($signed = false) {
+        if ($signed === false) {
+            return $this->unencryptedBlockSize;
+        }
+
+        return $this->unencryptedBlockSizeSigned;
+    }
+
+    /**
+     * check if the encryption module is able to read the file,
+     * e.g. if all encryption keys exists
+     *
+     * @param string $path
+     * @param string $uid user for whom we want to check if he can read the file
+     * @return bool
+     * @throws DecryptionFailedException
+     */
+    public function isReadable($path, $uid) {
+        $fileKey = $this->keyManager->getFileKey($path, $uid);
+        if (empty($fileKey)) {
+            $owner = $this->util->getOwner($path);
+            if ($owner !== $uid) {
+                // if it is a shared file we throw a exception with a useful
+                // error message because in this case it means that the file was
+                // shared with the user at a point where the user didn't had a
+                // valid private/public key
+                $msg = 'Encryption module "' . $this->getDisplayName() .
+                    '" is not able to read ' . $path;
+                $hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
+                $this->logger->warning($msg);
+                throw new DecryptionFailedException($msg, $hint);
+            }
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Initial encryption of all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output write some status information to the terminal during encryption
+     */
+    public function encryptAll(InputInterface $input, OutputInterface $output) {
+        $this->encryptAll->encryptAll($input, $output);
+    }
+
+    /**
+     * prepare module to perform decrypt all operation
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @param string $user
+     * @return bool
+     */
+    public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') {
+        return $this->decryptAll->prepare($input, $output, $user);
+    }
+
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    protected function getPathToRealFile($path) {
+        $realPath = $path;
+        $parts = explode('/', $path);
+        if ($parts[2] === 'files_versions') {
+            $realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
+            $length = strrpos($realPath, '.');
+            $realPath = substr($realPath, 0, $length);
+        }
+
+        return $realPath;
+    }
+
+    /**
+     * remove .part file extension and the ocTransferId from the file to get the
+     * original file name
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function stripPartFileExtension($path) {
+        if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
+            $pos = strrpos($path, '.', -6);
+            $path = substr($path, 0, $pos);
+        }
+
+        return $path;
+    }
+
+    /**
+     * get owner of a file
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function getOwner($path) {
+        if (!isset($this->owner[$path])) {
+            $this->owner[$path] = $this->util->getOwner($path);
+        }
+        return $this->owner[$path];
+    }
+
+    /**
+     * Check if the module is ready to be used by that specific user.
+     * In case a module is not ready - because e.g. key pairs have not been generated
+     * upon login this method can return false before any operation starts and might
+     * cause issues during operations.
+     *
+     * @param string $user
+     * @return boolean
+     * @since 9.1.0
+     */
+    public function isReadyForUser($user) {
+        return $this->keyManager->userHasKeys($user);
+    }
+
+    /**
+     * We only need a detailed access list if the master key is not enabled
+     *
+     * @return bool
+     */
+    public function needDetailedAccessList() {
+        return !$this->util->isMasterKeyEnabled();
+    }
 }

apps/encryption/lib/Crypto/EncryptAll.php

Indentation +435 added lines, -435 removed lines

@@ -46,440 +46,440 @@
 
 class EncryptAll {
 
-	/** @var Setup */
-	protected $userSetup;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var View */
-	protected $rootView;
-
-	/** @var KeyManager */
-	protected $keyManager;
-
-	/** @var Util */
-	protected $util;
-
-	/** @var array  */
-	protected $userPasswords;
-
-	/** @var  IConfig */
-	protected $config;
-
-	/** @var IMailer */
-	protected $mailer;
-
-	/** @var  IL10N */
-	protected $l;
-
-	/** @var  QuestionHelper */
-	protected $questionHelper;
-
-	/** @var  OutputInterface */
-	protected $output;
-
-	/** @var  InputInterface */
-	protected $input;
-
-	/** @var ISecureRandom */
-	protected $secureRandom;
-
-	/**
-	 * @param Setup $userSetup
-	 * @param IUserManager $userManager
-	 * @param View $rootView
-	 * @param KeyManager $keyManager
-	 * @param Util $util
-	 * @param IConfig $config
-	 * @param IMailer $mailer
-	 * @param IL10N $l
-	 * @param QuestionHelper $questionHelper
-	 * @param ISecureRandom $secureRandom
-	 */
-	public function __construct(
-		Setup $userSetup,
-		IUserManager $userManager,
-		View $rootView,
-		KeyManager $keyManager,
-		Util $util,
-		IConfig $config,
-		IMailer $mailer,
-		IL10N $l,
-		QuestionHelper $questionHelper,
-		ISecureRandom $secureRandom
-	) {
-		$this->userSetup = $userSetup;
-		$this->userManager = $userManager;
-		$this->rootView = $rootView;
-		$this->keyManager = $keyManager;
-		$this->util = $util;
-		$this->config = $config;
-		$this->mailer = $mailer;
-		$this->l = $l;
-		$this->questionHelper = $questionHelper;
-		$this->secureRandom = $secureRandom;
-		// store one time passwords for the users
-		$this->userPasswords = [];
-	}
-
-	/**
-	 * start to encrypt all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 */
-	public function encryptAll(InputInterface $input, OutputInterface $output) {
-
-		$this->input = $input;
-		$this->output = $output;
-
-		$headline = 'Encrypt all files with the ' . Encryption::DISPLAY_NAME;
-		$this->output->writeln("\n");
-		$this->output->writeln($headline);
-		$this->output->writeln(str_pad('', strlen($headline), '='));
-		$this->output->writeln("\n");
-
-		if ($this->util->isMasterKeyEnabled()) {
-			$this->output->writeln('Use master key to encrypt all files.');
-			$this->keyManager->validateMasterKey();
-		} else {
-			//create private/public keys for each user and store the private key password
-			$this->output->writeln('Create key-pair for every user');
-			$this->output->writeln('------------------------------');
-			$this->output->writeln('');
-			$this->output->writeln('This module will encrypt all files in the users files folder initially.');
-			$this->output->writeln('Already existing versions and files in the trash bin will not be encrypted.');
-			$this->output->writeln('');
-			$this->createKeyPairs();
-		}
-
-
-		// output generated encryption key passwords
-		if ($this->util->isMasterKeyEnabled() === false) {
-			//send-out or display password list and write it to a file
-			$this->output->writeln("\n");
-			$this->output->writeln('Generated encryption key passwords');
-			$this->output->writeln('----------------------------------');
-			$this->output->writeln('');
-			$this->outputPasswords();
-		}
-
-		//setup users file system and encrypt all files one by one (take should encrypt setting of storage into account)
-		$this->output->writeln("\n");
-		$this->output->writeln('Start to encrypt users files');
-		$this->output->writeln('----------------------------');
-		$this->output->writeln('');
-		$this->encryptAllUsersFiles();
-		$this->output->writeln("\n");
-	}
-
-	/**
-	 * create key-pair for every user
-	 */
-	protected function createKeyPairs() {
-		$this->output->writeln("\n");
-		$progress = new ProgressBar($this->output);
-		$progress->setFormat(" %message% \n [%bar%]");
-		$progress->start();
-
-		foreach($this->userManager->getBackends() as $backend) {
-			$limit = 500;
-			$offset = 0;
-			do {
-				$users = $backend->getUsers('', $limit, $offset);
-				foreach ($users as $user) {
-					if ($this->keyManager->userHasKeys($user) === false) {
-						$progress->setMessage('Create key-pair for ' . $user);
-						$progress->advance();
-						$this->setupUserFS($user);
-						$password = $this->generateOneTimePassword($user);
-						$this->userSetup->setupUser($user, $password);
-					} else {
-						// users which already have a key-pair will be stored with a
-						// empty password and filtered out later
-						$this->userPasswords[$user] = '';
-					}
-				}
-				$offset += $limit;
-			} while(count($users) >= $limit);
-		}
-
-		$progress->setMessage('Key-pair created for all users');
-		$progress->finish();
-	}
-
-	/**
-	 * iterate over all user and encrypt their files
-	 */
-	protected function encryptAllUsersFiles() {
-		$this->output->writeln("\n");
-		$progress = new ProgressBar($this->output);
-		$progress->setFormat(" %message% \n [%bar%]");
-		$progress->start();
-		$numberOfUsers = count($this->userPasswords);
-		$userNo = 1;
-		if ($this->util->isMasterKeyEnabled()) {
-			$this->encryptAllUserFilesWithMasterKey($progress);
-		} else {
-			foreach ($this->userPasswords as $uid => $password) {
-				$userCount = "$uid ($userNo of $numberOfUsers)";
-				$this->encryptUsersFiles($uid, $progress, $userCount);
-				$userNo++;
-			}
-		}
-		$progress->setMessage("all files encrypted");
-		$progress->finish();
-
-	}
-
-	/**
-	 * encrypt all user files with the master key
-	 *
-	 * @param ProgressBar $progress
-	 */
-	protected function encryptAllUserFilesWithMasterKey(ProgressBar $progress) {
-		$userNo = 1;
-		foreach($this->userManager->getBackends() as $backend) {
-			$limit = 500;
-			$offset = 0;
-			do {
-				$users = $backend->getUsers('', $limit, $offset);
-				foreach ($users as $user) {
-					$userCount = "$user ($userNo)";
-					$this->encryptUsersFiles($user, $progress, $userCount);
-					$userNo++;
-				}
-				$offset += $limit;
-			} while(count($users) >= $limit);
-		}
-	}
-
-	/**
-	 * encrypt files from the given user
-	 *
-	 * @param string $uid
-	 * @param ProgressBar $progress
-	 * @param string $userCount
-	 */
-	protected function encryptUsersFiles($uid, ProgressBar $progress, $userCount) {
-
-		$this->setupUserFS($uid);
-		$directories = [];
-		$directories[] =  '/' . $uid . '/files';
-
-		while($root = array_pop($directories)) {
-			$content = $this->rootView->getDirectoryContent($root);
-			foreach ($content as $file) {
-				$path = $root . '/' . $file['name'];
-				if ($this->rootView->is_dir($path)) {
-					$directories[] = $path;
-					continue;
-				} else {
-					$progress->setMessage("encrypt files for user $userCount: $path");
-					$progress->advance();
-					if($this->encryptFile($path) === false) {
-						$progress->setMessage("encrypt files for user $userCount: $path (already encrypted)");
-						$progress->advance();
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * encrypt file
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	protected function encryptFile($path) {
-
-		// skip already encrypted files
-		$fileInfo = $this->rootView->getFileInfo($path);
-		if ($fileInfo !== false && $fileInfo->isEncrypted()) {
-			return true;
-		}
-
-		$source = $path;
-		$target = $path . '.encrypted.' . time();
-
-		try {
-			$this->rootView->copy($source, $target);
-			$this->rootView->rename($target, $source);
-		} catch (DecryptionFailedException $e) {
-			if ($this->rootView->file_exists($target)) {
-				$this->rootView->unlink($target);
-			}
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * output one-time encryption passwords
-	 */
-	protected function outputPasswords() {
-		$table = new Table($this->output);
-		$table->setHeaders(['Username', 'Private key password']);
-
-		//create rows
-		$newPasswords = [];
-		$unchangedPasswords = [];
-		foreach ($this->userPasswords as $uid => $password) {
-			if (empty($password)) {
-				$unchangedPasswords[] = $uid;
-			} else {
-				$newPasswords[] = [$uid, $password];
-			}
-		}
-
-		if (empty($newPasswords)) {
-			$this->output->writeln("\nAll users already had a key-pair, no further action needed.\n");
-			return;
-		}
-
-		$table->setRows($newPasswords);
-		$table->render();
-
-		if (!empty($unchangedPasswords)) {
-			$this->output->writeln("\nThe following users already had a key-pair which was reused without setting a new password:\n");
-			foreach ($unchangedPasswords as $uid) {
-				$this->output->writeln("    $uid");
-			}
-		}
-
-		$this->writePasswordsToFile($newPasswords);
-
-		$this->output->writeln('');
-		$question = new ConfirmationQuestion('Do you want to send the passwords directly to the users by mail? (y/n) ', false);
-		if ($this->questionHelper->ask($this->input, $this->output, $question)) {
-			$this->sendPasswordsByMail();
-		}
-	}
-
-	/**
-	 * write one-time encryption passwords to a csv file
-	 *
-	 * @param array $passwords
-	 */
-	protected function writePasswordsToFile(array $passwords) {
-		$fp = $this->rootView->fopen('oneTimeEncryptionPasswords.csv', 'w');
-		foreach ($passwords as $pwd) {
-			fputcsv($fp, $pwd);
-		}
-		fclose($fp);
-		$this->output->writeln("\n");
-		$this->output->writeln('A list of all newly created passwords was written to data/oneTimeEncryptionPasswords.csv');
-		$this->output->writeln('');
-		$this->output->writeln('Each of these users need to login to the web interface, go to the');
-		$this->output->writeln('personal settings section "basic encryption module" and');
-		$this->output->writeln('update the private key password to match the login password again by');
-		$this->output->writeln('entering the one-time password into the "old log-in password" field');
-		$this->output->writeln('and their current login password');
-	}
-
-	/**
-	 * setup user file system
-	 *
-	 * @param string $uid
-	 */
-	protected function setupUserFS($uid) {
-		\OC_Util::tearDownFS();
-		\OC_Util::setupFS($uid);
-	}
-
-	/**
-	 * generate one time password for the user and store it in a array
-	 *
-	 * @param string $uid
-	 * @return string password
-	 */
-	protected function generateOneTimePassword($uid) {
-		$password = $this->secureRandom->generate(8);
-		$this->userPasswords[$uid] = $password;
-		return $password;
-	}
-
-	/**
-	 * send encryption key passwords to the users by mail
-	 */
-	protected function sendPasswordsByMail() {
-		$noMail = [];
-
-		$this->output->writeln('');
-		$progress = new ProgressBar($this->output, count($this->userPasswords));
-		$progress->start();
-
-		foreach ($this->userPasswords as $uid => $password) {
-			$progress->advance();
-			if (!empty($password)) {
-				$recipient = $this->userManager->get($uid);
-				$recipientDisplayName = $recipient->getDisplayName();
-				$to = $recipient->getEMailAddress();
-
-				if ($to === '') {
-					$noMail[] = $uid;
-					continue;
-				}
-
-				$subject = (string)$this->l->t('one-time password for server-side-encryption');
-				list($htmlBody, $textBody) = $this->createMailBody($password);
-
-				// send it out now
-				try {
-					$message = $this->mailer->createMessage();
-					$message->setSubject($subject);
-					$message->setTo([$to => $recipientDisplayName]);
-					$message->setHtmlBody($htmlBody);
-					$message->setPlainBody($textBody);
-					$message->setFrom([
-						\OCP\Util::getDefaultEmailAddress('admin-noreply')
-					]);
-
-					$this->mailer->send($message);
-				} catch (\Exception $e) {
-					$noMail[] = $uid;
-				}
-			}
-		}
-
-		$progress->finish();
-
-		if (empty($noMail)) {
-			$this->output->writeln("\n\nPassword successfully send to all users");
-		} else {
-			$table = new Table($this->output);
-			$table->setHeaders(['Username', 'Private key password']);
-			$this->output->writeln("\n\nCould not send password to following users:\n");
-			$rows = [];
-			foreach ($noMail as $uid) {
-				$rows[] = [$uid, $this->userPasswords[$uid]];
-			}
-			$table->setRows($rows);
-			$table->render();
-		}
-
-	}
-
-	/**
-	 * create mail body for plain text and html mail
-	 *
-	 * @param string $password one-time encryption password
-	 * @return array an array of the html mail body and the plain text mail body
-	 */
-	protected function createMailBody($password) {
-
-		$html = new \OC_Template("encryption", "mail", "");
-		$html->assign ('password', $password);
-		$htmlMail = $html->fetchPage();
-
-		$plainText = new \OC_Template("encryption", "altmail", "");
-		$plainText->assign ('password', $password);
-		$plainTextMail = $plainText->fetchPage();
-
-		return [$htmlMail, $plainTextMail];
-	}
+    /** @var Setup */
+    protected $userSetup;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var View */
+    protected $rootView;
+
+    /** @var KeyManager */
+    protected $keyManager;
+
+    /** @var Util */
+    protected $util;
+
+    /** @var array  */
+    protected $userPasswords;
+
+    /** @var  IConfig */
+    protected $config;
+
+    /** @var IMailer */
+    protected $mailer;
+
+    /** @var  IL10N */
+    protected $l;
+
+    /** @var  QuestionHelper */
+    protected $questionHelper;
+
+    /** @var  OutputInterface */
+    protected $output;
+
+    /** @var  InputInterface */
+    protected $input;
+
+    /** @var ISecureRandom */
+    protected $secureRandom;
+
+    /**
+     * @param Setup $userSetup
+     * @param IUserManager $userManager
+     * @param View $rootView
+     * @param KeyManager $keyManager
+     * @param Util $util
+     * @param IConfig $config
+     * @param IMailer $mailer
+     * @param IL10N $l
+     * @param QuestionHelper $questionHelper
+     * @param ISecureRandom $secureRandom
+     */
+    public function __construct(
+        Setup $userSetup,
+        IUserManager $userManager,
+        View $rootView,
+        KeyManager $keyManager,
+        Util $util,
+        IConfig $config,
+        IMailer $mailer,
+        IL10N $l,
+        QuestionHelper $questionHelper,
+        ISecureRandom $secureRandom
+    ) {
+        $this->userSetup = $userSetup;
+        $this->userManager = $userManager;
+        $this->rootView = $rootView;
+        $this->keyManager = $keyManager;
+        $this->util = $util;
+        $this->config = $config;
+        $this->mailer = $mailer;
+        $this->l = $l;
+        $this->questionHelper = $questionHelper;
+        $this->secureRandom = $secureRandom;
+        // store one time passwords for the users
+        $this->userPasswords = [];
+    }
+
+    /**
+     * start to encrypt all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
+    public function encryptAll(InputInterface $input, OutputInterface $output) {
+
+        $this->input = $input;
+        $this->output = $output;
+
+        $headline = 'Encrypt all files with the ' . Encryption::DISPLAY_NAME;
+        $this->output->writeln("\n");
+        $this->output->writeln($headline);
+        $this->output->writeln(str_pad('', strlen($headline), '='));
+        $this->output->writeln("\n");
+
+        if ($this->util->isMasterKeyEnabled()) {
+            $this->output->writeln('Use master key to encrypt all files.');
+            $this->keyManager->validateMasterKey();
+        } else {
+            //create private/public keys for each user and store the private key password
+            $this->output->writeln('Create key-pair for every user');
+            $this->output->writeln('------------------------------');
+            $this->output->writeln('');
+            $this->output->writeln('This module will encrypt all files in the users files folder initially.');
+            $this->output->writeln('Already existing versions and files in the trash bin will not be encrypted.');
+            $this->output->writeln('');
+            $this->createKeyPairs();
+        }
+
+
+        // output generated encryption key passwords
+        if ($this->util->isMasterKeyEnabled() === false) {
+            //send-out or display password list and write it to a file
+            $this->output->writeln("\n");
+            $this->output->writeln('Generated encryption key passwords');
+            $this->output->writeln('----------------------------------');
+            $this->output->writeln('');
+            $this->outputPasswords();
+        }
+
+        //setup users file system and encrypt all files one by one (take should encrypt setting of storage into account)
+        $this->output->writeln("\n");
+        $this->output->writeln('Start to encrypt users files');
+        $this->output->writeln('----------------------------');
+        $this->output->writeln('');
+        $this->encryptAllUsersFiles();
+        $this->output->writeln("\n");
+    }
+
+    /**
+     * create key-pair for every user
+     */
+    protected function createKeyPairs() {
+        $this->output->writeln("\n");
+        $progress = new ProgressBar($this->output);
+        $progress->setFormat(" %message% \n [%bar%]");
+        $progress->start();
+
+        foreach($this->userManager->getBackends() as $backend) {
+            $limit = 500;
+            $offset = 0;
+            do {
+                $users = $backend->getUsers('', $limit, $offset);
+                foreach ($users as $user) {
+                    if ($this->keyManager->userHasKeys($user) === false) {
+                        $progress->setMessage('Create key-pair for ' . $user);
+                        $progress->advance();
+                        $this->setupUserFS($user);
+                        $password = $this->generateOneTimePassword($user);
+                        $this->userSetup->setupUser($user, $password);
+                    } else {
+                        // users which already have a key-pair will be stored with a
+                        // empty password and filtered out later
+                        $this->userPasswords[$user] = '';
+                    }
+                }
+                $offset += $limit;
+            } while(count($users) >= $limit);
+        }
+
+        $progress->setMessage('Key-pair created for all users');
+        $progress->finish();
+    }
+
+    /**
+     * iterate over all user and encrypt their files
+     */
+    protected function encryptAllUsersFiles() {
+        $this->output->writeln("\n");
+        $progress = new ProgressBar($this->output);
+        $progress->setFormat(" %message% \n [%bar%]");
+        $progress->start();
+        $numberOfUsers = count($this->userPasswords);
+        $userNo = 1;
+        if ($this->util->isMasterKeyEnabled()) {
+            $this->encryptAllUserFilesWithMasterKey($progress);
+        } else {
+            foreach ($this->userPasswords as $uid => $password) {
+                $userCount = "$uid ($userNo of $numberOfUsers)";
+                $this->encryptUsersFiles($uid, $progress, $userCount);
+                $userNo++;
+            }
+        }
+        $progress->setMessage("all files encrypted");
+        $progress->finish();
+
+    }
+
+    /**
+     * encrypt all user files with the master key
+     *
+     * @param ProgressBar $progress
+     */
+    protected function encryptAllUserFilesWithMasterKey(ProgressBar $progress) {
+        $userNo = 1;
+        foreach($this->userManager->getBackends() as $backend) {
+            $limit = 500;
+            $offset = 0;
+            do {
+                $users = $backend->getUsers('', $limit, $offset);
+                foreach ($users as $user) {
+                    $userCount = "$user ($userNo)";
+                    $this->encryptUsersFiles($user, $progress, $userCount);
+                    $userNo++;
+                }
+                $offset += $limit;
+            } while(count($users) >= $limit);
+        }
+    }
+
+    /**
+     * encrypt files from the given user
+     *
+     * @param string $uid
+     * @param ProgressBar $progress
+     * @param string $userCount
+     */
+    protected function encryptUsersFiles($uid, ProgressBar $progress, $userCount) {
+
+        $this->setupUserFS($uid);
+        $directories = [];
+        $directories[] =  '/' . $uid . '/files';
+
+        while($root = array_pop($directories)) {
+            $content = $this->rootView->getDirectoryContent($root);
+            foreach ($content as $file) {
+                $path = $root . '/' . $file['name'];
+                if ($this->rootView->is_dir($path)) {
+                    $directories[] = $path;
+                    continue;
+                } else {
+                    $progress->setMessage("encrypt files for user $userCount: $path");
+                    $progress->advance();
+                    if($this->encryptFile($path) === false) {
+                        $progress->setMessage("encrypt files for user $userCount: $path (already encrypted)");
+                        $progress->advance();
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * encrypt file
+     *
+     * @param string $path
+     * @return bool
+     */
+    protected function encryptFile($path) {
+
+        // skip already encrypted files
+        $fileInfo = $this->rootView->getFileInfo($path);
+        if ($fileInfo !== false && $fileInfo->isEncrypted()) {
+            return true;
+        }
+
+        $source = $path;
+        $target = $path . '.encrypted.' . time();
+
+        try {
+            $this->rootView->copy($source, $target);
+            $this->rootView->rename($target, $source);
+        } catch (DecryptionFailedException $e) {
+            if ($this->rootView->file_exists($target)) {
+                $this->rootView->unlink($target);
+            }
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * output one-time encryption passwords
+     */
+    protected function outputPasswords() {
+        $table = new Table($this->output);
+        $table->setHeaders(['Username', 'Private key password']);
+
+        //create rows
+        $newPasswords = [];
+        $unchangedPasswords = [];
+        foreach ($this->userPasswords as $uid => $password) {
+            if (empty($password)) {
+                $unchangedPasswords[] = $uid;
+            } else {
+                $newPasswords[] = [$uid, $password];
+            }
+        }
+
+        if (empty($newPasswords)) {
+            $this->output->writeln("\nAll users already had a key-pair, no further action needed.\n");
+            return;
+        }
+
+        $table->setRows($newPasswords);
+        $table->render();
+
+        if (!empty($unchangedPasswords)) {
+            $this->output->writeln("\nThe following users already had a key-pair which was reused without setting a new password:\n");
+            foreach ($unchangedPasswords as $uid) {
+                $this->output->writeln("    $uid");
+            }
+        }
+
+        $this->writePasswordsToFile($newPasswords);
+
+        $this->output->writeln('');
+        $question = new ConfirmationQuestion('Do you want to send the passwords directly to the users by mail? (y/n) ', false);
+        if ($this->questionHelper->ask($this->input, $this->output, $question)) {
+            $this->sendPasswordsByMail();
+        }
+    }
+
+    /**
+     * write one-time encryption passwords to a csv file
+     *
+     * @param array $passwords
+     */
+    protected function writePasswordsToFile(array $passwords) {
+        $fp = $this->rootView->fopen('oneTimeEncryptionPasswords.csv', 'w');
+        foreach ($passwords as $pwd) {
+            fputcsv($fp, $pwd);
+        }
+        fclose($fp);
+        $this->output->writeln("\n");
+        $this->output->writeln('A list of all newly created passwords was written to data/oneTimeEncryptionPasswords.csv');
+        $this->output->writeln('');
+        $this->output->writeln('Each of these users need to login to the web interface, go to the');
+        $this->output->writeln('personal settings section "basic encryption module" and');
+        $this->output->writeln('update the private key password to match the login password again by');
+        $this->output->writeln('entering the one-time password into the "old log-in password" field');
+        $this->output->writeln('and their current login password');
+    }
+
+    /**
+     * setup user file system
+     *
+     * @param string $uid
+     */
+    protected function setupUserFS($uid) {
+        \OC_Util::tearDownFS();
+        \OC_Util::setupFS($uid);
+    }
+
+    /**
+     * generate one time password for the user and store it in a array
+     *
+     * @param string $uid
+     * @return string password
+     */
+    protected function generateOneTimePassword($uid) {
+        $password = $this->secureRandom->generate(8);
+        $this->userPasswords[$uid] = $password;
+        return $password;
+    }
+
+    /**
+     * send encryption key passwords to the users by mail
+     */
+    protected function sendPasswordsByMail() {
+        $noMail = [];
+
+        $this->output->writeln('');
+        $progress = new ProgressBar($this->output, count($this->userPasswords));
+        $progress->start();
+
+        foreach ($this->userPasswords as $uid => $password) {
+            $progress->advance();
+            if (!empty($password)) {
+                $recipient = $this->userManager->get($uid);
+                $recipientDisplayName = $recipient->getDisplayName();
+                $to = $recipient->getEMailAddress();
+
+                if ($to === '') {
+                    $noMail[] = $uid;
+                    continue;
+                }
+
+                $subject = (string)$this->l->t('one-time password for server-side-encryption');
+                list($htmlBody, $textBody) = $this->createMailBody($password);
+
+                // send it out now
+                try {
+                    $message = $this->mailer->createMessage();
+                    $message->setSubject($subject);
+                    $message->setTo([$to => $recipientDisplayName]);
+                    $message->setHtmlBody($htmlBody);
+                    $message->setPlainBody($textBody);
+                    $message->setFrom([
+                        \OCP\Util::getDefaultEmailAddress('admin-noreply')
+                    ]);
+
+                    $this->mailer->send($message);
+                } catch (\Exception $e) {
+                    $noMail[] = $uid;
+                }
+            }
+        }
+
+        $progress->finish();
+
+        if (empty($noMail)) {
+            $this->output->writeln("\n\nPassword successfully send to all users");
+        } else {
+            $table = new Table($this->output);
+            $table->setHeaders(['Username', 'Private key password']);
+            $this->output->writeln("\n\nCould not send password to following users:\n");
+            $rows = [];
+            foreach ($noMail as $uid) {
+                $rows[] = [$uid, $this->userPasswords[$uid]];
+            }
+            $table->setRows($rows);
+            $table->render();
+        }
+
+    }
+
+    /**
+     * create mail body for plain text and html mail
+     *
+     * @param string $password one-time encryption password
+     * @return array an array of the html mail body and the plain text mail body
+     */
+    protected function createMailBody($password) {
+
+        $html = new \OC_Template("encryption", "mail", "");
+        $html->assign ('password', $password);
+        $htmlMail = $html->fetchPage();
+
+        $plainText = new \OC_Template("encryption", "altmail", "");
+        $plainText->assign ('password', $password);
+        $plainTextMail = $plainText->fetchPage();
+
+        return [$htmlMail, $plainTextMail];
+    }
 
 }

apps/encryption/lib/AppInfo/Application.php

Indentation +213 added lines, -213 removed lines

@@ -50,217 +50,217 @@
 
 class Application extends \OCP\AppFramework\App {
 
-	/** @var IManager */
-	private $encryptionManager;
-	/** @var IConfig */
-	private $config;
-
-	/**
-	 * @param array $urlParams
-	 */
-	public function __construct($urlParams = []) {
-		parent::__construct('encryption', $urlParams);
-		$this->encryptionManager = \OC::$server->getEncryptionManager();
-		$this->config = \OC::$server->getConfig();
-		$this->registerServices();
-	}
-
-	public function setUp() {
-		if ($this->encryptionManager->isEnabled()) {
-			/** @var Setup $setup */
-			$setup = $this->getContainer()->query('UserSetup');
-			$setup->setupSystem();
-		}
-	}
-
-	/**
-	 * register hooks
-	 */
-	public function registerHooks() {
-		if (!$this->config->getSystemValueBool('maintenance')) {
-
-			$container = $this->getContainer();
-			$server = $container->getServer();
-			// Register our hooks and fire them.
-			$hookManager = new HookManager();
-
-			$hookManager->registerHook([
-				new UserHooks($container->query('KeyManager'),
-					$server->getUserManager(),
-					$server->getLogger(),
-					$container->query('UserSetup'),
-					$server->getUserSession(),
-					$container->query('Util'),
-					$container->query('Session'),
-					$container->query('Crypt'),
-					$container->query('Recovery'))
-			]);
-
-			$hookManager->fireHooks();
-
-		} else {
-			// Logout user if we are in maintenance to force re-login
-			$this->getContainer()->getServer()->getUserSession()->logout();
-		}
-	}
-
-	public function registerEncryptionModule() {
-		$container = $this->getContainer();
-
-
-		$this->encryptionManager->registerEncryptionModule(
-			Encryption::ID,
-			Encryption::DISPLAY_NAME,
-			function() use ($container) {
-
-			return new Encryption(
-				$container->query('Crypt'),
-				$container->query('KeyManager'),
-				$container->query('Util'),
-				$container->query('Session'),
-				$container->query('EncryptAll'),
-				$container->query('DecryptAll'),
-				$container->getServer()->getLogger(),
-				$container->getServer()->getL10N($container->getAppName())
-			);
-		});
-
-	}
-
-	public function registerServices() {
-		$container = $this->getContainer();
-
-		$container->registerService('Crypt',
-			function (IAppContainer $c) {
-				$server = $c->getServer();
-				return new Crypt($server->getLogger(),
-					$server->getUserSession(),
-					$server->getConfig(),
-					$server->getL10N($c->getAppName()));
-			});
-
-		$container->registerService('Session',
-			function (IAppContainer $c) {
-				$server = $c->getServer();
-				return new Session($server->getSession());
-			}
-		);
-
-		$container->registerService('KeyManager',
-			function (IAppContainer $c) {
-				$server = $c->getServer();
-
-				return new KeyManager($server->getEncryptionKeyStorage(),
-					$c->query('Crypt'),
-					$server->getConfig(),
-					$server->getUserSession(),
-					new Session($server->getSession()),
-					$server->getLogger(),
-					$c->query('Util')
-				);
-			});
-
-		$container->registerService('Recovery',
-			function (IAppContainer $c) {
-				$server = $c->getServer();
-
-				return new Recovery(
-					$server->getUserSession(),
-					$c->query('Crypt'),
-					$c->query('KeyManager'),
-					$server->getConfig(),
-					$server->getEncryptionFilesHelper(),
-					new View());
-			});
-
-		$container->registerService('RecoveryController', function (IAppContainer $c) {
-			$server = $c->getServer();
-			return new RecoveryController(
-				$c->getAppName(),
-				$server->getRequest(),
-				$server->getConfig(),
-				$server->getL10N($c->getAppName()),
-				$c->query('Recovery'));
-		});
-
-		$container->registerService('StatusController', function (IAppContainer $c) {
-			$server = $c->getServer();
-			return new StatusController(
-				$c->getAppName(),
-				$server->getRequest(),
-				$server->getL10N($c->getAppName()),
-				$c->query('Session'),
-				$server->getEncryptionManager()
-			);
-		});
-
-		$container->registerService('SettingsController', function (IAppContainer $c) {
-			$server = $c->getServer();
-			return new SettingsController(
-				$c->getAppName(),
-				$server->getRequest(),
-				$server->getL10N($c->getAppName()),
-				$server->getUserManager(),
-				$server->getUserSession(),
-				$c->query('KeyManager'),
-				$c->query('Crypt'),
-				$c->query('Session'),
-				$server->getSession(),
-				$c->query('Util')
-			);
-		});
-
-		$container->registerService('UserSetup',
-			function (IAppContainer $c) {
-				$server = $c->getServer();
-				return new Setup($server->getLogger(),
-					$server->getUserSession(),
-					$c->query('Crypt'),
-					$c->query('KeyManager'));
-			});
-
-		$container->registerService('Util',
-			function (IAppContainer $c) {
-				$server = $c->getServer();
-
-				return new Util(
-					new View(),
-					$c->query('Crypt'),
-					$server->getLogger(),
-					$server->getUserSession(),
-					$server->getConfig(),
-					$server->getUserManager());
-			});
-
-		$container->registerService('EncryptAll',
-			function (IAppContainer $c) {
-				$server = $c->getServer();
-				return new EncryptAll(
-					$c->query('UserSetup'),
-					$c->getServer()->getUserManager(),
-					new View(),
-					$c->query('KeyManager'),
-					$c->query('Util'),
-					$server->getConfig(),
-					$server->getMailer(),
-					$server->getL10N('encryption'),
-					new QuestionHelper(),
-					$server->getSecureRandom()
-				);
-			}
-		);
-
-		$container->registerService('DecryptAll',
-			function (IAppContainer $c) {
-				return new DecryptAll(
-					$c->query('Util'),
-					$c->query('KeyManager'),
-					$c->query('Crypt'),
-					$c->query('Session'),
-					new QuestionHelper()
-				);
-			}
-		);
-
-	}
+    /** @var IManager */
+    private $encryptionManager;
+    /** @var IConfig */
+    private $config;
+
+    /**
+     * @param array $urlParams
+     */
+    public function __construct($urlParams = []) {
+        parent::__construct('encryption', $urlParams);
+        $this->encryptionManager = \OC::$server->getEncryptionManager();
+        $this->config = \OC::$server->getConfig();
+        $this->registerServices();
+    }
+
+    public function setUp() {
+        if ($this->encryptionManager->isEnabled()) {
+            /** @var Setup $setup */
+            $setup = $this->getContainer()->query('UserSetup');
+            $setup->setupSystem();
+        }
+    }
+
+    /**
+     * register hooks
+     */
+    public function registerHooks() {
+        if (!$this->config->getSystemValueBool('maintenance')) {
+
+            $container = $this->getContainer();
+            $server = $container->getServer();
+            // Register our hooks and fire them.
+            $hookManager = new HookManager();
+
+            $hookManager->registerHook([
+                new UserHooks($container->query('KeyManager'),
+                    $server->getUserManager(),
+                    $server->getLogger(),
+                    $container->query('UserSetup'),
+                    $server->getUserSession(),
+                    $container->query('Util'),
+                    $container->query('Session'),
+                    $container->query('Crypt'),
+                    $container->query('Recovery'))
+            ]);
+
+            $hookManager->fireHooks();
+
+        } else {
+            // Logout user if we are in maintenance to force re-login
+            $this->getContainer()->getServer()->getUserSession()->logout();
+        }
+    }
+
+    public function registerEncryptionModule() {
+        $container = $this->getContainer();
+
+
+        $this->encryptionManager->registerEncryptionModule(
+            Encryption::ID,
+            Encryption::DISPLAY_NAME,
+            function() use ($container) {
+
+            return new Encryption(
+                $container->query('Crypt'),
+                $container->query('KeyManager'),
+                $container->query('Util'),
+                $container->query('Session'),
+                $container->query('EncryptAll'),
+                $container->query('DecryptAll'),
+                $container->getServer()->getLogger(),
+                $container->getServer()->getL10N($container->getAppName())
+            );
+        });
+
+    }
+
+    public function registerServices() {
+        $container = $this->getContainer();
+
+        $container->registerService('Crypt',
+            function (IAppContainer $c) {
+                $server = $c->getServer();
+                return new Crypt($server->getLogger(),
+                    $server->getUserSession(),
+                    $server->getConfig(),
+                    $server->getL10N($c->getAppName()));
+            });
+
+        $container->registerService('Session',
+            function (IAppContainer $c) {
+                $server = $c->getServer();
+                return new Session($server->getSession());
+            }
+        );
+
+        $container->registerService('KeyManager',
+            function (IAppContainer $c) {
+                $server = $c->getServer();
+
+                return new KeyManager($server->getEncryptionKeyStorage(),
+                    $c->query('Crypt'),
+                    $server->getConfig(),
+                    $server->getUserSession(),
+                    new Session($server->getSession()),
+                    $server->getLogger(),
+                    $c->query('Util')
+                );
+            });
+
+        $container->registerService('Recovery',
+            function (IAppContainer $c) {
+                $server = $c->getServer();
+
+                return new Recovery(
+                    $server->getUserSession(),
+                    $c->query('Crypt'),
+                    $c->query('KeyManager'),
+                    $server->getConfig(),
+                    $server->getEncryptionFilesHelper(),
+                    new View());
+            });
+
+        $container->registerService('RecoveryController', function (IAppContainer $c) {
+            $server = $c->getServer();
+            return new RecoveryController(
+                $c->getAppName(),
+                $server->getRequest(),
+                $server->getConfig(),
+                $server->getL10N($c->getAppName()),
+                $c->query('Recovery'));
+        });
+
+        $container->registerService('StatusController', function (IAppContainer $c) {
+            $server = $c->getServer();
+            return new StatusController(
+                $c->getAppName(),
+                $server->getRequest(),
+                $server->getL10N($c->getAppName()),
+                $c->query('Session'),
+                $server->getEncryptionManager()
+            );
+        });
+
+        $container->registerService('SettingsController', function (IAppContainer $c) {
+            $server = $c->getServer();
+            return new SettingsController(
+                $c->getAppName(),
+                $server->getRequest(),
+                $server->getL10N($c->getAppName()),
+                $server->getUserManager(),
+                $server->getUserSession(),
+                $c->query('KeyManager'),
+                $c->query('Crypt'),
+                $c->query('Session'),
+                $server->getSession(),
+                $c->query('Util')
+            );
+        });
+
+        $container->registerService('UserSetup',
+            function (IAppContainer $c) {
+                $server = $c->getServer();
+                return new Setup($server->getLogger(),
+                    $server->getUserSession(),
+                    $c->query('Crypt'),
+                    $c->query('KeyManager'));
+            });
+
+        $container->registerService('Util',
+            function (IAppContainer $c) {
+                $server = $c->getServer();
+
+                return new Util(
+                    new View(),
+                    $c->query('Crypt'),
+                    $server->getLogger(),
+                    $server->getUserSession(),
+                    $server->getConfig(),
+                    $server->getUserManager());
+            });
+
+        $container->registerService('EncryptAll',
+            function (IAppContainer $c) {
+                $server = $c->getServer();
+                return new EncryptAll(
+                    $c->query('UserSetup'),
+                    $c->getServer()->getUserManager(),
+                    new View(),
+                    $c->query('KeyManager'),
+                    $c->query('Util'),
+                    $server->getConfig(),
+                    $server->getMailer(),
+                    $server->getL10N('encryption'),
+                    new QuestionHelper(),
+                    $server->getSecureRandom()
+                );
+            }
+        );
+
+        $container->registerService('DecryptAll',
+            function (IAppContainer $c) {
+                return new DecryptAll(
+                    $c->query('Util'),
+                    $c->query('KeyManager'),
+                    $c->query('Crypt'),
+                    $c->query('Session'),
+                    new QuestionHelper()
+                );
+            }
+        );
+
+    }
 }

apps/encryption/lib/Recovery.php

Indentation +273 added lines, -273 removed lines

@@ -38,279 +38,279 @@
 class Recovery {
 
 
-	/**
-	 * @var null|IUser
-	 */
-	protected $user;
-	/**
-	 * @var Crypt
-	 */
-	protected $crypt;
-	/**
-	 * @var KeyManager
-	 */
-	private $keyManager;
-	/**
-	 * @var IConfig
-	 */
-	private $config;
-	/**
-	 * @var View
-	 */
-	private $view;
-	/**
-	 * @var IFile
-	 */
-	private $file;
-
-	/**
-	 * @param IUserSession $userSession
-	 * @param Crypt $crypt
-	 * @param KeyManager $keyManager
-	 * @param IConfig $config
-	 * @param IFile $file
-	 * @param View $view
-	 */
-	public function __construct(IUserSession $userSession,
-								Crypt $crypt,
-								KeyManager $keyManager,
-								IConfig $config,
-								IFile $file,
-								View $view) {
-		$this->user = ($userSession && $userSession->isLoggedIn()) ? $userSession->getUser() : false;
-		$this->crypt = $crypt;
-		$this->keyManager = $keyManager;
-		$this->config = $config;
-		$this->view = $view;
-		$this->file = $file;
-	}
-
-	/**
-	 * @param string $password
-	 * @return bool
-	 */
-	public function enableAdminRecovery($password) {
-		$appConfig = $this->config;
-		$keyManager = $this->keyManager;
-
-		if (!$keyManager->recoveryKeyExists()) {
-			$keyPair = $this->crypt->createKeyPair();
-			if(!is_array($keyPair)) {
-				return false;
-			}
-
-			$this->keyManager->setRecoveryKey($password, $keyPair);
-		}
-
-		if ($keyManager->checkRecoveryPassword($password)) {
-			$appConfig->setAppValue('encryption', 'recoveryAdminEnabled', 1);
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * change recovery key id
-	 *
-	 * @param string $newPassword
-	 * @param string $oldPassword
-	 * @return bool
-	 */
-	public function changeRecoveryKeyPassword($newPassword, $oldPassword) {
-		$recoveryKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
-		$decryptedRecoveryKey = $this->crypt->decryptPrivateKey($recoveryKey, $oldPassword);
-		if($decryptedRecoveryKey === false) {
-			return false;
-		}
-		$encryptedRecoveryKey = $this->crypt->encryptPrivateKey($decryptedRecoveryKey, $newPassword);
-		$header = $this->crypt->generateHeader();
-		if ($encryptedRecoveryKey) {
-			$this->keyManager->setSystemPrivateKey($this->keyManager->getRecoveryKeyId(), $header . $encryptedRecoveryKey);
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * @param string $recoveryPassword
-	 * @return bool
-	 */
-	public function disableAdminRecovery($recoveryPassword) {
-		$keyManager = $this->keyManager;
-
-		if ($keyManager->checkRecoveryPassword($recoveryPassword)) {
-			// Set recoveryAdmin as disabled
-			$this->config->setAppValue('encryption', 'recoveryAdminEnabled', 0);
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * check if recovery is enabled for user
-	 *
-	 * @param string $user if no user is given we check the current logged-in user
-	 *
-	 * @return bool
-	 */
-	public function isRecoveryEnabledForUser($user = '') {
-		$uid = $user === '' ? $this->user->getUID() : $user;
-		$recoveryMode = $this->config->getUserValue($uid,
-			'encryption',
-			'recoveryEnabled',
-			0);
-
-		return ($recoveryMode === '1');
-	}
-
-	/**
-	 * check if recovery is key is enabled by the administrator
-	 *
-	 * @return bool
-	 */
-	public function isRecoveryKeyEnabled() {
-		$enabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', 0);
-
-		return ($enabled === '1');
-	}
-
-	/**
-	 * @param string $value
-	 * @return bool
-	 */
-	public function setRecoveryForUser($value) {
-
-		try {
-			$this->config->setUserValue($this->user->getUID(),
-				'encryption',
-				'recoveryEnabled',
-				$value);
-
-			if ($value === '1') {
-				$this->addRecoveryKeys('/' . $this->user->getUID() . '/files/');
-			} else {
-				$this->removeRecoveryKeys('/' . $this->user->getUID() . '/files/');
-			}
-
-			return true;
-		} catch (PreConditionNotMetException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * add recovery key to all encrypted files
-	 * @param string $path
-	 */
-	private function addRecoveryKeys($path) {
-		$dirContent = $this->view->getDirectoryContent($path);
-		foreach ($dirContent as $item) {
-			$filePath = $item->getPath();
-			if ($item['type'] === 'dir') {
-				$this->addRecoveryKeys($filePath . '/');
-			} else {
-				$fileKey = $this->keyManager->getFileKey($filePath, $this->user->getUID());
-				if (!empty($fileKey)) {
-					$accessList = $this->file->getAccessList($filePath);
-					$publicKeys = [];
-					foreach ($accessList['users'] as $uid) {
-						$publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
-					}
-
-					$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->user->getUID());
-
-					$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
-					$this->keyManager->setAllFileKeys($filePath, $encryptedKeyfiles);
-				}
-			}
-		}
-	}
-
-	/**
-	 * remove recovery key to all encrypted files
-	 * @param string $path
-	 */
-	private function removeRecoveryKeys($path) {
-		$dirContent = $this->view->getDirectoryContent($path);
-		foreach ($dirContent as $item) {
-			$filePath = $item->getPath();
-			if ($item['type'] === 'dir') {
-				$this->removeRecoveryKeys($filePath . '/');
-			} else {
-				$this->keyManager->deleteShareKey($filePath, $this->keyManager->getRecoveryKeyId());
-			}
-		}
-	}
-
-	/**
-	 * recover users files with the recovery key
-	 *
-	 * @param string $recoveryPassword
-	 * @param string $user
-	 */
-	public function recoverUsersFiles($recoveryPassword, $user) {
-		$encryptedKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
-
-		$privateKey = $this->crypt->decryptPrivateKey($encryptedKey, $recoveryPassword);
-		if($privateKey !== false) {
-			$this->recoverAllFiles('/' . $user . '/files/', $privateKey, $user);
-		}
-	}
-
-	/**
-	 * recover users files
-	 *
-	 * @param string $path
-	 * @param string $privateKey
-	 * @param string $uid
-	 */
-	private function recoverAllFiles($path, $privateKey, $uid) {
-		$dirContent = $this->view->getDirectoryContent($path);
-
-		foreach ($dirContent as $item) {
-			// Get relative path from encryption/keyfiles
-			$filePath = $item->getPath();
-			if ($this->view->is_dir($filePath)) {
-				$this->recoverAllFiles($filePath . '/', $privateKey, $uid);
-			} else {
-				$this->recoverFile($filePath, $privateKey, $uid);
-			}
-		}
-
-	}
-
-	/**
-	 * recover file
-	 *
-	 * @param string $path
-	 * @param string $privateKey
-	 * @param string $uid
-	 */
-	private function recoverFile($path, $privateKey, $uid) {
-		$encryptedFileKey = $this->keyManager->getEncryptedFileKey($path);
-		$shareKey = $this->keyManager->getShareKey($path, $this->keyManager->getRecoveryKeyId());
-
-		if ($encryptedFileKey && $shareKey && $privateKey) {
-			$fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
-				$shareKey,
-				$privateKey);
-		}
-
-		if (!empty($fileKey)) {
-			$accessList = $this->file->getAccessList($path);
-			$publicKeys = [];
-			foreach ($accessList['users'] as $user) {
-				$publicKeys[$user] = $this->keyManager->getPublicKey($user);
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
-
-			$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
-			$this->keyManager->setAllFileKeys($path, $encryptedKeyfiles);
-		}
-
-	}
+    /**
+     * @var null|IUser
+     */
+    protected $user;
+    /**
+     * @var Crypt
+     */
+    protected $crypt;
+    /**
+     * @var KeyManager
+     */
+    private $keyManager;
+    /**
+     * @var IConfig
+     */
+    private $config;
+    /**
+     * @var View
+     */
+    private $view;
+    /**
+     * @var IFile
+     */
+    private $file;
+
+    /**
+     * @param IUserSession $userSession
+     * @param Crypt $crypt
+     * @param KeyManager $keyManager
+     * @param IConfig $config
+     * @param IFile $file
+     * @param View $view
+     */
+    public function __construct(IUserSession $userSession,
+                                Crypt $crypt,
+                                KeyManager $keyManager,
+                                IConfig $config,
+                                IFile $file,
+                                View $view) {
+        $this->user = ($userSession && $userSession->isLoggedIn()) ? $userSession->getUser() : false;
+        $this->crypt = $crypt;
+        $this->keyManager = $keyManager;
+        $this->config = $config;
+        $this->view = $view;
+        $this->file = $file;
+    }
+
+    /**
+     * @param string $password
+     * @return bool
+     */
+    public function enableAdminRecovery($password) {
+        $appConfig = $this->config;
+        $keyManager = $this->keyManager;
+
+        if (!$keyManager->recoveryKeyExists()) {
+            $keyPair = $this->crypt->createKeyPair();
+            if(!is_array($keyPair)) {
+                return false;
+            }
+
+            $this->keyManager->setRecoveryKey($password, $keyPair);
+        }
+
+        if ($keyManager->checkRecoveryPassword($password)) {
+            $appConfig->setAppValue('encryption', 'recoveryAdminEnabled', 1);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * change recovery key id
+     *
+     * @param string $newPassword
+     * @param string $oldPassword
+     * @return bool
+     */
+    public function changeRecoveryKeyPassword($newPassword, $oldPassword) {
+        $recoveryKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
+        $decryptedRecoveryKey = $this->crypt->decryptPrivateKey($recoveryKey, $oldPassword);
+        if($decryptedRecoveryKey === false) {
+            return false;
+        }
+        $encryptedRecoveryKey = $this->crypt->encryptPrivateKey($decryptedRecoveryKey, $newPassword);
+        $header = $this->crypt->generateHeader();
+        if ($encryptedRecoveryKey) {
+            $this->keyManager->setSystemPrivateKey($this->keyManager->getRecoveryKeyId(), $header . $encryptedRecoveryKey);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * @param string $recoveryPassword
+     * @return bool
+     */
+    public function disableAdminRecovery($recoveryPassword) {
+        $keyManager = $this->keyManager;
+
+        if ($keyManager->checkRecoveryPassword($recoveryPassword)) {
+            // Set recoveryAdmin as disabled
+            $this->config->setAppValue('encryption', 'recoveryAdminEnabled', 0);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * check if recovery is enabled for user
+     *
+     * @param string $user if no user is given we check the current logged-in user
+     *
+     * @return bool
+     */
+    public function isRecoveryEnabledForUser($user = '') {
+        $uid = $user === '' ? $this->user->getUID() : $user;
+        $recoveryMode = $this->config->getUserValue($uid,
+            'encryption',
+            'recoveryEnabled',
+            0);
+
+        return ($recoveryMode === '1');
+    }
+
+    /**
+     * check if recovery is key is enabled by the administrator
+     *
+     * @return bool
+     */
+    public function isRecoveryKeyEnabled() {
+        $enabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', 0);
+
+        return ($enabled === '1');
+    }
+
+    /**
+     * @param string $value
+     * @return bool
+     */
+    public function setRecoveryForUser($value) {
+
+        try {
+            $this->config->setUserValue($this->user->getUID(),
+                'encryption',
+                'recoveryEnabled',
+                $value);
+
+            if ($value === '1') {
+                $this->addRecoveryKeys('/' . $this->user->getUID() . '/files/');
+            } else {
+                $this->removeRecoveryKeys('/' . $this->user->getUID() . '/files/');
+            }
+
+            return true;
+        } catch (PreConditionNotMetException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * add recovery key to all encrypted files
+     * @param string $path
+     */
+    private function addRecoveryKeys($path) {
+        $dirContent = $this->view->getDirectoryContent($path);
+        foreach ($dirContent as $item) {
+            $filePath = $item->getPath();
+            if ($item['type'] === 'dir') {
+                $this->addRecoveryKeys($filePath . '/');
+            } else {
+                $fileKey = $this->keyManager->getFileKey($filePath, $this->user->getUID());
+                if (!empty($fileKey)) {
+                    $accessList = $this->file->getAccessList($filePath);
+                    $publicKeys = [];
+                    foreach ($accessList['users'] as $uid) {
+                        $publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
+                    }
+
+                    $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->user->getUID());
+
+                    $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
+                    $this->keyManager->setAllFileKeys($filePath, $encryptedKeyfiles);
+                }
+            }
+        }
+    }
+
+    /**
+     * remove recovery key to all encrypted files
+     * @param string $path
+     */
+    private function removeRecoveryKeys($path) {
+        $dirContent = $this->view->getDirectoryContent($path);
+        foreach ($dirContent as $item) {
+            $filePath = $item->getPath();
+            if ($item['type'] === 'dir') {
+                $this->removeRecoveryKeys($filePath . '/');
+            } else {
+                $this->keyManager->deleteShareKey($filePath, $this->keyManager->getRecoveryKeyId());
+            }
+        }
+    }
+
+    /**
+     * recover users files with the recovery key
+     *
+     * @param string $recoveryPassword
+     * @param string $user
+     */
+    public function recoverUsersFiles($recoveryPassword, $user) {
+        $encryptedKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
+
+        $privateKey = $this->crypt->decryptPrivateKey($encryptedKey, $recoveryPassword);
+        if($privateKey !== false) {
+            $this->recoverAllFiles('/' . $user . '/files/', $privateKey, $user);
+        }
+    }
+
+    /**
+     * recover users files
+     *
+     * @param string $path
+     * @param string $privateKey
+     * @param string $uid
+     */
+    private function recoverAllFiles($path, $privateKey, $uid) {
+        $dirContent = $this->view->getDirectoryContent($path);
+
+        foreach ($dirContent as $item) {
+            // Get relative path from encryption/keyfiles
+            $filePath = $item->getPath();
+            if ($this->view->is_dir($filePath)) {
+                $this->recoverAllFiles($filePath . '/', $privateKey, $uid);
+            } else {
+                $this->recoverFile($filePath, $privateKey, $uid);
+            }
+        }
+
+    }
+
+    /**
+     * recover file
+     *
+     * @param string $path
+     * @param string $privateKey
+     * @param string $uid
+     */
+    private function recoverFile($path, $privateKey, $uid) {
+        $encryptedFileKey = $this->keyManager->getEncryptedFileKey($path);
+        $shareKey = $this->keyManager->getShareKey($path, $this->keyManager->getRecoveryKeyId());
+
+        if ($encryptedFileKey && $shareKey && $privateKey) {
+            $fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
+                $shareKey,
+                $privateKey);
+        }
+
+        if (!empty($fileKey)) {
+            $accessList = $this->file->getAccessList($path);
+            $publicKeys = [];
+            foreach ($accessList['users'] as $user) {
+                $publicKeys[$user] = $this->keyManager->getPublicKey($user);
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
+
+            $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
+            $this->keyManager->setAllFileKeys($path, $encryptedKeyfiles);
+        }
+
+    }
 
 
 }

apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php

Indentation +801 added lines, -801 removed lines

@@ -57,805 +57,805 @@
 
 class CloudFederationProviderFiles implements ICloudFederationProvider {
 
-	/** @var IAppManager */
-	private $appManager;
-
-	/** @var FederatedShareProvider */
-	private $federatedShareProvider;
-
-	/** @var AddressHandler */
-	private $addressHandler;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IManager */
-	private $shareManager;
-
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-
-	/** @var IActivityManager */
-	private $activityManager;
-
-	/** @var INotificationManager */
-	private $notificationManager;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var ICloudFederationFactory */
-	private $cloudFederationFactory;
-
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
-
-	/** @var IDBConnection */
-	private $connection;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/**
-	 * CloudFederationProvider constructor.
-	 *
-	 * @param IAppManager $appManager
-	 * @param FederatedShareProvider $federatedShareProvider
-	 * @param AddressHandler $addressHandler
-	 * @param ILogger $logger
-	 * @param IUserManager $userManager
-	 * @param IManager $shareManager
-	 * @param ICloudIdManager $cloudIdManager
-	 * @param IActivityManager $activityManager
-	 * @param INotificationManager $notificationManager
-	 * @param IURLGenerator $urlGenerator
-	 * @param ICloudFederationFactory $cloudFederationFactory
-	 * @param ICloudFederationProviderManager $cloudFederationProviderManager
-	 * @param IDBConnection $connection
-	 * @param IGroupManager $groupManager
-	 */
-	public function __construct(IAppManager $appManager,
-								FederatedShareProvider $federatedShareProvider,
-								AddressHandler $addressHandler,
-								ILogger $logger,
-								IUserManager $userManager,
-								IManager $shareManager,
-								ICloudIdManager $cloudIdManager,
-								IActivityManager $activityManager,
-								INotificationManager $notificationManager,
-								IURLGenerator $urlGenerator,
-								ICloudFederationFactory $cloudFederationFactory,
-								ICloudFederationProviderManager $cloudFederationProviderManager,
-								IDBConnection $connection,
-								IGroupManager $groupManager
-	) {
-		$this->appManager = $appManager;
-		$this->federatedShareProvider = $federatedShareProvider;
-		$this->addressHandler = $addressHandler;
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->shareManager = $shareManager;
-		$this->cloudIdManager = $cloudIdManager;
-		$this->activityManager = $activityManager;
-		$this->notificationManager = $notificationManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->cloudFederationFactory = $cloudFederationFactory;
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-		$this->connection = $connection;
-		$this->groupManager = $groupManager;
-	}
-
-
-
-	/**
-	 * @return string
-	 */
-	public function getShareType() {
-		return 'file';
-	}
-
-	/**
-	 * share received from another server
-	 *
-	 * @param ICloudFederationShare $share
-	 * @return string provider specific unique ID of the share
-	 *
-	 * @throws ProviderCouldNotAddShareException
-	 * @throws \OCP\AppFramework\QueryException
-	 * @throws \OC\HintException
-	 * @since 14.0.0
-	 */
-	public function shareReceived(ICloudFederationShare $share) {
-
-		if (!$this->isS2SEnabled(true)) {
-			throw new ProviderCouldNotAddShareException('Server does not support federated cloud sharing', '', Http::STATUS_SERVICE_UNAVAILABLE);
-		}
-
-		$protocol = $share->getProtocol();
-		if ($protocol['name'] !== 'webdav') {
-			throw new ProviderCouldNotAddShareException('Unsupported protocol for data exchange.', '', Http::STATUS_NOT_IMPLEMENTED);
-		}
-
-		list($ownerUid, $remote) = $this->addressHandler->splitUserRemote($share->getOwner());
-		// for backward compatibility make sure that the remote url stored in the
-		// database ends with a trailing slash
-		if (substr($remote, -1) !== '/') {
-			$remote = $remote . '/';
-		}
-
-		$token = $share->getShareSecret();
-		$name = $share->getResourceName();
-		$owner = $share->getOwnerDisplayName();
-		$sharedBy = $share->getSharedByDisplayName();
-		$shareWith = $share->getShareWith();
-		$remoteId = $share->getProviderId();
-		$sharedByFederatedId = $share->getSharedBy();
-		$ownerFederatedId = $share->getOwner();
-		$shareType = $this->mapShareTypeToNextcloud($share->getShareType());
-
-		// if no explicit information about the person who created the share was send
-		// we assume that the share comes from the owner
-		if ($sharedByFederatedId === null) {
-			$sharedBy = $owner;
-			$sharedByFederatedId = $ownerFederatedId;
-		}
-
-		if ($remote && $token && $name && $owner && $remoteId && $shareWith) {
-
-			if (!Util::isValidFileName($name)) {
-				throw new ProviderCouldNotAddShareException('The mountpoint name contains invalid characters.', '', Http::STATUS_BAD_REQUEST);
-			}
-
-			// FIXME this should be a method in the user management instead
-			if ($shareType === Share::SHARE_TYPE_USER) {
-				$this->logger->debug('shareWith before, ' . $shareWith, ['app' => 'files_sharing']);
-				Util::emitHook(
-					'\OCA\Files_Sharing\API\Server2Server',
-					'preLoginNameUsedAsUserName',
-					['uid' => &$shareWith]
-				);
-				$this->logger->debug('shareWith after, ' . $shareWith, ['app' => 'files_sharing']);
-
-				if (!$this->userManager->userExists($shareWith)) {
-					throw new ProviderCouldNotAddShareException('User does not exists', '',Http::STATUS_BAD_REQUEST);
-				}
-
-				\OC_Util::setupFS($shareWith);
-			}
-
-			if ($shareType === Share::SHARE_TYPE_GROUP && !$this->groupManager->groupExists($shareWith)) {
-				throw new ProviderCouldNotAddShareException('Group does not exists', '',Http::STATUS_BAD_REQUEST);
-			}
-
-			$externalManager = new \OCA\Files_Sharing\External\Manager(
-				\OC::$server->getDatabaseConnection(),
-				Filesystem::getMountManager(),
-				Filesystem::getLoader(),
-				\OC::$server->getHTTPClientService(),
-				\OC::$server->getNotificationManager(),
-				\OC::$server->query(\OCP\OCS\IDiscoveryService::class),
-				\OC::$server->getCloudFederationProviderManager(),
-				\OC::$server->getCloudFederationFactory(),
-				\OC::$server->getGroupManager(),
-				\OC::$server->getUserManager(),
-				$shareWith
-			);
-
-			try {
-				$externalManager->addShare($remote, $token, '', $name, $owner, $shareType,false, $shareWith, $remoteId);
-				$shareId = \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share_external');
-
-				if ($shareType === Share::SHARE_TYPE_USER) {
-					$event = $this->activityManager->generateEvent();
-					$event->setApp('files_sharing')
-						->setType('remote_share')
-						->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/')])
-						->setAffectedUser($shareWith)
-						->setObject('remote_share', (int)$shareId, $name);
-					\OC::$server->getActivityManager()->publish($event);
-					$this->notifyAboutNewShare($shareWith, $shareId, $ownerFederatedId, $sharedByFederatedId, $name, $sharedBy, $owner);
-				} else {
-					$groupMembers = $this->groupManager->get($shareWith)->getUsers();
-					foreach ($groupMembers as $user) {
-						$event = $this->activityManager->generateEvent();
-						$event->setApp('files_sharing')
-							->setType('remote_share')
-							->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/')])
-							->setAffectedUser($user->getUID())
-							->setObject('remote_share', (int)$shareId, $name);
-						\OC::$server->getActivityManager()->publish($event);
-						$this->notifyAboutNewShare($user->getUID(), $shareId, $ownerFederatedId, $sharedByFederatedId, $name, $sharedBy, $owner);
-					}
-				}
-				return $shareId;
-			} catch (\Exception $e) {
-				$this->logger->logException($e, [
-					'message' => 'Server can not add remote share.',
-					'level' => ILogger::ERROR,
-					'app' => 'files_sharing'
-				]);
-				throw new ProviderCouldNotAddShareException('internal server error, was not able to add share from ' . $remote, '', HTTP::STATUS_INTERNAL_SERVER_ERROR);
-			}
-		}
-
-		throw new ProviderCouldNotAddShareException('server can not add remote share, missing parameter', '', HTTP::STATUS_BAD_REQUEST);
-
-	}
-
-	/**
-	 * notification received from another server
-	 *
-	 * @param string $notificationType (e.g. SHARE_ACCEPTED)
-	 * @param string $providerId id of the share
-	 * @param array $notification payload of the notification
-	 * @return array data send back to the sender
-	 *
-	 * @throws ActionNotSupportedException
-	 * @throws AuthenticationFailedException
-	 * @throws BadRequestException
-	 * @throws \OC\HintException
-	 * @since 14.0.0
-	 */
-	public function notificationReceived($notificationType, $providerId, array $notification) {
-
-		switch ($notificationType) {
-			case 'SHARE_ACCEPTED':
-				return $this->shareAccepted($providerId, $notification);
-			case 'SHARE_DECLINED':
-				return $this->shareDeclined($providerId, $notification);
-			case 'SHARE_UNSHARED':
-				return $this->unshare($providerId, $notification);
-			case 'REQUEST_RESHARE':
-				return $this->reshareRequested($providerId, $notification);
-			case 'RESHARE_UNDO':
-				return $this->undoReshare($providerId, $notification);
-			case 'RESHARE_CHANGE_PERMISSION':
-				return $this->updateResharePermissions($providerId, $notification);
-		}
-
-
-		throw new BadRequestException([$notificationType]);
-	}
-
-	/**
-	 * map OCM share type (strings) to Nextcloud internal share types (integer)
-	 *
-	 * @param string $shareType
-	 * @return int
-	 */
-	private function mapShareTypeToNextcloud($shareType) {
-		$result = Share::SHARE_TYPE_USER;
-		if ($shareType === 'group') {
-			$result = Share::SHARE_TYPE_GROUP;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * notify user about new federated share
-	 *
-	 * @param $shareWith
-	 * @param $shareId
-	 * @param $ownerFederatedId
-	 * @param $sharedByFederatedId
-	 * @param $name
-	 */
-	private function notifyAboutNewShare($shareWith, $shareId, $ownerFederatedId, $sharedByFederatedId, $name, $sharedBy, $owner) {
-		$notification = $this->notificationManager->createNotification();
-		$notification->setApp('files_sharing')
-			->setUser($shareWith)
-			->setDateTime(new \DateTime())
-			->setObject('remote_share', $shareId)
-			->setSubject('remote_share', [$ownerFederatedId, $sharedByFederatedId, trim($name, '/'), $sharedBy, $owner]);
-
-		$declineAction = $notification->createAction();
-		$declineAction->setLabel('decline')
-			->setLink($this->urlGenerator->getAbsoluteURL($this->urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'DELETE');
-		$notification->addAction($declineAction);
-
-		$acceptAction = $notification->createAction();
-		$acceptAction->setLabel('accept')
-			->setLink($this->urlGenerator->getAbsoluteURL($this->urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'POST');
-		$notification->addAction($acceptAction);
-
-		$this->notificationManager->notify($notification);
-	}
-
-	/**
-	 * process notification that the recipient accepted a share
-	 *
-	 * @param string $id
-	 * @param array $notification
-	 * @return array
-	 * @throws ActionNotSupportedException
-	 * @throws AuthenticationFailedException
-	 * @throws BadRequestException
-	 * @throws \OC\HintException
-	 */
-	private function shareAccepted($id, array $notification) {
-
-		if (!$this->isS2SEnabled()) {
-			throw new ActionNotSupportedException('Server does not support federated cloud sharing');
-		}
-
-		if (!isset($notification['sharedSecret'])) {
-			throw new BadRequestException(['sharedSecret']);
-		}
-
-		$token = $notification['sharedSecret'];
-
-		$share = $this->federatedShareProvider->getShareById($id);
-
-		$this->verifyShare($share, $token);
-		$this->executeAcceptShare($share);
-		if ($share->getShareOwner() !== $share->getSharedBy()) {
-			list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy());
-			$remoteId = $this->federatedShareProvider->getRemoteId($share);
-			$notification = $this->cloudFederationFactory->getCloudFederationNotification();
-			$notification->setMessage(
-				'SHARE_ACCEPTED',
-				'file',
-				$remoteId,
-				[
-					'sharedSecret' => $token,
-					'message' => 'Recipient accepted the re-share'
-				]
-
-			);
-			$this->cloudFederationProviderManager->sendNotification($remote, $notification);
-
-		}
-
-		return [];
-	}
-
-	/**
-	 * @param IShare $share
-	 * @throws ShareNotFound
-	 */
-	protected function executeAcceptShare(IShare $share) {
-		try {
-			$fileId = (int)$share->getNode()->getId();
-			list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId);
-		} catch (\Exception $e) {
-			throw new ShareNotFound();
-		}
-
-		$event = $this->activityManager->generateEvent();
-		$event->setApp('files_sharing')
-			->setType('remote_share')
-			->setAffectedUser($this->getCorrectUid($share))
-			->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_ACCEPTED, [$share->getSharedWith(), [$fileId => $file]])
-			->setObject('files', $fileId, $file)
-			->setLink($link);
-		$this->activityManager->publish($event);
-	}
-
-	/**
-	 * process notification that the recipient declined a share
-	 *
-	 * @param string $id
-	 * @param array $notification
-	 * @return array
-	 * @throws ActionNotSupportedException
-	 * @throws AuthenticationFailedException
-	 * @throws BadRequestException
-	 * @throws ShareNotFound
-	 * @throws \OC\HintException
-	 *
-	 */
-	protected function shareDeclined($id, array $notification) {
-
-		if (!$this->isS2SEnabled()) {
-			throw new ActionNotSupportedException('Server does not support federated cloud sharing');
-		}
-
-		if (!isset($notification['sharedSecret'])) {
-			throw new BadRequestException(['sharedSecret']);
-		}
-
-		$token = $notification['sharedSecret'];
-
-		$share = $this->federatedShareProvider->getShareById($id);
-
-		$this->verifyShare($share, $token);
-
-		if ($share->getShareOwner() !== $share->getSharedBy()) {
-			list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy());
-			$remoteId = $this->federatedShareProvider->getRemoteId($share);
-			$notification = $this->cloudFederationFactory->getCloudFederationNotification();
-			$notification->setMessage(
-				'SHARE_DECLINED',
-				'file',
-				$remoteId,
-				[
-					'sharedSecret' => $token,
-					'message' => 'Recipient declined the re-share'
-				]
-
-			);
-			$this->cloudFederationProviderManager->sendNotification($remote, $notification);
-		}
-
-		$this->executeDeclineShare($share);
-
-		return [];
-
-	}
-
-	/**
-	 * delete declined share and create a activity
-	 *
-	 * @param IShare $share
-	 * @throws ShareNotFound
-	 */
-	protected function executeDeclineShare(IShare $share) {
-		$this->federatedShareProvider->removeShareFromTable($share);
-
-		try {
-			$fileId = (int)$share->getNode()->getId();
-			list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId);
-		} catch (\Exception $e) {
-			throw new ShareNotFound();
-		}
-
-		$event = $this->activityManager->generateEvent();
-		$event->setApp('files_sharing')
-			->setType('remote_share')
-			->setAffectedUser($this->getCorrectUid($share))
-			->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_DECLINED, [$share->getSharedWith(), [$fileId => $file]])
-			->setObject('files', $fileId, $file)
-			->setLink($link);
-		$this->activityManager->publish($event);
-
-	}
-
-	/**
-	 * received the notification that the owner unshared a file from you
-	 *
-	 * @param string $id
-	 * @param array $notification
-	 * @return array
-	 * @throws AuthenticationFailedException
-	 * @throws BadRequestException
-	 */
-	private function undoReshare($id, array $notification) {
-		if (!isset($notification['sharedSecret'])) {
-			throw new BadRequestException(['sharedSecret']);
-		}
-		$token = $notification['sharedSecret'];
-
-		$share = $this->federatedShareProvider->getShareById($id);
-
-		$this->verifyShare($share, $token);
-		$this->federatedShareProvider->removeShareFromTable($share);
-		return [];
-	}
-
-	/**
-	 * unshare file from self
-	 *
-	 * @param string $id
-	 * @param array $notification
-	 * @return array
-	 * @throws ActionNotSupportedException
-	 * @throws BadRequestException
-	 */
-	private function unshare($id, array $notification) {
-
-		if (!$this->isS2SEnabled(true)) {
-			throw new ActionNotSupportedException("incoming shares disabled!");
-		}
-
-		if (!isset($notification['sharedSecret'])) {
-			throw new BadRequestException(['sharedSecret']);
-		}
-		$token = $notification['sharedSecret'];
-
-		$qb = $this->connection->getQueryBuilder();
-		$qb->select('*')
-			->from('share_external')
-			->where(
-				$qb->expr()->andX(
-					$qb->expr()->eq('remote_id', $qb->createNamedParameter($id)),
-					$qb->expr()->eq('share_token', $qb->createNamedParameter($token))
-				)
-			);
-
-		$result = $qb->execute();
-		$share = $result->fetch();
-		$result->closeCursor();
-
-		if ($token && $id && !empty($share)) {
-
-			$remote = $this->cleanupRemote($share['remote']);
-
-			$owner = $this->cloudIdManager->getCloudId($share['owner'], $remote);
-			$mountpoint = $share['mountpoint'];
-			$user = $share['user'];
-
-			$qb = $this->connection->getQueryBuilder();
-			$qb->delete('share_external')
-				->where(
-					$qb->expr()->andX(
-						$qb->expr()->eq('remote_id', $qb->createNamedParameter($id)),
-						$qb->expr()->eq('share_token', $qb->createNamedParameter($token))
-					)
-				);
-
-			$qb->execute();
-
-			// delete all child in case of a group share
-			$qb = $this->connection->getQueryBuilder();
-			$qb->delete('share_external')
-				->where($qb->expr()->eq('parent', $qb->createNamedParameter((int)$share['id'])));
-			$qb->execute();
-
-			if ((int)$share['share_type'] === Share::SHARE_TYPE_USER) {
-				if ($share['accepted']) {
-					$path = trim($mountpoint, '/');
-				} else {
-					$path = trim($share['name'], '/');
-				}
-				$notification = $this->notificationManager->createNotification();
-				$notification->setApp('files_sharing')
-					->setUser($share['user'])
-					->setObject('remote_share', (int)$share['id']);
-				$this->notificationManager->markProcessed($notification);
-
-				$event = $this->activityManager->generateEvent();
-				$event->setApp('files_sharing')
-					->setType('remote_share')
-					->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_UNSHARED, [$owner->getId(), $path])
-					->setAffectedUser($user)
-					->setObject('remote_share', (int)$share['id'], $path);
-				\OC::$server->getActivityManager()->publish($event);
-			}
-		}
-
-		return [];
-	}
-
-	private function cleanupRemote($remote) {
-		$remote = substr($remote, strpos($remote, '://') + 3);
-
-		return rtrim($remote, '/');
-	}
-
-	/**
-	 * recipient of a share request to re-share the file with another user
-	 *
-	 * @param string $id
-	 * @param array $notification
-	 * @return array
-	 * @throws AuthenticationFailedException
-	 * @throws BadRequestException
-	 * @throws ProviderCouldNotAddShareException
-	 * @throws ShareNotFound
-	 */
-	protected function reshareRequested($id, array $notification) {
-
-		if (!isset($notification['sharedSecret'])) {
-			throw new BadRequestException(['sharedSecret']);
-		}
-		$token = $notification['sharedSecret'];
-
-		if (!isset($notification['shareWith'])) {
-			throw new BadRequestException(['shareWith']);
-		}
-		$shareWith = $notification['shareWith'];
-
-		if (!isset($notification['senderId'])) {
-			throw new BadRequestException(['senderId']);
-		}
-		$senderId = $notification['senderId'];
-
-		$share = $this->federatedShareProvider->getShareById($id);
-		// don't allow to share a file back to the owner
-		try {
-			list($user, $remote) = $this->addressHandler->splitUserRemote($shareWith);
-			$owner = $share->getShareOwner();
-			$currentServer = $this->addressHandler->generateRemoteURL();
-			if ($this->addressHandler->compareAddresses($user, $remote, $owner, $currentServer)) {
-				throw new ProviderCouldNotAddShareException('Resharing back to the owner is not allowed: ' . $id);
-			}
-		} catch (\Exception $e) {
-			throw new ProviderCouldNotAddShareException($e->getMessage());
-		}
-
-		$this->verifyShare($share, $token);
-
-		// check if re-sharing is allowed
-		if ($share->getPermissions() & Constants::PERMISSION_SHARE) {
-			// the recipient of the initial share is now the initiator for the re-share
-			$share->setSharedBy($share->getSharedWith());
-			$share->setSharedWith($shareWith);
-			$result = $this->federatedShareProvider->create($share);
-			$this->federatedShareProvider->storeRemoteId((int)$result->getId(), $senderId);
-			return ['token' => $result->getToken(), 'providerId' => $result->getId()];
-		} else {
-			throw new ProviderCouldNotAddShareException('resharing not allowed for share: ' . $id);
-		}
-
-	}
-
-	/**
-	 * update permission of a re-share so that the share dialog shows the right
-	 * permission if the owner or the sender changes the permission
-	 *
-	 * @param string $id
-	 * @param array $notification
-	 * @return array
-	 * @throws AuthenticationFailedException
-	 * @throws BadRequestException
-	 */
-	protected function updateResharePermissions($id, array $notification) {
-
-		if (!isset($notification['sharedSecret'])) {
-			throw new BadRequestException(['sharedSecret']);
-		}
-		$token = $notification['sharedSecret'];
-
-		if (!isset($notification['permission'])) {
-			throw new BadRequestException(['permission']);
-		}
-		$ocmPermissions = $notification['permission'];
-
-		$share = $this->federatedShareProvider->getShareById($id);
-
-		$ncPermission = $this->ocmPermissions2ncPermissions($ocmPermissions);
-
-		$this->verifyShare($share, $token);
-		$this->updatePermissionsInDatabase($share, $ncPermission);
-
-		return [];
-	}
-
-	/**
-	 * translate OCM Permissions to Nextcloud permissions
-	 *
-	 * @param array $ocmPermissions
-	 * @return int
-	 * @throws BadRequestException
-	 */
-	protected function ocmPermissions2ncPermissions(array $ocmPermissions) {
-		$ncPermissions = 0;
-		foreach($ocmPermissions as $permission) {
-			switch (strtolower($permission)) {
-				case 'read':
-					$ncPermissions += Constants::PERMISSION_READ;
-					break;
-				case 'write':
-					$ncPermissions += Constants::PERMISSION_CREATE + Constants::PERMISSION_UPDATE;
-					break;
-				case 'share':
-					$ncPermissions += Constants::PERMISSION_SHARE;
-					break;
-				default:
-					throw new BadRequestException(['permission']);
-			}
-
-		}
-
-		return $ncPermissions;
-	}
-
-	/**
-	 * update permissions in database
-	 *
-	 * @param IShare $share
-	 * @param int $permissions
-	 */
-	protected function updatePermissionsInDatabase(IShare $share, $permissions) {
-		$query = $this->connection->getQueryBuilder();
-		$query->update('share')
-			->where($query->expr()->eq('id', $query->createNamedParameter($share->getId())))
-			->set('permissions', $query->createNamedParameter($permissions))
-			->execute();
-	}
-
-
-	/**
-	 * get file
-	 *
-	 * @param string $user
-	 * @param int $fileSource
-	 * @return array with internal path of the file and a absolute link to it
-	 */
-	private function getFile($user, $fileSource) {
-		\OC_Util::setupFS($user);
-
-		try {
-			$file = Filesystem::getPath($fileSource);
-		} catch (NotFoundException $e) {
-			$file = null;
-		}
-		$args = Filesystem::is_dir($file) ? ['dir' => $file] : ['dir' => dirname($file), 'scrollto' => $file];
-		$link = Util::linkToAbsolute('files', 'index.php', $args);
-
-		return [$file, $link];
-
-	}
-
-	/**
-	 * check if we are the initiator or the owner of a re-share and return the correct UID
-	 *
-	 * @param IShare $share
-	 * @return string
-	 */
-	protected function getCorrectUid(IShare $share) {
-		if ($this->userManager->userExists($share->getShareOwner())) {
-			return $share->getShareOwner();
-		}
-
-		return $share->getSharedBy();
-	}
-
-
-
-	/**
-	 * check if we got the right share
-	 *
-	 * @param IShare $share
-	 * @param string $token
-	 * @return bool
-	 * @throws AuthenticationFailedException
-	 */
-	protected function verifyShare(IShare $share, $token) {
-		if (
-			$share->getShareType() === FederatedShareProvider::SHARE_TYPE_REMOTE &&
-			$share->getToken() === $token
-		) {
-			return true;
-		}
-
-		if ($share->getShareType() === IShare::TYPE_CIRCLE) {
-			try {
-				$knownShare = $this->shareManager->getShareByToken($token);
-				if ($knownShare->getId() === $share->getId()) {
-					return true;
-				}
-			} catch (ShareNotFound $e) {
-			}
-		}
-
-		throw new AuthenticationFailedException();
-	}
-
-
-
-	/**
-	 * check if server-to-server sharing is enabled
-	 *
-	 * @param bool $incoming
-	 * @return bool
-	 */
-	private function isS2SEnabled($incoming = false) {
-
-		$result = $this->appManager->isEnabledForUser('files_sharing');
-
-		if ($incoming) {
-			$result = $result && $this->federatedShareProvider->isIncomingServer2serverShareEnabled();
-		} else {
-			$result = $result && $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
-		}
-
-		return $result;
-	}
-
-
-	/**
-	 * get the supported share types, e.g. "user", "group", etc.
-	 *
-	 * @return array
-	 *
-	 * @since 14.0.0
-	 */
-	public function getSupportedShareTypes() {
-		return ['user', 'group'];
-	}
+    /** @var IAppManager */
+    private $appManager;
+
+    /** @var FederatedShareProvider */
+    private $federatedShareProvider;
+
+    /** @var AddressHandler */
+    private $addressHandler;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IManager */
+    private $shareManager;
+
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
+
+    /** @var IActivityManager */
+    private $activityManager;
+
+    /** @var INotificationManager */
+    private $notificationManager;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /** @var ICloudFederationFactory */
+    private $cloudFederationFactory;
+
+    /** @var ICloudFederationProviderManager */
+    private $cloudFederationProviderManager;
+
+    /** @var IDBConnection */
+    private $connection;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /**
+     * CloudFederationProvider constructor.
+     *
+     * @param IAppManager $appManager
+     * @param FederatedShareProvider $federatedShareProvider
+     * @param AddressHandler $addressHandler
+     * @param ILogger $logger
+     * @param IUserManager $userManager
+     * @param IManager $shareManager
+     * @param ICloudIdManager $cloudIdManager
+     * @param IActivityManager $activityManager
+     * @param INotificationManager $notificationManager
+     * @param IURLGenerator $urlGenerator
+     * @param ICloudFederationFactory $cloudFederationFactory
+     * @param ICloudFederationProviderManager $cloudFederationProviderManager
+     * @param IDBConnection $connection
+     * @param IGroupManager $groupManager
+     */
+    public function __construct(IAppManager $appManager,
+                                FederatedShareProvider $federatedShareProvider,
+                                AddressHandler $addressHandler,
+                                ILogger $logger,
+                                IUserManager $userManager,
+                                IManager $shareManager,
+                                ICloudIdManager $cloudIdManager,
+                                IActivityManager $activityManager,
+                                INotificationManager $notificationManager,
+                                IURLGenerator $urlGenerator,
+                                ICloudFederationFactory $cloudFederationFactory,
+                                ICloudFederationProviderManager $cloudFederationProviderManager,
+                                IDBConnection $connection,
+                                IGroupManager $groupManager
+    ) {
+        $this->appManager = $appManager;
+        $this->federatedShareProvider = $federatedShareProvider;
+        $this->addressHandler = $addressHandler;
+        $this->logger = $logger;
+        $this->userManager = $userManager;
+        $this->shareManager = $shareManager;
+        $this->cloudIdManager = $cloudIdManager;
+        $this->activityManager = $activityManager;
+        $this->notificationManager = $notificationManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->cloudFederationFactory = $cloudFederationFactory;
+        $this->cloudFederationProviderManager = $cloudFederationProviderManager;
+        $this->connection = $connection;
+        $this->groupManager = $groupManager;
+    }
+
+
+
+    /**
+     * @return string
+     */
+    public function getShareType() {
+        return 'file';
+    }
+
+    /**
+     * share received from another server
+     *
+     * @param ICloudFederationShare $share
+     * @return string provider specific unique ID of the share
+     *
+     * @throws ProviderCouldNotAddShareException
+     * @throws \OCP\AppFramework\QueryException
+     * @throws \OC\HintException
+     * @since 14.0.0
+     */
+    public function shareReceived(ICloudFederationShare $share) {
+
+        if (!$this->isS2SEnabled(true)) {
+            throw new ProviderCouldNotAddShareException('Server does not support federated cloud sharing', '', Http::STATUS_SERVICE_UNAVAILABLE);
+        }
+
+        $protocol = $share->getProtocol();
+        if ($protocol['name'] !== 'webdav') {
+            throw new ProviderCouldNotAddShareException('Unsupported protocol for data exchange.', '', Http::STATUS_NOT_IMPLEMENTED);
+        }
+
+        list($ownerUid, $remote) = $this->addressHandler->splitUserRemote($share->getOwner());
+        // for backward compatibility make sure that the remote url stored in the
+        // database ends with a trailing slash
+        if (substr($remote, -1) !== '/') {
+            $remote = $remote . '/';
+        }
+
+        $token = $share->getShareSecret();
+        $name = $share->getResourceName();
+        $owner = $share->getOwnerDisplayName();
+        $sharedBy = $share->getSharedByDisplayName();
+        $shareWith = $share->getShareWith();
+        $remoteId = $share->getProviderId();
+        $sharedByFederatedId = $share->getSharedBy();
+        $ownerFederatedId = $share->getOwner();
+        $shareType = $this->mapShareTypeToNextcloud($share->getShareType());
+
+        // if no explicit information about the person who created the share was send
+        // we assume that the share comes from the owner
+        if ($sharedByFederatedId === null) {
+            $sharedBy = $owner;
+            $sharedByFederatedId = $ownerFederatedId;
+        }
+
+        if ($remote && $token && $name && $owner && $remoteId && $shareWith) {
+
+            if (!Util::isValidFileName($name)) {
+                throw new ProviderCouldNotAddShareException('The mountpoint name contains invalid characters.', '', Http::STATUS_BAD_REQUEST);
+            }
+
+            // FIXME this should be a method in the user management instead
+            if ($shareType === Share::SHARE_TYPE_USER) {
+                $this->logger->debug('shareWith before, ' . $shareWith, ['app' => 'files_sharing']);
+                Util::emitHook(
+                    '\OCA\Files_Sharing\API\Server2Server',
+                    'preLoginNameUsedAsUserName',
+                    ['uid' => &$shareWith]
+                );
+                $this->logger->debug('shareWith after, ' . $shareWith, ['app' => 'files_sharing']);
+
+                if (!$this->userManager->userExists($shareWith)) {
+                    throw new ProviderCouldNotAddShareException('User does not exists', '',Http::STATUS_BAD_REQUEST);
+                }
+
+                \OC_Util::setupFS($shareWith);
+            }
+
+            if ($shareType === Share::SHARE_TYPE_GROUP && !$this->groupManager->groupExists($shareWith)) {
+                throw new ProviderCouldNotAddShareException('Group does not exists', '',Http::STATUS_BAD_REQUEST);
+            }
+
+            $externalManager = new \OCA\Files_Sharing\External\Manager(
+                \OC::$server->getDatabaseConnection(),
+                Filesystem::getMountManager(),
+                Filesystem::getLoader(),
+                \OC::$server->getHTTPClientService(),
+                \OC::$server->getNotificationManager(),
+                \OC::$server->query(\OCP\OCS\IDiscoveryService::class),
+                \OC::$server->getCloudFederationProviderManager(),
+                \OC::$server->getCloudFederationFactory(),
+                \OC::$server->getGroupManager(),
+                \OC::$server->getUserManager(),
+                $shareWith
+            );
+
+            try {
+                $externalManager->addShare($remote, $token, '', $name, $owner, $shareType,false, $shareWith, $remoteId);
+                $shareId = \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share_external');
+
+                if ($shareType === Share::SHARE_TYPE_USER) {
+                    $event = $this->activityManager->generateEvent();
+                    $event->setApp('files_sharing')
+                        ->setType('remote_share')
+                        ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/')])
+                        ->setAffectedUser($shareWith)
+                        ->setObject('remote_share', (int)$shareId, $name);
+                    \OC::$server->getActivityManager()->publish($event);
+                    $this->notifyAboutNewShare($shareWith, $shareId, $ownerFederatedId, $sharedByFederatedId, $name, $sharedBy, $owner);
+                } else {
+                    $groupMembers = $this->groupManager->get($shareWith)->getUsers();
+                    foreach ($groupMembers as $user) {
+                        $event = $this->activityManager->generateEvent();
+                        $event->setApp('files_sharing')
+                            ->setType('remote_share')
+                            ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/')])
+                            ->setAffectedUser($user->getUID())
+                            ->setObject('remote_share', (int)$shareId, $name);
+                        \OC::$server->getActivityManager()->publish($event);
+                        $this->notifyAboutNewShare($user->getUID(), $shareId, $ownerFederatedId, $sharedByFederatedId, $name, $sharedBy, $owner);
+                    }
+                }
+                return $shareId;
+            } catch (\Exception $e) {
+                $this->logger->logException($e, [
+                    'message' => 'Server can not add remote share.',
+                    'level' => ILogger::ERROR,
+                    'app' => 'files_sharing'
+                ]);
+                throw new ProviderCouldNotAddShareException('internal server error, was not able to add share from ' . $remote, '', HTTP::STATUS_INTERNAL_SERVER_ERROR);
+            }
+        }
+
+        throw new ProviderCouldNotAddShareException('server can not add remote share, missing parameter', '', HTTP::STATUS_BAD_REQUEST);
+
+    }
+
+    /**
+     * notification received from another server
+     *
+     * @param string $notificationType (e.g. SHARE_ACCEPTED)
+     * @param string $providerId id of the share
+     * @param array $notification payload of the notification
+     * @return array data send back to the sender
+     *
+     * @throws ActionNotSupportedException
+     * @throws AuthenticationFailedException
+     * @throws BadRequestException
+     * @throws \OC\HintException
+     * @since 14.0.0
+     */
+    public function notificationReceived($notificationType, $providerId, array $notification) {
+
+        switch ($notificationType) {
+            case 'SHARE_ACCEPTED':
+                return $this->shareAccepted($providerId, $notification);
+            case 'SHARE_DECLINED':
+                return $this->shareDeclined($providerId, $notification);
+            case 'SHARE_UNSHARED':
+                return $this->unshare($providerId, $notification);
+            case 'REQUEST_RESHARE':
+                return $this->reshareRequested($providerId, $notification);
+            case 'RESHARE_UNDO':
+                return $this->undoReshare($providerId, $notification);
+            case 'RESHARE_CHANGE_PERMISSION':
+                return $this->updateResharePermissions($providerId, $notification);
+        }
+
+
+        throw new BadRequestException([$notificationType]);
+    }
+
+    /**
+     * map OCM share type (strings) to Nextcloud internal share types (integer)
+     *
+     * @param string $shareType
+     * @return int
+     */
+    private function mapShareTypeToNextcloud($shareType) {
+        $result = Share::SHARE_TYPE_USER;
+        if ($shareType === 'group') {
+            $result = Share::SHARE_TYPE_GROUP;
+        }
+
+        return $result;
+    }
+
+    /**
+     * notify user about new federated share
+     *
+     * @param $shareWith
+     * @param $shareId
+     * @param $ownerFederatedId
+     * @param $sharedByFederatedId
+     * @param $name
+     */
+    private function notifyAboutNewShare($shareWith, $shareId, $ownerFederatedId, $sharedByFederatedId, $name, $sharedBy, $owner) {
+        $notification = $this->notificationManager->createNotification();
+        $notification->setApp('files_sharing')
+            ->setUser($shareWith)
+            ->setDateTime(new \DateTime())
+            ->setObject('remote_share', $shareId)
+            ->setSubject('remote_share', [$ownerFederatedId, $sharedByFederatedId, trim($name, '/'), $sharedBy, $owner]);
+
+        $declineAction = $notification->createAction();
+        $declineAction->setLabel('decline')
+            ->setLink($this->urlGenerator->getAbsoluteURL($this->urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'DELETE');
+        $notification->addAction($declineAction);
+
+        $acceptAction = $notification->createAction();
+        $acceptAction->setLabel('accept')
+            ->setLink($this->urlGenerator->getAbsoluteURL($this->urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'POST');
+        $notification->addAction($acceptAction);
+
+        $this->notificationManager->notify($notification);
+    }
+
+    /**
+     * process notification that the recipient accepted a share
+     *
+     * @param string $id
+     * @param array $notification
+     * @return array
+     * @throws ActionNotSupportedException
+     * @throws AuthenticationFailedException
+     * @throws BadRequestException
+     * @throws \OC\HintException
+     */
+    private function shareAccepted($id, array $notification) {
+
+        if (!$this->isS2SEnabled()) {
+            throw new ActionNotSupportedException('Server does not support federated cloud sharing');
+        }
+
+        if (!isset($notification['sharedSecret'])) {
+            throw new BadRequestException(['sharedSecret']);
+        }
+
+        $token = $notification['sharedSecret'];
+
+        $share = $this->federatedShareProvider->getShareById($id);
+
+        $this->verifyShare($share, $token);
+        $this->executeAcceptShare($share);
+        if ($share->getShareOwner() !== $share->getSharedBy()) {
+            list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy());
+            $remoteId = $this->federatedShareProvider->getRemoteId($share);
+            $notification = $this->cloudFederationFactory->getCloudFederationNotification();
+            $notification->setMessage(
+                'SHARE_ACCEPTED',
+                'file',
+                $remoteId,
+                [
+                    'sharedSecret' => $token,
+                    'message' => 'Recipient accepted the re-share'
+                ]
+
+            );
+            $this->cloudFederationProviderManager->sendNotification($remote, $notification);
+
+        }
+
+        return [];
+    }
+
+    /**
+     * @param IShare $share
+     * @throws ShareNotFound
+     */
+    protected function executeAcceptShare(IShare $share) {
+        try {
+            $fileId = (int)$share->getNode()->getId();
+            list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId);
+        } catch (\Exception $e) {
+            throw new ShareNotFound();
+        }
+
+        $event = $this->activityManager->generateEvent();
+        $event->setApp('files_sharing')
+            ->setType('remote_share')
+            ->setAffectedUser($this->getCorrectUid($share))
+            ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_ACCEPTED, [$share->getSharedWith(), [$fileId => $file]])
+            ->setObject('files', $fileId, $file)
+            ->setLink($link);
+        $this->activityManager->publish($event);
+    }
+
+    /**
+     * process notification that the recipient declined a share
+     *
+     * @param string $id
+     * @param array $notification
+     * @return array
+     * @throws ActionNotSupportedException
+     * @throws AuthenticationFailedException
+     * @throws BadRequestException
+     * @throws ShareNotFound
+     * @throws \OC\HintException
+     *
+     */
+    protected function shareDeclined($id, array $notification) {
+
+        if (!$this->isS2SEnabled()) {
+            throw new ActionNotSupportedException('Server does not support federated cloud sharing');
+        }
+
+        if (!isset($notification['sharedSecret'])) {
+            throw new BadRequestException(['sharedSecret']);
+        }
+
+        $token = $notification['sharedSecret'];
+
+        $share = $this->federatedShareProvider->getShareById($id);
+
+        $this->verifyShare($share, $token);
+
+        if ($share->getShareOwner() !== $share->getSharedBy()) {
+            list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy());
+            $remoteId = $this->federatedShareProvider->getRemoteId($share);
+            $notification = $this->cloudFederationFactory->getCloudFederationNotification();
+            $notification->setMessage(
+                'SHARE_DECLINED',
+                'file',
+                $remoteId,
+                [
+                    'sharedSecret' => $token,
+                    'message' => 'Recipient declined the re-share'
+                ]
+
+            );
+            $this->cloudFederationProviderManager->sendNotification($remote, $notification);
+        }
+
+        $this->executeDeclineShare($share);
+
+        return [];
+
+    }
+
+    /**
+     * delete declined share and create a activity
+     *
+     * @param IShare $share
+     * @throws ShareNotFound
+     */
+    protected function executeDeclineShare(IShare $share) {
+        $this->federatedShareProvider->removeShareFromTable($share);
+
+        try {
+            $fileId = (int)$share->getNode()->getId();
+            list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId);
+        } catch (\Exception $e) {
+            throw new ShareNotFound();
+        }
+
+        $event = $this->activityManager->generateEvent();
+        $event->setApp('files_sharing')
+            ->setType('remote_share')
+            ->setAffectedUser($this->getCorrectUid($share))
+            ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_DECLINED, [$share->getSharedWith(), [$fileId => $file]])
+            ->setObject('files', $fileId, $file)
+            ->setLink($link);
+        $this->activityManager->publish($event);
+
+    }
+
+    /**
+     * received the notification that the owner unshared a file from you
+     *
+     * @param string $id
+     * @param array $notification
+     * @return array
+     * @throws AuthenticationFailedException
+     * @throws BadRequestException
+     */
+    private function undoReshare($id, array $notification) {
+        if (!isset($notification['sharedSecret'])) {
+            throw new BadRequestException(['sharedSecret']);
+        }
+        $token = $notification['sharedSecret'];
+
+        $share = $this->federatedShareProvider->getShareById($id);
+
+        $this->verifyShare($share, $token);
+        $this->federatedShareProvider->removeShareFromTable($share);
+        return [];
+    }
+
+    /**
+     * unshare file from self
+     *
+     * @param string $id
+     * @param array $notification
+     * @return array
+     * @throws ActionNotSupportedException
+     * @throws BadRequestException
+     */
+    private function unshare($id, array $notification) {
+
+        if (!$this->isS2SEnabled(true)) {
+            throw new ActionNotSupportedException("incoming shares disabled!");
+        }
+
+        if (!isset($notification['sharedSecret'])) {
+            throw new BadRequestException(['sharedSecret']);
+        }
+        $token = $notification['sharedSecret'];
+
+        $qb = $this->connection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share_external')
+            ->where(
+                $qb->expr()->andX(
+                    $qb->expr()->eq('remote_id', $qb->createNamedParameter($id)),
+                    $qb->expr()->eq('share_token', $qb->createNamedParameter($token))
+                )
+            );
+
+        $result = $qb->execute();
+        $share = $result->fetch();
+        $result->closeCursor();
+
+        if ($token && $id && !empty($share)) {
+
+            $remote = $this->cleanupRemote($share['remote']);
+
+            $owner = $this->cloudIdManager->getCloudId($share['owner'], $remote);
+            $mountpoint = $share['mountpoint'];
+            $user = $share['user'];
+
+            $qb = $this->connection->getQueryBuilder();
+            $qb->delete('share_external')
+                ->where(
+                    $qb->expr()->andX(
+                        $qb->expr()->eq('remote_id', $qb->createNamedParameter($id)),
+                        $qb->expr()->eq('share_token', $qb->createNamedParameter($token))
+                    )
+                );
+
+            $qb->execute();
+
+            // delete all child in case of a group share
+            $qb = $this->connection->getQueryBuilder();
+            $qb->delete('share_external')
+                ->where($qb->expr()->eq('parent', $qb->createNamedParameter((int)$share['id'])));
+            $qb->execute();
+
+            if ((int)$share['share_type'] === Share::SHARE_TYPE_USER) {
+                if ($share['accepted']) {
+                    $path = trim($mountpoint, '/');
+                } else {
+                    $path = trim($share['name'], '/');
+                }
+                $notification = $this->notificationManager->createNotification();
+                $notification->setApp('files_sharing')
+                    ->setUser($share['user'])
+                    ->setObject('remote_share', (int)$share['id']);
+                $this->notificationManager->markProcessed($notification);
+
+                $event = $this->activityManager->generateEvent();
+                $event->setApp('files_sharing')
+                    ->setType('remote_share')
+                    ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_UNSHARED, [$owner->getId(), $path])
+                    ->setAffectedUser($user)
+                    ->setObject('remote_share', (int)$share['id'], $path);
+                \OC::$server->getActivityManager()->publish($event);
+            }
+        }
+
+        return [];
+    }
+
+    private function cleanupRemote($remote) {
+        $remote = substr($remote, strpos($remote, '://') + 3);
+
+        return rtrim($remote, '/');
+    }
+
+    /**
+     * recipient of a share request to re-share the file with another user
+     *
+     * @param string $id
+     * @param array $notification
+     * @return array
+     * @throws AuthenticationFailedException
+     * @throws BadRequestException
+     * @throws ProviderCouldNotAddShareException
+     * @throws ShareNotFound
+     */
+    protected function reshareRequested($id, array $notification) {
+
+        if (!isset($notification['sharedSecret'])) {
+            throw new BadRequestException(['sharedSecret']);
+        }
+        $token = $notification['sharedSecret'];
+
+        if (!isset($notification['shareWith'])) {
+            throw new BadRequestException(['shareWith']);
+        }
+        $shareWith = $notification['shareWith'];
+
+        if (!isset($notification['senderId'])) {
+            throw new BadRequestException(['senderId']);
+        }
+        $senderId = $notification['senderId'];
+
+        $share = $this->federatedShareProvider->getShareById($id);
+        // don't allow to share a file back to the owner
+        try {
+            list($user, $remote) = $this->addressHandler->splitUserRemote($shareWith);
+            $owner = $share->getShareOwner();
+            $currentServer = $this->addressHandler->generateRemoteURL();
+            if ($this->addressHandler->compareAddresses($user, $remote, $owner, $currentServer)) {
+                throw new ProviderCouldNotAddShareException('Resharing back to the owner is not allowed: ' . $id);
+            }
+        } catch (\Exception $e) {
+            throw new ProviderCouldNotAddShareException($e->getMessage());
+        }
+
+        $this->verifyShare($share, $token);
+
+        // check if re-sharing is allowed
+        if ($share->getPermissions() & Constants::PERMISSION_SHARE) {
+            // the recipient of the initial share is now the initiator for the re-share
+            $share->setSharedBy($share->getSharedWith());
+            $share->setSharedWith($shareWith);
+            $result = $this->federatedShareProvider->create($share);
+            $this->federatedShareProvider->storeRemoteId((int)$result->getId(), $senderId);
+            return ['token' => $result->getToken(), 'providerId' => $result->getId()];
+        } else {
+            throw new ProviderCouldNotAddShareException('resharing not allowed for share: ' . $id);
+        }
+
+    }
+
+    /**
+     * update permission of a re-share so that the share dialog shows the right
+     * permission if the owner or the sender changes the permission
+     *
+     * @param string $id
+     * @param array $notification
+     * @return array
+     * @throws AuthenticationFailedException
+     * @throws BadRequestException
+     */
+    protected function updateResharePermissions($id, array $notification) {
+
+        if (!isset($notification['sharedSecret'])) {
+            throw new BadRequestException(['sharedSecret']);
+        }
+        $token = $notification['sharedSecret'];
+
+        if (!isset($notification['permission'])) {
+            throw new BadRequestException(['permission']);
+        }
+        $ocmPermissions = $notification['permission'];
+
+        $share = $this->federatedShareProvider->getShareById($id);
+
+        $ncPermission = $this->ocmPermissions2ncPermissions($ocmPermissions);
+
+        $this->verifyShare($share, $token);
+        $this->updatePermissionsInDatabase($share, $ncPermission);
+
+        return [];
+    }
+
+    /**
+     * translate OCM Permissions to Nextcloud permissions
+     *
+     * @param array $ocmPermissions
+     * @return int
+     * @throws BadRequestException
+     */
+    protected function ocmPermissions2ncPermissions(array $ocmPermissions) {
+        $ncPermissions = 0;
+        foreach($ocmPermissions as $permission) {
+            switch (strtolower($permission)) {
+                case 'read':
+                    $ncPermissions += Constants::PERMISSION_READ;
+                    break;
+                case 'write':
+                    $ncPermissions += Constants::PERMISSION_CREATE + Constants::PERMISSION_UPDATE;
+                    break;
+                case 'share':
+                    $ncPermissions += Constants::PERMISSION_SHARE;
+                    break;
+                default:
+                    throw new BadRequestException(['permission']);
+            }
+
+        }
+
+        return $ncPermissions;
+    }
+
+    /**
+     * update permissions in database
+     *
+     * @param IShare $share
+     * @param int $permissions
+     */
+    protected function updatePermissionsInDatabase(IShare $share, $permissions) {
+        $query = $this->connection->getQueryBuilder();
+        $query->update('share')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($share->getId())))
+            ->set('permissions', $query->createNamedParameter($permissions))
+            ->execute();
+    }
+
+
+    /**
+     * get file
+     *
+     * @param string $user
+     * @param int $fileSource
+     * @return array with internal path of the file and a absolute link to it
+     */
+    private function getFile($user, $fileSource) {
+        \OC_Util::setupFS($user);
+
+        try {
+            $file = Filesystem::getPath($fileSource);
+        } catch (NotFoundException $e) {
+            $file = null;
+        }
+        $args = Filesystem::is_dir($file) ? ['dir' => $file] : ['dir' => dirname($file), 'scrollto' => $file];
+        $link = Util::linkToAbsolute('files', 'index.php', $args);
+
+        return [$file, $link];
+
+    }
+
+    /**
+     * check if we are the initiator or the owner of a re-share and return the correct UID
+     *
+     * @param IShare $share
+     * @return string
+     */
+    protected function getCorrectUid(IShare $share) {
+        if ($this->userManager->userExists($share->getShareOwner())) {
+            return $share->getShareOwner();
+        }
+
+        return $share->getSharedBy();
+    }
+
+
+
+    /**
+     * check if we got the right share
+     *
+     * @param IShare $share
+     * @param string $token
+     * @return bool
+     * @throws AuthenticationFailedException
+     */
+    protected function verifyShare(IShare $share, $token) {
+        if (
+            $share->getShareType() === FederatedShareProvider::SHARE_TYPE_REMOTE &&
+            $share->getToken() === $token
+        ) {
+            return true;
+        }
+
+        if ($share->getShareType() === IShare::TYPE_CIRCLE) {
+            try {
+                $knownShare = $this->shareManager->getShareByToken($token);
+                if ($knownShare->getId() === $share->getId()) {
+                    return true;
+                }
+            } catch (ShareNotFound $e) {
+            }
+        }
+
+        throw new AuthenticationFailedException();
+    }
+
+
+
+    /**
+     * check if server-to-server sharing is enabled
+     *
+     * @param bool $incoming
+     * @return bool
+     */
+    private function isS2SEnabled($incoming = false) {
+
+        $result = $this->appManager->isEnabledForUser('files_sharing');
+
+        if ($incoming) {
+            $result = $result && $this->federatedShareProvider->isIncomingServer2serverShareEnabled();
+        } else {
+            $result = $result && $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
+        }
+
+        return $result;
+    }
+
+
+    /**
+     * get the supported share types, e.g. "user", "group", etc.
+     *
+     * @return array
+     *
+     * @since 14.0.0
+     */
+    public function getSupportedShareTypes() {
+        return ['user', 'group'];
+    }
 }