AuthTokenController::searchAction() - Code Metrics - Inspection of "Add permission to only view current users API auth..." - nuxsmin/sysPass - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#1516)

unknown
created 2020-01-24 13:46 UTC
AuthTokenController::searchAction() A

↳ Parent: AuthTokenController
Complexity

Conditions	2
Paths	2
Size

Total Lines	13
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	7
nc	2
nop	0
dl	0
loc	13
rs	10
c	0
b	0
f	0
<?php
/**
 * sysPass
 *
 * @author    nuxsmin
 * @link      https://syspass.org
 * @copyright 2012-2019, 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\Modules\Web\Controllers;

use DI\DependencyException;
use DI\NotFoundException;
use Exception;
use SP\Core\Acl\Acl;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
use SP\Core\Exceptions\ConstraintException;
use SP\Core\Exceptions\QueryException;
use SP\Core\Exceptions\SessionTimeout;
use SP\Core\Exceptions\SPException;
use SP\Core\Exceptions\ValidationException;
use SP\DataModel\AuthTokenData;
use SP\Http\JsonResponse;
use SP\Modules\Web\Controllers\Helpers\Grid\AuthTokenGrid;
use SP\Modules\Web\Controllers\Traits\ItemTrait;
use SP\Modules\Web\Controllers\Traits\JsonTrait;
use SP\Modules\Web\Forms\AuthTokenForm;
use SP\Mvc\Controller\CrudControllerInterface;
use SP\Mvc\View\Components\SelectItemAdapter;
use SP\Services\Auth\AuthException;
use SP\Services\AuthToken\AuthTokenService;
use SP\Services\ServiceException;
use SP\Services\User\UserService;

/**
 * Class AuthTokenController
 *
 * @package SP\Modules\Web\Controllers
 */
final class AuthTokenController extends ControllerBase implements CrudControllerInterface
{
    use JsonTrait, ItemTrait;


    /**
     * @var AuthTokenService
     */
    protected $authTokenService;

    /**
     * @var UserService
     */
    protected $userService;

    /**
     * Search action
     *
     * @return bool
     * @throws DependencyException
     * @throws NotFoundException
     * @throws ConstraintException
     * @throws QueryException
     * @throws SPException
     */
    public function searchAction()
    {
        $this->checkSecurityToken($this->previousSk, $this->request);

        if (!$this->acl->checkUserAccess(Acl::AUTHTOKEN_SEARCH)) {
            return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation'));
        }

        $this->view->addTemplate('datagrid-table', 'grid');
        $this->view->assign('index', $this->request->analyzeInt('activetab', 0));
        $this->view->assign('data', $this->getSearchGrid());

        return $this->returnJsonResponseData(['html' => $this->render()]);
    }

    /**
     * getSearchGrid
     *
     * @return $this
     * @throws DependencyException
     * @throws NotFoundException
     * @throws ConstraintException
     * @throws QueryException
     */
    protected function getSearchGrid()
    {
        $itemSearchData = $this->getSearchData($this->configData->getAccountCount(), $this->request);

        $authTokenGrid = $this->dic->get(AuthTokenGrid::class);

        return $authTokenGrid->updatePager(
            $authTokenGrid->getGrid($this->authTokenService->search($itemSearchData)),
            $itemSearchData
        );
    }

    /**
     * Create action
     */
    public function createAction()
    {
        try {
            $this->checkSecurityToken($this->previousSk, $this->request);

            if (!$this->acl->checkUserAccess(Acl::AUTHTOKEN_CREATE)) {
                return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation'));
            }

            $this->view->assign('header', __('New Authorization'));
            $this->view->assign('isView', false);
            $this->view->assign('route', 'authToken/saveCreate');

            $this->setViewData();

            $this->eventDispatcher->notifyEvent('show.authToken.create', new Event($this));

            return $this->returnJsonResponseData(['html' => $this->render()]);
        } catch (Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception', new Event($e));

            return $this->returnJsonResponseException($e);
        }
    }

