includes/api/ApiFeedContributions.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on June 06, 2011
   6  *
   7  * Copyright © 2011 Sam Reed
   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  * @ingroup API
  29  */
  30 class ApiFeedContributions extends ApiBase {
  31
  32         /**
  33          * This module uses a custom feed wrapper printer.
  34          *
  35          * @return ApiFormatFeedWrapper
  36          */
  37         public function getCustomPrinter() {
  38                 return new ApiFormatFeedWrapper( $this->getMain() );
  39         }
  40
  41         public function execute() {
  42                 $params = $this->extractRequestParams();
  43
  44                 global $wgFeed, $wgFeedClasses, $wgFeedLimit, $wgSitename, $wgLanguageCode;
  45
  46                 if ( !$wgFeed ) {
  47                         $this->dieUsage( 'Syndication feeds are not available', 'feed-unavailable' );
  48                 }
  49
  50                 if ( !isset( $wgFeedClasses[$params['feedformat']] ) ) {
  51                         $this->dieUsage( 'Invalid subscription feed type', 'feed-invalid' );
  52                 }
  53
  54                 global $wgMiserMode;
  55                 if ( $params['showsizediff'] && $wgMiserMode ) {
  56                         $this->dieUsage( 'Size difference is disabled in Miser Mode', 'sizediffdisabled' );
  57                 }
  58
  59                 $msg = wfMessage( 'Contributions' )->inContentLanguage()->text();
  60                 $feedTitle = $wgSitename . ' - ' . $msg . ' [' . $wgLanguageCode . ']';
  61                 $feedUrl = SpecialPage::getTitleFor( 'Contributions', $params['user'] )->getFullURL();
  62
  63                 $target = $params['user'] == 'newbies'
  64                         ? 'newbies'
  65                         : Title::makeTitleSafe( NS_USER, $params['user'] )->getText();
  66
  67                 $feed = new $wgFeedClasses[$params['feedformat']] (
  68                         $feedTitle,
  69                         htmlspecialchars( $msg ),
  70                         $feedUrl
  71                 );
  72
  73                 $pager = new ContribsPager( $this->getContext(), array(
  74                         'target' => $target,
  75                         'namespace' => $params['namespace'],
  76                         'year' => $params['year'],
  77                         'month' => $params['month'],
  78                         'tagFilter' => $params['tagfilter'],
  79                         'deletedOnly' => $params['deletedonly'],
  80                         'topOnly' => $params['toponly'],
  81                         'showSizeDiff' => $params['showsizediff'],
  82                 ) );
  83
  84                 if ( $pager->getLimit() > $wgFeedLimit ) {
  85                         $pager->setLimit( $wgFeedLimit );
  86                 }
  87
  88                 $feedItems = array();
  89                 if ( $pager->getNumRows() > 0 ) {
  90                         $count = 0;
  91                         $limit = $pager->getLimit();
  92                         foreach ( $pager->mResult as $row ) {
  93                                 // ContribsPager selects one more row for navigation, skip that row
  94                                 if ( ++$count > $limit ) {
  95                                         break;
  96                                 }
  97                                 $feedItems[] = $this->feedItem( $row );
  98                         }
  99                 }
 100
 101                 ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
 102         }
 103
 104         protected function feedItem( $row ) {
 105                 $title = Title::makeTitle( intval( $row->page_namespace ), $row->page_title );
 106                 if ( $title && $title->userCan( 'read', $this->getUser() ) ) {
 107                         $date = $row->rev_timestamp;
 108                         $comments = $title->getTalkPage()->getFullURL();
 109                         $revision = Revision::newFromRow( $row );
 110
 111                         return new FeedItem(
 112                                 $title->getPrefixedText(),
 113                                 $this->feedItemDesc( $revision ),
 114                                 $title->getFullURL(),
 115                                 $date,
 116                                 $this->feedItemAuthor( $revision ),
 117                                 $comments
 118                         );
 119                 }
 120
 121                 return null;
 122         }
 123
 124         /**
 125          * @param $revision Revision
 126          * @return string
 127          */
 128         protected function feedItemAuthor( $revision ) {
 129                 return $revision->getUserText();
 130         }
 131
 132         /**
 133          * @param $revision Revision
 134          * @return string
 135          */
 136         protected function feedItemDesc( $revision ) {
 137                 if ( $revision ) {
 138                         $msg = wfMessage( 'colon-separator' )->inContentLanguage()->text();
 139                         $content = $revision->getContent();
 140
 141                         if ( $content instanceof TextContent ) {
 142                                 // only textual content has a "source view".
 143                                 $html = nl2br( htmlspecialchars( $content->getNativeData() ) );
 144                         } else {
 145                                 //XXX: we could get an HTML representation of the content via getParserOutput, but that may
 146                                 //     contain JS magic and generally may not be suitable for inclusion in a feed.
 147                                 //     Perhaps Content should have a getDescriptiveHtml method and/or a getSourceText method.
 148                                 //Compare also FeedUtils::formatDiffRow.
 149                                 $html = '';
 150                         }
 151
 152                         return '<p>' . htmlspecialchars( $revision->getUserText() ) . $msg .
 153                                 htmlspecialchars( FeedItem::stripComment( $revision->getComment() ) ) .
 154                                 "</p>\n<hr />\n<div>" . $html . "</div>";
 155                 }
 156
 157                 return '';
 158         }
 159
 160         public function getAllowedParams() {
 161                 global $wgFeedClasses;
 162                 $feedFormatNames = array_keys( $wgFeedClasses );
 163
 164                 return array(
 165                         'feedformat' => array(
 166                                 ApiBase::PARAM_DFLT => 'rss',
 167                                 ApiBase::PARAM_TYPE => $feedFormatNames
 168                         ),
 169                         'user' => array(
 170                                 ApiBase::PARAM_TYPE => 'user',
 171                                 ApiBase::PARAM_REQUIRED => true,
 172                         ),
 173                         'namespace' => array(
 174                                 ApiBase::PARAM_TYPE => 'namespace'
 175                         ),
 176                         'year' => array(
 177                                 ApiBase::PARAM_TYPE => 'integer'
 178                         ),
 179                         'month' => array(
 180                                 ApiBase::PARAM_TYPE => 'integer'
 181                         ),
 182                         'tagfilter' => array(
 183                                 ApiBase::PARAM_ISMULTI => true,
 184                                 ApiBase::PARAM_TYPE => array_values( ChangeTags::listDefinedTags() ),
 185                                 ApiBase::PARAM_DFLT => '',
 186                         ),
 187                         'deletedonly' => false,
 188                         'toponly' => false,
 189                         'showsizediff' => false,
 190                 );
 191         }
 192
 193         public function getParamDescription() {
 194                 return array(
 195                         'feedformat' => 'The format of the feed',
 196                         'user' => 'What users to get the contributions for',
 197                         'namespace' => 'What namespace to filter the contributions by',
 198                         'year' => 'From year (and earlier)',
 199                         'month' => 'From month (and earlier)',
 200                         'tagfilter' => 'Filter contributions that have these tags',
 201                         'deletedonly' => 'Show only deleted contributions',
 202                         'toponly' => 'Only show edits that are latest revisions',
 203                         'showsizediff' => 'Show the size difference between revisions. Disabled in Miser Mode',
 204                 );
 205         }
 206
 207         public function getDescription() {
 208                 return 'Returns a user contributions feed';
 209         }
 210
 211         public function getPossibleErrors() {
 212                 return array_merge( parent::getPossibleErrors(), array(
 213                         array( 'code' => 'feed-unavailable', 'info' => 'Syndication feeds are not available' ),
 214                         array( 'code' => 'feed-invalid', 'info' => 'Invalid subscription feed type' ),
 215                         array( 'code' => 'sizediffdisabled', 'info' => 'Size difference is disabled in Miser Mode' ),
 216                 ) );
 217         }
 218
 219         public function getExamples() {
 220                 return array(
 221                         'api.php?action=feedcontributions&user=Reedy',
 222                 );
 223         }
 224 }