includes/PageHistory.php

   1 <?php
   2 /**
   3  * Page history
   4  *
   5  * Split off from Article.php and Skin.php, 2003-12-22
   6  */
   7
   8 /**
   9  * This class handles printing the history page for an article.  In order to
  10  * be efficient, it uses timestamps rather than offsets for paging, to avoid
  11  * costly LIMIT,offset queries.
  12  *
  13  * Construct it by passing in an Article, and call $h->history() to print the
  14  * history.
  15  *
  16  */
  17 class PageHistory {
  18         const DIR_PREV = 0;
  19         const DIR_NEXT = 1;
  20
  21         var $mArticle, $mTitle, $mSkin;
  22         var $lastdate;
  23         var $linesonpage;
  24         var $mNotificationTimestamp;
  25         var $mLatestId = null;
  26
  27         /**
  28          * Construct a new PageHistory.
  29          *
  30          * @param Article $article
  31          * @returns nothing
  32          */
  33         function __construct($article) {
  34                 global $wgUser;
  35
  36                 $this->mArticle =& $article;
  37                 $this->mTitle =& $article->mTitle;
  38                 $this->mNotificationTimestamp = NULL;
  39                 $this->mSkin = $wgUser->getSkin();
  40         }
  41
  42         /**
  43          * Print the history page for an article.
  44          *
  45          * @returns nothing
  46          */
  47         function history() {
  48                 global $wgOut, $wgRequest, $wgTitle;
  49
  50                 /*
  51                  * Allow client caching.
  52                  */
  53
  54                 if( $wgOut->checkLastModified( $this->mArticle->getTimestamp() ) )
  55                         /* Client cache fresh and headers sent, nothing more to do. */
  56                         return;
  57
  58                 $fname = 'PageHistory::history';
  59                 wfProfileIn( $fname );
  60
  61                 /*
  62                  * Setup page variables.
  63                  */
  64                 $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
  65                 $wgOut->setArticleFlag( false );
  66                 $wgOut->setArticleRelated( true );
  67                 $wgOut->setRobotpolicy( 'noindex,nofollow' );
  68                 $wgOut->setSyndicated( true );
  69
  70                 $logPage = SpecialPage::getTitleFor( 'Log' );
  71                 $logLink = $this->mSkin->makeKnownLinkObj( $logPage, wfMsgHtml( 'viewpagelogs' ), 'page=' . $this->mTitle->getPrefixedUrl() );
  72
  73                 $subtitle = wfMsgHtml( 'revhistory' ) . '<br />' . $logLink;
  74                 $wgOut->setSubtitle( $subtitle );
  75
  76                 $feedType = $wgRequest->getVal( 'feed' );
  77                 if( $feedType ) {
  78                         wfProfileOut( $fname );
  79                         return $this->feed( $feedType );
  80                 }
  81
  82                 /*
  83                  * Fail if article doesn't exist.
  84                  */
  85                 if( !$this->mTitle->exists() ) {
  86                         $wgOut->addWikiText( wfMsg( 'nohistory' ) );
  87                         wfProfileOut( $fname );
  88                         return;
  89                 }
  90
  91
  92                 /*
  93                  * "go=first" means to jump to the last (earliest) history page.
  94                  * This is deprecated, it no longer appears in the user interface
  95                  */
  96                 if ( $wgRequest->getText("go") == 'first' ) {
  97                         $limit = $wgRequest->getInt( 'limit', 50 );
  98                         $wgOut->redirect( $wgTitle->getLocalURL( "action=history&limit={$limit}&dir=prev" ) );
  99                         return;
 100                 }
 101
 102                 wfRunHooks( 'PageHistoryBeforeList', array( &$this->mArticle ) );
 103
 104                 /**
 105                  * Do the list
 106                  */
 107                 $pager = new PageHistoryPager( $this );
 108                 $this->linesonpage = $pager->getNumRows();
 109                 $wgOut->addHTML(
 110                         $pager->getNavigationBar() .
 111                         $this->beginHistoryList() .
 112                         $pager->getBody() .
 113                         $this->endHistoryList() .
 114                         $pager->getNavigationBar()
 115                 );
 116                 wfProfileOut( $fname );
 117         }
 118
 119         /** @todo document */
 120         function beginHistoryList() {
 121                 global $wgTitle;
 122                 $this->lastdate = '';
 123                 $s = wfMsgExt( 'histlegend', array( 'parse') );
 124                 $s .= '<form action="' . $wgTitle->escapeLocalURL( '-' ) . '" method="get">';
 125                 $prefixedkey = htmlspecialchars($wgTitle->getPrefixedDbKey());
 126
 127                 // The following line is SUPPOSED to have double-quotes around the
 128                 // $prefixedkey variable, because htmlspecialchars() doesn't escape
 129                 // single-quotes.
 130                 //
 131                 // On at least two occasions people have changed it to single-quotes,
 132                 // which creates invalid HTML and incorrect display of the resulting
 133                 // link.
 134                 //
 135                 // Please do not break this a third time. Thank you for your kind
 136                 // consideration and cooperation.
 137                 //
 138                 $s .= "<input type='hidden' name='title' value=\"{$prefixedkey}\" />\n";
 139
 140                 $s .= $this->submitButton();
 141                 $s .= '<ul id="pagehistory">' . "\n";
 142                 return $s;
 143         }
 144
 145         /** @todo document */
 146         function endHistoryList() {
 147                 $s = '</ul>';
 148                 $s .= $this->submitButton( array( 'id' => 'historysubmit' ) );
 149                 $s .= '</form>';
 150                 return $s;
 151         }
 152
 153         /** @todo document */
 154         function submitButton( $bits = array() ) {
 155                 return ( $this->linesonpage > 0 )
 156                         ? wfElement( 'input', array_merge( $bits,
 157                                 array(
 158                                         'class'     => 'historysubmit',
 159                                         'type'      => 'submit',
 160                                         'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
 161                                         'title'     => wfMsg( 'tooltip-compareselectedversions' ).' ['.wfMsg( 'accesskey-compareselectedversions' ).']',
 162                                         'value'     => wfMsg( 'compareselectedversions' ),
 163                                 ) ) )
 164                         : '';
 165         }
 166
 167         /**
 168          * Returns a row from the history printout.
 169          *
 170          * @todo document some more, and maybe clean up the code (some params redundant?)
 171          *
 172          * @param object $row The database row corresponding to the line (or is it the previous line?).
 173          * @param object $next The database row corresponding to the next line (or is it this one?).
 174          * @param int $counter Apparently a counter of what row number we're at, counted from the top row = 1.
 175          * @param $notificationtimestamp
 176          * @param bool $latest Whether this row corresponds to the page's latest revision.
 177          * @param bool $firstInList Whether this row corresponds to the first displayed on this history page.
 178          * @return string HTML output for the row
 179          */
 180         function historyLine( $row, $next, $counter = '', $notificationtimestamp = false, $latest = false, $firstInList = false ) {
 181                 global $wgUser, $wgLang;
 182                 $rev = new Revision( $row );
 183                 $rev->setTitle( $this->mTitle );
 184
 185                 $s = '<li>';
 186                 $curlink = $this->curLink( $rev, $latest );
 187                 $lastlink = $this->lastLink( $rev, $next, $counter );
 188                 $arbitrary = $this->diffButtons( $rev, $firstInList, $counter );
 189                 $link = $this->revLink( $rev );
 190
 191                 $user = $this->mSkin->userLink( $rev->getUser(), $rev->getUserText() )
 192                                 . $this->mSkin->userToolLinks( $rev->getUser(), $rev->getUserText() );
 193
 194                 $s .= "($curlink) ($lastlink) $arbitrary";
 195
 196                 if( $wgUser->isAllowed( 'deleterevision' ) ) {
 197                         $revdel = SpecialPage::getTitleFor( 'Revisiondelete' );
 198                         if( $firstInList ) {
 199                                 // We don't currently handle well changing the top revision's settings
 200                                 $del = wfMsgHtml( 'rev-delundel' );
 201                         } else if( !$rev->userCan( Revision::DELETED_RESTRICTED ) ) {
 202                         // If revision was hidden from sysops
 203                                 $del = wfMsgHtml( 'rev-delundel' );
 204                         } else {
 205                                 $del = $this->mSkin->makeKnownLinkObj( $revdel,
 206                                         wfMsg( 'rev-delundel' ),
 207                                         'target=' . urlencode( $this->mTitle->getPrefixedDbkey() ) .
 208                                         '&oldid=' . urlencode( $rev->getId() ) );
 209                         }
 210                         $s .= " (<small>$del</small>) ";
 211                 }
 212
 213                 $s .= " $link";
 214                 #getUser is safe, but this avoids making the invalid untargeted contribs links
 215                 if( $row->rev_deleted & Revision::DELETED_USER ) {
 216                         $user = '<span class="history-deleted">' . wfMsg('rev-deleted-user') . '</span>';
 217                 }
 218                 $s .= " <span class='history-user'>$user</span>";
 219
 220                 if( $row->rev_minor_edit ) {
 221                         $s .= ' ' . wfElement( 'span', array( 'class' => 'minor' ), wfMsg( 'minoreditletter') );
 222                 }
 223
 224                 if (!is_null($size = $rev->getSize())) {
 225                         if ($size == 0)
 226                                 $stxt = wfMsgHtml('historyempty');
 227                         else
 228                                 $stxt = wfMsgHtml('historysize', $wgLang->formatNum( $size ) );
 229                         $s .= " <span class=\"history-size\">$stxt</span>";
 230                 }
 231
 232                 #getComment is safe, but this is better formatted
 233                 if( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
 234                         $s .= " <span class=\"history-deleted\"><span class=\"comment\">" .
 235                         wfMsgHtml( 'rev-deleted-comment' ) . "</span></span>";
 236                 } else {
 237                         $s .= $this->mSkin->revComment( $rev );
 238                 }
 239
 240                 if ($notificationtimestamp && ($row->rev_timestamp >= $notificationtimestamp)) {
 241                         $s .= ' <span class="updatedmarker">' .  wfMsgHtml( 'updatedmarker' ) . '</span>';
 242                 }
 243                 #add blurb about text having been deleted
 244                 if( $row->rev_deleted & Revision::DELETED_TEXT ) {
 245                         $s .= ' ' . wfMsgHtml( 'deletedrev' );
 246                 }
 247                 if( $wgUser->isAllowed( 'rollback' ) && $latest ) {
 248                         $s .= ' '.$this->mSkin->generateRollback( $rev );
 249                 }
 250
 251                 if ( !is_null( $next ) ) {
 252                         $undolink = $this->mSkin->makeKnownLinkObj(
 253                                 $this->mTitle,
 254                                 '(' . wfMsgHtml( 'editundo' ) . ')',
 255                                 'action=edit&undoafter=' . $next->rev_id . '&undo=' . $rev->getId()
 256                         );
 257                         $s .= " <span class=\"mw-history-undo\">{$undolink}</span>";
 258                 }
 259
 260                 wfRunHooks( 'PageHistoryLineEnding', array( &$row , &$s ) );
 261
 262                 $s .= "</li>\n";
 263
 264                 return $s;
 265         }
 266
 267         /** @todo document */
 268         function revLink( $rev ) {
 269                 global $wgLang;
 270                 $date = $wgLang->timeanddate( wfTimestamp(TS_MW, $rev->getTimestamp()), true );
 271                 if( $rev->userCan( Revision::DELETED_TEXT ) ) {
 272                         $link = $this->mSkin->makeKnownLinkObj(
 273                                 $this->mTitle, $date, "oldid=" . $rev->getId() );
 274                 } else {
 275                         $link = $date;
 276                 }
 277                 if( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 278                         return '<span class="history-deleted">' . $link . '</span>';
 279                 }
 280                 return $link;
 281         }
 282
 283         /** @todo document */
 284         function curLink( $rev, $latest ) {
 285                 $cur = wfMsgExt( 'cur', array( 'escape') );
 286                 if( $latest || !$rev->userCan( Revision::DELETED_TEXT ) ) {
 287                         return $cur;
 288                 } else {
 289                         return $this->mSkin->makeKnownLinkObj(
 290                                 $this->mTitle, $cur,
 291                                 'diff=' . $this->getLatestID() .
 292                                 "&oldid=" . $rev->getId() );
 293                 }
 294         }
 295
 296         /** @todo document */
 297         function lastLink( $rev, $next, $counter ) {
 298                 $last = wfMsgExt( 'last', array( 'escape' ) );
 299                 if ( is_null( $next ) ) {
 300                         # Probably no next row
 301                         return $last;
 302                 } elseif ( $next === 'unknown' ) {
 303                         # Next row probably exists but is unknown, use an oldid=prev link
 304                         return $this->mSkin->makeKnownLinkObj(
 305                                 $this->mTitle,
 306                                 $last,
 307                                 "diff=" . $rev->getId() . "&oldid=prev" );
 308                 } elseif( !$rev->userCan( Revision::DELETED_TEXT ) ) {
 309                         return $last;
 310                 } else {
 311                         return $this->mSkin->makeKnownLinkObj(
 312                                 $this->mTitle,
 313                                 $last,
 314                                 "diff=" . $rev->getId() . "&oldid={$next->rev_id}"
 315                                 /*,
 316                                 '',
 317                                 '',
 318                                 "tabindex={$counter}"*/ );
 319                 }
 320         }
 321
 322         /** @todo document */
 323         function diffButtons( $rev, $firstInList, $counter ) {
 324                 if( $this->linesonpage > 1) {
 325                         $radio = array(
 326                                 'type'  => 'radio',
 327                                 'value' => $rev->getId(),
 328 # do we really need to flood this on every item?
 329 #                               'title' => wfMsgHtml( 'selectolderversionfordiff' )
 330                         );
 331
 332                         if( !$rev->userCan( Revision::DELETED_TEXT ) ) {
 333                                 $radio['disabled'] = 'disabled';
 334                         }
 335
 336                         /** @todo: move title texts to javascript */
 337                         if ( $firstInList ) {
 338                                 $first = wfElement( 'input', array_merge(
 339                                         $radio,
 340                                         array(
 341                                                 'style' => 'visibility:hidden',
 342                                                 'name'  => 'oldid' ) ) );
 343                                 $checkmark = array( 'checked' => 'checked' );
 344                         } else {
 345                                 if( $counter == 2 ) {
 346                                         $checkmark = array( 'checked' => 'checked' );
 347                                 } else {
 348                                         $checkmark = array();
 349                                 }
 350                                 $first = wfElement( 'input', array_merge(
 351                                         $radio,
 352                                         $checkmark,
 353                                         array( 'name'  => 'oldid' ) ) );
 354                                 $checkmark = array();
 355                         }
 356                         $second = wfElement( 'input', array_merge(
 357                                 $radio,
 358                                 $checkmark,
 359                                 array( 'name'  => 'diff' ) ) );
 360                         return $first . $second;
 361                 } else {
 362                         return '';
 363                 }
 364         }
 365
 366         /** @todo document */
 367         function getLatestId() {
 368                 if( is_null( $this->mLatestId ) ) {
 369                         $id = $this->mTitle->getArticleID();
 370                         $db = wfGetDB(DB_SLAVE);
 371                         $this->mLatestId = $db->selectField( 'page',
 372                                 "page_latest",
 373                                 array( 'page_id' => $id ),
 374                                 'PageHistory::getLatestID' );
 375                 }
 376                 return $this->mLatestId;
 377         }
 378
 379         /**
 380          * Fetch an array of revisions, specified by a given limit, offset and
 381          * direction. This is now only used by the feeds. It was previously
 382          * used by the main UI but that's now handled by the pager.
 383          */
 384         function fetchRevisions($limit, $offset, $direction) {
 385                 $fname = 'PageHistory::fetchRevisions';
 386
 387                 $dbr = wfGetDB( DB_SLAVE );
 388
 389                 if ($direction == PageHistory::DIR_PREV)
 390                         list($dirs, $oper) = array("ASC", ">=");
 391                 else /* $direction == PageHistory::DIR_NEXT */
 392                         list($dirs, $oper) = array("DESC", "<=");
 393
 394                 if ($offset)
 395                         $offsets = array("rev_timestamp $oper '$offset'");
 396                 else
 397                         $offsets = array();
 398
 399                 $page_id = $this->mTitle->getArticleID();
 400
 401                 $res = $dbr->select(
 402                         'revision',
 403                         Revision::selectFields(),
 404                         array_merge(array("rev_page=$page_id"), $offsets),
 405                         $fname,
 406                         array('ORDER BY' => "rev_timestamp $dirs",
 407                                 'USE INDEX' => 'page_timestamp', 'LIMIT' => $limit)
 408                         );
 409
 410                 $result = array();
 411                 while (($obj = $dbr->fetchObject($res)) != NULL)
 412                         $result[] = $obj;
 413
 414                 return $result;
 415         }
 416
 417         /** @todo document */
 418         function getNotificationTimestamp() {
 419                 global $wgUser, $wgShowUpdatedMarker;
 420                 $fname = 'PageHistory::getNotficationTimestamp';
 421
 422                 if ($this->mNotificationTimestamp !== NULL)
 423                         return $this->mNotificationTimestamp;
 424
 425                 if ($wgUser->isAnon() || !$wgShowUpdatedMarker)
 426                         return $this->mNotificationTimestamp = false;
 427
 428                 $dbr = wfGetDB(DB_SLAVE);
 429
 430                 $this->mNotificationTimestamp = $dbr->selectField(
 431                         'watchlist',
 432                         'wl_notificationtimestamp',
 433                         array(  'wl_namespace' => $this->mTitle->getNamespace(),
 434                                 'wl_title' => $this->mTitle->getDBkey(),
 435                                 'wl_user' => $wgUser->getID()
 436                         ),
 437                         $fname);
 438
 439                 // Don't use the special value reserved for telling whether the field is filled
 440                 if ( is_null( $this->mNotificationTimestamp ) ) {
 441                         $this->mNotificationTimestamp = false;
 442                 }
 443
 444                 return $this->mNotificationTimestamp;
 445         }
 446
 447         /**
 448          * Output a subscription feed listing recent edits to this page.
 449          * @param string $type
 450          */
 451         function feed( $type ) {
 452                 require_once 'SpecialRecentchanges.php';
 453
 454                 global $wgFeedClasses;
 455                 if( !isset( $wgFeedClasses[$type] ) ) {
 456                         global $wgOut;
 457                         $wgOut->addWikiText( wfMsg( 'feed-invalid' ) );
 458                         return;
 459                 }
 460
 461                 $feed = new $wgFeedClasses[$type](
 462                         $this->mTitle->getPrefixedText() . ' - ' .
 463                                 wfMsgForContent( 'history-feed-title' ),
 464                         wfMsgForContent( 'history-feed-description' ),
 465                         $this->mTitle->getFullUrl( 'action=history' ) );
 466
 467                 $items = $this->fetchRevisions(10, 0, PageHistory::DIR_NEXT);
 468                 $feed->outHeader();
 469                 if( $items ) {
 470                         foreach( $items as $row ) {
 471                                 $feed->outItem( $this->feedItem( $row ) );
 472                         }
 473                 } else {
 474                         $feed->outItem( $this->feedEmpty() );
 475                 }
 476                 $feed->outFooter();
 477         }
 478
 479         function feedEmpty() {
 480                 global $wgOut;
 481                 return new FeedItem(
 482                         wfMsgForContent( 'nohistory' ),
 483                         $wgOut->parse( wfMsgForContent( 'history-feed-empty' ) ),
 484                         $this->mTitle->getFullUrl(),
 485                         wfTimestamp( TS_MW ),
 486                         '',
 487                         $this->mTitle->getTalkPage()->getFullUrl() );
 488         }
 489
 490         /**
 491          * Generate a FeedItem object from a given revision table row
 492          * Borrows Recent Changes' feed generation functions for formatting;
 493          * includes a diff to the previous revision (if any).
 494          *
 495          * @param $row
 496          * @return FeedItem
 497          */
 498         function feedItem( $row ) {
 499                 $rev = new Revision( $row );
 500                 $rev->setTitle( $this->mTitle );
 501                 $text = rcFormatDiffRow( $this->mTitle,
 502                         $this->mTitle->getPreviousRevisionID( $rev->getId() ),
 503                         $rev->getId(),
 504                         $rev->getTimestamp(),
 505                         $rev->getComment() );
 506
 507                 if( $rev->getComment() == '' ) {
 508                         global $wgContLang;
 509                         $title = wfMsgForContent( 'history-feed-item-nocomment',
 510                                 $rev->getUserText(),
 511                                 $wgContLang->timeanddate( $rev->getTimestamp() ) );
 512                 } else {
 513                         $title = $rev->getUserText() . ": " . $this->stripComment( $rev->getComment() );
 514                 }
 515
 516                 return new FeedItem(
 517                         $title,
 518                         $text,
 519                         $this->mTitle->getFullUrl( 'diff=' . $rev->getId() . '&oldid=prev' ),
 520                         $rev->getTimestamp(),
 521                         $rev->getUserText(),
 522                         $this->mTitle->getTalkPage()->getFullUrl() );
 523         }
 524
 525         /**
 526          * Quickie hack... strip out wikilinks to more legible form from the comment.
 527          */
 528         function stripComment( $text ) {
 529                 return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
 530         }
 531 }
 532
 533
 534 /**
 535  * @addtogroup Pager
 536  */
 537 class PageHistoryPager extends ReverseChronologicalPager {
 538         public $mLastRow = false, $mPageHistory;
 539
 540         function __construct( $pageHistory ) {
 541                 parent::__construct();
 542                 $this->mPageHistory = $pageHistory;
 543         }
 544
 545         function getQueryInfo() {
 546                 return array(
 547                         'tables' => 'revision',
 548                         'fields' => Revision::selectFields(),
 549                         'conds' => array('rev_page' => $this->mPageHistory->mTitle->getArticleID() ),
 550                         'options' => array( 'USE INDEX' => 'page_timestamp' )
 551                 );
 552         }
 553
 554         function getIndexField() {
 555                 return 'rev_timestamp';
 556         }
 557
 558         function formatRow( $row ) {
 559                 if ( $this->mLastRow ) {
 560                         $latest = $this->mCounter == 1 && $this->mOffset == '';
 561                         $firstInList = $this->mCounter == 1;
 562                         $s = $this->mPageHistory->historyLine( $this->mLastRow, $row, $this->mCounter++,
 563                                 $this->mPageHistory->getNotificationTimestamp(), $latest, $firstInList );
 564                 } else {
 565                         $s = '';
 566                 }
 567                 $this->mLastRow = $row;
 568                 return $s;
 569         }
 570
 571         function getStartBody() {
 572                 $this->mLastRow = false;
 573                 $this->mCounter = 1;
 574                 return '';
 575         }
 576
 577         function getEndBody() {
 578                 if ( $this->mLastRow ) {
 579                         $latest = $this->mCounter == 1 && $this->mOffset == 0;
 580                         $firstInList = $this->mCounter == 1;
 581                         if ( $this->mIsBackwards ) {
 582                                 # Next row is unknown, but for UI reasons, probably exists if an offset has been specified
 583                                 if ( $this->mOffset == '' ) {
 584                                         $next = null;
 585                                 } else {
 586                                         $next = 'unknown';
 587                                 }
 588                         } else {
 589                                 # The next row is the past-the-end row
 590                                 $next = $this->mPastTheEndRow;
 591                         }
 592                         $s = $this->mPageHistory->historyLine( $this->mLastRow, $next, $this->mCounter++,
 593                                 $this->mPageHistory->getNotificationTimestamp(), $latest, $firstInList );
 594                 } else {
 595                         $s = '';
 596                 }
 597                 return $s;
 598         }
 599 }
 600
 601