sysPass/lib/SP/Services/Plugin/PluginDataService.php

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

use Defuse\Crypto\Exception\CryptoException;
use SP\Core\Exceptions\ConstraintException;
use SP\Core\Exceptions\NoSuchPropertyException;
use SP\Core\Exceptions\QueryException;
use SP\Repositories\NoSuchItemException;
use SP\Repositories\Plugin\PluginDataModel;
use SP\Repositories\Plugin\PluginDataRepository;
use SP\Services\Service;
use SP\Services\ServiceException;
use SP\Storage\Database\QueryResult;

/**
 * Class PluginDataService
 *
 * @package SP\Services\Plugin
 */
final class PluginDataService extends Service
{
    /**
     * @var PluginDataRepository
     */
    protected $pluginRepository;

    /**
     * Creates an item
     *
     * @param PluginDataModel $itemData
     *
     * @return QueryResult
     * @throws CryptoException
     * @throws ConstraintException
     * @throws NoSuchPropertyException
     * @throws QueryException
     * @throws ServiceException
     */
    public function create(PluginDataModel $itemData)
    {
        return $this->pluginRepository->create($itemData->encrypt($this->getMasterKeyFromContext()));
    }

    /**
     * Updates an item
     *
     * @param PluginDataModel $itemData
     *
     * @return int
     * @throws CryptoException
     * @throws ConstraintException
     * @throws NoSuchPropertyException
     * @throws QueryException
     * @throws ServiceException
     */
    public function update(PluginDataModel $itemData)
    {
        return $this->pluginRepository->update($itemData->encrypt($this->getMasterKeyFromContext()));
    }

    /**
     * Returns the item for given plugin and id
     *
     * @param string $name
     * @param int    $id
     *
     * @return PluginDataModel
     * @throws NoSuchItemException
     * @throws CryptoException
     * @throws ConstraintException
     * @throws NoSuchPropertyException
     * @throws QueryException
     * @throws ServiceException
     */
    public function getByItemId(string $name, int $id)
    {
        $result = $this->pluginRepository->getByItemId($name, $id);

        if ($result->getNumRows() === 0) {
            throw new NoSuchItemException(__u('Plugin\'s data not found'), NoSuchItemException::INFO);
        }

        /** @var PluginDataModel $itemData */
        $itemData = $result->getData();

        return $itemData->decrypt($this->getMasterKeyFromContext());
    }

    /**
     * Returns the item for given id
     *
     * @param int $id
     *
     * @return PluginDataModel[]
     * @throws ConstraintException
     * @throws QueryException
     * @throws NoSuchItemException
     */
    public function getById($id)
    {
        $result = $this->pluginRepository->getById($id);

        if ($result->getNumRows() === 0) {
            throw new NoSuchItemException(__u('Plugin\'s data not found'), NoSuchItemException::INFO);
        }

        $data = $result->getDataAsArray();

        array_walk($data, function ($itemData) {
            /** @var PluginDataModel $itemData */
            $itemData->decrypt($this->getMasterKeyFromContext());
        });

        return $data;
    }

    /**
     * Returns all the items
     *
     * @return PluginDataModel[]
     * @throws ConstraintException
     * @throws QueryException
     */
    public function getAll()
    {
        $data = $this->pluginRepository->getAll()->getDataAsArray();

        array_walk($data, function ($itemData) {
            /** @var PluginDataModel $itemData */
            $itemData->decrypt($this->getMasterKeyFromContext());
        });

        return $data;
    }

    /**
     * Deletes an item
     *
     * @param $id
     *
     * @throws NoSuchItemException
     * @throws ConstraintException
     * @throws QueryException
     */
    public function delete($id)
    {
        if ($this->pluginRepository->delete($id) === 0) {
            throw new NoSuchItemException(__u('Plugin\'s data not found'), NoSuchItemException::INFO);
        }
    }

    /**
     * Deletes an item
     *
     * @param string $name
     * @param int    $itemId
     *
     * @return void
     * @throws NoSuchItemException
     * @throws ConstraintException
     * @throws QueryException
     */
    public function deleteByItemId(string $name, int $itemId)
    {
        if ($this->pluginRepository->deleteByItemId($name, $itemId) === 0) {
            throw new NoSuchItemException(__u('Plugin\'s data not found'), NoSuchItemException::INFO);
        }
    }

    protected function initialize()
    {
        $this->pluginRepository = $this->dic->get(PluginDataRepository::class);
    }
}