add support for circles in approval rules

Signed-off-by: Julien Veyssier <eneiluj@posteo.net>

Author: Julien Veyssier

appinfo/info.xml

@@ -4,7 +4,7 @@
 	<name>Approval</name>
 	<summary>Let users approve or disapprove files</summary>
 	<description><![CDATA[Approve/reject files based on hidden tags rules.]]></description>
-	<version>0.0.3</version>
+	<version>0.0.2</version>
 	<licence>agpl</licence>
 	<author>Julien Veyssier</author>
 	<namespace>Approval</namespace>

lib/Controller/ConfigController.php

@@ -16,11 +16,10 @@
 use OCP\IConfig;
 use OCP\IL10N;
 use Psr\Log\LoggerInterface;
-
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\RedirectResponse;
-
 use OCP\AppFramework\Http\ContentSecurityPolicy;
+use OCP\App\IAppManager;
 
 use OCP\IRequest;
 use OCP\AppFramework\Http\DataResponse;
@@ -39,6 +38,7 @@ public function __construct($AppName,
 								IRequest $request,
 								IConfig $config,
 								IUserManager $userManager,
+								IAppManager $appManager,
 								IL10N $l,
 								LoggerInterface $logger,
 								RuleService $ruleService,
@@ -49,6 +49,7 @@ public function __construct($AppName,
 		$this->config = $config;
 		$this->logger = $logger;
 		$this->userManager = $userManager;
+		$this->appManager = $appManager;
 		$this->ruleService = $ruleService;
 	}
 
@@ -57,14 +58,23 @@ public function __construct($AppName,
 	 * @return DataResponse
 	 */
 	public function getRules(): DataResponse {
+		$circlesEnabled = $this->appManager->isEnabledForUser('circles');
+
 		$rules = $this->ruleService->getRules();
 		foreach ($rules as $id => $rule) {
 			foreach ($rule['who'] as $k => $elem) {
 				if (isset($elem['userId'])) {
 					$user = $this->userManager->get($elem['userId']);
 					$rules[$id]['who'][$k]['displayName'] = $user ? $user->getDisplayName() : $elem['userId'];
-				} else {
+				} elseif (isset($elem['groupId'])) {
 					$rules[$id]['who'][$k]['displayName'] = $elem['groupId'];
+				} elseif (isset($elem['circleId'])) {
+					if ($circlesEnabled) {
+						$circleDetails = \OCA\Circles\Api\v1\Circles::detailsCircle($elem['circleId']);
+						$rules[$id]['who'][$k]['displayName'] = $circleDetails->getName();
+					} else {
+						unset($rules[$id]['who'][$k]);
+					}
 				}
 			}
 		}

lib/Migration/Version000002Date20210330142733.php renamed to lib/Migration/Version000003Date20210331142733.php

@@ -12,7 +12,7 @@
 /**
  * Auto-generated migration step: Please modify to your needs!
  */
-class Version000002Date20210330142733 extends SimpleMigrationStep {
+class Version000003Date20210331142733 extends SimpleMigrationStep {
 
 	/**
 	 * @param IOutput $output
@@ -90,6 +90,24 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 			$table->setPrimaryKey(['id']);
 		}
 
+		if (!$schema->hasTable('approval_rule_circles')) {
+			$table = $schema->createTable('approval_rule_circles');
+			$table->addColumn('id', 'integer', [
+				'autoincrement' => true,
+				'notnull' => true,
+				'length' => 4,
+			]);
+			$table->addColumn('rule_id', 'integer', [
+				'notnull' => true,
+				'length' => 4,
+			]);
+			$table->addColumn('circle_id', 'string', [
+				'notnull' => true,
+				'length' => 300,
+			]);
+			$table->setPrimaryKey(['id']);
+		}
+
 		return $schema;
 	}
 

lib/Service/ApprovalService.php

@@ -23,6 +23,7 @@
 use OCP\IUserManager;
 use OCP\IUser;
 use OCP\IGroupManager;
+use OCP\App\IAppManager;
 use OCP\Notification\IManager as INotificationManager;
 
 use OCA\Approval\AppInfo\Application;
@@ -44,6 +45,7 @@ public function __construct (string $appName,
 								IRootFolder $root,
 								IUserManager $userManager,
 								IGroupManager $groupManager,
+								IAppManager $appManager,
 								INotificationManager $notificationManager,
 								RuleService $ruleService,
 								ActivityManager $activityManager,
@@ -55,6 +57,7 @@ public function __construct (string $appName,
 		$this->root = $root;
 		$this->userManager = $userManager;
 		$this->groupManager = $groupManager;
+		$this->appManager = $appManager;
 		$this->notificationManager = $notificationManager;
 		$this->activityManager = $activityManager;
 		$this->tagManager = $tagManager;
@@ -86,6 +89,8 @@ private function userHasAccessTo(int $fileId, ?string $userId): bool {
 	}
 
 	private function userIsAuthorizedByRule(string $userId, array $rule): bool {
+		$circlesEnabled = $this->appManager->isEnabledForUser('circles');
+
 		$user = $this->userManager->get($userId);
 
 		$ruleUserIds = array_map(function ($w) {
@@ -109,6 +114,42 @@ private function userIsAuthorizedByRule(string $userId, array $rule): bool {
 					return true;
 				}
 			}
+			// if user is member of one rule's circle list
+			if ($circlesEnabled) {
+				$ruleCircleIds = array_map(function ($w) {
+					return $w['circleId'];
+				}, array_filter($rule['who'], function ($w) {
+					return isset($w['circleId']);
+				}));
+				foreach ($ruleCircleIds as $circleId) {
+					if ($this->isUserInCircle($userId, $circleId)) {
+						return true;
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+	private function isUserInCircle(string $userId, string $circleId): bool {
+		$circleDetails = null;
+		try {
+			$circleDetails = \OCA\Circles\Api\v1\Circles::detailsCircle($circleId);
+		} catch (\OCA\Circles\Exceptions\CircleDoesNotExistException $e) {
+			return false;
+		}
+		// is the circle owner
+		if ($circleDetails->getOwner()->getUserId() === $userId) {
+			return true;
+		} else {
+			if ($circleDetails->getMembers() !== null) {
+				foreach ($circleDetails->getMembers() as $m) {
+					// is member of this circle
+					if ($m->getUserId() === $userId) {
+						return true;
+					}
+				}
+			}
 		}
 		return false;
 	}

lib/Service/RuleService.php

@@ -216,6 +216,53 @@ public function saveRule(int $id, int $tagPending, int $tagApproved, int $tagRej
 			$qb = $qb->resetQueryParts();
 		}
 
+		// circles
+		$toDelete = [];
+		$toAdd = [];
+		$oldCircleIds = [];
+		foreach ($rule['who'] as $elem) {
+			if (isset($elem['circleId'])) {
+				$oldCircleIds[] = $elem['circleId'];
+			}
+		}
+		$newCircleIds = [];
+		foreach ($who as $elem) {
+			if (isset($elem['circleId'])) {
+				$newCircleIds[] = $elem['circleId'];
+			}
+		}
+
+		foreach ($oldCircleIds as $gid) {
+			if (!in_array($gid, $newCircleIds)) {
+				$toDelete[] = $gid;
+			}
+		}
+		foreach ($newCircleIds as $gid) {
+			if (!in_array($gid, $oldCircleIds)) {
+				$toAdd[] = $gid;
+			}
+		}
+		foreach ($toDelete as $gid) {
+			$qb->delete('approval_rule_circles')
+				->where(
+					$qb->expr()->eq('rule_id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT))
+				)
+				->andWhere(
+                    $qb->expr()->eq('circle_id', $qb->createNamedParameter($gid, IQueryBuilder::PARAM_STR))
+                );
+			$req = $qb->execute();
+			$qb = $qb->resetQueryParts();
+		}
+		foreach ($toAdd as $gid) {
+			$qb->insert('approval_rule_circles')
+				->values([
+					'circle_id' => $qb->createNamedParameter($gid, IQueryBuilder::PARAM_STR),
+					'rule_id' => $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT),
+				]);
+			$req = $qb->execute();
+			$qb = $qb->resetQueryParts();
+		}
+
 		return ['id' => $id];
 	}
 
@@ -266,6 +313,14 @@ public function createRule(int $tagPending, int $tagApproved, int $tagRejected,
 					]);
 				$req = $qb->execute();
 				$qb = $qb->resetQueryParts();
+			} elseif (isset($elem['circleId'])) {
+				$qb->insert('approval_rule_circles')
+					->values([
+						'circle_id' => $qb->createNamedParameter($elem['circleId'], IQueryBuilder::PARAM_STR),
+						'rule_id' => $qb->createNamedParameter($insertedRuleId, IQueryBuilder::PARAM_INT),
+					]);
+				$req = $qb->execute();
+				$qb = $qb->resetQueryParts();
 			}
 		}
 
@@ -357,6 +412,7 @@ public function getRule(int $id): ?array {
 		$req->closeCursor();
 		$qb = $qb->resetQueryParts();
 
+		// groups
 		$qb->select('*')
 			->from('approval_rule_groups')
 			->where(
@@ -371,6 +427,21 @@ public function getRule(int $id): ?array {
 		$req->closeCursor();
 		$qb = $qb->resetQueryParts();
 
+		// circles
+		$qb->select('*')
+			->from('approval_rule_circles')
+			->where(
+				$qb->expr()->eq('rule_id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT))
+			);
+		$req = $qb->execute();
+		while ($row = $req->fetch()) {
+			$rule['who'][] = [
+				'circleId' => $row['circle_id']
+			];
+		}
+		$req->closeCursor();
+		$qb = $qb->resetQueryParts();
+
 		return $rule;
 	}
 
@@ -416,6 +487,7 @@ public function getRules(): array {
 			$req->closeCursor();
 			$qb = $qb->resetQueryParts();
 
+			// groups
 			$qb->select('*')
 				->from('approval_rule_groups')
 				->where(
@@ -429,6 +501,21 @@ public function getRules(): array {
 			}
 			$req->closeCursor();
 			$qb = $qb->resetQueryParts();
+
+			// circles
+			$qb->select('*')
+				->from('approval_rule_circles')
+				->where(
+					$qb->expr()->eq('rule_id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT))
+				);
+			$req = $qb->execute();
+			while ($row = $req->fetch()) {
+				$rules[$id]['who'][] = [
+					'circleId' => $row['circle_id']
+				];
+			}
+			$req->closeCursor();
+			$qb = $qb->resetQueryParts();
 		}
 
 		return $rules;

src/components/AdminSettings.vue

@@ -96,7 +96,11 @@ export default {
 					this.rules[id].who = this.rules[id].who.map(w => {
 						return {
 							...w,
-							trackKey: w.userId ? 'user-' + w.userId : 'group-' + w.groupId,
+							trackKey: w.userId
+								? 'user-' + w.userId
+								: w.groupId
+									? 'group-' + w.groupId
+									: 'circle-' + w.circleId,
 						}
 					})
 				}
@@ -120,6 +124,7 @@ export default {
 						return {
 							userId: u.userId,
 							groupId: u.groupId,
+							circleId: u.circleId,
 						}
 					}),
 				}
@@ -160,6 +165,7 @@ export default {
 						return {
 							userId: u.userId,
 							groupId: u.groupId,
+							circleId: u.circleId,
 						}
 					}),
 				}