sysPass/app/modules/web/Controllers/ConfigLdap/ImportController.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\Modules\Web\Controllers\ConfigLdap;

use SP\Core\Application;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
use SP\Domain\Auth\Providers\Ldap\LdapException;
use SP\Domain\Auth\Providers\Ldap\LdapParams;
use SP\Domain\Common\Attributes\Action;
use SP\Domain\Common\Dtos\ActionResponse;
use SP\Domain\Common\Enums\ResponseType;
use SP\Domain\Core\Acl\AclActionsInterface;
use SP\Domain\Core\Acl\UnauthorizedPageException;
use SP\Domain\Core\Exceptions\SessionTimeout;
use SP\Domain\Core\Exceptions\SPException;
use SP\Domain\Core\Exceptions\ValidationException;
use SP\Domain\Import\Dtos\LdapImportParamsDto;
use SP\Domain\Import\Ports\LdapImportService;
use SP\Modules\Web\Controllers\SimpleControllerBase;
use SP\Mvc\Controller\SimpleControllerHelper;

use function SP\__;
use function SP\__u;

/**
 * Class ImportController
 */
final class ImportController extends SimpleControllerBase
{
    public function __construct(
        Application                        $application,
        SimpleControllerHelper             $simpleControllerHelper,
        private readonly LdapImportService $ldapImportService
    ) {
        parent::__construct($application, $simpleControllerHelper);
    }

    /**
     * @throws ValidationException
     * @throws LdapException
     * @throws SPException
     */
    #[Action(ResponseType::JSON)]
    public function importAction(): ActionResponse
    {
        if ($this->configData->isDemoEnabled()) {
            return ActionResponse::warning(__u('Ey, this is a DEMO!!'));
        }

        [$ldapImportParams, $checkImportGroups] = $this->getImportParams();

        $ldapParams = LdapParams::fromRequest($this->request);

        $this->eventDispatcher->notify(
            'import.ldap.start',
            new Event($this, EventMessage::build(__u('LDAP Import')))
        );

        $userImportResults = $this->ldapImportService->importUsers($ldapParams, $ldapImportParams);
        $totalObjects = $userImportResults->getTotalObjects();

        if ($checkImportGroups === true) {
            $groupsImportResults = $this->ldapImportService->importGroups($ldapParams, $ldapImportParams);
            $totalObjects += $groupsImportResults->getTotalObjects();
        }

        $this->eventDispatcher->notify(
            'import.ldap.end',
            new Event($this, EventMessage::build(__u('Import finished')))
        );

        if ($totalObjects === 0) {
            throw SPException::warning(__u('There aren\'t any objects to synchronize'));
        }

        return ActionResponse::ok(
            __u('LDAP users import finished'),
            [
                sprintf(
                    __('Imported users: %d / %d'),
                    $userImportResults->getSyncedObjects(),
                    $userImportResults->getTotalObjects()
                ),
                sprintf(__('Errors: %d'), $userImportResults->getErrorObjects()),
            ]
        );
    }

    /**
     * @return array
     * @throws ValidationException
     */
    private function getImportParams(): array
    {
        $ldapImportParams = new LdapImportParamsDto(
            $this->request->analyzeInt('ldap_defaultgroup'),
            $this->request->analyzeInt('ldap_defaultprofile'),
            $this->request->analyzeString('ldap_login_attribute'),
            $this->request->analyzeString('ldap_username_attribute'),
            $this->request->analyzeString('ldap_groupname_attribute'),
            $this->request->analyzeString('ldap_import_filter')
        );

        $checkImportGroups = $this->request->analyzeBool('ldap_import_groups', false);

        if ((empty($ldapImportParams->getLoginAttribute())
             || empty($ldapImportParams->getUserNameAttribute())
             || empty($ldapImportParams->getDefaultUserGroup())
             || empty($ldapImportParams->getDefaultUserProfile()))
            && ($checkImportGroups === true && empty($ldapImportParams->getUserGroupNameAttribute()))
        ) {
            throw ValidationException::error(__u('Wrong LDAP parameters'));
        }

        return array($ldapImportParams, $checkImportGroups);
    }

    /**
     * @throws SessionTimeout
     * @throws UnauthorizedPageException
     * @throws SPException
     */
    protected function initialize(): void
    {
        $this->checks();
        $this->checkAccess(AclActionsInterface::CONFIG_LDAP);

        $this->extensionChecker->checkLdap(true);
    }
}