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' );
# Use consistent behavior for the limit options
$this->mDefaultLimit = intval( $wgUser->getOption( 'rclimit' ) );
list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset();
$this->mIsBackwards = ( $this->mRequest->getVal( 'dir' ) == 'prev' );
$this->mDb = wfGetDB( DB_SLAVE );
$index = $this->getIndexField();
$order = $this->mRequest->getVal( 'order' );
if( is_array( $index ) && isset( $index[$order] ) ) {
$this->mOrderType = $order;
$this->mIndexField = $index[$order];
} elseif( is_array( $index ) ) {
# First element is the default
reset( $index );
list( $this->mOrderType, $this->mIndexField ) = each( $index );
} else {
# $index is not an array
$this->mOrderType = null;
$this->mIndexField = $index;
}
if( !isset( $this->mDefaultDirection ) ) {
$dir = $this->getDefaultDirections();
$this->mDefaultDirection = is_array( $dir )
? $dir[$this->mOrderType]
: $dir;
}
}
/**
* 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;
$this->preprocessResults( $this->mResult );
$this->mResult->rewind(); // Paranoia
wfProfileOut( $fname );
}
/**
* @return ResultWrapper The result wrapper.
*/
function getResult() {
return $this->mResult;
}
/**
* Set the offset from an other source than $wgRequest
*/
function setOffset( $offset ) {
$this->mOffset = $offset;
}
/**
* Set the limit from an other source than $wgRequest
*/
function setLimit( $limit ) {
$this->mLimit = $limit;
}
/**
* Extract some useful data from the result object for use by
* the navigation bar, put it into $this
*
* @param $offset String: index offset, inclusive
* @param $limit Integer: exact query limit
* @param $res ResultWrapper
*/
function extractResultInfo( $offset, $limit, ResultWrapper $res ) {
$numRows = $res->numRows();
if ( $numRows ) {
# Remove any table prefix from index field
$parts = explode( '.', $this->mIndexField );
$indexColumn = end( $parts );
$row = $res->fetchRow();
$firstIndex = $row[$indexColumn];
# 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[$indexColumn];
} 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[$indexColumn];
}
} 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;
}
}
/**
* Get some text to go in brackets in the "function name" part of the SQL comment
*
* @return String
*/
function getSqlComment() {
return get_class( $this );
}
/**
* Do a query with specified parameters, rather than using the object
* context
*
* @param $offset String: index offset, inclusive
* @param $limit Integer: exact query limit
* @param $descending Boolean: query direction, false for ascending, true for descending
* @return ResultWrapper
*/
function reallyDoQuery( $offset, $limit, $descending ) {
$fname = __METHOD__ . ' (' . $this->getSqlComment() . ')';
$info = $this->getQueryInfo();
$tables = $info['tables'];
$fields = $info['fields'];
$conds = isset( $info['conds'] ) ? $info['conds'] : array();
$options = isset( $info['options'] ) ? $info['options'] : array();
$join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array();
if ( $descending ) {
$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, $join_conds );
return new ResultWrapper( $this->mDb, $res );
}
/**
* Pre-process results; useful for performing batch existence checks, etc.
*
* @param $result ResultWrapper
*/
protected function preprocessResults( $result ) {}
/**
* Get the formatted result list. Calls getStartBody(), formatRow() and
* getEndBody(), concatenates the results and returns them.
*
* @return String
*/
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 );
}
}
} else {
$s .= $this->getEmptyBody();
}
$s .= $this->getEndBody();
return $s;
}
/**
* Make a self-link
*
* @param $text String: text displayed on the link
* @param $query Array: associative array of paramter to be in the query string
* @param $type String: value of the "rel" attribute
* @return String: HTML fragment
*/
function makeLink($text, $query = null, $type=null) {
if ( $query === null ) {
return $text;
}
$attrs = array();
if( in_array( $type, array( 'first', 'prev', 'next', 'last' ) ) ) {
# HTML5 rel attributes
$attrs['rel'] = $type;
}
if( $type ) {
$attrs['class'] = "mw-{$type}link";
}
return $this->getSkin()->link(
$this->getTitle(),
$text,
$attrs,
$query + $this->getDefaultQuery(),
array( 'noclasses', 'known' )
);
}
/**
* 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.
*
* @return String
*/
function getStartBody() {
return '';
}
/**
* Hook into getBody() for the end of the list
*
* @return String
*/
function getEndBody() {
return '';
}
/**
* Hook into getBody(), for the bit between the start and the
* end when there are no rows
*
* @return String
*/
function getEmptyBody() {
return '';
}
/**
* Title used for self-links. Override this if you want to be able to
* use a title other than $wgTitle
*
* @return Title object
*/
function getTitle() {
return $GLOBALS['wgTitle'];
}
/**
* Get the current skin. This can be overridden if necessary.
*
* @return Skin object
*/
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.
*
* @return Associative array
*/
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'] );
unset( $this->mDefaultQuery['order'] );
unset( $this->mDefaultQuery['month'] );
unset( $this->mDefaultQuery['year'] );
}
return $this->mDefaultQuery;
}
/**
* Get the number of rows in the result set
*
* @return Integer
*/
function getNumRows() {
if ( !$this->mQueryDone ) {
$this->doQuery();
}
return $this->mResult->numRows();
}
/**
* Get a URL query array for the prev, next, first and last links.
*
* @return Array
*/
function getPagingQueries() {
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 ) {
$prev = false;
$first = false;
} else {
$prev = array(
'dir' => 'prev',
'offset' => $this->mFirstShown,
'limit' => $urlLimit
);
$first = array( 'limit' => $urlLimit );
}
if ( $this->mIsLast ) {
$next = false;
$last = false;
} else {
$next = array( 'offset' => $this->mLastShown, 'limit' => $urlLimit );
$last = array( 'dir' => 'prev', 'limit' => $urlLimit );
}
return array(
'prev' => $prev,
'next' => $next,
'first' => $first,
'last' => $last
);
}
/**
* Returns whether to show the "navigation bar"
*
* @return Boolean
*/
function isNavigationBarShown() {
if ( !$this->mQueryDone ) {
$this->doQuery();
}
// Hide navigation by default if there is nothing to page
return !($this->mIsFirst && $this->mIsLast);
}
/**
* Get paging links. If a link is disabled, the item from $disabledTexts
* will be used. If there is no such item, the unlinked text from
* $linkTexts will be used. Both $linkTexts and $disabledTexts are arrays
* of HTML.
*
* @return Array
*/
function getPagingLinks( $linkTexts, $disabledTexts = array() ) {
$queries = $this->getPagingQueries();
$links = array();
foreach ( $queries as $type => $query ) {
if ( $query !== false ) {
$links[$type] = $this->makeLink(
$linkTexts[$type],
$queries[$type],
$type
);
} elseif ( isset( $disabledTexts[$type] ) ) {
$links[$type] = $disabledTexts[$type];
} else {
$links[$type] = $linkTexts[$type];
}
}
return $links;
}
function getLimitLinks() {
global $wgLang;
$links = array();
if ( $this->mIsBackwards ) {
$offset = $this->mPastTheEndIndex;
} else {
$offset = $this->mOffset;
}
foreach ( $this->mLimitsShown as $limit ) {
$links[] = $this->makeLink(
$wgLang->formatNum( $limit ),
array( 'offset' => $offset, 'limit' => $limit ),
'num'
);
}
return $links;
}
/**
* Abstract formatting function. This should return an HTML string
* representing the result row $row. Rows will be concatenated and
* returned by getBody()
*
* @param $row Object: database row
* @return String
*/
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
* join_conds => JOIN conditions
*
* @return Array
*/
abstract function getQueryInfo();
/**
* This function should be overridden to return the name of the index fi-
* eld. If the pager supports multiple orders, it may return an array of
* 'querykey' => 'indexfield' pairs, so that a request with &count=querykey
* will use indexfield to sort. In this case, the first returned key is
* the default.
*
* Needless to say, it's really not a good idea to use a non-unique index
* for this! That won't page right.
*/
abstract function getIndexField();
/**
* Return the default sorting direction: false for ascending, true for de-
* scending. You can also have an associative array of ordertype => dir,
* if multiple order types are supported. In this case getIndexField()
* must return an array, and the keys of that must exactly match the keys
* of this.
*
* For backward compatibility, this method's return value will be ignored
* if $this->mDefaultDirection is already set when the constructor is
* called, for instance if it's statically initialized. In that case the
* value of that variable (which must be a boolean) will be used.
*
* Note that despite its name, this does not return the value of the
* $this->mDefaultDirection member variable. That's the default for this
* particular instantiation, which is a single value. This is the set of
* all defaults for the class.
*
* @return Boolean
*/
protected function getDefaultDirections() { return false; }
}
/**
* IndexPager with an alphabetic list and a formatted navigation bar
* @ingroup Pager
*/
abstract class AlphabeticPager extends IndexPager {
/**
* Shamelessly stolen bits from ReverseChronologicalPager,
* didn't want to do class magic as may be still revamped
*/
function getNavigationBar() {
global $wgLang;
if ( !$this->isNavigationBarShown() ) return '';
if( isset( $this->mNavigationBar ) ) {
return $this->mNavigationBar;
}
$opts = array( 'parsemag', 'escapenoentities' );
$linkTexts = array(
'prev' => wfMsgExt(
'prevn',
$opts,
$wgLang->formatNum( $this->mLimit )
),
'next' => wfMsgExt(
'nextn',
$opts,
$wgLang->formatNum($this->mLimit )
),
'first' => wfMsgExt( 'page_first', $opts ),
'last' => wfMsgExt( 'page_last', $opts )
);
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
$limits = $wgLang->pipeList( $limitLinks );
$this->mNavigationBar =
"(" . $wgLang->pipeList(
array( $pagingLinks['first'],
$pagingLinks['last'] )
) . ") " .
wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
$pagingLinks['next'], $limits );
if( !is_array( $this->getIndexField() ) ) {
# Early return to avoid undue nesting
return $this->mNavigationBar;
}
$extra = '';
$first = true;
$msgs = $this->getOrderTypeMessages();
foreach( array_keys( $msgs ) as $order ) {
if( $first ) {
$first = false;
} else {
$extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
}
if( $order == $this->mOrderType ) {
$extra .= wfMsgHTML( $msgs[$order] );
} else {
$extra .= $this->makeLink(
wfMsgHTML( $msgs[$order] ),
array( 'order' => $order )
);
}
}
if( $extra !== '' ) {
$this->mNavigationBar .= " ($extra)";
}
return $this->mNavigationBar;
}
/**
* If this supports multiple order type messages, give the message key for
* enabling each one in getNavigationBar. The return type is an associa-
* tive array whose keys must exactly match the keys of the array returned
* by getIndexField(), and whose values are message keys.
*
* @return Array
*/
protected function getOrderTypeMessages() {
return null;
}
}
/**
* IndexPager with a formatted navigation bar
* @ingroup Pager
*/
abstract class ReverseChronologicalPager extends IndexPager {
public $mDefaultDirection = true;
public $mYear;
public $mMonth;
function __construct() {
parent::__construct();
}
function getNavigationBar() {
global $wgLang;
if ( !$this->isNavigationBarShown() ) return '';
if ( isset( $this->mNavigationBar ) ) {
return $this->mNavigationBar;
}
$nicenumber = $wgLang->formatNum( $this->mLimit );
$linkTexts = array(
'prev' => wfMsgExt(
'pager-newer-n',
array( 'parsemag', 'escape' ),
$nicenumber
),
'next' => wfMsgExt(
'pager-older-n',
array( 'parsemag', 'escape' ),
$nicenumber
),
'first' => wfMsgHtml( 'histlast' ),
'last' => wfMsgHtml( 'histfirst' )
);
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
$limits = $wgLang->pipeList( $limitLinks );
$this->mNavigationBar = "({$pagingLinks['first']}" .
wfMsgExt( 'pipe-separator' , 'escapenoentities' ) .
"{$pagingLinks['last']}) " .
wfMsgHTML(
'viewprevnext',
$pagingLinks['prev'], $pagingLinks['next'],
$limits
);
return $this->mNavigationBar;
}
function getDateCond( $year, $month ) {
$year = intval($year);
$month = intval($month);
// Basic validity checks
$this->mYear = $year > 0 ? $year : false;
$this->mMonth = ($month > 0 && $month < 13) ? $month : false;
// Given an optional year and month, we need to generate a timestamp
// to use as "WHERE rev_timestamp <= result"
// Examples: year = 2006 equals < 20070101 (+000000)
// year=2005, month=1 equals < 20050201
// year=2005, month=12 equals < 20060101
if ( !$this->mYear && !$this->mMonth ) {
return;
}
if ( $this->mYear ) {
$year = $this->mYear;
} else {
// If no year given, assume the current one
$year = gmdate( 'Y' );
// If this month hasn't happened yet this year, go back to last year's month
if( $this->mMonth > gmdate( 'n' ) ) {
$year--;
}
}
if ( $this->mMonth ) {
$month = $this->mMonth + 1;
// For December, we want January 1 of the next year
if ($month > 12) {
$month = 1;
$year++;
}
} else {
// No month implies we want up to the end of the year in question
$month = 1;
$year++;
}
// Y2K38 bug
if ( $year > 2032 ) {
$year = 2032;
}
$ymd = (int)sprintf( "%04d%02d01", $year, $month );
if ( $ymd > 20320101 ) {
$ymd = 20320101;
}
$this->mOffset = $this->mDb->timestamp( "${ymd}000000" );
}
}
/**
* Table-based display with a user-selectable sort order
* @ingroup Pager
*/
abstract class TablePager extends IndexPager {
var $mSort;
var $mCurrentRow;
function __construct() {
global $wgRequest;
$this->mSort = $wgRequest->getText( 'sort' );
if ( !array_key_exists( $this->mSort, $this->getFieldNames() ) ) {
$this->mSort = $this->getDefaultSort();
}
if ( $wgRequest->getBool( 'asc' ) ) {
$this->mDefaultDirection = false;
} elseif ( $wgRequest->getBool( 'desc' ) ) {
$this->mDefaultDirection = true;
} /* Else leave it at whatever the class default is */
parent::__construct();
}
function getStartBody() {
global $wgStylePath;
$tableClass = htmlspecialchars( $this->getTableClass() );
$sortClass = htmlspecialchars( $this->getSortHeaderClass() );
$s = "
\n";
$fields = $this->getFieldNames();
# Make table header
foreach ( $fields as $field => $name ) {
if ( strval( $name ) == '' ) {
$s .= "
\n";
} elseif ( $this->isFieldSortable( $field ) ) {
$query = array( 'sort' => $field, 'limit' => $this->mLimit );
if ( $field == $this->mSort ) {
# This is the sorted column
# Prepare a link that goes in the other sort order
if ( $this->mDefaultDirection ) {
# Descending
$image = 'Arr_u.png';
$query['asc'] = '1';
$query['desc'] = '';
$alt = htmlspecialchars( wfMsg( 'descending_abbrev' ) );
} else {
# Ascending
$image = 'Arr_d.png';
$query['asc'] = '';
$query['desc'] = '1';
$alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) );
}
$image = htmlspecialchars( "$wgStylePath/common/images/$image" );
$link = $this->makeLink(
"" .
htmlspecialchars( $name ), $query );
$s .= "