Tweak for r29561: don't grab a database object until we need it
[lhc/web/wiklou.git] / includes / PageHistory.php
index 0f39a99..9d84665 100644 (file)
@@ -3,7 +3,6 @@
  * Page history
  *
  * Split off from Article.php and Skin.php, 2003-12-22
- * @package MediaWiki
  */
 
 /**
@@ -14,9 +13,7 @@
  * Construct it by passing in an Article, and call $h->history() to print the
  * history.
  *
- * @package MediaWiki
  */
-
 class PageHistory {
        const DIR_PREV = 0;
        const DIR_NEXT = 1;
@@ -33,7 +30,7 @@ class PageHistory {
         * @param Article $article
         * @returns nothing
         */
-       function PageHistory($article) {
+       function __construct($article) {
                global $wgUser;
 
                $this->mArticle =& $article;
@@ -64,17 +61,16 @@ class PageHistory {
                /*
                 * Setup page variables.
                 */
-               $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
+               $wgOut->setPageTitle( wfMsg( 'history-title', $this->mTitle->getPrefixedText() ) );
+               $wgOut->setPageTitleActionText( wfMsg( 'history_short' ) );
                $wgOut->setArticleFlag( false );
                $wgOut->setArticleRelated( true );
                $wgOut->setRobotpolicy( 'noindex,nofollow' );
                $wgOut->setSyndicated( true );
 
-               $logPage = Title::makeTitle( NS_SPECIAL, 'Log' );
+               $logPage = SpecialPage::getTitleFor( 'Log' );
                $logLink = $this->mSkin->makeKnownLinkObj( $logPage, wfMsgHtml( 'viewpagelogs' ), 'page=' . $this->mTitle->getPrefixedUrl() );
-
-               $subtitle = wfMsgHtml( 'revhistory' ) . '<br />' . $logLink;
-               $wgOut->setSubtitle( $subtitle );
+               $wgOut->setSubtitle( $logLink );
 
                $feedType = $wgRequest->getVal( 'feed' );
                if( $feedType ) {
@@ -91,7 +87,6 @@ class PageHistory {
                        return;
                }
 
-               
                /*
                 * "go=first" means to jump to the last (earliest) history page.
                 * This is deprecated, it no longer appears in the user interface
@@ -102,23 +97,28 @@ class PageHistory {
                        return;
                }
 
+               wfRunHooks( 'PageHistoryBeforeList', array( &$this->mArticle ) );
+
                /** 
                 * Do the list
                 */
                $pager = new PageHistoryPager( $this );
-               $navbar = $pager->getNavigationBar();
                $this->linesonpage = $pager->getNumRows();
                $wgOut->addHTML(
                        $pager->getNavigationBar() . 
                        $this->beginHistoryList() . 
-                       $pager->getBody() . 
+                       $pager->getBody() .
                        $this->endHistoryList() .
                        $pager->getNavigationBar()
                );
                wfProfileOut( $fname );
        }
 
-       /** @todo document */
+       /**
+        * Creates begin of history list with a submit button
+        *
+        * @return string HTML output
+        */
        function beginHistoryList() {
                global $wgTitle;
                $this->lastdate = '';
@@ -144,7 +144,11 @@ class PageHistory {
                return $s;
        }
 
-       /** @todo document */
+       /**
+        * Creates end of history list with a submit button
+        *
+        * @return string HTML output
+        */
        function endHistoryList() {
                $s = '</ul>';
                $s .= $this->submitButton( array( 'id' => 'historysubmit' ) );
@@ -152,23 +156,42 @@ class PageHistory {
                return $s;
        }
 
-       /** @todo document */
+       /**
+        * Creates a submit button
+        *
+        * @param array $bits optional CSS ID
+        * @return string HTML output for the submit button
+        */
        function submitButton( $bits = array() ) {
-               return ( $this->linesonpage > 0 )
-                       ? wfElement( 'input', array_merge( $bits,
-                               array(
+               # Disable submit button if history has 1 revision only
+               if ( $this->linesonpage > 1 ) {
+                       return Xml::submitButton( wfMsg( 'compareselectedversions' ),
+                               $bits + array(
                                        'class'     => 'historysubmit',
-                                       'type'      => 'submit',
                                        'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
-                                       'title'     => wfMsg( 'tooltip-compareselectedversions' ).' ['.wfMsg( 'accesskey-compareselectedversions' ).']',
-                                       'value'     => wfMsg( 'compareselectedversions' ),
-                               ) ) )
-                       : '';
+                                       'title'     => wfMsg( 'tooltip-compareselectedversions' ),
+                                       )
+                               );
+               } else {
+                       return '';
+               }
        }
 
-       /** @todo document */
+       /**
+        * Returns a row from the history printout.
+        *
+        * @todo document some more, and maybe clean up the code (some params redundant?)
+        *
+        * @param object $row The database row corresponding to the line (or is it the previous line?).
+        * @param object $next The database row corresponding to the next line (or is it this one?).
+        * @param int $counter Apparently a counter of what row number we're at, counted from the top row = 1.
+        * @param $notificationtimestamp
+        * @param bool $latest Whether this row corresponds to the page's latest revision.
+        * @param bool $firstInList Whether this row corresponds to the first displayed on this history page.
+        * @return string HTML output for the row
+        */
        function historyLine( $row, $next, $counter = '', $notificationtimestamp = false, $latest = false, $firstInList = false ) {
-               global $wgUser;
+               global $wgUser, $wgLang;
                $rev = new Revision( $row );
                $rev->setTitle( $this->mTitle );
 
@@ -184,32 +207,82 @@ class PageHistory {
                $s .= "($curlink) ($lastlink) $arbitrary";
                
                if( $wgUser->isAllowed( 'deleterevision' ) ) {
-                       $revdel = Title::makeTitle( NS_SPECIAL, 'Revisiondelete' );
+                       $revdel = SpecialPage::getTitleFor( 'Revisiondelete' );
                        if( $firstInList ) {
                                // We don't currently handle well changing the top revision's settings
                                $del = wfMsgHtml( 'rev-delundel' );
+                       } else if( !$rev->userCan( Revision::DELETED_RESTRICTED ) ) {
+                       // If revision was hidden from sysops
+                               $del = wfMsgHtml( 'rev-delundel' );                     
                        } else {
                                $del = $this->mSkin->makeKnownLinkObj( $revdel,
                                        wfMsg( 'rev-delundel' ),
                                        'target=' . urlencode( $this->mTitle->getPrefixedDbkey() ) .
                                        '&oldid=' . urlencode( $rev->getId() ) );
                        }
-                       $s .= "(<small>$del</small>) ";
+                       $s .= " (<small>$del</small>) ";
                }
                
-               $s .= " $link <span class='history-user'>$user</span>";
+               $s .= " $link";
+               #getUser is safe, but this avoids making the invalid untargeted contribs links
+               if( $row->rev_deleted & Revision::DELETED_USER ) {
+                       $user = '<span class="history-deleted">' . wfMsg('rev-deleted-user') . '</span>';
+               }
+               $s .= " <span class='history-user'>$user</span>";
 
                if( $row->rev_minor_edit ) {
                        $s .= ' ' . wfElement( 'span', array( 'class' => 'minor' ), wfMsg( 'minoreditletter') );
                }
 
-               $s .= $this->mSkin->revComment( $rev );
+               if ( !is_null( $size = $rev->getSize() ) ) {
+                       if ( $size == 0 )
+                               $stxt = wfMsgHtml( 'historyempty' );
+                       else
+                               $stxt = wfMsgExt( 'historysize', array( 'parsemag' ), $wgLang->formatNum( $size ) );
+                       $s .= " <span class=\"history-size\">$stxt</span>";
+               }
+
+               #getComment is safe, but this is better formatted
+               if( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
+                       $s .= " <span class=\"history-deleted\"><span class=\"comment\">" .
+                       wfMsgHtml( 'rev-deleted-comment' ) . "</span></span>";
+               } else {
+                       $s .= $this->mSkin->revComment( $rev );
+               }
+               
                if ($notificationtimestamp && ($row->rev_timestamp >= $notificationtimestamp)) {
                        $s .= ' <span class="updatedmarker">' .  wfMsgHtml( 'updatedmarker' ) . '</span>';
                }
+               #add blurb about text having been deleted
                if( $row->rev_deleted & Revision::DELETED_TEXT ) {
                        $s .= ' ' . wfMsgHtml( 'deletedrev' );
                }
+               
+               $tools = array();
+               
+               if ( !is_null( $next ) && is_object( $next ) ) {
+                       if( $wgUser->isAllowed( 'rollback' ) && $latest ) {
+                               $tools[] = '<span class="mw-rollback-link">'
+                                       . $this->mSkin->buildRollbackLink( $rev )
+                                       . '</span>';
+                       }
+
+                       if( $this->mTitle->quickUserCan( 'edit' ) ) {
+                               $undolink = $this->mSkin->makeKnownLinkObj(
+                                       $this->mTitle,
+                                       wfMsgHtml( 'editundo' ),
+                                       'action=edit&undoafter=' . $next->rev_id . '&undo=' . $rev->getId()
+                               );
+                               $tools[] = "<span class=\"mw-history-undo\">{$undolink}</span>";
+                       }
+               }
+               
+               if( $tools ) {
+                       $s .= ' (' . implode( ' | ', $tools ) . ')';
+               }
+               
+               wfRunHooks( 'PageHistoryLineEnding', array( &$row , &$s ) );
+               
                $s .= "</li>\n";
 
                return $s;
@@ -270,14 +343,19 @@ class PageHistory {
                }
        }
 
-       /** @todo document */
+       /**
+        * Create radio buttons for page history
+        *
+        * @param object $rev Revision
+        * @param bool $firstInList Is this version the first one?
+        * @param int $counter A counter of what row number we're at, counted from the top row = 1.
+        * @return string HTML output for the radio buttons
+        */
        function diffButtons( $rev, $firstInList, $counter ) {
                if( $this->linesonpage > 1) {
                        $radio = array(
                                'type'  => 'radio',
                                'value' => $rev->getId(),
-# do we really need to flood this on every item?
-#                              'title' => wfMsgHtml( 'selectolderversionfordiff' )
                        );
 
                        if( !$rev->userCan( Revision::DELETED_TEXT ) ) {
@@ -286,7 +364,7 @@ class PageHistory {
 
                        /** @todo: move title texts to javascript */
                        if ( $firstInList ) {
-                               $first = wfElement( 'input', array_merge(
+                               $first = Xml::element( 'input', array_merge(
                                        $radio,
                                        array(
                                                'style' => 'visibility:hidden',
@@ -298,13 +376,13 @@ class PageHistory {
                                } else {
                                        $checkmark = array();
                                }
-                               $first = wfElement( 'input', array_merge(
+                               $first = Xml::element( 'input', array_merge(
                                        $radio,
                                        $checkmark,
                                        array( 'name'  => 'oldid' ) ) );
                                $checkmark = array();
                        }
-                       $second = wfElement( 'input', array_merge(
+                       $second = Xml::element( 'input', array_merge(
                                $radio,
                                $checkmark,
                                array( 'name'  => 'diff' ) ) );
@@ -318,7 +396,7 @@ class PageHistory {
        function getLatestId() {
                if( is_null( $this->mLatestId ) ) {
                        $id = $this->mTitle->getArticleID();
-                       $db =& wfGetDB(DB_SLAVE);
+                       $db = wfGetDB(DB_SLAVE);
                        $this->mLatestId = $db->selectField( 'page',
                                "page_latest",
                                array( 'page_id' => $id ),
@@ -335,7 +413,7 @@ class PageHistory {
        function fetchRevisions($limit, $offset, $direction) {
                $fname = 'PageHistory::fetchRevisions';
 
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
 
                if ($direction == PageHistory::DIR_PREV)
                        list($dirs, $oper) = array("ASC", ">=");
@@ -351,8 +429,7 @@ class PageHistory {
 
                $res = $dbr->select(
                        'revision',
-                       array('rev_id', 'rev_page', 'rev_text_id', 'rev_user', 'rev_comment', 'rev_user_text',
-                               'rev_timestamp', 'rev_minor_edit', 'rev_deleted'),
+                       Revision::selectFields(),
                        array_merge(array("rev_page=$page_id"), $offsets),
                        $fname,
                        array('ORDER BY' => "rev_timestamp $dirs",
@@ -377,7 +454,7 @@ class PageHistory {
                if ($wgUser->isAnon() || !$wgShowUpdatedMarker)
                        return $this->mNotificationTimestamp = false;
 
-               $dbr =& wfGetDB(DB_SLAVE);
+               $dbr = wfGetDB(DB_SLAVE);
 
                $this->mNotificationTimestamp = $dbr->selectField(
                        'watchlist',
@@ -483,6 +560,9 @@ class PageHistory {
 }
 
 
+/**
+ * @addtogroup Pager
+ */
 class PageHistoryPager extends ReverseChronologicalPager {
        public $mLastRow = false, $mPageHistory;
        
@@ -494,8 +574,7 @@ class PageHistoryPager extends ReverseChronologicalPager {
        function getQueryInfo() {
                return array(
                        'tables' => 'revision',
-                       'fields' => array('rev_id', 'rev_page', 'rev_text_id', 'rev_user', 'rev_comment', 'rev_user_text',
-                               'rev_timestamp', 'rev_minor_edit', 'rev_deleted'),
+                       'fields' => Revision::selectFields(),
                        'conds' => array('rev_page' => $this->mPageHistory->mTitle->getArticleID() ),
                        'options' => array( 'USE INDEX' => 'page_timestamp' )
                );
@@ -547,5 +626,3 @@ class PageHistoryPager extends ReverseChronologicalPager {
                return $s;
        }
 }
-
-?>