ApiFeedContributions.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\CommentFormatter\CommentFormatter;
use MediaWiki\Content\TextContent;
use MediaWiki\Feed\ChannelFeed;
use MediaWiki\Feed\FeedItem;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\LinkBatchFactory;
use MediaWiki\Pager\ContribsPager;
use MediaWiki\ParamValidator\TypeDef\UserDef;
use MediaWiki\Revision\RevisionAccessException;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\RevisionStore;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\NamespaceInfo;
use MediaWiki\Title\Title;
use MediaWiki\User\ExternalUserNames;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserRigorOptions;
use stdClass;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Rdbms\IConnectionProvider;
 
class ApiFeedContributions extends ApiBase {
 
    private ApiHookRunner $hookRunner;
 
    public function __construct(
        ApiMain $main,
        string $action,
        private readonly RevisionStore $revisionStore,
        private readonly LinkRenderer $linkRenderer,
        private readonly LinkBatchFactory $linkBatchFactory,
        private readonly HookContainer $hookContainer,
        private readonly IConnectionProvider $dbProvider,
        private readonly NamespaceInfo $namespaceInfo,
        private readonly UserFactory $userFactory,
        private readonly CommentFormatter $commentFormatter,
    ) {
        parent::__construct( $main, $action );
 
        $this->hookRunner = new ApiHookRunner( $hookContainer );
    }
 
    public function getCustomPrinter() {
        return new ApiFormatFeedWrapper( $this->getMain() );
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
 
        $config = $this->getConfig();
        if ( !$config->get( MainConfigNames::Feed ) ) {
            $this->dieWithError( 'feed-unavailable' );
        }
 
        $feedClasses = $config->get( MainConfigNames::FeedClasses );
        '@phan-var array<string,class-string<ChannelFeed>> $feedClasses';
        if ( !isset( $feedClasses[$params['feedformat']] ) ) {
            $this->dieWithError( 'feed-invalid' );
        }
 
        if ( $params['showsizediff'] && $this->getConfig()->get( MainConfigNames::MiserMode ) ) {
            $this->dieWithError( 'apierror-sizediffdisabled' );
        }
 
        $msg = $this->msg( 'Contributions' )->inContentLanguage()->escaped();
        $feedTitle = $config->get( MainConfigNames::Sitename ) . ' - ' . $msg .
            ' [' . $config->get( MainConfigNames::LanguageCode ) . ']';
 
        $target = $params['user'];
        if ( ExternalUserNames::isExternal( $target ) ) {
            // Interwiki names make invalid titles, so put the target in the query instead.
            $feedUrl = SpecialPage::getTitleFor( 'Contributions' )->getFullURL( [ 'target' => $target ] );
        } else {
            $feedUrl = SpecialPage::getTitleFor( 'Contributions', $target )->getFullURL();
        }
 
        $feed = new $feedClasses[$params['feedformat']](
            $feedTitle,
            $msg,
            $feedUrl
        );
 
        // Convert year/month parameters to end parameter
        $params['start'] = '';
        $params['end'] = '';
        $params = ContribsPager::processDateFilter( $params );
 
        $targetUser = $this->userFactory->newFromName( $target, UserRigorOptions::RIGOR_NONE );
 
        $pager = new ContribsPager(
            $this->getContext(), [
                'target' => $target,
                'namespace' => $params['namespace'],
                'start' => $params['start'],
                'end' => $params['end'],
                'tagFilter' => $params['tagfilter'],
                'deletedOnly' => $params['deletedonly'],
                'topOnly' => $params['toponly'],
                'newOnly' => $params['newonly'],
                'hideMinor' => $params['hideminor'],
                'showSizeDiff' => $params['showsizediff'],
            ],
            $this->linkRenderer,
            $this->linkBatchFactory,
            $this->hookContainer,
            $this->dbProvider,
            $this->revisionStore,
            $this->namespaceInfo,
            $targetUser,
            $this->commentFormatter
        );
 
        $feedLimit = $this->getConfig()->get( MainConfigNames::FeedLimit );
        if ( $pager->getLimit() > $feedLimit ) {
            $pager->setLimit( $feedLimit );
        }
 
        $feedItems = [];
        if ( $pager->getNumRows() > 0 ) {
            $count = 0;
            $limit = $pager->getLimit();
            foreach ( $pager->mResult as $row ) {
                // ContribsPager selects one more row for navigation, skip that row
                if ( ++$count > $limit ) {
                    break;
                }
                $item = $this->feedItem( $row );
                if ( $item !== null ) {
                    $feedItems[] = $item;
                }
            }
        }
 
        ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
    }
 
