Initial version.

git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/trunk@9082 b35dd754-fafc-0310-a699-88a17e54d16e

Initial version.
git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/trunk@9082 b35dd754-fafc-0310-a699-88a17e54d16e
2a142623 · Gaston Dombiak · gato · 62f63dca · 2a142623 · 2a142623
Commit 2a142623 authored Sep 07, 2007 by Gaston Dombiak Committed by gato Sep 07, 2007
6 changed files
--- a/src/plugins/xmldebugger/changelog.html
+++ b/src/plugins/xmldebugger/changelog.html
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+	<title>Broadcast Plugin Changelog</title>
+    <style type="text/css">
+        BODY {
+            font-size : 100%;
+        }
+        BODY, TD, TH {
+            font-family : tahoma, verdana, arial, helvetica, sans-serif;
+            font-size : 0.8em;
+        }
+        H2 {
+             font-size : 10pt;
+             font-weight : bold;
+             padding-left : 1em;
+        }
+        A:hover {
+            text-decoration : none;
+        }
+        H1 {
+            font-family : tahoma, arial, helvetica, sans-serif;
+            font-size : 1.4em;
+            font-weight: bold;
+            border-bottom : 1px #ccc solid;
+            padding-bottom : 2px;
+        }
+      
+        TT {
+            font-family : courier new;
+            font-weight : bold;
+            color : #060;
+        }
+        PRE {
+            font-family : courier new;
+            font-size : 100%;
+        }
+    </style>
+</head>
+<body>
+
+<h1>
+XML Debugger Plugin Changelog
+</h1>
+
+<p><b>1.0.0</b> -- September 5, 2007</p>
+<ul>
+    <li>Initial release.</li>
+</ul>
+
+
+</body>
+</html>
\ No newline at end of file
--- a/src/plugins/xmldebugger/plugin.xml
+++ b/src/plugins/xmldebugger/plugin.xml
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+  Plugin configuration for the sessions debugger plugin.
+-->
+<plugin>
+    <class>org.jivesoftware.openfire.plugin.DebuggerPlugin</class>
+    <name>Debugger Plugin</name>
+    <description>Prints XML traffic to the stdout (raw and interpreted XML)</description>
+    <author>Jive Software</author>
+    <version>1.0</version>
+    <minServerVersion>3.2.0</minServerVersion>
+</plugin>
\ No newline at end of file
--- a/src/plugins/xmldebugger/readme.html
+++ b/src/plugins/xmldebugger/readme.html
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+	<title>XML Debugger Plugin Readme</title>
+    <style type="text/css">
+        BODY {
+            font-size : 100%;
+        }
+        BODY, TD, TH {
+            font-family : tahoma, verdana, arial, helvetica, sans-serif;
+            font-size : 0.8em;
+        }
+        H2 {
+             font-size : 10pt;
+             font-weight : bold;
+        }
+        A:hover {
+            text-decoration : none;
+        }
+        H1 {
+            font-family : tahoma, arial, helvetica, sans-serif;
+            font-size : 1.4em;
+            font-weight: bold;
+            border-bottom : 1px #ccc solid;
+            padding-bottom : 2px;
+        }
+
+        TT {
+            font-family : courier new;
+            font-weight : bold;
+            color : #060;
+        }
+        PRE {
+            font-family : courier new;
+            font-size : 100%;
+        }
+    </style>
+</head>
+<body>
+
+<h1>
+XML Debugger Plugin Readme
+</h1>
+
+<h2>Overview</h2>
+
+<p>
+The xml debugger plugin prints XML traffic to the stdout. The plugin will print raw XML as it
+was received and sent by the server as well as interpreted XML (i.e. parsed XML). By default the
+plugin will only print raw XML.
+</p>
+
+<h2>Installation</h2>
+
+<p>Copy xmldebugger.jar into the plugins directory of your Openfire installation. The
+plugin will then be automatically deployed. To upgrade to a new version, copy the new
+xmldebugger.jar file over the existing file.</p>
+
+<h2>Configuration</h2>
+
+The debugger plugin is configured via Openfire system properties. These can
+be configured under Server/Server Manager/System Properties:
+
+<ul>
+    <li><tt>plugin.debugger.interpretedAllowed</tt> -- true to print XML packets
+        after they were parsed by the server. This only includes incoming traffic. The
+        default value is false.</li>
+</ul>
+
+<h2>Using the Plugin</h2>
+
+Traffic generated by sessions created after the plugin was installed will be captured and
+printed.
+
+</body>
+</html>
--- a/src/plugins/xmldebugger/src/java/org/jivesoftware/openfire/plugin/DebuggerPlugin.java
+++ b/src/plugins/xmldebugger/src/java/org/jivesoftware/openfire/plugin/DebuggerPlugin.java
+/**
+ * $RCSfile: $
+ * $Revision: $
+ * $Date: $
+ *
+ * Copyright (C) 2007 Jive Software. All rights reserved.
+ *
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
+ */
+
+package org.jivesoftware.openfire.plugin;
+
+import org.jivesoftware.openfire.XMPPServer;
+import org.jivesoftware.openfire.container.Plugin;
+import org.jivesoftware.openfire.container.PluginManager;
+import org.jivesoftware.openfire.interceptor.InterceptorManager;
+import org.jivesoftware.openfire.spi.ConnectionManagerImpl;
+import org.jivesoftware.util.JiveGlobals;
+import org.jivesoftware.util.PropertyEventDispatcher;
+import org.jivesoftware.util.PropertyEventListener;
+
+import java.io.File;
+import java.util.Map;
+
+/**
+ * Debugger plugin that prints XML traffic to stdout. By default it will only print
+ * raw XML traffic (by using a MINA filter). To turn on printing of interpreted XML
+ * (i.e. parsed XML) just enable the system property <tt>plugin.debugger.interpretedAllowed</tt>.
+ * There is no need to restart the plugin or the server.
+ *
+ * @author Gaston Dombiak
+ */
+public class DebuggerPlugin implements Plugin, PropertyEventListener {
+    private RawPrintFilter defaultPortFilter;
+    private RawPrintFilter oldPortFilter;
+
+    private InterpretedXMLPrinter interpretedPrinter;
+
+    public void initializePlugin(PluginManager manager, File pluginDirectory) {
+        // Add filter to filter chain builder
+        ConnectionManagerImpl connManager = (ConnectionManagerImpl) XMPPServer.getInstance().getConnectionManager();
+        defaultPortFilter = new RawPrintFilter();
+        connManager.getSocketAcceptor().getFilterChain().addBefore("xmpp", "rawDebugger", defaultPortFilter);
+        oldPortFilter = new RawPrintFilter();
+        connManager.getSSLSocketAcceptor().getFilterChain().addBefore("xmpp", "rawDebugger", oldPortFilter);
+
+        interpretedPrinter = new InterpretedXMLPrinter();
+        if (JiveGlobals.getBooleanProperty("plugin.debugger.interpretedAllowed")) {
+            // Add the packet interceptor that prints interpreted XML
+            InterceptorManager.getInstance().addInterceptor(interpretedPrinter);
+        }
+        // Listen to property events
+        PropertyEventDispatcher.addListener(this);
+    }
+
+    public void destroyPlugin() {
+        // Stop listening to property events
+        PropertyEventDispatcher.removeListener(this);
+        // Remove filter from filter chain builder
+        ConnectionManagerImpl connManager = (ConnectionManagerImpl) XMPPServer.getInstance().getConnectionManager();
+        if (connManager.getSocketAcceptor().getFilterChain().contains("rawDebugger")) {
+            connManager.getSocketAcceptor().getFilterChain().remove("rawDebugger");
+        }
+        if (connManager.getSSLSocketAcceptor().getFilterChain().contains("rawDebugger")) {
+            connManager.getSSLSocketAcceptor().getFilterChain().remove("rawDebugger");
+        }
+        // Remove the filters from existing sessions
+        if (defaultPortFilter != null) {
+            defaultPortFilter.shutdown();
+        }
+        if (oldPortFilter != null) {
+            oldPortFilter.shutdown();
+        }
+
+        // Remove the packet interceptor that prints interpreted XML
+        InterceptorManager.getInstance().removeInterceptor(interpretedPrinter);
+
+        defaultPortFilter = null;
+        oldPortFilter = null;
+        interpretedPrinter = null;
+    }
+
+
+    public void propertySet(String property, Map<String, Object> params) {
+        if (property.equals("plugin.debugger.interpretedAllowed")) {
+            if (Boolean.parseBoolean((String)params.get("value"))) {
+                InterceptorManager.getInstance().addInterceptor(interpretedPrinter);
+            }
+            else {
+                InterceptorManager.getInstance().removeInterceptor(interpretedPrinter);
+            }
+        }
+    }
+
+    public void propertyDeleted(String property, Map<String, Object> params) {
+        if (property.equals("plugin.debugger.interpretedAllowed")) {
+            InterceptorManager.getInstance().removeInterceptor(interpretedPrinter);
+        }
+    }
+
+    public void xmlPropertySet(String property, Map<String, Object> params) {
+        // Do nothing
+    }
+
+    public void xmlPropertyDeleted(String property, Map<String, Object> params) {
+        // Do nothing
+    }
+}
--- a/src/plugins/xmldebugger/src/java/org/jivesoftware/openfire/plugin/InterpretedXMLPrinter.java
+++ b/src/plugins/xmldebugger/src/java/org/jivesoftware/openfire/plugin/InterpretedXMLPrinter.java
+/**
+ * $RCSfile: $
+ * $Revision: $
+ * $Date: $
+ *
+ * Copyright (C) 2007 Jive Software. All rights reserved.
+ *
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
+ */
+
+package org.jivesoftware.openfire.plugin;
+
+import org.jivesoftware.openfire.interceptor.PacketInterceptor;
+import org.jivesoftware.openfire.interceptor.PacketRejectedException;
+import org.jivesoftware.openfire.session.Session;
+import org.xmpp.packet.Packet;
+
+/**
+ * Packet interceptor that prints to the stdout XML packets (i.e. XML after
+ * it was parsed).<p>
+ *
+ * If you find in the logs an entry for raw XML, an entry that a session was closed and
+ * never find the corresponding interpreted XML for the raw XML then there was an error
+ * while parsing the XML that closed the session. 
+ *
+ * @author Gaston Dombiak.
+ */
+public class InterpretedXMLPrinter implements PacketInterceptor {
+
+    public void interceptPacket(Packet packet, Session session, boolean incoming, boolean processed)
+            throws PacketRejectedException {
+        if (!processed && incoming) {
+            System.out.println("INTERPRETED: " + packet.toXML());
+        }
+    }
+}
--- a/src/plugins/xmldebugger/src/java/org/jivesoftware/openfire/plugin/RawPrintFilter.java
+++ b/src/plugins/xmldebugger/src/java/org/jivesoftware/openfire/plugin/RawPrintFilter.java
+/**
+ * $RCSfile: $
+ * $Revision: $
+ * $Date: $
+ *
+ * Copyright (C) 2007 Jive Software. All rights reserved.
+ *
+ * This software is published under the terms of the GNU Public License (GPL),
+ * a copy of which is included in this distribution.
+ */
+
+package org.jivesoftware.openfire.plugin;
+
+import org.apache.mina.common.ByteBuffer;
+import org.apache.mina.common.IoFilterAdapter;
+import org.apache.mina.common.IoSession;
+
+import java.nio.CharBuffer;
+import java.nio.charset.Charset;
+import java.util.Collection;
+import java.util.concurrent.ConcurrentLinkedQueue;
+
+/**
+ * MINA filter that prints to the stdout received XML stanzas before they are actually parsed and
+ * also prints XML stanzas as sent to the XMPP entities. Moreover, it also prints information when
+ * a session is closed. 
+ *
+ * @author Gaston Dombiak
+ */
+public class RawPrintFilter extends IoFilterAdapter {
+        private Collection<IoSession> sessions = new ConcurrentLinkedQueue<IoSession>();
+
+        public void messageReceived(NextFilter nextFilter, IoSession session, Object message) throws Exception {
+            // Decode the bytebuffer and print it to the stdout
+            if (message instanceof ByteBuffer) {
+                ByteBuffer byteBuffer = (ByteBuffer) message;
+                // Keep current position in the buffer
+                int currentPos = byteBuffer.position();
+                // Decode buffer
+                Charset encoder = Charset.forName("UTF-8");
+                CharBuffer charBuffer = encoder.decode(byteBuffer.buf());
+                // Print buffer content
+                System.out.println("RECV (" + session.hashCode() + "): " + charBuffer);
+                // Reset to old position in the buffer
+                byteBuffer.position(currentPos);
+            }
+            // Pass the message to the next filter
+            super.messageReceived(nextFilter, session, message);
+        }
+
+        public void messageSent(NextFilter nextFilter, IoSession session, Object message) throws Exception {
+            System.out.println("SENT (" + session.hashCode() + "): " +
+                    Charset.forName("UTF-8").decode(((ByteBuffer) message).buf()));
+
+            // Pass the message to the next filter
+            super.messageSent(nextFilter, session, message);
+        }
+
+
+        public void shutdown() {
+            // Remove this filter from sessions that are using it
+            for (IoSession session : sessions) {
+                session.getFilterChain().remove("rawDebugger");
+            }
+            sessions = null;
+        }
+
+        public void sessionCreated(NextFilter nextFilter, IoSession session) throws Exception {
+            // Keep track of sessions using this filter
+            sessions.add(session);
+
+            super.sessionCreated(nextFilter, session);
+        }
+
+        public void sessionClosed(NextFilter nextFilter, IoSession session) throws Exception {
+            // Update list of sessions using this filter
+            sessions.remove(session);
+            // Print that a session was closed
+            System.out.println("CLOSED (" + session.hashCode() + ") ");
+
+            super.sessionClosed(nextFilter, session);
+        }
+    }
\ No newline at end of file