MediaWiki REL1_33
SpecialRevisiondelete.php
Go to the documentation of this file.
1<?php
32 protected $wasSaved = false;
33
36
38 private $ids;
39
41 private $archiveName;
42
44 private $token;
45
47 private $targetObj;
48
50 private $typeName;
51
53 private $checks;
54
56 private $typeLabels;
57
59 private $revDelList;
60
62 private $mIsAllowed;
63
65 private $otherReason;
66
70 private static $UILabels = [
71 'revision' => [
72 'check-label' => 'revdelete-hide-text',
73 'success' => 'revdelete-success',
74 'failure' => 'revdelete-failure',
75 'text' => 'revdelete-text-text',
76 'selected' => 'revdelete-selected-text',
77 ],
78 'archive' => [
79 'check-label' => 'revdelete-hide-text',
80 'success' => 'revdelete-success',
81 'failure' => 'revdelete-failure',
82 'text' => 'revdelete-text-text',
83 'selected' => 'revdelete-selected-text',
84 ],
85 'oldimage' => [
86 'check-label' => 'revdelete-hide-image',
87 'success' => 'revdelete-success',
88 'failure' => 'revdelete-failure',
89 'text' => 'revdelete-text-file',
90 'selected' => 'revdelete-selected-file',
91 ],
92 'filearchive' => [
93 'check-label' => 'revdelete-hide-image',
94 'success' => 'revdelete-success',
95 'failure' => 'revdelete-failure',
96 'text' => 'revdelete-text-file',
97 'selected' => 'revdelete-selected-file',
98 ],
99 'logging' => [
100 'check-label' => 'revdelete-hide-name',
101 'success' => 'logdelete-success',
102 'failure' => 'logdelete-failure',
103 'text' => 'logdelete-text',
104 'selected' => 'logdelete-selected',
105 ],
106 ];
107
108 public function __construct() {
109 parent::__construct( 'Revisiondelete', 'deleterevision' );
110 }
111
112 public function doesWrites() {
113 return true;
114 }
115
116 public function execute( $par ) {
118
119 $this->checkPermissions();
120 $this->checkReadOnly();
121
122 $output = $this->getOutput();
123 $user = $this->getUser();
124
125 // Check blocks
126 if ( $user->isBlocked() ) {
127 throw new UserBlockedError( $user->getBlock() );
128 }
129
130 $this->setHeaders();
131 $this->outputHeader();
132 $request = $this->getRequest();
133 $this->submitClicked = $request->wasPosted() && $request->getBool( 'wpSubmit' );
134 # Handle our many different possible input types.
135 $ids = $request->getVal( 'ids' );
136 if ( !is_null( $ids ) ) {
137 # Allow CSV, for backwards compatibility, or a single ID for show/hide links
138 $this->ids = explode( ',', $ids );
139 } else {
140 # Array input
141 $this->ids = array_keys( $request->getArray( 'ids', [] ) );
142 }
143 // $this->ids = array_map( 'intval', $this->ids );
144 $this->ids = array_unique( array_filter( $this->ids ) );
145
146 $this->typeName = $request->getVal( 'type' );
147 $this->targetObj = Title::newFromText( $request->getText( 'target' ) );
148
149 # For reviewing deleted files...
150 $this->archiveName = $request->getVal( 'file' );
151 $this->token = $request->getVal( 'token' );
152 if ( $this->archiveName && $this->targetObj ) {
153 $this->tryShowFile( $this->archiveName );
154
155 return;
156 }
157
158 $this->typeName = RevisionDeleter::getCanonicalTypeName( $this->typeName );
159
160 # No targets?
161 if ( !$this->typeName || count( $this->ids ) == 0 ) {
162 throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
163 }
164
165 # Allow the list type to adjust the passed target
166 $this->targetObj = RevisionDeleter::suggestTarget(
167 $this->typeName,
168 $this->targetObj,
169 $this->ids
170 );
171
172 # We need a target page!
173 if ( $this->targetObj === null ) {
174 $output->addWikiMsg( 'undelete-header' );
175
176 return;
177 }
178
179 $this->typeLabels = self::$UILabels[$this->typeName];
180 $list = $this->getList();
181 $list->reset();
182 $this->mIsAllowed = $user->isAllowed( RevisionDeleter::getRestriction( $this->typeName ) );
183 $canViewSuppressedOnly = $this->getUser()->isAllowed( 'viewsuppressed' ) &&
184 !$this->getUser()->isAllowed( 'suppressrevision' );
185 $pageIsSuppressed = $list->areAnySuppressed();
186 $this->mIsAllowed = $this->mIsAllowed && !( $canViewSuppressedOnly && $pageIsSuppressed );
187
188 $this->otherReason = $request->getVal( 'wpReason' );
189 # Give a link to the logs/hist for this page
190 $this->showConvenienceLinks();
191
192 # Initialise checkboxes
193 $this->checks = [
194 # Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name
195 [ $this->typeLabels['check-label'], 'wpHidePrimary',
196 RevisionDeleter::getRevdelConstant( $this->typeName )
197 ],
198 [ 'revdelete-hide-comment', 'wpHideComment', Revision::DELETED_COMMENT ],
199 [ 'revdelete-hide-user', 'wpHideUser', Revision::DELETED_USER ]
200 ];
201 if ( $user->isAllowed( 'suppressrevision' ) ) {
202 $this->checks[] = [ 'revdelete-hide-restricted',
203 'wpHideRestricted', Revision::DELETED_RESTRICTED ];
204 }
205
206 # Either submit or create our form
207 if ( $this->mIsAllowed && $this->submitClicked ) {
208 $this->submit();
209 } else {
210 $this->showForm();
211 }
212
213 if ( $user->isAllowed( 'deletedhistory' ) ) {
214 $qc = $this->getLogQueryCond();
215 # Show relevant lines from the deletion log
216 $deleteLogPage = new LogPage( 'delete' );
217 $output->addHTML( "<h2>" . $deleteLogPage->getName()->escaped() . "</h2>\n" );
219 $output,
220 'delete',
221 $this->targetObj,
222 '', /* user */
223 [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
224 );
225 }
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" );
231 $output,
232 'suppress',
233 $this->targetObj,
234 '',
235 [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
236 );
237 }
238 }
239
243 protected function showConvenienceLinks() {
245 # Give a link to the logs/hist for this page
246 if ( $this->targetObj ) {
247 // Also set header tabs to be for the target.
248 $this->getSkin()->setRelevantTitle( $this->targetObj );
249
250 $links = [];
251 $links[] = $linkRenderer->makeKnownLink(
253 $this->msg( 'viewpagelogs' )->text(),
254 [],
255 [ 'page' => $this->targetObj->getPrefixedText() ]
256 );
257 if ( !$this->targetObj->isSpecialPage() ) {
258 # Give a link to the page history
259 $links[] = $linkRenderer->makeKnownLink(
260 $this->targetObj,
261 $this->msg( 'pagehist' )->text(),
262 [],
263 [ 'action' => 'history' ]
264 );
265 # Link to deleted edits
266 if ( $this->getUser()->isAllowed( 'undelete' ) ) {
267 $undelete = SpecialPage::getTitleFor( 'Undelete' );
268 $links[] = $linkRenderer->makeKnownLink(
269 $undelete,
270 $this->msg( 'deletedhist' )->text(),
271 [],
272 [ 'target' => $this->targetObj->getPrefixedDBkey() ]
273 );
274 }
275 }
276 # Logs themselves don't have histories or archived revisions
277 $this->getOutput()->addSubtitle( $this->getLanguage()->pipeList( $links ) );
278 }
279 }
280
285 protected function getLogQueryCond() {
286 $conds = [];
287 // Revision delete logs for these item
288 $conds['log_type'] = [ 'delete', 'suppress' ];
289 $conds['log_action'] = $this->getList()->getLogAction();
290 $conds['ls_field'] = RevisionDeleter::getRelationType( $this->typeName );
291 $conds['ls_value'] = $this->ids;
292
293 return $conds;
294 }
295
303 protected function tryShowFile( $archiveName ) {
304 $repo = RepoGroup::singleton()->getLocalRepo();
305 $oimage = $repo->newFromArchiveName( $this->targetObj, $archiveName );
306 $oimage->load();
307 // Check if user is allowed to see this file
308 if ( !$oimage->exists() ) {
309 $this->getOutput()->addWikiMsg( 'revdelete-no-file' );
310
311 return;
312 }
313 $user = $this->getUser();
314 if ( !$oimage->userCan( File::DELETED_FILE, $user ) ) {
315 if ( $oimage->isDeleted( File::DELETED_RESTRICTED ) ) {
316 throw new PermissionsError( 'suppressrevision' );
317 } else {
318 throw new PermissionsError( 'deletedtext' );
319 }
320 }
321 if ( !$user->matchEditToken( $this->token, $archiveName ) ) {
322 $lang = $this->getLanguage();
323 $this->getOutput()->addWikiMsg( 'revdelete-show-file-confirm',
324 $this->targetObj->getText(),
325 $lang->userDate( $oimage->getTimestamp(), $user ),
326 $lang->userTime( $oimage->getTimestamp(), $user ) );
327 $this->getOutput()->addHTML(
328 Xml::openElement( 'form', [
329 'method' => 'POST',
330 'action' => $this->getPageTitle()->getLocalURL( [
331 'target' => $this->targetObj->getPrefixedDBkey(),
332 'file' => $archiveName,
333 'token' => $user->getEditToken( $archiveName ),
334 ] )
335 ]
336 ) .
337 Xml::submitButton( $this->msg( 'revdelete-show-file-submit' )->text() ) .
338 '</form>'
339 );
340
341 return;
342 }
343 $this->getOutput()->disable();
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' );
349 $this->getRequest()->response()->header(
350 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate'
351 );
352 $this->getRequest()->response()->header( 'Pragma: no-cache' );
353
354 $key = $oimage->getStorageKey();
355 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
356 $repo->streamFile( $path );
357 }
358
363 protected function getList() {
364 if ( is_null( $this->revDelList ) ) {
365 $this->revDelList = RevisionDeleter::createList(
366 $this->typeName, $this->getContext(), $this->targetObj, $this->ids
367 );
368 }
369
370 return $this->revDelList;
371 }
372
377 protected function showForm() {
378 $userAllowed = true;
379
380 // Messages: revdelete-selected-text, revdelete-selected-file, logdelete-selected
381 $out = $this->getOutput();
382 $out->wrapWikiMsg( "<strong>$1</strong>", [ $this->typeLabels['selected'],
383 $this->getLanguage()->formatNum( count( $this->ids ) ), $this->targetObj->getPrefixedText() ] );
384
385 $this->addHelpLink( 'Help:RevisionDelete' );
386 $out->addHTML( "<ul>" );
387
388 $numRevisions = 0;
389 // Live revisions...
390 $list = $this->getList();
391 for ( $list->reset(); $list->current(); $list->next() ) {
392 $item = $list->current();
393
394 if ( !$item->canView() ) {
395 if ( !$this->submitClicked ) {
396 throw new PermissionsError( 'suppressrevision' );
397 }
398 $userAllowed = false;
399 }
400
401 $numRevisions++;
402 $out->addHTML( $item->getHTML() );
403 }
404
405 if ( !$numRevisions ) {
406 throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
407 }
408
409 $out->addHTML( "</ul>" );
410 // Explanation text
411 $this->addUsageText();
412
413 // Normal sysops can always see what they did, but can't always change it
414 if ( !$userAllowed ) {
415 return;
416 }
417
418 // Show form if the user can submit
419 if ( $this->mIsAllowed ) {
420 $out->addModules( [ 'mediawiki.special.revisionDelete' ] );
421 $out->addModuleStyles( [ 'mediawiki.special',
422 'mediawiki.interface.helpers.styles' ] );
423
424 $form = Xml::openElement( 'form', [ 'method' => 'post',
425 'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ),
426 'id' => 'mw-revdel-form-revisions' ] ) .
427 Xml::fieldset( $this->msg( 'revdelete-legend' )->text() ) .
428 $this->buildCheckBoxes() .
429 Xml::openElement( 'table' ) .
430 "<tr>\n" .
431 '<td class="mw-label">' .
432 Xml::label( $this->msg( 'revdelete-log' )->text(), 'wpRevDeleteReasonList' ) .
433 '</td>' .
434 '<td class="mw-input">' .
435 Xml::listDropDown( 'wpRevDeleteReasonList',
436 $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->text(),
437 $this->msg( 'revdelete-reasonotherlist' )->inContentLanguage()->text(),
438 $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' ), 'wpReasonDropDown'
439 ) .
440 '</td>' .
441 "</tr><tr>\n" .
442 '<td class="mw-label">' .
443 Xml::label( $this->msg( 'revdelete-otherreason' )->text(), 'wpReason' ) .
444 '</td>' .
445 '<td class="mw-input">' .
446 Xml::input( 'wpReason', 60, $this->otherReason, [
447 'id' => 'wpReason',
448 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
449 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
450 // Unicode codepoints.
451 // "- 155" is to leave room for the 'wpRevDeleteReasonList' value.
452 'maxlength' => CommentStore::COMMENT_CHARACTER_LIMIT - 155,
453 ] ) .
454 '</td>' .
455 "</tr><tr>\n" .
456 '<td></td>' .
457 '<td class="mw-submit">' .
458 Xml::submitButton( $this->msg( 'revdelete-submit', $numRevisions )->text(),
459 [ 'name' => 'wpSubmit' ] ) .
460 '</td>' .
461 "</tr>\n" .
462 Xml::closeElement( 'table' ) .
463 Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() ) .
464 Html::hidden( 'target', $this->targetObj->getPrefixedText() ) .
465 Html::hidden( 'type', $this->typeName ) .
466 Html::hidden( 'ids', implode( ',', $this->ids ) ) .
467 Xml::closeElement( 'fieldset' ) . "\n" .
468 Xml::closeElement( 'form' ) . "\n";
469 // Show link to edit the dropdown reasons
470 if ( $this->getUser()->isAllowed( 'editinterface' ) ) {
471 $link = $this->getLinkRenderer()->makeKnownLink(
472 $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->getTitle(),
473 $this->msg( 'revdelete-edit-reasonlist' )->text(),
474 [],
475 [ 'action' => 'edit' ]
476 );
477 $form .= Xml::tags( 'p', [ 'class' => 'mw-revdel-editreasons' ], $link ) . "\n";
478 }
479 } else {
480 $form = '';
481 }
482 $out->addHTML( $form );
483 }
484
489 protected function addUsageText() {
490 // Messages: revdelete-text-text, revdelete-text-file, logdelete-text
491 $this->getOutput()->wrapWikiMsg(
492 "<strong>$1</strong>\n$2", $this->typeLabels['text'],
493 'revdelete-text-others'
494 );
495
496 if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
497 $this->getOutput()->addWikiMsg( 'revdelete-suppress-text' );
498 }
499
500 if ( $this->mIsAllowed ) {
501 $this->getOutput()->addWikiMsg( 'revdelete-confirm' );
502 }
503 }
504
508 protected function buildCheckBoxes() {
509 $html = '<table>';
510 // If there is just one item, use checkboxes
511 $list = $this->getList();
512 if ( $list->length() == 1 ) {
513 $list->reset();
514 $bitfield = $list->current()->getBits(); // existing field
515
516 if ( $this->submitClicked ) {
517 $bitfield = RevisionDeleter::extractBitfield( $this->extractBitParams(), $bitfield );
518 }
519
520 foreach ( $this->checks as $item ) {
521 // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
522 // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
523 list( $message, $name, $field ) = $item;
524 $innerHTML = Xml::checkLabel(
525 $this->msg( $message )->text(),
526 $name,
527 $name,
528 $bitfield & $field
529 );
530
531 if ( $field == Revision::DELETED_RESTRICTED ) {
532 $innerHTML = "<b>$innerHTML</b>";
533 }
534
535 $line = Xml::tags( 'td', [ 'class' => 'mw-input' ], $innerHTML );
536 $html .= "<tr>$line</tr>\n";
537 }
538 } else {
539 // Otherwise, use tri-state radios
540 $html .= '<tr>';
541 $html .= '<th class="mw-revdel-checkbox">'
542 . $this->msg( 'revdelete-radio-same' )->escaped() . '</th>';
543 $html .= '<th class="mw-revdel-checkbox">'
544 . $this->msg( 'revdelete-radio-unset' )->escaped() . '</th>';
545 $html .= '<th class="mw-revdel-checkbox">'
546 . $this->msg( 'revdelete-radio-set' )->escaped() . '</th>';
547 $html .= "<th></th></tr>\n";
548 foreach ( $this->checks as $item ) {
549 // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
550 // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
551 list( $message, $name, $field ) = $item;
552 // If there are several items, use third state by default...
553 if ( $this->submitClicked ) {
554 $selected = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
555 } else {
556 $selected = -1; // use existing field
557 }
558 $line = '<td class="mw-revdel-checkbox">' . Xml::radio( $name, -1, $selected == -1 ) . '</td>';
559 $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 0, $selected == 0 ) . '</td>';
560 $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 1, $selected == 1 ) . '</td>';
561 $label = $this->msg( $message )->escaped();
562 if ( $field == Revision::DELETED_RESTRICTED ) {
563 $label = "<b>$label</b>";
564 }
565 $line .= "<td>$label</td>";
566 $html .= "<tr>$line</tr>\n";
567 }
568 }
569
570 $html .= '</table>';
571
572 return $html;
573 }
574
580 protected function submit() {
581 # Check edit token on submission
582 $token = $this->getRequest()->getVal( 'wpEditToken' );
583 if ( $this->submitClicked && !$this->getUser()->matchEditToken( $token ) ) {
584 $this->getOutput()->addWikiMsg( 'sessionfailure' );
585
586 return false;
587 }
588 $bitParams = $this->extractBitParams();
589 // from dropdown
590 $listReason = $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' );
591 $comment = $listReason;
592 if ( $comment === 'other' ) {
593 $comment = $this->otherReason;
594 } elseif ( $this->otherReason !== '' ) {
595 // Entry from drop down menu + additional comment
596 $comment .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
598 }
599 # Can the user set this field?
600 if ( $bitParams[Revision::DELETED_RESTRICTED] == 1
601 && !$this->getUser()->isAllowed( 'suppressrevision' )
602 ) {
603 throw new PermissionsError( 'suppressrevision' );
604 }
605 # If the save went through, go to success message...
606 $status = $this->save( $bitParams, $comment );
607 if ( $status->isGood() ) {
608 $this->success();
609
610 return true;
611 } else {
612 # ...otherwise, bounce back to form...
613 $this->failure( $status );
614 }
615
616 return false;
617 }
618
622 protected function success() {
623 // Messages: revdelete-success, logdelete-success
624 $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
625 $this->getOutput()->wrapWikiMsg(
626 "<div class=\"successbox\">\n$1\n</div>",
627 $this->typeLabels['success']
628 );
629 $this->wasSaved = true;
630 $this->revDelList->reloadFromMaster();
631 $this->showForm();
632 }
633
638 protected function failure( $status ) {
639 // Messages: revdelete-failure, logdelete-failure
640 $this->getOutput()->setPageTitle( $this->msg( 'actionfailed' ) );
641 $this->getOutput()->wrapWikiTextAsInterface(
642 'errorbox',
643 $status->getWikiText( $this->typeLabels['failure'] )
644 );
645 $this->showForm();
646 }
647
653 protected function extractBitParams() {
654 $bitfield = [];
655 foreach ( $this->checks as $item ) {
656 list( /* message */, $name, $field ) = $item;
657 $val = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
658 if ( $val < -1 || $val > 1 ) {
659 $val = -1; // -1 for existing value
660 }
661 $bitfield[$field] = $val;
662 }
663 if ( !isset( $bitfield[Revision::DELETED_RESTRICTED] ) ) {
664 $bitfield[Revision::DELETED_RESTRICTED] = 0;
665 }
666
667 return $bitfield;
668 }
669
676 protected function save( array $bitPars, $reason ) {
677 return $this->getList()->setVisibility(
678 [ 'value' => $bitPars, 'comment' => $reason ]
679 );
680 }
681
682 protected function getGroupName() {
683 return 'pagetools';
684 }
685}
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
$line
Definition cdb.php:59
An error page which can definitely be safely rendered using the OutputPage.
const DELETED_RESTRICTED
Definition File.php:57
const DELETED_FILE
Definition File.php:54
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
Class to simplify the use of log pages.
Definition LogPage.php:33
Show an error when a user tries to do something they do not have the necessary permissions for.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:61
Abstract base class for a list of deletable items.
static getCanonicalTypeName( $typeName)
Gets the canonical type name, if any.
static createList( $typeName, IContextSource $context, Title $title, array $ids)
Instantiate the appropriate list class for a given list of IDs.
static getRelationType( $typeName)
Get DB field name for URL param... Future code for other things may also track other types of revisio...
static suggestTarget( $typeName, $target, array $ids)
Suggest a target for the revision deletion.
static extractBitfield(array $bitPars, $oldfield)
Put together a rev_deleted bitfield.
static getRevdelConstant( $typeName)
Get the revision deletion constant for the RevDel type.
static getRestriction( $typeName)
Get the user right required for the RevDel type.
const DELETED_USER
Definition Revision.php:48
const DELETED_RESTRICTED
Definition Revision.php:49
const DELETED_COMMENT
Definition Revision.php:47
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
getUser()
Shortcut to get the User executing this instance.
getSkin()
Shortcut to get the skin being used for this instance.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
getContext()
Gets the context this SpecialPage is executed in.
msg( $key)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
getPageTitle( $subpage=false)
Get a self-referential title object.
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
getLanguage()
Shortcut to get user's language.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
MediaWiki Linker LinkRenderer null $linkRenderer
getTitle( $subpage=false)
Get a self-referential title object.
Special page allowing users with the appropriate permissions to view and hide revisions.
string $token
Edit token for securing image views against XSS.
bool $mIsAllowed
Whether user is allowed to perform the action.
showForm()
Show a list of items that we will operate on, and show a form with checkboxes which will allow the us...
tryShowFile( $archiveName)
Show a deleted file version requested by the visitor.
string $archiveName
Archive name, for reviewing deleted files.
save(array $bitPars, $reason)
Do the write operations.
success()
Report that the submit operation succeeded.
addUsageText()
Show some introductory text.
array $typeLabels
UI Labels about the current type.
bool $wasSaved
Was the DB modified in this request.
getLogQueryCond()
Get the condition used for fetching log snippets.
RevDelList $revDelList
RevDelList object, storing the list of items to be deleted/undeleted.
showConvenienceLinks()
Show some useful links in the subtitle.
doesWrites()
Indicates whether this special page may perform database writes.
execute( $par)
Default execute method Checks user permissions.
array $checks
Array of checkbox specs (message, name, deletion bits)
failure( $status)
Report that the submit operation failed.
static $UILabels
UI labels for each type.
submit()
UI entry point for form submission.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Title $targetObj
Title object for target parameter.
extractBitParams()
Put together an array that contains -1, 0, or the *_deleted const for each bit.
bool $submitClicked
True if the submit button was clicked, and the form was posted.
string $typeName
Deletion type, may be revision, archive, oldimage, filearchive, logging.
getList()
Get the list object for this request.
array $ids
Target ID list.
Represents a title within MediaWiki.
Definition Title.php:40
Shortcut to construct a special page which is unlisted by default.
Show an error when the user tries to do something whilst blocked.
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 save
Definition deferred.txt:5
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2843
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:855
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1266
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
Definition hooks.txt:2011
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:3069
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:271
return true to allow those checks to and false if checking is done & $user
Definition hooks.txt:1510
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2272
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
if(!isset( $args[0])) $lang