Merge pull request #777 from ShaneMcC/displaywindowformat

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

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

@@ -0,0 +1,47 @@
+/*
+ * 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.
+ */
+@FunctionalInterface
+public interface DisplayLocation {
+    /** Event came from the same WindowModel. */
+    DisplayLocation SOURCE = (model, event) -> event.getSource().equals(model);
+
+    /** Event came from a WindowModel that shares the same connection. */
+    DisplayLocation SAME_CONNECTION = (model, event) -> event.getSource().getConnection().isPresent()
+            && model.getConnection().isPresent()
+            && event.getSource().getConnection().get().equals(model.getConnection().get());
+    /**
+     * 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.
+     */
+    boolean shouldDisplay(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/plugins/PluginEventFormatManager.java

@@ -21,11 +21,12 @@ import com.dmdirc.config.GlobalConfig;
 import com.dmdirc.events.PluginLoadedEvent;
 import com.dmdirc.events.PluginUnloadedEvent;
 import com.dmdirc.events.eventbus.EventBus;
-import com.dmdirc.util.system.SystemLifecycleComponent;
 import com.dmdirc.ui.messages.ColourManager;
 import com.dmdirc.ui.messages.EventFormatProvider;
 import com.dmdirc.ui.messages.MultiEventFormatProvider;
 import com.dmdirc.ui.messages.YamlEventFormatProvider;
+import com.dmdirc.ui.messages.DisplayLocationManager;
+import com.dmdirc.util.system.SystemLifecycleComponent;
 import net.engio.mbassy.listener.Handler;
 
 import javax.inject.Inject;
@@ -48,15 +49,18 @@ public class PluginEventFormatManager implements SystemLifecycleComponent {
     private final MultiEventFormatProvider multiEventFormatProvider;
     private final Map<PluginInfo, EventFormatProvider> providers = new HashMap<>();
     private final ColourManager colourManager;
+    private final DisplayLocationManager displayLocationManager;
 
     @Inject
     public PluginEventFormatManager(
             final EventBus eventbus,
             final MultiEventFormatProvider multiEventFormatProvider,
-            @GlobalConfig final ColourManager colourManager) {
+            @GlobalConfig final ColourManager colourManager,
+            final DisplayLocationManager displayLocationManager) {
         this.eventbus = eventbus;
         this.multiEventFormatProvider = multiEventFormatProvider;
         this.colourManager = colourManager;
+        this.displayLocationManager = displayLocationManager;
     }
 
     @Override
@@ -74,7 +78,7 @@ public class PluginEventFormatManager implements SystemLifecycleComponent {
         final Path path = event.getPlugin().getPath("/META-INF/format.yml");
         if (Files.exists(path)) {
             final YamlEventFormatProvider provider =
-                    new YamlEventFormatProvider(path, colourManager);
+                    new YamlEventFormatProvider(path, colourManager, displayLocationManager);
             provider.load();
             providers.put(event.getPlugin(), provider);
             multiEventFormatProvider.addProvider(provider);

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

@@ -17,6 +17,7 @@
 
 package com.dmdirc.ui.messages;
 
+import com.dmdirc.events.DisplayLocation;
 import com.dmdirc.events.DisplayProperty;
 import com.dmdirc.events.DisplayableEvent;
 import com.dmdirc.events.eventbus.EventBus;
@@ -85,7 +86,10 @@ 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.getEventFormatProvider().getFormat(event.getClass()).isPresent() ?
+                formatter.getEventFormatProvider().getFormat(event.getClass()).get().getDisplayProperties()
+                    .get(DisplayProperty.DISPLAY_LOCATION).orElse(DisplayLocation.SOURCE).shouldDisplay(owner, event)
+                        : DisplayLocation.SOURCE.shouldDisplay(owner, event))
                 && !event.hasDisplayProperty(DisplayProperty.DO_NOT_DISPLAY);
     }
 

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

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2006-2017 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.ui.messages;
+
+import com.dmdirc.events.DisplayLocation;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+
+@Singleton
+public class DisplayLocationManager {
+    private final Map<String, DisplayLocation> displayLocations = new HashMap<>();
+
+    @Inject
+    DisplayLocationManager() {
+        // Add Defaults
+        addDisplayLocation("source", DisplayLocation.SOURCE);
+        addDisplayLocation("sameconnection", DisplayLocation.SAME_CONNECTION);
+        addDisplayLocation("sameserver", DisplayLocation.SAME_CONNECTION);
+    }
+
+    public void addDisplayLocation(final String name, final DisplayLocation displayLocation) {
+        displayLocations.put(name.toLowerCase().replaceAll("[^a-z]", ""), displayLocation);
+    }
+
+    public Optional<DisplayLocation> getDisplayLocation(final String name) {
+        return Optional.ofNullable(displayLocations.get(name.toLowerCase().replaceAll("[^a-z]", "")));
+    }
+
+    public Set<String> getDisplayLocations() {
+        return displayLocations.keySet();
+    }
+}

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

@@ -155,4 +155,7 @@ public class EventFormatter {
         return res.toString();
     }
 
+    public EventFormatProvider getEventFormatProvider() {
+        return formatProvider;
+    }
 }

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

@@ -38,9 +38,10 @@ public class UiMessagesModule {
     @Singleton
     public MultiEventFormatProvider getTemplateProvider(
             @Directory(BASE) final Path directory,
-            @GlobalConfig final ColourManager colourManager) {
+            @GlobalConfig final ColourManager colourManager,
+            final DisplayLocationManager displayLocationManager) {
         final YamlEventFormatProvider yamlProvider =
-                new YamlEventFormatProvider(directory.resolve("format.yml"), colourManager);
+                new YamlEventFormatProvider(directory.resolve("format.yml"), colourManager, displayLocationManager);
         yamlProvider.load();
         return new MultiEventFormatProvider(yamlProvider);
     }

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

@@ -52,11 +52,14 @@ public class YamlEventFormatProvider implements EventFormatProvider {
 
     private final Path path;
     private final ColourManager colourManager;
+    private final DisplayLocationManager displayLocationManager;
     private final Map<String, EventFormat> formats = new HashMap<>();
 
-    public YamlEventFormatProvider(final Path path, final ColourManager colourManager) {
+    public YamlEventFormatProvider(final Path path, final ColourManager colourManager,
+                                   final DisplayLocationManager displayLocationManager) {
         this.path = path;
         this.colourManager = colourManager;
+        this.displayLocationManager = displayLocationManager;
     }
 
     public void load() {
@@ -120,6 +123,16 @@ 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, displayLocationManager.getDisplayLocation(
+                        info.get("displaywindow").toString()).orElseThrow(() -> new IllegalArgumentException()));
+            } catch (final IllegalArgumentException iae) {
+                LOG.info(USER_ERROR, "Invalid displaywindow specified for: {}.\nValid values are: {}",
+                        info.get("displaywindow").toString(),
+                        displayLocationManager.getDisplayLocations().toString());
+            }
+        }
         return map;
     }