Inheritance diagram for ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl:

Collaboration diagram for ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl:

Public Member Functions
	__construct (private \ilRegistrationSettings $settings, private PendingRegistrationRepository $pending_reg_repository, private \ilDBInterface $db, private \ilComponentLogger $logger, private ClockFactory $clock_factory)

	distributeMailsOnRegistration (\ilObjUser $user)

	deleteExpiredUserObjects (int $usr_id)

Public Member Functions inherited from ILIAS\Registration\DualOptIn\Service\DualOptInService
	verifyHashAndActivateUser (PendingRegistrationHash $hash)

	distributeMailsOnRegistration (\ilObjUser $user)

	deleteExpiredUserObjects (int $usr_id)

Data Fields
const string	ID = 'reg_hash_service'

Private Member Functions
	findConfirmableRegistration (PendingRegistrationHash $hash)

	createPendingRegistration (int $usr_id)

	activateUser (\ilObjUser $user)

	triggerExpiredUserCleanup (PendingRegistration $expired_reg)

	sendRegistrationMail (\ilObjUser $user, string $password)

Detailed Description

Definition at line 34 of file DualOptInServiceImpl.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl::__construct	(	private \ilRegistrationSettings	$settings,
		private PendingRegistrationRepository	$pending_reg_repository,
		private \ilDBInterface	$db,
		private \ilComponentLogger	$logger,
		private ClockFactory	$clock_factory
	)

Definition at line 38 of file DualOptInServiceImpl.php.

44 {

45 }

Member Function Documentation

◆ activateUser()

ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl::activateUser ( \ilObjUser $user )

private

Definition at line 183 of file DualOptInServiceImpl.php.

                                                   : void
    {
        $user->setActive(true);
 
        $password = '';
        if ($this->settings->passwordGenerationEnabled()) {
            $password = \ilSecuritySettingsChecker::generatePasswords(1)[0];
            $user->setPasswd($password, \ilObjUser::PASSWD_PLAIN);
            $user->setLastPasswordChangeTS($this->clock_factory->utc()->now()->getTimestamp());
        }
 
        $user->update();
 
        $this->sendRegistrationMail($user, $password);
    }

References ilSecuritySettingsChecker\generatePasswords(), ilObjUser\PASSWD_PLAIN, ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl\sendRegistrationMail(), ilObjUser\setActive(), ilObjUser\setLastPasswordChangeTS(), ilObjUser\setPasswd(), ILIAS\Repository\settings(), and ilObjUser\update().

Here is the call graph for this function:

◆ createPendingRegistration()

ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl::createPendingRegistration ( int $usr_id )

private

Definition at line 105 of file DualOptInServiceImpl.php.

                                                           : PendingRegistration
    {
        $pending_reg = new PendingRegistration(
            $this->pending_reg_repository->nextIdentity(),
            new ObjectId($usr_id),
            $this->pending_reg_repository->findNewHash(),
            $this->clock_factory->utc()->now()
        );
        $this->pending_reg_repository->store($pending_reg);
 
        return $pending_reg;
    }

Referenced by ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl\distributeMailsOnRegistration().

Here is the caller graph for this function:

◆ deleteExpiredUserObjects()

ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl::deleteExpiredUserObjects ( int $usr_id )

Implements ILIAS\Registration\DualOptIn\Service\DualOptInService.

Definition at line 118 of file DualOptInServiceImpl.php.

                                                         : void
    {
        $this->logger->debug(
            'Started deletion of inactive user objects with expired confirmation hash values (dual opt in) ...'
        );
 
        $lifetime = $this->settings->getRegistrationHashLifetime();
        if ($lifetime <= 0) {
            $this->logger->debug('Registration hash lifetime is <= 0, skipping deletion.');
            return;
        }
 
        $now = $this->clock_factory->utc()->now();
        $interval = new \DateInterval("PT{$lifetime}S");
        $cutoff = $now->sub($interval);
 
        $expired_regs = array_filter(
            array_map(
                static fn(PendingRegistration $reg): PendingRegistration => $reg->withEvaluatedState($now, $lifetime),
                $this->pending_reg_repository->findExpired($cutoff->getTimestamp(), $usr_id)
            ),
            static fn(PendingRegistration $reg): bool => $reg->isExpired()
        );
 
        $this->logger->info(
            \sprintf(
                '%d inactive user objects eligible for deletion found and deleted (cutoff: %s, lifetime: %d s).',
                \count($expired_regs),
                $cutoff->format(\DateTimeInterface::ATOM),
                $lifetime
            )
        );
 
        $this->pending_reg_repository->delete(...$expired_regs);
 
        $num_deleted_users = 0;
        foreach ($expired_regs as $expired_reg) {
            $user = \ilObjectFactory::getInstanceByObjId($expired_reg->userId()->toInt(), false);
            if (!($user instanceof \ilObjUser)) {
                continue;
            }
 
            $this->logger->info(
                \sprintf(
                    'Deleting user (login: %s | id: %d) – expired dual opt-in (created: %s, cutoff: %s, lifetime: %d s)',
                    $user->getLogin(),
                    $user->getId(),
                    $expired_reg->createdAt()->format(\DateTimeInterface::ATOM),
                    $cutoff->format(\DateTimeInterface::ATOM),
                    $lifetime
                )
            );
 
            $user->delete();
            ++$num_deleted_users;
        }
 
        $this->logger->info(
            \sprintf(
                '%d inactive user objects with expired confirmation hash values (dual opt-in) deleted.',
                $num_deleted_users
            )
        );
    }

