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().
88 protected $cachedTimestamp = null;
91 * Wheter to show prev/next links
93 protected $shownavigation = true;
96 * A mutator for $this->listoutput;
98 * @param $bool Boolean
100 function setListoutput( $bool ) {
101 $this->listoutput
= $bool;
105 * Subclasses return an SQL query here, formatted as an array with the
107 * tables => Table(s) for passing to Database::select()
108 * fields => Field(s) for passing to Database::select(), may be *
109 * conds => WHERE conditions
111 * join_conds => JOIN conditions
113 * Note that the query itself should return the following three columns:
114 * 'namespace', 'title', and 'value'. 'value' is used for sorting.
116 * These may be stored in the querycache table for expensive queries,
117 * and that cached data will be returned sometimes, so the presence of
118 * extra fields can't be relied upon. The cached 'value' column will be
119 * an integer; non-numeric values are useful only for sorting the
120 * initial query (except if they're timestamps, see usesTimestamps()).
122 * Don't include an ORDER or LIMIT clause, they will be added.
124 * If this function is not overridden or returns something other than
125 * an array, getSQL() will be used instead. This is for backwards
126 * compatibility only and is strongly deprecated.
130 function getQueryInfo() {
135 * For back-compat, subclasses may return a raw SQL query here, as a string.
136 * This is stronly deprecated; getQueryInfo() should be overridden instead.
140 /* Implement getQueryInfo() instead */
141 throw new MWException( "Bug in a QueryPage: doesn't implement getQueryInfo() nor getQuery() properly" );
145 * Subclasses return an array of fields to order by here. Don't append
146 * DESC to the field names, that'll be done automatically if
147 * sortDescending() returns true.
151 function getOrderFields() {
152 return array( 'value' );
156 * Does this query return timestamps rather than integers in its
157 * 'value' field? If true, this class will convert 'value' to a
158 * UNIX timestamp for caching.
159 * NOTE: formatRow() may get timestamps in TS_MW (mysql), TS_DB (pgsql)
160 * or TS_UNIX (querycache) format, so be sure to always run them
161 * through wfTimestamp()
165 function usesTimestamps() {
170 * Override to sort by increasing values
174 function sortDescending() {
179 * Is this query expensive (for some definition of expensive)? Then we
180 * don't let it run in miser mode. $wgDisableQueryPages causes all query
181 * pages to be declared expensive. Some query pages are always expensive.
185 function isExpensive() {
186 global $wgDisableQueryPages;
187 return $wgDisableQueryPages;
191 * Is the output of this query cacheable? Non-cacheable expensive pages
192 * will be disabled in miser mode and will not have their results written
193 * to the querycache table.
197 public function isCacheable() {
202 * Whether or not the output of the page in question is retrieved from
203 * the database cache.
207 function isCached() {
210 return $this->isExpensive() && $wgMiserMode;
214 * Sometime we dont want to build rss / atom feeds.
218 function isSyndicated() {
223 * Formats the results of the query for display. The skin is the current
224 * skin; you can use it for making links. The result is a single row of
225 * result data. You should be able to grab SQL results off of it.
226 * If the function returns false, the line output will be skipped.
228 * @param $result object Result row
229 * @return mixed String or false to skip
231 * @param $skin Skin object
232 * @param $result Object: database row
234 abstract function formatResult( $skin, $result );
237 * The content returned by this function will be output before any result
241 function getPageHeader() {
246 * If using extra form wheely-dealies, return a set of parameters here
247 * as an associative array. They will be encoded and added to the paging
248 * links (prev/next/lengths).
252 function linkParameters() {
257 * Some special pages (for example SpecialListusers) might not return the
258 * current object formatted, but return the previous one instead.
259 * Setting this to return true will ensure formatResult() is called
260 * one more time to make sure that the very last result is formatted
263 function tryLastResult() {
268 * Clear the cache and save new results
270 * @param $limit Integer: limit for SQL statement
271 * @param $ignoreErrors Boolean: whether to ignore database errors
273 function recache( $limit, $ignoreErrors = true ) {
274 if ( !$this->isCacheable() ) {
278 $fname = get_class( $this ) . '::recache';
279 $dbw = wfGetDB( DB_MASTER
);
280 $dbr = wfGetDB( DB_SLAVE
, array( $this->getName(), __METHOD__
, 'vslow' ) );
281 if ( !$dbw ||
!$dbr ) {
285 if ( $ignoreErrors ) {
286 $ignoreW = $dbw->ignoreErrors( true );
287 $ignoreR = $dbr->ignoreErrors( true );
290 # Clear out any old cached data
291 $dbw->delete( 'querycache', array( 'qc_type' => $this->getName() ), $fname );
293 $res = $this->reallyDoQuery( $limit, false );
296 $num = $dbr->numRows( $res );
299 while ( $res && $row = $dbr->fetchObject( $res ) ) {
300 if ( isset( $row->value
) ) {
301 if ( $this->usesTimestamps() ) {
302 $value = wfTimestamp( TS_UNIX
,
305 $value = intval( $row->value
); // @bug 14414
311 $vals[] = array( 'qc_type' => $this->getName(),
312 'qc_namespace' => $row->namespace,
313 'qc_title' => $row->title
,
314 'qc_value' => $value );
317 # Save results into the querycache table on the master
318 if ( count( $vals ) ) {
319 if ( !$dbw->insert( 'querycache', $vals, __METHOD__
) ) {
320 // Set result to false to indicate error
324 if ( $ignoreErrors ) {
325 $dbw->ignoreErrors( $ignoreW );
326 $dbr->ignoreErrors( $ignoreR );
329 # Update the querycache_info record for the page
330 $dbw->delete( 'querycache_info', array( 'qci_type' => $this->getName() ), $fname );
331 $dbw->insert( 'querycache_info', array( 'qci_type' => $this->getName(), 'qci_timestamp' => $dbw->timestamp() ), $fname );
338 * Run the query and return the result
339 * @param $limit mixed Numerical limit or false for no limit
340 * @param $offset mixed Numerical offset or false for no offset
341 * @return ResultWrapper
344 function reallyDoQuery( $limit, $offset = false ) {
345 $fname = get_class( $this ) . "::reallyDoQuery";
346 $dbr = wfGetDB( DB_SLAVE
);
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 $res = $dbr->select( $tables, $fields, $conds, $fname,
371 $options, $join_conds
374 // Old-fashioned raw SQL style, deprecated
375 $sql = $this->getSQL();
376 $sql .= ' ORDER BY ' . implode( ', ', $order );
377 $sql = $dbr->limitResult( $sql, $limit, $offset );
378 $res = $dbr->query( $sql, $fname );
380 return $dbr->resultObject( $res );
384 * Somewhat deprecated, you probably want to be using execute()
386 function doQuery( $offset = false, $limit = false ) {
387 if ( $this->isCached() && $this->isCacheable() ) {
388 return $this->fetchFromCache( $limit, $offset );
390 return $this->reallyDoQuery( $limit, $offset );
395 * Fetch the query results from the query cache
396 * @param $limit mixed Numerical limit or false for no limit
397 * @param $offset mixed Numerical offset or false for no offset
398 * @return ResultWrapper
401 function fetchFromCache( $limit, $offset = false ) {
402 $dbr = wfGetDB( DB_SLAVE
);
404 if ( $limit !== false ) {
405 $options['LIMIT'] = intval( $limit );
407 if ( $offset !== false ) {
408 $options['OFFSET'] = intval( $offset );
410 if ( $this->sortDescending() ) {
411 $options['ORDER BY'] = 'qc_value DESC';
413 $options['ORDER BY'] = 'qc_value ASC';
415 $res = $dbr->select( 'querycache', array( 'qc_type',
416 'qc_namespace AS namespace',
418 'qc_value AS value' ),
419 array( 'qc_type' => $this->getName() ),
422 return $dbr->resultObject( $res );
425 public function getCachedTimestamp() {
426 if ( !is_null( $this->cachedTimestamp
) ) {
427 $dbr = wfGetDB( DB_SLAVE
);
428 $fname = get_class( $this ) . '::getCachedTimestamp';
429 $this->cachedTimestamp
= $dbr->selectField( 'querycache_info', 'qci_timestamp',
430 array( 'qci_type' => $this->getName() ), $fname );
432 return $this->cachedTimestamp
;
436 * This is the actual workhorse. It does everything needed to make a
437 * real, honest-to-gosh query page.
439 function execute( $par ) {
440 global $wgUser, $wgOut, $wgLang, $wgRequest;
442 if ( !$this->userCanExecute( $wgUser ) ) {
443 $this->displayRestrictionError();
447 if ( $this->limit
== 0 && $this->offset
== 0 ) {
448 list( $this->limit
, $this->offset
) = $wgRequest->getLimitOffset();
450 $dbr = wfGetDB( DB_SLAVE
);
453 $wgOut->setSyndicated( $this->isSyndicated() );
455 if ( $this->isCached() && !$this->isCacheable() ) {
456 $wgOut->setSyndicated( false );
457 $wgOut->addWikiMsg( 'querypage-disabled' );
461 // TODO: Use doQuery()
463 if ( !$this->isCached() ) {
464 $res = $this->reallyDoQuery( $this->limit
, $this->offset
);
466 # Get the cached result
467 $res = $this->fetchFromCache( $this->limit
, $this->offset
);
468 if ( !$this->listoutput
) {
470 # Fetch the timestamp of this update
471 $ts = $this->getCachedTimestamp();
474 $updated = $wgLang->timeanddate( $ts, true, true );
475 $updateddate = $wgLang->date( $ts, true, true );
476 $updatedtime = $wgLang->time( $ts, true, true );
477 $wgOut->addMeta( 'Data-Cache-Time', $ts );
478 $wgOut->addInlineScript( "var dataCacheTime = '$ts';" );
479 $wgOut->addWikiMsg( 'perfcachedts', $updated, $updateddate, $updatedtime );
481 $wgOut->addWikiMsg( 'perfcached' );
484 # If updates on this page have been disabled, let the user know
485 # that the data set won't be refreshed for now
486 global $wgDisableQueryPageUpdate;
487 if ( is_array( $wgDisableQueryPageUpdate ) && in_array( $this->getName(), $wgDisableQueryPageUpdate ) ) {
488 $wgOut->addWikiMsg( 'querypage-no-updates' );
495 $this->numRows
= $dbr->numRows( $res );
497 $this->preprocessResults( $dbr, $res );
499 $wgOut->addHTML( Xml
::openElement( 'div', array( 'class' => 'mw-spcontent' ) ) );
501 # Top header and navigation
502 if ( $this->shownavigation
) {
503 $wgOut->addHTML( $this->getPageHeader() );
504 if ( $this->numRows
> 0 ) {
505 $wgOut->addHTML( '<p>' . wfShowingResults( $this->offset
, $this->numRows
) . '</p>' );
506 # Disable the "next" link when we reach the end
507 $paging = wfViewPrevNext( $this->offset
, $this->limit
,
508 $this->getTitle( $par ),
509 wfArrayToCGI( $this->linkParameters() ), ( $this->numRows
< $this->limit
) );
510 $wgOut->addHTML( '<p>' . $paging . '</p>' );
512 # No results to show, so don't bother with "showing X of Y" etc.
513 # -- just let the user know and give up now
514 $wgOut->addHTML( '<p>' . wfMsgHtml( 'specialpage-empty' ) . '</p>' );
515 $wgOut->addHTML( Xml
::closeElement( 'div' ) );
520 # The actual results; specialist subclasses will want to handle this
521 # with more than a straight list, so we hand them the info, plus
522 # an OutputPage, and let them get on with it
523 $this->outputResults( $wgOut,
525 $dbr, # Should use a ResultWrapper for this
530 # Repeat the paging links at the bottom
531 if ( $this->shownavigation
) {
532 $wgOut->addHTML( '<p>' . $paging . '</p>' );
535 $wgOut->addHTML( Xml
::closeElement( 'div' ) );
537 return $this->numRows
;
541 * Format and output report results using the given information plus
544 * @param $out OutputPage to print to
545 * @param $skin Skin: user skin to use
546 * @param $dbr Database (read) connection to use
547 * @param $res Integer: result pointer
548 * @param $num Integer: number of available result rows
549 * @param $offset Integer: paging offset
551 protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
556 if ( !$this->listoutput
) {
557 $html[] = $this->openList( $offset );
560 # $res might contain the whole 1,000 rows, so we read up to
561 # $num [should update this to use a Pager]
562 for ( $i = 0; $i < $num && $row = $dbr->fetchObject( $res ); $i++
) {
563 $line = $this->formatResult( $skin, $row );
565 $attr = ( isset( $row->usepatrol
) && $row->usepatrol
&& $row->patrolled
== 0 )
566 ?
' class="not-patrolled"'
568 $html[] = $this->listoutput
570 : "<li{$attr}>{$line}</li>\n";
574 # Flush the final result
575 if ( $this->tryLastResult() ) {
577 $line = $this->formatResult( $skin, $row );
579 $attr = ( isset( $row->usepatrol
) && $row->usepatrol
&& $row->patrolled
== 0 )
580 ?
' class="not-patrolled"'
582 $html[] = $this->listoutput
584 : "<li{$attr}>{$line}</li>\n";
588 if ( !$this->listoutput
) {
589 $html[] = $this->closeList();
592 $html = $this->listoutput
593 ?
$wgContLang->listToText( $html )
594 : implode( '', $html );
596 $out->addHTML( $html );
600 function openList( $offset ) {
601 return "\n<ol start='" . ( $offset +
1 ) . "' class='special'>\n";
604 function closeList() {
609 * Do any necessary preprocessing of the result object.
611 function preprocessResults( $db, $res ) {}
614 * Similar to above, but packaging in a syndicated feed instead of a web page
616 function doFeed( $class = '', $limit = 50 ) {
617 global $wgFeed, $wgFeedClasses;
621 $wgOut->addWikiMsg( 'feed-unavailable' );
626 if ( $limit > $wgFeedLimit ) {
627 $limit = $wgFeedLimit;
630 if ( isset( $wgFeedClasses[$class] ) ) {
631 $feed = new $wgFeedClasses[$class](
637 $res = $this->reallyDoQuery( $limit, 0 );
638 foreach ( $res as $obj ) {
639 $item = $this->feedResult( $obj );
641 $feed->outItem( $item );
653 * Override for custom handling. If the titles/links are ok, just do
656 function feedResult( $row ) {
657 if ( !isset( $row->title
) ) {
660 $title = Title
::MakeTitle( intval( $row->namespace ), $row->title
);
662 $date = isset( $row->timestamp
) ?
$row->timestamp
: '';
665 $talkpage = $title->getTalkPage();
666 $comments = $talkpage->getFullURL();
670 $title->getPrefixedText(),
671 $this->feedItemDesc( $row ),
672 $title->getFullURL(),
674 $this->feedItemAuthor( $row ),
681 function feedItemDesc( $row ) {
682 return isset( $row->comment
) ?
htmlspecialchars( $row->comment
) : '';
685 function feedItemAuthor( $row ) {
686 return isset( $row->user_text
) ?
$row->user_text
: '';
689 function feedTitle() {
690 global $wgLanguageCode, $wgSitename;
691 $desc = $this->getDescription();
692 return "$wgSitename - $desc [$wgLanguageCode]";
695 function feedDesc() {
696 return wfMsgExt( 'tagline', 'parsemag' );
700 return $this->getTitle()->getFullURL();
705 * Class definition for a wanted query page like
706 * WantedPages, WantedTemplates, etc
708 abstract class WantedQueryPage
extends QueryPage
{
710 function isExpensive() {
714 function isSyndicated() {
719 * Cache page existence for performance
721 function preprocessResults( $db, $res ) {
722 $batch = new LinkBatch
;
723 foreach ( $res as $row ) {
724 $batch->add( $row->namespace, $row->title
);
728 // Back to start for display
729 if ( $db->numRows( $res ) > 0 )
730 // If there are no rows we get an error seeking.
731 $db->dataSeek( $res, 0 );
735 * Should formatResult() always check page existence, even if
736 * the results are fresh? This is a (hopefully temporary)
737 * kluge for Special:WantedFiles, which may contain false
738 * positives for files that exist e.g. in a shared repo (bug
741 function forceExistenceCheck() {
746 * Format an individual result
748 * @param $skin Skin to use for UI elements
749 * @param $result Result row
752 public function formatResult( $skin, $result ) {
753 $title = Title
::makeTitleSafe( $result->namespace, $result->title
);
754 if ( $title instanceof Title
) {
755 if ( $this->isCached() ||
$this->forceExistenceCheck() ) {
756 $pageLink = $title->isKnown()
757 ?
'<del>' . $skin->link( $title ) . '</del>'
766 $pageLink = $skin->link(
774 return wfSpecialList( $pageLink, $this->makeWlhLink( $title, $skin, $result ) );
776 $tsafe = htmlspecialchars( $result->title
);
777 return wfMsgHtml( 'wantedpages-badtitle', $tsafe );
782 * Make a "what links here" link for a given title
784 * @param $title Title to make the link for
785 * @param $skin Skin object to use
786 * @param $result Object: result row
789 private function makeWlhLink( $title, $skin, $result ) {
791 $wlh = SpecialPage
::getTitleFor( 'Whatlinkshere' );
792 $label = wfMsgExt( 'nlinks', array( 'parsemag', 'escape' ),
793 $wgLang->formatNum( $result->value
) );
794 return $skin->link( $wlh, $label, array(), array( 'target' => $title->getPrefixedText() ) );