    /**
     * Sets view data for displaying auth token's data
     *
     * @param $authTokenId
     *
     * @throws ConstraintException
     * @throws QueryException
     * @throws ServiceException
     */
    protected function setViewData($authTokenId = null)
    {
        $this->view->addTemplate('auth_token', 'itemshow');

        $authToken = $authTokenId ? $this->authTokenService->getById($authTokenId) : new AuthTokenData();
        $this->view->assign('authToken', $authToken);

        if($this->acl->checkUserAccess(Acl::AUTHTOKEN_ONLY_USER) && !$this->session->getUserData()->getIsAdminApp()) {
            $tokenUserId = $this->session->getUserData()->getId();
            $selectItems = [$this->userService->getById($tokenUserId)];
        } else {
            $selectItems = UserService::getItemsBasic();
        }

        $this->view->assign('users', SelectItemAdapter::factory($selectItems)->getItemsFromModelSelected([$authToken->getUserId()]));
        $this->view->assign('actions', SelectItemAdapter::factory(AuthTokenService::getTokenActions())->getItemsFromArraySelected([$authToken->getActionId()]));

        $this->view->assign('nextAction', Acl::getActionRoute(Acl::ACCESS_MANAGE));

        if ($this->view->isView === true) {

            $this->view->assign('disabled', 'disabled');
            $this->view->assign('readonly', 'readonly');
        } else {
            $this->view->assign('disabled', false);
            $this->view->assign('readonly', false);
        }

        $this->view->assign('customFields', $this->getCustomFieldsForItem(Acl::AUTHTOKEN, $authTokenId));
    }

    /**
     * Edit action
     *
     * @param $id
     *
     * @return bool
     */
    public function editAction($id)
    {
        try {
            $this->checkSecurityToken($this->previousSk, $this->request);
            $tokenUserId = $this->authTokenService->getById($id)->getUserId();

            if (!$this->acl->checkUserAccess(Acl::AUTHTOKEN_EDIT) || !$this->authTokenOnlyUser($tokenUserId)) {
                return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation'));
            }

            $this->view->assign('header', __('Edit Authorization'));
            $this->view->assign('isView', false);
            $this->view->assign('route', 'authToken/saveEdit/' . $id);


            $this->setViewData($id);

            $this->eventDispatcher->notifyEvent('show.authToken.edit', new Event($this));

            return $this->returnJsonResponseData(['html' => $this->render()]);
        } catch (Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception', new Event($e));

            return $this->returnJsonResponseException($e);
        }
    }

    /**
     * Delete action
     *
     * @param $id
     *
     * @return bool
     */
    public function deleteAction($id = null)
    {
        try {
            $this->checkSecurityToken($this->previousSk, $this->request);
            $tokenUserId = $this->authTokenService->getById($id)->getUserId();

            if (!$this->acl->checkUserAccess(Acl::AUTHTOKEN_DELETE) || !$this->authTokenOnlyUser($tokenUserId)) {
                return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation'));
            }

            if ($id === null) {
                $this->authTokenService->deleteByIdBatch($this->getItemsIdFromRequest($this->request));
                $this->authTokenService->deleteByIdBatch(/** @scrutinizer ignore-type */ $this->getItemsIdFromRequest($this->request));

                $this->deleteCustomFieldsForItem(Acl::AUTHTOKEN, $id);

                $this->eventDispatcher->notifyEvent('delete.authToken.selection',
                    new Event($this,
                        EventMessage::factory()
                            ->addDescription(__u('Authorizations deleted')))
                );

                return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Authorizations deleted'));
            }

            $this->authTokenService->delete($id);

            $this->deleteCustomFieldsForItem(Acl::AUTHTOKEN, $id);

            $this->eventDispatcher->notifyEvent('delete.authToken',
                new Event($this,
                    EventMessage::factory()
                        ->addDescription(__u('Authorization deleted'))
                        ->addDetail(__u('Authorization'), $id))
            );

            return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Authorization deleted'));
        } catch (Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception', new Event($e));

            return $this->returnJsonResponseException($e);
        }
    }

