Partial revert of r56602: remove what is probably accidentally committed debugging...
[lhc/web/wiklou.git] / includes / Pager.php
index f3d99f6..825a046 100644 (file)
@@ -50,7 +50,7 @@ interface Pager {
  *      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
+ *  simple, please see the examples in HistoryPage.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.
@@ -67,11 +67,12 @@ abstract class IndexPager implements Pager {
        public $mPastTheEndRow;
 
        /**
-        * The index to actually be used for ordering.  This is a single string e-
-        * ven if multiple orderings are supported.
+        * The index to actually be used for ordering.  This is a single string
+        * even if multiple orderings are supported.
         */
        protected $mIndexField;
-       /** For pages that support multiple types of ordering, which one to use. */
+       /** For pages that support multiple types of ordering, which one to use.
+        */
        protected $mOrderType;
        /**
         * $mDefaultDirection gives the direction to use when sorting results:
@@ -87,6 +88,9 @@ abstract class IndexPager implements Pager {
        public $mDefaultDirection;
        public $mIsBackwards;
 
+       /** True if the current result set is the first one */
+       public $mIsFirst;
+
        /**
         * Result object for the query. Warning: seek before use.
         */
@@ -145,7 +149,11 @@ abstract class IndexPager implements Pager {
                # 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->mResult = $this->reallyDoQuery(
+                       $this->mOffset,
+                       $queryLimit,
+                       $descending
+               );
                $this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult );
                $this->mQueryDone = true;
 
@@ -155,6 +163,26 @@ abstract class IndexPager implements Pager {
                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
         * the navigation bar, put it into $this
@@ -284,17 +312,23 @@ abstract class IndexPager implements Pager {
                if ( $query === null ) {
                        return $text;
                }
-               if( $type == 'prev' || $type == 'next' ) {
-                       $attrs = "rel=\"$type\"";
-               } elseif( $type == 'first' ) {
-                       $attrs = "rel=\"start\"";
-               } else {
-                       # HTML 4 has no rel="end" . . .
-                       $attrs = '';
+
+               $attrs = array();
+               if( in_array( $type, array( 'first', 'prev', 'next', 'last' ) ) ) {
+                       # HTML5 rel attributes
+                       $attrs['rel'] = $type;
                }
-               return $this->getSkin()->makeKnownLinkObj( $this->getTitle(), $text,
-                               wfArrayToCGI( $query, $this->getDefaultQuery() ), '', '',
-                               $attrs );
+
+               if( $type ) {
+                       $attrs['class'] = "mw-{$type}link";
+               }
+               return $this->getSkin()->link(
+                       $this->getTitle(),
+                       $text,
+                       $attrs,
+                       $query + $this->getDefaultQuery(),
+                       array( 'noclasses', 'known' )
+               );
        }
 
        /**
@@ -383,7 +417,11 @@ abstract class IndexPager implements Pager {
                        $prev = false;
                        $first = false;
                } else {
-                       $prev = array( 'dir' => 'prev', 'offset' => $this->mFirstShown, 'limit' => $urlLimit );
+                       $prev = array(
+                               'dir' => 'prev',
+                               'offset' => $this->mFirstShown,
+                               'limit' => $urlLimit
+                       );
                        $first = array( 'limit' => $urlLimit );
                }
                if ( $this->mIsLast ) {
@@ -393,7 +431,20 @@ abstract class IndexPager implements Pager {
                        $next = array( 'offset' => $this->mLastShown, 'limit' => $urlLimit );
                        $last = array( 'dir' => 'prev', 'limit' => $urlLimit );
                }
-               return array( 'prev' => $prev, 'next' => $next, 'first' => $first, 'last' => $last );
+               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);
        }
 
        /**
@@ -407,7 +458,11 @@ abstract class IndexPager implements Pager {
                $links = array();
                foreach ( $queries as $type => $query ) {
                        if ( $query !== false ) {
-                               $links[$type] = $this->makeLink( $linkTexts[$type], $queries[$type], $type );
+                               $links[$type] = $this->makeLink(
+                                       $linkTexts[$type],
+                                       $queries[$type],
+                                       $type
+                               );
                        } elseif ( isset( $disabledTexts[$type] ) ) {
                                $links[$type] = $disabledTexts[$type];
                        } else {
@@ -426,8 +481,11 @@ abstract class IndexPager implements Pager {
                        $offset = $this->mOffset;
                }
                foreach ( $this->mLimitsShown as $limit ) {
-                       $links[] = $this->makeLink( $wgLang->formatNum( $limit ),
-                               array( 'offset' => $offset, 'limit' => $limit ) );
+                       $links[] = $this->makeLink(
+                               $wgLang->formatNum( $limit ),
+                               array( 'offset' => $offset, 'limit' => $limit ),
+                               'num'
+                       );
                }
                return $links;
        }
@@ -447,6 +505,7 @@ abstract class IndexPager implements Pager {
         *    fields => Field(s) for passing to Database::select(), may be *
         *    conds => WHERE conditions
         *    options => option array
+        *    join_conds => JOIN conditions
         */
        abstract function getQueryInfo();
 
@@ -495,24 +554,37 @@ abstract class AlphabeticPager extends IndexPager {
        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 ) ),
+                       '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 );
+               $limits = $wgLang->pipeList( $limitLinks );
 
                $this->mNavigationBar =
-                       "({$pagingLinks['first']} | {$pagingLinks['last']}) " .
+                       "(" . $wgLang->pipeList(
+                               array( $pagingLinks['first'],
+                               $pagingLinks['last'] )
+                       ) . ") " .
                        wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
                        $pagingLinks['next'], $limits );
 
@@ -528,7 +600,7 @@ abstract class AlphabeticPager extends IndexPager {
                        if( $first ) {
                                $first = false;
                        } else {
-                               $extra .= ' | ';
+                               $extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
                        }
 
                        if( $order == $this->mOrderType ) {
@@ -576,26 +648,42 @@ 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' => wfMsgExt( 'pager-newer-n', array( 'parsemag' ), $nicenumber ),
-                       'next' => wfMsgExt( 'pager-older-n', array( 'parsemag' ), $nicenumber ),
+                       '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);
@@ -724,22 +812,50 @@ abstract class TablePager extends IndexPager {
        }
 
        function formatRow( $row ) {
-               $s = "<tr>\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 = '&nbsp;';
                        }
-                       $class = 'TablePager_col_' . htmlspecialchars( $field );
-                       $s .= "<td class=\"$class\">$formatted</td>\n";
+                       $s .= Xml::tags( 'td', $this->getCellAttrs( $field, $value ), $formatted );
                }
                $s .= "</tr>\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;
        }
@@ -761,6 +877,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',
@@ -769,17 +888,22 @@ abstract class TablePager extends IndexPager {
                        'last' => 'table_pager_last',
                );
                $images = array(
-                       'first' => $wgContLang->isRTL() ? 'arrow_last_25.png' : 'arrow_first_25.png',
-                       'prev' =>  $wgContLang->isRTL() ? 'arrow_right_25.png' : 'arrow_left_25.png',
-                       'next' =>  $wgContLang->isRTL() ? 'arrow_left_25.png' : 'arrow_right_25.png',
-                       'last' =>  $wgContLang->isRTL() ? 'arrow_first_25.png' : 'arrow_last_25.png',
+                       'first' => 'arrow_first_25.png',
+                       'prev' => 'arrow_left_25.png',
+                       'next' => 'arrow_right_25.png',
+                       'last' => 'arrow_last_25.png',
                );
                $disabledImages = array(
-                       'first' => $wgContLang->isRTL() ? 'arrow_disabled_last_25.png' : 'arrow_disabled_first_25.png',
-                       'prev' =>  $wgContLang->isRTL() ? 'arrow_disabled_right_25.png' : 'arrow_disabled_left_25.png',
-                       'next' =>  $wgContLang->isRTL() ? 'arrow_disabled_left_25.png' : 'arrow_disabled_right_25.png',
-                       'last' =>  $wgContLang->isRTL() ? 'arrow_disabled_first_25.png' : 'arrow_disabled_last_25.png',
+                       'first' => 'arrow_disabled_first_25.png',
+                       'prev' => 'arrow_disabled_left_25.png',
+                       'next' => 'arrow_disabled_right_25.png',
+                       'last' => 'arrow_disabled_last_25.png',
                );
+               if( $wgContLang->isRTL() ) {
+                       $keys = array_keys( $labels );
+                       $images = array_combine( $keys, array_reverse( $images ) );
+                       $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) );
+               }
 
                $linkTexts = array();
                $disabledTexts = array();
