Merge branch 'general-devel' into handlegolfpacket

TShockAPI/Handlers/IPacketHandler.cs

@@ -0,0 +1,16 @@
+namespace TShockAPI.Handlers
+{
+	/// <summary>
+	/// Describes a packet handler that receives a packet from a GetDataHandler
+	/// </summary>
+	/// <typeparam name="TEventArgs"></typeparam>
+	public interface IPacketHandler<TEventArgs> where TEventArgs : GetDataHandledEventArgs
+	{
+		/// <summary>
+		/// Invoked when the packet is received
+		/// </summary>
+		/// <param name="sender"></param>
+		/// <param name="args"></param>
+		void OnReceive(object sender, TEventArgs args);
+	}
+}

TShockAPI/Handlers/NetModules/AmbienceHandler.cs

@@ -0,0 +1,28 @@
+using System.IO;
+
+namespace TShockAPI.Handlers.NetModules
+{
+	/// <summary>
+	/// Rejects ambience new modules from clients
+	/// </summary>
+	public class AmbienceHandler : INetModuleHandler
+	{
+		/// <summary>
+		/// No deserialization needed. This should never be received by the server
+		/// </summary>
+		/// <param name="data"></param>
+		public void Deserialize(MemoryStream data)
+		{
+		}
+
+		/// <summary>
+		/// This should never be received by the server
+		/// </summary>
+		/// <param name="player"></param>
+		/// <param name="rejectPacket"></param>
+		public void HandlePacket(TSPlayer player, out bool rejectPacket)
+		{
+			rejectPacket = true;
+		}
+	}
+}

TShockAPI/Handlers/NetModules/BestiaryHandler.cs

@@ -0,0 +1,28 @@
+using System.IO;
+
+namespace TShockAPI.Handlers.NetModules
+{
+	/// <summary>
+	/// Rejects client->server bestiary net modules as the client should never send this to the server
+	/// </summary>
+	public class BestiaryHandler : INetModuleHandler
+	{
+		/// <summary>
+		/// No deserialization needed. This should never be received by the server
+		/// </summary>
+		/// <param name="data"></param>
+		public void Deserialize(MemoryStream data)
+		{
+		}
+
+		/// <summary>
+		/// This should never be received by the server
+		/// </summary>
+		/// <param name="player"></param>
+		/// <param name="rejectPacket"></param>
+		public void HandlePacket(TSPlayer player, out bool rejectPacket)
+		{
+			rejectPacket = true;
+		}
+	}
+}

TShockAPI/Handlers/NetModules/CreativePowerHandler.cs

