package plugin_interfaces;

import java.util.Hashtable;
import java.util.Properties;

import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.JTextField;

import util.Uniq;
import util.gui.PreferencesPanel;

import callback_interfaces.PluginCallbackRegister;
import callback_interfaces.PublicExposedFunctions;
import callback_interfaces.StaticExposedFunctions;

/*
 * Created on Dec 1, 2004
 * By iago
 */

/** Every plugin has to have a class called "PluginMain" in the default folder that extends this class.  If it doesn't, then
 * the plugin will fail to load.
 * @author iago
 *
 */
abstract public class GenericPluginInterface
{
    /** Called when the plugin is loaded (whenever it's detected) the first time.  You aren't allowed to make hooks at this point.  This
     * can be done when the plugin is Activated. */
    abstract public void load(StaticExposedFunctions staticFuncs);

    /** Called when the plugin is enabled, or, if it's on by default, when the bot starts.  This is called once 
     * for each running instance of the bot that's using it. */
    abstract public void activate(PublicExposedFunctions out, PluginCallbackRegister register);
    /** Called when the plugin is disabled.  This includes when the instance is unloaded. */
    abstract public void deactivate(PluginCallbackRegister register);
    
    /** Get the name of the plugin */
    abstract public String getName();
    /** Get the version number */
    abstract public String getVersion();
    
    /** Get the author */
    abstract public String getAuthorName();
    /** Get the author's website */
    abstract public String getAuthorWebsite();
    /** Get the author's email address */
    abstract public String getAuthorEmail();
    /** Get a description of the plugin. */
    abstract public String getLongDescription();
    
    /** Get the default settings for the plugin. */
    abstract public Properties getDefaultSettingValues();
    /** This should return a Properties with each setting, as well as what it means. 
     * This is used for local settings. */
    abstract public Properties getSettingsDescription();
    /** This should return the appropriate component for the setting, along with the default value set.
     * If a JTextField is needed, null can be returned. */
    abstract public JComponent getComponent(String settingName, String value);

    /** Get the default global settings for the plugin.  By default, nothing. */
    abstract public Properties getGlobalDefaultSettingValues();
    /** Get the descriptions for the global plugins */
    abstract public Properties getGlobalSettingsDescription();
    /** This returns the appropriate component for the given global setting */
    abstract public JComponent getGlobalComponent(String settingName, String value);
    
    /** This should return true if the plugin should be loaded by default */
    public boolean isRequiredPlugin()
    {
        return false;
    }
    
    /** This is just to simplify some code */
    public Hashtable getComponents(Properties values)
    {
        String []keys = Uniq.uniq(getDefaultSettingValues().keys());
        Hashtable ret = new Hashtable();
        
        for(int i = 0; i < keys.length; i++)
        {
            JComponent component = getComponent(keys[i], values.getProperty(keys[i].toLowerCase())); 
            
            if(component == null)
                component = new JTextField(values.getProperty(keys[i].toLowerCase()));
                
            ret.put(keys[i], component);
        }
        
        return ret;
    }
    
    /** This is just to simplify some code */
    public Hashtable getGlobalComponents(Properties values)
    {
        String []keys = Uniq.uniq(getGlobalDefaultSettingValues().keys());
        Hashtable ret = new Hashtable();
        
        for(int i = 0; i < keys.length; i++)
        {
            JComponent component = getGlobalComponent(keys[i], values.getProperty(keys[i].toLowerCase())); 
            
            if(component == null)
                component = new JTextField(values.getProperty(keys[i].toLowerCase()));
                
            ret.put(keys[i], component);
        }
        
        return ret;
    }
    
    /** The PreferencePanels class can be overridden to change how your preferences look */
    public JPanel getPreferenceImplementation(Properties currentSettings, Properties defaultSettings, Properties descriptions, Hashtable components)
    {
        return new PreferencesPanel(currentSettings, defaultSettings, descriptions, components);
    }
    
    /** The PreferencesPanel class for the global settings can also be overridden, if desired */
    public JPanel getGlobalPreferenceImplementation(Properties currentSettings, Properties defaultSettings, Properties descriptions, Hashtable components)
    {
        return new PreferencesPanel(currentSettings, defaultSettings, descriptions, components);
    }
    
    
    /** Get the full name that uniquely identified this plugin (generally, the name + version) */
    public String getFullName()
    {
        return getName() + " v" + getVersion();
    }
    
    /** Add any default settings */
    public void setDefaultSettings(PublicExposedFunctions out)
    {
        Properties props = getDefaultSettingValues();
        String []defaultSettings = Uniq.uniq(props.keys());

        for(int i = 0; i < defaultSettings.length; i++)
        {
            out.getLocalSettingDefault(getName(), defaultSettings[i], props.getProperty(defaultSettings[i]));
        }
        
    }
    
    /** Add any global settings */
    public void setGlobalDefaultSettings(StaticExposedFunctions funcs)
    {
        Properties props = getGlobalDefaultSettingValues();
        String []defaultSettings = Uniq.uniq(props.keys());
        for(int i = 0; i < defaultSettings.length; i++)
            funcs.getGlobalSettingDefault(getName(), defaultSettings[i], props.getProperty(defaultSettings[i]));
    }
    
    public String toString()
    {
        return "Plugin: " + getFullName();
    }
}