X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiFeedWatchlist.php;h=4f2bb394a9b446f49122f401a600a17348a83dd7;hb=78bb312b86cfe6882cf12833037d9dcae96f9fe2;hp=6dd5f9879f24c62d816509e6a78a9bac345d1b9f;hpb=c43de1d4249d466681737346a7c76ec6d0640406;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiFeedWatchlist.php b/includes/api/ApiFeedWatchlist.php
index 6dd5f9879f..4f2bb394a9 100644
--- a/includes/api/ApiFeedWatchlist.php
+++ b/includes/api/ApiFeedWatchlist.php
@@ -1,12 +1,11 @@
 <?php
 
-
 /*
  * Created on Oct 13, 2006
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Copyright (C) 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
@@ -29,75 +28,160 @@ if (!defined('MEDIAWIKI')) {
 	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);
 	}
 
+	/**
+	 * This module uses a custom feed wrapper printer.
+	 */
 	public function getCustomPrinter() {
 		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());
-
-		// Prepare nested request
-		$params = new FauxRequest(array (
-			'action' => 'query',
-			'meta' => 'siteinfo',
-			'siprop' => 'general',
-			'list' => 'watchlist',
-			'wlprop' => 'user|comment|timestamp',
-			'wlstart' => wfTimestamp(TS_MW, time() - intval( 1 * 86400 )), // limit to 1 day
-			'wllimit' => 50
-		));
-		
-		// Execute
-		$module = new ApiMain($params);
-		$module->execute();
-
-		// Get data array
-		$data = & $module->getResultData();
-
-		$feedItems = array ();
-		foreach ($data['query']['watchlist'] as $index => $info) {
-			$title = $info['title'];
-			$titleUrl = Title :: newFromText($title)->getFullUrl();
-			$feedItems[] = new FeedItem($title, $info['comment'], $titleUrl, $info['timestamp'], $info['user']);
+
+		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);
 		}
+	}
+
+	private function createFeedItem($info) {
+		$titleStr = $info['title'];
+		$title = Title :: newFromText($titleStr);
+		$titleUrl = $title->getFullUrl();
+		$comment = isset( $info['comment'] ) ? $info['comment'] : null;
+		$timestamp = $info['timestamp'];
+		$user = $info['user'];
 
-		global $wgFeedClasses, $wgSitename, $wgContLanguageCode;
-		$feedTitle = $wgSitename . ' - ' . wfMsgForContent('watchlist') . ' [' . $wgContLanguageCode . ']';
-		$feedUrl = Title :: makeTitle(NS_SPECIAL, 'Watchlist')->getFullUrl();
-		$feed = new $wgFeedClasses[$feedformat] ($feedTitle, '!Watchlist (TODO)!', $feedUrl);
+		$completeText = "$comment ($user)";
 
-		ApiFormatFeedWrapper :: setResult($this->getResult(), $feed, $feedItems);
+		return new FeedItem($titleStr, $completeText, $titleUrl, $timestamp, $user);
 	}
 
-	protected function GetAllowedParams() {
+	public function getAllowedParams() {
 		global $wgFeedClasses;
 		$feedFormatNames = array_keys($wgFeedClasses);
 		return array (
 			'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() {
+	public function getParamDescription() {
 		return array (
-			'feedformat' => 'The format of the feed'
+			'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 wltoken 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() {
+	protected function getExamples() {
 		return array (
 			'api.php?action=feedwatchlist'
 		);
@@ -107,4 +191,3 @@ class ApiFeedWatchlist extends ApiBase {
 		return __CLASS__ . ': $Id$';
 	}
 }
-?>
\ No newline at end of file