3 * Implements Special:ChangePassword
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * Let users recover their password.
27 * @ingroup SpecialPage
29 class SpecialChangePassword
extends FormSpecialPage
{
31 protected $mUserName, $mDomain;
33 // Optional Wikitext Message to show above the password change form
34 protected $mPreTextMessage = null;
36 // label for old password input
37 protected $mOldPassMsg = null;
39 public function __construct() {
40 parent
::__construct( 'ChangePassword', 'editmyprivateinfo' );
41 $this->listed( false );
45 * Main execution point
47 function execute( $par ) {
48 $this->getOutput()->disallowUserJs();
50 parent
::execute( $par );
53 protected function checkExecutePermissions( User
$user ) {
54 parent
::checkExecutePermissions( $user );
56 if ( !$this->getRequest()->wasPosted() ) {
57 $this->requireLogin( 'resetpass-no-info' );
62 * Set a message at the top of the Change Password form
64 * @param Message $msg to parse and add to the form header
66 public function setChangeMessage( Message
$msg ) {
67 $this->mPreTextMessage
= $msg;
71 * Set a message at the top of the Change Password form
73 * @param string $msg Message label for old/temp password field
75 public function setOldPasswordMessage( $msg ) {
76 $this->mOldPassMsg
= $msg;
79 protected function getFormFields() {
80 global $wgCookieExpiration;
82 $user = $this->getUser();
83 $request = $this->getRequest();
85 $oldpassMsg = $this->mOldPassMsg
;
86 if ( !isset( $oldpassMsg ) ) {
87 $oldpassMsg = $user->isLoggedIn() ?
'oldpassword' : 'resetpass-temp-password';
93 'label-message' => 'username',
94 'default' => $request->getVal( 'wpName', $user->getName() ),
98 'label-message' => $oldpassMsg,
100 'NewPassword' => array(
101 'type' => 'password',
102 'label-message' => 'newpassword',
105 'type' => 'password',
106 'label-message' => 'retypenew',
110 if ( !$this->getUser()->isLoggedIn() ) {
111 if ( !LoginForm
::getLoginToken() ) {
112 LoginForm
::setLoginToken();
114 $fields['LoginOnChangeToken'] = array(
116 'label' => 'Change Password Token',
117 'default' => LoginForm
::getLoginToken(),
121 $extraFields = array();
122 wfRunHooks( 'ChangePasswordForm', array( &$extraFields ) );
123 foreach ( $extraFields as $extra ) {
124 list( $name, $label, $type, $default ) = $extra;
125 $fields[$name] = array(
128 'label-message' => $label,
129 'default' => $default,
133 if ( !$user->isLoggedIn() ) {
134 $fields['Remember'] = array(
136 'label' => $this->msg( 'remembermypassword' )
137 ->numParams( ceil( $wgCookieExpiration / ( 3600 * 24 ) ) )
139 'default' => $request->getVal( 'wpRemember' ),
146 protected function alterForm( HTMLForm
$form ) {
147 $form->setId( 'mw-resetpass-form' );
148 $form->setTableId( 'mw-resetpass-table' );
149 $form->setWrapperLegendMsg( 'resetpass_header' );
150 $form->setSubmitTextMsg(
151 $this->getUser()->isLoggedIn()
152 ?
'resetpass-submit-loggedin'
155 $form->addButton( 'wpCancel', $this->msg( 'resetpass-submit-cancel' )->text() );
156 $form->setHeaderText( $this->msg( 'resetpass_text' )->parseAsBlock() );
157 if ( $this->mPreTextMessage
instanceof Message
) {
158 $form->addPreText( $this->mPreTextMessage
->parseAsBlock() );
160 $form->addHiddenFields(
161 $this->getRequest()->getValues( 'wpName', 'wpDomain', 'returnto', 'returntoquery' ) );
164 public function onSubmit( array $data ) {
167 $request = $this->getRequest();
169 if ( $request->getCheck( 'wpLoginToken' ) ) {
170 // This comes from Special:Userlogin when logging in with a temporary password
174 if ( !$this->getUser()->isLoggedIn()
175 && $request->getVal( 'wpLoginOnChangeToken' ) !== LoginForm
::getLoginToken()
177 // Potential CSRF (bug 62497)
182 if ( $request->getCheck( 'wpCancel' ) ) {
183 $titleObj = Title
::newFromText( $request->getVal( 'returnto' ) );
184 if ( !$titleObj instanceof Title
) {
185 $titleObj = Title
::newMainPage();
187 $query = $request->getVal( 'returntoquery' );
188 $this->getOutput()->redirect( $titleObj->getFullURL( $query ) );
194 $this->mUserName
= $request->getVal( 'wpName', $this->getUser()->getName() );
195 $this->mDomain
= $wgAuth->getDomain();
197 if ( !$wgAuth->allowPasswordChange() ) {
198 throw new ErrorPageError( 'changepassword', 'resetpass_forbidden' );
201 $this->attemptReset( $data['Password'], $data['NewPassword'], $data['Retype'] );
204 } catch ( PasswordError
$e ) {
205 return $e->getMessage();
209 public function onSuccess() {
210 if ( $this->getUser()->isLoggedIn() ) {
211 $this->getOutput()->wrapWikiMsg(
212 "<div class=\"successbox\">\n$1\n</div>",
213 'changepassword-success'
215 $this->getOutput()->returnToMain();
217 $request = $this->getRequest();
218 LoginForm
::setLoginToken();
219 $token = LoginForm
::getLoginToken();
221 'action' => 'submitlogin',
222 'wpName' => $this->mUserName
,
223 'wpDomain' => $this->mDomain
,
224 'wpLoginToken' => $token,
225 'wpPassword' => $request->getVal( 'wpNewPassword' ),
226 ) +
$request->getValues( 'wpRemember', 'returnto', 'returntoquery' );
227 $login = new LoginForm( new DerivativeRequest( $request, $data, true ) );
228 $login->setContext( $this->getContext() );
229 $login->execute( null );
234 * @throws PasswordError when cannot set the new password because requirements not met.
236 protected function attemptReset( $oldpass, $newpass, $retype ) {
237 global $wgPasswordAttemptThrottle;
239 $isSelf = ( $this->mUserName
=== $this->getUser()->getName() );
241 $user = $this->getUser();
243 $user = User
::newFromName( $this->mUserName
);
246 if ( !$user ||
$user->isAnon() ) {
247 throw new PasswordError( $this->msg( 'nosuchusershort', $this->mUserName
)->text() );
250 if ( $newpass !== $retype ) {
251 wfRunHooks( 'PrefsPasswordAudit', array( $user, $newpass, 'badretype' ) );
252 throw new PasswordError( $this->msg( 'badretype' )->text() );
255 $throttleCount = LoginForm
::incLoginThrottle( $this->mUserName
);
256 if ( $throttleCount === true ) {
257 $lang = $this->getLanguage();
258 throw new PasswordError( $this->msg( 'changepassword-throttled' )
259 ->params( $lang->formatDuration( $wgPasswordAttemptThrottle['seconds'] ) )
264 // @TODO Make these separate messages, since the message is written for both cases
265 if ( !$user->checkTemporaryPassword( $oldpass ) && !$user->checkPassword( $oldpass ) ) {
266 wfRunHooks( 'PrefsPasswordAudit', array( $user, $newpass, 'wrongpassword' ) );
267 throw new PasswordError( $this->msg( 'resetpass-wrong-oldpass' )->text() );
270 // User is resetting their password to their old password
271 if ( $oldpass === $newpass ) {
272 throw new PasswordError( $this->msg( 'resetpass-recycled' )->text() );
275 // Do AbortChangePassword after checking mOldpass, so we don't leak information
276 // by possibly aborting a new password before verifying the old password.
277 $abortMsg = 'resetpass-abort-generic';
278 if ( !wfRunHooks( 'AbortChangePassword', array( $user, $oldpass, $newpass, &$abortMsg ) ) ) {
279 wfRunHooks( 'PrefsPasswordAudit', array( $user, $newpass, 'abortreset' ) );
280 throw new PasswordError( $this->msg( $abortMsg )->text() );
283 // Please reset throttle for successful logins, thanks!
284 if ( $throttleCount ) {
285 LoginForm
::clearLoginThrottle( $this->mUserName
);
289 $user->setPassword( $newpass );
290 wfRunHooks( 'PrefsPasswordAudit', array( $user, $newpass, 'success' ) );
291 } catch ( PasswordError
$e ) {
292 wfRunHooks( 'PrefsPasswordAudit', array( $user, $newpass, 'error' ) );
293 throw new PasswordError( $e->getMessage() );
297 // This is needed to keep the user connected since
298 // changing the password also modifies the user's token.
299 $remember = $this->getRequest()->getCookie( 'Token' ) !== null;
300 $user->setCookies( null, null, $remember );
302 $user->resetPasswordExpiration();
303 $user->saveSettings();
306 public function requiresUnblock() {
310 protected function getGroupName() {