refactor: [WIP] Migrate custom field controller.

Signed-off-by: Rubén D <nuxsmin@syspass.org>

app/modules/web/Controllers/CustomField/CreateController.php

@@ -0,0 +1,72 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Http\JsonResponse;
+use SP\Modules\Web\Controllers\Traits\JsonTrait;
+
+/**
+ * Class CreateController
+ */
+final class CreateController extends CustomFieldViewBase
+{
+    use JsonTrait;
+
+    /**
+     * @return bool
+     * @throws \JsonException
+     */
+    public function createAction(): bool
+    {
+        try {
+            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_CREATE)) {
+                return $this->returnJsonResponse(
+                    JsonResponse::JSON_ERROR,
+                    __u('You don\'t have permission to do this operation')
+                );
+            }
+
+            $this->view->assign('header', __('New Field'));
+            $this->view->assign('isView', false);
+            $this->view->assign('route', 'customField/saveCreate');
+
+            $this->setViewData();
+
+            $this->eventDispatcher->notifyEvent('show.customField.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);
+        }
+    }
+}

app/modules/web/Controllers/CustomField/CustomFieldSaveBase.php

@@ -0,0 +1,54 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+
+use SP\Core\Application;
+use SP\Domain\CustomField\CustomFieldDefServiceInterface;
+use SP\Modules\Web\Controllers\ControllerBase;
+use SP\Modules\Web\Forms\CustomFieldDefForm;
+use SP\Mvc\Controller\WebControllerHelper;
+
+/**
+ * Class CustomFieldSaveBase
+ */
+abstract class CustomFieldSaveBase extends ControllerBase
+{
+    protected CustomFieldDefServiceInterface $customFieldDefService;
+    protected CustomFieldDefForm             $form;
+
+    public function __construct(
+        Application $application,
+        WebControllerHelper $webControllerHelper,
+        CustomFieldDefServiceInterface $customFieldDefService
+    ) {
+        parent::__construct($application, $webControllerHelper);
+
+        $this->checkLoggedIn();
+
+        $this->customFieldDefService = $customFieldDefService;
+        $this->form = new CustomFieldDefForm($application, $this->request);
+    }
+}

app/modules/web/Controllers/CustomField/CustomFieldViewBase.php

@@ -0,0 +1,100 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+
+use SP\Core\Acl\Acl;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Application;
+use SP\Core\Exceptions\ConstraintException;
+use SP\Core\Exceptions\QueryException;
+use SP\DataModel\CustomFieldDefinitionData;
+use SP\Domain\CustomField\CustomFieldDefServiceInterface;
+use SP\Domain\CustomField\CustomFieldTypeServiceInterface;
+use SP\Domain\CustomField\Services\CustomFieldDefService;
+use SP\Infrastructure\Common\Repositories\NoSuchItemException;
+use SP\Modules\Web\Controllers\ControllerBase;
+use SP\Mvc\Controller\WebControllerHelper;
+use SP\Mvc\View\Components\SelectItemAdapter;
+
+abstract class CustomFieldViewBase extends ControllerBase
+{
+    private CustomFieldDefServiceInterface  $customFieldDefService;
+    private CustomFieldTypeServiceInterface $customFieldTypeService;
+
+    public function __construct(
+        Application $application,
+        WebControllerHelper $webControllerHelper,
+        CustomFieldDefServiceInterface $customFieldDefService,
+        CustomFieldTypeServiceInterface $customFieldTypeService
+    ) {
+        parent::__construct($application, $webControllerHelper);
+
+        $this->checkLoggedIn();
+
+        $this->customFieldDefService = $customFieldDefService;
+        $this->customFieldTypeService = $customFieldTypeService;
+    }
+
+    /**
+     * Sets view data for displaying custom field's data
+     *
+     * @param  int|null  $customFieldId
+     *
+     * @throws ConstraintException
+     * @throws QueryException
+     * @throws NoSuchItemException
+     */
+    protected function setViewData(?int $customFieldId = null): void
+    {
+        $this->view->addTemplate('custom_field', 'itemshow');
+
+        $customField = $customFieldId
+            ? $this->customFieldDefService->getById($customFieldId)
+            : new CustomFieldDefinitionData();
+
+        $this->view->assign('field', $customField);
+        $this->view->assign(
+            'types',
+            SelectItemAdapter::factory($this->customFieldTypeService->getAllBasic())
+                ->getItemsFromModelSelected([$customField->getTypeId()])
+        );
+        $this->view->assign(
+            'modules',
+            SelectItemAdapter::factory(CustomFieldDefService::getFieldModules())
+                ->getItemsFromArraySelected([$customField->getModuleId()])
+        );
+
+        $this->view->assign('nextAction', Acl::getActionRoute(ActionsInterface::ITEMS_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);
+        }
+    }
+}

