TempUserDetailsLookup.php

Go to the documentation of this file.

<?php
declare( strict_types=1 );
namespace MediaWiki\User\TempUser;
 
use ArrayIterator;
use CallbackFilterIterator;
use IteratorIterator;
use MediaWiki\User\Registration\UserRegistrationLookup;
use MediaWiki\User\UserIdentity;
use Wikimedia\ObjectCache\MapCacheLRU;
use Wikimedia\Timestamp\ConvertibleTimestamp;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class TempUserDetailsLookup {
    private readonly MapCacheLRU $expiryCache;
 
    public function __construct(
        private readonly TempUserConfig $tempUserConfig,
        private readonly UserRegistrationLookup $userRegistrationLookup,
    ) {
        // Use a relatively large cache size to account for pages with a high number of user links,
        // such as Special:RecentChanges or history pages.
        $this->expiryCache = new MapCacheLRU( 1_000 );
    }
 
    public function isExpired( UserIdentity $user ): bool {
        $userName = $user->getName();
        if (
            !$this->tempUserConfig->isTempName( $userName ) ||
            !$user->isRegistered()
        ) {
            return false;
        }
 
        if ( !$this->expiryCache->has( $userName ) ) {
            $registration = $this->userRegistrationLookup->getFirstRegistration( $user );
 
            $this->expiryCache->set( $userName, $this->getExpirationState( $registration ) );
        }
 
        return $this->expiryCache->get( $userName );
    }
 
    public function preloadExpirationStatus( iterable $users ): void {
        // Save the user name associated with each user id for use later.
        $usersById = [];
        foreach ( $users as $user ) {
            $usersById[$user->getId()] = $user->getName();
        }
 
        $users = is_array( $users ) ? new ArrayIterator( $users ) : new IteratorIterator( $users );
        $timestampsById = $this->userRegistrationLookup->getFirstRegistrationBatch(
            new CallbackFilterIterator(
                $users,
                fn ( UserIdentity $user ): bool =>
                    $user->isRegistered() && $this->tempUserConfig->isTempName( $user->getName() )
            )
        );
 
        foreach ( $timestampsById as $userId => $registrationTimestamp ) {
            // Cache expiry by user name instead of user id. See T398722.
            $this->expiryCache->set(
                $usersById[$userId],
                $this->getExpirationState( $registrationTimestamp )
            );
        }
    }
 
    public function getExpirationState( $registration ): bool {
        if ( !is_string( $registration ) ) {
            return false;
        }
 
        $expireAfterDays = $this->tempUserConfig->getExpireAfterDays();
        $expiresAt = (int)wfTimestamp( TS::UNIX, $registration ) + $expireAfterDays * 86400;
        return $expiresAt < ConvertibleTimestamp::now( TS::UNIX );
    }
}