FieldDefinitionService.php

<?php

/**
 * SPDX-FileCopyrightText: 2026 LibreCode coop and LibreCode contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

declare(strict_types=1);

namespace OCA\ProfileFields\Service;

use DateTime;
use InvalidArgumentException;
use JsonException;
use OCA\ProfileFields\Db\FieldDefinition;
use OCA\ProfileFields\Db\FieldDefinitionMapper;
use OCA\ProfileFields\Db\FieldValueMapper;
use OCP\IL10N;

class FieldDefinitionService {
	public function __construct(
		private FieldDefinitionMapper $fieldDefinitionMapper,
		private FieldValueMapper $fieldValueMapper,
		private FieldDefinitionValidator $validator,
		private IL10N $l10n,
	) {
	}

	/**
	 * @param array<string, mixed> $definition
	 */
	public function create(array $definition): FieldDefinition {
		$validated = $this->validator->validate($definition);
		if ($this->fieldDefinitionMapper->findByFieldKey($validated['field_key']) !== null) {
			// TRANSLATORS "field_key" is a technical API field identifier and should remain unchanged.
			throw new InvalidArgumentException($this->l10n->t('"field_key" already exists'));
		}

		$createdAt = $this->parseImportedDate($definition['created_at'] ?? null) ?? new DateTime();
		$updatedAt = $this->parseImportedDate($definition['updated_at'] ?? null) ?? clone $createdAt;
		$entity = new FieldDefinition();
		$entity->setFieldKey($validated['field_key']);
		$entity->setLabel($validated['label']);
		$entity->setType($validated['type']);
		$entity->setEditPolicy($validated['edit_policy']);
		$entity->setExposurePolicy($validated['exposure_policy']);
		$entity->setSortOrder($validated['sort_order']);
		$entity->setActive($validated['active']);
		try {
			$entity->setOptions(isset($validated['options']) ? json_encode($validated['options'], JSON_THROW_ON_ERROR) : null);
		} catch (JsonException $e) {
			// TRANSLATORS %s is a low-level JSON encoder error detail.
			throw new InvalidArgumentException($this->l10n->t('Options could not be encoded: %s', [$e->getMessage()]), 0, $e);
		}
		$entity->setCreatedAt($createdAt);
		$entity->setUpdatedAt($updatedAt);

		return $this->fieldDefinitionMapper->insert($entity);
	}

	/**
	 * @param array<string, mixed> $definition
	 */
	public function update(FieldDefinition $existing, array $definition): FieldDefinition {
		$validated = $this->validator->validate($definition + ['field_key' => $existing->getFieldKey()]);
		if (($definition['field_key'] ?? $existing->getFieldKey()) !== $existing->getFieldKey()) {
			// TRANSLATORS "field_key" is a technical API field identifier and should remain unchanged.
			throw new InvalidArgumentException($this->l10n->t('"field_key" cannot be changed'));
		}

		if ($validated['type'] !== $existing->getType() && $this->fieldValueMapper->hasValuesForFieldDefinitionId($existing->getId())) {
			throw new InvalidArgumentException($this->l10n->t('Type cannot be changed after values exist'));
		}

		$existing->setLabel($validated['label']);
		$existing->setType($validated['type']);
		$existing->setEditPolicy($validated['edit_policy']);
		$existing->setExposurePolicy($validated['exposure_policy']);
		$existing->setSortOrder($validated['sort_order']);
		$existing->setActive($validated['active']);
		try {
			$existing->setOptions(isset($validated['options']) ? json_encode($validated['options'], JSON_THROW_ON_ERROR) : null);
		} catch (JsonException $e) {
			// TRANSLATORS %s is a low-level JSON encoder error detail.
			throw new InvalidArgumentException($this->l10n->t('Options could not be encoded: %s', [$e->getMessage()]), 0, $e);
		}
		$existing->setUpdatedAt($this->parseImportedDate($definition['updated_at'] ?? null) ?? new DateTime());

		return $this->fieldDefinitionMapper->update($existing);
	}

	private function parseImportedDate(mixed $value): ?DateTime {
		if (!is_string($value) || $value === '') {
			return null;
		}

		return new DateTime($value);
	}

	/**
	 * @return list<FieldDefinition>
	 */
	public function findAllOrdered(): array {
		return $this->fieldDefinitionMapper->findAllOrdered();
	}

	public function findById(int $id): ?FieldDefinition {
		return $this->fieldDefinitionMapper->findById($id);
	}

	public function findByFieldKey(string $fieldKey): ?FieldDefinition {
		return $this->fieldDefinitionMapper->findByFieldKey($fieldKey);
	}

	public function delete(int $id): ?FieldDefinition {
		$definition = $this->fieldDefinitionMapper->findById($id);
		if ($definition === null) {
			return null;
		}

		return $this->fieldDefinitionMapper->delete($definition);
	}

	/**
	 * @return list<FieldDefinition>
	 */
	public function findActiveOrdered(): array {
		return $this->fieldDefinitionMapper->findActiveOrdered();
	}
}