app/modules/web/Controllers/CustomField/DeleteController.php

@@ -0,0 +1,85 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Core\Events\EventMessage;
+use SP\Http\JsonResponse;
+use SP\Modules\Web\Controllers\Traits\JsonTrait;
+use SP\Mvc\Controller\ItemTrait;
+
+/**
+ * Class DeleteController
+ */
+final class DeleteController extends CustomFieldSaveBase
+{
+    use JsonTrait, ItemTrait;
+
+    /**
+     * Delete action
+     *
+     * @param  int|null  $id
+     *
+     * @return bool
+     * @throws \JsonException
+     */
+    public function deleteAction(?int $id = null): bool
+    {
+        try {
+            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_DELETE)) {
+                return $this->returnJsonResponse(
+                    JsonResponse::JSON_ERROR,
+                    __u('You don\'t have permission to do this operation')
+                );
+            }
+
+            if ($id === null) {
+                $this->customFieldDefService->deleteByIdBatch($this->getItemsIdFromRequest($this->request));
+
+                $this->eventDispatcher->notifyEvent(
+                    'delete.customField.selection',
+                    new Event($this, EventMessage::factory()->addDescription(__u('Fields deleted')))
+                );
+
+                return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Fields deleted'));
+            }
+
+            $this->customFieldDefService->delete($id);
+
+            $this->eventDispatcher->notifyEvent('delete.customField', new Event($this));
+
+            return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Field deleted'));
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->eventDispatcher->notifyEvent('exception', new Event($e));
+
+            return $this->returnJsonResponseException($e);
+        }
+    }
+}

app/modules/web/Controllers/CustomField/EditController.php

@@ -0,0 +1,76 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Http\JsonResponse;
+use SP\Modules\Web\Controllers\Traits\JsonTrait;
+
+/**
+ * Class EditController
+ */
+final class EditController extends CustomFieldViewBase
+{
+    use JsonTrait;
+
+    /**
+     * Edit action
+     *
+     * @param  int  $id
+     *
+     * @return bool
+     * @throws \JsonException
+     */
+    public function editAction(int $id): bool
+    {
+        try {
+            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_EDIT)) {
+                return $this->returnJsonResponse(
+                    JsonResponse::JSON_ERROR,
+                    __u('You don\'t have permission to do this operation')
+                );
+            }
+
+            $this->view->assign('header', __('Edit Field'));
+            $this->view->assign('isView', false);
+            $this->view->assign('route', 'customField/saveEdit/'.$id);
+
+            $this->setViewData($id);
+
+            $this->eventDispatcher->notifyEvent('show.customField.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);
+        }
+    }
+}

app/modules/web/Controllers/CustomField/SaveCreateController.php

@@ -0,0 +1,87 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Core\Events\EventMessage;
+use SP\Core\Exceptions\ValidationException;
+use SP\Http\JsonResponse;
+use SP\Modules\Web\Controllers\Traits\JsonTrait;
+
+/**
+ * Class SaveCreateController
+ */
+final class SaveCreateController extends CustomFieldSaveBase
+{
+    use JsonTrait;
+
+    /**
+     * @return bool
+     * @throws \JsonException
+     */
+    public function saveCreateAction(): bool
+    {
+        try {
+            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_CREATE)) {
+                return $this->returnJsonResponse(
+                    JsonResponse::JSON_ERROR,
+                    __u('You don\'t have permission to do this operation')
+                );
+            }
+
+            $this->form->validateFor(ActionsInterface::CUSTOMFIELD_CREATE);
+
+            $itemData = $this->form->getItemData();
+
+            $this->customFieldDefService->create($itemData);
+
+            $this->eventDispatcher->notifyEvent(
+                'create.customField',
+                new Event(
+                    $this,
+                    EventMessage::factory()
+                        ->addDescription(__u('Field added'))
+                        ->addDetail(__u('Field'), $itemData->getName())
+                )
+            );
+
+            return $this->returnJsonResponse(
+                JsonResponse::JSON_SUCCESS,
+                __u('Field added')
+            );
+        } catch (ValidationException $e) {
+            return $this->returnJsonResponseException($e);
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->eventDispatcher->notifyEvent('exception', new Event($e));
+
+            return $this->returnJsonResponseException($e);
+        }
+    }
+}

