DMDirc-Client/src/com/dmdirc/plugins/plugins/windowstatus/WindowStatusPlugin.java

/*
 * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.plugins.plugins.windowstatus;

import java.awt.BorderLayout;
import java.awt.Dimension;
import java.util.Hashtable;
import java.util.Properties;

import javax.swing.BorderFactory;
import javax.swing.JInternalFrame;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.SwingConstants;

import com.dmdirc.Channel;
import com.dmdirc.Config;
import com.dmdirc.FrameContainer;
import com.dmdirc.Query;
import com.dmdirc.Server;
import com.dmdirc.commandparser.CommandWindow;
import com.dmdirc.actions.ActionType;
import com.dmdirc.actions.CoreActionType;
import com.dmdirc.parser.ChannelClientInfo;
import com.dmdirc.parser.ChannelInfo;
import com.dmdirc.plugins.Plugin;
import com.dmdirc.plugins.EventPlugin;
import com.dmdirc.ui.ChannelFrame;
import com.dmdirc.ui.MainFrame;
import com.dmdirc.ui.QueryFrame;
import com.dmdirc.ui.ServerFrame;
import com.dmdirc.ui.components.PreferencesInterface;
import com.dmdirc.ui.components.PreferencesPanel;

/**
 * Displays information related to the current window in the status bar.
 *
 * @author Shane 'Dataforce' McCormack
 * @version $Id: WindowStatusPlugin.java 969 2007-04-30 18:38:20Z ShaneMcC $
 */
public final class WindowStatusPlugin extends Plugin implements EventPlugin, PreferencesInterface {
	/** What domain do we store all settings in the global config under. */
	private static final String MY_DOMAIN = "plugin-Logging";
	
	/** The panel we use in the status bar. */
	private final JPanel panel = new JPanel();
	
	/** The label we use to show window status. */
	private final JLabel label = new JLabel(" ??? ");
	
	/** Creates a new instance of WindowStatusPlugin. */
	public WindowStatusPlugin() {
		super();
//		panel.setPreferredSize(new Dimension(70, 25));
		panel.setLayout(new BorderLayout());
		panel.setBorder(BorderFactory.createEtchedBorder());
		label.setHorizontalAlignment(SwingConstants.CENTER);
		panel.add(label);
	}
	
	/**
	 * Called when the plugin is loaded.
	 *
	 * @return false if the plugin can not be loaded
	 */
	public boolean onLoad() {
		final Properties config = Config.getConfig();
		
		// Set default options if they don't exist
		updateOption(config, "channel.shownone", "true");
		updateOption(config, "channel.noneprefix", "None:");
		
		return true;
	}
	
	/**
	 * Called when this plugin is Activated.
	 */
	public void onActivate() {
		updateStatus();
	}
	
	/**
	 * Called when this plugin is deactivated.
	 */
	public void onDeactivate() {
		MainFrame.getMainFrame().getStatusBar().removeComponent(panel);
	}
	
	/**
	 * Get the plugin version.
	 *
	 * @return Plugin Version
	 */
	public String getVersion() { return "0.3"; }
	
	/**
	 * Get the plugin Author.
	 *
	 * @return Author of plugin
	 */
	public String getAuthor() { return "Shane <shane@dmdirc.com>"; }
	
	/**
	 * Get the plugin Description.
	 *
	 * @return Description of plugin
	 */
	public String getDescription() { return "Displays information related to the current window in the status bar."; }
	
	/**
	 * Get the name of the plugin (used in "Manage Plugins" dialog).
	 *
	 * @return Name of plugin
	 */
	public String toString() { return "WindowStatus Plugin"; }
	
	/**
	 * Process an event of the specified type.
	 *
	 * @param type The type of the event to process
	 * @param format Format of messages that are about to be sent. (May be null)
	 * @param arguments The arguments for the event
	 */
	public void processEvent(final ActionType type, final StringBuffer format, final Object... arguments) {
		if (type instanceof CoreActionType) {
			final CoreActionType thisType = (CoreActionType)type;
			switch (thisType) {
				case CLIENT_FRAME_CHANGED:
					updateStatus((FrameContainer)arguments[0]);
					break;
				default:
					break;
			}
		}
	}
	
	/**
	 * Update the window status using the current active window.
	 */
	public void updateStatus() {
		MainFrame.getMainFrame().getStatusBar().addComponent(panel);
		JInternalFrame active = MainFrame.getMainFrame().getActiveFrame();
		if (active instanceof CommandWindow) {
			FrameContainer activeFrame = ((CommandWindow)active).getContainer();
			updateStatus(activeFrame);
		}
	}
	
