3 * Implements Special:Preferences
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
24 use MediaWiki\MediaWikiServices
;
27 * A special page that allows users to change their preferences
29 * @ingroup SpecialPage
31 class SpecialPreferences
extends SpecialPage
{
32 function __construct() {
33 parent
::__construct( 'Preferences' );
36 public function doesWrites() {
40 public function execute( $par ) {
42 $this->outputHeader();
43 $out = $this->getOutput();
44 $out->disallowUserJs(); # Prevent hijacked user scripts from sniffing passwords etc.
46 $this->requireLogin( 'prefsnologintext2' );
47 $this->checkReadOnly();
49 if ( $par == 'reset' ) {
50 $this->showResetForm();
55 $out->addModules( 'mediawiki.special.preferences.ooui' );
56 $out->addModuleStyles( [
57 'mediawiki.special.preferences.styles.ooui',
58 'mediawiki.widgets.TagMultiselectWidget.styles',
60 $out->addModuleStyles( 'oojs-ui-widgets.styles' );
62 $session = $this->getRequest()->getSession();
63 if ( $session->get( 'specialPreferencesSaveSuccess' ) ) {
64 // Remove session data for the success message
65 $session->remove( 'specialPreferencesSaveSuccess' );
66 $out->addModuleStyles( 'mediawiki.notification.convertmessagebox.styles' );
72 'class' => 'mw-preferences-messagebox mw-notify-success successbox',
73 'id' => 'mw-preferences-success',
74 'data-mw-autohide' => 'false',
76 Html
::element( 'p', [], $this->msg( 'savedprefs' )->text() )
81 $this->addHelpLink( 'Help:Preferences' );
83 // Load the user from the master to reduce CAS errors on double post (T95839)
84 if ( $this->getRequest()->wasPosted() ) {
85 $user = $this->getUser()->getInstanceForUpdate() ?
: $this->getUser();
87 $user = $this->getUser();
90 $htmlForm = $this->getFormObject( $user, $this->getContext() );
91 $sectionTitles = $htmlForm->getPreferenceSections();
94 foreach ( $sectionTitles as $key ) {
97 'label' => $htmlForm->getLegend( $key ),
100 $out->addJsConfigVars( 'wgPreferencesTabs', $prefTabs );
106 * Get the preferences form to use.
107 * @param User $user The user.
108 * @param IContextSource $context The context.
109 * @return PreferencesFormOOUI|HTMLForm
111 protected function getFormObject( $user, IContextSource
$context ) {
112 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
113 $form = $preferencesFactory->getForm( $user, $context, PreferencesFormOOUI
::class );
117 protected function showResetForm() {
118 if ( !MediaWikiServices
::getInstance()
119 ->getPermissionManager()
120 ->userHasRight( $this->getUser(), 'editmyoptions' )
122 throw new PermissionsError( 'editmyoptions' );
125 $this->getOutput()->addWikiMsg( 'prefs-reset-intro' );
127 $context = new DerivativeContext( $this->getContext() );
128 $context->setTitle( $this->getPageTitle( 'reset' ) ); // Reset subpage
129 $htmlForm = HTMLForm
::factory( 'ooui', [], $context, 'prefs-restore' );
131 $htmlForm->setSubmitTextMsg( 'restoreprefs' );
132 $htmlForm->setSubmitDestructive();
133 $htmlForm->setSubmitCallback( [ $this, 'submitReset' ] );
134 $htmlForm->suppressReset();
139 public function submitReset( $formData ) {
140 if ( !MediaWikiServices
::getInstance()
141 ->getPermissionManager()
142 ->userHasRight( $this->getUser(), 'editmyoptions' )
144 throw new PermissionsError( 'editmyoptions' );
147 $user = $this->getUser()->getInstanceForUpdate();
148 $user->resetOptions( 'all', $this->getContext() );
149 $user->saveSettings();
151 // Set session data for the success message
152 $this->getRequest()->getSession()->set( 'specialPreferencesSaveSuccess', 1 );
154 $url = $this->getPageTitle()->getFullUrlForRedirect();
155 $this->getOutput()->redirect( $url );
160 protected function getGroupName() {