Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 66
0.00% covered (danger)
0.00%
0 / 12
CRAP
0.00% covered (danger)
0.00%
0 / 1
SpecialPasswordReset
0.00% covered (danger)
0.00%
0 / 65
0.00% covered (danger)
0.00%
0 / 12
930
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 doesWrites
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 userCanExecute
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 checkExecutePermissions
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 execute
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
2
 getFormFields
0.00% covered (danger)
0.00%
0 / 16
0.00% covered (danger)
0.00%
0 / 1
42
 getDisplayFormat
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 alterForm
0.00% covered (danger)
0.00%
0 / 11
0.00% covered (danger)
0.00%
0 / 1
42
 onSubmit
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
12
 onSuccess
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
30
 isListed
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 getGroupName
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
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 */
20
21namespace MediaWiki\Specials;
22
23use ErrorPageError;
24use MediaWiki\HTMLForm\HTMLForm;
25use MediaWiki\MainConfigNames;
26use MediaWiki\SpecialPage\FormSpecialPage;
27use MediaWiki\Status\Status;
28use MediaWiki\User\PasswordReset;
29use MediaWiki\User\User;
30use ThrottledError;
31
32/**
33 * Special page for requesting a password reset email.
34 *
35 * Requires the TemporaryPasswordPrimaryAuthenticationProvider and the
36 * EmailNotificationSecondaryAuthenticationProvider (or something providing equivalent
37 * functionality) to be enabled.
38 *
39 * @ingroup SpecialPage
40 */
41class SpecialPasswordReset extends FormSpecialPage {
42    /** @var PasswordReset */
43    private $passwordReset;
44
45    /**
46     * @var Status
47     */
48    private $result;
49
50    /**
51     * @var string Identifies which password reset field was specified by the user.
52     */
53    private $method;
54
55    /**
56     * @param PasswordReset $passwordReset
57     */
58    public function __construct( PasswordReset $passwordReset ) {
59        parent::__construct( 'PasswordReset', 'editmyprivateinfo' );
60
61        $this->passwordReset = $passwordReset;
62    }
63
64    public function doesWrites() {
65        return true;
66    }
67
68    public function userCanExecute( User $user ) {
69        return $this->passwordReset->isAllowed( $user )->isGood();
70    }
71
72    public function checkExecutePermissions( User $user ) {
73        $status = Status::wrap( $this->passwordReset->isAllowed( $user ) );
74        if ( !$status->isGood() ) {
75            throw new ErrorPageError( 'internalerror', $status->getMessage() );
76        }
77
78        parent::checkExecutePermissions( $user );
79    }
80
81    /**
82     * @param string|null $par
83     */
84    public function execute( $par ) {
85        $out = $this->getOutput();
86        $out->disallowUserJs();
87        parent::execute( $par );
88    }
89
90    protected function getFormFields() {
91        $resetRoutes = $this->getConfig()->get( MainConfigNames::PasswordResetRoutes );
92        $a = [];
93        if ( isset( $resetRoutes['username'] ) && $resetRoutes['username'] ) {
94            $a['Username'] = [
95                'type' => 'text',
96                'default' => $this->getRequest()->getSession()->suggestLoginUsername(),
97                'label-message' => 'passwordreset-username',
98            ];
99
100            if ( $this->getUser()->isRegistered() ) {
101                $a['Username']['default'] = $this->getUser()->getName();
102            }
103        }
104
105        if ( isset( $resetRoutes['email'] ) && $resetRoutes['email'] ) {
106            $a['Email'] = [
107                'type' => 'email',
108                'label-message' => 'passwordreset-email',
109            ];
110        }
111
112        return $a;
113    }
114
115    protected function getDisplayFormat() {
116        return 'ooui';
117    }
118
119    public function alterForm( HTMLForm $form ) {
120        $resetRoutes = $this->getConfig()->get( MainConfigNames::PasswordResetRoutes );
121
122        $form->setSubmitDestructive();
123
124        $form->addHiddenFields( $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
125
126        $i = 0;
127        if ( isset( $resetRoutes['username'] ) && $resetRoutes['username'] ) {
128            $i++;
129        }
130        if ( isset( $resetRoutes['email'] ) && $resetRoutes['email'] ) {
131            $i++;
132        }
133
134        $message = ( $i > 1 ) ? 'passwordreset-text-many' : 'passwordreset-text-one';
135
136        $form->setHeaderHtml( $this->msg( $message, $i )->parseAsBlock() );
137        $form->setSubmitTextMsg( 'mailmypassword' );
138    }
139
140    /**
141     * Process the form.  At this point we know that the user passes all the criteria in
142     * userCanExecute(), and if the data array contains 'Username', etc, then Username
143     * resets are allowed.
144     * @param array $data
145     * @return Status
146     */
147    public function onSubmit( array $data ) {
148        $username = $data['Username'] ?? null;
149        $email = $data['Email'] ?? null;
150
151        $this->method = $username ? 'username' : 'email';
152        $this->result = Status::wrap(
153            $this->passwordReset->execute( $this->getUser(), $username, $email ) );
154
155        if ( $this->result->hasMessage( 'actionthrottledtext' ) ) {
156            throw new ThrottledError;
157        }
158
159        return $this->result;
160    }
161
162    /**
163     * Show a message on the successful processing of the form.
164     * This doesn't necessarily mean a reset email was sent.
165     */
166    public function onSuccess() {
167        $output = $this->getOutput();
168
169        // Information messages.
170        $output->addWikiMsg( 'passwordreset-success' );
171        $output->addWikiMsg( 'passwordreset-success-details-generic',
172            $this->getConfig()->get( MainConfigNames::PasswordReminderResendTime ) );
173
174        // Confirmation of what the user has just submitted.
175        $info = "\n";
176        $postVals = $this->getRequest()->getPostValues();
177        if ( isset( $postVals['wpUsername'] ) && $postVals['wpUsername'] !== '' ) {
178            $info .= "* " . $this->msg( 'passwordreset-username' ) . ' '
179                . wfEscapeWikiText( $postVals['wpUsername'] ) . "\n";
180        }
181        if ( isset( $postVals['wpEmail'] ) && $postVals['wpEmail'] !== '' ) {
182            $info .= "* " . $this->msg( 'passwordreset-email' ) . ' '
183                . wfEscapeWikiText( $postVals['wpEmail'] ) . "\n";
184        }
185        $output->addWikiMsg( 'passwordreset-success-info', $info );
186
187        // Link to main page.
188        $output->returnToMain();
189    }
190
191    /**
192     * Hide the password reset page if resets are disabled.
193     * @return bool
194     */
195    public function isListed() {
196        if ( !$this->passwordReset->isEnabled()->isGood() ) {
197            return false;
198        }
199
200        return parent::isListed();
201    }
202
203    protected function getGroupName() {
204        return 'login';
205    }
206}
207
208/**
209 * Retain the old class name for backwards compatibility.
210 * @deprecated since 1.41
211 */
212class_alias( SpecialPasswordReset::class, 'SpecialPasswordReset' );