* Refactored IPUnblockForm::doUnblock() to return an array of message keys and parameters

[lhc/web/wiklou.git] / includes / api / ApiFeedWatchlist.php

diff --git a/includes/api/ApiFeedWatchlist.php b/includes/api/ApiFeedWatchlist.php
index 55b5681..02bbbaa 100644 (file)
--- 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,33 +41,47 @@ 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 going from now back
-               $endTime = wfTimestamp(TS_MW, time() - intval(1 * 24 * 60 * 60));
-
-               // Prepare nested request
-               $params = new FauxRequest(array (
-                       'action' => 'query',
-                       'meta' => 'siteinfo',
-                       'siprop' => 'general',
-                       'list' => 'watchlist',
-                       'wlprop' => 'user|comment|timestamp',
-                       'wldir' => 'older',
-                       'wlend' => $endTime,
-                       'wllimit' => 50
-               ));
-
-               // Execute
-               $module = new ApiMain($params);
+               
+               global $wgFeedClasses, $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));
+       
+                       // 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
+                       );
+
+                       // 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
@@ -74,11 +92,10 @@ class ApiFeedWatchlist extends ApiBase {
                                $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);
+                       $feed = new $wgFeedClasses[$params['feedformat']] ($feedTitle, htmlspecialchars(wfMsgForContent('watchlist')), $feedUrl);
        
                        ApiFormatFeedWrapper :: setResult($this->getResult(), $feed, $feedItems);
 
@@ -87,11 +104,11 @@ class ApiFeedWatchlist extends ApiBase {
                        // Error results should not be cached
                        $this->getMain()->setCacheMaxAge(0);
        
-                       global $wgFeedClasses, $wgSitename, $wgContLanguageCode;
                        $feedTitle = $wgSitename . ' - Error - ' . wfMsgForContent('watchlist') . ' [' . $wgContLanguageCode . ']';
                        $feedUrl = SpecialPage::getTitleFor( 'Watchlist' )->getFullUrl();
        
-                       $feed = new $wgFeedClasses[$feedformat] ($feedTitle, htmlspecialchars(wfMsgForContent('watchlist')), $feedUrl);
+                       $feedFormat = isset($params['feedformat']) ? $params['feedformat'] : 'rss'; 
+                       $feed = new $wgFeedClasses[$feedFormat] ($feedTitle, htmlspecialchars(wfMsgForContent('watchlist')), $feedUrl);
 
 
                        if ($e instanceof UsageException) {
@@ -127,13 +144,22 @@ 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,
+                       ),
+                       'allrev' => null
                );
        }
 
        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',
+                       'allrev'     => 'Include multiple revisions of the same page within given timeframe.'
                );
        }
 
@@ -151,4 +177,4 @@ class ApiFeedWatchlist extends ApiBase {
                return __CLASS__ . ': $Id$';
        }
 }
-?>
+