Scripting Plugin.

Change-Id: Ib098163cb07ef9b4cbe5abb66c70c9052e117b24
Reviewed-on: http://gerrit.dmdirc.com/283
Reviewed-by: Gregory Holmes <greboid@dmdirc.com>
Tested-by: Gregory Holmes <greboid@dmdirc.com>

src/com/dmdirc/addons/scriptplugin/JavaScriptHelper.java

@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2006-2010 Shane Mc Cormack
+ *
+ * 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.addons.scriptplugin;
+import java.util.Hashtable;
+
+/**
+ * Used to allow the rhino javascript to do stuff that it otherwise can't, such
+ * as setting global variables, string triming and getting a char.
+ *
+ * @author Shane 'Dataforce' McCormack
+ */
+public class JavaScriptHelper {
+    /** Used to identify the JavaScriptHelper. */
+    private static final String myIDString = "DMDIRC-JSH";
+    
+    /** Used to allow scripts to know if a specific function they need is available. */
+    private final int myVersion = 2;
+
+    /** Hashtable for storing stufff. */
+    private static Hashtable<String,Object> globalSettings = new Hashtable<String,Object>();
+    
+    /**
+     * Method to set Stuff.
+     *
+     * @param setting Name of setting
+     * @param value Value of setting
+     */
+    public void setGlobal(String setting, Object value) {
+        if (setting.equals("")) { return; }
+        setting = setting.toLowerCase();
+        if (globalSettings.containsKey(setting)) { globalSettings.remove(setting); }
+        if (value != null) { globalSettings.put(setting,value); }
+    }
+    
+    /**
+     * Method to get Stuff.
+     *
+     * @param setting Name of setting
+     * @return Value of setting
+     */
+    public Object getGlobal(String setting) {
+        if (setting.equals("")) { return ""; }
+        setting = setting.toLowerCase();
+        if (globalSettings.containsKey(setting)) { return globalSettings.get(setting); }
+        return null;
+    }
+    
+    /**
+     * Method to trim spaces from strings.
+     *
+     * @param str String to trim
+     * @return String without spaces on the ends
+     */
+    public String trim(String str) { return str.trim(); }
+    
+    /**
+     * Method to get a java Character object.
+     *
+     * @param str String to make object from
+     * @return Character represending first char in the string
+     */
+    public Character toChar(String str) { return str.charAt(0); }
+    
+    /**
+     * Get the version of JavaScriptHelper in use.
+     *
+     * @return JavaScriptHelper version
+     */
+    public int getVersion() { return myVersion; }
+    
+    /**
+     * Get the ID of this JavaScriptHelper.
+     * If you extend or modify this, you should change the myIDString variable.
+     *
+     * @return JavaScriptHelper ID
+     */
+    public String getID() { return myIDString; }
+}

src/com/dmdirc/addons/scriptplugin/ScriptCommand.java

