Rename $wgVaryOnXFPForAPI (introduced in r93818) to $wgVaryOnXFP and extend it to...
[lhc/web/wiklou.git] / includes / Pager.php
index 81d9559..b91b061 100644 (file)
@@ -57,7 +57,7 @@ interface Pager {
  *
  * @ingroup Pager
  */
-abstract class IndexPager implements Pager {
+abstract class IndexPager extends ContextSource implements Pager {
        public $mRequest;
        public $mLimitsShown = array( 20, 50, 100, 250, 500 );
        public $mDefaultLimit = 50;
@@ -67,10 +67,15 @@ abstract class IndexPager implements Pager {
        public $mPastTheEndRow;
 
        /**
-        * The index to actually be used for ordering.  This is a single string
-        * even if multiple orderings are supported.
+        * The index to actually be used for ordering. This is a single column,
+        * for one ordering, even if multiple orderings are supported.
         */
        protected $mIndexField;
+       /**
+        * An array of secondary columns to order by. These fields are not part of the offset.
+        * This is a column list for one ordering, even if multiple orderings are supported.
+        */
+       protected $mExtraSortFields;
        /** For pages that support multiple types of ordering, which one to use.
         */
        protected $mOrderType;
@@ -98,9 +103,12 @@ abstract class IndexPager implements Pager {
         */
        public $mResult;
 
-       public function __construct() {
-               global $wgRequest, $wgUser;
-               $this->mRequest = $wgRequest;
+       public function __construct( IContextSource $context = null ) {
+               if ( $context ) {
+                       $this->setContext( $context );
+               }
+
+               $this->mRequest = $this->getRequest();
 
                # NB: the offset is quoted, not validated. It is treated as an
                # arbitrary string to support the widest variety of index types. Be
@@ -108,25 +116,33 @@ abstract class IndexPager implements Pager {
                $this->mOffset = $this->mRequest->getText( 'offset' );
 
                # Use consistent behavior for the limit options
-               $this->mDefaultLimit = intval( $wgUser->getOption( 'rclimit' ) );
+               $this->mDefaultLimit = intval( $this->getUser()->getOption( 'rclimit' ) );
                list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset();
 
                $this->mIsBackwards = ( $this->mRequest->getVal( 'dir' ) == 'prev' );
                $this->mDb = wfGetDB( DB_SLAVE );
 
-               $index = $this->getIndexField();
+               $index = $this->getIndexField(); // column to sort on
+               $extraSort = $this->getExtraSortFields(); // extra columns to sort on for query planning
                $order = $this->mRequest->getVal( 'order' );
                if( is_array( $index ) && isset( $index[$order] ) ) {
                        $this->mOrderType = $order;
                        $this->mIndexField = $index[$order];
+                       $this->mExtraSortFields = isset( $extraSort[$order] )
+                               ? (array)$extraSort[$order]
+                               : array();
                } elseif( is_array( $index ) ) {
                        # First element is the default
                        reset( $index );
                        list( $this->mOrderType, $this->mIndexField ) = each( $index );
+                       $this->mExtraSortFields = isset( $extraSort[$this->mOrderType] )
+                               ? (array)$extraSort[$this->mOrderType]
+                               : array();
                } else {
                        # $index is not an array
                        $this->mOrderType = null;
                        $this->mIndexField = $index;
+                       $this->mExtraSortFields = (array)$extraSort;
                }
 
                if( !isset( $this->mDefaultDirection ) ) {
@@ -173,13 +189,13 @@ abstract class IndexPager implements Pager {
        }
 
        /**
-        * Set the offset from an other source than $wgRequest
+        * Set the offset from an other source than the request
         */
        function setOffset( $offset ) {
                $this->mOffset = $offset;
        }
        /**
-        * Set the limit from an other source than $wgRequest
+        * Set the limit from an other source than the request
         */
        function setLimit( $limit ) {
                $this->mLimit = $limit;
@@ -269,11 +285,16 @@ abstract class IndexPager implements Pager {
                $conds = isset( $info['conds'] ) ? $info['conds'] : array();
                $options = isset( $info['options'] ) ? $info['options'] : array();
                $join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array();
+               $sortColumns = array_merge( array( $this->mIndexField ), $this->mExtraSortFields );
                if ( $descending ) {
-                       $options['ORDER BY'] = $this->mIndexField;
+                       $options['ORDER BY'] = implode( ',', $sortColumns );
                        $operator = '>';
                } else {
-                       $options['ORDER BY'] = $this->mIndexField . ' DESC';
+                       $orderBy = array();
+                       foreach ( $sortColumns as $col ) {
+                               $orderBy[] = $col . ' DESC';
+                       }
+                       $options['ORDER BY'] = implode( ',', $orderBy );
                        $operator = '<';
                }
                if ( $offset != '' ) {
@@ -348,12 +369,11 @@ abstract class IndexPager implements Pager {
                if( $type ) {
                        $attrs['class'] = "mw-{$type}link";
                }
-               return $this->getSkin()->link(
+               return Linker::linkKnown(
                        $this->getTitle(),
                        $text,
                        $attrs,
-                       $query + $this->getDefaultQuery(),
-                       array( 'noclasses', 'known' )
+                       $query + $this->getDefaultQuery()
                );
        }
 
@@ -386,29 +406,6 @@ abstract class IndexPager implements Pager {
                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
@@ -417,10 +414,8 @@ abstract class IndexPager implements Pager {
         * @return Associative array
         */
        function getDefaultQuery() {
-               global $wgRequest;
-
                if ( !isset( $this->mDefaultQuery ) ) {
-                       $this->mDefaultQuery = $wgRequest->getQueryValues();
+                       $this->mDefaultQuery = $this->getRequest()->getQueryValues();
                        unset( $this->mDefaultQuery['title'] );
                        unset( $this->mDefaultQuery['dir'] );
                        unset( $this->mDefaultQuery['offset'] );
@@ -524,7 +519,6 @@ abstract class IndexPager implements Pager {
        }
 
        function getLimitLinks() {
-               global $wgLang;
                $links = array();
                if ( $this->mIsBackwards ) {
                        $offset = $this->mPastTheEndIndex;
@@ -533,7 +527,7 @@ abstract class IndexPager implements Pager {
                }
                foreach ( $this->mLimitsShown as $limit ) {
                        $links[] = $this->makeLink(
-                               $wgLang->formatNum( $limit ),
+                               $this->getLang()->formatNum( $limit ),
                                array( 'offset' => $offset, 'limit' => $limit ),
                                'num'
                        );
@@ -574,9 +568,29 @@ abstract class IndexPager implements Pager {
         *
         * Needless to say, it's really not a good idea to use a non-unique index
         * for this!  That won't page right.
+        *
+        * @return string|Array
         */
        abstract function getIndexField();
 
+       /**
+        * This function should be overridden to return the names of secondary columns
+        * to order by in addition to the column in getIndexField(). These fields will
+        * not be used in the pager offset or in any links for users.
+        *
+        * If getIndexField() returns an array of 'querykey' => 'indexfield' pairs then
+        * this must return a corresponding array of 'querykey' => array( fields...) pairs
+        * in order for a request with &count=querykey to use array( fields...) to sort.
+        *
+        * This is useful for pagers that GROUP BY a unique column (say page_id)
+        * and ORDER BY another (say page_len). Using GROUP BY and ORDER BY both on
+        * page_len,page_id avoids temp tables (given a page_len index). This would
+        * also work if page_id was non-unique but we had a page_len,page_id index.
+        *
+        * @return Array
+        */
+       protected function getExtraSortFields() { return array(); }
+
        /**
         * Return the default sorting direction: false for ascending, true for de-
         * scending.  You can also have an associative array of ordertype => dir,
@@ -610,25 +624,25 @@ abstract class AlphabeticPager extends IndexPager {
         * 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;
                }
 
+               $lang = $this->getLang();
+
                $opts = array( 'parsemag', 'escapenoentities' );
                $linkTexts = array(
                        'prev' => wfMsgExt(
                                'prevn',
                                $opts,
-                               $wgLang->formatNum( $this->mLimit )
+                               $lang->formatNum( $this->mLimit )
                        ),
                        'next' => wfMsgExt(
                                'nextn',
                                $opts,
-                               $wgLang->formatNum($this->mLimit )
+                               $lang->formatNum($this->mLimit )
                        ),
                        'first' => wfMsgExt( 'page_first', $opts ),
                        'last' => wfMsgExt( 'page_last', $opts )
@@ -636,10 +650,10 @@ abstract class AlphabeticPager extends IndexPager {
 
                $pagingLinks = $this->getPagingLinks( $linkTexts );
                $limitLinks = $this->getLimitLinks();
-               $limits = $wgLang->pipeList( $limitLinks );
+               $limits = $lang->pipeList( $limitLinks );
 
                $this->mNavigationBar =
-                       "(" . $wgLang->pipeList(
+                       "(" . $lang->pipeList(
                                array( $pagingLinks['first'],
                                $pagingLinks['last'] )
                        ) . ") " .
@@ -700,13 +714,7 @@ abstract class ReverseChronologicalPager extends IndexPager {
        public $mYear;
        public $mMonth;
 
-       function __construct() {
-               parent::__construct();
-       }
-
        function getNavigationBar() {
-               global $wgLang;
-
                if ( !$this->isNavigationBarShown() ) {
                        return '';
                }
@@ -714,7 +722,8 @@ abstract class ReverseChronologicalPager extends IndexPager {
                if ( isset( $this->mNavigationBar ) ) {
                        return $this->mNavigationBar;
                }
-               $nicenumber = $wgLang->formatNum( $this->mLimit );
+
+               $nicenumber = $this->getLang()->formatNum( $this->mLimit );
                $linkTexts = array(
                        'prev' => wfMsgExt(
                                'pager-newer-n',
@@ -732,7 +741,7 @@ abstract class ReverseChronologicalPager extends IndexPager {
 
                $pagingLinks = $this->getPagingLinks( $linkTexts );
                $limitLinks = $this->getLimitLinks();
-               $limits = $wgLang->pipeList( $limitLinks );
+               $limits = $this->getLang()->pipeList( $limitLinks );
 
                $this->mNavigationBar = "({$pagingLinks['first']}" .
                        wfMsgExt( 'pipe-separator' , 'escapenoentities' ) .
@@ -801,15 +810,18 @@ abstract class TablePager extends IndexPager {
        var $mSort;
        var $mCurrentRow;
 
-       function __construct() {
-               global $wgRequest;
-               $this->mSort = $wgRequest->getText( 'sort' );
+       function __construct( IContextSource $context = null ) {
+               if ( $context ) {
+                       $this->setContext( $context );
+               }
+
+               $this->mSort = $this->getRequest()->getText( 'sort' );
                if ( !array_key_exists( $this->mSort, $this->getFieldNames() ) ) {
                        $this->mSort = $this->getDefaultSort();
                }
-               if ( $wgRequest->getBool( 'asc' ) ) {
+               if ( $this->getRequest()->getBool( 'asc' ) ) {
                        $this->mDefaultDirection = false;
-               } elseif ( $wgRequest->getBool( 'desc' ) ) {
+               } elseif ( $this->getRequest()->getBool( 'desc' ) ) {
                        $this->mDefaultDirection = true;
                } /* Else leave it at whatever the class default is */
 
@@ -821,7 +833,7 @@ abstract class TablePager extends IndexPager {
                $tableClass = htmlspecialchars( $this->getTableClass() );
                $sortClass = htmlspecialchars( $this->getSortHeaderClass() );
 
-               $s = "<table style='border:1;' class=\"$tableClass\"><thead><tr>\n";
+               $s = "<table style='border:1;' class=\"mw-datatable $tableClass\"><thead><tr>\n";
                $fields = $this->getFieldNames();
 
                # Make table header
@@ -947,7 +959,7 @@ abstract class TablePager extends IndexPager {
         * A navigation bar with images
         */
        function getNavigationBar() {
-               global $wgStylePath, $wgLang;
+               global $wgStylePath;
 
                if ( !$this->isNavigationBarShown() ) {
                        return '';
@@ -972,7 +984,7 @@ abstract class TablePager extends IndexPager {
                        'next' => 'arrow_disabled_right_25.png',
                        'last' => 'arrow_disabled_last_25.png',
                );
-               if( $wgLang->isRTL() ) {
+               if( $this->getLang()->isRTL() ) {
                        $keys = array_keys( $labels );
                        $images = array_combine( $keys, array_reverse( $images ) );
                        $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) );
@@ -1003,8 +1015,6 @@ abstract class TablePager extends IndexPager {
         * @return String: HTML fragment
         */
        function getLimitSelect() {
-               global $wgLang;
-
                # 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 ) ) {
@@ -1018,7 +1028,7 @@ abstract class TablePager extends IndexPager {
                        # will be a string.
                        if( is_int( $value ) ){
                                $limit = $value;
-                               $text = $wgLang->formatNum( $limit );
+                               $text = $this->getLang()->formatNum( $limit );
                        } else {
                                $limit = $key;
                                $text = $value;
@@ -1037,10 +1047,8 @@ abstract class TablePager extends IndexPager {
         * @return String: HTML fragment
         */
        function getHiddenFields( $blacklist = array() ) {
-               global $wgRequest;
-
                $blacklist = (array)$blacklist;
-               $query = $wgRequest->getQueryValues();
+               $query = $this->getRequest()->getQueryValues();
                foreach ( $blacklist as $name ) {
                        unset( $query[$name] );
                }