Merge pull request #18 from PatchworkMC/feature/networking

Patchwork Networking, Part 1

Author: coderbot16

checkstyle.xml

@@ -170,5 +170,11 @@
 		<module name="AtclauseOrder">
 			<property name="tagOrder" value="@param,@return,@throws,@deprecated"/>
 		</module>
+        <!--Some checks are broken (*ahem* lambda returns)-->
+        <module name="SuppressionCommentFilter">
+            <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
+            <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
+            <property name="checkFormat" value="$1"/>
+        </module>
 	</module>
 </module>

patchwork-fml/src/main/java/com/patchworkmc/impl/fml/PatchworkFML.java

@@ -0,0 +1,34 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2019, 2019
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package com.patchworkmc.impl.fml;
+
+import net.minecraftforge.fml.LogicalSidedProvider;
+
+import net.fabricmc.api.ModInitializer;
+import net.fabricmc.fabric.api.event.server.ServerStartCallback;
+import net.fabricmc.fabric.api.event.server.ServerStopCallback;
+
+public class PatchworkFML implements ModInitializer {
+	@Override
+	public void onInitialize() {
+		ServerStartCallback.EVENT.register(server -> LogicalSidedProvider.setServer(() -> server));
+		ServerStopCallback.EVENT.register(server -> LogicalSidedProvider.setServer(null));
+	}
+}

patchwork-fml/src/main/java/net/minecraftforge/fml/LogicalSidedProvider.java

@@ -0,0 +1,72 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2019, 2019
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.fml;
+
+import java.util.Optional;
+import java.util.function.Function;
+import java.util.function.Supplier;
+
+import net.minecraft.client.MinecraftClient;
+import net.minecraft.server.MinecraftServer;
+import net.minecraft.world.World;
+
+import net.fabricmc.api.EnvType;
+import net.fabricmc.loader.api.FabricLoader;
+
+import com.patchworkmc.impl.fml.PatchworkFML;
+
+public enum LogicalSidedProvider {
+	WORKQUEUE(Supplier::get, Supplier::get),
+	INSTANCE(Supplier::get, Supplier::get),
+	/**
+	 * @deprecated "this is pretty dubious" - coderbot
+	 */
+	@Deprecated
+	CLIENTWORLD(c -> Optional.<World>of(c.get().world), s -> Optional.<World>empty());
+	private static Supplier<MinecraftClient> client;
+	private static Supplier<MinecraftServer> server;
+
+	// Patchwork: since the client never changes we can just set it directly
+	static {
+		if (FabricLoader.getInstance().getEnvironmentType().equals(EnvType.CLIENT)) {
+			client = () -> (MinecraftClient) FabricLoader.getInstance().getGameInstance();
+		}
+	}
+
+	private final Function<Supplier<MinecraftClient>, ?> clientSide;
+	private final Function<Supplier<MinecraftServer>, ?> serverSide;
+
+	LogicalSidedProvider(Function<Supplier<MinecraftClient>, ?> clientSide, Function<Supplier<MinecraftServer>, ?> serverSide) {
+		this.clientSide = clientSide;
+		this.serverSide = serverSide;
+	}
+
+	/**
+	 * Called by callbacks registered in {@link PatchworkFML}.
+	 */
+	public static void setServer(Supplier<MinecraftServer> server) {
+		LogicalSidedProvider.server = server;
+	}
+
+	@SuppressWarnings("unchecked")
+	public <T> T get(final LogicalSide side) {
+		return (T) (side == LogicalSide.CLIENT ? clientSide.apply(client) : serverSide.apply(server));
+	}
+}

patchwork-fml/src/main/resources/fabric.mod.json

@@ -15,6 +15,11 @@
   "depends": {
     "fabricloader": ">=0.6.2"
   },
