includes/QueryPage.php

   1 <?php
   2 /**
   3  * Contain a class for special pages
   4  */
   5
   6 /**
   7  * List of query page classes and their associated special pages,
   8  * for periodic updates.
   9  *
  10  * DO NOT CHANGE THIS LIST without testing that
  11  * maintenance/updateSpecialPages.php still works.
  12  */
  13 global $wgQueryPages; // not redundant
  14 $wgQueryPages = array(
  15 //         QueryPage subclass           Special page name         Limit (false for none, none for the default)
  16 //----------------------------------------------------------------------------
  17         array( 'AncientPagesPage',              'Ancientpages'                  ),
  18         array( 'BrokenRedirectsPage',           'BrokenRedirects'               ),
  19         array( 'DeadendPagesPage',              'Deadendpages'                  ),
  20         array( 'DisambiguationsPage',           'Disambiguations'               ),
  21         array( 'DoubleRedirectsPage',           'DoubleRedirects'               ),
  22         array( 'ListredirectsPage',             'Listredirects'                                 ),
  23         array( 'LonelyPagesPage',               'Lonelypages'                   ),
  24         array( 'LongPagesPage',                 'Longpages'                     ),
  25         array( 'MostcategoriesPage',            'Mostcategories'                ),
  26         array( 'MostimagesPage',                'Mostimages'                    ),
  27         array( 'MostlinkedCategoriesPage',      'Mostlinkedcategories'          ),
  28         array( 'SpecialMostlinkedtemplates',    'Mostlinkedtemplates'                   ),
  29         array( 'MostlinkedPage',                'Mostlinked'                    ),
  30         array( 'MostrevisionsPage',             'Mostrevisions'                 ),
  31         array( 'FewestrevisionsPage',           'Fewestrevisions'               ),
  32         array( 'NewPagesPage',                  'Newpages'                      ),
  33         array( 'ShortPagesPage',                'Shortpages'                    ),
  34         array( 'UncategorizedCategoriesPage',   'Uncategorizedcategories'       ),
  35         array( 'UncategorizedPagesPage',        'Uncategorizedpages'            ),
  36         array( 'UncategorizedImagesPage',       'Uncategorizedimages'                   ),
  37         array( 'UncategorizedTemplatesPage',    'Uncategorizedtemplates'                ),
  38         array( 'UnusedCategoriesPage',          'Unusedcategories'              ),
  39         array( 'UnusedimagesPage',              'Unusedimages'                  ),
  40         array( 'WantedCategoriesPage',          'Wantedcategories'              ),
  41         array( 'WantedPagesPage',               'Wantedpages'                   ),
  42         array( 'UnwatchedPagesPage',            'Unwatchedpages'                ),
  43         array( 'UnusedtemplatesPage',           'Unusedtemplates'                               ),
  44         array( 'WithoutInterwikiPage',                  'Withoutinterwiki'                              ),
  45 );
  46 wfRunHooks( 'wgQueryPages', array( &$wgQueryPages ) );
  47
  48 global $wgDisableCounters;
  49 if ( !$wgDisableCounters )
  50         $wgQueryPages[] = array( 'PopularPagesPage',            'Popularpages'          );
  51
  52
  53 /**
  54  * This is a class for doing query pages; since they're almost all the same,
  55  * we factor out some of the functionality into a superclass, and let
  56  * subclasses derive from it.
  57  * @addtogroup SpecialPage
  58  */
  59 class QueryPage {
  60         /**
  61          * Whether or not we want plain listoutput rather than an ordered list
  62          *
  63          * @var bool
  64          */
  65         var $listoutput = false;
  66
  67         /**
  68          * The offset and limit in use, as passed to the query() function
  69          *
  70          * @var integer
  71          */
  72         var $offset = 0;
  73         var $limit = 0;
  74
  75         /**
  76          * A mutator for $this->listoutput;
  77          *
  78          * @param bool $bool
  79          */
  80         function setListoutput( $bool ) {
  81                 $this->listoutput = $bool;
  82         }
  83
  84         /**
  85          * Subclasses return their name here. Make sure the name is also
  86          * specified in SpecialPage.php and in Language.php as a language message
  87          * param.
  88          */
  89         function getName() {
  90                 return '';
  91         }
  92
  93         /**
  94          * Return title object representing this page
  95          *
  96          * @return Title
  97          */
  98         function getTitle() {
  99                 return SpecialPage::getTitleFor( $this->getName() );
 100         }
 101
 102         /**
 103          * Subclasses return an SQL query here.
 104          *
 105          * Note that the query itself should return the following four columns:
 106          * 'type' (your special page's name), 'namespace', 'title', and 'value'
 107          * *in that order*. 'value' is used for sorting.
 108          *
 109          * These may be stored in the querycache table for expensive queries,
 110          * and that cached data will be returned sometimes, so the presence of
 111          * extra fields can't be relied upon. The cached 'value' column will be
 112          * an integer; non-numeric values are useful only for sorting the initial
 113          * query.
 114          *
 115          * Don't include an ORDER or LIMIT clause, this will be added.
 116          */
 117         function getSQL() {
 118                 return "SELECT 'sample' as type, 0 as namespace, 'Sample result' as title, 42 as value";
 119         }
 120
 121         /**
 122          * Override to sort by increasing values
 123          */
 124         function sortDescending() {
 125                 return true;
 126         }
 127
 128         function getOrder() {
 129                 return ' ORDER BY value ' .
 130                         ($this->sortDescending() ? 'DESC' : '');
 131         }
 132
 133         /**
 134          * Is this query expensive (for some definition of expensive)? Then we
 135          * don't let it run in miser mode. $wgDisableQueryPages causes all query
 136          * pages to be declared expensive. Some query pages are always expensive.
 137          */
 138         function isExpensive( ) {
 139                 global $wgDisableQueryPages;
 140                 return $wgDisableQueryPages;
 141         }
 142
 143         /**
 144          * Whether or not the output of the page in question is retrived from
 145          * the database cache.
 146          *
 147          * @return bool
 148          */
 149         function isCached() {
 150                 global $wgMiserMode;
 151
 152                 return $this->isExpensive() && $wgMiserMode;
 153         }
 154
 155         /**
 156          * Sometime we dont want to build rss / atom feeds.
 157          */
 158         function isSyndicated() {
 159                 return true;
 160         }
 161
 162         /**
 163          * Formats the results of the query for display. The skin is the current
 164          * skin; you can use it for making links. The result is a single row of
 165          * result data. You should be able to grab SQL results off of it.
 166          * If the function return "false", the line output will be skipped.
 167          */
 168         function formatResult( $skin, $result ) {
 169                 return '';
 170         }
 171
 172         /**
 173          * The content returned by this function will be output before any result
 174          */
 175         function getPageHeader( ) {
 176                 return '';
 177         }
 178
 179         /**
 180          * If using extra form wheely-dealies, return a set of parameters here
 181          * as an associative array. They will be encoded and added to the paging
 182          * links (prev/next/lengths).
 183          * @return array
 184          */
 185         function linkParameters() {
 186                 return array();
 187         }
 188
 189         /**
 190          * Some special pages (for example SpecialListusers) might not return the
 191          * current object formatted, but return the previous one instead.
 192          * Setting this to return true, will call one more time wfFormatResult to
 193          * be sure that the very last result is formatted and shown.
 194          */
 195         function tryLastResult( ) {
 196                 return false;
 197         }
 198
 199         /**
 200          * Clear the cache and save new results
 201          */
 202         function recache( $limit, $ignoreErrors = true ) {
 203                 $fname = get_class($this) . '::recache';
 204                 $dbw = wfGetDB( DB_MASTER );
 205                 $dbr = wfGetDB( DB_SLAVE, array( $this->getName(), 'QueryPage::recache', 'vslow' ) );
 206                 if ( !$dbw || !$dbr ) {
 207                         return false;
 208                 }
 209
 210                 $querycache = $dbr->tableName( 'querycache' );
 211
 212                 if ( $ignoreErrors ) {
 213                         $ignoreW = $dbw->ignoreErrors( true );
 214                         $ignoreR = $dbr->ignoreErrors( true );
 215                 }
 216
 217                 # Clear out any old cached data
 218                 $dbw->delete( 'querycache', array( 'qc_type' => $this->getName() ), $fname );
 219                 # Do query
 220                 $sql = $this->getSQL() . $this->getOrder();
 221                 if ($limit !== false)
 222                         $sql = $dbr->limitResult($sql, $limit, 0);
 223                 $res = $dbr->query($sql, $fname);
 224                 $num = false;
 225                 if ( $res ) {
 226                         $num = $dbr->numRows( $res );
 227                         # Fetch results
 228                         $insertSql = "INSERT INTO $querycache (qc_type,qc_namespace,qc_title,qc_value) VALUES ";
 229                         $first = true;
 230                         while ( $res && $row = $dbr->fetchObject( $res ) ) {
 231                                 if ( $first ) {
 232                                         $first = false;
 233                                 } else {
 234                                         $insertSql .= ',';
 235                                 }
 236                                 if ( isset( $row->value ) ) {
 237                                         $value = $row->value;
 238                                 } else {
 239                                         $value = '';
 240                                 }
 241
 242                                 $insertSql .= '(' .
 243                                         $dbw->addQuotes( $row->type ) . ',' .
 244                                         $dbw->addQuotes( $row->namespace ) . ',' .
 245                                         $dbw->addQuotes( $row->title ) . ',' .
 246                                         $dbw->addQuotes( $value ) . ')';
 247                         }
 248
 249                         # Save results into the querycache table on the master
 250                         if ( !$first ) {
 251                                 if ( !$dbw->query( $insertSql, $fname ) ) {
 252                                         // Set result to false to indicate error
 253                                         $dbr->freeResult( $res );
 254                                         $res = false;
 255                                 }
 256                         }
 257                         if ( $res ) {
 258                                 $dbr->freeResult( $res );
 259                         }
 260                         if ( $ignoreErrors ) {
 261                                 $dbw->ignoreErrors( $ignoreW );
 262                                 $dbr->ignoreErrors( $ignoreR );
 263                         }
 264
 265                         # Update the querycache_info record for the page
 266                         $dbw->delete( 'querycache_info', array( 'qci_type' => $this->getName() ), $fname );
 267                         $dbw->insert( 'querycache_info', array( 'qci_type' => $this->getName(), 'qci_timestamp' => $dbw->timestamp() ), $fname );
 268
 269                 }
 270                 return $num;
 271         }
 272
 273         /**
 274          * This is the actual workhorse. It does everything needed to make a
 275          * real, honest-to-gosh query page.
 276          *
 277          * @param $offset database query offset
 278          * @param $limit database query limit
 279          * @param $shownavigation show navigation like "next 200"?
 280          */
 281         function doQuery( $offset, $limit, $shownavigation=true ) {
 282                 global $wgUser, $wgOut, $wgLang, $wgContLang;
 283
 284                 $this->offset = $offset;
 285                 $this->limit = $limit;
 286
 287                 $sname = $this->getName();
 288                 $fname = get_class($this) . '::doQuery';
 289                 $dbr = wfGetDB( DB_SLAVE );
 290
 291                 $wgOut->setSyndicated( $this->isSyndicated() );
 292
 293                 if ( !$this->isCached() ) {
 294                         $sql = $this->getSQL();
 295                 } else {
 296                         # Get the cached result
 297                         $querycache = $dbr->tableName( 'querycache' );
 298                         $type = $dbr->strencode( $sname );
 299                         $sql =
 300                                 "SELECT qc_type as type, qc_namespace as namespace,qc_title as title, qc_value as value
 301                                  FROM $querycache WHERE qc_type='$type'";
 302
 303                         if( !$this->listoutput ) {
 304
 305                                 # Fetch the timestamp of this update
 306                                 $tRes = $dbr->select( 'querycache_info', array( 'qci_timestamp' ), array( 'qci_type' => $type ), $fname );
 307                                 $tRow = $dbr->fetchObject( $tRes );
 308
 309                                 if( $tRow ) {
 310                                         $updated = $wgLang->timeAndDate( $tRow->qci_timestamp, true, true );
 311                                         $cacheNotice = wfMsg( 'perfcachedts', $updated );
 312                                         $wgOut->addMeta( 'Data-Cache-Time', $tRow->qci_timestamp );
 313                                         $wgOut->addInlineScript( "var dataCacheTime = '{$tRow->qci_timestamp}';" );
 314                                 } else {
 315                                         $cacheNotice = wfMsg( 'perfcached' );
 316                                 }
 317
 318                                 $wgOut->addWikiText( $cacheNotice );
 319
 320                                 # If updates on this page have been disabled, let the user know
 321                                 # that the data set won't be refreshed for now
 322                                 global $wgDisableQueryPageUpdate;
 323                                 if( is_array( $wgDisableQueryPageUpdate ) && in_array( $this->getName(), $wgDisableQueryPageUpdate ) ) {
 324                                         $wgOut->addWikiText( wfMsg( 'querypage-no-updates' ) );
 325                                 }
 326
 327                         }
 328
 329                 }
 330
 331                 $sql .= $this->getOrder();
 332                 $sql = $dbr->limitResult($sql, $limit, $offset);
 333                 $res = $dbr->query( $sql );
 334                 $num = $dbr->numRows($res);
 335
 336                 $this->preprocessResults( $dbr, $res );
 337
 338                 $wgOut->addHtml( XML::openElement( 'div', array('class' => 'mw-spcontent') ) );
 339
 340                 # Top header and navigation
 341                 if( $shownavigation ) {
 342                         $wgOut->addHtml( $this->getPageHeader() );
 343                         if( $num > 0 ) {
 344                                 $wgOut->addHtml( '<p>' . wfShowingResults( $offset, $num ) . '</p>' );
 345                                 # Disable the "next" link when we reach the end
 346                                 $paging = wfViewPrevNext( $offset, $limit, $wgContLang->specialPage( $sname ),
 347                                         wfArrayToCGI( $this->linkParameters() ), ( $num < $limit ) );
 348                                 $wgOut->addHtml( '<p>' . $paging . '</p>' );
 349                         } else {
 350                                 # No results to show, so don't bother with "showing X of Y" etc.
 351                                 # -- just let the user know and give up now
 352                                 $wgOut->addHtml( '<p>' . wfMsgHtml( 'specialpage-empty' ) . '</p>' );
 353                                 $wgOut->addHtml( XML::closeElement( 'div' ) );
 354                                 return;
 355                         }
 356                 }
 357
 358                 # The actual results; specialist subclasses will want to handle this
 359                 # with more than a straight list, so we hand them the info, plus
 360                 # an OutputPage, and let them get on with it
 361                 $this->outputResults( $wgOut,
 362                         $wgUser->getSkin(),
 363                         $dbr, # Should use a ResultWrapper for this
 364                         $res,
 365                         $dbr->numRows( $res ),
 366                         $offset );
 367
 368                 # Repeat the paging links at the bottom
 369                 if( $shownavigation ) {
 370                         $wgOut->addHtml( '<p>' . $paging . '</p>' );
 371                 }
 372
 373                 $wgOut->addHtml( XML::closeElement( 'div' ) );
 374
 375                 return $num;
 376         }
 377
 378         /**
 379          * Format and output report results using the given information plus
 380          * OutputPage
 381          *
 382          * @param OutputPage $out OutputPage to print to
 383          * @param Skin $skin User skin to use
 384          * @param Database $dbr Database (read) connection to use
 385          * @param int $res Result pointer
 386          * @param int $num Number of available result rows
 387          * @param int $offset Paging offset
 388          */
 389         protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
 390                 global $wgContLang;
 391
 392                 if( $num > 0 ) {
 393                         $html = array();
 394                         if( !$this->listoutput )
 395                                 $html[] = $this->openList( $offset );
 396
 397                         # $res might contain the whole 1,000 rows, so we read up to
 398                         # $num [should update this to use a Pager]
 399                         for( $i = 0; $i < $num && $row = $dbr->fetchObject( $res ); $i++ ) {
 400                                 $line = $this->formatResult( $skin, $row );
 401                                 if( $line ) {
 402                                         $attr = ( isset( $row->usepatrol ) && $row->usepatrol && $row->patrolled == 0 )
 403                                                 ? ' class="not-patrolled"'
 404                                                 : '';
 405                                         $html[] = $this->listoutput
 406                                                 ? $line
 407                                                 : "<li{$attr}>{$line}</li>\n";
 408                                 }
 409                         }
 410
 411                         # Flush the final result
 412                         if( $this->tryLastResult() ) {
 413                                 $row = null;
 414                                 $line = $this->formatResult( $skin, $row );
 415                                 if( $line ) {
 416                                         $attr = ( isset( $row->usepatrol ) && $row->usepatrol && $row->patrolled == 0 )
 417                                                 ? ' class="not-patrolled"'
 418                                                 : '';
 419                                         $html[] = $this->listoutput
 420                                                 ? $line
 421                                                 : "<li{$attr}>{$line}</li>\n";
 422                                 }
 423                         }
 424
 425                         if( !$this->listoutput )
 426                                 $html[] = $this->closeList();
 427
 428                         $html = $this->listoutput
 429                                 ? $wgContLang->listToText( $html )
 430                                 : implode( '', $html );
 431
 432                         $out->addHtml( $html );
 433                 }
 434         }
 435
 436         function openList( $offset ) {
 437                 return "\n<ol start='" . ( $offset + 1 ) . "' class='special'>\n";
 438         }
 439
 440         function closeList() {
 441                 return "</ol>\n";
 442         }
 443
 444         /**
 445          * Do any necessary preprocessing of the result object.
 446          * You should pass this by reference: &$db , &$res  [although probably no longer necessary in PHP5]
 447          */
 448         function preprocessResults( &$db, &$res ) {}
 449
 450         /**
 451          * Similar to above, but packaging in a syndicated feed instead of a web page
 452          */
 453         function doFeed( $class = '', $limit = 50 ) {
 454                 global $wgFeedClasses;
 455
 456                 if( isset($wgFeedClasses[$class]) ) {
 457                         $feed = new $wgFeedClasses[$class](
 458                                 $this->feedTitle(),
 459                                 $this->feedDesc(),
 460                                 $this->feedUrl() );
 461                         $feed->outHeader();
 462
 463                         $dbr = wfGetDB( DB_SLAVE );
 464                         $sql = $this->getSQL() . $this->getOrder();
 465                         $sql = $dbr->limitResult( $sql, $limit, 0 );
 466                         $res = $dbr->query( $sql, 'QueryPage::doFeed' );
 467                         while( $obj = $dbr->fetchObject( $res ) ) {
 468                                 $item = $this->feedResult( $obj );
 469                                 if( $item ) $feed->outItem( $item );
 470                         }
 471                         $dbr->freeResult( $res );
 472
 473                         $feed->outFooter();
 474                         return true;
 475                 } else {
 476                         return false;
 477                 }
 478         }
 479
 480         /**
 481          * Override for custom handling. If the titles/links are ok, just do
 482          * feedItemDesc()
 483          */
 484         function feedResult( $row ) {
 485                 if( !isset( $row->title ) ) {
 486                         return NULL;
 487                 }
 488                 $title = Title::MakeTitle( intval( $row->namespace ), $row->title );
 489                 if( $title ) {
 490                         $date = isset( $row->timestamp ) ? $row->timestamp : '';
 491                         $comments = '';
 492                         if( $title ) {
 493                                 $talkpage = $title->getTalkPage();
 494                                 $comments = $talkpage->getFullURL();
 495                         }
 496
 497                         return new FeedItem(
 498                                 $title->getPrefixedText(),
 499                                 $this->feedItemDesc( $row ),
 500                                 $title->getFullURL(),
 501                                 $date,
 502                                 $this->feedItemAuthor( $row ),
 503                                 $comments);
 504                 } else {
 505                         return NULL;
 506                 }
 507         }
 508
 509         function feedItemDesc( $row ) {
 510                 return isset( $row->comment ) ? htmlspecialchars( $row->comment ) : '';
 511         }
 512
 513         function feedItemAuthor( $row ) {
 514                 return isset( $row->user_text ) ? $row->user_text : '';
 515         }
 516
 517         function feedTitle() {
 518                 global $wgContLanguageCode, $wgSitename;
 519                 $page = SpecialPage::getPage( $this->getName() );
 520                 $desc = $page->getDescription();
 521                 return "$wgSitename - $desc [$wgContLanguageCode]";
 522         }
 523
 524         function feedDesc() {
 525                 return wfMsg( 'tagline' );
 526         }
 527
 528         function feedUrl() {
 529                 $title = SpecialPage::getTitleFor( $this->getName() );
 530                 return $title->getFullURL();
 531         }
 532 }
 533
 534