server/utils/metaserver.pl.in

#!/usr/bin/perl
# $Id: metaserver.pl.in,v 1.3 2005/07/08 23:48:59 mwedel Exp $

# Copyright 2000 by Mark Wedel.
# This script follows the same license as crossfire (GPL).

use Socket;
use English;

# We periodically generate a nice HTML file that people can't put their
# web browser at.  This is the location of that file.
$HTML_FILE="/var/apache/htdocs/metaserver.html";

# Cache file to keep data we ahve collected.  This is used so that if
# the metaserver program crashes/dies, it still has some old data.
# You may want to set this to a location that will survive across system
# reboots.
$CACHE_FILE="/var/tmp/meta_xfire.cache";

# We remove a server after $REMOVE_SERVER number of seconds of no updates.
# 600 is 10 minutes - if we haven't gotten an update that fast, the server
# is almost certainly gone/not available.  This reduces congestion when
# someone on a dhcp connection keeps running a server and it fills
# up a bunch of the slots.
$REMOVE_SERVER=600;

# UPDATE_SYNC determines how often we update the HTML_FILE and CACHE_FILE.
$UPDATE_SYNC=300;

# IP_INTERVAL is how often (in seconds) same IP can request metaserver
# info.  This is to prevent DOS attacks.

$IP_INTERVAL=5;

# For gathering some anonymous statistics. You probably want to use
# MRTG/RRDTOOL for generating statistics from the file.
# -- Heikki Hokkanen, 2005-03-26
my $STATS_FILE="/var/tmp/meta_xfire.stats";
my $stats_updatehits = 0; # COUNTER
my $stats_requesthits = 0; # COUNTER
my $stats_totalplayers = 0; # GAUGE
my $stats_totalservers = 0; # GAUGE

socket(SOCKET, PF_INET, SOCK_DGRAM, getprotobyname("udp")) || 
        die("$0: can not open udp socket: $OS_ERROR\n");
bind(SOCKET, sockaddr_in(13326, INADDR_ANY)) ||
        die("$0: Can not bind to socket: $OS_ERROR\n");

# Socket1 is used for incoming requests - if we get a connection on this,
# we dump out our data to that socket in an easily parsible form.
socket(SOCKET1, PF_INET, SOCK_STREAM, getprotobyname("tcp")) || 
        die("$0: can not open tcp socket: $OS_ERROR\n");

# errors on this not that critical
setsockopt(SOCKET1, SOL_SOCKET, SO_REUSEADDR, 1);

bind(SOCKET1, sockaddr_in(13326, INADDR_ANY)) ||
        die("$0: Can not bind to socket: $OS_ERROR\n");
listen(SOCKET1, 10) || 
        die("$0: Can not listen on socket: $OS_ERROR\n");

vec($rin, fileno(SOCKET), 1)=1;
vec($rin, fileno(SOCKET1), 1)=1;

if (open(CACHE,"<$CACHE_FILE")) {
    while (<CACHE>) {
        chomp;
        ($ip, $rest) = split /\|/, $_, 2;
        $data{$ip} = $_;
    }
}
close(CACHE);

$last_sync=time;

