QueryPage.php

Go to the documentation of this file.

<?php
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\DBError;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\ILoadBalancer;
use Wikimedia\Rdbms\IResultWrapper;
 
abstract class QueryPage extends SpecialPage {
    protected $listoutput = false;
 
    protected $offset = 0;
 
    protected $limit = 0;
 
    protected $numRows;
 
    protected $cachedTimestamp = null;
 
    protected $shownavigation = true;
 
    private $loadBalancer = null;
 
    private $linkBatchFactory = null;
 
    public static function getPages() {
        static $qp = null;
 
        if ( $qp === null ) {
            $qp = [
                [ SpecialAncientPages::class, 'Ancientpages' ],
                [ SpecialBrokenRedirects::class, 'BrokenRedirects' ],
                [ SpecialDeadendPages::class, 'Deadendpages' ],
                [ SpecialDoubleRedirects::class, 'DoubleRedirects' ],
                [ SpecialListDuplicatedFiles::class, 'ListDuplicatedFiles' ],
                [ SpecialLinkSearch::class, 'LinkSearch' ],
                [ SpecialListRedirects::class, 'Listredirects' ],
                [ SpecialLonelyPages::class, 'Lonelypages' ],
                [ SpecialLongPages::class, 'Longpages' ],
                [ SpecialMediaStatistics::class, 'MediaStatistics', SpecialMediaStatistics::MAX_LIMIT ],
                [ SpecialMIMESearch::class, 'MIMEsearch' ],
                [ SpecialMostCategories::class, 'Mostcategories' ],
                [ MostimagesPage::class, 'Mostimages' ],
                [ SpecialMostInterwikis::class, 'Mostinterwikis' ],
                [ SpecialMostLinkedCategories::class, 'Mostlinkedcategories' ],
                [ SpecialMostLinkedTemplates::class, 'Mostlinkedtemplates' ],
                [ SpecialMostLinked::class, 'Mostlinked' ],
                [ SpecialMostRevisions::class, 'Mostrevisions' ],
                [ SpecialFewestRevisions::class, 'Fewestrevisions' ],
                [ SpecialShortPages::class, 'Shortpages' ],
                [ SpecialUncategorizedCategories::class, 'Uncategorizedcategories' ],
                [ SpecialUncategorizedPages::class, 'Uncategorizedpages' ],
                [ SpecialUncategorizedImages::class, 'Uncategorizedimages' ],
                [ SpecialUncategorizedTemplates::class, 'Uncategorizedtemplates' ],
                [ SpecialUnusedCategories::class, 'Unusedcategories' ],
                [ SpecialUnusedImages::class, 'Unusedimages' ],
                [ SpecialWantedCategories::class, 'Wantedcategories' ],
                [ WantedFilesPage::class, 'Wantedfiles' ],
                [ WantedPagesPage::class, 'Wantedpages' ],
                [ SpecialWantedTemplates::class, 'Wantedtemplates' ],
                [ SpecialUnwatchedPages::class, 'Unwatchedpages' ],
                [ SpecialUnusedTemplates::class, 'Unusedtemplates' ],
                [ SpecialWithoutInterwiki::class, 'Withoutinterwiki' ],
            ];
            Hooks::runner()->onWgQueryPages( $qp );
        }
 
        return $qp;
    }
 
    final protected function setLinkBatchFactory( LinkBatchFactory $linkBatchFactory ) {
        $this->linkBatchFactory = $linkBatchFactory;
    }
 
    final protected function getLinkBatchFactory(): LinkBatchFactory {
        if ( $this->linkBatchFactory === null ) {
            // Fallback if not provided
            // TODO Change to wfWarn in a future release
            $this->linkBatchFactory = MediaWikiServices::getInstance()->getLinkBatchFactory();
        }
        return $this->linkBatchFactory;
    }
 
