includes/actions/pagers/HistoryPager.php

   1 <?php
   2 /**
   3  * Page history pager
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Actions
  22  */
  23
  24 use MediaWiki\MediaWikiServices;
  25
  26 /**
  27  * @ingroup Pager
  28  * @ingroup Actions
  29  */
  30 class HistoryPager extends ReverseChronologicalPager {
  31         /**
  32          * @var bool|stdClass
  33          */
  34         public $lastRow = false;
  35
  36         public $counter, $historyPage, $buttons, $conds;
  37
  38         protected $oldIdChecked;
  39
  40         protected $preventClickjacking = false;
  41         /**
  42          * @var array
  43          */
  44         protected $parentLens;
  45
  46         /** @var bool Whether to show the tag editing UI */
  47         protected $showTagEditUI;
  48
  49         /** @var string */
  50         private $tagFilter;
  51
  52         /**
  53          * @param HistoryAction $historyPage
  54          * @param string $year
  55          * @param string $month
  56          * @param string $tagFilter
  57          * @param array $conds
  58          */
  59         public function __construct(
  60                 HistoryAction $historyPage,
  61                 $year = '',
  62                 $month = '',
  63                 $tagFilter = '',
  64                 array $conds = []
  65         ) {
  66                 parent::__construct( $historyPage->getContext() );
  67                 $this->historyPage = $historyPage;
  68                 $this->tagFilter = $tagFilter;
  69                 $this->getDateCond( $year, $month );
  70                 $this->conds = $conds;
  71                 $this->showTagEditUI = ChangeTags::showTagEditingUI( $this->getUser() );
  72         }
  73
  74         // For hook compatibility...
  75         function getArticle() {
  76                 return $this->historyPage->getArticle();
  77         }
  78
  79         function getSqlComment() {
  80                 if ( $this->conds ) {
  81                         return 'history page filtered'; // potentially slow, see CR r58153
  82                 } else {
  83                         return 'history page unfiltered';
  84                 }
  85         }
  86
  87         function getQueryInfo() {
  88                 $revQuery = Revision::getQueryInfo( [ 'user' ] );
  89                 $queryInfo = [
  90                         'tables' => $revQuery['tables'],
  91                         'fields' => $revQuery['fields'],
  92                         'conds' => array_merge(
  93                                 [ 'rev_page' => $this->getWikiPage()->getId() ],
  94                                 $this->conds ),
  95                         'options' => [ 'USE INDEX' => [ 'revision' => 'page_timestamp' ] ],
  96                         'join_conds' => $revQuery['joins'],
  97                 ];
  98                 ChangeTags::modifyDisplayQuery(
  99                         $queryInfo['tables'],
 100                         $queryInfo['fields'],
 101                         $queryInfo['conds'],
 102                         $queryInfo['join_conds'],
 103                         $queryInfo['options'],
 104                         $this->tagFilter
 105                 );
 106
 107                 // Avoid PHP 7.1 warning of passing $this by reference
 108                 $historyPager = $this;
 109                 Hooks::run( 'PageHistoryPager::getQueryInfo', [ &$historyPager, &$queryInfo ] );
 110
 111                 return $queryInfo;
 112         }
 113
 114         function getIndexField() {
 115                 return 'rev_timestamp';
 116         }
 117
 118         /**
 119          * @param stdClass $row
 120          * @return string
 121          */
 122         function formatRow( $row ) {
 123                 if ( $this->lastRow ) {
 124                         $latest = ( $this->counter == 1 && $this->mIsFirst );
 125                         $firstInList = $this->counter == 1;
 126                         $this->counter++;
 127
 128                         $notifTimestamp = $this->getConfig()->get( 'ShowUpdatedMarker' )
 129                                 ? $this->getTitle()->getNotificationTimestamp( $this->getUser() )
 130                                 : false;
 131
 132                         $s = $this->historyLine(
 133                                 $this->lastRow, $row, $notifTimestamp, $latest, $firstInList );
 134                 } else {
 135                         $s = '';
 136                 }
 137                 $this->lastRow = $row;
 138
 139                 return $s;
 140         }
 141
 142         protected function doBatchLookups() {
 143                 if ( !Hooks::run( 'PageHistoryPager::doBatchLookups', [ $this, $this->mResult ] ) ) {
 144                         return;
 145                 }
 146
 147                 # Do a link batch query
 148                 $this->mResult->seek( 0 );
 149                 $batch = new LinkBatch();
 150                 $revIds = [];
 151                 foreach ( $this->mResult as $row ) {
 152                         if ( $row->rev_parent_id ) {
 153                                 $revIds[] = $row->rev_parent_id;
 154                         }
 155                         if ( $row->user_name !== null ) {
 156                                 $batch->add( NS_USER, $row->user_name );
 157                                 $batch->add( NS_USER_TALK, $row->user_name );
 158                         } else { # for anons or usernames of imported revisions
 159                                 $batch->add( NS_USER, $row->rev_user_text );
 160                                 $batch->add( NS_USER_TALK, $row->rev_user_text );
 161                         }
 162                 }
 163                 $this->parentLens = Revision::getParentLengths( $this->mDb, $revIds );
 164                 $batch->execute();
 165                 $this->mResult->seek( 0 );
 166         }
 167
 168         /**
 169          * Creates begin of history list with a submit button
 170          *
 171          * @return string HTML output
 172          */
 173         protected function getStartBody() {
 174                 $this->lastRow = false;
 175                 $this->counter = 1;
 176                 $this->oldIdChecked = 0;
 177
 178                 $this->getOutput()->wrapWikiMsg( "<div class='mw-history-legend'>\n$1\n</div>", 'histlegend' );
 179                 $s = Html::openElement( 'form', [ 'action' => wfScript(),
 180                         'id' => 'mw-history-compare' ] ) . "\n";
 181                 $s .= Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) . "\n";
 182                 $s .= Html::hidden( 'action', 'historysubmit' ) . "\n";
 183                 $s .= Html::hidden( 'type', 'revision' ) . "\n";
 184
 185                 // Button container stored in $this->buttons for re-use in getEndBody()
 186                 $this->buttons = '<div>';
 187                 $className = 'historysubmit mw-history-compareselectedversions-button';
 188                 $attrs = [ 'class' => $className ]
 189                         + Linker::tooltipAndAccesskeyAttribs( 'compareselectedversions' );
 190                 $this->buttons .= $this->submitButton( $this->msg( 'compareselectedversions' )->text(),
 191                         $attrs
 192                 ) . "\n";
 193
 194                 $user = $this->getUser();
 195                 $actionButtons = '';
 196                 if ( $user->isAllowed( 'deleterevision' ) ) {
 197                         $actionButtons .= $this->getRevisionButton( 'revisiondelete', 'showhideselectedversions' );
 198                 }
 199                 if ( $this->showTagEditUI ) {
 200                         $actionButtons .= $this->getRevisionButton( 'editchangetags', 'history-edit-tags' );
 201                 }
 202                 if ( $actionButtons ) {
 203                         $this->buttons .= Xml::tags( 'div', [ 'class' =>
 204                                 'mw-history-revisionactions' ], $actionButtons );
 205                 }
 206
 207                 if ( $user->isAllowed( 'deleterevision' ) || $this->showTagEditUI ) {
 208                         $this->buttons .= ( new ListToggle( $this->getOutput() ) )->getHTML();
 209                 }
 210
 211                 $this->buttons .= '</div>';
 212
 213                 $s .= $this->buttons;
 214                 $s .= '<ul id="pagehistory">' . "\n";
 215
 216                 return $s;
 217         }
 218
 219         private function getRevisionButton( $name, $msg ) {
 220                 $this->preventClickjacking();
 221                 # Note T22966, <button> is non-standard in IE<8
 222                 $element = Html::element(
 223                         'button',
 224                         [
 225                                 'type' => 'submit',
 226                                 'name' => $name,
 227                                 'value' => '1',
 228                                 'class' => "historysubmit mw-history-$name-button",
 229                         ],
 230                         $this->msg( $msg )->text()
 231                 ) . "\n";
 232                 return $element;
 233         }
 234
 235         protected function getEndBody() {
 236                 if ( $this->lastRow ) {
 237                         $latest = $this->counter == 1 && $this->mIsFirst;
 238                         $firstInList = $this->counter == 1;
 239                         if ( $this->mIsBackwards ) {
 240                                 # Next row is unknown, but for UI reasons, probably exists if an offset has been specified
 241                                 if ( $this->mOffset == '' ) {
 242                                         $next = null;
 243                                 } else {
 244                                         $next = 'unknown';
 245                                 }
 246                         } else {
 247                                 # The next row is the past-the-end row
 248                                 $next = $this->mPastTheEndRow;
 249                         }
 250                         $this->counter++;
 251
 252                         $notifTimestamp = $this->getConfig()->get( 'ShowUpdatedMarker' )
 253                                 ? $this->getTitle()->getNotificationTimestamp( $this->getUser() )
 254                                 : false;
 255
 256                         $s = $this->historyLine(
 257                                 $this->lastRow, $next, $notifTimestamp, $latest, $firstInList );
 258                 } else {
 259                         $s = '';
 260                 }
 261                 $s .= "</ul>\n";
 262                 # Add second buttons only if there is more than one rev
 263                 if ( $this->getNumRows() > 2 ) {
 264                         $s .= $this->buttons;
 265                 }
 266                 $s .= '</form>';
 267
 268                 return $s;
 269         }
 270
 271         /**
 272          * Creates a submit button
 273          *
 274          * @param string $message Text of the submit button, will be escaped
 275          * @param array $attributes
 276          * @return string HTML output for the submit button
 277          */
 278         function submitButton( $message, $attributes = [] ) {
 279                 # Disable submit button if history has 1 revision only
 280                 if ( $this->getNumRows() > 1 ) {
 281                         return Html::submitButton( $message, $attributes );
 282                 } else {
 283                         return '';
 284                 }
 285         }
 286
 287         /**
 288          * Returns a row from the history printout.
 289          *
 290          * @todo document some more, and maybe clean up the code (some params redundant?)
 291          *
 292          * @param stdClass $row The database row corresponding to the previous line.
 293          * @param mixed $next The database row corresponding to the next line
 294          *   (chronologically previous)
 295          * @param bool|string $notificationtimestamp
 296          * @param bool $latest Whether this row corresponds to the page's latest revision.
 297          * @param bool $firstInList Whether this row corresponds to the first
 298          *   displayed on this history page.
 299          * @return string HTML output for the row
 300          */
 301         function historyLine( $row, $next, $notificationtimestamp = false,
 302                 $latest = false, $firstInList = false ) {
 303                 $rev = new Revision( $row, 0, $this->getTitle() );
 304
 305                 if ( is_object( $next ) ) {
 306                         $prevRev = new Revision( $next, 0, $this->getTitle() );
 307                 } else {
 308                         $prevRev = null;
 309                 }
 310
 311                 $curlink = $this->curLink( $rev, $latest );
 312                 $lastlink = $this->lastLink( $rev, $next );
 313                 $curLastlinks = Html::rawElement( 'span', [], $curlink ) .
 314                         Html::rawElement( 'span', [], $lastlink );
 315                 $histLinks = Html::rawElement(
 316                         'span',
 317                         [ 'class' => 'mw-history-histlinks mw-changeslist-links' ],
 318                         $curLastlinks
 319                 );
 320
 321                 $diffButtons = $this->diffButtons( $rev, $firstInList );
 322                 $s = $histLinks . $diffButtons;
 323
 324                 $link = $this->revLink( $rev );
 325                 $classes = [];
 326
 327                 $del = '';
 328                 $user = $this->getUser();
 329                 $canRevDelete = $user->isAllowed( 'deleterevision' );
 330                 // Show checkboxes for each revision, to allow for revision deletion and
 331                 // change tags
 332                 if ( $canRevDelete || $this->showTagEditUI ) {
 333                         $this->preventClickjacking();
 334                         // If revision was hidden from sysops and we don't need the checkbox
 335                         // for anything else, disable it
 336                         if ( !$this->showTagEditUI && !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
 337                                 $del = Xml::check( 'deleterevisions', false, [ 'disabled' => 'disabled' ] );
 338                         // Otherwise, enable the checkbox...
 339                         } else {
 340                                 $del = Xml::check( 'showhiderevisions', false,
 341                                         [ 'name' => 'ids[' . $rev->getId() . ']' ] );
 342                         }
 343                 // User can only view deleted revisions...
 344                 } elseif ( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) {
 345                         // If revision was hidden from sysops, disable the link
 346                         if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
 347                                 $del = Linker::revDeleteLinkDisabled( false );
 348                         // Otherwise, show the link...
 349                         } else {
 350                                 $query = [ 'type' => 'revision',
 351                                         'target' => $this->getTitle()->getPrefixedDBkey(), 'ids' => $rev->getId() ];
 352                                 $del .= Linker::revDeleteLink( $query,
 353                                         $rev->isDeleted( Revision::DELETED_RESTRICTED ), false );
 354                         }
 355                 }
 356                 if ( $del ) {
 357                         $s .= " $del ";
 358                 }
 359
 360                 $lang = $this->getLanguage();
 361                 $dirmark = $lang->getDirMark();
 362
 363                 $s .= " $link";
 364                 $s .= $dirmark;
 365                 $s .= " <span class='history-user'>" .
 366                         Linker::revUserTools( $rev, true, false ) . "</span>";
 367                 $s .= $dirmark;
 368
 369                 if ( $rev->isMinor() ) {
 370                         $s .= ' ' . ChangesList::flag( 'minor', $this->getContext() );
 371                 }
 372
 373                 # Sometimes rev_len isn't populated
 374                 if ( $rev->getSize() !== null ) {
 375                         # Size is always public data
 376                         $prevSize = $this->parentLens[$row->rev_parent_id] ?? 0;
 377                         $sDiff = ChangesList::showCharacterDifference( $prevSize, $rev->getSize() );
 378                         $fSize = Linker::formatRevisionSize( $rev->getSize(), false );
 379                         $s .= ' <span class="mw-changeslist-separator"></span> ' . "$fSize $sDiff";
 380                 }
 381
 382                 # Text following the character difference is added just before running hooks
 383                 $s2 = Linker::revComment( $rev, false, true, false );
 384
 385                 if ( $notificationtimestamp && ( $row->rev_timestamp >= $notificationtimestamp ) ) {
 386                         $s2 .= ' <span class="updatedmarker">' . $this->msg( 'updatedmarker' )->escaped() . '</span>';
 387                         $classes[] = 'mw-history-line-updated';
 388                 }
 389
 390                 $tools = [];
 391
 392                 # Rollback and undo links
 393                 if ( $prevRev && $this->getTitle()->quickUserCan( 'edit', $user ) ) {
 394                         if ( $latest && $this->getTitle()->quickUserCan( 'rollback', $user ) ) {
 395                                 // Get a rollback link without the brackets
 396                                 $rollbackLink = Linker::generateRollback(
 397                                         $rev,
 398                                         $this->getContext(),
 399                                         [ 'verify', 'noBrackets' ]
 400                                 );
 401                                 if ( $rollbackLink ) {
 402                                         $this->preventClickjacking();
 403                                         $tools[] = $rollbackLink;
 404                                 }
 405                         }
 406
 407                         if ( !$rev->isDeleted( Revision::DELETED_TEXT )
 408                                 && !$prevRev->isDeleted( Revision::DELETED_TEXT )
 409                         ) {
 410                                 # Create undo tooltip for the first (=latest) line only
 411                                 $undoTooltip = $latest
 412                                         ? [ 'title' => $this->msg( 'tooltip-undo' )->text() ]
 413                                         : [];
 414                                 $undolink = MediaWikiServices::getInstance()->getLinkRenderer()->makeKnownLink(
 415                                         $this->getTitle(),
 416                                         $this->msg( 'editundo' )->text(),
 417                                         $undoTooltip,
 418                                         [
 419                                                 'action' => 'edit',
 420                                                 'undoafter' => $prevRev->getId(),
 421                                                 'undo' => $rev->getId()
 422                                         ]
 423                                 );
 424                                 $tools[] = "<span class=\"mw-history-undo\">{$undolink}</span>";
 425                         }
 426                 }
 427                 // Allow extension to add their own links here
 428                 Hooks::run( 'HistoryRevisionTools', [ $rev, &$tools, $prevRev, $user ] );
 429
 430                 if ( $tools ) {
 431                         $s2 .= ' ' . Html::openElement( 'span', [ 'class' => 'mw-changeslist-links' ] );
 432                         foreach ( $tools as $tool ) {
 433                                 $s2 .= Html::rawElement( 'span', [], $tool );
 434                         }
 435                         $s2 .= Html::closeElement( 'span' );
 436                 }
 437
 438                 # Tags
 439                 list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
 440                         $row->ts_tags,
 441                         'history',
 442                         $this->getContext()
 443                 );
 444                 $classes = array_merge( $classes, $newClasses );
 445                 if ( $tagSummary !== '' ) {
 446                         $s2 .= " $tagSummary";
 447                 }
 448
 449                 # Include separator between character difference and following text
 450                 if ( $s2 !== '' ) {
 451                         $s .= ' <span class="mw-changeslist-separator"></span> ' . $s2;
 452                 }
 453
 454                 $attribs = [ 'data-mw-revid' => $rev->getId() ];
 455
 456                 Hooks::run( 'PageHistoryLineEnding', [ $this, &$row, &$s, &$classes, &$attribs ] );
 457                 $attribs = array_filter( $attribs,
 458                         [ Sanitizer::class, 'isReservedDataAttribute' ],
 459                         ARRAY_FILTER_USE_KEY
 460                 );
 461
 462                 if ( $classes ) {
 463                         $attribs['class'] = implode( ' ', $classes );
 464                 }
 465
 466                 return Xml::tags( 'li', $attribs, $s ) . "\n";
 467         }
 468
 469         /**
 470          * Create a link to view this revision of the page
 471          *
 472          * @param Revision $rev
 473          * @return string
 474          */
 475         function revLink( $rev ) {
 476                 $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $this->getUser() );
 477                 if ( $rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
 478                         $link = MediaWikiServices::getInstance()->getLinkRenderer()->makeKnownLink(
 479                                 $this->getTitle(),
 480                                 $date,
 481                                 [ 'class' => 'mw-changeslist-date' ],
 482                                 [ 'oldid' => $rev->getId() ]
 483                         );
 484                 } else {
 485                         $link = htmlspecialchars( $date );
 486                 }
 487                 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 488                         $link = "<span class=\"history-deleted\">$link</span>";
 489                 }
 490
 491                 return $link;
 492         }
 493
 494         /**
 495          * Create a diff-to-current link for this revision for this page
 496          *
 497          * @param Revision $rev
 498          * @param bool $latest This is the latest revision of the page?
 499          * @return string
 500          */
 501         function curLink( $rev, $latest ) {
 502                 $cur = $this->historyPage->message['cur'];
 503                 if ( $latest || !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
 504                         return $cur;
 505                 } else {
 506                         return MediaWikiServices::getInstance()->getLinkRenderer()->makeKnownLink(
 507                                 $this->getTitle(),
 508                                 new HtmlArmor( $cur ),
 509                                 [],
 510                                 [
 511                                         'diff' => $this->getWikiPage()->getLatest(),
 512                                         'oldid' => $rev->getId()
 513                                 ]
 514                         );
 515                 }
 516         }
 517
 518         /**
 519          * Create a diff-to-previous link for this revision for this page.
 520          *
 521          * @param Revision $prevRev The revision being displayed
 522          * @param stdClass|string|null $next The next revision in list (that is
 523          *        the previous one in chronological order).
 524          *        May either be a row, "unknown" or null.
 525          * @return string
 526          */
 527         function lastLink( $prevRev, $next ) {
 528                 $last = $this->historyPage->message['last'];
 529
 530                 if ( $next === null ) {
 531                         # Probably no next row
 532                         return $last;
 533                 }
 534
 535                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 536                 if ( $next === 'unknown' ) {
 537                         # Next row probably exists but is unknown, use an oldid=prev link
 538                         return $linkRenderer->makeKnownLink(
 539                                 $this->getTitle(),
 540                                 new HtmlArmor( $last ),
 541                                 [],
 542                                 [
 543                                         'diff' => $prevRev->getId(),
 544                                         'oldid' => 'prev'
 545                                 ]
 546                         );
 547                 }
 548
 549                 $nextRev = new Revision( $next, 0, $this->getTitle() );
 550
 551                 if ( !$prevRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
 552                         || !$nextRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
 553                 ) {
 554                         return $last;
 555                 }
 556
 557                 return $linkRenderer->makeKnownLink(
 558                         $this->getTitle(),
 559                         new HtmlArmor( $last ),
 560                         [],
 561                         [
 562                                 'diff' => $prevRev->getId(),
 563                                 'oldid' => $next->rev_id
 564                         ]
 565                 );
 566         }
 567
 568         /**
 569          * Create radio buttons for page history
 570          *
 571          * @param Revision $rev
 572          * @param bool $firstInList Is this version the first one?
 573          *
 574          * @return string HTML output for the radio buttons
 575          */
 576         function diffButtons( $rev, $firstInList ) {
 577                 if ( $this->getNumRows() > 1 ) {
 578                         $id = $rev->getId();
 579                         $radio = [ 'type' => 'radio', 'value' => $id ];
 580                         /** @todo Move title texts to javascript */
 581                         if ( $firstInList ) {
 582                                 $first = Xml::element( 'input',
 583                                         array_merge( $radio, [
 584                                                 'style' => 'visibility:hidden',
 585                                                 'name' => 'oldid',
 586                                                 'id' => 'mw-oldid-null' ] )
 587                                 );
 588                                 $checkmark = [ 'checked' => 'checked' ];
 589                         } else {
 590                                 # Check visibility of old revisions
 591                                 if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
 592                                         $radio['disabled'] = 'disabled';
 593                                         $checkmark = []; // We will check the next possible one
 594                                 } elseif ( !$this->oldIdChecked ) {
 595                                         $checkmark = [ 'checked' => 'checked' ];
 596                                         $this->oldIdChecked = $id;
 597                                 } else {
 598                                         $checkmark = [];
 599                                 }
 600                                 $first = Xml::element( 'input',
 601                                         array_merge( $radio, $checkmark, [
 602                                                 'name' => 'oldid',
 603                                                 'id' => "mw-oldid-$id" ] ) );
 604                                 $checkmark = [];
 605                         }
 606                         $second = Xml::element( 'input',
 607                                 array_merge( $radio, $checkmark, [
 608                                         'name' => 'diff',
 609                                         'id' => "mw-diff-$id" ] ) );
 610
 611                         return $first . $second;
 612                 } else {
 613                         return '';
 614                 }
 615         }
 616
 617         /**
 618          * This is called if a write operation is possible from the generated HTML
 619          * @param bool $enable
 620          */
 621         function preventClickjacking( $enable = true ) {
 622                 $this->preventClickjacking = $enable;
 623         }
 624
 625         /**
 626          * Get the "prevent clickjacking" flag
 627          * @return bool
 628          */
 629         function getPreventClickjacking() {
 630                 return $this->preventClickjacking;
 631         }
 632
 633 }