1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Auth
*/
namespace MediaWiki\Auth;
use MediaWiki\Session\SessionManager;
use MediaWiki\Session\SessionProvider;
use UnexpectedValueException;
/**
* This is an authentication request added by AuthManager to show a "remember me" checkbox.
* When checked, it will take more time for the authenticated session to expire.
* @stable to extend
* @ingroup Auth
* @since 1.27
*/
class RememberMeAuthenticationRequest extends AuthenticationRequest {
/**
* Indicates that the user may be able to choose whether to be remembered or not. The
* choice field is skippable if no other fields are on the login form. This is the original
* pre-1.36 behavior.
*/
public const CHOOSE_REMEMBER = 'choose';
/**
* Indicates that the user will be able to choose whether to be remembered or not. The
* choice field is not skippable, even if there are no other fields on the login form.
*/
public const FORCE_CHOOSE_REMEMBER = 'force-choose';
/**
* Indicates that the user will always be remembered.
*/
public const ALWAYS_REMEMBER = 'always';
/**
* Indicates that the user will never be remembered.
*/
public const NEVER_REMEMBER = 'never';
/**
* Allowed configuration flags
*/
public const ALLOWED_FLAGS = [
self::CHOOSE_REMEMBER,
self::FORCE_CHOOSE_REMEMBER,
self::ALWAYS_REMEMBER,
self::NEVER_REMEMBER,
];
/**
* Whether this field must be filled in on the form. Since the field is a checkbox, which can
* by definition be left blank, it is always optional.
* @var bool
*/
public $required = self::OPTIONAL;
/**
* Whether display of this field can be skipped, accepting the default value, if there are no
* other fields on the form.
* @var bool
* @since 1.36
*/
public $skippable = true;
/** @var bool */
private $checkbox = false;
/**
* @var int|null How long the user will be remembered, in seconds.
* Null means setting the $rememberMe will have no effect
*/
protected $expiration = null;
/** @var bool */
public $rememberMe = false;
/**
* @stable to call
* @param string $flag
*/
public function __construct( string $flag = self::CHOOSE_REMEMBER ) {
/** @var SessionProvider $provider */
$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 ) . '\'' );
}
}
/**
* @inheritDoc
* @stable to override
*/
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,
]
];
}
}
|