@@ -0,0 +1,270 @@
+/*
+ * Copyright (c) 2006-2010 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.addons.scriptplugin;
+
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.config.IdentityManager;
+import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.GlobalCommand;
+import com.dmdirc.ui.interfaces.InputWindow;
+import com.dmdirc.commandparser.commands.IntelligentCommand;
+import com.dmdirc.ui.input.AdditionalTabTargets;
+import com.dmdirc.ui.input.TabCompletionType;
+
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+
+import java.lang.reflect.Method;
+
+/**
+ * The Script Command allows controlling of the scriptplugin.
+ *
+ * @author Shane 'Dataforce' McCormack
+ */
+public final class ScriptCommand extends GlobalCommand implements IntelligentCommand {
+    /** My Plugin */
+    final ScriptPlugin myPlugin;
+
+    /**
+     * Creates a new instance of ScriptCommand.
+     */
+    public ScriptCommand(final ScriptPlugin plugin) {
+        super();
+        myPlugin = plugin;
+        CommandManager.registerCommand(this);
+    }
+        
+    /**
+     * Executes this command.
+     *
+     * @param origin The frame in which this command was issued
+     * @param server The server object that this command is associated with
+     * @param isSilent Whether this command is silenced or not
+     * @param args The user supplied arguments
+     */
+    @Override
+    public void execute(final InputWindow origin, final boolean isSilent, final CommandArguments commandArgs) {
+        final String[] args = commandArgs.getArguments();
+    
+        if (args.length > 0 && (args[0].equalsIgnoreCase("rehash") || args[0].equalsIgnoreCase("reload"))) {
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "Reloading scripts");
+            myPlugin.rehash();
+        } else if (args.length > 0 && args[0].equalsIgnoreCase("load")) {
+            if (args.length > 1) {
+                final String filename = commandArgs.getArgumentsAsString(1);
+                sendLine(origin, isSilent, FORMAT_OUTPUT, "Loading: "+filename+" ["+myPlugin.loadScript(myPlugin.getScriptDir()+filename)+"]");
+            } else {
+                sendLine(origin, isSilent, FORMAT_ERROR, "You must specify a script to load");
+            }
+        } else if (args.length > 0 && args[0].equalsIgnoreCase("unload")) {
+            if (args.length > 1) {
+                final String filename = commandArgs.getArgumentsAsString(1);
+                sendLine(origin, isSilent, FORMAT_OUTPUT, "Unloading: "+filename+" ["+myPlugin.loadScript(myPlugin.getScriptDir()+filename)+"]");
+            } else {
+                sendLine(origin, isSilent, FORMAT_ERROR, "You must specify a script to unload");
+            }
+        } else if (args.length > 0 && args[0].equalsIgnoreCase("eval")) {
+            if (args.length > 1) {
+                final String script = commandArgs.getArgumentsAsString(1);
+                sendLine(origin, isSilent, FORMAT_OUTPUT, "Evaluating: "+script);
+                try {
+                    ScriptEngineWrapper wrapper;
+                    if (IdentityManager.getGlobalConfig().hasOptionString(myPlugin.getDomain(), "eval.baseFile")) {
+                        final String baseFile = myPlugin.getScriptDir()+'/'+IdentityManager.getGlobalConfig().getOption(myPlugin.getDomain(), "eval.baseFile");
+                        if ((new File(baseFile)).exists()) {
+                            wrapper = new ScriptEngineWrapper(myPlugin, baseFile);
+                        } else {
+                            wrapper = new ScriptEngineWrapper(myPlugin, null);
+                        }
+                    } else {
+                        wrapper = new ScriptEngineWrapper(myPlugin, null);
+                    }
+                    wrapper.getScriptEngine().put("cmd_origin", origin);
+                    wrapper.getScriptEngine().put("cmd_isSilent", isSilent);
+                    wrapper.getScriptEngine().put("cmd_args", args);
+                    sendLine(origin, isSilent, FORMAT_OUTPUT, "Result: "+wrapper.getScriptEngine().eval(script));
+                } catch (Exception e) {
+                    sendLine(origin, isSilent, FORMAT_OUTPUT, "Exception: "+e+" -> "+e.getMessage());
+                    
+                    if (IdentityManager.getGlobalConfig().getOptionBool(myPlugin.getDomain(), "eval.showStackTrace")) {
+                        try {
+                            final Class<?> logger = Class.forName("com.dmdirc.logger.Logger");
+                            if (logger != null) {
+                                final Method exceptionToStringArray = logger.getDeclaredMethod("exceptionToStringArray", new Class[]{Throwable.class});
+                                exceptionToStringArray.setAccessible(true);
+                                
+                                final String[] stacktrace = (String[])exceptionToStringArray.invoke(null, e);
+                                for (String line : stacktrace) {
+                                    sendLine(origin, isSilent, FORMAT_OUTPUT, "Stack trace: "+line);
+                                }
+                            }
+                        } catch (Exception ex) {
+                            sendLine(origin, isSilent, FORMAT_OUTPUT, "Stack trace: Exception showing stack trace: "+ex+" -> "+ex.getMessage());
+                        }
+                    }
+                    
+                }
+            } else {
+                sendLine(origin, isSilent, FORMAT_ERROR, "You must specify some script to eval.");
+            }
+        } else if (args.length > 0 && args[0].equalsIgnoreCase("savetobasefile")) {
+            if (args.length > 2) {
+                final String[] bits = args[1].split("/");
+                final String functionName = bits[0];
+                final String script = commandArgs.getArgumentsAsString(2);
+                sendLine(origin, isSilent, FORMAT_OUTPUT, "Saving as '"+functionName+"': "+script);
+                if (IdentityManager.getGlobalConfig().hasOptionString(myPlugin.getDomain(), "eval.baseFile")) {
+                    try {
+                        final String baseFile = myPlugin.getScriptDir()+'/'+IdentityManager.getGlobalConfig().getOption(myPlugin.getDomain(), "eval.baseFile");
+                        final FileWriter writer = new FileWriter(baseFile, true);
+                        writer.write("function ");
+                        writer.write(functionName);
+                        writer.write("(");
+                        for (int i = 1; i < bits.length; i++) {
+                            writer.write(bits[i]);
+                            writer.write(" ");
+                        }
+                        writer.write(") {\n");
+                        writer.write(script);
+                        writer.write("\n}\n");
+                        writer.flush();
+                        writer.close();
+                    } catch (IOException ioe) {
+                        sendLine(origin, isSilent, FORMAT_ERROR, "IOException: "+ioe.getMessage());
+                    }
+                } else {
+                    sendLine(origin, isSilent, FORMAT_ERROR, "No baseFile specified, please /set "+myPlugin.getDomain()+" eval.baseFile filename (stored in scripts dir of profile)");
+                }
+            } else if (args.length > 1) {
+                sendLine(origin, isSilent, FORMAT_ERROR, "You must specify some script to save.");
+            } else {
+                sendLine(origin, isSilent, FORMAT_ERROR, "You must specify a function name and some script to save.");
+            }
+        } else if (args.length > 0 && args[0].equalsIgnoreCase("help")) {
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "This command allows you to interact with the script plugin");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "-------------------");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "reload/rehash                  - Reload all loaded scripts");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "load <script>                  - load scripts/<script> (file name relative to scripts dir)");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "unload <script>                - unload <script> (full file name)");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "eval <script>                  - evaluate the code <script> and return the result");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "savetobasefile <name> <script> - save the code <script> to the eval basefile ("+myPlugin.getDomain()+".eval.basefile)");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "                                 as the function <name> (name/foo/bar will save it as 'name' with foo and");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "                                 bar as arguments.");
+            sendLine(origin, isSilent, FORMAT_OUTPUT, "-------------------");
+        } else {
+            sendLine(origin, isSilent, FORMAT_ERROR, "Unknown subcommand.");
+        }
+    }
+
+    /**
+     * Returns a list of suggestions for the specified argument, given the list
+     * of previous arguments.
+     * @param arg The argument that is being completed
+     * @param previousArgs The contents of the previous arguments, if any
+     * @return A list of suggestions for the argument
+     */
+    @Override
+    public AdditionalTabTargets getSuggestions(final int arg, final List<String> previousArgs) {
+        final AdditionalTabTargets res = new AdditionalTabTargets();
+        
+        res.excludeAll();
+        if (arg == 0) {
+            res.add("help");
+            res.add("rehash");
+            res.add("reload");
+            res.add("load");
+            res.add("unload");
+            res.add("eval");
+            res.add("savetobasefile");
+        } else if (arg == 1) {
+            final Map<String,ScriptEngineWrapper> scripts = myPlugin.getScripts();
+            if (previousArgs.get(0).equalsIgnoreCase("load")) {
+                for (String filename : getPossibleScripts()) {
+                    res.add(filename);
+                }
+            } else if (previousArgs.get(0).equalsIgnoreCase("unload")) {
+                for (String filename : scripts.keySet()) {
+                    res.add(filename);
+                }
+            }
+        }
+        
+        return res;
+    }
+    
+    /**
+     * Retrieves a list of all installed scripts.
+     * Any file under the main plugin directory (~/.DMDirc/scripts or similar)
+     * that matches *.js is deemed to be a valid script.
+     *
+     * @return A list of all installed scripts
+     */
+    private List<String> getPossibleScripts() {
+        final List<String> res = new LinkedList<String>();
+        
+        final LinkedList<File> dirs = new LinkedList<File>();
+        dirs.add(new File(myPlugin.getScriptDir()));
+        
+        while (!dirs.isEmpty()) {
+            final File dir = dirs.pop();
+            if (dir.isDirectory()) {
+                for (File file : dir.listFiles()) {
+                    dirs.add(file);
+                }
+            } else if (dir.isFile() && dir.getName().endsWith(".js")) {
+                final String target = dir.getPath();
+                res.add(target.substring(myPlugin.getScriptDir().length(), target.length()));
+            }
+        }
+        return res;
+    }
+
+    /**
+     * Returns this command's name.
+     *
+     * @return The name of this command
+     */
+    @Override
+    public String getName() { return "script"; }
+    
+    /**
+     * Returns whether or not this command should be shown in help messages.
+     *
+     * @return True iff the command should be shown, false otherwise
+     */
+    @Override
+    public boolean showInHelp() { return true; }
+    
+    /**
+     * Returns a string representing the help message for this command.
+     *
+     * @return the help message for this command
+     */
+    @Override
+    public String getHelp() { return "script - Allows controlling the script plugin"; }
+}
+

