Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
15.87% covered (danger)
15.87%
10 / 63
0.00% covered (danger)
0.00%
0 / 4
CRAP
0.00% covered (danger)
0.00%
0 / 1
CargoFeedFormat
15.87% covered (danger)
15.87%
10 / 63
0.00% covered (danger)
0.00%
0 / 4
210.91
0.00% covered (danger)
0.00%
0 / 1
 allowedParameters
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
2
 queryAndDisplay
76.92% covered (warning)
76.92%
10 / 13
0.00% covered (danger)
0.00%
0 / 1
7.60
 getFeedType
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
6
 outputFeed
0.00% covered (danger)
0.00%
0 / 38
0.00% covered (danger)
0.00%
0 / 1
72
1<?php
2/**
3 * @ingroup Cargo
4 * @file
5 */
6
7use MediaWiki\MediaWikiServices;
8
9/**
10 * Handle the feed export format.
11 * @since 3.5
12 */
13class CargoFeedFormat extends CargoDeferredFormat {
14
15    public static function allowedParameters() {
16        return [
17            'feed type' => [ 'values' => [ 'atom', 'rss' ] ],
18            'link text' => [ 'type' => 'string' ],
19            'feed title' => [ 'type' => 'string' ],
20            'feed description' => [ 'type' => 'string' ],
21        ];
22    }
23
24    /**
25     * @param CargoSQLQuery[] $sqlQueries
26     * @param string[] $displayParams Unused
27     * @param string[]|null $querySpecificParams Unused
28     * @return string An HTML link to Special:CargoExport with the required query string.
29     */
30    public function queryAndDisplay( $sqlQueries, $displayParams, $querySpecificParams = null ) {
31        $queryParams = $this->sqlQueriesToQueryParams( $sqlQueries );
32        $queryParams['format'] = 'feed';
33
34        // Feed type. Defaults to the first one set in $wgAdvertisedFeedTypes.
35        $queryParams['feed type'] = $this->getFeedType( $displayParams['feed type'] ?? null );
36
37        // Feed title.
38        if ( isset( $displayParams['feed title'] ) && trim( $displayParams['feed title'] ) != '' ) {
39            $queryParams['feed title'] = $displayParams['feed title'];
40        }
41
42        // Feed description.
43        if ( isset( $displayParams['feed description'] ) && trim( $displayParams['feed description'] ) !== '' ) {
44            $queryParams['feed description'] = $displayParams['feed description'];
45        }
46
47        // Link.
48        if ( isset( $displayParams['link text'] ) && $displayParams['link text'] ) {
49            $linkText = $displayParams['link text'];
50        } else {
51            // The following messages can be used here:
52            // * feed-rss
53            // * feed-atom
54            $feedName = wfMessage( 'feed-' . $queryParams['feed type'] );
55            $linkText = wfMessage( 'cargo-viewfeed', [ $feedName ] )->parse();
56        }
57
58        // Output full anchor element. The array_filter is to avoid empty params.
59        $export = SpecialPage::getTitleFor( 'CargoExport' );
60        return Html::rawElement( 'a', [ 'href' => $export->getFullURL( array_filter( $queryParams ) ) ], $linkText );
61    }
62
63    /**
64     * Determine the feed type (Atom or RSS).
65     * @param string|null $in The user-provided value.
66     * @return string Either 'atom' or 'rss'.
67     */
68    private function getFeedType( string $in = null ): string {
69        $config = MediaWikiServices::getInstance()->getMainConfig();
70        $types = array_keys( $config->get( 'FeedClasses' ) );
71
72        // User-provided (if it's valid).
73        $inType = strtolower( trim( $in ?? '' ) );
74        if ( in_array( $inType, $types ) ) {
75            return $inType;
76        }
77
78        // Otherwise, fall back to Atom.
79        return 'atom';
80    }
81
82    /**
83     * Get the iCalendar format output.
84     * @param WebRequest $request
85     * @param CargoSQLQuery[] $sqlQueries
86     * @return string
87     */
88    public function outputFeed( WebRequest $request, $sqlQueries ) {
89        $queryParams = $this->sqlQueriesToQueryParams( $sqlQueries );
90        $queryParams['format'] = 'feed';
91        $feedType = $this->getFeedType( $request->getText( 'feed_type' ) );
92        $title = $request->getText( 'feed_title', 'News feed' );
93        $description = $request->getText( 'feed_description', '' );
94
95        $feedClasses = MediaWikiServices::getInstance()->getMainConfig()->get( 'FeedClasses' );
96        /** @var RSSFeed|AtomFeed $feed */
97        $feed = new $feedClasses[$feedType]( $title, $description, $request->getFullRequestURL() );
98
99        $items = [];
100        foreach ( $sqlQueries as $sqlQuery ) {
101            $dateFields = $sqlQuery->getMainStartAndEndDateFields();
102
103            $queryResults = $sqlQuery->run();
104            foreach ( $queryResults as $queryResult ) {
105                $title = Title::newFromText( $queryResult['_pageName'] );
106                if ( isset( $queryResult['description'] ) ) {
107                    $description = $queryResult['description'];
108                } else {
109                    $wikiPage = new WikiPage( $title );
110                    if ( method_exists( MediaWikiServices::class, 'getContentRenderer' ) ) {
111                        // @todo Remove after dropping support for MediaWiki < 1.38.
112                        $description = MediaWikiServices::getInstance()
113                            ->getContentRenderer()
114                            ->getParserOutput( $wikiPage->getContent(), $title )
115                            ->getText();
116                    } else {
117                        $description = $wikiPage->getContent()->getParserOutput( $title )->getText();
118                    }
119                }
120                $item = new FeedItem(
121                    $queryResult['_pageName'] ?? '',
122                    $description,
123                    $queryResult['url'] ?? $title->getCanonicalURL(),
124                    $queryResult[$dateFields[0]] ?? '',
125                    $queryResult['author'] ?? '',
126                    $queryResult['comments'] ?? ''
127                );
128                if ( isset( $queryResult['id'] ) && !empty( $queryResult['id'] ) ) {
129                    $item->setUniqueId( $queryResult['id'] );
130                } else {
131                    $item->setUniqueId( $title->getCanonicalURL(), true );
132                }
133                $items[$queryResult[$dateFields[0]]] = $item;
134            }
135        }
136
137        // Output feed content.
138        $feed->outHeader();
139        foreach ( $items as $item ) {
140            $feed->outItem( $item );
141        }
142        $feed->outFooter();
143    }
144}