+ *
+ * A new EnhancedDebugger will be created for each connection to debug. All the EnhancedDebuggers
+ * will be shown in the same debug window provided by the class EnhancedDebuggerWindow.
+ *
+ * @author Gaston Dombiak
+ */
+public class EnhancedDebugger implements SmackDebugger {
+
+ private static final String NEWLINE = "\n";
+
+ private JFrame frame = null;
+ private DefaultTableModel messagesTable = null;
+ private JTextArea messageTextArea = null;
+ private JFormattedTextField userField = null;
+ private JFormattedTextField statusField = null;
+
+ private XMPPConnection connection = null;
+
+ private PacketListener listener = null;
+ private PacketWriterListener writerListener = null;
+ private ConnectionListener connListener = null;
+
+ private Writer writer;
+ private Reader reader;
+
+ private Date creationTime = new Date();
+
+ // Statistics variables
+ private DefaultTableModel statisticsTable = null;
+ private int sentPackets = 0;
+ private int receivedPackets = 0;
+ private int sentIQPackets = 0;
+ private int receivedIQPackets = 0;
+ private int sentMessagePackets = 0;
+ private int receivedMessagePackets = 0;
+ private int sentPresencePackets = 0;
+ private int receivedPresencePackets = 0;
+ private int sentOtherPackets = 0;
+ private int receivedOtherPackets = 0;
+
+ JTabbedPane tabbedPane;
+
+ public EnhancedDebugger(XMPPConnection connection, Writer writer, Reader reader) {
+ this.connection = connection;
+ this.writer = writer;
+ this.reader = reader;
+ createDebug();
+ EnhancedDebuggerWindow.addDebugger(this);
+ }
+
+ /**
+ * Creates the debug process, which is a GUI window that displays XML traffic.
+ */
+ private void createDebug() {
+ // Use the native look and feel.
+ try {
+ UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
+ }
+ catch (Exception e) {
+ e.printStackTrace();
+ }
+
+ // We'll arrange the UI into six tabs. The first tab contains all data, the second
+ // client generated XML, the third server generated XML, the fourth allows to send
+ // ad-hoc messages and the fifth contains connection information.
+ tabbedPane = new JTabbedPane();
+
+ // Add the All Packets, Sent, Received and Interpreted panels
+ addBasicPanels();
+
+ // Add the panel to send ad-hoc messages
+ addAdhocPacketPanel();
+
+ // Add the connection information panel
+ addInformationPanel();
+
+ // Create a thread that will listen for all incoming packets and write them to
+ // the GUI. This is what we call "interpreted" packet data, since it's the packet
+ // data as Smack sees it and not as it's coming in as raw XML.
+ listener = new PacketListener() {
+ SimpleDateFormat dateFormatter = new SimpleDateFormat("hh:mm:ss aaa");
+ public void processPacket(Packet packet) {
+ addReadPacketToTable(dateFormatter, packet);
+ }
+ };
+
+ // Create a thread that will listen for all outgoing packets and write them to
+ // the GUI.
+ writerListener = new PacketWriterListener() {
+ SimpleDateFormat dateFormatter = new SimpleDateFormat("hh:mm:ss aaa");
+ public void processPacket(Packet packet) {
+ addSentPacketToTable(dateFormatter, packet);
+ }
+ };
+
+ // Create a thread that will listen for any connection closed event
+ connListener = new ConnectionListener() {
+ public void connectionClosed() {
+ statusField.setValue("Closed");
+ }
+
+ public void connectionClosedOnError(Exception e) {
+ statusField.setValue("Closed due to an exception");
+ EnhancedDebuggerWindow.connectionClosedOnError(EnhancedDebugger.this, e);
+ }
+ };
+ }
+
+ private void addBasicPanels() {
+ JPanel allPane = new JPanel();
+ allPane.setLayout(new GridLayout(2, 1));
+ tabbedPane.add("All Packets", allPane);
+ tabbedPane.setToolTipTextAt(0, "Sent and received packets processed by Smack");
+
+ messagesTable = new DefaultTableModel(new Object[] { "Hide", "Timestamp", "Message", "Type", "To", "From" }, 0) {
+ public boolean isCellEditable(int rowIndex, int mColIndex) {
+ return false;
+ }
+ };
+ JTable table = new JTable(messagesTable);
+ // Allow only single a selection
+ table.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
+ // Hide the first column
+ table.getColumnModel().getColumn(0).setMaxWidth(0);
+ table.getColumnModel().getColumn(0).setMinWidth(0);
+ table.getTableHeader().getColumnModel().getColumn(0).setMaxWidth(0);
+ table.getTableHeader().getColumnModel().getColumn(0).setMinWidth(0);
+ // Set the column "timestamp" size
+ table.getColumnModel().getColumn(1).setMaxWidth(300);
+ table.getColumnModel().getColumn(1).setPreferredWidth(70);
+ // Set the column "type" size
+ table.getColumnModel().getColumn(3).setMaxWidth(200);
+ table.getColumnModel().getColumn(3).setPreferredWidth(50);
+ // Set the column "to" size
+ table.getColumnModel().getColumn(4).setMaxWidth(300);
+ table.getColumnModel().getColumn(4).setPreferredWidth(90);
+ // Set the column "from" size
+ table.getColumnModel().getColumn(5).setMaxWidth(300);
+ table.getColumnModel().getColumn(5).setPreferredWidth(90);
+ // Create a table listener that listen for row selection events
+ SelectionListener selectionListener = new SelectionListener(table);
+ table.getSelectionModel().addListSelectionListener(selectionListener);
+ table.getColumnModel().getSelectionModel().addListSelectionListener(selectionListener);
+ allPane.add(new JScrollPane(table));
+ messageTextArea = new JTextArea();
+ messageTextArea.setEditable(false);
+ // Add pop-up menu.
+ JPopupMenu menu = new JPopupMenu();
+ JMenuItem menuItem1 = new JMenuItem("Copy");
+ menuItem1.addActionListener(new ActionListener() {
+ public void actionPerformed(ActionEvent e) {
+ // Get the clipboard
+ Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
+ // Set the sent text as the new content of the clipboard
+ clipboard.setContents(new StringSelection(messageTextArea.getText()), null);
+ }
+ });
+ menu.add(menuItem1);
+ // Add listener to the text area so the popup menu can come up.
+ messageTextArea.addMouseListener(new PopupListener(menu));
+ allPane.add(new JScrollPane(messageTextArea));
+
+ // Create UI elements for client generated XML traffic.
+ final JTextArea sentText = new JTextArea();
+ sentText.setEditable(false);
+ sentText.setForeground(new Color(112, 3, 3));
+ tabbedPane.add("Raw Sent Packets", new JScrollPane(sentText));
+ tabbedPane.setToolTipTextAt(1, "Raw text of the sent packets");
+
+ // Add pop-up menu.
+ menu = new JPopupMenu();
+ menuItem1 = new JMenuItem("Copy");
+ menuItem1.addActionListener(new ActionListener() {
+ public void actionPerformed(ActionEvent e) {
+ // Get the clipboard
+ Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
+ // Set the sent text as the new content of the clipboard
+ clipboard.setContents(new StringSelection(sentText.getText()), null);
+ }
+ });
+
+ JMenuItem menuItem2 = new JMenuItem("Clear");
+ menuItem2.addActionListener(new ActionListener() {
+ public void actionPerformed(ActionEvent e) {
+ sentText.setText("");
+ }
+ });
+
+ // Add listener to the text area so the popup menu can come up.
+ sentText.addMouseListener(new PopupListener(menu));
+ menu.add(menuItem1);
+ menu.add(menuItem2);
+
+ // Create UI elements for server generated XML traffic.
+ final JTextArea receivedText = new JTextArea();
+ receivedText.setEditable(false);
+ receivedText.setForeground(new Color(6, 76, 133));
+ tabbedPane.add("Raw Received Packets", new JScrollPane(receivedText));
+ tabbedPane.setToolTipTextAt(
+ 2,
+ "Raw text of the received packets before Smack process them");
+
+ // Add pop-up menu.
+ menu = new JPopupMenu();
+ menuItem1 = new JMenuItem("Copy");
+ menuItem1.addActionListener(new ActionListener() {
+ public void actionPerformed(ActionEvent e) {
+ // Get the clipboard
+ Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
+ // Set the sent text as the new content of the clipboard
+ clipboard.setContents(new StringSelection(receivedText.getText()), null);
+ }
+ });
+
+ menuItem2 = new JMenuItem("Clear");
+ menuItem2.addActionListener(new ActionListener() {
+ public void actionPerformed(ActionEvent e) {
+ receivedText.setText("");
+ }
+ });
+
+ // Add listener to the text area so the popup menu can come up.
+ receivedText.addMouseListener(new PopupListener(menu));
+ menu.add(menuItem1);
+ menu.add(menuItem2);
+
+ // Create a special Reader that wraps the main Reader and logs data to the GUI.
+ Reader debugReader = new Reader() {
+
+ Reader myReader = reader;
+
+ public int read(char cbuf[], int off, int len) throws IOException {
+ int count = myReader.read(cbuf, off, len);
+ if (count > 0) {
+ String str = new String(cbuf, off, count);
+ int index = str.lastIndexOf(">");
+ if (index != -1) {
+ receivedText.append(str.substring(0, index + 1));
+ receivedText.append(NEWLINE);
+ if (str.length() > index) {
+ receivedText.append(str.substring(index + 1));
+ }
+ }
+ else {
+ receivedText.append(str);
+ }
+ }
+ return count;
+ }
+
+ public void close() throws IOException {
+ myReader.close();
+ }
+
+ public int read() throws IOException {
+ return myReader.read();
+ }
+
+ public int read(char cbuf[]) throws IOException {
+ return myReader.read(cbuf);
+ }
+
+ public long skip(long n) throws IOException {
+ return myReader.skip(n);
+ }
+
+ public boolean ready() throws IOException {
+ return myReader.ready();
+ }
+
+ public boolean markSupported() {
+ return myReader.markSupported();
+ }
+
+ public void mark(int readAheadLimit) throws IOException {
+ myReader.mark(readAheadLimit);
+ }
+
+ public void reset() throws IOException {
+ myReader.reset();
+ }
+ };
+
+ // Create a special Writer that wraps the main Writer and logs data to the GUI.
+ Writer debugWriter = new Writer() {
+
+ Writer myWriter = writer;
+
+ public void write(char cbuf[], int off, int len) throws IOException {
+ myWriter.write(cbuf, off, len);
+ String str = new String(cbuf, off, len);
+ sentText.append(str);
+ if (str.endsWith(">")) {
+ sentText.append(NEWLINE);
+ }
+ }
+
+ public void flush() throws IOException {
+ myWriter.flush();
+ }
+
+ public void close() throws IOException {
+ myWriter.close();
+ }
+
+ public void write(int c) throws IOException {
+ myWriter.write(c);
+ }
+
+ public void write(char cbuf[]) throws IOException {
+ myWriter.write(cbuf);
+ String str = new String(cbuf);
+ sentText.append(str);
+ if (str.endsWith(">")) {
+ sentText.append(NEWLINE);
+ }
+ }
+
+ public void write(String str) throws IOException {
+ myWriter.write(str);
+ sentText.append(str);
+ if (str.endsWith(">")) {
+ sentText.append(NEWLINE);
+ }
+ }
+
+ public void write(String str, int off, int len) throws IOException {
+ myWriter.write(str, off, len);
+ str = str.substring(off, off + len);
+ sentText.append(str);
+ if (str.endsWith(">")) {
+ sentText.append(NEWLINE);
+ }
+ }
+ };
+
+ // Assign the reader/writer objects to use the debug versions. The packet reader
+ // and writer will use the debug versions when they are created.
+ reader = debugReader;
+ writer = debugWriter;
+
+ }
+
+ private void addAdhocPacketPanel() {
+ // Create UI elements for sending ad-hoc messages.
+ final JTextArea adhocMessages = new JTextArea();
+ adhocMessages.setEditable(true);
+ adhocMessages.setForeground(new Color(1, 94, 35));
+ tabbedPane.add("Ad-hoc message", new JScrollPane(adhocMessages));
+ tabbedPane.setToolTipTextAt(3, "Panel that allows you to send adhoc packets");
+
+ // Add pop-up menu.
+ JPopupMenu menu = new JPopupMenu();
+ JMenuItem menuItem = new JMenuItem("Message");
+ menuItem.addActionListener(new ActionListener() {
+ public void actionPerformed(ActionEvent e) {
+ adhocMessages.setText(
+ "
+ * + * The whole text to send must be passed to the constructor. This implies that the client of + * this class is responsible for sending a valid text to the constructor. + * + */ + private class AdHocPacket extends Packet { + + private String text; + + /** + * Create a new AdHocPacket with the text to send. The passed text must be a valid text to + * send to the server, no validation will be done on the passed text. + * + * @param text the whole text of the packet to send + */ + public AdHocPacket(String text) { + this.text = text; + } + + public String toXML() { + return text; + } + + } + + /** + * Listens for debug window popup dialog events. + */ + private class PopupListener extends MouseAdapter { + JPopupMenu popup; + + PopupListener(JPopupMenu popupMenu) { + popup = popupMenu; + } + + public void mousePressed(MouseEvent e) { + maybeShowPopup(e); + } + + public void mouseReleased(MouseEvent e) { + maybeShowPopup(e); + } + + private void maybeShowPopup(MouseEvent e) { + if (e.isPopupTrigger()) { + popup.show(e.getComponent(), e.getX(), e.getY()); + } + } + } + + private class SelectionListener implements ListSelectionListener { + JTable table; + + // It is necessary to keep the table since it is not possible + // to determine the table from the event's source + SelectionListener(JTable table) { + this.table = table; + } + public void valueChanged(ListSelectionEvent e) { + if (table.getSelectedRow() == -1) { + // Clear the messageTextArea since there is none packet selected + messageTextArea.setText(null); + } + else { + // Set the detail of the packet in the messageTextArea + messageTextArea.setText( + (String) table.getModel().getValueAt(table.getSelectedRow(), 0)); + } + } + } +} diff --git a/source/org/jivesoftware/smackx/debugger/EnhancedDebuggerWindow.java b/source/org/jivesoftware/smackx/debugger/EnhancedDebuggerWindow.java new file mode 100644 index 000000000..369a544ce --- /dev/null +++ b/source/org/jivesoftware/smackx/debugger/EnhancedDebuggerWindow.java @@ -0,0 +1,249 @@ +/** +* $RCSfile$ +* $Revision$ +* $Date$ +* +* Copyright (C) 2002-2003 Jive Software. All rights reserved. +* ==================================================================== +* The Jive Software License (based on Apache Software License, Version 1.1) +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions +* are met: +* +* 1. Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* +* 2. Redistributions in binary form must reproduce the above copyright +* notice, this list of conditions and the following disclaimer in +* the documentation and/or other materials provided with the +* distribution. +* +* 3. The end-user documentation included with the redistribution, +* if any, must include the following acknowledgment: +* "This product includes software developed by +* Jive Software (http://www.jivesoftware.com)." +* Alternately, this acknowledgment may appear in the software itself, +* if and wherever such third-party acknowledgments normally appear. +* +* 4. The names "Smack" and "Jive Software" must not be used to +* endorse or promote products derived from this software without +* prior written permission. For written permission, please +* contact webmaster@jivesoftware.com. +* +* 5. Products derived from this software may not be called "Smack", +* nor may "Smack" appear in their name, without prior written +* permission of Jive Software. +* +* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED +* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR +* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +* SUCH DAMAGE. +* ==================================================================== +*/ + +package org.jivesoftware.smackx.debugger; + +import java.awt.*; +import java.awt.event.*; +import java.util.*; + +import javax.swing.*; + +import org.jivesoftware.smack.provider.ProviderManager; + +/** + * The EnhancedDebuggerWindow is the main debug window that will show all the EnhancedDebuggers. + * For each connection to debug there will be an EnhancedDebugger that will be shown in the + * EnhancedDebuggerWindow.
+ * + * This class also provides information about Smack like for example the Smack version and the + * installed providers. + * + * @author Gaston Dombiak + */ +class EnhancedDebuggerWindow { + + private static EnhancedDebuggerWindow instance; + + private JFrame frame = null; + private JTabbedPane tabbedPane = null; + + private EnhancedDebuggerWindow() { + } + + /** + * Returns the unique EnhancedDebuggerWindow instance available in the system. + * + * @return the unique EnhancedDebuggerWindow instance + */ + private static EnhancedDebuggerWindow getInstance() { + if (instance == null) { + instance = new EnhancedDebuggerWindow(); + } + return instance; + } + + /** + * Adds the new specified debugger to the list of debuggers to show in the main window. + * + * @param debugger the new debugger to show in the debug window + */ + synchronized static void addDebugger(EnhancedDebugger debugger) { + getInstance().showNewDebugger(debugger); + } + + /** + * Shows the new debugger in the debug window. + * + * @param debugger the new debugger to show + */ + private void showNewDebugger(EnhancedDebugger debugger) { + if (frame == null) { + createDebug(); + } + debugger.tabbedPane.setName("Connection_" + tabbedPane.getComponentCount()); + tabbedPane.add(debugger.tabbedPane, tabbedPane.getComponentCount() - 1); + frame.setTitle( + "Smack Debug Window -- Total connections: " + (tabbedPane.getComponentCount() - 1)); + } + + /** + * Notification that a user has logged in to the server. A new title will be set + * to the tab of the given debugger. + * + * @param debugger the debugger whose connection logged in to the server + * @param user the user@host/resource that has just logged in + */ + synchronized static void userHasLogged(EnhancedDebugger debugger, String user) { + getInstance().tabbedPane.setTitleAt( + getInstance().tabbedPane.indexOfComponent(debugger.tabbedPane), + user); + } + + /** + * Notification that the connection was closed due to an exception. + * + * @param debugger the debugger whose connection was closed due to an exception. + * @param e the exception. + */ + synchronized static void connectionClosedOnError(EnhancedDebugger debugger, Exception e) { + int index = getInstance().tabbedPane.indexOfComponent(debugger.tabbedPane); + String label = getInstance().tabbedPane.getTitleAt(index); + getInstance().tabbedPane.setTitleAt(index, "(!)" + label); + getInstance().tabbedPane.setToolTipTextAt( + index, + "Connection closed due to the exception: " + e.getMessage()); + } + + /** + * Creates the main debug window that provides information about Smack and also shows + * a tab panel for each connection that is being debugged. + */ + private void createDebug() { + + frame = new JFrame("Smack Debug Window"); + + // We'll arrange the UI into tabs. The last tab contains Smack's information. + // All the connection debugger tabs will be shown before the Smack info tab. + tabbedPane = new JTabbedPane(); + + // Create the Smack info panel + JPanel informationPanel = new JPanel(); + informationPanel.setLayout(new BoxLayout(informationPanel, BoxLayout.Y_AXIS)); + + // Add the Smack version label + JPanel versionPanel = new JPanel(); + versionPanel.setLayout(new BoxLayout(versionPanel, BoxLayout.X_AXIS)); + versionPanel.setMaximumSize(new Dimension(2000, 31)); + versionPanel.add(new JLabel(" Smack version: ")); + // TODO Replace the Smack version with the real one + JFormattedTextField field = new JFormattedTextField("1.3.0"); + field.setEditable(false); + field.setBorder(null); + versionPanel.add(field); + informationPanel.add(versionPanel); + //informationPanel.add(Box.createVerticalGlue()); + + // Add the list of installed IQ Providers + Vector providers = new Vector(); + for (Iterator it = ProviderManager.getIQProviders(); it.hasNext();) { + Object provider = it.next(); + providers.add( + (provider.getClass() == Class.class ? provider : provider.getClass().getName())); + } + JList list = new JList(providers); + list.setBorder(BorderFactory.createTitledBorder("Installed IQ Providers")); + informationPanel.add(new JScrollPane(list)); + + // Add the list of installed Extension Providers + providers = new Vector(); + for (Iterator it = ProviderManager.getExtensionProviders(); it.hasNext();) { + Object provider = it.next(); + providers.add( + (provider.getClass() == Class.class ? provider : provider.getClass().getName())); + } + list = new JList(providers); + list.setBorder(BorderFactory.createTitledBorder("Installed Extension Providers")); + informationPanel.add(new JScrollPane(list)); + + tabbedPane.add("Smack Info", informationPanel); + + // Add pop-up menu. + JPopupMenu menu = new JPopupMenu(); + JMenuItem menuItem = new JMenuItem("Close"); + menuItem.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent e) { + // Remove the selected tab pane if it's not the Smack info pane + if (tabbedPane.getSelectedIndex() < tabbedPane.getComponentCount() - 1) { + tabbedPane.remove(tabbedPane.getSelectedComponent()); + frame.setTitle( + "Smack Debug Window -- Total connections: " + + (tabbedPane.getComponentCount() - 1)); + } + } + }); + menu.add(menuItem); + // Add listener to the text area so the popup menu can come up. + tabbedPane.addMouseListener(new PopupListener(menu)); + + frame.getContentPane().add(tabbedPane); + + frame.setSize(650, 400); + frame.setVisible(true); + + } + + /** + * Listens for debug window popup dialog events. + */ + private class PopupListener extends MouseAdapter { + JPopupMenu popup; + + PopupListener(JPopupMenu popupMenu) { + popup = popupMenu; + } + + public void mousePressed(MouseEvent e) { + maybeShowPopup(e); + } + + public void mouseReleased(MouseEvent e) { + maybeShowPopup(e); + } + + private void maybeShowPopup(MouseEvent e) { + if (e.isPopupTrigger()) { + popup.show(e.getComponent(), e.getX(), e.getY()); + } + } + } +}