Merge branch 'develop' into stable

10 files changed, 481 insertions, 0 deletions

diff --git a/src/SMAPI/Framework/Networking/MessageType.cs b/src/SMAPI/Framework/Networking/MessageType.cs
new file mode 100644
index 00000000..bd9acfa9
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/MessageType.cs
@@ -0,0 +1,26 @@
+using StardewValley;
+
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>Network message types recognised by SMAPI and Stardew Valley.</summary>
+    internal enum MessageType : byte
+    {
+        /*********
+        ** SMAPI
+        *********/
+        /// <summary>A data message intended for mods to consume.</summary>
+        ModMessage = 254,
+
+        /// <summary>Metadata context about a player synced by SMAPI.</summary>
+        ModContext = 255,
+
+        /*********
+        ** Vanilla
+        *********/
+        /// <summary>Metadata about the host server sent to a farmhand.</summary>
+        ServerIntroduction = Multiplayer.serverIntroduction,
+
+        /// <summary>Metadata about a player sent to a farmhand or server.</summary>
+        PlayerIntroduction = Multiplayer.playerIntroduction
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/ModMessageModel.cs b/src/SMAPI/Framework/Networking/ModMessageModel.cs
new file mode 100644
index 00000000..7ee39863
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/ModMessageModel.cs
@@ -0,0 +1,72 @@
+using System.Linq;
+using Newtonsoft.Json.Linq;
+
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>The metadata for a mod message.</summary>
+    internal class ModMessageModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /****
+        ** Origin
+        ****/
+        /// <summary>The unique ID of the player who broadcast the message.</summary>
+        public long FromPlayerID { get; set; }
+
+        /// <summary>The unique ID of the mod which broadcast the message.</summary>
+        public string FromModID { get; set; }
+
+        /****
+        ** Destination
+        ****/
+        /// <summary>The players who should receive the message, or <c>null</c> for all players.</summary>
+        public long[] ToPlayerIDs { get; set; }
+
+        /// <summary>The mods which should receive the message, or <c>null</c> for all mods.</summary>
+        public string[] ToModIDs { get; set; }
+
+        /// <summary>A message type which receiving mods can use to decide whether it's the one they want to handle, like <c>SetPlayerLocation</c>. This doesn't need to be globally unique, since mods should check the originating mod ID.</summary>
+        public string Type { get; set; }
+
+        /// <summary>The custom mod data being broadcast.</summary>
+        public JToken Data { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public ModMessageModel() { }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="fromPlayerID">The unique ID of the player who broadcast the message.</param>
+        /// <param name="fromModID">The unique ID of the mod which broadcast the message.</param>
+        /// <param name="toPlayerIDs">The players who should receive the message, or <c>null</c> for all players.</param>
+        /// <param name="toModIDs">The mods which should receive the message, or <c>null</c> for all mods.</param>
+        /// <param name="type">A message type which receiving mods can use to decide whether it's the one they want to handle, like <c>SetPlayerLocation</c>. This doesn't need to be globally unique, since mods should check the originating mod ID.</param>
+        /// <param name="data">The custom mod data being broadcast.</param>
+        public ModMessageModel(long fromPlayerID, string fromModID, long[] toPlayerIDs, string[] toModIDs, string type, JToken data)
+        {
+            this.FromPlayerID = fromPlayerID;
+            this.FromModID = fromModID;
+            this.ToPlayerIDs = toPlayerIDs;
+            this.ToModIDs = toModIDs;
+            this.Type = type;
+            this.Data = data;
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="message">The message to clone.</param>
+        public ModMessageModel(ModMessageModel message)
+        {
+            this.FromPlayerID = message.FromPlayerID;
+            this.FromModID = message.FromModID;
+            this.ToPlayerIDs = message.ToPlayerIDs?.ToArray();
+            this.ToModIDs = message.ToModIDs?.ToArray();
+            this.Type = message.Type;
+            this.Data = message.Data;
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/MultiplayerPeer.cs b/src/SMAPI/Framework/Networking/MultiplayerPeer.cs
new file mode 100644
index 00000000..44a71978
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/MultiplayerPeer.cs
@@ -0,0 +1,84 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using StardewValley.Network;
+
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>Metadata about a connected player.</summary>
+    internal class MultiplayerPeer : IMultiplayerPeer
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>A method which sends a message to the peer.</summary>
+        private readonly Action<OutgoingMessage> SendMessageImpl;
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The player's unique ID.</summary>
+        public long PlayerID { get; }
+
+        /// <summary>Whether this is a connection to the host player.</summary>
+        public bool IsHost { get; }
+
+        /// <summary>Whether the player has SMAPI installed.</summary>
+        public bool HasSmapi => this.ApiVersion != null;
+
+        /// <summary>The player's OS platform, if <see cref="HasSmapi"/> is true.</summary>
+        public GamePlatform? Platform { get; }
+
+        /// <summary>The installed version of Stardew Valley, if <see cref="HasSmapi"/> is true.</summary>
+        public ISemanticVersion GameVersion { get; }
+
+        /// <summary>The installed version of SMAPI, if <see cref="HasSmapi"/> is true.</summary>
+        public ISemanticVersion ApiVersion { get; }
+
+        /// <summary>The installed mods, if <see cref="HasSmapi"/> is true.</summary>
+        public IEnumerable<IMultiplayerPeerMod> Mods { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="playerID">The player's unique ID.</param>
+        /// <param name="model">The metadata to copy.</param>
+        /// <param name="sendMessage">A method which sends a message to the peer.</param>
+        /// <param name="isHost">Whether this is a connection to the host player.</param>
+        public MultiplayerPeer(long playerID, RemoteContextModel model, Action<OutgoingMessage> sendMessage, bool isHost)
+        {
+            this.PlayerID = playerID;
+            this.IsHost = isHost;
+            if (model != null)
+            {
+                this.Platform = model.Platform;
+                this.GameVersion = model.GameVersion;
+                this.ApiVersion = model.ApiVersion;
+                this.Mods = model.Mods.Select(mod => new MultiplayerPeerMod(mod)).ToArray();
+            }
+            this.SendMessageImpl = sendMessage;
+        }
+
+        /// <summary>Get metadata for a mod installed by the player.</summary>
+        /// <param name="id">The unique mod ID.</param>
+        /// <returns>Returns the mod info, or <c>null</c> if the player doesn't have that mod.</returns>
+        public IMultiplayerPeerMod GetMod(string id)
+        {
+            if (string.IsNullOrWhiteSpace(id) || this.Mods == null || !this.Mods.Any())
+                return null;
+
+            id = id.Trim();
+            return this.Mods.FirstOrDefault(mod => mod.ID != null && mod.ID.Equals(id, StringComparison.InvariantCultureIgnoreCase));
+        }
+
+        /// <summary>Send a message to the given peer, bypassing the game's normal validation to allow messages before the connection is approved.</summary>
+        /// <param name="message">The message to send.</param>
+        public void SendMessage(OutgoingMessage message)
+        {
+            this.SendMessageImpl(message);
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs b/src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs
new file mode 100644
index 00000000..1b324bcd
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs
@@ -0,0 +1,30 @@
+namespace StardewModdingAPI.Framework.Networking
+{
+    internal class MultiplayerPeerMod : IMultiplayerPeerMod
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod's display name.</summary>
+        public string Name { get; }
+
+        /// <summary>The unique mod ID.</summary>
+        public string ID { get; }
+
+        /// <summary>The mod version.</summary>
+        public ISemanticVersion Version { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="mod">The mod metadata.</param>
+        public MultiplayerPeerMod(RemoteContextModModel mod)
+        {
+            this.Name = mod.Name;
+            this.ID = mod.ID?.Trim();
+            this.Version = mod.Version;
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/RemoteContextModModel.cs b/src/SMAPI/Framework/Networking/RemoteContextModModel.cs
new file mode 100644
index 00000000..9795d971
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/RemoteContextModModel.cs
@@ -0,0 +1,15 @@
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>Metadata about an installed mod exchanged with connected computers.</summary>
+    public class RemoteContextModModel
+    {
+        /// <summary>The mod's display name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The unique mod ID.</summary>
+        public string ID { get; set; }
+
+        /// <summary>The mod version.</summary>
+        public ISemanticVersion Version { get; set; }
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/RemoteContextModel.cs b/src/SMAPI/Framework/Networking/RemoteContextModel.cs
new file mode 100644
index 00000000..7befb151
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/RemoteContextModel.cs
@@ -0,0 +1,24 @@
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>Metadata about the game, SMAPI, and installed mods exchanged with connected computers.</summary>
+    internal class RemoteContextModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Whether this player is the host player.</summary>
+        public bool IsHost { get; set; }
+
+        /// <summary>The game's platform version.</summary>
+        public GamePlatform Platform { get; set; }
+
+        /// <summary>The installed version of Stardew Valley.</summary>
+        public ISemanticVersion GameVersion { get; set; }
+
+        /// <summary>The installed version of SMAPI.</summary>
+        public ISemanticVersion ApiVersion { get; set; }
+
+        /// <summary>The installed mods.</summary>
+        public RemoteContextModModel[] Mods { get; set; }
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/SGalaxyNetClient.cs b/src/SMAPI/Framework/Networking/SGalaxyNetClient.cs
new file mode 100644
index 00000000..fddd423d
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/SGalaxyNetClient.cs
@@ -0,0 +1,52 @@
+using System;
+using Galaxy.Api;
+using StardewValley.Network;
+using StardewValley.SDKs;
+
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>A multiplayer client used to connect to a hosted server. This is an implementation of <see cref="GalaxyNetClient"/> with callbacks for SMAPI functionality.</summary>
+    internal class SGalaxyNetClient : GalaxyNetClient
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>A callback to raise when receiving a message. This receives the incoming message, a method to send an arbitrary message, and a callback to run the default logic.</summary>
+        private readonly Action<IncomingMessage, Action<OutgoingMessage>, Action> OnProcessingMessage;
+
+        /// <summary>A callback to raise when sending a message. This receives the outgoing message, a method to send an arbitrary message, and a callback to resume the default logic.</summary>
+        private readonly Action<OutgoingMessage, Action<OutgoingMessage>, Action> OnSendingMessage;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="address">The remote address being connected.</param>
+        /// <param name="onProcessingMessage">A callback to raise when receiving a message. This receives the incoming message, a method to send an arbitrary message, and a callback to run the default logic.</param>
+        /// <param name="onSendingMessage">A callback to raise when sending a message. This receives the outgoing message, a method to send an arbitrary message, and a callback to resume the default logic.</param>
+        public SGalaxyNetClient(GalaxyID address, Action<IncomingMessage, Action<OutgoingMessage>, Action> onProcessingMessage, Action<OutgoingMessage, Action<OutgoingMessage>, Action> onSendingMessage)
+            : base(address)
+        {
+            this.OnProcessingMessage = onProcessingMessage;
+            this.OnSendingMessage = onSendingMessage;
+        }
+
+        /// <summary>Send a message to the connected peer.</summary>
+        public override void sendMessage(OutgoingMessage message)
+        {
+            this.OnSendingMessage(message, base.sendMessage, () => base.sendMessage(message));
+        }
+
+
+        /*********
+        ** Protected methods
+        *********/
+        /// <summary>Process an incoming network message.</summary>
+        /// <param name="message">The message to process.</param>
+        protected override void processIncomingMessage(IncomingMessage message)
+        {
+            this.OnProcessingMessage(message, base.sendMessage, () => base.processIncomingMessage(message));
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs b/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs
new file mode 100644
index 00000000..2fc92737
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs
@@ -0,0 +1,63 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using Galaxy.Api;
+using StardewValley.Network;
+using StardewValley.SDKs;
+
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>A multiplayer server used to connect to an incoming player. This is an implementation of <see cref="LidgrenServer"/> that adds support for SMAPI's metadata context exchange.</summary>
+    internal class SGalaxyNetServer : GalaxyNetServer
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>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.</summary>
+        private readonly Action<IncomingMessage, Action<OutgoingMessage>, Action> OnProcessingMessage;
+
+        /// <summary>SMAPI's implementation of the game's core multiplayer logic.</summary>
+        private readonly SMultiplayer Multiplayer;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="gameServer">The underlying game server.</param>
+        /// <param name="multiplayer">SMAPI's implementation of the game's core multiplayer logic.</param>
+        /// <param name="onProcessingMessage">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.</param>
+        public SGalaxyNetServer(IGameServer gameServer, SMultiplayer multiplayer, Action<IncomingMessage, Action<OutgoingMessage>, Action> onProcessingMessage)
+            : base(gameServer)
+        {
+            this.Multiplayer = multiplayer;
+            this.OnProcessingMessage = onProcessingMessage;
+        }
+
+        /// <summary>Read and process a message from the client.</summary>
+        /// <param name="peer">The Galaxy peer ID.</param>
+        /// <param name="messageStream">The data to process.</param>
+        [SuppressMessage("ReSharper", "AccessToDisposedClosure", Justification = "The callback is invoked synchronously.")]
+        protected override void onReceiveMessage(GalaxyID peer, Stream messageStream)
+        {
+            using (IncomingMessage message = new IncomingMessage())
+            using (BinaryReader reader = new BinaryReader(messageStream))
+            {
+                message.Read(reader);
+                this.OnProcessingMessage(message, outgoing => this.sendMessage(peer, outgoing), () =>
+                {
+                    if (this.peers.ContainsLeft(message.FarmerID) && (long)this.peers[message.FarmerID] == (long)peer.ToUint64())
+                    {
+                        this.gameServer.processIncomingMessage(message);
+                    }
+                    else if (message.MessageType == StardewValley.Multiplayer.playerIntroduction)
+                    {
+                        NetFarmerRoot farmer = this.Multiplayer.readFarmer(message.Reader);
+                        GalaxyID capturedPeer = new GalaxyID(peer.ToUint64());
+                        this.gameServer.checkFarmhandRequest(Convert.ToString(peer.ToUint64()), farmer, msg => this.sendMessage(capturedPeer, msg), () => this.peers[farmer.Value.UniqueMultiplayerID] = capturedPeer.ToUint64());
+                    }
+                });
+            }
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/SLidgrenClient.cs b/src/SMAPI/Framework/Networking/SLidgrenClient.cs
new file mode 100644
index 00000000..02d9d68f
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/SLidgrenClient.cs
@@ -0,0 +1,50 @@
+using System;
+using StardewValley.Network;
+
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>A multiplayer client used to connect to a hosted server. This is an implementation of <see cref="LidgrenClient"/> with callbacks for SMAPI functionality.</summary>
+    internal class SLidgrenClient : LidgrenClient
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>A callback to raise when receiving a message. This receives the incoming message, a method to send an arbitrary message, and a callback to run the default logic.</summary>
+        private readonly Action<IncomingMessage, Action<OutgoingMessage>, Action> OnProcessingMessage;
+
+        /// <summary>A callback to raise when sending a message. This receives the outgoing message, a method to send an arbitrary message, and a callback to resume the default logic.</summary>
+        private readonly Action<OutgoingMessage, Action<OutgoingMessage>, Action> OnSendingMessage;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="address">The remote address being connected.</param>
+        /// <param name="onProcessingMessage">A callback to raise when receiving a message. This receives the incoming message, a method to send an arbitrary message, and a callback to run the default logic.</param>
+        /// <param name="onSendingMessage">A callback to raise when sending a message. This receives the outgoing message, a method to send an arbitrary message, and a callback to resume the default logic.</param>
+        public SLidgrenClient(string address, Action<IncomingMessage, Action<OutgoingMessage>, Action> onProcessingMessage, Action<OutgoingMessage, Action<OutgoingMessage>, Action> onSendingMessage)
+            : base(address)
+        {
+            this.OnProcessingMessage = onProcessingMessage;
+            this.OnSendingMessage = onSendingMessage;
+        }
+
+        /// <summary>Send a message to the connected peer.</summary>
+        public override void sendMessage(OutgoingMessage message)
+        {
+            this.OnSendingMessage(message, base.sendMessage, () => base.sendMessage(message));
+        }
+
+
+        /*********
+        ** Protected methods
+        *********/
+        /// <summary>Process an incoming network message.</summary>
+        /// <param name="message">The message to process.</param>
+        protected override void processIncomingMessage(IncomingMessage message)
+        {
+            this.OnProcessingMessage(message, base.sendMessage, () => base.processIncomingMessage(message));
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Networking/SLidgrenServer.cs b/src/SMAPI/Framework/Networking/SLidgrenServer.cs
new file mode 100644
index 00000000..251e5268
--- /dev/null
+++ b/src/SMAPI/Framework/Networking/SLidgrenServer.cs
@@ -0,0 +1,65 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using Lidgren.Network;
+using StardewValley.Network;
+
+namespace StardewModdingAPI.Framework.Networking
+{
+    /// <summary>A multiplayer server used to connect to an incoming player. This is an implementation of <see cref="LidgrenServer"/> that adds support for SMAPI's metadata context exchange.</summary>
+    internal class SLidgrenServer : LidgrenServer
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>SMAPI's implementation of the game's core multiplayer logic.</summary>
+        private readonly SMultiplayer Multiplayer;
+
+        /// <summary>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.</summary>
+        private readonly Action<IncomingMessage, Action<OutgoingMessage>, Action> OnProcessingMessage;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="multiplayer">SMAPI's implementation of the game's core multiplayer logic.</param>
+        /// <param name="gameServer">The underlying game server.</param>
+        /// <param name="onProcessingMessage">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.</param>
+        public SLidgrenServer(IGameServer gameServer, SMultiplayer multiplayer, Action<IncomingMessage, Action<OutgoingMessage>, Action> onProcessingMessage)
+            : base(gameServer)
+        {
+            this.Multiplayer = multiplayer;
+            this.OnProcessingMessage = onProcessingMessage;
+        }
+
+        /// <summary>Parse a data message from a client.</summary>
+        /// <param name="rawMessage">The raw network message to parse.</param>
+        [SuppressMessage("ReSharper", "AccessToDisposedClosure", Justification = "The callback is invoked synchronously.")]
+        protected override void parseDataMessageFromClient(NetIncomingMessage rawMessage)
+        {
+            // add hook to call multiplayer core
+            NetConnection peer = rawMessage.SenderConnection;
+            using (IncomingMessage message = new IncomingMessage())
+            using (Stream readStream = new NetBufferReadStream(rawMessage))
+            using (BinaryReader reader = new BinaryReader(readStream))
+            {
+                while (rawMessage.LengthBits - rawMessage.Position >= 8)
+                {
+                    message.Read(reader);
+                    NetConnection connection = rawMessage.SenderConnection; // don't pass rawMessage into context because it gets reused
+                    this.OnProcessingMessage(message, outgoing => this.sendMessage(connection, outgoing), () =>
+                    {
+                        if (this.peers.ContainsLeft(message.FarmerID) && this.peers[message.FarmerID] == peer)
+                            this.gameServer.processIncomingMessage(message);
+                        else if (message.MessageType == StardewValley.Multiplayer.playerIntroduction)
+                        {
+                            NetFarmerRoot farmer = this.Multiplayer.readFarmer(message.Reader);
+                            this.gameServer.checkFarmhandRequest("", farmer, msg => this.sendMessage(peer, msg), () => this.peers[farmer.Value.UniqueMultiplayerID] = peer);
+                        }
+                    });
+                }
+            }
+        }
+    }
+}