includes/api/ApiFeedWatchlist.php

   1 <?php
   2 /**
   3  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * This action allows users to get their watchlist items in RSS/Atom formats.
  25  * When executed, it performs a nested call to the API to get the needed data,
  26  * and formats it in a proper format.
  27  *
  28  * @ingroup API
  29  */
  30 class ApiFeedWatchlist extends ApiBase {
  31
  32         private $watchlistModule = null;
  33         private $linkToSections = false;
  34
  35         /**
  36          * This module uses a custom feed wrapper printer.
  37          *
  38          * @return ApiFormatFeedWrapper
  39          */
  40         public function getCustomPrinter() {
  41                 return new ApiFormatFeedWrapper( $this->getMain() );
  42         }
  43
  44         /**
  45          * Make a nested call to the API to request watchlist items in the last $hours.
  46          * Wrap the result as an RSS/Atom feed.
  47          */
  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
 175         /**
 176          * @param array $info
 177          * @return FeedItem
 178          */
 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                 ) {
 213                         global $wgParser;
 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] ) &&
 274                                         isset( $p[ApiBase::PARAM_HELP_MSG_PER_VALUE] )
 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 }