. */ namespace SP\Domain\CustomField\Services; use Defuse\Crypto\Exception\CryptoException; use SP\Core\Application; use SP\Core\Crypt\Crypt; use SP\Core\Exceptions\ConstraintException; use SP\Core\Exceptions\QueryException; use SP\Core\Exceptions\SPException; use SP\DataModel\CustomFieldData; use SP\Domain\Common\Services\Service; use SP\Domain\Common\Services\ServiceException; use SP\Domain\CustomField\CustomFieldServiceInterface; use SP\Domain\CustomField\In\CustomFieldDefRepositoryInterface; use SP\Domain\CustomField\In\CustomFieldRepositoryInterface; use SP\Infrastructure\Common\Repositories\NoSuchItemException; /** * Class CustomFieldService * * @package SP\Domain\CustomField\Services */ final class CustomFieldService extends Service implements CustomFieldServiceInterface { protected CustomFieldRepositoryInterface $customFieldRepository; protected CustomFieldDefRepositoryInterface $customFieldDefRepository; public function __construct( Application $application, CustomFieldRepositoryInterface $customFieldRepository, CustomFieldDefRepositoryInterface $customFieldDefRepository ) { parent::__construct($application); $this->customFieldRepository = $customFieldRepository; $this->customFieldDefRepository = $customFieldDefRepository; } /** * Returns the form Id for a given name */ public static function getFormIdForName(string $name): string { return sprintf('cf_%s', strtolower(preg_replace('/\W*/', '', $name))); } /** * Desencriptar y formatear los datos del campo * * @throws CryptoException * @throws ServiceException */ public function decryptData(string $data, string $key): string { if (!empty($data) && !empty($key)) { return self::formatValue(Crypt::decrypt($data, $key, $this->getMasterKeyFromContext())); } return ''; } /** * Formatear el valor del campo * * @param $value string El valor del campo * * @return string */ public static function formatValue(string $value): string { if (preg_match('#https?://#', $value)) { return sprintf('%s', $value, $value); } return $value; } /** * Returns the module's item for given id * * @throws \SP\Core\Exceptions\ConstraintException * @throws \SP\Core\Exceptions\QueryException */ public function getForModuleAndItemId(int $moduleId, ?int $itemId): array { return $this->customFieldRepository->getForModuleAndItemId($moduleId, $itemId)->getDataAsArray(); } /** * Updates an item * * @throws CryptoException * @throws QueryException * @throws ConstraintException * @throws SPException */ public function updateOrCreateData(CustomFieldData $customFieldData): bool { $exists = $this->customFieldRepository->checkExists($customFieldData); // Deletes item's custom field data if value is left blank if ($exists && empty($customFieldData->getData())) { return $this->deleteCustomFieldData( $customFieldData->getId(), $customFieldData->getModuleId(), $customFieldData->getDefinitionId() ) === 1; } // Create item's custom field data if value is set if (!$exists) { return $this->create($customFieldData); } if ($this->customFieldDefRepository->getById($customFieldData->getDefinitionId())->getisEncrypted()) { $this->setSecureData($customFieldData); } return $this->customFieldRepository->update($customFieldData) === 1; } /** * Eliminar los datos de los campos personalizados del módulo * * @throws SPException */ public function deleteCustomFieldData(int $itemId, int $moduleId, ?int $definitionId = null): int { if ($definitionId === null) { return $this->customFieldRepository->deleteCustomFieldData($itemId, $moduleId); } return $this->customFieldRepository->deleteCustomFieldDataForDefinition($itemId, $moduleId, $definitionId); } /** * Creates an item * * @throws CryptoException * @throws QueryException * @throws ServiceException * @throws ConstraintException * @throws NoSuchItemException */ public function create(CustomFieldData $customFieldData): bool { if (empty($customFieldData->getData())) { return true; } if ($this->customFieldDefRepository->getById($customFieldData->getDefinitionId())->getisEncrypted()) { $this->setSecureData($customFieldData); } return $this->customFieldRepository->create($customFieldData) > 0; } /** * @throws \Defuse\Crypto\Exception\CryptoException * @throws \SP\Domain\Common\Services\ServiceException */ protected function setSecureData(CustomFieldData $customFieldData, ?string $key = null): void { $key = $key ?: $this->getMasterKeyFromContext(); $securedKey = Crypt::makeSecuredKey($key); if (strlen($securedKey) > 1000) { throw new ServiceException(__u('Internal error'), SPException::ERROR); } $customFieldData->setData(Crypt::encrypt($customFieldData->getData(), $securedKey, $key)); $customFieldData->setKey($securedKey); } /** * Eliminar los datos de los campos personalizados del módulo * * @throws QueryException * @throws ConstraintException */ public function deleteCustomFieldDefinitionData(int $definitionId): int { return $this->customFieldRepository->deleteCustomFieldDefinitionData($definitionId); } /** * Eliminar los datos de los campos personalizados del módulo * * @param int[] $ids * @param int $moduleId * * @return bool * @throws QueryException * @throws ConstraintException */ public function deleteCustomFieldDataBatch(array $ids, int $moduleId): bool { return $this->customFieldRepository->deleteCustomFieldDataBatch($ids, $moduleId); } /** * Eliminar los datos de los elementos de una definición * * @param int[] $definitionIds * * @return int * @throws ConstraintException * @throws QueryException */ public function deleteCustomFieldDefinitionDataBatch(array $definitionIds): int { return $this->customFieldRepository->deleteCustomFieldDefinitionDataBatch($definitionIds); } /** * Updates an item * * @param \SP\DataModel\CustomFieldData $customFieldData * @param string $masterPass * * @return int * @throws \Defuse\Crypto\Exception\CryptoException * @throws \SP\Domain\Common\Services\ServiceException */ public function updateMasterPass(CustomFieldData $customFieldData, string $masterPass): int { $this->setSecureData($customFieldData, $masterPass); return $this->customFieldRepository->update($customFieldData); } /** * @return CustomFieldData[] * @throws QueryException * @throws ConstraintException */ public function getAll(): array { return $this->customFieldRepository->getAll()->getDataAsArray(); } /** * @return CustomFieldData[] * @throws QueryException * @throws ConstraintException */ public function getAllEncrypted(): array { return $this->customFieldRepository->getAllEncrypted()->getDataAsArray(); } }