ApiPurge.php

Go to the documentation of this file.

<?php

class ApiPurge extends ApiBase {

        private $mPageSet;

        private static function addValues( array &$result, $values, $flag = null, $name = null ) {
                foreach ( $values as $val ) {
                        if( $val instanceof Title ) {
                                $v = array();
                                ApiQueryBase::addTitleInfo( $v, $val );
                        } elseif( $name !== null ) {
                                $v = array( $name => $val );
                        } else {
                                $v = $val;
                        }
                        if( $flag !== null ) {
                                $v[$flag] = '';
                        }
                        $result[] = $v;
                }
        }

        public function execute() {
                $params = $this->extractRequestParams();

                $forceLinkUpdate = $params['forcelinkupdate'];
                $pageSet = $this->getPageSet();
                $pageSet->execute();

                $result = array();
                self::addValues( $result, $pageSet->getInvalidTitles(), 'invalid', 'title' );
                self::addValues( $result, $pageSet->getSpecialTitles(), 'special', 'title' );
                self::addValues( $result, $pageSet->getMissingPageIDs(), 'missing', 'pageid' );
                self::addValues( $result, $pageSet->getMissingRevisionIDs(), 'missing', 'revid' );
                self::addValues( $result, $pageSet->getMissingTitles(), 'missing' );
                self::addValues( $result, $pageSet->getInterwikiTitlesAsResult() );

                foreach ( $pageSet->getGoodTitles() as $title ) {
                        $r = array();
                        ApiQueryBase::addTitleInfo( $r, $title );
                        $page = WikiPage::factory( $title );
                        $page->doPurge(); // Directly purge and skip the UI part of purge().
                        $r['purged'] = '';

                        if ( $forceLinkUpdate ) {
                                if ( !$this->getUser()->pingLimiter() ) {
                                        global $wgEnableParserCache;

                                        $popts = $page->makeParserOptions( 'canonical' );

                                        # Parse content; note that HTML generation is only needed if we want to cache the result.
                                        $content = $page->getContent( Revision::RAW );
                                        $p_result = $content->getParserOutput( $title, $page->getLatest(), $popts, $wgEnableParserCache );

                                        # Update the links tables
                                        $updates = $content->getSecondaryDataUpdates( $title, null, true, $p_result );
                                        DataUpdate::runUpdates( $updates );

                                        $r['linkupdate'] = '';

                                        if ( $wgEnableParserCache ) {
                                                $pcache = ParserCache::singleton();
                                                $pcache->save( $p_result, $page, $popts );
                                        }
                                } else {
                                        $error = $this->parseMsg( array( 'actionthrottledtext' ) );
                                        $this->setWarning( $error['info'] );
                                        $forceLinkUpdate = false;
                                }
                        }

                        $result[] = $r;
                }
                $apiResult = $this->getResult();
                $apiResult->setIndexedTagName( $result, 'page' );
                $apiResult->addValue( null, $this->getModuleName(), $result );

                $values = $pageSet->getNormalizedTitlesAsResult( $apiResult );
                if ( $values ) {
                        $apiResult->addValue( null, 'normalized', $values );
                }
                $values = $pageSet->getConvertedTitlesAsResult( $apiResult );
                if ( $values ) {
                        $apiResult->addValue( null, 'converted', $values );
                }
                $values = $pageSet->getRedirectTitlesAsResult( $apiResult );
                if ( $values ) {
                        $apiResult->addValue( null, 'redirects', $values );
                }
        }

        private function getPageSet() {
                if ( !isset( $this->mPageSet ) ) {
                        $this->mPageSet = new ApiPageSet( $this );
                }
                return $this->mPageSet;
        }

        public function isWriteMode() {
                return true;
        }

        public function mustBePosted() {
                // Anonymous users are not allowed a non-POST request
                return !$this->getUser()->isAllowed( 'purge' );
        }

        public function getAllowedParams( $flags = 0 ) {
                $result = array( 'forcelinkupdate' => false );
                if ( $flags ) {
                        $result += $this->getPageSet()->getFinalParams( $flags );
                }
                return $result;
        }

        public function getParamDescription() {
                return $this->getPageSet()->getParamDescription()
                        + array( 'forcelinkupdate' => 'Update the links tables' );
        }

        public function getResultProperties() {
                return array(
                        ApiBase::PROP_LIST => true,
                        '' => array(
                                'ns' => array(
                                        ApiBase::PROP_TYPE => 'namespace',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'title' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'pageid' => array(
                                        ApiBase::PROP_TYPE => 'integer',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'revid' => array(
                                        ApiBase::PROP_TYPE => 'integer',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                                'invalid' => 'boolean',
                                'special' => 'boolean',
                                'missing' => 'boolean',
                                'purged' => 'boolean',
                                'linkupdate' => 'boolean',
                                'iw' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                ),
                        )
                );
        }

        public function getDescription() {
                return array( 'Purge the cache for the given titles.',
                        'Requires a POST request if the user is not logged in.'
                );
        }

        public function getPossibleErrors() {
                return array_merge(
                        parent::getPossibleErrors(),
                        $this->getPageSet()->getPossibleErrors()
                );
        }

        public function getExamples() {
                return array(
                        'api.php?action=purge&titles=Main_Page|API' => 'Purge the "Main Page" and the "API" page',
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:Purge';
        }
}