app/modules/web/Controllers/CustomField/SaveEditController.php

@@ -0,0 +1,88 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Core\Events\EventMessage;
+use SP\Core\Exceptions\ValidationException;
+use SP\Http\JsonResponse;
+use SP\Modules\Web\Controllers\Traits\JsonTrait;
+
+/**
+ * Class SaveEditController
+ */
+final class SaveEditController extends CustomFieldSaveBase
+{
+    use JsonTrait;
+
+    /**
+     * Saves edit action
+     *
+     * @param  int  $id
+     *
+     * @return bool
+     * @throws \JsonException
+     */
+    public function saveEditAction(int $id): bool
+    {
+        try {
+            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_EDIT)) {
+                return $this->returnJsonResponse(
+                    JsonResponse::JSON_ERROR,
+                    __u('You don\'t have permission to do this operation')
+                );
+            }
+
+            $this->form->validateFor(ActionsInterface::CUSTOMFIELD_EDIT, $id);
+
+            $itemData = $this->form->getItemData();
+
+            $this->customFieldDefService->update($itemData);
+
+            $this->eventDispatcher->notifyEvent(
+                'edit.customField',
+                new Event(
+                    $this,
+                    EventMessage::factory()
+                        ->addDescription(__u('Field updated'))
+                        ->addDetail(__u('Field'), $itemData->getName())
+                )
+            );
+
+            return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Field updated'));
+        } catch (ValidationException $e) {
+            return $this->returnJsonResponseException($e);
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->eventDispatcher->notifyEvent('exception', new Event($e));
+
+            return $this->returnJsonResponseException($e);
+        }
+    }
+}

app/modules/web/Controllers/CustomField/SearchController.php

@@ -0,0 +1,107 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Application;
+use SP\Core\Exceptions\ConstraintException;
+use SP\Core\Exceptions\QueryException;
+use SP\Domain\CustomField\CustomFieldDefServiceInterface;
+use SP\Html\DataGrid\DataGridInterface;
+use SP\Http\JsonResponse;
+use SP\Modules\Web\Controllers\ControllerBase;
+use SP\Modules\Web\Controllers\Helpers\Grid\CustomFieldGrid;
+use SP\Modules\Web\Controllers\Traits\JsonTrait;
+use SP\Mvc\Controller\ItemTrait;
+use SP\Mvc\Controller\WebControllerHelper;
+
+/**
+ * Class SearchController
+ */
+final class SearchController extends ControllerBase
+{
+    use JsonTrait, ItemTrait;
+
+    private CustomFieldDefServiceInterface $customFieldDefService;
+    private CustomFieldGrid                $customFieldGrid;
+
+    public function __construct(
+        Application $application,
+        WebControllerHelper $webControllerHelper,
+        CustomFieldDefServiceInterface $customFieldDefService,
+        CustomFieldGrid $customFieldGrid
+    ) {
+        parent::__construct($application, $webControllerHelper);
+
+        $this->checkLoggedIn();
+
+        $this->customFieldDefService = $customFieldDefService;
+        $this->customFieldGrid = $customFieldGrid;
+    }
+
+    /**
+     * Search action
+     *
+     * @return bool
+     * @throws \JsonException
+     * @throws \SP\Core\Exceptions\ConstraintException
+     * @throws \SP\Core\Exceptions\QueryException
+     */
+    public function searchAction(): bool
+    {
+        if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_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
+     *
+     * @throws ConstraintException
+     * @throws QueryException
+     */
+    protected function getSearchGrid(): DataGridInterface
+    {
+        $itemSearchData = $this->getSearchData(
+            $this->configData->getAccountCount(),
+            $this->request
+        );
+
+        return $this->customFieldGrid->updatePager(
+            $this->customFieldGrid->getGrid($this->customFieldDefService->search($itemSearchData)),
+            $itemSearchData
+        );
+    }
+}

app/modules/web/Controllers/CustomField/ViewController.php

@@ -0,0 +1,76 @@
+<?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\Modules\Web\Controllers\CustomField;
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Http\JsonResponse;
+use SP\Modules\Web\Controllers\Traits\JsonTrait;
+
+/**
+ * Class CustomFieldController
+ *
+ * @package SP\Modules\Web\Controllers
+ */
+final class ViewController extends CustomFieldViewBase
+{
+    use JsonTrait;
+
+    /**
+     * View action
+     *
+     * @param  int  $id
+     *
+     * @return bool
+     * @throws \JsonException
+     */
+    public function viewAction(int $id): bool
+    {
+        try {
+            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_VIEW)) {
+                return $this->returnJsonResponse(
+                    JsonResponse::JSON_ERROR,
+                    __u('You don\'t have permission to do this operation')
+                );
+            }
+
+            $this->view->assign('header', __('View Field'));
+            $this->view->assign('isView', true);
+
+            $this->setViewData($id);
+
+            $this->eventDispatcher->notifyEvent('show.customField', new Event($this));
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->eventDispatcher->notifyEvent('exception', new Event($e));
+
+            return $this->returnJsonResponse(JsonResponse::JSON_ERROR, $e->getMessage());
+        }
+
+        return $this->returnJsonResponseData(['html' => $this->render()]);
+    }
+}

