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 {
  28         my ($message) = @_;
  29         my ($retval);
  30         if ($no_BZFlag) {
  31                 &::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 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         for my $line (split("\n",$res->content)) {
  56                 my ($serverport, $version, $flags, $ip, $comments) = split(" ",$line,5);
  57                 # not "(A4)18" to handle old dumb perl
  58                 my ($style, $maxShots, $shakeWins, $shakeTimeout, $maxPlayerScore, $maxTeamScore, $maxTime,
  59                                 $maxPlayers, $rogueSize, $rogueMax, $redSize, $redMax, $greenSize, $greenMax,
  60                                 $blueSize, $blueMax, $purpleSize, $purpleMax, $observerSize, $observerMax) =
  61                                 unpack("A4A4A4A4A4A4A4A2A2A2A2A2A2A2A2A2A2A2A2A2", $flags);
  62                 my $playerSize = hex($rogueSize) + hex($redSize) + hex($greenSize)
  63                                 + hex($blueSize) + hex($purpleSize) + hex($observerSize);
  64                 $servers{$serverport} = $playerSize;
  65           $servers{$version} += $playerSize;
  66                 $servers{'PLAYERS'} += $playerSize;
  67                 $totalServers += 1;
  68         }
  69         $response .= "s=$totalServers";
  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 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 querytext {
 117         my ($servernameport) = @_;
 118         my ($servername,$port) = split(":",$servernameport);
 119         if ($no_BZFlag) {
 120                 &::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   my ($version) = $magic . $major . $minor . $something . $revision;
 155
 156         # quit if version isn't valid
 157         return 'not a bzflag server' if ($magic ne "BZFS");
 158         $response .= "$major$minor$something$revision ";
 159         # check version
 160         if ($version eq "BZFS0026") {
 161                 # 1.11.x handled here
 162                 return 'read error' unless read(S1, $buffer, 1) == 1;
 163                 my ($id) = unpack("C", $buffer);
 164     return "rejected by server" if ($id == 255);
 165
 166                 # send game request
 167                 print S1 pack("n2", 0, 0x7167);
 168
 169                 # get reply
 170                 return 'server read error' unless read(S1, $buffer, 46) == 46;
 171     my ($infolen,$infocode,$style,$maxPlayers,$maxShots,
 172                         $rogueSize,$redSize,$greenSize,$blueSize,$purpleSize,$observerSize,
 173                         $rogueMax,$redMax,$greenMax,$blueMax,$purpleMax,$observerMax,
 174                         $shakeWins,$shakeTimeout,
 175                         $maxPlayerScore,$maxTeamScore,$maxTime,$timeElapsed) = unpack("n23", $buffer);
 176                 return "bad server data $infocode" unless $infocode == 0x7167;
 177
 178                 # send players request
 179                 print S1 pack("n2", 0, 0x7170);
 180
 181                 # get number of teams and players we'll be receiving
 182                 return 'count read error' unless read(S1, $buffer, 8) == 8;
 183                 my ($countlen,$countcode,$numTeams,$numPlayers) = unpack("n4", $buffer);
 184
 185                 # get the teams
 186                 return 'bad count data' unless $countcode == 0x7170;
 187                 return 'count read error' unless read(S1, $buffer, 5) == 5;
 188                 ($countlen,$countcode,$numTeams) = unpack("n n C", $buffer);
 189                 for (1..$numTeams) {
 190                         return 'team read error' unless read(S1, $buffer, 8) == 8;
 191                         my ($team,$size,$won,$lost) = unpack("n4", $buffer);
 192                         if ($size > 0) {
 193                                 my $score = $won - $lost;
 194                                 $response .= "$teamName[$team]:$score($won-$lost) ";
 195                         }
 196                 }
 197
 198                 # get the players
 199                 for (1..$numPlayers) {
 200                         last unless read(S1, $buffer, 175) == 175;
 201                         my ($playerlen,$playercode,$pID,$type,$team,$won,$lost,$tks,$sign,$email) =
 202                                         unpack("n2Cn5A32A128", $buffer);
 203                         #my ($playerlen,$playercode,$pAddr,$pPort,$pNum,$type,$team,$won,$lost,$sign,$email) =
 204                         #               unpack("n2Nn2 n4A32A128", $buffer);
 205                         return 'bad player data' unless $playercode == 0x6170;
 206                         my $score = $won - $lost;
 207                         $response .= " $sign($teamName[$team]";
 208                         $response .= ":$email" if ($email);
 209                         $response .= ")$score($won-$lost)";
 210                 }
 211                 $response .= "No Players" if ($numPlayers < 1);
 212
 213                 # close socket
 214         } elsif ($major == 1 && $minor == 9) {
 215                 # 1.10.x handled here
 216                 $revision = $something * 10 + $revision;
 217                 return 'read error' unless read(S1, $buffer, 1) == 1;
 218                 my ($id) = unpack("C", $buffer);
 219
 220                 # send game request
 221                 print S1 pack("n2", 0, 0x7167);
 222
 223                 # FIXME the packets are wrong from here down
 224                 # get reply
 225                 return 'server read error' unless read(S1, $buffer, 40) == 40;
 226                 my ($infolen,$infocode,$style,$maxPlayers,$maxShots,
 227                         $rogueSize,$redSize,$greenSize,$blueSize,$purpleSize,
 228                         $rogueMax,$redMax,$greenMax,$blueMax,$purpleMax,
 229                         $shakeWins,$shakeTimeout,
 230                         $maxPlayerScore,$maxTeamScore,$maxTime) = unpack("n20", $buffer);
 231                 return 'bad server data' unless $infocode == 0x7167;
 232
 233                 # send players request
 234                 print S1 pack("n2", 0, 0x7170);
 235
 236                 # get number of teams and players we'll be receiving
 237                 return 'count read error' unless read(S1, $buffer, 8) == 8;
 238                 my ($countlen,$countcode,$numTeams,$numPlayers) = unpack("n4", $buffer);
 239
 240                 # get the teams
 241                 return 'bad count data' unless $countcode == 0x7170;
 242                 return 'count read error' unless read(S1, $buffer, 5) == 5;
 243                 ($countlen,$countcode,$numTeams) = unpack("n n C", $buffer);
 244                 for (1..$numTeams) {
 245                         return 'team read error' unless read(S1, $buffer, 8) == 8;
 246                         my ($team,$size,$won,$lost) = unpack("n4", $buffer);
 247                         if ($size > 0) {
 248                                 my $score = $won - $lost;
 249                                 $response .= "$teamName[$team]:$score($won-$lost) ";
 250                         }
 251                 }
 252
 253                 # get the players
 254                 for (1..$numPlayers) {
 255                         last unless read(S1, $buffer, 175) == 175;
 256                         my ($playerlen,$playercode,$pID,$type,$team,$won,$lost,$tks,$sign,$email) =
 257                                         unpack("n2Cn5A32A128", $buffer);
 258                         #my ($playerlen,$playercode,$pAddr,$pPort,$pNum,$type,$team,$won,$lost,$sign,$email) =
 259                         #               unpack("n2Nn2 n4A32A128", $buffer);
 260                         return 'bad player data' unless $playercode == 0x6170;
 261                         my $score = $won - $lost;
 262                         $response .= " $sign($teamName[$team]";
 263                         $response .= ":$email" if ($email);
 264                         $response .= ")$score($won-$lost)";
 265                 }
 266                 $response .= "No Players" if ($numPlayers < 1);
 267
 268                 # close socket
 269                 close(S1);
 270         } elsif ($major == 1 && $minor == 0 && $something == 7) {
 271     # 1.7* versions handled here
 272                 # old servers send a reconnect port number
 273                 return 'read error' unless read(S1, $buffer, 2) == 2;
 274                 my ($reconnect) = unpack("n", $buffer);
 275                 $minor = $minor * 10 + $something;
 276                 # quit if rejected
 277                 return 'rejected by server' if ($reconnect == 0);
 278
 279                 # reconnect on new port
 280                 $server = pack($sockaddr, AF_INET, $reconnect, $serveraddr);
 281                 return 'socket() error on reconnect' unless socket(S, AF_INET, SOCK_STREAM, $proto);
 282                 return "could not reconnect to $servername:$reconnect" unless connect(S, $server);
 283                 select(S); $| = 1; select(STDOUT);
 284
 285                 # close first socket
 286                 close(S1);
 287
 288                 # send game request
 289                 print S pack("n2", 0, 0x7167);
 290
 291                 # get reply
 292                 return 'server read error' unless read(S, $buffer, 40) == 40;
 293                 my ($infolen,$infocode,$style,$maxPlayers,$maxShots,
 294                         $rogueSize,$redSize,$greenSize,$blueSize,$purpleSize,
 295                         $rogueMax,$redMax,$greenMax,$blueMax,$purpleMax,
 296                         $shakeWins,$shakeTimeout,
 297                         $maxPlayerScore,$maxTeamScore,$maxTime) = unpack("n20", $buffer);
 298                 return 'bad server data' unless $infocode == 0x7167;
 299
 300                 # send players request
 301                 print S pack("n2", 0, 0x7170);
 302
 303                 # get number of teams and players we'll be receiving
 304                 return 'count read error' unless read(S, $buffer, 8) == 8;
 305                 my ($countlen,$countcode,$numTeams,$numPlayers) = unpack("n4", $buffer);
 306                 return 'bad count data' unless $countcode == 0x7170;
 307
 308                 # get the teams
 309                 for (1..$numTeams) {
 310                         return 'team read error' unless read(S, $buffer, 14) == 14;
 311                         my ($teamlen,$teamcode,$team,$size,$aSize,$won,$lost) = unpack("n7", $buffer);
 312                         return 'bad team data' unless $teamcode == 0x7475;
 313                         if ($size > 0) {
 314                                 my $score = $won - $lost;
 315                                 $response .= "$teamName[$team]:$score($won-$lost) ";
 316                         }
 317                 }
 318
 319                 # get the players
 320                 for (1..$numPlayers) {
 321                         last unless read(S, $buffer, 180) == 180;
 322                         my ($playerlen,$playercode,$pAddr,$pPort,$pNum,$type,$team,$won,$lost,$sign,$email) =
 323                                         unpack("n2Nn2 n4A32A128", $buffer);
 324                         return 'bad player data' unless $playercode == 0x6170;
 325                         my $score = $won - $lost;
 326                         $response .= " $sign($teamName[$team]";
 327                         $response .= ":$email" if ($email);
 328                         $response .= ")$score($won-$lost)";
 329                 }
 330                 $response .= "No Players" if ($numPlayers <= 1);
 331
 332                 # close socket
 333                 close(S);
 334         } else {
 335                 $response = "incompatible version: $version";
 336         }
 337
 338         return $response;
 339 }
 340
 341 sub query {
 342         my ($servernameport) = @_;
 343         &::performStrictReply(&querytext($servernameport));
 344         return;
 345 }
 346
 347 1;
 348 # vim: ts=2 sw=2