includes/api/ApiFeedContributions.php

   1 <?php
   2 /**
   3  * Copyright © 2011 Sam Reed
   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 use MediaWiki\MediaWikiServices;
  24 use MediaWiki\Storage\RevisionAccessException;
  25 use MediaWiki\Storage\RevisionRecord;
  26 use MediaWiki\Storage\RevisionStore;
  27 use MediaWiki\Storage\SlotRecord;
  28
  29 /**
  30  * @ingroup API
  31  */
  32 class ApiFeedContributions extends ApiBase {
  33
  34         /** @var RevisionStore */
  35         private $revisionStore;
  36
  37         /**
  38          * This module uses a custom feed wrapper printer.
  39          *
  40          * @return ApiFormatFeedWrapper
  41          */
  42         public function getCustomPrinter() {
  43                 return new ApiFormatFeedWrapper( $this->getMain() );
  44         }
  45
  46         public function execute() {
  47                 $this->revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
  48
  49                 $params = $this->extractRequestParams();
  50
  51                 $config = $this->getConfig();
  52                 if ( !$config->get( 'Feed' ) ) {
  53                         $this->dieWithError( 'feed-unavailable' );
  54                 }
  55
  56                 $feedClasses = $config->get( 'FeedClasses' );
  57                 if ( !isset( $feedClasses[$params['feedformat']] ) ) {
  58                         $this->dieWithError( 'feed-invalid' );
  59                 }
  60
  61                 if ( $params['showsizediff'] && $this->getConfig()->get( 'MiserMode' ) ) {
  62                         $this->dieWithError( 'apierror-sizediffdisabled' );
  63                 }
  64
  65                 $msg = wfMessage( 'Contributions' )->inContentLanguage()->text();
  66                 $feedTitle = $config->get( 'Sitename' ) . ' - ' . $msg .
  67                         ' [' . $config->get( 'LanguageCode' ) . ']';
  68                 $feedUrl = SpecialPage::getTitleFor( 'Contributions', $params['user'] )->getFullURL();
  69
  70                 $target = $params['user'] == 'newbies'
  71                         ? 'newbies'
  72                         : Title::makeTitleSafe( NS_USER, $params['user'] )->getText();
  73
  74                 $feed = new $feedClasses[$params['feedformat']] (
  75                         $feedTitle,
  76                         htmlspecialchars( $msg ),
  77                         $feedUrl
  78                 );
  79
  80                 // Convert year/month parameters to end parameter
  81                 $params['start'] = '';
  82                 $params['end'] = '';
  83                 $params = ContribsPager::processDateFilter( $params );
  84
  85                 $pager = new ContribsPager( $this->getContext(), [
  86                         'target' => $target,
  87                         'namespace' => $params['namespace'],
  88                         'start' => $params['start'],
  89                         'end' => $params['end'],
  90                         'tagFilter' => $params['tagfilter'],
  91                         'deletedOnly' => $params['deletedonly'],
  92                         'topOnly' => $params['toponly'],
  93                         'newOnly' => $params['newonly'],
  94                         'hideMinor' => $params['hideminor'],
  95                         'showSizeDiff' => $params['showsizediff'],
  96                 ] );
  97
  98                 $feedLimit = $this->getConfig()->get( 'FeedLimit' );
  99                 if ( $pager->getLimit() > $feedLimit ) {
 100                         $pager->setLimit( $feedLimit );
 101                 }
 102
 103                 $feedItems = [];
 104                 if ( $pager->getNumRows() > 0 ) {
 105                         $count = 0;
 106                         $limit = $pager->getLimit();
 107                         foreach ( $pager->mResult as $row ) {
 108                                 // ContribsPager selects one more row for navigation, skip that row
 109                                 if ( ++$count > $limit ) {
 110                                         break;
 111                                 }
 112                                 $item = $this->feedItem( $row );
 113                                 if ( $item !== null ) {
 114                                         $feedItems[] = $item;
 115                                 }
 116                         }
 117                 }
 118
 119                 ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
 120         }
 121
 122         protected function feedItem( $row ) {
 123                 // This hook is the api contributions equivalent to the
 124                 // ContributionsLineEnding hook. Hook implementers may cancel
 125                 // the hook to signal the user is not allowed to read this item.
 126                 $feedItem = null;
 127                 $hookResult = Hooks::run(
 128                         'ApiFeedContributions::feedItem',
 129                         [ $row, $this->getContext(), &$feedItem ]
 130                 );
 131                 // Hook returned a valid feed item
 132                 if ( $feedItem instanceof FeedItem ) {
 133                         return $feedItem;
 134                 // Hook was canceled and did not return a valid feed item
 135                 } elseif ( !$hookResult ) {
 136                         return null;
 137                 }
 138
 139                 // Hook completed and did not return a valid feed item
 140                 $title = Title::makeTitle( intval( $row->page_namespace ), $row->page_title );
 141                 if ( $title && $title->userCan( 'read', $this->getUser() ) ) {
 142                         $date = $row->rev_timestamp;
 143                         $comments = $title->getTalkPage()->getFullURL();
 144                         $revision = $this->revisionStore->newRevisionFromRow( $row );
 145
 146                         return new FeedItem(
 147                                 $title->getPrefixedText(),
 148                                 $this->feedItemDesc( $revision ),
 149                                 $title->getFullURL( [ 'diff' => $revision->getId() ] ),
 150                                 $date,
 151                                 $this->feedItemAuthor( $revision ),
 152                                 $comments
 153                         );
 154                 }
 155
 156                 return null;
 157         }
 158
 159         /**
 160          * @since 1.32, takes a RevisionRecord instead of a Revision
 161          * @param RevisionRecord $revision
 162          * @return string
 163          */
 164         protected function feedItemAuthor( RevisionRecord $revision ) {
 165                 $user = $revision->getUser();
 166                 return $user ? $user->getName() : '';
 167         }
 168
 169         /**
 170          * @since 1.32, takes a RevisionRecord instead of a Revision
 171          * @param RevisionRecord $revision
 172          * @return string
 173          */
 174         protected function feedItemDesc( RevisionRecord $revision ) {
 175                 if ( $revision ) {
 176                         $msg = wfMessage( 'colon-separator' )->inContentLanguage()->text();
 177                         try {
 178                                 $content = $revision->getContent( SlotRecord::MAIN );
 179                         } catch ( RevisionAccessException $e ) {
 180                                 $content = null;
 181                         }
 182
 183                         if ( $content instanceof TextContent ) {
 184                                 // only textual content has a "source view".
 185                                 $html = nl2br( htmlspecialchars( $content->getNativeData() ) );
 186                         } else {
 187                                 // XXX: we could get an HTML representation of the content via getParserOutput, but that may
 188                                 //     contain JS magic and generally may not be suitable for inclusion in a feed.
 189                                 //     Perhaps Content should have a getDescriptiveHtml method and/or a getSourceText method.
 190                                 // Compare also FeedUtils::formatDiffRow.
 191                                 $html = '';
 192                         }
 193
 194                         $comment = $revision->getComment();
 195
 196                         return '<p>' . htmlspecialchars( $this->feedItemAuthor( $revision ) ) . $msg .
 197                                 htmlspecialchars( FeedItem::stripComment( $comment ? $comment->text : '' ) ) .
 198                                 "</p>\n<hr />\n<div>" . $html . '</div>';
 199                 }
 200
 201                 return '';
 202         }
 203
 204         public function getAllowedParams() {
 205                 $feedFormatNames = array_keys( $this->getConfig()->get( 'FeedClasses' ) );
 206
 207                 $ret = [
 208                         'feedformat' => [
 209                                 ApiBase::PARAM_DFLT => 'rss',
 210                                 ApiBase::PARAM_TYPE => $feedFormatNames
 211                         ],
 212                         'user' => [
 213                                 ApiBase::PARAM_TYPE => 'user',
 214                                 ApiBase::PARAM_REQUIRED => true,
 215                         ],
 216                         'namespace' => [
 217                                 ApiBase::PARAM_TYPE => 'namespace'
 218                         ],
 219                         'year' => [
 220                                 ApiBase::PARAM_TYPE => 'integer'
 221                         ],
 222                         'month' => [
 223                                 ApiBase::PARAM_TYPE => 'integer'
 224                         ],
 225                         'tagfilter' => [
 226                                 ApiBase::PARAM_ISMULTI => true,
 227                                 ApiBase::PARAM_TYPE => array_values( ChangeTags::listDefinedTags() ),
 228                                 ApiBase::PARAM_DFLT => '',
 229                         ],
 230                         'deletedonly' => false,
 231                         'toponly' => false,
 232                         'newonly' => false,
 233                         'hideminor' => false,
 234                         'showsizediff' => [
 235                                 ApiBase::PARAM_DFLT => false,
 236                         ],
 237                 ];
 238
 239                 if ( $this->getConfig()->get( 'MiserMode' ) ) {
 240                         $ret['showsizediff'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
 241                 }
 242
 243                 return $ret;
 244         }
 245
 246         protected function getExamplesMessages() {
 247                 return [
 248                         'action=feedcontributions&user=Example'
 249                                 => 'apihelp-feedcontributions-example-simple',
 250                 ];
 251         }
 252 }