Core support for lines with arbitrary timestamps

Fixed echo command not respecting silence characters when using --target or
--active(!). Added --ts command to echo command to fake the timestamp.

mIRC tab completion and /echo --ts <tab> ftw.

Fixes issue 4090

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

src/com/dmdirc/FrameContainer.java

@@ -501,11 +501,13 @@ public abstract class FrameContainer<T extends Window> {
      * reason, the line is silently discarded.
      *
      * @param type The message type to use
+     * @param timestamp The timestamp to use for this line
      * @param args The message's arguments
+     * @since 0.6.4
      */
-    public void addLine(final String type, final Object ... args) {
+    public void addLine(final String type, final Date timestamp, final Object ... args) {
         if (type != null && !type.isEmpty()) {
-            addLine(Formatter.formatMessage(getConfigManager(), type, args), true);
+            addLine(Formatter.formatMessage(getConfigManager(), type, args), timestamp);
         }
     }
 
@@ -516,12 +518,36 @@ public abstract class FrameContainer<T extends Window> {
      * @param type The message type to use
      * @param args The message's arguments
      */
-    public void addLine(final StringBuffer type, final Object ... args) {
+    public void addLine(final String type, final Object ... args) {
+        addLine(type, new Date(), args);
+    }
+
+    /**
+     * Adds a line to this container's window. If the window is null for some
+     * reason, the line is silently discarded.
+     *
+     * @param type The message type to use
+     * @param timestamp The timestamp to use for this line
+     * @param args The message's arguments
+     * @since 0.6.4
+     */
+    public void addLine(final StringBuffer type, final Date timestamp, final Object ... args) {
         if (type != null) {
-            addLine(type.toString(), args);
+            addLine(type.toString(), timestamp, args);
         }
     }
 
+    /**
+     * Adds a line to this container's window. If the window is null for some
+     * reason, the line is silently discarded.
+     *
+     * @param type The message type to use
+     * @param args The message's arguments
+     */
+    public void addLine(final StringBuffer type, final Object ... args) {
+        addLine(type, new Date(), args);
+    }
+
     /**
      * Adds the specified raw line to the window, without using a formatter.
      *
@@ -529,12 +555,25 @@ public abstract class FrameContainer<T extends Window> {
      * @param timestamp Whether or not to display the timestamp for this line
      */
     public void addLine(final String line, final boolean timestamp) {
+        addLine(line, timestamp ? new Date() : null);
+    }
+
+    /**
+     * Adds the specified raw line to the window, without using a formatter,
+     * and using the specified timestamp. If the timestamp is <code>null</code>,
+     * no timestamp is added.
+     *
+     * @param line The line to be added
+     * @param timestamp The timestamp to use for the line
+     * @since 0.6.4
+     */
+    public void addLine(final String line, final Date timestamp) {
         final String encodedLine = transcoder.decode(line);
         final List<String[]> lines = new LinkedList<String[]>();
         for (final String myLine : encodedLine.split("\n")) {
-            if (timestamp) {
+            if (timestamp != null) {
                 lines.add(new String[]{
-                    Formatter.formatMessage(getConfigManager(), "timestamp", new Date()),
+                    Formatter.formatMessage(getConfigManager(), "timestamp", timestamp),
                     myLine,
                 });
             } else {

src/com/dmdirc/commandparser/commands/global/Echo.java

@@ -33,7 +33,7 @@ import com.dmdirc.ui.WindowManager;
 import com.dmdirc.ui.input.AdditionalTabTargets;
 
 import java.util.ArrayList;
-import java.util.Arrays;
+import java.util.Date;
 import java.util.List;
 
 /**
@@ -54,34 +54,51 @@ public final class Echo extends GlobalCommand implements IntelligentCommand {
 
     /** {@inheritDoc} */
     @Override
-    public void execute(final FrameContainer origin, final boolean isSilent,
+    public void execute(final FrameContainer<?> origin, final boolean isSilent,
             final CommandArguments args) {
-        if (args.getArguments().length > 0
-                && args.getArguments()[0].equalsIgnoreCase("--active")) {
-            final FrameContainer frame = WindowManager.getActiveWindow();
-            frame.addLine(FORMAT_OUTPUT, args.getArgumentsAsString(1));
-        } else if (args.getArguments().length > 1
-                && args.getArguments()[0].equalsIgnoreCase("--target")) {
-            FrameContainer frame = null;
-            FrameContainer target = origin;
+        int offset = 0;
+        Date time = new Date();
+
+        if (args.getArguments().length > 1
+                && args.getArguments()[offset].equalsIgnoreCase("--ts")) {
+            try {
+                time = new Date(Long.parseLong(args.getWordsAsString(2, 2)));
+            } catch (NumberFormatException ex) {
+                sendLine(origin, isSilent, FORMAT_ERROR, "Unable to process timestamp");
+                return;
+            }
+
+            offset = 2;
+        }
+
+        if (args.getArguments().length > offset
+                && args.getArguments()[offset].equalsIgnoreCase("--active")) {
+            if (!isSilent) {
+                final FrameContainer<?> frame = WindowManager.getActiveWindow();
+                frame.addLine(FORMAT_OUTPUT, time, args.getArgumentsAsString(offset + 1));
+            }
+        } else if (args.getArguments().length > offset + 1
+                && args.getArguments()[offset].equalsIgnoreCase("--target")) {
+            FrameContainer<?> frame = null;
+            FrameContainer<?> target = origin;
 
             while (frame == null && target != null) {
-                frame = WindowManager.findCustomWindow(target, args.getArguments()[1]);
+                frame = WindowManager.findCustomWindow(target, args.getArguments()[offset + 1]);
             }
 
             if (frame == null) {
-                frame = WindowManager.findCustomWindow(args.getArguments()[1]);
+                frame = WindowManager.findCustomWindow(args.getArguments()[offset + 1]);
             }
 
             if (frame == null) {
                 sendLine(origin, isSilent, FORMAT_ERROR,
                         "Unable to find target window");
-            } else {
-                frame.addLine(FORMAT_OUTPUT, args.getArgumentsAsString(2));
+            } else if (!isSilent) {
+                frame.addLine(FORMAT_OUTPUT, time, args.getArgumentsAsString(offset + 2));
             }
 
-        } else {
-            sendLine(origin, isSilent, FORMAT_OUTPUT, args.getArgumentsAsString());
+        } else if (origin != null && !isSilent) {
+            origin.addLine(FORMAT_OUTPUT, time, args.getArgumentsAsString(offset));
         }
     }
 
@@ -100,7 +117,7 @@ public final class Echo extends GlobalCommand implements IntelligentCommand {
     /** {@inheritDoc} */
     @Override
     public String getHelp() {
-        return "echo [--active|--target <window>] <line> "
+        return "echo [--ts <timestamp>] [--active|--target <window>] <line> "
                 + "- echos the specified line to the window";
     }
 
@@ -113,7 +130,10 @@ public final class Echo extends GlobalCommand implements IntelligentCommand {
         if (arg == 0) {
             targets.add("--active");
             targets.add("--target");
-        } else if (arg == 1 && context.getPreviousArgs().get(0).equals("--target")) {
+            targets.add("--ts");
+        } else if ((arg == 1 && context.getPreviousArgs().get(0).equals("--target"))
+                || (arg == 3 && context.getPreviousArgs().get(2).equals("--target")
+                && context.getPreviousArgs().get(0).equals("--ts"))) {
 
             final List<FrameContainer<?>> windowList = new ArrayList<FrameContainer<?>>();
             final Server currentServer = context.getWindow().getContainer()
@@ -135,6 +155,9 @@ public final class Echo extends GlobalCommand implements IntelligentCommand {
                 }
             }
 
+            targets.excludeAll();
+        } else if (arg == 1 && context.getPreviousArgs().get(0).equals("--ts")) {
+            targets.add(String.valueOf(new Date().getTime()));
             targets.excludeAll();
         }