References ilObjectFactory\getInstanceByObjId(), ILIAS\Registration\DualOptIn\Entity\PendingRegistration\isExpired(), ILIAS\Repository\logger(), ILIAS\Repository\settings(), and ILIAS\Registration\DualOptIn\Entity\PendingRegistration\withEvaluatedState().

Here is the call graph for this function:

◆ distributeMailsOnRegistration()

ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl::distributeMailsOnRegistration ( \ilObjUser $user )

Implements ILIAS\Registration\DualOptIn\Service\DualOptInService.

Definition at line 92 of file DualOptInServiceImpl.php.

                                                                   : void
    {
        $pending_reg = $this->createPendingRegistration($user->getId());
 
        $mail = new DualOptInMail(
            $user,
            $pending_reg,
            $this->settings->getRegistrationHashLifetime()
        );
        $mail->setRecipients([$user]);
        $mail->send();
    }

References ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl\createPendingRegistration(), ilObject\getId(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ findConfirmableRegistration()

ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl::findConfirmableRegistration ( PendingRegistrationHash $hash )

private

Exceptions

PendingRegistrationNotFoundException
PendingRegistrationExpiredException
PendingRegistrationAlreadyConfirmedException

Definition at line 67 of file DualOptInServiceImpl.php.

                                                                               : PendingRegistration
    {
        $pending_reg = $this->pending_reg_repository->findByHashValue($hash->toString());
        if ($pending_reg === null) {
            throw new PendingRegistrationNotFoundException();
        }
 
        $lifetime = $this->settings->getRegistrationHashLifetime();
        $pending_reg = $pending_reg->withEvaluatedState(
            $this->clock_factory->utc()->now(),
            $lifetime > 0 ? $lifetime : null
        );
 
        if ($pending_reg->isConfirmed()) {
            throw new PendingRegistrationAlreadyConfirmedException();
        }
 
        if ($pending_reg->isExpired()) {
            $this->triggerExpiredUserCleanup($pending_reg);
            throw new PendingRegistrationExpiredException();
        }
 
        return $pending_reg;
    }

References ILIAS\Repository\settings(), ILIAS\Registration\DualOptIn\ValueObjects\PendingRegistrationHash\toString(), and ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl\triggerExpiredUserCleanup().

Here is the call graph for this function:

◆ sendRegistrationMail()

ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl::sendRegistrationMail	(	\ilObjUser	$user,
		string	$password
	)

private

Definition at line 215 of file DualOptInServiceImpl.php.

                                                                             : void
    {
        $account_mail = (new \ilAccountRegistrationMail(
            $this->settings,
            \ilLoggerFactory::getLogger('user'),
            new NewAccountMailRepository($this->db)
        ))->withEmailConfirmationRegistrationMode();
 
        if ($user->getPref('reg_target') ?? '') {
            $account_mail = $account_mail->withPermanentLinkTarget($user->getPref('reg_target'));
        }
 
        $account_mail->send($user, $password);
    }

References ilLoggerFactory\getLogger(), ilObjUser\getPref(), and ILIAS\Repository\settings().

Referenced by ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl\activateUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ triggerExpiredUserCleanup()

ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl::triggerExpiredUserCleanup ( PendingRegistration $expired_reg )

private

Definition at line 199 of file DualOptInServiceImpl.php.

                                                                                : void
    {
        $soap_client = new \ilSoapClient();
        $soap_client->setResponseTimeout(1);
        $soap_client->enableWSDL(true);
        $soap_client->init();
 
        $this->logger->info(
            'Triggered soap call (background process) for deletion of inactive ' .
            'user objects with expired confirmation hash values (dual opt in) ...'
        );
 
        $sid = session_id() . '::' . CLIENT_ID;
        $soap_client->call('deleteExpiredDualOptInUserObjects', [$sid, $expired_reg->userId()->toInt()]);
    }