teeworlds_network/lib/teeworlds_server.rb

477 lines
12 KiB
Ruby
Raw Normal View History

2022-11-08 15:20:46 +00:00
# frozen_string_literal: true
require 'socket'
require_relative 'string'
require_relative 'array'
require_relative 'bytes'
require_relative 'network'
require_relative 'packet'
require_relative 'chunk'
require_relative 'net_base'
require_relative 'models/net_addr'
2022-11-08 15:20:46 +00:00
require_relative 'packer'
2022-11-09 15:46:04 +00:00
require_relative 'game_server'
require_relative 'models/token'
class Client
2024-01-20 14:33:25 +00:00
attr_accessor :id, :addr, :vital_sent, :last_recv_time, :token, :player, :in_game, :authed
attr_reader :ack
def initialize(attr = {})
@id = attr[:id]
@addr = attr[:addr]
2022-11-12 10:18:12 +00:00
@vital_sent = 0
@ack = 0
2022-11-13 07:40:17 +00:00
@in_game = false
@last_recv_time = Time.now
@player = Player.new(
id: @id,
local: 0,
team: 0,
name: '(connecting)',
clan: '',
country: -1
)
2024-01-20 14:21:59 +00:00
@authed = false
2022-11-12 11:51:09 +00:00
@token = attr[:token]
SecurityToken.validate(@token)
end
2022-11-12 10:22:54 +00:00
2024-01-20 14:21:59 +00:00
def authed?
@authed
end
2022-11-13 07:40:17 +00:00
def in_game?
@in_game
end
def bump_ack
@ack = (@ack + 1) % NET_MAX_SEQUENCE
end
2022-11-12 10:22:54 +00:00
# TODO: use or remove
# not sure if its cool
# one can make vital_sent read only
# and then the seq reader increments it
# so everytime a header is created
# the chunk builder just calls
# seq = client.seq
def seq
@vital_sent + 1
end
end
2022-11-08 15:20:46 +00:00
class TeeworldsServer
attr_accessor :clients
2024-01-20 14:32:12 +00:00
attr_reader :hooks, :shutdown_reason
2022-11-08 15:20:46 +00:00
def initialize(options = {})
@verbose = options[:verbose] || false
@ip = '127.0.0.1'
@port = 8303
2022-11-09 15:46:04 +00:00
@game_server = GameServer.new(self)
@clients = {}
@current_game_tick = 0
@last_snap_time = Time.now
2024-01-20 13:39:21 +00:00
@hooks = {
2024-01-20 14:21:59 +00:00
chat: [],
rcon_auth: [],
rcon_cmd: [],
2024-02-21 03:39:57 +00:00
shutdown: [],
emote: [],
info: [],
ready: [],
start_info: [],
enter_game: [],
input: [],
client_drop: [],
tick: []
2024-01-20 13:39:21 +00:00
}
2024-01-20 13:50:55 +00:00
@thread_running = false
2024-01-20 14:21:59 +00:00
@is_shutting_down = false
2024-01-20 14:32:12 +00:00
@shutdown_reason = ''
2024-01-20 14:21:59 +00:00
end
2024-01-20 14:32:12 +00:00
def shutdown!(reason)
2024-01-20 14:21:59 +00:00
@is_shutting_down = true
2024-01-20 14:32:12 +00:00
@shutdown_reason = reason
2024-01-20 13:39:21 +00:00
end
def on_chat(&block)
@hooks[:chat].push(block)
2022-11-08 15:20:46 +00:00
end
2024-01-20 14:21:59 +00:00
def on_rcon_auth(&block)
@hooks[:rcon_auth].push(block)
end
def on_rcon_cmd(&block)
@hooks[:rcon_cmd].push(block)
end
def on_shutdown(&block)
@hooks[:shutdown].push(block)
end
2024-02-21 03:39:57 +00:00
def on_emote(&block)
@hooks[:emote].push(block)
end
def on_info(&block)
@hooks[:info].push(block)
end
def on_ready(&block)
@hooks[:ready].push(block)
end
def on_start_info(&block)
@hooks[:start_info].push(block)
end
def on_enter_game(&block)
@hooks[:enter_game].push(block)
end
def on_input(&block)
@hooks[:input].push(block)
end
def on_client_drop(&block)
@hooks[:client_drop].push(block)
end
def on_tick(&block)
@hooks[:tick].push(block)
end
2024-01-20 13:50:55 +00:00
def main_loop
2022-11-08 15:20:46 +00:00
loop do
2024-01-20 14:21:59 +00:00
break if @is_shutting_down
2022-11-08 15:20:46 +00:00
tick
2022-11-09 12:55:09 +00:00
# TODO: proper tick speed sleep
# replace by blocking network read
# m_NetServer
# .Wait(
# clamp(
# int((
# TickStartTime(
# m_CurrentGameTick+1)-time_get()
# )*1000/time_freq()),
# 1,
# 1000/SERVER_TICK_SPEED/2));
2022-11-09 12:55:09 +00:00
sleep 0.001
2022-11-08 15:20:46 +00:00
end
end
2024-01-20 13:50:55 +00:00
def run(ip, port, options = {})
options[:detach] = options[:detach] || false
if options[:detach] && @thread_running
puts 'Error: server already running in a thread'
return
end
@server_token = (1..4).to_a.map { |_| rand(0..255) }
@server_token = @server_token.map { |b| b.to_s(16).rjust(2, '0') }.join
puts "server token #{@server_token}"
@netbase = NetBase.new(verbose: @verbose)
NetChunk.reset
@ip = ip
@port = port
puts "listening on #{@ip}:#{@port} .."
@s = UDPSocket.new
@s.bind(@ip, @port)
@netbase.bind(@s)
if options[:detach]
@thread_running = true
Thread.new do
main_loop
end
else
main_loop
end
2024-01-20 14:21:59 +00:00
@game_server.on_shutdown
2024-01-20 13:50:55 +00:00
end
2022-11-11 12:42:11 +00:00
def on_message(chunk, packet)
puts "got game chunk: #{chunk}"
case chunk.msg
2022-11-13 09:37:46 +00:00
when NETMSGTYPE_CL_STARTINFO then @game_server.on_start_info(chunk, packet)
2022-11-13 10:15:33 +00:00
when NETMSGTYPE_CL_SAY then @game_server.on_say(chunk, packet)
2022-11-13 14:54:27 +00:00
when NETMSGTYPE_CL_EMOTICON then @game_server.on_emoticon(chunk, packet)
2024-01-21 07:55:17 +00:00
when NETMSG_NULL then nil # TODO: ddnet ex messages
2022-11-11 12:42:11 +00:00
else
puts "Unsupported game msg: #{chunk.msg}"
exit(1)
end
2022-11-09 15:46:04 +00:00
end
def process_chunk(chunk, packet)
2022-11-09 15:46:04 +00:00
unless chunk.sys
2022-11-11 12:42:11 +00:00
on_message(chunk, packet)
2022-11-09 15:46:04 +00:00
return
end
puts "proccess chunk with msg: #{chunk.msg}" if @verbose
2022-11-09 15:46:04 +00:00
case chunk.msg
when NETMSG_INFO
@game_server.on_info(chunk, packet)
2022-11-11 12:42:11 +00:00
when NETMSG_READY
@game_server.on_ready(chunk, packet)
when NETMSG_ENTERGAME
@game_server.on_enter_game(chunk, packet)
2022-11-12 10:38:46 +00:00
when NETMSG_INPUT
@game_server.on_input(chunk, packet)
2022-11-12 14:46:38 +00:00
when NETMSG_RCON_CMD
@game_server.on_rcon_cmd(chunk, packet)
2024-01-20 14:21:59 +00:00
when NETMSG_RCON_AUTH
@game_server.on_rcon_auth(chunk, packet)
2024-01-22 15:38:31 +00:00
when NETMSG_NULL
2024-01-21 07:55:17 +00:00
nil # TODO: ddnet ex messages
2022-11-09 15:46:04 +00:00
else
puts "Unsupported system msg: #{chunk.msg}"
exit(1)
end
end
def on_client_packet(packet)
client = packet.client
if client.nil?
# TODO: turn this into a silent return
# otherwise bad actors can easily trigger this
# with handcrafted packets
2024-01-21 07:32:22 +00:00
#
# This is currently triggerd by ddnet TKEN packets
# we should handle those correctly somewhere else i think
# if this warning does not show up anymore it can be removed
p packet
puts 'Warning: got client packet from unknown client'
return
end
2022-11-09 15:46:04 +00:00
chunks = BigChungusTheChunkGetter.get_chunks(packet.payload)
chunks.each do |chunk|
if chunk.flags_vital && !chunk.flags_resend
packet.client.bump_ack
puts "got ack: #{packet.client.ack}" if @verbose
2022-11-09 15:46:04 +00:00
end
process_chunk(chunk, packet)
2022-11-09 15:46:04 +00:00
end
2022-11-08 15:20:46 +00:00
end
def on_ctrl_message(packet)
u = Unpacker.new(packet.payload)
msg = u.get_int
puts "got ctrl msg: #{msg}"
case msg
when NET_CTRLMSG_TOKEN then on_ctrl_token(packet)
when NET_CTRLMSG_CONNECT then on_ctrl_connect(packet)
when NET_CTRLMSG_KEEPALIVE then on_ctrl_keep_alive(packet)
when NET_CTRLMSG_CLOSE then on_ctrl_close(packet)
2022-11-08 15:20:46 +00:00
else
puts "Uknown control message #{msg}"
exit(1)
end
end
def send_ctrl_close(client, reason)
# when clients disconnect
# during the connection process
# we do not care
return if client.nil?
msg = [NET_CTRLMSG_CLOSE]
msg += Packer.pack_str(reason) unless reason.nil?
2022-11-12 11:51:09 +00:00
@netbase.set_peer_token(client.token)
@netbase.send_packet(msg, chunks: 0, control: true, client:)
2022-11-12 11:51:09 +00:00
# @netbase.set_peer_token(@server_token)
end
2022-11-08 15:20:46 +00:00
def send_ctrl_with_token(addr, token)
2022-11-11 13:37:41 +00:00
msg = [NET_CTRLMSG_TOKEN] + str_bytes(@server_token)
2022-11-12 11:51:09 +00:00
@netbase.set_peer_token(token)
@netbase.send_packet(msg, chunks: 0, control: true, addr:)
2022-11-12 11:51:09 +00:00
# @netbase.set_peer_token(@server_token)
2022-11-08 15:20:46 +00:00
end
2022-11-12 10:18:12 +00:00
def send_map(client)
data = []
data += Packer.pack_str(@game_server.map.name)
data += @game_server.map.crc_arr # poor mans pack_raw()
data += Packer.pack_int(@game_server.map.size)
data += Packer.pack_int(8) # chunk num?
data += Packer.pack_int(MAP_CHUNK_SIZE)
data += @game_server.map.sha256_arr # poor mans pack_raw()
2022-11-12 10:18:12 +00:00
msg = NetChunk.create_header(vital: true, size: data.size + 1, client:) +
[pack_msg_id(NETMSG_MAP_CHANGE, system: true)] +
data
@netbase.send_packet(msg, chunks: 1, client:)
end
2024-01-20 14:32:12 +00:00
def send_rcon_auth_on(client)
msg = NetChunk.create_header(vital: true, size: 1, client:) +
[pack_msg_id(NETMSG_RCON_AUTH_ON, system: true)]
@netbase.send_packet(msg, chunks: 1, client:)
end
2022-11-12 10:18:12 +00:00
def send_ready(client)
msg = NetChunk.create_header(vital: true, size: 1, client:) +
2022-11-11 12:42:11 +00:00
[pack_msg_id(NETMSG_CON_READY, system: true)]
@netbase.send_packet(msg, chunks: 1, client:)
2022-11-11 12:42:11 +00:00
end
2022-11-12 10:18:12 +00:00
def send_ready_to_enter(client)
msg = NetChunk.create_header(vital: true, size: 1, client:) +
2022-11-11 12:42:11 +00:00
[pack_msg_id(NETMSGTYPE_SV_READYTOENTER, system: false)]
@netbase.send_packet(msg, chunks: 1, client:)
2022-11-11 12:42:11 +00:00
end
2022-11-13 08:40:05 +00:00
def send_server_settings(client, server_settings)
msg = NetChunk.create_header(vital: true, size: 1 + server_settings.size, client:) +
[pack_msg_id(NETMSGTYPE_SV_SERVERSETTINGS, system: false)] +
server_settings
@netbase.send_packet(msg, chunks: 1, client:)
end
2022-11-12 10:18:12 +00:00
def send_server_info(client, server_info)
msg = NetChunk.create_header(vital: true, size: 1 + server_info.size, client:) +
2022-11-11 12:42:11 +00:00
[pack_msg_id(NETMSG_SERVERINFO, system: true)] +
server_info
@netbase.send_packet(msg, chunks: 1, client:)
2022-11-11 12:42:11 +00:00
end
2022-11-12 10:18:12 +00:00
def send_game_info(client, data)
msg = NetChunk.create_header(vital: true, size: 1 + data.size, client:) +
2022-11-11 12:42:11 +00:00
[pack_msg_id(NETMSGTYPE_SV_GAMEINFO, system: false)] +
data
@netbase.send_packet(msg, chunks: 1, client:)
2022-11-11 12:42:11 +00:00
end
2022-11-08 15:20:46 +00:00
def on_ctrl_token(packet)
u = Unpacker.new(packet.payload[1..])
token = u.get_raw(4)
2022-11-12 11:51:09 +00:00
token_str = token.map { |b| b.to_s(16).rjust(2, '0') }.join
puts "got token #{token_str}"
send_ctrl_with_token(packet.addr, token_str)
2022-11-08 15:20:46 +00:00
end
def on_ctrl_keep_alive(packet)
puts "Got keep alive from #{packet.addr}" if @verbose
end
def on_ctrl_close(packet)
reason = nil
if packet.payload[2]
u = Unpacker.new(packet.payload[1..])
reason = u.get_string
end
drop_client(packet.client, reason)
end
def drop_client(client, reason = nil)
send_ctrl_close(client, reason)
return if client.nil?
@game_server.on_client_drop(client, reason)
@clients.delete(client.id)
end
def on_ctrl_connect(packet)
id = get_next_client_id
if id == -1
puts 'server full drop packet. TODO: tell the client'
return
end
2022-11-12 14:55:24 +00:00
token = bytes_to_str(packet.payload[1..4])
2022-11-12 11:51:09 +00:00
puts "got connection, sending accept (client token: #{token})"
client = Client.new(id:, addr: packet.addr, token:)
@clients[id] = client
@netbase.send_packet([NET_CTRLMSG_ACCEPT], chunks: 0, control: true, client:)
end
2022-11-08 15:20:46 +00:00
def on_packet(packet)
# process connless packets data
if packet.flags_control
on_ctrl_message(packet)
else # process non-connless packets
on_client_packet(packet)
end
end
def get_next_client_id
(0..MAX_CLIENTS).each do |i|
next if @clients[i]
return i
end
-1
end
def tick_start_time(tick)
# TODO: implement this C++ code
# m_GameStartTime + (time_freq()*Tick)/SERVER_TICK_SPEED;
end
def do_snapshot
delta_tick = -1
# DeltaTick = m_aClients[i].m_LastAckedSnapshot;
data = []
data += Packer.pack_int(@current_game_tick)
data += Packer.pack_int(@current_game_tick - delta_tick)
2022-11-12 09:13:29 +00:00
msg_snap_empty = NetChunk.create_header(vital: false, size: data.size + 1) +
[pack_msg_id(NETMSG_SNAPEMPTY, system: true)] +
data
2022-11-13 16:24:13 +00:00
# data = []
# data += Packer.pack_int(@current_game_tick)
# data += Packer.pack_int(@current_game_tick - delta_tick)
# msg_snap_single = NetChunk.create_header(vital: false, size: data.size + 1) +
# [pack_msg_id(NETMSG_SNAPSINGLE, system: true)] +
# data
2024-01-20 14:37:18 +00:00
@clients.each_value do |client|
2022-11-13 07:40:17 +00:00
next unless client.in_game?
@netbase.send_packet(msg_snap_empty, chunks: 1, client:)
end
end
2022-11-13 10:15:33 +00:00
def get_player_by_id(id)
@clients[id]&.player
end
2022-11-08 15:20:46 +00:00
def tick
unless @clients.empty?
now = Time.now
diff = now - @last_snap_time
# TODO: replace snaps every second by something more correct
if diff > 1
@current_game_tick += 1
do_snapshot
end
@game_server.on_tick
end
2022-11-08 15:20:46 +00:00
begin
data, sender_inet_addr = @s.recvfrom_nonblock(1400)
2022-11-08 15:20:46 +00:00
rescue IO::EAGAINWaitReadable
data = nil
sender_inet_addr = nil
2022-11-08 15:20:46 +00:00
end
return unless data
packet = Packet.new(data, '<')
packet.addr.ip = sender_inet_addr[2] # or 3 idk bot 127.0.0.1 in my local test case
packet.addr.port = sender_inet_addr[1]
@clients.each do |id, client|
next unless packet.addr.eq(client.addr)
client.last_recv_time = Time.now
packet.client_id = id
2022-11-12 10:18:12 +00:00
packet.client = client
end
2024-01-20 14:33:25 +00:00
puts packet if @verbose
2022-11-08 15:20:46 +00:00
on_packet(packet)
end
end