/*******************************************************************************
* Copyright (c) 2003, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - Initial API and implementation
*******************************************************************************/
package org.eclipse.wst.internet.monitor.ui.internal;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.util.*;
import java.util.zip.GZIPInputStream;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.osgi.service.debug.DebugOptions;
import org.eclipse.osgi.service.debug.DebugOptionsListener;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.eclipse.wst.internet.monitor.core.internal.provisional.*;
import org.eclipse.wst.internet.monitor.ui.internal.view.MonitorView;
import org.osgi.framework.BundleContext;
/**
* The TCP/IP monitor UI plugin.
*/
public class MonitorUIPlugin extends AbstractUIPlugin {
public static final String PLUGIN_ID = "org.eclipse.wst.internet.monitor.ui";
private static final byte[] BUFFER = new byte[4096];
private static MonitorUIPlugin singleton;
protected Map<String, ImageDescriptor> imageDescriptors = new HashMap<String, ImageDescriptor>();
private static final String lineSeparator = System.getProperty("line.separator");
private static URL ICON_BASE_URL;
private static final String URL_CLCL = "clcl16/";
private static final String URL_ELCL = "elcl16/";
private static final String URL_DLCL = "dlcl16/";
private static final String URL_OBJ = "obj16/";
public static final String IMG_ELCL_SORT_RESPONSE_TIME = "IMG_ELCL_SORT_RESPONSE_TIME";
public static final String IMG_ELCL_CLEAR = "IMG_ELCL_CLEAR";
public static final String IMG_ELCL_HTTP_HEADER = "IMG_ELCL_HTTP_HEADER";
public static final String IMG_ELCL_PIN = "IMG_ELCL_PIN";
public static final String IMG_CLCL_SORT_RESPONSE_TIME = "IMG_CLCL_SORT_RESPONSE_TIME";
public static final String IMG_CLCL_CLEAR = "IMG_CLCL_CLEAR";
public static final String IMG_CLCL_HTTP_HEADER = "IMG_CLCL_HTTP_HEADER";
public static final String IMG_CLCL_PIN = "IMG_CLCL_PIN";
public static final String IMG_DLCL_SORT_RESPONSE_TIME = "IMG_DLCL_SORT_RESPONSE_TIME";
public static final String IMG_DLCL_CLEAR = "IMG_DLCL_CLEAR";
public static final String IMG_DLCL_HTTP_HEADER = "IMG_DLCL_HTTP_HEADER";
public static final String IMG_DLCL_PIN = "IMG_DLCL_PIN";
public static final String IMG_REQUEST_RESPONSE = "requestResponse";
public static final String IMG_RESEND_REQUEST_RESPONSE = "resendRequestResponse";
public static final String IMG_HOST = "host";
public static final String IMG_MONITOR_ON = "monitorOn";
public static final String IMG_MONITOR_OFF = "monitorOff";
private static final String SHOW_VIEW_ON_ACTIVITY = "show-view";
private static final String PIN_VIEW = "pin-view";
private static final String SHOW_HEADER = "show-header";
protected List<Request> requests = new ArrayList<Request>();
protected IMonitorListener monitorListener = new IMonitorListener() {
public void monitorAdded(IMonitor monitor) {
monitor.addRequestListener(requestListener);
}
public void monitorChanged(IMonitor monitor) {
// ignore
}
public void monitorRemoved(IMonitor monitor) {
monitor.removeRequestListener(requestListener);
}
};
protected IRequestListener requestListener = new IRequestListener() {
public void requestAdded(IMonitor monitor, Request request) {
addRequest(request);
if (MonitorView.view != null)
MonitorView.view.doRequestAdded(request);
else if (MonitorUIPlugin.getShowOnActivityPreference())
MonitorView.open(request);
}
public void requestChanged(IMonitor monitor, Request request) {
if (MonitorView.view != null)
MonitorView.view.doRequestChanged(request);
}
};
/**
* MonitorUIPlugin constructor comment.
*/
public MonitorUIPlugin() {
super();
singleton = this;
}
/**
* Creates and pre-loads the image registry.
*
* @return ImageRegistry
*/
protected ImageRegistry createImageRegistry() {
ImageRegistry registry = super.createImageRegistry();
registerImage(registry, IMG_REQUEST_RESPONSE, URL_OBJ + "tcp.gif");
registerImage(registry, IMG_RESEND_REQUEST_RESPONSE, URL_ELCL + "resendRequest.gif");
registerImage(registry, IMG_HOST, URL_OBJ + "host.gif");
registerImage(registry, IMG_MONITOR_ON, URL_OBJ + "monitorOn.gif");
registerImage(registry, IMG_MONITOR_OFF, URL_OBJ + "monitorOff.gif");
registerImage(registry, IMG_CLCL_CLEAR, URL_CLCL + "clear.gif");
registerImage(registry, IMG_CLCL_SORT_RESPONSE_TIME, URL_CLCL + "sortResponseTime.gif");
registerImage(registry, IMG_CLCL_HTTP_HEADER, URL_CLCL + "httpHeader.gif");
registerImage(registry, IMG_CLCL_PIN, URL_CLCL + "pin.gif");
registerImage(registry, IMG_ELCL_CLEAR, URL_ELCL + "clear.gif");
registerImage(registry, IMG_ELCL_SORT_RESPONSE_TIME, URL_ELCL + "sortResponseTime.gif");
registerImage(registry, IMG_ELCL_HTTP_HEADER, URL_ELCL + "httpHeader.gif");
registerImage(registry, IMG_ELCL_PIN, URL_ELCL + "pin.gif");
registerImage(registry, IMG_DLCL_CLEAR, URL_DLCL + "clear.gif");
registerImage(registry, IMG_DLCL_SORT_RESPONSE_TIME, URL_DLCL + "sortResponseTime.gif");
registerImage(registry, IMG_DLCL_HTTP_HEADER, URL_DLCL + "httpHeader.gif");
registerImage(registry, IMG_DLCL_PIN, URL_DLCL + "pin.gif");
return registry;
}
/**
* Return the image with the given key from the image registry.
*
* @param key the key
* @return the image
*/
public static Image getImage(String key) {
return getInstance().getImageRegistry().get(key);
}
/**
* Return the image with the given key from the image registry.
*
* @param key the key
* @return an image descriptor
*/
public static ImageDescriptor getImageDescriptor(String key) {
try {
getInstance().getImageRegistry();
return getInstance().imageDescriptors.get(key);
} catch (Exception e) {
return null;
}
}
/**
* Returns the singleton instance of this plugin.
*
* @return the plugin
*/
public static MonitorUIPlugin getInstance() {
return singleton;
}
/**
* Register an image with the registry.
*
* @param key the key
* @param partialURL
*/
private void registerImage(ImageRegistry registry, String key, String partialURL) {
if (ICON_BASE_URL == null) {
String pathSuffix = "icons/";
ICON_BASE_URL = singleton.getBundle().getEntry(pathSuffix);
}
try {
ImageDescriptor id = ImageDescriptor.createFromURL(new URL(ICON_BASE_URL, partialURL));
registry.put(key, id);
imageDescriptors.put(key, id);
} catch (Exception e) {
if (Trace.SEVERE) {
Trace.trace(Trace.STRING_SEVERE, "Error registering image", e);
}
}
}
/**
* @see AbstractUIPlugin#start(org.osgi.framework.BundleContext)
*/
public void start(BundleContext context) throws Exception {
super.start(context);
getPreferenceStore().setDefault(MonitorUIPlugin.SHOW_VIEW_ON_ACTIVITY, true);
getPreferenceStore().setDefault(MonitorUIPlugin.PIN_VIEW, false);
MonitorCore.addMonitorListener(monitorListener);
IMonitor[] monitors = MonitorCore.getMonitors();
if (monitors != null) {
for (IMonitor monitor : monitors)
monitor.addRequestListener(requestListener);
}
// register the debug options listener
final Hashtable<String, String> props = new Hashtable<String, String>(4);
props.put(DebugOptions.LISTENER_SYMBOLICNAME, PLUGIN_ID);
context.registerService(DebugOptionsListener.class.getName(), new Trace(), props);
}
/**
* @see AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
super.stop(context);
IMonitor[] monitors = MonitorCore.getMonitors();
if (monitors != null) {
for (IMonitor monitor : monitors)
monitor.removeRequestListener(requestListener);
}
MonitorCore.removeMonitorListener(monitorListener);
}
public static boolean getDefaultShowOnActivityPreference() {
return getInstance().getPreferenceStore().getDefaultBoolean(SHOW_VIEW_ON_ACTIVITY);
}
public static boolean getShowOnActivityPreference() {
return getInstance().getPreferenceStore().getBoolean(SHOW_VIEW_ON_ACTIVITY);
}
public static void setShowOnActivityPreference(boolean b) {
getInstance().getPreferenceStore().setValue(SHOW_VIEW_ON_ACTIVITY, b);
getInstance().savePluginPreferences();
}
public static boolean getPinViewPreference() {
return getInstance().getPreferenceStore().getBoolean(PIN_VIEW);
}
public static void setPinViewPreference(boolean b) {
getInstance().getPreferenceStore().setValue(PIN_VIEW, b);
getInstance().savePluginPreferences();
}
public static boolean getShowHeaderPreference() {
return getInstance().getPreferenceStore().getBoolean(SHOW_HEADER);
}
public static void setShowHeaderPreference(boolean b) {
getInstance().getPreferenceStore().setValue(SHOW_HEADER, b);
getInstance().savePluginPreferences();
}
/**
* Convenience method to unzip the given bytes using gzip. The returned byte
* array is either the unzipped results, or the original byte array if unzipping
* was not successful. The byte array must not be null.
*
* @param b a byte array
* @return the unzipped array, or the original array if unsuccessful
*/
public static synchronized byte[] unzip(byte[] b) {
if (b == null)
throw new IllegalArgumentException();
try {
GZIPInputStream gin = new GZIPInputStream(new ByteArrayInputStream(b));
byte[] t = new byte[0];
while (gin.available() > 0) {
int n = gin.read(BUFFER);
if (n > 0) {
byte[] temp = new byte[t.length + n];
System.arraycopy(t, 0, temp, 0, t.length);
System.arraycopy(BUFFER, 0, temp, t.length, n);
t = temp;
}
}
return t;
} catch (Exception e) {
if (Trace.FINEST) {
Trace.trace(Trace.STRING_FINEST, "Could not unzip byte array");
}
return b;
}
}
/**
* Convenience method to parse the given bytes into String form. The bytes
* are parsed into a line delimited string. The byte array must not be null.
*
* @param b a byte array
* @return the string after the conversion
*/
public static String parse(byte[] b) {
if (b == null)
throw new IllegalArgumentException();
ByteArrayInputStream bin = new ByteArrayInputStream(b);
BufferedReader br = new BufferedReader(new InputStreamReader(bin));
StringBuffer sb = new StringBuffer();
try {
String s = br.readLine();
while (s != null) {
sb.append(s);
s = br.readLine();
if (s != null)
sb.append(lineSeparator);
}
} catch (Exception e) {
if (Trace.SEVERE) {
Trace.trace(Trace.STRING_SEVERE, "Error parsing input", e);
}
}
return sb.toString();
}
public void addRequest(Request request) {
if (!requests.contains(request))
requests.add(request);
}
/**
* Returns a list of the current requests.
*
* @return an array of requests
*/
public Request[] getRequests() {
Request[] r = new Request[requests.size()];
requests.toArray(r);
return r;
}
public void clearRequests() {
requests = new ArrayList<Request>();
}
}