2 files changed, 140 insertions, 0 deletions
diff --git a/apps/workflowengine/lib/Helper/LogContext.php b/apps/workflowengine/lib/Helper/LogContext.php
new file mode 100644
index 00000000000..9d740680bb6
--- /dev/null
+++ b/apps/workflowengine/lib/Helper/LogContext.php
@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\WorkflowEngine\Helper;
+
+use OCP\WorkflowEngine\IEntity;
+use OCP\WorkflowEngine\IManager;
+use OCP\WorkflowEngine\IOperation;
+
+class LogContext {
+	/** @var array */
+	protected $details;
+
+	public function setDescription(string $description): LogContext {
+		$this->details['message'] = $description;
+		return $this;
+	}
+
+	public function setScopes(array $scopes): LogContext {
+		$this->details['scopes'] = [];
+		foreach ($scopes as $scope) {
+			if ($scope instanceof ScopeContext) {
+				switch ($scope->getScope()) {
+					case IManager::SCOPE_ADMIN:
+						$this->details['scopes'][] = ['scope' => 'admin'];
+						break;
+					case IManager::SCOPE_USER:
+						$this->details['scopes'][] = [
+							'scope' => 'user',
+							'uid' => $scope->getScopeId(),
+						];
+						break;
+					default:
+						continue 2;
+				}
+			}
+		}
+		return $this;
+	}
+
+	public function setOperation(?IOperation $operation): LogContext {
+		if ($operation instanceof IOperation) {
+			$this->details['operation'] = [
+				'class' => get_class($operation),
+				'name' => $operation->getDisplayName(),
+			];
+		}
+		return $this;
+	}
+
+	public function setEntity(?IEntity $entity): LogContext {
+		if ($entity instanceof IEntity) {
+			$this->details['entity'] = [
+				'class' => get_class($entity),
+				'name' => $entity->getName(),
+			];
+		}
+		return $this;
+	}
+
+	public function setConfiguration(array $configuration): LogContext {
+		$this->details['configuration'] = $configuration;
+		return $this;
+	}
+
+	public function setEventName(string $eventName): LogContext {
+		$this->details['eventName'] = $eventName;
+		return $this;
+	}
+
+	public function getDetails(): array {
+		return $this->details;
+	}
+}
diff --git a/apps/workflowengine/lib/Helper/ScopeContext.php b/apps/workflowengine/lib/Helper/ScopeContext.php
new file mode 100644
index 00000000000..05379f5ff43
--- /dev/null
+++ b/apps/workflowengine/lib/Helper/ScopeContext.php
@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\WorkflowEngine\Helper;
+
+use OCP\WorkflowEngine\IManager;
+
+class ScopeContext {
+	/** @var int */
+	private $scope;
+	/** @var string */
+	private $scopeId;
+	/** @var string */
+	private $hash;
+
+	public function __construct(int $scope, ?string $scopeId = null) {
+		$this->scope = $this->evaluateScope($scope);
+		$this->scopeId = $this->evaluateScopeId($scopeId);
+	}
+
+	private function evaluateScope(int $scope): int {
+		if (in_array($scope, [IManager::SCOPE_ADMIN, IManager::SCOPE_USER], true)) {
+			return $scope;
+		}
+		throw new \InvalidArgumentException('Invalid scope');
+	}
+
+	private function evaluateScopeId(?string $scopeId = null): string {
+		if ($this->scope === IManager::SCOPE_USER
+			&& trim((string)$scopeId) === '') {
+			throw new \InvalidArgumentException('user scope requires a user id');
+		}
+		return trim((string)$scopeId);
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getScope(): int {
+		return $this->scope;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getScopeId(): string {
+		return $this->scopeId;
+	}
+
+	public function getHash(): string {
+		if ($this->hash === null) {
+			$this->hash = \hash('sha256', $this->getScope() . '::' . $this->getScopeId());
+		}
+		return $this->hash;
+	}
+}