MediaWiki  master
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 
47  protected function getTokensList() {
48  if ( !isset( $this->tokensList ) ) {
49  $tokens = [
50  [ 'preference' => 'watchlisttoken', 'label-message' => 'resettokens-watchlist-token' ],
51  ];
52  Hooks::run( 'SpecialResetTokensTokens', [ &$tokens ] );
53 
54  $hiddenPrefs = $this->getConfig()->get( 'HiddenPrefs' );
55  $tokens = array_filter( $tokens, function ( $tok ) use ( $hiddenPrefs ) {
56  return !in_array( $tok['preference'], $hiddenPrefs );
57  } );
58 
59  $this->tokensList = $tokens;
60  }
61 
62  return $this->tokensList;
63  }
64 
65  public function execute( $par ) {
66  // This is a preferences page, so no user JS for y'all.
67  $this->getOutput()->disallowUserJs();
68  $this->requireLogin();
69 
71 
72  $this->getOutput()->addReturnTo( SpecialPage::getTitleFor( 'Preferences' ) );
73  }
74 
75  public function onSuccess() {
76  $this->getOutput()->wrapWikiMsg(
77  Html::successBox( '$1' ),
78  'resettokens-done'
79  );
80  }
81 
87  protected function getFormFields() {
88  $user = $this->getUser();
89  $tokens = $this->getTokensList();
90 
91  if ( $tokens ) {
92  $tokensForForm = [];
93  foreach ( $tokens as $tok ) {
94  $label = $this->msg( 'resettokens-token-label' )
95  ->rawParams( $this->msg( $tok['label-message'] )->parse() )
96  ->params( $user->getTokenFromOption( $tok['preference'] ) )
97  ->escaped();
98  $tokensForForm[$label] = $tok['preference'];
99  }
100 
101  $desc = [
102  'label-message' => 'resettokens-tokens',
103  'type' => 'multiselect',
104  'options' => $tokensForForm,
105  ];
106  } else {
107  $desc = [
108  'label-message' => 'resettokens-no-tokens',
109  'type' => 'info',
110  ];
111  }
112 
113  return [
114  'tokens' => $desc,
115  ];
116  }
117 
123  protected function alterForm( HTMLForm $form ) {
124  $form->setSubmitDestructive();
125  if ( $this->getTokensList() ) {
126  $form->setSubmitTextMsg( 'resettokens-resetbutton' );
127  } else {
128  $form->suppressDefaultSubmit();
129  }
130  }
131 
132  protected function getDisplayFormat() {
133  return 'ooui';
134  }
135 
136  public function onSubmit( array $formData ) {
137  if ( $formData['tokens'] ) {
138  $user = $this->getUser();
139  foreach ( $formData['tokens'] as $tokenPref ) {
140  $user->resetTokenFromOption( $tokenPref );
141  }
142  $user->saveSettings();
143 
144  return true;
145  }
146 
147  return false;
148  }
149 
150  protected function getGroupName() {
151  return 'users';
152  }
153 
154  public function isListed() {
155  return (bool)$this->getTokensList();
156  }
157 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
alterForm(HTMLForm $form)
Suppress the submit button if there&#39;s nothing to do; provide additional message on it otherwise...
$batch execute()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getOutput()
Get the OutputPage being used for this instance.
Special page which uses an HTMLForm to handle processing.
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1345
getTokensList()
Returns the token information list for this page after running the hook and filtering out disabled pr...
$tokens
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
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
Let users reset tokens like the watchlist token.
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
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.
onSubmit(array $formData)
string $par
The sub-page of the special page.
static successBox( $html)
Return a success box.
Definition: Html.php:744
getConfig()
Shortcut to get main config object.
msg( $key)
Wrapper around wfMessage that sets the current context.
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1374
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1458
getFormFields()
Display appropriate message if there&#39;s nothing to do.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1487
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200