From a76af536004a770835fe65f747c022f1e42c4e3f Mon Sep 17 00:00:00 2001
From: Kunal Mehta <legoktm@gmail.com>
Date: Sat, 4 Jan 2014 21:10:13 -0800
Subject: [PATCH] Cleanup of includes/rcfeed

* Added license headers to everything
* Added @since tags for all classes
* Use wfParseUrl instead of parse_url
* Check for RedisConnectionPool::getConnection returning false

Change-Id: I7db808c0465bd869de3f2daa82444b5e3d1268c2
---
 .../rcfeed/IRCColourfulRCFeedFormatter.php    | 27 +++++++-
 includes/rcfeed/JSONRCFeedFormatter.php       | 25 ++++++++
 includes/rcfeed/RCFeedEngine.php              | 25 ++++++++
 includes/rcfeed/RCFeedFormatter.php           | 27 +++++++-
 includes/rcfeed/RedisPubSubFeedEngine.php     | 62 ++++++++++++++-----
 includes/rcfeed/UDPRCFeedEngine.php           | 26 +++++++-
 6 files changed, 173 insertions(+), 19 deletions(-)

diff --git a/includes/rcfeed/IRCColourfulRCFeedFormatter.php b/includes/rcfeed/IRCColourfulRCFeedFormatter.php
index 507369f390..ddbb548540 100644
--- a/includes/rcfeed/IRCColourfulRCFeedFormatter.php
+++ b/includes/rcfeed/IRCColourfulRCFeedFormatter.php
@@ -1,7 +1,32 @@
 <?php
+
+/**
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Generates a colourful notification intended for humans on IRC.
+ *
+ * @since 1.22
+ */
+
 class IRCColourfulRCFeedFormatter implements RCFeedFormatter {
 	/**
-	 * Generates a colourful notification intended for humans on IRC.
 	 * @see RCFeedFormatter::getLine
 	 */
 	public function getLine( array $feed, RecentChange $rc, $actionComment ) {
diff --git a/includes/rcfeed/JSONRCFeedFormatter.php b/includes/rcfeed/JSONRCFeedFormatter.php
index 144ec95bbc..063cb90b40 100644
--- a/includes/rcfeed/JSONRCFeedFormatter.php
+++ b/includes/rcfeed/JSONRCFeedFormatter.php
@@ -1,5 +1,30 @@
 <?php
 
+/**
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Formats a notification into the JSON format (http://www.json.org)
+ *
+ * @since 1.22
+ */
+
 class JSONRCFeedFormatter implements RCFeedFormatter {
 	/**
 	 * Generates a notification that can be easily interpreted by a machine.
diff --git a/includes/rcfeed/RCFeedEngine.php b/includes/rcfeed/RCFeedEngine.php
index f733bcb71d..022e317521 100644
--- a/includes/rcfeed/RCFeedEngine.php
+++ b/includes/rcfeed/RCFeedEngine.php
@@ -1,4 +1,29 @@
 <?php
+
+/**
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Interface for RC feed engines, which send formatted notifications
+ *
+ * @since 1.22
+ */
 interface RCFeedEngine {
 	/**
 	 * Sends some text to the specified live feed.
diff --git a/includes/rcfeed/RCFeedFormatter.php b/includes/rcfeed/RCFeedFormatter.php
index 6c9f804211..2f156598d3 100644
--- a/includes/rcfeed/RCFeedFormatter.php
+++ b/includes/rcfeed/RCFeedFormatter.php
@@ -1,7 +1,32 @@
 <?php
+
+/**
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Interface for RC feed formatters
+ *
+ * @since 1.22
+ */
 interface RCFeedFormatter {
 	/**
-	 * Formats the line for the live feed.
+	 * Formats the line to be sent by an engine
 	 *
 	 * @param array $feed The feed, as configured in an associative array.
 	 * @param RecentChange $rc The RecentChange object showing what sort
diff --git a/includes/rcfeed/RedisPubSubFeedEngine.php b/includes/rcfeed/RedisPubSubFeedEngine.php
index 4bcc13375b..b9023b6b84 100644
--- a/includes/rcfeed/RedisPubSubFeedEngine.php
+++ b/includes/rcfeed/RedisPubSubFeedEngine.php
@@ -1,23 +1,48 @@
 <?php
+
+/**
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Emit a recent change notification via Redis Pub/Sub
+ *
+ * If the feed URI contains a path component, it will be used to generate a
+ * channel name by stripping the leading slash and replacing any remaining
+ * slashes with '.'. If no path component is present, the channel is set to
+ * 'rc'. If the URI contains a query string, its parameters will be parsed
+ * as RedisConnectionPool options.
+ *
+ * @example
+ * $wgRCFeeds['redis'] = array(
+ *      'formatter' => 'JSONRCFeedFormatter',
+ *      'uri'       => "redis://127.0.0.1:6379/rc.$wgDBname",
+ * );
+ *
+ * @since 1.22
+ */
 class RedisPubSubFeedEngine implements RCFeedEngine {
+
 	/**
-	 * Emit a recent change notification via Redis Pub/Sub
-	 *
-	 * If the feed URI contains a path component, it will be used to generate a
-	 * channel name by stripping the leading slash and replacing any remaining
-	 * slashes with '.'. If no path component is present, the channel is set to
-	 * 'rc'. If the URI contains a query string, its parameters will be parsed
-	 * as RedisConnectionPool options.
-	 *
-	 * @example $wgRCFeeds['redis'] = array(
-	 *      'formatter' => 'JSONRCFeedFormatter',
-	 *      'uri'       => "redis://127.0.0.1:6379/rc.$wgDBname",
-	 * );
-	 *
-	 * @since 1.22
+	 * @see RCFeedEngine::send
 	 */
 	public function send( array $feed, $line ) {
-		$parsed = parse_url( $feed['uri'] );
+		$parsed = wfParseUrl( $feed['uri'] );
 		$server = $parsed['host'];
 		$options = array( 'serializer' => 'none' );
 		$channel = 'rc';
@@ -36,6 +61,11 @@ class RedisPubSubFeedEngine implements RCFeedEngine {
 		}
 		$pool = RedisConnectionPool::singleton( $options );
 		$conn = $pool->getConnection( $server );
-		$conn->publish( $channel, $line );
+		if ( $conn !== false ) {
+			$conn->publish( $channel, $line );
+			return true;
+		} else {
+			return false;
+		}
 	}
 }
diff --git a/includes/rcfeed/UDPRCFeedEngine.php b/includes/rcfeed/UDPRCFeedEngine.php
index beeb73bd78..8554670e13 100644
--- a/includes/rcfeed/UDPRCFeedEngine.php
+++ b/includes/rcfeed/UDPRCFeedEngine.php
@@ -1,7 +1,31 @@
 <?php
+
+/**
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Sends the notification to the specified host in a UDP packet.
+ * @since 1.22
+ */
+
 class UDPRCFeedEngine implements RCFeedEngine {
 	/**
-	 * Sends the notification to the specified host in a UDP packet.
 	 * @see RCFeedEngine::send
 	 */
 	public function send( array $feed, $line ) {
-- 
2.20.1