@@ -806,10 +930,19 @@ abstract class TablePager extends IndexPager {
        function getLimitSelect() {
                global $wgLang;
                $s = "<select name=\"limit\">";
-               foreach ( $this->mLimitsShown as $limit ) {
-                       $selected = $limit == $this->mLimit ? 'selected="selected"' : '';
-                       $formattedLimit = $wgLang->formatNum( $limit );
-                       $s .= "<option value=\"$limit\" $selected>$formattedLimit</option>\n";
+               foreach ( $this->mLimitsShown as $key => $value ) {
+                       # The pair is either $index => $limit, in which case the $value
+                       # will be numeric, or $limit => $text, in which case the $value
+                       # will be a string.
+                       if( is_int( $value ) ){
+                               $limit = $value;
+                               $text = $wgLang->formatNum( $limit );
+                       } else {
+                               $limit = $key;
+                               $text = $value;
+                       }
+                       $selected = ( $limit == $this->mLimit ? 'selected="selected"' : '' );
+                       $s .= "<option value=\"$limit\" $selected>$text</option>\n";
                }
                $s .= "</select>";
                return $s;
@@ -839,14 +972,21 @@ 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
-                       "<form method=\"get\" action=\"$url\">" .
+                       Xml::openElement(
+                               'form',
+                               array(
+                                       'method' => 'get',
+                                       'action' => $wgScript
+                               )
+                       ) . "\n" .
                        wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
                        "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
-                       $this->getHiddenFields( 'limit' ) .
+                       $this->getHiddenFields( array( 'limit' ) ) .
                        "</form>\n";
        }