MediaWiki  master
McrUndoAction.php
Go to the documentation of this file.
1 <?php
12 
29 class McrUndoAction extends FormAction {
30 
31  protected $undo = 0, $undoafter = 0, $cur = 0;
32 
34  protected $curRev = null;
35 
36  public function getName() {
37  return 'mcrundo';
38  }
39 
40  public function getDescription() {
41  return '';
42  }
43 
44  public function show() {
45  // Send a cookie so anons get talk message notifications
46  // (copied from SubmitAction)
48 
49  // Some stuff copied from EditAction
51 
52  $out = $this->getOutput();
53  $out->setRobotPolicy( 'noindex,nofollow' );
54  if ( $this->getContext()->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
55  $out->addModuleStyles( [
56  'mediawiki.ui.input',
57  'mediawiki.ui.checkbox',
58  ] );
59  }
60 
61  // IP warning headers copied from EditPage
62  // (should more be copied?)
63  if ( wfReadOnly() ) {
64  $out->wrapWikiMsg(
65  "<div id=\"mw-read-only-warning\">\n$1\n</div>",
66  [ 'readonlywarning', wfReadOnlyReason() ]
67  );
68  } elseif ( $this->context->getUser()->isAnon() ) {
69  if ( !$this->getRequest()->getCheck( 'wpPreview' ) ) {
70  $out->wrapWikiMsg(
71  "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
72  [ 'anoneditwarning',
73  // Log-in link
74  SpecialPage::getTitleFor( 'Userlogin' )->getFullURL( [
75  'returnto' => $this->getTitle()->getPrefixedDBkey()
76  ] ),
77  // Sign-up link
78  SpecialPage::getTitleFor( 'CreateAccount' )->getFullURL( [
79  'returnto' => $this->getTitle()->getPrefixedDBkey()
80  ] )
81  ]
82  );
83  } else {
84  $out->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
85  'anonpreviewwarning'
86  );
87  }
88  }
89 
90  parent::show();
91  }
92 
93  protected function initFromParameters() {
94  $this->undoafter = $this->getRequest()->getInt( 'undoafter' );
95  $this->undo = $this->getRequest()->getInt( 'undo' );
96 
97  if ( $this->undo == 0 || $this->undoafter == 0 ) {
98  throw new ErrorPageError( 'mcrundofailed', 'mcrundo-missingparam' );
99  }
100 
101  $curRev = $this->page->getRevision();
102  if ( !$curRev ) {
103  throw new ErrorPageError( 'mcrundofailed', 'nopagetext' );
104  }
105  $this->curRev = $curRev->getRevisionRecord();
106  $this->cur = $this->getRequest()->getInt( 'cur', $this->curRev->getId() );
107  }
108 
109  protected function checkCanExecute( User $user ) {
110  parent::checkCanExecute( $user );
111 
112  $this->initFromParameters();
113 
114  $revisionLookup = MediaWikiServices::getInstance()->getRevisionLookup();
115 
116  $undoRev = $revisionLookup->getRevisionById( $this->undo );
117  $oldRev = $revisionLookup->getRevisionById( $this->undoafter );
118 
119  if ( $undoRev === null || $oldRev === null ||
120  $undoRev->isDeleted( RevisionRecord::DELETED_TEXT ) ||
121  $oldRev->isDeleted( RevisionRecord::DELETED_TEXT )
122  ) {
123  throw new ErrorPageError( 'mcrundofailed', 'undo-norev' );
124  }
125 
126  return true;
127  }
128 
132  private function getNewRevision() {
133  $revisionLookup = MediaWikiServices::getInstance()->getRevisionLookup();
134 
135  $undoRev = $revisionLookup->getRevisionById( $this->undo );
136  $oldRev = $revisionLookup->getRevisionById( $this->undoafter );
138 
139  $isLatest = $curRev->getId() === $undoRev->getId();
140 
141  if ( $undoRev === null || $oldRev === null ||
142  $undoRev->isDeleted( RevisionRecord::DELETED_TEXT ) ||
143  $oldRev->isDeleted( RevisionRecord::DELETED_TEXT )
144  ) {
145  throw new ErrorPageError( 'mcrundofailed', 'undo-norev' );
146  }
147 
148  if ( $isLatest ) {
149  // Short cut! Undoing the current revision means we just restore the old.
150  return MutableRevisionRecord::newFromParentRevision( $oldRev );
151  }
152 
153  $newRev = MutableRevisionRecord::newFromParentRevision( $curRev );
154 
155  // Figure out the roles that need merging by first collecting all roles
156  // and then removing the ones that don't.
157  $rolesToMerge = array_unique( array_merge(
158  $oldRev->getSlotRoles(),
159  $undoRev->getSlotRoles(),
161  ) );
162 
163  // Any roles with the same content in $oldRev and $undoRev can be
164  // inherited because undo won't change them.
165  $rolesToMerge = array_intersect(
166  $rolesToMerge, $oldRev->getSlots()->getRolesWithDifferentContent( $undoRev->getSlots() )
167  );
168  if ( !$rolesToMerge ) {
169  throw new ErrorPageError( 'mcrundofailed', 'undo-nochange' );
170  }
171 
172  // Any roles with the same content in $oldRev and $curRev were already reverted
173  // and so can be inherited.
174  $rolesToMerge = array_intersect(
175  $rolesToMerge, $oldRev->getSlots()->getRolesWithDifferentContent( $curRev->getSlots() )
176  );
177  if ( !$rolesToMerge ) {
178  throw new ErrorPageError( 'mcrundofailed', 'undo-nochange' );
179  }
180 
181  // Any roles with the same content in $undoRev and $curRev weren't
182  // changed since and so can be reverted to $oldRev.
183  $diffRoles = array_intersect(
184  $rolesToMerge, $undoRev->getSlots()->getRolesWithDifferentContent( $curRev->getSlots() )
185  );
186  foreach ( array_diff( $rolesToMerge, $diffRoles ) as $role ) {
187  if ( $oldRev->hasSlot( $role ) ) {
188  $newRev->inheritSlot( $oldRev->getSlot( $role, RevisionRecord::RAW ) );
189  } else {
190  $newRev->removeSlot( $role );
191  }
192  }
193  $rolesToMerge = $diffRoles;
194 
195  // Any slot additions or removals not handled by the above checks can't be undone.
196  // There will be only one of the three revisions missing the slot:
197  // - !old means it was added in the undone revisions and modified after.
198  // Should it be removed entirely for the undo, or should the modified version be kept?
199  // - !undo means it was removed in the undone revisions and then readded with different content.
200  // Which content is should be kept, the old or the new?
201  // - !cur means it was changed in the undone revisions and then deleted after.
202  // Did someone delete vandalized content instead of undoing (meaning we should ideally restore
203  // it), or should it stay gone?
204  foreach ( $rolesToMerge as $role ) {
205  if ( !$oldRev->hasSlot( $role ) || !$undoRev->hasSlot( $role ) || !$curRev->hasSlot( $role ) ) {
206  throw new ErrorPageError( 'mcrundofailed', 'undo-failure' );
207  }
208  }
209 
210  // Try to merge anything that's left.
211  foreach ( $rolesToMerge as $role ) {
212  $oldContent = $oldRev->getSlot( $role, RevisionRecord::RAW )->getContent();
213  $undoContent = $undoRev->getSlot( $role, RevisionRecord::RAW )->getContent();
214  $curContent = $curRev->getSlot( $role, RevisionRecord::RAW )->getContent();
215  $newContent = $undoContent->getContentHandler()
216  ->getUndoContent( $curContent, $undoContent, $oldContent, $isLatest );
217  if ( !$newContent ) {
218  throw new ErrorPageError( 'mcrundofailed', 'undo-failure' );
219  }
220  $newRev->setSlot( SlotRecord::newUnsaved( $role, $newContent ) );
221  }
222 
223  return $newRev;
224  }
225 
226  private function generateDiffOrPreview() {
227  $newRev = $this->getNewRevision();
228  if ( $newRev->hasSameContent( $this->curRev ) ) {
229  throw new ErrorPageError( 'mcrundofailed', 'undo-nochange' );
230  }
231 
232  $diffEngine = new DifferenceEngine( $this->context );
233  $diffEngine->setRevisions( $this->curRev, $newRev );
234 
235  $oldtitle = $this->context->msg( 'currentrev' )->parse();
236  $newtitle = $this->context->msg( 'yourtext' )->parse();
237 
238  if ( $this->getRequest()->getCheck( 'wpPreview' ) ) {
239  $this->showPreview( $newRev );
240  return '';
241  } else {
242  $diffText = $diffEngine->getDiff( $oldtitle, $newtitle );
243  $diffEngine->showDiffStyle();
244  return '<div id="wikiDiff">' . $diffText . '</div>';
245  }
246  }
247 
248  private function showPreview( RevisionRecord $rev ) {
249  // Mostly copied from EditPage::getPreviewText()
250  $out = $this->getOutput();
251 
252  try {
253  $previewHTML = '';
254 
255  # provide a anchor link to the form
256  $continueEditing = '<span class="mw-continue-editing">' .
257  '[[#mw-mcrundo-form|' .
258  $this->context->getLanguage()->getArrow() . ' ' .
259  $this->context->msg( 'continue-editing' )->text() . ']]</span>';
260 
261  $note = $this->context->msg( 'previewnote' )->plain() . ' ' . $continueEditing;
262 
263  $parserOptions = $this->page->makeParserOptions( $this->context );
264  $parserOptions->setIsPreview( true );
265  $parserOptions->setIsSectionPreview( false );
266  $parserOptions->enableLimitReport();
267 
268  $parserOutput = MediaWikiServices::getInstance()->getRevisionRenderer()
269  ->getRenderedRevision( $rev, $parserOptions, $this->context->getUser() )
270  ->getRevisionParserOutput();
271  $previewHTML = $parserOutput->getText( [ 'enableSectionEditLinks' => false ] );
272 
273  $out->addParserOutputMetadata( $parserOutput );
274  if ( count( $parserOutput->getWarnings() ) ) {
275  $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
276  }
277  } catch ( MWContentSerializationException $ex ) {
278  $m = $this->context->msg(
279  'content-failed-to-parse',
280  $ex->getMessage()
281  );
282  $note .= "\n\n" . $m->parse();
283  $previewHTML = '';
284  }
285 
286  $previewhead = Html::rawElement(
287  'div', [ 'class' => 'previewnote' ],
289  'h2', [ 'id' => 'mw-previewheader' ],
290  $this->context->msg( 'preview' )->text()
291  ) .
292  $out->parseAsInterface( $note ) .
293  "<hr />"
294  );
295 
296  $pageViewLang = $this->getTitle()->getPageViewLanguage();
297  $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
298  'class' => 'mw-content-' . $pageViewLang->getDir() ];
299  $previewHTML = Html::rawElement( 'div', $attribs, $previewHTML );
300 
301  $out->addHTML( $previewhead . $previewHTML );
302  }
303 
304  public function onSubmit( $data ) {
305  global $wgUseRCPatrol;
306 
307  if ( !$this->getRequest()->getCheck( 'wpSave' ) ) {
308  // Diff or preview
309  return false;
310  }
311 
312  $updater = $this->page->getPage()->newPageUpdater( $this->context->getUser() );
313  $curRev = $updater->grabParentRevision();
314  if ( !$curRev ) {
315  throw new ErrorPageError( 'mcrundofailed', 'nopagetext' );
316  }
317 
318  if ( $this->cur !== $curRev->getId() ) {
319  return Status::newFatal( 'mcrundo-changed' );
320  }
321 
322  $newRev = $this->getNewRevision();
323  if ( !$newRev->hasSameContent( $curRev ) ) {
324  // Copy new slots into the PageUpdater, and remove any removed slots.
325  // TODO: This interface is awful, there should be a way to just pass $newRev.
326  // TODO: MCR: test this once we can store multiple slots
327  foreach ( $newRev->getSlots()->getSlots() as $slot ) {
328  $updater->setSlot( $slot );
329  }
330  foreach ( $curRev->getSlotRoles() as $role ) {
331  if ( !$newRev->hasSlot( $role ) ) {
332  $updater->removeSlot( $role );
333  }
334  }
335 
336  $updater->setOriginalRevisionId( false );
337  $updater->setUndidRevisionId( $this->undo );
338 
339  // TODO: Ugh.
340  if ( $wgUseRCPatrol && $this->getTitle()->userCan( 'autopatrol', $this->getUser() ) ) {
341  $updater->setRcPatrolStatus( RecentChange::PRC_AUTOPATROLLED );
342  }
343 
344  $updater->saveRevision(
345  CommentStoreComment::newUnsavedComment( trim( $this->getRequest()->getVal( 'wpSummary' ) ) ),
347  );
348 
349  return $updater->getStatus();
350  }
351 
352  return Status::newGood();
353  }
354 
355  protected function usesOOUI() {
356  return true;
357  }
358 
359  protected function getFormFields() {
360  $request = $this->getRequest();
361  $ret = [
362  'diff' => [
363  'type' => 'info',
364  'vertical-label' => true,
365  'raw' => true,
366  'default' => function () {
367  return $this->generateDiffOrPreview();
368  }
369  ],
370  'summary' => [
371  'type' => 'text',
372  'id' => 'wpSummary',
373  'name' => 'wpSummary',
374  'cssclass' => 'mw-summary',
375  'label-message' => 'summary',
377  'value' => $request->getVal( 'wpSummary', '' ),
378  'size' => 60,
379  'spellcheck' => 'true',
380  ],
381  'summarypreview' => [
382  'type' => 'info',
383  'label-message' => 'summary-preview',
384  'raw' => true,
385  ],
386  ];
387 
388  if ( $request->getCheck( 'wpSummary' ) ) {
389  $ret['summarypreview']['default'] = Xml::tags( 'div', [ 'class' => 'mw-summary-preview' ],
390  Linker::commentBlock( trim( $request->getVal( 'wpSummary' ) ), $this->getTitle(), false )
391  );
392  } else {
393  unset( $ret['summarypreview'] );
394  }
395 
396  return $ret;
397  }
398 
399  protected function alterForm( HTMLForm $form ) {
400  $form->setWrapperLegendMsg( 'confirm-mcrundo-title' );
401 
402  $labelAsPublish = $this->context->getConfig()->get( 'EditSubmitButtonLabelPublish' );
403 
404  $form->setId( 'mw-mcrundo-form' );
405  $form->setSubmitName( 'wpSave' );
406  $form->setSubmitTooltip( $labelAsPublish ? 'publish' : 'save' );
407  $form->setSubmitTextMsg( $labelAsPublish ? 'publishchanges' : 'savechanges' );
408  $form->showCancel( true );
409  $form->setCancelTarget( $this->getTitle() );
410  $form->addButton( [
411  'name' => 'wpPreview',
412  'value' => '1',
413  'label-message' => 'showpreview',
414  'attribs' => Linker::tooltipAndAccesskeyAttribs( 'preview' ),
415  ] );
416  $form->addButton( [
417  'name' => 'wpDiff',
418  'value' => '1',
419  'label-message' => 'showdiff',
420  'attribs' => Linker::tooltipAndAccesskeyAttribs( 'diff' ),
421  ] );
422 
423  $this->addStatePropagationFields( $form );
424  }
425 
426  protected function addStatePropagationFields( HTMLForm $form ) {
427  $form->addHiddenField( 'undo', $this->undo );
428  $form->addHiddenField( 'undoafter', $this->undoafter );
429  $form->addHiddenField( 'cur', $this->curRev->getId() );
430  }
431 
432  public function onSuccess() {
433  $this->getOutput()->redirect( $this->getTitle()->getFullURL() );
434  }
435 
436  protected function preText() {
437  return '<div style="clear:both"></div>';
438  }
439 }
DifferenceEngine is responsible for rendering the difference between two revisions as HTML...
getOutput()
Get the OutputPage being used for this instance.
Definition: Action.php:208
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
getTitle()
Shortcut to get the Title object from the page.
Definition: Action.php:247
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 & $ret
Definition: hooks.txt:1982
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
setSubmitName( $name)
Definition: HTMLForm.php:1420
showCancel( $show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1494
addStatePropagationFields(HTMLForm $form)
getSlots()
Returns the slots defined for this revision.
getUser()
Shortcut to get the User being used for this instance.
Definition: Action.php:218
setSubmitTooltip( $name)
Definition: HTMLForm.php:1431
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
addButton( $data)
Add a button to the form.
Definition: HTMLForm.php:973
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
Definition: injection.txt:23
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
const EDIT_UPDATE
Definition: Defines.php:153
target page
hasSlot( $role)
Returns whether the given slot is defined in this revision.
static newUnsavedComment( $comment, array $data=null)
Create a new, unsaved CommentStoreComment.
showPreview(RevisionRecord $rev)
setId( $id)
Definition: HTMLForm.php:1530
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
$newRev
Definition: pageupdater.txt:66
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:780
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: Action.php:421
An action which shows a form and does something based on the input from the form. ...
Definition: FormAction.php:28
setCancelTarget( $target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1505
addHiddenField( $name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:924
wfReadOnly()
Check whether the wiki is in read-only mode.
getSlotRoles()
Returns the slot names (roles) of all slots present in this revision.
An error page which can definitely be safely rendered using the OutputPage.
presenting them properly to the user as errors is done by the caller return true use this to change the list i e undo
Definition: hooks.txt:1766
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
alterForm(HTMLForm $form)
const EDIT_AUTOSUMMARY
Definition: Defines.php:158
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:130
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1982
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 null
Definition: hooks.txt:780
getContext()
Get the IContextSource in use here.
Definition: Action.php:179
$wgUseRCPatrol
Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files...
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1766
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
Definition: distributors.txt:9
RevisionRecord null $curRev
static getGlobalSession()
Get the "global" session.
getSlot( $role, $audience=self::FOR_PUBLIC, User $user=null)
Returns meta-data for the given slot.
getId()
Get revision ID.
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:35
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
checkCanExecute(User $user)
$page->newPageUpdater($user) $updater
Definition: pageupdater.txt:63
Temporary action for MCR undos.
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1398
Page revision base class.
getUser( $audience=self::FOR_PUBLIC, User $user=null)
Fetch revision&#39;s author&#39;s user identity, if it&#39;s available to the specified audience.
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element...
Definition: HTMLForm.php:1585
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2144
getRequest()
Get the WebRequest being used for this instance.
Definition: Action.php:198
const PRC_AUTOPATROLLED
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:2633
static commentBlock( $comment, $title=null, $local=false, $wikiId=null, $useParentheses=true)
Wrap a comment in standard punctuation and formatting if it&#39;s non-empty, otherwise return empty strin...
Definition: Linker.php:1492
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
Exception representing a failure to serialize or unserialize a content object.