MediaWiki  1.30.0
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  // Hide [edit]s
454  $popts = $out->parserOptions();
455  $popts->setEditSection( false );
456 
457  $pout = $content->getParserOutput( $this->mTargetObj, $rev->getId(), $popts, true );
458  $out->addParserOutput( $pout );
459  }
460 
461  if ( $isText ) {
462  // source view for textual content
463  $sourceView = Xml::element(
464  'textarea',
465  [
466  'readonly' => 'readonly',
467  'cols' => 80,
468  'rows' => 25
469  ],
470  $content->getNativeData() . "\n"
471  );
472 
473  $previewButton = Xml::element( 'input', [
474  'type' => 'submit',
475  'name' => 'preview',
476  'value' => $this->msg( 'showpreview' )->text()
477  ] );
478  } else {
479  $sourceView = '';
480  $previewButton = '';
481  }
482 
483  $diffButton = Xml::element( 'input', [
484  'name' => 'diff',
485  'type' => 'submit',
486  'value' => $this->msg( 'showdiff' )->text() ] );
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  $previewButton .
508  $diffButton .
509  Xml::closeElement( 'form' ) .
510  Xml::closeElement( 'div' )
511  );
512  }
513 
522  function showDiff( $previousRev, $currentRev ) {
523  $diffContext = clone $this->getContext();
524  $diffContext->setTitle( $currentRev->getTitle() );
525  $diffContext->setWikiPage( WikiPage::factory( $currentRev->getTitle() ) );
526 
527  $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
528  $diffEngine->showDiffStyle();
529 
530  $formattedDiff = $diffEngine->generateContentDiffBody(
531  $previousRev->getContent( Revision::FOR_THIS_USER, $this->getUser() ),
532  $currentRev->getContent( Revision::FOR_THIS_USER, $this->getUser() )
533  );
534 
535  $formattedDiff = $diffEngine->addHeader(
536  $formattedDiff,
537  $this->diffHeader( $previousRev, 'o' ),
538  $this->diffHeader( $currentRev, 'n' )
539  );
540 
541  $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
542  }
543 
549  private function diffHeader( $rev, $prefix ) {
550  $isDeleted = !( $rev->getId() && $rev->getTitle() );
551  if ( $isDeleted ) {
553  $targetPage = $this->getPageTitle();
554  $targetQuery = [
555  'target' => $this->mTargetObj->getPrefixedText(),
556  'timestamp' => wfTimestamp( TS_MW, $rev->getTimestamp() )
557  ];
558  } else {
560  $targetPage = $rev->getTitle();
561  $targetQuery = [ 'oldid' => $rev->getId() ];
562  }
563 
564  // Add show/hide deletion links if available
565  $user = $this->getUser();
566  $lang = $this->getLanguage();
567  $rdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
568 
569  if ( $rdel ) {
570  $rdel = " $rdel";
571  }
572 
573  $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
574 
575  $tags = wfGetDB( DB_REPLICA )->selectField(
576  'tag_summary',
577  'ts_tags',
578  [ 'ts_rev_id' => $rev->getId() ],
579  __METHOD__
580  );
581  $tagSummary = ChangeTags::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
582 
583  // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
584  // and partially #showDiffPage, but worse
585  return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
586  $this->getLinkRenderer()->makeLink(
587  $targetPage,
588  $this->msg(
589  'revisionasof',
590  $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
591  $lang->userDate( $rev->getTimestamp(), $user ),
592  $lang->userTime( $rev->getTimestamp(), $user )
593  )->text(),
594  [],
595  $targetQuery
596  ) .
597  '</strong></div>' .
598  '<div id="mw-diff-' . $prefix . 'title2">' .
599  Linker::revUserTools( $rev ) . '<br />' .
600  '</div>' .
601  '<div id="mw-diff-' . $prefix . 'title3">' .
602  $minor . Linker::revComment( $rev ) . $rdel . '<br />' .
603  '</div>' .
604  '<div id="mw-diff-' . $prefix . 'title5">' .
605  $tagSummary[0] . '<br />' .
606  '</div>';
607  }
608 
613  private function showFileConfirmationForm( $key ) {
614  $out = $this->getOutput();
615  $lang = $this->getLanguage();
616  $user = $this->getUser();
617  $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
618  $out->addWikiMsg( 'undelete-show-file-confirm',
619  $this->mTargetObj->getText(),
620  $lang->userDate( $file->getTimestamp(), $user ),
621  $lang->userTime( $file->getTimestamp(), $user ) );
622  $out->addHTML(
623  Xml::openElement( 'form', [
624  'method' => 'POST',
625  'action' => $this->getPageTitle()->getLocalURL( [
626  'target' => $this->mTarget,
627  'file' => $key,
628  'token' => $user->getEditToken( $key ),
629  ] ),
630  ]
631  ) .
632  Xml::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
633  '</form>'
634  );
635  }
636 
641  private function showFile( $key ) {
642  $this->getOutput()->disable();
643 
644  # We mustn't allow the output to be CDN cached, otherwise
645  # if an admin previews a deleted image, and it's cached, then
646  # a user without appropriate permissions can toddle off and
647  # nab the image, and CDN will serve it
648  $response = $this->getRequest()->response();
649  $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
650  $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
651  $response->header( 'Pragma: no-cache' );
652 
653  $repo = RepoGroup::singleton()->getLocalRepo();
654  $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
655  $repo->streamFile( $path );
656  }
657 
658  protected function showHistory() {
659  $this->checkReadOnly();
660 
661  $out = $this->getOutput();
662  if ( $this->mAllowed ) {
663  $out->addModules( 'mediawiki.special.undelete' );
664  }
665  $out->wrapWikiMsg(
666  "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
667  [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) ]
668  );
669 
670  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
671  Hooks::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj ] );
672 
673  $out->addHTML( '<div class="mw-undelete-history">' );
674  if ( $this->mAllowed ) {
675  $out->addWikiMsg( 'undeletehistory' );
676  $out->addWikiMsg( 'undeleterevdel' );
677  } else {
678  $out->addWikiMsg( 'undeletehistorynoadmin' );
679  }
680  $out->addHTML( '</div>' );
681 
682  # List all stored revisions
683  $revisions = $archive->listRevisions();
684  $files = $archive->listFiles();
685 
686  $haveRevisions = $revisions && $revisions->numRows() > 0;
687  $haveFiles = $files && $files->numRows() > 0;
688 
689  # Batch existence check on user and talk pages
690  if ( $haveRevisions ) {
691  $batch = new LinkBatch();
692  foreach ( $revisions as $row ) {
693  $batch->addObj( Title::makeTitleSafe( NS_USER, $row->ar_user_text ) );
694  $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->ar_user_text ) );
695  }
696  $batch->execute();
697  $revisions->seek( 0 );
698  }
699  if ( $haveFiles ) {
700  $batch = new LinkBatch();
701  foreach ( $files as $row ) {
702  $batch->addObj( Title::makeTitleSafe( NS_USER, $row->fa_user_text ) );
703  $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->fa_user_text ) );
704  }
705  $batch->execute();
706  $files->seek( 0 );
707  }
708 
709  if ( $this->mAllowed ) {
710  $out->enableOOUI();
711 
712  $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
713  # Start the form here
714  $form = new OOUI\FormLayout( [
715  'method' => 'post',
716  'action' => $action,
717  'id' => 'undelete',
718  ] );
719  }
720 
721  # Show relevant lines from the deletion log:
722  $deleteLogPage = new LogPage( 'delete' );
723  $out->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
724  LogEventsList::showLogExtract( $out, 'delete', $this->mTargetObj );
725  # Show relevant lines from the suppression log:
726  $suppressLogPage = new LogPage( 'suppress' );
727  if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
728  $out->addHTML( Xml::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
729  LogEventsList::showLogExtract( $out, 'suppress', $this->mTargetObj );
730  }
731 
732  if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
733  $fields[] = new OOUI\Layout( [
734  'content' => new OOUI\HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
735  ] );
736 
737  $fields[] = new OOUI\FieldLayout(
738  new OOUI\TextInputWidget( [
739  'name' => 'wpComment',
740  'inputId' => 'wpComment',
741  'infusable' => true,
742  'value' => $this->mComment,
743  'autofocus' => true,
744  ] ),
745  [
746  'label' => $this->msg( 'undeletecomment' )->text(),
747  'align' => 'top',
748  ]
749  );
750 
751  $fields[] = new OOUI\FieldLayout(
752  new OOUI\Widget( [
753  'content' => new OOUI\HorizontalLayout( [
754  'items' => [
755  new OOUI\ButtonInputWidget( [
756  'name' => 'restore',
757  'inputId' => 'mw-undelete-submit',
758  'value' => '1',
759  'label' => $this->msg( 'undeletebtn' )->text(),
760  'flags' => [ 'primary', 'progressive' ],
761  'type' => 'submit',
762  ] ),
763  new OOUI\ButtonInputWidget( [
764  'name' => 'invert',
765  'inputId' => 'mw-undelete-invert',
766  'value' => '1',
767  'label' => $this->msg( 'undeleteinvert' )->text()
768  ] ),
769  ]
770  ] )
771  ] )
772  );
773 
774  if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
775  $fields[] = new OOUI\FieldLayout(
776  new OOUI\CheckboxInputWidget( [
777  'name' => 'wpUnsuppress',
778  'inputId' => 'mw-undelete-unsuppress',
779  'value' => '1',
780  ] ),
781  [
782  'label' => $this->msg( 'revdelete-unsuppress' )->text(),
783  'align' => 'inline',
784  ]
785  );
786  }
787 
788  $fieldset = new OOUI\FieldsetLayout( [
789  'label' => $this->msg( 'undelete-fieldset-title' )->text(),
790  'id' => 'mw-undelete-table',
791  'items' => $fields,
792  ] );
793 
794  $form->appendContent(
795  new OOUI\PanelLayout( [
796  'expanded' => false,
797  'padded' => true,
798  'framed' => true,
799  'content' => $fieldset,
800  ] ),
801  new OOUI\HtmlSnippet(
802  Html::hidden( 'target', $this->mTarget ) .
803  Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
804  )
805  );
806  }
807 
808  $history = '';
809  $history .= Xml::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
810 
811  if ( $haveRevisions ) {
812  # Show the page's stored (deleted) history
813 
814  if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
815  $history .= Html::element(
816  'button',
817  [
818  'name' => 'revdel',
819  'type' => 'submit',
820  'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
821  ],
822  $this->msg( 'showhideselectedversions' )->text()
823  ) . "\n";
824  }
825 
826  $history .= '<ul class="mw-undelete-revlist">';
827  $remaining = $revisions->numRows();
828  $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
829 
830  foreach ( $revisions as $row ) {
831  $remaining--;
832  $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
833  }
834  $revisions->free();
835  $history .= '</ul>';
836  } else {
837  $out->addWikiMsg( 'nohistory' );
838  }
839 
840  if ( $haveFiles ) {
841  $history .= Xml::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
842  $history .= '<ul class="mw-undelete-revlist">';
843  foreach ( $files as $row ) {
844  $history .= $this->formatFileRow( $row );
845  }
846  $files->free();
847  $history .= '</ul>';
848  }
849 
850  if ( $this->mAllowed ) {
851  # Slip in the hidden controls here
852  $misc = Html::hidden( 'target', $this->mTarget );
853  $misc .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
854  $history .= $misc;
855 
856  $form->appendContent( new OOUI\HtmlSnippet( $history ) );
857  $out->addHTML( $form );
858  } else {
859  $out->addHTML( $history );
860  }
861 
862  return true;
863  }
864 
865  protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
867  [
868  'title' => $this->mTargetObj
869  ] );
870 
871  $revTextSize = '';
872  $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
873  // Build checkboxen...
874  if ( $this->mAllowed ) {
875  if ( $this->mInvert ) {
876  if ( in_array( $ts, $this->mTargetTimestamp ) ) {
877  $checkBox = Xml::check( "ts$ts" );
878  } else {
879  $checkBox = Xml::check( "ts$ts", true );
880  }
881  } else {
882  $checkBox = Xml::check( "ts$ts" );
883  }
884  } else {
885  $checkBox = '';
886  }
887 
888  // Build page & diff links...
889  $user = $this->getUser();
890  if ( $this->mCanView ) {
891  $titleObj = $this->getPageTitle();
892  # Last link
893  if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
894  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
895  $last = $this->msg( 'diff' )->escaped();
896  } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
897  $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
898  $last = $this->getLinkRenderer()->makeKnownLink(
899  $titleObj,
900  $this->msg( 'diff' )->text(),
901  [],
902  [
903  'target' => $this->mTargetObj->getPrefixedText(),
904  'timestamp' => $ts,
905  'diff' => 'prev'
906  ]
907  );
908  } else {
909  $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
910  $last = $this->msg( 'diff' )->escaped();
911  }
912  } else {
913  $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
914  $last = $this->msg( 'diff' )->escaped();
915  }
916 
917  // User links
918  $userLink = Linker::revUserTools( $rev );
919 
920  // Minor edit
921  $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
922 
923  // Revision text size
924  $size = $row->ar_len;
925  if ( !is_null( $size ) ) {
926  $revTextSize = Linker::formatRevisionSize( $size );
927  }
928 
929  // Edit summary
930  $comment = Linker::revComment( $rev );
931 
932  // Tags
933  $attribs = [];
934  list( $tagSummary, $classes ) = ChangeTags::formatSummaryRow(
935  $row->ts_tags,
936  'deletedhistory',
937  $this->getContext()
938  );
939  if ( $classes ) {
940  $attribs['class'] = implode( ' ', $classes );
941  }
942 
943  $revisionRow = $this->msg( 'undelete-revision-row2' )
944  ->rawParams(
945  $checkBox,
946  $last,
947  $pageLink,
948  $userLink,
949  $minor,
950  $revTextSize,
951  $comment,
952  $tagSummary
953  )
954  ->escaped();
955 
956  return Xml::tags( 'li', $attribs, $revisionRow ) . "\n";
957  }
958 
959  private function formatFileRow( $row ) {
960  $file = ArchivedFile::newFromRow( $row );
961  $ts = wfTimestamp( TS_MW, $row->fa_timestamp );
962  $user = $this->getUser();
963 
964  $checkBox = '';
965  if ( $this->mCanView && $row->fa_storage_key ) {
966  if ( $this->mAllowed ) {
967  $checkBox = Xml::check( 'fileid' . $row->fa_id );
968  }
969  $key = urlencode( $row->fa_storage_key );
970  $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
971  } else {
972  $pageLink = $this->getLanguage()->userTimeAndDate( $ts, $user );
973  }
974  $userLink = $this->getFileUser( $file );
975  $data = $this->msg( 'widthheight' )->numParams( $row->fa_width, $row->fa_height )->text();
976  $bytes = $this->msg( 'parentheses' )
977  ->rawParams( $this->msg( 'nbytes' )->numParams( $row->fa_size )->text() )
978  ->plain();
979  $data = htmlspecialchars( $data . ' ' . $bytes );
980  $comment = $this->getFileComment( $file );
981 
982  // Add show/hide deletion links if available
983  $canHide = $this->isAllowed( 'deleterevision' );
984  if ( $canHide || ( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
985  if ( !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
986  // Revision was hidden from sysops
987  $revdlink = Linker::revDeleteLinkDisabled( $canHide );
988  } else {
989  $query = [
990  'type' => 'filearchive',
991  'target' => $this->mTargetObj->getPrefixedDBkey(),
992  'ids' => $row->fa_id
993  ];
994  $revdlink = Linker::revDeleteLink( $query,
995  $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
996  }
997  } else {
998  $revdlink = '';
999  }
1000 
1001  return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1002  }
1003 
1012  function getPageLink( $rev, $titleObj, $ts ) {
1013  $user = $this->getUser();
1014  $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1015 
1016  if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1017  return '<span class="history-deleted">' . $time . '</span>';
1018  }
1019 
1020  $link = $this->getLinkRenderer()->makeKnownLink(
1021  $titleObj,
1022  $time,
1023  [],
1024  [
1025  'target' => $this->mTargetObj->getPrefixedText(),
1026  'timestamp' => $ts
1027  ]
1028  );
1029 
1030  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1031  $link = '<span class="history-deleted">' . $link . '</span>';
1032  }
1033 
1034  return $link;
1035  }
1036 
1047  function getFileLink( $file, $titleObj, $ts, $key ) {
1048  $user = $this->getUser();
1049  $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1050 
1051  if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
1052  return '<span class="history-deleted">' . $time . '</span>';
1053  }
1054 
1055  $link = $this->getLinkRenderer()->makeKnownLink(
1056  $titleObj,
1057  $time,
1058  [],
1059  [
1060  'target' => $this->mTargetObj->getPrefixedText(),
1061  'file' => $key,
1062  'token' => $user->getEditToken( $key )
1063  ]
1064  );
1065 
1066  if ( $file->isDeleted( File::DELETED_FILE ) ) {
1067  $link = '<span class="history-deleted">' . $link . '</span>';
1068  }
1069 
1070  return $link;
1071  }
1072 
1079  function getFileUser( $file ) {
1080  if ( !$file->userCan( File::DELETED_USER, $this->getUser() ) ) {
1081  return '<span class="history-deleted">' .
1082  $this->msg( 'rev-deleted-user' )->escaped() .
1083  '</span>';
1084  }
1085 
1086  $link = Linker::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1087  Linker::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1088 
1089  if ( $file->isDeleted( File::DELETED_USER ) ) {
1090  $link = '<span class="history-deleted">' . $link . '</span>';
1091  }
1092 
1093  return $link;
1094  }
1095 
1102  function getFileComment( $file ) {
1103  if ( !$file->userCan( File::DELETED_COMMENT, $this->getUser() ) ) {
1104  return '<span class="history-deleted"><span class="comment">' .
1105  $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1106  }
1107 
1108  $link = Linker::commentBlock( $file->getRawDescription() );
1109 
1110  if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
1111  $link = '<span class="history-deleted">' . $link . '</span>';
1112  }
1113 
1114  return $link;
1115  }
1116 
1117  function undelete() {
1118  if ( $this->getConfig()->get( 'UploadMaintenance' )
1119  && $this->mTargetObj->getNamespace() == NS_FILE
1120  ) {
1121  throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1122  }
1123 
1124  $this->checkReadOnly();
1125 
1126  $out = $this->getOutput();
1127  $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
1128  Hooks::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj ] );
1129  $ok = $archive->undelete(
1130  $this->mTargetTimestamp,
1131  $this->mComment,
1132  $this->mFileVersions,
1133  $this->mUnsuppress,
1134  $this->getUser()
1135  );
1136 
1137  if ( is_array( $ok ) ) {
1138  if ( $ok[1] ) { // Undeleted file count
1139  Hooks::run( 'FileUndeleteComplete', [
1140  $this->mTargetObj, $this->mFileVersions,
1141  $this->getUser(), $this->mComment ] );
1142  }
1143 
1144  $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj );
1145  $out->addHTML( $this->msg( 'undeletedpage' )->rawParams( $link )->parse() );
1146  } else {
1147  $out->setPageTitle( $this->msg( 'undelete-error' ) );
1148  }
1149 
1150  // Show revision undeletion warnings and errors
1151  $status = $archive->getRevisionStatus();
1152  if ( $status && !$status->isGood() ) {
1153  $out->addWikiText( '<div class="error" id="mw-error-cannotundelete">' .
1154  $status->getWikiText(
1155  'cannotundelete',
1156  'cannotundelete'
1157  ) . '</div>'
1158  );
1159  }
1160 
1161  // Show file undeletion warnings and errors
1162  $status = $archive->getFileStatus();
1163  if ( $status && !$status->isGood() ) {
1164  $out->addWikiText( '<div class="error">' .
1165  $status->getWikiText(
1166  'undelete-error-short',
1167  'undelete-error-long'
1168  ) . '</div>'
1169  );
1170  }
1171  }
1172 
1181  public function prefixSearchSubpages( $search, $limit, $offset ) {
1182  return $this->prefixSearchString( $search, $limit, $offset );
1183  }
1184 
1185  protected function getGroupName() {
1186  return 'pagetools';
1187  }
1188 }
Revision\newFromArchiveRow
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:189
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:628
SpecialUndelete\formatRevisionRow
formatRevisionRow( $row, $earliestLiveTime, $remaining)
Definition: SpecialUndelete.php:865
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:244
Revision\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: Revision.php:93
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:268
SpecialUndelete\diffHeader
diffHeader( $rev, $prefix)
Definition: SpecialUndelete.php:549
SpecialUndelete\showDiff
showDiff( $previousRev, $currentRev)
Build a diff display between this and the previous either deleted or non-deleted edit.
Definition: SpecialUndelete.php:522
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
SpecialUndelete\$mAllowed
$mAllowed
Definition: SpecialUndelete.php:41
File\DELETED_USER
const DELETED_USER
Definition: File.php:55
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
Xml\tags
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:131
PageArchive
Used to show archived pages and eventually restore them.
Definition: PageArchive.php:28
Linker\userLink
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:893
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
File\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: File.php:56
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
SpecialUndelete\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialUndelete.php:1185
SpecialUndelete
Special page allowing users with the appropriate permissions to view and restore deleted content.
Definition: SpecialUndelete.php:32
$last
$last
Definition: profileinfo.php:415
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
SpecialUndelete\isAllowed
isAllowed( $permission, User $user=null)
Checks whether a user is allowed the permission for the specific title if one is set.
Definition: SpecialUndelete.php:135
SpecialUndelete\getPageLink
getPageLink( $rev, $titleObj, $ts)
Fetch revision text link if it's available to all users.
Definition: SpecialUndelete.php:1012
$result
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 '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! 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! 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:1963
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:2040
SpecialUndelete\execute
execute( $par)
Default execute method Checks user permissions.
Definition: SpecialUndelete.php:148
SpecialUndelete\$mAction
$mAction
Definition: SpecialUndelete.php:33
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1245
SpecialUndelete\showRevision
showRevision( $timestamp)
Definition: SpecialUndelete.php:356
SpecialUndelete\showHistory
showHistory()
Definition: SpecialUndelete.php:658
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
SpecialUndelete\showList
showList( $result)
Generic list of deleted pages.
Definition: SpecialUndelete.php:312
SpecialPage\checkPermissions
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
Definition: SpecialPage.php:306
SpecialUndelete\showSearchForm
showSearchForm()
Definition: SpecialUndelete.php:235
PageArchive\listPagesByPrefix
static listPagesByPrefix( $prefix)
List deleted pages recorded in the archive table matching the given title prefix.
Definition: PageArchive.php:128
NS_FILE
const NS_FILE
Definition: Defines.php:71
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
SpecialPage\getSkin
getSkin()
Shortcut to get the skin being used for this instance.
Definition: SpecialPage.php:695
SpecialPage\useTransactionalTimeLimit
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: SpecialPage.php:850
SpecialUndelete\$mTargetTimestamp
$mTargetTimestamp
Definition: SpecialUndelete.php:40
Wikimedia\Rdbms\ResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: ResultWrapper.php:24
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:705
Linker\getInvalidTitleDescription
static getInvalidTitleDescription(IContextSource $context, $namespace, $title)
Get a message saying that an invalid title was encountered.
Definition: Linker.php:209
SpecialUndelete\getFileUser
getFileUser( $file)
Fetch file's user id if it's available to this user.
Definition: SpecialUndelete.php:1079
PageArchive\listPagesBySearch
static listPagesBySearch( $term)
List deleted pages recorded in the archive matching the given term, using search engine archive.
Definition: PageArchive.php:78
Xml\openElement
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:109
SpecialUndelete\$mFilename
$mFilename
Definition: SpecialUndelete.php:39
SpecialUndelete\$mRestore
$mRestore
Definition: SpecialUndelete.php:36
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Revision\FOR_THIS_USER
const FOR_THIS_USER
Definition: Revision.php:99
SpecialUndelete\$mTargetObj
Title $mTargetObj
Definition: SpecialUndelete.php:47
$query
null for the 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:1581
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:785
SpecialPage\prefixSearchString
prefixSearchString( $search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
Definition: SpecialPage.php:448
SpecialUndelete\$mTimestamp
$mTimestamp
Definition: SpecialUndelete.php:35
SpecialUndelete\$mCanView
$mCanView
Definition: SpecialUndelete.php:42
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:714
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
File\DELETED_COMMENT
const DELETED_COMMENT
Definition: File.php:54
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:121
SpecialUndelete\redirectToRevDel
redirectToRevDel()
Convert submitted form data to format expected by RevisionDelete and redirect the request.
Definition: SpecialUndelete.php:215
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2934
SpecialUndelete\userCanExecute
userCanExecute(User $user)
Checks if the given user (identified by an object) can execute this special page (as defined by $mRes...
Definition: SpecialUndelete.php:144
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2856
Linker\revUserTools
static revUserTools( $rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
Definition: Linker.php:1060
$matches
$matches
Definition: NoLocalSettings.php:24
Xml\check
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:323
SpecialUndelete\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialUndelete.php:57
$attribs
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1965
LogPage
Class to simplify the use of log pages.
Definition: LogPage.php:31
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
ChangesList\flag
static flag( $flag, IContextSource $context=null)
Make an "<abbr>" element for a given change flag.
Definition: ChangesList.php:228
Linker\revDeleteLinkDisabled
static revDeleteLinkDisabled( $delete=true)
Creates a dead (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2093
SpecialUndelete\$mToken
$mToken
Definition: SpecialUndelete.php:44
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:484
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:685
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1778
LogEventsList\showLogExtract
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
Definition: LogEventsList.php:594
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
SpecialUndelete\$mRevdel
$mRevdel
Definition: SpecialUndelete.php:37
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:648
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2581
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:725
SpecialUndelete\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialUndelete.php:1181
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:557
Linker\revComment
static revComment(Revision $rev, $local=false, $isPublic=false)
Wrap and format the given revision's comment block, if the current user is allowed to view it.
Definition: Linker.php:1470
SpecialUndelete\formatFileRow
formatFileRow( $row)
Definition: SpecialUndelete.php:959
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:68
SpecialUndelete\$mSearchPrefix
string $mSearchPrefix
Search prefix.
Definition: SpecialUndelete.php:51
Linker\userToolLinks
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:926
ArchivedFile
Class representing a row of the 'filearchive' table.
Definition: ArchivedFile.php:29
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:36
Linker\getRevDeleteLink
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:2030
SpecialUndelete\$mComment
$mComment
Definition: SpecialUndelete.php:43
SpecialUndelete\$mInvert
$mInvert
Definition: SpecialUndelete.php:38
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:665
Linker\formatRevisionSize
static formatRevisionSize( $size)
Definition: Linker.php:1493
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1703
SpecialUndelete\getFileComment
getFileComment( $file)
Fetch file upload comment if it's available to this user.
Definition: SpecialUndelete.php:1102
plain
either a plain
Definition: hooks.txt:2026
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:35
$response
this hook is for auditing only $response
Definition: hooks.txt:781
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:860
SpecialUndelete\getFileLink
getFileLink( $file, $titleObj, $ts, $key)
Fetch image view link if it's available to all users.
Definition: SpecialUndelete.php:1047
Title
Represents a title within MediaWiki.
Definition: Title.php:39
Xml\closeElement
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:118
SpecialUndelete\showFile
showFile( $key)
Show a deleted file version requested by the visitor.
Definition: SpecialUndelete.php:641
$path
$path
Definition: NoLocalSettings.php:26
$rev
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:1750
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
SpecialUndelete\__construct
__construct()
Definition: SpecialUndelete.php:53
Linker\revDeleteLink
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2071
Linker\commentBlock
static commentBlock( $comment, $title=null, $local=false, $wikiId=null)
Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty strin...
Definition: Linker.php:1445
NS_USER
const NS_USER
Definition: Defines.php:67
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2981
$batch
$batch
Definition: linkcache.txt:23
true
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:1965
File\DELETED_FILE
const DELETED_FILE
Definition: File.php:53
SpecialPage\checkReadOnly
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
Definition: SpecialPage.php:319
$t
$t
Definition: testCompression.php:67
SpecialUndelete\$mTarget
$mTarget
Definition: SpecialUndelete.php:34
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
SpecialUndelete\undelete
undelete()
Definition: SpecialUndelete.php:1117
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
SpecialUndelete\showFileConfirmationForm
showFileConfirmationForm( $key)
Show a form confirming whether a tokenless user really wants to see a file.
Definition: SpecialUndelete.php:613
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:51
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:583
ChangeTags\formatSummaryRow
static formatSummaryRow( $tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:53
Revision\DELETED_TEXT
const DELETED_TEXT
Definition: Revision.php:90
ArchivedFile\newFromRow
static newFromRow( $row)
Loads a file object from the filearchive table.
Definition: ArchivedFile.php:209
SpecialUndelete\loadRequest
loadRequest( $par)
Definition: SpecialUndelete.php:61
Xml\submitButton
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:781