Your IP : 216.73.216.54


Current Path : /var/www/html/mediawiki/includes/user/Registration/
Upload File :
Current File : /var/www/html/mediawiki/includes/user/Registration/UserRegistrationLookup.php

<?php

namespace MediaWiki\User\Registration;

use InvalidArgumentException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\MainConfigSchema;
use MediaWiki\User\UserIdentity;
use Wikimedia\ObjectFactory\ObjectFactory;

/**
 * @since 1.41
 */
class UserRegistrationLookup {

	/**
	 * @internal for use in ServiceWiring
	 * @var string[] Config names to require
	 */
	public const CONSTRUCTOR_OPTIONS = [
		MainConfigNames::UserRegistrationProviders,
	];

	/** @var array ObjectFactory specs indexed by provider name */
	private array $providersSpecs;

	/** @var IUserRegistrationProvider[] Constructed registration providers indexed by name */
	private array $providers = [];

	private ObjectFactory $objectFactory;

	public function __construct(
		ServiceOptions $options,
		ObjectFactory $objectFactory
	) {
		$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
		$this->providersSpecs = $options->get( MainConfigNames::UserRegistrationProviders );
		$this->objectFactory = $objectFactory;
	}

	/**
	 * Is a registration provider registered?
	 *
	 * @see MainConfigSchema::UserRegistrationLookupProviders
	 * @param string $type
	 * @return bool
	 */
	public function isRegistered( string $type ): bool {
		return array_key_exists( $type, $this->providersSpecs );
	}

	/**
	 * Construct a registration provider, if needed
	 *
	 * @param string $type
	 * @return IUserRegistrationProvider
	 */
	private function getProvider( string $type ): IUserRegistrationProvider {
		if ( !$this->isRegistered( $type ) ) {
			throw new InvalidArgumentException( 'Registration provider ' . $type . ' is not registered' );
		}
		if ( !array_key_exists( $type, $this->providers ) ) {
			$this->providers[$type] = $this->objectFactory->createObject(
				$this->providersSpecs[$type],
				[ 'assertClass' => IUserRegistrationProvider::class ]
			);
		}
		return $this->providers[$type];
	}

	/**
	 * @param UserIdentity $user User for which registration should be fetched.
	 * @param string $type Name of a registered registration provider
	 * @return string|null|false Registration timestamp, null if not available or false if it
	 * cannot be fetched (anonymous users, for example).
	 */
	public function getRegistration(
		UserIdentity $user,
		string $type = LocalUserRegistrationProvider::TYPE
	) {
		return $this->getProvider( $type )->fetchRegistration( $user );
	}

	/**
	 * Find the first registration timestamp for a given user
	 *
	 * Note this invokes _all_ registered providers.
	 *
	 * @param UserIdentity $user
	 * @return string|null Earliest registration timestamp, null if not available.
	 */
	public function getFirstRegistration( UserIdentity $user ): ?string {
		$registrationTimestampsUnix = [];
		foreach ( $this->providersSpecs as $providerKey => $_ ) {
			$registrationTimestampRaw = $this->getRegistration( $user, $providerKey );
			if ( !is_string( $registrationTimestampRaw ) ) {
				// Provider was unable to return a registration timestamp for $providerKey, skip
				// them.
				continue;
			}
			$registrationTimestampsUnix[] = (int)wfTimestamp( TS_UNIX, $registrationTimestampRaw );
		}

		if ( $registrationTimestampsUnix === [] ) {
			return null;
		}

		return wfTimestamp( TS_MW, min( $registrationTimestampsUnix ) );
	}
}