PendingRegistrationDatabaseRepository.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Registration\DualOptIn\Repository;
 
use ILIAS\Data\ObjectId;
use ILIAS\Registration\DualOptIn\Entity\PendingRegistration;
use ILIAS\Registration\DualOptIn\ValueObjects\PendingRegistrationHash;
use ILIAS\Registration\DualOptIn\ValueObjects\PendingRegistrationId;
 
final readonly class PendingRegistrationDatabaseRepository implements PendingRegistrationRepository
{
    public function __construct(private \ilDBInterface $db)
    {
    }
 
    public function nextIdentity(): PendingRegistrationId
    {
        return PendingRegistrationId::create();
    }
 
    public function findNewHash(): PendingRegistrationHash
    {
        do {
            $unique_id = uniqid((string) mt_rand(), true);
            $hash = substr(md5($unique_id), 0, 16);
 
            $res = $this->db->queryF(
                'SELECT COUNT(usr_id) cnt FROM reg_dual_opt_in WHERE reg_hash = %s',
                [\ilDBConstants::T_TEXT],
                [$hash]
            );
            $row = $this->db->fetchObject($res);
            if ($row->cnt > 0) {
                continue;
            }
            break;
        } while (true);
 
        return new PendingRegistrationHash($hash);
    }
 
    public function store(PendingRegistration $reg): void
    {
        $this->db->manipulateF(
            'REPLACE INTO reg_dual_opt_in (id, usr_id, reg_hash, creation_date) VALUES (%s, %s, %s, %s)',
            [
                \ilDBConstants::T_TEXT,
                \ilDBConstants::T_INTEGER,
                \ilDBConstants::T_TEXT,
                \ilDBConstants::T_INTEGER
            ],
            [
                $reg->id()->toString(),
                $reg->userId()->toInt(),
                $reg->hash()->toString(),
                $reg->createdAt()->getTimestamp()
            ]
        );
    }
 
    public function findByHashValue(string $hash_value): ?PendingRegistration
    {
        $res = $this->db->queryF(
            'SELECT id, usr_id, reg_hash, creation_date FROM reg_dual_opt_in WHERE reg_hash = %s',
            [\ilDBConstants::T_TEXT],
            [$hash_value]
        );
 
        $row = $this->db->fetchAssoc($res);
        if (!$row) {
            return null;
        }
 
        return $this->rebuildObjFromRow($row);
    }
 
    public function delete(PendingRegistration ...$pending_registrations): void
    {
        if (\count($pending_registrations) === 0) {
            return;
        }
 
        if (\count($pending_registrations) === 1) {
            $this->db->manipulateF(
                'DELETE FROM reg_dual_opt_in WHERE id = %s',
                [\ilDBConstants::T_TEXT],
                [$pending_registrations[0]->id()->toString()]
            );
        } else {
            $ids = array_map(
                static fn(PendingRegistration $pr): string => $pr->id()->toString(),
                $pending_registrations
            );
 
            $this->db->manipulate(
                'DELETE FROM reg_dual_opt_in ' .
                'WHERE ' . $this->db->in('id', $ids, false, \ilDBConstants::T_TEXT)
            );
        }
    }
 
    public function deleteByUserId(int $usr_id): void
    {
        $this->db->manipulateF(
            'DELETE FROM reg_dual_opt_in WHERE usr_id = %s',
            [\ilDBConstants::T_INTEGER],
            [$usr_id]
        );
    }
 
    public function findExpired(int $cutoff_ts, ?int $prioritize_usr_id = null): array
    {
        $except_anon_and_sys = $this->db->in(
            'pr.usr_id',
            [ANONYMOUS_USER_ID, SYSTEM_USER_ID],
            true,
            \ilDBConstants::T_INTEGER
        );
 
        $query = '
            SELECT pr.*
              FROM reg_dual_opt_in pr
              JOIN usr_data ud ON ud.usr_id = pr.usr_id
             WHERE ud.active = 0
               AND pr.creation_date < %s
               AND ' . $except_anon_and_sys . '
             ORDER BY (CASE WHEN pr.usr_id = %s THEN 0 ELSE 1 END), pr.creation_date
         ';
 
        $res = $this->db->queryF(
            $query,
            [\ilDBConstants::T_INTEGER, \ilDBConstants::T_INTEGER],
            [$cutoff_ts, $prioritize_usr_id ?? 0]
        );
 
        $expired_registrations = [];
        while ($row = $this->db->fetchAssoc($res)) {
            $expired_registrations[] = $this->rebuildObjFromRow($row);
        }
 
        return $expired_registrations;
    }
 
    private function rebuildObjFromRow(array $row): PendingRegistration
    {
        $id = new PendingRegistrationId($row['id']);
        $usr_id = new ObjectId($row['usr_id']);
        $reg_hash = new PendingRegistrationHash($row['reg_hash']);
        $created_at = new \DateTimeImmutable('@' . $row['creation_date']);
 
        return new PendingRegistration($id, $usr_id, $reg_hash, $created_at);
    }
}