tw_serverinfo.game_servers.GameServers.parse_extended_response() - Code Metrics - Inspection of "[DOC] add badge for code coverage" - DaRealFreak/Teeworlds-ServerInfo - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a89286...fe5519 )

by Steffen

created 2018-10-12 10:44 UTC

GameServers.parse_extended_response() A

↳ Parent: tw_serverinfo.game_servers

Complexity

Conditions

Size

Total Lines	30
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	22
nop	2
dl	0
loc	30
ccs	17
cts	17
cp	1
crap	2
rs	9.352
c	0
b	0
f	0

#!/usr/bin/python
# -*- coding: utf-8 -*-
import socket
from collections import deque
from time import sleep

from tw_serverinfo import Network
from tw_serverinfo.models.game_server import GameServer


class GameServers(object):
    """GameServers Class containing the logic to request and parse responses from the game servers"""
    SERVER_CHUNK_SIZE = 50
    SERVER_CHUNK_SLEEP_MS = 1000

    _game_servers = []

    def fill_server_info(self, game_servers: list) -> None:
        """

        :param game_servers:
        :return:
        """
        self._game_servers = game_servers
        # create an udp protocol socket
        sock = socket.socket(family=Network.PROTOCOL_FAMILY, type=socket.SOCK_DGRAM)
        # set the socket to non blocking to allow parallel requests
        sock.setblocking(False)

        i = 0
        for game_server in self._game_servers:  # type: GameServer
            i += 1
            Network.send_packet(sock=sock, data=Network.PACKETS['SERVERBROWSE_GETINFO'], server=game_server)
            Network.send_packet(sock=sock, data=Network.PACKETS['SERVERBROWSE_GETINFO_64_LEGACY'], server=game_server)

            if i % self.SERVER_CHUNK_SIZE or i >= len(self._game_servers):
                duration_without_response = Network.CONNECTION_SLEEP_DURATION
                sleep(Network.CONNECTION_SLEEP_DURATION / 1000.0)

                while True:
                    if not Network.receive_packet(sock, self._game_servers, self.process_packet):
                        if duration_without_response > Network.CONNECTION_TIMEOUT:
                            # we didn't receive any packets in time and cancel the connection here
                            sock.close()
                            break
                        else:
                            # increase the measured duration without a response and sleep for the set duration
                            duration_without_response += Network.CONNECTION_SLEEP_DURATION
                            sleep(Network.CONNECTION_SLEEP_DURATION / 1000.0)
                    else:
                        # if we got a response reset the duration in case we receive multiple packets
                        duration_without_response = 0

    def process_packet(self, data: bytes, server: GameServer) -> None:
        """Process packet function for
         - SERVERBROWSE_COUNT
         - SERVERBROWSE_LIST
        packets

        :type data: bytes
        :type server: GameServer
        :return:
        """
        slots = deque(data[14:].split(b"\x00"))
        token = int(slots.popleft().decode('utf-8'))
        # ToDo: token validation

        if data[6:6 + 8] == Network.PACKETS['SERVERBROWSE_INFO']:
            # vanilla
            self.parse_vanilla_response(slots, server)
        elif data[6:6 + 8] == Network.PACKETS['SERVERBROWSE_INFO_64_LEGACY']:
            # 64 legacy
            self.parse_64_legacy_response(slots, server)
        elif data[6:6 + 8] == Network.PACKETS['SERVERBROWSE_INFO_EXTENDED']:
            # extended response, current default of DDNet
            self.parse_extended_response(slots, server)
        elif data[6:6 + 8] == Network.PACKETS['SERVERBROWSE_INFO_EXTENDED_MORE']:
            print('no idea what to expect here, never got useful data')

    @staticmethod

    def parse_vanilla_response(slots: deque, server: GameServer) -> None:
        """Parse the default response of the vanilla client

        :param slots:
        :param server:
        :return:
        """
        server.server_type = 'vanilla'
        server.version = slots.popleft().decode('utf-8')
        server.name = slots.popleft().decode('utf-8')
        server.map_name = slots.popleft().decode('utf-8')
        server.game_type = slots.popleft().decode('utf-8')
        server.flags = int(slots.popleft().decode('utf-8'))
        server.num_players = int(slots.popleft().decode('utf-8'))
        server.max_players = int(slots.popleft().decode('utf-8'))
        server.num_clients = int(slots.popleft().decode('utf-8'))
        server.max_clients = int(slots.popleft().decode('utf-8'))

        while len(slots) >= 5:
            # no idea what this is, always empty
            server.players.append({
                'name': slots.popleft(),
                'clan': slots.popleft(),
                'country': int(slots.popleft().decode('utf-8')),
                'score': int(slots.popleft().decode('utf-8')),
                'ingame': int(slots.popleft().decode('utf-8'))
            })

    @staticmethod

    def parse_64_legacy_response(slots: deque, server: GameServer) -> None:
        """Parse the 64 slot legacy response

        :param slots:
        :param server:
        :return:
        """
        server.server_type = '64_legacy'
        server.version = slots.popleft().decode('utf-8')
        server.name = slots.popleft().decode('utf-8')
        server.map_name = slots.popleft().decode('utf-8')
        server.game_type = slots.popleft().decode('utf-8')
        server.flags = int(slots.popleft().decode('utf-8'))
        server.num_players = int(slots.popleft().decode('utf-8'))
        server.max_players = int(slots.popleft().decode('utf-8'))
        server.num_clients = int(slots.popleft().decode('utf-8'))
        server.max_clients = int(slots.popleft().decode('utf-8'))

        if slots[0] == b'':
            # no idea what this is, always empty
            slots.popleft()

        while len(slots) >= 5:
            server.players.append({
                'name': slots.popleft(),
                'clan': slots.popleft(),
                'country': int(slots.popleft().decode('utf-8')),
                'score': int(slots.popleft().decode('utf-8')),
                'ingame': int(slots.popleft().decode('utf-8'))
            })

    @staticmethod
    def parse_extended_response(slots: deque, server: GameServer) -> None:
        """Parse the extended server info response(default for DDNet)

        :param slots:
        :param server:
        :return:
        """
        server.server_type = 'ext'
        server.version = slots.popleft().decode('utf-8')
        server.name = slots.popleft().decode('utf-8')
        server.map_name = slots.popleft().decode('utf-8')
        server.map_crc = int(slots.popleft().decode('utf-8'))
        server.map_size = int(slots.popleft().decode('utf-8'))
        server.game_type = slots.popleft().decode('utf-8')
        server.flags = int(slots.popleft().decode('utf-8'))
        server.num_players = int(slots.popleft().decode('utf-8'))
        server.max_players = int(slots.popleft().decode('utf-8'))
        server.num_clients = int(slots.popleft().decode('utf-8'))
        server.max_clients = int(slots.popleft().decode('utf-8'))

        while len(slots) >= 6:
            # no idea what this is, always empty
            slots.popleft()
            server.players.append({
                'name': slots.popleft(),
                'clan': slots.popleft(),
                'country': int(slots.popleft().decode('utf-8')),
                'score': int(slots.popleft().decode('utf-8')),
                'ingame': int(slots.popleft().decode('utf-8'))
            })


