Go to the documentation of this file.
55 parent::__construct(
'Undelete',
'deletedhistory' );
66 $this->mAction =
$request->getVal(
'action' );
67 if ( $par !==
null && $par !==
'' ) {
68 $this->mTarget = $par;
70 $this->mTarget =
$request->getVal(
'target' );
73 $this->mTargetObj =
null;
75 if ( $this->mTarget !==
null && $this->mTarget !==
'' ) {
79 $this->mSearchPrefix =
$request->getText(
'prefix' );
82 $this->mFilename =
$request->getVal(
'file' );
86 $this->mRestore =
$request->getCheck(
'restore' ) && $posted;
87 $this->mRevdel =
$request->getCheck(
'revdel' ) && $posted;
88 $this->mInvert =
$request->getCheck(
'invert' ) && $posted;
89 $this->mPreview =
$request->getCheck(
'preview' ) && $posted;
90 $this->mDiff =
$request->getCheck(
'diff' );
91 $this->mDiffOnly =
$request->getBool(
'diffonly', $this->
getUser()->getOption(
'diffonly' ) );
92 $this->mComment =
$request->getText(
'wpComment' );
93 $this->mUnsuppress =
$request->getVal(
'wpUnsuppress' ) &&
$user->isAllowed(
'suppressrevision' );
94 $this->mToken =
$request->getVal(
'token' );
97 $this->mAllowed =
true;
98 $this->mCanView =
true;
99 } elseif ( $this->
isAllowed(
'deletedtext' ) ) {
100 $this->mAllowed =
false;
101 $this->mCanView =
true;
102 $this->mRestore =
false;
104 $this->mAllowed =
false;
105 $this->mCanView =
false;
106 $this->mTimestamp =
'';
107 $this->mRestore =
false;
110 if ( $this->mRestore || $this->mInvert ) {
112 $this->mFileVersions = [];
113 foreach (
$request->getValues()
as $key => $val ) {
115 if ( preg_match(
'/^ts(\d{14})$/', $key,
$matches ) ) {
116 array_push( $timestamps,
$matches[1] );
119 if ( preg_match(
'/^fileid(\d+)$/', $key,
$matches ) ) {
120 $this->mFileVersions[] = intval(
$matches[1] );
123 rsort( $timestamps );
124 $this->mTargetTimestamp = $timestamps;
138 if ( $this->mTargetObj !==
null ) {
139 return $this->mTargetObj->userCan( $permission,
$user );
141 return $user->isAllowed( $permission );
162 if ( is_null( $this->mTargetObj ) ) {
163 $out->addWikiMsg(
'undelete-header' );
165 # Not all users can just browse every deleted page from the list
166 if (
$user->isAllowed(
'browsearchive' ) ) {
174 if ( $this->mAllowed ) {
175 $out->setPageTitle( $this->
msg(
'undeletepage' ) );
177 $out->setPageTitle( $this->
msg(
'viewdeletedpage' ) );
180 $this->
getSkin()->setRelevantTitle( $this->mTargetObj );
182 if ( $this->mTimestamp !==
'' ) {
184 } elseif ( $this->mFilename !==
null && $this->mTargetObj->inNamespace(
NS_FILE ) ) {
185 $file =
new ArchivedFile( $this->mTargetObj,
'', $this->mFilename );
187 if ( !$file->exists() ) {
188 $out->addWikiMsg(
'filedelete-nofile', $this->mFilename );
195 } elseif ( !
$user->matchEditToken( $this->mToken, $this->mFilename ) ) {
198 $this->
showFile( $this->mFilename );
200 } elseif ( $this->mAction ===
"submit" ) {
201 if ( $this->mRestore ) {
203 } elseif ( $this->mRevdel ) {
221 foreach ( $this->
getRequest()->getValues()
as $key => $val ) {
223 if ( preg_match(
"/^ts(\d{14})$/", $key,
$matches ) ) {
224 $revisions[ $archive->getRevision(
$matches[1] )->getId() ] = 1;
228 "type" =>
"revision",
230 "target" => $this->mTargetObj->getPrefixedText()
238 $out->setPageTitle( $this->
msg(
'undelete-search-title' ) );
246 [
'for' =>
'prefix' ],
247 $this->
msg(
'undelete-search-prefix' )->parse()
252 $this->mSearchPrefix,
253 [
'id' =>
'prefix',
'autofocus' =>
'' ]
257 $this->
msg(
'undelete-search-submit' )->
text(),
258 [
'id' =>
'searchUndelete' ]
264 # List undeletable articles
265 if ( $this->mSearchPrefix ) {
268 if ( $this->
getRequest()->getVal(
"fuzzy",
false ) ) {
286 if (
$result->numRows() == 0 ) {
287 $out->addWikiMsg(
'undelete-no-results' );
296 $out->addHTML(
"<ul id='undeleteResultsList'>\n" );
302 $title->getPrefixedText(),
304 [
'target' =>
$title->getPrefixedText() ]
310 [
'class' =>
'mw-invalidtitle' ],
318 $revs = $this->
msg(
'undeleterevisions' )->numParams( $row->count )->parse();
319 $out->addHTML(
"<li class='undeleteResult'>{$item} ({$revs})</li>\n" );
322 $out->addHTML(
"</ul>\n" );
328 if ( !preg_match(
'/[0-9]{14}/', $timestamp ) ) {
333 if ( !
Hooks::run(
'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj ] ) ) {
336 $rev = $archive->getRevision( $timestamp );
342 $out->addWikiMsg(
'undeleterevision-missing' );
350 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
352 'rev-suppressed-text-permission' :
'rev-deleted-text-permission'
359 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
361 'rev-suppressed-text-view' :
'rev-deleted-text-view'
363 $out->addHTML(
'<br />' );
367 if ( $this->mDiff ) {
368 $previousRev = $archive->getPreviousRevision( $timestamp );
369 if ( $previousRev ) {
371 if ( $this->mDiffOnly ) {
375 $out->addHTML(
'<hr />' );
377 $out->addWikiMsg(
'undelete-nodiff' );
382 $this->
getPageTitle( $this->mTargetObj->getPrefixedDBkey() ),
383 $this->mTargetObj->getPrefixedText()
399 if ( $this->mPreview || $isText ) {
400 $openDiv =
'<div id="mw-undelete-revision" class="mw-warning">';
402 $openDiv =
'<div id="mw-undelete-revision">';
404 $out->addHTML( $openDiv );
407 if ( !$this->mDiff ) {
410 $out->addHTML(
"$revdel " );
414 $out->addHTML( $this->
msg(
'undelete-revision' )->rawParams(
$link )->params(
415 $time )->rawParams( $userLink )->params( $d,
$t )->parse() .
'</div>' );
417 if ( !
Hooks::run(
'UndeleteShowRevision', [ $this->mTargetObj,
$rev ] ) ) {
421 if ( ( $this->mPreview || !$isText ) &&
$content ) {
425 $popts =
$out->parserOptions();
426 $popts->setEditSection(
false );
428 $pout =
$content->getParserOutput( $this->mTargetObj,
$rev->getId(), $popts,
true );
429 $out->addParserOutput( $pout );
437 'readonly' =>
'readonly',
447 'value' => $this->
msg(
'showpreview' )->
text()
457 'value' => $this->
msg(
'showdiff' )->
text() ] );
462 'style' =>
'clear: both' ] ) .
465 'action' => $this->
getPageTitle()->getLocalURL( [
'action' =>
'submit' ] ) ] ) .
469 'value' => $this->mTargetObj->getPrefixedDBkey() ] ) .
472 'name' =>
'timestamp',
473 'value' => $timestamp ] ) .
476 'name' =>
'wpEditToken',
477 'value' =>
$user->getEditToken() ] ) .
495 $diffContext->setTitle( $currentRev->getTitle() );
498 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
499 $diffEngine->showDiffStyle();
501 $formattedDiff = $diffEngine->generateContentDiffBody(
506 $formattedDiff = $diffEngine->addHeader(
512 $this->
getOutput()->addHTML(
"<div>$formattedDiff</div>\n" );
521 $isDeleted = !(
$rev->getId() &&
$rev->getTitle() );
526 'target' => $this->mTargetObj->getPrefixedText(),
531 $targetPage =
$rev->getTitle();
532 $targetQuery = [
'oldid' =>
$rev->getId() ];
549 [
'ts_rev_id' =>
$rev->getId() ],
556 return '<div id="mw-diff-' . $prefix .
'title1"><strong>' .
569 '<div id="mw-diff-' . $prefix .
'title2">' .
572 '<div id="mw-diff-' . $prefix .
'title3">' .
575 '<div id="mw-diff-' . $prefix .
'title5">' .
576 $tagSummary[0] .
'<br />' .
588 $file =
new ArchivedFile( $this->mTargetObj,
'', $this->mFilename );
589 $out->addWikiMsg(
'undelete-show-file-confirm',
590 $this->mTargetObj->getText(),
591 $lang->userDate( $file->getTimestamp(),
$user ),
592 $lang->userTime( $file->getTimestamp(),
$user ) );
597 'target' => $this->mTarget,
599 'token' =>
$user->getEditToken( $key ),
615 # We mustn't allow the output to be CDN cached, otherwise
616 # if an admin previews a deleted image, and it's cached, then
617 # a user without appropriate permissions can toddle off and
618 # nab the image, and CDN will serve it
620 $response->header(
'Expires: ' . gmdate(
'D, d M Y H:i:s', 0 ) .
' GMT' );
621 $response->header(
'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
625 $path = $repo->getZonePath(
'deleted' ) .
'/' . $repo->getDeletedHashPath( $key ) . $key;
626 $repo->streamFile(
$path );
633 if ( $this->mAllowed ) {
634 $out->addModules(
'mediawiki.special.undelete' );
637 "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
638 [
'undeletepagetitle',
wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) ]
642 Hooks::run(
'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj ] );
650 $out->addHTML(
'<div class="mw-undelete-history">' );
651 if ( $this->mAllowed ) {
652 $out->addWikiMsg(
'undeletehistory' );
653 $out->addWikiMsg(
'undeleterevdel' );
655 $out->addWikiMsg(
'undeletehistorynoadmin' );
657 $out->addHTML(
'</div>' );
659 # List all stored revisions
660 $revisions = $archive->listRevisions();
661 $files = $archive->listFiles();
663 $haveRevisions = $revisions && $revisions->numRows() > 0;
664 $haveFiles = $files && $files->numRows() > 0;
666 # Batch existence check on user and talk pages
667 if ( $haveRevisions ) {
669 foreach ( $revisions
as $row ) {
674 $revisions->seek( 0 );
678 foreach ( $files
as $row ) {
686 if ( $this->mAllowed ) {
687 $action = $this->
getPageTitle()->getLocalURL( [
'action' =>
'submit' ] );
688 # Start the form here
691 [
'method' =>
'post',
'action' => $action,
'id' =>
'undelete' ]
693 $out->addHTML( $top );
696 # Show relevant lines from the deletion log:
697 $deleteLogPage =
new LogPage(
'delete' );
698 $out->addHTML(
Xml::element(
'h2',
null, $deleteLogPage->getName()->text() ) .
"\n" );
700 # Show relevant lines from the suppression log:
701 $suppressLogPage =
new LogPage(
'suppress' );
703 $out->addHTML(
Xml::element(
'h2',
null, $suppressLogPage->getName()->text() ) .
"\n" );
707 if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
708 # Format the user-visible controls (comment field, submission button)
709 # in a nice little table
714 <td class='mw-input'>" .
716 'wpUnsuppress',
'mw-undelete-unsuppress', $this->mUnsuppress ) .
726 <td colspan='2' class='mw-undelete-extrahelp'>" .
727 $this->
msg(
'undeleteextrahelp' )->parseAsBlock() .
731 <td class='mw-label'>" .
734 <td class='mw-input'>" .
739 [
'id' =>
'wpComment',
'autofocus' =>
'' ]
745 <td class='mw-submit'>" .
747 $this->
msg(
'undeletebtn' )->
text(),
748 [
'name' =>
'restore',
'id' =>
'mw-undelete-submit' ]
751 $this->
msg(
'undeleteinvert' )->
text(),
752 [
'name' =>
'invert',
'id' =>
'mw-undelete-invert' ]
760 $out->addHTML( $table );
765 if ( $haveRevisions ) {
766 # Show the page's stored (deleted) history
774 'class' =>
'deleterevision-log-submit mw-log-deleterevision-button'
776 $this->
msg(
'showhideselectedversions' )->
text()
780 $out->addHTML(
'<ul>' );
781 $remaining = $revisions->numRows();
782 $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
784 foreach ( $revisions
as $row ) {
789 $out->addHTML(
'</ul>' );
791 $out->addWikiMsg(
'nohistory' );
796 $out->addHTML(
'<ul>' );
797 foreach ( $files
as $row ) {
801 $out->addHTML(
'</ul>' );
804 if ( $this->mAllowed ) {
805 # Slip in the hidden controls here
809 $out->addHTML( $misc );
818 'title' => $this->mTargetObj
824 if ( $this->mAllowed ) {
825 if ( $this->mInvert ) {
826 if ( in_array( $ts, $this->mTargetTimestamp ) ) {
840 if ( $this->mCanView ) {
844 $pageLink = htmlspecialchars( $this->
getLanguage()->userTimeAndDate( $ts,
$user ) );
845 $last = $this->
msg(
'diff' )->escaped();
846 } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
853 'target' => $this->mTargetObj->getPrefixedText(),
860 $last = $this->
msg(
'diff' )->escaped();
863 $pageLink = htmlspecialchars( $this->
getLanguage()->userTimeAndDate( $ts,
$user ) );
864 $last = $this->
msg(
'diff' )->escaped();
874 $size = $row->ar_len;
875 if ( !is_null( $size ) ) {
890 $attribs[
'class'] = implode(
' ', $classes );
893 $revisionRow = $this->
msg(
'undelete-revision-row2' )
915 if ( $this->mCanView && $row->fa_storage_key ) {
916 if ( $this->mAllowed ) {
917 $checkBox =
Xml::check(
'fileid' . $row->fa_id );
919 $key = urlencode( $row->fa_storage_key );
925 $data = $this->
msg(
'widthheight' )->numParams( $row->fa_width, $row->fa_height )->text();
926 $bytes = $this->
msg(
'parentheses' )
927 ->rawParams( $this->
msg(
'nbytes' )->numParams( $row->fa_size )->text() )
929 $data = htmlspecialchars( $data .
' ' . $bytes );
933 $canHide = $this->
isAllowed(
'deleterevision' );
934 if ( $canHide || ( $file->getVisibility() && $this->
isAllowed(
'deletedhistory' ) ) ) {
940 'type' =>
'filearchive',
941 'target' => $this->mTargetObj->getPrefixedDBkey(),
951 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
967 return '<span class="history-deleted">' .
$time .
'</span>';
975 'target' => $this->mTargetObj->getPrefixedText(),
981 $link =
'<span class="history-deleted">' .
$link .
'</span>';
1002 return '<span class="history-deleted">' .
$time .
'</span>';
1010 'target' => $this->mTargetObj->getPrefixedText(),
1012 'token' =>
$user->getEditToken( $key )
1017 $link =
'<span class="history-deleted">' .
$link .
'</span>';
1031 return '<span class="history-deleted">' .
1032 $this->
msg(
'rev-deleted-user' )->escaped() .
1040 $link =
'<span class="history-deleted">' .
$link .
'</span>';
1054 return '<span class="history-deleted"><span class="comment">' .
1055 $this->
msg(
'rev-deleted-comment' )->escaped() .
'</span></span>';
1061 $link =
'<span class="history-deleted">' .
$link .
'</span>';
1068 if ( $this->
getConfig()->
get(
'UploadMaintenance' )
1069 && $this->mTargetObj->getNamespace() ==
NS_FILE
1071 throw new ErrorPageError(
'undelete-error',
'filedelete-maintenance' );
1078 Hooks::run(
'UndeleteForm::undelete', [ &$archive, $this->mTargetObj ] );
1079 $ok = $archive->undelete(
1080 $this->mTargetTimestamp,
1082 $this->mFileVersions,
1087 if ( is_array( $ok ) ) {
1090 $this->mTargetObj, $this->mFileVersions,
1091 $this->
getUser(), $this->mComment ] );
1095 $out->addHTML( $this->
msg(
'undeletedpage' )->rawParams(
$link )->parse() );
1097 $out->setPageTitle( $this->
msg(
'undelete-error' ) );
1101 $status = $archive->getRevisionStatus();
1104 "<div class=\"error\" id=\"mw-error-cannotundelete\">\n$1\n</div>",
1110 $status = $archive->getFileStatus();
1112 $out->addWikiText(
'<div class="error">' .
1114 'undelete-error-short',
1115 'undelete-error-long'
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
getPageTitle( $subpage=false)
Get a self-referential title object.
formatRevisionRow( $row, $earliestLiveTime, $remaining)
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.
error also a ContextSource you ll probably need to make sure the header is varied on $request
static singleton()
Get a RepoGroup instance.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
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...
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
Special page allowing users with the appropriate permissions to view and restore deleted content.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
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 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
execute( $par)
Default execute method Checks user permissions.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
showRevision( $timestamp)
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
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
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 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
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
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
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...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
static revUserTools( $rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
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.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired 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 inclusive $limit
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
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.
see documentation in includes Linker php for Linker::makeImageLink & $time
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
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.
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
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.
static revComment(Revision $rev, $local=false, $isPublic=false)
Wrap and format the given revision's comment block, if the current user is allowed to view it.
string $mSearchPrefix
Search prefix.
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
msg()
Wrapper around wfMessage that sets the current context.
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...
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
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 rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
static commentBlock( $comment, $title=null, $local=false, $wikiId=null)
Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty strin...
usually copyright or history_copyright This message must be in HTML not wikitext & $link
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
MediaWiki Linker LinkRenderer null $linkRenderer
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like 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 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 ...
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out