server/rcon2irc/rcon2irc.pl

   1 #!/usr/bin/perl
   2
   3 our $VERSION = '0.4.2 svn $Revision$';
   4
   5 # Copyright (c) 2008 Rudolf "divVerent" Polzer
   6 #
   7 # Permission is hereby granted, free of charge, to any person
   8 # obtaining a copy of this software and associated documentation
   9 # files (the "Software"), to deal in the Software without
  10 # restriction, including without limitation the rights to use,
  11 # copy, modify, merge, publish, distribute, sublicense, and/or sell
  12 # copies of the Software, and to permit persons to whom the
  13 # Software is furnished to do so, subject to the following
  14 # conditions:
  15 #
  16 # The above copyright notice and this permission notice shall be
  17 # included in all copies or substantial portions of the Software.
  18 #
  19 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  20 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  21 # OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  23 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  24 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  26 # OTHER DEALINGS IN THE SOFTWARE.
  27
  28 # MISC STRING UTILITY ROUTINES to convert between DarkPlaces and IRC conventions
  29
  30 # convert mIRC color codes to DP color codes
  31 our $color_utf8_enable = 1;
  32 our @color_irc2dp_table = (7, 0, 4, 2, 1, 1, 6, 1, 3, 2, 5, 5, 4, 6, 7, 7);
  33 our @color_dp2irc_table = (-1, 4, 9, 8, 12, 11, 13, -1, -1, -1); # not accurate, but legible
  34 our @color_dp2ansi_table = ("m", "1;31m", "1;32m", "1;33m", "1;34m", "1;36m", "1;35m", "m", "1m", "1m"); # not accurate, but legible
  35 our %color_team2dp_table = (5 => 1, 14 => 4, 13 => 3, 10 => 6);
  36 our %color_team2irc_table = (5 => 4, 14 => 12, 13 => 8, 10 => 13);
  37 sub color_irc2dp($)
  38 {
  39         my ($message) = @_;
  40         $message =~ s/\^/^^/g;
  41         my $color = 7;
  42         $message =~ s{\003(\d\d?)(?:,(\d?\d?))?|(\017)}{
  43                 # $1 is FG, $2 is BG, but let's ignore BG
  44                 my $oldcolor = $color;
  45                 if($3)
  46                 {
  47                         $color = 7;
  48                 }
  49                 else
  50                 {
  51                         $color = $color_irc2dp_table[$1];
  52                         $color = $oldcolor if not defined $color;
  53                 }
  54                 ($color == $oldcolor) ? '' : '^' . $color;
  55         }esg;
  56         $message =~ s{[\000-\037]}{}gs; # kill bold etc. for now
  57         return $message;
  58 }
  59
  60 our @text_qfont_table = ( # ripped from DP console.c qfont_table
  61     '',   '#',  '#',  '#',  '#',  '.',  '#',  '#',
  62     '#',  9,    10,   '#',  ' ',  13,   '.',  '.',
  63     '[',  ']',  '0',  '1',  '2',  '3',  '4',  '5',
  64     '6',  '7',  '8',  '9',  '.',  '<',  '=',  '>',
  65     ' ',  '!',  '"',  '#',  '$',  '%',  '&',  '\'',
  66     '(',  ')',  '*',  '+',  ',',  '-',  '.',  '/',
  67     '0',  '1',  '2',  '3',  '4',  '5',  '6',  '7',
  68     '8',  '9',  ':',  ';',  '<',  '=',  '>',  '?',
  69     '@',  'A',  'B',  'C',  'D',  'E',  'F',  'G',
  70     'H',  'I',  'J',  'K',  'L',  'M',  'N',  'O',
  71     'P',  'Q',  'R',  'S',  'T',  'U',  'V',  'W',
  72     'X',  'Y',  'Z',  '[',  '\\', ']',  '^',  '_',
  73     '`',  'a',  'b',  'c',  'd',  'e',  'f',  'g',
  74     'h',  'i',  'j',  'k',  'l',  'm',  'n',  'o',
  75     'p',  'q',  'r',  's',  't',  'u',  'v',  'w',
  76     'x',  'y',  'z',  '{',  '|',  '}',  '~',  '<',
  77     '<',  '=',  '>',  '#',  '#',  '.',  '#',  '#',
  78     '#',  '#',  ' ',  '#',  ' ',  '>',  '.',  '.',
  79     '[',  ']',  '0',  '1',  '2',  '3',  '4',  '5',
  80     '6',  '7',  '8',  '9',  '.',  '<',  '=',  '>',
  81     ' ',  '!',  '"',  '#',  '$',  '%',  '&',  '\'',
  82     '(',  ')',  '*',  '+',  ',',  '-',  '.',  '/',
  83     '0',  '1',  '2',  '3',  '4',  '5',  '6',  '7',
  84     '8',  '9',  ':',  ';',  '<',  '=',  '>',  '?',
  85     '@',  'A',  'B',  'C',  'D',  'E',  'F',  'G',
  86     'H',  'I',  'J',  'K',  'L',  'M',  'N',  'O',
  87     'P',  'Q',  'R',  'S',  'T',  'U',  'V',  'W',
  88     'X',  'Y',  'Z',  '[',  '\\', ']',  '^',  '_',
  89     '`',  'a',  'b',  'c',  'd',  'e',  'f',  'g',
  90     'h',  'i',  'j',  'k',  'l',  'm',  'n',  'o',
  91     'p',  'q',  'r',  's',  't',  'u',  'v',  'w',
  92     'x',  'y',  'z',  '{',  '|',  '}',  '~',  '<'
  93 );
  94 sub text_qfont_table($)
  95 {
  96         my ($char) = @_;
  97         my $o = ord $char;
  98         if($color_utf8_enable)
  99         {
 100                 return (($o & 0xFF00) == 0xE000) ? $text_qfont_table[$o & 0xFF] : $char;
 101         }
 102         else
 103         {
 104                 return $text_qfont_table[$o];
 105         }
 106 }
 107 sub text_dp2ascii($)
 108 {
 109         my ($message) = @_;
 110         $message = join '', map { text_qfont_table $_ } split //, $message;
 111 }
 112
 113 sub color_dp_transform(&$)
 114 {
 115         my ($block, $message) = @_;
 116         $message =~ s{(?:(\^\^)|\^x([0-9a-fA-F])([0-9a-fA-F])([0-9a-fA-F])|\^([0-9])|(.))(?=([0-9,]?))}{
 117                 defined $1 ? $block->(char => '^', $7) :
 118                 defined $2 ? $block->(rgb => [hex $2, hex $3, hex $4], $7) :
 119                 defined $5 ? $block->(color => $5, $7) :
 120                 defined $6 ? $block->(char => $6, $7) :
 121                         die "Invalid match";
 122         }esg;
 123
 124         return $message;
 125 }
 126
 127 sub color_dp2none($)
 128 {
 129         my ($message) = @_;
 130
 131         return color_dp_transform
 132         {
 133                 my ($type, $data, $next) = @_;
 134                 $type eq 'char'
 135                         ? text_qfont_table $data
 136                         : "";
 137         }
 138         $message;
 139 }
 140
 141 sub color_rgb2basic($)
 142 {
 143         my ($data) = @_;
 144         my ($R, $G, $B) = @$data;
 145         my $min = [sort { $a <=> $b } ($R, $G, $B)]->[0];
 146         my $max = [sort { $a <=> $b } ($R, $G, $B)]->[-1];
 147
 148         my $v = $max / 15;
 149         my $s = ($max == $min) ? 0 : 1 - $min/$max;
 150
 151         if($s < 0.2)
 152         {
 153                 return 0 if $v < 0.5;
 154                 return 7;
 155         }
 156
 157         my $h;
 158         if($max == $min)
 159         {
 160                 $h = 0;
 161         }
 162         elsif($max == $R)
 163         {
 164                 $h = (60 * ($G - $B) / ($max - $min)) % 360;
 165         }
 166         elsif($max == $G)
 167         {
 168                 $h = (60 * ($B - $R) / ($max - $min)) + 120;
 169         }
 170         elsif($max == $B)
 171         {
 172                 $h = (60 * ($R - $G) / ($max - $min)) + 240;
 173         }
 174
 175         return 1 if $h < 36;
 176         return 3 if $h < 80;
 177         return 2 if $h < 150;
 178         return 5 if $h < 200;
 179         return 4 if $h < 270;
 180         return 6 if $h < 330;
 181         return 1;
 182 }
 183
 184 sub color_dp_rgb2basic($)
 185 {
 186         my ($message) = @_;
 187         return color_dp_transform
 188         {
 189                 my ($type, $data, $next) = @_;
 190                 $type eq 'char'  ? ($data eq '^' ? '^^' : $data) :
 191                 $type eq 'color' ? "^$data" :
 192                 $type eq 'rgb'   ? "^" . color_rgb2basic $data :
 193                         die "Invalid type";
 194         }
 195         $message;
 196 }
 197
 198 sub color_dp2irc($)
 199 {
 200         my ($message) = @_;
 201         my $color = -1;
 202         return color_dp_transform
 203         {
 204                 my ($type, $data, $next) = @_;
 205
 206                 if($type eq 'rgb')
 207                 {
 208                         $type = 'color';
 209                         $data = color_rgb2basic $data;
 210                 }
 211
 212                 $type eq 'char'  ? text_qfont_table $data :
 213                 $type eq 'color' ? do {
 214                         my $oldcolor = $color;
 215                         $color = $color_dp2irc_table[$data];
 216
 217                         $color == $oldcolor               ? '' :
 218                         $color < 0                        ? "\017" :
 219                         (index '0123456789,', $next) >= 0 ? "\003$color\002\002" :
 220                                                             "\003$color";
 221                 } :
 222                         die "Invalid type";
 223         }
 224         $message;
 225 }
 226
 227 sub color_dp2ansi($)
 228 {
 229         my ($message) = @_;
 230         my $color = -1;
 231         return color_dp_transform
 232         {
 233                 my ($type, $data, $next) = @_;
 234
 235                 if($type eq 'rgb')
 236                 {
 237                         $type = 'color';
 238                         $data = color_rgb2basic $data;
 239                 }
 240
 241                 $type eq 'char'  ? text_qfont_table $data :
 242                 $type eq 'color' ? do {
 243                         my $oldcolor = $color;
 244                         $color = $color_dp2ansi_table[$data];
 245
 246                         $color eq $oldcolor ? '' :
 247                                               "\033[${color}"
 248                 } :
 249                         die "Invalid type";
 250         }
 251         $message;
 252 }
 253
 254 sub color_dpfix($)
 255 {
 256         my ($message) = @_;
 257         # if the message ends with an odd number of ^, kill one
 258         chop $message if $message =~ /(?:^|[^\^])\^(\^\^)*$/;
 259         return $message;
 260 }
 261
 262
 263
 264
 265 # Interfaces:
 266 #   Connection:
 267 #     $conn->sockname() returns a connection type specific representation
 268 #       string of the local address, or undef if not applicable.
 269 #     $conn->peername() returns a connection type specific representation
 270 #       string of the remote address, or undef if not applicable.
 271 #     $conn->send("string") sends something over the connection.
 272 #     $conn->recv() receives a string from the connection, or returns "" if no
 273 #       data is available.
 274 #     $conn->fds() returns all file descriptors used by the connection, so one
 275 #       can use select() on them.
 276 #   Channel:
 277 #     Usually wraps around a connection and implements a command based
 278 #     structure over it. It usually is constructed using new
 279 #     ChannelType($connection, someparameters...)
 280 #     @cmds = $chan->join_commands(@cmds) joins multiple commands to a single
 281 #       command string if the protocol supports it, or does nothing and leaves
 282 #       @cmds unchanged if the protocol does not support that usage (this is
 283 #       meant to save send() invocations).
 284 #     $chan->send($command, $nothrottle) sends a command over the channel. If
 285 #       $nothrottle is sent, the command must not be left out even if the channel
 286 #       is saturated (for example, because of IRC's flood control mechanism).
 287 #     $chan->quote($str) returns a string in a quoted form so it can safely be
 288 #       inserted as a substring into a command, or returns $str as is if not
 289 #       applicable. It is assumed that the result of the quote method is used
 290 #       as part of a quoted string, if the protocol supports that.
 291 #     $chan->recv() returns a list of received commands from the channel, or
 292 #       the empty list if none are available.
 293 #     $conn->fds() returns all file descriptors used by the channel's
 294 #       connections, so one can use select() on them.
 295
 296
 297
 298
 299
 300
 301
 302 # Socket connection.
 303 # Represents a connection over a socket.
 304 # Mainly used to wrap a channel around it for, in this case, line based or rcon-like operation.
 305 package Connection::Socket;
 306 use strict;
 307 use warnings;
 308 use IO::Socket::INET;
 309 use IO::Handle;
 310
 311 # Constructor:
 312 #   my $conn = new Connection::Socket(tcp => "localaddress" => "remoteaddress" => 6667);
 313 # If the remote address does not contain a port number, the numeric port is
 314 # used (it serves as a default port).
 315 sub new($$)
 316 {
 317         my ($class, $proto, $local, $remote, $defaultport) = @_;
 318         my $sock = IO::Socket::INET->new(
 319                 Proto => $proto,
 320                 (length($local) ? (LocalAddr => $local) : ()),
 321                 PeerAddr => $remote,
 322                 PeerPort => $defaultport
 323         ) or die "socket $proto/$local/$remote/$defaultport: $!";
 324         binmode $sock;
 325         $sock->blocking(0);
 326         my $you = {
 327                 # Mortal fool! Release me from this wretched tomb! I must be set free
 328                 # or I will haunt you forever! I will hide your keys beneath the
 329                 # cushions of your upholstered furniture... and NEVERMORE will you be
 330                 # able to find socks that match!
 331                 sock => $sock,
 332                 # My demonic powers have made me OMNIPOTENT! Bwahahahahahahaha!
 333         };
 334         return
 335                 bless $you, 'Connection::Socket';
 336 }
 337
 338 # $sock->sockname() returns the local address of the socket.
 339 sub sockname($)
 340 {
 341         my ($self) = @_;
 342         my ($port, $addr) = sockaddr_in $self->{sock}->sockname();
 343         return "@{[inet_ntoa $addr]}:$port";
 344 }
 345
 346 # $sock->peername() returns the remote address of the socket.
 347 sub peername($)
 348 {
 349         my ($self) = @_;
 350         my ($port, $addr) = sockaddr_in $self->{sock}->peername();
 351         return "@{[inet_ntoa $addr]}:$port";
 352 }
 353
 354 # $sock->send($data) sends some data over the socket; on success, 1 is returned.
 355 sub send($$)
 356 {
 357         my ($self, $data) = @_;
 358         return 1
 359                 if not length $data;
 360         if(not eval { $self->{sock}->send($data); })
 361         {
 362                 warn "$@";
 363                 return 0;
 364         }
 365         return 1;
 366 }
 367
 368 # $sock->recv() receives as much as possible from the socket (or at most 32k). Returns "" if no data is available.
 369 sub recv($)
 370 {
 371         my ($self) = @_;
 372         my $data = "";
 373         if(defined $self->{sock}->recv($data, 32768, 0))
 374         {
 375                 return $data;
 376         }
 377         elsif($!{EAGAIN})
 378         {
 379                 return "";
 380         }
 381         else
 382         {
 383                 return undef;
 384         }
 385 }
 386
 387 # $sock->fds() returns the socket file descriptor.
 388 sub fds($)
 389 {
 390         my ($self) = @_;
 391         return fileno $self->{sock};
 392 }
 393
 394
 395
 396
 397
 398
 399
 400 # Line-based buffered connectionless FIFO channel.
 401 # Whatever is sent to it using send() is echoed back when using recv().
 402 package Channel::FIFO;
 403 use strict;
 404 use warnings;
 405
 406 # Constructor:
 407 #   my $chan = new Channel::FIFO();
 408 sub new($)
 409 {
 410         my ($class) = @_;
 411         my $you = {
 412                 buffer => []
 413         };
 414         return
 415                 bless $you, 'Channel::FIFO';
 416 }
 417
 418 sub join_commands($@)
 419 {
 420         my ($self, @data) = @_;
 421         return @data;
 422 }
 423
 424 sub send($$$)
 425 {
 426         my ($self, $line, $nothrottle) = @_;
 427         push @{$self->{buffer}}, $line;
 428 }
 429
 430 sub quote($$)
 431 {
 432         my ($self, $data) = @_;
 433         return $data;
 434 }
 435
 436 sub recv($)
 437 {
 438         my ($self) = @_;
 439         my $r = $self->{buffer};
 440         $self->{buffer} = [];
 441         return @$r;
 442 }
 443
 444 sub fds($)
 445 {
 446         my ($self) = @_;
 447         return ();
 448 }
 449
 450
 451
 452
 453
 454
 455
 456 # QW rcon protocol channel.
 457 # Wraps around a UDP based Connection and sends commands as rcon commands as
 458 # well as receives rcon replies. The quote and join_commands methods are using
 459 # DarkPlaces engine specific rcon protocol extensions.
 460 package Channel::QW;
 461 use strict;
 462 use warnings;
 463 use Digest::HMAC;
 464 use Digest::MD4;
 465
 466 # Constructor:
 467 #   my $chan = new Channel::QW($connection, "password");
 468 sub new($$$)
 469 {
 470         my ($class, $conn, $password, $secure, $timeout) = @_;
 471         my $you = {
 472                 connector => $conn,
 473                 password => $password,
 474                 recvbuf => "",
 475                 secure => $secure,
 476                 timeout => $timeout,
 477         };
 478         return
 479                 bless $you, 'Channel::QW';
 480 }
 481
 482 # Note: multiple commands in one rcon packet is a DarkPlaces extension.
 483 sub join_commands($@)
 484 {
 485         my ($self, @data) = @_;
 486         return join "\0", @data;
 487 }
 488
 489 sub send($$$)
 490 {
 491         my ($self, $line, $nothrottle) = @_;
 492         utf8::encode $line
 493                 if $color_utf8_enable;
 494         if($self->{secure} > 1)
 495         {
 496                 $self->{connector}->send("\377\377\377\377getchallenge");
 497                 my $c = $self->recvchallenge();
 498                 return 0 if not defined $c;
 499                 my $key = Digest::HMAC::hmac("$c $line", $self->{password}, \&Digest::MD4::md4);
 500                 return $self->{connector}->send("\377\377\377\377srcon HMAC-MD4 CHALLENGE $key $c $line");
 501         }
 502         elsif($self->{secure})
 503         {
 504                 my $t = sprintf "%ld.%06d", time(), int rand 1000000;
 505                 my $key = Digest::HMAC::hmac("$t $line", $self->{password}, \&Digest::MD4::md4);
 506                 return $self->{connector}->send("\377\377\377\377srcon HMAC-MD4 TIME $key $t $line");
 507         }
 508         else
 509         {
 510                 return $self->{connector}->send("\377\377\377\377rcon $self->{password} $line");
 511         }
 512 }
 513
 514 # Note: backslash and quotation mark escaping is a DarkPlaces extension.
 515 sub quote($$)
 516 {
 517         my ($self, $data) = @_;
 518         $data =~ s/[\000-\037]//g;
 519         $data =~ s/([\\"])/\\$1/g;
 520         $data =~ s/\$/\$\$/g;
 521         return $data;
 522 }
 523
 524 sub recvchallenge($)
 525 {
 526         my ($self) = @_;
 527
 528         my $sel = IO::Select->new($self->fds());
 529         my $endtime_max = Time::HiRes::time() + $self->{timeout};
 530         my $endtime = $endtime_max;
 531
 532         while((my $dt = $endtime - Time::HiRes::time()) > 0)
 533         {
 534                 if($sel->can_read($dt))
 535                 {
 536                         for(;;)
 537                         {
 538                                 my $s = $self->{connector}->recv();
 539                                 die "read error\n"
 540                                         if not defined $s;
 541                                 length $s
 542                                         or last;
 543                                 if($s =~ /^\377\377\377\377challenge (.*?)(?:$|\0)/s)
 544                                 {
 545                                         return $1;
 546                                 }
 547                                 next
 548                                         if $s !~ /^\377\377\377\377n(.*)$/s;
 549                                 $self->{recvbuf} .= $1;
 550                         }
 551                 }
 552         }
 553         return undef;
 554 }
 555
 556 sub recv($)
 557 {
 558         my ($self) = @_;
 559         for(;;)
 560         {
 561                 my $s = $self->{connector}->recv();
 562                 die "read error\n"
 563                         if not defined $s;
 564                 length $s
 565                         or last;
 566                 next
 567                         if $s !~ /^\377\377\377\377n(.*)$/s;
 568                 $self->{recvbuf} .= $1;
 569         }
 570         my @out = ();
 571         while($self->{recvbuf} =~ s/^(.*?)(?:\r\n?|\n)//)
 572         {
 573                 my $s = $1;
 574                 utf8::decode $s
 575                         if $color_utf8_enable;
 576                 push @out, $s;
 577         }
 578         return @out;
 579 }
 580
 581 sub fds($)
 582 {
 583         my ($self) = @_;
 584         return $self->{connector}->fds();
 585 }
 586
 587
 588
 589
 590
 591
 592
 593 # Line based protocol channel.
 594 # Wraps around a TCP based Connection and sends commands as text lines
 595 # (separated by CRLF). When reading responses from the Connection, any type of
 596 # line ending is accepted.
 597 # A flood control mechanism is implemented.
 598 package Channel::Line;
 599 use strict;
 600 use warnings;
 601 use Time::HiRes qw/time/;
 602
 603 # Constructor:
 604 #   my $chan = new Channel::Line($connection);
 605 sub new($$)
 606 {
 607         my ($class, $conn) = @_;
 608         my $you = {
 609                 connector => $conn,
 610                 recvbuf => "",
 611                 capacity => undef,
 612                 linepersec => undef,
 613                 maxlines => undef,
 614                 lastsend => time()
 615         };
 616         return
 617                 bless $you, 'Channel::Line';
 618 }
 619
 620 sub join_commands($@)
 621 {
 622         my ($self, @data) = @_;
 623         return @data;
 624 }
 625
 626 # Sets new flood control parameters:
 627 #   $chan->throttle(maximum lines per second, maximum burst length allowed to
 628 #     exceed the lines per second limit);
 629 #   RFC 1459 describes these parameters to be 0.5 and 5 for the IRC protocol.
 630 #   If the $nothrottle flag is set while sending, the line is sent anyway even
 631 #   if flooding would take place.
 632 sub throttle($$$)
 633 {
 634         my ($self, $linepersec, $maxlines) = @_;
 635         $self->{linepersec} = $linepersec;
 636         $self->{maxlines} = $maxlines;
 637         $self->{capacity} = $maxlines;
 638 }
 639
 640 sub send($$$)
 641 {
 642         my ($self, $line, $nothrottle) = @_;
 643         utf8::encode $line
 644                 if $color_utf8_enable;
 645         my $t = time();
 646         if(defined $self->{capacity})
 647         {
 648                 $self->{capacity} += ($t - $self->{lastsend}) * $self->{linepersec};
 649                 $self->{lastsend} = $t;
 650                 $self->{capacity} = $self->{maxlines}
 651                         if $self->{capacity} > $self->{maxlines};
 652                 if(!$nothrottle)
 653                 {
 654                         return -1
 655                                 if $self->{capacity} < 0;
 656                 }
 657                 $self->{capacity} -= 1;
 658         }
 659         $line =~ s/\r|\n//g;
 660         return $self->{connector}->send("$line\r\n");
 661 }
 662
 663 sub quote($$)
 664 {
 665         my ($self, $data) = @_;
 666         $data =~ s/\r\n?/\n/g;
 667         $data =~ s/\n/*/g;
 668         return $data;
 669 }
 670
 671 sub recv($)
 672 {
 673         my ($self) = @_;
 674         for(;;)
 675         {
 676                 my $s = $self->{connector}->recv();
 677                 die "read error\n"
 678                         if not defined $s;
 679                 length $s
 680                         or last;
 681                 $self->{recvbuf} .= $s;
 682         }
 683         my @out = ();
 684         while($self->{recvbuf} =~ s/^(.*?)(?:\r\n?|\n)//)
 685         {
 686                 my $s = $1;
 687                 utf8::decode $s
 688                         if $color_utf8_enable;
 689                 push @out, $s;
 690         }
 691         return @out;
 692 }
 693
 694 sub fds($)
 695 {
 696         my ($self) = @_;
 697         return $self->{connector}->fds();
 698 }
 699
 700
 701
 702
 703
 704
 705 # main program... a gateway between IRC and DarkPlaces servers
 706 package main;
 707
 708 use strict;
 709 use warnings;
 710 use IO::Select;
 711 use Digest::SHA;
 712 use Digest::HMAC;
 713 use Time::HiRes qw/time/;
 714
 715 our @handlers = (); # list of [channel, expression, sub to handle result]
 716 our @tasks = (); # list of [time, sub]
 717 our %channels = ();
 718 our %store = (
 719         irc_nick => "",
 720         playernick_byid_0 => "(console)",
 721 );
 722 our %config = (
 723         irc_server => undef,
 724         irc_nick => undef,
 725         irc_nick_alternates => "",
 726         irc_user => undef,
 727         irc_channel => undef,
 728         irc_ping_delay => 120,
 729         irc_trigger => "",
 730
 731         irc_nickserv_password => "",
 732         irc_nickserv_identify => 'PRIVMSG NickServ :IDENTIFY %2$s',
 733         irc_nickserv_ghost => 'PRIVMSG NickServ :GHOST %1$s %2$s',
 734         irc_nickserv_ghost_attempts => 3,
 735
 736         irc_quakenet_authname => "",
 737         irc_quakenet_password => "",
 738         irc_quakenet_authusers => "",
 739         irc_quakenet_getchallenge => 'PRIVMSG Q@CServe.quakenet.org :CHALLENGE',
 740         irc_quakenet_challengeauth => 'PRIVMSG Q@CServe.quakenet.org :CHALLENGEAUTH',
 741         irc_quakenet_challengeprefix => ':Q!TheQBot@CServe.quakenet.org NOTICE [^:]+ :CHALLENGE',
 742
 743         irc_announce_slotsfree => 1,
 744         irc_announce_mapchange => 'always',
 745
 746         dp_server => undef,
 747         dp_secure => 1,
 748         dp_secure_challengetimeout => 1,
 749         dp_listen => "",
 750         dp_password => undef,
 751         dp_status_delay => 30,
 752         dp_server_from_wan => "",
 753         dp_listen_from_server => "",
 754         dp_utf8_enable => $color_utf8_enable,
 755         irc_local => "",
 756
 757         irc_admin_password => "",
 758         irc_admin_timeout => 3600,
 759         irc_admin_quote_re => "",
 760
 761         irc_reconnect_delay => 300,
 762
 763         plugins => "",
 764 );
 765
 766 sub pickip($$)
 767 {
 768         my ($wan, $lan) = @_;
 769         # $wan shall override $lan
 770         return $lan
 771                 if not length $wan;
 772         return $wan
 773                 if $wan =~ /:\d+$/; # full override
 774         return $wan
 775                 if $lan !~ /:(\d+)$/;
 776         return "$wan:$1";
 777 }
 778
 779
 780
 781 # Xonotic specific parsing of some server messages
 782
 783 sub xon_slotsstring()
 784 {
 785         my $slotsstr = "";
 786         if(defined $store{slots_max})
 787         {
 788                 my $slots = $store{slots_max} - $store{slots_active};
 789                 my $slots_s = ($slots == 1) ? '' : 's';
 790                 $slotsstr = " ($slots free slot$slots_s)";
 791                 my $s = pickip($config{dp_server_from_wan}, $config{dp_server});
 792                 $slotsstr .= "; join now: \002xonotic +connect $s"
 793                         if $slots >= 1 and not $store{lms_blocked};
 794         }
 795         return $slotsstr;
 796 }
 797
 798
 799
 800 # Do we have a config file? If yes, read and parse it (syntax: key = value
 801 # pairs, separated by newlines), if not, complain.
 802 die "Usage: $0 configfile\n"
 803         unless @ARGV == 1;
 804
 805 open my $fh, "<", $ARGV[0]
 806         or die "open $ARGV[0]: $!";
 807 while(<$fh>)
 808 {
 809         chomp;
 810         /^#/ and next;
 811         /^(.*?)\s*=(?:\s*(.*))?$/ or next;
 812         warn "Undefined config item: $1"
 813                 unless exists $config{$1};
 814         $config{$1} = defined $2 ? $2 : "";
 815 }
 816 close $fh;
 817 my @missing = grep { !defined $config{$_} } keys %config;
 818 die "The following config items are missing: @missing"
 819         if @missing;
 820
 821 $color_utf8_enable = $config{dp_utf8_enable};
 822
 823
 824 # Create a channel for error messages and other internal status messages...
 825
 826 $channels{system} = new Channel::FIFO();
 827
 828 # for example, quit messages caused by signals (if SIGTERM or SIGINT is first
 829 # received, try to shut down cleanly, and if such a signal is received a second
 830 # time, just exit)
 831 my $quitting = 0;
 832 $SIG{INT} = sub {
 833         exit 1 if $quitting++;
 834         $channels{system}->send("quit SIGINT");
 835 };
 836 $SIG{TERM} = sub {
 837         exit 1 if $quitting++;
 838         $channels{system}->send("quit SIGTERM");
 839 };
 840
 841
 842
 843 # Create the two channels to gateway between...
 844
 845 $channels{irc} = new Channel::Line(new Connection::Socket(tcp => $config{irc_local} => $config{irc_server} => 6667));
 846 $channels{dp} = new Channel::QW(my $dpsock = new Connection::Socket(udp => $config{dp_listen} => $config{dp_server} => 26000), $config{dp_password}, $config{dp_secure}, $config{dp_secure_challengetimeout});
 847 $config{dp_listen} = $dpsock->sockname();
 848 $config{dp_server} = $dpsock->peername();
 849 print "Listening on $config{dp_listen}\n";
 850
 851 $channels{irc}->throttle(0.5, 5);
 852
 853
 854 # Utility routine to write to a channel by name, also outputting what's been written and some status
 855 sub out($$@)
 856 {
 857         my $chanstr = shift;
 858         my $nothrottle = shift;
 859         my $chan = $channels{$chanstr};
 860         if(!$chan)
 861         {
 862                 print "UNDEFINED: $chanstr, ignoring message\n";
 863                 return;
 864         }
 865         @_ = $chan->join_commands(@_);
 866         for(@_)
 867         {
 868                 my $result = $chan->send($_, $nothrottle);
 869                 if($result > 0)
 870                 {
 871                         print "           $chanstr << $_\n";
 872                 }
 873                 elsif($result < 0)
 874                 {
 875                         print "FLOOD:     $chanstr << $_\n";
 876                 }
 877                 else
 878                 {
 879                         print "ERROR:     $chanstr << $_\n";
 880                         $channels{system}->send("error $chanstr", 0);
 881                 }
 882         }
 883 }
 884
 885
 886
 887 # Schedule a task for later execution by the main loop; usage: schedule sub {
 888 # task... }, $time; When a scheduled task is run, a reference to the task's own
 889 # sub is passed as first argument; that way, the task is able to re-schedule
 890 # itself so it gets periodically executed.
 891 sub schedule($$)
 892 {
 893         my ($sub, $time) = @_;
 894         push @tasks, [time() + $time, $sub];
 895 }
 896
 897 # On IRC error, delete some data store variables of the connection, and
 898 # reconnect to the IRC server soon (but only if someone is actually playing)
 899 sub irc_error()
 900 {
 901         # prevent multiple instances of this timer
 902         return if $store{irc_error_active};
 903         $store{irc_error_active} = 1;
 904
 905         delete $channels{irc};
 906         schedule sub {
 907                 my ($timer) = @_;
 908                 if(!defined $store{slots_active})
 909                 {
 910                         # DP is not running, then delay IRC reconnecting
 911                         #use Data::Dumper; print Dumper \$timer;
 912                         schedule $timer => 1;
 913                         return;
 914                         # this will keep irc_error_active
 915                 }
 916                 $channels{irc} = new Channel::Line(new Connection::Socket(tcp => $config{irc_local} => $config{irc_server} => 6667));
 917                 delete $store{$_} for grep { /^irc_/ } keys %store;
 918                 $store{irc_nick} = "";
 919                 schedule sub {
 920                         my ($timer) = @_;
 921                         out dp => 0, 'sv_cmd bans', 'status 1', 'log_dest_udp';
 922                         $store{status_waiting} = -1;
 923                 } => 1;
 924                 # this will clear irc_error_active
 925         } => $config{irc_reconnect_delay};
 926         return 0;
 927 }
 928
 929 sub uniq(@)
 930 {
 931         my @out = ();
 932         my %found = ();
 933         for(@_)
 934         {
 935                 next if $found{$_}++;
 936                 push @out, $_;
 937         }
 938         return @out;
 939 }
 940
 941 # IRC joining (if this is called as response to a nick name collision, $is433 is set);
 942 # among other stuff, it performs NickServ or Quakenet authentication. This is to be called
 943 # until the channel has been joined for every message that may be "interesting" (basically,
 944 # IRC 001 hello messages, 443 nick collision messages and some notices by services).
 945 sub irc_joinstage($)
 946 {
 947         my($is433) = @_;
 948
 949         return 0
 950                 if $store{irc_joined_channel};
 951
 952                 #use Data::Dumper; print Dumper \%store;
 953
 954         if($is433)
 955         {
 956                 if(length $store{irc_nick})
 957                 {
 958                         # we already have another nick, but couldn't change to the new one
 959                         # try ghosting and then get the nick again
 960                         if(length $config{irc_nickserv_password})
 961                         {
 962                                 if(++$store{irc_nickserv_ghost_attempts} <= $config{irc_nickserv_ghost_attempts})
 963                                 {
 964                                         $store{irc_nick_requested} = $config{irc_nick};
 965                                         out irc => 1, sprintf($config{irc_nickserv_ghost}, $config{irc_nick}, $config{irc_nickserv_password});
 966                                         schedule sub {
 967                                                 out irc => 1, "NICK $config{irc_nick}";
 968                                         } => 1;
 969                                         return; # we'll get here again for the NICK success message, or for a 433 failure
 970                                 }
 971                                 # otherwise, we failed to ghost and will continue with the wrong
 972                                 # nick... also, no need to try to identify here
 973                         }
 974                         # otherwise, we can't handle this and will continue with our wrong nick
 975                 }
 976                 else
 977                 {
 978                         # we failed to get an initial nickname
 979                         # change ours a bit and try again
 980
 981                         my @alternates = uniq ($config{irc_nick}, grep { $_ ne "" } split /\s+/, $config{irc_nick_alternates});
 982                         my $nextnick = undef;
 983                         for(0..@alternates-2)
 984                         {
 985                                 if($store{irc_nick_requested} eq $alternates[$_])
 986                                 {
 987                                         $nextnick = $alternates[$_+1];
 988                                 }
 989                         }
 990                         if($store{irc_nick_requested} eq $alternates[@alternates-1]) # this will only happen once
 991                         {
 992                                 $store{irc_nick_requested} = $alternates[0];
 993                                 # but don't set nextnick, so we edit it
 994                         }
 995                         if(defined $nextnick)
 996                         {
 997                                 $store{irc_nick_requested} = $nextnick;
 998                         }
 999                         else
1000                         {
1001                                 for(;;)
1002                                 {
1003                                         if(length $store{irc_nick_requested} < 9)
1004                                         {
1005                                                 $store{irc_nick_requested} .= '_';
1006                                         }
1007                                         else
1008                                         {
1009                                                 substr $store{irc_nick_requested}, int(rand length $store{irc_nick_requested}), 1, chr(97 + int rand 26);
1010                                         }
1011                                         last unless grep { $_ eq $store{irc_nick_requested} } @alternates;
1012                                 }
1013                         }
1014                         out irc => 1, "NICK $store{irc_nick_requested}";
1015                         return; # when it fails, we'll get here again, and when it succeeds, we will continue
1016                 }
1017         }
1018
1019         # we got a 001 or a NICK message, so $store{irc_nick} has been updated
1020         if(length $config{irc_nickserv_password})
1021         {
1022                 if($store{irc_nick} eq $config{irc_nick})
1023                 {
1024                         # identify
1025                         out irc => 1, sprintf($config{irc_nickserv_identify}, $config{irc_nick}, $config{irc_nickserv_password});
1026                 }
1027                 else
1028                 {
1029                         # ghost
1030                         if(++$store{irc_nickserv_ghost_attempts} <= $config{irc_nickserv_ghost_attempts})
1031                         {
1032                                 $store{irc_nick_requested} = $config{irc_nick};
1033                                 out irc => 1, sprintf($config{irc_nickserv_ghost}, $config{irc_nick}, $config{irc_nickserv_password});
1034                                 schedule sub {
1035                                         out irc => 1, "NICK $config{irc_nick}";
1036                                 } => 1;
1037                                 return; # we'll get here again for the NICK success message, or for a 433 failure
1038                         }
1039                         # otherwise, we failed to ghost and will continue with the wrong
1040                         # nick... also, no need to try to identify here
1041                 }
1042         }
1043
1044         # we are on Quakenet. Try to authenticate.
1045         if(length $config{irc_quakenet_password} and length $config{irc_quakenet_authname})
1046         {
1047                 if(defined $store{irc_quakenet_challenge})
1048                 {
1049                         if($store{irc_quakenet_challenge} =~ /^([0-9a-f]*)\b.*\bHMAC-SHA-256\b/)
1050                         {
1051                                 my $challenge = $1;
1052                                 my $hash1 = Digest::SHA::sha256_hex(substr $config{irc_quakenet_password}, 0, 10);
1053                                 my $key = Digest::SHA::sha256_hex("@{[lc $config{irc_quakenet_authname}]}:$hash1");
1054                                 my $digest = Digest::HMAC::hmac_hex($challenge, $key, \&Digest::SHA::sha256);
1055                                 out irc => 1, "$config{irc_quakenet_challengeauth} $config{irc_quakenet_authname} $digest HMAC-SHA-256";
1056                         }
1057                 }
1058                 else
1059                 {
1060                         out irc => 1, $config{irc_quakenet_getchallenge};
1061                         return;
1062                         # we get here again when Q asks us
1063                 }
1064         }
1065
1066         # if we get here, we are on IRC
1067         $store{irc_joined_channel} = 1;
1068         schedule sub {
1069                 out irc => 1, "JOIN $config{irc_channel}";
1070         } => 1;
1071         return 0;
1072 }
1073
1074 my $RE_FAIL = qr/$ $/;
1075 my $RE_SUCCEED = qr//;
1076 sub cond($)
1077 {
1078         return $_[0] ? $RE_FAIL : $RE_SUCCEED;
1079 }
1080
1081
1082 # List of all handlers on the various sockets. Additional handlers can be added by a plugin.
1083 @handlers = (
1084         # detect a server restart and set it up again
1085         [ dp => q{ *(?:Warning: Could not expand \$|Unknown command ")(?:rcon2irc_[a-z0-9_]*)[" ]*} => sub {
1086                 out dp => 0,
1087                         'alias rcon2irc_eval "$*"',
1088                         'log_dest_udp',
1089                         'sv_logscores_console 0',
1090                         'sv_logscores_bots 1',
1091                         'sv_eventlog 1',
1092                         'sv_eventlog_console 1',
1093                         'alias rcon2irc_say_as "set say_as_restorenick \"$sv_adminnick\"; sv_adminnick \"$1^3\"; say \"^7$2\"; rcon2irc_say_as_restore"',
1094                         'alias rcon2irc_say_as_restore "set sv_adminnick \"$say_as_restorenick\""',
1095                         'alias rcon2irc_quit "echo \"quitting rcon2irc $1: log_dest_udp is $log_dest_udp\""'; # note: \\\\\\" ->perl \\\" ->console \"
1096                 return 0;
1097         } ],
1098
1099         # detect missing entry in log_dest_udp and fix it
1100         [ dp => q{"log_dest_udp" is "([^"]*)" \["[^"]*"\]} => sub {
1101                 my ($dest) = @_;
1102                 my @dests = split ' ', $dest;
1103                 return 0 if grep { $_ eq pickip($config{dp_listen_from_server}, $config{dp_listen}) } @dests;
1104                 out dp => 0, 'log_dest_udp "' . join(" ", @dests, pickip($config{dp_listen_from_server}, $config{dp_listen})) . '"';
1105                 return 0;
1106         } ],
1107
1108         # retrieve list of banned hosts
1109         [ dp => q{#(\d+): (\S+) is still banned for (\S+) seconds} => sub {
1110                 return 0 unless $store{status_waiting} < 0;
1111                 my ($id, $ip, $time) = @_;
1112                 $store{bans_new} = [] if $id == 0;
1113                 $store{bans_new}[$id] = { ip => $ip, 'time' => $time };
1114                 return 0;
1115         } ],
1116
1117         # retrieve hostname from status replies
1118         [ dp => q{host:     (.*)} => sub {
1119                 return 0 unless $store{status_waiting} < 0;
1120                 my ($name) = @_;
1121                 $store{dp_hostname} = $name;
1122                 $store{bans} = $store{bans_new};
1123                 return 0;
1124         } ],
1125
1126         # retrieve version from status replies
1127         [ dp => q{version:  (.*)} => sub {
1128                 return 0 unless $store{status_waiting} < 0;
1129                 my ($version) = @_;
1130                 $store{dp_version} = $version;
1131                 return 0;
1132         } ],
1133
1134         # retrieve player names
1135         [ dp => q{players:  (\d+) active \((\d+) max\)} => sub {
1136                 return 0 unless $store{status_waiting} < 0;
1137                 my ($active, $max) = @_;
1138                 my $full = ($active >= $max);
1139                 $store{slots_max} = $max;
1140                 $store{slots_active} = $active;
1141                 $store{status_waiting} = $active;
1142                 $store{playerslots_active_new} = [];
1143                 if($store{status_waiting} == 0)
1144                 {
1145                         $store{playerslots_active} = $store{playerslots_active_new};
1146                 }
1147                 if($full != ($store{slots_full} || 0))
1148                 {
1149                         $store{slots_full} = $full;
1150                         return 0 if $store{lms_blocked};
1151                         return 0 if !$config{irc_announce_slotsfree};
1152                         if($full)
1153                         {
1154                                 out irc => 0, "PRIVMSG $config{irc_channel} :\001ACTION is full!\001";
1155                         }
1156                         else
1157                         {
1158                                 my $slotsstr = xon_slotsstring();
1159                                 out irc => 0, "PRIVMSG $config{irc_channel} :\001ACTION can be joined again$slotsstr!\001";
1160                         }
1161                 }
1162                 return 0;
1163         } ],
1164
1165         # retrieve player names
1166         [ dp => q{\^\d(\S+)\s+(\d+)\s+(\d+)\s+(\S+)\s+(-?\d+)\s+\#(\d+)\s+\^\d(.*)} => sub {
1167                 return 0 unless $store{status_waiting} > 0;
1168                 my ($ip, $pl, $ping, $time, $frags, $no, $name) = ($1, $2, $3, $4, $5, $6, $7);
1169                 $store{"playerslot_$no"} = { ip => $ip, pl => $pl, ping => $ping, 'time' => $time, frags => $frags, no => $no, name => $name };
1170                 push @{$store{playerslots_active_new}}, $no;
1171                 if(--$store{status_waiting} == 0)
1172                 {
1173                         $store{playerslots_active} = $store{playerslots_active_new};
1174                 }
1175                 return 0;
1176         } ],
1177
1178         # IRC admin commands
1179         [ irc => q{:(([^! ]*)![^ ]*) (?i:PRIVMSG) [^&#%]\S* :(.*)} => sub {
1180                 return 0 unless ($config{irc_admin_password} ne '' || $store{irc_quakenet_users});
1181
1182                 my ($hostmask, $nick, $command) = @_;
1183                 my $dpnick = color_dpfix $nick;
1184
1185                 if($command eq "login $config{irc_admin_password}")
1186                 {
1187                         $store{logins}{$hostmask} = time() + $config{irc_admin_timeout};
1188                         out irc => 0, "PRIVMSG $nick :my wish is your command";
1189                         return -1;
1190                 }
1191
1192                 if($command =~ /^login /)
1193                 {
1194                         out irc => 0, "PRIVMSG $nick :invalid password";
1195                         return -1;
1196                 }
1197
1198                 if(($store{logins}{$hostmask} || 0) < time())
1199                 {
1200                         out irc => 0, "PRIVMSG $nick :authentication required";
1201                         return -1;
1202                 }
1203
1204                 if($command =~ /^status(?: (.*))?$/)
1205                 {
1206                         my ($match) = $1;
1207                         my $found = 0;
1208                         my $foundany = 0;
1209                         for my $slot(@{$store{playerslots_active} || []})
1210                         {
1211                                 my $s = $store{"playerslot_$slot"};
1212                                 next unless $s;
1213                                 if(not defined $match or index(color_dp2none($s->{name}), $match) >= 0)
1214                                 {
1215                                         out irc => 0, sprintf 'PRIVMSG %s :%-21s %2i %4i %8s %4i #%-3u %s', $nick, $s->{ip}, $s->{pl}, $s->{ping}, $s->{time}, $s->{frags}, $slot, color_dp2irc $s->{name};
1216                                         ++$found;
1217                                 }
1218                                 ++$foundany;
1219                         }
1220                         if(!$found)
1221                         {
1222                                 if(!$foundany)
1223                                 {
1224                                         out irc => 0, "PRIVMSG $nick :the server is empty";
1225                                 }
1226                                 else
1227                                 {
1228                                         out irc => 0, "PRIVMSG $nick :no nicknames match";
1229                                 }
1230                         }
1231                         return 0;
1232                 }
1233
1234                 if($command =~ /^kick # (\d+) (.*)$/)
1235                 {
1236                         my ($id, $reason) = ($1, $2);
1237                         my $dpreason = color_irc2dp $reason;
1238                         $dpreason =~ s/^(~?)(.*)/$1irc $dpnick: $2/g;
1239                         $dpreason =~ s/(["\\])/\\$1/g;
1240                         out dp => 0, "kick # $id $dpreason";
1241                         my $slotnik = "playerslot_$id";
1242                         out irc => 0, "PRIVMSG $nick :kicked #$id (@{[color_dp2irc $store{$slotnik}{name}]}\017 @ $store{$slotnik}{ip}) ($reason)";
1243                         return 0;
1244                 }
1245
1246                 if($command =~ /^kickban # (\d+) (\d+) (\d+) (.*)$/)
1247                 {
1248                         my ($id, $bantime, $mask, $reason) = ($1, $2, $3, $4);
1249                         my $dpreason = color_irc2dp $reason;
1250                         $dpreason =~ s/^(~?)(.*)/$1irc $dpnick: $2/g;
1251                         $dpreason =~ s/(["\\])/\\$1/g;
1252                         out dp => 0, "kickban # $id $bantime $mask $dpreason";
1253                         my $slotnik = "playerslot_$id";
1254                         out irc => 0, "PRIVMSG $nick :kickbanned #$id (@{[color_dp2irc $store{$slotnik}{name}]}\017 @ $store{$slotnik}{ip}), netmask $mask, for $bantime seconds ($reason)";
1255                         return 0;
1256                 }
1257
1258                 if($command eq "bans")
1259                 {
1260                         my $banlist =
1261                                 join ", ",
1262                                 map { "$_ ($store{bans}[$_]{ip}, $store{bans}[$_]{time}s)" }
1263                                 0..@{$store{bans} || []}-1;
1264                         $banlist = "no bans"
1265                                 if $banlist eq "";
1266                         out irc => 0, "PRIVMSG $nick :$banlist";
1267                         return 0;
1268                 }
1269
1270                 if($command =~ /^unban (\d+)$/)
1271                 {
1272                         my ($id) = ($1);
1273                         out dp => 0, "unban $id";
1274                         out irc => 0, "PRIVMSG $nick :removed ban $id ($store{bans}[$id]{ip})";
1275                         return 0;
1276                 }
1277
1278                 if($command =~ /^mute (\d+)$/)
1279                 {
1280                         my $id = $1;
1281                         out dp => 0, "mute $id";
1282                         my $slotnik = "playerslot_$id";
1283                         out irc => 0, "PRIVMSG $nick :muted $id (@{[color_dp2irc $store{$slotnik}{name}]}\017 @ $store{$slotnik}{ip})";
1284                         return 0;
1285                 }
1286
1287                 if($command =~ /^unmute (\d+)$/)
1288                 {
1289                         my ($id) = ($1);
1290                         out dp => 0, "unmute $id";
1291                         my $slotnik = "playerslot_$id";
1292                         out irc => 0, "PRIVMSG $nick :unmuted $id (@{[color_dp2irc $store{$slotnik}{name}]}\017 @ $store{$slotnik}{ip})";
1293                         return 0;
1294                 }
1295
1296                 if($command =~ /^quote (.*)$/)
1297                 {
1298                         my ($cmd) = ($1);
1299                         if($cmd =~ /^(??{$config{irc_admin_quote_re}})$/si)
1300                         {
1301                                 out irc => 0, $cmd;
1302                                 out irc => 0, "PRIVMSG $nick :executed your command";
1303                         }
1304                         else
1305                         {
1306                                 out irc => 0, "PRIVMSG $nick :permission denied";
1307                         }
1308                         return 0;
1309                 }
1310
1311                 out irc => 0, "PRIVMSG $nick :unknown command (supported: status [substring], kick # id reason, kickban # id bantime mask reason, bans, unban banid, mute id, unmute id)";
1312
1313                 return -1;
1314         } ],
1315
1316         # LMS: detect "no more lives" message
1317         [ dp => q{\^4.*\^4 has no more lives left} => sub {
1318                 if(!$store{lms_blocked})
1319                 {
1320                         $store{lms_blocked} = 1;
1321                         if(!$store{slots_full})
1322                         {
1323                                 schedule sub {
1324                                         if($store{lms_blocked})
1325                                         {
1326                                                 out irc => 0, "PRIVMSG $config{irc_channel} :\001ACTION can't be joined until next round (a player has no more lives left)\001";
1327                                         }
1328                                 } => 1;
1329                         }
1330                 }
1331         } ],
1332
1333         # detect IRC errors and reconnect
1334         [ irc => q{ERROR .*} => \&irc_error ],
1335         [ irc => q{:[^ ]* 404 .*} => \&irc_error ], # cannot send to channel
1336         [ system => q{error irc} => \&irc_error ],
1337
1338         # IRC nick in use
1339         [ irc => q{:[^ ]* 433 .*} => sub {
1340                 return irc_joinstage(433);
1341         } ],
1342
1343         # IRC welcome
1344         [ irc => q{:[^ ]* 001 .*} => sub {
1345                 $store{irc_seen_welcome} = 1;
1346                 $store{irc_nick} = $store{irc_nick_requested};
1347
1348                 # If users for quakenet are listed, parse them into a hash and schedule a sub to query information
1349                 if ($config{irc_quakenet_authusers} ne '') {
1350                         $store{irc_quakenet_users} = { map { $_ => 1 } split / /, $config{irc_quakenet_authusers} };
1351
1352                         schedule sub {
1353                                 my ($timer) = @_;
1354                                 out irc => 0, "PRIVMSG Q :users " . $config{irc_channel};
1355                                 schedule $timer => 300;;
1356                         } => 1;
1357                 }
1358
1359                 return irc_joinstage(0);
1360         } ],
1361
1362         # IRC my nickname changed
1363         [ irc => q{:(?i:(??{$store{irc_nick}}))![^ ]* (?i:NICK) :(.*)} => sub {
1364                 my ($n) = @_;
1365                 $store{irc_nick} = $n;
1366                 return irc_joinstage(0);
1367         } ],
1368
1369         # Quakenet: challenge from Q
1370         [ irc => q{(??{$config{irc_quakenet_challengeprefix}}) (.*)} => sub {
1371                 $store{irc_quakenet_challenge} = $1;
1372                 return irc_joinstage(0);
1373         } ],
1374
1375         # Catch joins of people in a channel the bot is in and catch our own joins of a channel,
1376         # detect channel join message and note hostname length to get the maximum allowed line length
1377         [ irc => q{:(([^! ]*)![^ ]*) JOIN (#.+)} => sub {
1378                 my ($hostmask, $nick, $chan) = @_;
1379
1380                 if ($nick eq $store{irc_nick}) {
1381                         $store{irc_maxlen} = 510 - length($hostmask);
1382                         $store{irc_joined_channel} = 1;
1383                         print "* detected maximum line length for channel messages: $store{irc_maxlen}\n";
1384                 }
1385
1386                 return 0 unless ($store{irc_quakenet_users});
1387
1388                 if ($nick eq $store{irc_nick}) {
1389                         out irc => 0, "PRIVMSG Q :users $chan"; # get auths for all users
1390                 } else {
1391                         $store{quakenet_hosts}->{$nick} = $hostmask;
1392                         out irc => 0, "PRIVMSG Q :whois $nick"; # get auth for single user
1393                 }
1394
1395                 return 0;
1396         } ],
1397
1398         # Catch response of users request
1399         [ irc => q{:Q!TheQBot@CServe.quakenet.org NOTICE [^:]+ :[@\+\s]?(\S+)\s+(\S+)\s*(\S*)\s*\((.*)\)} => sub {
1400                 my ($nick, $username, $flags, $host) = @_;
1401                 return 0 unless ($store{irc_quakenet_users});
1402
1403                 $store{logins}{"$nick!$host"} = time() + 600 if ($store{irc_quakenet_users}->{$username});
1404
1405                 return 0;
1406         } ],
1407
1408         # Catch response of whois request
1409         [ irc => q{:Q!TheQBot@CServe.quakenet.org NOTICE [^:]+ :-Information for user (.*) \(using account (.*)\):} => sub {
1410                 my ($nick, $username) = @_;
1411                 return 0 unless ($store{irc_quakenet_users});
1412
1413                 if ($store{irc_quakenet_users}->{$username}) {
1414                         my $hostmask = $store{quakenet_hosts}->{$nick};
1415                         $store{logins}{$hostmask} = time() + 600;
1416                 }
1417
1418                 return 0;
1419         } ],
1420
1421         # shut down everything on SIGINT
1422         [ system => q{quit (.*)} => sub {
1423                 my ($cause) = @_;
1424                 out irc => 1, "QUIT :$cause";
1425                 $store{quitcookie} = int rand 1000000000;
1426                 out dp => 0, "rcon2irc_quit $store{quitcookie}";
1427         } ],
1428
1429         # remove myself from the log destinations and exit everything
1430         [ dp => q{quitting rcon2irc (??{$store{quitcookie}}): log_dest_udp is (.*) *} => sub {
1431                 my ($dest) = @_;
1432                 my @dests = grep { $_ ne pickip($config{dp_listen_from_server}, $config{dp_listen}) } split ' ', $dest;
1433                 out dp => 0, 'log_dest_udp "' . join(" ", @dests) . '"';
1434                 exit 0;
1435                 return 0;
1436         } ],
1437
1438         # IRC PING
1439         [ irc => q{PING (.*)} => sub {
1440                 my ($data) = @_;
1441                 out irc => 1, "PONG $data";
1442                 return 1;
1443         } ],
1444
1445         # IRC PONG
1446         [ irc => q{:[^ ]* PONG .* :(.*)} => sub {
1447                 my ($data) = @_;
1448                 return 0
1449                         if not defined $store{irc_pingtime};
1450                 return 0
1451                         if $data ne $store{irc_pingtime};
1452                 print "* measured IRC line delay: @{[time() - $store{irc_pingtime}]}\n";
1453                 undef $store{irc_pingtime};
1454                 return 0;
1455         } ],
1456
1457         # chat: Xonotic server -> IRC channel
1458         [ dp => q{\001(.*?)\^7: (.*)} => sub {
1459                 my ($nick, $message) = map { color_dp2irc $_ } @_;
1460                 out irc => 0, "PRIVMSG $config{irc_channel} :<$nick\017> $message";
1461                 return 0;
1462         } ],
1463
1464         # chat: Xonotic server -> IRC channel, nick set
1465         [ dp => q{:join:(\d+):(\d+):([^:]*):(.*)} => sub {
1466                 my ($id, $slot, $ip, $nick) = @_;
1467                 $store{"playernickraw_byid_$id"} = $nick;
1468                 $nick = color_dp2irc $nick;
1469                 $store{"playernick_byid_$id"} = $nick;
1470                 $store{"playerip_byid_$id"} = $ip;
1471                 $store{"playerslot_byid_$id"} = $slot;
1472                 $store{"playerid_byslot_$slot"} = $id;
1473                 return 0;
1474         } ],
1475
1476         # chat: Xonotic server -> IRC channel, nick change/set
1477         [ dp => q{:name:(\d+):(.*)} => sub {
1478                 my ($id, $nick) = @_;
1479                 $store{"playernickraw_byid_$id"} = $nick;
1480                 $nick = color_dp2irc $nick;
1481                 my $oldnick = $store{"playernick_byid_$id"};
1482                 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 is now known as $nick";
1483                 $store{"playernick_byid_$id"} = $nick;
1484                 return 0;
1485         } ],
1486
1487         # chat: Xonotic server -> IRC channel, vote call
1488         [ dp => q{:vote:vcall:(\d+):(.*)} => sub {
1489                 my ($id, $command) = @_;
1490                 $command = color_dp2irc $command;
1491                 my $oldnick = $id ? $store{"playernick_byid_$id"} : "(console)";
1492                 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 calls a vote for \"$command\017\"";
1493                 return 0;
1494         } ],
1495
1496         # chat: Xonotic server -> IRC channel, vote stop
1497         [ dp => q{:vote:vstop:(\d+)} => sub {
1498                 my ($id) = @_;
1499                 my $oldnick = $id ? $store{"playernick_byid_$id"} : "(console)";
1500                 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 stopped the vote";
1501                 return 0;
1502         } ],
1503
1504         # chat: Xonotic server -> IRC channel, master login
1505         [ dp => q{:vote:vlogin:(\d+)} => sub {
1506                 my ($id) = @_;
1507                 my $oldnick = $id ? $store{"playernick_byid_$id"} : "(console)";
1508                 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 logged in as master";
1509                 return 0;
1510         } ],
1511
1512         # chat: Xonotic server -> IRC channel, master do
1513         [ dp => q{:vote:vdo:(\d+):(.*)} => sub {
1514                 my ($id, $command) = @_;
1515                 $command = color_dp2irc $command;
1516                 my $oldnick = $id ? $store{"playernick_byid_$id"} : "(console)";
1517                 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 used his master status to do \"$command\017\"";
1518                 return 0;
1519         } ],
1520
1521         # chat: Xonotic server -> IRC channel, result
1522         [ dp => q{:vote:v(yes|no|timeout):(\d+):(\d+):(\d+):(\d+):(-?\d+)} => sub {
1523                 my ($result, $yes, $no, $abstain, $not, $min) = @_;
1524                 my $spam = "$yes:$no" . (($min >= 0) ? " ($min needed)" : "") . ", $abstain didn't care, $not didn't vote";
1525                 out irc => 0, "PRIVMSG $config{irc_channel} :* the vote ended with $result: $spam";
1526                 return 0;
1527         } ],
1528
1529         # chat: IRC channel -> Xonotic server
1530         [ irc => q{:([^! ]*)![^ ]* (?i:PRIVMSG) (?i:(??{$config{irc_channel}})) :(?i:(??{$store{irc_nick}}))(?: |: ?|, ?)(.*)} => sub {
1531                 my ($nick, $message) = @_;
1532                 $nick = color_dpfix $nick;
1533                         # allow the nickname to contain colors in DP format! Therefore, NO color_irc2dp on the nickname!
1534                 $message = color_irc2dp $message;
1535                 $message =~ s/(["\\])/\\$1/g;
1536                 out dp => 0, "rcon2irc_say_as \"$nick on IRC\" \"$message\"";
1537                 return 0;
1538         } ],
1539
1540         (
1541                 length $config{irc_trigger}
1542                         ?
1543                                 [ irc => q{:([^! ]*)![^ ]* (?i:PRIVMSG) (?i:(??{$config{irc_channel}})) :(?i:(??{$config{irc_trigger}}))(?: |: ?|, ?)(.*)} => sub {
1544                                         my ($nick, $message) = @_;
1545                                         $nick = color_dpfix $nick;
1546                                                 # allow the nickname to contain colors in DP format! Therefore, NO color_irc2dp on the nickname!
1547                                         $message = color_irc2dp $message;
1548                                         $message =~ s/(["\\])/\\$1/g;
1549                                         out dp => 0, "rcon2irc_say_as \"$nick on IRC\" \"$message\"";
1550                                         return 0;
1551                                 } ]
1552                         :
1553                                 ()
1554         ),
1555
1556         # irc: CTCP VERSION reply
1557         [ irc => q{:([^! ]*)![^ ]* (?i:PRIVMSG) (?i:(??{$store{irc_nick}})) :\001VERSION( .*)?\001} => sub {
1558                 my ($nick) = @_;
1559                 my $ver = $store{dp_version} or return 0;
1560                 $ver .= ", rcon2irc $VERSION";
1561                 out irc => 0, "NOTICE $nick :\001VERSION $ver\001";
1562         } ],
1563
1564         # on game start, notify the channel
1565         [ dp => q{:gamestart:(.*):[0-9.]*} => sub {
1566                 my ($map) = @_;
1567                 $store{playing} = 1;
1568                 $store{map} = $map;
1569                 $store{map_starttime} = time();
1570                 if ($config{irc_announce_mapchange} eq 'always' || ($config{irc_announce_mapchange} eq 'notempty' && $store{slots_active} > 0)) {
1571                         my $slotsstr = xon_slotsstring();
1572                         out irc => 0, "PRIVMSG $config{irc_channel} :\00304" . $map . "\017 has begun$slotsstr";
1573                 }
1574                 delete $store{lms_blocked};
1575                 return 0;
1576         } ],
1577
1578         # on game over, clear the current map
1579         [ dp => q{:gameover} => sub {
1580                 $store{playing} = 0;
1581                 return 0;
1582         } ],
1583
1584         # scores: Xonotic server -> IRC channel (start)
1585         [ dp => q{:scores:(.*):(\d+)} => sub {
1586                 my ($map, $time) = @_;
1587                 $store{scores} = {};
1588                 $store{scores}{map} = $map;
1589                 $store{scores}{time} = $time;
1590                 $store{scores}{players} = [];
1591                 delete $store{lms_blocked};
1592                 return 0;
1593         } ],
1594
1595         # scores: Xonotic server -> IRC channel, legacy format
1596         [ dp => q{:player:(-?\d+):(\d+):(\d+):(\d+):(\d+):(.*)} => sub {
1597                 my ($frags, $deaths, $time, $team, $id, $name) = @_;
1598                 return if not exists $store{scores};
1599                 push @{$store{scores}{players}}, [$frags, $team, $name]
1600                         unless $frags <= -666; # no spectators
1601                 return 0;
1602         } ],
1603
1604         # scores: Xonotic server -> IRC channel (CTF), legacy format
1605         [ dp => q{:teamscores:(\d+:-?\d*(?::\d+:-?\d*)*)} => sub {
1606                 my ($teams) = @_;
1607                 return if not exists $store{scores};
1608                 $store{scores}{teams} = {split /:/, $teams};
1609                 return 0;
1610         } ],
1611
1612         # scores: Xonotic server -> IRC channel, new format
1613         [ dp => q{:player:see-labels:(-?\d+)[-0-9,]*:(\d+):(\d+):(\d+):(.*)} => sub {
1614                 my ($frags, $time, $team, $id, $name) = @_;
1615                 return if not exists $store{scores};
1616                 push @{$store{scores}{players}}, [$frags, $team, $name];
1617                 return 0;
1618         } ],
1619
1620         # scores: Xonotic server -> IRC channel (CTF), new format
1621         [ dp => q{:teamscores:see-labels:(-?\d+)[-0-9,]*:(\d+)} => sub {
1622                 my ($frags, $team) = @_;
1623                 return if not exists $store{scores};
1624                 $store{scores}{teams}{$team} = $frags;
1625                 return 0;
1626         } ],
1627
1628         # scores: Xonotic server -> IRC channel
1629         [ dp => q{:end} => sub {
1630                 return if not exists $store{scores};
1631                 my $s = $store{scores};
1632                 delete $store{scores};
1633                 my $teams_matter = defined $s->{teams};
1634
1635                 my @t = ();
1636                 my @p = ();
1637
1638                 if($teams_matter)
1639                 {
1640                         # put players into teams
1641                         my %t = ();
1642                         for(@{$s->{players}})
1643                         {
1644                                 my $thisteam = ($t{$_->[1]} ||= {score => 0, team => $_->[1], players => []});
1645                                 push @{$thisteam->{players}}, [$_->[0], $_->[1], $_->[2]];
1646                                 if($s->{teams})
1647                                 {
1648                                         $thisteam->{score} = $s->{teams}{$_->[1]};
1649                                 }
1650                                 else
1651                                 {
1652                                         $thisteam->{score} += $_->[0];
1653                                 }
1654                         }
1655
1656                         # sort by team score
1657                         @t = sort { $b->{score} <=> $a->{score} } values %t;
1658
1659                         # sort by player score
1660                         @p = ();
1661                         for(@t)
1662                         {
1663                                 @{$_->{players}} = sort { $b->[0] <=> $a->[0] } @{$_->{players}};
1664                                 push @p, @{$_->{players}};
1665                         }
1666                 }
1667                 else
1668                 {
1669                         @p = sort { $b->[0] <=> $a->[0] } @{$s->{players}};
1670                 }
1671
1672                 # no display for empty server
1673                 return 0
1674                         if !@p;
1675
1676                 # make message fit somehow
1677                 for my $maxnamelen(reverse 3..64)
1678                 {
1679                         my $scores_string = "PRIVMSG $config{irc_channel} :\00304" . $s->{map} . "\017 ended:";
1680                         if($teams_matter)
1681                         {
1682                                 my $sep = ' ';
1683                                 for(@t)
1684                                 {
1685                                         $scores_string .= $sep . "\003" . $color_team2irc_table{$_->{team}}. "\002\002" . $_->{score} . "\017";
1686                                         $sep = ':';
1687                                 }
1688                         }
1689                         my $sep = '';
1690                         for(@p)
1691                         {
1692                                 my ($frags, $team, $name) = @$_;
1693                                 $name = color_dpfix substr($name, 0, $maxnamelen);
1694                                 if($teams_matter)
1695                                 {
1696                                         $name = "\003" . $color_team2irc_table{$team} . " " . color_dp2none $name;
1697                                 }
1698                                 else
1699                                 {
1700                                         $name = " " . color_dp2irc $name;
1701                                 }
1702                                 $scores_string .= "$sep$name\017 $frags";
1703                                 $sep = ',';
1704                         }
1705                         if(length($scores_string) <= ($store{irc_maxlen} || 256))
1706                         {
1707                                 out irc => 0, $scores_string;
1708                                 return 0;
1709                         }
1710                 }
1711                 out irc => 0, "PRIVMSG $config{irc_channel} :\001ACTION would have LIKED to put the scores here, but they wouldn't fit :(\001";
1712                 return 0;
1713         } ],
1714
1715         # complain when system load gets too high
1716         [ dp => q{timing:   (([0-9.]*)% CPU, ([0-9.]*)% lost, offset avg ([0-9.]*)ms, max ([0-9.]*)ms, sdev ([0-9.]*)ms)} => sub {
1717                 my ($all, $cpu, $lost, $avg, $max, $sdev) = @_;
1718                 return 0 # don't complain when just on the voting screen
1719                         if !$store{playing};
1720                 return 0 # don't complain if it was less than 0.5%
1721                         if $lost < 0.5;
1722                 return 0 # don't complain if nobody is looking
1723                         if $store{slots_active} == 0;
1724                 return 0 # don't complain in the first two minutes
1725                         if time() - $store{map_starttime} < 120;
1726                 return 0 # don't complain if it was already at least half as bad in this round
1727                         if $store{map_starttime} == $store{timingerror_map_starttime} and $lost <= 2 * $store{timingerror_lost};
1728                 $store{timingerror_map_starttime} = $store{map_starttime};
1729                 $store{timingerror_lost} = $lost;
1730                 out dp => 0, 'rcon2irc_say_as server "There are currently some severe system load problems. The admins have been notified."';
1731                 out irc => 1, "PRIVMSG $config{irc_channel} :\001ACTION has big trouble on $store{map} after @{[int(time() - $store{map_starttime})]}s: $all\001";
1732                 #out irc => 1, "PRIVMSG OpBaI :\001ACTION has big trouble on $store{map} after @{[int(time() - $store{map_starttime})]}s: $all\001";
1733                 return 0;
1734         } ],
1735 );
1736
1737
1738
1739 # Load plugins and add them to the handler list in the front.
1740 for my $p(split ' ', $config{plugins})
1741 {
1742         my @h = eval { do $p; }
1743                 or die "Invalid plugin $p: $@";
1744         for(reverse @h)
1745         {
1746                 ref $_ eq 'ARRAY' or die "Invalid plugin $p: did not return a list of arrays";
1747                 @$_ == 3 or die "Invalid plugin $p: did not return a list of three-element arrays";
1748                 !ref $_->[0] && !ref $_->[1] && ref $_->[2] eq 'CODE' or die "Invalid plugin $p: did not return a list of string-string-sub arrays";
1749                 unshift @handlers, $_;
1750         }
1751 }
1752
1753
1754
1755 # verify that the server is up by letting it echo back a string that causes
1756 # re-initialization of the required aliases
1757 out dp => 0, 'echo "Unknown command \"rcon2irc_eval\""'; # assume the server has been restarted
1758
1759
1760
1761 # regularily, query the server status and if it still is connected to us using
1762 # the log_dest_udp feature. If not, we will detect the response to this rcon
1763 # command and re-initialize the server's connection to us (either by log_dest_udp
1764 # not containing our own IP:port, or by rcon2irc_eval not being a defined command).
1765 schedule sub {
1766         my ($timer) = @_;
1767         out dp => 0, 'sv_cmd bans', 'status 1', 'log_dest_udp', 'rcon2irc_eval set dummy 1';
1768         $store{status_waiting} = -1;
1769         schedule $timer => (exists $store{dp_hostname} ? $config{dp_status_delay} : 1);;
1770 } => 1;
1771
1772
1773
1774 # Continue with connecting to IRC as soon as we get our first status reply from
1775 # the DP server (which contains the server's hostname that we'll use as
1776 # realname for IRC).
1777 schedule sub {
1778         my ($timer) = @_;
1779
1780         # log on to IRC when needed
1781         if(exists $store{dp_hostname} && !exists $store{irc_seen_welcome})
1782         {
1783                 $store{irc_nick_requested} = $config{irc_nick};
1784                 out irc => 1, "NICK $config{irc_nick}", "USER $config{irc_user} localhost localhost :$store{dp_hostname}";
1785                 $store{irc_logged_in} = 1;
1786                 undef $store{irc_maxlen};
1787                 undef $store{irc_pingtime};
1788         }
1789
1790         schedule $timer => 1;;
1791 } => 1;
1792
1793
1794
1795 # Regularily ping the IRC server to detect if the connection is down. If it is,
1796 # schedule an IRC error that will cause reconnection later.
1797 schedule sub {
1798         my ($timer) = @_;
1799
1800         if($store{irc_logged_in})
1801         {
1802                 if(defined $store{irc_pingtime})
1803                 {
1804                         # IRC connection apparently broke
1805                         # so... KILL IT WITH FIRE
1806                         $channels{system}->send("error irc", 0);
1807                 }
1808                 else
1809                 {
1810                         # everything is fine, send a new ping
1811                         $store{irc_pingtime} = time();
1812                         out irc => 1, "PING $store{irc_pingtime}";
1813                 }
1814         }
1815
1816         schedule $timer => $config{irc_ping_delay};;
1817 } => 1;
1818
1819
1820
1821 # Main loop.
1822 for(;;)
1823 {
1824         # Build up an IO::Select object for all our channels.
1825         my $s = IO::Select->new();
1826         for my $chan(values %channels)
1827         {
1828                 $s->add($_) for $chan->fds();
1829         }
1830
1831         # wait for something to happen on our sockets, or wait 2 seconds without anything happening there
1832         $s->can_read(2);
1833         my @errors = $s->has_exception(0);
1834
1835         # on every channel, look for incoming messages
1836         CHANNEL:
1837         for my $chanstr(keys %channels)
1838         {
1839                 my $chan = $channels{$chanstr};
1840                 my @chanfds = $chan->fds();
1841
1842                 for my $chanfd(@chanfds)
1843                 {
1844                         if(grep { $_ == $chanfd } @errors)
1845                         {
1846                                 # STOP! This channel errored!
1847                                 $channels{system}->send("error $chanstr", 0);
1848                                 next CHANNEL;
1849                         }
1850                 }
1851
1852                 eval
1853                 {
1854                         for my $line($chan->recv())
1855                         {
1856                                 # found one! Check if it matches the regular expression of one of
1857                                 # our handlers...
1858                                 my $handled = 0;
1859                                 my $private = 0;
1860                                 for my $h(@handlers)
1861                                 {
1862                                         my ($chanstr_wanted, $re, $sub) = @$h;
1863                                         next
1864                                                 if $chanstr_wanted ne $chanstr;
1865                                         use re 'eval';
1866                                         my @matches = ($line =~ /^$re$/s);
1867                                         no re 'eval';
1868                                         next
1869                                                 unless @matches;
1870                                         # and if it is a match, handle it.
1871                                         ++$handled;
1872                                         my $result = $sub->(@matches);
1873                                         $private = 1
1874                                                 if $result < 0;
1875                                         last
1876                                                 if $result;
1877                                 }
1878                                 # print the message, together with info on whether it has been handled or not
1879                                 if($private)
1880                                 {
1881                                         print "           $chanstr >> (private)\n";
1882                                 }
1883                                 elsif($handled)
1884                                 {
1885                                         print "           $chanstr >> $line\n";
1886                                 }
1887                                 else
1888                                 {
1889                                         print "unhandled: $chanstr >> $line\n";
1890                                 }
1891                         }
1892                         1;
1893                 } or do {
1894                         if($@ eq "read error\n")
1895                         {
1896                                 $channels{system}->send("error $chanstr", 0);
1897                                 next CHANNEL;
1898                         }
1899                         else
1900                         {
1901                                 # re-throw
1902                                 die $@;
1903                         }
1904                 };
1905         }
1906
1907         # handle scheduled tasks...
1908         my @t = @tasks;
1909         my $t = time();
1910         # by emptying the list of tasks...
1911         @tasks = ();
1912         for(@t)
1913         {
1914                 my ($time, $sub) = @$_;
1915                 if($t >= $time)
1916                 {
1917                         # calling them if they are schedled for the "past"...
1918                         $sub->($sub);
1919                 }
1920                 else
1921                 {
1922                         # or re-adding them to the task list if they still are scheduled for the "future"
1923                         push @tasks, [$time, $sub];
1924                 }
1925         }
1926 }