mirror of
https://github.com/tribufu/rust-gamedig
synced 2026-06-01 09:42:41 +00:00
refator: copy cli into mono
This commit is contained in:
Cain
parent
66ae3c296e
commit
80f6b87991
63 changed files with 244 additions and 34 deletions
|
|
@ -1,483 +0,0 @@
|
|||
use crate::{
|
||||
buffer::Buffer,
|
||||
protocols::{
|
||||
types::TimeoutSettings,
|
||||
valve::{
|
||||
types::{
|
||||
Environment,
|
||||
ExtraData,
|
||||
GatheringSettings,
|
||||
Request,
|
||||
Response,
|
||||
Server,
|
||||
ServerInfo,
|
||||
ServerPlayer,
|
||||
TheShip,
|
||||
},
|
||||
Engine,
|
||||
ModData,
|
||||
SteamApp,
|
||||
},
|
||||
},
|
||||
socket::{Socket, UdpSocket},
|
||||
utils::{retry_on_timeout, u8_lower_upper},
|
||||
GDErrorKind::{BadGame, Decompress, UnknownEnumCast},
|
||||
GDResult,
|
||||
};
|
||||
|
||||
use bzip2_rs::decoder::Decoder;
|
||||
|
||||
use crate::buffer::Utf8Decoder;
|
||||
use crate::protocols::valve::Packet;
|
||||
use byteorder::LittleEndian;
|
||||
use std::collections::HashMap;
|
||||
use std::net::SocketAddr;
|
||||
|
||||
#[derive(Debug)]
|
||||
#[allow(dead_code)] //remove this later on
|
||||
struct SplitPacket {
|
||||
pub header: u32,
|
||||
pub id: u32,
|
||||
pub total: u8,
|
||||
pub number: u8,
|
||||
pub size: u16,
|
||||
/// None means its not compressed, Some means it is
|
||||
/// and it contains (size and crc32)
|
||||
pub decompressed: Option<(u32, u32)>,
|
||||
payload: Vec<u8>,
|
||||
}
|
||||
|
||||
impl SplitPacket {
|
||||
fn new(engine: &Engine, protocol: u8, buffer: &mut Buffer<LittleEndian>) -> GDResult<Self> {
|
||||
let header = buffer.read()?; //buffer.get_u32()?;
|
||||
let id = buffer.read()?;
|
||||
let (total, number, size, decompressed) = match engine {
|
||||
Engine::GoldSrc(_) => {
|
||||
let (lower, upper) = u8_lower_upper(buffer.read()?);
|
||||
(lower, upper, 0, None)
|
||||
}
|
||||
Engine::Source(_) => {
|
||||
let total = buffer.read()?;
|
||||
let number = buffer.read()?;
|
||||
let size = match protocol == 7 && (*engine == SteamApp::CSS.as_engine()) {
|
||||
// certain apps with protocol = 7 dont have this field
|
||||
false => buffer.read()?,
|
||||
true => 1248,
|
||||
};
|
||||
|
||||
let is_compressed = ((id >> 31) & 1u32) == 1u32;
|
||||
let decompressed = match is_compressed {
|
||||
false => None,
|
||||
true => Some((buffer.read()?, buffer.read()?)),
|
||||
};
|
||||
|
||||
(total, number, size, decompressed)
|
||||
}
|
||||
};
|
||||
|
||||
Ok(Self {
|
||||
header,
|
||||
id,
|
||||
total,
|
||||
number,
|
||||
size,
|
||||
decompressed,
|
||||
payload: buffer.remaining_bytes().to_vec(),
|
||||
})
|
||||
}
|
||||
|
||||
fn get_payload(&self) -> GDResult<Vec<u8>> {
|
||||
if let Some(decompressed) = self.decompressed {
|
||||
let mut decoder = Decoder::new();
|
||||
decoder
|
||||
.write(&self.payload)
|
||||
.map_err(|e| Decompress.context(e))?;
|
||||
|
||||
let decompressed_size = decompressed.0 as usize;
|
||||
|
||||
let mut decompressed_payload = vec![0; decompressed_size];
|
||||
|
||||
decoder
|
||||
.read(&mut decompressed_payload)
|
||||
.map_err(|e| Decompress.context(e))?;
|
||||
|
||||
if decompressed_payload.len() != decompressed_size
|
||||
|| crc32fast::hash(&decompressed_payload) != decompressed.1
|
||||
{
|
||||
Err(Decompress.context(format!(
|
||||
"Decompressed size {} was not expected {}",
|
||||
decompressed_payload.len(),
|
||||
decompressed_size
|
||||
)))
|
||||
} else {
|
||||
Ok(decompressed_payload)
|
||||
}
|
||||
} else {
|
||||
Ok(self.payload.clone())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) struct ValveProtocol {
|
||||
socket: UdpSocket,
|
||||
retry_count: usize,
|
||||
}
|
||||
|
||||
static PACKET_SIZE: usize = 6144;
|
||||
|
||||
impl ValveProtocol {
|
||||
pub fn new(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
|
||||
let socket = UdpSocket::new(address)?;
|
||||
let retry_count = timeout_settings
|
||||
.as_ref()
|
||||
.map(|t| t.get_retries())
|
||||
.unwrap_or_else(|| TimeoutSettings::default().get_retries());
|
||||
socket.apply_timeout(&timeout_settings)?;
|
||||
|
||||
Ok(Self {
|
||||
socket,
|
||||
retry_count,
|
||||
})
|
||||
}
|
||||
|
||||
fn receive(&mut self, engine: &Engine, protocol: u8, buffer_size: usize) -> GDResult<Packet> {
|
||||
let data = self.socket.receive(Some(buffer_size))?;
|
||||
let mut buffer = Buffer::<LittleEndian>::new(&data);
|
||||
|
||||
let header: u8 = buffer.read()?;
|
||||
buffer.move_cursor(-1)?;
|
||||
if header == 0xFE {
|
||||
// the packet is split
|
||||
let mut main_packet = SplitPacket::new(engine, protocol, &mut buffer)?;
|
||||
let mut chunk_packets = Vec::with_capacity((main_packet.total - 1) as usize);
|
||||
|
||||
for _ in 1 .. main_packet.total {
|
||||
let new_data = self.socket.receive(Some(buffer_size))?;
|
||||
buffer = Buffer::<LittleEndian>::new(&new_data);
|
||||
let chunk_packet = SplitPacket::new(engine, protocol, &mut buffer)?;
|
||||
chunk_packets.push(chunk_packet);
|
||||
}
|
||||
|
||||
chunk_packets.sort_by(|a, b| a.number.cmp(&b.number));
|
||||
|
||||
for chunk_packet in chunk_packets {
|
||||
main_packet.payload.extend(chunk_packet.payload);
|
||||
}
|
||||
|
||||
let payload = main_packet.get_payload()?; // Creating a non-temporary value here
|
||||
let mut new_packet_buffer = Buffer::<LittleEndian>::new(&payload); // Using the non-temporary value here
|
||||
Ok(Packet::new_from_bufferer(&mut new_packet_buffer)?)
|
||||
} else {
|
||||
Packet::new_from_bufferer(&mut buffer)
|
||||
}
|
||||
}
|
||||
|
||||
pub fn get_kind_request_data(&mut self, engine: &Engine, protocol: u8, kind: Request) -> GDResult<Vec<u8>> {
|
||||
let data = self.get_request_data(engine, protocol, kind as u8, kind.get_default_payload())?;
|
||||
Ok(data)
|
||||
}
|
||||
|
||||
/// Ask for a specific request only.
|
||||
/// This function will retry fetch on timeouts.
|
||||
pub fn get_request_data(&mut self, engine: &Engine, protocol: u8, kind: u8, payload: Vec<u8>) -> GDResult<Vec<u8>> {
|
||||
retry_on_timeout(self.retry_count, || {
|
||||
self.get_request_data_impl(engine, protocol, kind, payload.clone())
|
||||
})
|
||||
}
|
||||
|
||||
/// Ask for a specific request only (without retry logic).
|
||||
fn get_request_data_impl(
|
||||
&mut self,
|
||||
engine: &Engine,
|
||||
protocol: u8,
|
||||
kind: u8,
|
||||
payload: Vec<u8>,
|
||||
) -> GDResult<Vec<u8>> {
|
||||
let request_initial_packet = Packet::new(kind, payload).to_bytes();
|
||||
self.socket.send(&request_initial_packet)?;
|
||||
|
||||
let mut packet = self.receive(engine, protocol, PACKET_SIZE)?;
|
||||
while packet.kind == 0x41 {
|
||||
// 'A'
|
||||
let challenge = packet.payload;
|
||||
|
||||
const INFO: u8 = Request::Info as u8;
|
||||
let challenge_packet = Packet::new(
|
||||
kind,
|
||||
match kind {
|
||||
INFO => [Request::Info.get_default_payload(), challenge].concat(),
|
||||
_ => challenge,
|
||||
},
|
||||
)
|
||||
.to_bytes();
|
||||
|
||||
self.socket.send(&challenge_packet)?;
|
||||
|
||||
packet = self.receive(engine, protocol, PACKET_SIZE)?;
|
||||
}
|
||||
|
||||
Ok(packet.payload)
|
||||
}
|
||||
|
||||
fn get_goldsrc_server_info(buffer: &mut Buffer<LittleEndian>) -> GDResult<ServerInfo> {
|
||||
let _header: u8 = buffer.read()?; //get the header (useless info)
|
||||
let _address: String = buffer.read_string::<Utf8Decoder>(None)?; //get the server address (useless info)
|
||||
let name = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let map = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let folder = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let game_mode = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let players = buffer.read()?;
|
||||
let max_players = buffer.read()?;
|
||||
let protocol = buffer.read()?;
|
||||
let server_type = match buffer.read::<u8>()? {
|
||||
68 => Server::Dedicated, //'D'
|
||||
76 => Server::NonDedicated, //'L'
|
||||
80 => Server::TV, //'P'
|
||||
_ => Err(UnknownEnumCast)?,
|
||||
};
|
||||
let environment_type = match buffer.read::<u8>()? {
|
||||
76 => Environment::Linux, //'L'
|
||||
87 => Environment::Windows, //'W'
|
||||
_ => Err(UnknownEnumCast)?,
|
||||
};
|
||||
let has_password = buffer.read::<u8>()? == 1;
|
||||
let is_mod = buffer.read::<u8>()? == 1;
|
||||
let mod_data = match is_mod {
|
||||
false => None,
|
||||
true => {
|
||||
Some(ModData {
|
||||
link: buffer.read_string::<Utf8Decoder>(None)?,
|
||||
download_link: buffer.read_string::<Utf8Decoder>(None)?,
|
||||
version: buffer.read()?,
|
||||
size: buffer.read()?,
|
||||
multiplayer_only: buffer.read::<u8>()? == 1,
|
||||
has_own_dll: buffer.read::<u8>()? == 1,
|
||||
})
|
||||
}
|
||||
};
|
||||
let vac_secured = buffer.read::<u8>()? == 1;
|
||||
let bots = buffer.read::<u8>()?;
|
||||
|
||||
Ok(ServerInfo {
|
||||
protocol_version: protocol,
|
||||
name,
|
||||
map,
|
||||
folder,
|
||||
game_mode,
|
||||
appid: 0, // not present in the obsolete response
|
||||
players_online: players,
|
||||
players_maximum: max_players,
|
||||
players_bots: bots,
|
||||
server_type,
|
||||
environment_type,
|
||||
has_password,
|
||||
vac_secured,
|
||||
the_ship: None,
|
||||
game_version: "".to_string(), // a version field only for the mod
|
||||
extra_data: None,
|
||||
is_mod,
|
||||
mod_data,
|
||||
})
|
||||
}
|
||||
|
||||
/// Get the server information's.
|
||||
fn get_server_info(&mut self, engine: &Engine) -> GDResult<ServerInfo> {
|
||||
let data = self.get_kind_request_data(engine, 0, Request::Info)?;
|
||||
let mut buffer = Buffer::<LittleEndian>::new(&data);
|
||||
|
||||
if let Engine::GoldSrc(force) = engine {
|
||||
if *force {
|
||||
return Self::get_goldsrc_server_info(&mut buffer);
|
||||
}
|
||||
}
|
||||
|
||||
let protocol = buffer.read()?;
|
||||
let name = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let map = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let folder = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let game_mode = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let mut appid = buffer.read::<u16>()? as u32;
|
||||
let players = buffer.read()?;
|
||||
let max_players = buffer.read()?;
|
||||
let bots = buffer.read()?;
|
||||
let server_type = Server::from_gldsrc(buffer.read()?)?;
|
||||
let environment_type = Environment::from_gldsrc(buffer.read()?)?;
|
||||
let has_password = buffer.read::<u8>()? == 1;
|
||||
let vac_secured = buffer.read::<u8>()? == 1;
|
||||
let the_ship = match *engine == SteamApp::THESHIP.as_engine() {
|
||||
false => None,
|
||||
true => {
|
||||
Some(TheShip {
|
||||
mode: buffer.read()?,
|
||||
witnesses: buffer.read()?,
|
||||
duration: buffer.read()?,
|
||||
})
|
||||
}
|
||||
};
|
||||
let game_version = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let extra_data = match buffer.read::<u8>() {
|
||||
Err(_) => None,
|
||||
Ok(value) => {
|
||||
Some(ExtraData {
|
||||
port: match (value & 0x80) > 0 {
|
||||
false => None,
|
||||
true => Some(buffer.read()?),
|
||||
},
|
||||
steam_id: match (value & 0x10) > 0 {
|
||||
false => None,
|
||||
true => Some(buffer.read()?),
|
||||
},
|
||||
tv_port: match (value & 0x40) > 0 {
|
||||
false => None,
|
||||
true => Some(buffer.read()?),
|
||||
},
|
||||
tv_name: match (value & 0x40) > 0 {
|
||||
false => None,
|
||||
true => Some(buffer.read_string::<Utf8Decoder>(None)?),
|
||||
},
|
||||
keywords: match (value & 0x20) > 0 {
|
||||
false => None,
|
||||
true => Some(buffer.read_string::<Utf8Decoder>(None)?),
|
||||
},
|
||||
game_id: match (value & 0x01) > 0 {
|
||||
false => None,
|
||||
true => {
|
||||
let gid = buffer.read()?;
|
||||
appid = (gid & ((1 << 24) - 1)) as u32;
|
||||
|
||||
Some(gid)
|
||||
}
|
||||
},
|
||||
})
|
||||
}
|
||||
};
|
||||
|
||||
Ok(ServerInfo {
|
||||
protocol_version: protocol,
|
||||
name,
|
||||
map,
|
||||
folder,
|
||||
game_mode,
|
||||
appid,
|
||||
players_online: players,
|
||||
players_maximum: max_players,
|
||||
players_bots: bots,
|
||||
server_type,
|
||||
environment_type,
|
||||
has_password,
|
||||
vac_secured,
|
||||
the_ship,
|
||||
game_version,
|
||||
extra_data,
|
||||
is_mod: false,
|
||||
mod_data: None,
|
||||
})
|
||||
}
|
||||
|
||||
/// Get the server player's.
|
||||
fn get_server_players(&mut self, engine: &Engine, protocol: u8) -> GDResult<Vec<ServerPlayer>> {
|
||||
let data = self.get_kind_request_data(engine, protocol, Request::Players)?;
|
||||
let mut buffer = Buffer::<LittleEndian>::new(&data);
|
||||
|
||||
let count = buffer.read::<u8>()? as usize;
|
||||
let mut players: Vec<ServerPlayer> = Vec::with_capacity(count);
|
||||
|
||||
for _ in 0 .. count {
|
||||
buffer.move_cursor(1)?; //skip the index byte
|
||||
|
||||
players.push(ServerPlayer {
|
||||
name: buffer.read_string::<Utf8Decoder>(None)?,
|
||||
score: buffer.read()?,
|
||||
duration: buffer.read()?,
|
||||
deaths: match *engine == SteamApp::THESHIP.as_engine() {
|
||||
false => None,
|
||||
true => Some(buffer.read()?),
|
||||
},
|
||||
money: match *engine == SteamApp::THESHIP.as_engine() {
|
||||
false => None,
|
||||
true => Some(buffer.read()?),
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
Ok(players)
|
||||
}
|
||||
|
||||
/// Get the server's rules.
|
||||
fn get_server_rules(&mut self, engine: &Engine, protocol: u8) -> GDResult<HashMap<String, String>> {
|
||||
let data = self.get_kind_request_data(engine, protocol, Request::Rules)?;
|
||||
let mut buffer = Buffer::<LittleEndian>::new(&data);
|
||||
|
||||
let count = buffer.read::<u16>()? as usize;
|
||||
let mut rules: HashMap<String, String> = HashMap::with_capacity(count);
|
||||
|
||||
for _ in 0 .. count {
|
||||
let name = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
let value = buffer.read_string::<Utf8Decoder>(None)?;
|
||||
|
||||
rules.insert(name, value);
|
||||
}
|
||||
|
||||
if *engine == SteamApp::ROR2.as_engine() {
|
||||
rules.remove("Test");
|
||||
}
|
||||
|
||||
Ok(rules)
|
||||
}
|
||||
}
|
||||
|
||||
/// Query a server by providing the address, the port, the app, gather and
|
||||
/// timeout settings. Providing None to the settings results in using the
|
||||
/// default values for them
|
||||
/// (GatherSettings::[default](GatheringSettings::default),
|
||||
/// TimeoutSettings::[default](TimeoutSettings::default)).
|
||||
pub fn query(
|
||||
address: &SocketAddr,
|
||||
engine: Engine,
|
||||
gather_settings: Option<GatheringSettings>,
|
||||
timeout_settings: Option<TimeoutSettings>,
|
||||
) -> GDResult<Response> {
|
||||
let response_gather_settings = gather_settings.unwrap_or_default();
|
||||
get_response(address, engine, response_gather_settings, timeout_settings)
|
||||
}
|
||||
|
||||
fn get_response(
|
||||
address: &SocketAddr,
|
||||
engine: Engine,
|
||||
gather_settings: GatheringSettings,
|
||||
timeout_settings: Option<TimeoutSettings>,
|
||||
) -> GDResult<Response> {
|
||||
let mut client = ValveProtocol::new(address, timeout_settings)?;
|
||||
|
||||
let info = client.get_server_info(&engine)?;
|
||||
|
||||
if let Engine::Source(Some(appids)) = &engine {
|
||||
let mut is_specified_id = false;
|
||||
|
||||
if appids.0 == info.appid {
|
||||
is_specified_id = true;
|
||||
} else if let Some(dedicated_appid) = appids.1 {
|
||||
if dedicated_appid == info.appid {
|
||||
is_specified_id = true;
|
||||
}
|
||||
}
|
||||
|
||||
if !is_specified_id && gather_settings.check_app_id {
|
||||
return Err(BadGame.context(format!("AppId: {}", info.appid)));
|
||||
}
|
||||
}
|
||||
|
||||
let protocol = info.protocol_version;
|
||||
|
||||
Ok(Response {
|
||||
info,
|
||||
players: match gather_settings.players {
|
||||
false => None,
|
||||
true => Some(client.get_server_players(&engine, protocol)?),
|
||||
},
|
||||
rules: match gather_settings.rules {
|
||||
false => None,
|
||||
true => Some(client.get_server_rules(&engine, protocol)?),
|
||||
},
|
||||
})
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue