Add typing to Sharing Backend

Signed-off-by: Carl Schwan <carl@carlschwan.eu>

2 files changed, 36 insertions, 64 deletions

diff --git a/apps/dav/lib/DAV/Sharing/Backend.php b/apps/dav/lib/DAV/Sharing/Backend.php
index 544a38cfbe6..92971992c20 100644
--- a/apps/dav/lib/DAV/Sharing/Backend.php
+++ b/apps/dav/lib/DAV/Sharing/Backend.php
@@ -32,32 +32,20 @@ use OCA\DAV\Connector\Sabre\Principal;
 use OCP\IDBConnection;
 use OCP\IGroupManager;
 use OCP\IUserManager;
+use OCP\DB\QueryBuilder\IQueryBuilder;
 
 class Backend {
-
-	/** @var IDBConnection */
-	private $db;
-	/** @var IUserManager */
-	private $userManager;
-	/** @var IGroupManager */
-	private $groupManager;
-	/** @var Principal */
-	private $principalBackend;
-	/** @var string */
-	private $resourceType;
+	private IDBConnection $db;
+	private IUserManager $userManager;
+	private IGroupManager $groupManager;
+	private Principal $principalBackend;
+	private string $resourceType;
 
 	public const ACCESS_OWNER = 1;
 	public const ACCESS_READ_WRITE = 2;
 	public const ACCESS_READ = 3;
 
-	/**
-	 * @param IDBConnection $db
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param Principal $principalBackend
-	 * @param string $resourceType
-	 */
-	public function __construct(IDBConnection $db, IUserManager $userManager, IGroupManager $groupManager, Principal $principalBackend, $resourceType) {
+	public function __construct(IDBConnection $db, IUserManager $userManager, IGroupManager $groupManager, Principal $principalBackend, string $resourceType) {
 		$this->db = $db;
 		$this->userManager = $userManager;
 		$this->groupManager = $groupManager;
@@ -66,11 +54,10 @@ class Backend {
 	}
 
 	/**
-	 * @param IShareable $shareable
-	 * @param string[] $add
-	 * @param string[] $remove
+	 * @param list<array{href: string, commonName: string, readOnly: bool}> $add
+	 * @param list<string> $remove
 	 */
-	public function updateShares(IShareable $shareable, array $add, array $remove) {
+	public function updateShares(IShareable $shareable, array $add, array $remove): void {
 		foreach ($add as $element) {
 			$principal = $this->principalBackend->findByUri($element['href'], '');
 			if ($principal !== '') {
@@ -86,10 +73,9 @@ class Backend {
 	}
 
 	/**
-	 * @param IShareable $shareable
-	 * @param string $element
+	 * @param array{href: string, commonName: string, readOnly: bool} $element
 	 */
-	private function shareWith($shareable, $element) {
+	private function shareWith(IShareable $shareable, array $element): void {
 		$user = $element['href'];
 		$parts = explode(':', $user, 2);
 		if ($parts[0] !== 'principal') {
@@ -129,33 +115,26 @@ class Backend {
 				'access' => $query->createNamedParameter($access),
 				'resourceid' => $query->createNamedParameter($shareable->getResourceId())
 			]);
-		$query->execute();
+		$query->executeStatement();
 	}
 
-	/**
-	 * @param $resourceId
-	 */
-	public function deleteAllShares($resourceId) {
+	public function deleteAllShares(int $resourceId): void {
 		$query = $this->db->getQueryBuilder();
 		$query->delete('dav_shares')
 			->where($query->expr()->eq('resourceid', $query->createNamedParameter($resourceId)))
 			->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType)))
-			->execute();
+			->executeStatement();
 	}
 
-	public function deleteAllSharesByUser($principaluri) {
+	public function deleteAllSharesByUser(string $principaluri): void {
 		$query = $this->db->getQueryBuilder();
 		$query->delete('dav_shares')
 			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principaluri)))
 			->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType)))
-			->execute();
+			->executeStatement();
 	}
 
-	/**
-	 * @param IShareable $shareable
-	 * @param string $element
-	 */
-	private function unshare($shareable, $element) {
+	private function unshare(IShareable $shareable, string $element): void {
 		$parts = explode(':', $element, 2);
 		if ($parts[0] !== 'principal') {
 			return;
@@ -172,7 +151,7 @@ class Backend {
 			->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType)))
 			->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($parts[1])))
 		;