    public static function getDisabledQueryPages( Config $config ) {
        $disableQueryPageUpdate = $config->get( MainConfigNames::DisableQueryPageUpdate );
 
        if ( !is_array( $disableQueryPageUpdate ) ) {
            return [];
        }
 
        $pages = [];
        foreach ( $disableQueryPageUpdate as $name => $runMode ) {
            if ( is_int( $name ) ) {
                // The run mode may be omitted
                $pages[$runMode] = 'disabled';
            } else {
                $pages[$name] = $runMode;
            }
        }
        return $pages;
    }
 
    protected function setListoutput( $bool ) {
        $this->listoutput = $bool;
    }
 
    public function getQueryInfo() {
        // @phan-suppress-next-line PhanTypeMismatchReturnProbablyReal null needed for b/c checks
        return null;
    }
 
    protected function getSQL() {
        MWDebug::detectDeprecatedOverride(
            $this,
            __CLASS__,
            'getSQL',
            '1.39'
        );
        throw new MWException( "Bug in a QueryPage: doesn't implement getQueryInfo() nor "
            . "getQuery() properly" );
    }
 
    protected function getOrderFields() {
        return [ 'value' ];
    }
 
    public function usesTimestamps() {
        return false;
    }
 
    protected function sortDescending() {
        return true;
    }
 
    public function isExpensive() {
        return $this->getConfig()->get( MainConfigNames::DisableQueryPages );
    }
 
    public function isCacheable() {
        return true;
    }
 
    public function isCached() {
        return $this->isExpensive() && $this->getConfig()->get( MainConfigNames::MiserMode );
    }
 
    public function isSyndicated() {
        return true;
    }
 
    abstract protected function formatResult( $skin, $result );
 
    protected function getPageHeader() {
        return '';
    }
 
    protected function showEmptyText() {
        $this->getOutput()->addWikiMsg( 'specialpage-empty' );
    }
 
    protected function linkParameters() {
        return [];
    }
 
    public function recache( $limit, $ignoreErrors = true ) {
        if ( !$this->isCacheable() ) {
            return 0;
        }
 
        $fname = static::class . '::recache';
        $dbw = $this->getDBLoadBalancer()->getConnectionRef( ILoadBalancer::DB_PRIMARY );
 
        try {
            // Do query
            $res = $this->reallyDoQuery( $limit, false );
            $num = false;
            if ( $res ) {
                $num = $res->numRows();
                // Fetch results
                $vals = [];
                foreach ( $res as $i => $row ) {
                    if ( isset( $row->value ) ) {
                        if ( $this->usesTimestamps() ) {
                            $value = (int)wfTimestamp( TS_UNIX, $row->value );
                        } else {
                            $value = intval( $row->value ); // T16414
                        }
                    } else {
                        $value = $i;
                    }
 
                    $vals[] = [
                        'qc_type' => $this->getName(),
                        'qc_namespace' => $row->namespace,
                        'qc_title' => $row->title,
                        'qc_value' => $value
                    ];
                }
 
                $dbw->doAtomicSection(
                    __METHOD__,
                    function ( IDatabase $dbw, $fname ) use ( $vals ) {
                        // Clear out any old cached data
                        $dbw->delete( 'querycache',
                            [ 'qc_type' => $this->getName() ],
                            $fname
                        );
                        // Save results into the querycache table on the primary DB
                        if ( count( $vals ) ) {
                            $dbw->insert( 'querycache', $vals, $fname );
                        }
                        // Update the querycache_info record for the page
                        $dbw->upsert(
                            'querycache_info',
                            [
                                'qci_type' => $this->getName(),
                                'qci_timestamp' => $dbw->timestamp(),
                            ],
                            'qci_type',
                            [
                                'qci_timestamp' => $dbw->timestamp(),
                            ],
                            $fname
                        );
                    }
                );
            }
        } catch ( DBError $e ) {
            if ( !$ignoreErrors ) {
                throw $e; // report query error
            }
            $num = false; // set result to false to indicate error
        }
 
        return $num;
    }
 
    protected function getRecacheDB() {
        return $this->getDBLoadBalancer()
            ->getConnectionRef( ILoadBalancer::DB_REPLICA, [ $this->getName(), 'QueryPage::recache', 'vslow' ] );
    }
 
