psmith 2003/09/03 19:30:28
Modified: src/java/org/apache/log4j/chainsaw LogUI.java
Added: src/java/org/apache/log4j/chainsaw/layout
DefaultDetailLayout.html EventDetailLayout.java
Removed: src/java/org/apache/log4j/chainsaw EventDetailLayout.java
Log:
Moved EventDetailLayout into a subpackage, chainsaw package is getting a bit big.
Changed EventDetailLayout to delegate most of the work
to a PatternLayout instance. EventDetailLayout merely ensures HTML
characters are escaped properly. This requires copying
the event being displayed first, escaping, then delegating
to the Pattern Layout.
The default Conversion Pattern used by the internal Pattern
layout is now loaded from a HTML file contained with the Jar.
Also added mini-toolbar to Event detail pane with Edit icon
for the soon to be added Pattern Layout Dialog editor.
Revision Changes Path
1.18 +55 -23 jakarta-log4j/src/java/org/apache/log4j/chainsaw/LogUI.java
Index: LogUI.java
===================================================================
RCS file: /home/cvs/jakarta-log4j/src/java/org/apache/log4j/chainsaw/LogUI.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- LogUI.java 3 Sep 2003 07:37:19 -0000 1.17
+++ LogUI.java 4 Sep 2003 02:30:28 -0000 1.18
@@ -49,13 +49,13 @@
package org.apache.log4j.chainsaw;
-import org.apache.log4j.HTMLLayout;
import org.apache.log4j.Layout;
import org.apache.log4j.Level;
import org.apache.log4j.LogManager;
import org.apache.log4j.Priority;
import org.apache.log4j.UtilLoggingLevel;
import org.apache.log4j.chainsaw.icons.ChainsawIcons;
+import org.apache.log4j.chainsaw.layout.EventDetailLayout;
import org.apache.log4j.chainsaw.prefs.LoadSettingsEvent;
import org.apache.log4j.chainsaw.prefs.SaveSettingsEvent;
import org.apache.log4j.chainsaw.prefs.SettingsListener;
@@ -106,6 +106,7 @@
import java.io.Serializable;
import java.lang.reflect.Method;
+
import java.net.URL;
import java.text.NumberFormat;
@@ -124,6 +125,7 @@
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.BorderFactory;
+import javax.swing.Box;
import javax.swing.ButtonGroup;
import javax.swing.ImageIcon;
import javax.swing.JCheckBox;
@@ -313,13 +315,13 @@
* @param args
*/
public static void main(String[] args) {
-
-// TODO remove this when ready
+ // TODO remove this when ready
JOptionPane.showMessageDialog(
null,
- "Chainsaw v2 is currently going through some refactoring work at
present.\n\n" +
- "Some features, most notably filtering and colouring, may be inoperable at
this time.\n\n" +
- "The Log4J Dev team apologises for this inconvenience, but be assured this
functionality will be back very shortly.", "Apologise", JOptionPane.WARNING_MESSAGE);
+ "Chainsaw v2 is currently going through some refactoring work at present.\n\n"
+ + "Some features, most notably filtering and colouring, may be inoperable at
this time.\n\n"
+ + "The Log4J Dev team apologises for this inconvenience, but be assured this
functionality will be back very shortly.",
+ "Apologise", JOptionPane.WARNING_MESSAGE);
showSplash();
@@ -690,23 +692,29 @@
toggleReceiversPanel();
} else if (noReceiversWarningPanel.getModel().isSimpleReceiverMode()) {
int port = noReceiversWarningPanel.getModel().getSimplePort();
- Class receiverClass =
noReceiversWarningPanel.getModel().getSimpleReceiverClass();
+ Class receiverClass =
+ noReceiversWarningPanel.getModel().getSimpleReceiverClass();
+
try {
- Receiver simpleReceiver =
- (Receiver) receiverClass.newInstance();
- simpleReceiver.setName("Simple Receiver");
- Method portMethod = simpleReceiver.getClass().getMethod("setPort",
new Class[] {int.class});
- portMethod.invoke(simpleReceiver, new Object[] {new Integer(port)});
-
- PluginRegistry.startPlugin(simpleReceiver);
- receiversPanel.updateReceiverTreeInDispatchThread();
- getStatusBar().setMessage(
- "Simple Receiver created, started, and
listening on port "
- + port + " (using " +
receiverClass.getName() + ")");
- } catch (Exception e) {
- LogLog.error("Error creating Receiver", e);
- getStatusBar().setMessage("An error occurred creating your
Receiver");
- }
+ Receiver simpleReceiver = (Receiver) receiverClass.newInstance();
+ simpleReceiver.setName("Simple Receiver");
+
+ Method portMethod =
+ simpleReceiver.getClass().getMethod(
+ "setPort", new Class[] { int.class });
+ portMethod.invoke(
+ simpleReceiver, new Object[] { new Integer(port) });
+
+ PluginRegistry.startPlugin(simpleReceiver);
+ receiversPanel.updateReceiverTreeInDispatchThread();
+ getStatusBar().setMessage(
+ "Simple Receiver created, started, and listening on port "
+ + port + " (using " + receiverClass.getName() + ")");
+ } catch (Exception e) {
+ LogLog.error("Error creating Receiver", e);
+ getStatusBar().setMessage(
+ "An error occurred creating your Receiver");
+ }
} else if (noReceiversWarningPanel.getModel().isLoadConfig()) {
final URL url =
noReceiversWarningPanel.getModel().getConfigToLoad();
@@ -1570,10 +1578,34 @@
});
final JScrollPane detailPane = new JScrollPane(detail);
+
detailPane.setPreferredSize(new Dimension(900, 50));
detailPanel.add(detailPane, BorderLayout.CENTER);
+ final JToolBar detailToolbar = new JToolBar(JToolBar.HORIZONTAL);
+ detailToolbar.setFloatable(false);
+
+ Action editDetailAction =
+ new AbstractAction(
+ "Edit...", new ImageIcon(ChainsawIcons.ICON_EDIT_RECEIVER)) {
+ public void actionPerformed(ActionEvent e) {
+ // TODO Auto-generated method stub
+ }
+ };
+
+ editDetailAction.putValue(
+ Action.SHORT_DESCRIPTION,
+ "opens a Dialog window to Edit the Pattern Layout text");
+
+ final SmallButton editDetailButton = new SmallButton(editDetailAction);
+ editDetailButton.setText(null);
+ detailToolbar.add(Box.createHorizontalGlue());
+ detailToolbar.add(editDetailButton);
+
+ // detailToolbar.add(Box.createHorizontalStrut(5));
+ detailPanel.add(detailToolbar, BorderLayout.NORTH);
+
lowerPanel =
new JSplitPane(
JSplitPane.VERTICAL_SPLIT, eventsAndStatusPanel, detailPanel);
@@ -1866,8 +1898,8 @@
eventsPane.addMouseListener(popupListener);
table.addMouseListener(popupListener);
- detail.addMouseListener(popupListener);
+ // detail.addMouseListener(popupListener);
tableMap.put(ident, table);
tableModelMap.put(ident, tableModel);
tabbedPane.add(ident, this);
1.1
jakarta-log4j/src/java/org/apache/log4j/chainsaw/layout/DefaultDetailLayout.html
Index: DefaultDetailLayout.html
===================================================================
<html><body><table cellspacing=0 cellpadding=0>
<TR><TD><B>Level</B></TD><TD>%p</td></tr>
<TR><TD><B>Logger</B><TD>%c</td></tr>
<TR><TD><B>TIme</B><TD>%d</td></tr>
<TR><TD><B>Thread</B><TD>%t</td></tr>
<TR><TD><B>Message</B><TD>%m</td></tr>
<TR><TD><B>Location</B><TD>%l</td></tr>
<TR><TD><B>NDC</B><TD>%x</td></tr>
<TR><TD><B>MDC</B><TD>%X</td></tr>
<TR><TD><B>Class</B><TD>%C</td></tr>
<TR><TD><B>Method</B><TD>%M</td></tr>
<TR><TD><B>Line</B><TD>%L</td></tr>
<TR><TD><B>File</B><TD>%F</td></tr>
<TR><TD><B>Properties</B><TD><em>Properties support is missing from PatternLayout at
this time, stay tuned.</em></td></tr>
<TR><TD><B>Throwable</B><TD><em>Throwable Information support is missing from
PatternLayout at this time, stay tuned</em></td></tr>
</table></body></html>
1.1
jakarta-log4j/src/java/org/apache/log4j/chainsaw/layout/EventDetailLayout.java
Index: EventDetailLayout.java
===================================================================
/*
* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
*
* Copyright (C) 1999 The Apache Software Foundation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modifica-
* tion, 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 the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
*
* 4. The names "log4j" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
*
* 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 THE
* APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
* DING, 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.
*
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation. For more information on the
* Apache Software Foundation, please see <http://www.apache.org/>.
*
*/
package org.apache.log4j.chainsaw.layout;
import org.apache.log4j.Layout;
import org.apache.log4j.Logger;
import org.apache.log4j.PatternLayout;
import org.apache.log4j.helpers.LogLog;
import org.apache.log4j.spi.LocationInfo;
import org.apache.log4j.spi.LoggingEvent;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Writer;
import java.net.URL;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.Set;
import javax.swing.text.html.HTMLEditorKit;
/**
* This layout is used for formatting HTML text for use inside
* the Chainsaw Event Detail Panel, and the tooltip used
* when mouse-over on a particular log event row
*
* @author Paul Smith <[EMAIL PROTECTED]>
*/
public class EventDetailLayout extends Layout {
private PatternLayout patternLayout =
new PatternLayout(PatternLayout.TTCC_CONVERSION_PATTERN);
public EventDetailLayout() {
URL defaultLayoutURL =
this.getClass().getClassLoader().getResource(
"org/apache/log4j/chainsaw/layout/DefaultDetailLayout.html");
if (defaultLayoutURL == null) {
LogLog.warn(
"Could not locate the default Layout for Event Details and Tooltips");
} else {
HTMLEditorKit kit = new HTMLEditorKit();
try {
StringBuffer content = new StringBuffer();
BufferedReader reader = null;
try {
reader =
new BufferedReader(
new InputStreamReader(defaultLayoutURL.openStream()));
String line = "";
while ((line = reader.readLine()) != null) {
content.append(line);
}
} finally {
if (reader != null) {
reader.close();
}
}
if (content != null) {
LogLog.debug("Loaded layout content:\n" + content);
patternLayout.setConversionPattern(content.toString());
} else {
LogLog.warn("No Layout content retrieved, using default");
}
} catch (Exception e) {
LogLog.error("Failed to read in the Layout", e);
}
}
}
public void setConverionPatter(String conversionPatter) {
patternLayout.setConversionPattern(conversionPatter);
}
public String getConversionPattern() {
return patternLayout.getConversionPattern();
}
/* (non-Javadoc)
* @see org.apache.log4j.Layout#getFooter()
*/
public String getFooter() {
return "";
}
/* (non-Javadoc)
* @see org.apache.log4j.Layout#getHeader()
*/
public String getHeader() {
return "";
}
// /* (non-Javadoc)
// * @see org.apache.log4j.Layout#format(java.io.Writer,
org.apache.log4j.spi.LoggingEvent)
// */
// public void format(Writer output, LoggingEvent event)
// throws IOException {
// boolean pastFirst = false;
// output.write("<html><body><table cellspacing=0 cellpadding=0>");
//
// List columnNames = ChainsawColumns.getColumnsNames();
//
// Vector v = ChainsawAppenderHandler.convert(event);
//
// /**
// * we need to add the ID property from the event
// */
// v.add(event.getProperty(ChainsawConstants.LOG4J_ID_KEY));
//
// // ListIterator iter =
displayFilter.getDetailColumns().listIterator();
// Iterator iter = columnNames.iterator();
// String column = null;
// int index = -1;
//
// while (iter.hasNext()) {
// column = (String) iter.next();
// index = columnNames.indexOf(column);
//
// if (index > -1) {
// if (pastFirst) {
// output.write("</td></tr>");
// }
//
// output.write("<tr><td valign=\"top\"><b>");
// output.write(column);
// output.write(": </b></td><td>");
//
//
// if (index<v.size()) {
// Object o = v.get(index);
//
// if (o != null) {
// output.write(escape(o.toString()));
// } else {
// output.write("{null}");
// }
//
// }else {
//// output.write("Invalid column " + column + " (index=" + index +
")");
// }
//
// pastFirst = true;
// }
// }
//
// output.write("</table></body></html>");
// }
/**
* Escape <, > & and " as their entities. It is very
* dumb about & handling.
* @param aStr the String to escape.
* @return the escaped String
*/
private static String escape(String string) {
if (string == null) {
return "";
}
final StringBuffer buf = new StringBuffer();
for (int i = 0; i < string.length(); i++) {
char c = string.charAt(i);
switch (c) {
case '<':
buf.append("<");
break;
case '>':
buf.append(">");
break;
case '\"':
buf.append(""");
break;
case '&':
buf.append("&");
break;
default:
buf.append(c);
break;
}
}
return buf.toString();
}
/**
* Takes a source event and copies it into a new LoggingEvent object
* and ensuring all the internal elements of the event are HTML safe
* @param event
* @return new LoggingEvent
*/
private static LoggingEvent copyForHTML(LoggingEvent event) {
String fqnCategory = escape(event.fqnOfCategoryClass);
Logger logger = Logger.getLogger(event.getLoggerName());
String threadName = event.getThreadName();
Object msg = event.getMessage();
String ndc = event.getNDC();
Hashtable mdc = formatMDC(event);
String[] throwableStringRep = event.getThrowableStrRep();
LocationInfo li = formatLocationInfo(event);
Hashtable properties = formatProperties(event);
LoggingEvent copy =
new LoggingEvent(
fqnCategory, logger, event.timeStamp, event.getLevel(), threadName, msg,
ndc, mdc, throwableStringRep, li, properties);
return copy;
}
/**
* @param event
* @return
*/
private static Hashtable formatMDC(LoggingEvent event) {
Set keySet = event.getMDCKeySet();
Hashtable hashTable = new Hashtable();
for (Iterator iter = keySet.iterator(); iter.hasNext();) {
Object key = (Object) iter.next();
Object value = event.getMDC(key.toString());
hashTable.put(escape(key.toString()), escape(value.toString()));
}
return hashTable;
}
/**
* @param event
* @return
*/
private static LocationInfo formatLocationInfo(LoggingEvent event) {
LocationInfo info = event.getLocationInformation();
LocationInfo newInfo =
new LocationInfo(
escape(info.getFileName()), escape(info.getClassName()),
escape(info.getMethodName()), escape(info.getLineNumber()));
return newInfo;
}
/**
* @param event
* @return
*/
private static Hashtable formatProperties(LoggingEvent event) {
Set keySet = event.getPropertyKeySet();
Hashtable hashTable = new Hashtable();
for (Iterator iter = keySet.iterator(); iter.hasNext();) {
Object key = (Object) iter.next();
Object value = event.getProperty(key.toString());
hashTable.put(escape(key.toString()), escape(value.toString()));
}
return hashTable;
}
/* (non-Javadoc)
* @see org.apache.log4j.Layout#ignoresThrowable()
*/
public boolean ignoresThrowable() {
return false;
}
/* (non-Javadoc)
* @see org.apache.log4j.spi.OptionHandler#activateOptions()
*/
public void activateOptions() {
}
/* (non-Javadoc)
* @see org.apache.log4j.Layout#format(java.io.Writer,
org.apache.log4j.spi.LoggingEvent)
*/
public void format(Writer output, LoggingEvent event)
throws IOException {
patternLayout.format(output, copyForHTML(event));
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
