MediaWiki  master
ProtectionForm.php
Go to the documentation of this file.
1 <?php
26 
32  protected $mRestrictions = [];
33 
35  protected $mReason = '';
36 
38  protected $mReasonSelection = '';
39 
41  protected $mCascade = false;
42 
44  protected $mExpiry = [];
45 
50  protected $mExpirySelection = [];
51 
53  protected $mPermErrors = [];
54 
56  protected $mApplicableTypes = [];
57 
59  protected $mExistingExpiry = [];
60 
62  private $mContext;
63 
65  // Set instance variables.
66  $this->mArticle = $article;
67  $this->mTitle = $article->getTitle();
68  $this->mApplicableTypes = $this->mTitle->getRestrictionTypes();
69  $this->mContext = $article->getContext();
70 
71  // Check if the form should be disabled.
72  // If it is, the form will be available in read-only to show levels.
73  $this->mPermErrors = $this->mTitle->getUserPermissionsErrors(
74  'protect',
75  $this->mContext->getUser(),
76  $this->mContext->getRequest()->wasPosted() ? 'secure' : 'full' // T92357
77  );
78  if ( wfReadOnly() ) {
79  $this->mPermErrors[] = [ 'readonlytext', wfReadOnlyReason() ];
80  }
81  $this->disabled = $this->mPermErrors != [];
82  $this->disabledAttrib = $this->disabled
83  ? [ 'disabled' => 'disabled' ]
84  : [];
85 
86  $this->loadData();
87  }
88 
92  function loadData() {
93  $levels = MediaWikiServices::getInstance()->getNamespaceInfo()->getRestrictionLevels(
94  $this->mTitle->getNamespace(), $this->mContext->getUser()
95  );
96  $this->mCascade = $this->mTitle->areRestrictionsCascading();
97 
98  $request = $this->mContext->getRequest();
99  $this->mReason = $request->getText( 'mwProtect-reason' );
100  $this->mReasonSelection = $request->getText( 'wpProtectReasonSelection' );
101  $this->mCascade = $request->getBool( 'mwProtect-cascade', $this->mCascade );
102 
103  foreach ( $this->mApplicableTypes as $action ) {
104  // @todo FIXME: This form currently requires individual selections,
105  // but the db allows multiples separated by commas.
106 
107  // Pull the actual restriction from the DB
108  $this->mRestrictions[$action] = implode( '', $this->mTitle->getRestrictions( $action ) );
109 
110  if ( !$this->mRestrictions[$action] ) {
111  // No existing expiry
112  $existingExpiry = '';
113  } else {
114  $existingExpiry = $this->mTitle->getRestrictionExpiry( $action );
115  }
116  $this->mExistingExpiry[$action] = $existingExpiry;
117 
118  $requestExpiry = $request->getText( "mwProtect-expiry-$action" );
119  $requestExpirySelection = $request->getVal( "wpProtectExpirySelection-$action" );
120 
121  if ( $requestExpiry ) {
122  // Custom expiry takes precedence
123  $this->mExpiry[$action] = $requestExpiry;
124  $this->mExpirySelection[$action] = 'othertime';
125  } elseif ( $requestExpirySelection ) {
126  // Expiry selected from list
127  $this->mExpiry[$action] = '';
128  $this->mExpirySelection[$action] = $requestExpirySelection;
129  } elseif ( $existingExpiry ) {
130  // Use existing expiry in its own list item
131  $this->mExpiry[$action] = '';
132  $this->mExpirySelection[$action] = $existingExpiry;
133  } else {
134  // Catches 'infinity' - Existing expiry is infinite, use "infinite" in drop-down
135  // Final default: infinite
136  $this->mExpiry[$action] = '';
137  $this->mExpirySelection[$action] = 'infinite';
138  }
139 
140  $val = $request->getVal( "mwProtect-level-$action" );
141  if ( isset( $val ) && in_array( $val, $levels ) ) {
142  $this->mRestrictions[$action] = $val;
143  }
144  }
145  }
146 
154  function getExpiry( $action ) {
155  if ( $this->mExpirySelection[$action] == 'existing' ) {
156  return $this->mExistingExpiry[$action];
157  } elseif ( $this->mExpirySelection[$action] == 'othertime' ) {
158  $value = $this->mExpiry[$action];
159  } else {
160  $value = $this->mExpirySelection[$action];
161  }
162  if ( wfIsInfinity( $value ) ) {
163  $time = 'infinity';
164  } else {
165  $unix = strtotime( $value );
166 
167  if ( !$unix || $unix === -1 ) {
168  return false;
169  }
170 
171  // @todo FIXME: Non-qualified absolute times are not in users specified timezone
172  // and there isn't notice about it in the ui
173  $time = wfTimestamp( TS_MW, $unix );
174  }
175  return $time;
176  }
177 
181  function execute() {
182  if (
183  MediaWikiServices::getInstance()->getNamespaceInfo()->getRestrictionLevels(
184  $this->mTitle->getNamespace()
185  ) === [ '' ]
186  ) {
187  throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
188  }
189 
190  if ( $this->mContext->getRequest()->wasPosted() ) {
191  if ( $this->save() ) {
192  $q = $this->mArticle->isRedirect() ? 'redirect=no' : '';
193  $this->mContext->getOutput()->redirect( $this->mTitle->getFullURL( $q ) );
194  }
195  } else {
196  $this->show();
197  }
198  }
199 
205  function show( $err = null ) {
206  $out = $this->mContext->getOutput();
207  $out->setRobotPolicy( 'noindex,nofollow' );
208  $out->addBacklinkSubtitle( $this->mTitle );
209 
210  if ( is_array( $err ) ) {
211  $out->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n", $err );
212  } elseif ( is_string( $err ) ) {
213  $out->addHTML( "<div class='error'>{$err}</div>\n" );
214  }
215 
216  if ( $this->mTitle->getRestrictionTypes() === [] ) {
217  // No restriction types available for the current title
218  // this might happen if an extension alters the available types
219  $out->setPageTitle( $this->mContext->msg(
220  'protect-norestrictiontypes-title',
221  $this->mTitle->getPrefixedText()
222  ) );
223  $out->addWikiTextAsInterface(
224  $this->mContext->msg( 'protect-norestrictiontypes-text' )->plain()
225  );
226 
227  // Show the log in case protection was possible once
228  $this->showLogExtract( $out );
229  // return as there isn't anything else we can do
230  return;
231  }
232 
233  list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
234  if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
235  $titles = '';
236 
237  foreach ( $cascadeSources as $title ) {
238  $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
239  }
240 
242  $out->wrapWikiMsg(
243  "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
244  [ 'protect-cascadeon', count( $cascadeSources ) ]
245  );
246  }
247 
248  # Show an appropriate message if the user isn't allowed or able to change
249  # the protection settings at this time
250  if ( $this->disabled ) {
251  $out->setPageTitle(
252  $this->mContext->msg( 'protect-title-notallowed',
253  $this->mTitle->getPrefixedText() )
254  );
255  $out->addWikiTextAsInterface( $out->formatPermissionsErrorMessage(
256  $this->mPermErrors, 'protect'
257  ) );
258  } else {
259  $out->setPageTitle( $this->mContext->msg( 'protect-title', $this->mTitle->getPrefixedText() ) );
260  $out->addWikiMsg( 'protect-text',
261  wfEscapeWikiText( $this->mTitle->getPrefixedText() ) );
262  }
263 
264  $out->addHTML( $this->buildForm() );
265  $this->showLogExtract( $out );
266  }
267 
273  function save() {
274  # Permission check!
275  if ( $this->disabled ) {
276  $this->show();
277  return false;
278  }
279 
280  $request = $this->mContext->getRequest();
281  $user = $this->mContext->getUser();
282  $out = $this->mContext->getOutput();
283  $token = $request->getVal( 'wpEditToken' );
284  if ( !$user->matchEditToken( $token, [ 'protect', $this->mTitle->getPrefixedDBkey() ] ) ) {
285  $this->show( [ 'sessionfailure' ] );
286  return false;
287  }
288 
289  # Create reason string. Use list and/or custom string.
290  $reasonstr = $this->mReasonSelection;
291  if ( $reasonstr != 'other' && $this->mReason != '' ) {
292  // Entry from drop down menu + additional comment
293  $reasonstr .= $this->mContext->msg( 'colon-separator' )->text() . $this->mReason;
294  } elseif ( $reasonstr == 'other' ) {
295  $reasonstr = $this->mReason;
296  }
297  $expiry = [];
298  foreach ( $this->mApplicableTypes as $action ) {
299  $expiry[$action] = $this->getExpiry( $action );
300  if ( empty( $this->mRestrictions[$action] ) ) {
301  continue; // unprotected
302  }
303  if ( !$expiry[$action] ) {
304  $this->show( [ 'protect_expiry_invalid' ] );
305  return false;
306  }
307  if ( $expiry[$action] < wfTimestampNow() ) {
308  $this->show( [ 'protect_expiry_old' ] );
309  return false;
310  }
311  }
312 
313  $this->mCascade = $request->getBool( 'mwProtect-cascade' );
314 
315  $status = $this->mArticle->doUpdateRestrictions(
316  $this->mRestrictions,
317  $expiry,
318  $this->mCascade,
319  $reasonstr,
320  $user
321  );
322 
323  if ( !$status->isOK() ) {
324  $this->show( $out->parseInlineAsInterface( $status->getWikiText() ) );
325  return false;
326  }
327 
334  $errorMsg = '';
335  if ( !Hooks::run( 'ProtectionForm::save', [ $this->mArticle, &$errorMsg, $reasonstr ] ) ) {
336  if ( $errorMsg == '' ) {
337  $errorMsg = [ 'hookaborted' ];
338  }
339  }
340  if ( $errorMsg != '' ) {
341  $this->show( $errorMsg );
342  return false;
343  }
344 
345  WatchAction::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle, $user );
346 
347  return true;
348  }
349 
355  function buildForm() {
357  $user = $context->getUser();
358  $output = $context->getOutput();
359  $lang = $context->getLanguage();
360  $out = '';
361  if ( !$this->disabled ) {
362  $output->addModules( 'mediawiki.legacy.protect' );
363  $out .= Xml::openElement( 'form', [ 'method' => 'post',
364  'action' => $this->mTitle->getLocalURL( 'action=protect' ),
365  'id' => 'mw-Protect-Form' ] );
366  }
367 
368  $out .= Xml::openElement( 'fieldset' ) .
369  Xml::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
370  Xml::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
371  Xml::openElement( 'tbody' );
372 
373  $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
374  $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled;
375 
376  // Not all languages have V_x <-> N_x relation
377  foreach ( $this->mRestrictions as $action => $selected ) {
378  // Messages:
379  // restriction-edit, restriction-move, restriction-create, restriction-upload
380  $msg = $context->msg( 'restriction-' . $action );
381  $out .= "<tr><td>" .
382  Xml::openElement( 'fieldset' ) .
383  Xml::element( 'legend', null, $msg->exists() ? $msg->text() : $action ) .
384  Xml::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
385  "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
386 
387  $mProtectexpiry = Xml::label(
388  $context->msg( 'protectexpiry' )->text(),
389  "mwProtectExpirySelection-$action"
390  );
391  $mProtectother = Xml::label(
392  $context->msg( 'protect-othertime' )->text(),
393  "mwProtect-$action-expires"
394  );
395 
396  $expiryFormOptions = new XmlSelect(
397  "wpProtectExpirySelection-$action",
398  "mwProtectExpirySelection-$action",
399  $this->mExpirySelection[$action]
400  );
401  $expiryFormOptions->setAttribute( 'tabindex', '2' );
402  if ( $this->disabled ) {
403  $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
404  }
405 
406  if ( $this->mExistingExpiry[$action] ) {
407  if ( $this->mExistingExpiry[$action] == 'infinity' ) {
408  $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
409  } else {
410  $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry[$action], $user );
411  $d = $lang->userDate( $this->mExistingExpiry[$action], $user );
412  $t = $lang->userTime( $this->mExistingExpiry[$action], $user );
413  $existingExpiryMessage = $context->msg(
414  'protect-existing-expiry',
415  $timestamp,
416  $d,
417  $t
418  );
419  }
420  $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
421  }
422 
423  $expiryFormOptions->addOption(
424  $context->msg( 'protect-othertime-op' )->text(),
425  'othertime'
426  );
427  foreach ( explode( ',', $scExpiryOptions ) as $option ) {
428  if ( strpos( $option, ":" ) === false ) {
429  $show = $value = $option;
430  } else {
431  list( $show, $value ) = explode( ":", $option );
432  }
433  $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
434  }
435  # Add expiry dropdown
436  if ( $showProtectOptions && !$this->disabled ) {
437  $out .= "
438  <table><tr>
439  <td class='mw-label'>
440  {$mProtectexpiry}
441  </td>
442  <td class='mw-input'>" .
443  $expiryFormOptions->getHTML() .
444  "</td>
445  </tr></table>";
446  }
447  # Add custom expiry field
448  $attribs = [ 'id' => "mwProtect-$action-expires" ] + $this->disabledAttrib;
449  $out .= "<table><tr>
450  <td class='mw-label'>" .
451  $mProtectother .
452  '</td>
453  <td class="mw-input">' .
454  Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
455  '</td>
456  </tr></table>';
457  $out .= "</td></tr>" .
458  Xml::closeElement( 'table' ) .
459  Xml::closeElement( 'fieldset' ) .
460  "</td></tr>";
461  }
462  # Give extensions a chance to add items to the form
463  Hooks::run( 'ProtectionForm::buildForm', [ $this->mArticle, &$out ] );
464 
465  $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
466 
467  // JavaScript will add another row with a value-chaining checkbox
468  if ( $this->mTitle->exists() ) {
469  $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
470  Xml::openElement( 'tbody' );
471  $out .= '<tr>
472  <td></td>
473  <td class="mw-input">' .
475  $context->msg( 'protect-cascade' )->text(),
476  'mwProtect-cascade',
477  'mwProtect-cascade',
478  $this->mCascade, $this->disabledAttrib
479  ) .
480  "</td>
481  </tr>\n";
482  $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
483  }
484 
485  # Add manual and custom reason field/selects as well as submit
486  if ( !$this->disabled ) {
487  $mProtectreasonother = Xml::label(
488  $context->msg( 'protectcomment' )->text(),
489  'wpProtectReasonSelection'
490  );
491 
492  $mProtectreason = Xml::label(
493  $context->msg( 'protect-otherreason' )->text(),
494  'mwProtect-reason'
495  );
496 
497  $reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
498  wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
499  wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
500  $this->mReasonSelection,
501  'mwProtect-reason', 4 );
502 
503  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
504  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
505  // Unicode codepoints.
506  // Subtract arbitrary 75 to leave some space for the autogenerated null edit's summary
507  // and other texts chosen by dropdown menus on this page.
508  $maxlength = CommentStore::COMMENT_CHARACTER_LIMIT - 75;
509 
510  $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
511  Xml::openElement( 'tbody' );
512  $out .= "
513  <tr>
514  <td class='mw-label'>
515  {$mProtectreasonother}
516  </td>
517  <td class='mw-input'>
518  {$reasonDropDown}
519  </td>
520  </tr>
521  <tr>
522  <td class='mw-label'>
523  {$mProtectreason}
524  </td>
525  <td class='mw-input'>" .
526  Xml::input( 'mwProtect-reason', 60, $this->mReason, [ 'type' => 'text',
527  'id' => 'mwProtect-reason', 'maxlength' => $maxlength ] ) .
528  "</td>
529  </tr>";
530  # Disallow watching is user is not logged in
531  if ( $user->isLoggedIn() ) {
532  $out .= "
533  <tr>
534  <td></td>
535  <td class='mw-input'>" .
536  Xml::checkLabel( $context->msg( 'watchthis' )->text(),
537  'mwProtectWatch', 'mwProtectWatch',
538  $user->isWatched( $this->mTitle ) || $user->getOption( 'watchdefault' ) ) .
539  "</td>
540  </tr>";
541  }
542  $out .= "
543  <tr>
544  <td></td>
545  <td class='mw-submit'>" .
547  $context->msg( 'confirm' )->text(),
548  [ 'id' => 'mw-Protect-submit' ]
549  ) .
550  "</td>
551  </tr>\n";
552  $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
553  }
554  $out .= Xml::closeElement( 'fieldset' );
555 
556  if ( $user->isAllowed( 'editinterface' ) ) {
557  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
558  $link = $linkRenderer->makeKnownLink(
559  $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
560  $context->msg( 'protect-edit-reasonlist' )->text(),
561  [],
562  [ 'action' => 'edit' ]
563  );
564  $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
565  }
566 
567  if ( !$this->disabled ) {
568  $out .= Html::hidden(
569  'wpEditToken',
570  $user->getEditToken( [ 'protect', $this->mTitle->getPrefixedDBkey() ] )
571  );
572  $out .= Xml::closeElement( 'form' );
573  }
574 
575  return $out;
576  }
577 
585  function buildSelector( $action, $selected ) {
586  // If the form is disabled, display all relevant levels. Otherwise,
587  // just show the ones this user can use.
588  $levels = MediaWikiServices::getInstance()->getNamespaceInfo()->getRestrictionLevels(
589  $this->mTitle->getNamespace(),
590  $this->disabled ? null : $this->mContext->getUser()
591  );
592 
593  $id = 'mwProtect-level-' . $action;
594 
595  $select = new XmlSelect( $id, $id, $selected );
596  $select->setAttribute( 'size', count( $levels ) );
597  if ( $this->disabled ) {
598  $select->setAttribute( 'disabled', 'disabled' );
599  }
600 
601  foreach ( $levels as $key ) {
602  $select->addOption( $this->getOptionLabel( $key ), $key );
603  }
604 
605  return $select->getHTML();
606  }
607 
614  private function getOptionLabel( $permission ) {
615  if ( $permission == '' ) {
616  return $this->mContext->msg( 'protect-default' )->text();
617  } else {
618  // Messages: protect-level-autoconfirmed, protect-level-sysop
619  $msg = $this->mContext->msg( "protect-level-{$permission}" );
620  if ( $msg->exists() ) {
621  return $msg->text();
622  }
623  return $this->mContext->msg( 'protect-fallback', $permission )->text();
624  }
625  }
626 
632  private function showLogExtract( OutputPage $out ) {
633  # Show relevant lines from the protection log:
634  $protectLogPage = new LogPage( 'protect' );
635  $out->addHTML( Xml::element( 'h2', null, $protectLogPage->getName()->text() ) );
636  LogEventsList::showLogExtract( $out, 'protect', $this->mTitle );
637  # Let extensions add other relevant log extracts
638  Hooks::run( 'ProtectionForm::showLogExtract', [ $this->mArticle, $out ] );
639  }
640 }
showLogExtract(OutputPage $out)
Show protection long extracts for this page.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
save()
Save submitted protection form.
buildForm()
Build the input form.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:1982
if(!isset( $args[0])) $lang
Class for generating HTML <select> or <datalist> elements.
Definition: XmlSelect.php:26
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:274
string $mReasonSelection
The reason selected from the list, blank for other/additional.
Class for viewing MediaWiki article and history.
Definition: Article.php:38
$value
wfIsInfinity( $str)
Determine input string is represents as infinity.
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
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
array $mApplicableTypes
Types (i.e.
buildSelector( $action, $selected)
Build protection level selector.
array $mRestrictions
A map of action to restriction level, from request or default.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1799
array $mPermErrors
Permissions errors for the protect action.
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
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2217
array $mExpiry
Map of action to "other" expiry time.
Class to simplify the use of log pages.
Definition: LogPage.php:33
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3051
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
getContext()
Gets the context this Article is executed in.
Definition: Article.php:2237
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfReadOnly()
Check whether the wiki is in read-only mode.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
getExpiry( $action)
Get the expiry time for a given action, by combining the relevant inputs.
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:108
An error page which can definitely be safely rendered using the OutputPage.
static doWatchOrUnwatch( $watch, Title $title, User $user)
Watch or unwatch a page.
Definition: WatchAction.php:89
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
getOptionLabel( $permission)
Prepare the label for a protection selector option.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
string $mReason
The custom/additional protection reason.
getTitle()
Get the title object of the article.
Definition: Article.php:221
IContextSource $mContext
loadData()
Loads the current state of protection into the object.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1982
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
show( $err=null)
Show the input form with optional error message.
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
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
Definition: Xml.php:358
getTitle()
Get the Title object that we&#39;ll be acting on, as specified in the WebRequest.
Definition: MediaWiki.php:137
execute()
Main entry point for action=protect and action=unprotect.
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
__construct(Article $article)
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:117
static listDropDown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
Definition: Xml.php:508
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
array $mExpirySelection
Map of action to value selected in expiry drop-down list.
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
array $mExistingExpiry
Map of action to the expiry time of the existing protection.
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:797
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
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:2633
bool $mCascade
True if the restrictions are cascading, from request or existing protection.
addHTML( $text)
Append $text to the body HTML.
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file & $article
Definition: hooks.txt:1473
Handles the page protection UI and backend.
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:419
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 $request
Definition: hooks.txt:2633
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.