includes/Pager.php

   1 <?php
   2 /**
   3  * Efficient paging for SQL queries.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Pager
  22  */
  23
  24 /**
  25  * @defgroup Pager Pager
  26  */
  27
  28 /**
  29  * Basic pager interface.
  30  * @ingroup Pager
  31  */
  32 interface Pager {
  33         function getNavigationBar();
  34         function getBody();
  35 }
  36
  37 /**
  38  * IndexPager is an efficient pager which uses a (roughly unique) index in the
  39  * data set to implement paging, rather than a "LIMIT offset,limit" clause.
  40  * In MySQL, such a limit/offset clause requires counting through the
  41  * specified number of offset rows to find the desired data, which can be
  42  * expensive for large offsets.
  43  *
  44  * ReverseChronologicalPager is a child class of the abstract IndexPager, and
  45  * contains  some formatting and display code which is specific to the use of
  46  * timestamps as  indexes. Here is a synopsis of its operation:
  47  *
  48  *    * The query is specified by the offset, limit and direction (dir)
  49  *      parameters, in addition to any subclass-specific parameters.
  50  *    * The offset is the non-inclusive start of the DB query. A row with an
  51  *      index value equal to the offset will never be shown.
  52  *    * The query may either be done backwards, where the rows are returned by
  53  *      the database in the opposite order to which they are displayed to the
  54  *      user, or forwards. This is specified by the "dir" parameter, dir=prev
  55  *      means backwards, anything else means forwards. The offset value
  56  *      specifies the start of the database result set, which may be either
  57  *      the start or end of the displayed data set. This allows "previous"
  58  *      links to be implemented without knowledge of the index value at the
  59  *      start of the previous page.
  60  *    * An additional row beyond the user-specified limit is always requested.
  61  *      This allows us to tell whether we should display a "next" link in the
  62  *      case of forwards mode, or a "previous" link in the case of backwards
  63  *      mode. Determining whether to display the other link (the one for the
  64  *      page before the start of the database result set) can be done
  65  *      heuristically by examining the offset.
  66  *
  67  *    * An empty offset indicates that the offset condition should be omitted
  68  *      from the query. This naturally produces either the first page or the
  69  *      last page depending on the dir parameter.
  70  *
  71  *  Subclassing the pager to implement concrete functionality should be fairly
  72  *  simple, please see the examples in HistoryPage.php and
  73  *  SpecialBlockList.php. You just need to override formatRow(),
  74  *  getQueryInfo() and getIndexField(). Don't forget to call the parent
  75  *  constructor if you override it.
  76  *
  77  * @ingroup Pager
  78  */
  79 abstract class IndexPager extends ContextSource implements Pager {
  80         public $mRequest;
  81         public $mLimitsShown = array( 20, 50, 100, 250, 500 );
  82         public $mDefaultLimit = 50;
  83         public $mOffset, $mLimit;
  84         public $mQueryDone = false;
  85         public $mDb;
  86         public $mPastTheEndRow;
  87
  88         /**
  89          * The index to actually be used for ordering. This is a single column,
  90          * for one ordering, even if multiple orderings are supported.
  91          */
  92         protected $mIndexField;
  93         /**
  94          * An array of secondary columns to order by. These fields are not part of the offset.
  95          * This is a column list for one ordering, even if multiple orderings are supported.
  96          */
  97         protected $mExtraSortFields;
  98         /** For pages that support multiple types of ordering, which one to use.
  99          */
 100         protected $mOrderType;
 101         /**
 102          * $mDefaultDirection gives the direction to use when sorting results:
 103          * false for ascending, true for descending.  If $mIsBackwards is set, we
 104          * start from the opposite end, but we still sort the page itself according
 105          * to $mDefaultDirection.  E.g., if $mDefaultDirection is false but we're
 106          * going backwards, we'll display the last page of results, but the last
 107          * result will be at the bottom, not the top.
 108          *
 109          * Like $mIndexField, $mDefaultDirection will be a single value even if the
 110          * class supports multiple default directions for different order types.
 111          */
 112         public $mDefaultDirection;
 113         public $mIsBackwards;
 114
 115         /** True if the current result set is the first one */
 116         public $mIsFirst;
 117         public $mIsLast;
 118
 119         protected $mLastShown, $mFirstShown, $mPastTheEndIndex, $mDefaultQuery, $mNavigationBar;
 120
 121         /**
 122          * Whether to include the offset in the query
 123          */
 124         protected $mIncludeOffset = false;
 125
 126         /**
 127          * Result object for the query. Warning: seek before use.
 128          *
 129          * @var ResultWrapper
 130          */
 131         public $mResult;
 132
 133         public function __construct( IContextSource $context = null ) {
 134                 if ( $context ) {
 135                         $this->setContext( $context );
 136                 }
 137
 138                 $this->mRequest = $this->getRequest();
 139
 140                 # NB: the offset is quoted, not validated. It is treated as an
 141                 # arbitrary string to support the widest variety of index types. Be
 142                 # careful outputting it into HTML!
 143                 $this->mOffset = $this->mRequest->getText( 'offset' );
 144
 145                 # Use consistent behavior for the limit options
 146                 $this->mDefaultLimit = intval( $this->getUser()->getOption( 'rclimit' ) );
 147                 if ( !$this->mLimit ) {
 148                         // Don't override if a subclass calls $this->setLimit() in its constructor.
 149                         list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset();
 150                 }
 151
 152                 $this->mIsBackwards = ( $this->mRequest->getVal( 'dir' ) == 'prev' );
 153                 $this->mDb = wfGetDB( DB_SLAVE );
 154
 155                 $index = $this->getIndexField(); // column to sort on
 156                 $extraSort = $this->getExtraSortFields(); // extra columns to sort on for query planning
 157                 $order = $this->mRequest->getVal( 'order' );
 158                 if( is_array( $index ) && isset( $index[$order] ) ) {
 159                         $this->mOrderType = $order;
 160                         $this->mIndexField = $index[$order];
 161                         $this->mExtraSortFields = isset( $extraSort[$order] )
 162                                 ? (array)$extraSort[$order]
 163                                 : array();
 164                 } elseif( is_array( $index ) ) {
 165                         # First element is the default
 166                         reset( $index );
 167                         list( $this->mOrderType, $this->mIndexField ) = each( $index );
 168                         $this->mExtraSortFields = isset( $extraSort[$this->mOrderType] )
 169                                 ? (array)$extraSort[$this->mOrderType]
 170                                 : array();
 171                 } else {
 172                         # $index is not an array
 173                         $this->mOrderType = null;
 174                         $this->mIndexField = $index;
 175                         $this->mExtraSortFields = (array)$extraSort;
 176                 }
 177
 178                 if( !isset( $this->mDefaultDirection ) ) {
 179                         $dir = $this->getDefaultDirections();
 180                         $this->mDefaultDirection = is_array( $dir )
 181                                 ? $dir[$this->mOrderType]
 182                                 : $dir;
 183                 }
 184         }
 185
 186         /**
 187          * Get the Database object in use
 188          *
 189          * @return DatabaseBase
 190          */
 191         public function getDatabase() {
 192                 return $this->mDb;
 193         }
 194
 195         /**
 196          * Do the query, using information from the object context. This function
 197          * has been kept minimal to make it overridable if necessary, to allow for
 198          * result sets formed from multiple DB queries.
 199          */
 200         public function doQuery() {
 201                 # Use the child class name for profiling
 202                 $fname = __METHOD__ . ' (' . get_class( $this ) . ')';
 203                 wfProfileIn( $fname );
 204
 205                 $descending = ( $this->mIsBackwards == $this->mDefaultDirection );
 206                 # Plus an extra row so that we can tell the "next" link should be shown
 207                 $queryLimit = $this->mLimit + 1;
 208
 209                 $this->mResult = $this->reallyDoQuery(
 210                         $this->mOffset,
 211                         $queryLimit,
 212                         $descending
 213                 );
 214
 215                 $this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult );
 216                 $this->mQueryDone = true;
 217
 218                 $this->preprocessResults( $this->mResult );
 219                 $this->mResult->rewind(); // Paranoia
 220
 221                 wfProfileOut( $fname );
 222         }
 223
 224         /**
 225          * @return ResultWrapper The result wrapper.
 226          */
 227         function getResult() {
 228                 return $this->mResult;
 229         }
 230
 231         /**
 232          * Set the offset from an other source than the request
 233          *
 234          * @param $offset Int|String
 235          */
 236         function setOffset( $offset ) {
 237                 $this->mOffset = $offset;
 238         }
 239         /**
 240          * Set the limit from an other source than the request
 241          *
 242          * Verifies limit is between 1 and 5000
 243          *
 244          * @param $limit Int|String
 245          */
 246         function setLimit( $limit ) {
 247                 $limit = (int) $limit;
 248                 // WebRequest::getLimitOffset() puts a cap of 5000, so do same here.
 249                 if ( $limit > 5000 ) {
 250                         $limit = 5000;
 251                 }
 252                 if ( $limit > 0 ) {
 253                         $this->mLimit = $limit;
 254                 }
 255         }
 256
 257         /**
 258          * Set whether a row matching exactly the offset should be also included
 259          * in the result or not. By default this is not the case, but when the
 260          * offset is user-supplied this might be wanted.
 261          *
 262          * @param $include bool
 263          */
 264         public function setIncludeOffset( $include ) {
 265                 $this->mIncludeOffset = $include;
 266         }
 267
 268         /**
 269          * Extract some useful data from the result object for use by
 270          * the navigation bar, put it into $this
 271          *
 272          * @param $offset String: index offset, inclusive
 273          * @param $limit Integer: exact query limit
 274          * @param $res ResultWrapper
 275          */
 276         function extractResultInfo( $offset, $limit, ResultWrapper $res ) {
 277                 $numRows = $res->numRows();
 278                 if ( $numRows ) {
 279                         # Remove any table prefix from index field
 280                         $parts = explode( '.', $this->mIndexField );
 281                         $indexColumn = end( $parts );
 282
 283                         $row = $res->fetchRow();
 284                         $firstIndex = $row[$indexColumn];
 285
 286                         # Discard the extra result row if there is one
 287                         if ( $numRows > $this->mLimit && $numRows > 1 ) {
 288                                 $res->seek( $numRows - 1 );
 289                                 $this->mPastTheEndRow = $res->fetchObject();
 290                                 $this->mPastTheEndIndex = $this->mPastTheEndRow->$indexColumn;
 291                                 $res->seek( $numRows - 2 );
 292                                 $row = $res->fetchRow();
 293                                 $lastIndex = $row[$indexColumn];
 294                         } else {
 295                                 $this->mPastTheEndRow = null;
 296                                 # Setting indexes to an empty string means that they will be
 297                                 # omitted if they would otherwise appear in URLs. It just so
 298                                 # happens that this  is the right thing to do in the standard
 299                                 # UI, in all the relevant cases.
 300                                 $this->mPastTheEndIndex = '';
 301                                 $res->seek( $numRows - 1 );
 302                                 $row = $res->fetchRow();
 303                                 $lastIndex = $row[$indexColumn];
 304                         }
 305                 } else {
 306                         $firstIndex = '';
 307                         $lastIndex = '';
 308                         $this->mPastTheEndRow = null;
 309                         $this->mPastTheEndIndex = '';
 310                 }
 311
 312                 if ( $this->mIsBackwards ) {
 313                         $this->mIsFirst = ( $numRows < $limit );
 314                         $this->mIsLast = ( $offset == '' );
 315                         $this->mLastShown = $firstIndex;
 316                         $this->mFirstShown = $lastIndex;
 317                 } else {
 318                         $this->mIsFirst = ( $offset == '' );
 319                         $this->mIsLast = ( $numRows < $limit );
 320                         $this->mLastShown = $lastIndex;
 321                         $this->mFirstShown = $firstIndex;
 322                 }
 323         }
 324
 325         /**
 326          * Get some text to go in brackets in the "function name" part of the SQL comment
 327          *
 328          * @return String
 329          */
 330         function getSqlComment() {
 331                 return get_class( $this );
 332         }
 333
 334         /**
 335          * Do a query with specified parameters, rather than using the object
 336          * context
 337          *
 338          * @param $offset String: index offset, inclusive
 339          * @param $limit Integer: exact query limit
 340          * @param $descending Boolean: query direction, false for ascending, true for descending
 341          * @return ResultWrapper
 342          */
 343         public function reallyDoQuery( $offset, $limit, $descending ) {
 344                 list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo( $offset, $limit, $descending );
 345                 return $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
 346         }
 347
 348         /**
 349          * Build variables to use by the database wrapper.
 350          *
 351          * @param $offset String: index offset, inclusive
 352          * @param $limit Integer: exact query limit
 353          * @param $descending Boolean: query direction, false for ascending, true for descending
 354          * @return array
 355          */
 356         protected function buildQueryInfo( $offset, $limit, $descending ) {
 357                 $fname = __METHOD__ . ' (' . $this->getSqlComment() . ')';
 358                 $info = $this->getQueryInfo();
 359                 $tables = $info['tables'];
 360                 $fields = $info['fields'];
 361                 $conds = isset( $info['conds'] ) ? $info['conds'] : array();
 362                 $options = isset( $info['options'] ) ? $info['options'] : array();
 363                 $join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array();
 364                 $sortColumns = array_merge( array( $this->mIndexField ), $this->mExtraSortFields );
 365                 if ( $descending ) {
 366                         $options['ORDER BY'] = $sortColumns;
 367                         $operator = $this->mIncludeOffset ? '>=' : '>';
 368                 } else {
 369                         $orderBy = array();
 370                         foreach ( $sortColumns as $col ) {
 371                                 $orderBy[] = $col . ' DESC';
 372                         }
 373                         $options['ORDER BY'] = $orderBy;
 374                         $operator = $this->mIncludeOffset ? '<=' : '<';
 375                 }
 376                 if ( $offset != '' ) {
 377                         $conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset );
 378                 }
 379                 $options['LIMIT'] = intval( $limit );
 380                 return array( $tables, $fields, $conds, $fname, $options, $join_conds );
 381         }
 382
 383         /**
 384          * Pre-process results; useful for performing batch existence checks, etc.
 385          *
 386          * @param $result ResultWrapper
 387          */
 388         protected function preprocessResults( $result ) {}
 389
 390         /**
 391          * Get the formatted result list. Calls getStartBody(), formatRow() and
 392          * getEndBody(), concatenates the results and returns them.
 393          *
 394          * @return String
 395          */
 396         public function getBody() {
 397                 if ( !$this->mQueryDone ) {
 398                         $this->doQuery();
 399                 }
 400
 401                 if ( $this->mResult->numRows() ) {
 402                         # Do any special query batches before display
 403                         $this->doBatchLookups();
 404                 }
 405
 406                 # Don't use any extra rows returned by the query
 407                 $numRows = min( $this->mResult->numRows(), $this->mLimit );
 408
 409                 $s = $this->getStartBody();
 410                 if ( $numRows ) {
 411                         if ( $this->mIsBackwards ) {
 412                                 for ( $i = $numRows - 1; $i >= 0; $i-- ) {
 413                                         $this->mResult->seek( $i );
 414                                         $row = $this->mResult->fetchObject();
 415                                         $s .= $this->formatRow( $row );
 416                                 }
 417                         } else {
 418                                 $this->mResult->seek( 0 );
 419                                 for ( $i = 0; $i < $numRows; $i++ ) {
 420                                         $row = $this->mResult->fetchObject();
 421                                         $s .= $this->formatRow( $row );
 422                                 }
 423                         }
 424                 } else {
 425                         $s .= $this->getEmptyBody();
 426                 }
 427                 $s .= $this->getEndBody();
 428                 return $s;
 429         }
 430
 431         /**
 432          * Make a self-link
 433          *
 434          * @param $text String: text displayed on the link
 435          * @param $query Array: associative array of paramter to be in the query string
 436          * @param $type String: value of the "rel" attribute
 437          *
 438          * @return String: HTML fragment
 439          */
 440         function makeLink( $text, array $query = null, $type = null ) {
 441                 if ( $query === null ) {
 442                         return $text;
 443                 }
 444
 445                 $attrs = array();
 446                 if( in_array( $type, array( 'first', 'prev', 'next', 'last' ) ) ) {
 447                         # HTML5 rel attributes
 448                         $attrs['rel'] = $type;
 449                 }
 450
 451                 if( $type ) {
 452                         $attrs['class'] = "mw-{$type}link";
 453                 }
 454
 455                 return Linker::linkKnown(
 456                         $this->getTitle(),
 457                         $text,
 458                         $attrs,
 459                         $query + $this->getDefaultQuery()
 460                 );
 461         }
 462
 463         /**
 464          * Called from getBody(), before getStartBody() is called and
 465          * after doQuery() was called. This will be called only if there
 466          * are rows in the result set.
 467          *
 468          * @return void
 469          */
 470         protected function doBatchLookups() {}
 471
 472         /**
 473          * Hook into getBody(), allows text to be inserted at the start. This
 474          * will be called even if there are no rows in the result set.
 475          *
 476          * @return String
 477          */
 478         protected function getStartBody() {
 479                 return '';
 480         }
 481
 482         /**
 483          * Hook into getBody() for the end of the list
 484          *
 485          * @return String
 486          */
 487         protected function getEndBody() {
 488                 return '';
 489         }
 490
 491         /**
 492          * Hook into getBody(), for the bit between the start and the
 493          * end when there are no rows
 494          *
 495          * @return String
 496          */
 497         protected function getEmptyBody() {
 498                 return '';
 499         }
 500
 501         /**
 502          * Get an array of query parameters that should be put into self-links.
 503          * By default, all parameters passed in the URL are used, except for a
 504          * short blacklist.
 505          *
 506          * @return array Associative array
 507          */
 508         function getDefaultQuery() {
 509                 if ( !isset( $this->mDefaultQuery ) ) {
 510                         $this->mDefaultQuery = $this->getRequest()->getQueryValues();
 511                         unset( $this->mDefaultQuery['title'] );
 512                         unset( $this->mDefaultQuery['dir'] );
 513                         unset( $this->mDefaultQuery['offset'] );
 514                         unset( $this->mDefaultQuery['limit'] );
 515                         unset( $this->mDefaultQuery['order'] );
 516                         unset( $this->mDefaultQuery['month'] );
 517                         unset( $this->mDefaultQuery['year'] );
 518                 }
 519                 return $this->mDefaultQuery;
 520         }
 521
 522         /**
 523          * Get the number of rows in the result set
 524          *
 525          * @return Integer
 526          */
 527         function getNumRows() {
 528                 if ( !$this->mQueryDone ) {
 529                         $this->doQuery();
 530                 }
 531                 return $this->mResult->numRows();
 532         }
 533
 534         /**
 535          * Get a URL query array for the prev, next, first and last links.
 536          *
 537          * @return Array
 538          */
 539         function getPagingQueries() {
 540                 if ( !$this->mQueryDone ) {
 541                         $this->doQuery();
 542                 }
 543
 544                 # Don't announce the limit everywhere if it's the default
 545                 $urlLimit = $this->mLimit == $this->mDefaultLimit ? null : $this->mLimit;
 546
 547                 if ( $this->mIsFirst ) {
 548                         $prev = false;
 549                         $first = false;
 550                 } else {
 551                         $prev = array(
 552                                 'dir' => 'prev',
 553                                 'offset' => $this->mFirstShown,
 554                                 'limit' => $urlLimit
 555                         );
 556                         $first = array( 'limit' => $urlLimit );
 557                 }
 558                 if ( $this->mIsLast ) {
 559                         $next = false;
 560                         $last = false;
 561                 } else {
 562                         $next = array( 'offset' => $this->mLastShown, 'limit' => $urlLimit );
 563                         $last = array( 'dir' => 'prev', 'limit' => $urlLimit );
 564                 }
 565                 return array(
 566                         'prev' => $prev,
 567                         'next' => $next,
 568                         'first' => $first,
 569                         'last' => $last
 570                 );
 571         }
 572
 573         /**
 574          * Returns whether to show the "navigation bar"
 575          *
 576          * @return Boolean
 577          */
 578         function isNavigationBarShown() {
 579                 if ( !$this->mQueryDone ) {
 580                         $this->doQuery();
 581                 }
 582                 // Hide navigation by default if there is nothing to page
 583                 return !($this->mIsFirst && $this->mIsLast);
 584         }
 585
 586         /**
 587          * Get paging links. If a link is disabled, the item from $disabledTexts
 588          * will be used. If there is no such item, the unlinked text from
 589          * $linkTexts will be used. Both $linkTexts and $disabledTexts are arrays
 590          * of HTML.
 591          *
 592          * @param $linkTexts Array
 593          * @param $disabledTexts Array
 594          * @return Array
 595          */
 596         function getPagingLinks( $linkTexts, $disabledTexts = array() ) {
 597                 $queries = $this->getPagingQueries();
 598                 $links = array();
 599
 600                 foreach ( $queries as $type => $query ) {
 601                         if ( $query !== false ) {
 602                                 $links[$type] = $this->makeLink(
 603                                         $linkTexts[$type],
 604                                         $queries[$type],
 605                                         $type
 606                                 );
 607                         } elseif ( isset( $disabledTexts[$type] ) ) {
 608                                 $links[$type] = $disabledTexts[$type];
 609                         } else {
 610                                 $links[$type] = $linkTexts[$type];
 611                         }
 612                 }
 613
 614                 return $links;
 615         }
 616
 617         function getLimitLinks() {
 618                 $links = array();
 619                 if ( $this->mIsBackwards ) {
 620                         $offset = $this->mPastTheEndIndex;
 621                 } else {
 622                         $offset = $this->mOffset;
 623                 }
 624                 foreach ( $this->mLimitsShown as $limit ) {
 625                         $links[] = $this->makeLink(
 626                                 $this->getLanguage()->formatNum( $limit ),
 627                                 array( 'offset' => $offset, 'limit' => $limit ),
 628                                 'num'
 629                         );
 630                 }
 631                 return $links;
 632         }
 633
 634         /**
 635          * Abstract formatting function. This should return an HTML string
 636          * representing the result row $row. Rows will be concatenated and
 637          * returned by getBody()
 638          *
 639          * @param $row Object: database row
 640          * @return String
 641          */
 642         abstract function formatRow( $row );
 643
 644         /**
 645          * This function should be overridden to provide all parameters
 646          * needed for the main paged query. It returns an associative
 647          * array with the following elements:
 648          *    tables => Table(s) for passing to Database::select()
 649          *    fields => Field(s) for passing to Database::select(), may be *
 650          *    conds => WHERE conditions
 651          *    options => option array
 652          *    join_conds => JOIN conditions
 653          *
 654          * @return Array
 655          */
 656         abstract function getQueryInfo();
 657
 658         /**
 659          * This function should be overridden to return the name of the index fi-
 660          * eld.  If the pager supports multiple orders, it may return an array of
 661          * 'querykey' => 'indexfield' pairs, so that a request with &count=querykey
 662          * will use indexfield to sort.  In this case, the first returned key is
 663          * the default.
 664          *
 665          * Needless to say, it's really not a good idea to use a non-unique index
 666          * for this!  That won't page right.
 667          *
 668          * @return string|Array
 669          */
 670         abstract function getIndexField();
 671
 672         /**
 673          * This function should be overridden to return the names of secondary columns
 674          * to order by in addition to the column in getIndexField(). These fields will
 675          * not be used in the pager offset or in any links for users.
 676          *
 677          * If getIndexField() returns an array of 'querykey' => 'indexfield' pairs then
 678          * this must return a corresponding array of 'querykey' => array( fields...) pairs
 679          * in order for a request with &count=querykey to use array( fields...) to sort.
 680          *
 681          * This is useful for pagers that GROUP BY a unique column (say page_id)
 682          * and ORDER BY another (say page_len). Using GROUP BY and ORDER BY both on
 683          * page_len,page_id avoids temp tables (given a page_len index). This would
 684          * also work if page_id was non-unique but we had a page_len,page_id index.
 685          *
 686          * @return Array
 687          */
 688         protected function getExtraSortFields() { return array(); }
 689
 690         /**
 691          * Return the default sorting direction: false for ascending, true for de-
 692          * scending.  You can also have an associative array of ordertype => dir,
 693          * if multiple order types are supported.  In this case getIndexField()
 694          * must return an array, and the keys of that must exactly match the keys
 695          * of this.
 696          *
 697          * For backward compatibility, this method's return value will be ignored
 698          * if $this->mDefaultDirection is already set when the constructor is
 699          * called, for instance if it's statically initialized.  In that case the
 700          * value of that variable (which must be a boolean) will be used.
 701          *
 702          * Note that despite its name, this does not return the value of the
 703          * $this->mDefaultDirection member variable.  That's the default for this
 704          * particular instantiation, which is a single value.  This is the set of
 705          * all defaults for the class.
 706          *
 707          * @return Boolean
 708          */
 709         protected function getDefaultDirections() { return false; }
 710 }
 711
 712
 713 /**
 714  * IndexPager with an alphabetic list and a formatted navigation bar
 715  * @ingroup Pager
 716  */
 717 abstract class AlphabeticPager extends IndexPager {
 718
 719         /**
 720          * Shamelessly stolen bits from ReverseChronologicalPager,
 721          * didn't want to do class magic as may be still revamped
 722          *
 723          * @return String HTML
 724          */
 725         function getNavigationBar() {
 726                 if ( !$this->isNavigationBarShown() ) {
 727                         return '';
 728                 }
 729
 730                 if( isset( $this->mNavigationBar ) ) {
 731                         return $this->mNavigationBar;
 732                 }
 733
 734                 $linkTexts = array(
 735                         'prev' => $this->msg( 'prevn' )->numParams( $this->mLimit )->escaped(),
 736                         'next' => $this->msg( 'nextn' )->numParams( $this->mLimit )->escaped(),
 737                         'first' => $this->msg( 'page_first' )->escaped(),
 738                         'last' => $this->msg( 'page_last' )->escaped()
 739                 );
 740
 741                 $lang = $this->getLanguage();
 742
 743                 $pagingLinks = $this->getPagingLinks( $linkTexts );
 744                 $limitLinks = $this->getLimitLinks();
 745                 $limits = $lang->pipeList( $limitLinks );
 746
 747                 $this->mNavigationBar = $this->msg( 'parentheses' )->rawParams(
 748                         $lang->pipeList( array( $pagingLinks['first'],
 749                         $pagingLinks['last'] ) ) )->escaped() . " " .
 750                         $this->msg( 'viewprevnext' )->rawParams( $pagingLinks['prev'],
 751                                 $pagingLinks['next'], $limits )->escaped();
 752
 753                 if( !is_array( $this->getIndexField() ) ) {
 754                         # Early return to avoid undue nesting
 755                         return $this->mNavigationBar;
 756                 }
 757
 758                 $extra = '';
 759                 $first = true;
 760                 $msgs = $this->getOrderTypeMessages();
 761                 foreach( array_keys( $msgs ) as $order ) {
 762                         if( $first ) {
 763                                 $first = false;
 764                         } else {
 765                                 $extra .= $this->msg( 'pipe-separator' )->escaped();
 766                         }
 767
 768                         if( $order == $this->mOrderType ) {
 769                                 $extra .= $this->msg( $msgs[$order] )->escaped();
 770                         } else {
 771                                 $extra .= $this->makeLink(
 772                                         $this->msg( $msgs[$order] )->escaped(),
 773                                         array( 'order' => $order )
 774                                 );
 775                         }
 776                 }
 777
 778                 if( $extra !== '' ) {
 779                         $extra = ' ' . $this->msg( 'parentheses' )->rawParams( $extra )->escaped();
 780                         $this->mNavigationBar .= $extra;
 781                 }
 782
 783                 return $this->mNavigationBar;
 784         }
 785
 786         /**
 787          * If this supports multiple order type messages, give the message key for
 788          * enabling each one in getNavigationBar.  The return type is an associa-
 789          * tive array whose keys must exactly match the keys of the array returned
 790          * by getIndexField(), and whose values are message keys.
 791          *
 792          * @return Array
 793          */
 794         protected function getOrderTypeMessages() {
 795                 return null;
 796         }
 797 }
 798
 799 /**
 800  * IndexPager with a formatted navigation bar
 801  * @ingroup Pager
 802  */
 803 abstract class ReverseChronologicalPager extends IndexPager {
 804         public $mDefaultDirection = true;
 805         public $mYear;
 806         public $mMonth;
 807
 808         function getNavigationBar() {
 809                 if ( !$this->isNavigationBarShown() ) {
 810                         return '';
 811                 }
 812
 813                 if ( isset( $this->mNavigationBar ) ) {
 814                         return $this->mNavigationBar;
 815                 }
 816
 817                 $linkTexts = array(
 818                         'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(),
 819                         'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(),
 820                         'first' => $this->msg( 'histlast' )->escaped(),
 821                         'last' => $this->msg( 'histfirst' )->escaped()
 822                 );
 823
 824                 $pagingLinks = $this->getPagingLinks( $linkTexts );
 825                 $limitLinks = $this->getLimitLinks();
 826                 $limits = $this->getLanguage()->pipeList( $limitLinks );
 827                 $firstLastLinks = $this->msg( 'parentheses' )->rawParams( "{$pagingLinks['first']}" .
 828                         $this->msg( 'pipe-separator' )->escaped() .
 829                         "{$pagingLinks['last']}" )->escaped();
 830
 831                 $this->mNavigationBar = $firstLastLinks . ' ' .
 832                         $this->msg( 'viewprevnext' )->rawParams(
 833                                 $pagingLinks['prev'], $pagingLinks['next'], $limits )->escaped();
 834
 835                 return $this->mNavigationBar;
 836         }
 837
 838         function getDateCond( $year, $month ) {
 839                 $year = intval( $year );
 840                 $month = intval( $month );
 841
 842                 // Basic validity checks
 843                 $this->mYear = $year > 0 ? $year : false;
 844                 $this->mMonth = ( $month > 0 && $month < 13 ) ? $month : false;
 845
 846                 // Given an optional year and month, we need to generate a timestamp
 847                 // to use as "WHERE rev_timestamp <= result"
 848                 // Examples: year = 2006 equals < 20070101 (+000000)
 849                 // year=2005, month=1    equals < 20050201
 850                 // year=2005, month=12   equals < 20060101
 851                 if ( !$this->mYear && !$this->mMonth ) {
 852                         return;
 853                 }
 854
 855                 if ( $this->mYear ) {
 856                         $year = $this->mYear;
 857                 } else {
 858                         // If no year given, assume the current one
 859                         $year = gmdate( 'Y' );
 860                         // If this month hasn't happened yet this year, go back to last year's month
 861                         if( $this->mMonth > gmdate( 'n' ) ) {
 862                                 $year--;
 863                         }
 864                 }
 865
 866                 if ( $this->mMonth ) {
 867                         $month = $this->mMonth + 1;
 868                         // For December, we want January 1 of the next year
 869                         if ($month > 12) {
 870                                 $month = 1;
 871                                 $year++;
 872                         }
 873                 } else {
 874                         // No month implies we want up to the end of the year in question
 875                         $month = 1;
 876                         $year++;
 877                 }
 878
 879                 // Y2K38 bug
 880                 if ( $year > 2032 ) {
 881                         $year = 2032;
 882                 }
 883
 884                 $ymd = (int)sprintf( "%04d%02d01", $year, $month );
 885
 886                 if ( $ymd > 20320101 ) {
 887                         $ymd = 20320101;
 888                 }
 889
 890                 $this->mOffset = $this->mDb->timestamp( "${ymd}000000" );
 891         }
 892 }
 893
 894 /**
 895  * Table-based display with a user-selectable sort order
 896  * @ingroup Pager
 897  */
 898 abstract class TablePager extends IndexPager {
 899         var $mSort;
 900         var $mCurrentRow;
 901
 902         public function __construct( IContextSource $context = null ) {
 903                 if ( $context ) {
 904                         $this->setContext( $context );
 905                 }
 906
 907                 $this->mSort = $this->getRequest()->getText( 'sort' );
 908                 if ( !array_key_exists( $this->mSort, $this->getFieldNames() ) ) {
 909                         $this->mSort = $this->getDefaultSort();
 910                 }
 911                 if ( $this->getRequest()->getBool( 'asc' ) ) {
 912                         $this->mDefaultDirection = false;
 913                 } elseif ( $this->getRequest()->getBool( 'desc' ) ) {
 914                         $this->mDefaultDirection = true;
 915                 } /* Else leave it at whatever the class default is */
 916
 917                 parent::__construct();
 918         }
 919
 920         /**
 921          * @protected
 922          * @return string
 923          */
 924         function getStartBody() {
 925                 global $wgStylePath;
 926                 $tableClass = htmlspecialchars( $this->getTableClass() );
 927                 $sortClass = htmlspecialchars( $this->getSortHeaderClass() );
 928
 929                 $s = "<table style='border:1px;' class=\"mw-datatable $tableClass\"><thead><tr>\n";
 930                 $fields = $this->getFieldNames();
 931
 932                 # Make table header
 933                 foreach ( $fields as $field => $name ) {
 934                         if ( strval( $name ) == '' ) {
 935                                 $s .= "<th>&#160;</th>\n";
 936                         } elseif ( $this->isFieldSortable( $field ) ) {
 937                                 $query = array( 'sort' => $field, 'limit' => $this->mLimit );
 938                                 if ( $field == $this->mSort ) {
 939                                         # This is the sorted column
 940                                         # Prepare a link that goes in the other sort order
 941                                         if ( $this->mDefaultDirection ) {
 942                                                 # Descending
 943                                                 $image = 'Arr_d.png';
 944                                                 $query['asc'] = '1';
 945                                                 $query['desc'] = '';
 946                                                 $alt = $this->msg( 'descending_abbrev' )->escaped();
 947                                         } else {
 948                                                 # Ascending
 949                                                 $image = 'Arr_u.png';
 950                                                 $query['asc'] = '';
 951                                                 $query['desc'] = '1';
 952                                                 $alt = $this->msg( 'ascending_abbrev' )->escaped();
 953                                         }
 954                                         $image = htmlspecialchars( "$wgStylePath/common/images/$image" );
 955                                         $link = $this->makeLink(
 956                                                 "<img width=\"12\" height=\"12\" alt=\"$alt\" src=\"$image\" />" .
 957                                                         htmlspecialchars( $name ), $query );
 958                                         $s .= "<th class=\"$sortClass\">$link</th>\n";
 959                                 } else {
 960                                         $s .= '<th>' . $this->makeLink( htmlspecialchars( $name ), $query ) . "</th>\n";
 961                                 }
 962                         } else {
 963                                 $s .= '<th>' . htmlspecialchars( $name ) . "</th>\n";
 964                         }
 965                 }
 966                 $s .= "</tr></thead><tbody>\n";
 967                 return $s;
 968         }
 969
 970         /**
 971          * @protected
 972          * @return string
 973          */
 974         function getEndBody() {
 975                 return "</tbody></table>\n";
 976         }
 977
 978         /**
 979          * @protected
 980          * @return string
 981          */
 982         function getEmptyBody() {
 983                 $colspan = count( $this->getFieldNames() );
 984                 $msgEmpty = $this->msg( 'table_pager_empty' )->escaped();
 985                 return "<tr><td colspan=\"$colspan\">$msgEmpty</td></tr>\n";
 986         }
 987
 988         /**
 989          * @protected
 990          * @param stdClass $row
 991          * @return String HTML
 992          */
 993         function formatRow( $row ) {
 994                 $this->mCurrentRow = $row; // In case formatValue etc need to know
 995                 $s = Xml::openElement( 'tr', $this->getRowAttrs( $row ) );
 996                 $fieldNames = $this->getFieldNames();
 997
 998                 foreach ( $fieldNames as $field => $name ) {
 999                         $value = isset( $row->$field ) ? $row->$field : null;
1000                         $formatted = strval( $this->formatValue( $field, $value ) );
1001
1002                         if ( $formatted == '' ) {
1003                                 $formatted = '&#160;';
1004                         }
1005
1006                         $s .= Xml::tags( 'td', $this->getCellAttrs( $field, $value ), $formatted );
1007                 }
1008
1009                 $s .= "</tr>\n";
1010
1011                 return $s;
1012         }
1013
1014         /**
1015          * Get a class name to be applied to the given row.
1016          *
1017          * @protected
1018          *
1019          * @param $row Object: the database result row
1020          * @return String
1021          */
1022         function getRowClass( $row ) {
1023                 return '';
1024         }
1025
1026         /**
1027          * Get attributes to be applied to the given row.
1028          *
1029          * @protected
1030          *
1031          * @param $row Object: the database result row
1032          * @return Array of attribute => value
1033          */
1034         function getRowAttrs( $row ) {
1035                 $class = $this->getRowClass( $row );
1036                 if ( $class === '' ) {
1037                         // Return an empty array to avoid clutter in HTML like class=""
1038                         return array();
1039                 } else {
1040                         return array( 'class' => $this->getRowClass( $row ) );
1041                 }
1042         }
1043
1044         /**
1045          * Get any extra attributes to be applied to the given cell. Don't
1046          * take this as an excuse to hardcode styles; use classes and
1047          * CSS instead.  Row context is available in $this->mCurrentRow
1048          *
1049          * @protected
1050          *
1051          * @param $field String The column
1052          * @param $value String The cell contents
1053          * @return Array of attr => value
1054          */
1055         function getCellAttrs( $field, $value ) {
1056                 return array( 'class' => 'TablePager_col_' . $field );
1057         }
1058
1059         /**
1060          * @protected
1061          * @return string
1062          */
1063         function getIndexField() {
1064                 return $this->mSort;
1065         }
1066
1067         /**
1068          * @protected
1069          * @return string
1070          */
1071         function getTableClass() {
1072                 return 'TablePager';
1073         }
1074
1075         /**
1076          * @protected
1077          * @return string
1078          */
1079         function getNavClass() {
1080                 return 'TablePager_nav';
1081         }
1082
1083         /**
1084          * @protected
1085          * @return string
1086          */
1087         function getSortHeaderClass() {
1088                 return 'TablePager_sort';
1089         }
1090
1091         /**
1092          * A navigation bar with images
1093          * @return String HTML
1094          */
1095         public function getNavigationBar() {
1096                 global $wgStylePath;
1097
1098                 if ( !$this->isNavigationBarShown() ) {
1099                         return '';
1100                 }
1101
1102                 $path = "$wgStylePath/common/images";
1103                 $labels = array(
1104                         'first' => 'table_pager_first',
1105                         'prev' => 'table_pager_prev',
1106                         'next' => 'table_pager_next',
1107                         'last' => 'table_pager_last',
1108                 );
1109                 $images = array(
1110                         'first' => 'arrow_first_25.png',
1111                         'prev' => 'arrow_left_25.png',
1112                         'next' => 'arrow_right_25.png',
1113                         'last' => 'arrow_last_25.png',
1114                 );
1115                 $disabledImages = array(
1116                         'first' => 'arrow_disabled_first_25.png',
1117                         'prev' => 'arrow_disabled_left_25.png',
1118                         'next' => 'arrow_disabled_right_25.png',
1119                         'last' => 'arrow_disabled_last_25.png',
1120                 );
1121                 if( $this->getLanguage()->isRTL() ) {
1122                         $keys = array_keys( $labels );
1123                         $images = array_combine( $keys, array_reverse( $images ) );
1124                         $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) );
1125                 }
1126
1127                 $linkTexts = array();
1128                 $disabledTexts = array();
1129                 foreach ( $labels as $type => $label ) {
1130                         $msgLabel = $this->msg( $label )->escaped();
1131                         $linkTexts[$type] = "<img src=\"$path/{$images[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
1132                         $disabledTexts[$type] = "<img src=\"$path/{$disabledImages[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
1133                 }
1134                 $links = $this->getPagingLinks( $linkTexts, $disabledTexts );
1135
1136                 $navClass = htmlspecialchars( $this->getNavClass() );
1137                 $s = "<table class=\"$navClass\"><tr>\n";
1138                 $width = 100 / count( $links ) . '%';
1139                 foreach ( $labels as $type => $label ) {
1140                         $s .= "<td style='width:$width;'>{$links[$type]}</td>\n";
1141                 }
1142                 $s .= "</tr></table>\n";
1143                 return $s;
1144         }
1145
1146         /**
1147          * Get a "<select>" element which has options for each of the allowed limits
1148          *
1149          * @return String: HTML fragment
1150          */
1151         public function getLimitSelect() {
1152                 # Add the current limit from the query string
1153                 # to avoid that the limit is lost after clicking Go next time
1154                 if ( !in_array( $this->mLimit, $this->mLimitsShown ) ) {
1155                         $this->mLimitsShown[] = $this->mLimit;
1156                         sort( $this->mLimitsShown );
1157                 }
1158                 $s = Html::openElement( 'select', array( 'name' => 'limit' ) ) . "\n";
1159                 foreach ( $this->mLimitsShown as $key => $value ) {
1160                         # The pair is either $index => $limit, in which case the $value
1161                         # will be numeric, or $limit => $text, in which case the $value
1162                         # will be a string.
1163                         if( is_int( $value ) ){
1164                                 $limit = $value;
1165                                 $text = $this->getLanguage()->formatNum( $limit );
1166                         } else {
1167                                 $limit = $key;
1168                                 $text = $value;
1169                         }
1170                         $s .= Xml::option( $text, $limit, $limit == $this->mLimit ) . "\n";
1171                 }
1172                 $s .= Html::closeElement( 'select' );
1173                 return $s;
1174         }
1175
1176         /**
1177          * Get \<input type="hidden"\> elements for use in a method="get" form.
1178          * Resubmits all defined elements of the query string, except for a
1179          * blacklist, passed in the $blacklist parameter.
1180          *
1181          * @param $blacklist Array parameters from the request query which should not be resubmitted
1182          * @return String: HTML fragment
1183          */
1184         function getHiddenFields( $blacklist = array() ) {
1185                 $blacklist = (array)$blacklist;
1186                 $query = $this->getRequest()->getQueryValues();
1187                 foreach ( $blacklist as $name ) {
1188                         unset( $query[$name] );
1189                 }
1190                 $s = '';
1191                 foreach ( $query as $name => $value ) {
1192                         $encName = htmlspecialchars( $name );
1193                         $encValue = htmlspecialchars( $value );
1194                         $s .= "<input type=\"hidden\" name=\"$encName\" value=\"$encValue\"/>\n";
1195                 }
1196                 return $s;
1197         }
1198
1199         /**
1200          * Get a form containing a limit selection dropdown
1201          *
1202          * @return String: HTML fragment
1203          */
1204         function getLimitForm() {
1205                 global $wgScript;
1206
1207                 return Xml::openElement(
1208                         'form',
1209                         array(
1210                                 'method' => 'get',
1211                                 'action' => $wgScript
1212                         ) ) . "\n" . $this->getLimitDropdown() . "</form>\n";
1213         }
1214
1215         /**
1216          * Gets a limit selection dropdown
1217          *
1218          * @return string
1219          */
1220         function getLimitDropdown() {
1221                 # Make the select with some explanatory text
1222                 $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped();
1223
1224                 return $this->msg( 'table_pager_limit' )
1225                         ->rawParams( $this->getLimitSelect() )->escaped() .
1226                         "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
1227                         $this->getHiddenFields( array( 'limit' ) );
1228         }
1229
1230         /**
1231          * Return true if the named field should be sortable by the UI, false
1232          * otherwise
1233          *
1234          * @param $field String
1235          */
1236         abstract function isFieldSortable( $field );
1237
1238         /**
1239          * Format a table cell. The return value should be HTML, but use an empty
1240          * string not &#160; for empty cells. Do not include the <td> and </td>.
1241          *
1242          * The current result row is available as $this->mCurrentRow, in case you
1243          * need more context.
1244          *
1245          * @protected
1246          *
1247          * @param $name String: the database field name
1248          * @param $value String: the value retrieved from the database
1249          */
1250         abstract function formatValue( $name, $value );
1251
1252         /**
1253          * The database field name used as a default sort order.
1254          *
1255          * @protected
1256          *
1257          * @return string
1258          */
1259         abstract function getDefaultSort();
1260
1261         /**
1262          * An array mapping database field names to a textual description of the
1263          * field name, for use in the table header. The description should be plain
1264          * text, it will be HTML-escaped later.
1265          *
1266          * @return Array
1267          */
1268         abstract function getFieldNames();
1269 }