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");
 124         my @teamName = ("X", "R", "G", "B", "P");
 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         return 'socket() error' unless socket(S1, AF_INET, SOCK_STREAM, $proto);
 142         return "could not connect to $servername:$port" unless connect(S1, $server);
 143
 144         # don't buffer
 145         select(S1); $| = 1; select(STDOUT);
 146
 147         # get hello
 148         my $buffer;
 149         return 'read error' unless read(S1, $buffer, 8) == 8;
 150
 151         # parse reply
 152         my ($magic,$major,$minor,$something,$revision) = unpack("a4 a1 a1 a1 a1", $buffer);
 153
 154         # quit if version isn't valid
 155         return 'not a bzflag server' if ($magic ne "BZFS");
 156   # check version
 157   if ($major == 1 && $minor == 9) {
 158           $revision = $something * 10 + $revision;
 159           $response = "version: $magic $major $minor $revision";
 160
 161                 # send game request
 162                 print S1 pack("n2", 0, 0x7167);
 163
 164                 # FIXME the packets are wrong from here down
 165                 # get reply
 166                 return 'server read error' unless read(S1, $buffer, 40) == 40;
 167                 my ($infolen,$infocode,$style,$maxPlayers,$maxShots,
 168                         $rogueSize,$redSize,$greenSize,$blueSize,$purpleSize,
 169                         $rogueMax,$redMax,$greenMax,$blueMax,$purpleMax,
 170                         $shakeWins,$shakeTimeout,
 171                         $maxPlayerScore,$maxTeamScore,$maxTime) = unpack("n20", $buffer);
 172                 return 'bad server data' unless $infocode == 0x7167;
 173
 174                 # send players request
 175                 print S1 pack("n2", 0, 0x7170);
 176
 177                 # get number of teams and players we'll be receiving
 178                 return 'count read error' unless read(S1, $buffer, 8) == 8;
 179                 my ($countlen,$countcode,$numTeams,$numPlayers) = unpack("n4", $buffer);
 180                 return 'bad count data' unless $countcode == 0x7170;
 181
 182                 # get the teams
 183                 for (1..$numTeams) {
 184                         return 'team read error' unless read(S1, $buffer, 14) == 14;
 185                         my ($teamlen,$teamcode,$team,$size,$aSize,$won,$lost) = unpack("n7", $buffer);
 186                         return 'bad team data' unless $teamcode == 0x7475;
 187                         if ($size > 0) {
 188                                 my $score = $won - $lost;
 189                                 $response .= "$teamName[$team]:$score($won-$lost) ";
 190                         }
 191                 }
 192
 193                 # get the players
 194                 for (1..$numPlayers) {
 195                         last unless read(S1, $buffer, 180) == 180;
 196                         my ($playerlen,$playercode,$pAddr,$pPort,$pNum,$type,$team,$won,$lost,$sign,$email) =
 197                                         unpack("n2Nn2 n4A32A128", $buffer);
 198                         return 'bad player data' unless $playercode == 0x6170;
 199                         my $score = $won - $lost;
 200                         $response .= " $sign($teamName[$team]";
 201                         $response .= ":$email" if ($email);
 202                         $response .= ")$score($won-$lost)";
 203                 }
 204                 $response .= "No Players" if ($numPlayers <= 1);
 205
 206                 # close socket
 207                 close(S1);
 208         } elsif ($major == 1 && $minor == 0 && $something == 7) {
 209           # old servers send a reconnect port number
 210           return 'read error' unless read(S1, $buffer, 2) == 2;
 211           my ($reconnect) = unpack("n", $buffer);
 212     $minor = $minor * 10 + $something;
 213                 # quit if rejected
 214                 return 'rejected by server' if ($reconnect == 0);
 215
 216                 # reconnect on new port
 217                 $server = pack($sockaddr, AF_INET, $reconnect, $serveraddr);
 218                 return 'socket() error on reconnect' unless socket(S, AF_INET, SOCK_STREAM, $proto);
 219                 return "could not reconnect to $servername:$reconnect" unless connect(S, $server);
 220                 select(S); $| = 1; select(STDOUT);
 221
 222                 # close first socket
 223                 close(S1);
 224
 225                 # send game request
 226                 print S pack("n2", 0, 0x7167);
 227
 228                 # get reply
 229                 return 'server read error' unless read(S, $buffer, 40) == 40;
 230                 my ($infolen,$infocode,$style,$maxPlayers,$maxShots,
 231                         $rogueSize,$redSize,$greenSize,$blueSize,$purpleSize,
 232                         $rogueMax,$redMax,$greenMax,$blueMax,$purpleMax,
 233                         $shakeWins,$shakeTimeout,
 234                         $maxPlayerScore,$maxTeamScore,$maxTime) = unpack("n20", $buffer);
 235                 return 'bad server data' unless $infocode == 0x7167;
 236
 237                 # send players request
 238                 print S pack("n2", 0, 0x7170);
 239
 240                 # get number of teams and players we'll be receiving
 241                 return 'count read error' unless read(S, $buffer, 8) == 8;
 242                 my ($countlen,$countcode,$numTeams,$numPlayers) = unpack("n4", $buffer);
 243                 return 'bad count data' unless $countcode == 0x7170;
 244
 245                 # get the teams
 246                 for (1..$numTeams) {
 247                         return 'team read error' unless read(S, $buffer, 14) == 14;
 248                         my ($teamlen,$teamcode,$team,$size,$aSize,$won,$lost) = unpack("n7", $buffer);
 249                         return 'bad team data' unless $teamcode == 0x7475;
 250                         if ($size > 0) {
 251                                 my $score = $won - $lost;
 252                                 $response .= "$teamName[$team]:$score($won-$lost) ";
 253                         }
 254                 }
 255
 256                 # get the players
 257                 for (1..$numPlayers) {
 258                         last unless read(S, $buffer, 180) == 180;
 259                         my ($playerlen,$playercode,$pAddr,$pPort,$pNum,$type,$team,$won,$lost,$sign,$email) =
 260                                         unpack("n2Nn2 n4A32A128", $buffer);
 261                         return 'bad player data' unless $playercode == 0x6170;
 262                         my $score = $won - $lost;
 263                         $response .= " $sign($teamName[$team]";
 264                         $response .= ":$email" if ($email);
 265                         $response .= ")$score($won-$lost)";
 266                 }
 267                 $response .= "No Players" if ($numPlayers <= 1);
 268
 269                 # close socket
 270                 close(S);
 271   } else {
 272           $response = 'incompatible version';
 273         }
 274
 275         return $response;
 276 }
 277
 278 sub BZFlag::query {
 279         my ($servernameport) = @_;
 280         &::performStrictReply(&querytext($servernameport));
 281   return;
 282 }
 283
 284 1;
 285 # vim: ts=2 sw=2