includes/QueryPage.php

   1 <?php
   2 /**
   3  * Contain a class for special pages
   4  * @package MediaWiki
   5  */
   6
   7 /**
   8  *
   9  */
  10 require_once 'Feed.php';
  11
  12 /**
  13  * List of query page classes and their associated special pages, for periodic update purposes
  14  */
  15 global $wgQueryPages; // not redundant
  16 $wgQueryPages = array(
  17 //         QueryPage subclass           Special page name         Limit (false for none, none for the default)
  18 //----------------------------------------------------------------------------
  19         array( 'AncientPagesPage',              'Ancientpages'                  ),
  20         array( 'BrokenRedirectsPage',           'BrokenRedirects'               ),
  21         array( 'CategoriesPage',                'Categories'                    ),
  22         array( 'DeadendPagesPage',              'Deadendpages'                  ),
  23         array( 'DisambiguationsPage',           'Disambiguations'               ),
  24         array( 'DoubleRedirectsPage',           'DoubleRedirects'               ),
  25         array( 'ListUsersPage',                 'Listusers'                     ),
  26         array( 'ListredirectsPage', 'Listredirects' ),
  27         array( 'LonelyPagesPage',               'Lonelypages'                   ),
  28         array( 'LongPagesPage',                 'Longpages'                     ),
  29         array( 'MostcategoriesPage',            'Mostcategories'                ),
  30         array( 'MostimagesPage',                'Mostimages'                    ),
  31         array( 'MostlinkedCategoriesPage',      'Mostlinkedcategories'          ),
  32         array( 'MostlinkedPage',                'Mostlinked'                    ),
  33         array( 'MostrevisionsPage',             'Mostrevisions'                 ),
  34         array( 'NewPagesPage',                  'Newpages'                      ),
  35         array( 'ShortPagesPage',                'Shortpages'                    ),
  36         array( 'UncategorizedCategoriesPage',   'Uncategorizedcategories'       ),
  37         array( 'UncategorizedPagesPage',        'Uncategorizedpages'            ),
  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 );
  45 wfRunHooks( 'wgQueryPages', array( &$wgQueryPages ) );
  46
  47 global $wgDisableCounters;
  48 if ( !$wgDisableCounters )
  49         $wgQueryPages[] = array( 'PopularPagesPage',            'Popularpages'          );
  50
  51
  52 /**
  53  * This is a class for doing query pages; since they're almost all the same,
  54  * we factor out some of the functionality into a superclass, and let
  55  * subclasses derive from it.
  56  *
  57  * @package MediaWiki
  58  */
  59 abstract class QueryPage {
  60         /**
  61          * Whether or not we want plain listoutput rather than an ordered list
  62          *
  63          * @var bool
  64          */
  65         private $listoutput = false;
  66
  67         /**
  68          * The offset and limit in use, as passed to the query() function
  69          *
  70          * @var integer
  71          */
  72         protected $offset = 0;
  73         protected $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 Title::makeTitle( NS_SPECIAL, $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                 $sql = $this->getSQL();
 290                 $dbr =& wfGetDB( DB_SLAVE );
 291                 $querycache = $dbr->tableName( 'querycache' );
 292
 293                 $wgOut->setSyndicated( $this->isSyndicated() );
 294
 295                 if ( $this->isCached() ) {
 296                         $type = $dbr->strencode( $sname );
 297                         $sql =
 298                                 "SELECT qc_type as type, qc_namespace as namespace,qc_title as title, qc_value as value
 299                                  FROM $querycache WHERE qc_type='$type'";
 300
 301                         if( !$this->listoutput ) {
 302
 303                                 # Fetch the timestamp of this update
 304                                 $tRes = $dbr->select( 'querycache_info', array( 'qci_timestamp' ), array( 'qci_type' => $type ), $fname );
 305                                 $tRow = $dbr->fetchObject( $tRes );
 306
 307                                 if( $tRow ) {
 308                                         $updated = $wgLang->timeAndDate( $tRow->qci_timestamp, true, true );
 309                                         $cacheNotice = wfMsg( 'perfcachedts', $updated );
 310                                         $wgOut->addMeta( 'Data-Cache-Time', $tRow->qci_timestamp );
 311                                         $wgOut->addScript( '<script language="JavaScript">var dataCacheTime = \'' . $tRow->qci_timestamp . '\';</script>' );
 312                                 } else {
 313                                         $cacheNotice = wfMsg( 'perfcached' );
 314                                 }
 315
 316                                 $wgOut->addWikiText( $cacheNotice );
 317                         }
 318
 319                 }
 320
 321                 $sql .= $this->getOrder();
 322                 $sql = $dbr->limitResult($sql, $limit, $offset);
 323                 $res = $dbr->query( $sql );
 324                 $num = $dbr->numRows($res);
 325
 326                 $this->preprocessResults( $dbr, $res );
 327
 328                 $sk = $wgUser->getSkin( );
 329
 330                 if($shownavigation) {
 331                         $wgOut->addHTML( $this->getPageHeader() );
 332                         $top = wfShowingResults( $offset, $num);
 333                         $wgOut->addHTML( "<p>{$top}\n" );
 334
 335                         # often disable 'next' link when we reach the end
 336                         $atend = $num < $limit;
 337
 338                         $sl = wfViewPrevNext( $offset, $limit ,
 339                                 $wgContLang->specialPage( $sname ),
 340                                 wfArrayToCGI( $this->linkParameters() ), $atend );
 341                         $wgOut->addHTML( "<br />{$sl}</p>\n" );
 342                 }
 343                 if ( $num > 0 ) {
 344                         $s = array();
 345                         if ( ! $this->listoutput )
 346                                 $s[] = "<ol start='" . ( $offset + 1 ) . "' class='special'>";
 347
 348                         # Only read at most $num rows, because $res may contain the whole 1000
 349                         for ( $i = 0; $i < $num && $obj = $dbr->fetchObject( $res ); $i++ ) {
 350                                 $format = $this->formatResult( $sk, $obj );
 351                                 if ( $format ) {
 352                                         $attr = ( isset ( $obj->usepatrol ) && $obj->usepatrol &&
 353                                                                                 $obj->patrolled == 0 ) ? ' class="not-patrolled"' : '';
 354                                         $s[] = $this->listoutput ? $format : "<li{$attr}>{$format}</li>\n";
 355                                 }
 356                         }
 357
 358                         if($this->tryLastResult()) {
 359                                 // flush the very last result
 360                                 $obj = null;
 361                                 $format = $this->formatResult( $sk, $obj );
 362                                 if( $format ) {
 363                                         $attr = ( isset ( $obj->usepatrol ) && $obj->usepatrol &&
 364                                                                                 $obj->patrolled == 0 ) ? ' class="not-patrolled"' : '';
 365                                         $s[] = "<li{$attr}>{$format}</li>\n";
 366                                 }
 367                         }
 368
 369                         $dbr->freeResult( $res );
 370                         if ( ! $this->listoutput )
 371                                 $s[] = '</ol>';
 372                         $str = $this->listoutput ? $wgContLang->listToText( $s ) : implode( '', $s );
 373                         $wgOut->addHTML( $str );
 374                 }
 375                 if($shownavigation) {
 376                         $wgOut->addHTML( "<p>{$sl}</p>\n" );
 377                 }
 378                 return $num;
 379         }
 380
 381         /**
 382          * Do any necessary preprocessing of the result object.
 383          * You should pass this by reference: &$db , &$res
 384          */
 385         function preprocessResults( $db, $res ) {}
 386
 387         /**
 388          * Similar to above, but packaging in a syndicated feed instead of a web page
 389          */
 390         function doFeed( $class = '', $limit = 50 ) {
 391                 global $wgFeedClasses;
 392
 393                 if( isset($wgFeedClasses[$class]) ) {
 394                         $feed = new $wgFeedClasses[$class](
 395                                 $this->feedTitle(),
 396                                 $this->feedDesc(),
 397                                 $this->feedUrl() );
 398                         $feed->outHeader();
 399
 400                         $dbr =& wfGetDB( DB_SLAVE );
 401                         $sql = $this->getSQL() . $this->getOrder();
 402                         $sql = $dbr->limitResult( $sql, $limit, 0 );
 403                         $res = $dbr->query( $sql, 'QueryPage::doFeed' );
 404                         while( $obj = $dbr->fetchObject( $res ) ) {
 405                                 $item = $this->feedResult( $obj );
 406                                 if( $item ) $feed->outItem( $item );
 407                         }
 408                         $dbr->freeResult( $res );
 409
 410                         $feed->outFooter();
 411                         return true;
 412                 } else {
 413                         return false;
 414                 }
 415         }
 416
 417         /**
 418          * Override for custom handling. If the titles/links are ok, just do
 419          * feedItemDesc()
 420          */
 421         function feedResult( $row ) {
 422                 if( !isset( $row->title ) ) {
 423                         return NULL;
 424                 }
 425                 $title = Title::MakeTitle( intval( $row->namespace ), $row->title );
 426                 if( $title ) {
 427                         $date = isset( $row->timestamp ) ? $row->timestamp : '';
 428                         $comments = '';
 429                         if( $title ) {
 430                                 $talkpage = $title->getTalkPage();
 431                                 $comments = $talkpage->getFullURL();
 432                         }
 433
 434                         return new FeedItem(
 435                                 $title->getPrefixedText(),
 436                                 $this->feedItemDesc( $row ),
 437                                 $title->getFullURL(),
 438                                 $date,
 439                                 $this->feedItemAuthor( $row ),
 440                                 $comments);
 441                 } else {
 442                         return NULL;
 443                 }
 444         }
 445
 446         function feedItemDesc( $row ) {
 447                 return isset( $row->comment ) ? htmlspecialchars( $row->comment ) : '';
 448         }
 449
 450         function feedItemAuthor( $row ) {
 451                 return isset( $row->user_text ) ? $row->user_text : '';
 452         }
 453
 454         function feedTitle() {
 455                 global $wgLanguageCode, $wgSitename;
 456                 $page = SpecialPage::getPage( $this->getName() );
 457                 $desc = $page->getDescription();
 458                 return "$wgSitename - $desc [$wgLanguageCode]";
 459         }
 460
 461         function feedDesc() {
 462                 return wfMsg( 'tagline' );
 463         }
 464
 465         function feedUrl() {
 466                 $title = Title::MakeTitle( NS_SPECIAL, $this->getName() );
 467                 return $title->getFullURL();
 468         }
 469 }
 470
 471 /**
 472  * This is a subclass for very simple queries that are just looking for page
 473  * titles that match some criteria. It formats each result item as a link to
 474  * that page.
 475  *
 476  * @package MediaWiki
 477  */
 478 class PageQueryPage extends QueryPage {
 479
 480         function formatResult( $skin, $result ) {
 481                 global $wgContLang;
 482                 $nt = Title::makeTitle( $result->namespace, $result->title );
 483                 return $skin->makeKnownLinkObj( $nt, htmlspecialchars( $wgContLang->convert( $nt->getPrefixedText() ) ) );
 484         }
 485 }
 486
 487 ?>