ApiFeedWatchlist.php

Go to the documentation of this file.

<?php
class ApiFeedWatchlist extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

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

        private $linkToDiffs = false;

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

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

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

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

                        // limit to the number of hours going from now back
                        $endTime = wfTimestamp( TS_MW, time() - intval( $params['hours'] * 60 * 60 ) );

                        // Prepare parameters for nested request
                        $fauxReqArr = array(
                                'action' => 'query',
                                'meta' => 'siteinfo',
                                'siprop' => 'general',
                                'list' => 'watchlist',
                                'wlprop' => 'title|user|comment|timestamp',
                                'wldir' => 'older', // reverse order - from newest to oldest
                                'wlend' => $endTime, // stop at this time
                                'wllimit' => ( 50 > $wgFeedLimit ) ? $wgFeedLimit : 50
                        );

                        if ( !is_null( $params['wlowner'] ) ) {
                                $fauxReqArr['wlowner'] = $params['wlowner'];
                        }
                        if ( !is_null( $params['wltoken'] ) ) {
                                $fauxReqArr['wltoken'] = $params['wltoken'];
                        }

                        // Support linking to diffs instead of article
                        if ( $params['linktodiffs'] ) {
                                $this->linkToDiffs = true;
                                $fauxReqArr['wlprop'] .= '|ids';
                        }

                        // Check for 'allrev' parameter, and if found, show all revisions to each page on wl.
                        if ( $params['allrev'] ) {
                                $fauxReqArr['wlallrev'] = '';
                        }

                        // Create the request
                        $fauxReq = new FauxRequest( $fauxReqArr );

                        // Execute
                        $module = new ApiMain( $fauxReq );
                        $module->execute();

                        // Get data array
                        $data = $module->getResultData();

                        $feedItems = array();
                        foreach ( (array)$data['query']['watchlist'] as $info ) {
                                $feedItems[] = $this->createFeedItem( $info );
                        }

                        $msg = wfMessage( 'watchlist' )->inContentLanguage()->text();

                        $feedTitle = $wgSitename . ' - ' . $msg . ' [' . $wgLanguageCode . ']';
                        $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL();

                        $feed = new $wgFeedClasses[$params['feedformat']] ( $feedTitle, htmlspecialchars( $msg ), $feedUrl );

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

                } catch ( Exception $e ) {

                        // Error results should not be cached
                        $this->getMain()->setCacheMaxAge( 0 );

                        $feedTitle = $wgSitename . ' - Error - ' . wfMessage( 'watchlist' )->inContentLanguage()->text() . ' [' . $wgLanguageCode . ']';
                        $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL();

                        $feedFormat = isset( $params['feedformat'] ) ? $params['feedformat'] : 'rss';
                        $msg = wfMessage( 'watchlist' )->inContentLanguage()->escaped();
                        $feed = new $wgFeedClasses[$feedFormat] ( $feedTitle, $msg, $feedUrl );

                        if ( $e instanceof UsageException ) {
                                $errorCode = $e->getCodeString();
                        } else {
                                // Something is seriously wrong
                                $errorCode = 'internal_api_error';
                        }

                        $errorText = $e->getMessage();
                        $feedItems[] = new FeedItem( "Error ($errorCode)", $errorText, '', '', '' );
                        ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
                }
        }

        private function createFeedItem( $info ) {
                $titleStr = $info['title'];
                $title = Title::newFromText( $titleStr );
                if ( $this->linkToDiffs && isset( $info['revid'] ) ) {
                        $titleUrl = $title->getFullURL( array( 'diff' => $info['revid'] ) );
                } else {
                        $titleUrl = $title->getFullURL();
                }
                $comment = isset( $info['comment'] ) ? $info['comment'] : null;
                $timestamp = $info['timestamp'];
                $user = $info['user'];

                $completeText = "$comment ($user)";

                return new FeedItem( $titleStr, $completeText, $titleUrl, $timestamp, $user );
        }

        public function getAllowedParams() {
                global $wgFeedClasses;
                $feedFormatNames = array_keys( $wgFeedClasses );
                return array (
                        'feedformat' => array(
                                ApiBase::PARAM_DFLT => 'rss',
                                ApiBase::PARAM_TYPE => $feedFormatNames
                        ),
                        'hours' => array(
                                ApiBase::PARAM_DFLT => 24,
                                ApiBase::PARAM_TYPE => 'integer',
                                ApiBase::PARAM_MIN => 1,
                                ApiBase::PARAM_MAX => 72,
                        ),
                        'allrev' => false,
                        'wlowner' => array(
                                ApiBase::PARAM_TYPE => 'user'
                        ),
                        'wltoken' => array(
                                ApiBase::PARAM_TYPE => 'string'
                        ),
                        'wlexcludeuser' => array(
                                ApiBase::PARAM_TYPE => 'user'
                        ),
                        'linktodiffs' => false,
                );
        }

        public function getParamDescription() {
                return array(
                        'feedformat' => 'The format of the feed',
                        'hours'      => 'List pages modified within this many hours from now',
                        'allrev'     => 'Include multiple revisions of the same page within given timeframe',
                        'wlowner'    => "The user whose watchlist you want (must be accompanied by {$this->getModulePrefix()}wltoken if it's not you)",
                        'wltoken'    => 'Security token that requested user set in their preferences',
                        'wlexcludeuser' => 'A user whose edits should not be shown in the watchlist',
                        'linktodiffs' => 'Link to change differences instead of article pages',
                );
        }

        public function getDescription() {
                return 'Returns a watchlist 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=feedwatchlist',
                        'api.php?action=feedwatchlist&allrev=&linktodiffs=&hours=6'
                );
        }

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

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}