From 15acbc8f230dd2c4ba394960cdcc12a22a831bbf Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Wed, 14 Nov 2018 01:36:43 -0500 Subject: patch GalaxyNetServer to support context sync pending game code changes to make it public (#480) --- src/SMAPI/Framework/Networking/SGalaxyNetServer.cs | 96 ------------------- src/SMAPI/Framework/SCore.cs | 3 +- src/SMAPI/Framework/SMultiplayer.cs | 10 +- src/SMAPI/Patches/GalaxyNetServerPatch.cs | 106 +++++++++++++++++++++ src/SMAPI/StardewModdingAPI.csproj | 2 +- 5 files changed, 114 insertions(+), 103 deletions(-) delete mode 100644 src/SMAPI/Framework/Networking/SGalaxyNetServer.cs create mode 100644 src/SMAPI/Patches/GalaxyNetServerPatch.cs (limited to 'src') diff --git a/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs b/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs deleted file mode 100644 index 99eae8ad..00000000 --- a/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs +++ /dev/null @@ -1,96 +0,0 @@ -using System; -using System.IO; -using Galaxy.Api; -using StardewModdingAPI.Framework.Reflection; -using StardewValley; -using StardewValley.Network; -using StardewValley.SDKs; - -namespace StardewModdingAPI.Framework.Networking -{ - /// A multiplayer server used to connect to an incoming player. This is an implementation of that adds support for SMAPI's metadata context exchange. - internal class SGalaxyNetServer : GalaxyNetServer - { - /********* - ** Properties - *********/ - /// A callback to raise when receiving a message. This receives the incoming message, a method to send a message, and a callback to run the default logic. - private readonly Action, Action> OnProcessingMessage; - - /// The peer connections. - private readonly Bimap Peers; - - /// The underlying net server. - private readonly IReflectedField Server; - - /// The underlying method which handles incoming connections. - private readonly Action BaseReceiveConnection; - - /// The underlying method which handles incoming disconnections. - private readonly Action BaseReceiveDisconnect; - - /// The underlying method which handles incoming errors. - private readonly Action BaseReceiveError; - - - /********* - ** Public methods - *********/ - /// Construct an instance. - /// The underlying game server. - /// Simplifies access to private code. - /// A callback to raise when receiving a message. This receives the incoming message, a method to send a message, and a callback to run the default logic. - public SGalaxyNetServer(IGameServer gameServer, Reflector reflection, Action, Action> onProcessingMessage) - : base(gameServer) - { - this.OnProcessingMessage = onProcessingMessage; - this.Peers = reflection.GetField>(this, "peers").GetValue(); - this.Server = reflection.GetField(this, "server"); - - this.BaseReceiveConnection = (Action)Delegate.CreateDelegate(typeof(Action), this, reflection.GetMethod(this, "onReceiveConnection").MethodInfo); - this.BaseReceiveDisconnect = (Action)Delegate.CreateDelegate(typeof(Action), this, reflection.GetMethod(this, "onReceiveDisconnect").MethodInfo); - this.BaseReceiveError = (Action)Delegate.CreateDelegate(typeof(Action), this, reflection.GetMethod(this, "onReceiveError").MethodInfo); - } - - /// Receive and process messages from the client. - public override void receiveMessages() - { - GalaxySocket server = this.Server.GetValue(); - if (server == null) - return; - - server.Receive(this.BaseReceiveConnection, this.OnReceiveMessage, this.BaseReceiveDisconnect, this.BaseReceiveError); - server.Heartbeat(server.LobbyMembers()); - foreach (GalaxyID connection in server.Connections) - { - if (server.GetPingWith(connection) > 30000L) - server.Kick(connection); - } - } - - /// Read and process a message from the client. - /// The Galaxy peer ID. - /// The data to process. - private void OnReceiveMessage(GalaxyID peerID, Stream data) - { - using (IncomingMessage message = new IncomingMessage()) - using (BinaryReader reader = new BinaryReader(data)) - { - message.Read(reader); - this.OnProcessingMessage(message, outgoing => this.sendMessage(peerID, outgoing), () => - { - if (this.Peers.ContainsLeft(message.FarmerID) && (long)this.Peers[message.FarmerID] == (long)peerID.ToUint64()) - { - this.gameServer.processIncomingMessage(message); - } - else if (message.MessageType == Multiplayer.playerIntroduction) - { - NetFarmerRoot farmer = Game1.multiplayer.readFarmer(message.Reader); - GalaxyID capturedPeer = new GalaxyID(peerID.ToUint64()); - this.gameServer.checkFarmhandRequest(Convert.ToString(peerID.ToUint64()), farmer, msg => this.sendMessage(capturedPeer, msg), () => this.Peers[farmer.Value.UniqueMultiplayerID] = capturedPeer.ToUint64()); - } - }); - } - } - } -} diff --git a/src/SMAPI/Framework/SCore.cs b/src/SMAPI/Framework/SCore.cs index 890058b0..6ad118ce 100644 --- a/src/SMAPI/Framework/SCore.cs +++ b/src/SMAPI/Framework/SCore.cs @@ -170,7 +170,8 @@ namespace StardewModdingAPI.Framework // apply game patches new GamePatcher(this.Monitor).Apply( new DialogueErrorPatch(this.MonitorForGame, this.Reflection), - new LidgrenServerPatch() + new LidgrenServerPatch(), + new GalaxyNetServerPatch(() => this.GameInstance.Multiplayer) ); } diff --git a/src/SMAPI/Framework/SMultiplayer.cs b/src/SMAPI/Framework/SMultiplayer.cs index 5a8aa3e5..1777a261 100644 --- a/src/SMAPI/Framework/SMultiplayer.cs +++ b/src/SMAPI/Framework/SMultiplayer.cs @@ -138,11 +138,11 @@ namespace StardewModdingAPI.Framework return new SLidgrenServer(gameServer, this.Reflection, this.readFarmer, this.OnServerProcessingMessage); } - case GalaxyNetServer _: - { - IGameServer gameServer = this.Reflection.GetField(server, "gameServer").GetValue(); - return new SGalaxyNetServer(gameServer, this.Reflection, this.OnServerProcessingMessage); - } + //case GalaxyNetServer _: + // { + // IGameServer gameServer = this.Reflection.GetField(server, "gameServer").GetValue(); + // return new SGalaxyNetServer(gameServer, this.Reflection, this.OnServerProcessingMessage); + // } default: return server; diff --git a/src/SMAPI/Patches/GalaxyNetServerPatch.cs b/src/SMAPI/Patches/GalaxyNetServerPatch.cs new file mode 100644 index 00000000..e01ac329 --- /dev/null +++ b/src/SMAPI/Patches/GalaxyNetServerPatch.cs @@ -0,0 +1,106 @@ +using System; +using System.Diagnostics.CodeAnalysis; +using System.IO; +using System.Reflection; +using Galaxy.Api; +using Harmony; +using StardewModdingAPI.Framework; +using StardewModdingAPI.Framework.Patching; +using StardewValley.Network; + +namespace StardewModdingAPI.Patches +{ + /// A Harmony patch to let SMAPI override methods. + internal class GalaxyNetServerPatch : IHarmonyPatch + { + /********* + ** Properties + *********/ + /// SMAPI's implementation of the game's core multiplayer logic. + private static Lazy Multiplayer; + + /// The name of the internal GalaxyNetServer class. + private static readonly string ServerTypeName = $"StardewValley.SDKs.GalaxyNetServer, {Constants.GameAssemblyName}"; + + /// The method which sends an arbitrary message. + private static MethodInfo SendMessageMethod; + + + /********* + ** Accessors + *********/ + /// A unique name for this patch. + public string Name => $"{nameof(GalaxyNetServerPatch)}"; + + + /********* + ** Public methods + *********/ + /// Construct an instance. + /// SMAPI's implementation of the game's core multiplayer logic. + public GalaxyNetServerPatch(Func multiplayer) + { + // init + GalaxyNetServerPatch.Multiplayer = new Lazy(multiplayer); + + // get server.sendMessage method + Type type = Type.GetType(GalaxyNetServerPatch.ServerTypeName); + if (type == null) + throw new InvalidOperationException($"Can't find type '{GalaxyNetServerPatch.ServerTypeName}'."); + GalaxyNetServerPatch.SendMessageMethod = type.GetMethod("sendMessage", BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic, null, new[] { typeof(GalaxyID), typeof(OutgoingMessage) }, null); + if (GalaxyNetServerPatch.SendMessageMethod == null) + throw new InvalidOperationException($"Can't find method 'sendMessage' on '{GalaxyNetServerPatch.ServerTypeName}'."); + } + + /// Apply the Harmony patch. + /// The Harmony instance. + public void Apply(HarmonyInstance harmony) + { + // override parseDataMessageFromClient + { + MethodInfo method = AccessTools.Method(Type.GetType($"StardewValley.SDKs.GalaxyNetServer, {Constants.GameAssemblyName}"), "onReceiveMessage"); + MethodInfo prefix = AccessTools.Method(this.GetType(), nameof(GalaxyNetServerPatch.Prefix_GalaxyNetServer_OnReceiveMessage)); + harmony.Patch(method, new HarmonyMethod(prefix), null); + } + } + + + /********* + ** Private methods + *********/ + /// The method to call instead of the method. + /// The instance being patched. + /// The Galaxy peer ID. + /// The data to process. + /// The private peers field on the instance. + /// The private gameServer field on the instance. + /// Returns whether to execute the original method. + /// This method must be static for Harmony to work correctly. See the Harmony documentation before renaming arguments. + [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "Argument names are defined by Harmony.")] + private static bool Prefix_GalaxyNetServer_OnReceiveMessage(Server __instance, GalaxyID peer, Stream messageStream, Bimap ___peers, IGameServer ___gameServer) + { + SMultiplayer multiplayer = GalaxyNetServerPatch.Multiplayer.Value; + + using (IncomingMessage message = new IncomingMessage()) + using (BinaryReader reader = new BinaryReader(messageStream)) + { + message.Read(reader); + multiplayer.OnServerProcessingMessage(message, outgoing => GalaxyNetServerPatch.SendMessageMethod.Invoke(__instance, new object[] { peer, outgoing }), () => + { + if (___peers.ContainsLeft(message.FarmerID) && (long)___peers[message.FarmerID] == (long)peer.ToUint64()) + { + ___gameServer.processIncomingMessage(message); + } + else if (message.MessageType == StardewValley.Multiplayer.playerIntroduction) + { + NetFarmerRoot farmer = multiplayer.readFarmer(message.Reader); + GalaxyID capturedPeer = new GalaxyID(peer.ToUint64()); + ___gameServer.checkFarmhandRequest(Convert.ToString(peer.ToUint64()), farmer, msg => GalaxyNetServerPatch.SendMessageMethod.Invoke(__instance, new object[] { capturedPeer, msg }), () => ___peers[farmer.Value.UniqueMultiplayerID] = capturedPeer.ToUint64()); + } + }); + } + + return false; + } + } +} diff --git a/src/SMAPI/StardewModdingAPI.csproj b/src/SMAPI/StardewModdingAPI.csproj index 29c9f7fa..f16087bc 100644 --- a/src/SMAPI/StardewModdingAPI.csproj +++ b/src/SMAPI/StardewModdingAPI.csproj @@ -182,7 +182,6 @@ - @@ -325,6 +324,7 @@ + -- cgit