    public function delete( LinkTarget $title ) {
        if ( $this->isCached() ) {
            $dbw = $this->getDBLoadBalancer()->getConnectionRef( ILoadBalancer::DB_PRIMARY );
            $dbw->delete( 'querycache', [
                'qc_type' => $this->getName(),
                'qc_namespace' => $title->getNamespace(),
                'qc_title' => $title->getDBkey(),
            ], __METHOD__ );
        }
    }
 
    public function deleteAllCachedData() {
        $fname = static::class . '::' . __FUNCTION__;
        $dbw = $this->getDBLoadBalancer()->getConnectionRef( ILoadBalancer::DB_PRIMARY );
        $dbw->delete( 'querycache',
            [ 'qc_type' => $this->getName() ],
            $fname
        );
        $dbw->delete( 'querycachetwo',
            [ 'qcc_type' => $this->getName() ],
            $fname
        );
        $dbw->delete( 'querycache_info',
            [ 'qci_type' => $this->getName() ],
            $fname
        );
    }
 
    public function reallyDoQuery( $limit, $offset = false ) {
        $fname = static::class . '::reallyDoQuery';
        $dbr = $this->getRecacheDB();
        $query = $this->getQueryInfo();
        $order = $this->getOrderFields();
 
        if ( $this->sortDescending() ) {
            foreach ( $order as &$field ) {
                $field .= ' DESC';
            }
        }
 
        if ( is_array( $query ) ) {
            $tables = isset( $query['tables'] ) ? (array)$query['tables'] : [];
            $fields = isset( $query['fields'] ) ? (array)$query['fields'] : [];
            $conds = isset( $query['conds'] ) ? (array)$query['conds'] : [];
            $options = isset( $query['options'] ) ? (array)$query['options'] : [];
            $join_conds = isset( $query['join_conds'] ) ? (array)$query['join_conds'] : [];
 
            if ( $order ) {
                $options['ORDER BY'] = $order;
            }
 
            if ( $limit !== false ) {
                $options['LIMIT'] = intval( $limit );
            }
 
            if ( $offset !== false ) {
                $options['OFFSET'] = intval( $offset );
            }
 
            $res = $dbr->select( $tables, $fields, $conds, $fname,
                    $options, $join_conds
            );
        } else {
            // Old-fashioned raw SQL style, deprecated
            $sql = $this->getSQL();
            $sql .= ' ORDER BY ' . implode( ', ', $order );
            $sql = $dbr->limitResult( $sql, $limit, $offset );
            $res = $dbr->query( $sql, $fname );
        }
 
        return $res;
    }
 
    public function doQuery( $offset = false, $limit = false ) {
        if ( $this->isCached() && $this->isCacheable() ) {
            return $this->fetchFromCache( $limit, $offset );
        } else {
            return $this->reallyDoQuery( $limit, $offset );
        }
    }
 
    public function fetchFromCache( $limit, $offset = false ) {
        $dbr = $this->getDBLoadBalancer()->getConnectionRef( ILoadBalancer::DB_REPLICA );
        $options = [];
 
        if ( $limit !== false ) {
            $options['LIMIT'] = intval( $limit );
        }
 
        if ( $offset !== false ) {
            $options['OFFSET'] = intval( $offset );
        }
 
        $order = $this->getCacheOrderFields();
        if ( $this->sortDescending() ) {
            foreach ( $order as &$field ) {
                $field .= " DESC";
            }
        }
        if ( $order ) {
            $options['ORDER BY'] = $order;
        }
 
        return $dbr->select( 'querycache',
                [ 'qc_type',
                'namespace' => 'qc_namespace',
                'title' => 'qc_title',
                'value' => 'qc_value' ],
                [ 'qc_type' => $this->getName() ],
                __METHOD__,
                $options
        );
    }
 
    protected function getCacheOrderFields() {
        return [ 'value' ];
    }
 
    public function getCachedTimestamp() {
        if ( $this->cachedTimestamp === null ) {
            $dbr = $this->getDBLoadBalancer()->getConnectionRef( ILoadBalancer::DB_REPLICA );
            $fname = static::class . '::getCachedTimestamp';
            $this->cachedTimestamp = $dbr->selectField( 'querycache_info', 'qci_timestamp',
                [ 'qci_type' => $this->getName() ], $fname );
        }
        return $this->cachedTimestamp;
    }
 
