1 files changed, 107 insertions, 0 deletions
diff --git a/apps/files_external/lib/Lib/FrontendDefinitionTrait.php b/apps/files_external/lib/Lib/FrontendDefinitionTrait.php
new file mode 100644
index 00000000000..0f280d1d486
--- /dev/null
+++ b/apps/files_external/lib/Lib/FrontendDefinitionTrait.php
@@ -0,0 +1,107 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2017-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCA\Files_External\Lib;
+
+/**
+ * Trait for objects that have a frontend representation
+ */
+trait FrontendDefinitionTrait {
+
+	/** @var string human-readable mechanism name */
+	private string $text = '';
+
+	/** @var array<string, DefinitionParameter> parameters for mechanism */
+	private array $parameters = [];
+
+	/** @var string[] custom JS */
+	private array $customJs = [];
+
+	public function getText(): string {
+		return $this->text;
+	}
+
+	public function setText(string $text): self {
+		$this->text = $text;
+		return $this;
+	}
+
+	public static function lexicalCompare(IFrontendDefinition $a, IFrontendDefinition $b): int {
+		return strcmp($a->getText(), $b->getText());
+	}
+
+	/**
+	 * @return array<string, DefinitionParameter>
+	 */
+	public function getParameters(): array {
+		return $this->parameters;
+	}
+
+	/**
+	 * @param list<DefinitionParameter> $parameters
+	 */
+	public function addParameters(array $parameters): self {
+		foreach ($parameters as $parameter) {
+			$this->addParameter($parameter);
+		}
+		return $this;
+	}
+
+	public function addParameter(DefinitionParameter $parameter): self {
+		$this->parameters[$parameter->getName()] = $parameter;
+		return $this;
+	}
+
+	/**
+	 * @return string[]
+	 */
+	public function getCustomJs(): array {
+		return $this->customJs;
+	}
+
+	/**
+	 * @param string $custom
+	 * @return self
+	 */
+	public function addCustomJs(string $custom): self {
+		$this->customJs[] = $custom;
+		return $this;
+	}
+
+	/**
+	 * Serialize into JSON for client-side JS
+	 */
+	public function jsonSerializeDefinition(): array {
+		$configuration = [];
+		foreach ($this->getParameters() as $parameter) {
+			$configuration[$parameter->getName()] = $parameter;
+		}
+
+		$data = [
+			'name' => $this->getText(),
+			'configuration' => $configuration,
+			'custom' => $this->getCustomJs(),
+		];
+		return $data;
+	}
+
+	/**
+	 * Check if parameters are satisfied in a StorageConfig
+	 */
+	public function validateStorageDefinition(StorageConfig $storage): bool {
+		foreach ($this->getParameters() as $name => $parameter) {
+			$value = $storage->getBackendOption($name);
+			if (!is_null($value) || !$parameter->isOptional()) {
+				if (!$parameter->validateValue($value)) {
+					return false;
+				}
+				$storage->setBackendOption($name, $value);
+			}
+		}
+		return true;
+	}
+}