1			#!/usr/bin/python
2			# -- coding: utf-8 --
3	1		import socket
4	1		from collections import deque
5	1		from time import sleep
6
7	1		from tw_serverinfo import Network
8	1		from tw_serverinfo.models.game_server import GameServer
9
10
11	1		class GameServers(object):
12			"""GameServers Class containing the logic to request and parse responses from the game servers"""
13	1		SERVER_CHUNK_SIZE = 50
14	1		SERVER_CHUNK_SLEEP_MS = 1000
15
16	1		_game_servers = []
17
18	1		def fill_server_info(self, game_servers: list) -> None:
19			"""
20
21			:param game_servers:
22			:return:
23			"""
24	1		self._game_servers = game_servers
25			# create an udp protocol socket
26	1		sock = socket.socket(family=Network.PROTOCOL_FAMILY, type=socket.SOCK_DGRAM)
27			# set the socket to non blocking to allow parallel requests
28	1		sock.setblocking(False)
29
30	1		i = 0
31	1		for game_server in self._game_servers: # type: GameServer
32	1		i += 1
33	1		Network.send_packet(sock=sock, data=Network.PACKETS['SERVERBROWSE_GETINFO'], server=game_server)
34	1		Network.send_packet(sock=sock, data=Network.PACKETS['SERVERBROWSE_GETINFO_64_LEGACY'], server=game_server)
35
36	1		if i % self.SERVER_CHUNK_SIZE or i >= len(self._game_servers):
37	1		duration_without_response = Network.CONNECTION_SLEEP_DURATION
38	1		sleep(Network.CONNECTION_SLEEP_DURATION / 1000.0)
39
40	1		while True:
41	1		if not Network.receive_packet(sock, self._game_servers, self.process_packet):
42	1		if duration_without_response > Network.CONNECTION_TIMEOUT:
43			# we didn't receive any packets in time and cancel the connection here
44	1		sock.close()
45	1		break
46			else:
47			# increase the measured duration without a response and sleep for the set duration
48	1		duration_without_response += Network.CONNECTION_SLEEP_DURATION
49	1		sleep(Network.CONNECTION_SLEEP_DURATION / 1000.0)
50			else:
51			# if we got a response reset the duration in case we receive multiple packets
52	1		duration_without_response = 0
53
54	1		def process_packet(self, data: bytes, server: GameServer) -> None:
55			"""Process packet function for
56			- SERVERBROWSE_COUNT
57			- SERVERBROWSE_LIST
58			packets
59
60			:type data: bytes
61			:type server: GameServer
62			:return:
63			"""
64	1		slots = deque(data[14:].split(b"\x00"))
65	1		token = int(slots.popleft().decode('utf-8'))
66			# ToDo: token validation
67
68	1		if data[6:6 + 8] == Network.PACKETS['SERVERBROWSE_INFO']:
69			# vanilla
70			self.parse_vanilla_response(slots, server)
71	1		elif data[6:6 + 8] == Network.PACKETS['SERVERBROWSE_INFO_64_LEGACY']:
72			# 64 legacy
73	1		self.parse_64_legacy_response(slots, server)
74	1		elif data[6:6 + 8] == Network.PACKETS['SERVERBROWSE_INFO_EXTENDED']:
75			# extended response, current default of DDNet
76	1		self.parse_extended_response(slots, server)
77			elif data[6:6 + 8] == Network.PACKETS['SERVERBROWSE_INFO_EXTENDED_MORE']:
78			print('no idea what to expect here, never got useful data')
79
80	1	View Code Duplication	@staticmethod
			0 ignored issues – show Duplication introduced 2018-10-12 10:46 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
