Exec command plugin

Fixes issue CLIENT-223

Change-Id: I0a25c94b05e364b483227a11311e26238b5a0d78
Reviewed-on: http://gerrit.dmdirc.com/1891
Reviewed-by: Shane Mc Cormack <shane@dmdirc.com>
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>

src/com/dmdirc/addons/exec/ExecCommand.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes,
+ * Simon Mott
+ *
+ * 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.exec;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.logger.Logger;
+import com.dmdirc.util.StreamReader;
+import com.dmdirc.util.CommandUtils;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.LinkedList;
+import java.util.List;
+
+/**
+ * A command which allows users execute scripts.
+ */
+public class ExecCommand extends Command {
+
+    /** {@inheritDoc} */
+    @Override
+    public void execute(final FrameContainer origin,
+            final CommandArguments args, final CommandContext context) {
+        final String[] commandArray = CommandUtils.parseArguments(
+                args.getArgumentsAsString());
+
+        try {
+            // This checks the command to execute has correct quotes
+            // (if necessary). Without this /exec "command arg1 arg2 would error.
+            if (commandArray.length == 0) {
+                sendLine(origin, args.isSilent(), FORMAT_ERROR,
+                       "Could not execute: Invalid file name provided");
+            } else if (!new File(commandArray[0]).exists()) {
+                sendLine(origin, args.isSilent(), FORMAT_ERROR,
+                       "Could not execute: " + commandArray[0] + " does not exist.");
+            } else {
+                final Process p = Runtime.getRuntime().exec(commandArray);
+                final List<String> execOutput = args.isSilent()
+                        ? null : new LinkedList<String>();
+                final List<String> errorOutput = args.isSilent()
+                        ? null : new LinkedList<String>();
+                final StreamReader inputReader = new StreamReader(
+                            p.getInputStream(), execOutput);
+                final StreamReader errorReader = new StreamReader(
+                            p.getErrorStream(), errorOutput);
+
+                inputReader.run();
+                errorReader.run();
+                if (!args.isSilent()) {
+                    for (String line : execOutput) {
+                        sendLine(origin, args.isSilent(), FORMAT_OUTPUT, line);
+                    }
+                    for (String line : errorOutput) {
+                        sendLine(origin, args.isSilent(), FORMAT_ERROR, line);
+                    }
+                }
+            }
+        } catch (IOException ex) {
+            Logger.userError(ErrorLevel.LOW, "Unable to run application: "
+                    + ex.getMessage(), ex);
+        }
+    }
+}

src/com/dmdirc/addons/exec/ExecCommandInfo.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes,
+ * Simon Mott
+ *
+ * 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.exec;
+
+import com.dmdirc.commandparser.CommandInfo;
+import com.dmdirc.commandparser.CommandType;
+
+/**
+ * Exec command info.
+ */
+public class ExecCommandInfo implements CommandInfo {
+
+    /** {@inheritDoc} */
+    @Override
+    public String getName() {
+        return "exec";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean showInHelp() {
+        return true;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getHelp() {
+        return "exec <command> [<parameters>] - Executes an external program "
+                + "and displays the output";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public CommandType getType() {
+        return CommandType.TYPE_GLOBAL;
+    }
+}

src/com/dmdirc/addons/exec/ExecPlugin.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes,
+ * Simon Mott
+ *
+ * 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.exec;
+
+import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.plugins.Plugin;
+
+/**
+ * A plugin which provides an execute command.
+ */
+public class ExecPlugin extends Plugin {
+
+    /** The command we register when loaded. */
+    private final ExecCommand command = new ExecCommand();
+    /** The CommandInfo object describing the exec command. */
+    private final ExecCommandInfo commandInfo = new ExecCommandInfo();
+
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        CommandManager.registerCommand(command, commandInfo);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        CommandManager.unregisterCommand(commandInfo);
+    }
+
+}

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

@@ -0,0 +1,25 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  updates
+  version
+
+metadata:
+  author=Simon <simon@dmdirc.com>
+  mainclass=com.dmdirc.addons.exec.ExecPlugin
+  description=Executes commands
+  name=exec
+  nicename=Exec Plugin
+
+updates:
+  id=65
+
+version:
+  friendly=0.1
+
+provides:
+  exec command