From 8f416baead93a48e5799e44b8bd2e2c4859f4e04 Mon Sep 17 00:00:00 2001
From: Pierre Schmitz <pierre@archlinux.de>
Date: Fri, 14 Sep 2007 13:18:58 +0200
Subject: auf Version 1.11 aktualisiert; Login-Bug behoben

---
 includes/api/ApiFeedWatchlist.php | 121 ++++++++++++++++++++++++++------------
 1 file changed, 83 insertions(+), 38 deletions(-)

(limited to 'includes/api/ApiFeedWatchlist.php')

diff --git a/includes/api/ApiFeedWatchlist.php b/includes/api/ApiFeedWatchlist.php
index 7918ee0e..b2f6ceff 100644
--- a/includes/api/ApiFeedWatchlist.php
+++ b/includes/api/ApiFeedWatchlist.php
@@ -5,7 +5,7 @@
  *
  * 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,6 +29,10 @@ if (!defined('MEDIAWIKI')) {
 }
 
 /**
+ * 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.
+ * 
  * @addtogroup API
  */
 class ApiFeedWatchlist extends ApiBase {
@@ -37,47 +41,81 @@ class ApiFeedWatchlist extends ApiBase {
 		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());
-
-		// 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 $info) {
-			$feedItems[] = $this->createFeedItem($info);
-		}
-
+		
 		global $wgFeedClasses, $wgSitename, $wgContLanguageCode;
-		$feedTitle = $wgSitename . ' - ' . wfMsgForContent('watchlist') . ' [' . $wgContLanguageCode . ']';
-		$feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullUrl();
-
-		$feed = new $wgFeedClasses[$feedformat] ($feedTitle, htmlspecialchars(wfMsgForContent('watchlist')), $feedUrl);
 
-		ApiFormatFeedWrapper :: setResult($this->getResult(), $feed, $feedItems);
+		try {
+			$params = $this->extractRequestParams();
+			
+			// limit to the number of hours going from now back
+			$endTime = wfTimestamp(TS_MW, time() - intval($params['hours'] * 60 * 60));
+	
+			// Prepare nested request
+			$fauxReq = new FauxRequest(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
+			));
+	
+			// Execute
+			$module = new ApiMain($fauxReq);
+			$module->execute();
+
+			// Get data array
+			$data = $module->getResultData();
+	
+			$feedItems = array ();
+			foreach ($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) {
@@ -100,13 +138,20 @@ class ApiFeedWatchlist extends ApiBase {
 			'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,
 			)
 		);
 	}
 
 	protected 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'
 		);
 	}
 
@@ -121,7 +166,7 @@ class ApiFeedWatchlist extends ApiBase {
 	}
 
 	public function getVersion() {
-		return __CLASS__ . ': $Id: ApiFeedWatchlist.php 21402 2007-04-20 08:55:14Z nickj $';
+		return __CLASS__ . ': $Id: ApiFeedWatchlist.php 23531 2007-06-29 01:19:14Z simetrical $';
 	}
 }
-?>
+
-- 
cgit v1.2.3-54-g00ecf