3 * Edit rollback user interface
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 * User interface for the rollback action
28 class RollbackAction
extends FormlessAction
{
30 public function getName() {
34 public function getRestriction() {
39 * Temporarily unused message keys due to T88044/T136375:
40 * - confirm-rollback-top
41 * - confirm-rollback-button
43 * - rollback-missingparam
44 * - rollback-success-notify
48 * @throws ErrorPageError
50 public function onView() {
51 // TODO: use $this->useTransactionalTimeLimit(); when POST only
52 wfTransactionalTimeLimit();
54 $request = $this->getRequest();
55 $user = $this->getUser();
56 $from = $request->getVal( 'from' );
57 $rev = $this->page
->getRevision();
58 if ( $from === null ) {
59 throw new ErrorPageError( 'rollbackfailed', 'rollback-missingparam' );
62 throw new ErrorPageError( 'rollbackfailed', 'rollback-missingrevision' );
64 if ( $from !== $rev->getUserText() ) {
65 throw new ErrorPageError( 'rollbackfailed', 'alreadyrolled', [
66 $this->getTitle()->getPrefixedText(),
72 // @TODO: remove this hack once rollback uses POST (T88044)
74 $trxLimits = $this->context
->getConfig()->get( 'TrxProfilerLimits' );
75 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
76 $trxProfiler->redefineExpectations( $trxLimits['POST'], $fname );
77 DeferredUpdates
::addCallableUpdate( function () use ( $trxProfiler, $trxLimits, $fname ) {
78 $trxProfiler->redefineExpectations( $trxLimits['PostSend-POST'], $fname );
82 $errors = $this->page
->doRollback(
84 $request->getText( 'summary' ),
85 $request->getVal( 'token' ),
86 $request->getBool( 'bot' ),
91 if ( in_array( [ 'actionthrottledtext' ], $errors ) ) {
92 throw new ThrottledError
;
95 if ( isset( $errors[0][0] ) &&
96 ( $errors[0][0] == 'alreadyrolled' ||
$errors[0][0] == 'cantrollback' )
98 $this->getOutput()->setPageTitle( $this->msg( 'rollbackfailed' ) );
99 $errArray = $errors[0];
100 $errMsg = array_shift( $errArray );
101 $this->getOutput()->addWikiMsgArray( $errMsg, $errArray );
103 if ( isset( $data['current'] ) ) {
104 /** @var Revision $current */
105 $current = $data['current'];
107 if ( $current->getComment() != '' ) {
108 $this->getOutput()->addWikiMsg(
111 Linker
::formatComment( $current->getComment() )
120 # NOTE: Permission errors already handled by Action::checkExecute.
121 if ( $errors == [ [ 'readonlytext' ] ] ) {
122 throw new ReadOnlyError
;
125 # XXX: Would be nice if ErrorPageError could take multiple errors, and/or a status object.
126 # Right now, we only show the first error
127 foreach ( $errors as $error ) {
128 throw new ErrorPageError( 'rollbackfailed', $error[0], array_slice( $error, 1 ) );
131 /** @var Revision $current */
132 $current = $data['current'];
133 $target = $data['target'];
134 $newId = $data['newid'];
135 $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
136 $this->getOutput()->setRobotPolicy( 'noindex,nofollow' );
138 $old = Linker
::revUserTools( $current );
139 $new = Linker
::revUserTools( $target );
140 $this->getOutput()->addHTML(
141 $this->msg( 'rollback-success' )
142 ->rawParams( $old, $new )
143 ->params( $current->getUserText( Revision
::FOR_THIS_USER
, $user ) )
144 ->params( $target->getUserText( Revision
::FOR_THIS_USER
, $user ) )
148 if ( $user->getBoolOption( 'watchrollback' ) ) {
149 $user->addWatch( $this->page
->getTitle(), User
::IGNORE_USER_RIGHTS
);
152 $this->getOutput()->returnToMain( false, $this->getTitle() );
154 if ( !$request->getBool( 'hidediff', false ) &&
155 !$this->getUser()->getBoolOption( 'norollbackdiff' )
157 $contentHandler = $current->getContentHandler();
158 $de = $contentHandler->createDifferenceEngine(
165 $de->showDiff( '', '' );
169 protected function getDescription() {
173 public function doesWrites() {