81	1		def parse_vanilla_response(slots: deque, server: GameServer) -> None:
82			"""Parse the default response of the vanilla client
83
84			:param slots:
85			:param server:
86			:return:
87			"""
88			server.server_type = 'vanilla'
89			server.version = slots.popleft().decode('utf-8')
90			server.name = slots.popleft().decode('utf-8')
91			server.map_name = slots.popleft().decode('utf-8')
92			server.game_type = slots.popleft().decode('utf-8')
93			server.flags = int(slots.popleft().decode('utf-8'))
94			server.num_players = int(slots.popleft().decode('utf-8'))
95			server.max_players = int(slots.popleft().decode('utf-8'))
96			server.num_clients = int(slots.popleft().decode('utf-8'))
97			server.max_clients = int(slots.popleft().decode('utf-8'))
98
99			while len(slots) >= 5:
100			# no idea what this is, always empty
101			server.players.append({
102			'name': slots.popleft(),
103			'clan': slots.popleft(),
104			'country': int(slots.popleft().decode('utf-8')),
105			'score': int(slots.popleft().decode('utf-8')),
106			'ingame': int(slots.popleft().decode('utf-8'))
107			})
108
109	1	View Code Duplication	@staticmethod
			0 ignored issues – show Duplication introduced 2018-10-12 10:46 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
110	1		def parse_64_legacy_response(slots: deque, server: GameServer) -> None:
111			"""Parse the 64 slot legacy response
112
113			:param slots:
114			:param server:
115			:return:
116			"""
117	1		server.server_type = '64_legacy'
118	1		server.version = slots.popleft().decode('utf-8')
119	1		server.name = slots.popleft().decode('utf-8')
120	1		server.map_name = slots.popleft().decode('utf-8')
121	1		server.game_type = slots.popleft().decode('utf-8')
122	1		server.flags = int(slots.popleft().decode('utf-8'))
123	1		server.num_players = int(slots.popleft().decode('utf-8'))
124	1		server.max_players = int(slots.popleft().decode('utf-8'))
125	1		server.num_clients = int(slots.popleft().decode('utf-8'))
126	1		server.max_clients = int(slots.popleft().decode('utf-8'))
127
128	1		if slots[0] == b'':
129			# no idea what this is, always empty
130	1		slots.popleft()
131
132	1		while len(slots) >= 5:
133	1		server.players.append({
134			'name': slots.popleft(),
135			'clan': slots.popleft(),
136			'country': int(slots.popleft().decode('utf-8')),
137			'score': int(slots.popleft().decode('utf-8')),
138			'ingame': int(slots.popleft().decode('utf-8'))
139			})
140
141	1		@staticmethod
142	1		def parse_extended_response(slots: deque, server: GameServer) -> None:
143			"""Parse the extended server info response(default for DDNet)
144
145			:param slots:
146			:param server:
147			:return:
148			"""
149	1		server.server_type = 'ext'
150	1		server.version = slots.popleft().decode('utf-8')
151	1		server.name = slots.popleft().decode('utf-8')
152	1		server.map_name = slots.popleft().decode('utf-8')
153	1		server.map_crc = int(slots.popleft().decode('utf-8'))
154	1		server.map_size = int(slots.popleft().decode('utf-8'))
155	1		server.game_type = slots.popleft().decode('utf-8')
156	1		server.flags = int(slots.popleft().decode('utf-8'))
157	1		server.num_players = int(slots.popleft().decode('utf-8'))
158	1		server.max_players = int(slots.popleft().decode('utf-8'))
159	1		server.num_clients = int(slots.popleft().decode('utf-8'))
160	1		server.max_clients = int(slots.popleft().decode('utf-8'))
161
162	1		while len(slots) >= 6:
163			# no idea what this is, always empty
164	1		slots.popleft()
165	1		server.players.append({
166			'name': slots.popleft(),
167			'clan': slots.popleft(),
168			'country': int(slots.popleft().decode('utf-8')),
169			'score': int(slots.popleft().decode('utf-8')),
170			'ingame': int(slots.popleft().decode('utf-8'))
171			})
172

DaRealFreak / Teeworlds-ServerInfo

Push — master ( a89286...fe5519 )

GameServers.parse_extended_response() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like