ApiFeedRecentChanges.php

Go to the documentation of this file.

<?php
class ApiFeedRecentChanges extends ApiBase {

    public function getCustomPrinter() {
        return new ApiFormatFeedWrapper( $this->getMain() );
    }

    public function execute() {
        global $wgFeed, $wgFeedClasses;

        $this->params = $this->extractRequestParams();

        if ( !$wgFeed ) {
            $this->dieUsage( 'Syndication feeds are not available', 'feed-unavailable' );
        }

        if ( !isset( $wgFeedClasses[$this->params['feedformat']] ) ) {
            $this->dieUsage( 'Invalid subscription feed type', 'feed-invalid' );
        }

        $this->getMain()->setCacheMode( 'public' );
        if ( !$this->getMain()->getParameter( 'smaxage' ) ) {
            // bug 63249: This page gets hit a lot, cache at least 15 seconds.
            $this->getMain()->setCacheMaxAge( 15 );
        }

        $feedFormat = $this->params['feedformat'];
        $specialClass = $this->params['target'] !== null
            ? 'SpecialRecentchangeslinked'
            : 'SpecialRecentchanges';

        $formatter = $this->getFeedObject( $feedFormat, $specialClass );

        // Everything is passed implicitly via $wgRequest… :(
        // The row-getting functionality should maybe be factored out of ChangesListSpecialPage too…
        $rc = new $specialClass();
        $rows = $rc->getRows();

        $feedItems = $rows ? ChangesFeed::buildItems( $rows ) : array();

        ApiFormatFeedWrapper::setResult( $this->getResult(), $formatter, $feedItems );
    }

    public function getFeedObject( $feedFormat, $specialClass ) {
        if ( $specialClass === 'SpecialRecentchangeslinked' ) {
            $title = Title::newFromText( $this->params['target'] );
            if ( !$title ) {
                $this->dieUsageMsg( array( 'invalidtitle', $this->params['target'] ) );
            }

            $feed = new ChangesFeed( $feedFormat, false );
            $feedObj = $feed->getFeedObject(
                $this->msg( 'recentchangeslinked-title', $title->getPrefixedText() )
                    ->inContentLanguage()->text(),
                $this->msg( 'recentchangeslinked-feed' )->inContentLanguage()->text(),
                SpecialPage::getTitleFor( 'Recentchangeslinked' )->getFullURL()
            );
        } else {
            $feed = new ChangesFeed( $feedFormat, 'rcfeed' );
            $feedObj = $feed->getFeedObject(
                $this->msg( 'recentchanges' )->inContentLanguage()->text(),
                $this->msg( 'recentchanges-feed-description' )->inContentLanguage()->text(),
                SpecialPage::getTitleFor( 'Recentchanges' )->getFullURL()
            );
        }

        return $feedObj;
    }

    public function getAllowedParams() {
        global $wgFeedClasses, $wgAllowCategorizedRecentChanges, $wgFeedLimit;
        $feedFormatNames = array_keys( $wgFeedClasses );

        $ret = array(
            'feedformat' => array(
                ApiBase::PARAM_DFLT => 'rss',
                ApiBase::PARAM_TYPE => $feedFormatNames,
            ),

            'namespace' => array(
                ApiBase::PARAM_TYPE => 'namespace',
            ),
            'invert' => false,
            'associated' => false,

            'days' => array(
                ApiBase::PARAM_DFLT => 7,
                ApiBase::PARAM_MIN => 1,
                ApiBase::PARAM_TYPE => 'integer',
            ),
            'limit' => array(
                ApiBase::PARAM_DFLT => 50,
                ApiBase::PARAM_MIN => 1,
                ApiBase::PARAM_MAX => $wgFeedLimit,
                ApiBase::PARAM_TYPE => 'integer',
            ),
            'from' => array(
                ApiBase::PARAM_TYPE => 'timestamp',
            ),

            'hideminor' => false,
            'hidebots' => false,
            'hideanons' => false,
            'hideliu' => false,
            'hidepatrolled' => false,
            'hidemyself' => false,

            'tagfilter' => array(
                ApiBase::PARAM_TYPE => 'string',
            ),

            'target' => array(
                ApiBase::PARAM_TYPE => 'string',
            ),
            'showlinkedto' => false,
        );

        if ( $wgAllowCategorizedRecentChanges ) {
            $ret += array(
                'categories' => array(
                    ApiBase::PARAM_TYPE => 'string',
                    ApiBase::PARAM_ISMULTI => true,
                ),
                'categories_any' => false,
            );
        }

        return $ret;
    }

    public function getParamDescription() {
        return array(
            'feedformat' => 'The format of the feed',
            'namespace' => 'Namespace to limit the results to',
            'invert' => 'All namespaces but the selected one',
            'associated' => 'Include associated (talk or main) namespace',
            'days' => 'Days to limit the results to',
            'limit' => 'Maximum number of results to return',
            'from' => 'Show changes since then',
            'hideminor' => 'Hide minor changes',
            'hidebots' => 'Hide changes made by bots',
            'hideanons' => 'Hide changes made by anonymous users',
            'hideliu' => 'Hide changes made by registered users',
            'hidepatrolled' => 'Hide patrolled changes',
            'hidemyself' => 'Hide changes made by yourself',
            'tagfilter' => 'Filter by tag',
            'target' => 'Show only changes on pages linked from this page',
            'showlinkedto' => 'Show changes on pages linked to the selected page instead',
            'categories' => 'Show only changes on pages in all of these categories',
            'categories_any' => 'Show only changes on pages in any of the categories instead',
        );
    }

    public function getDescription() {
        return 'Returns a recent changes feed';
    }

    public function getPossibleErrors() {
        return array_merge( parent::getPossibleErrors(), array(
            array( 'code' => 'feed-unavailable', 'info' => 'Syndication feeds are not available' ),
            array( 'code' => 'feed-invalid', 'info' => 'Invalid subscription feed type' ),
        ) );
    }

    public function getExamples() {
        return array(
            'api.php?action=feedrecentchanges',
            'api.php?action=feedrecentchanges&days=30'
        );
    }
}