@@ -0,0 +1,113 @@
+using System.Collections.Generic;
+using System.IO;
+using System.IO.Streams;
+using static TShockAPI.GetDataHandlers;
+
+namespace TShockAPI.Handlers.NetModules
+{
+	/// <summary>
+	/// Provides handling for the Creative Power net module. Checks permissions on all creative powers
+	/// </summary>
+	public class CreativePowerHandler : INetModuleHandler
+	{
+		/// <summary>
+		/// The power type being activated
+		/// </summary>
+		public CreativePowerTypes PowerType { get; set; }
+
+		/// <summary>
+		/// Reads the power type from the stream
+		/// </summary>
+		/// <param name="data"></param>
+		public void Deserialize(MemoryStream data)
+		{
+			PowerType = (CreativePowerTypes)data.ReadInt16();
+		}
+
+		/// <summary>
+		/// Determines if the player has permission to use the power type
+		/// </summary>
+		/// <param name="player"></param>
+		/// <param name="rejectPacket"></param>
+		public void HandlePacket(TSPlayer player, out bool rejectPacket)
+		{
+			if (!HasPermission(PowerType, player))
+			{
+				rejectPacket = true;
+				return;
+			}
+
+			rejectPacket = false;
+		}
+
+		/// <summary>
+		/// Determines if a player has permission to use a specific creative power
+		/// </summary>
+		/// <param name="powerType"></param>
+		/// <param name="player"></param>
+		/// <returns></returns>
+		public static bool HasPermission(CreativePowerTypes powerType, TSPlayer player)
+		{
+			if (!PowerToPermissionMap.ContainsKey(powerType))
+			{
+				TShock.Log.ConsoleDebug("CreativePowerHandler received permission check request for unknown creative power");
+				return false;
+			}
+
+			string permission = PowerToPermissionMap[powerType];
+
+			if (!player.HasPermission(permission))
+			{
+				player.SendErrorMessage("You do not have permission to {0}.", PermissionToDescriptionMap[permission]);
+				return false;
+			}
+
+			return true;
+		}
+
+
+		/// <summary>
+		/// Maps creative powers to permission nodes
+		/// </summary>
+		public static Dictionary<CreativePowerTypes, string> PowerToPermissionMap = new Dictionary<CreativePowerTypes, string>
+		{
+			{ CreativePowerTypes.FreezeTime,              Permissions.journey_timefreeze		},
+			{ CreativePowerTypes.SetDawn,                 Permissions.journey_timeset			},
+			{ CreativePowerTypes.SetNoon,                 Permissions.journey_timeset			},
+			{ CreativePowerTypes.SetDusk,                 Permissions.journey_timeset			},
+			{ CreativePowerTypes.SetMidnight,             Permissions.journey_timeset			},
+			{ CreativePowerTypes.Godmode,                 Permissions.journey_godmode			},
+			{ CreativePowerTypes.WindStrength,            Permissions.journey_windstrength		},
+			{ CreativePowerTypes.RainStrength,            Permissions.journey_rainstrength		},
+			{ CreativePowerTypes.TimeSpeed,               Permissions.journey_timespeed			},
+			{ CreativePowerTypes.RainFreeze,              Permissions.journey_rainfreeze		},
+			{ CreativePowerTypes.WindFreeze,              Permissions.journey_windfreeze		},
+			{ CreativePowerTypes.IncreasePlacementRange,  Permissions.journey_placementrange	},
+			{ CreativePowerTypes.WorldDifficulty,         Permissions.journey_setdifficulty		},
+			{ CreativePowerTypes.BiomeSpreadFreeze,       Permissions.journey_biomespreadfreeze },
+			{ CreativePowerTypes.SetSpawnRate,            Permissions.journey_setspawnrate		},
+		};
+
+		/// <summary>
+		/// Maps journey mode permission nodes to descriptions of what the permission allows
+		/// </summary>
+		public static Dictionary<string, string> PermissionToDescriptionMap = new Dictionary<string, string>
+		{
+			{ Permissions.journey_timefreeze,			"freeze the time of the server"						},
+			{ Permissions.journey_timeset,				"modify the time of the server"						},
+			{ Permissions.journey_timeset,				"modify the time of the server"						},
+			{ Permissions.journey_timeset,				"modify the time of the server"						},
+			{ Permissions.journey_timeset,				"modify the time of the server"						},
+			{ Permissions.journey_godmode,				"toggle godmode"									},
+			{ Permissions.journey_windstrength,			"modify the wind strength of the server"			},
+			{ Permissions.journey_rainstrength,			"modify the rain strength of the server"			},
+			{ Permissions.journey_timespeed,			"modify the time speed of the server"				},
+			{ Permissions.journey_rainfreeze,			"freeze the rain strength of the server"			},
+			{ Permissions.journey_windfreeze,			"freeze the wind strength of the server"			},
+			{ Permissions.journey_placementrange,		"modify the tile placement range of your character" },
+			{ Permissions.journey_setdifficulty,		"modify the world difficulty of the server"			},
+			{ Permissions.journey_biomespreadfreeze,	"freeze the biome spread of the server"				},
+			{ Permissions.journey_setspawnrate,			"modify the NPC spawn rate of the server"			},
+		};
+	}
+}

TShockAPI/Handlers/NetModules/CreativeUnlocksHandler.cs

