Add XMLRCFeedFormatter

Endpoints like XMPP natively support sending XML,
which can be advantageous in some cases.

Since most of the logic is the same as the existing
JSONRCFeedFormatter, it was moved into an abstract
MachineReadableRCFeedFormatter class, which simply
creates the array and lets the implementations format
it.

Change-Id: I44f22777cb55fc1ca6527b79ef40b340e2afbd58

diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php
index 6436f3b..0e56b7c 100644 (file)
--- a/includes/AutoLoader.php
+++ b/includes/AutoLoader.php
@@ -842,6 +842,8 @@ $wgAutoloadLocalClasses = array(
        'RCFeedFormatter' => 'includes/rcfeed/RCFeedFormatter.php',
        'IRCColourfulRCFeedFormatter' => 'includes/rcfeed/IRCColourfulRCFeedFormatter.php',
        'JSONRCFeedFormatter' => 'includes/rcfeed/JSONRCFeedFormatter.php',
+       'XMLRCFeedFormatter' => 'includes/rcfeed/XMLRCFeedFormatter.php',
+       'MachineReadableRCFeedFormatter' => 'includes/rcfeed/MachineReadableRCFeedFormatter.php',
 
        # includes/resourceloader
        'ResourceLoader' => 'includes/resourceloader/ResourceLoader.php',

diff --git a/includes/rcfeed/JSONRCFeedFormatter.php b/includes/rcfeed/JSONRCFeedFormatter.php
index 063cb90..98d3f02 100644 (file)
--- a/includes/rcfeed/JSONRCFeedFormatter.php
+++ b/includes/rcfeed/JSONRCFeedFormatter.php
@@ -24,92 +24,9 @@
  *
  * @since 1.22
  */
+class JSONRCFeedFormatter extends MachineReadableRCFeedFormatter {
 
-class JSONRCFeedFormatter implements RCFeedFormatter {
-       /**
-        * Generates a notification that can be easily interpreted by a machine.
-        * @see RCFeedFormatter::getLine
-        */
-       public function getLine( array $feed, RecentChange $rc, $actionComment ) {
-               global $wgCanonicalServer, $wgScriptPath, $wgDBname;
-               $attrib = $rc->getAttributes();
-
-               $packet = array(
-                       // Usually, RC ID is exposed only for patrolling purposes,
-                       // but there is no real reason not to expose it in other cases,
-                       // and I can see how this may be potentially useful for clients.
-                       'id' => $attrib['rc_id'],
-                       'type' => $attrib['rc_type'],
-                       'namespace' => $rc->getTitle()->getNamespace(),
-                       'title' => $rc->getTitle()->getPrefixedText(),
-                       'comment' => $attrib['rc_comment'],
-                       'timestamp' => (int)wfTimestamp( TS_UNIX, $attrib['rc_timestamp'] ),
-                       'user' => $attrib['rc_user_text'],
-                       'bot' => (bool)$attrib['rc_bot'],
-               );
-
-               if ( isset( $feed['channel'] ) ) {
-                       $packet['channel'] = $feed['channel'];
-               }
-
-               $type = $attrib['rc_type'];
-               if ( $type == RC_EDIT || $type == RC_NEW ) {
-                       global $wgUseRCPatrol, $wgUseNPPatrol;
-
-                       $packet['minor'] = $attrib['rc_minor'];
-                       if ( $wgUseRCPatrol || ( $type == RC_NEW && $wgUseNPPatrol ) ) {
-                               $packet['patrolled'] = $attrib['rc_patrolled'];
-                       }
-               }
-
-               switch ( $type ) {
-                       case RC_EDIT:
-                               $packet['length'] = array( 'old' => $attrib['rc_old_len'], 'new' => $attrib['rc_new_len'] );
-                               $packet['revision'] = array( 'old' => $attrib['rc_last_oldid'], 'new' => $attrib['rc_this_oldid'] );
-                               break;
-
-                       case RC_NEW:
-                               $packet['length'] = array( 'old' => null, 'new' => $attrib['rc_new_len'] );
-                               $packet['revision'] = array( 'old' => null, 'new' => $attrib['rc_this_oldid'] );
-                               break;
-
-                       case RC_LOG:
-                               $packet['log_type'] = $attrib['rc_log_type'];
-                               $packet['log_action'] = $attrib['rc_log_action'];
-                               if ( $attrib['rc_params'] ) {
-                                       wfSuppressWarnings();
-                                       $params = unserialize( $attrib['rc_params'] );
-                                       wfRestoreWarnings();
-                                       if (
-                                               // If it's an actual serialised false...
-                                               $attrib['rc_params'] == serialize( false ) ||
-                                               // Or if we did not get false back when trying to unserialise
-                                               $params !== false
-                                       ) {
-                                               // From ApiQueryLogEvents::addLogParams
-                                               $logParams = array();
-                                               // Keys like "4::paramname" can't be used for output so we change them to "paramname"
-                                               foreach ( $params as $key => $value ) {
-                                                       if ( strpos( $key, ':' ) === false ) {
-                                                               $logParams[$key] = $value;
-                                                               continue;
-                                                       }
-                                                       $logParam = explode( ':', $key, 3 );
-                                                       $logParams[$logParam[2]] = $value;
-                                               }
-                                               $packet['log_params'] = $logParams;
-                                       } else {
-                                               $packet['log_params'] = explode( "\n", $attrib['rc_params'] );
-                                       }
-                               }
-                               $packet['log_action_comment'] = $actionComment;
-                               break;
-               }
-
-               $packet['server_url'] = $wgCanonicalServer;
-               $packet['server_script_path'] = $wgScriptPath ?: '/';
-               $packet['wiki'] = $wgDBname;
-
+       protected function formatArray( array $packet ) {
                return FormatJson::encode( $packet );
        }
 }

diff --git a/includes/rcfeed/MachineReadableRCFeedFormatter.php b/includes/rcfeed/MachineReadableRCFeedFormatter.php
new file mode 100644 (file)
index 0000000..565d0eb
--- /dev/null
+++ b/includes/rcfeed/MachineReadableRCFeedFormatter.php
@@ -0,0 +1,128 @@
+<?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
+ */
+
+/**
+ * Abstract class so there can be multiple formatters outputting the same data
+ *
+ * @since 1.23
+ */
+abstract class MachineReadableRCFeedFormatter implements RCFeedFormatter {
+
+       /**
+        * Take the packet and return the formatted string
+        * @param array $packet
+        * @return string
+        */
+       abstract protected function formatArray( array $packet );
+
+       /**
+        * Generates a notification that can be easily interpreted by a machine.
+        * @see RCFeedFormatter::getLine
+        */
+       public function getLine( array $feed, RecentChange $rc, $actionComment ) {
+               global $wgCanonicalServer, $wgScriptPath, $wgDBname;
+               $attrib = $rc->getAttributes();
+
+               $packet = array(
+                       // Usually, RC ID is exposed only for patrolling purposes,
+                       // but there is no real reason not to expose it in other cases,
+                       // and I can see how this may be potentially useful for clients.
+                       'id' => $attrib['rc_id'],
+                       'type' => $attrib['rc_type'],
+                       'namespace' => $rc->getTitle()->getNamespace(),
+                       'title' => $rc->getTitle()->getPrefixedText(),
+                       'comment' => $attrib['rc_comment'],
+                       'timestamp' => (int)wfTimestamp( TS_UNIX, $attrib['rc_timestamp'] ),
+                       'user' => $attrib['rc_user_text'],
+                       'bot' => (bool)$attrib['rc_bot'],
+               );
+
+               if ( isset( $feed['channel'] ) ) {
+                       $packet['channel'] = $feed['channel'];
+               }
+
+               $type = $attrib['rc_type'];
+               if ( $type == RC_EDIT || $type == RC_NEW ) {
+                       global $wgUseRCPatrol, $wgUseNPPatrol;
+
+                       $packet['minor'] = $attrib['rc_minor'];
+                       if ( $wgUseRCPatrol || ( $type == RC_NEW && $wgUseNPPatrol ) ) {
+                               $packet['patrolled'] = $attrib['rc_patrolled'];
+                       }
+               }
+
+               switch ( $type ) {
+                       case RC_EDIT:
+                               $packet['length'] = array(
+                                       'old' => $attrib['rc_old_len'],
+                                       'new' => $attrib['rc_new_len']
+                               );
+                               $packet['revision'] = array(
+                                       'old' => $attrib['rc_last_oldid'],
+                                       'new' => $attrib['rc_this_oldid']
+                               );
+                               break;
+
+                       case RC_NEW:
+                               $packet['length'] = array( 'old' => null, 'new' => $attrib['rc_new_len'] );
+                               $packet['revision'] = array( 'old' => null, 'new' => $attrib['rc_this_oldid'] );
+                               break;
+
+                       case RC_LOG:
+                               $packet['log_type'] = $attrib['rc_log_type'];
+                               $packet['log_action'] = $attrib['rc_log_action'];
+                               if ( $attrib['rc_params'] ) {
+                                       wfSuppressWarnings();
+                                       $params = unserialize( $attrib['rc_params'] );
+                                       wfRestoreWarnings();
+                                       if (
+                                               // If it's an actual serialised false...
+                                               $attrib['rc_params'] == serialize( false ) ||
+                                               // Or if we did not get false back when trying to unserialise
+                                               $params !== false
+                                       ) {
+                                               // From ApiQueryLogEvents::addLogParams
+                                               $logParams = array();
+                                               // Keys like "4::paramname" can't be used for output so we change them to "paramname"
+                                               foreach ( $params as $key => $value ) {
+                                                       if ( strpos( $key, ':' ) === false ) {
+                                                               $logParams[$key] = $value;
+                                                               continue;
+                                                       }
+                                                       $logParam = explode( ':', $key, 3 );
+                                                       $logParams[$logParam[2]] = $value;
+                                               }
+                                               $packet['log_params'] = $logParams;
+                                       } else {
+                                               $packet['log_params'] = explode( "\n", $attrib['rc_params'] );
+                                       }
+                               }
+                               $packet['log_action_comment'] = $actionComment;
+                               break;
+               }
+
+               $packet['server_url'] = $wgCanonicalServer;
+               $packet['server_script_path'] = $wgScriptPath ?: '/';
+               $packet['wiki'] = $wgDBname;
+
+               return $this->formatArray( $packet );
+       }
+}

diff --git a/includes/rcfeed/XMLRCFeedFormatter.php b/includes/rcfeed/XMLRCFeedFormatter.php
new file mode 100644 (file)
index 0000000..d572426
--- /dev/null
+++ b/includes/rcfeed/XMLRCFeedFormatter.php
@@ -0,0 +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
+ */
+
+/**
+ * @since 1.23
+ */
+class XMLRCFeedFormatter extends MachineReadableRCFeedFormatter {
+
+       protected function formatArray( array $packet ) {
+               return ApiFormatXml::recXmlPrint( 'recentchange', $packet, 0 );
+       }
+}