MediaWiki  master
SpecialRevisionDelete.php
Go to the documentation of this file.
1 <?php
32  protected $wasSaved = false;
33 
35  private $submitClicked;
36 
38  private $ids;
39 
41  private $archiveName;
42 
44  private $token;
45 
47  private $targetObj;
48 
50  private $typeName;
51 
53  private $checks;
54 
56  private $typeLabels;
57 
59  private $revDelList;
60 
62  private $mIsAllowed;
63 
65  private $otherReason;
66 
70  private static $UILabels = [
71  'revision' => [
72  'check-label' => 'revdelete-hide-text',
73  'success' => 'revdelete-success',
74  'failure' => 'revdelete-failure',
75  'text' => 'revdelete-text-text',
76  'selected' => 'revdelete-selected-text',
77  ],
78  'archive' => [
79  'check-label' => 'revdelete-hide-text',
80  'success' => 'revdelete-success',
81  'failure' => 'revdelete-failure',
82  'text' => 'revdelete-text-text',
83  'selected' => 'revdelete-selected-text',
84  ],
85  'oldimage' => [
86  'check-label' => 'revdelete-hide-image',
87  'success' => 'revdelete-success',
88  'failure' => 'revdelete-failure',
89  'text' => 'revdelete-text-file',
90  'selected' => 'revdelete-selected-file',
91  ],
92  'filearchive' => [
93  'check-label' => 'revdelete-hide-image',
94  'success' => 'revdelete-success',
95  'failure' => 'revdelete-failure',
96  'text' => 'revdelete-text-file',
97  'selected' => 'revdelete-selected-file',
98  ],
99  'logging' => [
100  'check-label' => 'revdelete-hide-name',
101  'success' => 'logdelete-success',
102  'failure' => 'logdelete-failure',
103  'text' => 'logdelete-text',
104  'selected' => 'logdelete-selected',
105  ],
106  ];
107 
108  public function __construct() {
109  parent::__construct( 'Revisiondelete', 'deleterevision' );
110  }
111 
112  public function doesWrites() {
113  return true;
114  }
115 
116  public function execute( $par ) {
117  $this->useTransactionalTimeLimit();
118 
119  $this->checkPermissions();
120  $this->checkReadOnly();
121 
122  $output = $this->getOutput();
123  $user = $this->getUser();
124 
125  // Check blocks
126  // @TODO Use PermissionManager::isBlockedFrom() instead.
127  $block = $user->getBlock();
128  if ( $block ) {
129  throw new UserBlockedError( $block );
130  }
131 
132  $this->setHeaders();
133  $this->outputHeader();
134  $request = $this->getRequest();
135  $this->submitClicked = $request->wasPosted() && $request->getBool( 'wpSubmit' );
136  # Handle our many different possible input types.
137  $ids = $request->getVal( 'ids' );
138  if ( !is_null( $ids ) ) {
139  # Allow CSV, for backwards compatibility, or a single ID for show/hide links
140  $this->ids = explode( ',', $ids );
141  } else {
142  # Array input
143  $this->ids = array_keys( $request->getArray( 'ids', [] ) );
144  }
145  // $this->ids = array_map( 'intval', $this->ids );
146  $this->ids = array_unique( array_filter( $this->ids ) );
147 
148  $this->typeName = $request->getVal( 'type' );
149  $this->targetObj = Title::newFromText( $request->getText( 'target' ) );
150 
151  # For reviewing deleted files...
152  $this->archiveName = $request->getVal( 'file' );
153  $this->token = $request->getVal( 'token' );
154  if ( $this->archiveName && $this->targetObj ) {
155  $this->tryShowFile( $this->archiveName );
156 
157  return;
158  }
159 
160  $this->typeName = RevisionDeleter::getCanonicalTypeName( $this->typeName );
161 
162  # No targets?
163  if ( !$this->typeName || count( $this->ids ) == 0 ) {
164  throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
165  }
166 
167  # Allow the list type to adjust the passed target
168  $this->targetObj = RevisionDeleter::suggestTarget(
169  $this->typeName,
170  $this->targetObj,
171  $this->ids
172  );
173 
174  # We need a target page!
175  if ( $this->targetObj === null ) {
176  $output->addWikiMsg( 'undelete-header' );
177 
178  return;
179  }
180 
181  $this->typeLabels = self::$UILabels[$this->typeName];
182  $list = $this->getList();
183  $list->reset();
184  $this->mIsAllowed = $user->isAllowed( RevisionDeleter::getRestriction( $this->typeName ) );
185  $canViewSuppressedOnly = $this->getUser()->isAllowed( 'viewsuppressed' ) &&
186  !$this->getUser()->isAllowed( 'suppressrevision' );
187  $pageIsSuppressed = $list->areAnySuppressed();
188  $this->mIsAllowed = $this->mIsAllowed && !( $canViewSuppressedOnly && $pageIsSuppressed );
189 
190  $this->otherReason = $request->getVal( 'wpReason' );
191  # Give a link to the logs/hist for this page
192  $this->showConvenienceLinks();
193 
194  # Initialise checkboxes
195  $this->checks = [
196  # Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name
197  [ $this->typeLabels['check-label'], 'wpHidePrimary',
198  RevisionDeleter::getRevdelConstant( $this->typeName )
199  ],
200  [ 'revdelete-hide-comment', 'wpHideComment', Revision::DELETED_COMMENT ],
201  [ 'revdelete-hide-user', 'wpHideUser', Revision::DELETED_USER ]
202  ];
203  if ( $user->isAllowed( 'suppressrevision' ) ) {
204  $this->checks[] = [ 'revdelete-hide-restricted',
205  'wpHideRestricted', Revision::DELETED_RESTRICTED ];
206  }
207 
208  # Either submit or create our form
209  if ( $this->mIsAllowed && $this->submitClicked ) {
210  $this->submit();
211  } else {
212  $this->showForm();
213  }
214 
215  if ( $user->isAllowed( 'deletedhistory' ) ) {
216  $qc = $this->getLogQueryCond();
217  # Show relevant lines from the deletion log
218  $deleteLogPage = new LogPage( 'delete' );
219  $output->addHTML( "<h2>" . $deleteLogPage->getName()->escaped() . "</h2>\n" );
221  $output,
222  'delete',
223  $this->targetObj,
224  '', /* user */
225  [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
226  );
227  }
228  # Show relevant lines from the suppression log
229  if ( $user->isAllowed( 'suppressionlog' ) ) {
230  $suppressLogPage = new LogPage( 'suppress' );
231  $output->addHTML( "<h2>" . $suppressLogPage->getName()->escaped() . "</h2>\n" );
233  $output,
234  'suppress',
235  $this->targetObj,
236  '',
237  [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
238  );
239  }
240  }
241 
245  protected function showConvenienceLinks() {
246  $linkRenderer = $this->getLinkRenderer();
247  # Give a link to the logs/hist for this page
248  if ( $this->targetObj ) {
249  // Also set header tabs to be for the target.
250  $this->getSkin()->setRelevantTitle( $this->targetObj );
251 
252  $links = [];
253  $links[] = $linkRenderer->makeKnownLink(
254  SpecialPage::getTitleFor( 'Log' ),
255  $this->msg( 'viewpagelogs' )->text(),
256  [],
257  [ 'page' => $this->targetObj->getPrefixedText() ]
258  );
259  if ( !$this->targetObj->isSpecialPage() ) {
260  # Give a link to the page history
261  $links[] = $linkRenderer->makeKnownLink(
262  $this->targetObj,
263  $this->msg( 'pagehist' )->text(),
264  [],
265  [ 'action' => 'history' ]
266  );
267  # Link to deleted edits
268  if ( $this->getUser()->isAllowed( 'undelete' ) ) {
269  $undelete = SpecialPage::getTitleFor( 'Undelete' );
270  $links[] = $linkRenderer->makeKnownLink(
271  $undelete,
272  $this->msg( 'deletedhist' )->text(),
273  [],
274  [ 'target' => $this->targetObj->getPrefixedDBkey() ]
275  );
276  }
277  }
278  # Logs themselves don't have histories or archived revisions
279  $this->getOutput()->addSubtitle( $this->getLanguage()->pipeList( $links ) );
280  }
281  }
282 
287  protected function getLogQueryCond() {
288  $conds = [];
289  // Revision delete logs for these item
290  $conds['log_type'] = [ 'delete', 'suppress' ];
291  $conds['log_action'] = $this->getList()->getLogAction();
292  $conds['ls_field'] = RevisionDeleter::getRelationType( $this->typeName );
293  $conds['ls_value'] = $this->ids;
294 
295  return $conds;
296  }
297 
305  protected function tryShowFile( $archiveName ) {
306  $repo = RepoGroup::singleton()->getLocalRepo();
307  $oimage = $repo->newFromArchiveName( $this->targetObj, $archiveName );
308  $oimage->load();
309  // Check if user is allowed to see this file
310  if ( !$oimage->exists() ) {
311  $this->getOutput()->addWikiMsg( 'revdelete-no-file' );
312 
313  return;
314  }
315  $user = $this->getUser();
316  if ( !$oimage->userCan( File::DELETED_FILE, $user ) ) {
317  if ( $oimage->isDeleted( File::DELETED_RESTRICTED ) ) {
318  throw new PermissionsError( 'suppressrevision' );
319  } else {
320  throw new PermissionsError( 'deletedtext' );
321  }
322  }
323  if ( !$user->matchEditToken( $this->token, $archiveName ) ) {
324  $lang = $this->getLanguage();
325  $this->getOutput()->addWikiMsg( 'revdelete-show-file-confirm',
326  $this->targetObj->getText(),
327  $lang->userDate( $oimage->getTimestamp(), $user ),
328  $lang->userTime( $oimage->getTimestamp(), $user ) );
329  $this->getOutput()->addHTML(
330  Xml::openElement( 'form', [
331  'method' => 'POST',
332  'action' => $this->getPageTitle()->getLocalURL( [
333  'target' => $this->targetObj->getPrefixedDBkey(),
334  'file' => $archiveName,
335  'token' => $user->getEditToken( $archiveName ),
336  ] )
337  ]
338  ) .
339  Xml::submitButton( $this->msg( 'revdelete-show-file-submit' )->text() ) .
340  '</form>'
341  );
342 
343  return;
344  }
345  $this->getOutput()->disable();
346  # We mustn't allow the output to be CDN cached, otherwise
347  # if an admin previews a deleted image, and it's cached, then
348  # a user without appropriate permissions can toddle off and
349  # nab the image, and CDN will serve it
350  $this->getRequest()->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
351  $this->getRequest()->response()->header(
352  'Cache-Control: no-cache, no-store, max-age=0, must-revalidate'
353  );
354  $this->getRequest()->response()->header( 'Pragma: no-cache' );
355 
356  $key = $oimage->getStorageKey();
357  $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
358  $repo->streamFileWithStatus( $path );
359  }
360 
365  protected function getList() {
366  if ( is_null( $this->revDelList ) ) {
367  $this->revDelList = RevisionDeleter::createList(
368  $this->typeName, $this->getContext(), $this->targetObj, $this->ids
369  );
370  }
371 
372  return $this->revDelList;
373  }
374 
379  protected function showForm() {
380  $userAllowed = true;
381 
382  // Messages: revdelete-selected-text, revdelete-selected-file, logdelete-selected
383  $out = $this->getOutput();
384  $out->wrapWikiMsg( "<strong>$1</strong>", [ $this->typeLabels['selected'],
385  $this->getLanguage()->formatNum( count( $this->ids ) ), $this->targetObj->getPrefixedText() ] );
386 
387  $this->addHelpLink( 'Help:RevisionDelete' );
388  $out->addHTML( "<ul>" );
389 
390  $numRevisions = 0;
391  // Live revisions...
392  $list = $this->getList();
393  for ( $list->reset(); $list->current(); $list->next() ) {
394  $item = $list->current();
395 
396  if ( !$item->canView() ) {
397  if ( !$this->submitClicked ) {
398  throw new PermissionsError( 'suppressrevision' );
399  }
400  $userAllowed = false;
401  }
402 
403  $numRevisions++;
404  $out->addHTML( $item->getHTML() );
405  }
406 
407  if ( !$numRevisions ) {
408  throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
409  }
410 
411  $out->addHTML( "</ul>" );
412  // Explanation text
413  $this->addUsageText();
414 
415  // Normal sysops can always see what they did, but can't always change it
416  if ( !$userAllowed ) {
417  return;
418  }
419 
420  // Show form if the user can submit
421  if ( $this->mIsAllowed ) {
422  $out->addModules( [ 'mediawiki.special.revisionDelete' ] );
423  $out->addModuleStyles( [ 'mediawiki.special',
424  'mediawiki.interface.helpers.styles' ] );
425 
426  $form = Xml::openElement( 'form', [ 'method' => 'post',
427  'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ),
428  'id' => 'mw-revdel-form-revisions' ] ) .
429  Xml::fieldset( $this->msg( 'revdelete-legend' )->text() ) .
430  $this->buildCheckBoxes() .
431  Xml::openElement( 'table' ) .
432  "<tr>\n" .
433  '<td class="mw-label">' .
434  Xml::label( $this->msg( 'revdelete-log' )->text(), 'wpRevDeleteReasonList' ) .
435  '</td>' .
436  '<td class="mw-input">' .
437  Xml::listDropDown( 'wpRevDeleteReasonList',
438  $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->text(),
439  $this->msg( 'revdelete-reasonotherlist' )->inContentLanguage()->text(),
440  $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' ), 'wpReasonDropDown'
441  ) .
442  '</td>' .
443  "</tr><tr>\n" .
444  '<td class="mw-label">' .
445  Xml::label( $this->msg( 'revdelete-otherreason' )->text(), 'wpReason' ) .
446  '</td>' .
447  '<td class="mw-input">' .
448  Xml::input( 'wpReason', 60, $this->otherReason, [
449  'id' => 'wpReason',
450  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
451  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
452  // Unicode codepoints.
453  // "- 155" is to leave room for the 'wpRevDeleteReasonList' value.
454  'maxlength' => CommentStore::COMMENT_CHARACTER_LIMIT - 155,
455  ] ) .
456  '</td>' .
457  "</tr><tr>\n" .
458  '<td></td>' .
459  '<td class="mw-submit">' .
460  Xml::submitButton( $this->msg( 'revdelete-submit', $numRevisions )->text(),
461  [ 'name' => 'wpSubmit' ] ) .
462  '</td>' .
463  "</tr>\n" .
464  Xml::closeElement( 'table' ) .
465  Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() ) .
466  Html::hidden( 'target', $this->targetObj->getPrefixedText() ) .
467  Html::hidden( 'type', $this->typeName ) .
468  Html::hidden( 'ids', implode( ',', $this->ids ) ) .
469  Xml::closeElement( 'fieldset' ) . "\n" .
470  Xml::closeElement( 'form' ) . "\n";
471  // Show link to edit the dropdown reasons
472  if ( $this->getUser()->isAllowed( 'editinterface' ) ) {
473  $link = $this->getLinkRenderer()->makeKnownLink(
474  $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->getTitle(),
475  $this->msg( 'revdelete-edit-reasonlist' )->text(),
476  [],
477  [ 'action' => 'edit' ]
478  );
479  $form .= Xml::tags( 'p', [ 'class' => 'mw-revdel-editreasons' ], $link ) . "\n";
480  }
481  } else {
482  $form = '';
483  }
484  $out->addHTML( $form );
485  }
486 
491  protected function addUsageText() {
492  // Messages: revdelete-text-text, revdelete-text-file, logdelete-text
493  $this->getOutput()->wrapWikiMsg(
494  "<strong>$1</strong>\n$2", $this->typeLabels['text'],
495  'revdelete-text-others'
496  );
497 
498  if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
499  $this->getOutput()->addWikiMsg( 'revdelete-suppress-text' );
500  }
501 
502  if ( $this->mIsAllowed ) {
503  $this->getOutput()->addWikiMsg( 'revdelete-confirm' );
504  }
505  }
506 
510  protected function buildCheckBoxes() {
511  $html = '<table>';
512  // If there is just one item, use checkboxes
513  $list = $this->getList();
514  if ( $list->length() == 1 ) {
515  $list->reset();
516  $bitfield = $list->current()->getBits(); // existing field
517 
518  if ( $this->submitClicked ) {
519  $bitfield = RevisionDeleter::extractBitfield( $this->extractBitParams(), $bitfield );
520  }
521 
522  foreach ( $this->checks as $item ) {
523  // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
524  // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
525  list( $message, $name, $field ) = $item;
526  $innerHTML = Xml::checkLabel(
527  $this->msg( $message )->text(),
528  $name,
529  $name,
530  $bitfield & $field
531  );
532 
533  if ( $field == Revision::DELETED_RESTRICTED ) {
534  $innerHTML = "<b>$innerHTML</b>";
535  }
536 
537  $line = Xml::tags( 'td', [ 'class' => 'mw-input' ], $innerHTML );
538  $html .= "<tr>$line</tr>\n";
539  }
540  } else {
541  // Otherwise, use tri-state radios
542  $html .= '<tr>';
543  $html .= '<th class="mw-revdel-checkbox">'
544  . $this->msg( 'revdelete-radio-same' )->escaped() . '</th>';
545  $html .= '<th class="mw-revdel-checkbox">'
546  . $this->msg( 'revdelete-radio-unset' )->escaped() . '</th>';
547  $html .= '<th class="mw-revdel-checkbox">'
548  . $this->msg( 'revdelete-radio-set' )->escaped() . '</th>';
549  $html .= "<th></th></tr>\n";
550  foreach ( $this->checks as $item ) {
551  // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
552  // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
553  list( $message, $name, $field ) = $item;
554  // If there are several items, use third state by default...
555  if ( $this->submitClicked ) {
556  $selected = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
557  } else {
558  $selected = -1; // use existing field
559  }
560  $line = '<td class="mw-revdel-checkbox">' . Xml::radio( $name, -1, $selected == -1 ) . '</td>';
561  $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 0, $selected == 0 ) . '</td>';
562  $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 1, $selected == 1 ) . '</td>';
563  $label = $this->msg( $message )->escaped();
564  if ( $field == Revision::DELETED_RESTRICTED ) {
565  $label = "<b>$label</b>";
566  }
567  $line .= "<td>$label</td>";
568  $html .= "<tr>$line</tr>\n";
569  }
570  }
571 
572  $html .= '</table>';
573 
574  return $html;
575  }
576 
582  protected function submit() {
583  # Check edit token on submission
584  $token = $this->getRequest()->getVal( 'wpEditToken' );
585  if ( $this->submitClicked && !$this->getUser()->matchEditToken( $token ) ) {
586  $this->getOutput()->addWikiMsg( 'sessionfailure' );
587 
588  return false;
589  }
590  $bitParams = $this->extractBitParams();
591  // from dropdown
592  $listReason = $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' );
593  $comment = $listReason;
594  if ( $comment === 'other' ) {
595  $comment = $this->otherReason;
596  } elseif ( $this->otherReason !== '' ) {
597  // Entry from drop down menu + additional comment
598  $comment .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
600  }
601  # Can the user set this field?
602  if ( $bitParams[Revision::DELETED_RESTRICTED] == 1
603  && !$this->getUser()->isAllowed( 'suppressrevision' )
604  ) {
605  throw new PermissionsError( 'suppressrevision' );
606  }
607  # If the save went through, go to success message...
608  $status = $this->save( $bitParams, $comment );
609  if ( $status->isGood() ) {
610  $this->success();
611 
612  return true;
613  } else {
614  # ...otherwise, bounce back to form...
615  $this->failure( $status );
616  }
617 
618  return false;
619  }
620 
624  protected function success() {
625  // Messages: revdelete-success, logdelete-success
626  $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
627  $this->getOutput()->wrapWikiMsg(
628  "<div class=\"successbox\">\n$1\n</div>",
629  $this->typeLabels['success']
630  );
631  $this->wasSaved = true;
632  $this->revDelList->reloadFromMaster();
633  $this->showForm();
634  }
635 
640  protected function failure( $status ) {
641  // Messages: revdelete-failure, logdelete-failure
642  $this->getOutput()->setPageTitle( $this->msg( 'actionfailed' ) );
643  $this->getOutput()->wrapWikiTextAsInterface(
644  'errorbox',
645  $status->getWikiText( $this->typeLabels['failure'] )
646  );
647  $this->showForm();
648  }
649 
655  protected function extractBitParams() {
656  $bitfield = [];
657  foreach ( $this->checks as $item ) {
658  list( /* message */, $name, $field ) = $item;
659  $val = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
660  if ( $val < -1 || $val > 1 ) {
661  $val = -1; // -1 for existing value
662  }
663  $bitfield[$field] = $val;
664  }
665  if ( !isset( $bitfield[Revision::DELETED_RESTRICTED] ) ) {
666  $bitfield[Revision::DELETED_RESTRICTED] = 0;
667  }
668 
669  return $bitfield;
670  }
671 
678  protected function save( array $bitPars, $reason ) {
679  return $this->getList()->setVisibility(
680  [ 'value' => $bitPars, 'comment' => $reason ]
681  );
682  }
683 
684  protected function getGroupName() {
685  return 'pagetools';
686  }
687 }
string $archiveName
Archive name, for reviewing deleted files.
static getRelationType( $typeName)
Get DB field name for URL param...
showConvenienceLinks()
Show some useful links in the subtitle.
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 & $html
Definition: hooks.txt:1971
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
static getRestriction( $typeName)
Get the user right required for the RevDel type.
string $typeName
Deletion type, may be revision, archive, oldimage, filearchive, logging.
Shortcut to construct a special page which is unlisted by default.
bool $mIsAllowed
Whether user is allowed to perform the action.
static getCanonicalTypeName( $typeName)
Gets the canonical type name, if any.
getContext()
Gets the context this SpecialPage is executed in.
if(!isset( $args[0])) $lang
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:274
static $UILabels
UI labels for each type.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
getOutput()
Get the OutputPage being used for this instance.
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
Title $targetObj
Title object for target parameter.
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
showForm()
Show a list of items that we will operate on, and show a form with checkboxes which will allow the us...
const DELETED_FILE
Definition: File.php:63
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:2204
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:3038
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:767
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:1244
Special page allowing users with the appropriate permissions to view and hide revisions.
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:108
bool $wasSaved
Was the DB modified in this request.
bool $submitClicked
True if the submit button was clicked, and the form was posted.
An error page which can definitely be safely rendered using the OutputPage.
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:609
getLogQueryCond()
Get the condition used for fetching log snippets.
static singleton()
Definition: RepoGroup.php:60
static createList( $typeName, IContextSource $context, Title $title, array $ids)
Instantiate the appropriate list class for a given list of IDs.
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
array $typeLabels
UI Labels about the current type.
getSkin()
Shortcut to get the skin being used for this instance.
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:130
static extractBitfield(array $bitPars, $oldfield)
Put together a rev_deleted bitfield.
static getRevdelConstant( $typeName)
Get the revision deletion constant for the RevDel type.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
const DELETED_RESTRICTED
Definition: Revision.php:49
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:767
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:83
Show an error when the user tries to do something whilst blocked.
array $checks
Array of checkbox specs (message, name, deletion bits)
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
const DELETED_RESTRICTED
Definition: File.php:66
extractBitParams()
Put together an array that contains -1, 0, or the *_deleted const for each bit.
string $token
Edit token for securing image views against XSS.
array $ids
Target ID list.
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
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
const DELETED_USER
Definition: Revision.php:48
static suggestTarget( $typeName, $target, array $ids)
Suggest a target for the revision deletion.
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
getUser()
Shortcut to get the User executing this instance.
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:796
$line
Definition: cdb.php:59
addUsageText()
Show some introductory text.
Show an error when a user tries to do something they do not have the necessary permissions for...
getLanguage()
Shortcut to get user&#39;s language.
save(array $bitPars, $reason)
Do the write operations.
msg( $key)
Wrapper around wfMessage that sets the current context.
getList()
Get the list object for this request.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:419
const DELETED_COMMENT
Definition: Revision.php:47
getRequest()
Get the WebRequest being used for this instance.
RevDelList $revDelList
RevDelList object, storing the list of items to be deleted/undeleted.
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
Definition: Xml.php:341
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
failure( $status)
Report that the submit operation failed.
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:2620
success()
Report that the submit operation succeeded.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
tryShowFile( $archiveName)
Show a deleted file version requested by the visitor.
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:320
submit()
UI entry point for form submission.