tribufu/node-gamedig
1
0
Fork 0
mirror of https://github.com/tribufu/node-gamedig synced 2026-06-01 09:42:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Replace use of deprecated internal debugLog with logger.debug

Browse source
This commit is contained in:
CosminPerRam 2023-09-18 10:48:24 +03:00
parent ca69e76ed3
commit bff9507189
12 changed files with 64 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

4
protocols/battlefield.js
View file

@ -111,7 +111,7 @@ export default class battlefield extends Core {
return await this.tcpSend(socket, outPacket, (data) => { return await this.tcpSend(socket, outPacket, (data) => {
const decoded = this.decodePacket(data); const decoded = this.decodePacket(data);
if(decoded) { if(decoded) {
this.debugLog(decoded); this.logger.debug(decoded);
if(decoded.shift() !== 'OK') throw new Error('Missing OK'); if(decoded.shift() !== 'OK') throw new Error('Missing OK');
return decoded; return decoded;
} }
@ -148,7 +148,7 @@ export default class battlefield extends Core {
const header = reader.uint(4); const header = reader.uint(4);
const totalLength = reader.uint(4); const totalLength = reader.uint(4);
if(buffer.length < totalLength) return false; if(buffer.length < totalLength) return false;
this.debugLog("Expected " + totalLength + " bytes, have " + buffer.length); this.logger.debug("Expected " + totalLength + " bytes, have " + buffer.length);
const paramCount = reader.uint(4); const paramCount = reader.uint(4);
const params = []; const params = [];

19
protocols/core.js
View file

@ -111,7 +111,7 @@ export default class Core extends EventEmitter {
this.registerRtt(rtt); this.registerRtt(rtt);
}).catch(() => {}); }).catch(() => {});
} else { } else {
this.debugLog("Registered RTT: " + param + "ms"); this.logger.debug("Registered RTT: " + param + "ms");
if (this.shortestRTT === 0 || param < this.shortestRTT) { if (this.shortestRTT === 0 || param < this.shortestRTT) {
this.shortestRTT = param; this.shortestRTT = param;
} }
@ -173,8 +173,8 @@ export default class Core extends EventEmitter {
// Prevent unhandled 'error' events from dumping straight to console // Prevent unhandled 'error' events from dumping straight to console
socket.on('error', () => {}); socket.on('error', () => {});
this.debugLog(log => { this.logger.debug(log => {
this.debugLog(address+':'+port+" TCP Connecting"); this.logger.debug(address+':'+port+" TCP Connecting");
const writeHook = socket.write; const writeHook = socket.write;
socket.write = (...args) => { socket.write = (...args) => {
log(address+':'+port+" TCP-->"); log(address+':'+port+" TCP-->");
@ -276,7 +276,7 @@ export default class Core extends EventEmitter {
} }
const result = onPacket(buffer); const result = onPacket(buffer);
if (result !== undefined) { if (result !== undefined) {
this.debugLog("UDP send finished by callback"); this.logger.debug("UDP send finished by callback");
resolve(result); resolve(result);
} }
} catch(e) { } catch(e) {
@ -288,12 +288,12 @@ export default class Core extends EventEmitter {
timeout = Promises.createTimeout(this.options.socketTimeout, 'UDP'); timeout = Promises.createTimeout(this.options.socketTimeout, 'UDP');
const wrappedTimeout = new Promise((resolve, reject) => { const wrappedTimeout = new Promise((resolve, reject) => {
timeout.catch((e) => { timeout.catch((e) => {
this.debugLog("UDP timeout detected"); this.logger.debug("UDP timeout detected");
if (onTimeout) { if (onTimeout) {
try { try {
const result = onTimeout(); const result = onTimeout();
if (result !== undefined) { if (result !== undefined) {
this.debugLog("UDP timeout resolved by callback"); this.logger.debug("UDP timeout resolved by callback");
resolve(result); resolve(result);
return; return;
} }
@ -331,7 +331,7 @@ export default class Core extends EventEmitter {
request: this.options.socketTimeout request: this.options.socketTimeout
} }
}); });
this.debugLog(log => { this.logger.debug(log => {
log(() => params.url + " HTTP-->"); log(() => params.url + " HTTP-->");
requestPromise requestPromise
.then((response) => log(params.url + " <--HTTP " + response.statusCode)) .then((response) => log(params.url + " <--HTTP " + response.statusCode))
@ -346,9 +346,4 @@ export default class Core extends EventEmitter {
requestPromise && requestPromise.cancel(); requestPromise && requestPromise.cancel();
} }
} }
/** @deprecated */
debugLog(...args) {
this.logger.debug(...args);
}
} }

36
protocols/doom3.js
View file

@ -32,7 +32,7 @@ export default class doom3 extends Core {
if (packetContainsSize) { if (packetContainsSize) {
const size = reader.uint(4); const size = reader.uint(4);
this.debugLog("Received packet size: " + size); this.logger.debug("Received packet size: " + size);
} }
while(!reader.done()) { while(!reader.done()) {
@ -44,7 +44,7 @@ export default class doom3 extends Core {
} }
if(!key) break; if(!key) break;
state.raw[key] = value; state.raw[key] = value;
this.debugLog(key + "=" + value); this.logger.debug(key + "=" + value);
} }
const isEtqw = state.raw.gamename && state.raw.gamename.toLowerCase().includes('etqw'); const isEtqw = state.raw.gamename && state.raw.gamename.toLowerCase().includes('etqw');
@ -91,51 +91,51 @@ export default class doom3 extends Core {
} }
attemptPlayerParse(rest, isEtqw, hasClanTag, hasClanTagPos, hasTypeFlag) { attemptPlayerParse(rest, isEtqw, hasClanTag, hasClanTagPos, hasTypeFlag) {
this.debugLog("starting player parse attempt:"); this.logger.debug("starting player parse attempt:");
this.debugLog("isEtqw: " + isEtqw); this.logger.debug("isEtqw: " + isEtqw);
this.debugLog("hasClanTag: " + hasClanTag); this.logger.debug("hasClanTag: " + hasClanTag);
this.debugLog("hasClanTagPos: " + hasClanTagPos); this.logger.debug("hasClanTagPos: " + hasClanTagPos);
this.debugLog("hasTypeFlag: " + hasTypeFlag); this.logger.debug("hasTypeFlag: " + hasTypeFlag);
const reader = this.reader(rest); const reader = this.reader(rest);
let lastId = -1; let lastId = -1;
const players = []; const players = [];
while(true) { while(true) {
this.debugLog("---"); this.logger.debug("---");
if (reader.done()) { if (reader.done()) {
this.debugLog("* aborting attempt, overran buffer *"); this.logger.debug("* aborting attempt, overran buffer *");
return null; return null;
} }
const player = {}; const player = {};
player.id = reader.uint(1); player.id = reader.uint(1);
this.debugLog("id: " + player.id); this.logger.debug("id: " + player.id);
if (player.id <= lastId || player.id > 0x20) { if (player.id <= lastId || player.id > 0x20) {
this.debugLog("* aborting attempt, invalid player id *"); this.logger.debug("* aborting attempt, invalid player id *");
return null; return null;
} }
lastId = player.id; lastId = player.id;
if(player.id === 0x20) { if(player.id === 0x20) {
this.debugLog("* player parse successful *"); this.logger.debug("* player parse successful *");
break; break;
} }
player.ping = reader.uint(2); player.ping = reader.uint(2);
this.debugLog("ping: " + player.ping); this.logger.debug("ping: " + player.ping);
if(!isEtqw) { if(!isEtqw) {
player.rate = reader.uint(4); player.rate = reader.uint(4);
this.debugLog("rate: " + player.rate); this.logger.debug("rate: " + player.rate);
} }
player.name = this.stripColors(reader.string()); player.name = this.stripColors(reader.string());
this.debugLog("name: " + player.name); this.logger.debug("name: " + player.name);
if(hasClanTag) { if(hasClanTag) {
if(hasClanTagPos) { if(hasClanTagPos) {
const clanTagPos = reader.uint(1); const clanTagPos = reader.uint(1);
this.debugLog("clanTagPos: " + clanTagPos); this.logger.debug("clanTagPos: " + clanTagPos);
} }
player.clantag = this.stripColors(reader.string()); player.clantag = this.stripColors(reader.string());
this.debugLog("clan tag: " + player.clantag); this.logger.debug("clan tag: " + player.clantag);
} }
if(hasTypeFlag) { if(hasTypeFlag) {
player.typeflag = reader.uint(1); player.typeflag = reader.uint(1);
this.debugLog("type flag: " + player.typeflag); this.logger.debug("type flag: " + player.typeflag);
} }
players.push(player); players.push(player);
} }

2
protocols/ffow.js
View file

@ -7,7 +7,7 @@ export default class ffow extends valve {
this.legacyChallenge = true; this.legacyChallenge = true;
} }
async queryInfo(state) { async queryInfo(state) {
this.debugLog("Requesting ffow info ..."); this.logger.debug("Requesting ffow info ...");
const b = await this.sendPacket( const b = await this.sendPacket(
0x46, 0x46,
'LSQ', 'LSQ',

10
protocols/gamespy2.js
View file

@ -87,19 +87,19 @@ export default class gamespy2 extends Core {
// so we can detect this. // so we can detect this.
if (count > 64) { if (count > 64) {
reader.skip(-1); reader.skip(-1);
this.debugLog("Detected missing count byte, rewinding by 1"); this.logger.debug("Detected missing count byte, rewinding by 1");
} else { } else {
this.debugLog("Detected row count: " + count); this.logger.debug("Detected row count: " + count);
} }
this.debugLog(() => "Reading fields, starting at: "+reader.rest()); this.logger.debug(() => "Reading fields, starting at: "+reader.rest());
const fields = []; const fields = [];
while(!reader.done()) { while(!reader.done()) {
let field = reader.string(); let field = reader.string();
if(!field) break; if(!field) break;
fields.push(field); fields.push(field);
this.debugLog("field:"+field); this.logger.debug("field:"+field);
} }
if (!fields.length) return []; if (!fields.length) return [];
@ -111,7 +111,7 @@ export default class gamespy2 extends Core {
let key = fields[iField]; let key = fields[iField];
let value = reader.string(); let value = reader.string();
if(!value && iField === 0) break outer; if(!value && iField === 0) break outer;
this.debugLog("value:"+value); this.logger.debug("value:"+value);
if(key === 'player_') key = 'name'; if(key === 'player_') key = 'name';
else if(key === 'score_') key = 'score'; else if(key === 'score_') key = 'score';
else if(key === 'deaths_') key = 'deaths'; else if(key === 'deaths_') key = 'deaths';

14
protocols/gamespy3.js
View file

@ -14,7 +14,7 @@ export default class gamespy3 extends Core {
const buffer = await this.sendPacket(9, false, false, false); const buffer = await this.sendPacket(9, false, false, false);
const reader = this.reader(buffer); const reader = this.reader(buffer);
let challenge = parseInt(reader.string()); let challenge = parseInt(reader.string());
this.debugLog("Received challenge key: " + challenge); this.logger.debug("Received challenge key: " + challenge);
if (challenge === 0) { if (challenge === 0) {
// Some servers send us a 0 if they don't want a challenge key used // Some servers send us a 0 if they don't want a challenge key used
// BF2 does this. // BF2 does this.
@ -40,8 +40,8 @@ export default class gamespy3 extends Core {
const packet = packets[iPacket]; const packet = packets[iPacket];
const reader = this.reader(packet); const reader = this.reader(packet);
this.debugLog("Parsing packet #" + iPacket); this.logger.debug("Parsing packet #" + iPacket);
this.debugLog(packet); this.logger.debug(packet);
// Parse raw server key/values // Parse raw server key/values
@ -57,7 +57,7 @@ export default class gamespy3 extends Core {
} }
state.raw[key] = value; state.raw[key] = value;
this.debugLog(key + " = " + value); this.logger.debug(key + " = " + value);
} }
} }
@ -91,7 +91,7 @@ export default class gamespy3 extends Core {
let offset = reader.uint(1); let offset = reader.uint(1);
firstMode = false; firstMode = false;
this.debugLog(() => "Parsing new field: itemType=" + itemType + " fieldName=" + fieldName + " startOffset=" + offset); this.logger.debug(() => "Parsing new field: itemType=" + itemType + " fieldName=" + fieldName + " startOffset=" + offset);
while(!reader.done()) { while(!reader.done()) {
const item = reader.string(); const item = reader.string();
@ -99,7 +99,7 @@ export default class gamespy3 extends Core {
while(items.length <= offset) { items.push({}); } while(items.length <= offset) { items.push({}); }
items[offset][fieldName] = item; items[offset][fieldName] = item;
this.debugLog("* " + item); this.logger.debug("* " + item);
offset++; offset++;
} }
} }
@ -177,7 +177,7 @@ export default class gamespy3 extends Core {
packets[id] = reader.rest(); packets[id] = reader.rest();
if(this.debug) { if(this.debug) {
this.debugLog("Received packet #"+id + (last ? " (last)" : "")); this.logger.debug("Received packet #"+id + (last ? " (last)" : ""));
} }
if(!numPackets || Object.keys(packets).length !== numPackets) return; if(!numPackets || Object.keys(packets).length !== numPackets) return;

6
protocols/minecraftvanilla.js
View file

@ -34,13 +34,13 @@ export default class minecraftvanilla extends Core {
const reader = this.reader(data); const reader = this.reader(data);
const packetId = reader.varint(); const packetId = reader.varint();
this.debugLog("Packet ID: "+packetId); this.logger.debug("Packet ID: "+packetId);
const strLen = reader.varint(); const strLen = reader.varint();
this.debugLog("String Length: "+strLen); this.logger.debug("String Length: "+strLen);
const str = reader.rest().toString('utf8'); const str = reader.rest().toString('utf8');
this.debugLog(str); this.logger.debug(str);
const json = JSON.parse(str); const json = JSON.parse(str);
delete json.favicon; delete json.favicon;

4
protocols/openttd.js
View file

@ -91,13 +91,13 @@ export default class openttd extends Core {
const packetLen = reader.uint(2); const packetLen = reader.uint(2);
if(packetLen !== buffer.length) { if(packetLen !== buffer.length) {
this.debugLog('Invalid reported packet length: '+packetLen+' '+buffer.length); this.logger.debug('Invalid reported packet length: '+packetLen+' '+buffer.length);
return; return;
} }
const packetType = reader.uint(1); const packetType = reader.uint(1);
if(packetType !== expected) { if(packetType !== expected) {
this.debugLog('Unexpected response packet type: '+packetType); this.logger.debug('Unexpected response packet type: '+packetType);
return; return;
} }

6
protocols/tribes1.js
View file

@ -17,17 +17,17 @@ export default class tribes1 extends Core {
const reader = this.reader(buffer); const reader = this.reader(buffer);
const responseByte = reader.uint(1); const responseByte = reader.uint(1);
if (responseByte !== this.responseByte) { if (responseByte !== this.responseByte) {
this.debugLog('Unexpected response byte'); this.logger.debug('Unexpected response byte');
return; return;
} }
const challenge = reader.uint(2); const challenge = reader.uint(2);
if (challenge !== this.challenge) { if (challenge !== this.challenge) {
this.debugLog('Unexpected challenge'); this.logger.debug('Unexpected challenge');
return; return;
} }
const requestByte = reader.uint(1); const requestByte = reader.uint(1);
if (requestByte !== this.requestByte) { if (requestByte !== this.requestByte) {
this.debugLog('Unexpected request byte'); this.logger.debug('Unexpected request byte');
return; return;
} }
return reader; return reader;

6
protocols/tribes1master.js
View file

@ -23,7 +23,7 @@ export default class tribes1master extends Core {
const reader = this.reader(buffer); const reader = this.reader(buffer);
const header = reader.uint(2); const header = reader.uint(2);
if (header !== 0x0610) { if (header !== 0x0610) {
this.debugLog('Header response does not match: ' + header.toString(16)); this.logger.debug('Header response does not match: ' + header.toString(16));
return; return;
} }
const num = reader.uint(1); const num = reader.uint(1);
@ -34,11 +34,11 @@ export default class tribes1master extends Core {
total = t; total = t;
if (num < 1 || num > total) { if (num < 1 || num > total) {
this.debugLog('Invalid packet number: ' + num + ' ' + total); this.logger.debug('Invalid packet number: ' + num + ' ' + total);
return; return;
} }
if (parts.has(num)) { if (parts.has(num)) {
this.debugLog('Duplicate part: ' + num); this.logger.debug('Duplicate part: ' + num);
return; return;
} }

4
protocols/unreal2.js
View file

@ -104,7 +104,7 @@ export default class unreal2 extends Core {
const peek = reader.uint(1); const peek = reader.uint(1);
if (peek !== 1) reader.skip(-1); if (peek !== 1) reader.skip(-1);
this.debugLog(log => { this.logger.debug(log => {
log("UCS2 STRING"); log("UCS2 STRING");
log("UCS2 Length: " + length); log("UCS2 Length: " + length);
log(reader.buffer.slice(reader.i,reader.i+length)); log(reader.buffer.slice(reader.i,reader.i+length));
@ -114,7 +114,7 @@ export default class unreal2 extends Core {
let out = ''; let out = '';
if (ucs2) { if (ucs2) {
out = reader.string({encoding:'ucs2',length:length}); out = reader.string({encoding:'ucs2',length:length});
this.debugLog("UCS2 String decoded: " + out); this.logger.debug("UCS2 String decoded: " + out);
} else if (length > 0) { } else if (length > 0) {
out = reader.string(); out = reader.string();
} }

22
protocols/valve.js
View file

@ -48,7 +48,7 @@ export default class valve extends Core {
} }
async queryInfo(/** Results */ state) { async queryInfo(/** Results */ state) {
this.debugLog("Requesting info ..."); this.logger.debug("Requesting info ...");
const b = await this.sendPacket( const b = await this.sendPacket(
this.goldsrcInfo ? undefined : 0x54, this.goldsrcInfo ? undefined : 0x54,
this.goldsrcInfo ? 'details' : 'Source Engine Query\0', this.goldsrcInfo ? 'details' : 'Source Engine Query\0',
@ -186,7 +186,7 @@ export default class valve extends Core {
if(this.legacyChallenge) { if(this.legacyChallenge) {
// sendPacket will catch the response packet and // sendPacket will catch the response packet and
// save the challenge for us // save the challenge for us
this.debugLog("Requesting legacy challenge key ..."); this.logger.debug("Requesting legacy challenge key ...");
await this.sendPacket( await this.sendPacket(
0x57, 0x57,
null, null,
@ -199,7 +199,7 @@ export default class valve extends Core {
async queryPlayers(/** Results */ state) { async queryPlayers(/** Results */ state) {
state.raw.players = []; state.raw.players = [];
this.debugLog("Requesting player list ..."); this.logger.debug("Requesting player list ...");
const b = await this.sendPacket( const b = await this.sendPacket(
this.goldsrcInfo ? undefined : 0x55, this.goldsrcInfo ? undefined : 0x55,
this.goldsrcInfo ? 'players' : null, this.goldsrcInfo ? 'players' : null,
@ -223,7 +223,7 @@ export default class valve extends Core {
const score = reader.int(4); const score = reader.int(4);
const time = reader.float(); const time = reader.float();
this.debugLog("Found player: "+name+" "+score+" "+time); this.logger.debug("Found player: "+name+" "+score+" "+time);
// connecting players don't count as players. // connecting players don't count as players.
if(!name) continue; if(!name) continue;
@ -251,7 +251,7 @@ export default class valve extends Core {
state.raw.rules = rules; state.raw.rules = rules;
const dayZPayload = []; const dayZPayload = [];
this.debugLog("Requesting rules ..."); this.logger.debug("Requesting rules ...");
if (this.goldsrcInfo) { if (this.goldsrcInfo) {
const b = await this.udpSend('\xff\xff\xff\xffrules', b=>b, ()=>null); const b = await this.udpSend('\xff\xff\xff\xffrules', b=>b, ()=>null);
@ -455,11 +455,11 @@ export default class valve extends Core {
(payload) => { (payload) => {
const reader = this.reader(payload); const reader = this.reader(payload);
const type = reader.uint(1); const type = reader.uint(1);
this.debugLog(() => "Received 0x" + type.toString(16) + " expected 0x" + expect.toString(16)); this.logger.debug(() => "Received 0x" + type.toString(16) + " expected 0x" + expect.toString(16));
if (type === 0x41) { if (type === 0x41) {
const key = reader.uint(4); const key = reader.uint(4);
if (this._challenge !== key) { if (this._challenge !== key) {
this.debugLog('Received new challenge key: 0x' + key.toString(16)); this.logger.debug('Received new challenge key: 0x' + key.toString(16));
this._challenge = key; this._challenge = key;
receivedNewChallengeKey = true; receivedNewChallengeKey = true;
} }
@ -544,7 +544,7 @@ export default class valve extends Core {
const header = reader.int(4); const header = reader.int(4);
if(header === -1) { if(header === -1) {
// full package // full package
this.debugLog("Received full packet"); this.logger.debug("Received full packet");
return onResponse(reader.rest()); return onResponse(reader.rest());
} }
if(header === -2) { if(header === -2) {
@ -572,8 +572,8 @@ export default class valve extends Core {
packets[packetNum] = payload; packets[packetNum] = payload;
this.debugLog(() => "Received partial packet uid: 0x"+uid.toString(16)+" num: "+packetNum); this.logger.debug(() => "Received partial packet uid: 0x"+uid.toString(16)+" num: "+packetNum);
this.debugLog(() => "Received "+Object.keys(packets).length+'/'+numPackets+" packets for this UID"); this.logger.debug(() => "Received "+Object.keys(packets).length+'/'+numPackets+" packets for this UID");
if(Object.keys(packets).length !== numPackets) return; if(Object.keys(packets).length !== numPackets) return;
@ -588,7 +588,7 @@ export default class valve extends Core {
let assembled = Buffer.concat(list); let assembled = Buffer.concat(list);
if(bzip) { if(bzip) {
this.debugLog("BZIP DETECTED - Extracing packet..."); this.logger.debug("BZIP DETECTED - Extracing packet...");
try { try {
assembled = Bzip2.decode(assembled); assembled = Bzip2.decode(assembled);
} catch(e) { } catch(e) {