    /**
     * Saves create action
     */
    public function saveCreateAction()
    {
        try {
            $this->checkSecurityToken($this->previousSk, $this->request);
            $tokenUserId = $this->session->getUserData()->getId();

            if (!$this->acl->checkUserAccess(Acl::AUTHTOKEN_CREATE) || (!$this->session->getUserData()->getIsAdminApp() && $tokenUserId !== $this->request->analyzeInt('users'))) {
                return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation'));
            }


            $form = new AuthTokenForm($this->dic);
            $form->validate(Acl::AUTHTOKEN_CREATE);
            $form->validate(Acl::AUTHTOKEN_ONLY_USER);

            $apiTokenData = $form->getItemData();

            $id = $this->authTokenService->create($apiTokenData);

            $this->addCustomFieldsForItem(Acl::AUTHTOKEN, $id, $this->request);

            $this->eventDispatcher->notifyEvent('create.authToken', new Event($this));

            return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Authorization added'));
        } catch (ValidationException $e) {
            return $this->returnJsonResponse(JsonResponse::JSON_ERROR, $e->getMessage());
        } catch (Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception', new Event($e));

            return $this->returnJsonResponseException($e);
        }
    }

    /**
     * Saves edit action
     *
     * @param $id
     *
     * @return bool
     */
    public function saveEditAction($id)
    {
        try {
            $this->checkSecurityToken($this->previousSk, $this->request);
            $tokenUserId = $this->authTokenService->getById($id)->getUserId();

            if (!$this->acl->checkUserAccess(Acl::AUTHTOKEN_EDIT) || !$this->authTokenOnlyUser($tokenUserId)) {
             return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation'));
            }

            $form = new AuthTokenForm($this->dic, $id);
            $form->validate(Acl::AUTHTOKEN_EDIT);

            if ($form->isRefresh()) {
                $this->authTokenService->refreshAndUpdate($form->getItemData());

                $this->eventDispatcher->notifyEvent('refresh.authToken',
                    new Event($this,
                        EventMessage::factory()
                            ->addDescription(__u('Authorization updated'))
                            ->addDetail(__u('Authorization'), $id))
                );
            } else {
                $this->authTokenService->update($form->getItemData());

                $this->eventDispatcher->notifyEvent('edit.authToken',
                    new Event($this,
                        EventMessage::factory()
                            ->addDescription(__u('Authorization updated'))
                            ->addDetail(__u('Authorization'), $id))
                );
            }

            $this->updateCustomFieldsForItem(Acl::AUTHTOKEN, $id, $this->request);

            return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Authorization updated'));
        } catch (ValidationException $e) {
            return $this->returnJsonResponse(JsonResponse::JSON_ERROR, $e->getMessage());
        } catch (Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception', new Event($e));

            return $this->returnJsonResponseException($e);
        }
    }

    /**
     * View action
     *
     * @param $id
     *
     * @return bool
     */
    public function viewAction($id)
    {
        try {
            $this->checkSecurityToken($this->previousSk, $this->request);
            $tokenUserId = $this->authTokenService->getById($id)->getUserId();

            if (!$this->acl->checkUserAccess(Acl::AUTHTOKEN_VIEW) || !$this->authTokenOnlyUser($tokenUserId)) {
                return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation'));
            }

            $this->view->assign('header', __('View Authorization'));
            $this->view->assign('isView', true);


            $this->setViewData($id);

            $this->eventDispatcher->notifyEvent('show.authToken',
                new Event($this, EventMessage::factory()
                    ->addDescription(__u('Authorization viewed'))
                    ->addDetail(__u('Authorization'), $id))
            );

            return $this->returnJsonResponseData(['html' => $this->render()]);
        } catch (Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception', new Event($e));

            return $this->returnJsonResponseException($e);
        }
    }

    /**
     * Initialize class
     *
     * @throws AuthException
     * @throws DependencyException
     * @throws NotFoundException
     * @throws SessionTimeout
     */
    protected function initialize()
    {
        $this->checkLoggedIn();

        $this->authTokenService = $this->dic->get(AuthTokenService::class);
        $this->userService = $this->dic->get(UserService::class);
    }

    protected function authTokenOnlyUser($tokenUserId) {
        return $this->session->getUserData()->getIsAdminApp() || ($this->acl->checkUserAccess(Acl::AUTHTOKEN_ONLY_USER) && $tokenUserId == $this->session->getUserData()->getId());
    }
}

nuxsmin / sysPass

Pull Request — master (#1516)

AuthTokenController::searchAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