@@ -0,0 +1,90 @@
+using System.IO;
+using System.IO.Streams;
+using Terraria;
+using Terraria.GameContent.NetModules;
+using Terraria.Net;
+
+namespace TShockAPI.Handlers.NetModules
+{
+	/// <summary>
+	/// Handles creative unlock requests
+	/// </summary>
+	public class CreativeUnlocksHandler : INetModuleHandler
+	{
+		/// <summary>
+		/// An unknown field. If this does not have a value of '0' the packet should be rejected.
+		/// </summary>
+		public byte UnknownField { get; set; }
+		/// <summary>
+		/// ID of the item being sacrificed
+		/// </summary>
+		public ushort ItemId { get; set; }
+		/// <summary>
+		/// Stack size of the item being sacrificed
+		/// </summary>
+		public ushort Amount { get; set; }
+
+		/// <summary>
+		/// Reads the unlock data from the stream
+		/// </summary>
+		/// <param name="data"></param>
+		public void Deserialize(MemoryStream data)
+		{
+			// For whatever reason Terraria writes '0' to the stream at the beginning of this packet.
+			// If this value is not 0 then its been crafted by a non-vanilla client.
+			// We don't actually know why the 0 is written, so we're just going to call this UnknownField for now
+			UnknownField = data.ReadInt8();
+			if (UnknownField == 0)
+			{
+				ItemId = data.ReadUInt16();
+				Amount = data.ReadUInt16();
+			}
+		}
+
+		/// <summary>
+		/// Determines if the unlock is valid and the player has permission to perform the unlock.
+		/// Syncs unlock status if the packet is accepted
+		/// </summary>
+		/// <param name="player"></param>
+		/// <param name="rejectPacket"></param>
+		public void HandlePacket(TSPlayer player, out bool rejectPacket)
+		{
+			if (!Main.GameModeInfo.IsJourneyMode)
+			{
+				TShock.Log.ConsoleDebug(
+					"NetModuleHandler received attempt to unlock sacrifice while not in journey mode from",
+					player.Name
+				);
+
+				rejectPacket = true;
+				return;
+			}
+
+			if (UnknownField != 0)
+			{
+				TShock.Log.ConsoleDebug(
+					"CreativeUnlocksHandler received non-vanilla unlock request. Random field value: {0} but should be 0 from {1}",
+					UnknownField,
+					player.Name
+				);
+
+				rejectPacket = true;
+				return;
+			}
+
+			if (!player.HasPermission(Permissions.journey_contributeresearch))
+			{
+				player.SendErrorMessage("You do not have permission to contribute research.");
+				rejectPacket = true;
+				return;
+			}
+
+			var totalSacrificed = TShock.ResearchDatastore.SacrificeItem(ItemId, Amount, player);
+
+			var response = NetCreativeUnlocksModule.SerializeItemSacrifice(ItemId, totalSacrificed);
+			NetManager.Instance.Broadcast(response);
+
+			rejectPacket = false;
+		}
+	}
+}

TShockAPI/Handlers/NetModules/INetModuleHandler.cs

@@ -0,0 +1,23 @@
+using System.IO;
+
+namespace TShockAPI.Handlers.NetModules
+{
+	/// <summary>
+	/// Describes a handler for a net module
+	/// </summary>
+	public interface INetModuleHandler
+	{
+		/// <summary>
+		/// Reads the net module's data from the given stream
+		/// </summary>
+		/// <param name="data"></param>
+		void Deserialize(MemoryStream data);
+
+		/// <summary>
+		/// Provides handling for the packet and determines if it should be accepted or rejected
+		/// </summary>
+		/// <param name="player"></param>
+		/// <param name="rejectPacket"></param>
+		void HandlePacket(TSPlayer player, out bool rejectPacket);
+	}
+}

TShockAPI/Handlers/NetModules/LiquidHandler.cs

@@ -0,0 +1,29 @@
+using System.IO;
+
+namespace TShockAPI.Handlers.NetModules
+{
+	/// <summary>
+	/// Handles the NetLiquidModule. Rejects all incoming net liquid requests, as clients should never send them
+	/// </summary>
+	public class LiquidHandler : INetModuleHandler
+	{
+		/// <summary>
+		/// Does nothing. We should not deserialize this data
+		/// </summary>
+		/// <param name="data"></param>
+		public void Deserialize(MemoryStream data)
+		{
+			// No need to deserialize
+		}
+
+		/// <summary>
+		/// Rejects the packet. Clients should not send this to us
+		/// </summary>
+		/// <param name="player"></param>
+		/// <param name="rejectPacket"></param>
+		public void HandlePacket(TSPlayer player, out bool rejectPacket)
+		{
+			rejectPacket = true;
+		}
+	}
+}

