MediaWiki  master
SpecialUndelete.php
Go to the documentation of this file.
1 <?php
25 
33  private $mAction;
34  private $mTarget;
35  private $mTimestamp;
36  private $mRestore;
37  private $mRevdel;
38  private $mInvert;
39  private $mFilename;
41  private $mAllowed;
42  private $mCanView;
43  private $mComment;
44  private $mToken;
45 
47  private $mTargetObj;
51  private $mSearchPrefix;
52 
53  function __construct() {
54  parent::__construct( 'Undelete', 'deletedhistory' );
55  }
56 
57  public function doesWrites() {
58  return true;
59  }
60 
61  function loadRequest( $par ) {
62  $request = $this->getRequest();
63  $user = $this->getUser();
64 
65  $this->mAction = $request->getVal( 'action' );
66  if ( $par !== null && $par !== '' ) {
67  $this->mTarget = $par;
68  } else {
69  $this->mTarget = $request->getVal( 'target' );
70  }
71 
72  $this->mTargetObj = null;
73 
74  if ( $this->mTarget !== null && $this->mTarget !== '' ) {
75  $this->mTargetObj = Title::newFromText( $this->mTarget );
76  }
77 
78  $this->mSearchPrefix = $request->getText( 'prefix' );
79  $time = $request->getVal( 'timestamp' );
80  $this->mTimestamp = $time ? wfTimestamp( TS_MW, $time ) : '';
81  $this->mFilename = $request->getVal( 'file' );
82 
83  $posted = $request->wasPosted() &&
84  $user->matchEditToken( $request->getVal( 'wpEditToken' ) );
85  $this->mRestore = $request->getCheck( 'restore' ) && $posted;
86  $this->mRevdel = $request->getCheck( 'revdel' ) && $posted;
87  $this->mInvert = $request->getCheck( 'invert' ) && $posted;
88  $this->mPreview = $request->getCheck( 'preview' ) && $posted;
89  $this->mDiff = $request->getCheck( 'diff' );
90  $this->mDiffOnly = $request->getBool( 'diffonly', $this->getUser()->getOption( 'diffonly' ) );
91  $this->mComment = $request->getText( 'wpComment' );
92  $this->mUnsuppress = $request->getVal( 'wpUnsuppress' ) && $user->isAllowed( 'suppressrevision' );
93  $this->mToken = $request->getVal( 'token' );
94 
95  if ( $this->isAllowed( 'undelete' ) && !$user->isBlocked() ) {
96  $this->mAllowed = true; // user can restore
97  $this->mCanView = true; // user can view content
98  } elseif ( $this->isAllowed( 'deletedtext' ) ) {
99  $this->mAllowed = false; // user cannot restore
100  $this->mCanView = true; // user can view content
101  $this->mRestore = false;
102  } else { // user can only view the list of revisions
103  $this->mAllowed = false;
104  $this->mCanView = false;
105  $this->mTimestamp = '';
106  $this->mRestore = false;
107  }
108 
109  if ( $this->mRestore || $this->mInvert ) {
110  $timestamps = [];
111  $this->mFileVersions = [];
112  foreach ( $request->getValues() as $key => $val ) {
113  $matches = [];
114  if ( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
115  array_push( $timestamps, $matches[1] );
116  }
117 
118  if ( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
119  $this->mFileVersions[] = intval( $matches[1] );
120  }
121  }
122  rsort( $timestamps );
123  $this->mTargetTimestamp = $timestamps;
124  }
125  }
126 
135  protected function isAllowed( $permission, User $user = null ) {
136  $user = $user ?: $this->getUser();
137  if ( $this->mTargetObj !== null ) {
138  return $this->mTargetObj->userCan( $permission, $user );
139  } else {
140  return $user->isAllowed( $permission );
141  }
142  }
143 
144  function userCanExecute( User $user ) {
145  return $this->isAllowed( $this->mRestriction, $user );
146  }
147 
148  function execute( $par ) {
149  $this->useTransactionalTimeLimit();
150 
151  $user = $this->getUser();
152 
153  $this->setHeaders();
154  $this->outputHeader();
155 
156  $this->loadRequest( $par );
157  $this->checkPermissions(); // Needs to be after mTargetObj is set
158 
159  $out = $this->getOutput();
160 
161  if ( is_null( $this->mTargetObj ) ) {
162  $out->addWikiMsg( 'undelete-header' );
163 
164  # Not all users can just browse every deleted page from the list
165  if ( $user->isAllowed( 'browsearchive' ) ) {
166  $this->showSearchForm();
167  }
168 
169  return;
170  }
171 
172  $this->addHelpLink( 'Help:Undelete' );
173  if ( $this->mAllowed ) {
174  $out->setPageTitle( $this->msg( 'undeletepage' ) );
175  } else {
176  $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
177  }
178 
179  $this->getSkin()->setRelevantTitle( $this->mTargetObj );
180 
181  if ( $this->mTimestamp !== '' ) {
182  $this->showRevision( $this->mTimestamp );
183  } elseif ( $this->mFilename !== null && $this->mTargetObj->inNamespace( NS_FILE ) ) {
184  $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
185  // Check if user is allowed to see this file
186  if ( !$file->exists() ) {
187  $out->addWikiMsg( 'filedelete-nofile', $this->mFilename );
188  } elseif ( !$file->userCan( File::DELETED_FILE, $user ) ) {
189  if ( $file->isDeleted( File::DELETED_RESTRICTED ) ) {
190  throw new PermissionsError( 'suppressrevision' );
191  } else {
192  throw new PermissionsError( 'deletedtext' );
193  }
194  } elseif ( !$user->matchEditToken( $this->mToken, $this->mFilename ) ) {
195  $this->showFileConfirmationForm( $this->mFilename );
196  } else {
197  $this->showFile( $this->mFilename );
198  }
199  } elseif ( $this->mAction === "submit" ) {
200  if ( $this->mRestore ) {
201  $this->undelete();
202  } elseif ( $this->mRevdel ) {
203  $this->redirectToRevDel();
204  }
205 
206  } else {
207  $this->showHistory();
208  }
209  }
210 
215  private function redirectToRevDel() {
216  $archive = new PageArchive( $this->mTargetObj );
217 
218  $revisions = [];
219 
220  foreach ( $this->getRequest()->getValues() as $key => $val ) {
221  $matches = [];
222  if ( preg_match( "/^ts(\d{14})$/", $key, $matches ) ) {
223  $revisions[ $archive->getRevision( $matches[1] )->getId() ] = 1;
224  }
225  }
226  $query = [
227  "type" => "revision",
228  "ids" => $revisions,
229  "target" => $this->mTargetObj->getPrefixedText()
230  ];
231  $url = SpecialPage::getTitleFor( 'Revisiondelete' )->getFullURL( $query );
232  $this->getOutput()->redirect( $url );
233  }
234 
235  function showSearchForm() {
236  $out = $this->getOutput();
237  $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
238  $fuzzySearch = $this->getRequest()->getVal( 'fuzzy', true );
239 
240  $out->enableOOUI();
241 
242  $fields[] = new OOUI\ActionFieldLayout(
243  new OOUI\TextInputWidget( [
244  'name' => 'prefix',
245  'inputId' => 'prefix',
246  'infusable' => true,
247  'value' => $this->mSearchPrefix,
248  'autofocus' => true,
249  ] ),
250  new OOUI\ButtonInputWidget( [
251  'label' => $this->msg( 'undelete-search-submit' )->text(),
252  'flags' => [ 'primary', 'progressive' ],
253  'inputId' => 'searchUndelete',
254  'type' => 'submit',
255  ] ),
256  [
257  'label' => new OOUI\HtmlSnippet(
258  $this->msg(
259  $fuzzySearch ? 'undelete-search-full' : 'undelete-search-prefix'
260  )->parse()
261  ),
262  'align' => 'left',
263  ]
264  );
265 
266  $fieldset = new OOUI\FieldsetLayout( [
267  'label' => $this->msg( 'undelete-search-box' )->text(),
268  'items' => $fields,
269  ] );
270 
271  $form = new OOUI\FormLayout( [
272  'method' => 'get',
273  'action' => wfScript(),
274  ] );
275 
276  $form->appendContent(
277  $fieldset,
278  new OOUI\HtmlSnippet(
279  Html::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) .
280  Html::hidden( 'fuzzy', $fuzzySearch )
281  )
282  );
283 
284  $out->addHTML(
285  new OOUI\PanelLayout( [
286  'expanded' => false,
287  'padded' => true,
288  'framed' => true,
289  'content' => $form,
290  ] )
291  );
292 
293  # List undeletable articles
294  if ( $this->mSearchPrefix ) {
295  // For now, we enable search engine match only when specifically asked to
296  // by using fuzzy=1 parameter.
297  if ( $fuzzySearch ) {
298  $result = PageArchive::listPagesBySearch( $this->mSearchPrefix );
299  } else {
300  $result = PageArchive::listPagesByPrefix( $this->mSearchPrefix );
301  }
302  $this->showList( $result );
303  }
304  }
305 
312  private function showList( $result ) {
313  $out = $this->getOutput();
314 
315  if ( $result->numRows() == 0 ) {
316  $out->addWikiMsg( 'undelete-no-results' );
317 
318  return false;
319  }
320 
321  $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
322 
323  $linkRenderer = $this->getLinkRenderer();
324  $undelete = $this->getPageTitle();
325  $out->addHTML( "<ul id='undeleteResultsList'>\n" );
326  foreach ( $result as $row ) {
327  $title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
328  if ( $title !== null ) {
329  $item = $linkRenderer->makeKnownLink(
330  $undelete,
331  $title->getPrefixedText(),
332  [],
333  [ 'target' => $title->getPrefixedText() ]
334  );
335  } else {
336  // The title is no longer valid, show as text
337  $item = Html::element(
338  'span',
339  [ 'class' => 'mw-invalidtitle' ],
341  $this->getContext(),
342  $row->ar_namespace,
343  $row->ar_title
344  )
345  );
346  }
347  $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count )->parse();
348  $out->addHTML( "<li class='undeleteResult'>{$item} ({$revs})</li>\n" );
349  }
350  $result->free();
351  $out->addHTML( "</ul>\n" );
352 
353  return true;
354  }
355 
356  private function showRevision( $timestamp ) {
357  if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
358  return;
359  }
360 
361  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
362  if ( !Hooks::run( 'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj ] ) ) {
363  return;
364  }
365  $rev = $archive->getRevision( $timestamp );
366 
367  $out = $this->getOutput();
368  $user = $this->getUser();
369 
370  if ( !$rev ) {
371  $out->addWikiMsg( 'undeleterevision-missing' );
372 
373  return;
374  }
375 
376  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
377  if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
378  $out->wrapWikiMsg(
379  "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
380  $rev->isDeleted( Revision::DELETED_RESTRICTED ) ?
381  'rev-suppressed-text-permission' : 'rev-deleted-text-permission'
382  );
383 
384  return;
385  }
386 
387  $out->wrapWikiMsg(
388  "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
389  $rev->isDeleted( Revision::DELETED_RESTRICTED ) ?
390  'rev-suppressed-text-view' : 'rev-deleted-text-view'
391  );
392  $out->addHTML( '<br />' );
393  // and we are allowed to see...
394  }
395 
396  if ( $this->mDiff ) {
397  $previousRev = $archive->getPreviousRevision( $timestamp );
398  if ( $previousRev ) {
399  $this->showDiff( $previousRev, $rev );
400  if ( $this->mDiffOnly ) {
401  return;
402  }
403 
404  $out->addHTML( '<hr />' );
405  } else {
406  $out->addWikiMsg( 'undelete-nodiff' );
407  }
408  }
409 
410  $link = $this->getLinkRenderer()->makeKnownLink(
411  $this->getPageTitle( $this->mTargetObj->getPrefixedDBkey() ),
412  $this->mTargetObj->getPrefixedText()
413  );
414 
415  $lang = $this->getLanguage();
416 
417  // date and time are separate parameters to facilitate localisation.
418  // $time is kept for backward compat reasons.
419  $time = $lang->userTimeAndDate( $timestamp, $user );
420  $d = $lang->userDate( $timestamp, $user );
421  $t = $lang->userTime( $timestamp, $user );
422  $userLink = Linker::revUserTools( $rev );
423 
424  $content = $rev->getContent( Revision::FOR_THIS_USER, $user );
425 
426  $isText = ( $content instanceof TextContent );
427 
428  if ( $this->mPreview || $isText ) {
429  $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
430  } else {
431  $openDiv = '<div id="mw-undelete-revision">';
432  }
433  $out->addHTML( $openDiv );
434 
435  // Revision delete links
436  if ( !$this->mDiff ) {
437  $revdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
438  if ( $revdel ) {
439  $out->addHTML( "$revdel " );
440  }
441  }
442 
443  $out->addHTML( $this->msg( 'undelete-revision' )->rawParams( $link )->params(
444  $time )->rawParams( $userLink )->params( $d, $t )->parse() . '</div>' );
445 
446  if ( !Hooks::run( 'UndeleteShowRevision', [ $this->mTargetObj, $rev ] ) ) {
447  return;
448  }
449 
450  if ( ( $this->mPreview || !$isText ) && $content ) {
451  // NOTE: non-text content has no source view, so always use rendered preview
452 
453  $popts = $out->parserOptions();
454 
455  $pout = $content->getParserOutput( $this->mTargetObj, $rev->getId(), $popts, true );
456  $out->addParserOutput( $pout, [
457  'enableSectionEditLinks' => false,
458  ] );
459  }
460 
461  $out->enableOOUI();
462  $buttonFields = [];
463 
464  if ( $isText ) {
465  // source view for textual content
466  $sourceView = Xml::element( 'textarea', [
467  'readonly' => 'readonly',
468  'cols' => 80,
469  'rows' => 25
470  ], $content->getNativeData() . "\n" );
471 
472  $buttonFields[] = new OOUI\ButtonInputWidget( [
473  'type' => 'submit',
474  'name' => 'preview',
475  'label' => $this->msg( 'showpreview' )->text()
476  ] );
477  } else {
478  $sourceView = '';
479  $previewButton = '';
480  }
481 
482  $buttonFields[] = new OOUI\ButtonInputWidget( [
483  'name' => 'diff',
484  'type' => 'submit',
485  'label' => $this->msg( 'showdiff' )->text()
486  ] );
487 
488  $out->addHTML(
489  $sourceView .
490  Xml::openElement( 'div', [
491  'style' => 'clear: both' ] ) .
492  Xml::openElement( 'form', [
493  'method' => 'post',
494  'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ) ] ) .
495  Xml::element( 'input', [
496  'type' => 'hidden',
497  'name' => 'target',
498  'value' => $this->mTargetObj->getPrefixedDBkey() ] ) .
499  Xml::element( 'input', [
500  'type' => 'hidden',
501  'name' => 'timestamp',
502  'value' => $timestamp ] ) .
503  Xml::element( 'input', [
504  'type' => 'hidden',
505  'name' => 'wpEditToken',
506  'value' => $user->getEditToken() ] ) .
507  new OOUI\FieldLayout(
508  new OOUI\Widget( [
509  'content' => new OOUI\HorizontalLayout( [
510  'items' => $buttonFields
511  ] )
512  ] )
513  ) .
514  Xml::closeElement( 'form' ) .
515  Xml::closeElement( 'div' )
516  );
517  }
518 
527  function showDiff( $previousRev, $currentRev ) {
528  $diffContext = clone $this->getContext();
529  $diffContext->setTitle( $currentRev->getTitle() );
530  $diffContext->setWikiPage( WikiPage::factory( $currentRev->getTitle() ) );
531 
532  $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
533  $diffEngine->showDiffStyle();
534 
535  $formattedDiff = $diffEngine->generateContentDiffBody(
536  $previousRev->getContent( Revision::FOR_THIS_USER, $this->getUser() ),
537  $currentRev->getContent( Revision::FOR_THIS_USER, $this->getUser() )
538  );
539 
540  $formattedDiff = $diffEngine->addHeader(
541  $formattedDiff,
542  $this->diffHeader( $previousRev, 'o' ),
543  $this->diffHeader( $currentRev, 'n' )
544  );
545 
546  $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
547  }
548 
554  private function diffHeader( $rev, $prefix ) {
555  $isDeleted = !( $rev->getId() && $rev->getTitle() );
556  if ( $isDeleted ) {
558  $targetPage = $this->getPageTitle();
559  $targetQuery = [
560  'target' => $this->mTargetObj->getPrefixedText(),
561  'timestamp' => wfTimestamp( TS_MW, $rev->getTimestamp() )
562  ];
563  } else {
565  $targetPage = $rev->getTitle();
566  $targetQuery = [ 'oldid' => $rev->getId() ];
567  }
568 
569  // Add show/hide deletion links if available
570  $user = $this->getUser();
571  $lang = $this->getLanguage();
572  $rdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
573 
574  if ( $rdel ) {
575  $rdel = " $rdel";
576  }
577 
578  $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
579 
580  $tags = wfGetDB( DB_REPLICA )->selectField(
581  'tag_summary',
582  'ts_tags',
583  [ 'ts_rev_id' => $rev->getId() ],
584  __METHOD__
585  );
586  $tagSummary = ChangeTags::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
587 
588  // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
589  // and partially #showDiffPage, but worse
590  return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
591  $this->getLinkRenderer()->makeLink(
592  $targetPage,
593  $this->msg(
594  'revisionasof',
595  $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
596  $lang->userDate( $rev->getTimestamp(), $user ),
597  $lang->userTime( $rev->getTimestamp(), $user )
598  )->text(),
599  [],
600  $targetQuery
601  ) .
602  '</strong></div>' .
603  '<div id="mw-diff-' . $prefix . 'title2">' .
604  Linker::revUserTools( $rev ) . '<br />' .
605  '</div>' .
606  '<div id="mw-diff-' . $prefix . 'title3">' .
607  $minor . Linker::revComment( $rev ) . $rdel . '<br />' .
608  '</div>' .
609  '<div id="mw-diff-' . $prefix . 'title5">' .
610  $tagSummary[0] . '<br />' .
611  '</div>';
612  }
613 
618  private function showFileConfirmationForm( $key ) {
619  $out = $this->getOutput();
620  $lang = $this->getLanguage();
621  $user = $this->getUser();
622  $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
623  $out->addWikiMsg( 'undelete-show-file-confirm',
624  $this->mTargetObj->getText(),
625  $lang->userDate( $file->getTimestamp(), $user ),
626  $lang->userTime( $file->getTimestamp(), $user ) );
627  $out->addHTML(
628  Xml::openElement( 'form', [
629  'method' => 'POST',
630  'action' => $this->getPageTitle()->getLocalURL( [
631  'target' => $this->mTarget,
632  'file' => $key,
633  'token' => $user->getEditToken( $key ),
634  ] ),
635  ]
636  ) .
637  Xml::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
638  '</form>'
639  );
640  }
641 
646  private function showFile( $key ) {
647  $this->getOutput()->disable();
648 
649  # We mustn't allow the output to be CDN cached, otherwise
650  # if an admin previews a deleted image, and it's cached, then
651  # a user without appropriate permissions can toddle off and
652  # nab the image, and CDN will serve it
653  $response = $this->getRequest()->response();
654  $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
655  $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
656  $response->header( 'Pragma: no-cache' );
657 
658  $repo = RepoGroup::singleton()->getLocalRepo();
659  $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
660  $repo->streamFile( $path );
661  }
662 
663  protected function showHistory() {
664  $this->checkReadOnly();
665 
666  $out = $this->getOutput();
667  if ( $this->mAllowed ) {
668  $out->addModules( 'mediawiki.special.undelete' );
669  }
670  $out->wrapWikiMsg(
671  "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
672  [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) ]
673  );
674 
675  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
676  Hooks::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj ] );
677 
678  $out->addHTML( '<div class="mw-undelete-history">' );
679  if ( $this->mAllowed ) {
680  $out->addWikiMsg( 'undeletehistory' );
681  $out->addWikiMsg( 'undeleterevdel' );
682  } else {
683  $out->addWikiMsg( 'undeletehistorynoadmin' );
684  }
685  $out->addHTML( '</div>' );
686 
687  # List all stored revisions
688  $revisions = $archive->listRevisions();
689  $files = $archive->listFiles();
690 
691  $haveRevisions = $revisions && $revisions->numRows() > 0;
692  $haveFiles = $files && $files->numRows() > 0;
693 
694  # Batch existence check on user and talk pages
695  if ( $haveRevisions ) {
696  $batch = new LinkBatch();
697  foreach ( $revisions as $row ) {
698  $batch->addObj( Title::makeTitleSafe( NS_USER, $row->ar_user_text ) );
699  $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->ar_user_text ) );
700  }
701  $batch->execute();
702  $revisions->seek( 0 );
703  }
704  if ( $haveFiles ) {
705  $batch = new LinkBatch();
706  foreach ( $files as $row ) {
707  $batch->addObj( Title::makeTitleSafe( NS_USER, $row->fa_user_text ) );
708  $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->fa_user_text ) );
709  }
710  $batch->execute();
711  $files->seek( 0 );
712  }
713 
714  if ( $this->mAllowed ) {
715  $out->enableOOUI();
716 
717  $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
718  # Start the form here
719  $form = new OOUI\FormLayout( [
720  'method' => 'post',
721  'action' => $action,
722  'id' => 'undelete',
723  ] );
724  }
725 
726  # Show relevant lines from the deletion log:
727  $deleteLogPage = new LogPage( 'delete' );
728  $out->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
729  LogEventsList::showLogExtract( $out, 'delete', $this->mTargetObj );
730  # Show relevant lines from the suppression log:
731  $suppressLogPage = new LogPage( 'suppress' );
732  if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
733  $out->addHTML( Xml::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
734  LogEventsList::showLogExtract( $out, 'suppress', $this->mTargetObj );
735  }
736 
737  if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
738  $fields[] = new OOUI\Layout( [
739  'content' => new OOUI\HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
740  ] );
741 
742  $conf = $this->getConfig();
743  $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD;
744 
745  $fields[] = new OOUI\FieldLayout(
746  new OOUI\TextInputWidget( [
747  'name' => 'wpComment',
748  'inputId' => 'wpComment',
749  'infusable' => true,
750  'value' => $this->mComment,
751  'autofocus' => true,
752  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
753  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
754  // Unicode codepoints (or 255 UTF-8 bytes for old schema).
755  'maxLength' => $oldCommentSchema ? 255 : CommentStore::COMMENT_CHARACTER_LIMIT,
756  ] ),
757  [
758  'label' => $this->msg( 'undeletecomment' )->text(),
759  'align' => 'top',
760  ]
761  );
762 
763  $fields[] = new OOUI\FieldLayout(
764  new OOUI\Widget( [
765  'content' => new OOUI\HorizontalLayout( [
766  'items' => [
767  new OOUI\ButtonInputWidget( [
768  'name' => 'restore',
769  'inputId' => 'mw-undelete-submit',
770  'value' => '1',
771  'label' => $this->msg( 'undeletebtn' )->text(),
772  'flags' => [ 'primary', 'progressive' ],
773  'type' => 'submit',
774  ] ),
775  new OOUI\ButtonInputWidget( [
776  'name' => 'invert',
777  'inputId' => 'mw-undelete-invert',
778  'value' => '1',
779  'label' => $this->msg( 'undeleteinvert' )->text()
780  ] ),
781  ]
782  ] )
783  ] )
784  );
785 
786  if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
787  $fields[] = new OOUI\FieldLayout(
788  new OOUI\CheckboxInputWidget( [
789  'name' => 'wpUnsuppress',
790  'inputId' => 'mw-undelete-unsuppress',
791  'value' => '1',
792  ] ),
793  [
794  'label' => $this->msg( 'revdelete-unsuppress' )->text(),
795  'align' => 'inline',
796  ]
797  );
798  }
799 
800  $fieldset = new OOUI\FieldsetLayout( [
801  'label' => $this->msg( 'undelete-fieldset-title' )->text(),
802  'id' => 'mw-undelete-table',
803  'items' => $fields,
804  ] );
805 
806  $form->appendContent(
807  new OOUI\PanelLayout( [
808  'expanded' => false,
809  'padded' => true,
810  'framed' => true,
811  'content' => $fieldset,
812  ] ),
813  new OOUI\HtmlSnippet(
814  Html::hidden( 'target', $this->mTarget ) .
815  Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
816  )
817  );
818  }
819 
820  $history = '';
821  $history .= Xml::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
822 
823  if ( $haveRevisions ) {
824  # Show the page's stored (deleted) history
825 
826  if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
827  $history .= Html::element(
828  'button',
829  [
830  'name' => 'revdel',
831  'type' => 'submit',
832  'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
833  ],
834  $this->msg( 'showhideselectedversions' )->text()
835  ) . "\n";
836  }
837 
838  $history .= '<ul class="mw-undelete-revlist">';
839  $remaining = $revisions->numRows();
840  $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
841 
842  foreach ( $revisions as $row ) {
843  $remaining--;
844  $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
845  }
846  $revisions->free();
847  $history .= '</ul>';
848  } else {
849  $out->addWikiMsg( 'nohistory' );
850  }
851 
852  if ( $haveFiles ) {
853  $history .= Xml::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
854  $history .= '<ul class="mw-undelete-revlist">';
855  foreach ( $files as $row ) {
856  $history .= $this->formatFileRow( $row );
857  }
858  $files->free();
859  $history .= '</ul>';
860  }
861 
862  if ( $this->mAllowed ) {
863  # Slip in the hidden controls here
864  $misc = Html::hidden( 'target', $this->mTarget );
865  $misc .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
866  $history .= $misc;
867 
868  $form->appendContent( new OOUI\HtmlSnippet( $history ) );
869  $out->addHTML( $form );
870  } else {
871  $out->addHTML( $history );
872  }
873 
874  return true;
875  }
876 
877  protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
879  [
880  'title' => $this->mTargetObj
881  ] );
882 
883  $revTextSize = '';
884  $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
885  // Build checkboxen...
886  if ( $this->mAllowed ) {
887  if ( $this->mInvert ) {
888  if ( in_array( $ts, $this->mTargetTimestamp ) ) {
889  $checkBox = Xml::check( "ts$ts" );
890  } else {
891  $checkBox = Xml::check( "ts$ts", true );
892  }
893  } else {
894  $checkBox = Xml::check( "ts$ts" );
895  }
896  } else {
897  $checkBox = '';
898  }
899 
900  // Build page & diff links...
901  $user = $this->getUser();
902  if ( $this->mCanView ) {
903  $titleObj = $this->getPageTitle();
904  # Last link
905  if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
906  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
907  $last = $this->msg( 'diff' )->escaped();
908  } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
909  $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
910  $last = $this->getLinkRenderer()->makeKnownLink(
911  $titleObj,
912  $this->msg( 'diff' )->text(),
913  [],
914  [
915  'target' => $this->mTargetObj->getPrefixedText(),
916  'timestamp' => $ts,
917  'diff' => 'prev'
918  ]
919  );
920  } else {
921  $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
922  $last = $this->msg( 'diff' )->escaped();
923  }
924  } else {
925  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
926  $last = $this->msg( 'diff' )->escaped();
927  }
928 
929  // User links
930  $userLink = Linker::revUserTools( $rev );
931 
932  // Minor edit
933  $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
934 
935  // Revision text size
936  $size = $row->ar_len;
937  if ( !is_null( $size ) ) {
938  $revTextSize = Linker::formatRevisionSize( $size );
939  }
940 
941  // Edit summary
942  $comment = Linker::revComment( $rev );
943 
944  // Tags
945  $attribs = [];
946  list( $tagSummary, $classes ) = ChangeTags::formatSummaryRow(
947  $row->ts_tags,
948  'deletedhistory',
949  $this->getContext()
950  );
951  if ( $classes ) {
952  $attribs['class'] = implode( ' ', $classes );
953  }
954 
955  $revisionRow = $this->msg( 'undelete-revision-row2' )
956  ->rawParams(
957  $checkBox,
958  $last,
959  $pageLink,
960  $userLink,
961  $minor,
962  $revTextSize,
963  $comment,
964  $tagSummary
965  )
966  ->escaped();
967 
968  return Xml::tags( 'li', $attribs, $revisionRow ) . "\n";
969  }
970 
971  private function formatFileRow( $row ) {
972  $file = ArchivedFile::newFromRow( $row );
973  $ts = wfTimestamp( TS_MW, $row->fa_timestamp );
974  $user = $this->getUser();
975 
976  $checkBox = '';
977  if ( $this->mCanView && $row->fa_storage_key ) {
978  if ( $this->mAllowed ) {
979  $checkBox = Xml::check( 'fileid' . $row->fa_id );
980  }
981  $key = urlencode( $row->fa_storage_key );
982  $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
983  } else {
984  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
985  }
986  $userLink = $this->getFileUser( $file );
987  $data = $this->msg( 'widthheight' )->numParams( $row->fa_width, $row->fa_height )->text();
988  $bytes = $this->msg( 'parentheses' )
989  ->plaintextParams( $this->msg( 'nbytes' )->numParams( $row->fa_size )->text() )
990  ->plain();
991  $data = htmlspecialchars( $data . ' ' . $bytes );
992  $comment = $this->getFileComment( $file );
993 
994  // Add show/hide deletion links if available
995  $canHide = $this->isAllowed( 'deleterevision' );
996  if ( $canHide || ( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
997  if ( !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
998  // Revision was hidden from sysops
999  $revdlink = Linker::revDeleteLinkDisabled( $canHide );
1000  } else {
1001  $query = [
1002  'type' => 'filearchive',
1003  'target' => $this->mTargetObj->getPrefixedDBkey(),
1004  'ids' => $row->fa_id
1005  ];
1006  $revdlink = Linker::revDeleteLink( $query,
1007  $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
1008  }
1009  } else {
1010  $revdlink = '';
1011  }
1012 
1013  return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1014  }
1015 
1024  function getPageLink( $rev, $titleObj, $ts ) {
1025  $user = $this->getUser();
1026  $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1027 
1028  if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1029  return '<span class="history-deleted">' . $time . '</span>';
1030  }
1031 
1032  $link = $this->getLinkRenderer()->makeKnownLink(
1033  $titleObj,
1034  $time,
1035  [],
1036  [
1037  'target' => $this->mTargetObj->getPrefixedText(),
1038  'timestamp' => $ts
1039  ]
1040  );
1041 
1042  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1043  $link = '<span class="history-deleted">' . $link . '</span>';
1044  }
1045 
1046  return $link;
1047  }
1048 
1059  function getFileLink( $file, $titleObj, $ts, $key ) {
1060  $user = $this->getUser();
1061  $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1062 
1063  if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
1064  return '<span class="history-deleted">' . htmlspecialchars( $time ) . '</span>';
1065  }
1066 
1067  $link = $this->getLinkRenderer()->makeKnownLink(
1068  $titleObj,
1069  $time,
1070  [],
1071  [
1072  'target' => $this->mTargetObj->getPrefixedText(),
1073  'file' => $key,
1074  'token' => $user->getEditToken( $key )
1075  ]
1076  );
1077 
1078  if ( $file->isDeleted( File::DELETED_FILE ) ) {
1079  $link = '<span class="history-deleted">' . $link . '</span>';
1080  }
1081 
1082  return $link;
1083  }
1084 
1091  function getFileUser( $file ) {
1092  if ( !$file->userCan( File::DELETED_USER, $this->getUser() ) ) {
1093  return '<span class="history-deleted">' .
1094  $this->msg( 'rev-deleted-user' )->escaped() .
1095  '</span>';
1096  }
1097 
1098  $link = Linker::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1099  Linker::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1100 
1101  if ( $file->isDeleted( File::DELETED_USER ) ) {
1102  $link = '<span class="history-deleted">' . $link . '</span>';
1103  }
1104 
1105  return $link;
1106  }
1107 
1114  function getFileComment( $file ) {
1115  if ( !$file->userCan( File::DELETED_COMMENT, $this->getUser() ) ) {
1116  return '<span class="history-deleted"><span class="comment">' .
1117  $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1118  }
1119 
1120  $link = Linker::commentBlock( $file->getRawDescription() );
1121 
1122  if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
1123  $link = '<span class="history-deleted">' . $link . '</span>';
1124  }
1125 
1126  return $link;
1127  }
1128 
1129  function undelete() {
1130  if ( $this->getConfig()->get( 'UploadMaintenance' )
1131  && $this->mTargetObj->getNamespace() == NS_FILE
1132  ) {
1133  throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1134  }
1135 
1136  $this->checkReadOnly();
1137 
1138  $out = $this->getOutput();
1139  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
1140  Hooks::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj ] );
1141  $ok = $archive->undelete(
1142  $this->mTargetTimestamp,
1143  $this->mComment,
1144  $this->mFileVersions,
1145  $this->mUnsuppress,
1146  $this->getUser()
1147  );
1148 
1149  if ( is_array( $ok ) ) {
1150  if ( $ok[1] ) { // Undeleted file count
1151  Hooks::run( 'FileUndeleteComplete', [
1152  $this->mTargetObj, $this->mFileVersions,
1153  $this->getUser(), $this->mComment ] );
1154  }
1155 
1156  $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj );
1157  $out->addHTML( $this->msg( 'undeletedpage' )->rawParams( $link )->parse() );
1158  } else {
1159  $out->setPageTitle( $this->msg( 'undelete-error' ) );
1160  }
1161 
1162  // Show revision undeletion warnings and errors
1163  $status = $archive->getRevisionStatus();
1164  if ( $status && !$status->isGood() ) {
1165  $out->addWikiText( '<div class="error" id="mw-error-cannotundelete">' .
1166  $status->getWikiText(
1167  'cannotundelete',
1168  'cannotundelete'
1169  ) . '</div>'
1170  );
1171  }
1172 
1173  // Show file undeletion warnings and errors
1174  $status = $archive->getFileStatus();
1175  if ( $status && !$status->isGood() ) {
1176  $out->addWikiText( '<div class="error">' .
1177  $status->getWikiText(
1178  'undelete-error-short',
1179  'undelete-error-long'
1180  ) . '</div>'
1181  );
1182  }
1183  }
1184 
1193  public function prefixSearchSubpages( $search, $limit, $offset ) {
1194  return $this->prefixSearchString( $search, $limit, $offset );
1195  }
1196 
1197  protected function getGroupName() {
1198  return 'pagetools';
1199  }
1200 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:125
const FOR_THIS_USER
Definition: Revision.php:56
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 revComment(Revision $rev, $local=false, $isPublic=false)
Wrap and format the given revision&#39;s comment block, if the current user is allowed to view it...
Definition: Linker.php:1463
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:167
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:798
const DELETED_COMMENT
Definition: File.php:54
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:1636
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:2102
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 getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
Definition: Linker.php:2048
static formatRevisionSize( $size)
Definition: Linker.php:1486
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
showRevision( $timestamp)
if(!isset( $args[0])) $lang
static revUserTools( $rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
Definition: Linker.php:1048
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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). '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:1300
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.
static listPagesBySearch( $term)
List deleted pages recorded in the archive matching the given term, using search engine archive...
Definition: PageArchive.php:97
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:798
static listPagesByPrefix( $prefix)
List deleted pages recorded in the archive table matching the given title prefix. ...
const DELETED_FILE
Definition: File.php:53
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. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:2039
$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:3089
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:46
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
$last
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 true
Definition: hooks.txt:2041
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:110
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.
const MIGRATION_OLD
Definition: Defines.php:315
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:461
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:132
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:2041
string $mSearchPrefix
Search prefix.
const DELETED_RESTRICTED
Definition: Revision.php:50
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:949
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
const NS_FILE
Definition: Defines.php:70
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:82
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:1813
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:55
const DELETED_TEXT
Definition: Revision.php:47
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:871
const DELETED_RESTRICTED
Definition: File.php:56
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:566
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 closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:119
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:791
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2089
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:32
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 commentBlock( $comment, $title=null, $local=false, $wikiId=null)
Wrap a comment in standard punctuation and formatting if it&#39;s non-empty, otherwise return empty strin...
Definition: Linker.php:1438
static formatSummaryRow( $tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:91
diffHeader( $rev, $prefix)
static getInvalidTitleDescription(IContextSource $context, $namespace, $title)
Get a message saying that an invalid title was encountered.
Definition: Linker.php:186
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.
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:909
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:67
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:2681
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:325
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1846
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:244
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:2111
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
$matches
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273