Adds --timeout parameter to /osd command

Fixes issue CLIENT-49

Change-Id: If8c57a5270e08a7c7eaa330b836f34c5361454c7
Reviewed-on: http://gerrit.dmdirc.com/1620
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/addons/osd/OsdCommand.java

@@ -56,12 +56,14 @@ public final class OsdCommand extends Command implements
     /**
      * Used to show a notification using this plugin.
      *
+     * @param timeout Timeout for the OSD window. If negative then the value
+     * from the config will be used
      * @param title Title of dialog if applicable
      * @param message Message to show
      * @return True if the notification was shown.
      */
-    public boolean showOSD(final String title, final String message) {
-        osdManager.showWindow(Styliser.stipControlCodes(message));
+    public boolean showOSD(final int timeout, final String title, final String message) {
+        osdManager.showWindow(timeout, Styliser.stipControlCodes(message));
         return true;
     }
 
@@ -72,8 +74,26 @@ public final class OsdCommand extends Command implements
         if (args.getArguments().length > 0
                 && "--close".equalsIgnoreCase(args.getArguments()[0])) {
             osdManager.closeAll();
+        } else if (args.getArguments().length > 0
+                && "--timeout".equalsIgnoreCase(args.getArguments()[0])) {
+            if (args.getArguments().length < 2) {
+                sendLine(origin, args.isSilent(), FORMAT_ERROR, "You " +
+                        "must specify a valid number for the OSD timeout.");
+                return;
+            }
+
+            int timeout = 0;
+            try {
+                timeout = Integer.parseInt(args.getArguments()[1]);
+            } catch (NumberFormatException ex) {
+                sendLine(origin, args.isSilent(), FORMAT_ERROR, "You " +
+                        "must specify a valid number for the OSD timeout.");
+                return;
+            }
+
+            showOSD(timeout, null, args.getArgumentsAsString(2));
         } else {
-            showOSD(null, args.getArgumentsAsString());
+            showOSD(-1 , null, args.getArgumentsAsString());
         }
     }
     
@@ -99,7 +119,8 @@ public final class OsdCommand extends Command implements
     @Override
     public String getHelp() {
         return "osd --close - closes all OSD windows\n" +
-                "osd <message> - show the specified message in an OSD window";
+                "osd [--timer <delay in seconds>] <message> - show the specified" +
+                " message in an OSD window";
     }
 
     /** {@inheritDoc} */

src/com/dmdirc/addons/osd/OsdManager.java