    protected function getLimitOffset() {
        list( $limit, $offset ) = $this->getRequest()
            ->getLimitOffsetForUser( $this->getUser() );
        if ( $this->getConfig()->get( MainConfigNames::MiserMode ) ) {
            $maxResults = $this->getMaxResults();
            // Can't display more than max results on a page
            $limit = min( $limit, $maxResults );
            // Can't skip over more than the end of $maxResults
            $offset = min( $offset, $maxResults + 1 );
        }
        return [ $limit, $offset ];
    }
 
    protected function getDBLimit( $uiLimit, $uiOffset ) {
        $maxResults = $this->getMaxResults();
        if ( $this->getConfig()->get( MainConfigNames::MiserMode ) ) {
            $limit = min( $uiLimit + 1, $maxResults - $uiOffset );
            return max( $limit, 0 );
        } else {
            return $uiLimit + 1;
        }
    }
 
    protected function getMaxResults() {
        // Max of 10000, unless we store more than 10000 in query cache.
        return max( $this->getConfig()->get( MainConfigNames::QueryCacheLimit ), 10000 );
    }
 
    public function execute( $par ) {
        $this->checkPermissions();
 
        $this->setHeaders();
        $this->outputHeader();
 
        $out = $this->getOutput();
 
        if ( $this->isCached() && !$this->isCacheable() ) {
            $out->addWikiMsg( 'querypage-disabled' );
            return;
        }
 
        $out->setSyndicated( $this->isSyndicated() );
 
        if ( $this->limit == 0 && $this->offset == 0 ) {
            list( $this->limit, $this->offset ) = $this->getLimitOffset();
        }
        $dbLimit = $this->getDBLimit( $this->limit, $this->offset );
        // @todo Use doQuery()
        if ( !$this->isCached() ) {
            // select one extra row for navigation
            $res = $this->reallyDoQuery( $dbLimit, $this->offset );
        } else {
            // Get the cached result, select one extra row for navigation
            $res = $this->fetchFromCache( $dbLimit, $this->offset );
            if ( !$this->listoutput ) {
                // Fetch the timestamp of this update
                $ts = $this->getCachedTimestamp();
                $lang = $this->getLanguage();
                $maxResults = $lang->formatNum( $this->getConfig()->get(
                    MainConfigNames::QueryCacheLimit ) );
 
                if ( $ts ) {
                    $user = $this->getUser();
                    $updated = $lang->userTimeAndDate( $ts, $user );
                    $updateddate = $lang->userDate( $ts, $user );
                    $updatedtime = $lang->userTime( $ts, $user );
                    $out->addMeta( 'Data-Cache-Time', $ts );
                    $out->addJsConfigVars( 'dataCacheTime', $ts );
                    $out->addWikiMsg( 'perfcachedts', $updated, $updateddate, $updatedtime, $maxResults );
                } else {
                    $out->addWikiMsg( 'perfcached', $maxResults );
                }
 
                // If updates on this page have been disabled, let the user know
                // that the data set won't be refreshed for now
                $disabledQueryPages = self::getDisabledQueryPages( $this->getConfig() );
                if ( isset( $disabledQueryPages[$this->getName()] ) ) {
                    $runMode = $disabledQueryPages[$this->getName()];
                    if ( $runMode === 'disabled' ) {
                        $out->wrapWikiMsg(
                            "<div class=\"mw-querypage-no-updates\">\n$1\n</div>",
                            'querypage-no-updates'
                        );
                    } else {
                        // Messages used here: querypage-updates-periodical
                        $out->wrapWikiMsg(
                            "<div class=\"mw-querypage-updates-" . $runMode . "\">\n$1\n</div>",
                            'querypage-updates-' . $runMode
                        );
                    }
                }
            }
        }
 
        $this->numRows = $res->numRows();
 
        $dbr = $this->getRecacheDB();
        $this->preprocessResults( $dbr, $res );
 
        $out->addHTML( Xml::openElement( 'div', [ 'class' => 'mw-spcontent' ] ) );
 
        // Top header and navigation
        if ( $this->shownavigation ) {
            $out->addHTML( $this->getPageHeader() );
            if ( $this->numRows > 0 ) {
                $out->addHTML( $this->msg( 'showingresultsinrange' )->numParams(
                    min( $this->numRows, $this->limit ), // do not show the one extra row, if exist
                    $this->offset + 1, ( min( $this->numRows, $this->limit ) + $this->offset ) )->parseAsBlock() );
                // Disable the "next" link when we reach the end
                $miserMaxResults = $this->getConfig()->get( MainConfigNames::MiserMode )
                    && ( $this->offset + $this->limit >= $this->getMaxResults() );
                $atEnd = ( $this->numRows <= $this->limit ) || $miserMaxResults;
                $paging = $this->buildPrevNextNavigation( $this->offset,
                    $this->limit, $this->linkParameters(), $atEnd, $par );
                $out->addHTML( '<p>' . $paging . '</p>' );
            } else {
                // No results to show, so don't bother with "showing X of Y" etc.
                // -- just let the user know and give up now
                $this->showEmptyText();
                $out->addHTML( Xml::closeElement( 'div' ) );
                return;
            }
        }
 
        // The actual results; specialist subclasses will want to handle this
        // with more than a straight list, so we hand them the info, plus
        // an OutputPage, and let them get on with it
        $this->outputResults( $out,
            $this->getSkin(),
            $dbr, // Should use IResultWrapper for this
            $res,
            min( $this->numRows, $this->limit ), // do not format the one extra row, if exist
            $this->offset );
 
        // Repeat the paging links at the bottom
        if ( $this->shownavigation ) {
            // @phan-suppress-next-line PhanPossiblyUndeclaredVariable paging is set when used here
            $out->addHTML( '<p>' . $paging . '</p>' );
        }
 
        $out->addHTML( Xml::closeElement( 'div' ) );
    }
 
    protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
        if ( $num > 0 ) {
            $html = [];
            if ( !$this->listoutput ) {
                $html[] = $this->openList( $offset );
            }
 
            // $res might contain the whole 1,000 rows, so we read up to
            // $num [should update this to use a Pager]
            for ( $i = 0; $i < $num && $row = $res->fetchObject(); $i++ ) {
                $line = $this->formatResult( $skin, $row );
                if ( $line ) {
                    $html[] = $this->listoutput
                        ? $line
                        : "<li>{$line}</li>\n";
                }
            }
 
            if ( !$this->listoutput ) {
                $html[] = $this->closeList();
            }
 
            $html = $this->listoutput
                ? $this->getContentLanguage()->listToText( $html )
                : implode( '', $html );
 
            $out->addHTML( $html );
        }
    }
 
    protected function openList( $offset ) {
        return "\n<ol start='" . ( $offset + 1 ) . "' class='special'>\n";
    }
 
    protected function closeList() {
        return "</ol>\n";
    }
 
    protected function preprocessResults( $db, $res ) {
    }
 
    protected function executeLBFromResultWrapper( IResultWrapper $res, $ns = null ) {
        if ( !$res->numRows() ) {
            return;
        }
 
        $batch = $this->getLinkBatchFactory()->newLinkBatch();
        foreach ( $res as $row ) {
            $batch->add( $ns ?? (int)$row->namespace, $row->title );
        }
        $batch->execute();
 
        $res->seek( 0 );
    }
 
    final protected function setDBLoadBalancer( ILoadBalancer $loadBalancer ) {
        $this->loadBalancer = $loadBalancer;
    }
 
    final protected function getDBLoadBalancer(): ILoadBalancer {
        if ( $this->loadBalancer === null ) {
            // Fallback if not provided
            // TODO Change to wfWarn in a future release
            $this->loadBalancer = MediaWikiServices::getInstance()->getDBLoadBalancer();
        }
        return $this->loadBalancer;
    }
}