MediaWiki  REL1_31
SpecialPreferences.php
Go to the documentation of this file.
1 <?php
25 
32  function __construct() {
33  parent::__construct( 'Preferences' );
34  }
35 
36  public function doesWrites() {
37  return true;
38  }
39 
40  public function execute( $par ) {
41  $this->setHeaders();
42  $this->outputHeader();
43  $out = $this->getOutput();
44  $out->disallowUserJs(); # Prevent hijacked user scripts from sniffing passwords etc.
45 
46  $this->requireLogin( 'prefsnologintext2' );
47  $this->checkReadOnly();
48 
49  if ( $par == 'reset' ) {
50  $this->showResetForm();
51 
52  return;
53  }
54 
55  $out->addModules( 'mediawiki.special.preferences' );
56  $out->addModuleStyles( 'mediawiki.special.preferences.styles' );
57 
58  $session = $this->getRequest()->getSession();
59  if ( $session->get( 'specialPreferencesSaveSuccess' ) ) {
60  // Remove session data for the success message
61  $session->remove( 'specialPreferencesSaveSuccess' );
62  $out->addModuleStyles( 'mediawiki.notification.convertmessagebox.styles' );
63 
64  $out->addHTML(
66  'div',
67  [
68  'class' => 'mw-preferences-messagebox mw-notify-success successbox',
69  'id' => 'mw-preferences-success',
70  'data-mw-autohide' => 'false',
71  ],
72  Html::element( 'p', [], $this->msg( 'savedprefs' )->text() )
73  )
74  );
75  }
76 
77  $this->addHelpLink( 'Help:Preferences' );
78 
79  // Load the user from the master to reduce CAS errors on double post (T95839)
80  if ( $this->getRequest()->wasPosted() ) {
81  $user = $this->getUser()->getInstanceForUpdate() ?: $this->getUser();
82  } else {
83  $user = $this->getUser();
84  }
85 
86  $htmlForm = $this->getFormObject( $user, $this->getContext() );
87  $sectionTitles = $htmlForm->getPreferenceSections();
88 
89  $prefTabs = '';
90  foreach ( $sectionTitles as $key ) {
91  $prefTabs .= Html::rawElement( 'li',
92  [
93  'role' => 'presentation',
94  'class' => ( $key === 'personal' ) ? 'selected' : null
95  ],
96  Html::rawElement( 'a',
97  [
98  'id' => 'preftab-' . $key,
99  'role' => 'tab',
100  'href' => '#mw-prefsection-' . $key,
101  'aria-controls' => 'mw-prefsection-' . $key,
102  'aria-selected' => ( $key === 'personal' ) ? 'true' : 'false',
103  'tabIndex' => ( $key === 'personal' ) ? 0 : -1,
104  ],
105  $htmlForm->getLegend( $key )
106  )
107  );
108  }
109 
110  $out->addHTML(
111  Html::rawElement( 'ul',
112  [
113  'id' => 'preftoc',
114  'role' => 'tablist'
115  ],
116  $prefTabs )
117  );
118  $htmlForm->show();
119  }
120 
127  protected function getFormObject( $user, IContextSource $context ) {
128  $preferencesFactory = MediaWikiServices::getInstance()->getPreferencesFactory();
129  $form = $preferencesFactory->getForm( $user, $context );
130  return $form;
131  }
132 
133  protected function showResetForm() {
134  if ( !$this->getUser()->isAllowed( 'editmyoptions' ) ) {
135  throw new PermissionsError( 'editmyoptions' );
136  }
137 
138  $this->getOutput()->addWikiMsg( 'prefs-reset-intro' );
139 
140  $context = new DerivativeContext( $this->getContext() );
141  $context->setTitle( $this->getPageTitle( 'reset' ) ); // Reset subpage
142  $htmlForm = new HTMLForm( [], $context, 'prefs-restore' );
143 
144  $htmlForm->setSubmitTextMsg( 'restoreprefs' );
145  $htmlForm->setSubmitDestructive();
146  $htmlForm->setSubmitCallback( [ $this, 'submitReset' ] );
147  $htmlForm->suppressReset();
148 
149  $htmlForm->show();
150  }
151 
152  public function submitReset( $formData ) {
153  if ( !$this->getUser()->isAllowed( 'editmyoptions' ) ) {
154  throw new PermissionsError( 'editmyoptions' );
155  }
156 
157  $user = $this->getUser()->getInstanceForUpdate();
158  $user->resetOptions( 'all', $this->getContext() );
159  $user->saveSettings();
160 
161  // Set session data for the success message
162  $this->getRequest()->getSession()->set( 'specialPreferencesSaveSuccess', 1 );
163 
164  $url = $this->getPageTitle()->getFullUrlForRedirect();
165  $this->getOutput()->redirect( $url );
166 
167  return true;
168  }
169 
170  protected function getGroupName() {
171  return 'users';
172  }
173 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:675
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:18
SpecialPreferences
A special page that allows users to change their preferences.
Definition: SpecialPreferences.php:31
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
SpecialPreferences\execute
execute( $par)
Default execute method Checks user permissions.
Definition: SpecialPreferences.php:40
SpecialPreferences\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialPreferences.php:36
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
DerivativeContext
An IContextSource implementation which will inherit context from another source but allow individual ...
Definition: DerivativeContext.php:30
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:832
user
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
Definition: distributors.txt:25
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:527
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
SpecialPage\requireLogin
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
Definition: SpecialPage.php:336
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:36
etc
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add etc
Definition: design.txt:19
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
SpecialPreferences\getFormObject
getFormObject( $user, IContextSource $context)
Get the preferences form to use.
Definition: SpecialPreferences.php:127
scripts
The package scripts
Definition: README.txt:1
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
from
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable from
Definition: APACHE-LICENSE-2.0.txt:46
SpecialPreferences\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialPreferences.php:170
SpecialPage\checkReadOnly
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
Definition: SpecialPage.php:319
SpecialPreferences\submitReset
submitReset( $formData)
Definition: SpecialPreferences.php:152
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
SpecialPreferences\showResetForm
showResetForm()
Definition: SpecialPreferences.php:133
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2811
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:629
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130
SpecialPreferences\__construct
__construct()
Definition: SpecialPreferences.php:32