includes/api/ApiFeedWatchlist.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Oct 13, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * This action allows users to get their watchlist items in RSS/Atom formats.
  29  * When executed, it performs a nested call to the API to get the needed data,
  30  * and formats it in a proper format.
  31  *
  32  * @ingroup API
  33  */
  34 class ApiFeedWatchlist extends ApiBase {
  35
  36         private $watchlistModule = null;
  37         private $linkToDiffs = false;
  38         private $linkToSections = false;
  39
  40         /**
  41          * This module uses a custom feed wrapper printer.
  42          *
  43          * @return ApiFormatFeedWrapper
  44          */
  45         public function getCustomPrinter() {
  46                 return new ApiFormatFeedWrapper( $this->getMain() );
  47         }
  48
  49         /**
  50          * Make a nested call to the API to request watchlist items in the last $hours.
  51          * Wrap the result as an RSS/Atom feed.
  52          */
  53         public function execute() {
  54                 global $wgFeed, $wgFeedClasses, $wgFeedLimit, $wgSitename, $wgLanguageCode;
  55
  56                 try {
  57                         $params = $this->extractRequestParams();
  58
  59                         if ( !$wgFeed ) {
  60                                 $this->dieUsage( 'Syndication feeds are not available', 'feed-unavailable' );
  61                         }
  62
  63                         if ( !isset( $wgFeedClasses[$params['feedformat']] ) ) {
  64                                 $this->dieUsage( 'Invalid subscription feed type', 'feed-invalid' );
  65                         }
  66
  67                         // limit to the number of hours going from now back
  68                         $endTime = wfTimestamp( TS_MW, time() - intval( $params['hours'] * 60 * 60 ) );
  69
  70                         // Prepare parameters for nested request
  71                         $fauxReqArr = array(
  72                                 'action' => 'query',
  73                                 'meta' => 'siteinfo',
  74                                 'siprop' => 'general',
  75                                 'list' => 'watchlist',
  76                                 'wlprop' => 'title|user|comment|timestamp',
  77                                 'wldir' => 'older', // reverse order - from newest to oldest
  78                                 'wlend' => $endTime, // stop at this time
  79                                 'wllimit' => min( 50, $wgFeedLimit )
  80                         );
  81
  82                         if ( $params['wlowner'] !== null ) {
  83                                 $fauxReqArr['wlowner'] = $params['wlowner'];
  84                         }
  85                         if ( $params['wltoken'] !== null ) {
  86                                 $fauxReqArr['wltoken'] = $params['wltoken'];
  87                         }
  88                         if ( $params['wlexcludeuser'] !== null ) {
  89                                 $fauxReqArr['wlexcludeuser'] = $params['wlexcludeuser'];
  90                         }
  91                         if ( $params['wlshow'] !== null ) {
  92                                 $fauxReqArr['wlshow'] = $params['wlshow'];
  93                         }
  94                         if ( $params['wltype'] !== null ) {
  95                                 $fauxReqArr['wltype'] = $params['wltype'];
  96                         }
  97
  98                         // Support linking to diffs instead of article
  99                         if ( $params['linktodiffs'] ) {
 100                                 $this->linkToDiffs = true;
 101                                 $fauxReqArr['wlprop'] .= '|ids';
 102                         }
 103
 104                         // Support linking directly to sections when possible
 105                         // (possible only if section name is present in comment)
 106                         if ( $params['linktosections'] ) {
 107                                 $this->linkToSections = true;
 108                         }
 109
 110                         // Check for 'allrev' parameter, and if found, show all revisions to each page on wl.
 111                         if ( $params['allrev'] ) {
 112                                 $fauxReqArr['wlallrev'] = '';
 113                         }
 114
 115                         // Create the request
 116                         $fauxReq = new FauxRequest( $fauxReqArr );
 117
 118                         // Execute
 119                         $module = new ApiMain( $fauxReq );
 120                         $module->execute();
 121
 122                         // Get data array
 123                         $data = $module->getResultData();
 124
 125                         $feedItems = array();
 126                         foreach ( (array)$data['query']['watchlist'] as $info ) {
 127                                 $feedItems[] = $this->createFeedItem( $info );
 128                         }
 129
 130                         $msg = wfMessage( 'watchlist' )->inContentLanguage()->text();
 131
 132                         $feedTitle = $wgSitename . ' - ' . $msg . ' [' . $wgLanguageCode . ']';
 133                         $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL();
 134
 135                         $feed = new $wgFeedClasses[$params['feedformat']] (
 136                                 $feedTitle,
 137                                 htmlspecialchars( $msg ),
 138                                 $feedUrl
 139                         );
 140
 141                         ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
 142                 } catch ( Exception $e ) {
 143                         // Error results should not be cached
 144                         $this->getMain()->setCacheMaxAge( 0 );
 145
 146                         // @todo FIXME: Localise  brackets
 147                         $feedTitle = $wgSitename . ' - Error - ' .
 148                                 wfMessage( 'watchlist' )->inContentLanguage()->text() .
 149                                 ' [' . $wgLanguageCode . ']';
 150                         $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL();
 151
 152                         $feedFormat = isset( $params['feedformat'] ) ? $params['feedformat'] : 'rss';
 153                         $msg = wfMessage( 'watchlist' )->inContentLanguage()->escaped();
 154                         $feed = new $wgFeedClasses[$feedFormat] ( $feedTitle, $msg, $feedUrl );
 155
 156                         if ( $e instanceof UsageException ) {
 157                                 $errorCode = $e->getCodeString();
 158                         } else {
 159                                 // Something is seriously wrong
 160                                 $errorCode = 'internal_api_error';
 161                         }
 162
 163                         $errorText = $e->getMessage();
 164                         $feedItems[] = new FeedItem( "Error ($errorCode)", $errorText, '', '', '' );
 165                         ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
 166                 }
 167         }
 168
 169         /**
 170          * @param $info array
 171          * @return FeedItem
 172          */
 173         private function createFeedItem( $info ) {
 174                 $titleStr = $info['title'];
 175                 $title = Title::newFromText( $titleStr );
 176                 if ( $this->linkToDiffs && isset( $info['revid'] ) ) {
 177                         $titleUrl = $title->getFullURL( array( 'diff' => $info['revid'] ) );
 178                 } else {
 179                         $titleUrl = $title->getFullURL();
 180                 }
 181                 $comment = isset( $info['comment'] ) ? $info['comment'] : null;
 182
 183                 // Create an anchor to section.
 184                 // The anchor won't work for sections that have dupes on page
 185                 // as there's no way to strip that info from ApiWatchlist (apparently?).
 186                 // RegExp in the line below is equal to Linker::formatAutocomments().
 187                 if ( $this->linkToSections && $comment !== null &&
 188                         preg_match( '!(.*)/\*\s*(.*?)\s*\*/(.*)!', $comment, $matches )
 189                 ) {
 190                         global $wgParser;
 191
 192                         $sectionTitle = $wgParser->stripSectionName( $matches[2] );
 193                         $sectionTitle = Sanitizer::normalizeSectionNameWhitespace( $sectionTitle );
 194                         $titleUrl .= Title::newFromText( '#' . $sectionTitle )->getFragmentForURL();
 195                 }
 196
 197                 $timestamp = $info['timestamp'];
 198                 $user = $info['user'];
 199
 200                 $completeText = "$comment ($user)";
 201
 202                 return new FeedItem( $titleStr, $completeText, $titleUrl, $timestamp, $user );
 203         }
 204
 205         private function getWatchlistModule() {
 206                 if ( $this->watchlistModule === null ) {
 207                         $this->watchlistModule = $this->getMain()->getModuleManager()->getModule( 'query' )
 208                                 ->getModuleManager()->getModule( 'watchlist' );
 209                 }
 210
 211                 return $this->watchlistModule;
 212         }
 213
 214         public function getAllowedParams( $flags = 0 ) {
 215                 global $wgFeedClasses;
 216                 $feedFormatNames = array_keys( $wgFeedClasses );
 217                 $ret = array(
 218                         'feedformat' => array(
 219                                 ApiBase::PARAM_DFLT => 'rss',
 220                                 ApiBase::PARAM_TYPE => $feedFormatNames
 221                         ),
 222                         'hours' => array(
 223                                 ApiBase::PARAM_DFLT => 24,
 224                                 ApiBase::PARAM_TYPE => 'integer',
 225                                 ApiBase::PARAM_MIN => 1,
 226                                 ApiBase::PARAM_MAX => 72,
 227                         ),
 228                         'linktodiffs' => false,
 229                         'linktosections' => false,
 230                 );
 231                 if ( $flags ) {
 232                         $wlparams = $this->getWatchlistModule()->getAllowedParams( $flags );
 233                         $ret['allrev'] = $wlparams['allrev'];
 234                         $ret['wlowner'] = $wlparams['owner'];
 235                         $ret['wltoken'] = $wlparams['token'];
 236                         $ret['wlshow'] = $wlparams['show'];
 237                         $ret['wltype'] = $wlparams['type'];
 238                         $ret['wlexcludeuser'] = $wlparams['excludeuser'];
 239                 } else {
 240                         $ret['allrev'] = null;
 241                         $ret['wlowner'] = null;
 242                         $ret['wltoken'] = null;
 243                         $ret['wlshow'] = null;
 244                         $ret['wltype'] = null;
 245                         $ret['wlexcludeuser'] = null;
 246                 }
 247
 248                 return $ret;
 249         }
 250
 251         public function getParamDescription() {
 252                 $wldescr = $this->getWatchlistModule()->getParamDescription();
 253
 254                 return array(
 255                         'feedformat' => 'The format of the feed',
 256                         'hours' => 'List pages modified within this many hours from now',
 257                         'linktodiffs' => 'Link to change differences instead of article pages',
 258                         'linktosections' => 'Link directly to changed sections if possible',
 259                         'allrev' => $wldescr['allrev'],
 260                         'wlowner' => $wldescr['owner'],
 261                         'wltoken' => $wldescr['token'],
 262                         'wlshow' => $wldescr['show'],
 263                         'wltype' => $wldescr['type'],
 264                         'wlexcludeuser' => $wldescr['excludeuser'],
 265                 );
 266         }
 267
 268         public function getDescription() {
 269                 return 'Returns a watchlist feed';
 270         }
 271
 272         public function getPossibleErrors() {
 273                 return array_merge( parent::getPossibleErrors(), array(
 274                         array( 'code' => 'feed-unavailable', 'info' => 'Syndication feeds are not available' ),
 275                         array( 'code' => 'feed-invalid', 'info' => 'Invalid subscription feed type' ),
 276                 ) );
 277         }
 278
 279         public function getExamples() {
 280                 return array(
 281                         'api.php?action=feedwatchlist',
 282                         'api.php?action=feedwatchlist&allrev=&linktodiffs=&hours=6'
 283                 );
 284         }
 285
 286         public function getHelpUrls() {
 287                 return 'https://www.mediawiki.org/wiki/API:Watchlist_feed';
 288         }
 289 }