Go to the documentation of this file.
57 parent::__construct(
'Undelete',
'deletedhistory' );
68 $this->mAction =
$request->getVal(
'action' );
69 if ( $par !==
null && $par !==
'' ) {
70 $this->mTarget = $par;
72 $this->mTarget =
$request->getVal(
'target' );
75 $this->mTargetObj =
null;
77 if ( $this->mTarget !==
null && $this->mTarget !==
'' ) {
81 $this->mSearchPrefix =
$request->getText(
'prefix' );
84 $this->mFilename =
$request->getVal(
'file' );
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' );
98 $block =
$user->getBlock();
99 if ( $this->
isAllowed(
'undelete' ) && !( $block && $block->isSitewide() ) ) {
100 $this->mAllowed =
true;
101 $this->mCanView =
true;
102 } elseif ( $this->
isAllowed(
'deletedtext' ) ) {
103 $this->mAllowed =
false;
104 $this->mCanView =
true;
105 $this->mRestore =
false;
107 $this->mAllowed =
false;
108 $this->mCanView =
false;
109 $this->mTimestamp =
'';
110 $this->mRestore =
false;
113 if ( $this->mRestore || $this->mInvert ) {
115 $this->mFileVersions = [];
116 foreach (
$request->getValues()
as $key => $val ) {
118 if ( preg_match(
'/^ts(\d{14})$/', $key,
$matches ) ) {
119 array_push( $timestamps,
$matches[1] );
122 if ( preg_match(
'/^fileid(\d+)$/', $key,
$matches ) ) {
123 $this->mFileVersions[] = intval(
$matches[1] );
126 rsort( $timestamps );
127 $this->mTargetTimestamp = $timestamps;
141 if ( $this->mTargetObj !==
null ) {
142 return $this->mTargetObj->userCan( $permission,
$user );
144 return $user->isAllowed( $permission );
165 if ( is_null( $this->mTargetObj ) ) {
166 $out->addWikiMsg(
'undelete-header' );
168 # Not all users can just browse every deleted page from the list
169 if (
$user->isAllowed(
'browsearchive' ) ) {
177 if ( $this->mAllowed ) {
178 $out->setPageTitle( $this->
msg(
'undeletepage' ) );
180 $out->setPageTitle( $this->
msg(
'viewdeletedpage' ) );
183 $this->
getSkin()->setRelevantTitle( $this->mTargetObj );
185 if ( $this->mTimestamp !==
'' ) {
187 } elseif ( $this->mFilename !==
null && $this->mTargetObj->inNamespace(
NS_FILE ) ) {
190 if ( !
$file->exists() ) {
191 $out->addWikiMsg(
'filedelete-nofile', $this->mFilename );
198 } elseif ( !
$user->matchEditToken( $this->mToken, $this->mFilename ) ) {
201 $this->
showFile( $this->mFilename );
203 } elseif ( $this->mAction ===
'submit' ) {
204 if ( $this->mRestore ) {
206 } elseif ( $this->mRevdel ) {
224 foreach ( $this->
getRequest()->getValues()
as $key => $val ) {
226 if ( preg_match(
"/^ts(\d{14})$/", $key,
$matches ) ) {
227 $revisions[$archive->getRevision(
$matches[1] )->getId()] = 1;
232 'type' =>
'revision',
234 'target' => $this->mTargetObj->getPrefixedText()
242 $out->setPageTitle( $this->
msg(
'undelete-search-title' ) );
243 $fuzzySearch = $this->
getRequest()->getVal(
'fuzzy',
true );
247 $fields[] =
new OOUI\ActionFieldLayout(
248 new OOUI\TextInputWidget( [
250 'inputId' =>
'prefix',
252 'value' => $this->mSearchPrefix,
255 new OOUI\ButtonInputWidget( [
256 'label' => $this->
msg(
'undelete-search-submit' )->
text(),
257 'flags' => [
'primary',
'progressive' ],
258 'inputId' =>
'searchUndelete',
262 'label' =>
new OOUI\HtmlSnippet(
264 $fuzzySearch ?
'undelete-search-full' :
'undelete-search-prefix'
271 $fieldset =
new OOUI\FieldsetLayout( [
272 'label' => $this->
msg(
'undelete-search-box' )->
text(),
276 $form =
new OOUI\FormLayout( [
281 $form->appendContent(
283 new OOUI\HtmlSnippet(
284 Html::hidden(
'title', $this->
getPageTitle()->getPrefixedDBkey() ) .
285 Html::hidden(
'fuzzy', $fuzzySearch )
290 new OOUI\PanelLayout( [
298 # List undeletable articles
299 if ( $this->mSearchPrefix ) {
302 if ( $fuzzySearch ) {
320 if (
$result->numRows() == 0 ) {
321 $out->addWikiMsg(
'undelete-no-results' );
330 $out->addHTML(
"<ul id='undeleteResultsList'>\n" );
336 $title->getPrefixedText(),
338 [
'target' =>
$title->getPrefixedText() ]
342 $item = Html::element(
344 [
'class' =>
'mw-invalidtitle' ],
352 $revs = $this->
msg(
'undeleterevisions' )->numParams( $row->count )->parse();
356 [
'class' =>
'undeleteResult' ],
362 $out->addHTML(
"</ul>\n" );
368 if ( !preg_match(
'/[0-9]{14}/', $timestamp ) ) {
373 if ( !
Hooks::run(
'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj ] ) ) {
376 $rev = $archive->getRevision( $timestamp );
382 $out->addWikiMsg(
'undeleterevision-missing' );
390 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
392 'rev-suppressed-text-permission' :
'rev-deleted-text-permission'
399 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
401 'rev-suppressed-text-view' :
'rev-deleted-text-view'
403 $out->addHTML(
'<br />' );
407 if ( $this->mDiff ) {
408 $previousRev = $archive->getPreviousRevision( $timestamp );
409 if ( $previousRev ) {
411 if ( $this->mDiffOnly ) {
415 $out->addHTML(
'<hr />' );
417 $out->addWikiMsg(
'undelete-nodiff' );
422 $this->
getPageTitle( $this->mTargetObj->getPrefixedDBkey() ),
423 $this->mTargetObj->getPrefixedText()
440 if ( $this->mPreview || $isText ) {
441 $openDiv =
'<div id="mw-undelete-revision" class="mw-warning">';
443 $openDiv =
'<div id="mw-undelete-revision">';
445 $out->addHTML( $openDiv );
448 if ( !$this->mDiff ) {
451 $out->addHTML(
"$revdel " );
458 Message::rawParam( $userLink ), $d,
$t
460 $out->addHTML(
'</div>' );
462 if ( !
Hooks::run(
'UndeleteShowRevision', [ $this->mTargetObj,
$rev ] ) ) {
466 if ( $this->mPreview || !$isText ) {
469 $popts =
$out->parserOptions();
470 $renderer = MediaWikiServices::getInstance()->getRevisionRenderer();
472 $rendered = $renderer->getRenderedRevision(
473 $rev->getRevisionRecord(),
476 [
'audience' => RevisionRecord::FOR_THIS_USER ]
481 $pout = $rendered->getRevisionParserOutput();
483 $out->addParserOutput( $pout, [
484 'enableSectionEditLinks' =>
false,
495 'readonly' =>
'readonly',
500 $buttonFields[] =
new OOUI\ButtonInputWidget( [
503 'label' => $this->
msg(
'showpreview' )->
text()
509 $buttonFields[] =
new OOUI\ButtonInputWidget( [
512 'label' => $this->
msg(
'showdiff' )->
text()
518 'style' =>
'clear: both' ] ) .
521 'action' => $this->
getPageTitle()->getLocalURL( [
'action' =>
'submit' ] ) ] ) .
525 'value' => $this->mTargetObj->getPrefixedDBkey() ] ) .
528 'name' =>
'timestamp',
529 'value' => $timestamp ] ) .
532 'name' =>
'wpEditToken',
533 'value' =>
$user->getEditToken() ] ) .
534 new OOUI\FieldLayout(
536 'content' =>
new OOUI\HorizontalLayout( [
537 'items' => $buttonFields
555 $diffContext->setTitle( $currentRev->getTitle() );
558 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
559 $diffEngine->setRevisions( $previousRev->getRevisionRecord(), $currentRev->getRevisionRecord() );
560 $diffEngine->showDiffStyle();
561 $formattedDiff = $diffEngine->getDiff(
566 $this->
getOutput()->addHTML(
"<div>$formattedDiff</div>\n" );
575 $isDeleted = !(
$rev->getId() &&
$rev->getTitle() );
580 'target' => $this->mTargetObj->getPrefixedText(),
585 $targetPage =
$rev->getTitle();
586 $targetQuery = [
'oldid' =>
$rev->getId() ];
603 [
'ct_rev_id' =>
$rev->getId() ],
607 $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
608 foreach ( $tagIds
as $tagId ) {
610 $tags[] = $changeTagDefStore->getName( (
int)$tagId );
615 $tags = implode(
',', $tags );
620 return '<div id="mw-diff-' . $prefix .
'title1"><strong>' .
633 '<div id="mw-diff-' . $prefix .
'title2">' .
636 '<div id="mw-diff-' . $prefix .
'title3">' .
639 '<div id="mw-diff-' . $prefix .
'title5">' .
640 $tagSummary[0] .
'<br />' .
653 $out->addWikiMsg(
'undelete-show-file-confirm',
654 $this->mTargetObj->getText(),
661 'target' => $this->mTarget,
663 'token' =>
$user->getEditToken( $key ),
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
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' );
689 $path = $repo->getZonePath(
'deleted' ) .
'/' . $repo->getDeletedHashPath( $key ) . $key;
690 $repo->streamFile(
$path );
697 if ( $this->mAllowed ) {
698 $out->addModules(
'mediawiki.special.undelete' );
701 "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
702 [
'undeletepagetitle',
wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) ]
706 Hooks::run(
'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj ] );
708 $out->addHTML(
'<div class="mw-undelete-history">' );
709 if ( $this->mAllowed ) {
710 $out->addWikiMsg(
'undeletehistory' );
711 $out->addWikiMsg(
'undeleterevdel' );
713 $out->addWikiMsg(
'undeletehistorynoadmin' );
715 $out->addHTML(
'</div>' );
717 # List all stored revisions
718 $revisions = $archive->listRevisions();
719 $files = $archive->listFiles();
721 $haveRevisions = $revisions && $revisions->numRows() > 0;
722 $haveFiles = $files && $files->numRows() > 0;
724 # Batch existence check on user and talk pages
725 if ( $haveRevisions ) {
727 foreach ( $revisions
as $row ) {
732 $revisions->seek( 0 );
736 foreach ( $files
as $row ) {
744 if ( $this->mAllowed ) {
747 $action = $this->
getPageTitle()->getLocalURL( [
'action' =>
'submit' ] );
748 # Start the form here
749 $form =
new OOUI\FormLayout( [
756 # Show relevant lines from the deletion log:
757 $deleteLogPage =
new LogPage(
'delete' );
758 $out->addHTML(
Xml::element(
'h2',
null, $deleteLogPage->getName()->text() ) .
"\n" );
760 # Show relevant lines from the suppression log:
761 $suppressLogPage =
new LogPage(
'suppress' );
763 $out->addHTML(
Xml::element(
'h2',
null, $suppressLogPage->getName()->text() ) .
"\n" );
767 if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
768 $fields[] =
new OOUI\Layout( [
769 'content' =>
new OOUI\HtmlSnippet( $this->
msg(
'undeleteextrahelp' )->parseAsBlock() )
772 $fields[] =
new OOUI\FieldLayout(
773 new OOUI\TextInputWidget( [
774 'name' =>
'wpComment',
775 'inputId' =>
'wpComment',
777 'value' => $this->mComment,
785 'label' => $this->
msg(
'undeletecomment' )->
text(),
790 $fields[] =
new OOUI\FieldLayout(
792 'content' =>
new OOUI\HorizontalLayout( [
794 new OOUI\ButtonInputWidget( [
796 'inputId' =>
'mw-undelete-submit',
798 'label' => $this->
msg(
'undeletebtn' )->
text(),
799 'flags' => [
'primary',
'progressive' ],
802 new OOUI\ButtonInputWidget( [
804 'inputId' =>
'mw-undelete-invert',
806 'label' => $this->
msg(
'undeleteinvert' )->
text()
814 $fields[] =
new OOUI\FieldLayout(
815 new OOUI\CheckboxInputWidget( [
816 'name' =>
'wpUnsuppress',
817 'inputId' =>
'mw-undelete-unsuppress',
821 'label' => $this->
msg(
'revdelete-unsuppress' )->
text(),
827 $fieldset =
new OOUI\FieldsetLayout( [
828 'label' => $this->
msg(
'undelete-fieldset-title' )->
text(),
829 'id' =>
'mw-undelete-table',
833 $form->appendContent(
834 new OOUI\PanelLayout( [
838 'content' => $fieldset,
840 new OOUI\HtmlSnippet(
841 Html::hidden(
'target', $this->mTarget ) .
842 Html::hidden(
'wpEditToken', $this->
getUser()->getEditToken() )
850 if ( $haveRevisions ) {
851 # Show the page's stored (deleted) history
854 $history .= Html::element(
859 'class' =>
'deleterevision-log-submit mw-log-deleterevision-button'
861 $this->
msg(
'showhideselectedversions' )->
text()
865 $history .=
'<ul class="mw-undelete-revlist">';
866 $remaining = $revisions->numRows();
867 $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
869 foreach ( $revisions
as $row ) {
876 $out->addWikiMsg(
'nohistory' );
881 $history .=
'<ul class="mw-undelete-revlist">';
882 foreach ( $files
as $row ) {
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() );
895 $form->appendContent(
new OOUI\HtmlSnippet( $history ) );
896 $out->addHTML( $form );
898 $out->addHTML( $history );
907 'title' => $this->mTargetObj
913 if ( $this->mAllowed ) {
914 if ( $this->mInvert ) {
915 if ( in_array( $ts, $this->mTargetTimestamp ) ) {
929 if ( $this->mCanView ) {
933 $pageLink = htmlspecialchars( $this->
getLanguage()->userTimeAndDate( $ts,
$user ) );
934 $last = $this->
msg(
'diff' )->escaped();
935 } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
942 'target' => $this->mTargetObj->getPrefixedText(),
949 $last = $this->
msg(
'diff' )->escaped();
952 $pageLink = htmlspecialchars( $this->
getLanguage()->userTimeAndDate( $ts,
$user ) );
953 $last = $this->
msg(
'diff' )->escaped();
963 $size = $row->ar_len;
964 if ( !is_null( $size ) ) {
979 $attribs[
'class'] = implode(
' ', $classes );
982 $revisionRow = $this->
msg(
'undelete-revision-row2' )
1004 if ( $this->mCanView && $row->fa_storage_key ) {
1005 if ( $this->mAllowed ) {
1006 $checkBox =
Xml::check(
'fileid' . $row->fa_id );
1008 $key = urlencode( $row->fa_storage_key );
1011 $pageLink = htmlspecialchars( $this->
getLanguage()->userTimeAndDate( $ts,
$user ) );
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() )
1018 $data = htmlspecialchars(
$data .
' ' . $bytes );
1022 $canHide = $this->
isAllowed(
'deleterevision' );
1023 if ( $canHide || (
$file->getVisibility() && $this->
isAllowed(
'deletedhistory' ) ) ) {
1029 'type' =>
'filearchive',
1030 'target' => $this->mTargetObj->getPrefixedDBkey(),
1031 'ids' => $row->fa_id
1040 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1056 return '<span class="history-deleted">' .
$time .
'</span>';
1064 'target' => $this->mTargetObj->getPrefixedText(),
1070 $link =
'<span class="history-deleted">' .
$link .
'</span>';
1091 return '<span class="history-deleted">' . htmlspecialchars(
$time ) .
'</span>';
1099 'target' => $this->mTargetObj->getPrefixedText(),
1101 'token' =>
$user->getEditToken( $key )
1106 $link =
'<span class="history-deleted">' .
$link .
'</span>';
1120 return '<span class="history-deleted">' .
1121 $this->
msg(
'rev-deleted-user' )->escaped() .
1129 $link =
'<span class="history-deleted">' .
$link .
'</span>';
1143 return '<span class="history-deleted"><span class="comment">' .
1144 $this->
msg(
'rev-deleted-comment' )->escaped() .
'</span></span>';
1150 $link =
'<span class="history-deleted">' .
$link .
'</span>';
1157 if ( $this->
getConfig()->
get(
'UploadMaintenance' )
1158 && $this->mTargetObj->getNamespace() ==
NS_FILE
1160 throw new ErrorPageError(
'undelete-error',
'filedelete-maintenance' );
1167 Hooks::run(
'UndeleteForm::undelete', [ &$archive, $this->mTargetObj ] );
1168 $ok = $archive->undelete(
1169 $this->mTargetTimestamp,
1171 $this->mFileVersions,
1176 if ( is_array( $ok ) ) {
1179 $this->mTargetObj, $this->mFileVersions,
1180 $this->
getUser(), $this->mComment ] );
1184 $out->addWikiMsg(
'undeletedpage', Message::rawParam(
$link ) );
1186 $out->setPageTitle( $this->
msg(
'undelete-error' ) );
1190 $status = $archive->getRevisionStatus();
1192 $out->wrapWikiTextAsInterface(
1194 '<div id="mw-error-cannotundelete">' .
1203 $status = $archive->getFileStatus();
1205 $out->wrapWikiTextAsInterface(
1208 'undelete-error-short',
1209 'undelete-error-long'
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
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
getPageTitle( $subpage=false)
Get a self-referential title object.
formatRevisionRow( $row, $earliestLiveTime, $remaining)
return true to allow those checks to and false if checking is done & $user
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
diffHeader( $rev, $prefix)
showDiff( $previousRev, $currentRev)
Build a diff display between this and the previous either deleted or non-deleted edit.
static singleton()
Get a RepoGroup instance.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
msg( $key)
Wrapper around wfMessage that sets the current context.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Used to show archived pages and eventually restore them.
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
getOutput()
Get the OutputPage being used for this instance.
if(!isset( $args[0])) $lang
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Special page allowing users with the appropriate permissions to view and restore deleted content.
isAllowed( $permission, User $user=null)
Checks whether a user is allowed the permission for the specific title if one is set.
getPageLink( $rev, $titleObj, $ts)
Fetch revision text link if it's available to all users.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
execute( $par)
Default execute method Checks user permissions.
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null, $useParentheses=true)
Generate standard user tool links (talk, contributions, block link, etc.)
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
showRevision( $timestamp)
showList( $result)
Generic list of deleted pages.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
static listPagesByPrefix( $prefix)
List deleted pages recorded in the archive table matching the given title prefix.
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.
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,...
getSkin()
Shortcut to get the skin being used for this instance.
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Show an error when a user tries to do something they do not have the necessary permissions for.
getLanguage()
Shortcut to get user's language.
static getInvalidTitleDescription(IContextSource $context, $namespace, $title)
Get a message saying that an invalid title was encountered.
getFileUser( $file)
Fetch file's user id if it's available to this user.
static listPagesBySearch( $term)
List deleted pages recorded in the archive matching the given term, using search engine archive.
static openElement( $element, $attribs=null)
This opens an XML element.
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
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
prefixSearchString( $search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
getConfig()
Shortcut to get main config object.
namespace and then decline to actually register it file or subcat img or subcat $title
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
redirectToRevDel()
Convert submitted form data to format expected by RevisionDelete and redirect the request.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
userCanExecute(User $user)
Checks if the given user (identified by an object) can execute this special page (as defined by $mRes...
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
doesWrites()
Indicates whether this special page may perform database writes.
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
Class to simplify the use of log pages.
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
static flag( $flag, IContextSource $context=null)
Make an "<abbr>" element for a given change flag.
static revDeleteLinkDisabled( $delete=true)
Creates a dead (show/hide) link for deleting revisions/log entries.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getUser()
Shortcut to get the User executing this instance.
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
static revUserTools( $rev, $isPublic=false, $useParentheses=true)
Generate a user tool link cluster if the current user is allowed to view it.
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
getContext()
Gets the context this SpecialPage is executed in.
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
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
string $mSearchPrefix
Search prefix.
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...
Class representing a row of the 'filearchive' table.
Parent class for all special pages.
static getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
getRequest()
Get the WebRequest being used for this instance.
static formatRevisionSize( $size)
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
getFileComment( $file)
Fetch file upload comment if it's available to this user.
Content object implementation for representing flat text.
this hook is for auditing only $response
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
getFileLink( $file, $titleObj, $ts, $key)
Fetch image view link if it's available to all users.
Represents a title within MediaWiki.
static closeElement( $element)
Shortcut to close an XML element.
showFile( $key)
Show a deleted file version requested by the visitor.
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
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
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
see documentation in includes Linker php for Linker::makeImageLink & $time
MediaWiki Linker LinkRenderer null $linkRenderer
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
showFileConfirmationForm( $key)
Show a form confirming whether a tokenless user really wants to see a file.
An error page which can definitely be safely rendered using the OutputPage.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
static newFromRow( $row)
Loads a file object from the filearchive table.
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...