MediaWiki REL1_32
ApiFeedRecentChanges.php
Go to the documentation of this file.
1<?php
28
29 private $params;
30
36 public function getCustomPrinter() {
37 return new ApiFormatFeedWrapper( $this->getMain() );
38 }
39
44 public function execute() {
45 $config = $this->getConfig();
46
47 $this->params = $this->extractRequestParams();
48
49 if ( !$config->get( 'Feed' ) ) {
50 $this->dieWithError( 'feed-unavailable' );
51 }
52
53 $feedClasses = $config->get( 'FeedClasses' );
54 if ( !isset( $feedClasses[$this->params['feedformat']] ) ) {
55 $this->dieWithError( 'feed-invalid' );
56 }
57
58 $this->getMain()->setCacheMode( 'public' );
59 if ( !$this->getMain()->getParameter( 'smaxage' ) ) {
60 // T65249: This page gets hit a lot, cache at least 15 seconds.
61 $this->getMain()->setCacheMaxAge( 15 );
62 }
63
64 $feedFormat = $this->params['feedformat'];
65 $specialClass = $this->params['target'] !== null
66 ? SpecialRecentChangesLinked::class
67 : SpecialRecentChanges::class;
68
69 $formatter = $this->getFeedObject( $feedFormat, $specialClass );
70
71 // Parameters are passed via the request in the context… :(
72 $context = new DerivativeContext( $this );
73 $context->setRequest( new DerivativeRequest(
74 $this->getRequest(),
75 $this->params,
76 $this->getRequest()->wasPosted()
77 ) );
78
79 // The row-getting functionality should be factored out of ChangesListSpecialPage too…
80 $rc = new $specialClass();
81 $rc->setContext( $context );
82 $rows = $rc->getRows();
83
84 $feedItems = $rows ? ChangesFeed::buildItems( $rows ) : [];
85
86 ApiFormatFeedWrapper::setResult( $this->getResult(), $formatter, $feedItems );
87 }
88
97 public function getFeedObject( $feedFormat, $specialClass ) {
98 if ( $specialClass === SpecialRecentChangesLinked::class ) {
99 $title = Title::newFromText( $this->params['target'] );
100 if ( !$title ) {
101 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $this->params['target'] ) ] );
102 }
103
104 $feed = new ChangesFeed( $feedFormat, false );
105 $feedObj = $feed->getFeedObject(
106 $this->msg( 'recentchangeslinked-title', $title->getPrefixedText() )
107 ->inContentLanguage()->text(),
108 $this->msg( 'recentchangeslinked-feed' )->inContentLanguage()->text(),
109 SpecialPage::getTitleFor( 'Recentchangeslinked' )->getFullURL()
110 );
111 } else {
112 $feed = new ChangesFeed( $feedFormat, 'rcfeed' );
113 $feedObj = $feed->getFeedObject(
114 $this->msg( 'recentchanges' )->inContentLanguage()->text(),
115 $this->msg( 'recentchanges-feed-description' )->inContentLanguage()->text(),
116 SpecialPage::getTitleFor( 'Recentchanges' )->getFullURL()
117 );
118 }
119
120 return $feedObj;
121 }
122
123 public function getAllowedParams() {
124 $config = $this->getConfig();
125 $feedFormatNames = array_keys( $config->get( 'FeedClasses' ) );
126
127 $ret = [
128 'feedformat' => [
129 ApiBase::PARAM_DFLT => 'rss',
130 ApiBase::PARAM_TYPE => $feedFormatNames,
131 ],
132
133 'namespace' => [
134 ApiBase::PARAM_TYPE => 'namespace',
135 ],
136 'invert' => false,
137 'associated' => false,
138
139 'days' => [
142 ApiBase::PARAM_TYPE => 'integer',
143 ],
144 'limit' => [
147 ApiBase::PARAM_MAX => $config->get( 'FeedLimit' ),
148 ApiBase::PARAM_TYPE => 'integer',
149 ],
150 'from' => [
151 ApiBase::PARAM_TYPE => 'timestamp',
152 ],
153
154 'hideminor' => false,
155 'hidebots' => false,
156 'hideanons' => false,
157 'hideliu' => false,
158 'hidepatrolled' => false,
159 'hidemyself' => false,
160 'hidecategorization' => false,
161
162 'tagfilter' => [
163 ApiBase::PARAM_TYPE => 'string',
164 ],
165
166 'target' => [
167 ApiBase::PARAM_TYPE => 'string',
168 ],
169 'showlinkedto' => false,
170 ];
171
172 return $ret;
173 }
174
175 protected function getExamplesMessages() {
176 return [
177 'action=feedrecentchanges'
178 => 'apihelp-feedrecentchanges-example-simple',
179 'action=feedrecentchanges&days=30'
180 => 'apihelp-feedrecentchanges-example-30days',
181 ];
182 }
183}
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:37
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition ApiBase.php:884
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:90
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1987
getMain()
Get the main module.
Definition ApiBase.php:555
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:99
getResult()
Get the result object.
Definition ApiBase.php:659
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:770
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getExamplesMessages()
Returns usage examples for this module.
execute()
Format the rows (generated by SpecialRecentchanges or SpecialRecentchangeslinked) as an RSS/Atom feed...
getFeedObject( $feedFormat, $specialClass)
Return a ChannelFeed object.
getCustomPrinter()
This module uses a custom feed wrapper printer.
This printer is used to wrap an instance of the Feed class.
static setResult( $result, $feed, $feedItems)
Call this method to initialize output data.
Feed to Special:RecentChanges and Special:RecentChangesLiked.
static buildItems( $rows)
Generate the feed items given a row from the database.
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
IContextSource $context
An IContextSource implementation which will inherit context from another source but allow individual ...
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition hooks.txt:2857
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2054
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37