includes/specials/pagers/ContribsPager.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  * Pager for Special:Contributions
  24  * @ingroup Pager
  25  */
  26 class ContribsPager extends ReverseChronologicalPager {
  27
  28         public $mDefaultDirection = IndexPager::DIR_DESCENDING;
  29         public $messages;
  30         public $target;
  31         public $namespace = '';
  32         public $mDb;
  33         public $preventClickjacking = false;
  34
  35         /** @var IDatabase */
  36         public $mDbSecondary;
  37
  38         /**
  39          * @var array
  40          */
  41         protected $mParentLens;
  42
  43         function __construct( IContextSource $context, array $options ) {
  44                 parent::__construct( $context );
  45
  46                 $msgs = [
  47                         'diff',
  48                         'hist',
  49                         'pipe-separator',
  50                         'uctop'
  51                 ];
  52
  53                 foreach ( $msgs as $msg ) {
  54                         $this->messages[$msg] = $this->msg( $msg )->escaped();
  55                 }
  56
  57                 $this->target = isset( $options['target'] ) ? $options['target'] : '';
  58                 $this->contribs = isset( $options['contribs'] ) ? $options['contribs'] : 'users';
  59                 $this->namespace = isset( $options['namespace'] ) ? $options['namespace'] : '';
  60                 $this->tagFilter = isset( $options['tagfilter'] ) ? $options['tagfilter'] : false;
  61                 $this->nsInvert = isset( $options['nsInvert'] ) ? $options['nsInvert'] : false;
  62                 $this->associated = isset( $options['associated'] ) ? $options['associated'] : false;
  63
  64                 $this->deletedOnly = !empty( $options['deletedOnly'] );
  65                 $this->topOnly = !empty( $options['topOnly'] );
  66                 $this->newOnly = !empty( $options['newOnly'] );
  67                 $this->hideMinor = !empty( $options['hideMinor'] );
  68
  69                 $year = isset( $options['year'] ) ? $options['year'] : false;
  70                 $month = isset( $options['month'] ) ? $options['month'] : false;
  71                 $this->getDateCond( $year, $month );
  72
  73                 // Most of this code will use the 'contributions' group DB, which can map to slaves
  74                 // with extra user based indexes or partioning by user. The additional metadata
  75                 // queries should use a regular slave since the lookup pattern is not all by user.
  76                 $this->mDbSecondary = wfGetDB( DB_SLAVE ); // any random slave
  77                 $this->mDb = wfGetDB( DB_SLAVE, 'contributions' );
  78         }
  79
  80         function getDefaultQuery() {
  81                 $query = parent::getDefaultQuery();
  82                 $query['target'] = $this->target;
  83
  84                 return $query;
  85         }
  86
  87         /**
  88          * This method basically executes the exact same code as the parent class, though with
  89          * a hook added, to allow extensions to add additional queries.
  90          *
  91          * @param string $offset Index offset, inclusive
  92          * @param int $limit Exact query limit
  93          * @param bool $descending Query direction, false for ascending, true for descending
  94          * @return ResultWrapper
  95          */
  96         function reallyDoQuery( $offset, $limit, $descending ) {
  97                 list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo(
  98                         $offset,
  99                         $limit,
 100                         $descending
 101                 );
 102
 103                 /*
 104                  * This hook will allow extensions to add in additional queries, so they can get their data
 105                  * in My Contributions as well. Extensions should append their results to the $data array.
 106                  *
 107                  * Extension queries have to implement the navbar requirement as well. They should
 108                  * - have a column aliased as $pager->getIndexField()
 109                  * - have LIMIT set
 110                  * - have a WHERE-clause that compares the $pager->getIndexField()-equivalent column to the offset
 111                  * - have the ORDER BY specified based upon the details provided by the navbar
 112                  *
 113                  * See includes/Pager.php buildQueryInfo() method on how to build LIMIT, WHERE & ORDER BY
 114                  *
 115                  * &$data: an array of results of all contribs queries
 116                  * $pager: the ContribsPager object hooked into
 117                  * $offset: see phpdoc above
 118                  * $limit: see phpdoc above
 119                  * $descending: see phpdoc above
 120                  */
 121                 $data = [ $this->mDb->select(
 122                         $tables, $fields, $conds, $fname, $options, $join_conds
 123                 ) ];
 124                 Hooks::run(
 125                         'ContribsPager::reallyDoQuery',
 126                         [ &$data, $this, $offset, $limit, $descending ]
 127                 );
 128
 129                 $result = [];
 130
 131                 // loop all results and collect them in an array
 132                 foreach ( $data as $query ) {
 133                         foreach ( $query as $i => $row ) {
 134                                 // use index column as key, allowing us to easily sort in PHP
 135                                 $result[$row->{$this->getIndexField()} . "-$i"] = $row;
 136                         }
 137                 }
 138
 139                 // sort results
 140                 if ( $descending ) {
 141                         ksort( $result );
 142                 } else {
 143                         krsort( $result );
 144                 }
 145
 146                 // enforce limit
 147                 $result = array_slice( $result, 0, $limit );
 148
 149                 // get rid of array keys
 150                 $result = array_values( $result );
 151
 152                 return new FakeResultWrapper( $result );
 153         }
 154
 155         function getQueryInfo() {
 156                 list( $tables, $index, $userCond, $join_cond ) = $this->getUserCond();
 157
 158                 $user = $this->getUser();
 159                 $conds = array_merge( $userCond, $this->getNamespaceCond() );
 160
 161                 // Paranoia: avoid brute force searches (bug 17342)
 162                 if ( !$user->isAllowed( 'deletedhistory' ) ) {
 163                         $conds[] = $this->mDb->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0';
 164                 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 165                         $conds[] = $this->mDb->bitAnd( 'rev_deleted', Revision::SUPPRESSED_USER ) .
 166                                 ' != ' . Revision::SUPPRESSED_USER;
 167                 }
 168
 169                 # Don't include orphaned revisions
 170                 $join_cond['page'] = Revision::pageJoinCond();
 171                 # Get the current user name for accounts
 172                 $join_cond['user'] = Revision::userJoinCond();
 173
 174                 $options = [];
 175                 if ( $index ) {
 176                         $options['USE INDEX'] = [ 'revision' => $index ];
 177                 }
 178
 179                 $queryInfo = [
 180                         'tables' => $tables,
 181                         'fields' => array_merge(
 182                                 Revision::selectFields(),
 183                                 Revision::selectUserFields(),
 184                                 [ 'page_namespace', 'page_title', 'page_is_new',
 185                                         'page_latest', 'page_is_redirect', 'page_len' ]
 186                         ),
 187                         'conds' => $conds,
 188                         'options' => $options,
 189                         'join_conds' => $join_cond
 190                 ];
 191
 192                 ChangeTags::modifyDisplayQuery(
 193                         $queryInfo['tables'],
 194                         $queryInfo['fields'],
 195                         $queryInfo['conds'],
 196                         $queryInfo['join_conds'],
 197                         $queryInfo['options'],
 198                         $this->tagFilter
 199                 );
 200
 201                 Hooks::run( 'ContribsPager::getQueryInfo', [ &$this, &$queryInfo ] );
 202
 203                 return $queryInfo;
 204         }
 205
 206         function getUserCond() {
 207                 $condition = [];
 208                 $join_conds = [];
 209                 $tables = [ 'revision', 'page', 'user' ];
 210                 $index = false;
 211                 if ( $this->contribs == 'newbie' ) {
 212                         $max = $this->mDb->selectField( 'user', 'max(user_id)', false, __METHOD__ );
 213                         $condition[] = 'rev_user >' . (int)( $max - $max / 100 );
 214                         # ignore local groups with the bot right
 215                         # @todo FIXME: Global groups may have 'bot' rights
 216                         $groupsWithBotPermission = User::getGroupsWithPermission( 'bot' );
 217                         if ( count( $groupsWithBotPermission ) ) {
 218                                 $tables[] = 'user_groups';
 219                                 $condition[] = 'ug_group IS NULL';
 220                                 $join_conds['user_groups'] = [
 221                                         'LEFT JOIN', [
 222                                                 'ug_user = rev_user',
 223                                                 'ug_group' => $groupsWithBotPermission
 224                                         ]
 225                                 ];
 226                         }
 227                 } else {
 228                         $uid = User::idFromName( $this->target );
 229                         if ( $uid ) {
 230                                 $condition['rev_user'] = $uid;
 231                                 $index = 'user_timestamp';
 232                         } else {
 233                                 $condition['rev_user_text'] = $this->target;
 234                                 $index = 'usertext_timestamp';
 235                         }
 236                 }
 237
 238                 if ( $this->deletedOnly ) {
 239                         $condition[] = 'rev_deleted != 0';
 240                 }
 241
 242                 if ( $this->topOnly ) {
 243                         $condition[] = 'rev_id = page_latest';
 244                 }
 245
 246                 if ( $this->newOnly ) {
 247                         $condition[] = 'rev_parent_id = 0';
 248                 }
 249
 250                 if ( $this->hideMinor ) {
 251                         $condition[] = 'rev_minor_edit = 0';
 252                 }
 253
 254                 return [ $tables, $index, $condition, $join_conds ];
 255         }
 256
 257         function getNamespaceCond() {
 258                 if ( $this->namespace !== '' ) {
 259                         $selectedNS = $this->mDb->addQuotes( $this->namespace );
 260                         $eq_op = $this->nsInvert ? '!=' : '=';
 261                         $bool_op = $this->nsInvert ? 'AND' : 'OR';
 262
 263                         if ( !$this->associated ) {
 264                                 return [ "page_namespace $eq_op $selectedNS" ];
 265                         }
 266
 267                         $associatedNS = $this->mDb->addQuotes(
 268                                 MWNamespace::getAssociated( $this->namespace )
 269                         );
 270
 271                         return [
 272                                 "page_namespace $eq_op $selectedNS " .
 273                                 $bool_op .
 274                                 " page_namespace $eq_op $associatedNS"
 275                         ];
 276                 }
 277
 278                 return [];
 279         }
 280
 281         function getIndexField() {
 282                 return 'rev_timestamp';
 283         }
 284
 285         function doBatchLookups() {
 286                 # Do a link batch query
 287                 $this->mResult->seek( 0 );
 288                 $parentRevIds = [];
 289                 $this->mParentLens = [];
 290                 $batch = new LinkBatch();
 291                 # Give some pointers to make (last) links
 292                 foreach ( $this->mResult as $row ) {
 293                         if ( isset( $row->rev_parent_id ) && $row->rev_parent_id ) {
 294                                 $parentRevIds[] = $row->rev_parent_id;
 295                         }
 296                         if ( isset( $row->rev_id ) ) {
 297                                 $this->mParentLens[$row->rev_id] = $row->rev_len;
 298                                 if ( $this->contribs === 'newbie' ) { // multiple users
 299                                         $batch->add( NS_USER, $row->user_name );
 300                                         $batch->add( NS_USER_TALK, $row->user_name );
 301                                 }
 302                                 $batch->add( $row->page_namespace, $row->page_title );
 303                         }
 304                 }
 305                 # Fetch rev_len for revisions not already scanned above
 306                 $this->mParentLens += Revision::getParentLengths(
 307                         $this->mDbSecondary,
 308                         array_diff( $parentRevIds, array_keys( $this->mParentLens ) )
 309                 );
 310                 $batch->execute();
 311                 $this->mResult->seek( 0 );
 312         }
 313
 314         /**
 315          * @return string
 316          */
 317         function getStartBody() {
 318                 return "<ul class=\"mw-contributions-list\">\n";
 319         }
 320
 321         /**
 322          * @return string
 323          */
 324         function getEndBody() {
 325                 return "</ul>\n";
 326         }
 327
 328         /**
 329          * Generates each row in the contributions list.
 330          *
 331          * Contributions which are marked "top" are currently on top of the history.
 332          * For these contributions, a [rollback] link is shown for users with roll-
 333          * back privileges. The rollback link restores the most recent version that
 334          * was not written by the target user.
 335          *
 336          * @todo This would probably look a lot nicer in a table.
 337          * @param object $row
 338          * @return string
 339          */
 340         function formatRow( $row ) {
 341
 342                 $ret = '';
 343                 $classes = [];
 344
 345                 /*
 346                  * There may be more than just revision rows. To make sure that we'll only be processing
 347                  * revisions here, let's _try_ to build a revision out of our row (without displaying
 348                  * notices though) and then trying to grab data from the built object. If we succeed,
 349                  * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
 350                  * to extensions to subscribe to the hook to parse the row.
 351                  */
 352                 MediaWiki\suppressWarnings();
 353                 try {
 354                         $rev = new Revision( $row );
 355                         $validRevision = (bool)$rev->getId();
 356                 } catch ( Exception $e ) {
 357                         $validRevision = false;
 358                 }
 359                 MediaWiki\restoreWarnings();
 360
 361                 if ( $validRevision ) {
 362                         $classes = [];
 363
 364                         $page = Title::newFromRow( $row );
 365                         $link = Linker::link(
 366                                 $page,
 367                                 htmlspecialchars( $page->getPrefixedText() ),
 368                                 [ 'class' => 'mw-contributions-title' ],
 369                                 $page->isRedirect() ? [ 'redirect' => 'no' ] : []
 370                         );
 371                         # Mark current revisions
 372                         $topmarktext = '';
 373                         $user = $this->getUser();
 374                         if ( $row->rev_id === $row->page_latest ) {
 375                                 $topmarktext .= '<span class="mw-uctop">' . $this->messages['uctop'] . '</span>';
 376                                 $classes[] = 'mw-contributions-current';
 377                                 # Add rollback link
 378                                 if ( !$row->page_is_new && $page->quickUserCan( 'rollback', $user )
 379                                         && $page->quickUserCan( 'edit', $user )
 380                                 ) {
 381                                         $this->preventClickjacking();
 382                                         $topmarktext .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
 383                                 }
 384                         }
 385                         # Is there a visible previous revision?
 386                         if ( $rev->userCan( Revision::DELETED_TEXT, $user ) && $rev->getParentId() !== 0 ) {
 387                                 $difftext = Linker::linkKnown(
 388                                         $page,
 389                                         $this->messages['diff'],
 390                                         [],
 391                                         [
 392                                                 'diff' => 'prev',
 393                                                 'oldid' => $row->rev_id
 394                                         ]
 395                                 );
 396                         } else {
 397                                 $difftext = $this->messages['diff'];
 398                         }
 399                         $histlink = Linker::linkKnown(
 400                                 $page,
 401                                 $this->messages['hist'],
 402                                 [],
 403                                 [ 'action' => 'history' ]
 404                         );
 405
 406                         if ( $row->rev_parent_id === null ) {
 407                                 // For some reason rev_parent_id isn't populated for this row.
 408                                 // Its rumoured this is true on wikipedia for some revisions (bug 34922).
 409                                 // Next best thing is to have the total number of bytes.
 410                                 $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
 411                                 $chardiff .= Linker::formatRevisionSize( $row->rev_len );
 412                                 $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
 413                         } else {
 414                                 $parentLen = 0;
 415                                 if ( isset( $this->mParentLens[$row->rev_parent_id] ) ) {
 416                                         $parentLen = $this->mParentLens[$row->rev_parent_id];
 417                                 }
 418
 419                                 $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
 420                                 $chardiff .= ChangesList::showCharacterDifference(
 421                                         $parentLen,
 422                                         $row->rev_len,
 423                                         $this->getContext()
 424                                 );
 425                                 $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
 426                         }
 427
 428                         $lang = $this->getLanguage();
 429                         $comment = $lang->getDirMark() . Linker::revComment( $rev, false, true );
 430                         $date = $lang->userTimeAndDate( $row->rev_timestamp, $user );
 431                         if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
 432                                 $d = Linker::linkKnown(
 433                                         $page,
 434                                         htmlspecialchars( $date ),
 435                                         [ 'class' => 'mw-changeslist-date' ],
 436                                         [ 'oldid' => intval( $row->rev_id ) ]
 437                                 );
 438                         } else {
 439                                 $d = htmlspecialchars( $date );
 440                         }
 441                         if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 442                                 $d = '<span class="history-deleted">' . $d . '</span>';
 443                         }
 444
 445                         # Show user names for /newbies as there may be different users.
 446                         # Note that we already excluded rows with hidden user names.
 447                         if ( $this->contribs == 'newbie' ) {
 448                                 $userlink = ' . . ' . $lang->getDirMark()
 449                                         . Linker::userLink( $rev->getUser(), $rev->getUserText() );
 450                                 $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams(
 451                                                 Linker::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' ';
 452                         } else {
 453                                 $userlink = '';
 454                         }
 455
 456                         $flags = [];
 457                         if ( $rev->getParentId() === 0 ) {
 458                                 $flags[] = ChangesList::flag( 'newpage' );
 459                         }
 460
 461                         if ( $rev->isMinor() ) {
 462                                 $flags[] = ChangesList::flag( 'minor' );
 463                         }
 464
 465                         $del = Linker::getRevDeleteLink( $user, $rev, $page );
 466                         if ( $del !== '' ) {
 467                                 $del .= ' ';
 468                         }
 469
 470                         $diffHistLinks = $this->msg( 'parentheses' )
 471                                 ->rawParams( $difftext . $this->messages['pipe-separator'] . $histlink )
 472                                 ->escaped();
 473
 474                         # Tags, if any.
 475                         list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
 476                                 $row->ts_tags,
 477                                 'contributions',
 478                                 $this->getContext()
 479                         );
 480                         $classes = array_merge( $classes, $newClasses );
 481
 482                         Hooks::run( 'SpecialContributions::formatRow::flags', [ $this->getContext(), $row, &$flags ] );
 483
 484                         $templateParams = [
 485                                 'del' => $del,
 486                                 'timestamp' => $d,
 487                                 'diffHistLinks' => $diffHistLinks,
 488                                 'charDifference' => $chardiff,
 489                                 'flags' => $flags,
 490                                 'articleLink' => $link,
 491                                 'userlink' => $userlink,
 492                                 'logText' => $comment,
 493                                 'topmarktext' => $topmarktext,
 494                                 'tagSummary' => $tagSummary,
 495                         ];
 496
 497                         # Denote if username is redacted for this edit
 498                         if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
 499                                 $templateParams['rev-deleted-user-contribs'] =
 500                                         $this->msg( 'rev-deleted-user-contribs' )->escaped();
 501                         }
 502
 503                         $templateParser = new TemplateParser();
 504                         $ret = $templateParser->processTemplate(
 505                                 'SpecialContributionsLine',
 506                                 $templateParams
 507                         );
 508                 }
 509
 510                 // Let extensions add data
 511                 Hooks::run( 'ContributionsLineEnding', [ $this, &$ret, $row, &$classes ] );
 512
 513                 // TODO: Handle exceptions in the catch block above.  Do any extensions rely on
 514                 // receiving empty rows?
 515
 516                 if ( $classes === [] && $ret === '' ) {
 517                         wfDebug( "Dropping Special:Contribution row that could not be formatted\n" );
 518                         return "<!-- Could not format Special:Contribution row. -->\n";
 519                 }
 520
 521                 // FIXME: The signature of the ContributionsLineEnding hook makes it
 522                 // very awkward to move this LI wrapper into the template.
 523                 return Html::rawElement( 'li', [ 'class' => $classes ], $ret ) . "\n";
 524         }
 525
 526         /**
 527          * Overwrite Pager function and return a helpful comment
 528          * @return string
 529          */
 530         function getSqlComment() {
 531                 if ( $this->namespace || $this->deletedOnly ) {
 532                         // potentially slow, see CR r58153
 533                         return 'contributions page filtered for namespace or RevisionDeleted edits';
 534                 } else {
 535                         return 'contributions page unfiltered';
 536                 }
 537         }
 538
 539         protected function preventClickjacking() {
 540                 $this->preventClickjacking = true;
 541         }
 542
 543         /**
 544          * @return bool
 545          */
 546         public function getPreventClickjacking() {
 547                 return $this->preventClickjacking;
 548         }
 549 }