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