includes/specials/pagers/DeletedContribsPager.php

   1 <?php
   2 /**
   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.
   7  *
   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.
  12  *
  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
  17  *
  18  * @file
  19  * @ingroup Pager
  20  */
  21
  22 /**
  23  * @ingroup Pager
  24  */
  25 use MediaWiki\MediaWikiServices;
  26 use Wikimedia\Rdbms\ResultWrapper;
  27 use Wikimedia\Rdbms\FakeResultWrapper;
  28
  29 class DeletedContribsPager extends IndexPager {
  30
  31         public $mDefaultDirection = IndexPager::DIR_DESCENDING;
  32         public $messages;
  33         public $target;
  34         public $namespace = '';
  35         public $mDb;
  36
  37         /**
  38          * @var string Navigation bar with paging links.
  39          */
  40         protected $mNavigationBar;
  41
  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();
  47                 }
  48                 $this->target = $target;
  49                 $this->namespace = $namespace;
  50                 $this->mDb = wfGetDB( DB_REPLICA, 'contributions' );
  51         }
  52
  53         function getDefaultQuery() {
  54                 $query = parent::getDefaultQuery();
  55                 $query['target'] = $this->target;
  56
  57                 return $query;
  58         }
  59
  60         function getQueryInfo() {
  61                 $userCond = [
  62                         // ->getJoin() below takes care of any joins needed
  63                         ActorMigration::newMigration()->getWhere(
  64                                 wfGetDB( DB_REPLICA ), 'ar_user', User::newFromName( $this->target, false ), false
  65                         )['conds']
  66                 ];
  67                 $conds = array_merge( $userCond, $this->getNamespaceCond() );
  68                 $user = $this->getUser();
  69                 // Paranoia: avoid brute force searches (T19792)
  70                 if ( !$user->isAllowed( 'deletedhistory' ) ) {
  71                         $conds[] = $this->mDb->bitAnd( 'ar_deleted', Revision::DELETED_USER ) . ' = 0';
  72                 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
  73                         $conds[] = $this->mDb->bitAnd( 'ar_deleted', Revision::SUPPRESSED_USER ) .
  74                                 ' != ' . Revision::SUPPRESSED_USER;
  75                 }
  76
  77                 $commentQuery = CommentStore::getStore()->getJoin( 'ar_comment' );
  78                 $actorQuery = ActorMigration::newMigration()->getJoin( 'ar_user' );
  79
  80                 return [
  81                         'tables' => [ 'archive' ] + $commentQuery['tables'] + $actorQuery['tables'],
  82                         'fields' => [
  83                                 'ar_rev_id', 'ar_namespace', 'ar_title', 'ar_timestamp',
  84                                 'ar_minor_edit', 'ar_deleted'
  85                         ] + $commentQuery['fields'] + $actorQuery['fields'],
  86                         'conds' => $conds,
  87                         'options' => [],
  88                         'join_conds' => $commentQuery['joins'] + $actorQuery['joins'],
  89                 ];
  90         }
  91
  92         /**
  93          * This method basically executes the exact same code as the parent class, though with
  94          * a hook added, to allow extensions to add additional queries.
  95          *
  96          * @param string $offset Index offset, inclusive
  97          * @param int $limit Exact query limit
  98          * @param bool $descending Query direction, false for ascending, true for descending
  99          * @return ResultWrapper
 100          */
 101         function reallyDoQuery( $offset, $limit, $descending ) {
 102                 $data = [ parent::reallyDoQuery( $offset, $limit, $descending ) ];
 103
 104                 // This hook will allow extensions to add in additional queries, nearly
 105                 // identical to ContribsPager::reallyDoQuery.
 106                 Hooks::run(
 107                         'DeletedContribsPager::reallyDoQuery',
 108                         [ &$data, $this, $offset, $limit, $descending ]
 109                 );
 110
 111                 $result = [];
 112
 113                 // loop all results and collect them in an array
 114                 foreach ( $data as $query ) {
 115                         foreach ( $query as $i => $row ) {
 116                                 // use index column as key, allowing us to easily sort in PHP
 117                                 $result[$row->{$this->getIndexField()} . "-$i"] = $row;
 118                         }
 119                 }
 120
 121                 // sort results
 122                 if ( $descending ) {
 123                         ksort( $result );
 124                 } else {
 125                         krsort( $result );
 126                 }
 127
 128                 // enforce limit
 129                 $result = array_slice( $result, 0, $limit );
 130
 131                 // get rid of array keys
 132                 $result = array_values( $result );
 133
 134                 return new FakeResultWrapper( $result );
 135         }
 136
 137         function getIndexField() {
 138                 return 'ar_timestamp';
 139         }
 140
 141         function getStartBody() {
 142                 return "<ul>\n";
 143         }
 144
 145         function getEndBody() {
 146                 return "</ul>\n";
 147         }
 148
 149         function getNavigationBar() {
 150                 if ( isset( $this->mNavigationBar ) ) {
 151                         return $this->mNavigationBar;
 152                 }
 153
 154                 $linkTexts = [
 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()
 159                 ];
 160
 161                 $pagingLinks = $this->getPagingLinks( $linkTexts );
 162                 $limitLinks = $this->getLimitLinks();
 163                 $lang = $this->getLanguage();
 164                 $limits = $lang->pipeList( $limitLinks );
 165
 166                 $firstLast = $lang->pipeList( [ $pagingLinks['first'], $pagingLinks['last'] ] );
 167                 $firstLast = $this->msg( 'parentheses' )->rawParams( $firstLast )->escaped();
 168                 $prevNext = $this->msg( 'viewprevnext' )
 169                         ->rawParams(
 170                                 $pagingLinks['prev'],
 171                                 $pagingLinks['next'],
 172                                 $limits
 173                         )->escaped();
 174                 $separator = $this->msg( 'word-separator' )->escaped();
 175                 $this->mNavigationBar = $firstLast . $separator . $prevNext;
 176
 177                 return $this->mNavigationBar;
 178         }
 179
 180         function getNamespaceCond() {
 181                 if ( $this->namespace !== '' ) {
 182                         return [ 'ar_namespace' => (int)$this->namespace ];
 183                 } else {
 184                         return [];
 185                 }
 186         }
 187
 188         /**
 189          * Generates each row in the contributions list.
 190          *
 191          * @todo This would probably look a lot nicer in a table.
 192          * @param stdClass $row
 193          * @return string
 194          */
 195         function formatRow( $row ) {
 196                 $ret = '';
 197                 $classes = [];
 198                 $attribs = [];
 199
 200                 /*
 201                  * There may be more than just revision rows. To make sure that we'll only be processing
 202                  * revisions here, let's _try_ to build a revision out of our row (without displaying
 203                  * notices though) and then trying to grab data from the built object. If we succeed,
 204                  * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
 205                  * to extensions to subscribe to the hook to parse the row.
 206                  */
 207                 Wikimedia\suppressWarnings();
 208                 try {
 209                         $rev = Revision::newFromArchiveRow( $row );
 210                         $validRevision = (bool)$rev->getId();
 211                 } catch ( Exception $e ) {
 212                         $validRevision = false;
 213                 }
 214                 Wikimedia\restoreWarnings();
 215
 216                 if ( $validRevision ) {
 217                         $attribs['data-mw-revid'] = $rev->getId();
 218                         $ret = $this->formatRevisionRow( $row );
 219                 }
 220
 221                 // Let extensions add data
 222                 Hooks::run( 'DeletedContributionsLineEnding', [ $this, &$ret, $row, &$classes, &$attribs ] );
 223                 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer::class, 'isReservedDataAttribute' ] );
 224
 225                 if ( $classes === [] && $attribs === [] && $ret === '' ) {
 226                         wfDebug( "Dropping Special:DeletedContribution row that could not be formatted\n" );
 227                         $ret = "<!-- Could not format Special:DeletedContribution row. -->\n";
 228                 } else {
 229                         $attribs['class'] = $classes;
 230                         $ret = Html::rawElement( 'li', $attribs, $ret ) . "\n";
 231                 }
 232
 233                 return $ret;
 234         }
 235
 236         /**
 237          * Generates each row in the contributions list for archive entries.
 238          *
 239          * Contributions which are marked "top" are currently on top of the history.
 240          * For these contributions, a [rollback] link is shown for users with sysop
 241          * privileges. The rollback link restores the most recent version that was not
 242          * written by the target user.
 243          *
 244          * @todo This would probably look a lot nicer in a table.
 245          * @param stdClass $row
 246          * @return string
 247          */
 248         function formatRevisionRow( $row ) {
 249                 $page = Title::makeTitle( $row->ar_namespace, $row->ar_title );
 250
 251                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 252
 253                 $rev = new Revision( [
 254                         'title' => $page,
 255                         'id' => $row->ar_rev_id,
 256                         'comment' => CommentStore::getStore()->getComment( 'ar_comment', $row )->text,
 257                         'user' => $row->ar_user,
 258                         'user_text' => $row->ar_user_text,
 259                         'actor' => isset( $row->ar_actor ) ? $row->ar_actor : null,
 260                         'timestamp' => $row->ar_timestamp,
 261                         'minor_edit' => $row->ar_minor_edit,
 262                         'deleted' => $row->ar_deleted,
 263                 ] );
 264
 265                 $undelete = SpecialPage::getTitleFor( 'Undelete' );
 266
 267                 $logs = SpecialPage::getTitleFor( 'Log' );
 268                 $dellog = $linkRenderer->makeKnownLink(
 269                         $logs,
 270                         $this->messages['deletionlog'],
 271                         [],
 272                         [
 273                                 'type' => 'delete',
 274                                 'page' => $page->getPrefixedText()
 275                         ]
 276                 );
 277
 278                 $reviewlink = $linkRenderer->makeKnownLink(
 279                         SpecialPage::getTitleFor( 'Undelete', $page->getPrefixedDBkey() ),
 280                         $this->messages['undeleteviewlink']
 281                 );
 282
 283                 $user = $this->getUser();
 284
 285                 if ( $user->isAllowed( 'deletedtext' ) ) {
 286                         $last = $linkRenderer->makeKnownLink(
 287                                 $undelete,
 288                                 $this->messages['diff'],
 289                                 [],
 290                                 [
 291                                         'target' => $page->getPrefixedText(),
 292                                         'timestamp' => $rev->getTimestamp(),
 293                                         'diff' => 'prev'
 294                                 ]
 295                         );
 296                 } else {
 297                         $last = htmlspecialchars( $this->messages['diff'] );
 298                 }
 299
 300                 $comment = Linker::revComment( $rev );
 301                 $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $user );
 302
 303                 if ( !$user->isAllowed( 'undelete' ) || !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
 304                         $link = htmlspecialchars( $date ); // unusable link
 305                 } else {
 306                         $link = $linkRenderer->makeKnownLink(
 307                                 $undelete,
 308                                 $date,
 309                                 [ 'class' => 'mw-changeslist-date' ],
 310                                 [
 311                                         'target' => $page->getPrefixedText(),
 312                                         'timestamp' => $rev->getTimestamp()
 313                                 ]
 314                         );
 315                 }
 316                 // Style deleted items
 317                 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 318                         $link = '<span class="history-deleted">' . $link . '</span>';
 319                 }
 320
 321                 $pagelink = $linkRenderer->makeLink(
 322                         $page,
 323                         null,
 324                         [ 'class' => 'mw-changeslist-title' ]
 325                 );
 326
 327                 if ( $rev->isMinor() ) {
 328                         $mflag = ChangesList::flag( 'minor' );
 329                 } else {
 330                         $mflag = '';
 331                 }
 332
 333                 // Revision delete link
 334                 $del = Linker::getRevDeleteLink( $user, $rev, $page );
 335                 if ( $del ) {
 336                         $del .= ' ';
 337                 }
 338
 339                 $tools = Html::rawElement(
 340                         'span',
 341                         [ 'class' => 'mw-deletedcontribs-tools' ],
 342                         $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList(
 343                                 [ $last, $dellog, $reviewlink ] ) )->escaped()
 344                 );
 345
 346                 $separator = '<span class="mw-changeslist-separator">. .</span>';
 347                 $ret = "{$del}{$link} {$tools} {$separator} {$mflag} {$pagelink} {$comment}";
 348
 349                 # Denote if username is redacted for this edit
 350                 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
 351                         $ret .= " <strong>" . $this->msg( 'rev-deleted-user-contribs' )->escaped() . "</strong>";
 352                 }
 353
 354                 return $ret;
 355         }
 356
 357         /**
 358          * Get the Database object in use
 359          *
 360          * @return IDatabase
 361          */
 362         public function getDatabase() {
 363                 return $this->mDb;
 364         }
 365 }