MediaWiki  1.30.0
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() {
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 ( MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace() ) === [ '' ] ) {
183  throw new ErrorPageError( 'protect-badnamespace-title', 'protect-badnamespace-text' );
184  }
185 
186  if ( $this->mContext->getRequest()->wasPosted() ) {
187  if ( $this->save() ) {
188  $q = $this->mArticle->isRedirect() ? 'redirect=no' : '';
189  $this->mContext->getOutput()->redirect( $this->mTitle->getFullURL( $q ) );
190  }
191  } else {
192  $this->show();
193  }
194  }
195 
201  function show( $err = null ) {
202  $out = $this->mContext->getOutput();
203  $out->setRobotPolicy( 'noindex,nofollow' );
204  $out->addBacklinkSubtitle( $this->mTitle );
205 
206  if ( is_array( $err ) ) {
207  $out->wrapWikiMsg( "<p class='error'>\n$1\n</p>\n", $err );
208  } elseif ( is_string( $err ) ) {
209  $out->addHTML( "<p class='error'>{$err}</p>\n" );
210  }
211 
212  if ( $this->mTitle->getRestrictionTypes() === [] ) {
213  // No restriction types available for the current title
214  // this might happen if an extension alters the available types
215  $out->setPageTitle( $this->mContext->msg(
216  'protect-norestrictiontypes-title',
217  $this->mTitle->getPrefixedText()
218  ) );
219  $out->addWikiText( $this->mContext->msg( 'protect-norestrictiontypes-text' )->plain() );
220 
221  // Show the log in case protection was possible once
222  $this->showLogExtract( $out );
223  // return as there isn't anything else we can do
224  return;
225  }
226 
227  list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
228  if ( $cascadeSources && count( $cascadeSources ) > 0 ) {
229  $titles = '';
230 
231  foreach ( $cascadeSources as $title ) {
232  $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
233  }
234 
236  $out->wrapWikiMsg(
237  "<div id=\"mw-protect-cascadeon\">\n$1\n" . $titles . "</div>",
238  [ 'protect-cascadeon', count( $cascadeSources ) ]
239  );
240  }
241 
242  # Show an appropriate message if the user isn't allowed or able to change
243  # the protection settings at this time
244  if ( $this->disabled ) {
245  $out->setPageTitle(
246  $this->mContext->msg( 'protect-title-notallowed',
247  $this->mTitle->getPrefixedText() )
248  );
249  $out->addWikiText( $out->formatPermissionsErrorMessage( $this->mPermErrors, 'protect' ) );
250  } else {
251  $out->setPageTitle( $this->mContext->msg( 'protect-title', $this->mTitle->getPrefixedText() ) );
252  $out->addWikiMsg( 'protect-text',
253  wfEscapeWikiText( $this->mTitle->getPrefixedText() ) );
254  }
255 
256  $out->addHTML( $this->buildForm() );
257  $this->showLogExtract( $out );
258  }
259 
265  function save() {
266  # Permission check!
267  if ( $this->disabled ) {
268  $this->show();
269  return false;
270  }
271 
272  $request = $this->mContext->getRequest();
273  $user = $this->mContext->getUser();
274  $out = $this->mContext->getOutput();
275  $token = $request->getVal( 'wpEditToken' );
276  if ( !$user->matchEditToken( $token, [ 'protect', $this->mTitle->getPrefixedDBkey() ] ) ) {
277  $this->show( [ 'sessionfailure' ] );
278  return false;
279  }
280 
281  # Create reason string. Use list and/or custom string.
282  $reasonstr = $this->mReasonSelection;
283  if ( $reasonstr != 'other' && $this->mReason != '' ) {
284  // Entry from drop down menu + additional comment
285  $reasonstr .= $this->mContext->msg( 'colon-separator' )->text() . $this->mReason;
286  } elseif ( $reasonstr == 'other' ) {
287  $reasonstr = $this->mReason;
288  }
289  $expiry = [];
290  foreach ( $this->mApplicableTypes as $action ) {
291  $expiry[$action] = $this->getExpiry( $action );
292  if ( empty( $this->mRestrictions[$action] ) ) {
293  continue; // unprotected
294  }
295  if ( !$expiry[$action] ) {
296  $this->show( [ 'protect_expiry_invalid' ] );
297  return false;
298  }
299  if ( $expiry[$action] < wfTimestampNow() ) {
300  $this->show( [ 'protect_expiry_old' ] );
301  return false;
302  }
303  }
304 
305  $this->mCascade = $request->getBool( 'mwProtect-cascade' );
306 
307  $status = $this->mArticle->doUpdateRestrictions(
308  $this->mRestrictions,
309  $expiry,
310  $this->mCascade,
311  $reasonstr,
312  $user
313  );
314 
315  if ( !$status->isOK() ) {
316  $this->show( $out->parseInline( $status->getWikiText() ) );
317  return false;
318  }
319 
326  $errorMsg = '';
327  if ( !Hooks::run( 'ProtectionForm::save', [ $this->mArticle, &$errorMsg, $reasonstr ] ) ) {
328  if ( $errorMsg == '' ) {
329  $errorMsg = [ 'hookaborted' ];
330  }
331  }
332  if ( $errorMsg != '' ) {
333  $this->show( $errorMsg );
334  return false;
335  }
336 
337  WatchAction::doWatchOrUnwatch( $request->getCheck( 'mwProtectWatch' ), $this->mTitle, $user );
338 
339  return true;
340  }
341 
347  function buildForm() {
349  $user = $context->getUser();
350  $output = $context->getOutput();
351  $lang = $context->getLanguage();
352  $cascadingRestrictionLevels = $context->getConfig()->get( 'CascadingRestrictionLevels' );
353  $out = '';
354  if ( !$this->disabled ) {
355  $output->addModules( 'mediawiki.legacy.protect' );
356  $output->addJsConfigVars( 'wgCascadeableLevels', $cascadingRestrictionLevels );
357  $out .= Xml::openElement( 'form', [ 'method' => 'post',
358  'action' => $this->mTitle->getLocalURL( 'action=protect' ),
359  'id' => 'mw-Protect-Form' ] );
360  }
361 
362  $out .= Xml::openElement( 'fieldset' ) .
363  Xml::element( 'legend', null, $context->msg( 'protect-legend' )->text() ) .
364  Xml::openElement( 'table', [ 'id' => 'mwProtectSet' ] ) .
365  Xml::openElement( 'tbody' );
366 
367  $scExpiryOptions = wfMessage( 'protect-expiry-options' )->inContentLanguage()->text();
368  $showProtectOptions = $scExpiryOptions !== '-' && !$this->disabled;
369 
370  // Not all languages have V_x <-> N_x relation
371  foreach ( $this->mRestrictions as $action => $selected ) {
372  // Messages:
373  // restriction-edit, restriction-move, restriction-create, restriction-upload
374  $msg = $context->msg( 'restriction-' . $action );
375  $out .= "<tr><td>" .
376  Xml::openElement( 'fieldset' ) .
377  Xml::element( 'legend', null, $msg->exists() ? $msg->text() : $action ) .
378  Xml::openElement( 'table', [ 'id' => "mw-protect-table-$action" ] ) .
379  "<tr><td>" . $this->buildSelector( $action, $selected ) . "</td></tr><tr><td>";
380 
381  $mProtectexpiry = Xml::label(
382  $context->msg( 'protectexpiry' )->text(),
383  "mwProtectExpirySelection-$action"
384  );
385  $mProtectother = Xml::label(
386  $context->msg( 'protect-othertime' )->text(),
387  "mwProtect-$action-expires"
388  );
389 
390  $expiryFormOptions = new XmlSelect(
391  "wpProtectExpirySelection-$action",
392  "mwProtectExpirySelection-$action",
393  $this->mExpirySelection[$action]
394  );
395  $expiryFormOptions->setAttribute( 'tabindex', '2' );
396  if ( $this->disabled ) {
397  $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
398  }
399 
400  if ( $this->mExistingExpiry[$action] ) {
401  if ( $this->mExistingExpiry[$action] == 'infinity' ) {
402  $existingExpiryMessage = $context->msg( 'protect-existing-expiry-infinity' );
403  } else {
404  $timestamp = $lang->userTimeAndDate( $this->mExistingExpiry[$action], $user );
405  $d = $lang->userDate( $this->mExistingExpiry[$action], $user );
406  $t = $lang->userTime( $this->mExistingExpiry[$action], $user );
407  $existingExpiryMessage = $context->msg(
408  'protect-existing-expiry',
409  $timestamp,
410  $d,
411  $t
412  );
413  }
414  $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
415  }
416 
417  $expiryFormOptions->addOption(
418  $context->msg( 'protect-othertime-op' )->text(),
419  'othertime'
420  );
421  foreach ( explode( ',', $scExpiryOptions ) as $option ) {
422  if ( strpos( $option, ":" ) === false ) {
423  $show = $value = $option;
424  } else {
425  list( $show, $value ) = explode( ":", $option );
426  }
427  $expiryFormOptions->addOption( $show, htmlspecialchars( $value ) );
428  }
429  # Add expiry dropdown
430  if ( $showProtectOptions && !$this->disabled ) {
431  $out .= "
432  <table><tr>
433  <td class='mw-label'>
434  {$mProtectexpiry}
435  </td>
436  <td class='mw-input'>" .
437  $expiryFormOptions->getHTML() .
438  "</td>
439  </tr></table>";
440  }
441  # Add custom expiry field
442  $attribs = [ 'id' => "mwProtect-$action-expires" ] + $this->disabledAttrib;
443  $out .= "<table><tr>
444  <td class='mw-label'>" .
445  $mProtectother .
446  '</td>
447  <td class="mw-input">' .
448  Xml::input( "mwProtect-expiry-$action", 50, $this->mExpiry[$action], $attribs ) .
449  '</td>
450  </tr></table>';
451  $out .= "</td></tr>" .
452  Xml::closeElement( 'table' ) .
453  Xml::closeElement( 'fieldset' ) .
454  "</td></tr>";
455  }
456  # Give extensions a chance to add items to the form
457  Hooks::run( 'ProtectionForm::buildForm', [ $this->mArticle, &$out ] );
458 
459  $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
460 
461  // JavaScript will add another row with a value-chaining checkbox
462  if ( $this->mTitle->exists() ) {
463  $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table2' ] ) .
464  Xml::openElement( 'tbody' );
465  $out .= '<tr>
466  <td></td>
467  <td class="mw-input">' .
469  $context->msg( 'protect-cascade' )->text(),
470  'mwProtect-cascade',
471  'mwProtect-cascade',
472  $this->mCascade, $this->disabledAttrib
473  ) .
474  "</td>
475  </tr>\n";
476  $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
477  }
478 
479  # Add manual and custom reason field/selects as well as submit
480  if ( !$this->disabled ) {
481  $mProtectreasonother = Xml::label(
482  $context->msg( 'protectcomment' )->text(),
483  'wpProtectReasonSelection'
484  );
485 
486  $mProtectreason = Xml::label(
487  $context->msg( 'protect-otherreason' )->text(),
488  'mwProtect-reason'
489  );
490 
491  $reasonDropDown = Xml::listDropDown( 'wpProtectReasonSelection',
492  wfMessage( 'protect-dropdown' )->inContentLanguage()->text(),
493  wfMessage( 'protect-otherreason-op' )->inContentLanguage()->text(),
494  $this->mReasonSelection,
495  'mwProtect-reason', 4 );
496 
497  $out .= Xml::openElement( 'table', [ 'id' => 'mw-protect-table3' ] ) .
498  Xml::openElement( 'tbody' );
499  $out .= "
500  <tr>
501  <td class='mw-label'>
502  {$mProtectreasonother}
503  </td>
504  <td class='mw-input'>
505  {$reasonDropDown}
506  </td>
507  </tr>
508  <tr>
509  <td class='mw-label'>
510  {$mProtectreason}
511  </td>
512  <td class='mw-input'>" .
513  Xml::input( 'mwProtect-reason', 60, $this->mReason, [ 'type' => 'text',
514  'id' => 'mwProtect-reason', 'maxlength' => 180 ] ) .
515  // Limited maxlength as the database trims at 255 bytes and other texts
516  // chosen by dropdown menus on this page are also included in this database field.
517  // The byte limit of 180 bytes is enforced in javascript
518  "</td>
519  </tr>";
520  # Disallow watching is user is not logged in
521  if ( $user->isLoggedIn() ) {
522  $out .= "
523  <tr>
524  <td></td>
525  <td class='mw-input'>" .
526  Xml::checkLabel( $context->msg( 'watchthis' )->text(),
527  'mwProtectWatch', 'mwProtectWatch',
528  $user->isWatched( $this->mTitle ) || $user->getOption( 'watchdefault' ) ) .
529  "</td>
530  </tr>";
531  }
532  $out .= "
533  <tr>
534  <td></td>
535  <td class='mw-submit'>" .
537  $context->msg( 'confirm' )->text(),
538  [ 'id' => 'mw-Protect-submit' ]
539  ) .
540  "</td>
541  </tr>\n";
542  $out .= Xml::closeElement( 'tbody' ) . Xml::closeElement( 'table' );
543  }
544  $out .= Xml::closeElement( 'fieldset' );
545 
546  if ( $user->isAllowed( 'editinterface' ) ) {
547  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
548  $link = $linkRenderer->makeKnownLink(
549  $context->msg( 'protect-dropdown' )->inContentLanguage()->getTitle(),
550  $context->msg( 'protect-edit-reasonlist' )->text(),
551  [],
552  [ 'action' => 'edit' ]
553  );
554  $out .= '<p class="mw-protect-editreasons">' . $link . '</p>';
555  }
556 
557  if ( !$this->disabled ) {
558  $out .= Html::hidden(
559  'wpEditToken',
560  $user->getEditToken( [ 'protect', $this->mTitle->getPrefixedDBkey() ] )
561  );
562  $out .= Xml::closeElement( 'form' );
563  }
564 
565  return $out;
566  }
567 
575  function buildSelector( $action, $selected ) {
576  // If the form is disabled, display all relevant levels. Otherwise,
577  // just show the ones this user can use.
578  $levels = MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace(),
579  $this->disabled ? null : $this->mContext->getUser()
580  );
581 
582  $id = 'mwProtect-level-' . $action;
583 
584  $select = new XmlSelect( $id, $id, $selected );
585  $select->setAttribute( 'size', count( $levels ) );
586  if ( $this->disabled ) {
587  $select->setAttribute( 'disabled', 'disabled' );
588  }
589 
590  foreach ( $levels as $key ) {
591  $select->addOption( $this->getOptionLabel( $key ), $key );
592  }
593 
594  return $select->getHTML();
595  }
596 
603  private function getOptionLabel( $permission ) {
604  if ( $permission == '' ) {
605  return $this->mContext->msg( 'protect-default' )->text();
606  } else {
607  // Messages: protect-level-autoconfirmed, protect-level-sysop
608  $msg = $this->mContext->msg( "protect-level-{$permission}" );
609  if ( $msg->exists() ) {
610  return $msg->text();
611  }
612  return $this->mContext->msg( 'protect-fallback', $permission )->text();
613  }
614  }
615 
622  function showLogExtract( &$out ) {
623  # Show relevant lines from the protection log:
624  $protectLogPage = new LogPage( 'protect' );
625  $out->addHTML( Xml::element( 'h2', null, $protectLogPage->getName()->text() ) );
626  LogEventsList::showLogExtract( $out, 'protect', $this->mTitle );
627  # Let extensions add other relevant log extracts
628  Hooks::run( 'ProtectionForm::showLogExtract', [ $this->mArticle, $out ] );
629  }
630 }
ProtectionForm\$mExpirySelection
array $mExpirySelection
Map of action to value selected in expiry drop-down list.
Definition: ProtectionForm.php:50
$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:244
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
ProtectionForm\$mExpiry
array $mExpiry
Map of action to "other" expiry time.
Definition: ProtectionForm.php:44
$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:2581
ProtectionForm\__construct
__construct(Article $article)
Definition: ProtectionForm.php:64
ProtectionForm\$mReason
string $mReason
The custom/additional protection reason.
Definition: ProtectionForm.php:35
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
Xml\label
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
Definition: Xml.php:358
captcha-old.count
count
Definition: captcha-old.py:249
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:12
MediaWiki\getTitle
getTitle()
Get the Title object that we'll be acting on, as specified in the WebRequest.
Definition: MediaWiki.php:137
ProtectionForm\getExpiry
getExpiry( $action)
Get the expiry time for a given action, by combining the relevant inputs.
Definition: ProtectionForm.php:154
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:2040
ProtectionForm\$mContext
IContextSource $mContext
Definition: ProtectionForm.php:62
$status
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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). '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:1245
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1324
ProtectionForm\loadData
loadData()
Loads the current state of protection into the object.
Definition: ProtectionForm.php:92
$linkRenderer
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:1965
Xml\openElement
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:109
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2198
ProtectionForm
Handles the page protection UI and backend.
Definition: ProtectionForm.php:30
ProtectionForm\save
save()
Save submitted protection form.
Definition: ProtectionForm.php:265
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:35
XmlSelect
Class for generating HTML <select> or <datalist> elements.
Definition: XmlSelect.php:26
ProtectionForm\$mRestrictions
array $mRestrictions
A map of action to restriction level, from request or default.
Definition: ProtectionForm.php:32
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
$titles
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
ProtectionForm\getOptionLabel
getOptionLabel( $permission)
Prepare the label for a protection selector option.
Definition: ProtectionForm.php:603
$article
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
Definition: hooks.txt:77
ProtectionForm\$mCascade
bool $mCascade
True if the restrictions are cascading, from request or existing protection.
Definition: ProtectionForm.php:41
ProtectionForm\showLogExtract
showLogExtract(&$out)
Show protection long extracts for this page.
Definition: ProtectionForm.php:622
$attribs
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:1965
LogPage
Class to simplify the use of log pages.
Definition: LogPage.php:31
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
WatchAction\doWatchOrUnwatch
static doWatchOrUnwatch( $watch, Title $title, User $user)
Watch or unwatch a page.
Definition: WatchAction.php:93
ProtectionForm\$mApplicableTypes
array $mApplicableTypes
Types (i.e.
Definition: ProtectionForm.php:56
ProtectionForm\execute
execute()
Main entry point for action=protect and action=unprotect.
Definition: ProtectionForm.php:181
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1778
LogEventsList\showLogExtract
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
Definition: LogEventsList.php:594
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:2069
MWNamespace\getRestrictionLevels
static getRestrictionLevels( $index, User $user=null)
Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a use...
Definition: MWNamespace.php:465
list
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
$request
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:2581
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:725
$value
$value
Definition: styleTest.css.php:45
ProtectionForm\show
show( $err=null)
Show the input form with optional error message.
Definition: ProtectionForm.php:201
wfIsInfinity
wfIsInfinity( $str)
Determine input string is represents as infinity.
Definition: GlobalFunctions.php:3377
ProtectionForm\$mExistingExpiry
array $mExistingExpiry
Map of action to the expiry time of the existing protection.
Definition: ProtectionForm.php:59
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1703
ProtectionForm\buildForm
buildForm()
Build the input form.
Definition: ProtectionForm.php:347
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:55
Xml\closeElement
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:118
wfReadOnlyReason
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
Definition: GlobalFunctions.php:1337
Xml\listDropDown
static listDropDown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
Definition: Xml.php:508
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:9
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2981
wfMessage
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 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
Xml\input
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:274
$t
$t
Definition: testCompression.php:67
Article
Class for viewing MediaWiki article and history.
Definition: Article.php:35
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:23
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
ProtectionForm\$mReasonSelection
string $mReasonSelection
The reason selected from the list, blank for other/additional.
Definition: ProtectionForm.php:38
ProtectionForm\buildSelector
buildSelector( $action, $selected)
Build protection level selector.
Definition: ProtectionForm.php:575
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Xml\submitButton
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
Xml\checkLabel
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:419
ProtectionForm\$mPermErrors
array $mPermErrors
Permissions errors for the protect action.
Definition: ProtectionForm.php:53
$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:781