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\IDatabase
;
27 use Wikimedia\Rdbms\IResultWrapper
;
28 use Wikimedia\Rdbms\FakeResultWrapper
;
30 class DeletedContribsPager
extends IndexPager
{
32 public $mDefaultDirection = IndexPager
::DIR_DESCENDING
;
35 public $namespace = '';
39 * @var string Navigation bar with paging links.
41 protected $mNavigationBar;
43 function __construct( IContextSource
$context, $target, $namespace = false ) {
44 parent
::__construct( $context );
45 $msgs = [ 'deletionlog', 'undeleteviewlink', 'diff' ];
46 foreach ( $msgs as $msg ) {
47 $this->messages
[$msg] = $this->msg( $msg )->text();
49 $this->target
= $target;
50 $this->namespace = $namespace;
51 $this->mDb
= wfGetDB( DB_REPLICA
, 'contributions' );
54 function getDefaultQuery() {
55 $query = parent
::getDefaultQuery();
56 $query['target'] = $this->target
;
61 function getQueryInfo() {
63 // ->getJoin() below takes care of any joins needed
64 ActorMigration
::newMigration()->getWhere(
65 wfGetDB( DB_REPLICA
), 'ar_user', User
::newFromName( $this->target
, false ), false
68 $conds = array_merge( $userCond, $this->getNamespaceCond() );
69 $user = $this->getUser();
70 // Paranoia: avoid brute force searches (T19792)
71 if ( !$user->isAllowed( 'deletedhistory' ) ) {
72 $conds[] = $this->mDb
->bitAnd( 'ar_deleted', Revision
::DELETED_USER
) . ' = 0';
73 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
74 $conds[] = $this->mDb
->bitAnd( 'ar_deleted', Revision
::SUPPRESSED_USER
) .
75 ' != ' . Revision
::SUPPRESSED_USER
;
78 $commentQuery = CommentStore
::getStore()->getJoin( 'ar_comment' );
79 $actorQuery = ActorMigration
::newMigration()->getJoin( 'ar_user' );
82 'tables' => [ 'archive' ] +
$commentQuery['tables'] +
$actorQuery['tables'],
84 'ar_rev_id', 'ar_namespace', 'ar_title', 'ar_timestamp',
85 'ar_minor_edit', 'ar_deleted'
86 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
89 'join_conds' => $commentQuery['joins'] +
$actorQuery['joins'],
94 * This method basically executes the exact same code as the parent class, though with
95 * a hook added, to allow extensions to add additional queries.
97 * @param string $offset Index offset, inclusive
98 * @param int $limit Exact query limit
99 * @param bool $descending Query direction, false for ascending, true for descending
100 * @return IResultWrapper
102 function reallyDoQuery( $offset, $limit, $descending ) {
103 $data = [ parent
::reallyDoQuery( $offset, $limit, $descending ) ];
105 // This hook will allow extensions to add in additional queries, nearly
106 // identical to ContribsPager::reallyDoQuery.
108 'DeletedContribsPager::reallyDoQuery',
109 [ &$data, $this, $offset, $limit, $descending ]
114 // loop all results and collect them in an array
115 foreach ( $data as $query ) {
116 foreach ( $query as $i => $row ) {
117 // use index column as key, allowing us to easily sort in PHP
118 $result[$row->{$this->getIndexField()} . "-$i"] = $row;
130 $result = array_slice( $result, 0, $limit );
132 // get rid of array keys
133 $result = array_values( $result );
135 return new FakeResultWrapper( $result );
138 function getIndexField() {
139 return 'ar_timestamp';
142 function getStartBody() {
146 function getEndBody() {
150 function getNavigationBar() {
151 if ( isset( $this->mNavigationBar
) ) {
152 return $this->mNavigationBar
;
156 'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit
)->escaped(),
157 'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit
)->escaped(),
158 'first' => $this->msg( 'histlast' )->escaped(),
159 'last' => $this->msg( 'histfirst' )->escaped()
162 $pagingLinks = $this->getPagingLinks( $linkTexts );
163 $limitLinks = $this->getLimitLinks();
164 $lang = $this->getLanguage();
165 $limits = $lang->pipeList( $limitLinks );
167 $firstLast = $lang->pipeList( [ $pagingLinks['first'], $pagingLinks['last'] ] );
168 $firstLast = $this->msg( 'parentheses' )->rawParams( $firstLast )->escaped();
169 $prevNext = $this->msg( 'viewprevnext' )
171 $pagingLinks['prev'],
172 $pagingLinks['next'],
175 $separator = $this->msg( 'word-separator' )->escaped();
176 $this->mNavigationBar
= $firstLast . $separator . $prevNext;
178 return $this->mNavigationBar
;
181 function getNamespaceCond() {
182 if ( $this->namespace !== '' ) {
183 return [ 'ar_namespace' => (int)$this->namespace ];
190 * Generates each row in the contributions list.
192 * @todo This would probably look a lot nicer in a table.
193 * @param stdClass $row
196 function formatRow( $row ) {
202 * There may be more than just revision rows. To make sure that we'll only be processing
203 * revisions here, let's _try_ to build a revision out of our row (without displaying
204 * notices though) and then trying to grab data from the built object. If we succeed,
205 * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
206 * to extensions to subscribe to the hook to parse the row.
208 Wikimedia\
suppressWarnings();
210 $rev = Revision
::newFromArchiveRow( $row );
211 $validRevision = (bool)$rev->getId();
212 } catch ( Exception
$e ) {
213 $validRevision = false;
215 Wikimedia\restoreWarnings
();
217 if ( $validRevision ) {
218 $attribs['data-mw-revid'] = $rev->getId();
219 $ret = $this->formatRevisionRow( $row );
222 // Let extensions add data
223 Hooks
::run( 'DeletedContributionsLineEnding', [ $this, &$ret, $row, &$classes, &$attribs ] );
224 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer
::class, 'isReservedDataAttribute' ] );
226 if ( $classes === [] && $attribs === [] && $ret === '' ) {
227 wfDebug( "Dropping Special:DeletedContribution row that could not be formatted\n" );
228 $ret = "<!-- Could not format Special:DeletedContribution row. -->\n";
230 $attribs['class'] = $classes;
231 $ret = Html
::rawElement( 'li', $attribs, $ret ) . "\n";
238 * Generates each row in the contributions list for archive entries.
240 * Contributions which are marked "top" are currently on top of the history.
241 * For these contributions, a [rollback] link is shown for users with sysop
242 * privileges. The rollback link restores the most recent version that was not
243 * written by the target user.
245 * @todo This would probably look a lot nicer in a table.
246 * @param stdClass $row
249 function formatRevisionRow( $row ) {
250 $page = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
252 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
254 $rev = new Revision( [
256 'id' => $row->ar_rev_id
,
257 'comment' => CommentStore
::getStore()->getComment( 'ar_comment', $row )->text
,
258 'user' => $row->ar_user
,
259 'user_text' => $row->ar_user_text
,
260 'actor' => $row->ar_actor ??
null,
261 'timestamp' => $row->ar_timestamp
,
262 'minor_edit' => $row->ar_minor_edit
,
263 'deleted' => $row->ar_deleted
,
266 $undelete = SpecialPage
::getTitleFor( 'Undelete' );
268 $logs = SpecialPage
::getTitleFor( 'Log' );
269 $dellog = $linkRenderer->makeKnownLink(
271 $this->messages
['deletionlog'],
275 'page' => $page->getPrefixedText()
279 $reviewlink = $linkRenderer->makeKnownLink(
280 SpecialPage
::getTitleFor( 'Undelete', $page->getPrefixedDBkey() ),
281 $this->messages
['undeleteviewlink']
284 $user = $this->getUser();
286 if ( $user->isAllowed( 'deletedtext' ) ) {
287 $last = $linkRenderer->makeKnownLink(
289 $this->messages
['diff'],
292 'target' => $page->getPrefixedText(),
293 'timestamp' => $rev->getTimestamp(),
298 $last = htmlspecialchars( $this->messages
['diff'] );
301 $comment = Linker
::revComment( $rev );
302 $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $user );
304 if ( !$user->isAllowed( 'undelete' ) ||
!$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
305 $link = htmlspecialchars( $date ); // unusable link
307 $link = $linkRenderer->makeKnownLink(
310 [ 'class' => 'mw-changeslist-date' ],
312 'target' => $page->getPrefixedText(),
313 'timestamp' => $rev->getTimestamp()
317 // Style deleted items
318 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
319 $link = '<span class="history-deleted">' . $link . '</span>';
322 $pagelink = $linkRenderer->makeLink(
325 [ 'class' => 'mw-changeslist-title' ]
328 if ( $rev->isMinor() ) {
329 $mflag = ChangesList
::flag( 'minor' );
334 // Revision delete link
335 $del = Linker
::getRevDeleteLink( $user, $rev, $page );
340 $tools = Html
::rawElement(
342 [ 'class' => 'mw-deletedcontribs-tools' ],
343 $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList(
344 [ $last, $dellog, $reviewlink ] ) )->escaped()
347 $separator = '<span class="mw-changeslist-separator">. .</span>';
348 $ret = "{$del}{$link} {$tools} {$separator} {$mflag} {$pagelink} {$comment}";
350 # Denote if username is redacted for this edit
351 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
352 $ret .= " <strong>" . $this->msg( 'rev-deleted-user-contribs' )->escaped() . "</strong>";
359 * Get the Database object in use
363 public function getDatabase() {