3 * Base code for "query" special pages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * This is a class for doing query pages; since they're almost all the same,
26 * we factor out some of the functionality into a superclass, and let
27 * subclasses derive from it.
28 * @ingroup SpecialPage
30 abstract class QueryPage
extends SpecialPage
{
31 /** @var bool Whether or not we want plain listoutput rather than an ordered list */
32 protected $listoutput = false;
34 /** @var int The offset and limit in use, as passed to the query() function */
35 protected $offset = 0;
41 * The number of rows returned by the query. Reading this variable
42 * only makes sense in functions that are run after the query has been
43 * done, such as preprocessResults() and formatRow().
47 protected $cachedTimestamp = null;
50 * Whether to show prev/next links
52 protected $shownavigation = true;
55 * Get a list of query page classes and their associated special pages,
56 * for periodic updates.
58 * DO NOT CHANGE THIS LIST without testing that
59 * maintenance/updateSpecialPages.php still works.
62 public static function getPages() {
66 // QueryPage subclass, Special page name
68 array( 'AncientPagesPage', 'Ancientpages' ),
69 array( 'BrokenRedirectsPage', 'BrokenRedirects' ),
70 array( 'DeadendPagesPage', 'Deadendpages' ),
71 array( 'DoubleRedirectsPage', 'DoubleRedirects' ),
72 array( 'FileDuplicateSearchPage', 'FileDuplicateSearch' ),
73 array( 'ListDuplicatedFilesPage', 'ListDuplicatedFiles' ),
74 array( 'LinkSearchPage', 'LinkSearch' ),
75 array( 'ListredirectsPage', 'Listredirects' ),
76 array( 'LonelyPagesPage', 'Lonelypages' ),
77 array( 'LongPagesPage', 'Longpages' ),
78 array( 'MediaStatisticsPage', 'MediaStatistics' ),
79 array( 'MIMEsearchPage', 'MIMEsearch' ),
80 array( 'MostcategoriesPage', 'Mostcategories' ),
81 array( 'MostimagesPage', 'Mostimages' ),
82 array( 'MostinterwikisPage', 'Mostinterwikis' ),
83 array( 'MostlinkedCategoriesPage', 'Mostlinkedcategories' ),
84 array( 'MostlinkedTemplatesPage', 'Mostlinkedtemplates' ),
85 array( 'MostlinkedPage', 'Mostlinked' ),
86 array( 'MostrevisionsPage', 'Mostrevisions' ),
87 array( 'FewestrevisionsPage', 'Fewestrevisions' ),
88 array( 'ShortPagesPage', 'Shortpages' ),
89 array( 'UncategorizedCategoriesPage', 'Uncategorizedcategories' ),
90 array( 'UncategorizedPagesPage', 'Uncategorizedpages' ),
91 array( 'UncategorizedImagesPage', 'Uncategorizedimages' ),
92 array( 'UncategorizedTemplatesPage', 'Uncategorizedtemplates' ),
93 array( 'UnusedCategoriesPage', 'Unusedcategories' ),
94 array( 'UnusedimagesPage', 'Unusedimages' ),
95 array( 'WantedCategoriesPage', 'Wantedcategories' ),
96 array( 'WantedFilesPage', 'Wantedfiles' ),
97 array( 'WantedPagesPage', 'Wantedpages' ),
98 array( 'WantedTemplatesPage', 'Wantedtemplates' ),
99 array( 'UnwatchedpagesPage', 'Unwatchedpages' ),
100 array( 'UnusedtemplatesPage', 'Unusedtemplates' ),
101 array( 'WithoutInterwikiPage', 'Withoutinterwiki' ),
103 Hooks
::run( 'wgQueryPages', array( &$qp ) );
110 * A mutator for $this->listoutput;
114 function setListoutput( $bool ) {
115 $this->listoutput
= $bool;
119 * Subclasses return an SQL query here, formatted as an array with the
121 * tables => Table(s) for passing to Database::select()
122 * fields => Field(s) for passing to Database::select(), may be *
123 * conds => WHERE conditions
125 * join_conds => JOIN conditions
127 * Note that the query itself should return the following three columns:
128 * 'namespace', 'title', and 'value'. 'value' is used for sorting.
130 * These may be stored in the querycache table for expensive queries,
131 * and that cached data will be returned sometimes, so the presence of
132 * extra fields can't be relied upon. The cached 'value' column will be
133 * an integer; non-numeric values are useful only for sorting the
134 * initial query (except if they're timestamps, see usesTimestamps()).
136 * Don't include an ORDER or LIMIT clause, they will be added.
138 * If this function is not overridden or returns something other than
139 * an array, getSQL() will be used instead. This is for backwards
140 * compatibility only and is strongly deprecated.
144 public function getQueryInfo() {
149 * For back-compat, subclasses may return a raw SQL query here, as a string.
150 * This is strongly deprecated; getQueryInfo() should be overridden instead.
151 * @throws MWException
155 /* Implement getQueryInfo() instead */
156 throw new MWException( "Bug in a QueryPage: doesn't implement getQueryInfo() nor "
157 . "getQuery() properly" );
161 * Subclasses return an array of fields to order by here. Don't append
162 * DESC to the field names, that'll be done automatically if
163 * sortDescending() returns true.
167 function getOrderFields() {
168 return array( 'value' );
172 * Does this query return timestamps rather than integers in its
173 * 'value' field? If true, this class will convert 'value' to a
174 * UNIX timestamp for caching.
175 * NOTE: formatRow() may get timestamps in TS_MW (mysql), TS_DB (pgsql)
176 * or TS_UNIX (querycache) format, so be sure to always run them
177 * through wfTimestamp()
181 public function usesTimestamps() {
186 * Override to sort by increasing values
190 function sortDescending() {
195 * Is this query expensive (for some definition of expensive)? Then we
196 * don't let it run in miser mode. $wgDisableQueryPages causes all query
197 * pages to be declared expensive. Some query pages are always expensive.
201 public function isExpensive() {
202 return $this->getConfig()->get( 'DisableQueryPages' );
206 * Is the output of this query cacheable? Non-cacheable expensive pages
207 * will be disabled in miser mode and will not have their results written
208 * to the querycache table.
212 public function isCacheable() {
217 * Whether or not the output of the page in question is retrieved from
218 * the database cache.
222 public function isCached() {
223 return $this->isExpensive() && $this->getConfig()->get( 'MiserMode' );
227 * Sometime we don't want to build rss / atom feeds.
231 function isSyndicated() {
236 * Formats the results of the query for display. The skin is the current
237 * skin; you can use it for making links. The result is a single row of
238 * result data. You should be able to grab SQL results off of it.
239 * If the function returns false, the line output will be skipped.
241 * @param object $result Result row
242 * @return string|bool String or false to skip
244 abstract function formatResult( $skin, $result );
247 * The content returned by this function will be output before any result
251 function getPageHeader() {
256 * Outputs some kind of an informative message (via OutputPage) to let the
257 * user know that the query returned nothing and thus there's nothing to
262 protected function showEmptyText() {
263 $this->getOutput()->addWikiMsg( 'specialpage-empty' );
267 * If using extra form wheely-dealies, return a set of parameters here
268 * as an associative array. They will be encoded and added to the paging
269 * links (prev/next/lengths).
273 function linkParameters() {
278 * Some special pages (for example SpecialListusers used to) might not return the
279 * current object formatted, but return the previous one instead.
280 * Setting this to return true will ensure formatResult() is called
281 * one more time to make sure that the very last result is formatted
284 * @deprecated since 1.27
288 function tryLastResult() {
293 * Clear the cache and save new results
295 * @param int|bool $limit Limit for SQL statement
296 * @param bool $ignoreErrors Whether to ignore database errors
297 * @throws DBError|Exception
300 public function recache( $limit, $ignoreErrors = true ) {
301 if ( !$this->isCacheable() ) {
305 $fname = get_class( $this ) . '::recache';
306 $dbw = wfGetDB( DB_MASTER
);
313 $res = $this->reallyDoQuery( $limit, false );
316 $num = $res->numRows();
319 foreach ( $res as $row ) {
320 if ( isset( $row->value
) ) {
321 if ( $this->usesTimestamps() ) {
322 $value = wfTimestamp( TS_UNIX
,
325 $value = intval( $row->value
); // @bug 14414
332 'qc_type' => $this->getName(),
333 'qc_namespace' => $row->namespace,
334 'qc_title' => $row->title
,
340 $dbw->doAtomicSection(
342 function ( IDatabase
$dbw, $fname ) use ( $that, $vals ) {
343 # Clear out any old cached data
344 $dbw->delete( 'querycache',
345 array( 'qc_type' => $that->getName() ),
348 # Save results into the querycache table on the master
349 if ( count( $vals ) ) {
350 $dbw->insert( 'querycache', $vals, $fname );
352 # Update the querycache_info record for the page
353 $dbw->delete( 'querycache_info',
354 array( 'qci_type' => $that->getName() ),
357 $dbw->insert( 'querycache_info',
358 array( 'qci_type' => $that->getName(),
359 'qci_timestamp' => $dbw->timestamp() ),
365 } catch ( DBError
$e ) {
366 if ( !$ignoreErrors ) {
367 throw $e; // report query error
369 $num = false; // set result to false to indicate error
376 * Get a DB connection to be used for slow recache queries
379 function getRecacheDB() {
380 return wfGetDB( DB_SLAVE
, array( $this->getName(), 'QueryPage::recache', 'vslow' ) );
384 * Run the query and return the result
385 * @param int|bool $limit Numerical limit or false for no limit
386 * @param int|bool $offset Numerical offset or false for no offset
387 * @return ResultWrapper
390 public function reallyDoQuery( $limit, $offset = false ) {
391 $fname = get_class( $this ) . "::reallyDoQuery";
392 $dbr = $this->getRecacheDB();
393 $query = $this->getQueryInfo();
394 $order = $this->getOrderFields();
396 if ( $this->sortDescending() ) {
397 foreach ( $order as &$field ) {
402 if ( is_array( $query ) ) {
403 $tables = isset( $query['tables'] ) ?
(array)$query['tables'] : array();
404 $fields = isset( $query['fields'] ) ?
(array)$query['fields'] : array();
405 $conds = isset( $query['conds'] ) ?
(array)$query['conds'] : array();
406 $options = isset( $query['options'] ) ?
(array)$query['options'] : array();
407 $join_conds = isset( $query['join_conds'] ) ?
(array)$query['join_conds'] : array();
409 if ( count( $order ) ) {
410 $options['ORDER BY'] = $order;
413 if ( $limit !== false ) {
414 $options['LIMIT'] = intval( $limit );
417 if ( $offset !== false ) {
418 $options['OFFSET'] = intval( $offset );
421 $res = $dbr->select( $tables, $fields, $conds, $fname,
422 $options, $join_conds
425 // Old-fashioned raw SQL style, deprecated
426 $sql = $this->getSQL();
427 $sql .= ' ORDER BY ' . implode( ', ', $order );
428 $sql = $dbr->limitResult( $sql, $limit, $offset );
429 $res = $dbr->query( $sql, $fname );
436 * Somewhat deprecated, you probably want to be using execute()
437 * @param int|bool $offset
438 * @param int|bool $limit
439 * @return ResultWrapper
441 public function doQuery( $offset = false, $limit = false ) {
442 if ( $this->isCached() && $this->isCacheable() ) {
443 return $this->fetchFromCache( $limit, $offset );
445 return $this->reallyDoQuery( $limit, $offset );
450 * Fetch the query results from the query cache
451 * @param int|bool $limit Numerical limit or false for no limit
452 * @param int|bool $offset Numerical offset or false for no offset
453 * @return ResultWrapper
456 public function fetchFromCache( $limit, $offset = false ) {
457 $dbr = wfGetDB( DB_SLAVE
);
459 if ( $limit !== false ) {
460 $options['LIMIT'] = intval( $limit );
462 if ( $offset !== false ) {
463 $options['OFFSET'] = intval( $offset );
465 if ( $this->sortDescending() ) {
466 $options['ORDER BY'] = 'qc_value DESC';
468 $options['ORDER BY'] = 'qc_value ASC';
470 return $dbr->select( 'querycache', array( 'qc_type',
471 'namespace' => 'qc_namespace',
472 'title' => 'qc_title',
473 'value' => 'qc_value' ),
474 array( 'qc_type' => $this->getName() ),
479 public function getCachedTimestamp() {
480 if ( is_null( $this->cachedTimestamp
) ) {
481 $dbr = wfGetDB( DB_SLAVE
);
482 $fname = get_class( $this ) . '::getCachedTimestamp';
483 $this->cachedTimestamp
= $dbr->selectField( 'querycache_info', 'qci_timestamp',
484 array( 'qci_type' => $this->getName() ), $fname );
486 return $this->cachedTimestamp
;
490 * Returns limit and offset, as returned by $this->getRequest()->getLimitOffset().
491 * Subclasses may override this to further restrict or modify limit and offset.
493 * @note Restricts the offset parameter, as most query pages have inefficient paging
496 * @return int[] list( $limit, $offset )
498 protected function getLimitOffset() {
499 list( $limit, $offset ) = $this->getRequest()->getLimitOffset();
500 if ( !$this->getConfig()->get( 'MiserMode' ) ) {
501 $maxResults = $this->getMaxResults();
502 // Can't display more than max results on a page
503 $limit = min( $limit, $maxResults );
504 // Can't skip over more than $maxResults
505 $offset = min( $offset, $maxResults );
506 // Can't let $offset + $limit > $maxResults
507 $limit = min( $limit, $maxResults - $offset );
509 return array( $limit, $offset );
513 * Get max number of results we can return in miser mode.
515 * Most QueryPage subclasses use inefficient paging, so limit the max amount we return
516 * This matters for uncached query pages that might otherwise accept an offset of 3 million
521 protected function getMaxResults() {
522 // Max of 10000, unless we store more than 5000 in query cache.
523 return max( $this->getConfig()->get( 'QueryCacheLimit' ), 10000 );
527 * This is the actual workhorse. It does everything needed to make a
528 * real, honest-to-gosh query page.
531 public function execute( $par ) {
532 $user = $this->getUser();
533 if ( !$this->userCanExecute( $user ) ) {
534 $this->displayRestrictionError();
539 $this->outputHeader();
541 $out = $this->getOutput();
543 if ( $this->isCached() && !$this->isCacheable() ) {
544 $out->addWikiMsg( 'querypage-disabled' );
548 $out->setSyndicated( $this->isSyndicated() );
550 if ( $this->limit
== 0 && $this->offset
== 0 ) {
551 list( $this->limit
, $this->offset
) = $this->getLimitOffset();
554 // @todo Use doQuery()
555 if ( !$this->isCached() ) {
556 # select one extra row for navigation
557 $res = $this->reallyDoQuery( $this->limit +
1, $this->offset
);
559 # Get the cached result, select one extra row for navigation
560 $res = $this->fetchFromCache( $this->limit +
1, $this->offset
);
561 if ( !$this->listoutput
) {
563 # Fetch the timestamp of this update
564 $ts = $this->getCachedTimestamp();
565 $lang = $this->getLanguage();
566 $maxResults = $lang->formatNum( $this->getConfig()->get( 'QueryCacheLimit' ) );
569 $updated = $lang->userTimeAndDate( $ts, $user );
570 $updateddate = $lang->userDate( $ts, $user );
571 $updatedtime = $lang->userTime( $ts, $user );
572 $out->addMeta( 'Data-Cache-Time', $ts );
573 $out->addJsConfigVars( 'dataCacheTime', $ts );
574 $out->addWikiMsg( 'perfcachedts', $updated, $updateddate, $updatedtime, $maxResults );
576 $out->addWikiMsg( 'perfcached', $maxResults );
579 # If updates on this page have been disabled, let the user know
580 # that the data set won't be refreshed for now
581 if ( is_array( $this->getConfig()->get( 'DisableQueryPageUpdate' ) )
582 && in_array( $this->getName(), $this->getConfig()->get( 'DisableQueryPageUpdate' ) )
585 "<div class=\"mw-querypage-no-updates\">\n$1\n</div>",
586 'querypage-no-updates'
592 $this->numRows
= $res->numRows();
594 $dbr = $this->getRecacheDB();
595 $this->preprocessResults( $dbr, $res );
597 $out->addHTML( Xml
::openElement( 'div', array( 'class' => 'mw-spcontent' ) ) );
599 # Top header and navigation
600 if ( $this->shownavigation
) {
601 $out->addHTML( $this->getPageHeader() );
602 if ( $this->numRows
> 0 ) {
603 $out->addHTML( $this->msg( 'showingresultsinrange' )->numParams(
604 min( $this->numRows
, $this->limit
), # do not show the one extra row, if exist
605 $this->offset +
1, ( min( $this->numRows
, $this->limit
) +
$this->offset
) )->parseAsBlock() );
606 # Disable the "next" link when we reach the end
607 $atEnd = ( $this->numRows
<= $this->limit
)
608 ||
( $this->offset +
$this-> limit
>= $this->getMaxResults() );
609 $paging = $this->getLanguage()->viewPrevNext( $this->getPageTitle( $par ), $this->offset
,
610 $this->limit
, $this->linkParameters(), $atEnd );
611 $out->addHTML( '<p>' . $paging . '</p>' );
613 # No results to show, so don't bother with "showing X of Y" etc.
614 # -- just let the user know and give up now
615 $this->showEmptyText();
616 $out->addHTML( Xml
::closeElement( 'div' ) );
621 # The actual results; specialist subclasses will want to handle this
622 # with more than a straight list, so we hand them the info, plus
623 # an OutputPage, and let them get on with it
624 $this->outputResults( $out,
626 $dbr, # Should use a ResultWrapper for this
628 min( $this->numRows
, $this->limit
), # do not format the one extra row, if exist
631 # Repeat the paging links at the bottom
632 if ( $this->shownavigation
) {
633 $out->addHTML( '<p>' . $paging . '</p>' );
636 $out->addHTML( Xml
::closeElement( 'div' ) );
640 * Format and output report results using the given information plus
643 * @param OutputPage $out OutputPage to print to
644 * @param Skin $skin User skin to use
645 * @param IDatabase $dbr Database (read) connection to use
646 * @param ResultWrapper $res Result pointer
647 * @param int $num Number of available result rows
648 * @param int $offset Paging offset
650 protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
655 if ( !$this->listoutput
) {
656 $html[] = $this->openList( $offset );
659 # $res might contain the whole 1,000 rows, so we read up to
660 # $num [should update this to use a Pager]
661 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
662 for ( $i = 0; $i < $num && $row = $res->fetchObject(); $i++
) {
663 // @codingStandardsIgnoreEnd
664 $line = $this->formatResult( $skin, $row );
666 $html[] = $this->listoutput
668 : "<li>{$line}</li>\n";
672 # Flush the final result
673 if ( $this->tryLastResult() ) {
675 $line = $this->formatResult( $skin, $row );
677 $html[] = $this->listoutput
679 : "<li>{$line}</li>\n";
683 if ( !$this->listoutput
) {
684 $html[] = $this->closeList();
687 $html = $this->listoutput
688 ?
$wgContLang->listToText( $html )
689 : implode( '', $html );
691 $out->addHTML( $html );
699 function openList( $offset ) {
700 return "\n<ol start='" . ( $offset +
1 ) . "' class='special'>\n";
706 function closeList() {
711 * Do any necessary preprocessing of the result object.
712 * @param IDatabase $db
713 * @param ResultWrapper $res
715 function preprocessResults( $db, $res ) {
719 * Similar to above, but packaging in a syndicated feed instead of a web page
720 * @param string $class
724 function doFeed( $class = '', $limit = 50 ) {
725 if ( !$this->getConfig()->get( 'Feed' ) ) {
726 $this->getOutput()->addWikiMsg( 'feed-unavailable' );
730 $limit = min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
732 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
733 if ( isset( $feedClasses[$class] ) ) {
734 /** @var RSSFeed|AtomFeed $feed */
735 $feed = new $feedClasses[$class](
741 $res = $this->reallyDoQuery( $limit, 0 );
742 foreach ( $res as $obj ) {
743 $item = $this->feedResult( $obj );
745 $feed->outItem( $item );
757 * Override for custom handling. If the titles/links are ok, just do
760 * @return FeedItem|null
762 function feedResult( $row ) {
763 if ( !isset( $row->title
) ) {
766 $title = Title
::makeTitle( intval( $row->namespace ), $row->title
);
768 $date = isset( $row->timestamp
) ?
$row->timestamp
: '';
771 $talkpage = $title->getTalkPage();
772 $comments = $talkpage->getFullURL();
776 $title->getPrefixedText(),
777 $this->feedItemDesc( $row ),
778 $title->getFullURL(),
780 $this->feedItemAuthor( $row ),
787 function feedItemDesc( $row ) {
788 return isset( $row->comment
) ?
htmlspecialchars( $row->comment
) : '';
791 function feedItemAuthor( $row ) {
792 return isset( $row->user_text
) ?
$row->user_text
: '';
795 function feedTitle() {
796 $desc = $this->getDescription();
797 $code = $this->getConfig()->get( 'LanguageCode' );
798 $sitename = $this->getConfig()->get( 'Sitename' );
799 return "$sitename - $desc [$code]";
802 function feedDesc() {
803 return $this->msg( 'tagline' )->text();
807 return $this->getPageTitle()->getFullURL();