TShockAPI/Handlers/NetModules/NetModulePacketHandler.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Collections.Generic;
+using Terraria;
+using static TShockAPI.GetDataHandlers;
+
+namespace TShockAPI.Handlers.NetModules
+{
+	/// <summary>
+	/// Handles packet 82 - Load Net Module packets
+	/// </summary>
+	public class NetModulePacketHandler : IPacketHandler<ReadNetModuleEventArgs>
+	{
+		/// <summary>
+		/// Maps net module types to handlers for the net module type. Add to or edit this dictionary to customise handling
+		/// </summary>
+		public static Dictionary<NetModuleType, Type> NetModulesToHandlersMap = new Dictionary<NetModuleType, Type>
+		{
+			{ NetModuleType.CreativePowers,               typeof(CreativePowerHandler)    },
+			{ NetModuleType.CreativeUnlocksPlayerReport,  typeof(CreativeUnlocksHandler)  },
+			{ NetModuleType.TeleportPylon,                typeof(PylonHandler)            },
+			{ NetModuleType.Liquid,                       typeof(LiquidHandler)           },
+			{ NetModuleType.Bestiary,                     typeof(BestiaryHandler)         },
+			{ NetModuleType.Ambience,                     typeof(AmbienceHandler)         }
+		};
+
+		/// <summary>
+		/// Invoked when a load net module packet is received. This method picks a <see cref="INetModuleHandler"/> based on the
+		/// net module type being loaded, then forwards the data to the chosen handler to process
+		/// </summary>
+		/// <param name="sender"></param>
+		/// <param name="args"></param>
+		public void OnReceive(object sender, ReadNetModuleEventArgs args)
+		{
+			INetModuleHandler handler;
+
+			if (NetModulesToHandlersMap.ContainsKey(args.ModuleType))
+			{
+				handler = (INetModuleHandler)Activator.CreateInstance(NetModulesToHandlersMap[args.ModuleType]);
+			}
+			else
+			{
+				// We don't have handlers for NetModuleType.Ping and NetModuleType.Particles.
+				// These net modules are fairly innocuous and can be processed normally by the game
+				args.Handled = false;
+				return;
+			}
+
+			handler.Deserialize(args.Data);
+			handler.HandlePacket(args.Player, out bool rejectPacket);
+
+			args.Handled = rejectPacket;
+		}
+	}
+}

TShockAPI/Handlers/NetModules/PylonHandler.cs

@@ -0,0 +1,62 @@
+using System.IO;
+using System.IO.Streams;
+using Terraria.GameContent;
+using static Terraria.GameContent.NetModules.NetTeleportPylonModule;
+
+namespace TShockAPI.Handlers.NetModules
+{
+	/// <summary>
+	/// Handles a pylon net module
+	/// </summary>
+	public class PylonHandler : INetModuleHandler
+	{
+		/// <summary>
+		/// Event occuring
+		/// </summary>
+		public SubPacketType PylonEventType { get; set; }
+		/// <summary>
+		/// Tile X coordinate of the pylon
+		/// </summary>
+		public short TileX { get; set; }
+		/// <summary>
+		/// Tile Y coordinate of the pylon
+		/// </summary>
+		public short TileY { get; set; }
+		/// <summary>
+		/// Type of Pylon
+		/// </summary>
+		public TeleportPylonType PylonType { get; set; }
+
+		/// <summary>
+		/// Reads the pylon data from the net module
+		/// </summary>
+		/// <param name="data"></param>
+		public void Deserialize(MemoryStream data)
+		{
+			PylonEventType = (SubPacketType)data.ReadInt8();
+			TileX = data.ReadInt16();
+			TileY = data.ReadInt16();
+			PylonType = (TeleportPylonType)data.ReadInt8();
+		}
+
+		/// <summary>
+		/// Rejects a pylon teleport request if the player does not have permission
+		/// </summary>
+		/// <param name="player"></param>
+		/// <param name="rejectPacket"></param>
+		public void HandlePacket(TSPlayer player, out bool rejectPacket)
+		{
+			if (PylonEventType == SubPacketType.PlayerRequestsTeleport)
+			{
+				if (!player.HasPermission(Permissions.pylon))
+				{
+					rejectPacket = true;
+					player.SendErrorMessage("You do not have permission to teleport with pylons.");
+					return;
+				}
+			}
+
+			rejectPacket = false;
+		}
+	}
+}

TShockAPI/Handlers/SendTileSquareHandler.cs

@@ -14,12 +14,12 @@ namespace TShockAPI.Handlers
 	/// <summary>
 	/// Provides processors for handling Tile Square packets
 	/// </summary>
