RememberMeAuthenticationRequest.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Auth;
 
use MediaWiki\Session\SessionManager;
use MediaWiki\Session\SessionProvider;
use UnexpectedValueException;
 
class RememberMeAuthenticationRequest extends AuthenticationRequest {
 
    public const CHOOSE_REMEMBER = 'choose';
 
    public const FORCE_CHOOSE_REMEMBER = 'force-choose';
 
    public const ALWAYS_REMEMBER = 'always';
 
    public const NEVER_REMEMBER = 'never';
 
    public const ALLOWED_FLAGS = [
        self::CHOOSE_REMEMBER,
        self::FORCE_CHOOSE_REMEMBER,
        self::ALWAYS_REMEMBER,
        self::NEVER_REMEMBER,
    ];
 
    public $required = self::OPTIONAL;
 
    public $skippable = true;
 
    private $checkbox = false;
 
    protected $expiration = null;
 
    public $rememberMe = false;
 
    public function __construct( string $flag = self::CHOOSE_REMEMBER ) {
        $provider = SessionManager::getGlobalSession()->getProvider();
        '@phan-var SessionProvider $provider';
 
        switch ( $flag ) {
            case self::CHOOSE_REMEMBER:
                $this->skippable = true;
                $this->checkbox = true;
                $this->expiration = $provider->getRememberUserDuration();
                break;
            case self::FORCE_CHOOSE_REMEMBER:
                $this->skippable = false;
                $this->checkbox = true;
                $this->expiration = $provider->getRememberUserDuration();
                break;
            case self::ALWAYS_REMEMBER:
                $this->skippable = true;
                $this->checkbox = false;
                $this->expiration = $provider->getRememberUserDuration();
                break;
            case self::NEVER_REMEMBER:
                $this->skippable = true;
                $this->checkbox = false;
                $this->expiration = null;
                break;
            default:
                throw new UnexpectedValueException( '$flag must be one of the values: \'' .
                    implode( "', '", self::ALLOWED_FLAGS ) . '\'' );
        }
    }
 
    public function getFieldInfo() {
        if ( !$this->expiration || !$this->checkbox ) {
            return [];
        }
 
        $expirationDays = ceil( $this->expiration / ( 3600 * 24 ) );
        return [
            'rememberMe' => [
                'type' => 'checkbox',
                'label' => wfMessage( 'userlogin-remembermypassword' )->numParams( $expirationDays ),
                'help' => wfMessage( 'authmanager-userlogin-remembermypassword-help' ),
                'optional' => true,
                'skippable' => $this->skippable,
            ]
        ];
    }
}