while (1) {
    $nfound=select($rout=$rin, undef, undef, 60);
    $cur_time=time;
    if ($nfound) {
        if (vec($rout, fileno(SOCKET),1)) {
            $ipaddr = recv(SOCKET, $data, 256, 0) ||
                print STDERR "$0: error on recv call: $OS_ERROR\n";
            ($port, $ip) = sockaddr_in($ipaddr);
            $host = inet_ntoa $ip;
            ($name, $rest) = split /\|/, $data;
            if ($name ne "put.your.hostname.here") {
                $data{$host} = "$host|$cur_time|$data";
                $stats_updatehits++;
            }
        }
        if (vec($rout, fileno(SOCKET1),1)) {
            # This is overly basic - if there are enough servers
            # where the output won't fit in the outgoing socket,
            # this will block.  However, if we fork, we open
            # ourselves up to someone intentionally designing something
            # that causes these to block, and then have us fork a huge
            # number of process potentially filling up our proc table.
            if ($ipaddr=accept NEWSOCKET, SOCKET1) {
                ($port, $ip ) = sockaddr_in( $ipaddr );
                $dq = join('.',unpack('C4', $ip));
                if ($ip_times{$dq} > time) {
                    close(NEWSOCKET);
                } else {
                    $ip_times{$dq} = time + $IP_INTERVAL;
                    foreach $i (keys %data) {
                        # Report idle time to client, and not last update
                        # as we received in seconds since epoch.
                        ($ip, $time, $rest) = split /\|/, $data{$i}, 3;
                        $newtime = $cur_time - $time;
                        print NEWSOCKET "$ip|$newtime|$rest\n";
                    }
                    close(NEWSOCKET);
                    $stats_requesthits++;
                }
            }
        }
    }

    # Need to generate some files.  This is also where we remove outdated
    # hosts.
    if ($last_sync+$UPDATE_SYNC < $cur_time) {
        $last_sync = $cur_time;
        open(CACHE,">$CACHE_FILE");
        open(HTML,">$HTML_FILE");

        print HTML 
'<title>Crossfire Server List</title>
<h1 align=center>Crossfire Server List</h1><p>
<table border=1 align=center cellpadding=5>
<tr>
<th>IP Address</th><th>Last Update Date/Time</th><th>Last Update Minutes Elapsed</th>
<th>Hostname</th><th>Number of Players</th><th>Version</th><th>Comment</th>
</tr>
';

        $stats_totalplayers = 0;
        $stats_totalservers = 0;
        foreach $i (keys %data) {
                $stats_totalservers++;
            ($ip, $time, @rest) = split /\|/, $data{$i};
            if ($time+$REMOVE_SERVER<$cur_time) { 
                delete $data{$i}; 
            } else {
                print CACHE "$data{$i}\n";
                $elapsed = int(($cur_time - $time)/60);
                $gmtime = gmtime($time);
                print HTML "<tr><td>$i</td><td>$gmtime</td><td>$elapsed</td>";
                print HTML "<td>$rest[0]</td><td>$rest[1]</td><td>$rest[2]</td><td>$rest[3]</td></tr>\n";
                $stats_totalplayers += int($rest[2]);
            }
        }
        $gmtime = gmtime($cur_time);
        print HTML "
</table><p>
The server name is reported by the server, while the ip address is determined by
the incoming data packet.  These values may not resolve to the same thing in the
case of multi homed hosts or multi ip hosts.<p>

All times are in GMT.<p>

<font size=-2>Last Updated: $gmtime<font size=+2><p>";
        close(HTML);
        close(CACHE);
        
        open(STATS,">$STATS_FILE");
        print STATS "$stats_updatehits:$stats_requesthits:$stats_totalservers:$stats_totalplayers\n";
        close(STATS);
        
    }
}
Revision:	1.1
Committed:	Fri Feb 3 07:14:50 2006 UTC (18 years, 3 months ago) by root
Branch point for:	UPSTREAM, MAIN
Log Message:	Initial revision
#	User	Rev	Content
1	root	1.1	#!/usr/bin/perl
2			# $Id: metaserver.pl.in,v 1.3 2005/07/08 23:48:59 mwedel Exp $
3
4			# Copyright 2000 by Mark Wedel.
5			# This script follows the same license as crossfire (GPL).
6
7			use Socket;
8			use English;
9
10			# We periodically generate a nice HTML file that people can't put their
11			# web browser at. This is the location of that file.
12			$HTML_FILE="/var/apache/htdocs/metaserver.html";
13
14			# Cache file to keep data we ahve collected. This is used so that if
15			# the metaserver program crashes/dies, it still has some old data.
16			# You may want to set this to a location that will survive across system
17			# reboots.
18			$CACHE_FILE="/var/tmp/meta_xfire.cache";
19
20			# We remove a server after $REMOVE_SERVER number of seconds of no updates.
21			# 600 is 10 minutes - if we haven't gotten an update that fast, the server
22			# is almost certainly gone/not available. This reduces congestion when
23			# someone on a dhcp connection keeps running a server and it fills
24			# up a bunch of the slots.
25			$REMOVE_SERVER=600;
26
27			# UPDATE_SYNC determines how often we update the HTML_FILE and CACHE_FILE.
28			$UPDATE_SYNC=300;
29
30			# IP_INTERVAL is how often (in seconds) same IP can request metaserver
31			# info. This is to prevent DOS attacks.
32
33			$IP_INTERVAL=5;
34
35			# For gathering some anonymous statistics. You probably want to use
36			# MRTG/RRDTOOL for generating statistics from the file.
37			# -- Heikki Hokkanen, 2005-03-26
38			my $STATS_FILE="/var/tmp/meta_xfire.stats";
39			my $stats_updatehits = 0; # COUNTER
40			my $stats_requesthits = 0; # COUNTER
41			my $stats_totalplayers = 0; # GAUGE
42			my $stats_totalservers = 0; # GAUGE
43
44			socket(SOCKET, PF_INET, SOCK_DGRAM, getprotobyname("udp")) \|\|
45			die("$0: can not open udp socket: $OS_ERROR\n");
46			bind(SOCKET, sockaddr_in(13326, INADDR_ANY)) \|\|
47			die("$0: Can not bind to socket: $OS_ERROR\n");
48
49			# Socket1 is used for incoming requests - if we get a connection on this,
50			# we dump out our data to that socket in an easily parsible form.
51			socket(SOCKET1, PF_INET, SOCK_STREAM, getprotobyname("tcp")) \|\|
52			die("$0: can not open tcp socket: $OS_ERROR\n");
53
54			# errors on this not that critical
55			setsockopt(SOCKET1, SOL_SOCKET, SO_REUSEADDR, 1);
56
57			bind(SOCKET1, sockaddr_in(13326, INADDR_ANY)) \|\|
58			die("$0: Can not bind to socket: $OS_ERROR\n");
59			listen(SOCKET1, 10) \|\|
60			die("$0: Can not listen on socket: $OS_ERROR\n");
61
62			vec($rin, fileno(SOCKET), 1)=1;
63			vec($rin, fileno(SOCKET1), 1)=1;
64
65			if (open(CACHE,"<$CACHE_FILE")) {
66			while (<CACHE>) {
67			chomp;
68			($ip, $rest) = split /\\|/, $_, 2;
69			$data{$ip} = $_;
70			}
71			}
72			close(CACHE);
73
74			$last_sync=time;
75
76			while (1) {
77			$nfound=select($rout=$rin, undef, undef, 60);
78			$cur_time=time;
79			if ($nfound) {
80			if (vec($rout, fileno(SOCKET),1)) {
81			$ipaddr = recv(SOCKET, $data, 256, 0) \|\|
82			print STDERR "$0: error on recv call: $OS_ERROR\n";
83			($port, $ip) = sockaddr_in($ipaddr);
84			$host = inet_ntoa $ip;
85			($name, $rest) = split /\\|/, $data;
86			if ($name ne "put.your.hostname.here") {
87			$data{$host} = "$host\|$cur_time\|$data";
88			$stats_updatehits++;
89			}
90			}
91			if (vec($rout, fileno(SOCKET1),1)) {
92			# This is overly basic - if there are enough servers
93			# where the output won't fit in the outgoing socket,
94			# this will block. However, if we fork, we open
95			# ourselves up to someone intentionally designing something
96			# that causes these to block, and then have us fork a huge
97			# number of process potentially filling up our proc table.
98			if ($ipaddr=accept NEWSOCKET, SOCKET1) {
99			($port, $ip ) = sockaddr_in( $ipaddr );
100			$dq = join('.',unpack('C4', $ip));
101			if ($ip_times{$dq} > time) {
102			close(NEWSOCKET);
103			} else {
104			$ip_times{$dq} = time + $IP_INTERVAL;
105			foreach $i (keys %data) {
106			# Report idle time to client, and not last update
107			# as we received in seconds since epoch.
108			($ip, $time, $rest) = split /\\|/, $data{$i}, 3;
109			$newtime = $cur_time - $time;
110			print NEWSOCKET "$ip\|$newtime\|$rest\n";
111			}
112			close(NEWSOCKET);
113			$stats_requesthits++;
114			}
115			}
116			}
117			}
118
119			# Need to generate some files. This is also where we remove outdated
120			# hosts.
121			if ($last_sync+$UPDATE_SYNC < $cur_time) {
122			$last_sync = $cur_time;
123			open(CACHE,">$CACHE_FILE");
124			open(HTML,">$HTML_FILE");
125
126			print HTML
127			'<title>Crossfire Server List</title>
128			<h1 align=center>Crossfire Server List</h1><p>
129			<table border=1 align=center cellpadding=5>
130			<tr>
131			<th>IP Address</th><th>Last Update Date/Time</th><th>Last Update Minutes Elapsed</th>
132			<th>Hostname</th><th>Number of Players</th><th>Version</th><th>Comment</th>
133			</tr>
134			';
135
136			$stats_totalplayers = 0;
137			$stats_totalservers = 0;
138			foreach $i (keys %data) {
139			$stats_totalservers++;
140			($ip, $time, @rest) = split /\\|/, $data{$i};
141			if ($time+$REMOVE_SERVER<$cur_time) {
142			delete $data{$i};
143			} else {
144			print CACHE "$data{$i}\n";
145			$elapsed = int(($cur_time - $time)/60);
146			$gmtime = gmtime($time);
147			print HTML "<tr><td>$i</td><td>$gmtime</td><td>$elapsed</td>";
148			print HTML "<td>$rest[0]</td><td>$rest[1]</td><td>$rest[2]</td><td>$rest[3]</td></tr>\n";
149			$stats_totalplayers += int($rest[2]);
150			}
151			}
152			$gmtime = gmtime($cur_time);
153			print HTML "
154			</table><p>
155			The server name is reported by the server, while the ip address is determined by
156			the incoming data packet. These values may not resolve to the same thing in the
157			case of multi homed hosts or multi ip hosts.<p>
158
159			All times are in GMT.<p>
160
161			<font size=-2>Last Updated: $gmtime<font size=+2><p>";
162			close(HTML);
163			close(CACHE);
164
165			open(STATS,">$STATS_FILE");
166			print STATS "$stats_updatehits:$stats_requesthits:$stats_totalservers:$stats_totalplayers\n";
167			close(STATS);
168
169			}
170			}