<?php
-
-
-/*
- * Created on Oct 13, 2006
+/**
*
- * API for MediaWiki 1.8+
*
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Created on Oct 13, 2006
+ *
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
-if (!defined('MEDIAWIKI')) {
- // Eclipse helper - will be ignored in production
- require_once ("ApiBase.php");
-}
-
+/**
+ * This action allows users to get their watchlist items in RSS/Atom formats.
+ * When executed, it performs a nested call to the API to get the needed data,
+ * and formats it in a proper format.
+ *
+ * @ingroup API
+ */
class ApiFeedWatchlist extends ApiBase {
- public function __construct($main, $action) {
- parent :: __construct($main, $action);
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
}
+ /**
+ * This module uses a custom feed wrapper printer.
+ *
+ * @return ApiFormatFeedWrapper
+ */
public function getCustomPrinter() {
- return new ApiFormatFeedWrapper($this->getMain());
+ return new ApiFormatFeedWrapper( $this->getMain() );
}
+ private $linkToDiffs = false;
+
+ /**
+ * Make a nested call to the API to request watchlist items in the last $hours.
+ * Wrap the result as an RSS/Atom feed.
+ */
public function execute() {
- $feedformat = null;
- extract($this->extractRequestParams());
-
- // Prepare nested request
- $params = new FauxRequest(array (
- 'action' => 'query',
- 'meta' => 'siteinfo',
- 'siprop' => 'general',
- 'list' => 'watchlist',
- 'wlstart' => wfTimestamp(TS_MW, time() - intval( 3 * 86400 )), // limit to 3 days
- 'wllimit' => 50
- ));
-
- // Execute
- $module = new ApiMain($params);
- $module->execute();
-
- // Get clean data
- $result = & $module->getResult();
- $result->SanitizeData();
- $data = & $result->GetData();
-
- $feedItems = array ();
- foreach ($data['query']['watchlist'] as $index => & $info) {
- $title = $info['title'];
- $titleUrl = Title :: newFromText($title)->getFullUrl();
- $feedItems[] = new FeedItem($title, '', $titleUrl, $info['timestamp'], $info['user']);
+ global $wgFeed, $wgFeedClasses, $wgFeedLimit, $wgSitename, $wgLanguageCode;
+
+ try {
+ $params = $this->extractRequestParams();
+
+ if( !$wgFeed ) {
+ $this->dieUsage( 'Syndication feeds are not available', 'feed-unavailable' );
+ }
+
+ if( !isset( $wgFeedClasses[ $params['feedformat'] ] ) ) {
+ $this->dieUsage( 'Invalid subscription feed type', 'feed-invalid' );
+ }
+ if ( !is_null( $params['wlexcludeuser'] ) ) {
+ $fauxReqArr['wlexcludeuser'] = $params['wlexcludeuser'];
+ }
+
+ // limit to the number of hours going from now back
+ $endTime = wfTimestamp( TS_MW, time() - intval( $params['hours'] * 60 * 60 ) );
+
+ // Prepare parameters for nested request
+ $fauxReqArr = array(
+ 'action' => 'query',
+ 'meta' => 'siteinfo',
+ 'siprop' => 'general',
+ 'list' => 'watchlist',
+ 'wlprop' => 'title|user|comment|timestamp',
+ 'wldir' => 'older', // reverse order - from newest to oldest
+ 'wlend' => $endTime, // stop at this time
+ 'wllimit' => ( 50 > $wgFeedLimit ) ? $wgFeedLimit : 50
+ );
+
+ if ( !is_null( $params['wlowner'] ) ) {
+ $fauxReqArr['wlowner'] = $params['wlowner'];
+ }
+ if ( !is_null( $params['wltoken'] ) ) {
+ $fauxReqArr['wltoken'] = $params['wltoken'];
+ }
+
+ // Support linking to diffs instead of article
+ if ( $params['linktodiffs'] ) {
+ $this->linkToDiffs = true;
+ $fauxReqArr['wlprop'] .= '|ids';
+ }
+
+ // Check for 'allrev' parameter, and if found, show all revisions to each page on wl.
+ if ( $params['allrev'] ) {
+ $fauxReqArr['wlallrev'] = '';
+ }
+
+ // Create the request
+ $fauxReq = new FauxRequest( $fauxReqArr );
+
+ // Execute
+ $module = new ApiMain( $fauxReq );
+ $module->execute();
+
+ // Get data array
+ $data = $module->getResultData();
+
+ $feedItems = array();
+ foreach ( (array)$data['query']['watchlist'] as $info ) {
+ $feedItems[] = $this->createFeedItem( $info );
+ }
+
+ $msg = wfMsgForContent( 'watchlist' );
+
+ $feedTitle = $wgSitename . ' - ' . $msg . ' [' . $wgLanguageCode . ']';
+ $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL();
+
+ $feed = new $wgFeedClasses[$params['feedformat']] ( $feedTitle, htmlspecialchars( $msg ), $feedUrl );
+
+ ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
+
+ } catch ( Exception $e ) {
+
+ // Error results should not be cached
+ $this->getMain()->setCacheMaxAge( 0 );
+
+ $feedTitle = $wgSitename . ' - Error - ' . wfMsgForContent( 'watchlist' ) . ' [' . $wgLanguageCode . ']';
+ $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL();
+
+ $feedFormat = isset( $params['feedformat'] ) ? $params['feedformat'] : 'rss';
+ $feed = new $wgFeedClasses[$feedFormat] ( $feedTitle, htmlspecialchars( wfMsgForContent( 'watchlist' ) ), $feedUrl );
+
+ if ( $e instanceof UsageException ) {
+ $errorCode = $e->getCodeString();
+ } else {
+ // Something is seriously wrong
+ $errorCode = 'internal_api_error';
+ }
+
+ $errorText = $e->getMessage();
+ $feedItems[] = new FeedItem( "Error ($errorCode)", $errorText, '', '', '' );
+ ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
}
+ }
- global $wgFeedClasses, $wgSitename, $wgContLanguageCode;
- $feedTitle = $wgSitename . ' - ' . wfMsgForContent('watchlist') . ' [' . $wgContLanguageCode . ']';
- $feedUrl = Title :: makeTitle(NS_SPECIAL, 'Watchlist')->getFullUrl();
- $feed = new $wgFeedClasses[$feedformat] ($feedTitle, '!Watchlist!', $feedUrl);
+ /**
+ * @param $info array
+ * @return FeedItem
+ */
+ private function createFeedItem( $info ) {
+ $titleStr = $info['title'];
+ $title = Title::newFromText( $titleStr );
+ if ( $this->linkToDiffs && isset( $info['revid'] ) ) {
+ $titleUrl = $title->getFullURL( array( 'diff' => $info['revid'] ) );
+ } else {
+ $titleUrl = $title->getFullURL();
+ }
+ $comment = isset( $info['comment'] ) ? $info['comment'] : null;
+ $timestamp = $info['timestamp'];
+ $user = $info['user'];
- ApiFormatFeedWrapper :: setResult($this->getResult(), $feed, $feedItems);
+ $completeText = "$comment ($user)";
+
+ return new FeedItem( $titleStr, $completeText, $titleUrl, $timestamp, $user );
}
- protected function GetAllowedParams() {
+ public function getAllowedParams() {
global $wgFeedClasses;
- $feedFormatNames = array_keys($wgFeedClasses);
+ $feedFormatNames = array_keys( $wgFeedClasses );
return array (
- 'feedformat' => array (
- ApiBase :: PARAM_DFLT => 'rss',
- ApiBase :: PARAM_TYPE => $feedFormatNames
- )
+ 'feedformat' => array(
+ ApiBase::PARAM_DFLT => 'rss',
+ ApiBase::PARAM_TYPE => $feedFormatNames
+ ),
+ 'hours' => array(
+ ApiBase::PARAM_DFLT => 24,
+ ApiBase::PARAM_TYPE => 'integer',
+ ApiBase::PARAM_MIN => 1,
+ ApiBase::PARAM_MAX => 72,
+ ),
+ 'allrev' => false,
+ 'wlowner' => array(
+ ApiBase::PARAM_TYPE => 'user'
+ ),
+ 'wltoken' => array(
+ ApiBase::PARAM_TYPE => 'string'
+ ),
+ 'wlexcludeuser' => array(
+ ApiBase::PARAM_TYPE => 'user'
+ ),
+ 'linktodiffs' => false,
);
}
- protected function GetParamDescription() {
- return array (
- 'feedformat' => 'The format of the feed'
+ public function getParamDescription() {
+ return array(
+ 'feedformat' => 'The format of the feed',
+ 'hours' => 'List pages modified within this many hours from now',
+ 'allrev' => 'Include multiple revisions of the same page within given timeframe',
+ 'wlowner' => "The user whose watchlist you want (must be accompanied by {$this->getModulePrefix()}wltoken if it's not you)",
+ 'wltoken' => 'Security token that requested user set in their preferences',
+ 'wlexcludeuser' => 'A user whose edits should not be shown in the watchlist',
+ 'linktodiffs' => 'Link to change differences instead of article pages',
);
}
- protected function GetDescription() {
- return 'This module returns a watchlist feed';
+ public function getDescription() {
+ return 'Returns a watchlist feed';
}
- protected function GetExamples() {
- return array (
- 'api.php?action=feedwatchlist'
+ public function getPossibleErrors() {
+ return array_merge( parent::getPossibleErrors(), array(
+ array( 'code' => 'feed-unavailable', 'info' => 'Syndication feeds are not available' ),
+ array( 'code' => 'feed-invalid', 'info' => 'Invalid subscription feed type' ),
+ ) );
+ }
+
+ public function getExamples() {
+ return array(
+ 'api.php?action=feedwatchlist',
+ 'api.php?action=feedwatchlist&allrev=&linktodiffs=&hours=6'
);
}
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/API:Watchlist_feed';
+ }
+
public function getVersion() {
return __CLASS__ . ': $Id$';
}
}
-?>
\ No newline at end of file
dépôts / lhc / web / wiklou.git / blobdiff