MediaWiki  master
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.ooui' );
56  $out->addModuleStyles( 'mediawiki.special.preferences.styles.ooui' );
57  $out->addModuleStyles( 'oojs-ui-widgets.styles' );
58 
59  $session = $this->getRequest()->getSession();
60  if ( $session->get( 'specialPreferencesSaveSuccess' ) ) {
61  // Remove session data for the success message
62  $session->remove( 'specialPreferencesSaveSuccess' );
63  $out->addModuleStyles( 'mediawiki.notification.convertmessagebox.styles' );
64 
65  $out->addHTML(
67  'div',
68  [
69  'class' => 'mw-preferences-messagebox mw-notify-success successbox',
70  'id' => 'mw-preferences-success',
71  'data-mw-autohide' => 'false',
72  ],
73  Html::element( 'p', [], $this->msg( 'savedprefs' )->text() )
74  )
75  );
76  }
77 
78  $this->addHelpLink( 'Help:Preferences' );
79 
80  // Load the user from the master to reduce CAS errors on double post (T95839)
81  if ( $this->getRequest()->wasPosted() ) {
82  $user = $this->getUser()->getInstanceForUpdate() ?: $this->getUser();
83  } else {
84  $user = $this->getUser();
85  }
86 
87  $htmlForm = $this->getFormObject( $user, $this->getContext() );
88  $sectionTitles = $htmlForm->getPreferenceSections();
89 
90  $prefTabs = [];
91  foreach ( $sectionTitles as $key ) {
92  $prefTabs[] = [
93  'name' => $key,
94  'label' => $htmlForm->getLegend( $key ),
95  ];
96  }
97  $out->addJsConfigVars( 'wgPreferencesTabs', $prefTabs );
98 
99  $htmlForm->show();
100  }
101 
108  protected function getFormObject( $user, IContextSource $context ) {
109  $preferencesFactory = MediaWikiServices::getInstance()->getPreferencesFactory();
110  $form = $preferencesFactory->getForm( $user, $context, PreferencesFormOOUI::class );
111  return $form;
112  }
113 
114  protected function showResetForm() {
115  if ( !$this->getUser()->isAllowed( 'editmyoptions' ) ) {
116  throw new PermissionsError( 'editmyoptions' );
117  }
118 
119  $this->getOutput()->addWikiMsg( 'prefs-reset-intro' );
120 
121  $context = new DerivativeContext( $this->getContext() );
122  $context->setTitle( $this->getPageTitle( 'reset' ) ); // Reset subpage
123  $htmlForm = HTMLForm::factory( 'ooui', [], $context, 'prefs-restore' );
124 
125  $htmlForm->setSubmitTextMsg( 'restoreprefs' );
126  $htmlForm->setSubmitDestructive();
127  $htmlForm->setSubmitCallback( [ $this, 'submitReset' ] );
128  $htmlForm->suppressReset();
129 
130  $htmlForm->show();
131  }
132 
133  public function submitReset( $formData ) {
134  if ( !$this->getUser()->isAllowed( 'editmyoptions' ) ) {
135  throw new PermissionsError( 'editmyoptions' );
136  }
137 
138  $user = $this->getUser()->getInstanceForUpdate();
139  $user->resetOptions( 'all', $this->getContext() );
140  $user->saveSettings();
141 
142  // Set session data for the success message
143  $this->getRequest()->getSession()->set( 'specialPreferencesSaveSuccess', 1 );
144 
145  $url = $this->getPageTitle()->getFullUrlForRedirect();
146  $this->getOutput()->redirect( $url );
147 
148  return true;
149  }
150 
151  protected function getGroupName() {
152  return 'users';
153  }
154 }
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:822
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
getContext()
Gets the context this SpecialPage is executed in.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
An IContextSource implementation which will inherit context from another source but allow individual ...
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
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:23
getFormObject( $user, IContextSource $context)
Get the preferences form to use.
getOutput()
Get the OutputPage being used for this instance.
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:286
The package scripts
Definition: README.txt:1
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
A special page that allows users to change their preferences.
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing etc
Definition: hooks.txt:91
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:9
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
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:9
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:35
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
getUser()
Shortcut to get the User executing this instance.
Show an error when a user tries to do something they do not have the necessary permissions for...
msg( $key)
Wrapper around wfMessage that sets the current 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:2685
getRequest()
Get the WebRequest being used for this instance.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
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 local account $user
Definition: hooks.txt:244