Go to the documentation of this file.
72 'check-label' =>
'revdelete-hide-text',
73 'success' =>
'revdelete-success',
74 'failure' =>
'revdelete-failure',
75 'text' =>
'revdelete-text-text',
76 'selected'=>
'revdelete-selected-text',
79 'check-label' =>
'revdelete-hide-text',
80 'success' =>
'revdelete-success',
81 'failure' =>
'revdelete-failure',
82 'text' =>
'revdelete-text-text',
83 'selected'=>
'revdelete-selected-text',
86 'check-label' =>
'revdelete-hide-image',
87 'success' =>
'revdelete-success',
88 'failure' =>
'revdelete-failure',
89 'text' =>
'revdelete-text-file',
90 'selected'=>
'revdelete-selected-file',
93 'check-label' =>
'revdelete-hide-image',
94 'success' =>
'revdelete-success',
95 'failure' =>
'revdelete-failure',
96 'text' =>
'revdelete-text-file',
97 'selected'=>
'revdelete-selected-file',
100 'check-label' =>
'revdelete-hide-name',
101 'success' =>
'logdelete-success',
102 'failure' =>
'logdelete-failure',
103 'text' =>
'logdelete-text',
104 'selected' =>
'logdelete-selected',
109 parent::__construct(
'Revisiondelete',
'deleterevision' );
126 if (
$user->isBlocked() ) {
133 $this->submitClicked =
$request->wasPosted() &&
$request->getBool(
'wpSubmit' );
134 # Handle our many different possible input types.
136 if ( !is_null(
$ids ) ) {
137 # Allow CSV, for backwards compatibility, or a single ID for show/hide links
138 $this->ids = explode(
',',
$ids );
141 $this->ids = array_keys(
$request->getArray(
'ids', [] ) );
144 $this->ids = array_unique( array_filter( $this->ids ) );
146 $this->typeName =
$request->getVal(
'type' );
149 # For reviewing deleted files...
150 $this->archiveName =
$request->getVal(
'file' );
151 $this->token =
$request->getVal(
'token' );
152 if ( $this->archiveName && $this->targetObj ) {
161 if ( !$this->typeName ||
count( $this->ids ) == 0 ) {
162 throw new ErrorPageError(
'revdelete-nooldid-title',
'revdelete-nooldid-text' );
165 # Allow the list type to adjust the passed target
172 # We need a target page!
173 if ( $this->targetObj ===
null ) {
174 $output->addWikiMsg(
'undelete-header' );
183 $canViewSuppressedOnly = $this->
getUser()->isAllowed(
'viewsuppressed' ) &&
184 !$this->
getUser()->isAllowed(
'suppressrevision' );
185 $pageIsSuppressed = $list->areAnySuppressed();
186 $this->mIsAllowed = $this->mIsAllowed && !( $canViewSuppressedOnly && $pageIsSuppressed );
188 $this->otherReason =
$request->getVal(
'wpReason' );
189 # Give a link to the logs/hist for this page
192 # Initialise checkboxes
194 # Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name
195 [ $this->typeLabels[
'check-label'],
'wpHidePrimary',
201 if (
$user->isAllowed(
'suppressrevision' ) ) {
202 $this->checks[] = [
'revdelete-hide-restricted',
206 # Either submit or create our form
207 if ( $this->mIsAllowed && $this->submitClicked ) {
213 if (
$user->isAllowed(
'deletedhistory' ) ) {
215 # Show relevant lines from the deletion log
216 $deleteLogPage =
new LogPage(
'delete' );
217 $output->addHTML(
"<h2>" . $deleteLogPage->getName()->escaped() .
"</h2>\n" );
223 [
'lim' => 25,
'conds' => $qc,
'useMaster' => $this->wasSaved ]
226 # Show relevant lines from the suppression log
227 if (
$user->isAllowed(
'suppressionlog' ) ) {
228 $suppressLogPage =
new LogPage(
'suppress' );
229 $output->addHTML(
"<h2>" . $suppressLogPage->getName()->escaped() .
"</h2>\n" );
235 [
'lim' => 25,
'conds' => $qc,
'useMaster' => $this->wasSaved ]
245 # Give a link to the logs/hist for this page
246 if ( $this->targetObj ) {
248 $this->
getSkin()->setRelevantTitle( $this->targetObj );
253 $this->
msg(
'viewpagelogs' )->
text(),
255 [
'page' => $this->targetObj->getPrefixedText() ]
257 if ( !$this->targetObj->isSpecialPage() ) {
258 # Give a link to the page history
261 $this->
msg(
'pagehist' )->
text(),
263 [
'action' =>
'history' ]
265 # Link to deleted edits
266 if ( $this->
getUser()->isAllowed(
'undelete' ) ) {
270 $this->
msg(
'deletedhist' )->
text(),
272 [
'target' => $this->targetObj->getPrefixedDBkey() ]
276 # Logs themselves don't have histories or archived revisions
288 $conds[
'log_type'] = [
'delete',
'suppress' ];
289 $conds[
'log_action'] = $this->
getList()->getLogAction();
305 $oimage = $repo->newFromArchiveName( $this->targetObj,
$archiveName );
308 if ( !$oimage->exists() ) {
309 $this->
getOutput()->addWikiMsg(
'revdelete-no-file' );
323 $this->
getOutput()->addWikiMsg(
'revdelete-show-file-confirm',
324 $this->targetObj->getText(),
325 $lang->userDate( $oimage->getTimestamp(),
$user ),
326 $lang->userTime( $oimage->getTimestamp(),
$user ) );
331 'target' => $this->targetObj->getPrefixedDBkey(),
344 # We mustn't allow the output to be CDN cached, otherwise
345 # if an admin previews a deleted image, and it's cached, then
346 # a user without appropriate permissions can toddle off and
347 # nab the image, and CDN will serve it
348 $this->
getRequest()->response()->header(
'Expires: ' . gmdate(
'D, d M Y H:i:s', 0 ) .
' GMT' );
350 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate'
352 $this->
getRequest()->response()->header(
'Pragma: no-cache' );
354 $key = $oimage->getStorageKey();
355 $path = $repo->getZonePath(
'deleted' ) .
'/' . $repo->getDeletedHashPath( $key ) . $key;
356 $repo->streamFile(
$path );
364 if ( is_null( $this->revDelList ) ) {
366 $this->typeName, $this->
getContext(), $this->targetObj, $this->ids
382 $out->wrapWikiMsg(
"<strong>$1</strong>", [ $this->typeLabels[
'selected'],
383 $this->
getLanguage()->formatNum(
count( $this->ids ) ), $this->targetObj->getPrefixedText() ] );
386 $out->addHTML(
"<ul>" );
392 for ( $list->reset(); $list->current(); $list->next() ) {
394 $item = $list->current();
396 if ( !$item->canView() ) {
397 if ( !$this->submitClicked ) {
400 $userAllowed =
false;
404 $out->addHTML( $item->getHTML() );
407 if ( !$numRevisions ) {
408 throw new ErrorPageError(
'revdelete-nooldid-title',
'revdelete-nooldid-text' );
411 $out->addHTML(
"</ul>" );
416 if ( !$userAllowed ) {
421 if ( $this->mIsAllowed ) {
422 $out->addModuleStyles(
'mediawiki.special' );
425 'action' => $this->
getPageTitle()->getLocalURL( [
'action' =>
'submit' ] ),
426 'id' =>
'mw-revdel-form-revisions' ] ) .
431 '<td class="mw-label">' .
434 '<td class="mw-input">' .
436 $this->
msg(
'revdelete-reason-dropdown' )->inContentLanguage()->
text(),
437 $this->
msg(
'revdelete-reasonotherlist' )->inContentLanguage()->
text(),
438 $this->
getRequest()->getText(
'wpRevDeleteReasonList',
'other' ),
'wpReasonDropDown'
442 '<td class="mw-label">' .
445 '<td class="mw-input">' .
450 [
'id' =>
'wpReason',
'maxlength' => 100 ]
455 '<td class="mw-submit">' .
457 [
'name' =>
'wpSubmit' ] ) .
462 Html::hidden(
'target', $this->targetObj->getPrefixedText() ) .
468 if ( $this->
getUser()->isAllowed(
'editinterface' ) ) {
470 $this->
msg(
'revdelete-reason-dropdown' )->inContentLanguage()->
getTitle(),
471 $this->
msg(
'revdelete-edit-reasonlist' )->
text(),
473 [
'action' =>
'edit' ]
475 $form .=
Xml::tags(
'p', [
'class' =>
'mw-revdel-editreasons' ],
$link ) .
"\n";
480 $out->addHTML( $form );
490 "<strong>$1</strong>\n$2", $this->typeLabels[
'text'],
491 'revdelete-text-others'
494 if ( $this->
getUser()->isAllowed(
'suppressrevision' ) ) {
495 $this->
getOutput()->addWikiMsg(
'revdelete-suppress-text' );
498 if ( $this->mIsAllowed ) {
499 $this->
getOutput()->addWikiMsg(
'revdelete-confirm' );
510 if ( $list->length() == 1 ) {
512 $bitfield = $list->current()->getBits();
514 if ( $this->submitClicked ) {
518 foreach ( $this->checks
as $item ) {
523 $this->
msg( $message )->
text(),
530 $innerHTML =
"<b>$innerHTML</b>";
534 $html .=
"<tr>$line</tr>\n";
539 $html .=
'<th class="mw-revdel-checkbox">'
540 . $this->
msg(
'revdelete-radio-same' )->escaped() .
'</th>';
541 $html .=
'<th class="mw-revdel-checkbox">'
542 . $this->
msg(
'revdelete-radio-unset' )->escaped() .
'</th>';
543 $html .=
'<th class="mw-revdel-checkbox">'
544 . $this->
msg(
'revdelete-radio-set' )->escaped() .
'</th>';
545 $html .=
"<th></th></tr>\n";
546 foreach ( $this->checks
as $item ) {
551 if ( $this->submitClicked ) {
559 $label = $this->
msg( $message )->escaped();
561 $label =
"<b>$label</b>";
563 $line .=
"<td>$label</td>";
564 $html .=
"<tr>$line</tr>\n";
579 # Check edit token on submission
581 if ( $this->submitClicked && !$this->
getUser()->matchEditToken(
$token ) ) {
582 $this->
getOutput()->addWikiMsg(
'sessionfailure' );
588 $listReason = $this->
getRequest()->getText(
'wpRevDeleteReasonList',
'other' );
589 $comment = $listReason;
590 if ( $comment ===
'other' ) {
592 } elseif ( $this->otherReason !==
'' ) {
594 $comment .= $this->
msg(
'colon-separator' )->inContentLanguage()->text()
597 # Can the user set this field?
599 && !$this->
getUser()->isAllowed(
'suppressrevision' )
603 # If the save went through, go to success message...
610 # ...otherwise, bounce back to form...
622 $this->
getOutput()->setPageTitle( $this->
msg(
'actioncomplete' ) );
624 "<div class=\"successbox\">\n$1\n</div>",
625 $this->typeLabels[
'success']
627 $this->wasSaved =
true;
628 $this->revDelList->reloadFromMaster();
638 $this->
getOutput()->setPageTitle( $this->
msg(
'actionfailed' ) );
639 $this->
getOutput()->addWikiText(
'<div class="errorbox">' .
640 $status->getWikiText( $this->typeLabels[
'failure'] ) .
653 foreach ( $this->checks
as $item ) {
656 if ( $val < -1 || $val > 1 ) {
659 $bitfield[$field] = $val;
675 return $this->
getList()->setVisibility(
676 [
'value' => $bitPars,
'comment' => $reason ]
getPageTitle( $subpage=false)
Get a self-referential title object.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
error also a ContextSource you ll probably need to make sure the header is varied on $request
static singleton()
Get a RepoGroup instance.
Show an error when the user tries to do something whilst blocked.
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
getOutput()
Get the OutputPage being used for this instance.
bool $wasSaved
Was the DB modified in this request.
if(!isset( $args[0])) $lang
getTitle( $subpage=false)
Get a self-referential title object.
Shortcut to construct a special page which is unlisted by default.
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
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
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
array $typeLabels
UI Labels about the current type.
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
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
RevDelList $revDelList
RevDelList object, storing the list of items to be deleted/undeleted.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
Special page allowing users with the appropriate permissions to view and hide revisions.
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.
Allows to change the fields on the form that will be generated $name
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 openElement( $element, $attribs=null)
This opens an XML element.
getList()
Get the list object for this request.
bool $submitClicked
True if the submit button was clicked, and the form was posted.
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
showConvenienceLinks()
Show some useful links in the subtitle.
save(array $bitPars, $reason)
Do the write operations.
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
getLogQueryCond()
Get the condition used for fetching log snippets.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
string $typeName
Deletion type, may be revision, archive, oldimage, filearchive, logging.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
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 & $html
failure( $status)
Report that the submit operation failed.
Class to simplify the use of log pages.
Abstract base class for a list of deletable items.
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 & $output
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getUser()
Shortcut to get the User executing this instance.
string $archiveName
Archive name, for reviewing deleted files.
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
array $checks
Array of checkbox specs (message, name, deletion bits)
extractBitParams()
Put together an array that contains -1, 0, or the *_deleted const for each bit.
static createList( $typeName, IContextSource $context, Title $title, array $ids)
Instantiate the appropriate list class for a given list of IDs.
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.
Title $targetObj
Title object for target parameter.
showForm()
Show a list of items that we will operate on, and show a form with checkboxes which will allow the us...
doesWrites()
Indicates whether this special page may perform database writes.
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
static getRevdelConstant( $typeName)
Get the revision deletion constant for the RevDel type.
msg()
Wrapper around wfMessage that sets the current context.
success()
Report that the submit operation succeeded.
tryShowFile( $archiveName)
Show a deleted file version requested by the visitor.
getRequest()
Get the WebRequest being used for this instance.
addUsageText()
Show some introductory text.
static $UILabels
UI labels for each type.
Represents a title within MediaWiki.
static closeElement( $element)
Shortcut to close an XML element.
static listDropDown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
string $token
Edit token for securing image views against XSS.
array $ids
Target ID list.
static getRelationType( $typeName)
Get DB field name for URL param...
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
usually copyright or history_copyright This message must be in HTML not wikitext & $link
static getCanonicalTypeName( $typeName)
Gets the canonical type name, if any.
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
execute( $par)
Default execute method Checks user permissions.
static extractBitfield(array $bitPars, $oldfield)
Put together a rev_deleted bitfield.
An error page which can definitely be safely rendered using the OutputPage.
static suggestTarget( $typeName, $target, array $ids)
Suggest a target for the revision deletion.
submit()
UI entry point for form submission.
static getRestriction( $typeName)
Get the user right required for the RevDel type.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
bool $mIsAllowed
Whether user is allowed to perform the action.
the array() calling protocol came about after MediaWiki 1.4rc1.
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