app/modules/web/Controllers/CustomFieldController.php

@@ -1,471 +0,0 @@
-<?php
-/*
- * sysPass
- *
- * @author nuxsmin
- * @link https://syspass.org
- * @copyright 2012-2021, 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\Acl\ActionsInterface;
-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\ValidationException;
-use SP\DataModel\CustomFieldDefinitionData;
-use SP\Domain\Auth\Services\AuthException;
-use SP\Domain\CustomField\Services\CustomFieldDefService;
-use SP\Domain\CustomField\Services\CustomFieldTypeService;
-use SP\Html\DataGrid\DataGridInterface;
-use SP\Http\JsonResponse;
-use SP\Infrastructure\Common\Repositories\NoSuchItemException;
-use SP\Modules\Web\Controllers\Helpers\Grid\CustomFieldGrid;
-use SP\Modules\Web\Controllers\Traits\JsonTrait;
-use SP\Modules\Web\Forms\CustomFieldDefForm;
-use SP\Mvc\Controller\CrudControllerInterface;
-use SP\Mvc\Controller\ItemTrait;
-use SP\Mvc\View\Components\SelectItemAdapter;
-
-/**
- * Class CustomFieldController
- *
- * @package SP\Modules\Web\Controllers
- */
-final class CustomFieldController extends ControllerBase implements CrudControllerInterface
-{
-    use JsonTrait, ItemTrait;
-
-    protected ?CustomFieldDefService $customFieldService = null;
-
-    /**
-     * Search action
-     *
-     * @return bool
-     * @throws \DI\DependencyException
-     * @throws \DI\NotFoundException
-     * @throws \JsonException
-     * @throws \SP\Core\Exceptions\ConstraintException
-     * @throws \SP\Core\Exceptions\QueryException
-     */
-    public function searchAction(): bool
-    {
-        if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_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
-     *
-     * @throws DependencyException
-     * @throws NotFoundException
-     * @throws ConstraintException
-     * @throws QueryException
-     */
-    protected function getSearchGrid(): DataGridInterface
-    {
-        $itemSearchData = $this->getSearchData(
-            $this->configData->getAccountCount(),
-            $this->request
-        );
-
-        $customFieldGrid = $this->dic->get(CustomFieldGrid::class);
-
-        return $customFieldGrid->updatePager(
-            $customFieldGrid->getGrid($this->customFieldService->search($itemSearchData)),
-            $itemSearchData
-        );
-    }
-
-    /**
-     * @return bool
-     * @throws \DI\DependencyException
-     * @throws \DI\NotFoundException
-     * @throws \JsonException
-     */
-    public function createAction(): bool
-    {
-        try {
-            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_CREATE)) {
-                return $this->returnJsonResponse(
-                    JsonResponse::JSON_ERROR,
-                    __u('You don\'t have permission to do this operation')
-                );
-            }
-
-            $this->view->assign('header', __('New Field'));
-            $this->view->assign('isView', false);
-            $this->view->assign('route', 'customField/saveCreate');
-
-            $this->setViewData();
-
-            $this->eventDispatcher->notifyEvent(
-                'show.customField.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 custom field's data
-     *
-     * @param int|null $customFieldId
-     *
-     * @throws ConstraintException
-     * @throws QueryException
-     * @throws NoSuchItemException
-     */
-    protected function setViewData(?int $customFieldId = null): void
-    {
-        $this->view->addTemplate('custom_field', 'itemshow');
-
-        $customField = $customFieldId
-            ? $this->customFieldService->getById($customFieldId)
-            : new CustomFieldDefinitionData();
-
-        $this->view->assign('field', $customField);
-        $this->view->assign(
-            'types',
-            SelectItemAdapter::factory(CustomFieldTypeService::getItemsBasic())
-                ->getItemsFromModelSelected([$customField->getTypeId()])
-        );
-        $this->view->assign(
-            'modules',
-            SelectItemAdapter::factory(CustomFieldDefService::getFieldModules())
-                ->getItemsFromArraySelected([$customField->getModuleId()])
-        );
-
-        $this->view->assign(
-            'nextAction',
-            Acl::getActionRoute(ActionsInterface::ITEMS_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);
-        }
-    }
-
-    /**
-     * Edit action
-     *
-     * @param int $id
-     *
-     * @return bool
-     * @throws DependencyException
-     * @throws NotFoundException
-     * @throws \JsonException
-     */
-    public function editAction(int $id): bool
-    {
-        try {
-            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_EDIT)) {
-                return $this->returnJsonResponse(
-                    JsonResponse::JSON_ERROR,
-                    __u('You don\'t have permission to do this operation')
-                );
-            }
-
-            $this->view->assign('header', __('Edit Field'));
-            $this->view->assign('isView', false);
-            $this->view->assign('route', 'customField/saveEdit/' . $id);
-
-            $this->setViewData($id);
-
-            $this->eventDispatcher->notifyEvent(
-                'show.customField.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 int|null $id
-     *
-     * @return bool
-     * @throws \DI\DependencyException
-     * @throws \DI\NotFoundException
-     * @throws \JsonException
-     */
-    public function deleteAction(?int $id = null): bool
-    {
-        try {
-            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_DELETE)) {
-                return $this->returnJsonResponse(
-                    JsonResponse::JSON_ERROR,
-                    __u('You don\'t have permission to do this operation')
-                );
-            }
-
-            if ($id === null) {
-                $this->customFieldService
-                    ->deleteByIdBatch($this->getItemsIdFromRequest($this->request));
-
-                $this->eventDispatcher->notifyEvent(
-                    'delete.customField.selection',
-                    new Event(
-                        $this,
-                        EventMessage::factory()
-                            ->addDescription(__u('Fields deleted'))
-                    )
-                );
-
-                return $this->returnJsonResponse(
-                    JsonResponse::JSON_SUCCESS,
-                    __u('Fields deleted')
-                );
-            }
-
-            $this->customFieldService->delete($id);
-
-            $this->eventDispatcher->notifyEvent(
-                'delete.customField',
-                new Event($this)
-            );
-
-            return $this->returnJsonResponse(
-                JsonResponse::JSON_SUCCESS,
-                __u('Field deleted')
-            );
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->eventDispatcher->notifyEvent(
-                'exception',
-                new Event($e)
-            );
-
-            return $this->returnJsonResponseException($e);
-        }
-    }
-
-    /**
-     * @return bool
-     * @throws DependencyException
-     * @throws NotFoundException
-     * @throws \JsonException
-     */
-    public function saveCreateAction(): bool
-    {
-        try {
-            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_CREATE)) {
-                return $this->returnJsonResponse(
-                    JsonResponse::JSON_ERROR,
-                    __u('You don\'t have permission to do this operation')
-                );
-            }
-
-            $form = new CustomFieldDefForm($this->dic);
-            $form->validateFor(ActionsInterface::CUSTOMFIELD_CREATE, null);
-
-            $itemData = $form->getItemData();
-
-            $this->customFieldService->create($itemData);
-
-            $this->eventDispatcher->notifyEvent(
-                'create.customField',
-                new Event(
-                    $this,
-                    EventMessage::factory()
-                        ->addDescription(__u('Field added'))
-                        ->addDetail(__u('Field'), $itemData->getName())
-                )
-            );
-
-            return $this->returnJsonResponse(
-                JsonResponse::JSON_SUCCESS,
-                __u('Field added')
-            );
-        } catch (ValidationException $e) {
-            return $this->returnJsonResponseException($e);
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->eventDispatcher->notifyEvent(
-                'exception',
-                new Event($e)
-            );
-
-            return $this->returnJsonResponseException($e);
-        }
-    }
-
-    /**
-     * Saves edit action
-     *
-     * @param int $id
-     *
-     * @return bool
-     * @throws DependencyException
-     * @throws NotFoundException
-     * @throws \JsonException
-     */
-    public function saveEditAction(int $id): bool
-    {
-        try {
-            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_EDIT)) {
-                return $this->returnJsonResponse(
-                    JsonResponse::JSON_ERROR,
-                    __u('You don\'t have permission to do this operation')
-                );
-            }
-
-            $form = new CustomFieldDefForm($this->dic, $id);
-            $form->validateFor(ActionsInterface::CUSTOMFIELD_EDIT, null);
-
-            $itemData = $form->getItemData();
-
-            $this->customFieldService->update($itemData);
-
-            $this->eventDispatcher->notifyEvent(
-                'edit.customField',
-                new Event(
-                    $this,
-                    EventMessage::factory()
-                        ->addDescription(__u('Field updated'))
-                        ->addDetail(__u('Field'), $itemData->getName())
-                )
-            );
-
-            return $this->returnJsonResponse(
-                JsonResponse::JSON_SUCCESS,
-                __u('Field updated')
-            );
-        } catch (ValidationException $e) {
-            return $this->returnJsonResponseException($e);
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->eventDispatcher->notifyEvent(
-                'exception',
-                new Event($e)
-            );
-
-            return $this->returnJsonResponseException($e);
-        }
-    }
-
-    /**
-     * View action
-     *
-     * @param int $id
-     *
-     * @return bool
-     * @throws \DI\DependencyException
-     * @throws \DI\NotFoundException
-     * @throws \JsonException
-     */
-    public function viewAction(int $id): bool
-    {
-        try {
-            if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_VIEW)) {
-                return $this->returnJsonResponse(
-                    JsonResponse::JSON_ERROR,
-                    __u('You don\'t have permission to do this operation')
-                );
-            }
-
-            $this->view->assign('header', __('View Field'));
-            $this->view->assign('isView', true);
-
-            $this->setViewData($id);
-
-            $this->eventDispatcher->notifyEvent(
-                'show.customField',
-                new Event($this)
-            );
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->eventDispatcher->notifyEvent(
-                'exception',
-                new Event($e)
-            );
-
-            return $this->returnJsonResponse(
-                JsonResponse::JSON_ERROR,
-                $e->getMessage()
-            );
-        }
-
-        return $this->returnJsonResponseData(['html' => $this->render()]);
-    }
-
-    /**
-     * Initialize class
-     *
-     * @throws AuthException
-     * @throws DependencyException
-     * @throws NotFoundException
-     * @throws SessionTimeout
-     */
-    protected function initialize(): void
-    {
-        $this->checkLoggedIn();
-
-        $this->customFieldService = $this->dic->get(CustomFieldDefService::class);
-    }
-
-}

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

@@ -239,9 +239,11 @@ final class CustomFieldService extends Service implements CustomFieldServiceInte
     /**
      * Updates an item
      *
+     * @param  \SP\DataModel\CustomFieldData  $customFieldData
+     * @param  string  $masterPass
+     *
+     * @return int
      * @throws \Defuse\Crypto\Exception\CryptoException
-     * @throws \SP\Core\Exceptions\ConstraintException
-     * @throws \SP\Core\Exceptions\QueryException
      * @throws \SP\Domain\Common\Services\ServiceException
      */
     public function updateMasterPass(CustomFieldData $customFieldData, string $masterPass): int