includes/auth/RememberMeAuthenticationRequest.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Auth
  20  */
  21
  22 namespace MediaWiki\Auth;
  23
  24 use MediaWiki\Session\SessionManager;
  25 use MediaWiki\Session\SessionProvider;
  26
  27 /**
  28  * This is an authentication request added by AuthManager to show a "remember
  29  * me" checkbox. When checked, it will take more time for the authenticated session to expire.
  30  * @ingroup Auth
  31  * @since 1.27
  32  */
  33 class RememberMeAuthenticationRequest extends AuthenticationRequest {
  34
  35         public $required = self::OPTIONAL;
  36
  37         /** @var int How long the user will be remembered, in seconds */
  38         protected $expiration = null;
  39
  40         /** @var bool */
  41         public $rememberMe = false;
  42
  43         public function __construct() {
  44                 /** @var SessionProvider $provider */
  45                 $provider = SessionManager::getGlobalSession()->getProvider();
  46                 $this->expiration = $provider->getRememberUserDuration();
  47         }
  48
  49         public function getFieldInfo() {
  50                 if ( !$this->expiration ) {
  51                         return [];
  52                 }
  53
  54                 $expirationDays = ceil( $this->expiration / ( 3600 * 24 ) );
  55                 return [
  56                         'rememberMe' => [
  57                                 'type' => 'checkbox',
  58                                 'label' => wfMessage( 'userlogin-remembermypassword' )->numParams( $expirationDays ),
  59                                 'help' => wfMessage( 'authmanager-userlogin-remembermypassword-help' ),
  60                                 'optional' => true,
  61                                 'skippable' => true,
  62                         ]
  63                 ];
  64         }
  65 }