src/com/dmdirc/addons/scriptplugin/ScriptEngineWrapper.java

@@ -0,0 +1,145 @@
+/*
+ * Copyright (c) 2006-2010 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.addons.scriptplugin;
+
+import com.dmdirc.logger.Logger;
+import com.dmdirc.logger.ErrorLevel;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileReader;
+import javax.script.ScriptEngine;
+import javax.script.Invocable;
+import javax.script.ScriptException;
+
+/**
+ * Class to create script engines!
+ *
+ * @author Shane 'Dataforce' McCormack
+ */
+public class ScriptEngineWrapper {
+    /** The Script Engine this wrapper wraps */
+    private ScriptEngine engine;
+
+    /** The File this script is from */
+    private final File file;
+    
+    /** Script-Local JS Helper */
+    private JavaScriptHelper localHelper = new JavaScriptHelper();
+
+    /** The script plugin that owns this wrapper. */
+    private final ScriptPlugin plugin;
+
+    /**
+     * Create a new ScriptEngineWrapper
+     *
+     * @param plugin The script plugin that owns this wrapper
+     * @param filename Filename of script
+     */
+    protected ScriptEngineWrapper(final ScriptPlugin plugin, final String filename) throws FileNotFoundException, ScriptException {
+        this.plugin = plugin;
+        file = (filename != null) ? new File(filename) : null;
+        
+        engine = createEngine();
+        
+        callFunction("onLoad");
+    }
+    
+    /**
+     * Get a reference to the ScriptEngine.
+     *
+     * @return a reference to the ScriptEngine
+     */
+    protected ScriptEngine getScriptEngine() { return engine; }
+    
+    /**
+     * Get a reference to the JavaScriptHelper
+     *
+     * @return a reference to the JavaScriptHelper
+     */
+    protected JavaScriptHelper getJavaScriptHelper() { return localHelper; }
+    
+    /**
+     * Get the file for this script
+     *
+     * @return The file for this script
+     */
+    protected File getFile() { return file; }
+    
+    /**
+     * Create a new engine for this script
+     */
+    protected ScriptEngine createEngine() throws FileNotFoundException, ScriptException {
+        final ScriptEngine result = plugin.getScriptFactory().getEngineByName("JavaScript");
+        if (file != null) {
+            result.eval(new FileReader(file));
+        }
+        
+        result.put("localHelper", localHelper);
+        result.put("thisEngine", this);
+        
+        return result;
+    }
+    
+    /**
+     * Call a function in this script.
+     *
+     * @param functionName Name of function
+     * @param args Arguments for function
+     */
+    protected void callFunction(final String functionName, final Object... args) {
+        try {
+            // Call Function
+            final Invocable invEngine = (Invocable) engine;
+            invEngine.invokeFunction(functionName, args);
+        } catch (NoSuchMethodException nsme) {
+            // There is no "methodExists" function, so we catch NoSuchMethodException
+            // and do nothing rather that add an erropr every time a method is called
+            // that doesn't exist (such as the action_* methods)
+        } catch (Exception e) {
+            Logger.userError(ErrorLevel.LOW, "Error calling '"+functionName+"' in '"+file.getPath()+"': "+e.getMessage(), e);
+        }
+    }
+    
+    /**
+     * Try to reload this script.
+     */
+    protected boolean reload() {
+        // Tell the current engine that its about to be obliterated.
+        callFunction("onPreRehash");
+        
+        try {
+            // Try making a new engine
+            engine = createEngine();
+            // Tell it that it has been rehashed
+            callFunction("onRehashSucess");
+        } catch (Exception e) {
+            Logger.userError(ErrorLevel.LOW, "Reloading '"+file.getPath()+"' failed: "+e.getMessage(), e);
+            // Tell it that its rehash failed
+            callFunction("onRehashFailed", e);
+            return false;
+        }
+        
+        return true;
+    }
+}

