Split off index paging code from PageHistory.php to a new abstract class hierarchy in Pager.php. Application to Special:Ipblocklist will follow.
This commit is contained in:
Tim Starling
parent
2356185060
commit
20949b0961
3 changed files with 478 additions and 232 deletions
|
|
@ -113,6 +113,8 @@ function __autoload($className) {
|
||||||
'FakeMemCachedClient' => 'includes/ObjectCache.php',
|
'FakeMemCachedClient' => 'includes/ObjectCache.php',
|
||||||
'OutputPage' => 'includes/OutputPage.php',
|
'OutputPage' => 'includes/OutputPage.php',
|
||||||
'PageHistory' => 'includes/PageHistory.php',
|
'PageHistory' => 'includes/PageHistory.php',
|
||||||
|
'IndexPager' => 'includes/Pager.php',
|
||||||
|
'ReverseChronologicalPager' => 'includes/Pager.php',
|
||||||
'Parser' => 'includes/Parser.php',
|
'Parser' => 'includes/Parser.php',
|
||||||
'ParserOutput' => 'includes/Parser.php',
|
'ParserOutput' => 'includes/Parser.php',
|
||||||
'ParserOptions' => 'includes/Parser.php',
|
'ParserOptions' => 'includes/Parser.php',
|
||||||
|
|
|
||||||
|
|
@ -40,8 +40,6 @@ class PageHistory {
|
||||||
$this->mTitle =& $article->mTitle;
|
$this->mTitle =& $article->mTitle;
|
||||||
$this->mNotificationTimestamp = NULL;
|
$this->mNotificationTimestamp = NULL;
|
||||||
$this->mSkin = $wgUser->getSkin();
|
$this->mSkin = $wgUser->getSkin();
|
||||||
|
|
||||||
$this->defaultLimit = 50;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -93,99 +91,29 @@ class PageHistory {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
$dbr =& wfGetDB(DB_SLAVE);
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Extract limit, the number of revisions to show, and
|
* "go=first" means to jump to the last (earliest) history page.
|
||||||
* offset, the timestamp to begin at, from the URL.
|
* This is deprecated, it no longer appears in the user interface
|
||||||
*/
|
*/
|
||||||
$limit = $wgRequest->getInt('limit', $this->defaultLimit);
|
if ( $wgRequest->getText("go") == 'first' ) {
|
||||||
if ( $limit <= 0 ) {
|
$limit = $wgRequest->getInt( 'limit', 50 );
|
||||||
$limit = $this->defaultLimit;
|
$wgOut->redirect( $wgTitle->getLocalURL( "action=history&limit={$limit}&dir=prev" ) );
|
||||||
} elseif ( $limit > 50000 ) {
|
|
||||||
# Arbitrary maximum
|
|
||||||
# Any more than this and we'll probably get an out of memory error
|
|
||||||
$limit = 50000;
|
|
||||||
}
|
|
||||||
|
|
||||||
$offset = $wgRequest->getText('offset');
|
|
||||||
|
|
||||||
/* Offset must be an integral. */
|
|
||||||
if (!strlen($offset) || !preg_match("/^[0-9]+$/", $offset))
|
|
||||||
$offset = 0;
|
|
||||||
# $offset = $dbr->timestamp($offset);
|
|
||||||
$dboffset = $offset === 0 ? 0 : $dbr->timestamp($offset);
|
|
||||||
/*
|
|
||||||
* "go=last" means to jump to the last history page.
|
|
||||||
*/
|
|
||||||
if (($gowhere = $wgRequest->getText("go")) !== NULL) {
|
|
||||||
$gourl = null;
|
|
||||||
switch ($gowhere) {
|
|
||||||
case "first":
|
|
||||||
if (($lastid = $this->getLastOffsetForPaging($this->mTitle->getArticleID(), $limit)) === NULL)
|
|
||||||
break;
|
|
||||||
$gourl = $wgTitle->getLocalURL("action=history&limit={$limit}&offset=".
|
|
||||||
wfTimestamp(TS_MW, $lastid));
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!is_null($gourl)) {
|
|
||||||
$wgOut->redirect($gourl);
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* Fetch revisions.
|
* Do the list
|
||||||
*
|
|
||||||
* If the user clicked "previous", we retrieve the revisions backwards,
|
|
||||||
* then reverse them. This is to avoid needing to know the timestamp of
|
|
||||||
* previous revisions when generating the URL.
|
|
||||||
*/
|
*/
|
||||||
$direction = $this->getDirection();
|
$pager = new PageHistoryPager( $this );
|
||||||
$revisions = $this->fetchRevisions($limit, $dboffset, $direction);
|
$navbar = $pager->getNavigationBar();
|
||||||
$navbar = $this->makeNavbar($revisions, $offset, $limit, $direction);
|
$wgOut->addHTML(
|
||||||
|
$pager->getNavigationBar() .
|
||||||
/*
|
$this->beginHistoryList() .
|
||||||
* We fetch one more revision than needed to get the timestamp of the
|
$pager->getBody() .
|
||||||
* one after this page (and to know if it exists).
|
$pager->getNavigationBar() .
|
||||||
*
|
$this->endHistoryList()
|
||||||
* linesonpage stores the actual number of lines.
|
);
|
||||||
*/
|
|
||||||
if (count($revisions) < $limit + 1)
|
|
||||||
$this->linesonpage = count($revisions);
|
|
||||||
else
|
|
||||||
$this->linesonpage = count($revisions) - 1;
|
|
||||||
|
|
||||||
/* Un-reverse revisions */
|
|
||||||
if ($direction == PageHistory::DIR_PREV)
|
|
||||||
$revisions = array_reverse($revisions);
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Print the top navbar.
|
|
||||||
*/
|
|
||||||
$s = $navbar;
|
|
||||||
$s .= $this->beginHistoryList();
|
|
||||||
$counter = 1;
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Print each revision, excluding the one-past-the-end, if any.
|
|
||||||
*/
|
|
||||||
foreach (array_slice($revisions, 0, $limit) as $i => $line) {
|
|
||||||
$latest = !$i && $offset == 0;
|
|
||||||
$firstInList = !$i;
|
|
||||||
$next = isset( $revisions[$i + 1] ) ? $revisions[$i + 1 ] : null;
|
|
||||||
$s .= $this->historyLine($line, $next, $counter, $this->getNotificationTimestamp(), $latest, $firstInList);
|
|
||||||
$counter++;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
* End navbar.
|
|
||||||
*/
|
|
||||||
$s .= $this->endHistoryList();
|
|
||||||
$s .= $navbar;
|
|
||||||
|
|
||||||
$wgOut->addHTML( $s );
|
|
||||||
wfProfileOut( $fname );
|
wfProfileOut( $fname );
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -319,15 +247,14 @@ class PageHistory {
|
||||||
function lastLink( $rev, $next, $counter ) {
|
function lastLink( $rev, $next, $counter ) {
|
||||||
$last = wfMsgExt( 'last', array( 'escape' ) );
|
$last = wfMsgExt( 'last', array( 'escape' ) );
|
||||||
if ( is_null( $next ) ) {
|
if ( is_null( $next ) ) {
|
||||||
if( $rev->getTimestamp() == $this->getEarliestOffset() ) {
|
# Probably no next row
|
||||||
return $last;
|
return $last;
|
||||||
} else {
|
} elseif ( $next === 'unknown' ) {
|
||||||
// Cut off by paging; there are more behind us...
|
# Next row probably exists but is unknown, use an oldid=prev link
|
||||||
return $this->mSkin->makeKnownLinkObj(
|
return $this->mSkin->makeKnownLinkObj(
|
||||||
$this->mTitle,
|
$this->mTitle,
|
||||||
$last,
|
$last,
|
||||||
"diff=" . $rev->getId() . "&oldid=prev" );
|
"diff=" . $rev->getId() . "&oldid=prev" );
|
||||||
}
|
|
||||||
} elseif( !$rev->userCan( Revision::DELETED_TEXT ) ) {
|
} elseif( !$rev->userCan( Revision::DELETED_TEXT ) ) {
|
||||||
return $last;
|
return $last;
|
||||||
} else {
|
} else {
|
||||||
|
|
@ -386,73 +313,24 @@ class PageHistory {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @todo document */
|
|
||||||
function getLatestOffset( $id = null ) {
|
|
||||||
if ( $id === null) $id = $this->mTitle->getArticleID();
|
|
||||||
return $this->getExtremeOffset( $id, 'max' );
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @todo document */
|
|
||||||
function getEarliestOffset( $id = null ) {
|
|
||||||
if ( $id === null) $id = $this->mTitle->getArticleID();
|
|
||||||
return $this->getExtremeOffset( $id, 'min' );
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @todo document */
|
|
||||||
function getExtremeOffset( $id, $func ) {
|
|
||||||
$db =& wfGetDB(DB_SLAVE);
|
|
||||||
return $db->selectField( 'revision',
|
|
||||||
"$func(rev_timestamp)",
|
|
||||||
array( 'rev_page' => $id ),
|
|
||||||
'PageHistory::getExtremeOffset' );
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @todo document */
|
/** @todo document */
|
||||||
function getLatestId() {
|
function getLatestId() {
|
||||||
if( is_null( $this->mLatestId ) ) {
|
if( is_null( $this->mLatestId ) ) {
|
||||||
$id = $this->mTitle->getArticleID();
|
$id = $this->mTitle->getArticleID();
|
||||||
$db =& wfGetDB(DB_SLAVE);
|
$db =& wfGetDB(DB_SLAVE);
|
||||||
$this->mLatestId = $db->selectField( 'revision',
|
$this->mLatestId = $db->selectField( 'page',
|
||||||
"max(rev_id)",
|
"page_latest",
|
||||||
array( 'rev_page' => $id ),
|
array( 'page_id' => $id ),
|
||||||
'PageHistory::getLatestID' );
|
'PageHistory::getLatestID' );
|
||||||
}
|
}
|
||||||
return $this->mLatestId;
|
return $this->mLatestId;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @todo document */
|
|
||||||
function getLastOffsetForPaging( $id, $step ) {
|
|
||||||
$fname = 'PageHistory::getLastOffsetForPaging';
|
|
||||||
|
|
||||||
$dbr =& wfGetDB(DB_SLAVE);
|
|
||||||
$res = $dbr->select(
|
|
||||||
'revision',
|
|
||||||
'rev_timestamp',
|
|
||||||
"rev_page=$id",
|
|
||||||
$fname,
|
|
||||||
array('ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => $step));
|
|
||||||
|
|
||||||
$n = $dbr->numRows( $res );
|
|
||||||
$last = null;
|
|
||||||
while( $obj = $dbr->fetchObject( $res ) ) {
|
|
||||||
$last = $obj->rev_timestamp;
|
|
||||||
}
|
|
||||||
$dbr->freeResult( $res );
|
|
||||||
return $last;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return returns the direction of browsing watchlist
|
* Fetch an array of revisions, specified by a given limit, offset and
|
||||||
|
* direction. This is now only used by the feeds. It was previously
|
||||||
|
* used by the main UI but that's now handled by the pager.
|
||||||
*/
|
*/
|
||||||
function getDirection() {
|
|
||||||
global $wgRequest;
|
|
||||||
if ($wgRequest->getText("dir") == "prev")
|
|
||||||
return PageHistory::DIR_PREV;
|
|
||||||
else
|
|
||||||
return PageHistory::DIR_NEXT;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @todo document */
|
|
||||||
function fetchRevisions($limit, $offset, $direction) {
|
function fetchRevisions($limit, $offset, $direction) {
|
||||||
$fname = 'PageHistory::fetchRevisions';
|
$fname = 'PageHistory::fetchRevisions';
|
||||||
|
|
||||||
|
|
@ -517,83 +395,6 @@ class PageHistory {
|
||||||
return $this->mNotificationTimestamp;
|
return $this->mNotificationTimestamp;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @todo document */
|
|
||||||
function makeNavbar($revisions, $offset, $limit, $direction) {
|
|
||||||
global $wgLang;
|
|
||||||
|
|
||||||
$revisions = array_slice($revisions, 0, $limit);
|
|
||||||
|
|
||||||
$latestTimestamp = wfTimestamp(TS_MW, $this->getLatestOffset());
|
|
||||||
$earliestTimestamp = wfTimestamp(TS_MW, $this->getEarliestOffset());
|
|
||||||
|
|
||||||
/*
|
|
||||||
* When we're displaying previous revisions, we need to reverse
|
|
||||||
* the array, because it's queried in reverse order.
|
|
||||||
*/
|
|
||||||
if ($direction == PageHistory::DIR_PREV)
|
|
||||||
$revisions = array_reverse($revisions);
|
|
||||||
|
|
||||||
/*
|
|
||||||
* lowts is the timestamp of the first revision on this page.
|
|
||||||
* hights is the timestamp of the last revision.
|
|
||||||
*/
|
|
||||||
|
|
||||||
$lowts = $hights = 0;
|
|
||||||
|
|
||||||
if( count( $revisions ) ) {
|
|
||||||
$latestShown = wfTimestamp(TS_MW, $revisions[0]->rev_timestamp);
|
|
||||||
$earliestShown = wfTimestamp(TS_MW, $revisions[count($revisions) - 1]->rev_timestamp);
|
|
||||||
} else {
|
|
||||||
$latestShown = null;
|
|
||||||
$earliestShown = null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Don't announce the limit everywhere if it's the default */
|
|
||||||
$usefulLimit = $limit == $this->defaultLimit ? '' : $limit;
|
|
||||||
|
|
||||||
$urls = array();
|
|
||||||
foreach (array(20, 50, 100, 250, 500) as $num) {
|
|
||||||
$urls[] = $this->MakeLink( $wgLang->formatNum($num),
|
|
||||||
array('offset' => $offset == 0 ? '' : wfTimestamp(TS_MW, $offset), 'limit' => $num, ) );
|
|
||||||
}
|
|
||||||
|
|
||||||
$bits = implode($urls, ' | ');
|
|
||||||
|
|
||||||
wfDebug("latestShown=$latestShown latestTimestamp=$latestTimestamp\n");
|
|
||||||
if( $latestShown < $latestTimestamp ) {
|
|
||||||
$prevtext = $this->MakeLink( wfMsgHtml("prevn", $limit),
|
|
||||||
array( 'dir' => 'prev', 'offset' => $latestShown, 'limit' => $usefulLimit ) );
|
|
||||||
$lasttext = $this->MakeLink( wfMsgHtml('histlast'),
|
|
||||||
array( 'limit' => $usefulLimit ) );
|
|
||||||
} else {
|
|
||||||
$prevtext = wfMsgHtml("prevn", $limit);
|
|
||||||
$lasttext = wfMsgHtml('histlast');
|
|
||||||
}
|
|
||||||
|
|
||||||
wfDebug("earliestShown=$earliestShown earliestTimestamp=$earliestTimestamp\n");
|
|
||||||
if( $earliestShown > $earliestTimestamp ) {
|
|
||||||
$nexttext = $this->MakeLink( wfMsgHtml("nextn", $limit),
|
|
||||||
array( 'offset' => $earliestShown, 'limit' => $usefulLimit ) );
|
|
||||||
$firsttext = $this->MakeLink( wfMsgHtml('histfirst'),
|
|
||||||
array( 'go' => 'first', 'limit' => $usefulLimit ) );
|
|
||||||
} else {
|
|
||||||
$nexttext = wfMsgHtml("nextn", $limit);
|
|
||||||
$firsttext = wfMsgHtml('histfirst');
|
|
||||||
}
|
|
||||||
|
|
||||||
$firstlast = "($lasttext | $firsttext)";
|
|
||||||
|
|
||||||
return "$firstlast " . wfMsgHtml("viewprevnext", $prevtext, $nexttext, $bits);
|
|
||||||
}
|
|
||||||
|
|
||||||
function MakeLink($text, $query = NULL) {
|
|
||||||
if ( $query === null ) return $text;
|
|
||||||
return $this->mSkin->makeKnownLinkObj(
|
|
||||||
$this->mTitle, $text,
|
|
||||||
wfArrayToCGI( $query, array( 'action' => 'history' )));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Output a subscription feed listing recent edits to this page.
|
* Output a subscription feed listing recent edits to this page.
|
||||||
* @param string $type
|
* @param string $type
|
||||||
|
|
@ -678,8 +479,73 @@ class PageHistory {
|
||||||
function stripComment( $text ) {
|
function stripComment( $text ) {
|
||||||
return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
|
return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class PageHistoryPager extends ReverseChronologicalPager {
|
||||||
|
public $mLastRow = false, $mPageHistory;
|
||||||
|
|
||||||
|
function __construct( $pageHistory ) {
|
||||||
|
parent::__construct();
|
||||||
|
$this->mPageHistory = $pageHistory;
|
||||||
|
}
|
||||||
|
|
||||||
|
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'),
|
||||||
|
'conds' => array('rev_page' => $this->mPageHistory->mTitle->getArticleID() ),
|
||||||
|
'options' => array( 'USE INDEX' => 'page_timestamp' )
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getIndexField() {
|
||||||
|
return 'rev_timestamp';
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatRow( $row ) {
|
||||||
|
if ( $this->mLastRow ) {
|
||||||
|
$latest = $this->mCounter == 1 && $this->mOffset == '';
|
||||||
|
$firstInList = $this->mCounter == 1;
|
||||||
|
$s = $this->mPageHistory->historyLine( $this->mLastRow, $row, $this->mCounter++,
|
||||||
|
$this->mPageHistory->getNotificationTimestamp(), $latest, $firstInList );
|
||||||
|
} else {
|
||||||
|
$s = '';
|
||||||
|
}
|
||||||
|
$this->mLastRow = $row;
|
||||||
|
return $s;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getStartBody() {
|
||||||
|
$this->mLastRow = false;
|
||||||
|
$this->mCounter = 1;
|
||||||
|
$this->mPageHistory->linesonpage = $this->getNumRows();
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
function getEndBody() {
|
||||||
|
if ( $this->mLastRow ) {
|
||||||
|
$latest = $this->mCounter == 1 && $this->mOffset == 0;
|
||||||
|
$firstInList = $this->mCounter == 1;
|
||||||
|
if ( $this->mIsBackwards ) {
|
||||||
|
# Next row is unknown, but for UI reasons, probably exists if an offset has been specified
|
||||||
|
if ( $this->mOffset == '' ) {
|
||||||
|
$next = null;
|
||||||
|
} else {
|
||||||
|
$next = 'unknown';
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
# The next row is the past-the-end row
|
||||||
|
$next = $this->mPastTheEndRow;
|
||||||
|
}
|
||||||
|
$s = $this->mPageHistory->historyLine( $this->mLastRow, $next, $this->mCounter++,
|
||||||
|
$this->mPageHistory->getNotificationTimestamp(), $latest, $firstInList );
|
||||||
|
} else {
|
||||||
|
$s = '';
|
||||||
|
}
|
||||||
|
return $s;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
?>
|
?>
|
||||||
|
|
|
||||||
378
includes/Pager.php
Normal file
378
includes/Pager.php
Normal file
|
|
@ -0,0 +1,378 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Basic pager interface.
|
||||||
|
*/
|
||||||
|
interface Pager {
|
||||||
|
function getNavigationBar();
|
||||||
|
function getBody();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* IndexPager is an efficient pager which uses a (roughly unique) index in the
|
||||||
|
* data set to implement paging, rather than a "LIMIT offset,limit" clause.
|
||||||
|
* In MySQL, such a limit/offset clause requires counting through the specified number
|
||||||
|
* of offset rows to find the desired data, which can be expensive for large offsets.
|
||||||
|
*
|
||||||
|
* ReverseChronologicalPager is a child class of the abstract IndexPager, and contains
|
||||||
|
* some formatting and display code which is specific to the use of timestamps as
|
||||||
|
* indexes. It is currently the only such child class. Here is a synopsis of the operation
|
||||||
|
* of IndexPager and its primary subclass:
|
||||||
|
*
|
||||||
|
* * The query is specified by the offset, limit and direction (dir) parameters, in
|
||||||
|
* addition to any subclass-specific parameters.
|
||||||
|
*
|
||||||
|
* * The offset is the non-inclusive start of the DB query. A row with an index value
|
||||||
|
* equal to the offset will never be shown.
|
||||||
|
*
|
||||||
|
* * The query may either be done backwards, where the rows are returned by the database
|
||||||
|
* in the opposite order to which they are displayed to the user, or forwards. This is
|
||||||
|
* specified by the "dir" parameter, dir=prev means backwards, anything else means
|
||||||
|
* forwards. The offset value specifies the start of the database result set, which
|
||||||
|
* may be either the start or end of the displayed data set. This allows "previous"
|
||||||
|
* links to be implemented without knowledge of the index value at the start of the
|
||||||
|
* previous page.
|
||||||
|
*
|
||||||
|
* * An additional row beyond the user-specified limit is always requested. This allows
|
||||||
|
* us to tell whether we should display a "next" link in the case of forwards mode,
|
||||||
|
* or a "previous" link in the case of backwards mode. Determining whether to
|
||||||
|
* display the other link (the one for the page before the start of the database
|
||||||
|
* result set) can be done heuristically by examining the offset.
|
||||||
|
*
|
||||||
|
* * An empty offset indicates that the offset condition should be omitted from the query.
|
||||||
|
* This naturally produces either the first page or the last page depending on the
|
||||||
|
* dir parameter.
|
||||||
|
*
|
||||||
|
* Subclassing the pager to implement concrete functionality should be fairly simple,
|
||||||
|
* please see the examples in PageHistory.php and SpecialIpblocklist.php. You just need
|
||||||
|
* to override formatRow(), getQueryInfo() and getIndexField(). Don't forget to call the
|
||||||
|
* parent constructor if you override it.
|
||||||
|
*/
|
||||||
|
abstract class IndexPager implements Pager {
|
||||||
|
public $mRequest;
|
||||||
|
public $mLimitsShown = array( 20, 50, 100, 250, 500 );
|
||||||
|
public $mDefaultLimit = 50;
|
||||||
|
public $mOffset, $mLimit;
|
||||||
|
public $mQueryDone = false;
|
||||||
|
public $mDb;
|
||||||
|
public $mPastTheEndRow;
|
||||||
|
|
||||||
|
protected $mIndexField;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Default query direction. false for ascending, true for descending
|
||||||
|
*/
|
||||||
|
public $mDefaultDirection = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Result object for the query. Warning: seek before use.
|
||||||
|
*/
|
||||||
|
public $mResult;
|
||||||
|
|
||||||
|
function __construct() {
|
||||||
|
global $wgRequest;
|
||||||
|
$this->mRequest = $wgRequest;
|
||||||
|
|
||||||
|
# NB: the offset is quoted, not validated. It is treated as an arbitrary string
|
||||||
|
# to support the widest variety of index types. Be careful outputting it into
|
||||||
|
# HTML!
|
||||||
|
$this->mOffset = $this->mRequest->getText( 'offset' );
|
||||||
|
$this->mLimit = $this->mRequest->getInt( 'limit', $this->mDefaultLimit );
|
||||||
|
if ( $this->mLimit <= 0 ) {
|
||||||
|
$this->mLimit = $this->mDefaultLimit;
|
||||||
|
}
|
||||||
|
$this->mIsBackwards = ( $this->mRequest->getVal( 'dir' ) == 'prev' );
|
||||||
|
$this->mIndexField = $this->getIndexField();
|
||||||
|
$this->mDb = wfGetDB( DB_SLAVE );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Do the query, using information from the object context. This function
|
||||||
|
* has been kept minimal to make it overridable if necessary, to allow for
|
||||||
|
* result sets formed from multiple DB queries.
|
||||||
|
*/
|
||||||
|
function doQuery() {
|
||||||
|
# Use the child class name for profiling
|
||||||
|
$fname = __METHOD__ . ' (' . get_class( $this ) . ')';
|
||||||
|
wfProfileIn( $fname );
|
||||||
|
|
||||||
|
$descending = ( $this->mIsBackwards == $this->mDefaultDirection );
|
||||||
|
# Plus an extra row so that we can tell the "next" link should be shown
|
||||||
|
$queryLimit = $this->mLimit + 1;
|
||||||
|
|
||||||
|
$this->mResult = $this->reallyDoQuery( $this->mOffset, $queryLimit, $descending );
|
||||||
|
$this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult );
|
||||||
|
$this->mQueryDone = true;
|
||||||
|
|
||||||
|
wfProfileOut( $fname );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extract some useful data from the result object for use by
|
||||||
|
* the navigation bar, put it into $this
|
||||||
|
*/
|
||||||
|
function extractResultInfo( $offset, $limit, ResultWrapper $res ) {
|
||||||
|
$numRows = $res->numRows();
|
||||||
|
if ( $numRows ) {
|
||||||
|
$row = $res->fetchRow();
|
||||||
|
$firstIndex = $row[$this->mIndexField];
|
||||||
|
|
||||||
|
# Discard the extra result row if there is one
|
||||||
|
if ( $numRows > $this->mLimit && $numRows > 1 ) {
|
||||||
|
$res->seek( $numRows - 1 );
|
||||||
|
$this->mPastTheEndRow = $res->fetchObject();
|
||||||
|
$indexField = $this->mIndexField;
|
||||||
|
$this->mPastTheEndIndex = $this->mPastTheEndRow->$indexField;
|
||||||
|
$res->seek( $numRows - 2 );
|
||||||
|
$row = $res->fetchRow();
|
||||||
|
$lastIndex = $row[$this->mIndexField];
|
||||||
|
} else {
|
||||||
|
$this->mPastTheEndRow = null;
|
||||||
|
# Setting indexes to an empty string means that they will be omitted
|
||||||
|
# if they would otherwise appear in URLs. It just so happens that this
|
||||||
|
# is the right thing to do in the standard UI, in all the relevant cases.
|
||||||
|
$this->mPastTheEndIndex = '';
|
||||||
|
$res->seek( $numRows - 1 );
|
||||||
|
$row = $res->fetchRow();
|
||||||
|
$lastIndex = $row[$this->mIndexField];
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$firstIndex = '';
|
||||||
|
$lastIndex = '';
|
||||||
|
$this->mPastTheEndRow = null;
|
||||||
|
$this->mPastTheEndIndex = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( $this->mIsBackwards ) {
|
||||||
|
$this->mIsFirst = ( $numRows < $limit );
|
||||||
|
$this->mIsLast = ( $offset == '' );
|
||||||
|
$this->mLastShown = $firstIndex;
|
||||||
|
$this->mFirstShown = $lastIndex;
|
||||||
|
} else {
|
||||||
|
$this->mIsFirst = ( $offset == '' );
|
||||||
|
$this->mIsLast = ( $numRows < $limit );
|
||||||
|
$this->mLastShown = $lastIndex;
|
||||||
|
$this->mFirstShown = $firstIndex;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Do a query with specified parameters, rather than using the object context
|
||||||
|
*
|
||||||
|
* @param string $offset Index offset, inclusive
|
||||||
|
* @param integer $limit Exact query limit
|
||||||
|
* @param boolean $descending Query direction, false for ascending, true for descending
|
||||||
|
* @return ResultWrapper
|
||||||
|
*/
|
||||||
|
function reallyDoQuery( $offset, $limit, $ascending ) {
|
||||||
|
$fname = __METHOD__ . ' (' . get_class( $this ) . ')';
|
||||||
|
$info = $this->getQueryInfo();
|
||||||
|
$tables = $info['tables'];
|
||||||
|
$fields = $info['fields'];
|
||||||
|
$conds = isset( $info['conds'] ) ? $info['conds'] : array();
|
||||||
|
$options = isset( $info['options'] ) ? $info['options'] : array();
|
||||||
|
if ( $ascending ) {
|
||||||
|
$options['ORDER BY'] = $this->mIndexField;
|
||||||
|
$operator = '>';
|
||||||
|
} else {
|
||||||
|
$options['ORDER BY'] = $this->mIndexField . ' DESC';
|
||||||
|
$operator = '<';
|
||||||
|
}
|
||||||
|
if ( $offset != '' ) {
|
||||||
|
$conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset );
|
||||||
|
}
|
||||||
|
$options['LIMIT'] = intval( $limit );
|
||||||
|
$res = $this->mDb->select( $tables, $fields, $conds, $fname, $options );
|
||||||
|
return new ResultWrapper( $this->mDb, $res );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the formatted result list. Calls getStartBody(), formatRow() and
|
||||||
|
* getEndBody(), concatenates the results and returns them.
|
||||||
|
*/
|
||||||
|
function getBody() {
|
||||||
|
if ( !$this->mQueryDone ) {
|
||||||
|
$this->doQuery();
|
||||||
|
}
|
||||||
|
# Don't use any extra rows returned by the query
|
||||||
|
$numRows = min( $this->mResult->numRows(), $this->mLimit );
|
||||||
|
|
||||||
|
$s = $this->getStartBody();
|
||||||
|
if ( $numRows ) {
|
||||||
|
if ( $this->mIsBackwards ) {
|
||||||
|
for ( $i = $numRows - 1; $i >= 0; $i-- ) {
|
||||||
|
$this->mResult->seek( $i );
|
||||||
|
$row = $this->mResult->fetchObject();
|
||||||
|
$s .= $this->formatRow( $row );
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$this->mResult->seek( 0 );
|
||||||
|
for ( $i = 0; $i < $numRows; $i++ ) {
|
||||||
|
$row = $this->mResult->fetchObject();
|
||||||
|
$s .= $this->formatRow( $row );
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$s .= $this->getEndBody();
|
||||||
|
return $s;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make a self-link
|
||||||
|
*/
|
||||||
|
function makeLink($text, $query = NULL) {
|
||||||
|
if ( $query === null ) {
|
||||||
|
return $text;
|
||||||
|
} else {
|
||||||
|
return $this->getSkin()->makeKnownLinkObj( $this->getTitle(), $text,
|
||||||
|
wfArrayToCGI( $query, $this->getDefaultQuery() ) );
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hook into getBody(), allows text to be inserted at the start. This
|
||||||
|
* will be called even if there are no rows in the result set.
|
||||||
|
*/
|
||||||
|
function getStartBody() {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hook into getBody() for the end of the list
|
||||||
|
*/
|
||||||
|
function getEndBody() {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Title used for self-links. Override this if you want to be able to
|
||||||
|
* use a title other than $wgTitle
|
||||||
|
*/
|
||||||
|
function getTitle() {
|
||||||
|
return $GLOBALS['wgTitle'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the current skin. This can be overridden if necessary.
|
||||||
|
*/
|
||||||
|
function getSkin() {
|
||||||
|
if ( !isset( $this->mSkin ) ) {
|
||||||
|
global $wgUser;
|
||||||
|
$this->mSkin = $wgUser->getSkin();
|
||||||
|
}
|
||||||
|
return $this->mSkin;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get an array of query parameters that should be put into self-links.
|
||||||
|
* By default, all parameters passed in the URL are used, except for a
|
||||||
|
* short blacklist.
|
||||||
|
*/
|
||||||
|
function getDefaultQuery() {
|
||||||
|
if ( !isset( $this->mDefaultQuery ) ) {
|
||||||
|
$this->mDefaultQuery = $_GET;
|
||||||
|
unset( $this->mDefaultQuery['title'] );
|
||||||
|
unset( $this->mDefaultQuery['dir'] );
|
||||||
|
unset( $this->mDefaultQuery['offset'] );
|
||||||
|
unset( $this->mDefaultQuery['limit'] );
|
||||||
|
}
|
||||||
|
return $this->mDefaultQuery;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the number of rows in the result set
|
||||||
|
*/
|
||||||
|
function getNumRows() {
|
||||||
|
if ( !$this->mQueryDone ) {
|
||||||
|
$this->doQuery();
|
||||||
|
}
|
||||||
|
return $this->mResult->numRows();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Abstract formatting function. This should return an HTML string
|
||||||
|
* representing the result row $row. Rows will be concatenated and
|
||||||
|
* returned by getBody()
|
||||||
|
*/
|
||||||
|
abstract function formatRow( $row );
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function should be overridden to provide all parameters
|
||||||
|
* needed for the main paged query. It returns an associative
|
||||||
|
* array with the following elements:
|
||||||
|
* tables => Table(s) for passing to Database::select()
|
||||||
|
* fields => Field(s) for passing to Database::select(), may be *
|
||||||
|
* conds => WHERE conditions
|
||||||
|
* options => option array
|
||||||
|
*/
|
||||||
|
abstract function getQueryInfo();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function should be overridden to return the name of the
|
||||||
|
* index field.
|
||||||
|
*/
|
||||||
|
abstract function getIndexField();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* IndexPager with a formatted navigation bar
|
||||||
|
*/
|
||||||
|
abstract class ReverseChronologicalPager extends IndexPager {
|
||||||
|
public $mDefaultDirection = true;
|
||||||
|
|
||||||
|
function __construct() {
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
function getNavigationBar() {
|
||||||
|
global $wgLang;
|
||||||
|
|
||||||
|
if ( isset( $this->mNavigationBar ) ) {
|
||||||
|
return $this->mNavigationBar;
|
||||||
|
}
|
||||||
|
if ( !$this->mQueryDone ) {
|
||||||
|
$this->doQuery();
|
||||||
|
}
|
||||||
|
|
||||||
|
# Don't announce the limit everywhere if it's the default
|
||||||
|
$urlLimit = $this->mLimit == $this->mDefaultLimit ? '' : $this->mLimit;
|
||||||
|
|
||||||
|
if ( $this->mIsFirst ) {
|
||||||
|
$prevText = wfMsgHtml("prevn", $this->mLimit);
|
||||||
|
$latestText = wfMsgHtml('histlast');
|
||||||
|
} else {
|
||||||
|
$prevText = $this->makeLink( wfMsgHtml("prevn", $this->mLimit),
|
||||||
|
array( 'dir' => 'prev', 'offset' => $this->mFirstShown, 'limit' => $urlLimit ) );
|
||||||
|
$latestText = $this->makeLink( wfMsgHtml('histlast'),
|
||||||
|
array( 'limit' => $urlLimit ) );
|
||||||
|
}
|
||||||
|
if ( $this->mIsLast ) {
|
||||||
|
$nextText = wfMsgHtml( 'nextn', $this->mLimit);
|
||||||
|
$earliestText = wfMsgHtml( 'histfirst' );
|
||||||
|
} else {
|
||||||
|
$nextText = $this->makeLink( wfMsgHtml( 'nextn', $this->mLimit ),
|
||||||
|
array( 'offset' => $this->mLastShown, 'limit' => $urlLimit ) );
|
||||||
|
$earliestText = $this->makeLink( wfMsgHtml( 'histfirst' ),
|
||||||
|
array( 'dir' => 'prev', 'limit' => $urlLimit ) );
|
||||||
|
}
|
||||||
|
$limits = '';
|
||||||
|
foreach ( $this->mLimitsShown as $limit ) {
|
||||||
|
if ( $limits !== '' ) {
|
||||||
|
$limits .= ' | ';
|
||||||
|
}
|
||||||
|
if ( $this->mIsBackwards ) {
|
||||||
|
$offset = $this->mPastTheEndIndex;
|
||||||
|
} else {
|
||||||
|
$offset = $this->mOffset;
|
||||||
|
}
|
||||||
|
$limits .= $this->makeLink( $wgLang->formatNum($limit),
|
||||||
|
array('offset' => $offset, 'limit' => $limit ) );
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->mNavigationBar = "($latestText | $earliestText) " . wfMsgHtml("viewprevnext", $prevText, $nextText, $limits);
|
||||||
|
return $this->mNavigationBar;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
?>
|
||||||
Loading…
Reference in a new issue