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\IDatabase;
  27 use Wikimedia\Rdbms\IResultWrapper;
  28 use Wikimedia\Rdbms\FakeResultWrapper;
  29
  30 class DeletedContribsPager extends IndexPager {
  31
  32         public $mDefaultDirection = IndexPager::DIR_DESCENDING;
  33         public $messages;
  34         public $target;
  35         public $namespace = '';
  36         public $mDb;
  37
  38         /**
  39          * @var string Navigation bar with paging links.
  40          */
  41         protected $mNavigationBar;
  42
  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();
  48                 }
  49                 $this->target = $target;
  50                 $this->namespace = $namespace;
  51                 $this->mDb = wfGetDB( DB_REPLICA, 'contributions' );
  52         }
  53
  54         function getDefaultQuery() {
  55                 $query = parent::getDefaultQuery();
  56                 $query['target'] = $this->target;
  57
  58                 return $query;
  59         }
  60
  61         function getQueryInfo() {
  62                 $userCond = [
  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
  66                         )['conds']
  67                 ];
  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;
  76                 }
  77
  78                 $commentQuery = CommentStore::getStore()->getJoin( 'ar_comment' );
  79                 $actorQuery = ActorMigration::newMigration()->getJoin( 'ar_user' );
  80
  81                 return [
  82                         'tables' => [ 'archive' ] + $commentQuery['tables'] + $actorQuery['tables'],
  83                         'fields' => [
  84                                 'ar_rev_id', 'ar_namespace', 'ar_title', 'ar_timestamp',
  85                                 'ar_minor_edit', 'ar_deleted'
  86                         ] + $commentQuery['fields'] + $actorQuery['fields'],
  87                         'conds' => $conds,
  88                         'options' => [],
  89                         'join_conds' => $commentQuery['joins'] + $actorQuery['joins'],
  90                 ];
  91         }
  92
  93         /**
  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.
  96          *
  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
 101          */
 102         function reallyDoQuery( $offset, $limit, $descending ) {
 103                 $data = [ parent::reallyDoQuery( $offset, $limit, $descending ) ];
 104
 105                 // This hook will allow extensions to add in additional queries, nearly
 106                 // identical to ContribsPager::reallyDoQuery.
 107                 Hooks::run(
 108                         'DeletedContribsPager::reallyDoQuery',
 109                         [ &$data, $this, $offset, $limit, $descending ]
 110                 );
 111
 112                 $result = [];
 113
 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;
 119                         }
 120                 }
 121
 122                 // sort results
 123                 if ( $descending ) {
 124                         ksort( $result );
 125                 } else {
 126                         krsort( $result );
 127                 }
 128
 129                 // enforce limit
 130                 $result = array_slice( $result, 0, $limit );
 131
 132                 // get rid of array keys
 133                 $result = array_values( $result );
 134
 135                 return new FakeResultWrapper( $result );
 136         }
 137
 138         function getIndexField() {
 139                 return 'ar_timestamp';
 140         }
 141
 142         function getStartBody() {
 143                 return "<ul>\n";
 144         }
 145
 146         function getEndBody() {
 147                 return "</ul>\n";
 148         }
 149
 150         function getNavigationBar() {
 151                 if ( isset( $this->mNavigationBar ) ) {
 152                         return $this->mNavigationBar;
 153                 }
 154
 155                 $linkTexts = [
 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()
 160                 ];
 161
 162                 $pagingLinks = $this->getPagingLinks( $linkTexts );
 163                 $limitLinks = $this->getLimitLinks();
 164                 $lang = $this->getLanguage();
 165                 $limits = $lang->pipeList( $limitLinks );
 166
 167                 $firstLast = $lang->pipeList( [ $pagingLinks['first'], $pagingLinks['last'] ] );
 168                 $firstLast = $this->msg( 'parentheses' )->rawParams( $firstLast )->escaped();
 169                 $prevNext = $this->msg( 'viewprevnext' )
 170                         ->rawParams(
 171                                 $pagingLinks['prev'],
 172                                 $pagingLinks['next'],
 173                                 $limits
 174                         )->escaped();
 175                 $separator = $this->msg( 'word-separator' )->escaped();
 176                 $this->mNavigationBar = $firstLast . $separator . $prevNext;
 177
 178                 return $this->mNavigationBar;
 179         }
 180
 181         function getNamespaceCond() {
 182                 if ( $this->namespace !== '' ) {
 183                         return [ 'ar_namespace' => (int)$this->namespace ];
 184                 } else {
 185                         return [];
 186                 }
 187         }
 188
 189         /**
 190          * Generates each row in the contributions list.
 191          *
 192          * @todo This would probably look a lot nicer in a table.
 193          * @param stdClass $row
 194          * @return string
 195          */
 196         function formatRow( $row ) {
 197                 $ret = '';
 198                 $classes = [];
 199                 $attribs = [];
 200
 201                 /*
 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.
 207                  */
 208                 Wikimedia\suppressWarnings();
 209                 try {
 210                         $rev = Revision::newFromArchiveRow( $row );
 211                         $validRevision = (bool)$rev->getId();
 212                 } catch ( Exception $e ) {
 213                         $validRevision = false;
 214                 }
 215                 Wikimedia\restoreWarnings();
 216
 217                 if ( $validRevision ) {
 218                         $attribs['data-mw-revid'] = $rev->getId();
 219                         $ret = $this->formatRevisionRow( $row );
 220                 }
 221
 222                 // Let extensions add data
 223                 Hooks::run( 'DeletedContributionsLineEnding', [ $this, &$ret, $row, &$classes, &$attribs ] );
 224                 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer::class, 'isReservedDataAttribute' ] );
 225
 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";
 229                 } else {
 230                         $attribs['class'] = $classes;
 231                         $ret = Html::rawElement( 'li', $attribs, $ret ) . "\n";
 232                 }
 233
 234                 return $ret;
 235         }
 236
 237         /**
 238          * Generates each row in the contributions list for archive entries.
 239          *
 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.
 244          *
 245          * @todo This would probably look a lot nicer in a table.
 246          * @param stdClass $row
 247          * @return string
 248          */
 249         function formatRevisionRow( $row ) {
 250                 $page = Title::makeTitle( $row->ar_namespace, $row->ar_title );
 251
 252                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 253
 254                 $rev = new Revision( [
 255                         'title' => $page,
 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,
 264                 ] );
 265
 266                 $undelete = SpecialPage::getTitleFor( 'Undelete' );
 267
 268                 $logs = SpecialPage::getTitleFor( 'Log' );
 269                 $dellog = $linkRenderer->makeKnownLink(
 270                         $logs,
 271                         $this->messages['deletionlog'],
 272                         [],
 273                         [
 274                                 'type' => 'delete',
 275                                 'page' => $page->getPrefixedText()
 276                         ]
 277                 );
 278
 279                 $reviewlink = $linkRenderer->makeKnownLink(
 280                         SpecialPage::getTitleFor( 'Undelete', $page->getPrefixedDBkey() ),
 281                         $this->messages['undeleteviewlink']
 282                 );
 283
 284                 $user = $this->getUser();
 285
 286                 if ( $user->isAllowed( 'deletedtext' ) ) {
 287                         $last = $linkRenderer->makeKnownLink(
 288                                 $undelete,
 289                                 $this->messages['diff'],
 290                                 [],
 291                                 [
 292                                         'target' => $page->getPrefixedText(),
 293                                         'timestamp' => $rev->getTimestamp(),
 294                                         'diff' => 'prev'
 295                                 ]
 296                         );
 297                 } else {
 298                         $last = htmlspecialchars( $this->messages['diff'] );
 299                 }
 300
 301                 $comment = Linker::revComment( $rev );
 302                 $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $user );
 303
 304                 if ( !$user->isAllowed( 'undelete' ) || !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
 305                         $link = htmlspecialchars( $date ); // unusable link
 306                 } else {
 307                         $link = $linkRenderer->makeKnownLink(
 308                                 $undelete,
 309                                 $date,
 310                                 [ 'class' => 'mw-changeslist-date' ],
 311                                 [
 312                                         'target' => $page->getPrefixedText(),
 313                                         'timestamp' => $rev->getTimestamp()
 314                                 ]
 315                         );
 316                 }
 317                 // Style deleted items
 318                 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 319                         $link = '<span class="history-deleted">' . $link . '</span>';
 320                 }
 321
 322                 $pagelink = $linkRenderer->makeLink(
 323                         $page,
 324                         null,
 325                         [ 'class' => 'mw-changeslist-title' ]
 326                 );
 327
 328                 if ( $rev->isMinor() ) {
 329                         $mflag = ChangesList::flag( 'minor' );
 330                 } else {
 331                         $mflag = '';
 332                 }
 333
 334                 // Revision delete link
 335                 $del = Linker::getRevDeleteLink( $user, $rev, $page );
 336                 if ( $del ) {
 337                         $del .= ' ';
 338                 }
 339
 340                 $tools = Html::rawElement(
 341                         'span',
 342                         [ 'class' => 'mw-deletedcontribs-tools' ],
 343                         $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList(
 344                                 [ $last, $dellog, $reviewlink ] ) )->escaped()
 345                 );
 346
 347                 $separator = '<span class="mw-changeslist-separator">. .</span>';
 348                 $ret = "{$del}{$link} {$tools} {$separator} {$mflag} {$pagelink} {$comment}";
 349
 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>";
 353                 }
 354
 355                 return $ret;
 356         }
 357
 358         /**
 359          * Get the Database object in use
 360          *
 361          * @return IDatabase
 362          */
 363         public function getDatabase() {
 364                 return $this->mDb;
 365         }
 366 }