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 
162  $this->loadRequest( $par );
163  $this->checkPermissions(); // Needs to be after mTargetObj is set
164 
165  $out = $this->getOutput();
166 
167  if ( is_null( $this->mTargetObj ) ) {
168  $out->addWikiMsg( 'undelete-header' );
169 
170  # Not all users can just browse every deleted page from the list
171  if ( $user->isAllowed( 'browsearchive' ) ) {
172  $this->showSearchForm();
173  }
174 
175  return;
176  }
177 
178  $this->addHelpLink( 'Help:Undelete' );
179  if ( $this->mAllowed ) {
180  $out->setPageTitle( $this->msg( 'undeletepage' ) );
181  } else {
182  $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
183  }
184 
185  $this->getSkin()->setRelevantTitle( $this->mTargetObj );
186 
187  if ( $this->mTimestamp !== '' ) {
188  $this->showRevision( $this->mTimestamp );
189  } elseif ( $this->mFilename !== null && $this->mTargetObj->inNamespace( NS_FILE ) ) {
190  $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
191  // Check if user is allowed to see this file
192  if ( !$file->exists() ) {
193  $out->addWikiMsg( 'filedelete-nofile', $this->mFilename );
194  } elseif ( !$file->userCan( File::DELETED_FILE, $user ) ) {
195  if ( $file->isDeleted( File::DELETED_RESTRICTED ) ) {
196  throw new PermissionsError( 'suppressrevision' );
197  } else {
198  throw new PermissionsError( 'deletedtext' );
199  }
200  } elseif ( !$user->matchEditToken( $this->mToken, $this->mFilename ) ) {
201  $this->showFileConfirmationForm( $this->mFilename );
202  } else {
203  $this->showFile( $this->mFilename );
204  }
205  } elseif ( $this->mAction === 'submit' ) {
206  if ( $this->mRestore ) {
207  $this->undelete();
208  } elseif ( $this->mRevdel ) {
209  $this->redirectToRevDel();
210  }
211 
212  } else {
213  $this->showHistory();
214  }
215  }
216 
221  private function redirectToRevDel() {
222  $archive = new PageArchive( $this->mTargetObj );
223 
224  $revisions = [];
225 
226  foreach ( $this->getRequest()->getValues() as $key => $val ) {
227  $matches = [];
228  if ( preg_match( "/^ts(\d{14})$/", $key, $matches ) ) {
229  $revisions[$archive->getRevision( $matches[1] )->getId()] = 1;
230  }
231  }
232 
233  $query = [
234  'type' => 'revision',
235  'ids' => $revisions,
236  'target' => $this->mTargetObj->getPrefixedText()
237  ];
238  $url = SpecialPage::getTitleFor( 'Revisiondelete' )->getFullURL( $query );
239  $this->getOutput()->redirect( $url );
240  }
241 
242  function showSearchForm() {
243  $out = $this->getOutput();
244  $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
245  $fuzzySearch = $this->getRequest()->getVal( 'fuzzy', true );
246 
247  $out->enableOOUI();
248 
249  $fields[] = new OOUI\ActionFieldLayout(
250  new OOUI\TextInputWidget( [
251  'name' => 'prefix',
252  'inputId' => 'prefix',
253  'infusable' => true,
254  'value' => $this->mSearchPrefix,
255  'autofocus' => true,
256  ] ),
257  new OOUI\ButtonInputWidget( [
258  'label' => $this->msg( 'undelete-search-submit' )->text(),
259  'flags' => [ 'primary', 'progressive' ],
260  'inputId' => 'searchUndelete',
261  'type' => 'submit',
262  ] ),
263  [
264  'label' => new OOUI\HtmlSnippet(
265  $this->msg(
266  $fuzzySearch ? 'undelete-search-full' : 'undelete-search-prefix'
267  )->parse()
268  ),
269  'align' => 'left',
270  ]
271  );
272 
273  $fieldset = new OOUI\FieldsetLayout( [
274  'label' => $this->msg( 'undelete-search-box' )->text(),
275  'items' => $fields,
276  ] );
277 
278  $form = new OOUI\FormLayout( [
279  'method' => 'get',
280  'action' => wfScript(),
281  ] );
282 
283  $form->appendContent(
284  $fieldset,
285  new OOUI\HtmlSnippet(
286  Html::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) .
287  Html::hidden( 'fuzzy', $fuzzySearch )
288  )
289  );
290 
291  $out->addHTML(
292  new OOUI\PanelLayout( [
293  'expanded' => false,
294  'padded' => true,
295  'framed' => true,
296  'content' => $form,
297  ] )
298  );
299 
300  # List undeletable articles
301  if ( $this->mSearchPrefix ) {
302  // For now, we enable search engine match only when specifically asked to
303  // by using fuzzy=1 parameter.
304  if ( $fuzzySearch ) {
305  $result = PageArchive::listPagesBySearch( $this->mSearchPrefix );
306  } else {
307  $result = PageArchive::listPagesByPrefix( $this->mSearchPrefix );
308  }
309  $this->showList( $result );
310  }
311  }
312 
319  private function showList( $result ) {
320  $out = $this->getOutput();
321 
322  if ( $result->numRows() == 0 ) {
323  $out->addWikiMsg( 'undelete-no-results' );
324 
325  return false;
326  }
327 
328  $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
329 
330  $linkRenderer = $this->getLinkRenderer();
331  $undelete = $this->getPageTitle();
332  $out->addHTML( "<ul id='undeleteResultsList'>\n" );
333  foreach ( $result as $row ) {
334  $title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
335  if ( $title !== null ) {
336  $item = $linkRenderer->makeKnownLink(
337  $undelete,
338  $title->getPrefixedText(),
339  [],
340  [ 'target' => $title->getPrefixedText() ]
341  );
342  } else {
343  // The title is no longer valid, show as text
344  $item = Html::element(
345  'span',
346  [ 'class' => 'mw-invalidtitle' ],
348  $this->getContext(),
349  $row->ar_namespace,
350  $row->ar_title
351  )
352  );
353  }
354  $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count )->parse();
355  $out->addHTML(
357  'li',
358  [ 'class' => 'undeleteResult' ],
359  "{$item} ({$revs})"
360  )
361  );
362  }
363  $result->free();
364  $out->addHTML( "</ul>\n" );
365 
366  return true;
367  }
368 
369  private function showRevision( $timestamp ) {
370  if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
371  return;
372  }
373 
374  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
375  if ( !Hooks::run( 'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj ] ) ) {
376  return;
377  }
378  $rev = $archive->getRevision( $timestamp );
379 
380  $out = $this->getOutput();
381  $user = $this->getUser();
382 
383  if ( !$rev ) {
384  $out->addWikiMsg( 'undeleterevision-missing' );
385 
386  return;
387  }
388 
389  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
390  if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
391  $out->wrapWikiMsg(
392  "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
393  $rev->isDeleted( Revision::DELETED_RESTRICTED ) ?
394  'rev-suppressed-text-permission' : 'rev-deleted-text-permission'
395  );
396 
397  return;
398  }
399 
400  $out->wrapWikiMsg(
401  "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
402  $rev->isDeleted( Revision::DELETED_RESTRICTED ) ?
403  'rev-suppressed-text-view' : 'rev-deleted-text-view'
404  );
405  $out->addHTML( '<br />' );
406  // and we are allowed to see...
407  }
408 
409  if ( $this->mDiff ) {
410  $previousRev = $archive->getPreviousRevision( $timestamp );
411  if ( $previousRev ) {
412  $this->showDiff( $previousRev, $rev );
413  if ( $this->mDiffOnly ) {
414  return;
415  }
416 
417  $out->addHTML( '<hr />' );
418  } else {
419  $out->addWikiMsg( 'undelete-nodiff' );
420  }
421  }
422 
423  $link = $this->getLinkRenderer()->makeKnownLink(
424  $this->getPageTitle( $this->mTargetObj->getPrefixedDBkey() ),
425  $this->mTargetObj->getPrefixedText()
426  );
427 
428  $lang = $this->getLanguage();
429 
430  // date and time are separate parameters to facilitate localisation.
431  // $time is kept for backward compat reasons.
432  $time = $lang->userTimeAndDate( $timestamp, $user );
433  $d = $lang->userDate( $timestamp, $user );
434  $t = $lang->userTime( $timestamp, $user );
435  $userLink = Linker::revUserTools( $rev );
436 
437  $content = $rev->getContent( RevisionRecord::FOR_THIS_USER, $user );
438 
439  // TODO: MCR: this will have to become something like $hasTextSlots and $hasNonTextSlots
440  $isText = ( $content instanceof TextContent );
441 
442  if ( $this->mPreview || $isText ) {
443  $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
444  } else {
445  $openDiv = '<div id="mw-undelete-revision">';
446  }
447  $out->addHTML( $openDiv );
448 
449  // Revision delete links
450  if ( !$this->mDiff ) {
451  $revdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
452  if ( $revdel ) {
453  $out->addHTML( "$revdel " );
454  }
455  }
456 
457  $out->addWikiMsg(
458  'undelete-revision',
460  Message::rawParam( $userLink ), $d, $t
461  );
462  $out->addHTML( '</div>' );
463 
464  if ( !Hooks::run( 'UndeleteShowRevision', [ $this->mTargetObj, $rev ] ) ) {
465  return;
466  }
467 
468  if ( $this->mPreview || !$isText ) {
469  // NOTE: non-text content has no source view, so always use rendered preview
470 
471  $popts = $out->parserOptions();
472  $renderer = MediaWikiServices::getInstance()->getRevisionRenderer();
473 
474  $rendered = $renderer->getRenderedRevision(
475  $rev->getRevisionRecord(),
476  $popts,
477  $user,
478  [ 'audience' => RevisionRecord::FOR_THIS_USER ]
479  );
480 
481  // Fail hard if the audience check fails, since we already checked
482  // at the beginning of this method.
483  $pout = $rendered->getRevisionParserOutput();
484 
485  $out->addParserOutput( $pout, [
486  'enableSectionEditLinks' => false,
487  ] );
488  }
489 
490  $out->enableOOUI();
491  $buttonFields = [];
492 
493  if ( $isText ) {
494  // TODO: MCR: make this work for multiple slots
495  // source view for textual content
496  $sourceView = Xml::element( 'textarea', [
497  'readonly' => 'readonly',
498  'cols' => 80,
499  'rows' => 25
500  ], $content->getText() . "\n" );
501 
502  $buttonFields[] = new OOUI\ButtonInputWidget( [
503  'type' => 'submit',
504  'name' => 'preview',
505  'label' => $this->msg( 'showpreview' )->text()
506  ] );
507  } else {
508  $sourceView = '';
509  }
510 
511  $buttonFields[] = new OOUI\ButtonInputWidget( [
512  'name' => 'diff',
513  'type' => 'submit',
514  'label' => $this->msg( 'showdiff' )->text()
515  ] );
516 
517  $out->addHTML(
518  $sourceView .
519  Xml::openElement( 'div', [
520  'style' => 'clear: both' ] ) .
521  Xml::openElement( 'form', [
522  'method' => 'post',
523  'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ) ] ) .
524  Xml::element( 'input', [
525  'type' => 'hidden',
526  'name' => 'target',
527  'value' => $this->mTargetObj->getPrefixedDBkey() ] ) .
528  Xml::element( 'input', [
529  'type' => 'hidden',
530  'name' => 'timestamp',
531  'value' => $timestamp ] ) .
532  Xml::element( 'input', [
533  'type' => 'hidden',
534  'name' => 'wpEditToken',
535  'value' => $user->getEditToken() ] ) .
536  new OOUI\FieldLayout(
537  new OOUI\Widget( [
538  'content' => new OOUI\HorizontalLayout( [
539  'items' => $buttonFields
540  ] )
541  ] )
542  ) .
543  Xml::closeElement( 'form' ) .
544  Xml::closeElement( 'div' )
545  );
546  }
547 
555  function showDiff( $previousRev, $currentRev ) {
556  $diffContext = clone $this->getContext();
557  $diffContext->setTitle( $currentRev->getTitle() );
558  $diffContext->setWikiPage( WikiPage::factory( $currentRev->getTitle() ) );
559 
560  $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
561  $diffEngine->setRevisions( $previousRev->getRevisionRecord(), $currentRev->getRevisionRecord() );
562  $diffEngine->showDiffStyle();
563  $formattedDiff = $diffEngine->getDiff(
564  $this->diffHeader( $previousRev, 'o' ),
565  $this->diffHeader( $currentRev, 'n' )
566  );
567 
568  $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
569  }
570 
576  private function diffHeader( $rev, $prefix ) {
577  $isDeleted = !( $rev->getId() && $rev->getTitle() );
578  if ( $isDeleted ) {
580  $targetPage = $this->getPageTitle();
581  $targetQuery = [
582  'target' => $this->mTargetObj->getPrefixedText(),
583  'timestamp' => wfTimestamp( TS_MW, $rev->getTimestamp() )
584  ];
585  } else {
587  $targetPage = $rev->getTitle();
588  $targetQuery = [ 'oldid' => $rev->getId() ];
589  }
590 
591  // Add show/hide deletion links if available
592  $user = $this->getUser();
593  $lang = $this->getLanguage();
594  $rdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
595 
596  if ( $rdel ) {
597  $rdel = " $rdel";
598  }
599 
600  $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
601 
602  $tagIds = wfGetDB( DB_REPLICA )->selectFieldValues(
603  'change_tag',
604  'ct_tag_id',
605  [ 'ct_rev_id' => $rev->getId() ],
606  __METHOD__
607  );
608  $tags = [];
609  $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
610  foreach ( $tagIds as $tagId ) {
611  try {
612  $tags[] = $changeTagDefStore->getName( (int)$tagId );
613  } catch ( NameTableAccessException $exception ) {
614  continue;
615  }
616  }
617  $tags = implode( ',', $tags );
618  $tagSummary = ChangeTags::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
619 
620  // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
621  // and partially #showDiffPage, but worse
622  return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
623  $this->getLinkRenderer()->makeLink(
624  $targetPage,
625  $this->msg(
626  'revisionasof',
627  $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
628  $lang->userDate( $rev->getTimestamp(), $user ),
629  $lang->userTime( $rev->getTimestamp(), $user )
630  )->text(),
631  [],
632  $targetQuery
633  ) .
634  '</strong></div>' .
635  '<div id="mw-diff-' . $prefix . 'title2">' .
636  Linker::revUserTools( $rev ) . '<br />' .
637  '</div>' .
638  '<div id="mw-diff-' . $prefix . 'title3">' .
639  $minor . Linker::revComment( $rev ) . $rdel . '<br />' .
640  '</div>' .
641  '<div id="mw-diff-' . $prefix . 'title5">' .
642  $tagSummary[0] . '<br />' .
643  '</div>';
644  }
645 
650  private function showFileConfirmationForm( $key ) {
651  $out = $this->getOutput();
652  $lang = $this->getLanguage();
653  $user = $this->getUser();
654  $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
655  $out->addWikiMsg( 'undelete-show-file-confirm',
656  $this->mTargetObj->getText(),
657  $lang->userDate( $file->getTimestamp(), $user ),
658  $lang->userTime( $file->getTimestamp(), $user ) );
659  $out->addHTML(
660  Xml::openElement( 'form', [
661  'method' => 'POST',
662  'action' => $this->getPageTitle()->getLocalURL( [
663  'target' => $this->mTarget,
664  'file' => $key,
665  'token' => $user->getEditToken( $key ),
666  ] ),
667  ]
668  ) .
669  Xml::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
670  '</form>'
671  );
672  }
673 
678  private function showFile( $key ) {
679  $this->getOutput()->disable();
680 
681  # We mustn't allow the output to be CDN cached, otherwise
682  # if an admin previews a deleted image, and it's cached, then
683  # a user without appropriate permissions can toddle off and
684  # nab the image, and CDN will serve it
685  $response = $this->getRequest()->response();
686  $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
687  $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
688  $response->header( 'Pragma: no-cache' );
689 
690  $repo = RepoGroup::singleton()->getLocalRepo();
691  $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
692  $repo->streamFileWithStatus( $path );
693  }
694 
695  protected function showHistory() {
696  $this->checkReadOnly();
697 
698  $out = $this->getOutput();
699  if ( $this->mAllowed ) {
700  $out->addModules( 'mediawiki.special.undelete' );
701  }
702  $out->wrapWikiMsg(
703  "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
704  [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) ]
705  );
706 
707  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
708  Hooks::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj ] );
709 
710  $out->addHTML( '<div class="mw-undelete-history">' );
711  if ( $this->mAllowed ) {
712  $out->addWikiMsg( 'undeletehistory' );
713  $out->addWikiMsg( 'undeleterevdel' );
714  } else {
715  $out->addWikiMsg( 'undeletehistorynoadmin' );
716  }
717  $out->addHTML( '</div>' );
718 
719  # List all stored revisions
720  $revisions = $archive->listRevisions();
721  $files = $archive->listFiles();
722 
723  $haveRevisions = $revisions && $revisions->numRows() > 0;
724  $haveFiles = $files && $files->numRows() > 0;
725 
726  # Batch existence check on user and talk pages
727  if ( $haveRevisions ) {
728  $batch = new LinkBatch();
729  foreach ( $revisions as $row ) {
730  $batch->addObj( Title::makeTitleSafe( NS_USER, $row->ar_user_text ) );
731  $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->ar_user_text ) );
732  }
733  $batch->execute();
734  $revisions->seek( 0 );
735  }
736  if ( $haveFiles ) {
737  $batch = new LinkBatch();
738  foreach ( $files as $row ) {
739  $batch->addObj( Title::makeTitleSafe( NS_USER, $row->fa_user_text ) );
740  $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->fa_user_text ) );
741  }
742  $batch->execute();
743  $files->seek( 0 );
744  }
745 
746  if ( $this->mAllowed ) {
747  $out->enableOOUI();
748 
749  $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
750  # Start the form here
751  $form = new OOUI\FormLayout( [
752  'method' => 'post',
753  'action' => $action,
754  'id' => 'undelete',
755  ] );
756  }
757 
758  # Show relevant lines from the deletion log:
759  $deleteLogPage = new LogPage( 'delete' );
760  $out->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
761  LogEventsList::showLogExtract( $out, 'delete', $this->mTargetObj );
762  # Show relevant lines from the suppression log:
763  $suppressLogPage = new LogPage( 'suppress' );
764  if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
765  $out->addHTML( Xml::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
766  LogEventsList::showLogExtract( $out, 'suppress', $this->mTargetObj );
767  }
768 
769  if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
770  $fields[] = new OOUI\Layout( [
771  'content' => new OOUI\HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
772  ] );
773 
774  $fields[] = new OOUI\FieldLayout(
775  new OOUI\TextInputWidget( [
776  'name' => 'wpComment',
777  'inputId' => 'wpComment',
778  'infusable' => true,
779  'value' => $this->mComment,
780  'autofocus' => true,
781  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
782  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
783  // Unicode codepoints.
785  ] ),
786  [
787  'label' => $this->msg( 'undeletecomment' )->text(),
788  'align' => 'top',
789  ]
790  );
791 
792  $fields[] = new OOUI\FieldLayout(
793  new OOUI\Widget( [
794  'content' => new OOUI\HorizontalLayout( [
795  'items' => [
796  new OOUI\ButtonInputWidget( [
797  'name' => 'restore',
798  'inputId' => 'mw-undelete-submit',
799  'value' => '1',
800  'label' => $this->msg( 'undeletebtn' )->text(),
801  'flags' => [ 'primary', 'progressive' ],
802  'type' => 'submit',
803  ] ),
804  new OOUI\ButtonInputWidget( [
805  'name' => 'invert',
806  'inputId' => 'mw-undelete-invert',
807  'value' => '1',
808  'label' => $this->msg( 'undeleteinvert' )->text()
809  ] ),
810  ]
811  ] )
812  ] )
813  );
814 
815  if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
816  $fields[] = new OOUI\FieldLayout(
817  new OOUI\CheckboxInputWidget( [
818  'name' => 'wpUnsuppress',
819  'inputId' => 'mw-undelete-unsuppress',
820  'value' => '1',
821  ] ),
822  [
823  'label' => $this->msg( 'revdelete-unsuppress' )->text(),
824  'align' => 'inline',
825  ]
826  );
827  }
828 
829  $fieldset = new OOUI\FieldsetLayout( [
830  'label' => $this->msg( 'undelete-fieldset-title' )->text(),
831  'id' => 'mw-undelete-table',
832  'items' => $fields,
833  ] );
834 
835  $form->appendContent(
836  new OOUI\PanelLayout( [
837  'expanded' => false,
838  'padded' => true,
839  'framed' => true,
840  'content' => $fieldset,
841  ] ),
842  new OOUI\HtmlSnippet(
843  Html::hidden( 'target', $this->mTarget ) .
844  Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
845  )
846  );
847  }
848 
849  $history = '';
850  $history .= Xml::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
851 
852  if ( $haveRevisions ) {
853  # Show the page's stored (deleted) history
854 
855  if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
856  $history .= Html::element(
857  'button',
858  [
859  'name' => 'revdel',
860  'type' => 'submit',
861  'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
862  ],
863  $this->msg( 'showhideselectedversions' )->text()
864  ) . "\n";
865  }
866 
867  $history .= '<ul class="mw-undelete-revlist">';
868  $remaining = $revisions->numRows();
869  $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
870 
871  foreach ( $revisions as $row ) {
872  $remaining--;
873  $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
874  }
875  $revisions->free();
876  $history .= '</ul>';
877  } else {
878  $out->addWikiMsg( 'nohistory' );
879  }
880 
881  if ( $haveFiles ) {
882  $history .= Xml::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
883  $history .= '<ul class="mw-undelete-revlist">';
884  foreach ( $files as $row ) {
885  $history .= $this->formatFileRow( $row );
886  }
887  $files->free();
888  $history .= '</ul>';
889  }
890 
891  if ( $this->mAllowed ) {
892  # Slip in the hidden controls here
893  $misc = Html::hidden( 'target', $this->mTarget );
894  $misc .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
895  $history .= $misc;
896 
897  $form->appendContent( new OOUI\HtmlSnippet( $history ) );
898  $out->addHTML( $form );
899  } else {
900  $out->addHTML( $history );
901  }
902 
903  return true;
904  }
905 
906  protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
908  [
909  'title' => $this->mTargetObj
910  ] );
911 
912  $revTextSize = '';
913  $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
914  // Build checkboxen...
915  if ( $this->mAllowed ) {
916  if ( $this->mInvert ) {
917  if ( in_array( $ts, $this->mTargetTimestamp ) ) {
918  $checkBox = Xml::check( "ts$ts" );
919  } else {
920  $checkBox = Xml::check( "ts$ts", true );
921  }
922  } else {
923  $checkBox = Xml::check( "ts$ts" );
924  }
925  } else {
926  $checkBox = '';
927  }
928 
929  // Build page & diff links...
930  $user = $this->getUser();
931  if ( $this->mCanView ) {
932  $titleObj = $this->getPageTitle();
933  # Last link
934  if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
935  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
936  $last = $this->msg( 'diff' )->escaped();
937  } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
938  $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
939  $last = $this->getLinkRenderer()->makeKnownLink(
940  $titleObj,
941  $this->msg( 'diff' )->text(),
942  [],
943  [
944  'target' => $this->mTargetObj->getPrefixedText(),
945  'timestamp' => $ts,
946  'diff' => 'prev'
947  ]
948  );
949  } else {
950  $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
951  $last = $this->msg( 'diff' )->escaped();
952  }
953  } else {
954  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
955  $last = $this->msg( 'diff' )->escaped();
956  }
957 
958  // User links
959  $userLink = Linker::revUserTools( $rev );
960 
961  // Minor edit
962  $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
963 
964  // Revision text size
965  $size = $row->ar_len;
966  if ( !is_null( $size ) ) {
967  $revTextSize = Linker::formatRevisionSize( $size );
968  }
969 
970  // Edit summary
971  $comment = Linker::revComment( $rev );
972 
973  // Tags
974  $attribs = [];
975  list( $tagSummary, $classes ) = ChangeTags::formatSummaryRow(
976  $row->ts_tags,
977  'deletedhistory',
978  $this->getContext()
979  );
980  if ( $classes ) {
981  $attribs['class'] = implode( ' ', $classes );
982  }
983 
984  $revisionRow = $this->msg( 'undelete-revision-row2' )
985  ->rawParams(
986  $checkBox,
987  $last,
988  $pageLink,
989  $userLink,
990  $minor,
991  $revTextSize,
992  $comment,
993  $tagSummary
994  )
995  ->escaped();
996 
997  return Xml::tags( 'li', $attribs, $revisionRow ) . "\n";
998  }
999 
1000  private function formatFileRow( $row ) {
1001  $file = ArchivedFile::newFromRow( $row );
1002  $ts = wfTimestamp( TS_MW, $row->fa_timestamp );
1003  $user = $this->getUser();
1004 
1005  $checkBox = '';
1006  if ( $this->mCanView && $row->fa_storage_key ) {
1007  if ( $this->mAllowed ) {
1008  $checkBox = Xml::check( 'fileid' . $row->fa_id );
1009  }
1010  $key = urlencode( $row->fa_storage_key );
1011  $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
1012  } else {
1013  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1014  }
1015  $userLink = $this->getFileUser( $file );
1016  $data = $this->msg( 'widthheight' )->numParams( $row->fa_width, $row->fa_height )->text();
1017  $bytes = $this->msg( 'parentheses' )
1018  ->plaintextParams( $this->msg( 'nbytes' )->numParams( $row->fa_size )->text() )
1019  ->plain();
1020  $data = htmlspecialchars( $data . ' ' . $bytes );
1021  $comment = $this->getFileComment( $file );
1022 
1023  // Add show/hide deletion links if available
1024  $canHide = $this->isAllowed( 'deleterevision' );
1025  if ( $canHide || ( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
1026  if ( !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
1027  // Revision was hidden from sysops
1028  $revdlink = Linker::revDeleteLinkDisabled( $canHide );
1029  } else {
1030  $query = [
1031  'type' => 'filearchive',
1032  'target' => $this->mTargetObj->getPrefixedDBkey(),
1033  'ids' => $row->fa_id
1034  ];
1035  $revdlink = Linker::revDeleteLink( $query,
1036  $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
1037  }
1038  } else {
1039  $revdlink = '';
1040  }
1041 
1042  return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1043  }
1044 
1053  function getPageLink( $rev, $titleObj, $ts ) {
1054  $user = $this->getUser();
1055  $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1056 
1057  if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1058  return '<span class="history-deleted">' . $time . '</span>';
1059  }
1060 
1061  $link = $this->getLinkRenderer()->makeKnownLink(
1062  $titleObj,
1063  $time,
1064  [],
1065  [
1066  'target' => $this->mTargetObj->getPrefixedText(),
1067  'timestamp' => $ts
1068  ]
1069  );
1070 
1071  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1072  $link = '<span class="history-deleted">' . $link . '</span>';
1073  }
1074 
1075  return $link;
1076  }
1077 
1088  function getFileLink( $file, $titleObj, $ts, $key ) {
1089  $user = $this->getUser();
1090  $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1091 
1092  if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
1093  return '<span class="history-deleted">' . htmlspecialchars( $time ) . '</span>';
1094  }
1095 
1096  $link = $this->getLinkRenderer()->makeKnownLink(
1097  $titleObj,
1098  $time,
1099  [],
1100  [
1101  'target' => $this->mTargetObj->getPrefixedText(),
1102  'file' => $key,
1103  'token' => $user->getEditToken( $key )
1104  ]
1105  );
1106 
1107  if ( $file->isDeleted( File::DELETED_FILE ) ) {
1108  $link = '<span class="history-deleted">' . $link . '</span>';
1109  }
1110 
1111  return $link;
1112  }
1113 
1120  function getFileUser( $file ) {
1121  if ( !$file->userCan( File::DELETED_USER, $this->getUser() ) ) {
1122  return '<span class="history-deleted">' .
1123  $this->msg( 'rev-deleted-user' )->escaped() .
1124  '</span>';
1125  }
1126 
1127  $link = Linker::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1128  Linker::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1129 
1130  if ( $file->isDeleted( File::DELETED_USER ) ) {
1131  $link = '<span class="history-deleted">' . $link . '</span>';
1132  }
1133 
1134  return $link;
1135  }
1136 
1143  function getFileComment( $file ) {
1144  if ( !$file->userCan( File::DELETED_COMMENT, $this->getUser() ) ) {
1145  return '<span class="history-deleted"><span class="comment">' .
1146  $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1147  }
1148 
1149  $link = Linker::commentBlock( $file->getRawDescription() );
1150 
1151  if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
1152  $link = '<span class="history-deleted">' . $link . '</span>';
1153  }
1154 
1155  return $link;
1156  }
1157 
1158  function undelete() {
1159  if ( $this->getConfig()->get( 'UploadMaintenance' )
1160  && $this->mTargetObj->getNamespace() == NS_FILE
1161  ) {
1162  throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1163  }
1164 
1165  $this->checkReadOnly();
1166 
1167  $out = $this->getOutput();
1168  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
1169  Hooks::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj ] );
1170  $ok = $archive->undelete(
1171  $this->mTargetTimestamp,
1172  $this->mComment,
1173  $this->mFileVersions,
1174  $this->mUnsuppress,
1175  $this->getUser()
1176  );
1177 
1178  if ( is_array( $ok ) ) {
1179  if ( $ok[1] ) { // Undeleted file count
1180  Hooks::run( 'FileUndeleteComplete', [
1181  $this->mTargetObj, $this->mFileVersions,
1182  $this->getUser(), $this->mComment ] );
1183  }
1184 
1185  $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj );
1186  $out->addWikiMsg( 'undeletedpage', Message::rawParam( $link ) );
1187  } else {
1188  $out->setPageTitle( $this->msg( 'undelete-error' ) );
1189  }
1190 
1191  // Show revision undeletion warnings and errors
1192  $status = $archive->getRevisionStatus();
1193  if ( $status && !$status->isGood() ) {
1194  $out->wrapWikiTextAsInterface(
1195  'error',
1196  '<div id="mw-error-cannotundelete">' .
1197  $status->getWikiText(
1198  'cannotundelete',
1199  'cannotundelete'
1200  ) . '</div>'
1201  );
1202  }
1203 
1204  // Show file undeletion warnings and errors
1205  $status = $archive->getFileStatus();
1206  if ( $status && !$status->isGood() ) {
1207  $out->wrapWikiTextAsInterface(
1208  'error',
1209  $status->getWikiText(
1210  'undelete-error-short',
1211  'undelete-error-long'
1212  )
1213  );
1214  }
1215  }
1216 
1225  public function prefixSearchSubpages( $search, $limit, $offset ) {
1226  return $this->prefixSearchString( $search, $limit, $offset );
1227  }
1228 
1229  protected function getGroupName() {
1230  return 'pagetools';
1231  }
1232 }
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:1038
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
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:1585
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
either a plain
Definition: hooks.txt:2043
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:210
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:780
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:1799
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. '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:1980
$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:3050
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:780
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:1263
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:945
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:1982
string $mSearchPrefix
Search prefix.
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:780
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:925
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:1766
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
const DELETED_TEXT
Definition: Revision.php:46
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:900
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:617
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:2111
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:797
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2153
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:93
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:192
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:2633
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:1473
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:2175
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:1124
$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:319