mirror of
https://github.com/2revoemag/PSF-BotServer.git
synced 2026-03-04 12:40:20 +00:00
407429ee21
The game uses a UDP-based protocol. Unlike TCP, UDP does not guarantee that packets arrive, or that they arrive in the correct order. For this reason, the game protocol implements those features using the following: * All packets have a sequence number that is utilized for reordering * Important packets are wrapped in a SlottedMetaPacket with a subslot number * RelatedA packets ae used to request lost packets using the subslot number * RelatedB packets are used to confirm received SlottedMetaPackets All of these go both ways, server <-> client. We used to only partially implement these features: Outgoing packet bundles used SMPs and could be resent, but not all packets were bundled and there was no logic for requesting lost packets from the client and there was no packet reordering, which resulted in dire consequences in the case of packet loss (zoning failures, crashes and many other odd bugs). This patch addresses all of these issues. * Packet bundling: Packets are now automatically bundled and sent as SlottedMetaPackets using a recurring timer. All manual bundling functionality was removed. * Packet reordering: Incoming packets, if received out of order, are stashed and reordered. The maximum wait time for reordering is 20ms. * Packet requesting: Missing SlottedMetaPackets are requested from the client. * PacketCoding refactor: Dropped confusing packet container types. Fixes #5. * Crypto rewrite: PSCrypto is based on a ancient buggy version of cryptopp. Updating to a current version was not possible because it removed the MD5-MAC algorithm. For more details, see Md5Mac.scala. This patch replaces PSCrypto with native Scala code. * Added two new actors: * SocketActor: A simple typed UDP socket actor * MiddlewareActor: The old session pipeline greatly simplified into a typed actor that does most of the things mentioned above. * Begun work on a headless client * Fixed anniversary gun breaking stamina regen * Resolved a few sentry errors
118 lines
3.6 KiB
Scala
118 lines
3.6 KiB
Scala
// Copyright (c) 2017 PSForever
|
|
package game
|
|
|
|
import java.net.{InetAddress, InetSocketAddress}
|
|
|
|
import net.psforever.packet._
|
|
import net.psforever.packet.game._
|
|
import net.psforever.types.PlanetSideEmpire
|
|
import org.specs2.mutable._
|
|
import scodec.bits._
|
|
|
|
class VNLWorldStatusMessageTest extends Specification {
|
|
// NOTE: the ServerType is encoded as 0x03 here, but the real planetside server will encode it as 0x04
|
|
val string =
|
|
hex"0597570065006c0063006f006d006500200074006f00200050006c0061006e00650074005300690064006500210020000186" ++
|
|
hex"67656d696e69" ++ hex"0100 03 00 01459e2540 3775" ++ bin"01".toByteVector
|
|
|
|
"decode" in {
|
|
PacketCoding.decodePacket(string).require match {
|
|
case VNLWorldStatusMessage(message, worlds) =>
|
|
message mustEqual "Welcome to PlanetSide! "
|
|
|
|
worlds.length mustEqual 1
|
|
|
|
val world = worlds(0)
|
|
world.name mustEqual "gemini"
|
|
world.empireNeed mustEqual PlanetSideEmpire.NC
|
|
world.status mustEqual WorldStatus.Up
|
|
world.serverType mustEqual ServerType.Released
|
|
world.connections.length mustEqual 1
|
|
world
|
|
.connections {
|
|
0
|
|
}
|
|
.address
|
|
.getPort mustEqual 30007
|
|
world
|
|
.connections {
|
|
0
|
|
}
|
|
.address
|
|
.getAddress
|
|
.toString mustEqual "/64.37.158.69"
|
|
case _ =>
|
|
ko
|
|
}
|
|
}
|
|
|
|
"encode" in {
|
|
val msg = VNLWorldStatusMessage(
|
|
"Welcome to PlanetSide! ",
|
|
Vector(
|
|
WorldInformation(
|
|
"gemini",
|
|
WorldStatus.Up,
|
|
ServerType.Released,
|
|
Vector(
|
|
WorldConnectionInfo(new InetSocketAddress(InetAddress.getByName("64.37.158.69"), 30007))
|
|
),
|
|
PlanetSideEmpire.NC
|
|
)
|
|
)
|
|
)
|
|
|
|
//0100 04 00 01459e2540377540
|
|
|
|
val pkt = PacketCoding.encodePacket(msg).require.toByteVector
|
|
|
|
pkt mustEqual string
|
|
}
|
|
|
|
"encode and decode empty messages" in {
|
|
val string = hex"0584410041004100410000"
|
|
val empty_msg = VNLWorldStatusMessage("AAAA", Vector())
|
|
val empty_pkt = PacketCoding.encodePacket(empty_msg).require.toByteVector
|
|
|
|
empty_pkt mustEqual string
|
|
|
|
PacketCoding.decodePacket(string).require match {
|
|
case VNLWorldStatusMessage(message, worlds) =>
|
|
message mustEqual "AAAA"
|
|
worlds.length mustEqual 0
|
|
case _ =>
|
|
ko
|
|
}
|
|
}
|
|
|
|
"encode and decode multiple worlds" in {
|
|
var string =
|
|
hex"0597570065006c0063006f006d006500200074006f00200050006c0061006e0065007400530069006400650021002000048941424344414243443101000300006240414243444142434432000002020022404142434441424344330000010100a2404142434441424344340500040000c0"
|
|
|
|
val worlds = Vector(
|
|
WorldInformation("ABCDABCD1", WorldStatus.Up, ServerType.Released, Vector(), PlanetSideEmpire.NC),
|
|
WorldInformation("ABCDABCD2", WorldStatus.Down, ServerType.Beta, Vector(), PlanetSideEmpire.TR),
|
|
WorldInformation("ABCDABCD3", WorldStatus.Locked, ServerType.Development, Vector(), PlanetSideEmpire.VS),
|
|
WorldInformation("ABCDABCD4", WorldStatus.Full, ServerType.ReleasedGemini, Vector(), PlanetSideEmpire.NEUTRAL)
|
|
)
|
|
|
|
val msg = VNLWorldStatusMessage("Welcome to PlanetSide! ", worlds)
|
|
val pkt = PacketCoding.encodePacket(msg).require.toByteVector
|
|
|
|
pkt mustEqual string
|
|
|
|
PacketCoding.decodePacket(string).require match {
|
|
case VNLWorldStatusMessage(message, pkt_worlds) =>
|
|
message mustEqual "Welcome to PlanetSide! "
|
|
|
|
pkt_worlds.length mustEqual worlds.length
|
|
|
|
for (i <- 0 to pkt_worlds.length - 1)
|
|
pkt_worlds(i) mustEqual worlds(i)
|
|
|
|
ok
|
|
case _ =>
|
|
ko
|
|
}
|
|
}
|
|
}
|