-		$query->execute();
+		$query->executeStatement();
 	}
 
 	/**
@@ -183,29 +162,28 @@ class Backend {
 	 *   * 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
 	 *
 	 * @param int $resourceId
-	 * @return array
+	 * @return list<array{href: string, commonName: string, status: int, readOnly: bool, '{http://owncloud.org/ns}principal': string, '{http://owncloud.org/ns}group-share': bool}>
 	 */
-	public function getShares($resourceId) {
+	public function getShares(int $resourceId): array {
 		$query = $this->db->getQueryBuilder();
 		$result = $query->select(['principaluri', 'access'])
 			->from('dav_shares')
-			->where($query->expr()->eq('resourceid', $query->createNamedParameter($resourceId)))
+			->where($query->expr()->eq('resourceid', $query->createNamedParameter($resourceId, IQueryBuilder::PARAM_INT)))
 			->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType)))
 			->groupBy(['principaluri', 'access'])
-			->execute();
+			->executeQuery();
 
 		$shares = [];
 		while ($row = $result->fetch()) {
 			$p = $this->principalBackend->getPrincipalByPath($row['principaluri']);
 			$shares[] = [
-				'href' => "principal:{$row['principaluri']}",
-				'commonName' => isset($p['{DAV:}displayname']) ? $p['{DAV:}displayname'] : '',
+				'href' => "principal:${row['principaluri']}",
+				'commonName' => isset($p['{DAV:}displayname']) ? (string)$p['{DAV:}displayname'] : '',
 				'status' => 1,
 				'readOnly' => (int) $row['access'] === self::ACCESS_READ,
-				'{http://owncloud.org/ns}principal' => $row['principaluri'],
+				'{http://owncloud.org/ns}principal' => (string)$row['principaluri'],
 				'{http://owncloud.org/ns}group-share' => is_null($p)
 			];
 		}
@@ -217,10 +195,10 @@ class Backend {
 	 * For shared resources the sharee is set in the ACL of the resource
 	 *
 	 * @param int $resourceId
-	 * @param array $acl
-	 * @return array
+	 * @param list<array{privilege: string, principal: string, protected: bool}> $acl
+	 * @return list<array{privilege: string, principal: string, protected: bool}>
 	 */
-	public function applyShareAcl($resourceId, $acl) {
+	public function applyShareAcl(int $resourceId, array $acl): array {
 		$shares = $this->getShares($resourceId);
 		foreach ($shares as $share) {
 			$acl[] = [
diff --git a/apps/dav/lib/DAV/Sharing/IShareable.php b/apps/dav/lib/DAV/Sharing/IShareable.php
index 3833e026696..759981af078 100644
--- a/apps/dav/lib/DAV/Sharing/IShareable.php
+++ b/apps/dav/lib/DAV/Sharing/IShareable.php
@@ -40,16 +40,14 @@ interface IShareable extends INode {
 	 * Every element in the add array has the following properties:
 	 *   * href - A url. Usually a mailto: address
 	 *   * commonName - Usually a first and last name, or false
-	 *   * summary - A description of the share, can also be false
 	 *   * readOnly - A boolean value
 	 *
 	 * Every element in the remove array is just the address string.
 	 *
-	 * @param array $add
-	 * @param array $remove
-	 * @return void
+	 * @param list<array{href: string, commonName: string, readOnly: bool}> $add
+	 * @param list<string> $remove
 	 */
-	public function updateShares(array $add, array $remove);
+	public function updateShares(array $add, array $remove): void;
 
 	/**
 	 * Returns the list of people whom this resource is shared with.
@@ -59,19 +57,15 @@ interface IShareable extends INode {
 	 *   * 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
+	 * @return list<array{href: string, commonName: string, status: int, readOnly: bool, '{http://owncloud.org/ns}principal': string, '{http://owncloud.org/ns}group-share': bool}>
 	 */
-	public function getShares();
+	public function getShares(): array;
 
-	/**
-	 * @return int
-	 */
-	public function getResourceId();
+	public function getResourceId(): int;
 
 	/**
-	 * @return string
+	 * @return ?string
 	 */
 	public function getOwner();
 }