3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
25 use MediaWiki\MediaWikiServices
;
26 use Wikimedia\Rdbms\ResultWrapper
;
27 use Wikimedia\Rdbms\FakeResultWrapper
;
29 class DeletedContribsPager
extends IndexPager
{
31 public $mDefaultDirection = IndexPager
::DIR_DESCENDING
;
34 public $namespace = '';
38 * @var string Navigation bar with paging links.
40 protected $mNavigationBar;
42 function __construct( IContextSource
$context, $target, $namespace = false ) {
43 parent
::__construct( $context );
44 $msgs = [ 'deletionlog', 'undeleteviewlink', 'diff' ];
45 foreach ( $msgs as $msg ) {
46 $this->messages
[$msg] = $this->msg( $msg )->text();
48 $this->target
= $target;
49 $this->namespace = $namespace;
50 $this->mDb
= wfGetDB( DB_REPLICA
, 'contributions' );
53 function getDefaultQuery() {
54 $query = parent
::getDefaultQuery();
55 $query['target'] = $this->target
;
60 function getQueryInfo() {
61 list( $index, $userCond ) = $this->getUserCond();
62 $conds = array_merge( $userCond, $this->getNamespaceCond() );
63 $user = $this->getUser();
64 // Paranoia: avoid brute force searches (T19792)
65 if ( !$user->isAllowed( 'deletedhistory' ) ) {
66 $conds[] = $this->mDb
->bitAnd( 'ar_deleted', Revision
::DELETED_USER
) . ' = 0';
67 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
68 $conds[] = $this->mDb
->bitAnd( 'ar_deleted', Revision
::SUPPRESSED_USER
) .
69 ' != ' . Revision
::SUPPRESSED_USER
;
73 'tables' => [ 'archive' ],
75 'ar_rev_id', 'ar_namespace', 'ar_title', 'ar_timestamp', 'ar_comment',
76 'ar_minor_edit', 'ar_user', 'ar_user_text', 'ar_deleted'
79 'options' => [ 'USE INDEX' => $index ]
84 * This method basically executes the exact same code as the parent class, though with
85 * a hook added, to allow extensions to add additional queries.
87 * @param string $offset Index offset, inclusive
88 * @param int $limit Exact query limit
89 * @param bool $descending Query direction, false for ascending, true for descending
90 * @return ResultWrapper
92 function reallyDoQuery( $offset, $limit, $descending ) {
93 $data = [ parent
::reallyDoQuery( $offset, $limit, $descending ) ];
95 // This hook will allow extensions to add in additional queries, nearly
96 // identical to ContribsPager::reallyDoQuery.
98 'DeletedContribsPager::reallyDoQuery',
99 [ &$data, $this, $offset, $limit, $descending ]
104 // loop all results and collect them in an array
105 foreach ( $data as $query ) {
106 foreach ( $query as $i => $row ) {
107 // use index column as key, allowing us to easily sort in PHP
108 $result[$row->{$this->getIndexField()} . "-$i"] = $row;
120 $result = array_slice( $result, 0, $limit );
122 // get rid of array keys
123 $result = array_values( $result );
125 return new FakeResultWrapper( $result );
128 function getUserCond() {
131 $condition['ar_user_text'] = $this->target
;
132 $index = 'usertext_timestamp';
134 return [ $index, $condition ];
137 function getIndexField() {
138 return 'ar_timestamp';
141 function getStartBody() {
145 function getEndBody() {
149 function getNavigationBar() {
150 if ( isset( $this->mNavigationBar
) ) {
151 return $this->mNavigationBar
;
155 'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit
)->escaped(),
156 'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit
)->escaped(),
157 'first' => $this->msg( 'histlast' )->escaped(),
158 'last' => $this->msg( 'histfirst' )->escaped()
161 $pagingLinks = $this->getPagingLinks( $linkTexts );
162 $limitLinks = $this->getLimitLinks();
163 $lang = $this->getLanguage();
164 $limits = $lang->pipeList( $limitLinks );
166 $firstLast = $lang->pipeList( [ $pagingLinks['first'], $pagingLinks['last'] ] );
167 $firstLast = $this->msg( 'parentheses' )->rawParams( $firstLast )->escaped();
168 $prevNext = $this->msg( 'viewprevnext' )
170 $pagingLinks['prev'],
171 $pagingLinks['next'],
174 $separator = $this->msg( 'word-separator' )->escaped();
175 $this->mNavigationBar
= $firstLast . $separator . $prevNext;
177 return $this->mNavigationBar
;
180 function getNamespaceCond() {
181 if ( $this->namespace !== '' ) {
182 return [ 'ar_namespace' => (int)$this->namespace ];
189 * Generates each row in the contributions list.
191 * @todo This would probably look a lot nicer in a table.
192 * @param stdClass $row
195 function formatRow( $row ) {
200 * There may be more than just revision rows. To make sure that we'll only be processing
201 * revisions here, let's _try_ to build a revision out of our row (without displaying
202 * notices though) and then trying to grab data from the built object. If we succeed,
203 * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
204 * to extensions to subscribe to the hook to parse the row.
206 MediaWiki\
suppressWarnings();
208 $rev = Revision
::newFromArchiveRow( $row );
209 $validRevision = (bool)$rev->getId();
210 } catch ( Exception
$e ) {
211 $validRevision = false;
213 MediaWiki\restoreWarnings
();
215 if ( $validRevision ) {
216 $ret = $this->formatRevisionRow( $row );
219 // Let extensions add data
220 Hooks
::run( 'DeletedContributionsLineEnding', [ $this, &$ret, $row, &$classes ] );
222 if ( $classes === [] && $ret === '' ) {
223 wfDebug( "Dropping Special:DeletedContribution row that could not be formatted\n" );
224 $ret = "<!-- Could not format Special:DeletedContribution row. -->\n";
226 $ret = Html
::rawElement( 'li', [ 'class' => $classes ], $ret ) . "\n";
233 * Generates each row in the contributions list for archive entries.
235 * Contributions which are marked "top" are currently on top of the history.
236 * For these contributions, a [rollback] link is shown for users with sysop
237 * privileges. The rollback link restores the most recent version that was not
238 * written by the target user.
240 * @todo This would probably look a lot nicer in a table.
241 * @param stdClass $row
244 function formatRevisionRow( $row ) {
245 $page = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
247 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
249 $rev = new Revision( [
251 'id' => $row->ar_rev_id
,
252 'comment' => $row->ar_comment
,
253 'user' => $row->ar_user
,
254 'user_text' => $row->ar_user_text
,
255 'timestamp' => $row->ar_timestamp
,
256 'minor_edit' => $row->ar_minor_edit
,
257 'deleted' => $row->ar_deleted
,
260 $undelete = SpecialPage
::getTitleFor( 'Undelete' );
262 $logs = SpecialPage
::getTitleFor( 'Log' );
263 $dellog = $linkRenderer->makeKnownLink(
265 $this->messages
['deletionlog'],
269 'page' => $page->getPrefixedText()
273 $reviewlink = $linkRenderer->makeKnownLink(
274 SpecialPage
::getTitleFor( 'Undelete', $page->getPrefixedDBkey() ),
275 $this->messages
['undeleteviewlink']
278 $user = $this->getUser();
280 if ( $user->isAllowed( 'deletedtext' ) ) {
281 $last = $linkRenderer->makeKnownLink(
283 $this->messages
['diff'],
286 'target' => $page->getPrefixedText(),
287 'timestamp' => $rev->getTimestamp(),
292 $last = htmlspecialchars( $this->messages
['diff'] );
295 $comment = Linker
::revComment( $rev );
296 $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $user );
298 if ( !$user->isAllowed( 'undelete' ) ||
!$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
299 $link = htmlspecialchars( $date ); // unusable link
301 $link = $linkRenderer->makeKnownLink(
304 [ 'class' => 'mw-changeslist-date' ],
306 'target' => $page->getPrefixedText(),
307 'timestamp' => $rev->getTimestamp()
311 // Style deleted items
312 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
313 $link = '<span class="history-deleted">' . $link . '</span>';
316 $pagelink = $linkRenderer->makeLink(
319 [ 'class' => 'mw-changeslist-title' ]
322 if ( $rev->isMinor() ) {
323 $mflag = ChangesList
::flag( 'minor' );
328 // Revision delete link
329 $del = Linker
::getRevDeleteLink( $user, $rev, $page );
334 $tools = Html
::rawElement(
336 [ 'class' => 'mw-deletedcontribs-tools' ],
337 $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList(
338 [ $last, $dellog, $reviewlink ] ) )->escaped()
341 $separator = '<span class="mw-changeslist-separator">. .</span>';
342 $ret = "{$del}{$link} {$tools} {$separator} {$mflag} {$pagelink} {$comment}";
344 # Denote if username is redacted for this edit
345 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
346 $ret .= " <strong>" . $this->msg( 'rev-deleted-user-contribs' )->escaped() . "</strong>";
353 * Get the Database object in use
357 public function getDatabase() {