MediaWiki  REL1_31
ApiFeedWatchlist.php
Go to the documentation of this file.
1 <?php
30 class ApiFeedWatchlist extends ApiBase {
31 
32  private $watchlistModule = null;
33  private $linkToSections = false;
34 
40  public function getCustomPrinter() {
41  return new ApiFormatFeedWrapper( $this->getMain() );
42  }
43 
48  public function execute() {
49  $config = $this->getConfig();
50  $feedClasses = $config->get( 'FeedClasses' );
51  $params = [];
52  try {
53  $params = $this->extractRequestParams();
54 
55  if ( !$config->get( 'Feed' ) ) {
56  $this->dieWithError( 'feed-unavailable' );
57  }
58 
59  if ( !isset( $feedClasses[$params['feedformat']] ) ) {
60  $this->dieWithError( 'feed-invalid' );
61  }
62 
63  // limit to the number of hours going from now back
64  $endTime = wfTimestamp( TS_MW, time() - intval( $params['hours'] * 60 * 60 ) );
65 
66  // Prepare parameters for nested request
67  $fauxReqArr = [
68  'action' => 'query',
69  'meta' => 'siteinfo',
70  'siprop' => 'general',
71  'list' => 'watchlist',
72  'wlprop' => 'title|user|comment|timestamp|ids',
73  'wldir' => 'older', // reverse order - from newest to oldest
74  'wlend' => $endTime, // stop at this time
75  'wllimit' => min( 50, $this->getConfig()->get( 'FeedLimit' ) )
76  ];
77 
78  if ( $params['wlowner'] !== null ) {
79  $fauxReqArr['wlowner'] = $params['wlowner'];
80  }
81  if ( $params['wltoken'] !== null ) {
82  $fauxReqArr['wltoken'] = $params['wltoken'];
83  }
84  if ( $params['wlexcludeuser'] !== null ) {
85  $fauxReqArr['wlexcludeuser'] = $params['wlexcludeuser'];
86  }
87  if ( $params['wlshow'] !== null ) {
88  $fauxReqArr['wlshow'] = $params['wlshow'];
89  }
90  if ( $params['wltype'] !== null ) {
91  $fauxReqArr['wltype'] = $params['wltype'];
92  }
93 
94  // Support linking directly to sections when possible
95  // (possible only if section name is present in comment)
96  if ( $params['linktosections'] ) {
97  $this->linkToSections = true;
98  }
99 
100  // Check for 'allrev' parameter, and if found, show all revisions to each page on wl.
101  if ( $params['allrev'] ) {
102  $fauxReqArr['wlallrev'] = '';
103  }
104 
105  // Create the request
106  $fauxReq = new FauxRequest( $fauxReqArr );
107 
108  // Execute
109  $module = new ApiMain( $fauxReq );
110  $module->execute();
111 
112  $data = $module->getResult()->getResultData( [ 'query', 'watchlist' ] );
113  $feedItems = [];
114  foreach ( (array)$data as $key => $info ) {
115  if ( ApiResult::isMetadataKey( $key ) ) {
116  continue;
117  }
118  $feedItem = $this->createFeedItem( $info );
119  if ( $feedItem ) {
120  $feedItems[] = $feedItem;
121  }
122  }
123 
124  $msg = wfMessage( 'watchlist' )->inContentLanguage()->text();
125 
126  $feedTitle = $this->getConfig()->get( 'Sitename' ) . ' - ' . $msg .
127  ' [' . $this->getConfig()->get( 'LanguageCode' ) . ']';
128  $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL();
129 
130  $feed = new $feedClasses[$params['feedformat']] (
131  $feedTitle,
132  htmlspecialchars( $msg ),
133  $feedUrl
134  );
135 
136  ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
137  } catch ( Exception $e ) {
138  // Error results should not be cached
139  $this->getMain()->setCacheMaxAge( 0 );
140 
141  // @todo FIXME: Localise brackets
142  $feedTitle = $this->getConfig()->get( 'Sitename' ) . ' - Error - ' .
143  wfMessage( 'watchlist' )->inContentLanguage()->text() .
144  ' [' . $this->getConfig()->get( 'LanguageCode' ) . ']';
145  $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL();
146 
147  $feedFormat = isset( $params['feedformat'] ) ? $params['feedformat'] : 'rss';
148  $msg = wfMessage( 'watchlist' )->inContentLanguage()->escaped();
149  $feed = new $feedClasses[$feedFormat] ( $feedTitle, $msg, $feedUrl );
150 
151  if ( $e instanceof ApiUsageException ) {
152  foreach ( $e->getStatusValue()->getErrors() as $error ) {
153  $msg = ApiMessage::create( $error )
154  ->inLanguage( $this->getLanguage() );
155  $errorTitle = $this->msg( 'api-feed-error-title', $msg->getApiCode() );
156  $errorText = $msg->text();
157  $feedItems[] = new FeedItem( $errorTitle, $errorText, '', '', '' );
158  }
159  } else {
160  if ( $e instanceof UsageException ) {
161  $errorCode = $e->getCodeString();
162  } else {
163  // Something is seriously wrong
164  $errorCode = 'internal_api_error';
165  }
166  $errorTitle = $this->msg( 'api-feed-error-title', $errorCode );
167  $errorText = $e->getMessage();
168  $feedItems[] = new FeedItem( $errorTitle, $errorText, '', '', '' );
169  }
170 
171  ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
172  }
173  }
174 
179  private function createFeedItem( $info ) {
180  if ( !isset( $info['title'] ) ) {
181  // Probably a revdeled log entry, skip it.
182  return null;
183  }
184 
185  $titleStr = $info['title'];
186  $title = Title::newFromText( $titleStr );
187  $curidParam = [];
188  if ( !$title || $title->isExternal() ) {
189  // Probably a formerly-valid title that's now conflicting with an
190  // interwiki prefix or the like.
191  if ( isset( $info['pageid'] ) ) {
192  $title = Title::newFromID( $info['pageid'] );
193  $curidParam = [ 'curid' => $info['pageid'] ];
194  }
195  if ( !$title || $title->isExternal() ) {
196  return null;
197  }
198  }
199  if ( isset( $info['revid'] ) ) {
200  $titleUrl = $title->getFullURL( [ 'diff' => $info['revid'] ] );
201  } else {
202  $titleUrl = $title->getFullURL( $curidParam );
203  }
204  $comment = isset( $info['comment'] ) ? $info['comment'] : null;
205 
206  // Create an anchor to section.
207  // The anchor won't work for sections that have dupes on page
208  // as there's no way to strip that info from ApiWatchlist (apparently?).
209  // RegExp in the line below is equal to Linker::formatAutocomments().
210  if ( $this->linkToSections && $comment !== null &&
211  preg_match( '!(.*)/\*\s*(.*?)\s*\*/(.*)!', $comment, $matches )
212  ) {
214  $titleUrl .= $wgParser->guessSectionNameFromWikiText( $matches[ 2 ] );
215  }
216 
217  $timestamp = $info['timestamp'];
218 
219  if ( isset( $info['user'] ) ) {
220  $user = $info['user'];
221  $completeText = "$comment ($user)";
222  } else {
223  $user = '';
224  $completeText = (string)$comment;
225  }
226 
227  return new FeedItem( $titleStr, $completeText, $titleUrl, $timestamp, $user );
228  }
229 
230  private function getWatchlistModule() {
231  if ( $this->watchlistModule === null ) {
232  $this->watchlistModule = $this->getMain()->getModuleManager()->getModule( 'query' )
233  ->getModuleManager()->getModule( 'watchlist' );
234  }
235 
236  return $this->watchlistModule;
237  }
238 
239  public function getAllowedParams( $flags = 0 ) {
240  $feedFormatNames = array_keys( $this->getConfig()->get( 'FeedClasses' ) );
241  $ret = [
242  'feedformat' => [
243  ApiBase::PARAM_DFLT => 'rss',
244  ApiBase::PARAM_TYPE => $feedFormatNames
245  ],
246  'hours' => [
247  ApiBase::PARAM_DFLT => 24,
248  ApiBase::PARAM_TYPE => 'integer',
249  ApiBase::PARAM_MIN => 1,
250  ApiBase::PARAM_MAX => 72,
251  ],
252  'linktosections' => false,
253  ];
254 
255  $copyParams = [
256  'allrev' => 'allrev',
257  'owner' => 'wlowner',
258  'token' => 'wltoken',
259  'show' => 'wlshow',
260  'type' => 'wltype',
261  'excludeuser' => 'wlexcludeuser',
262  ];
263  if ( $flags ) {
264  $wlparams = $this->getWatchlistModule()->getAllowedParams( $flags );
265  foreach ( $copyParams as $from => $to ) {
266  $p = $wlparams[$from];
267  if ( !is_array( $p ) ) {
268  $p = [ ApiBase::PARAM_DFLT => $p ];
269  }
270  if ( !isset( $p[ApiBase::PARAM_HELP_MSG] ) ) {
271  $p[ApiBase::PARAM_HELP_MSG] = "apihelp-query+watchlist-param-$from";
272  }
273  if ( isset( $p[ApiBase::PARAM_TYPE] ) && is_array( $p[ApiBase::PARAM_TYPE] ) &&
275  ) {
276  foreach ( $p[ApiBase::PARAM_TYPE] as $v ) {
277  if ( !isset( $p[ApiBase::PARAM_HELP_MSG_PER_VALUE][$v] ) ) {
278  $p[ApiBase::PARAM_HELP_MSG_PER_VALUE][$v] = "apihelp-query+watchlist-paramvalue-$from-$v";
279  }
280  }
281  }
282  $ret[$to] = $p;
283  }
284  } else {
285  foreach ( $copyParams as $from => $to ) {
286  $ret[$to] = null;
287  }
288  }
289 
290  return $ret;
291  }
292 
293  protected function getExamplesMessages() {
294  return [
295  'action=feedwatchlist'
296  => 'apihelp-feedwatchlist-example-default',
297  'action=feedwatchlist&allrev=&hours=6'
298  => 'apihelp-feedwatchlist-example-all6hrs',
299  ];
300  }
301 
302  public function getHelpUrls() {
303  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlist_feed';
304  }
305 }
ApiFeedWatchlist\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiFeedWatchlist.php:293
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
ApiFeedWatchlist\getAllowedParams
getAllowedParams( $flags=0)
Definition: ApiFeedWatchlist.php:239
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
ApiFeedWatchlist
This action allows users to get their watchlist items in RSS/Atom formats.
Definition: ApiFeedWatchlist.php:30
FeedItem
A base class for basic support for outputting syndication feeds in RSS and other formats.
Definition: Feed.php:38
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
ApiUsageException
Exception used to abort API execution with an error.
Definition: ApiUsageException.php:103
$wgParser
$wgParser
Definition: Setup.php:917
ApiFeedWatchlist\getCustomPrinter
getCustomPrinter()
This module uses a custom feed wrapper printer.
Definition: ApiFeedWatchlist.php:40
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
string
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:181
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
$ret
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:2005
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
$params
$params
Definition: styleTest.css.php:40
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
ApiFeedWatchlist\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiFeedWatchlist.php:302
php
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
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
ContextSource\getLanguage
getLanguage()
Definition: ContextSource.php:128
ApiFeedWatchlist\$linkToSections
$linkToSections
Definition: ApiFeedWatchlist.php:33
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
ApiFeedWatchlist\$watchlistModule
$watchlistModule
Definition: ApiFeedWatchlist.php:32
ApiFormatFeedWrapper
This printer is used to wrap an instance of the Feed class.
Definition: ApiFormatFeedWrapper.php:27
UsageException
This exception will be thrown when dieUsage is called to stop module execution.
Definition: ApiUsageException.php:27
$matches
$matches
Definition: NoLocalSettings.php:24
ApiFeedWatchlist\execute
execute()
Make a nested call to the API to request watchlist items in the last $hours.
Definition: ApiFeedWatchlist.php:48
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
ApiFeedWatchlist\createFeedItem
createFeedItem( $info)
Definition: ApiFeedWatchlist.php:179
ApiMessage\create
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:219
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiResult\isMetadataKey
static isMetadataKey( $key)
Test whether a key should be considered metadata.
Definition: ApiResult.php:793
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:537
ApiFeedWatchlist\getWatchlistModule
getWatchlistModule()
Definition: ApiFeedWatchlist.php:230
ApiBase\PARAM_HELP_MSG_PER_VALUE
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:157
Title\newFromID
static newFromID( $id, $flags=0)
Create a new Title from an article ID.
Definition: Title.php:416
ApiFormatFeedWrapper\setResult
static setResult( $result, $feed, $feedItems)
Call this method to initialize output data.
Definition: ApiFormatFeedWrapper.php:39
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171