sysPass/lib/SP/Domain/CustomField/Services/CustomField.php

<?php
/*
 * sysPass
 *
 * @author nuxsmin
 * @link https://syspass.org
 * @copyright 2012-2024, Rubén Domínguez nuxsmin@$syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * sysPass is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace SP\Domain\CustomField\Services;

use Defuse\Crypto\Exception\CryptoException;
use SP\Core\Application;
use SP\Core\Crypt\Crypt;
use SP\Domain\Common\Services\Service;
use SP\Domain\Common\Services\ServiceException;
use SP\Domain\Core\Exceptions\ConstraintException;
use SP\Domain\Core\Exceptions\CryptException;
use SP\Domain\Core\Exceptions\QueryException;
use SP\Domain\Core\Exceptions\SPException;
use SP\Domain\CustomField\Models\CustomFieldData;
use SP\Domain\CustomField\Ports\CustomFieldDataRepository;
use SP\Domain\CustomField\Ports\CustomFieldDefinitionRepository;
use SP\Domain\CustomField\Ports\CustomFieldService;
use SP\Infrastructure\Common\Repositories\NoSuchItemException;

/**
 * Class CustomFieldService
 *
 * @package SP\Domain\CustomField\Services
 */
final class CustomField extends Service implements CustomFieldService
{

    public function __construct(
        Application                                      $application,
        private readonly CustomFieldDataRepository       $customFieldDataRepository,
        private readonly CustomFieldDefinitionRepository $customFieldDefRepository
    ) {
        parent::__construct($application);
    }

    /**
     * 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
     *
     * @param string $data
     * @param string $key
     * @return string
     * @throws ServiceException
     * @throws CryptException
     */
    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('<a href="%s" target="_blank">%s</a>', $value, $value);
        }

        return $value;
    }

    /**
     * Returns the module's item for given id
     *
     * @throws ConstraintException
     * @throws QueryException
     * @throws SPException
     */
    public function getForModuleAndItemId(int $moduleId, ?int $itemId): array
    {
        return $this->customFieldDataRepository->getForModuleAndItemId($moduleId, $itemId)->getDataAsArray();
    }

    /**
     * Updates an item
     *
     * @throws CryptoException
     * @throws QueryException
     * @throws ConstraintException
     * @throws SPException
     */
    public function updateOrCreateData(CustomFieldData $customFieldData): bool
    {
        $exists = $this->customFieldDataRepository->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->customFieldDataRepository->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->customFieldDataRepository->deleteCustomFieldData($itemId, $moduleId);
        }

        return $this->customFieldDataRepository->deleteByItemAndModuleAndDefinition($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->customFieldDataRepository->create($customFieldData) > 0;
    }

    /**
     * @throws CryptoException
     * @throws 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->customFieldDataRepository->deleteByDefinition($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->customFieldDataRepository->deleteBatch($ids, $moduleId);
    }

    /**
     * Updates an item
     *
     * @param CustomFieldData $customFieldData
     * @param string $masterPass
     *
     * @return int
     * @throws CryptoException
     * @throws ServiceException
     */
    public function updateMasterPass(CustomFieldData $customFieldData, string $masterPass): int
    {
        $this->setSecureData($customFieldData, $masterPass);

        return $this->customFieldDataRepository->update($customFieldData);
    }

    /**
     * @return CustomFieldData[]
     * @throws QueryException
     * @throws ConstraintException
     */
    public function getAll(): array
    {
        return $this->customFieldDataRepository->getAll()->getDataAsArray();
    }

    /**
     * @return CustomFieldData[]
     * @throws QueryException
     * @throws ConstraintException
     */
    public function getAllEncrypted(): array
    {
        return $this->customFieldDataRepository->getAllEncrypted()->getDataAsArray();
    }
}