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