Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 59
0.00% covered (danger)
0.00%
0 / 12
CRAP
0.00% covered (danger)
0.00%
0 / 1
SpecialResetTokens
0.00% covered (danger)
0.00%
0 / 58
0.00% covered (danger)
0.00%
0 / 12
342
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 1
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
 requiresUnblock
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getTokensList
0.00% covered (danger)
0.00%
0 / 11
0.00% covered (danger)
0.00%
0 / 1
6
 execute
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 onSuccess
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 getFormFields
0.00% covered (danger)
0.00%
0 / 22
0.00% covered (danger)
0.00%
0 / 1
12
 alterForm
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 getDisplayFormat
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 onSubmit
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
12
 getGroupName
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 isListed
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 MediaWiki\Html\Html;
24use MediaWiki\HTMLForm\HTMLForm;
25use MediaWiki\MainConfigNames;
26use MediaWiki\SpecialPage\FormSpecialPage;
27use MediaWiki\SpecialPage\SpecialPage;
28
29/**
30 * Let users reset tokens like the watchlist token.
31 *
32 * @ingroup SpecialPage
33 * @ingroup Auth
34 * @deprecated since 1.26
35 */
36class SpecialResetTokens extends FormSpecialPage {
37    private $tokensList;
38
39    public function __construct() {
40        parent::__construct( 'ResetTokens' );
41    }
42
43    public function doesWrites() {
44        return true;
45    }
46
47    public function requiresUnblock() {
48        return false;
49    }
50
51    /**
52     * Returns the token information list for this page after running
53     * the hook and filtering out disabled preferences.
54     *
55     * @return array
56     */
57    protected function getTokensList() {
58        if ( !isset( $this->tokensList ) ) {
59            $tokens = [
60                [ 'preference' => 'watchlisttoken', 'label-message' => 'resettokens-watchlist-token' ],
61            ];
62            $this->getHookRunner()->onSpecialResetTokensTokens( $tokens );
63
64            $hiddenPrefs = $this->getConfig()->get( MainConfigNames::HiddenPrefs );
65            $tokens = array_filter( $tokens, static function ( $tok ) use ( $hiddenPrefs ) {
66                return !in_array( $tok['preference'], $hiddenPrefs );
67            } );
68
69            $this->tokensList = $tokens;
70        }
71
72        return $this->tokensList;
73    }
74
75    public function execute( $par ) {
76        // This is a preferences page, so no user JS for y'all.
77        $this->getOutput()->disallowUserJs();
78        $this->requireNamedUser();
79
80        parent::execute( $par );
81
82        $this->getOutput()->addReturnTo( SpecialPage::getTitleFor( 'Preferences' ) );
83    }
84
85    public function onSuccess() {
86        $this->getOutput()->wrapWikiMsg(
87            Html::successBox( '$1' ),
88            'resettokens-done'
89        );
90    }
91
92    /**
93     * Display appropriate message if there's nothing to do.
94     * The submit button is also suppressed in this case (see alterForm()).
95     * @return array
96     */
97    protected function getFormFields() {
98        $user = $this->getUser();
99        $tokens = $this->getTokensList();
100
101        if ( $tokens ) {
102            $tokensForForm = [];
103            foreach ( $tokens as $tok ) {
104                $label = $this->msg( 'resettokens-token-label' )
105                    ->rawParams( $this->msg( $tok['label-message'] )->parse() )
106                    ->params( $user->getTokenFromOption( $tok['preference'] ) )
107                    ->escaped();
108                $tokensForForm[$label] = $tok['preference'];
109            }
110
111            $desc = [
112                'label-message' => 'resettokens-tokens',
113                'type' => 'multiselect',
114                'options' => $tokensForForm,
115            ];
116        } else {
117            $desc = [
118                'label-message' => 'resettokens-no-tokens',
119                'type' => 'info',
120            ];
121        }
122
123        return [
124            'tokens' => $desc,
125        ];
126    }
127
128    /**
129     * Suppress the submit button if there's nothing to do;
130     * provide additional message on it otherwise.
131     * @param HTMLForm $form
132     */
133    protected function alterForm( HTMLForm $form ) {
134        $form->setSubmitDestructive();
135        if ( $this->getTokensList() ) {
136            $form->setSubmitTextMsg( 'resettokens-resetbutton' );
137        } else {
138            $form->suppressDefaultSubmit();
139        }
140    }
141
142    protected function getDisplayFormat() {
143        return 'ooui';
144    }
145
146    public function onSubmit( array $formData ) {
147        if ( $formData['tokens'] ) {
148            $user = $this->getUser();
149            foreach ( $formData['tokens'] as $tokenPref ) {
150                $user->resetTokenFromOption( $tokenPref );
151            }
152            $user->saveSettings();
153
154            return true;
155        }
156
157        return false;
158    }
159
160    protected function getGroupName() {
161        return 'login';
162    }
163
164    public function isListed() {
165        return (bool)$this->getTokensList();
166    }
167}
168
169/**
170 * Retain the old class name for backwards compatibility.
171 * @deprecated since 1.41
172 */
173class_alias( SpecialResetTokens::class, 'SpecialResetTokens' );