-	public class SendTileSquareHandler
+	public class SendTileSquareHandler : IPacketHandler<GetDataHandlers.SendTileSquareEventArgs>
 	{
 		/// <summary>
 		/// Maps grass-type blocks to flowers that can be grown on them with flower boots
 		/// </summary>
-		Dictionary<ushort, List<ushort>> _grassToPlantMap = new Dictionary<ushort, List<ushort>>
+		public static Dictionary<ushort, List<ushort>> GrassToPlantMap = new Dictionary<ushort, List<ushort>>
 		{
 			{ TileID.Grass, new List<ushort>            { TileID.Plants,         TileID.Plants2 } },
 			{ TileID.HallowedGrass, new List<ushort>    { TileID.HallowedPlants, TileID.HallowedPlants2 } },
@@ -29,7 +29,7 @@ namespace TShockAPI.Handlers
 		/// <summary>
 		/// Item IDs that can spawn flowers while you walk
 		/// </summary>
-		List<int> _flowerBootItems = new List<int>
+		public static List<int> FlowerBootItems = new List<int>
 		{
 			ItemID.FlowerBoots,
 			ItemID.FairyBoots
@@ -40,7 +40,7 @@ namespace TShockAPI.Handlers
 		/// Note: <see cref="Terraria.ID.TileEntityID"/> is empty at the time of writing, but entities are dynamically assigned their ID at initialize time
 		/// which is why we can use the _myEntityId field on each entity type
 		/// </summary>
-		Dictionary<int, int> _tileEntityIdToTileIdMap = new Dictionary<int, int>
+		public static Dictionary<int, int> TileEntityIdToTileIdMap = new Dictionary<int, int>
 		{
 			{ TileID.TargetDummy,        TETrainingDummy._myEntityID },
 			{ TileID.ItemFrame,          TEItemFrame._myEntityID },
@@ -57,7 +57,7 @@ namespace TShockAPI.Handlers
 		/// </summary>
 		/// <param name="sender"></param>
 		/// <param name="args"></param>
-		public void OnReceiveSendTileSquare(object sender, GetDataHandlers.SendTileSquareEventArgs args)
+		public void OnReceive(object sender, GetDataHandlers.SendTileSquareEventArgs args)
 		{
 			// By default, we'll handle everything
 			args.Handled = true;
@@ -191,14 +191,20 @@ namespace TShockAPI.Handlers
 				TShock.Log.ConsoleDebug("Bouncer / SendTileSquare rejected from no permission for tile object from {0}", args.Player.Name);
 				return;
 			}
+			
+			if (TShock.TileBans.TileIsBanned((short)tileType))
+			{
+				TShock.Log.ConsoleDebug("Bouncer / SendTileSquare rejected for banned tile");
+				return;
+			}
 
 			// Update all tiles in the tile object. These will be sent back to the player later
 			UpdateMultipleServerTileStates(realX, realY, width, height, newTiles);
 
 			// Tile entities have special placements that we should let the game deal with
-			if (_tileEntityIdToTileIdMap.ContainsKey(tileType))
+			if (TileEntityIdToTileIdMap.ContainsKey(tileType))
 			{
-				TileEntity.PlaceEntityNet(realX, realY, _tileEntityIdToTileIdMap[tileType]);
+				TileEntity.PlaceEntityNet(realX, realY, TileEntityIdToTileIdMap[tileType]);
 			}
 		}
 
@@ -214,7 +220,7 @@ namespace TShockAPI.Handlers
 		{
 			// Some boots allow growing flowers on grass. This process sends a 1x1 tile square to grow the flowers
 			// The square size must be 1 and the player must have an accessory that allows growing flowers in order for this square to be valid
-			if (squareSize == 1 && args.Player.Accessories.Any(a => a != null && _flowerBootItems.Contains(a.type)))
+			if (squareSize == 1 && args.Player.Accessories.Any(a => a != null && FlowerBootItems.Contains(a.type)))
 			{
 				ProcessFlowerBoots(realX, realY, newTile, args);
 				return;
@@ -254,7 +260,7 @@ namespace TShockAPI.Handlers
 			}
 
 			ITile tile = Main.tile[realX, realY + 1];
-			if (!_grassToPlantMap.TryGetValue(tile.type, out List<ushort> plantTiles) && !plantTiles.Contains(newTile.Type))
+			if (!GrassToPlantMap.TryGetValue(tile.type, out List<ushort> plantTiles) && !plantTiles.Contains(newTile.Type))
 			{
 				// If the tile below the tile square isn't a valid plant tile (eg grass) then we don't update the server tile state
 				return;