Initial import

README.md

@@ -1,2 +1,4 @@
 # q3_server_status
 
+Q3 communication module is taken from here : https://github.com/gak/pyquake3
+(thanks ! :) )

pyquake3.py

@@ -0,0 +1,145 @@
+#!/usr/bin/python2 
+"""
+Python Quake 3 Library
+http://misc.slowchop.com/misc/wiki/pyquake3
+Copyright (C) 2006-2007 Gerald Kaszuba
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+"""
+
+import socket
+import re
+
+class Player:
+    def __init__(self, name, frags, ping, address=None, bot=-1):
+        self.name = name
+        self.frags = frags
+        self.ping = ping
+        self.address = address
+        self.bot = bot
+    def __str__(self):
+        return self.name
+    def __repr__(self):
+        return str(self)
+
+class PyQuake3:
+    packet_prefix = '\xff' * 4
+    player_reo = re.compile(r'^(\d+) (\d+) "(.*)"')
+    def __init__(self, server, rcon_password=''):
+        self.s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        self.set_server(server)
+        self.set_rcon_password(rcon_password)
+    def set_server(self, server):
+        try:
+            self.address, self.port = server.split(':')
+        except:
+            raise Exception('Server address must be in the format of \
+                    "address:port"')
+        self.port = int(self.port)
+        self.s.connect((self.address, self.port))
+    def get_address(self):
+        return '%s:%s' % (self.address, self.port)
+    def set_rcon_password(self, rcon_password):
+        self.rcon_password = rcon_password
+    def send_packet(self, data):
+        self.s.send('%s%s\n' % (self.packet_prefix, data))
+    def recv(self, timeout=1):
+        self.s.settimeout(timeout)
+        try:
+            return self.s.recv(4096)
+        except socket.error, e:
+            raise Exception('Error receiving the packet: %s' % \
+                    e[1])
+    def command(self, cmd, timeout=1, retries=3):
+        while retries:
+            self.send_packet(cmd)
+            try:
+                data = self.recv(timeout)
+            except:
+                data = None
+            if data:
+                return self.parse_packet(data)
+            retries -= 1
+        raise Exception('Server response timed out')
+    def rcon(self, cmd):
+        r = self.command('rcon "%s" %s' % (self.rcon_password, cmd))
+        if r[1] == 'No rconpassword set on the server.\n' or r[1] == \
+                'Bad rconpassword.\n':
+            raise Exception(r[1][:-1])
+        return r
+    def parse_packet(self, data):
+        if data.find(self.packet_prefix) != 0:
+            raise Exception('Malformed packet')
+        first_line_length = data.find('\n')
+        if first_line_length == -1:
+            raise Exception('Malformed packet')
+        response_type = data[len(self.packet_prefix):first_line_length]
+        response_data = data[first_line_length+1:]
+        return response_type, response_data
+    def parse_status(self, data):
+        split = data[1:].split('\\')
+        values = dict(zip(split[::2], split[1::2]))
+        # if there are \n's in one of the values, it's the list of players
+        for var, val in values.items():
+            pos = val.find('\n')
+            if pos == -1:
+                continue
+            split = val.split('\n', 1)
+            values[var] = split[0]
+            self.parse_players(split[1])
+        return values
+    def parse_players(self, data):
+        self.players = []
+        for player in data.split('\n'):
+            if not player:
+                continue
+            match = self.player_reo.match(player)
+            if not match:
+                print 'couldnt match', player
+                continue
+            frags, ping, name = match.groups()
+            self.players.append(Player(name, frags, ping))
+    def update(self):
+        cmd, data = self.command('getstatus')
+        self.vars = self.parse_status(data)
+    def rcon_update(self):
+        cmd, data = self.rcon('status')
+        lines = data.split('\n')
+        players = lines[3:]
+        self.players = []
+        for p in players:
+            while p.find('  ') != -1:
+                p = p.replace('  ', ' ')
+            while p.find(' ') == 0:
+                p = p[1:]
+            if p == '':
+                continue
+            p = p.split(' ')
+            self.players.append(Player(p[3][:-2], p[0], p[1], p[5], p[6]))
+
+#if __name__ == '__main__':
+#    q = PyQuake3('server-quake3:27960','secret')
+#    q.update()
+#    my_status = 'The name of %s is %s, running map %s with %s player(s).' % \
+#            (q.get_address(), q.vars['sv_hostname'], \
+#            q.vars['mapname'], len(q.players))
+#    print my_status
+#    for player in q.players:
+#        print '%s with %s frags and a %sms ping' % (player.name, \
+#                player.frags, player.ping)
+#    q.rcon_update()
+#    for player in q.players:
+#        print '%s has an address of %s' % (player.name, player.address)
+#