sysPass/lib/SP/Domain/Import/Services/ImportTrait.php

<?php
/*
 * sysPass
 *
 * @author nuxsmin
 * @link https://syspass.org
 * @copyright 2012-2022, 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\Import\Services;

use Defuse\Crypto\Exception\CryptoException;
use SP\Core\Crypt\Crypt;
use SP\Core\Exceptions\ConstraintException;
use SP\Core\Exceptions\NoSuchPropertyException;
use SP\Core\Exceptions\QueryException;
use SP\Core\Exceptions\SPException;
use SP\DataModel\CategoryData;
use SP\DataModel\ClientData;
use SP\DataModel\TagData;
use SP\Domain\Account\AccountServiceInterface;
use SP\Domain\Account\Services\AccountRequest;
use SP\Domain\Category\CategoryServiceInterface;
use SP\Domain\Client\ClientServiceInterface;
use SP\Domain\Tag\TagServiceInterface;
use SP\Infrastructure\Common\Repositories\DuplicatedItemException;

/**
 * Trait ImportTrait
 *
 * @package SP\Domain\Import\Services
 */
trait ImportTrait
{
    protected int $version = 0;
    /**
     * @var bool Indica si el hash de la clave suministrada es igual a la actual
     */
    protected bool                   $mPassValidHash = false;
    protected int                    $counter        = 0;
    protected ImportParams           $importParams;
    private AccountServiceInterface  $accountService;
    private CategoryServiceInterface $categoryService;
    private ClientServiceInterface   $clientService;
    private TagServiceInterface      $tagService;
    private array                    $items;

    /**
     * @return int
     */
    public function getCounter(): int
    {
        return $this->counter;
    }

    /**
     * Añadir una cuenta desde un archivo importado.
     *
     * @param  AccountRequest  $accountRequest
     *
     * @throws ImportException
     * @throws SPException
     * @throws CryptoException
     * @throws ConstraintException
     * @throws NoSuchPropertyException
     * @throws QueryException
     */
    protected function addAccount(AccountRequest $accountRequest): void
    {
        if (empty($accountRequest->categoryId)) {
            throw new ImportException(__u('Category Id not set. Unable to import account.'));
        }

        if (empty($accountRequest->clientId)) {
            throw new ImportException(__u('Client Id not set. Unable to import account.'));
        }

        $accountRequest->userId = $this->importParams->getDefaultUser();
        $accountRequest->userGroupId = $this->importParams->getDefaultGroup();

        if ($this->mPassValidHash === false
            && !empty($this->importParams->getImportMasterPwd())) {
            if ($this->version >= 210) {
                $pass = Crypt::decrypt(
                    $accountRequest->pass,
                    $accountRequest->key,
                    $this->importParams->getImportMasterPwd()
                );
            } else {
                throw new ImportException(__u('The file was exported with an old sysPass version (<= 2.10).'));
            }

            $accountRequest->pass = $pass;
            $accountRequest->key = '';
        }

        $this->accountService->create($accountRequest);

        $this->counter++;
    }

    /**
     * Añadir una categoría y devolver el Id
     *
     * @param  CategoryData  $categoryData
     *
     * @return int
     * @throws DuplicatedItemException
     * @throws SPException
     */
    protected function addCategory(CategoryData $categoryData): int
    {
        try {
            $categoryId = $this->getWorkingItem('category', $categoryData->getName());

            return $categoryId ?? $this->categoryService->create($categoryData);
        } catch (DuplicatedItemException $e) {
            $itemData = $this->categoryService->getByName($categoryData->getName());

            if ($itemData === null) {
                throw $e;
            }

            return $this->addWorkingItem('category', $itemData->getName(), $itemData->getId());
        }
    }

    /**
     * @param  string  $type
     * @param  string|int  $value
     *
     * @return int|null
     */
    protected function getWorkingItem(string $type, $value): ?int
    {
        return $this->items[$type][$value] ?? null;
    }

    /**
     * @param  string  $type
     * @param  string|int  $value
     * @param  int  $id
     *
     * @return int
     */
    protected function addWorkingItem(string $type, $value, int $id): int
    {
        if (isset($this->items[$type][$value])) {
            return $this->items[$type][$value];
        }

        $this->items[$type][$value] = $id;

        return $id;
    }

    /**
     * Añadir un cliente y devolver el Id
     *
     * @param  ClientData  $clientData
     *
     * @return int
     * @throws DuplicatedItemException
     * @throws SPException
     */
    protected function addClient(ClientData $clientData): int
    {
        try {
            $clientId = $this->getWorkingItem('client', $clientData->getName());

            return $clientId ?? $this->clientService->create($clientData);
        } catch (DuplicatedItemException $e) {
            $itemData = $this->clientService->getByName($clientData->getName());

            if ($itemData === null) {
                throw $e;
            }

            return $this->addWorkingItem(
                'client',
                $itemData->getName(),
                $itemData->getId()
            );
        }
    }

    /**
     * Añadir una etiqueta y devolver el Id
     *
     * @param  TagData  $tagData
     *
     * @return int
     * @throws SPException
     */
    protected function addTag(TagData $tagData): int
    {
        try {
            $tagId = $this->getWorkingItem('tag', $tagData->getName());

            return $tagId ?? $this->tagService->create($tagData);
        } catch (DuplicatedItemException $e) {
            $itemData = $this->tagService->getByName($tagData->getName());

            if ($itemData === null) {
                throw $e;
            }

            return $this->addWorkingItem(
                'tag',
                $itemData->getName(),
                $itemData->getId()
            );
        }
    }
}