X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/rcfeed/FormattedRCFeed.php

diff --git a/includes/rcfeed/FormattedRCFeed.php b/includes/rcfeed/FormattedRCFeed.php
new file mode 100644
index 00000000..afe900d0
--- /dev/null
+++ b/includes/rcfeed/FormattedRCFeed.php
@@ -0,0 +1,68 @@
+<?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
+ */
+
+/**
+ * Base class for RC feed engines that send messages in a freely configurable
+ * format to a uri-addressed engine set in $wgRCEngines.
+ * @since 1.29
+ */
+abstract class FormattedRCFeed extends RCFeed {
+	private $params;
+
+	/**
+	 * @param array $params
+	 *  - 'uri'
+	 *  - 'formatter'
+	 * @see $wgRCFeeds
+	 */
+	public function __construct( array $params = [] ) {
+		$this->params = $params;
+	}
+
+	/**
+	 * Send some text to the specified feed.
+	 *
+	 * @param array $feed The feed, as configured in an associative array
+	 * @param string $line The text to send
+	 * @return bool Success
+	 */
+	abstract public function send( array $feed, $line );
+
+	/**
+	 * @param RecentChange $rc
+	 * @param string|null $actionComment
+	 * @return bool Success
+	 */
+	public function notify( RecentChange $rc, $actionComment = null ) {
+		$params = $this->params;
+		/** @var RCFeedFormatter $formatter */
+		$formatter = is_object( $params['formatter'] ) ? $params['formatter'] : new $params['formatter'];
+
+		$line = $formatter->getLine( $params, $rc, $actionComment );
+		if ( !$line ) {
+			// @codeCoverageIgnoreStart
+			// T109544 - If a feed formatter returns null, this will otherwise cause an
+			// error in at least RedisPubSubFeedEngine. Not sure best to handle this.
+			return;
+			// @codeCoverageIgnoreEnd
+		}
+		return $this->send( $params, $line );
+	}
+}