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                 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;
  70                 }
  71
  72                 return [
  73                         'tables' => [ 'archive' ],
  74                         'fields' => [
  75                                 'ar_rev_id', 'ar_namespace', 'ar_title', 'ar_timestamp', 'ar_comment',
  76                                 'ar_minor_edit', 'ar_user', 'ar_user_text', 'ar_deleted'
  77                         ],
  78                         'conds' => $conds,
  79                         'options' => [ 'USE INDEX' => $index ]
  80                 ];
  81         }
  82
  83         /**
  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.
  86          *
  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
  91          */
  92         function reallyDoQuery( $offset, $limit, $descending ) {
  93                 $data = [ parent::reallyDoQuery( $offset, $limit, $descending ) ];
  94
  95                 // This hook will allow extensions to add in additional queries, nearly
  96                 // identical to ContribsPager::reallyDoQuery.
  97                 Hooks::run(
  98                         'DeletedContribsPager::reallyDoQuery',
  99                         [ &$data, $this, $offset, $limit, $descending ]
 100                 );
 101
 102                 $result = [];
 103
 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;
 109                         }
 110                 }
 111
 112                 // sort results
 113                 if ( $descending ) {
 114                         ksort( $result );
 115                 } else {
 116                         krsort( $result );
 117                 }
 118
 119                 // enforce limit
 120                 $result = array_slice( $result, 0, $limit );
 121
 122                 // get rid of array keys
 123                 $result = array_values( $result );
 124
 125                 return new FakeResultWrapper( $result );
 126         }
 127
 128         function getUserCond() {
 129                 $condition = [];
 130
 131                 $condition['ar_user_text'] = $this->target;
 132                 $index = 'usertext_timestamp';
 133
 134                 return [ $index, $condition ];
 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
 199                 /*
 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.
 205                  */
 206                 MediaWiki\suppressWarnings();
 207                 try {
 208                         $rev = Revision::newFromArchiveRow( $row );
 209                         $validRevision = (bool)$rev->getId();
 210                 } catch ( Exception $e ) {
 211                         $validRevision = false;
 212                 }
 213                 MediaWiki\restoreWarnings();
 214
 215                 if ( $validRevision ) {
 216                         $ret = $this->formatRevisionRow( $row );
 217                 }
 218
 219                 // Let extensions add data
 220                 Hooks::run( 'DeletedContributionsLineEnding', [ $this, &$ret, $row, &$classes ] );
 221
 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";
 225                 } else {
 226                         $ret = Html::rawElement( 'li', [ 'class' => $classes ], $ret ) . "\n";
 227                 }
 228
 229                 return $ret;
 230         }
 231
 232         /**
 233          * Generates each row in the contributions list for archive entries.
 234          *
 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.
 239          *
 240          * @todo This would probably look a lot nicer in a table.
 241          * @param stdClass $row
 242          * @return string
 243          */
 244         function formatRevisionRow( $row ) {
 245                 $page = Title::makeTitle( $row->ar_namespace, $row->ar_title );
 246
 247                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 248
 249                 $rev = new Revision( [
 250                         'title' => $page,
 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,
 258                 ] );
 259
 260                 $undelete = SpecialPage::getTitleFor( 'Undelete' );
 261
 262                 $logs = SpecialPage::getTitleFor( 'Log' );
 263                 $dellog = $linkRenderer->makeKnownLink(
 264                         $logs,
 265                         $this->messages['deletionlog'],
 266                         [],
 267                         [
 268                                 'type' => 'delete',
 269                                 'page' => $page->getPrefixedText()
 270                         ]
 271                 );
 272
 273                 $reviewlink = $linkRenderer->makeKnownLink(
 274                         SpecialPage::getTitleFor( 'Undelete', $page->getPrefixedDBkey() ),
 275                         $this->messages['undeleteviewlink']
 276                 );
 277
 278                 $user = $this->getUser();
 279
 280                 if ( $user->isAllowed( 'deletedtext' ) ) {
 281                         $last = $linkRenderer->makeKnownLink(
 282                                 $undelete,
 283                                 $this->messages['diff'],
 284                                 [],
 285                                 [
 286                                         'target' => $page->getPrefixedText(),
 287                                         'timestamp' => $rev->getTimestamp(),
 288                                         'diff' => 'prev'
 289                                 ]
 290                         );
 291                 } else {
 292                         $last = htmlspecialchars( $this->messages['diff'] );
 293                 }
 294
 295                 $comment = Linker::revComment( $rev );
 296                 $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $user );
 297
 298                 if ( !$user->isAllowed( 'undelete' ) || !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
 299                         $link = htmlspecialchars( $date ); // unusable link
 300                 } else {
 301                         $link = $linkRenderer->makeKnownLink(
 302                                 $undelete,
 303                                 $date,
 304                                 [ 'class' => 'mw-changeslist-date' ],
 305                                 [
 306                                         'target' => $page->getPrefixedText(),
 307                                         'timestamp' => $rev->getTimestamp()
 308                                 ]
 309                         );
 310                 }
 311                 // Style deleted items
 312                 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 313                         $link = '<span class="history-deleted">' . $link . '</span>';
 314                 }
 315
 316                 $pagelink = $linkRenderer->makeLink(
 317                         $page,
 318                         null,
 319                         [ 'class' => 'mw-changeslist-title' ]
 320                 );
 321
 322                 if ( $rev->isMinor() ) {
 323                         $mflag = ChangesList::flag( 'minor' );
 324                 } else {
 325                         $mflag = '';
 326                 }
 327
 328                 // Revision delete link
 329                 $del = Linker::getRevDeleteLink( $user, $rev, $page );
 330                 if ( $del ) {
 331                         $del .= ' ';
 332                 }
 333
 334                 $tools = Html::rawElement(
 335                         'span',
 336                         [ 'class' => 'mw-deletedcontribs-tools' ],
 337                         $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList(
 338                                 [ $last, $dellog, $reviewlink ] ) )->escaped()
 339                 );
 340
 341                 $separator = '<span class="mw-changeslist-separator">. .</span>';
 342                 $ret = "{$del}{$link} {$tools} {$separator} {$mflag} {$pagelink} {$comment}";
 343
 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>";
 347                 }
 348
 349                 return $ret;
 350         }
 351
 352         /**
 353          * Get the Database object in use
 354          *
 355          * @return IDatabase
 356          */
 357         public function getDatabase() {
 358                 return $this->mDb;
 359         }
 360 }