MediaWiki  master
SpecialUndelete.php
Go to the documentation of this file.
1 <?php
28 
36  private $mAction;
37  private $mTarget;
38  private $mTimestamp;
39  private $mRestore;
40  private $mRevdel;
41  private $mInvert;
42  private $mFilename;
44  private $mAllowed;
45  private $mCanView;
46  private $mComment;
47  private $mToken;
48 
50  private $mTargetObj;
54  private $mSearchPrefix;
55 
56  function __construct() {
57  parent::__construct( 'Undelete', 'deletedhistory' );
58  }
59 
60  public function doesWrites() {
61  return true;
62  }
63 
64  function loadRequest( $par ) {
65  $request = $this->getRequest();
66  $user = $this->getUser();
67 
68  $this->mAction = $request->getVal( 'action' );
69  if ( $par !== null && $par !== '' ) {
70  $this->mTarget = $par;
71  } else {
72  $this->mTarget = $request->getVal( 'target' );
73  }
74 
75  $this->mTargetObj = null;
76 
77  if ( $this->mTarget !== null && $this->mTarget !== '' ) {
78  $this->mTargetObj = Title::newFromText( $this->mTarget );
79  }
80 
81  $this->mSearchPrefix = $request->getText( 'prefix' );
82  $time = $request->getVal( 'timestamp' );
83  $this->mTimestamp = $time ? wfTimestamp( TS_MW, $time ) : '';
84  $this->mFilename = $request->getVal( 'file' );
85 
86  $posted = $request->wasPosted() &&
87  $user->matchEditToken( $request->getVal( 'wpEditToken' ) );
88  $this->mRestore = $request->getCheck( 'restore' ) && $posted;
89  $this->mRevdel = $request->getCheck( 'revdel' ) && $posted;
90  $this->mInvert = $request->getCheck( 'invert' ) && $posted;
91  $this->mPreview = $request->getCheck( 'preview' ) && $posted;
92  $this->mDiff = $request->getCheck( 'diff' );
93  $this->mDiffOnly = $request->getBool( 'diffonly', $this->getUser()->getOption( 'diffonly' ) );
94  $this->mComment = $request->getText( 'wpComment' );
95  $this->mUnsuppress = $request->getVal( 'wpUnsuppress' ) && $user->isAllowed( 'suppressrevision' );
96  $this->mToken = $request->getVal( 'token' );
97 
98  $block = $user->getBlock();
99  if ( $this->isAllowed( 'undelete' ) && !( $block && $block->isSitewide() ) ) {
100  $this->mAllowed = true; // user can restore
101  $this->mCanView = true; // user can view content
102  } elseif ( $this->isAllowed( 'deletedtext' ) ) {
103  $this->mAllowed = false; // user cannot restore
104  $this->mCanView = true; // user can view content
105  $this->mRestore = false;
106  } else { // user can only view the list of revisions
107  $this->mAllowed = false;
108  $this->mCanView = false;
109  $this->mTimestamp = '';
110  $this->mRestore = false;
111  }
112 
113  if ( $this->mRestore || $this->mInvert ) {
114  $timestamps = [];
115  $this->mFileVersions = [];
116  foreach ( $request->getValues() as $key => $val ) {
117  $matches = [];
118  if ( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
119  array_push( $timestamps, $matches[1] );
120  }
121 
122  if ( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
123  $this->mFileVersions[] = intval( $matches[1] );
124  }
125  }
126  rsort( $timestamps );
127  $this->mTargetTimestamp = $timestamps;
128  }
129  }
130 
139  protected function isAllowed( $permission, User $user = null ) {
140  $user = $user ?: $this->getUser();
141  $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
142 
143  if ( $this->mTargetObj !== null ) {
144  return $permissionManager->userCan( $permission, $user, $this->mTargetObj );
145  } else {
146  return $user->isAllowed( $permission );
147  }
148  }
149 
150  function userCanExecute( User $user ) {
151  return $this->isAllowed( $this->mRestriction, $user );
152  }
153 
154  function execute( $par ) {
155  $this->useTransactionalTimeLimit();
156 
157  $user = $this->getUser();
158 
159  $this->setHeaders();
160  $this->outputHeader();
161  $this->addHelpLink( 'Help:Deletion_and_undeletion' );
162 
163  $this->loadRequest( $par );
164  $this->checkPermissions(); // Needs to be after mTargetObj is set
165 
166  $out = $this->getOutput();
167 
168  if ( is_null( $this->mTargetObj ) ) {
169  $out->addWikiMsg( 'undelete-header' );
170 
171  # Not all users can just browse every deleted page from the list
172  if ( $user->isAllowed( 'browsearchive' ) ) {
173  $this->showSearchForm();
174  }
175 
176  return;
177  }
178 
179  $this->addHelpLink( 'Help:Undelete' );
180  if ( $this->mAllowed ) {
181  $out->setPageTitle( $this->msg( 'undeletepage' ) );
182  } else {
183  $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
184  }
185 
186  $this->getSkin()->setRelevantTitle( $this->mTargetObj );
187 
188  if ( $this->mTimestamp !== '' ) {
189  $this->showRevision( $this->mTimestamp );
190  } elseif ( $this->mFilename !== null && $this->mTargetObj->inNamespace( NS_FILE ) ) {
191  $file = new ArchivedFile( $this->mTargetObj, 0, $this->mFilename );
192  // Check if user is allowed to see this file
193  if ( !$file->exists() ) {
194  $out->addWikiMsg( 'filedelete-nofile', $this->mFilename );
195  } elseif ( !$file->userCan( File::DELETED_FILE, $user ) ) {
196  if ( $file->isDeleted( File::DELETED_RESTRICTED ) ) {
197  throw new PermissionsError( 'suppressrevision' );
198  } else {
199  throw new PermissionsError( 'deletedtext' );
200  }
201  } elseif ( !$user->matchEditToken( $this->mToken, $this->mFilename ) ) {
202  $this->showFileConfirmationForm( $this->mFilename );
203  } else {
204  $this->showFile( $this->mFilename );
205  }
206  } elseif ( $this->mAction === 'submit' ) {
207  if ( $this->mRestore ) {
208  $this->undelete();
209  } elseif ( $this->mRevdel ) {
210  $this->redirectToRevDel();
211  }
212 
213  } else {
214  $this->showHistory();
215  }
216  }
217 
222  private function redirectToRevDel() {
223  $archive = new PageArchive( $this->mTargetObj );
224 
225  $revisions = [];
226 
227  foreach ( $this->getRequest()->getValues() as $key => $val ) {
228  $matches = [];
229  if ( preg_match( "/^ts(\d{14})$/", $key, $matches ) ) {
230  $revisions[$archive->getRevision( $matches[1] )->getId()] = 1;
231  }
232  }
233 
234  $query = [
235  'type' => 'revision',
236  'ids' => $revisions,
237  'target' => $this->mTargetObj->getPrefixedText()
238  ];
239  $url = SpecialPage::getTitleFor( 'Revisiondelete' )->getFullURL( $query );
240  $this->getOutput()->redirect( $url );
241  }
242 
243  function showSearchForm() {
244  $out = $this->getOutput();
245  $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
246  $fuzzySearch = $this->getRequest()->getVal( 'fuzzy', true );
247 
248  $out->enableOOUI();
249 
250  $fields[] = new OOUI\ActionFieldLayout(
251  new OOUI\TextInputWidget( [
252  'name' => 'prefix',
253  'inputId' => 'prefix',
254  'infusable' => true,
255  'value' => $this->mSearchPrefix,
256  'autofocus' => true,
257  ] ),
258  new OOUI\ButtonInputWidget( [
259  'label' => $this->msg( 'undelete-search-submit' )->text(),
260  'flags' => [ 'primary', 'progressive' ],
261  'inputId' => 'searchUndelete',
262  'type' => 'submit',
263  ] ),
264  [
265  'label' => new OOUI\HtmlSnippet(
266  $this->msg(
267  $fuzzySearch ? 'undelete-search-full' : 'undelete-search-prefix'
268  )->parse()
269  ),
270  'align' => 'left',
271  ]
272  );
273 
274  $fieldset = new OOUI\FieldsetLayout( [
275  'label' => $this->msg( 'undelete-search-box' )->text(),
276  'items' => $fields,
277  ] );
278 
279  $form = new OOUI\FormLayout( [
280  'method' => 'get',
281  'action' => wfScript(),
282  ] );
283 
284  $form->appendContent(
285  $fieldset,
286  new OOUI\HtmlSnippet(
287  Html::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) .
288  Html::hidden( 'fuzzy', $fuzzySearch )
289  )
290  );
291 
292  $out->addHTML(
293  new OOUI\PanelLayout( [
294  'expanded' => false,
295  'padded' => true,
296  'framed' => true,
297  'content' => $form,
298  ] )
299  );
300 
301  # List undeletable articles
302  if ( $this->mSearchPrefix ) {
303  // For now, we enable search engine match only when specifically asked to
304  // by using fuzzy=1 parameter.
305  if ( $fuzzySearch ) {
306  $result = PageArchive::listPagesBySearch( $this->mSearchPrefix );
307  } else {
308  $result = PageArchive::listPagesByPrefix( $this->mSearchPrefix );
309  }
310  $this->showList( $result );
311  }
312  }
313 
320  private function showList( $result ) {
321  $out = $this->getOutput();
322 
323  if ( $result->numRows() == 0 ) {
324  $out->addWikiMsg( 'undelete-no-results' );
325 
326  return false;
327  }
328 
329  $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
330 
331  $linkRenderer = $this->getLinkRenderer();
332  $undelete = $this->getPageTitle();
333  $out->addHTML( "<ul id='undeleteResultsList'>\n" );
334  foreach ( $result as $row ) {
335  $title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
336  if ( $title !== null ) {
337  $item = $linkRenderer->makeKnownLink(
338  $undelete,
339  $title->getPrefixedText(),
340  [],
341  [ 'target' => $title->getPrefixedText() ]
342  );
343  } else {
344  // The title is no longer valid, show as text
345  $item = Html::element(
346  'span',
347  [ 'class' => 'mw-invalidtitle' ],
349  $this->getContext(),
350  $row->ar_namespace,
351  $row->ar_title
352  )
353  );
354  }
355  $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count )->parse();
356  $out->addHTML(
358  'li',
359  [ 'class' => 'undeleteResult' ],
360  "{$item} ({$revs})"
361  )
362  );
363  }
364  $result->free();
365  $out->addHTML( "</ul>\n" );
366 
367  return true;
368  }
369 
370  private function showRevision( $timestamp ) {
371  if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
372  return;
373  }
374 
375  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
376  if ( !Hooks::run( 'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj ] ) ) {
377  return;
378  }
379  $rev = $archive->getRevision( $timestamp );
380 
381  $out = $this->getOutput();
382  $user = $this->getUser();
383 
384  if ( !$rev ) {
385  $out->addWikiMsg( 'undeleterevision-missing' );
386 
387  return;
388  }
389 
390  if ( $rev->isDeleted( RevisionRecord::DELETED_TEXT ) ) {
391  if ( !$rev->userCan( RevisionRecord::DELETED_TEXT, $user ) ) {
392  $out->wrapWikiMsg(
393  "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
394  $rev->isDeleted( RevisionRecord::DELETED_RESTRICTED ) ?
395  'rev-suppressed-text-permission' : 'rev-deleted-text-permission'
396  );
397 
398  return;
399  }
400 
401  $out->wrapWikiMsg(
402  "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
403  $rev->isDeleted( RevisionRecord::DELETED_RESTRICTED ) ?
404  'rev-suppressed-text-view' : 'rev-deleted-text-view'
405  );
406  $out->addHTML( '<br />' );
407  // and we are allowed to see...
408  }
409 
410  if ( $this->mDiff ) {
411  $previousRev = $archive->getPreviousRevision( $timestamp );
412  if ( $previousRev ) {
413  $this->showDiff( $previousRev, $rev );
414  if ( $this->mDiffOnly ) {
415  return;
416  }
417 
418  $out->addHTML( '<hr />' );
419  } else {
420  $out->addWikiMsg( 'undelete-nodiff' );
421  }
422  }
423 
424  $link = $this->getLinkRenderer()->makeKnownLink(
425  $this->getPageTitle( $this->mTargetObj->getPrefixedDBkey() ),
426  $this->mTargetObj->getPrefixedText()
427  );
428 
429  $lang = $this->getLanguage();
430 
431  // date and time are separate parameters to facilitate localisation.
432  // $time is kept for backward compat reasons.
433  $time = $lang->userTimeAndDate( $timestamp, $user );
434  $d = $lang->userDate( $timestamp, $user );
435  $t = $lang->userTime( $timestamp, $user );
436  $userLink = Linker::revUserTools( $rev );
437 
438  $content = $rev->getContent( RevisionRecord::FOR_THIS_USER, $user );
439 
440  // TODO: MCR: this will have to become something like $hasTextSlots and $hasNonTextSlots
441  $isText = ( $content instanceof TextContent );
442 
443  if ( $this->mPreview || $isText ) {
444  $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
445  } else {
446  $openDiv = '<div id="mw-undelete-revision">';
447  }
448  $out->addHTML( $openDiv );
449 
450  // Revision delete links
451  if ( !$this->mDiff ) {
452  $revdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
453  if ( $revdel ) {
454  $out->addHTML( "$revdel " );
455  }
456  }
457 
458  $out->addWikiMsg(
459  'undelete-revision',
461  Message::rawParam( $userLink ), $d, $t
462  );
463  $out->addHTML( '</div>' );
464 
465  if ( !Hooks::run( 'UndeleteShowRevision', [ $this->mTargetObj, $rev ] ) ) {
466  return;
467  }
468 
469  if ( $this->mPreview || !$isText ) {
470  // NOTE: non-text content has no source view, so always use rendered preview
471 
472  $popts = $out->parserOptions();
473  $renderer = MediaWikiServices::getInstance()->getRevisionRenderer();
474 
475  $rendered = $renderer->getRenderedRevision(
476  $rev->getRevisionRecord(),
477  $popts,
478  $user,
479  [ 'audience' => RevisionRecord::FOR_THIS_USER ]
480  );
481 
482  // Fail hard if the audience check fails, since we already checked
483  // at the beginning of this method.
484  $pout = $rendered->getRevisionParserOutput();
485 
486  $out->addParserOutput( $pout, [
487  'enableSectionEditLinks' => false,
488  ] );
489  }
490 
491  $out->enableOOUI();
492  $buttonFields = [];
493 
494  if ( $isText ) {
495  // TODO: MCR: make this work for multiple slots
496  // source view for textual content
497  $sourceView = Xml::element( 'textarea', [
498  'readonly' => 'readonly',
499  'cols' => 80,
500  'rows' => 25
501  ], $content->getText() . "\n" );
502 
503  $buttonFields[] = new OOUI\ButtonInputWidget( [
504  'type' => 'submit',
505  'name' => 'preview',
506  'label' => $this->msg( 'showpreview' )->text()
507  ] );
508  } else {
509  $sourceView = '';
510  }
511 
512  $buttonFields[] = new OOUI\ButtonInputWidget( [
513  'name' => 'diff',
514  'type' => 'submit',
515  'label' => $this->msg( 'showdiff' )->text()
516  ] );
517 
518  $out->addHTML(
519  $sourceView .
520  Xml::openElement( 'div', [
521  'style' => 'clear: both' ] ) .
522  Xml::openElement( 'form', [
523  'method' => 'post',
524  'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ) ] ) .
525  Xml::element( 'input', [
526  'type' => 'hidden',
527  'name' => 'target',
528  'value' => $this->mTargetObj->getPrefixedDBkey() ] ) .
529  Xml::element( 'input', [
530  'type' => 'hidden',
531  'name' => 'timestamp',
532  'value' => $timestamp ] ) .
533  Xml::element( 'input', [
534  'type' => 'hidden',
535  'name' => 'wpEditToken',
536  'value' => $user->getEditToken() ] ) .
537  new OOUI\FieldLayout(
538  new OOUI\Widget( [
539  'content' => new OOUI\HorizontalLayout( [
540  'items' => $buttonFields
541  ] )
542  ] )
543  ) .
544  Xml::closeElement( 'form' ) .
545  Xml::closeElement( 'div' )
546  );
547  }
548 
556  function showDiff( $previousRev, $currentRev ) {
557  $diffContext = clone $this->getContext();
558  $diffContext->setTitle( $currentRev->getTitle() );
559  $diffContext->setWikiPage( WikiPage::factory( $currentRev->getTitle() ) );
560 
561  $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
562  $diffEngine->setRevisions( $previousRev->getRevisionRecord(), $currentRev->getRevisionRecord() );
563  $diffEngine->showDiffStyle();
564  $formattedDiff = $diffEngine->getDiff(
565  $this->diffHeader( $previousRev, 'o' ),
566  $this->diffHeader( $currentRev, 'n' )
567  );
568 
569  $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
570  }
571 
577  private function diffHeader( $rev, $prefix ) {
578  $isDeleted = !( $rev->getId() && $rev->getTitle() );
579  if ( $isDeleted ) {
581  $targetPage = $this->getPageTitle();
582  $targetQuery = [
583  'target' => $this->mTargetObj->getPrefixedText(),
584  'timestamp' => wfTimestamp( TS_MW, $rev->getTimestamp() )
585  ];
586  } else {
588  $targetPage = $rev->getTitle();
589  $targetQuery = [ 'oldid' => $rev->getId() ];
590  }
591 
592  // Add show/hide deletion links if available
593  $user = $this->getUser();
594  $lang = $this->getLanguage();
595  $rdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
596 
597  if ( $rdel ) {
598  $rdel = " $rdel";
599  }
600 
601  $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
602 
603  $tagIds = wfGetDB( DB_REPLICA )->selectFieldValues(
604  'change_tag',
605  'ct_tag_id',
606  [ 'ct_rev_id' => $rev->getId() ],
607  __METHOD__
608  );
609  $tags = [];
610  $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
611  foreach ( $tagIds as $tagId ) {
612  try {
613  $tags[] = $changeTagDefStore->getName( (int)$tagId );
614  } catch ( NameTableAccessException $exception ) {
615  continue;
616  }
617  }
618  $tags = implode( ',', $tags );
619  $tagSummary = ChangeTags::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
620 
621  // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
622  // and partially #showDiffPage, but worse
623  return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
624  $this->getLinkRenderer()->makeLink(
625  $targetPage,
626  $this->msg(
627  'revisionasof',
628  $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
629  $lang->userDate( $rev->getTimestamp(), $user ),
630  $lang->userTime( $rev->getTimestamp(), $user )
631  )->text(),
632  [],
633  $targetQuery
634  ) .
635  '</strong></div>' .
636  '<div id="mw-diff-' . $prefix . 'title2">' .
637  Linker::revUserTools( $rev ) . '<br />' .
638  '</div>' .
639  '<div id="mw-diff-' . $prefix . 'title3">' .
640  $minor . Linker::revComment( $rev ) . $rdel . '<br />' .
641  '</div>' .
642  '<div id="mw-diff-' . $prefix . 'title5">' .
643  $tagSummary[0] . '<br />' .
644  '</div>';
645  }
646 
651  private function showFileConfirmationForm( $key ) {
652  $out = $this->getOutput();
653  $lang = $this->getLanguage();
654  $user = $this->getUser();
655  $file = new ArchivedFile( $this->mTargetObj, 0, $this->mFilename );
656  $out->addWikiMsg( 'undelete-show-file-confirm',
657  $this->mTargetObj->getText(),
658  $lang->userDate( $file->getTimestamp(), $user ),
659  $lang->userTime( $file->getTimestamp(), $user ) );
660  $out->addHTML(
661  Xml::openElement( 'form', [
662  'method' => 'POST',
663  'action' => $this->getPageTitle()->getLocalURL( [
664  'target' => $this->mTarget,
665  'file' => $key,
666  'token' => $user->getEditToken( $key ),
667  ] ),
668  ]
669  ) .
670  Xml::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
671  '</form>'
672  );
673  }
674 
679  private function showFile( $key ) {
680  $this->getOutput()->disable();
681 
682  # We mustn't allow the output to be CDN cached, otherwise
683  # if an admin previews a deleted image, and it's cached, then
684  # a user without appropriate permissions can toddle off and
685  # nab the image, and CDN will serve it
686  $response = $this->getRequest()->response();
687  $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
688  $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
689  $response->header( 'Pragma: no-cache' );
690 
691  $repo = RepoGroup::singleton()->getLocalRepo();
692  $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
693  $repo->streamFileWithStatus( $path );
694  }
695 
696  protected function showHistory() {
697  $this->checkReadOnly();
698 
699  $out = $this->getOutput();
700  if ( $this->mAllowed ) {
701  $out->addModules( 'mediawiki.special.undelete' );
702  }
703  $out->wrapWikiMsg(
704  "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
705  [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) ]
706  );
707 
708  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
709  Hooks::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj ] );
710 
711  $out->addHTML( '<div class="mw-undelete-history">' );
712  if ( $this->mAllowed ) {
713  $out->addWikiMsg( 'undeletehistory' );
714  $out->addWikiMsg( 'undeleterevdel' );
715  } else {
716  $out->addWikiMsg( 'undeletehistorynoadmin' );
717  }
718  $out->addHTML( '</div>' );
719 
720  # List all stored revisions
721  $revisions = $archive->listRevisions();
722  $files = $archive->listFiles();
723 
724  $haveRevisions = $revisions && $revisions->numRows() > 0;
725  $haveFiles = $files && $files->numRows() > 0;
726 
727  # Batch existence check on user and talk pages
728  if ( $haveRevisions ) {
729  $batch = new LinkBatch();
730  foreach ( $revisions as $row ) {
731  $batch->addObj( Title::makeTitleSafe( NS_USER, $row->ar_user_text ) );
732  $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->ar_user_text ) );
733  }
734  $batch->execute();
735  $revisions->seek( 0 );
736  }
737  if ( $haveFiles ) {
738  $batch = new LinkBatch();
739  foreach ( $files as $row ) {
740  $batch->addObj( Title::makeTitleSafe( NS_USER, $row->fa_user_text ) );
741  $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->fa_user_text ) );
742  }
743  $batch->execute();
744  $files->seek( 0 );
745  }
746 
747  if ( $this->mAllowed ) {
748  $out->enableOOUI();
749 
750  $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
751  # Start the form here
752  $form = new OOUI\FormLayout( [
753  'method' => 'post',
754  'action' => $action,
755  'id' => 'undelete',
756  ] );
757  }
758 
759  # Show relevant lines from the deletion log:
760  $deleteLogPage = new LogPage( 'delete' );
761  $out->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
762  LogEventsList::showLogExtract( $out, 'delete', $this->mTargetObj );
763  # Show relevant lines from the suppression log:
764  $suppressLogPage = new LogPage( 'suppress' );
765  if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
766  $out->addHTML( Xml::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
767  LogEventsList::showLogExtract( $out, 'suppress', $this->mTargetObj );
768  }
769 
770  if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
771  $fields[] = new OOUI\Layout( [
772  'content' => new OOUI\HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
773  ] );
774 
775  $fields[] = new OOUI\FieldLayout(
776  new OOUI\TextInputWidget( [
777  'name' => 'wpComment',
778  'inputId' => 'wpComment',
779  'infusable' => true,
780  'value' => $this->mComment,
781  'autofocus' => true,
782  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
783  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
784  // Unicode codepoints.
786  ] ),
787  [
788  'label' => $this->msg( 'undeletecomment' )->text(),
789  'align' => 'top',
790  ]
791  );
792 
793  $fields[] = new OOUI\FieldLayout(
794  new OOUI\Widget( [
795  'content' => new OOUI\HorizontalLayout( [
796  'items' => [
797  new OOUI\ButtonInputWidget( [
798  'name' => 'restore',
799  'inputId' => 'mw-undelete-submit',
800  'value' => '1',
801  'label' => $this->msg( 'undeletebtn' )->text(),
802  'flags' => [ 'primary', 'progressive' ],
803  'type' => 'submit',
804  ] ),
805  new OOUI\ButtonInputWidget( [
806  'name' => 'invert',
807  'inputId' => 'mw-undelete-invert',
808  'value' => '1',
809  'label' => $this->msg( 'undeleteinvert' )->text()
810  ] ),
811  ]
812  ] )
813  ] )
814  );
815 
816  if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
817  $fields[] = new OOUI\FieldLayout(
818  new OOUI\CheckboxInputWidget( [
819  'name' => 'wpUnsuppress',
820  'inputId' => 'mw-undelete-unsuppress',
821  'value' => '1',
822  ] ),
823  [
824  'label' => $this->msg( 'revdelete-unsuppress' )->text(),
825  'align' => 'inline',
826  ]
827  );
828  }
829 
830  $fieldset = new OOUI\FieldsetLayout( [
831  'label' => $this->msg( 'undelete-fieldset-title' )->text(),
832  'id' => 'mw-undelete-table',
833  'items' => $fields,
834  ] );
835 
836  $form->appendContent(
837  new OOUI\PanelLayout( [
838  'expanded' => false,
839  'padded' => true,
840  'framed' => true,
841  'content' => $fieldset,
842  ] ),
843  new OOUI\HtmlSnippet(
844  Html::hidden( 'target', $this->mTarget ) .
845  Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
846  )
847  );
848  }
849 
850  $history = '';
851  $history .= Xml::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
852 
853  if ( $haveRevisions ) {
854  # Show the page's stored (deleted) history
855 
856  if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
857  $history .= Html::element(
858  'button',
859  [
860  'name' => 'revdel',
861  'type' => 'submit',
862  'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
863  ],
864  $this->msg( 'showhideselectedversions' )->text()
865  ) . "\n";
866  }
867 
868  $history .= '<ul class="mw-undelete-revlist">';
869  $remaining = $revisions->numRows();
870  $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
871 
872  foreach ( $revisions as $row ) {
873  $remaining--;
874  $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
875  }
876  $revisions->free();
877  $history .= '</ul>';
878  } else {
879  $out->addWikiMsg( 'nohistory' );
880  }
881 
882  if ( $haveFiles ) {
883  $history .= Xml::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
884  $history .= '<ul class="mw-undelete-revlist">';
885  foreach ( $files as $row ) {
886  $history .= $this->formatFileRow( $row );
887  }
888  $files->free();
889  $history .= '</ul>';
890  }
891 
892  if ( $this->mAllowed ) {
893  # Slip in the hidden controls here
894  $misc = Html::hidden( 'target', $this->mTarget );
895  $misc .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
896  $history .= $misc;
897 
898  $form->appendContent( new OOUI\HtmlSnippet( $history ) );
899  $out->addHTML( $form );
900  } else {
901  $out->addHTML( $history );
902  }
903 
904  return true;
905  }
906 
907  protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
909  [
910  'title' => $this->mTargetObj
911  ] );
912 
913  $revTextSize = '';
914  $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
915  // Build checkboxen...
916  if ( $this->mAllowed ) {
917  if ( $this->mInvert ) {
918  if ( in_array( $ts, $this->mTargetTimestamp ) ) {
919  $checkBox = Xml::check( "ts$ts" );
920  } else {
921  $checkBox = Xml::check( "ts$ts", true );
922  }
923  } else {
924  $checkBox = Xml::check( "ts$ts" );
925  }
926  } else {
927  $checkBox = '';
928  }
929 
930  // Build page & diff links...
931  $user = $this->getUser();
932  if ( $this->mCanView ) {
933  $titleObj = $this->getPageTitle();
934  # Last link
935  if ( !$rev->userCan( RevisionRecord::DELETED_TEXT, $this->getUser() ) ) {
936  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
937  $last = $this->msg( 'diff' )->escaped();
938  } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
939  $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
940  $last = $this->getLinkRenderer()->makeKnownLink(
941  $titleObj,
942  $this->msg( 'diff' )->text(),
943  [],
944  [
945  'target' => $this->mTargetObj->getPrefixedText(),
946  'timestamp' => $ts,
947  'diff' => 'prev'
948  ]
949  );
950  } else {
951  $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
952  $last = $this->msg( 'diff' )->escaped();
953  }
954  } else {
955  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
956  $last = $this->msg( 'diff' )->escaped();
957  }
958 
959  // User links
960  $userLink = Linker::revUserTools( $rev );
961 
962  // Minor edit
963  $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
964 
965  // Revision text size
966  $size = $row->ar_len;
967  if ( !is_null( $size ) ) {
968  $revTextSize = Linker::formatRevisionSize( $size );
969  }
970 
971  // Edit summary
972  $comment = Linker::revComment( $rev );
973 
974  // Tags
975  $attribs = [];
976  list( $tagSummary, $classes ) = ChangeTags::formatSummaryRow(
977  $row->ts_tags,
978  'deletedhistory',
979  $this->getContext()
980  );
981  if ( $classes ) {
982  $attribs['class'] = implode( ' ', $classes );
983  }
984 
985  $revisionRow = $this->msg( 'undelete-revision-row2' )
986  ->rawParams(
987  $checkBox,
988  $last,
989  $pageLink,
990  $userLink,
991  $minor,
992  $revTextSize,
993  $comment,
994  $tagSummary
995  )
996  ->escaped();
997 
998  return Xml::tags( 'li', $attribs, $revisionRow ) . "\n";
999  }
1000 
1001  private function formatFileRow( $row ) {
1002  $file = ArchivedFile::newFromRow( $row );
1003  $ts = wfTimestamp( TS_MW, $row->fa_timestamp );
1004  $user = $this->getUser();
1005 
1006  $checkBox = '';
1007  if ( $this->mCanView && $row->fa_storage_key ) {
1008  if ( $this->mAllowed ) {
1009  $checkBox = Xml::check( 'fileid' . $row->fa_id );
1010  }
1011  $key = urlencode( $row->fa_storage_key );
1012  $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
1013  } else {
1014  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1015  }
1016  $userLink = $this->getFileUser( $file );
1017  $data = $this->msg( 'widthheight' )->numParams( $row->fa_width, $row->fa_height )->text();
1018  $bytes = $this->msg( 'parentheses' )
1019  ->plaintextParams( $this->msg( 'nbytes' )->numParams( $row->fa_size )->text() )
1020  ->plain();
1021  $data = htmlspecialchars( $data . ' ' . $bytes );
1022  $comment = $this->getFileComment( $file );
1023 
1024  // Add show/hide deletion links if available
1025  $canHide = $this->isAllowed( 'deleterevision' );
1026  if ( $canHide || ( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
1027  if ( !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
1028  // Revision was hidden from sysops
1029  $revdlink = Linker::revDeleteLinkDisabled( $canHide );
1030  } else {
1031  $query = [
1032  'type' => 'filearchive',
1033  'target' => $this->mTargetObj->getPrefixedDBkey(),
1034  'ids' => $row->fa_id
1035  ];
1036  $revdlink = Linker::revDeleteLink( $query,
1037  $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
1038  }
1039  } else {
1040  $revdlink = '';
1041  }
1042 
1043  return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1044  }
1045 
1054  function getPageLink( $rev, $titleObj, $ts ) {
1055  $user = $this->getUser();
1056  $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1057 
1058  if ( !$rev->userCan( RevisionRecord::DELETED_TEXT, $user ) ) {
1059  return '<span class="history-deleted">' . $time . '</span>';
1060  }
1061 
1062  $link = $this->getLinkRenderer()->makeKnownLink(
1063  $titleObj,
1064  $time,
1065  [],
1066  [
1067  'target' => $this->mTargetObj->getPrefixedText(),
1068  'timestamp' => $ts
1069  ]
1070  );
1071 
1072  if ( $rev->isDeleted( RevisionRecord::DELETED_TEXT ) ) {
1073  $link = '<span class="history-deleted">' . $link . '</span>';
1074  }
1075 
1076  return $link;
1077  }
1078 
1089  function getFileLink( $file, $titleObj, $ts, $key ) {
1090  $user = $this->getUser();
1091  $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1092 
1093  if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
1094  return '<span class="history-deleted">' . htmlspecialchars( $time ) . '</span>';
1095  }
1096 
1097  $link = $this->getLinkRenderer()->makeKnownLink(
1098  $titleObj,
1099  $time,
1100  [],
1101  [
1102  'target' => $this->mTargetObj->getPrefixedText(),
1103  'file' => $key,
1104  'token' => $user->getEditToken( $key )
1105  ]
1106  );
1107 
1108  if ( $file->isDeleted( File::DELETED_FILE ) ) {
1109  $link = '<span class="history-deleted">' . $link . '</span>';
1110  }
1111 
1112  return $link;
1113  }
1114 
1121  function getFileUser( $file ) {
1122  if ( !$file->userCan( File::DELETED_USER, $this->getUser() ) ) {
1123  return '<span class="history-deleted">' .
1124  $this->msg( 'rev-deleted-user' )->escaped() .
1125  '</span>';
1126  }
1127 
1128  $link = Linker::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1129  Linker::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1130 
1131  if ( $file->isDeleted( File::DELETED_USER ) ) {
1132  $link = '<span class="history-deleted">' . $link . '</span>';
1133  }
1134 
1135  return $link;
1136  }
1137 
1144  function getFileComment( $file ) {
1145  if ( !$file->userCan( File::DELETED_COMMENT, $this->getUser() ) ) {
1146  return '<span class="history-deleted"><span class="comment">' .
1147  $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1148  }
1149 
1150  $link = Linker::commentBlock( $file->getRawDescription() );
1151 
1152  if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
1153  $link = '<span class="history-deleted">' . $link . '</span>';
1154  }
1155 
1156  return $link;
1157  }
1158 
1159  function undelete() {
1160  if ( $this->getConfig()->get( 'UploadMaintenance' )
1161  && $this->mTargetObj->getNamespace() == NS_FILE
1162  ) {
1163  throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1164  }
1165 
1166  $this->checkReadOnly();
1167 
1168  $out = $this->getOutput();
1169  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
1170  Hooks::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj ] );
1171  $ok = $archive->undelete(
1172  $this->mTargetTimestamp,
1173  $this->mComment,
1174  $this->mFileVersions,
1175  $this->mUnsuppress,
1176  $this->getUser()
1177  );
1178 
1179  if ( is_array( $ok ) ) {
1180  if ( $ok[1] ) { // Undeleted file count
1181  Hooks::run( 'FileUndeleteComplete', [
1182  $this->mTargetObj, $this->mFileVersions,
1183  $this->getUser(), $this->mComment ] );
1184  }
1185 
1186  $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj );
1187  $out->addWikiMsg( 'undeletedpage', Message::rawParam( $link ) );
1188  } else {
1189  $out->setPageTitle( $this->msg( 'undelete-error' ) );
1190  }
1191 
1192  // Show revision undeletion warnings and errors
1193  $status = $archive->getRevisionStatus();
1194  if ( $status && !$status->isGood() ) {
1195  $out->wrapWikiTextAsInterface(
1196  'error',
1197  '<div id="mw-error-cannotundelete">' .
1198  $status->getWikiText(
1199  'cannotundelete',
1200  'cannotundelete'
1201  ) . '</div>'
1202  );
1203  }
1204 
1205  // Show file undeletion warnings and errors
1206  $status = $archive->getFileStatus();
1207  if ( $status && !$status->isGood() ) {
1208  $out->wrapWikiTextAsInterface(
1209  'error',
1210  $status->getWikiText(
1211  'undelete-error-short',
1212  'undelete-error-long'
1213  )
1214  );
1215  }
1216  }
1217 
1226  public function prefixSearchSubpages( $search, $limit, $offset ) {
1227  return $this->prefixSearchString( $search, $limit, $offset );
1228  }
1229 
1230  protected function getGroupName() {
1231  return 'pagetools';
1232  }
1233 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
static rawParam( $raw)
Definition: Message.php:1040
showList( $result)
Generic list of deleted pages.
static newFromRow( $row)
Loads a file object from the filearchive table.
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.
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:171
const DELETED_COMMENT
Definition: File.php:64
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 $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1529
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
either a plain
Definition: hooks.txt:2033
getFileUser( $file)
Fetch file&#39;s user id if it&#39;s available to this user.
getContext()
Gets the context this SpecialPage is executed in.
static formatRevisionSize( $size)
Definition: Linker.php:1597
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
showRevision( $timestamp)
Exception representing a failure to look up a row from a name table.
if(!isset( $args[0])) $lang
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
showFileConfirmationForm( $key)
Show a form confirming whether a tokenless user really wants to see a file.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
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
static listPagesBySearch( $term)
List deleted pages recorded in the archive matching the given term, using search engine archive...
Definition: PageArchive.php:79
getOutput()
Get the OutputPage being used for this instance.
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
showDiff( $previousRev, $currentRev)
Build a diff display between this and the previous either deleted or non-deleted edit.
this hook is for auditing only $response
Definition: hooks.txt:767
static listPagesByPrefix( $prefix)
List deleted pages recorded in the archive table matching the given title prefix. ...
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1781
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
const DELETED_FILE
Definition: File.php:63
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1970
$batch
Definition: linkcache.txt:23
Class to simplify the use of log pages.
Definition: LogPage.php:33
formatRevisionRow( $row, $earliestLiveTime, $remaining)
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3039
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
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
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
$last
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
redirectToRevDel()
Convert submitted form data to format expected by RevisionDelete and redirect the request...
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Class representing a row of the &#39;filearchive&#39; table.
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
prefixSearchString( $search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
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 flag( $flag, IContextSource $context=null)
Make an "<abbr>" element for a given change flag.
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null, $useParentheses=true)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:940
static singleton()
Definition: RepoGroup.php:60
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
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
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
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:1972
string $mSearchPrefix
Search prefix.
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
isAllowed( $permission, User $user=null)
Checks whether a user is allowed the permission for the specific title if one is set.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
const NS_FILE
Definition: Defines.php:66
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
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1748
getPageLink( $rev, $titleObj, $ts)
Fetch revision text link if it&#39;s available to all users.
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
const DELETED_USER
Definition: File.php:65
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:895
const DELETED_RESTRICTED
Definition: File.php:66
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:620
getFileLink( $file, $titleObj, $ts, $key)
Fetch image view link if it&#39;s available to all users.
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 getRevDeleteLink(User $user, Revision $rev, LinkTarget $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
Definition: Linker.php:2105
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:117
Special page allowing users with the appropriate permissions to view and restore deleted content...
userCanExecute(User $user)
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
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2147
getConfig()
Shortcut to get main config object.
Show an error when a user tries to do something they do not have the necessary permissions for...
Used to show archived pages and eventually restore them.
Definition: PageArchive.php:31
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
static formatSummaryRow( $tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:94
static revComment(Revision $rev, $local=false, $isPublic=false, $useParentheses=true)
Wrap and format the given revision&#39;s comment block, if the current user is allowed to view it...
Definition: Linker.php:1572
diffHeader( $rev, $prefix)
static getInvalidTitleDescription(IContextSource $context, $namespace, $title)
Get a message saying that an invalid title was encountered.
Definition: Linker.php:187
const DB_REPLICA
Definition: defines.php:25
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
showFile( $key)
Show a deleted file version requested by the visitor.
getRequest()
Get the WebRequest being used for this instance.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
$content
Definition: pageupdater.txt:72
getFileComment( $file)
Fetch file upload comment if it&#39;s available to this user.
const NS_USER_TALK
Definition: Defines.php:63
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:2621
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.
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:323
static commentBlock( $comment, $title=null, $local=false, $wikiId=null, $useParentheses=true)
Wrap a comment in standard punctuation and formatting if it&#39;s non-empty, otherwise return empty strin...
Definition: Linker.php:1542
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static revDeleteLinkDisabled( $delete=true)
Creates a dead (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2169
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
static revUserTools( $rev, $isPublic=false, $useParentheses=true)
Generate a user tool link cluster if the current user is allowed to view it.
Definition: Linker.php:1119
$matches
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:322