@@ -43,7 +43,7 @@ public class OsdManager {
     /** List of OSD Windows. */
     private final List<OsdWindow> windowList = new ArrayList<OsdWindow>();
     /** List of messages to be queued. */
-    private final Queue<String> windowQueue = new LinkedList<String>();
+    private final Queue<QueuedMessage> windowQueue = new LinkedList<QueuedMessage>();
 
     /**
      * Create a new OSD Manager.
@@ -59,8 +59,8 @@ public class OsdManager {
      *
      * @param message Message to be displayed.
      */
-    public void showWindow(final String message) {
-        windowQueue.add(message);
+    public void showWindow(final int timeout, final String message) {
+        windowQueue.add(new QueuedMessage(timeout, message));
         displayWindows();
     }
 
@@ -71,11 +71,11 @@ public class OsdManager {
         final Integer maxWindows = IdentityManager.getGlobalConfig().
                 getOptionInt(plugin.getDomain(), "maxWindows", false);
 
-        String nextItem;
+        QueuedMessage nextItem;
 
         while ((maxWindows == null || getWindowCount() < maxWindows)
                 && (nextItem = windowQueue.poll()) != null) {
-            displayWindow(nextItem);
+            displayWindow(nextItem.getTimeout(), nextItem.getMessage());
         }
     }
 
@@ -90,7 +90,7 @@ public class OsdManager {
      * @see OsdPolicy#getYPosition(com.dmdirc.addons.osd.OsdManager, int)
      * @param message Text to display in the OSD window.
      */
-    private synchronized void displayWindow(final String message) {
+    private synchronized void displayWindow(final int timeout, final String message) {
         final OsdPolicy policy = OsdPolicy.valueOf(IdentityManager.
                 getGlobalConfig().getOption(plugin.getDomain(), "newbehaviour").
                 toUpperCase());
@@ -103,7 +103,7 @@ public class OsdManager {
             /** {@inheritDoc} */
             @Override
             public void run() {
-                setObject(new OsdWindow(message, false,
+                setObject(new OsdWindow(timeout, message, false,
                         IdentityManager.getGlobalConfig().getOptionInt(
                         plugin.getDomain(), "locationX"), policy.getYPosition(
                         OsdManager.this, startY), plugin, OsdManager.this));

src/com/dmdirc/addons/osd/OsdPlugin.java

@@ -146,7 +146,7 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
     /** {@inheritDoc} */
     @Override
     public void categorySelected(final PreferencesCategory category) {
-        osdWindow = new OsdWindow("Please drag this OSD to position", true, x, y, this, osdManager);
+        osdWindow = new OsdWindow(-1, "Please drag this OSD to position", true, x, y, this, osdManager);
         osdWindow.setBackgroundColour(backgroundSetting.getValue());
         osdWindow.setForegroundColour(foregroundSetting.getValue());
         osdWindow.setFontSize(Integer.parseInt(fontSizeSetting.getValue()));
@@ -203,7 +203,7 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
      * @param message Message to show
      */
     public void showOSD(final String title, final String message) {
-        osdManager.showWindow(message);
+        osdManager.showWindow(-1, message);
     }
 
 }

src/com/dmdirc/addons/osd/OsdWindow.java

@@ -84,23 +84,30 @@ public class OsdWindow extends JDialog implements MouseListener,
     /**
      * Creates a new instance of OsdWindow.
      *
+     * @param timeout Timeout period for the window. Set to -1 to use value from
+     *        config
      * @param text The text to be displayed in the OSD window
      * @param config Is the window being configured (should it timeout and
-     * allow itself to be moved)
+     *        allow itself to be moved)
      * @param x The x-axis position for the OSD Window
      * @param y The y-axis position for the OSD window
      * @param plugin Parent OSD Plugin
      * @param osdManager The manager that owns this OSD Window
      */
-    public OsdWindow(final String text, final boolean config, final int x,
+    public OsdWindow(final int timeout, final String text, final boolean config, final int x,
             final int y, final OsdPlugin plugin, final OsdManager osdManager) {
         super(((SwingController) PluginManager.getPluginManager()
                 .getPluginInfoByName("ui_swing").getPlugin()).getMainFrame(), false);
 
         this.config = config;
         this.osdManager = osdManager;
-        this.timeout = IdentityManager.getGlobalConfig()
-            .getOptionInt(osdManager.getPlugin().getDomain(), "timeout", false);
+
+        if (timeout < 0) {
+            this.timeout = IdentityManager.getGlobalConfig().getOptionInt(
+                    osdManager.getPlugin().getDomain(), "timeout", false);
+        } else {
+            this.timeout = timeout;
+        }
 
         setFocusableWindowState(false);
         setAlwaysOnTop(true);
@@ -141,7 +148,7 @@ public class OsdWindow extends JDialog implements MouseListener,
             addMouseListener(this);
         } else {
             addMouseListener(this);
-            if (timeout != null) {
+            if (this.timeout != null && this.timeout > 0) {
                 new Timer("OSD Display Timer").schedule(new TimerTask() {
 
                     /** {@inheritDoc} */
@@ -149,7 +156,7 @@ public class OsdWindow extends JDialog implements MouseListener,
                     public void run() {
                         osdManager.closeWindow(OsdWindow.this);
                     }
-                }, Math.max(timeout, 1) * 1000);
+                }, this.timeout * 1000);
             }
         }
     }

src/com/dmdirc/addons/osd/QueuedMessage.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2006-2010 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.osd;
+
+/**
+ * Class for storing OSD Window timeout values and messages for the window queue.
+ *
+ * @since 0.6.5
+ */
+public class QueuedMessage  {
+    /** Timeout delay in seconds. */
+    private final int timeout;
+
+    /** Message to display on the OSD. */
+    private final String message;
+
+    /**
+     * Creates a new instance of QueuedMessage.
+     *
+     * @param timeout Timeout for the OSD window in seconds
+     * @param message Message to display in the OSD
+     */
+    public QueuedMessage(final int timeout, final String message) {
+        this.timeout = timeout;
+        this.message = message;
+    }
+
+    /**
+     * Returns the timeout for this OSD window.
+     *
+     * @return Timeout in seconds
+     */
+    public int getTimeout() {
+        return timeout;
+    }
+
+    /**
+     * Returns the message for the OSD window.
+     *
+     * @return Message for the OSD window
+     */
+    public String getMessage() {
+        return message;
+    }
+}