From 63601400e476c6cf43d985f3e7b9864681695ed4 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Fri, 18 Jan 2013 16:46:04 +0100 Subject: Update to MediaWiki 1.20.2 this update includes: * adjusted Arch Linux skin * updated FluxBBAuthPlugin * patch for https://bugzilla.wikimedia.org/show_bug.cgi?id=44024 --- includes/Pager.php | 264 +++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 187 insertions(+), 77 deletions(-) (limited to 'includes/Pager.php') diff --git a/includes/Pager.php b/includes/Pager.php index faae3d2d..96ba446e 100644 --- a/includes/Pager.php +++ b/includes/Pager.php @@ -1,11 +1,30 @@ mDefaultLimit = intval( $this->getUser()->getOption( 'rclimit' ) ); - list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset(); + if ( !$this->mLimit ) { + // Don't override if a subclass calls $this->setLimit() in its constructor. + list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset(); + } $this->mIsBackwards = ( $this->mRequest->getVal( 'dir' ) == 'prev' ); $this->mDb = wfGetDB( DB_SLAVE ); @@ -156,6 +183,15 @@ abstract class IndexPager extends ContextSource implements Pager { } } + /** + * Get the Database object in use + * + * @return DatabaseBase + */ + public function getDatabase() { + return $this->mDb; + } + /** * Do the query, using information from the object context. This function * has been kept minimal to make it overridable if necessary, to allow for @@ -175,6 +211,7 @@ abstract class IndexPager extends ContextSource implements Pager { $queryLimit, $descending ); + $this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult ); $this->mQueryDone = true; @@ -202,10 +239,30 @@ abstract class IndexPager extends ContextSource implements Pager { /** * Set the limit from an other source than the request * + * Verifies limit is between 1 and 5000 + * * @param $limit Int|String */ function setLimit( $limit ) { - $this->mLimit = $limit; + $limit = (int) $limit; + // WebRequest::getLimitOffset() puts a cap of 5000, so do same here. + if ( $limit > 5000 ) { + $limit = 5000; + } + if ( $limit > 0 ) { + $this->mLimit = $limit; + } + } + + /** + * Set whether a row matching exactly the offset should be also included + * in the result or not. By default this is not the case, but when the + * offset is user-supplied this might be wanted. + * + * @param $include bool + */ + public function setIncludeOffset( $include ) { + $this->mIncludeOffset = $include; } /** @@ -284,7 +341,20 @@ abstract class IndexPager extends ContextSource implements Pager { * @param $descending Boolean: query direction, false for ascending, true for descending * @return ResultWrapper */ - function reallyDoQuery( $offset, $limit, $descending ) { + public function reallyDoQuery( $offset, $limit, $descending ) { + list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo( $offset, $limit, $descending ); + return $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds ); + } + + /** + * Build variables to use by the database wrapper. + * + * @param $offset String: index offset, inclusive + * @param $limit Integer: exact query limit + * @param $descending Boolean: query direction, false for ascending, true for descending + * @return array + */ + protected function buildQueryInfo( $offset, $limit, $descending ) { $fname = __METHOD__ . ' (' . $this->getSqlComment() . ')'; $info = $this->getQueryInfo(); $tables = $info['tables']; @@ -294,22 +364,21 @@ abstract class IndexPager extends ContextSource implements Pager { $join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array(); $sortColumns = array_merge( array( $this->mIndexField ), $this->mExtraSortFields ); if ( $descending ) { - $options['ORDER BY'] = implode( ',', $sortColumns ); - $operator = '>'; + $options['ORDER BY'] = $sortColumns; + $operator = $this->mIncludeOffset ? '>=' : '>'; } else { $orderBy = array(); foreach ( $sortColumns as $col ) { $orderBy[] = $col . ' DESC'; } - $options['ORDER BY'] = implode( ',', $orderBy ); - $operator = '<'; + $options['ORDER BY'] = $orderBy; + $operator = $this->mIncludeOffset ? '<=' : '<'; } 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 ); + return array( $tables, $fields, $conds, $fname, $options, $join_conds ); } /** @@ -366,9 +435,10 @@ abstract class IndexPager extends ContextSource implements Pager { * @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) { + function makeLink( $text, array $query = null, $type = null ) { if ( $query === null ) { return $text; } @@ -382,6 +452,7 @@ abstract class IndexPager extends ContextSource implements Pager { if( $type ) { $attrs['class'] = "mw-{$type}link"; } + return Linker::linkKnown( $this->getTitle(), $text, @@ -433,7 +504,7 @@ abstract class IndexPager extends ContextSource implements Pager { * By default, all parameters passed in the URL are used, except for a * short blacklist. * - * @return Associative array + * @return array Associative array */ function getDefaultQuery() { if ( !isset( $this->mDefaultQuery ) ) { @@ -526,6 +597,7 @@ abstract class IndexPager extends ContextSource implements Pager { function getPagingLinks( $linkTexts, $disabledTexts = array() ) { $queries = $this->getPagingQueries(); $links = array(); + foreach ( $queries as $type => $query ) { if ( $query !== false ) { $links[$type] = $this->makeLink( @@ -539,6 +611,7 @@ abstract class IndexPager extends ContextSource implements Pager { $links[$type] = $linkTexts[$type]; } } + return $links; } @@ -651,41 +724,32 @@ abstract class AlphabeticPager extends IndexPager { * @return String HTML */ function getNavigationBar() { - if ( !$this->isNavigationBarShown() ) return ''; + if ( !$this->isNavigationBarShown() ) { + return ''; + } if( isset( $this->mNavigationBar ) ) { return $this->mNavigationBar; } - $lang = $this->getLanguage(); - - $opts = array( 'parsemag', 'escapenoentities' ); $linkTexts = array( - 'prev' => wfMsgExt( - 'prevn', - $opts, - $lang->formatNum( $this->mLimit ) - ), - 'next' => wfMsgExt( - 'nextn', - $opts, - $lang->formatNum($this->mLimit ) - ), - 'first' => wfMsgExt( 'page_first', $opts ), - 'last' => wfMsgExt( 'page_last', $opts ) + 'prev' => $this->msg( 'prevn' )->numParams( $this->mLimit )->escaped(), + 'next' => $this->msg( 'nextn' )->numParams( $this->mLimit )->escaped(), + 'first' => $this->msg( 'page_first' )->escaped(), + 'last' => $this->msg( 'page_last' )->escaped() ); + $lang = $this->getLanguage(); + $pagingLinks = $this->getPagingLinks( $linkTexts ); $limitLinks = $this->getLimitLinks(); $limits = $lang->pipeList( $limitLinks ); - $this->mNavigationBar = - "(" . $lang->pipeList( - array( $pagingLinks['first'], - $pagingLinks['last'] ) - ) . ") " . - wfMsgHtml( 'viewprevnext', $pagingLinks['prev'], - $pagingLinks['next'], $limits ); + $this->mNavigationBar = $this->msg( 'parentheses' )->rawParams( + $lang->pipeList( array( $pagingLinks['first'], + $pagingLinks['last'] ) ) )->escaped() . " " . + $this->msg( 'viewprevnext' )->rawParams( $pagingLinks['prev'], + $pagingLinks['next'], $limits )->escaped(); if( !is_array( $this->getIndexField() ) ) { # Early return to avoid undue nesting @@ -699,21 +763,22 @@ abstract class AlphabeticPager extends IndexPager { if( $first ) { $first = false; } else { - $extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' ); + $extra .= $this->msg( 'pipe-separator' )->escaped(); } if( $order == $this->mOrderType ) { - $extra .= wfMsgHTML( $msgs[$order] ); + $extra .= $this->msg( $msgs[$order] )->escaped(); } else { $extra .= $this->makeLink( - wfMsgHTML( $msgs[$order] ), + $this->msg( $msgs[$order] )->escaped(), array( 'order' => $order ) ); } } if( $extra !== '' ) { - $this->mNavigationBar .= " ($extra)"; + $extra = ' ' . $this->msg( 'parentheses' )->rawParams( $extra )->escaped(); + $this->mNavigationBar .= $extra; } return $this->mNavigationBar; @@ -750,43 +815,35 @@ abstract class ReverseChronologicalPager extends IndexPager { return $this->mNavigationBar; } - $nicenumber = $this->getLanguage()->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' ) + 'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(), + 'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(), + 'first' => $this->msg( 'histlast' )->escaped(), + 'last' => $this->msg( 'histfirst' )->escaped() ); $pagingLinks = $this->getPagingLinks( $linkTexts ); $limitLinks = $this->getLimitLinks(); $limits = $this->getLanguage()->pipeList( $limitLinks ); + $firstLastLinks = $this->msg( 'parentheses' )->rawParams( "{$pagingLinks['first']}" . + $this->msg( 'pipe-separator' )->escaped() . + "{$pagingLinks['last']}" )->escaped(); + + $this->mNavigationBar = $firstLastLinks . ' ' . + $this->msg( 'viewprevnext' )->rawParams( + $pagingLinks['prev'], $pagingLinks['next'], $limits )->escaped(); - $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) @@ -795,6 +852,7 @@ abstract class ReverseChronologicalPager extends IndexPager { if ( !$this->mYear && !$this->mMonth ) { return; } + if ( $this->mYear ) { $year = $this->mYear; } else { @@ -805,6 +863,7 @@ abstract class ReverseChronologicalPager extends IndexPager { $year--; } } + if ( $this->mMonth ) { $month = $this->mMonth + 1; // For December, we want January 1 of the next year @@ -817,14 +876,18 @@ abstract class ReverseChronologicalPager extends IndexPager { $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" ); } } @@ -837,7 +900,7 @@ abstract class TablePager extends IndexPager { var $mSort; var $mCurrentRow; - function __construct( IContextSource $context = null ) { + public function __construct( IContextSource $context = null ) { if ( $context ) { $this->setContext( $context ); } @@ -855,12 +918,16 @@ abstract class TablePager extends IndexPager { parent::__construct(); } + /** + * @protected + * @return string + */ function getStartBody() { global $wgStylePath; $tableClass = htmlspecialchars( $this->getTableClass() ); $sortClass = htmlspecialchars( $this->getSortHeaderClass() ); - $s = "\n"; + $s = "
\n"; $fields = $this->getFieldNames(); # Make table header @@ -877,18 +944,18 @@ abstract class TablePager extends IndexPager { $image = 'Arr_d.png'; $query['asc'] = '1'; $query['desc'] = ''; - $alt = htmlspecialchars( wfMsg( 'descending_abbrev' ) ); + $alt = $this->msg( 'descending_abbrev' )->escaped(); } else { # Ascending $image = 'Arr_u.png'; $query['asc'] = ''; $query['desc'] = '1'; - $alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) ); + $alt = $this->msg( 'ascending_abbrev' )->escaped(); } $image = htmlspecialchars( "$wgStylePath/common/images/$image" ); $link = $this->makeLink( "\"$alt\"" . - htmlspecialchars( $name ), $query ); + htmlspecialchars( $name ), $query ); $s .= "\n"; } else { $s .= '\n"; @@ -901,39 +968,55 @@ abstract class TablePager extends IndexPager { return $s; } + /** + * @protected + * @return string + */ function getEndBody() { return "
$link' . $this->makeLink( htmlspecialchars( $name ), $query ) . "
\n"; } + /** + * @protected + * @return string + */ function getEmptyBody() { $colspan = count( $this->getFieldNames() ); - $msgEmpty = wfMsgHtml( 'table_pager_empty' ); + $msgEmpty = $this->msg( 'table_pager_empty' )->escaped(); return "$msgEmpty\n"; } /** - * @param $row Array + * @protected + * @param stdClass $row * @return String HTML */ function formatRow( $row ) { - $this->mCurrentRow = $row; # In case formatValue etc need to know + $this->mCurrentRow = $row; // In case formatValue etc need to know $s = Xml::openElement( 'tr', $this->getRowAttrs( $row ) ); $fieldNames = $this->getFieldNames(); + foreach ( $fieldNames as $field => $name ) { $value = isset( $row->$field ) ? $row->$field : null; $formatted = strval( $this->formatValue( $field, $value ) ); + if ( $formatted == '' ) { $formatted = ' '; } + $s .= Xml::tags( 'td', $this->getCellAttrs( $field, $value ), $formatted ); } + $s .= "\n"; + return $s; } /** * Get a class name to be applied to the given row. * + * @protected + * * @param $row Object: the database result row * @return String */ @@ -944,8 +1027,10 @@ abstract class TablePager extends IndexPager { /** * Get attributes to be applied to the given row. * + * @protected + * * @param $row Object: the database result row - * @return Array of => + * @return Array of attribute => value */ function getRowAttrs( $row ) { $class = $this->getRowClass( $row ); @@ -962,6 +1047,8 @@ abstract class TablePager extends IndexPager { * take this as an excuse to hardcode styles; use classes and * CSS instead. Row context is available in $this->mCurrentRow * + * @protected + * * @param $field String The column * @param $value String The cell contents * @return Array of attr => value @@ -970,18 +1057,34 @@ abstract class TablePager extends IndexPager { return array( 'class' => 'TablePager_col_' . $field ); } + /** + * @protected + * @return string + */ function getIndexField() { return $this->mSort; } + /** + * @protected + * @return string + */ function getTableClass() { return 'TablePager'; } + /** + * @protected + * @return string + */ function getNavClass() { return 'TablePager_nav'; } + /** + * @protected + * @return string + */ function getSortHeaderClass() { return 'TablePager_sort'; } @@ -990,7 +1093,7 @@ abstract class TablePager extends IndexPager { * A navigation bar with images * @return String HTML */ - function getNavigationBar() { + public function getNavigationBar() { global $wgStylePath; if ( !$this->isNavigationBarShown() ) { @@ -1025,7 +1128,7 @@ abstract class TablePager extends IndexPager { $linkTexts = array(); $disabledTexts = array(); foreach ( $labels as $type => $label ) { - $msgLabel = wfMsgHtml( $label ); + $msgLabel = $this->msg( $label )->escaped(); $linkTexts[$type] = "\"$msgLabel\"/
$msgLabel"; $disabledTexts[$type] = "\"$msgLabel\"/
$msgLabel"; } @@ -1042,11 +1145,11 @@ abstract class TablePager extends IndexPager { } /** - * Get a " element which has options for each of the allowed limits * * @return String: HTML fragment */ - function getLimitSelect() { + public function getLimitSelect() { # Add the current limit from the query string # to avoid that the limit is lost after clicking Go next time if ( !in_array( $this->mLimit, $this->mLimitsShown ) ) { @@ -1072,7 +1175,7 @@ abstract class TablePager extends IndexPager { } /** - * Get elements for use in a method="get" form. + * Get \ elements for use in a method="get" form. * Resubmits all defined elements of the query string, except for a * blacklist, passed in the $blacklist parameter. * @@ -1117,9 +1220,10 @@ abstract class TablePager extends IndexPager { */ function getLimitDropdown() { # Make the select with some explanatory text - $msgSubmit = wfMsgHtml( 'table_pager_limit_submit' ); + $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped(); - return wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) . + return $this->msg( 'table_pager_limit' ) + ->rawParams( $this->getLimitSelect() )->escaped() . "\n\n" . $this->getHiddenFields( array( 'limit' ) ); } @@ -1139,13 +1243,19 @@ abstract class TablePager extends IndexPager { * The current result row is available as $this->mCurrentRow, in case you * need more context. * + * @protected + * * @param $name String: the database field name * @param $value String: the value retrieved from the database */ abstract function formatValue( $name, $value ); /** - * The database field name used as a default sort order + * The database field name used as a default sort order. + * + * @protected + * + * @return string */ abstract function getDefaultSort(); -- cgit v1.2.2