+  "entrypoints": {
+    "main": [
+      "com.patchworkmc.impl.fml.PatchworkFML"
+    ]
+  },
   "description": "Implementation of FML's mod-facing interface.",
   "custom": {
     "modmenu:api": true,

patchwork-networking/build.gradle

@@ -0,0 +1,6 @@
+archivesBaseName = "patchwork-networking"
+version = getSubprojectVersion(project, "0.1.0")
+
+dependencies {
+	compile project(path: ':patchwork-fml', configuration: 'dev')
+}

patchwork-networking/src/main/java/com/patchworkmc/impl/networking/ListenableChannel.java

@@ -0,0 +1,34 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2019, 2019
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package com.patchworkmc.impl.networking;
+
+import java.util.List;
+import java.util.function.BiConsumer;
+import java.util.function.Consumer;
+
+import net.minecraftforge.fml.network.ICustomPacket;
+import net.minecraftforge.fml.network.NetworkEvent;
+import net.minecraftforge.fml.network.NetworkRegistry;
+
+public interface ListenableChannel {
+	void setPacketListener(BiConsumer<ICustomPacket<?>, NetworkEvent.Context> listener);
+	void setRegistrationChangeListener(Consumer<NetworkEvent.ChannelRegistrationChangeEvent> listener);
+	void setGatherLoginPayloadsListener(BiConsumer<List<NetworkRegistry.LoginPayload>, Boolean> listener);
+}

patchwork-networking/src/main/java/com/patchworkmc/impl/networking/NamedChannel.java

@@ -0,0 +1,26 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2019, 2019
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package com.patchworkmc.impl.networking;
+
+import net.minecraft.util.Identifier;
+
+public interface NamedChannel {
+	Identifier getChannelName();
+}

patchwork-networking/src/main/java/com/patchworkmc/impl/networking/NetworkChannel.java

@@ -0,0 +1,104 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2019, 2019
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package com.patchworkmc.impl.networking;
+
+import java.util.List;
+import java.util.function.BiConsumer;
+import java.util.function.Consumer;
+import java.util.function.Predicate;
+import java.util.function.Supplier;
+
+import net.minecraftforge.fml.network.ICustomPacket;
+import net.minecraftforge.fml.network.NetworkEvent;
+import net.minecraftforge.fml.network.NetworkRegistry;
+
+import net.minecraft.util.Identifier;
+
+public class NetworkChannel implements NamedChannel, ListenableChannel, VersionedChannel {
+	private final Identifier name;
+
+	private BiConsumer<ICustomPacket<?>, NetworkEvent.Context> packetListener;
+	private Consumer<NetworkEvent.ChannelRegistrationChangeEvent> registrationChangeListener;
+	private BiConsumer<List<NetworkRegistry.LoginPayload>, Boolean> gatherLoginPayloadsListener;
+
+	private final String networkProtocolVersion;
+	private final Predicate<String> clientAcceptedVersions;
+	private final Predicate<String> serverAcceptedVersions;
+
+	public NetworkChannel(Identifier name, Supplier<String> networkProtocolVersion, Predicate<String> clientAcceptedVersions, Predicate<String> serverAcceptedVersions) {
+		this.name = name;
+		this.networkProtocolVersion = networkProtocolVersion.get();
+		this.clientAcceptedVersions = clientAcceptedVersions;
+		this.serverAcceptedVersions = serverAcceptedVersions;
+	}
+
+	@Override
+	public Identifier getChannelName() {
+		return name;
+	}
+
+	@Override
+	public void setPacketListener(BiConsumer<ICustomPacket<?>, NetworkEvent.Context> listener) {
+		this.packetListener = listener;
+	}
+
+	@Override
+	public void setRegistrationChangeListener(Consumer<NetworkEvent.ChannelRegistrationChangeEvent> listener) {
+		this.registrationChangeListener = listener;
+	}
+
+	@Override
+	public void setGatherLoginPayloadsListener(BiConsumer<List<NetworkRegistry.LoginPayload>, Boolean> listener) {
+		this.gatherLoginPayloadsListener = listener;
+	}
+
+	public void onPacket(ICustomPacket<?> packet, NetworkEvent.Context context) {
+		if (packetListener != null) {
+			packetListener.accept(packet, context);
+		}
+	}
+
+	public void onRegistrationChange(NetworkEvent.ChannelRegistrationChangeEvent event) {
+		if (registrationChangeListener != null) {
+			registrationChangeListener.accept(event);
+		}
+	}
+
+	public void onGatherLoginPayloads(List<NetworkRegistry.LoginPayload> payloads, boolean isLocal) {
+		if (gatherLoginPayloadsListener != null) {
+			gatherLoginPayloadsListener.accept(payloads, isLocal);
+		}
+	}
+
+	@Override
+	public String getNetworkProtocolVersion() {
+		return networkProtocolVersion;
+	}
+
+	@Override
+	public boolean tryServerVersionOnClient(final String serverVersion) {
+		return this.clientAcceptedVersions.test(serverVersion);
+	}
+
+	@Override
+	public boolean tryClientVersionOnServer(final String clientVersion) {
+		return this.serverAcceptedVersions.test(clientVersion);
+	}
+}