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                 wfRunHooks( 'PageHistoryLineEnding', array( &$row , &$s ) );
 252
 253                 $s .= "</li>\n";
 254
 255                 return $s;
 256         }
 257
 258         /** @todo document */
 259         function revLink( $rev ) {
 260                 global $wgLang;
 261                 $date = $wgLang->timeanddate( wfTimestamp(TS_MW, $rev->getTimestamp()), true );
 262                 if( $rev->userCan( Revision::DELETED_TEXT ) ) {
 263                         $link = $this->mSkin->makeKnownLinkObj(
 264                                 $this->mTitle, $date, "oldid=" . $rev->getId() );
 265                 } else {
 266                         $link = $date;
 267                 }
 268                 if( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 269                         return '<span class="history-deleted">' . $link . '</span>';
 270                 }
 271                 return $link;
 272         }
 273
 274         /** @todo document */
 275         function curLink( $rev, $latest ) {
 276                 $cur = wfMsgExt( 'cur', array( 'escape') );
 277                 if( $latest || !$rev->userCan( Revision::DELETED_TEXT ) ) {
 278                         return $cur;
 279                 } else {
 280                         return $this->mSkin->makeKnownLinkObj(
 281                                 $this->mTitle, $cur,
 282                                 'diff=' . $this->getLatestID() .
 283                                 "&oldid=" . $rev->getId() );
 284                 }
 285         }
 286
 287         /** @todo document */
 288         function lastLink( $rev, $next, $counter ) {
 289                 $last = wfMsgExt( 'last', array( 'escape' ) );
 290                 if ( is_null( $next ) ) {
 291                         # Probably no next row
 292                         return $last;
 293                 } elseif ( $next === 'unknown' ) {
 294                         # Next row probably exists but is unknown, use an oldid=prev link
 295                         return $this->mSkin->makeKnownLinkObj(
 296                                 $this->mTitle,
 297                                 $last,
 298                                 "diff=" . $rev->getId() . "&oldid=prev" );
 299                 } elseif( !$rev->userCan( Revision::DELETED_TEXT ) ) {
 300                         return $last;
 301                 } else {
 302                         return $this->mSkin->makeKnownLinkObj(
 303                                 $this->mTitle,
 304                                 $last,
 305                                 "diff=" . $rev->getId() . "&oldid={$next->rev_id}"
 306                                 /*,
 307                                 '',
 308                                 '',
 309                                 "tabindex={$counter}"*/ );
 310                 }
 311         }
 312
 313         /** @todo document */
 314         function diffButtons( $rev, $firstInList, $counter ) {
 315                 if( $this->linesonpage > 1) {
 316                         $radio = array(
 317                                 'type'  => 'radio',
 318                                 'value' => $rev->getId(),
 319 # do we really need to flood this on every item?
 320 #                               'title' => wfMsgHtml( 'selectolderversionfordiff' )
 321                         );
 322
 323                         if( !$rev->userCan( Revision::DELETED_TEXT ) ) {
 324                                 $radio['disabled'] = 'disabled';
 325                         }
 326
 327                         /** @todo: move title texts to javascript */
 328                         if ( $firstInList ) {
 329                                 $first = wfElement( 'input', array_merge(
 330                                         $radio,
 331                                         array(
 332                                                 'style' => 'visibility:hidden',
 333                                                 'name'  => 'oldid' ) ) );
 334                                 $checkmark = array( 'checked' => 'checked' );
 335                         } else {
 336                                 if( $counter == 2 ) {
 337                                         $checkmark = array( 'checked' => 'checked' );
 338                                 } else {
 339                                         $checkmark = array();
 340                                 }
 341                                 $first = wfElement( 'input', array_merge(
 342                                         $radio,
 343                                         $checkmark,
 344                                         array( 'name'  => 'oldid' ) ) );
 345                                 $checkmark = array();
 346                         }
 347                         $second = wfElement( 'input', array_merge(
 348                                 $radio,
 349                                 $checkmark,
 350                                 array( 'name'  => 'diff' ) ) );
 351                         return $first . $second;
 352                 } else {
 353                         return '';
 354                 }
 355         }
 356
 357         /** @todo document */
 358         function getLatestId() {
 359                 if( is_null( $this->mLatestId ) ) {
 360                         $id = $this->mTitle->getArticleID();
 361                         $db = wfGetDB(DB_SLAVE);
 362                         $this->mLatestId = $db->selectField( 'page',
 363                                 "page_latest",
 364                                 array( 'page_id' => $id ),
 365                                 'PageHistory::getLatestID' );
 366                 }
 367                 return $this->mLatestId;
 368         }
 369
 370         /**
 371          * Fetch an array of revisions, specified by a given limit, offset and
 372          * direction. This is now only used by the feeds. It was previously
 373          * used by the main UI but that's now handled by the pager.
 374          */
 375         function fetchRevisions($limit, $offset, $direction) {
 376                 $fname = 'PageHistory::fetchRevisions';
 377
 378                 $dbr = wfGetDB( DB_SLAVE );
 379
 380                 if ($direction == PageHistory::DIR_PREV)
 381                         list($dirs, $oper) = array("ASC", ">=");
 382                 else /* $direction == PageHistory::DIR_NEXT */
 383                         list($dirs, $oper) = array("DESC", "<=");
 384
 385                 if ($offset)
 386                         $offsets = array("rev_timestamp $oper '$offset'");
 387                 else
 388                         $offsets = array();
 389
 390                 $page_id = $this->mTitle->getArticleID();
 391
 392                 $res = $dbr->select(
 393                         'revision',
 394                         Revision::selectFields(),
 395                         array_merge(array("rev_page=$page_id"), $offsets),
 396                         $fname,
 397                         array('ORDER BY' => "rev_timestamp $dirs",
 398                                 'USE INDEX' => 'page_timestamp', 'LIMIT' => $limit)
 399                         );
 400
 401                 $result = array();
 402                 while (($obj = $dbr->fetchObject($res)) != NULL)
 403                         $result[] = $obj;
 404
 405                 return $result;
 406         }
 407
 408         /** @todo document */
 409         function getNotificationTimestamp() {
 410                 global $wgUser, $wgShowUpdatedMarker;
 411                 $fname = 'PageHistory::getNotficationTimestamp';
 412
 413                 if ($this->mNotificationTimestamp !== NULL)
 414                         return $this->mNotificationTimestamp;
 415
 416                 if ($wgUser->isAnon() || !$wgShowUpdatedMarker)
 417                         return $this->mNotificationTimestamp = false;
 418
 419                 $dbr = wfGetDB(DB_SLAVE);
 420
 421                 $this->mNotificationTimestamp = $dbr->selectField(
 422                         'watchlist',
 423                         'wl_notificationtimestamp',
 424                         array(  'wl_namespace' => $this->mTitle->getNamespace(),
 425                                 'wl_title' => $this->mTitle->getDBkey(),
 426                                 'wl_user' => $wgUser->getID()
 427                         ),
 428                         $fname);
 429
 430                 // Don't use the special value reserved for telling whether the field is filled
 431                 if ( is_null( $this->mNotificationTimestamp ) ) {
 432                         $this->mNotificationTimestamp = false;
 433                 }
 434
 435                 return $this->mNotificationTimestamp;
 436         }
 437
 438         /**
 439          * Output a subscription feed listing recent edits to this page.
 440          * @param string $type
 441          */
 442         function feed( $type ) {
 443                 require_once 'SpecialRecentchanges.php';
 444
 445                 global $wgFeedClasses;
 446                 if( !isset( $wgFeedClasses[$type] ) ) {
 447                         global $wgOut;
 448                         $wgOut->addWikiText( wfMsg( 'feed-invalid' ) );
 449                         return;
 450                 }
 451
 452                 $feed = new $wgFeedClasses[$type](
 453                         $this->mTitle->getPrefixedText() . ' - ' .
 454                                 wfMsgForContent( 'history-feed-title' ),
 455                         wfMsgForContent( 'history-feed-description' ),
 456                         $this->mTitle->getFullUrl( 'action=history' ) );
 457
 458                 $items = $this->fetchRevisions(10, 0, PageHistory::DIR_NEXT);
 459                 $feed->outHeader();
 460                 if( $items ) {
 461                         foreach( $items as $row ) {
 462                                 $feed->outItem( $this->feedItem( $row ) );
 463                         }
 464                 } else {
 465                         $feed->outItem( $this->feedEmpty() );
 466                 }
 467                 $feed->outFooter();
 468         }
 469
 470         function feedEmpty() {
 471                 global $wgOut;
 472                 return new FeedItem(
 473                         wfMsgForContent( 'nohistory' ),
 474                         $wgOut->parse( wfMsgForContent( 'history-feed-empty' ) ),
 475                         $this->mTitle->getFullUrl(),
 476                         wfTimestamp( TS_MW ),
 477                         '',
 478                         $this->mTitle->getTalkPage()->getFullUrl() );
 479         }
 480
 481         /**
 482          * Generate a FeedItem object from a given revision table row
 483          * Borrows Recent Changes' feed generation functions for formatting;
 484          * includes a diff to the previous revision (if any).
 485          *
 486          * @param $row
 487          * @return FeedItem
 488          */
 489         function feedItem( $row ) {
 490                 $rev = new Revision( $row );
 491                 $rev->setTitle( $this->mTitle );
 492                 $text = rcFormatDiffRow( $this->mTitle,
 493                         $this->mTitle->getPreviousRevisionID( $rev->getId() ),
 494                         $rev->getId(),
 495                         $rev->getTimestamp(),
 496                         $rev->getComment() );
 497
 498                 if( $rev->getComment() == '' ) {
 499                         global $wgContLang;
 500                         $title = wfMsgForContent( 'history-feed-item-nocomment',
 501                                 $rev->getUserText(),
 502                                 $wgContLang->timeanddate( $rev->getTimestamp() ) );
 503                 } else {
 504                         $title = $rev->getUserText() . ": " . $this->stripComment( $rev->getComment() );
 505                 }
 506
 507                 return new FeedItem(
 508                         $title,
 509                         $text,
 510                         $this->mTitle->getFullUrl( 'diff=' . $rev->getId() . '&oldid=prev' ),
 511                         $rev->getTimestamp(),
 512                         $rev->getUserText(),
 513                         $this->mTitle->getTalkPage()->getFullUrl() );
 514         }
 515
 516         /**
 517          * Quickie hack... strip out wikilinks to more legible form from the comment.
 518          */
 519         function stripComment( $text ) {
 520                 return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
 521         }
 522 }
 523
 524
 525 /**
 526  * @addtogroup Pager
 527  */
 528 class PageHistoryPager extends ReverseChronologicalPager {
 529         public $mLastRow = false, $mPageHistory;
 530
 531         function __construct( $pageHistory ) {
 532                 parent::__construct();
 533                 $this->mPageHistory = $pageHistory;
 534         }
 535
 536         function getQueryInfo() {
 537                 return array(
 538                         'tables' => 'revision',
 539                         'fields' => Revision::selectFields(),
 540                         'conds' => array('rev_page' => $this->mPageHistory->mTitle->getArticleID() ),
 541                         'options' => array( 'USE INDEX' => 'page_timestamp' )
 542                 );
 543         }
 544
 545         function getIndexField() {
 546                 return 'rev_timestamp';
 547         }
 548
 549         function formatRow( $row ) {
 550                 if ( $this->mLastRow ) {
 551                         $latest = $this->mCounter == 1 && $this->mOffset == '';
 552                         $firstInList = $this->mCounter == 1;
 553                         $s = $this->mPageHistory->historyLine( $this->mLastRow, $row, $this->mCounter++,
 554                                 $this->mPageHistory->getNotificationTimestamp(), $latest, $firstInList );
 555                 } else {
 556                         $s = '';
 557                 }
 558                 $this->mLastRow = $row;
 559                 return $s;
 560         }
 561
 562         function getStartBody() {
 563                 $this->mLastRow = false;
 564                 $this->mCounter = 1;
 565                 return '';
 566         }
 567
 568         function getEndBody() {
 569                 if ( $this->mLastRow ) {
 570                         $latest = $this->mCounter == 1 && $this->mOffset == 0;
 571                         $firstInList = $this->mCounter == 1;
 572                         if ( $this->mIsBackwards ) {
 573                                 # Next row is unknown, but for UI reasons, probably exists if an offset has been specified
 574                                 if ( $this->mOffset == '' ) {
 575                                         $next = null;
 576                                 } else {
 577                                         $next = 'unknown';
 578                                 }
 579                         } else {
 580                                 # The next row is the past-the-end row
 581                                 $next = $this->mPastTheEndRow;
 582                         }
 583                         $s = $this->mPageHistory->historyLine( $this->mLastRow, $next, $this->mCounter++,
 584                                 $this->mPageHistory->getNotificationTimestamp(), $latest, $firstInList );
 585                 } else {
 586                         $s = '';
 587                 }
 588                 return $s;
 589         }
 590 }
 591
 592