MediaWiki  REL1_31
SpecialResetTokens.php
Go to the documentation of this file.
1 <?php
31  private $tokensList;
32 
33  public function __construct() {
34  parent::__construct( 'ResetTokens' );
35  }
36 
37  public function doesWrites() {
38  return true;
39  }
40 
41  public function requiresUnblock() {
42  return false;
43  }
44 
51  protected function getTokensList() {
52  if ( !isset( $this->tokensList ) ) {
53  $tokens = [
54  [ 'preference' => 'watchlisttoken', 'label-message' => 'resettokens-watchlist-token' ],
55  ];
56  Hooks::run( 'SpecialResetTokensTokens', [ &$tokens ] );
57 
58  $hiddenPrefs = $this->getConfig()->get( 'HiddenPrefs' );
59  $tokens = array_filter( $tokens, function ( $tok ) use ( $hiddenPrefs ) {
60  return !in_array( $tok['preference'], $hiddenPrefs );
61  } );
62 
63  $this->tokensList = $tokens;
64  }
65 
66  return $this->tokensList;
67  }
68 
69  public function execute( $par ) {
70  // This is a preferences page, so no user JS for y'all.
71  $this->getOutput()->disallowUserJs();
72  $this->requireLogin();
73 
75 
76  $this->getOutput()->addReturnTo( SpecialPage::getTitleFor( 'Preferences' ) );
77  }
78 
79  public function onSuccess() {
80  $this->getOutput()->wrapWikiMsg(
81  Html::successBox( '$1' ),
82  'resettokens-done'
83  );
84  }
85 
91  protected function getFormFields() {
92  $user = $this->getUser();
93  $tokens = $this->getTokensList();
94 
95  if ( $tokens ) {
96  $tokensForForm = [];
97  foreach ( $tokens as $tok ) {
98  $label = $this->msg( 'resettokens-token-label' )
99  ->rawParams( $this->msg( $tok['label-message'] )->parse() )
100  ->params( $user->getTokenFromOption( $tok['preference'] ) )
101  ->escaped();
102  $tokensForForm[$label] = $tok['preference'];
103  }
104 
105  $desc = [
106  'label-message' => 'resettokens-tokens',
107  'type' => 'multiselect',
108  'options' => $tokensForForm,
109  ];
110  } else {
111  $desc = [
112  'label-message' => 'resettokens-no-tokens',
113  'type' => 'info',
114  ];
115  }
116 
117  return [
118  'tokens' => $desc,
119  ];
120  }
121 
127  protected function alterForm( HTMLForm $form ) {
128  if ( $this->getTokensList() ) {
129  $form->setSubmitTextMsg( 'resettokens-resetbutton' );
130  } else {
131  $form->suppressDefaultSubmit();
132  }
133  }
134 
135  protected function getDisplayFormat() {
136  return 'ooui';
137  }
138 
139  public function onSubmit( array $formData ) {
140  if ( $formData['tokens'] ) {
141  $user = $this->getUser();
142  foreach ( $formData['tokens'] as $tokenPref ) {
143  $user->resetTokenFromOption( $tokenPref );
144  }
145  $user->saveSettings();
146 
147  return true;
148  }
149 
150  return false;
151  }
152 
153  protected function getGroupName() {
154  return 'users';
155  }
156 
157  public function isListed() {
158  return (bool)$this->getTokensList();
159  }
160 }
$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
SpecialResetTokens\__construct
__construct()
Definition: SpecialResetTokens.php:33
SpecialResetTokens\getDisplayFormat
getDisplayFormat()
Get display format for the form.
Definition: SpecialResetTokens.php:135
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
HTMLForm\suppressDefaultSubmit
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1440
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
SpecialResetTokens\getTokensList
getTokensList()
Returns the token information list for this page after running the hook and filtering out disabled pr...
Definition: SpecialResetTokens.php:51
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
array
the array() calling protocol came about after MediaWiki 1.4rc1.
SpecialResetTokens\$tokensList
$tokensList
Definition: SpecialResetTokens.php:31
FormSpecialPage
Special page which uses an HTMLForm to handle processing.
Definition: FormSpecialPage.php:31
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
SpecialResetTokens\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialResetTokens.php:37
SpecialResetTokens\getFormFields
getFormFields()
Display appropriate message if there's nothing to do.
Definition: SpecialResetTokens.php:91
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
Html\successBox
static successBox( $html)
Return a success box.
Definition: Html.php:723
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
SpecialResetTokens\execute
execute( $par)
Basic SpecialPage workflow: get a form, send it to the user; get some data back,.
Definition: SpecialResetTokens.php:69
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
SpecialPage\requireLogin
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
Definition: SpecialPage.php:336
execute
$batch execute()
SpecialResetTokens\onSuccess
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
Definition: SpecialResetTokens.php:79
FormSpecialPage\$par
string $par
The sub-page of the special page.
Definition: FormSpecialPage.php:36
$tokens
$tokens
Definition: mwdoc-filter.php:47
SpecialResetTokens\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialResetTokens.php:153
SpecialResetTokens\alterForm
alterForm(HTMLForm $form)
Suppress the submit button if there's nothing to do; provide additional message on it otherwise.
Definition: SpecialResetTokens.php:127
SpecialResetTokens\isListed
isListed()
Whether this special page is listed in Special:SpecialPages.
Definition: SpecialResetTokens.php:157
HTMLForm\setSubmitTextMsg
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1356
SpecialResetTokens
Let users reset tokens like the watchlist token.
Definition: SpecialResetTokens.php:30
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
SpecialResetTokens\requiresUnblock
requiresUnblock()
Whether this action cannot be executed by a blocked user.
Definition: SpecialResetTokens.php:41
SpecialResetTokens\onSubmit
onSubmit(array $formData)
Process the form on POST submission.
Definition: SpecialResetTokens.php:139
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130