    protected function feedItem( $row ): ?FeedItem {
        // This hook is the api contributions equivalent to the
        // ContributionsLineEnding hook. Hook implementers may cancel
        // the hook to signal the user is not allowed to read this item.
        $feedItem = null;
        $hookResult = $this->hookRunner->onApiFeedContributions__feedItem(
            $row, $this->getContext(), $feedItem );
        // Hook returned a valid feed item
        if ( $feedItem instanceof FeedItem ) {
            return $feedItem;
        // Hook was canceled and did not return a valid feed item
        } elseif ( !$hookResult ) {
            return null;
        }
 
        // Hook completed and did not return a valid feed item
        $title = Title::makeTitle( (int)$row->page_namespace, $row->page_title );
 
        if ( $this->getAuthority()->authorizeRead( 'read', $title ) ) {
            $date = $row->rev_timestamp;
            $comments = $title->getTalkPage()->getFullURL();
            $revision = $this->revisionStore->newRevisionFromRow( $row, 0, $title );
 
            return new FeedItem(
                $title->getPrefixedText(),
                $this->feedItemDesc( $revision ),
                $title->getFullURL( [ 'diff' => $revision->getId() ] ),
                $date,
                $this->feedItemAuthor( $revision ),
                $comments
            );
        }
 
        return null;
    }
 
    protected function feedItemAuthor( RevisionRecord $revision ) {
        $user = $revision->getUser();
        return $user ? $user->getName() : '';
    }
 
    protected function feedItemDesc( RevisionRecord $revision ) {
        $msg = $this->msg( 'colon-separator' )->inContentLanguage()->escaped();
        try {
            $content = $revision->getContent( SlotRecord::MAIN );
        } catch ( RevisionAccessException ) {
            $content = null;
        }
 
        if ( $content instanceof TextContent ) {
            // only textual content has a "source view".
            $html = nl2br( htmlspecialchars( $content->getText(), ENT_COMPAT ) );
        } else {
            // XXX: we could get an HTML representation of the content via getParserOutput, but that may
            //     contain JS magic and generally may not be suitable for inclusion in a feed.
            //     Perhaps Content should have a getDescriptiveHtml method and/or a getSourceText method.
            // Compare also MediaWiki\Feed\FeedUtils::formatDiffRow.
            $html = '';
        }
 
        $comment = $revision->getComment();
 
        return '<p>' . htmlspecialchars( $this->feedItemAuthor( $revision ) ) . $msg .
            htmlspecialchars( FeedItem::stripComment( $comment->text ?? '' ) ) .
            "</p>\n<hr />\n<div>" . $html . '</div>';
    }
 
    public function getAllowedParams() {
        $feedFormatNames = array_keys( $this->getConfig()->get( MainConfigNames::FeedClasses ) );
 
        $ret = [
            'feedformat' => [
                ParamValidator::PARAM_DEFAULT => 'rss',
                ParamValidator::PARAM_TYPE => $feedFormatNames
            ],
            'user' => [
                ParamValidator::PARAM_TYPE => 'user',
                UserDef::PARAM_ALLOWED_USER_TYPES => [ 'name', 'ip', 'temp', 'cidr', 'id', 'interwiki' ],
                ParamValidator::PARAM_REQUIRED => true,
            ],
            'namespace' => [
                ParamValidator::PARAM_TYPE => 'namespace'
            ],
            'year' => [
                ParamValidator::PARAM_TYPE => 'integer'
            ],
            'month' => [
                ParamValidator::PARAM_TYPE => 'integer'
            ],
            'tagfilter' => [
                ParamValidator::PARAM_ISMULTI => true,
                ParamValidator::PARAM_TYPE => array_values( MediaWikiServices::getInstance()
                    ->getChangeTagsStore()->listDefinedTags()
                ),
                ParamValidator::PARAM_DEFAULT => '',
            ],
            'deletedonly' => false,
            'toponly' => false,
            'newonly' => false,
            'hideminor' => false,
            'showsizediff' => [
                ParamValidator::PARAM_DEFAULT => false,
            ],
        ];
 
        if ( $this->getConfig()->get( MainConfigNames::MiserMode ) ) {
            $ret['showsizediff'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
        }
 
        return $ret;
    }
 
    protected function getExamplesMessages() {
        return [
            'action=feedcontributions&user=Example'
                => 'apihelp-feedcontributions-example-simple',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Feedcontributions';
    }
}
 
class_alias( ApiFeedContributions::class, 'ApiFeedContributions' );