src/com/dmdirc/addons/scriptplugin/ScriptPlugin.java

@@ -0,0 +1,270 @@
+/*
+ * Copyright (c) 2006-2010 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.addons.scriptplugin;
+
+import com.dmdirc.Main;
+import com.dmdirc.config.prefs.validator.ValidationResponse;
+import com.dmdirc.plugins.Plugin;
+import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.actions.ActionManager;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.actions.interfaces.ActionType;
+import com.dmdirc.logger.Logger;
+import com.dmdirc.logger.ErrorLevel;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.HashMap;
+
+import javax.script.ScriptEngineManager;
+
+/**
+ * This allows javascript scripts to be used in DMDirc.
+ *
+ * @author Shane 'Dataforce' McCormack
+ */
+public final class ScriptPlugin extends Plugin implements ActionListener {
+    /** The ScriptCommand we created */
+    private ScriptCommand command = null;
+    
+    /** Script Directory */
+    private final String scriptDir = Main.getConfigDir() + "scripts/";
+    
+    /** Script Engine Manager */
+    private ScriptEngineManager scriptFactory = new ScriptEngineManager();
+    
+    /** Instance of the javaScriptHelper class */
+    private JavaScriptHelper jsHelper = new JavaScriptHelper();
+    
+    /** Store Script State Name,Engine */
+    private Map<String,ScriptEngineWrapper> scripts = new HashMap<String,ScriptEngineWrapper>();
+    
+    /** Used to store permanent variables */
+    protected TypedProperties globalVariables = new TypedProperties();
+
+    /**
+     * Creates a new instance of the Script Plugin.
+     */
+    public ScriptPlugin() {
+        super();
+        
+        // Add the JS Helper to the scriptFactory
+        getScriptFactory().put("globalHelper", getJavaScriptHelper());
+        getScriptFactory().put("globalVariables", getGlobalVariables());
+    }
+    
+    /**
+     * Called when the plugin is loaded.
+     */
+    @Override
+    public void onLoad() {
+        // Register the plugin_loaded action initially, this will be called
+        // after this method finishes for us to register the rest.
+        ActionManager.addListener(this, CoreActionType.PLUGIN_LOADED);
+        command = new ScriptCommand(this);
+        
+        // Make sure our scripts dir exists
+        final File newDir = new File(scriptDir);
+        if (!newDir.exists()) { newDir.mkdirs(); }
+        
+        final File savedVariables = new File(scriptDir+"storedVariables");
+        if (savedVariables.exists()) {
+            try {
+                globalVariables.load(new FileInputStream(savedVariables));
+            } catch (IOException e) {
+                Logger.userError(ErrorLevel.LOW, "Error reading savedVariables from '"+savedVariables.getPath()+"': "+e.getMessage(), e);
+            }
+        }
+    }
+    
+    /**
+     * Called when this plugin is Unloaded
+     */
+    @Override
+    public void onUnload() {
+        ActionManager.removeListener(this);
+        CommandManager.unregisterCommand(command);
+        
+        final File savedVariables = new File(scriptDir+"storedVariables");
+        try {
+            globalVariables.store(new FileOutputStream(savedVariables), "# DMDirc Script Plugin savedVariables");
+        } catch (IOException e) {
+            Logger.userError(ErrorLevel.LOW, "Error reading savedVariables to '"+savedVariables.getPath()+"': "+e.getMessage(), e);
+        }
+    }
+    
+    /**
+     * Register all the action types.
+     * This will unregister all the actions first.
+     */
+    private void registerAll() {
+        ActionManager.removeListener(this);
+        for (Map.Entry<String, List<ActionType>> entry : ActionManager.getTypeGroups().entrySet()) {
+            final List<ActionType> types = entry.getValue();
+            ActionManager.addListener(this, types.toArray(new ActionType[0]));
+        }
+    }
+    
+    /**
+     * 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
+     */
+    @Override
+    public void processEvent(final ActionType type, final StringBuffer format, final Object... arguments) {
+        // Plugins may to register/unregister action types, so lets reregister all
+        // the action types. This 
+        if (type.equals(CoreActionType.PLUGIN_LOADED) || type.equals(CoreActionType.PLUGIN_UNLOADED)) {
+            registerAll();
+        }
+        callFunctionAll("action_"+type.toString().toLowerCase(), arguments);
+    }
+    
+    /**
+     * Get a clone of the scripts map.
+     *
+     * @return a clone of the scripts map
+     */
+    protected Map<String,ScriptEngineWrapper> getScripts() { return new HashMap<String,ScriptEngineWrapper>(scripts); }
+    
+    /**
+     * Get a reference to the scriptFactory.
+     *
+     * @return a reference to the scriptFactory
+     */
+    protected ScriptEngineManager getScriptFactory() { return scriptFactory; }
+    
+    /**
+     * Get a reference to the JavaScriptHelper
+     *
+     * @return a reference to the JavaScriptHelper
+     */
+    protected JavaScriptHelper getJavaScriptHelper() { return jsHelper; }
+    
+    /**
+     * Get a reference to the GlobalVariables Properties
+     *
+     * @return a reference to the GlobalVariables Properties
+     */
+    protected TypedProperties getGlobalVariables() { return globalVariables; }
+    
+    /**
+     * Get the name of the directory where scripts should be stored.
+     *
+     * @return The name of the directory where scripts should be stored.
+     */
+    protected String getScriptDir() { return scriptDir; }
+    
+    /** Reload all scripts */
+    public void rehash() {
+        for (final ScriptEngineWrapper engine : scripts.values()) {
+            engine.reload();
+        }
+        // Advise the Garbage collector that now would be a good time to run
+        System.gc();
+    }
+    
+    /**
+     * Call a function in all scripts.
+     *
+     * @param functionName Name of function
+     * @param args Arguments for function
+     */
+    private void callFunctionAll(final String functionName, final Object... args) {
+        for (final ScriptEngineWrapper engine : scripts.values()) {
+            engine.callFunction(functionName, args);
+        }
+    }
+
+    /**
+     * Unload a script file.
+     *
+     * @param scriptFilename Path to script
+     */
+    public void unloadScript(final String scriptFilename) {
+        if (scripts.containsKey(scriptFilename)) {
+            // Tell it that its about to be unloaded.
+            (scripts.get(scriptFilename)).callFunction("onUnload");
+            // Remove the script
+            scripts.remove(scriptFilename);
+            // Advise the Garbage collector that now would be a good time to run
+            System.gc();
+        }
+    }
+        
+    /**
+     * Load a script file into a new jsEngine
+     *
+     * @param scriptFilename Path to script
+     * @return true for Success (or already loaded), false for fail. (Fail occurs if script already exists, or if it has errors)
+     */
+    public boolean loadScript(final String scriptFilename) {
+        if (!scripts.containsKey(scriptFilename)) {
+            try {
+                final ScriptEngineWrapper wrapper = new ScriptEngineWrapper(this, scriptFilename);
+                scripts.put(scriptFilename, wrapper);
+            } catch (Exception e) {
+                Logger.userError(ErrorLevel.LOW, "Error loading '"+scriptFilename+"': "+e.getMessage(), e);
+                return false;
+            }
+        }
+        return true;
+    }
+    
+    /**
+     * Check any further Prerequisites for this plugin to load that can not be
+     * checked using metainfo.
+     *
+     * @return ValidationResponse detailign if the plugin passes any extra checks
+     *         that plugin.info can't handle
+     */
+    public ValidationResponse checkPrerequisites() {
+        if (getScriptFactory().getEngineByName("JavaScript") == null) {
+            return new ValidationResponse("JavaScript Scripting Engine not found.");
+        } else {
+            return new ValidationResponse();
+        }
+    }
+    
+    /**
+     * Get the reason for checkPrerequisites failing.
+     *
+     * @return Human-Readble reason for checkPrerequisites failing.
+     */
+    public String checkPrerequisitesReason() {
+        if (getScriptFactory().getEngineByName("JavaScript") == null) {
+            return "JavaScript Scripting Engine not found.";
+        } else {
+            return "";
+        }
+    }
+}
+

