X-Git-Url: https://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiFeedWatchlist.php;h=34c6650bddddc53b8f1e2cb28d8a6e446bdd605f;hb=1d28b9ed350ae3d9c351273fb61b60453a88e04d;hp=b5003a221b4f73a407d7782a4720d74000ba543c;hpb=3ec1b5b6469cdafdb7b06857dc512437b1cb5ac4;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiFeedWatchlist.php b/includes/api/ApiFeedWatchlist.php index b5003a221b..34c6650bdd 100644 --- a/includes/api/ApiFeedWatchlist.php +++ b/includes/api/ApiFeedWatchlist.php @@ -1,12 +1,11 @@ + * Copyright © 2006 Yuri Astrakhan @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 @@ -20,102 +19,172 @@ * * 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 */ -if (!defined('MEDIAWIKI')) { +if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ("ApiBase.php"); + 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. + */ public function getCustomPrinter() { - return new ApiFormatFeedWrapper($this->getMain()); + return new ApiFormatFeedWrapper( $this->getMain() ); } + /** + * 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()); - - // limit to 1 day - $startTime = wfTimestamp(TS_MW, time() - intval(1 * 86400)); - - // Prepare nested request - $params = new FauxRequest(array ( - 'action' => 'query', - 'meta' => 'siteinfo', - 'siprop' => 'general', - 'list' => 'watchlist', - 'wlprop' => 'user|comment|timestamp', - 'wlstart' => $startTime, - 'wllimit' => 50 - )); - - // Execute - $module = new ApiMain($params); - $module->execute(); - - // Get data array - $data = $module->getResultData(); - - $feedItems = array (); - foreach ($data['query']['watchlist'] as $index => $info) { - $feedItems[] = $this->createFeedItem($info); + global $wgFeedClasses, $wgFeedLimit, $wgSitename, $wgContLanguageCode; + + try { + $params = $this->extractRequestParams(); + + // limit to the number of hours going from now back + $endTime = wfTimestamp( TS_MW, time() - intval( $params['hours'] * 60 * 60 ) ); + + $dbr = wfGetDB( DB_SLAVE ); + // 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' => $dbr->timestamp( $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']; + } + + // Check for 'allrev' parameter, and if found, show all revisions to each page on wl. + if ( !is_null( $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 ); + } + + $feedTitle = $wgSitename . ' - ' . wfMsgForContent( 'watchlist' ) . ' [' . $wgContLanguageCode . ']'; + $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullURL(); + + $feed = new $wgFeedClasses[$params['feedformat']] ( $feedTitle, htmlspecialchars( wfMsgForContent( 'watchlist' ) ), $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' ) . ' [' . $wgContLanguageCode . ']'; + $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, htmlspecialchars(wfMsgForContent('watchlist')), $feedUrl); - - ApiFormatFeedWrapper :: setResult($this->getResult(), $feed, $feedItems); } - private function createFeedItem($info) { - global $wgUser; - + private function createFeedItem( $info ) { $titleStr = $info['title']; - $title = Title :: newFromText($titleStr); - $titleUrl = $title->getFullUrl(); - $comment = $info['comment']; + $title = Title::newFromText( $titleStr ); + $titleUrl = $title->getFullURL(); + $comment = isset( $info['comment'] ) ? $info['comment'] : null; $timestamp = $info['timestamp']; $user = $info['user']; $completeText = "$comment ($user)"; - return new FeedItem($titleStr, $completeText, $titleUrl, $timestamp, $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' => null, + 'wlowner' => array( + ApiBase::PARAM_TYPE => 'user' + ), + 'wltoken' => array( + ApiBase::PARAM_TYPE => 'string' ) ); } - 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()}token if it's not you)", + 'wltoken' => 'Security token that requested user set in their preferences' ); } - protected function getDescription() { + public function getDescription() { return 'This module returns a watchlist feed'; } protected function getExamples() { - return array ( + return array( 'api.php?action=feedwatchlist' ); } @@ -124,4 +193,3 @@ class ApiFeedWatchlist extends ApiBase { return __CLASS__ . ': $Id$'; } } -?> \ No newline at end of file