Allow specifying a window for DisplayableEvents in format.yml (Issue #459)

I'm sure this will be changed/redone, but this is at least a start by allowing
certain events to go to all windows (eg ServerNotices)

Ideally it would be possible for some events to only be displayed in the window
that generated them (eg if I do /notice foo bar the ">-{{target}}-> {{message}}"
message only appears in the window I ran the command in, not either just the
server window or all the windows, but this would need changes to a bunch of
events to make them include a source window.

api/src/main/java/com/dmdirc/events/DisplayLocation.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.interfaces.WindowModel;
+
+/**
+ * Valid values for the DISPLAY_LOCATION property and how to test for them.
+ */
+public enum DisplayLocation {
+    /** Event came from the same WindowModel. */
+    SOURCE((model, event) -> event.getSource().equals(model)),
+
+    /** Event came from a WindowModel that shares the same connection. */
+    SAMECONNECTION((model, event) -> event.getSource().getConnection().isPresent()
+            && model.getConnection().isPresent()
+            && event.getSource().getConnection().get().equals(model.getConnection().get())),
+
+    /** Alias for SAMECONNECTION. */
+    SAMESERVER((model, event) -> SAMECONNECTION.shouldDisplay(model, event));
+
+    /** Function to test this DisplayLocation. */
+    private DisplayLocationTester locationTester;
+
+    /**
+     * Create a new DisplayLocation
+     *
+     * @param test Test function to run to see if this location is valid.
+     */
+    DisplayLocation(final DisplayLocationTester test) {
+        locationTester = test;
+    }
+
+    /**
+     * Test to see if this location is valid.
+     *
+     * @param model WindowModel we are wanting to display the event in.
+     * @param event Event we are wanting to display.
+     * @return True if the event should be displayed here.
+     */
+    public boolean shouldDisplay(final WindowModel model, final DisplayableEvent event) {
+        return locationTester.test(model, event);
+    }
+
+    interface DisplayLocationTester {
+        public boolean test(final WindowModel model, final DisplayableEvent event);
+    }
+};

api/src/main/java/com/dmdirc/events/DisplayProperty.java

@@ -39,6 +39,8 @@ public interface DisplayProperty<T> {
     DisplayProperty<Boolean> DO_NOT_DISPLAY = new DisplayPropertyImpl<>();
     /** Whether to suppress timestamps for the event. */
     DisplayProperty<Boolean> NO_TIMESTAMPS = new DisplayPropertyImpl<>();
+    /** Where the event should be displayed. */
+    DisplayProperty<DisplayLocation> DISPLAY_LOCATION = new DisplayPropertyImpl<>();
     /** A user that the displayable is linked to. */
     DisplayProperty<User> LINK_USER = new DisplayPropertyImpl<>();
 

src/main/java/com/dmdirc/ui/messages/BackBufferImpl.java

@@ -17,7 +17,9 @@
 
 package com.dmdirc.ui.messages;
 
+import com.dmdirc.events.DisplayLocation;
 import com.dmdirc.events.DisplayProperty;
+import com.dmdirc.events.DisplayPropertyMap;
 import com.dmdirc.events.DisplayableEvent;
 import com.dmdirc.events.eventbus.EventBus;
 import com.dmdirc.interfaces.WindowModel;
@@ -85,7 +87,8 @@ public class BackBufferImpl implements BackBuffer {
      * @return True if the event should be displayed, false otherwise.
      */
     private boolean shouldDisplay(final DisplayableEvent event) {
-        return event.getSource().equals(owner)
+        return formatter.getFormatDisplayableProperties(event).get(DisplayProperty.DISPLAY_LOCATION)
+                    .orElse(DisplayLocation.SOURCE).shouldDisplay(owner, event)
                 && !event.hasDisplayProperty(DisplayProperty.DO_NOT_DISPLAY);
     }
 

src/main/java/com/dmdirc/ui/messages/EventFormatter.java

@@ -155,4 +155,15 @@ public class EventFormatter {
         return res.toString();
     }
 
+    /**
+     * Get the displayable properties map for this event according to the formatter.
+     *
+     * @param event Event to get properties for.
+     * @return DisplayPropertyMap from formatter.
+     */
+    public DisplayPropertyMap getFormatDisplayableProperties(final DisplayableEvent event) {
+        return formatProvider.getFormat(event.getClass()).isPresent()
+                ? formatProvider.getFormat(event.getClass()).get().getDisplayProperties()
+                : event.getDisplayProperties();
+    }
 }

src/main/java/com/dmdirc/ui/messages/YamlEventFormatProvider.java

@@ -17,6 +17,7 @@
 
 package com.dmdirc.ui.messages;
 
+import com.dmdirc.events.DisplayLocation;
 import com.dmdirc.events.DisplayProperty;
 import com.dmdirc.events.DisplayPropertyMap;
 import com.dmdirc.events.DisplayableEvent;
@@ -27,6 +28,7 @@ import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
@@ -120,6 +122,15 @@ public class YamlEventFormatProvider implements EventFormatProvider {
             map.put(DisplayProperty.NO_TIMESTAMPS,
                     !info.get("timestamp").toString().toLowerCase().matches("y|yes|true|1|on"));
         }
+        if (info.containsKey("displaywindow")) {
+            try {
+                map.put(DisplayProperty.DISPLAY_LOCATION,
+                        DisplayLocation.valueOf(info.get("displaywindow").toString().toUpperCase()));
+            } catch (final IllegalArgumentException iae) {
+                LOG.info(USER_ERROR, "Invalid displaywindow specified for: {}.\nValid values are: {}",
+                        info.get("displaywindow").toString(), Arrays.toString(DisplayLocation.values()));
+            }
+        }
         return map;
     }