Merge "RollbackAction/SpecialUndelete: Use OutputPage::addWikiMsg() where possible"
[lhc/web/wiklou.git] / includes / actions / RollbackAction.php
1 <?php
2 /**
3 * Edit rollback user interface
4 *
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.
9 *
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.
14 *
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
18 *
19 * @file
20 * @ingroup Actions
21 */
22
23 /**
24 * User interface for the rollback action
25 *
26 * @ingroup Actions
27 */
28 class RollbackAction extends FormlessAction {
29
30 public function getName() {
31 return 'rollback';
32 }
33
34 public function getRestriction() {
35 return 'rollback';
36 }
37
38 /**
39 * Temporarily unused message keys due to T88044/T136375:
40 * - confirm-rollback-top
41 * - confirm-rollback-button
42 * - rollbackfailed
43 * - rollback-missingparam
44 * - rollback-success-notify
45 */
46
47 /**
48 * @throws ErrorPageError
49 */
50 public function onView() {
51 // TODO: use $this->useTransactionalTimeLimit(); when POST only
52 wfTransactionalTimeLimit();
53
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' );
60 }
61 if ( !$rev ) {
62 throw new ErrorPageError( 'rollbackfailed', 'rollback-missingrevision' );
63 }
64 if ( $from !== $rev->getUserText() ) {
65 throw new ErrorPageError( 'rollbackfailed', 'alreadyrolled', [
66 $this->getTitle()->getPrefixedText(),
67 $from,
68 $rev->getUserText()
69 ] );
70 }
71
72 // @TODO: remove this hack once rollback uses POST (T88044)
73 $trxLimits = $this->context->getConfig()->get( 'TrxProfilerLimits' );
74 $trxProfiler = Profiler::instance()->getTransactionProfiler();
75 $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
76
77 $data = null;
78 $errors = $this->page->doRollback(
79 $from,
80 $request->getText( 'summary' ),
81 $request->getVal( 'token' ),
82 $request->getBool( 'bot' ),
83 $data,
84 $this->getUser()
85 );
86
87 if ( in_array( [ 'actionthrottledtext' ], $errors ) ) {
88 throw new ThrottledError;
89 }
90
91 if ( isset( $errors[0][0] ) &&
92 ( $errors[0][0] == 'alreadyrolled' || $errors[0][0] == 'cantrollback' )
93 ) {
94 $this->getOutput()->setPageTitle( $this->msg( 'rollbackfailed' ) );
95 $errArray = $errors[0];
96 $errMsg = array_shift( $errArray );
97 $this->getOutput()->addWikiMsgArray( $errMsg, $errArray );
98
99 if ( isset( $data['current'] ) ) {
100 /** @var Revision $current */
101 $current = $data['current'];
102
103 if ( $current->getComment() != '' ) {
104 $this->getOutput()->addWikiMsg(
105 'editcomment',
106 Message::rawParam(
107 Linker::formatComment( $current->getComment() )
108 )
109 );
110 }
111 }
112
113 return;
114 }
115
116 # NOTE: Permission errors already handled by Action::checkExecute.
117 if ( $errors == [ [ 'readonlytext' ] ] ) {
118 throw new ReadOnlyError;
119 }
120
121 # XXX: Would be nice if ErrorPageError could take multiple errors, and/or a status object.
122 # Right now, we only show the first error
123 foreach ( $errors as $error ) {
124 throw new ErrorPageError( 'rollbackfailed', $error[0], array_slice( $error, 1 ) );
125 }
126
127 /** @var Revision $current */
128 $current = $data['current'];
129 $target = $data['target'];
130 $newId = $data['newid'];
131 $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
132 $this->getOutput()->setRobotPolicy( 'noindex,nofollow' );
133
134 $old = Linker::revUserTools( $current );
135 $new = Linker::revUserTools( $target );
136 $this->getOutput()->addHTML(
137 $this->msg( 'rollback-success' )
138 ->rawParams( $old, $new )
139 ->params( $current->getUserText( Revision::FOR_THIS_USER, $user ) )
140 ->params( $target->getUserText( Revision::FOR_THIS_USER, $user ) )
141 ->parseAsBlock()
142 );
143
144 if ( $user->getBoolOption( 'watchrollback' ) ) {
145 $user->addWatch( $this->page->getTitle(), User::IGNORE_USER_RIGHTS );
146 }
147
148 $this->getOutput()->returnToMain( false, $this->getTitle() );
149
150 if ( !$request->getBool( 'hidediff', false ) &&
151 !$this->getUser()->getBoolOption( 'norollbackdiff' )
152 ) {
153 $contentHandler = $current->getContentHandler();
154 $de = $contentHandler->createDifferenceEngine(
155 $this->getContext(),
156 $current->getId(),
157 $newId,
158 false,
159 true
160 );
161 $de->showDiff( '', '' );
162 }
163 }
164
165 protected function getDescription() {
166 return '';
167 }
168
169 public function doesWrites() {
170 return true;
171 }
172 }