src/Modules/BZFlag.pl

   1 #!/usr/bin/perl
   2 #
   3 # BZFlag
   4 # Copyright (c) 1993 - 2002 Tim Riker
   5 #
   6 # This package is free software;  you can redistribute it and/or
   7 # modify it under the terms of the license found in the file
   8 # named LICENSE that should have accompanied this file.
   9 #
  10 # THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  11 # IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  12 # WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  13
  14 package BZFlag;
  15 use strict;
  16 use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
  17
  18 my $no_BZFlag;
  19
  20 BEGIN {
  21         $no_BZFlag = 0;
  22         eval "use Socket";
  23         eval "use LWP::UserAgent";
  24         $no_BZFlag++ if ($@);
  25 }
  26
  27 sub BZFlag::BZFlag {
  28         my ($message) = @_;
  29         my ($retval);
  30         if ($no_BZFlag) {
  31                 &main::status("BZFlag module requires Socket.");
  32                 return 'BZFlag module not active';
  33         }
  34         if ($message =~ /^bzfquery\s+([^:]*)(?::([0-9]*))?$/xi) {
  35                 $retval = &query($1,$2);
  36         } elsif ($message =~ /^bzflist$/xi) {
  37                 $retval = &list();
  38         } else {
  39                 $retval = "BZFlag: unhandled command \"$message\"";
  40         }
  41         &::performStrictReply($retval);
  42 }
  43
  44 sub BZFlag::list {
  45         my ($response);
  46         my $ua = new LWP::UserAgent;
  47         $ua->proxy('http', $::param{'httpProxy'}) if (&::IsParam("httpProxy"));
  48
  49         $ua->timeout(5);
  50
  51         my $req = HTTP::Request->new('GET', 'http://db.bzflag.org/db/?action=LIST');
  52         my $res = $ua->request($req);
  53         my %servers;
  54         my $totalServers = 0;
  55         my $totalPlayers = 0;
  56         for my $line (split("\n",$res->content)) {
  57                 my ($serverport, $version, $flags, $ip, $comments) = split(" ",$line,5);
  58                 # not "(A4)18" to handle old dumb perl
  59                 my ($style, $maxShots, $shakeWins, $shakeTimeout, $maxPlayerScore, $maxTeamScore, $maxTime,
  60                                 $maxPlayers, $rogueSize, $rogueMax, $redSize, $redMax, $greenSize, $greenMax,
  61                                 $blueSize, $blueMax, $purpleSize, $purpleMax, $observerSize, $observerMax) =
  62                                 unpack("A4A4A4A4A4A4A4A2A2A2A2A2A2A2A2A2A2A2A2A2", $flags);
  63                 my $playerSize = hex($rogueSize) + hex($redSize) + hex($greenSize)
  64                                 + hex($blueSize) + hex($purpleSize) + hex($observerSize);
  65                 $servers{$serverport} = $playerSize;
  66                 $totalServers += 1;
  67                 $totalPlayers += $playerSize;
  68         }
  69         $response .= "s=$totalServers p=$totalPlayers";
  70         foreach my $key (sort {$servers{$b} <=> $servers{$a}} (keys(%servers))) {
  71                 if ($servers{$key} > 0) {
  72                         $response .= " $key($servers{$key})";
  73                 }
  74         }
  75         &::performStrictReply($response);
  76         return;
  77 }
  78
  79 sub BZFlag::list17 {
  80         my ($response);
  81         my $ua = new LWP::UserAgent;
  82         $ua->proxy('http', $::param{'httpProxy'}) if (&::IsParam("httpProxy"));
  83
  84         $ua->timeout(5);
  85
  86         my $req = HTTP::Request->new('GET', 'http://list.bzflag.org:5156/');
  87         my $res = $ua->request($req);
  88         my %servers;
  89         my $totalServers = 0;
  90         my $totalPlayers = 0;
  91         for my $line (split("\n",$res->content)) {
  92                 my ($serverport, $version, $flags, $ip, $comments) = split(" ",$line,5);
  93                 # not "(A4)18" to handle old dumb perl
  94                 my ($style,$maxPlayers,$maxShots,
  95                                 $rogueSize,$redSize,$greenSize,$blueSize,$purpleSize,
  96                                 $rogueMax,$redMax,$greenMax,$blueMax,$purpleMax,
  97                                 $shakeWins,$shakeTimeout,
  98                                 $maxPlayerScore,$maxTeamScore,$maxTime) =
  99                                 unpack("A4A4A4A4A4A4A4A4A4A4A4A4A4A4A4A4A4A4", $flags);
 100                 my $playerSize = hex($rogueSize) + hex($redSize) + hex($greenSize)
 101                                 + hex($blueSize) + hex($purpleSize);
 102                 $servers{$serverport} = $playerSize;
 103                 $totalServers += 1;
 104                 $totalPlayers += $playerSize;
 105         }
 106         $response .= "s=$totalServers p=$totalPlayers";
 107         foreach my $key (sort {$servers{$b} <=> $servers{$a}} (keys(%servers))) {
 108                 if ($servers{$key} > 0) {
 109                         $response .= " $key($servers{$key})";
 110                 }
 111         }
 112         &::performStrictReply($response);
 113         return;
 114 }
 115
 116 sub BZFlag::querytext {
 117         my ($servernameport) = @_;
 118         my ($servername,$port) = split(":",$servernameport);
 119         if ($no_BZFlag) {
 120                 &main::status("BZFlag module requires Socket.");
 121                 return 'BZFlag module not active';
 122         }
 123         #my @teamName = ("Rogue", "Red", "Green", "Blue", "Purple", "Observer", "Rabbit");
 124         my @teamName = ("X", "R", "G", "B", "P", "O", "K");
 125         my ($message, $server, $response);
 126         $port = 5154 unless $port;
 127
 128         # socket define
 129         my $sockaddr = 'S n a4 x8';
 130
 131         # port to port number
 132         my ($name,$aliases,$proto) = getprotobyname('tcp');
 133         ($name,$aliases,$port)  = getservbyname($port,'tcp') unless $port =~ /^\d+$/;
 134
 135         # get server address
 136         my ($type,$len,$serveraddr);
 137         ($name,$aliases,$type,$len,$serveraddr) = gethostbyname($servername);
 138         $server = pack($sockaddr, AF_INET, $port, $serveraddr);
 139
 140         # connect
 141         # TODO wrap this with a 5 second alarm()
 142         return 'socket() error' unless socket(S1, AF_INET, SOCK_STREAM, $proto);
 143         return "could not connect to $servername:$port" unless connect(S1, $server);
 144
 145         # don't buffer
 146         select(S1); $| = 1; select(STDOUT);
 147
 148         # get hello
 149         my $buffer;
 150         return 'read error' unless read(S1, $buffer, 8) == 8;
 151
 152         # parse reply
 153         my ($magic,$major,$minor,$something,$revision) = unpack("a4 a1 a1 a1 a1", $buffer);
 154
 155         # quit if version isn't valid
 156         return 'not a bzflag server' if ($magic ne "BZFS");
 157         # check version
 158         if ($major == 1 && $minor == 9) {
 159                 $revision = $something * 10 + $revision;
 160                 return 'read error' unless read(S1, $buffer, 1) == 1;
 161                 my ($id) = unpack("C", $buffer);
 162
 163                 # send game request
 164                 print S1 pack("n2", 0, 0x7167);
 165
 166                 # FIXME the packets are wrong from here down
 167                 # get reply
 168                 return 'server read error' unless read(S1, $buffer, 40) == 40;
 169                 my ($infolen,$infocode,$style,$maxPlayers,$maxShots,
 170                         $rogueSize,$redSize,$greenSize,$blueSize,$purpleSize,
 171                         $rogueMax,$redMax,$greenMax,$blueMax,$purpleMax,
 172                         $shakeWins,$shakeTimeout,
 173                         $maxPlayerScore,$maxTeamScore,$maxTime) = unpack("n20", $buffer);
 174                 return 'bad server data' unless $infocode == 0x7167;
 175
 176                 # send players request
 177                 print S1 pack("n2", 0, 0x7170);
 178
 179                 # get number of teams and players we'll be receiving
 180                 return 'count read error' unless read(S1, $buffer, 8) == 8;
 181                 my ($countlen,$countcode,$numTeams,$numPlayers) = unpack("n4", $buffer);
 182
 183                 # get the teams
 184                 return 'bad count data' unless $countcode == 0x7170;
 185                 return 'count read error' unless read(S1, $buffer, 5) == 5;
 186                 ($countlen,$countcode,$numTeams) = unpack("n n C", $buffer);
 187                 for (1..$numTeams) {
 188                         return 'team read error' unless read(S1, $buffer, 8) == 8;
 189                         my ($team,$size,$won,$lost) = unpack("n4", $buffer);
 190                         if ($size > 0) {
 191                                 my $score = $won - $lost;
 192                                 $response .= "$teamName[$team]:$score($won-$lost) ";
 193                         }
 194                 }
 195
 196                 # get the players
 197                 for (1..$numPlayers) {
 198                         last unless read(S1, $buffer, 175) == 175;
 199                         my ($playerlen,$playercode,$pID,$type,$team,$won,$lost,$tks,$sign,$email) =
 200                                         unpack("n2Cn5A32A128", $buffer);
 201                         #my ($playerlen,$playercode,$pAddr,$pPort,$pNum,$type,$team,$won,$lost,$sign,$email) =
 202                         #               unpack("n2Nn2 n4A32A128", $buffer);
 203                         return 'bad player data' unless $playercode == 0x6170;
 204                         my $score = $won - $lost;
 205                         $response .= " $sign($teamName[$team]";
 206                         $response .= ":$email" if ($email);
 207                         $response .= ")$score($won-$lost)";
 208                 }
 209                 $response .= "No Players" if ($numPlayers < 1);
 210
 211                 # close socket
 212                 close(S1);
 213         } elsif ($major == 1 && $minor == 0 && $something == 7) {
 214                 # old servers send a reconnect port number
 215                 return 'read error' unless read(S1, $buffer, 2) == 2;
 216                 my ($reconnect) = unpack("n", $buffer);
 217                 $minor = $minor * 10 + $something;
 218                 # quit if rejected
 219                 return 'rejected by server' if ($reconnect == 0);
 220
 221                 # reconnect on new port
 222                 $server = pack($sockaddr, AF_INET, $reconnect, $serveraddr);
 223                 return 'socket() error on reconnect' unless socket(S, AF_INET, SOCK_STREAM, $proto);
 224                 return "could not reconnect to $servername:$reconnect" unless connect(S, $server);
 225                 select(S); $| = 1; select(STDOUT);
 226
 227                 # close first socket
 228                 close(S1);
 229
 230                 # send game request
 231                 print S pack("n2", 0, 0x7167);
 232
 233                 # get reply
 234                 return 'server read error' unless read(S, $buffer, 40) == 40;
 235                 my ($infolen,$infocode,$style,$maxPlayers,$maxShots,
 236                         $rogueSize,$redSize,$greenSize,$blueSize,$purpleSize,
 237                         $rogueMax,$redMax,$greenMax,$blueMax,$purpleMax,
 238                         $shakeWins,$shakeTimeout,
 239                         $maxPlayerScore,$maxTeamScore,$maxTime) = unpack("n20", $buffer);
 240                 return 'bad server data' unless $infocode == 0x7167;
 241
 242                 # send players request
 243                 print S pack("n2", 0, 0x7170);
 244
 245                 # get number of teams and players we'll be receiving
 246                 return 'count read error' unless read(S, $buffer, 8) == 8;
 247                 my ($countlen,$countcode,$numTeams,$numPlayers) = unpack("n4", $buffer);
 248                 return 'bad count data' unless $countcode == 0x7170;
 249
 250                 # get the teams
 251                 for (1..$numTeams) {
 252                         return 'team read error' unless read(S, $buffer, 14) == 14;
 253                         my ($teamlen,$teamcode,$team,$size,$aSize,$won,$lost) = unpack("n7", $buffer);
 254                         return 'bad team data' unless $teamcode == 0x7475;
 255                         if ($size > 0) {
 256                                 my $score = $won - $lost;
 257                                 $response .= "$teamName[$team]:$score($won-$lost) ";
 258                         }
 259                 }
 260
 261                 # get the players
 262                 for (1..$numPlayers) {
 263                         last unless read(S, $buffer, 180) == 180;
 264                         my ($playerlen,$playercode,$pAddr,$pPort,$pNum,$type,$team,$won,$lost,$sign,$email) =
 265                                         unpack("n2Nn2 n4A32A128", $buffer);
 266                         return 'bad player data' unless $playercode == 0x6170;
 267                         my $score = $won - $lost;
 268                         $response .= " $sign($teamName[$team]";
 269                         $response .= ":$email" if ($email);
 270                         $response .= ")$score($won-$lost)";
 271                 }
 272                 $response .= "No Players" if ($numPlayers <= 1);
 273
 274                 # close socket
 275                 close(S);
 276         } else {
 277                 $response = 'incompatible version';
 278         }
 279
 280         return $response;
 281 }
 282
 283 sub BZFlag::query {
 284         my ($servernameport) = @_;
 285         &::performStrictReply(&querytext($servernameport));
 286         return;
 287 }
 288
 289 1;
 290 # vim: ts=2 sw=2