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