includes/Pager.php

   1 <?php
   2 /**
   3  * @defgroup Pager Pager
   4  *
   5  * @file
   6  * @ingroup Pager
   7  */
   8
   9 /**
  10  * Basic pager interface.
  11  * @ingroup Pager
  12  */
  13 interface Pager {
  14         function getNavigationBar();
  15         function getBody();
  16 }
  17
  18 /**
  19  * IndexPager is an efficient pager which uses a (roughly unique) index in the
  20  * data set to implement paging, rather than a "LIMIT offset,limit" clause.
  21  * In MySQL, such a limit/offset clause requires counting through the
  22  * specified number of offset rows to find the desired data, which can be
  23  * expensive for large offsets.
  24  *
  25  * ReverseChronologicalPager is a child class of the abstract IndexPager, and
  26  * contains  some formatting and display code which is specific to the use of
  27  * timestamps as  indexes. Here is a synopsis of its operation:
  28  *
  29  *    * The query is specified by the offset, limit and direction (dir)
  30  *      parameters, in addition to any subclass-specific parameters.
  31  *    * The offset is the non-inclusive start of the DB query. A row with an
  32  *      index value equal to the offset will never be shown.
  33  *    * The query may either be done backwards, where the rows are returned by
  34  *      the database in the opposite order to which they are displayed to the
  35  *      user, or forwards. This is specified by the "dir" parameter, dir=prev
  36  *      means backwards, anything else means forwards. The offset value
  37  *      specifies the start of the database result set, which may be either
  38  *      the start or end of the displayed data set. This allows "previous"
  39  *      links to be implemented without knowledge of the index value at the
  40  *      start of the previous page.
  41  *    * An additional row beyond the user-specified limit is always requested.
  42  *      This allows us to tell whether we should display a "next" link in the
  43  *      case of forwards mode, or a "previous" link in the case of backwards
  44  *      mode. Determining whether to display the other link (the one for the
  45  *      page before the start of the database result set) can be done
  46  *      heuristically by examining the offset.
  47  *
  48  *    * An empty offset indicates that the offset condition should be omitted
  49  *      from the query. This naturally produces either the first page or the
  50  *      last page depending on the dir parameter.
  51  *
  52  *  Subclassing the pager to implement concrete functionality should be fairly
  53  *  simple, please see the examples in PageHistory.php and
  54  *  SpecialIpblocklist.php. You just need to override formatRow(),
  55  *  getQueryInfo() and getIndexField(). Don't forget to call the parent
  56  *  constructor if you override it.
  57  *
  58  * @ingroup Pager
  59  */
  60 abstract class IndexPager implements Pager {
  61         public $mRequest;
  62         public $mLimitsShown = array( 20, 50, 100, 250, 500 );
  63         public $mDefaultLimit = 50;
  64         public $mOffset, $mLimit;
  65         public $mQueryDone = false;
  66         public $mDb;
  67         public $mPastTheEndRow;
  68
  69         /**
  70          * The index to actually be used for ordering.  This is a single string e-
  71          * ven if multiple orderings are supported.
  72          */
  73         protected $mIndexField;
  74         /** For pages that support multiple types of ordering, which one to use. */
  75         protected $mOrderType;
  76         /**
  77          * $mDefaultDirection gives the direction to use when sorting results:
  78          * false for ascending, true for descending.  If $mIsBackwards is set, we
  79          * start from the opposite end, but we still sort the page itself according
  80          * to $mDefaultDirection.  E.g., if $mDefaultDirection is false but we're
  81          * going backwards, we'll display the last page of results, but the last
  82          * result will be at the bottom, not the top.
  83          *
  84          * Like $mIndexField, $mDefaultDirection will be a single value even if the
  85          * class supports multiple default directions for different order types.
  86          */
  87         public $mDefaultDirection;
  88         public $mIsBackwards;
  89
  90         /**
  91          * Result object for the query. Warning: seek before use.
  92          */
  93         public $mResult;
  94
  95         public function __construct() {
  96                 global $wgRequest, $wgUser;
  97                 $this->mRequest = $wgRequest;
  98
  99                 # NB: the offset is quoted, not validated. It is treated as an
 100                 # arbitrary string to support the widest variety of index types. Be
 101                 # careful outputting it into HTML!
 102                 $this->mOffset = $this->mRequest->getText( 'offset' );
 103
 104                 # Use consistent behavior for the limit options
 105                 $this->mDefaultLimit = intval( $wgUser->getOption( 'rclimit' ) );
 106                 list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset();
 107
 108                 $this->mIsBackwards = ( $this->mRequest->getVal( 'dir' ) == 'prev' );
 109                 $this->mDb = wfGetDB( DB_SLAVE );
 110
 111                 $index = $this->getIndexField();
 112                 $order = $this->mRequest->getVal( 'order' );
 113                 if( is_array( $index ) && isset( $index[$order] ) ) {
 114                         $this->mOrderType = $order;
 115                         $this->mIndexField = $index[$order];
 116                 } elseif( is_array( $index ) ) {
 117                         # First element is the default
 118                         reset( $index );
 119                         list( $this->mOrderType, $this->mIndexField ) = each( $index );
 120                 } else {
 121                         # $index is not an array
 122                         $this->mOrderType = null;
 123                         $this->mIndexField = $index;
 124                 }
 125
 126                 if( !isset( $this->mDefaultDirection ) ) {
 127                         $dir = $this->getDefaultDirections();
 128                         $this->mDefaultDirection = is_array( $dir )
 129                                 ? $dir[$this->mOrderType]
 130                                 : $dir;
 131                 }
 132         }
 133
 134         /**
 135          * Do the query, using information from the object context. This function
 136          * has been kept minimal to make it overridable if necessary, to allow for
 137          * result sets formed from multiple DB queries.
 138          */
 139         function doQuery() {
 140                 # Use the child class name for profiling
 141                 $fname = __METHOD__ . ' (' . get_class( $this ) . ')';
 142                 wfProfileIn( $fname );
 143
 144                 $descending = ( $this->mIsBackwards == $this->mDefaultDirection );
 145                 # Plus an extra row so that we can tell the "next" link should be shown
 146                 $queryLimit = $this->mLimit + 1;
 147
 148                 $this->mResult = $this->reallyDoQuery( $this->mOffset, $queryLimit, $descending );
 149                 $this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult );
 150                 $this->mQueryDone = true;
 151
 152                 $this->preprocessResults( $this->mResult );
 153                 $this->mResult->rewind(); // Paranoia
 154
 155                 wfProfileOut( $fname );
 156         }
 157
 158         /**
 159          * Return the result wrapper.
 160          */
 161         function getResult() {
 162                 return $this->mResult;
 163         }
 164
 165         /**
 166          * Set the offset from an other source than $wgRequest
 167          */
 168         function setOffset( $offset ) {
 169                 $this->mOffset = $offset;
 170         }
 171         /**
 172          * Set the limit from an other source than $wgRequest
 173          */
 174         function setLimit( $limit ) {
 175                 $this->mLimit = $limit;
 176         }
 177
 178         /**
 179          * Extract some useful data from the result object for use by
 180          * the navigation bar, put it into $this
 181          */
 182         function extractResultInfo( $offset, $limit, ResultWrapper $res ) {
 183                 $numRows = $res->numRows();
 184                 if ( $numRows ) {
 185                         $row = $res->fetchRow();
 186                         $firstIndex = $row[$this->mIndexField];
 187
 188                         # Discard the extra result row if there is one
 189                         if ( $numRows > $this->mLimit && $numRows > 1 ) {
 190                                 $res->seek( $numRows - 1 );
 191                                 $this->mPastTheEndRow = $res->fetchObject();
 192                                 $indexField = $this->mIndexField;
 193                                 $this->mPastTheEndIndex = $this->mPastTheEndRow->$indexField;
 194                                 $res->seek( $numRows - 2 );
 195                                 $row = $res->fetchRow();
 196                                 $lastIndex = $row[$this->mIndexField];
 197                         } else {
 198                                 $this->mPastTheEndRow = null;
 199                                 # Setting indexes to an empty string means that they will be
 200                                 # omitted if they would otherwise appear in URLs. It just so
 201                                 # happens that this  is the right thing to do in the standard
 202                                 # UI, in all the relevant cases.
 203                                 $this->mPastTheEndIndex = '';
 204                                 $res->seek( $numRows - 1 );
 205                                 $row = $res->fetchRow();
 206                                 $lastIndex = $row[$this->mIndexField];
 207                         }
 208                 } else {
 209                         $firstIndex = '';
 210                         $lastIndex = '';
 211                         $this->mPastTheEndRow = null;
 212                         $this->mPastTheEndIndex = '';
 213                 }
 214
 215                 if ( $this->mIsBackwards ) {
 216                         $this->mIsFirst = ( $numRows < $limit );
 217                         $this->mIsLast = ( $offset == '' );
 218                         $this->mLastShown = $firstIndex;
 219                         $this->mFirstShown = $lastIndex;
 220                 } else {
 221                         $this->mIsFirst = ( $offset == '' );
 222                         $this->mIsLast = ( $numRows < $limit );
 223                         $this->mLastShown = $lastIndex;
 224                         $this->mFirstShown = $firstIndex;
 225                 }
 226         }
 227
 228         /**
 229          * Do a query with specified parameters, rather than using the object
 230          * context
 231          *
 232          * @param string $offset Index offset, inclusive
 233          * @param integer $limit Exact query limit
 234          * @param boolean $descending Query direction, false for ascending, true for descending
 235          * @return ResultWrapper
 236          */
 237         function reallyDoQuery( $offset, $limit, $descending ) {
 238                 $fname = __METHOD__ . ' (' . get_class( $this ) . ')';
 239                 $info = $this->getQueryInfo();
 240                 $tables = $info['tables'];
 241                 $fields = $info['fields'];
 242                 $conds = isset( $info['conds'] ) ? $info['conds'] : array();
 243                 $options = isset( $info['options'] ) ? $info['options'] : array();
 244                 $join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array();
 245                 if ( $descending ) {
 246                         $options['ORDER BY'] = $this->mIndexField;
 247                         $operator = '>';
 248                 } else {
 249                         $options['ORDER BY'] = $this->mIndexField . ' DESC';
 250                         $operator = '<';
 251                 }
 252                 if ( $offset != '' ) {
 253                         $conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset );
 254                 }
 255                 $options['LIMIT'] = intval( $limit );
 256                 $res = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
 257                 return new ResultWrapper( $this->mDb, $res );
 258         }
 259
 260         /**
 261          * Pre-process results; useful for performing batch existence checks, etc.
 262          *
 263          * @param ResultWrapper $result Result wrapper
 264          */
 265         protected function preprocessResults( $result ) {}
 266
 267         /**
 268          * Get the formatted result list. Calls getStartBody(), formatRow() and
 269          * getEndBody(), concatenates the results and returns them.
 270          */
 271         function getBody() {
 272                 if ( !$this->mQueryDone ) {
 273                         $this->doQuery();
 274                 }
 275                 # Don't use any extra rows returned by the query
 276                 $numRows = min( $this->mResult->numRows(), $this->mLimit );
 277
 278                 $s = $this->getStartBody();
 279                 if ( $numRows ) {
 280                         if ( $this->mIsBackwards ) {
 281                                 for ( $i = $numRows - 1; $i >= 0; $i-- ) {
 282                                         $this->mResult->seek( $i );
 283                                         $row = $this->mResult->fetchObject();
 284                                         $s .= $this->formatRow( $row );
 285                                 }
 286                         } else {
 287                                 $this->mResult->seek( 0 );
 288                                 for ( $i = 0; $i < $numRows; $i++ ) {
 289                                         $row = $this->mResult->fetchObject();
 290                                         $s .= $this->formatRow( $row );
 291                                 }
 292                         }
 293                 } else {
 294                         $s .= $this->getEmptyBody();
 295                 }
 296                 $s .= $this->getEndBody();
 297                 return $s;
 298         }
 299
 300         /**
 301          * Make a self-link
 302          */
 303         function makeLink($text, $query = null, $type=null) {
 304                 if ( $query === null ) {
 305                         return $text;
 306                 }
 307
 308                 $attrs = array();
 309                 if( in_array( $type, array( 'first', 'prev', 'next', 'last' ) ) ) {
 310                         # HTML5 rel attributes
 311                         $attrs['rel'] = $type;
 312                 }
 313
 314                 if( $type ) {
 315                         $attrs['class'] = "mw-{$type}link";
 316                 }
 317                 return $this->getSkin()->link( $this->getTitle(), $text,
 318                         $attrs, $query + $this->getDefaultQuery(), array('noclasses','known') );
 319         }
 320
 321         /**
 322          * Hook into getBody(), allows text to be inserted at the start. This
 323          * will be called even if there are no rows in the result set.
 324          */
 325         function getStartBody() {
 326                 return '';
 327         }
 328
 329         /**
 330          * Hook into getBody() for the end of the list
 331          */
 332         function getEndBody() {
 333                 return '';
 334         }
 335
 336         /**
 337          * Hook into getBody(), for the bit between the start and the
 338          * end when there are no rows
 339          */
 340         function getEmptyBody() {
 341                 return '';
 342         }
 343
 344         /**
 345          * Title used for self-links. Override this if you want to be able to
 346          * use a title other than $wgTitle
 347          */
 348         function getTitle() {
 349                 return $GLOBALS['wgTitle'];
 350         }
 351
 352         /**
 353          * Get the current skin. This can be overridden if necessary.
 354          */
 355         function getSkin() {
 356                 if ( !isset( $this->mSkin ) ) {
 357                         global $wgUser;
 358                         $this->mSkin = $wgUser->getSkin();
 359                 }
 360                 return $this->mSkin;
 361         }
 362
 363         /**
 364          * Get an array of query parameters that should be put into self-links.
 365          * By default, all parameters passed in the URL are used, except for a
 366          * short blacklist.
 367          */
 368         function getDefaultQuery() {
 369                 if ( !isset( $this->mDefaultQuery ) ) {
 370                         $this->mDefaultQuery = $_GET;
 371                         unset( $this->mDefaultQuery['title'] );
 372                         unset( $this->mDefaultQuery['dir'] );
 373                         unset( $this->mDefaultQuery['offset'] );
 374                         unset( $this->mDefaultQuery['limit'] );
 375                         unset( $this->mDefaultQuery['order'] );
 376                         unset( $this->mDefaultQuery['month'] );
 377                         unset( $this->mDefaultQuery['year'] );
 378                 }
 379                 return $this->mDefaultQuery;
 380         }
 381
 382         /**
 383          * Get the number of rows in the result set
 384          */
 385         function getNumRows() {
 386                 if ( !$this->mQueryDone ) {
 387                         $this->doQuery();
 388                 }
 389                 return $this->mResult->numRows();
 390         }
 391
 392         /**
 393          * Get a URL query array for the prev, next, first and last links.
 394          */
 395         function getPagingQueries() {
 396                 if ( !$this->mQueryDone ) {
 397                         $this->doQuery();
 398                 }
 399
 400                 # Don't announce the limit everywhere if it's the default
 401                 $urlLimit = $this->mLimit == $this->mDefaultLimit ? '' : $this->mLimit;
 402
 403                 if ( $this->mIsFirst ) {
 404                         $prev = false;
 405                         $first = false;
 406                 } else {
 407                         $prev = array( 'dir' => 'prev', 'offset' => $this->mFirstShown, 'limit' => $urlLimit );
 408                         $first = array( 'limit' => $urlLimit );
 409                 }
 410                 if ( $this->mIsLast ) {
 411                         $next = false;
 412                         $last = false;
 413                 } else {
 414                         $next = array( 'offset' => $this->mLastShown, 'limit' => $urlLimit );
 415                         $last = array( 'dir' => 'prev', 'limit' => $urlLimit );
 416                 }
 417                 return array( 'prev' => $prev, 'next' => $next, 'first' => $first, 'last' => $last );
 418         }
 419
 420         /**
 421          * Get paging links. If a link is disabled, the item from $disabledTexts
 422          * will be used. If there is no such item, the unlinked text from
 423          * $linkTexts will be used. Both $linkTexts and $disabledTexts are arrays
 424          * of HTML.
 425          */
 426         function getPagingLinks( $linkTexts, $disabledTexts = array() ) {
 427                 $queries = $this->getPagingQueries();
 428                 $links = array();
 429                 foreach ( $queries as $type => $query ) {
 430                         if ( $query !== false ) {
 431                                 $links[$type] = $this->makeLink( $linkTexts[$type], $queries[$type], $type );
 432                         } elseif ( isset( $disabledTexts[$type] ) ) {
 433                                 $links[$type] = $disabledTexts[$type];
 434                         } else {
 435                                 $links[$type] = $linkTexts[$type];
 436                         }
 437                 }
 438                 return $links;
 439         }
 440
 441         function getLimitLinks() {
 442                 global $wgLang;
 443                 $links = array();
 444                 if ( $this->mIsBackwards ) {
 445                         $offset = $this->mPastTheEndIndex;
 446                 } else {
 447                         $offset = $this->mOffset;
 448                 }
 449                 foreach ( $this->mLimitsShown as $limit ) {
 450                         $links[] = $this->makeLink( $wgLang->formatNum( $limit ),
 451                                 array( 'offset' => $offset, 'limit' => $limit ), 'num' );
 452                 }
 453                 return $links;
 454         }
 455
 456         /**
 457          * Abstract formatting function. This should return an HTML string
 458          * representing the result row $row. Rows will be concatenated and
 459          * returned by getBody()
 460          */
 461         abstract function formatRow( $row );
 462
 463         /**
 464          * This function should be overridden to provide all parameters
 465          * needed for the main paged query. It returns an associative
 466          * array with the following elements:
 467          *    tables => Table(s) for passing to Database::select()
 468          *    fields => Field(s) for passing to Database::select(), may be *
 469          *    conds => WHERE conditions
 470          *    options => option array
 471          *    join_conds => JOIN conditions
 472          */
 473         abstract function getQueryInfo();
 474
 475         /**
 476          * This function should be overridden to return the name of the index fi-
 477          * eld.  If the pager supports multiple orders, it may return an array of
 478          * 'querykey' => 'indexfield' pairs, so that a request with &count=querykey
 479          * will use indexfield to sort.  In this case, the first returned key is
 480          * the default.
 481          *
 482          * Needless to say, it's really not a good idea to use a non-unique index
 483          * for this!  That won't page right.
 484          */
 485         abstract function getIndexField();
 486
 487         /**
 488          * Return the default sorting direction: false for ascending, true for de-
 489          * scending.  You can also have an associative array of ordertype => dir,
 490          * if multiple order types are supported.  In this case getIndexField()
 491          * must return an array, and the keys of that must exactly match the keys
 492          * of this.
 493          *
 494          * For backward compatibility, this method's return value will be ignored
 495          * if $this->mDefaultDirection is already set when the constructor is
 496          * called, for instance if it's statically initialized.  In that case the
 497          * value of that variable (which must be a boolean) will be used.
 498          *
 499          * Note that despite its name, this does not return the value of the
 500          * $this->mDefaultDirection member variable.  That's the default for this
 501          * particular instantiation, which is a single value.  This is the set of
 502          * all defaults for the class.
 503          */
 504         protected function getDefaultDirections() { return false; }
 505 }
 506
 507
 508 /**
 509  * IndexPager with an alphabetic list and a formatted navigation bar
 510  * @ingroup Pager
 511  */
 512 abstract class AlphabeticPager extends IndexPager {
 513         /**
 514          * Shamelessly stolen bits from ReverseChronologicalPager,
 515          * didn't want to do class magic as may be still revamped
 516          */
 517         function getNavigationBar() {
 518                 global $wgLang;
 519
 520                 if ( $this->mIsFirst && $this->mIsLast ) return '';
 521
 522                 if( isset( $this->mNavigationBar ) ) {
 523                         return $this->mNavigationBar;
 524                 }
 525
 526                 $opts = array( 'parsemag', 'escapenoentities' );
 527                 $linkTexts = array(
 528                         'prev' => wfMsgExt( 'prevn', $opts, $wgLang->formatNum( $this->mLimit ) ),
 529                         'next' => wfMsgExt( 'nextn', $opts, $wgLang->formatNum($this->mLimit ) ),
 530                         'first' => wfMsgExt( 'page_first', $opts ),
 531                         'last' => wfMsgExt( 'page_last', $opts )
 532                 );
 533
 534                 $pagingLinks = $this->getPagingLinks( $linkTexts );
 535                 $limitLinks = $this->getLimitLinks();
 536                 $limits = $wgLang->pipeList( $limitLinks );
 537
 538                 $this->mNavigationBar =
 539                         "(" . $wgLang->pipeList( array( $pagingLinks['first'], $pagingLinks['last'] ) ) . ") " .
 540                         wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
 541                         $pagingLinks['next'], $limits );
 542
 543                 if( !is_array( $this->getIndexField() ) ) {
 544                         # Early return to avoid undue nesting
 545                         return $this->mNavigationBar;
 546                 }
 547
 548                 $extra = '';
 549                 $first = true;
 550                 $msgs = $this->getOrderTypeMessages();
 551                 foreach( array_keys( $msgs ) as $order ) {
 552                         if( $first ) {
 553                                 $first = false;
 554                         } else {
 555                                 $extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
 556                         }
 557
 558                         if( $order == $this->mOrderType ) {
 559                                 $extra .= wfMsgHTML( $msgs[$order] );
 560                         } else {
 561                                 $extra .= $this->makeLink(
 562                                         wfMsgHTML( $msgs[$order] ),
 563                                         array( 'order' => $order )
 564                                 );
 565                         }
 566                 }
 567
 568                 if( $extra !== '' ) {
 569                         $this->mNavigationBar .= " ($extra)";
 570                 }
 571
 572                 return $this->mNavigationBar;
 573         }
 574
 575         /**
 576          * If this supports multiple order type messages, give the message key for
 577          * enabling each one in getNavigationBar.  The return type is an associa-
 578          * tive array whose keys must exactly match the keys of the array returned
 579          * by getIndexField(), and whose values are message keys.
 580          * @return array
 581          */
 582         protected function getOrderTypeMessages() {
 583                 return null;
 584         }
 585 }
 586
 587 /**
 588  * IndexPager with a formatted navigation bar
 589  * @ingroup Pager
 590  */
 591 abstract class ReverseChronologicalPager extends IndexPager {
 592         public $mDefaultDirection = true;
 593         public $mYear;
 594         public $mMonth;
 595
 596         function __construct() {
 597                 parent::__construct();
 598         }
 599
 600         function getNavigationBar() {
 601                 global $wgLang;
 602
 603                 if ( $this->mIsFirst && $this->mIsLast ) return '';
 604
 605                 if ( isset( $this->mNavigationBar ) ) {
 606                         return $this->mNavigationBar;
 607                 }
 608                 $nicenumber = $wgLang->formatNum( $this->mLimit );
 609                 $linkTexts = array(
 610                         'prev' => wfMsgExt( 'pager-newer-n', array( 'parsemag' ), $nicenumber ),
 611                         'next' => wfMsgExt( 'pager-older-n', array( 'parsemag' ), $nicenumber ),
 612                         'first' => wfMsgHtml( 'histlast' ),
 613                         'last' => wfMsgHtml( 'histfirst' )
 614                 );
 615
 616                 $pagingLinks = $this->getPagingLinks( $linkTexts );
 617                 $limitLinks = $this->getLimitLinks();
 618                 $limits = $wgLang->pipeList( $limitLinks );
 619
 620                 $this->mNavigationBar = "({$pagingLinks['first']}" . wfMsgExt( 'pipe-separator' , 'escapenoentities' ) . "{$pagingLinks['last']}) " .
 621                         wfMsgHtml("viewprevnext", $pagingLinks['prev'], $pagingLinks['next'], $limits);
 622                 return $this->mNavigationBar;
 623         }
 624
 625         function getDateCond( $year, $month ) {
 626                 $year = intval($year);
 627                 $month = intval($month);
 628                 // Basic validity checks
 629                 $this->mYear = $year > 0 ? $year : false;
 630                 $this->mMonth = ($month > 0 && $month < 13) ? $month : false;
 631                 // Given an optional year and month, we need to generate a timestamp
 632                 // to use as "WHERE rev_timestamp <= result"
 633                 // Examples: year = 2006 equals < 20070101 (+000000)
 634                 // year=2005, month=1    equals < 20050201
 635                 // year=2005, month=12   equals < 20060101
 636                 if ( !$this->mYear && !$this->mMonth ) {
 637                         return;
 638                 }
 639                 if ( $this->mYear ) {
 640                         $year = $this->mYear;
 641                 } else {
 642                         // If no year given, assume the current one
 643                         $year = gmdate( 'Y' );
 644                         // If this month hasn't happened yet this year, go back to last year's month
 645                         if( $this->mMonth > gmdate( 'n' ) ) {
 646                                 $year--;
 647                         }
 648                 }
 649                 if ( $this->mMonth ) {
 650                         $month = $this->mMonth + 1;
 651                         // For December, we want January 1 of the next year
 652                         if ($month > 12) {
 653                                 $month = 1;
 654                                 $year++;
 655                         }
 656                 } else {
 657                         // No month implies we want up to the end of the year in question
 658                         $month = 1;
 659                         $year++;
 660                 }
 661                 // Y2K38 bug
 662                 if ( $year > 2032 ) {
 663                         $year = 2032;
 664                 }
 665                 $ymd = (int)sprintf( "%04d%02d01", $year, $month );
 666                 if ( $ymd > 20320101 ) {
 667                         $ymd = 20320101;
 668                 }
 669                 $this->mOffset = $this->mDb->timestamp( "${ymd}000000" );
 670         }
 671 }
 672
 673 /**
 674  * Table-based display with a user-selectable sort order
 675  * @ingroup Pager
 676  */
 677 abstract class TablePager extends IndexPager {
 678         var $mSort;
 679         var $mCurrentRow;
 680
 681         function __construct() {
 682                 global $wgRequest;
 683                 $this->mSort = $wgRequest->getText( 'sort' );
 684                 if ( !array_key_exists( $this->mSort, $this->getFieldNames() ) ) {
 685                         $this->mSort = $this->getDefaultSort();
 686                 }
 687                 if ( $wgRequest->getBool( 'asc' ) ) {
 688                         $this->mDefaultDirection = false;
 689                 } elseif ( $wgRequest->getBool( 'desc' ) ) {
 690                         $this->mDefaultDirection = true;
 691                 } /* Else leave it at whatever the class default is */
 692
 693                 parent::__construct();
 694         }
 695
 696         function getStartBody() {
 697                 global $wgStylePath;
 698                 $tableClass = htmlspecialchars( $this->getTableClass() );
 699                 $sortClass = htmlspecialchars( $this->getSortHeaderClass() );
 700
 701                 $s = "<table border='1' class=\"$tableClass\"><thead><tr>\n";
 702                 $fields = $this->getFieldNames();
 703
 704                 # Make table header
 705                 foreach ( $fields as $field => $name ) {
 706                         if ( strval( $name ) == '' ) {
 707                                 $s .= "<th>&nbsp;</th>\n";
 708                         } elseif ( $this->isFieldSortable( $field ) ) {
 709                                 $query = array( 'sort' => $field, 'limit' => $this->mLimit );
 710                                 if ( $field == $this->mSort ) {
 711                                         # This is the sorted column
 712                                         # Prepare a link that goes in the other sort order
 713                                         if ( $this->mDefaultDirection ) {
 714                                                 # Descending
 715                                                 $image = 'Arr_u.png';
 716                                                 $query['asc'] = '1';
 717                                                 $query['desc'] = '';
 718                                                 $alt = htmlspecialchars( wfMsg( 'descending_abbrev' ) );
 719                                         } else {
 720                                                 # Ascending
 721                                                 $image = 'Arr_d.png';
 722                                                 $query['asc'] = '';
 723                                                 $query['desc'] = '1';
 724                                                 $alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) );
 725                                         }
 726                                         $image = htmlspecialchars( "$wgStylePath/common/images/$image" );
 727                                         $link = $this->makeLink(
 728                                                 "<img width=\"12\" height=\"12\" alt=\"$alt\" src=\"$image\" />" .
 729                                                 htmlspecialchars( $name ), $query );
 730                                         $s .= "<th class=\"$sortClass\">$link</th>\n";
 731                                 } else {
 732                                         $s .= '<th>' . $this->makeLink( htmlspecialchars( $name ), $query ) . "</th>\n";
 733                                 }
 734                         } else {
 735                                 $s .= '<th>' . htmlspecialchars( $name ) . "</th>\n";
 736                         }
 737                 }
 738                 $s .= "</tr></thead><tbody>\n";
 739                 return $s;
 740         }
 741
 742         function getEndBody() {
 743                 return "</tbody></table>\n";
 744         }
 745
 746         function getEmptyBody() {
 747                 $colspan = count( $this->getFieldNames() );
 748                 $msgEmpty = wfMsgHtml( 'table_pager_empty' );
 749                 return "<tr><td colspan=\"$colspan\">$msgEmpty</td></tr>\n";
 750         }
 751
 752         function formatRow( $row ) {
 753                 $this->mCurrentRow = $row;      # In case formatValue etc need to know
 754                 $s = Xml::openElement( 'tr', $this->getRowAttrs($row) );
 755                 $fieldNames = $this->getFieldNames();
 756                 foreach ( $fieldNames as $field => $name ) {
 757                         $value = isset( $row->$field ) ? $row->$field : null;
 758                         $formatted = strval( $this->formatValue( $field, $value ) );
 759                         if ( $formatted == '' ) {
 760                                 $formatted = '&nbsp;';
 761                         }
 762                         $s .= Xml::tags( 'td', $this->getCellAttrs( $field, $value ), $formatted );
 763                 }
 764                 $s .= "</tr>\n";
 765                 return $s;
 766         }
 767
 768         /**
 769          * Get a class name to be applied to the given row.
 770          * @param object $row The database result row
 771          */
 772         function getRowClass( $row ) {
 773                 return '';
 774         }
 775
 776         /**
 777          * Get attributes to be applied to the given row.
 778          * @param object $row The database result row
 779          * @return associative array
 780          */
 781         function getRowAttrs( $row ) {
 782                 return array( 'class' => $this->getRowClass( $row ) );
 783         }
 784
 785         /**
 786          * Get any extra attributes to be applied to the given cell. Don't
 787          * take this as an excuse to hardcode styles; use classes and
 788          * CSS instead.  Row context is available in $this->mCurrentRow
 789          * @param $field The column
 790          * @param $value The cell contents
 791          * @return associative array
 792          */
 793         function getCellAttrs( $field, $value ) {
 794                 return array( 'class' => 'TablePager_col_' . $field );
 795         }
 796
 797         function getIndexField() {
 798                 return $this->mSort;
 799         }
 800
 801         function getTableClass() {
 802                 return 'TablePager';
 803         }
 804
 805         function getNavClass() {
 806                 return 'TablePager_nav';
 807         }
 808
 809         function getSortHeaderClass() {
 810                 return 'TablePager_sort';
 811         }
 812
 813         /**
 814          * A navigation bar with images
 815          */
 816         function getNavigationBar() {
 817                 global $wgStylePath, $wgContLang;
 818                 $path = "$wgStylePath/common/images";
 819                 $labels = array(
 820                         'first' => 'table_pager_first',
 821                         'prev' => 'table_pager_prev',
 822                         'next' => 'table_pager_next',
 823                         'last' => 'table_pager_last',
 824                 );
 825                 $images = array(
 826                         'first' => $wgContLang->isRTL() ? 'arrow_last_25.png' : 'arrow_first_25.png',
 827                         'prev' =>  $wgContLang->isRTL() ? 'arrow_right_25.png' : 'arrow_left_25.png',
 828                         'next' =>  $wgContLang->isRTL() ? 'arrow_left_25.png' : 'arrow_right_25.png',
 829                         'last' =>  $wgContLang->isRTL() ? 'arrow_first_25.png' : 'arrow_last_25.png',
 830                 );
 831                 $disabledImages = array(
 832                         'first' => $wgContLang->isRTL() ? 'arrow_disabled_last_25.png' : 'arrow_disabled_first_25.png',
 833                         'prev' =>  $wgContLang->isRTL() ? 'arrow_disabled_right_25.png' : 'arrow_disabled_left_25.png',
 834                         'next' =>  $wgContLang->isRTL() ? 'arrow_disabled_left_25.png' : 'arrow_disabled_right_25.png',
 835                         'last' =>  $wgContLang->isRTL() ? 'arrow_disabled_first_25.png' : 'arrow_disabled_last_25.png',
 836                 );
 837
 838                 $linkTexts = array();
 839                 $disabledTexts = array();
 840                 foreach ( $labels as $type => $label ) {
 841                         $msgLabel = wfMsgHtml( $label );
 842                         $linkTexts[$type] = "<img src=\"$path/{$images[$type]}\" alt=\"$msgLabel\"/><br/>$msgLabel";
 843                         $disabledTexts[$type] = "<img src=\"$path/{$disabledImages[$type]}\" alt=\"$msgLabel\"/><br/>$msgLabel";
 844                 }
 845                 $links = $this->getPagingLinks( $linkTexts, $disabledTexts );
 846
 847                 $navClass = htmlspecialchars( $this->getNavClass() );
 848                 $s = "<table class=\"$navClass\" align=\"center\" cellpadding=\"3\"><tr>\n";
 849                 $cellAttrs = 'valign="top" align="center" width="' . 100 / count( $links ) . '%"';
 850                 foreach ( $labels as $type => $label ) {
 851                         $s .= "<td $cellAttrs>{$links[$type]}</td>\n";
 852                 }
 853                 $s .= "</tr></table>\n";
 854                 return $s;
 855         }
 856
 857         /**
 858          * Get a <select> element which has options for each of the allowed limits
 859          */
 860         function getLimitSelect() {
 861                 global $wgLang;
 862                 $s = "<select name=\"limit\">";
 863                 foreach ( $this->mLimitsShown as $limit ) {
 864                         $selected = $limit == $this->mLimit ? 'selected="selected"' : '';
 865                         $formattedLimit = $wgLang->formatNum( $limit );
 866                         $s .= "<option value=\"$limit\" $selected>$formattedLimit</option>\n";
 867                 }
 868                 $s .= "</select>";
 869                 return $s;
 870         }
 871
 872         /**
 873          * Get <input type="hidden"> elements for use in a method="get" form.
 874          * Resubmits all defined elements of the $_GET array, except for a
 875          * blacklist, passed in the $blacklist parameter.
 876          */
 877         function getHiddenFields( $blacklist = array() ) {
 878                 $blacklist = (array)$blacklist;
 879                 $query = $_GET;
 880                 foreach ( $blacklist as $name ) {
 881                         unset( $query[$name] );
 882                 }
 883                 $s = '';
 884                 foreach ( $query as $name => $value ) {
 885                         $encName = htmlspecialchars( $name );
 886                         $encValue = htmlspecialchars( $value );
 887                         $s .= "<input type=\"hidden\" name=\"$encName\" value=\"$encValue\"/>\n";
 888                 }
 889                 return $s;
 890         }
 891
 892         /**
 893          * Get a form containing a limit selection dropdown
 894          */
 895         function getLimitForm() {
 896                 # Make the select with some explanatory text
 897                 $url = $this->getTitle()->escapeLocalURL();
 898                 $msgSubmit = wfMsgHtml( 'table_pager_limit_submit' );
 899                 return
 900                         "<form method=\"get\" action=\"$url\">" .
 901                         wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
 902                         "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
 903                         $this->getHiddenFields( array('limit','title') ) .
 904                         "</form>\n";
 905         }
 906
 907         /**
 908          * Return true if the named field should be sortable by the UI, false
 909          * otherwise
 910          *
 911          * @param string $field
 912          */
 913         abstract function isFieldSortable( $field );
 914
 915         /**
 916          * Format a table cell. The return value should be HTML, but use an empty
 917          * string not &nbsp; for empty cells. Do not include the <td> and </td>.
 918          *
 919          * The current result row is available as $this->mCurrentRow, in case you
 920          * need more context.
 921          *
 922          * @param string $name The database field name
 923          * @param string $value The value retrieved from the database
 924          */
 925         abstract function formatValue( $name, $value );
 926
 927         /**
 928          * The database field name used as a default sort order
 929          */
 930         abstract function getDefaultSort();
 931
 932         /**
 933          * An array mapping database field names to a textual description of the
 934          * field name, for use in the table header. The description should be plain
 935          * text, it will be HTML-escaped later.
 936          */
 937         abstract function getFieldNames();
 938 }