	/**
	 * Update the window status using a given FrameContainer as the active frame.
	 *
	 * @param current Window to use when adding status.
	 */
	public void updateStatus(final FrameContainer current) {
		if (current == null) { return; }
		StringBuffer textString = new StringBuffer("");
		
		if (current instanceof Server) {
			Server frame = (Server)current;
			
			textString.append(frame.getName());
		} else if (current instanceof Channel) {
			Channel frame = (Channel)current;
			ChannelInfo chan = frame.getChannelInfo();
			Hashtable<Integer,String> names = new Hashtable<Integer,String>();
			Hashtable<Integer,Integer> types = new Hashtable<Integer,Integer>();
			
			textString.append(chan.getName());
			textString.append(" - Nicks: "+chan.getUserCount()+" (");
			
			for (ChannelClientInfo client : chan.getChannelClients()) {
				Integer im = client.getImportantModeValue();
				
				if (!names.containsKey(im)) {
					String mode = client.getImportantModePrefix();
					
					if (mode.equals("")) {
						if (Config.getOptionBool(MY_DOMAIN, "channel.shownone")) {
							if (Config.hasOption(MY_DOMAIN, "channel.noneprefix")) {
								mode = Config.getOption(MY_DOMAIN, "channel.noneprefix");
							} else {
								mode = "None:";
							}
						} else {
							continue;
						}
					}
					names.put(im, mode);
				}
				
				Integer count = types.get(im);
				
				if (count == null) {
					count = new Integer(1);
				} else {
					count = count+1;
				}
				types.put(im, count);
			}
			
			boolean isFirst = true;
			
			for (Integer modeval : types.keySet()) {
				int count = types.get(modeval);
				if (isFirst) { isFirst = false; }
				else { textString.append(" "); }
				textString.append(names.get(modeval)+count);
			}
			
			textString.append(")");
		} else if (current instanceof Query) {
			Query frame = (Query)current;
			
			textString.append(frame.getHost());
		}
		label.setText(" "+textString.toString()+" ");
	}
	
	/**
	 * Called to see if the plugin has configuration options (via dialog).
	 *
	 * @return true if the plugin has configuration options via a dialog.
	 */
	public boolean isConfigurable() { return true; }
	
	/**
	 * Called to show the Configuration dialog of the plugin if appropriate.
	 */
	public void showConfig() {
		final PreferencesPanel preferencesPanel = new PreferencesPanel(this, "Window Status Plugin - Config");
		preferencesPanel.addCategory("Channel", "Configuration for Window Status plugin when showing a channel window.");

		preferencesPanel.addCheckboxOption("Channel", "channel.shownone", "Show 'none' count: ", "Should the count for uses with no state be shown?", Config.getOptionBool(MY_DOMAIN, "channel.shownone"));
		preferencesPanel.addTextfieldOption("Channel", "channel.noneprefix", "Prefix used before 'none' count: ", "The Prefix to use when showing the 'none' count", Config.getOption(MY_DOMAIN, "channel.noneprefix"));
		
		preferencesPanel.display();
	}
	
	/**
	 * Get the name of the domain we store all settings in the global config under.
	 *
	 * @return the plugins domain
	 */
	 protected static String getDomain() { return MY_DOMAIN; }
	
	/**
	 * Copy the new vaule of an option to the global config.
	 *
	 * @param properties Source of option value
	 * @param name name of option
	 * @param defaultValue value to set if source doesn't contain a value.
	 *                     if this is null, value will not be changed.
	 */
	protected void updateOption(final Properties properties, final String name, final String defaultValue) {
		String value = null;
		
		// Get the value from the properties file if one is given
		// if one isn't given we will just use the defaultValue and set that
		if (properties != null) {
			if (properties == Config.getConfig()) {
				// If this properties file is the global config, then
				// we need to prepend our domain name to it.
				value = properties.getProperty(MY_DOMAIN + "." + name);
			} else {
				// Otherwise we do not.
				value = properties.getProperty(name);
			}
		}
		
		// Check if the Properties contains the value we want
		if (value != null) {
			// It does, so update the global config
			Config.setOption(MY_DOMAIN, name, value);
		} else {
			// It does not, so check if we have a default value
			if (defaultValue != null) {
				// We do, use that instead.
				Config.setOption(MY_DOMAIN, name, defaultValue);
			}
		}
	}
	
	/**
	 * Called when the preferences dialog is closed.
	 *
	 * @param properties user preferences
	 */
	public void configClosed(final Properties properties) {
		// Update Config options
		updateOption(properties, "channel.shownone", null);
		updateOption(properties, "channel.noneprefix", "");
		// Update Status bar
		updateStatus();
	}
}