3 * Contain a class for special pages
5 * @ingroup SpecialPages
9 * List of query page classes and their associated special pages,
10 * for periodic updates.
12 * DO NOT CHANGE THIS LIST without testing that
13 * maintenance/updateSpecialPages.php still works.
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( 'DeadendPagesPage', 'Deadendpages' ),
22 array( 'DisambiguationsPage', 'Disambiguations' ),
23 array( 'DoubleRedirectsPage', 'DoubleRedirects' ),
24 array( 'FileDuplicateSearchPage', 'FileDuplicateSearch' ),
25 array( 'LinkSearchPage', 'LinkSearch' ),
26 array( 'ListredirectsPage', 'Listredirects' ),
27 array( 'LonelyPagesPage', 'Lonelypages' ),
28 array( 'LongPagesPage', 'Longpages' ),
29 array( 'MIMEsearchPage', 'MIMEsearch' ),
30 array( 'MostcategoriesPage', 'Mostcategories' ),
31 array( 'MostimagesPage', 'Mostimages' ),
32 array( 'MostlinkedCategoriesPage', 'Mostlinkedcategories' ),
33 array( 'MostlinkedtemplatesPage', 'Mostlinkedtemplates' ),
34 array( 'MostlinkedPage', 'Mostlinked' ),
35 array( 'MostrevisionsPage', 'Mostrevisions' ),
36 array( 'FewestrevisionsPage', 'Fewestrevisions' ),
37 array( 'ShortPagesPage', 'Shortpages' ),
38 array( 'UncategorizedCategoriesPage', 'Uncategorizedcategories' ),
39 array( 'UncategorizedPagesPage', 'Uncategorizedpages' ),
40 array( 'UncategorizedImagesPage', 'Uncategorizedimages' ),
41 array( 'UncategorizedTemplatesPage', 'Uncategorizedtemplates' ),
42 array( 'UnusedCategoriesPage', 'Unusedcategories' ),
43 array( 'UnusedimagesPage', 'Unusedimages' ),
44 array( 'WantedCategoriesPage', 'Wantedcategories' ),
45 array( 'WantedFilesPage', 'Wantedfiles' ),
46 array( 'WantedPagesPage', 'Wantedpages' ),
47 array( 'WantedTemplatesPage', 'Wantedtemplates' ),
48 array( 'UnwatchedPagesPage', 'Unwatchedpages' ),
49 array( 'UnusedtemplatesPage', 'Unusedtemplates' ),
50 array( 'WithoutInterwikiPage', 'Withoutinterwiki' ),
52 wfRunHooks( 'wgQueryPages', array( &$wgQueryPages ) );
54 global $wgDisableCounters;
55 if ( !$wgDisableCounters )
56 $wgQueryPages[] = array( 'PopularPagesPage', 'Popularpages' );
60 * This is a class for doing query pages; since they're almost all the same,
61 * we factor out some of the functionality into a superclass, and let
62 * subclasses derive from it.
63 * @ingroup SpecialPage
65 abstract class QueryPage
extends SpecialPage
{
67 * Whether or not we want plain listoutput rather than an ordered list
71 var $listoutput = false;
74 * The offset and limit in use, as passed to the query() function
82 * The number of rows returned by the query. Reading this variable
83 * only makes sense in functions that are run after the query has been
84 * done, such as preprocessResults() and formatRow().
89 * Wheter to show prev/next links
91 var $shownavigation = true;
94 * A mutator for $this->listoutput;
96 * @param $bool Boolean
98 function setListoutput( $bool ) {
99 $this->listoutput
= $bool;
103 * Return title object representing this page
107 function getTitle() {
108 return SpecialPage
::getTitleFor( $this->getName() );
112 * Subclasses return an SQL query here, formatted as an array with the
114 * tables => Table(s) for passing to Database::select()
115 * fields => Field(s) for passing to Database::select(), may be *
116 * conds => WHERE conditions
118 * join_conds => JOIN conditions
120 * Note that the query itself should return the following three columns:
121 * 'namespace', 'title', and 'value'
122 * *in that order*. 'value' is used for sorting.
124 * These may be stored in the querycache table for expensive queries,
125 * and that cached data will be returned sometimes, so the presence of
126 * extra fields can't be relied upon. The cached 'value' column will be
127 * an integer; non-numeric values are useful only for sorting the
128 * initial query (except if they're timestamps, see usesTimestamps()).
130 * Don't include an ORDER or LIMIT clause, they will be added.
132 * If this function is not overridden or returns something other than
133 * an array, getSQL() will be used instead. This is for backwards
134 * compatibility only and is strongly deprecated.
138 function getQueryInfo() {
143 * For back-compat, subclasses may return a raw SQL query here, as a string.
144 * This is stronly deprecated; getQueryInfo() should be overridden instead.
146 * @deprecated since 1.18
149 throw new MWException( "Bug in a QueryPage: doesn't implement getQueryInfo() nor getQuery() properly" );
153 * Subclasses return an array of fields to order by here. Don't append
154 * DESC to the field names, that'll be done automatically if
155 * sortDescending() returns true.
159 function getOrderFields() {
160 return array( 'value' );
164 * Does this query return timestamps rather than integers in its
165 * 'value' field? If true, this class will convert 'value' to a
166 * UNIX timestamp for caching.
167 * NOTE: formatRow() may get timestamps in TS_MW (mysql), TS_DB (pgsql)
168 * or TS_UNIX (querycache) format, so be sure to always run them
169 * through wfTimestamp()
172 function usesTimestamps() {
177 * Override to sort by increasing values
181 function sortDescending() {
186 * Is this query expensive (for some definition of expensive)? Then we
187 * don't let it run in miser mode. $wgDisableQueryPages causes all query
188 * pages to be declared expensive. Some query pages are always expensive.
192 function isExpensive() {
193 global $wgDisableQueryPages;
194 return $wgDisableQueryPages;
198 * Is the output of this query cacheable? Non-cacheable expensive pages
199 * will be disabled in miser mode and will not have their results written
200 * to the querycache table.
203 public function isCacheable() {
208 * Whether or not the output of the page in question is retrieved from
209 * the database cache.
213 function isCached() {
216 return $this->isExpensive() && $wgMiserMode;
220 * Sometime we dont want to build rss / atom feeds.
224 function isSyndicated() {
229 * Formats the results of the query for display. The skin is the current
230 * skin; you can use it for making links. The result is a single row of
231 * result data. You should be able to grab SQL results off of it.
232 * If the function returns false, the line output will be skipped.
234 * @param $result object Result row
235 * @return mixed String or false to skip
237 * @param $skin Skin object
238 * @param $result Object: database row
240 abstract function formatResult( $skin, $result );
243 * The content returned by this function will be output before any result
247 function getPageHeader() {
252 * If using extra form wheely-dealies, return a set of parameters here
253 * as an associative array. They will be encoded and added to the paging
254 * links (prev/next/lengths).
258 function linkParameters() {
263 * Some special pages (for example SpecialListusers) might not return the
264 * current object formatted, but return the previous one instead.
265 * Setting this to return true will ensure formatResult() is called
266 * one more time to make sure that the very last result is formatted
269 function tryLastResult() {
274 * Clear the cache and save new results
276 * @param $limit Integer: limit for SQL statement
277 * @param $ignoreErrors Boolean: whether to ignore database errors
279 function recache( $limit, $ignoreErrors = true ) {
280 $fname = get_class( $this ) . '::recache';
281 $dbw = wfGetDB( DB_MASTER
);
282 $dbr = wfGetDB( DB_SLAVE
, array( $this->getName(), __METHOD__
, 'vslow' ) );
283 if ( !$dbw ||
!$dbr ||
!$this->isCacheable() ) {
287 if ( $ignoreErrors ) {
288 $ignoreW = $dbw->ignoreErrors( true );
289 $ignoreR = $dbr->ignoreErrors( true );
292 # Clear out any old cached data
293 $dbw->delete( 'querycache', array( 'qc_type' => $this->getName() ), $fname );
295 $res = $this->reallyDoQuery( $limit, false );
298 $num = $dbr->numRows( $res );
301 while ( $res && $row = $dbr->fetchObject( $res ) ) {
302 if ( isset( $row->value
) ) {
303 if ( $this->usesTimestamps() ) {
304 $value = wfTimestamp( TS_UNIX
,
307 $value = intval( $row->value
); // @bug 14414
313 $vals[] = array( 'qc_type' => $this->getName(),
314 'qc_namespace' => $row->namespace,
315 'qc_title' => $row->title
,
316 'qc_value' => $value );
319 # Save results into the querycache table on the master
320 if ( count( $vals ) ) {
321 if ( !$dbw->insert( 'querycache', $vals, __METHOD__
) ) {
322 // Set result to false to indicate error
326 if ( $ignoreErrors ) {
327 $dbw->ignoreErrors( $ignoreW );
328 $dbr->ignoreErrors( $ignoreR );
331 # Update the querycache_info record for the page
332 $dbw->delete( 'querycache_info', array( 'qci_type' => $this->getName() ), $fname );
333 $dbw->insert( 'querycache_info', array( 'qci_type' => $this->getName(), 'qci_timestamp' => $dbw->timestamp() ), $fname );
340 * Run the query and return the result
341 * @param $limit mixed Numerical limit or false for no limit
342 * @param $offset mixed Numerical offset or false for no offset
343 * @return ResultWrapper
345 function reallyDoQuery( $limit, $offset = false ) {
346 $fname = get_class( $this ) . "::reallyDoQuery";
347 $query = $this->getQueryInfo();
348 $order = $this->getOrderFields();
349 if ( $this->sortDescending() ) {
350 foreach ( $order as &$field ) {
354 if ( is_array( $query ) ) {
355 $tables = isset( $query['tables'] ) ?
(array)$query['tables'] : array();
356 $fields = isset( $query['fields'] ) ?
(array)$query['fields'] : array();
357 $conds = isset( $query['conds'] ) ?
(array)$query['conds'] : array();
358 $options = isset( $query['options'] ) ?
(array)$query['options'] : array();
359 $join_conds = isset( $query['join_conds'] ) ?
(array)$query['join_conds'] : array();
360 if ( count( $order ) ) {
361 $options['ORDER BY'] = implode( ', ', $order );
363 if ( $limit !== false ) {
364 $options['LIMIT'] = intval( $limit );
366 if ( $offset !== false ) {
367 $options['OFFSET'] = intval( $offset );
370 $dbr = wfGetDB( DB_SLAVE
);
371 $res = $dbr->select( $tables, $fields, $conds, $fname,
372 $options, $join_conds
375 // Old-fashioned raw SQL style, deprecated
376 $sql = $this->getSQL();
377 $sql .= ' ORDER BY ' . implode( ', ', $order );
378 $sql = $dbr->limitResult( $sql, $limit, $offset );
379 $res = $dbr->query( $sql );
381 return $dbr->resultObject( $res );
384 function doQuery( $limit, $offset = false ) {
385 if ( $this->isCached() && $this->isCacheable() ) {
386 return $this->fetchFromCache( $limit, $offset );
388 return $this->reallyDoQuery( $limit, $offset );
393 * Fetch the query results from the query cache
394 * @param $limit mixed Numerical limit or false for no limit
395 * @param $offset mixed Numerical offset or false for no offset
396 * @return ResultWrapper
398 function fetchFromCache( $limit, $offset = false ) {
399 $dbr = wfGetDB( DB_SLAVE
);
401 if ( $limit !== false ) {
402 $options['LIMIT'] = intval( $limit );
404 if ( $offset !== false ) {
405 $options['OFFSET'] = intval( $offset );
407 $res = $dbr->select( 'querycache', array( 'qc_type',
408 'qc_namespace AS namespace',
410 'qc_value AS value' ),
411 array( 'qc_type' => $this->getName() ),
414 return $dbr->resultObject( $res );
418 * This is the actual workhorse. It does everything needed to make a
419 * real, honest-to-gosh query page.
421 function execute( $par ) {
422 global $wgUser, $wgOut, $wgLang;
424 if ( !$this->userCanExecute( $wgUser ) ) {
425 $this->displayRestrictionError();
429 if ( $this->limit
== 0 && $this->offset
== 0 )
430 list( $this->limit
, $this->offset
) = wfCheckLimits();
431 $sname = $this->getName();
432 $fname = get_class( $this ) . '::doQuery';
433 $dbr = wfGetDB( DB_SLAVE
);
436 $wgOut->setSyndicated( $this->isSyndicated() );
438 if ( $this->isCached() && !$this->isCacheable() ) {
439 $wgOut->setSyndicated( false );
440 $wgOut->addWikiMsg( 'querypage-disabled' );
444 // TODO: Use doQuery()
446 if ( !$this->isCached() ) {
447 $res = $this->reallyDoQuery( $this->limit
, $this->offset
);
449 # Get the cached result
450 $res = $this->fetchFromCache( $this->limit
, $this->offset
);
451 if ( !$this->listoutput
) {
453 # Fetch the timestamp of this update
454 $tRes = $dbr->select( 'querycache_info', array( 'qci_timestamp' ), array( 'qci_type' => $sname ), $fname );
455 $tRow = $dbr->fetchObject( $tRes );
458 $updated = $wgLang->timeanddate( $tRow->qci_timestamp
, true, true );
459 $updateddate = $wgLang->date( $tRow->qci_timestamp
, true, true );
460 $updatedtime = $wgLang->time( $tRow->qci_timestamp
, true, true );
461 $wgOut->addMeta( 'Data-Cache-Time', $tRow->qci_timestamp
);
462 $wgOut->addInlineScript( "var dataCacheTime = '{$tRow->qci_timestamp}';" );
463 $wgOut->addWikiMsg( 'perfcachedts', $updated, $updateddate, $updatedtime );
465 $wgOut->addWikiMsg( 'perfcached' );
468 # If updates on this page have been disabled, let the user know
469 # that the data set won't be refreshed for now
470 global $wgDisableQueryPageUpdate;
471 if ( is_array( $wgDisableQueryPageUpdate ) && in_array( $this->getName(), $wgDisableQueryPageUpdate ) ) {
472 $wgOut->addWikiMsg( 'querypage-no-updates' );
479 $this->numRows
= $dbr->numRows( $res );
481 $this->preprocessResults( $dbr, $res );
483 $wgOut->addHTML( Xml
::openElement( 'div', array( 'class' => 'mw-spcontent' ) ) );
485 # Top header and navigation
486 if ( $this->shownavigation
) {
487 $wgOut->addHTML( $this->getPageHeader() );
488 if ( $this->numRows
> 0 ) {
489 $wgOut->addHTML( '<p>' . wfShowingResults( $this->offset
, $this->numRows
) . '</p>' );
490 # Disable the "next" link when we reach the end
491 $paging = wfViewPrevNext( $this->offset
, $this->limit
,
492 $this->getTitle( $par ),
493 wfArrayToCGI( $this->linkParameters() ), ( $this->numRows
< $this->limit
) );
494 $wgOut->addHTML( '<p>' . $paging . '</p>' );
496 # No results to show, so don't bother with "showing X of Y" etc.
497 # -- just let the user know and give up now
498 $wgOut->addHTML( '<p>' . wfMsgHtml( 'specialpage-empty' ) . '</p>' );
499 $wgOut->addHTML( Xml
::closeElement( 'div' ) );
504 # The actual results; specialist subclasses will want to handle this
505 # with more than a straight list, so we hand them the info, plus
506 # an OutputPage, and let them get on with it
507 $this->outputResults( $wgOut,
509 $dbr, # Should use a ResultWrapper for this
514 # Repeat the paging links at the bottom
515 if ( $this->shownavigation
) {
516 $wgOut->addHTML( '<p>' . $paging . '</p>' );
519 $wgOut->addHTML( Xml
::closeElement( 'div' ) );
521 return $this->numRows
;
525 * Format and output report results using the given information plus
528 * @param $out OutputPage to print to
529 * @param $skin Skin: user skin to use
530 * @param $dbr Database (read) connection to use
531 * @param $res Integer: result pointer
532 * @param $num Integer: number of available result rows
533 * @param $offset Integer: paging offset
535 protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
540 if ( !$this->listoutput
)
541 $html[] = $this->openList( $offset );
543 # $res might contain the whole 1,000 rows, so we read up to
544 # $num [should update this to use a Pager]
545 for ( $i = 0; $i < $num && $row = $dbr->fetchObject( $res ); $i++
) {
546 $line = $this->formatResult( $skin, $row );
548 $attr = ( isset( $row->usepatrol
) && $row->usepatrol
&& $row->patrolled
== 0 )
549 ?
' class="not-patrolled"'
551 $html[] = $this->listoutput
553 : "<li{$attr}>{$line}</li>\n";
557 # Flush the final result
558 if ( $this->tryLastResult() ) {
560 $line = $this->formatResult( $skin, $row );
562 $attr = ( isset( $row->usepatrol
) && $row->usepatrol
&& $row->patrolled
== 0 )
563 ?
' class="not-patrolled"'
565 $html[] = $this->listoutput
567 : "<li{$attr}>{$line}</li>\n";
571 if ( !$this->listoutput
)
572 $html[] = $this->closeList();
574 $html = $this->listoutput
575 ?
$wgContLang->listToText( $html )
576 : implode( '', $html );
578 $out->addHTML( $html );
582 function openList( $offset ) {
583 return "\n<ol start='" . ( $offset +
1 ) . "' class='special'>\n";
586 function closeList() {
591 * Do any necessary preprocessing of the result object.
593 function preprocessResults( $db, $res ) {}
596 * Similar to above, but packaging in a syndicated feed instead of a web page
598 function doFeed( $class = '', $limit = 50 ) {
599 global $wgFeed, $wgFeedClasses;
603 $wgOut->addWikiMsg( 'feed-unavailable' );
608 if ( $limit > $wgFeedLimit ) {
609 $limit = $wgFeedLimit;
612 if ( isset( $wgFeedClasses[$class] ) ) {
613 $feed = new $wgFeedClasses[$class](
619 $dbr = wfGetDB( DB_SLAVE
);
620 $res = $this->reallyDoQuery( $limit, 0 );
621 foreach ( $res as $obj ) {
622 $item = $this->feedResult( $obj );
624 $feed->outItem( $item );
636 * Override for custom handling. If the titles/links are ok, just do
639 function feedResult( $row ) {
640 if ( !isset( $row->title
) ) {
643 $title = Title
::MakeTitle( intval( $row->namespace ), $row->title
);
645 $date = isset( $row->timestamp
) ?
$row->timestamp
: '';
648 $talkpage = $title->getTalkPage();
649 $comments = $talkpage->getFullURL();
653 $title->getPrefixedText(),
654 $this->feedItemDesc( $row ),
655 $title->getFullURL(),
657 $this->feedItemAuthor( $row ),
664 function feedItemDesc( $row ) {
665 return isset( $row->comment
) ?
htmlspecialchars( $row->comment
) : '';
668 function feedItemAuthor( $row ) {
669 return isset( $row->user_text
) ?
$row->user_text
: '';
672 function feedTitle() {
673 global $wgLanguageCode, $wgSitename;
674 $page = SpecialPage
::getPage( $this->getName() );
675 $desc = $page->getDescription();
676 return "$wgSitename - $desc [$wgLanguageCode]";
679 function feedDesc() {
680 return wfMsgExt( 'tagline', 'parsemag' );
684 $title = SpecialPage
::getTitleFor( $this->getName() );
685 return $title->getFullURL();
690 * Class definition for a wanted query page like
691 * WantedPages, WantedTemplates, etc
693 abstract class WantedQueryPage
extends QueryPage
{
695 function isExpensive() {
699 function isSyndicated() {
704 * Cache page existence for performance
706 function preprocessResults( $db, $res ) {
707 $batch = new LinkBatch
;
708 foreach ( $res as $row ) {
709 $batch->add( $row->namespace, $row->title
);
713 // Back to start for display
714 if ( $db->numRows( $res ) > 0 )
715 // If there are no rows we get an error seeking.
716 $db->dataSeek( $res, 0 );
720 * Should formatResult() always check page existence, even if
721 * the results are fresh? This is a (hopefully temporary)
722 * kluge for Special:WantedFiles, which may contain false
723 * positives for files that exist e.g. in a shared repo (bug
726 function forceExistenceCheck() {
731 * Format an individual result
733 * @param $skin Skin to use for UI elements
734 * @param $result Result row
737 public function formatResult( $skin, $result ) {
738 $title = Title
::makeTitleSafe( $result->namespace, $result->title
);
739 if ( $title instanceof Title
) {
740 if ( $this->isCached() ||
$this->forceExistenceCheck() ) {
741 $pageLink = $title->isKnown()
742 ?
'<del>' . $skin->link( $title ) . '</del>'
751 $pageLink = $skin->link(
759 return wfSpecialList( $pageLink, $this->makeWlhLink( $title, $skin, $result ) );
761 $tsafe = htmlspecialchars( $result->title
);
762 return wfMsgHtml( 'wantedpages-badtitle', $tsafe );
767 * Make a "what links here" link for a given title
769 * @param $title Title to make the link for
770 * @param $skin Skin object to use
771 * @param $result Object: result row
774 private function makeWlhLink( $title, $skin, $result ) {
776 $wlh = SpecialPage
::getTitleFor( 'Whatlinkshere' );
777 $label = wfMsgExt( 'nlinks', array( 'parsemag', 'escape' ),
778 $wgLang->formatNum( $result->value
) );
779 return $skin->link( $wlh, $label, array(), array( 'target' => $title->getPrefixedText() ) );