includes/QueryPage.php

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