keyremapping: add option to block extra mouse buttons

runelite-client/src/main/java/net/runelite/client/plugins/keyremapping/KeyRemappingConfig.java

@@ -241,4 +241,15 @@ public interface KeyRemappingConfig extends Config
 	{
 		return new ModifierlessKeybind(KeyEvent.VK_ESCAPE, 0);
 	}
+
+	@ConfigItem(
+		position = 20,
+		keyName = "consumeExtraMouseButtons",
+		name = "Block extra mouse buttons",
+		description = "Blocks mouse buttons 4 and 5"
+	)
+	default boolean consumeExtraMouseButtons()
+	{
+		return false;
+	}
 }

runelite-client/src/main/java/net/runelite/client/plugins/keyremapping/KeyRemappingListener.java

@@ -27,6 +27,7 @@ package net.runelite.client.plugins.keyremapping;
 
 import com.google.common.base.Strings;
 import java.awt.event.KeyEvent;
+import java.awt.event.MouseEvent;
 import java.util.HashMap;
 import java.util.Map;
 import javax.inject.Inject;
@@ -39,6 +40,8 @@ import net.runelite.client.input.MouseAdapter;
 
 class KeyRemappingListener extends MouseAdapter implements KeyListener
 {
+	// Button numbers greater than BUTTON3 have no constant identifier
+	private static final int MOUSE_BUTTON_4 = 4;
 
 	@Inject
 	private KeyRemappingPlugin plugin;
@@ -307,4 +310,32 @@ class KeyRemappingListener extends MouseAdapter implements KeyListener
 			}
 		}
 	}
+
+	@Override
+	public MouseEvent mouseClicked(MouseEvent mouseEvent)
+	{
+		return consumeMouseEvent(mouseEvent);
+	}
+
+	@Override
+	public MouseEvent mousePressed(MouseEvent mouseEvent)
+	{
+		return consumeMouseEvent(mouseEvent);
+	}
+
+	@Override
+	public MouseEvent mouseReleased(MouseEvent mouseEvent)
+	{
+		return consumeMouseEvent(mouseEvent);
+	}
+
+	private MouseEvent consumeMouseEvent(MouseEvent mouseEvent)
+	{
+		int button = mouseEvent.getButton();
+		if (button >= MOUSE_BUTTON_4 && config.consumeExtraMouseButtons())
+		{
+			mouseEvent.consume();
+		}
+		return mouseEvent;
+	}
 }

runelite-client/src/main/java/net/runelite/client/plugins/keyremapping/KeyRemappingPlugin.java

@@ -43,6 +43,7 @@ import net.runelite.client.callback.ClientThread;
 import net.runelite.client.config.ConfigManager;
 import net.runelite.client.eventbus.Subscribe;
 import net.runelite.client.input.KeyManager;
+import net.runelite.client.input.MouseManager;
 import net.runelite.client.plugins.Plugin;
 import net.runelite.client.plugins.PluginDescriptor;
 import net.runelite.client.ui.JagexColors;
@@ -69,6 +70,9 @@ public class KeyRemappingPlugin extends Plugin
 	@Inject
 	private KeyManager keyManager;
 
+	@Inject
+	private MouseManager mouseManager;
+
 	@Inject
 	private KeyRemappingListener inputListener;
 
@@ -81,6 +85,7 @@ public class KeyRemappingPlugin extends Plugin
 	{
 		typing = false;
 		keyManager.registerKeyListener(inputListener);
+		mouseManager.registerMouseListener(inputListener);
 
 		clientThread.invoke(() ->
 		{
@@ -104,6 +109,7 @@ public class KeyRemappingPlugin extends Plugin
 			}
 		});
 
+		mouseManager.unregisterMouseListener(inputListener);
 		keyManager.unregisterKeyListener(inputListener);
 	}
 

runelite-client/src/test/java/net/runelite/client/plugins/keyremapping/KeyRemappingListenerTest.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2020, Adam <Adam@sigterm.info>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package net.runelite.client.plugins.keyremapping;
+
+import com.google.inject.Guice;
+import com.google.inject.testing.fieldbinder.Bind;
+import com.google.inject.testing.fieldbinder.BoundFieldModule;
+import java.awt.event.MouseEvent;
+import javax.inject.Inject;
+import net.runelite.api.Client;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import org.mockito.junit.MockitoJUnitRunner;
+
+@RunWith(MockitoJUnitRunner.class)
+public class KeyRemappingListenerTest
+{
+	@Inject
+	private KeyRemappingListener keyRemappingListener;
+
+	@Mock
+	@Bind
+	private Client client;
+
+	@Mock
+	@Bind
+	private KeyRemappingConfig keyRemappingConfig;
+
+	@Before
+	public void setUp()
+	{
+		Guice.createInjector(BoundFieldModule.of(this)).injectMembers(this);
+	}
+
+	@Test
+	public void testMouseClicked()
+	{
+		when(keyRemappingConfig.consumeExtraMouseButtons()).thenReturn(true);
+		MouseEvent mouseEvent = mock(MouseEvent.class);
+		when(mouseEvent.getButton()).thenReturn(4);
+		keyRemappingListener.mousePressed(mouseEvent);
+		verify(mouseEvent).consume();
+
+		mouseEvent = mock(MouseEvent.class);
+		when(mouseEvent.getButton()).thenReturn(1);
+		keyRemappingListener.mousePressed(mouseEvent);
+		verify(mouseEvent, never()).consume();
+	}
+}