src/com/dmdirc/addons/scriptplugin/TypedProperties.java

@@ -0,0 +1,421 @@
+/*
+ * Copyright (c) 2006-2010 Shane Mc Cormack
+ *
+ * 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.addons.scriptplugin;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Properties;
+import java.io.InputStream;
+import java.io.Reader;
+import java.io.IOException;
+
+/**
+ * Properties file that allows for getting/setting of typed properties
+ *
+ * @author Shane 'Dataforce' McCormack
+ */
+public class TypedProperties extends Properties {
+	/**
+	 * A version number for this class.
+	 * It should be changed whenever the class structure is changed (or anything
+	 * else that would prevent serialized objects being unserialized with the new 
+	 * class).
+	 */
+	private static final long serialVersionUID = 200711071;
+	
+	/** Is this properties file Case Sensitive */
+	private boolean caseSensitive = true;
+	
+	/**
+	 * Creates an empty property list with no default values.
+	 */
+	public TypedProperties() {
+		super();
+	}
+	
+	/**
+	 * Creates an empty property list with the specified defaults.
+	 *
+	 * @param defaults The Defaults
+	 */
+	public TypedProperties(final Properties defaults) {
+		super(defaults);
+	}
+	
+	/**
+	 * Set case sensitivity of this properties file.
+	 *
+	 * @param value True/False for the case sensitivity of this file
+	 */
+	public void setCaseSensitivity(final boolean value) {
+		// Set all existing values to lowercase.
+		if (!value) {
+			for (Object property : this.keySet()) {
+				if (property instanceof String) {
+					final String propertyName = (String)property;
+					if (!propertyName.equals(propertyName.toLowerCase())) {
+						super.setProperty(propertyName.toLowerCase(), getProperty(propertyName));
+						super.remove(propertyName);
+					}
+				}
+			}
+		}
+		caseSensitive = value;
+	}
+	
+	/**
+	 * Load properties from an InputStream.
+	 * After loading, setCaseSensitivity(caseSensitive) is called.
+	 * If this properties file is ment to be case Insensitive, all non-lowercase
+	 * property names will be lowercased.
+	 *
+	 * @param inStream InputStream to load from.
+	 * @throws IOException If there is a problem reading from the Input Stream
+	 */
+	@Override
+	public void load(final InputStream inStream) throws IOException {
+		super.load(inStream);
+		setCaseSensitivity(caseSensitive);
+	}
+	
+	/**
+	 * Load properties from a Reader.
+	 * After loading, setCaseSensitivity(caseSensitive) is called.
+	 * If this properties file is ment to be case Insensitive, all non-lowercase
+	 * property names will be lowercased.
+	 *
+	 * @param reader Reader to load from.
+	 * @throws IOException If there is an error reading from the reader
+	 */
+	@Override
+	public void load(final Reader reader) throws IOException {
+		super.load(reader);
+		setCaseSensitivity(caseSensitive);
+	}
+	
+	/**
+	 * Load properties from an XML InputStream.
+	 * After loading, setCaseSensitivity(caseSensitive) is called.
+	 * If this properties file is ment to be case Insensitive, all non-lowercase
+	 * property names will be lowercased.
+	 *
+	 * @param in InputStream to load from.
+	 * @throws java.io.IOException 
+	 */
+	@Override
+	public void loadFromXML(final InputStream in) throws IOException {
+		super.loadFromXML(in);
+		setCaseSensitivity(caseSensitive);
+	}
+	
+	/**
+	 * Get a property from the config
+	 *
+	 * @param key key for property
+	 * @return the requested property, or null if not defined
+	 */
+	@Override
+	public String getProperty(final String key) {
+		if (!caseSensitive) {
+			return super.getProperty(key.toLowerCase());
+		} else {
+			return super.getProperty(key);
+		}
+	}
+	
+	/**
+	 * Get a property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	@Override
+	public String getProperty(final String key, final String fallback) {
+		if (!caseSensitive) {
+			return super.getProperty(key.toLowerCase(), fallback);
+		} else {
+			return super.getProperty(key, fallback);
+		}
+	}
+	
+	/**
+	 * Set a property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 * @return Old value of property
+	 */
+	@Override
+	public Object setProperty(final String key, final String value) {
+		if (!caseSensitive) {
+			return super.setProperty(key.toLowerCase(), value);
+		} else {
+			return super.setProperty(key, value);
+		}
+	}
+	
+	/**
+	 * Check if a property exists
+	 *
+	 * @param key key for property
+	 * @return True if the property exists, else false
+	 */
+	public boolean hasProperty(final String key) {
+		return getProperty(key) != null;
+	}
+	
+	/**
+	 * Get a Byte property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	public byte getByteProperty(final String key, final byte fallback) {
+		try {
+			return Byte.parseByte(getProperty(key, Byte.toString(fallback)));
+		} catch (NumberFormatException nfe) {
+			return fallback;
+		}
+	}
+	
+	/**
+	 * Set a Byte property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setByteProperty(final String key, final byte value) {
+		setProperty(key, Byte.toString(value));
+	}
+	
+	/**
+	 * Get a Short property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	public short getShortProperty(final String key, final short fallback) {
+		try {
+			return Short.parseShort(getProperty(key, Short.toString(fallback)));
+		} catch (NumberFormatException nfe) {
+			return fallback;
+		}
+	}
+	
+	/**
+	 * Set a Short property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setShortProperty(final String key, final short value) {
+		setProperty(key, Short.toString(value));
+	}
+	
+	/**
+	 * Get an integer property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	public int getIntProperty(final String key, final int fallback) {
+		try {
+			return Integer.parseInt(getProperty(key, Integer.toString(fallback)));
+		} catch (NumberFormatException nfe) {
+			return fallback;
+		}
+	}
+	
+	/**
+	 * Set an integer property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setIntProperty(final String key, final int value) {
+		setProperty(key, Integer.toString(value));
+	}
+	
+	/**
+	 * Get a Long property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	public long getLongProperty(final String key, final long fallback) {
+		try {
+			return Long.parseLong(getProperty(key, Long.toString(fallback)));
+		} catch (NumberFormatException nfe) {
+			return fallback;
+		}
+	}
+	
+	/**
+	 * Set a Long property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setLongProperty(final String key, final long value) {
+		setProperty(key, Long.toString(value));
+	}
+	
+	/**
+	 * Get a float property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	public float getFloatProperty(final String key, final float fallback) {
+		try {
+			return Float.parseFloat(getProperty(key, Float.toString(fallback)));
+		} catch (NumberFormatException nfe) {
+			return fallback;
+		}
+	}
+	
+	/**
+	 * Set a float property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setFloatProperty(final String key, final float value) {
+		setProperty(key, Float.toString(value));
+	}
+	
+	/**
+	 * Get a double property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	public double getDoubleProperty(final String key, final double fallback) {
+		try {
+			return Double.parseDouble(getProperty(key, Double.toString(fallback)));
+		} catch (NumberFormatException nfe) {
+			return fallback;
+		}
+	}
+	
+	/**
+	 * Set a double property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setDoubleProperty(final String key, final double value) {
+		setProperty(key, Double.toString(value));
+	}
+	
+	/**
+	 * Get a boolean property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+ 	 * @return the requested property, or the fallback value if not defined
+	 */
+	public boolean getBoolProperty(final String key, final boolean fallback) {
+		return Boolean.parseBoolean(getProperty(key, Boolean.toString(fallback)));
+	}
+	
+	/**
+	 * Set a Boolean property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setBoolProperty(final String key, final boolean value) {
+		setProperty(key, Boolean.toString(value));
+	}
+	
+	/**
+	 * Get a Char property from the config
+	 *
+	 * @param key key for property
+	 * @param fallback Value to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	public char getCharProperty(final String key, final char fallback) {
+		final String res = getProperty(key, Character.toString(fallback));
+		if (res == null || res.isEmpty()) {
+			return fallback;
+		} else {
+			return res.charAt(0);
+		}
+	}
+	
+	/**
+	 * Set a Char property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setCharProperty(final String key, final char value) {
+		setProperty(key, Character.toString(value));
+	}
+	
+	/**
+	 * Get a List property from the config.
+	 *
+	 * @param key key for property
+	 * @param fallback List to return if key is not found
+	 * @return the requested property, or the fallback value if not defined
+	 */
+	public List<String> getListProperty(final String key, final List<String> fallback) {
+		final String res = getProperty(key, "");
+		if (res == null || res.isEmpty()) {
+			return fallback;
+		} else {
+			final String bits[] = res.split("\n");
+			final ArrayList<String> result = new ArrayList<String>();
+			for (String bit : bits) {
+				result.add(bit);
+			}
+			return result;
+		}
+	}
+	
+	/**
+	 * Set a List property in the config
+	 *
+	 * @param key key for property
+	 * @param value Value for property
+	 */
+	public void setListProperty(final String key, final List<String> value) {
+		final StringBuilder val = new StringBuilder();
+		final String LF = "\n";
+		boolean first = true;
+		for (String bit : value) {
+			if (first) { first = false; } else { val.append(LF); }
+			val.append(bit);
+		}
+		setProperty(key, val.toString());
+	}
+}

src/com/dmdirc/addons/scriptplugin/plugin.config

@@ -0,0 +1,27 @@
+keysections:
+  metadata
+  version
+  updates
+  defaults
+
+metadata:
+  mainclass=com.dmdirc.addons.scriptplugin.ScriptPlugin
+  author=Shane <shane@dmdirc.com>
+  description=Allows using javascript scripts with DMDirc
+  name=script
+  nicename=Scripting Plugin
+
+version:
+  number=3
+  friendly=0.3
+
+updates:
+  id=33
+
+defaults:
+  eval.showStackTrace=false
+
+provides:
+  script command
+  scripting feature
+  javascript script