X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FPager.php;h=3f96251077b89dcbf7d739c3105a0dd46babf7bb;hb=775154ca2137e2c253deeafe9497579c56bd35f0;hp=c135e2126ba6f51f4c6976848da7a299eac053c2;hpb=7f131d95633b86d422e5f61cd00ef1473a59b83a;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Pager.php b/includes/Pager.php index c135e2126b..3f96251077 100644 --- a/includes/Pager.php +++ b/includes/Pager.php @@ -1,7 +1,14 @@ 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! + # 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 > 50000 ) { - $this->mLimit = $this->mDefaultLimit; - } + + # 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->mIndexField = $this->getIndexField(); $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 + * 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() { @@ -103,11 +149,34 @@ abstract class IndexPager implements Pager { $this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult ); $this->mQueryDone = true; + $this->preprocessResults( $this->mResult ); + $this->mResult->rewind(); // Paranoia + wfProfileOut( $fname ); } + + /** + * Return 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 + * Extract some useful data from the result object for use by * the navigation bar, put it into $this */ function extractResultInfo( $offset, $limit, ResultWrapper $res ) { @@ -127,9 +196,10 @@ abstract class IndexPager implements Pager { $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. + # 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(); @@ -156,21 +226,23 @@ abstract class IndexPager implements Pager { } /** - * Do a query with specified parameters, rather than using the object context + * 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 ) { + function reallyDoQuery( $offset, $limit, $descending ) { $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 ) { + $join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array(); + if ( $descending ) { $options['ORDER BY'] = $this->mIndexField; $operator = '>'; } else { @@ -181,12 +253,19 @@ abstract class IndexPager implements Pager { $conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset ); } $options['LIMIT'] = intval( $limit ); - $res = $this->mDb->select( $tables, $fields, $conds, $fname, $options ); + $res = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds ); return new ResultWrapper( $this->mDb, $res ); } /** - * Get the formatted result list. Calls getStartBody(), formatRow() and + * Pre-process results; useful for performing batch existence checks, etc. + * + * @param ResultWrapper $result Result wrapper + */ + protected function preprocessResults( $result ) {} + + /** + * Get the formatted result list. Calls getStartBody(), formatRow() and * getEndBody(), concatenates the results and returns them. */ function getBody() { @@ -221,17 +300,26 @@ abstract class IndexPager implements Pager { /** * Make a self-link */ - function makeLink($text, $query = NULL) { + function makeLink($text, $query = null, $type=null) { if ( $query === null ) { return $text; - } else { - return $this->getSkin()->makeKnownLinkObj( $this->getTitle(), $text, - wfArrayToCGI( $query, $this->getDefaultQuery() ) ); } + + $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 + * 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() { @@ -246,15 +334,15 @@ abstract class IndexPager implements Pager { } /** - * Hook into getBody(), for the bit between the start and the + * Hook into getBody(), for the bit between the start and the * end when there are no rows */ function getEmptyBody() { return ''; } - + /** - * Title used for self-links. Override this if you want to be able to + * Title used for self-links. Override this if you want to be able to * use a title other than $wgTitle */ function getTitle() { @@ -273,8 +361,8 @@ abstract class IndexPager implements Pager { } /** - * 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 + * 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() { @@ -284,6 +372,9 @@ abstract class IndexPager implements Pager { 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; } @@ -299,16 +390,16 @@ abstract class IndexPager implements Pager { } /** - * Get a query array for the prev, next, first and last links. + * Get a URL query array for the prev, next, first and last links. */ 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; @@ -326,17 +417,26 @@ abstract class IndexPager implements Pager { return array( 'prev' => $prev, 'next' => $next, 'first' => $first, 'last' => $last ); } + 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. + * 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. */ 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] ); + $links[$type] = $this->makeLink( $linkTexts[$type], $queries[$type], $type ); } elseif ( isset( $disabledTexts[$type] ) ) { $links[$type] = $disabledTexts[$type]; } else { @@ -356,76 +456,150 @@ abstract class IndexPager implements Pager { } foreach ( $this->mLimitsShown as $limit ) { $links[] = $this->makeLink( $wgLang->formatNum( $limit ), - array( 'offset' => $offset, 'limit' => $limit ) ); + array( 'offset' => $offset, 'limit' => $limit ), 'num' ); } return $links; } /** - * Abstract formatting function. This should return an HTML string + * 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 + * 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 */ abstract function getQueryInfo(); /** - * This function should be overridden to return the name of the - * index field. + * 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. + */ + protected function getDefaultDirections() { return false; } } /** * IndexPager with an alphabetic list and a formatted navigation bar -*/ + * @ingroup Pager + */ abstract class AlphabeticPager extends IndexPager { - public $mDefaultDirection = false; - - function __construct() { - parent::__construct(); - } - - /** - * Shamelessly stolen bits from ReverseChronologicalPager, d - * didn't want to do class magic as may be still revamped + /** + * 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' => wfMsgHtml( "prevn", $this->mLimit ), - 'next' => wfMsgHtml( 'nextn', $this->mLimit ), - 'first' => wfMsgHtml('page_first'), /* Introduced the message */ - 'last' => wfMsgHtml( 'page_last' ) /* Introduced the message */ + '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 = implode( ' | ', $limitLinks ); - - $this->mNavigationBar = "({$pagingLinks['first']} | {$pagingLinks['last']}) " . wfMsgHtml("viewprevnext", $pagingLinks['prev'], $pagingLinks['next'], $limits); + $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(); @@ -434,27 +608,79 @@ abstract class ReverseChronologicalPager extends IndexPager { function getNavigationBar() { global $wgLang; + if ( !$this->isNavigationBarShown() ) return ''; + if ( isset( $this->mNavigationBar ) ) { return $this->mNavigationBar; } + $nicenumber = $wgLang->formatNum( $this->mLimit ); $linkTexts = array( - 'prev' => wfMsgHtml( "prevn", $this->mLimit ), - 'next' => wfMsgHtml( 'nextn', $this->mLimit ), - 'first' => wfMsgHtml('histlast'), + '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 = implode( ' | ', $limitLinks ); - - $this->mNavigationBar = "({$pagingLinks['first']} | {$pagingLinks['last']}) " . wfMsgHtml("viewprevnext", $pagingLinks['prev'], $pagingLinks['next'], $limits); + $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; @@ -479,7 +705,7 @@ abstract class TablePager extends IndexPager { global $wgStylePath; $tableClass = htmlspecialchars( $this->getTableClass() ); $sortClass = htmlspecialchars( $this->getSortHeaderClass() ); - + $s = "\n"; $fields = $this->getFieldNames(); @@ -506,7 +732,7 @@ abstract class TablePager extends IndexPager { $alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) ); } $image = htmlspecialchars( "$wgStylePath/common/images/$image" ); - $link = $this->makeLink( + $link = $this->makeLink( "\"$alt\"" . htmlspecialchars( $name ), $query ); $s .= "\n"; @@ -518,7 +744,7 @@ abstract class TablePager extends IndexPager { } } $s .= "\n"; - return $s; + return $s; } function getEndBody() { @@ -532,22 +758,50 @@ abstract class TablePager extends IndexPager { } function formatRow( $row ) { - $s = "\n"; + $this->mCurrentRow = $row; # In case formatValue etc need to know + $s = Xml::openElement( 'tr', $this->getRowAttrs($row) ); $fieldNames = $this->getFieldNames(); - $this->mCurrentRow = $row; # In case formatValue needs to know foreach ( $fieldNames as $field => $name ) { $value = isset( $row->$field ) ? $row->$field : null; $formatted = strval( $this->formatValue( $field, $value ) ); if ( $formatted == '' ) { $formatted = ' '; } - $class = 'TablePager_col_' . htmlspecialchars( $field ); - $s .= "\n"; + $s .= Xml::tags( 'td', $this->getCellAttrs( $field, $value ), $formatted ); } $s .= "\n"; return $s; } + /** + * Get a class name to be applied to the given row. + * @param object $row The database result row + */ + function getRowClass( $row ) { + return ''; + } + + /** + * Get attributes to be applied to the given row. + * @param object $row The database result row + * @return associative array + */ + function getRowAttrs( $row ) { + return array( 'class' => $this->getRowClass( $row ) ); + } + + /** + * Get any extra attributes to be applied to the given cell. Don't + * take this as an excuse to hardcode styles; use classes and + * CSS instead. Row context is available in $this->mCurrentRow + * @param $field The column + * @param $value The cell contents + * @return associative array + */ + function getCellAttrs( $field, $value ) { + return array( 'class' => 'TablePager_col_' . $field ); + } + function getIndexField() { return $this->mSort; } @@ -569,6 +823,9 @@ abstract class TablePager extends IndexPager { */ function getNavigationBar() { global $wgStylePath, $wgContLang; + + if ( !$this->isNavigationBarShown() ) return ''; + $path = "$wgStylePath/common/images"; $labels = array( 'first' => 'table_pager_first', @@ -624,8 +881,8 @@ abstract class TablePager extends IndexPager { } /** - * Get elements for use in a method="get" form. - * Resubmits all defined elements of the $_GET array, except for a + * Get elements for use in a method="get" form. + * Resubmits all defined elements of the $_GET array, except for a * blacklist, passed in the $blacklist parameter. */ function getHiddenFields( $blacklist = array() ) { @@ -647,32 +904,35 @@ abstract class TablePager extends IndexPager { * Get a form containing a limit selection dropdown */ function getLimitForm() { + global $wgScript; + # Make the select with some explanatory text - $url = $this->getTitle()->escapeLocalURL(); $msgSubmit = wfMsgHtml( 'table_pager_limit_submit' ); return - "" . - wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) . + Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) . "\n" . + wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) . "\n\n" . - $this->getHiddenFields( 'limit' ) . + $this->getHiddenFields( array( 'limit' ) ) . "\n"; } /** - * Return true if the named field should be sortable by the UI, false otherwise + * Return true if the named field should be sortable by the UI, false + * otherwise + * * @param string $field */ abstract function isFieldSortable( $field ); /** - * Format a table cell. The return value should be HTML, but use an empty string - * not   for empty cells. Do not include the . + * Format a table cell. The return value should be HTML, but use an empty + * string not   for empty cells. Do not include the . + * + * The current result row is available as $this->mCurrentRow, in case you + * need more context. * * @param string $name The database field name * @param string $value The value retrieved from the database - * - * The current result row is available as $this->mCurrentRow, in case you need - * more context. */ abstract function formatValue( $name, $value ); @@ -682,10 +942,9 @@ abstract class TablePager extends IndexPager { abstract function getDefaultSort(); /** - * An array mapping database field names to a textual description of the field - * name, for use in the table header. The description should be plain text, it - * will be HTML-escaped later. + * An array mapping database field names to a textual description of the + * field name, for use in the table header. The description should be plain + * text, it will be HTML-escaped later. */ abstract function getFieldNames(); } -?>
$link
$formatted
and and