3 our $VERSION = '0.4.2 svn $Revision$';
5 # Copyright (c) 2008 Rudolf "divVerent" Polzer
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
16 # The above copyright notice and this permission notice shall be
17 # included in all copies or substantial portions of the Software.
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.
28 # MISC STRING UTILITY ROUTINES to convert between DarkPlaces and IRC conventions
30 # convert mIRC color codes to DP color codes
31 our @color_irc2dp_table = (7, 0, 4, 2, 1, 1, 6, 1, 3, 2, 5, 5, 4, 6, 7, 7);
32 our @color_dp2irc_table = (-1, 4, 9, 8, 12, 11, 13, -1, -1, -1); # not accurate, but legible
33 our @color_dp2ansi_table = ("m", "1;31m", "1;32m", "1;33m", "1;34m", "1;36m", "1;35m", "m", "1m", "1m"); # not accurate, but legible
34 our %color_team2dp_table = (5 => 1, 14 => 4, 13 => 3, 10 => 6);
35 our %color_team2irc_table = (5 => 4, 14 => 12, 13 => 8, 10 => 13);
39 $message =~ s/\^/^^/g;
41 $message =~ s{\003(\d\d?)(?:,(\d?\d?))?|(\017)}{
42 # $1 is FG, $2 is BG, but let's ignore BG
43 my $oldcolor = $color;
50 $color = $color_irc2dp_table[$1];
51 $color = $oldcolor if not defined $color;
53 ($color == $oldcolor) ? '' : '^' . $color;
55 $message =~ s{[\000-\037]}{}gs; # kill bold etc. for now
59 our @text_qfont_table = ( # ripped from DP console.c qfont_table
60 "\0", '#', '#', '#', '#', '.', '#', '#',
61 '#', 9, 10, '#', ' ', 13, '.', '.',
62 '[', ']', '0', '1', '2', '3', '4', '5',
63 '6', '7', '8', '9', '.', '<', '=', '>',
64 ' ', '!', '"', '#', '$', '%', '&', '\'',
65 '(', ')', '*', '+', ',', '-', '.', '/',
66 '0', '1', '2', '3', '4', '5', '6', '7',
67 '8', '9', ':', ';', '<', '=', '>', '?',
68 '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G',
69 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
70 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
71 'X', 'Y', 'Z', '[', '\\', ']', '^', '_',
72 '`', 'a', 'b', 'c', 'd', 'e', 'f', 'g',
73 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
74 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
75 'x', 'y', 'z', '{', '|', '}', '~', '<',
76 '<', '=', '>', '#', '#', '.', '#', '#',
77 '#', '#', ' ', '#', ' ', '>', '.', '.',
78 '[', ']', '0', '1', '2', '3', '4', '5',
79 '6', '7', '8', '9', '.', '<', '=', '>',
80 ' ', '!', '"', '#', '$', '%', '&', '\'',
81 '(', ')', '*', '+', ',', '-', '.', '/',
82 '0', '1', '2', '3', '4', '5', '6', '7',
83 '8', '9', ':', ';', '<', '=', '>', '?',
84 '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G',
85 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
86 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
87 'X', 'Y', 'Z', '[', '\\', ']', '^', '_',
88 '`', 'a', 'b', 'c', 'd', 'e', 'f', 'g',
89 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
90 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
91 'x', 'y', 'z', '{', '|', '}', '~', '<'
96 $message = join '', map { $text_qfont_table[ord $_] } split //, $message;
99 sub color_dp_transform(&$)
101 my ($block, $message) = @_;
103 $message =~ s{(?:(\^\^)|\^x([0-9a-fA-F])([0-9a-fA-F])([0-9a-fA-F])|\^([0-9])|(.))(?=([0-9,]?))}{
104 defined $1 ? $block->(char => '^', $7) :
105 defined $2 ? $block->(rgb => [hex $2, hex $3, hex $4], $7) :
106 defined $5 ? $block->(color => $5, $7) :
107 defined $6 ? $block->(char => $6, $7) :
118 return color_dp_transform
120 my ($type, $data, $next) = @_;
122 ? $text_qfont_table[ord $data]
128 sub color_rgb2basic($)
131 my ($R, $G, $B) = @$data;
132 my $min = [sort { $a <=> $b } ($R, $G, $B)]->[0];
133 my $max = [sort { $a <=> $b } ($R, $G, $B)]->[-1];
136 my $s = ($max == $min) ? 0 : 1 - $min/$max;
140 return 0 if $v < 0.5;
151 $h = (60 * ($G - $B) / ($max - $min)) % 360;
155 $h = (60 * ($B - $R) / ($max - $min)) + 120;
159 $h = (60 * ($R - $G) / ($max - $min)) + 240;
164 return 2 if $h < 150;
165 return 5 if $h < 200;
166 return 4 if $h < 270;
167 return 6 if $h < 330;
171 sub color_dp_rgb2basic($)
174 return color_dp_transform
176 my ($type, $data, $next) = @_;
177 $type eq 'char' ? ($data eq '^' ? '^^' : $data) :
178 $type eq 'color' ? "^$data" :
179 $type eq 'rgb' ? "^" . color_rgb2basic $data :
189 return color_dp_transform
191 my ($type, $data, $next) = @_;
196 $data = color_rgb2basic $data;
199 $type eq 'char' ? $text_qfont_table[ord $data] :
200 $type eq 'color' ? do {
201 my $oldcolor = $color;
202 $color = $color_dp2irc_table[$data];
204 $color == $oldcolor ? '' :
205 $color < 0 ? "\017" :
206 $next eq ',' ? "\003$color\002\002" :
207 sprintf "\003%02d", $color;
218 return color_dp_transform
220 my ($type, $data, $next) = @_;
225 $data = color_rgb2basic $data;
228 $type eq 'char' ? $text_qfont_table[ord $data] :
229 $type eq 'color' ? do {
230 my $oldcolor = $color;
231 $color = $color_dp2ansi_table[$data];
233 $color eq $oldcolor ? '' :
244 # if the message ends with an odd number of ^, kill one
245 chop $message if $message =~ /(?:^|[^\^])\^(\^\^)*$/;
254 # $conn->sockname() returns a connection type specific representation
255 # string of the local address, or undef if not applicable.
256 # $conn->send("string") sends something over the connection.
257 # $conn->recv() receives a string from the connection, or returns "" if no
259 # $conn->fds() returns all file descriptors used by the connection, so one
260 # can use select() on them.
262 # Usually wraps around a connection and implements a command based
263 # structure over it. It usually is constructed using new
264 # ChannelType($connection, someparameters...)
265 # @cmds = $chan->join_commands(@cmds) joins multiple commands to a single
266 # command string if the protocol supports it, or does nothing and leaves
267 # @cmds unchanged if the protocol does not support that usage (this is
268 # meant to save send() invocations).
269 # $chan->send($command, $nothrottle) sends a command over the channel. If
270 # $nothrottle is sent, the command must not be left out even if the channel
271 # is saturated (for example, because of IRC's flood control mechanism).
272 # $chan->quote($str) returns a string in a quoted form so it can safely be
273 # inserted as a substring into a command, or returns $str as is if not
274 # applicable. It is assumed that the result of the quote method is used
275 # as part of a quoted string, if the protocol supports that.
276 # $chan->recv() returns a list of received commands from the channel, or
277 # the empty list if none are available.
278 # $conn->fds() returns all file descriptors used by the channel's
279 # connections, so one can use select() on them.
288 # Represents a connection over a socket.
289 # Mainly used to wrap a channel around it for, in this case, line based or rcon-like operation.
290 package Connection::Socket;
293 use IO::Socket::INET;
297 # my $conn = new Connection::Socket(tcp => "localaddress" => "remoteaddress" => 6667);
298 # If the remote address does not contain a port number, the numeric port is
299 # used (it serves as a default port).
302 my ($class, $proto, $local, $remote, $defaultport) = @_;
303 my $sock = IO::Socket::INET->new(
305 (length($local) ? (LocalAddr => $local) : ()),
307 PeerPort => $defaultport
308 ) or die "socket $proto/$local/$remote: $!";
311 # Mortal fool! Release me from this wretched tomb! I must be set free
312 # or I will haunt you forever! I will hide your keys beneath the
313 # cushions of your upholstered furniture... and NEVERMORE will you be
314 # able to find socks that match!
316 # My demonic powers have made me OMNIPOTENT! Bwahahahahahahaha!
319 bless $you, 'Connection::Socket';
322 # $sock->sockname() returns the local address of the socket.
326 my ($port, $addr) = sockaddr_in $self->{sock}->sockname();
327 return "@{[inet_ntoa $addr]}:$port";
330 # $sock->send($data) sends some data over the socket; on success, 1 is returned.
333 my ($self, $data) = @_;
336 if(not eval { $self->{sock}->send($data); })
344 # $sock->recv() receives as much as possible from the socket (or at most 32k). Returns "" if no data is available.
349 if(defined $self->{sock}->recv($data, 32768, 0))
363 # $sock->fds() returns the socket file descriptor.
367 return fileno $self->{sock};
376 # Line-based buffered connectionless FIFO channel.
377 # Whatever is sent to it using send() is echoed back when using recv().
378 package Channel::FIFO;
383 # my $chan = new Channel::FIFO();
391 bless $you, 'Channel::FIFO';
394 sub join_commands($@)
396 my ($self, @data) = @_;
402 my ($self, $line, $nothrottle) = @_;
403 push @{$self->{buffer}}, $line;
408 my ($self, $data) = @_;
415 my $r = $self->{buffer};
416 $self->{buffer} = [];
432 # QW rcon protocol channel.
433 # Wraps around a UDP based Connection and sends commands as rcon commands as
434 # well as receives rcon replies. The quote and join_commands methods are using
435 # DarkPlaces engine specific rcon protocol extensions.
441 # my $chan = new Channel::QW($connection, "password");
444 my ($class, $conn, $password) = @_;
447 password => $password,
451 bless $you, 'Channel::QW';
454 # Note: multiple commands in one rcon packet is a DarkPlaces extension.
455 sub join_commands($@)
457 my ($self, @data) = @_;
458 return join "\0", @data;
463 my ($self, $line, $nothrottle) = @_;
464 return $self->{connector}->send("\377\377\377\377rcon $self->{password} $line");
467 # Note: backslash and quotation mark escaping is a DarkPlaces extension.
470 my ($self, $data) = @_;
471 $data =~ s/[\000-\037]//g;
472 $data =~ s/([\\"])/\\$1/g;
473 $data =~ s/\$/\$\$/g;
482 my $s = $self->{connector}->recv();
488 if $s !~ /^\377\377\377\377n(.*)$/s;
489 $self->{recvbuf} .= $1;
492 while($self->{recvbuf} =~ s/^(.*?)(?:\r\n?|\n)//)
502 return $self->{connector}->fds();
511 # Line based protocol channel.
512 # Wraps around a TCP based Connection and sends commands as text lines
513 # (separated by CRLF). When reading responses from the Connection, any type of
514 # line ending is accepted.
515 # A flood control mechanism is implemented.
516 package Channel::Line;
519 use Time::HiRes qw/time/;
522 # my $chan = new Channel::Line($connection);
525 my ($class, $conn) = @_;
535 bless $you, 'Channel::Line';
538 sub join_commands($@)
540 my ($self, @data) = @_;
544 # Sets new flood control parameters:
545 # $chan->throttle(maximum lines per second, maximum burst length allowed to
546 # exceed the lines per second limit);
547 # RFC 1459 describes these parameters to be 0.5 and 5 for the IRC protocol.
548 # If the $nothrottle flag is set while sending, the line is sent anyway even
549 # if flooding would take place.
552 my ($self, $linepersec, $maxlines) = @_;
553 $self->{linepersec} = $linepersec;
554 $self->{maxlines} = $maxlines;
555 $self->{capacity} = $maxlines;
560 my ($self, $line, $nothrottle) = @_;
562 if(defined $self->{capacity})
564 $self->{capacity} += ($t - $self->{lastsend}) * $self->{linepersec};
565 $self->{lastsend} = $t;
566 $self->{capacity} = $self->{maxlines}
567 if $self->{capacity} > $self->{maxlines};
571 if $self->{capacity} < 0;
573 $self->{capacity} -= 1;
576 return $self->{connector}->send("$line\r\n");
581 my ($self, $data) = @_;
582 $data =~ s/\r\n?/\n/g;
592 my $s = $self->{connector}->recv();
597 $self->{recvbuf} .= $s;
600 while($self->{recvbuf} =~ s/^(.*?)(?:\r\n?|\n)//)
610 return $self->{connector}->fds();
618 # main program... a gateway between IRC and DarkPlaces servers
625 use Time::HiRes qw/time/;
627 our @handlers = (); # list of [channel, expression, sub to handle result]
628 our @tasks = (); # list of [time, sub]
632 playernick_byid_0 => "(console)",
637 irc_nick_alternates => "",
639 irc_channel => undef,
640 irc_ping_delay => 120,
643 irc_nickserv_password => "",
644 irc_nickserv_identify => 'PRIVMSG NickServ :IDENTIFY %2$s',
645 irc_nickserv_ghost => 'PRIVMSG NickServ :GHOST %1$s %2$s',
646 irc_nickserv_ghost_attempts => 3,
648 irc_quakenet_authname => "",
649 irc_quakenet_password => "",
650 irc_quakenet_getchallenge => 'PRIVMSG Q@CServe.quakenet.org :CHALLENGE',
651 irc_quakenet_challengeauth => 'PRIVMSG Q@CServe.quakenet.org :CHALLENGEAUTH',
652 irc_quakenet_challengeprefix => ':Q!TheQBot@CServe.quakenet.org NOTICE [^:]+ :CHALLENGE',
656 dp_password => undef,
657 dp_status_delay => 30,
658 dp_server_from_wan => "",
661 irc_admin_password => "",
662 irc_admin_timeout => 3600,
669 # Nexuiz specific parsing of some server messages
671 sub nex_is_teamplay($)
674 return $map =~ /^(?:kh|ctf|tdm|dom)_/;
677 sub nex_slotsstring()
680 if(defined $store{slots_max})
682 my $slots = $store{slots_max} - $store{slots_active};
683 my $slots_s = ($slots == 1) ? '' : 's';
684 $slotsstr = " ($slots free slot$slots_s)";
685 my $s = $config{dp_server_from_wan} || $config{dp_server};
686 $slotsstr .= "; join now: \002nexuiz +connect $s"
687 if $slots >= 1 and not $store{lms_blocked};
694 # Do we have a config file? If yes, read and parse it (syntax: key = value
695 # pairs, separated by newlines), if not, complain.
696 die "Usage: $0 configfile\n"
699 open my $fh, "<", $ARGV[0]
700 or die "open $ARGV[0]: $!";
705 /^(.*?)\s*=(?:\s*(.*))?$/ or next;
706 warn "Undefined config item: $1"
707 unless exists $config{$1};
708 $config{$1} = defined $2 ? $2 : "";
711 my @missing = grep { !defined $config{$_} } keys %config;
712 die "The following config items are missing: @missing"
717 # Create a channel for error messages and other internal status messages...
719 $channels{system} = new Channel::FIFO();
721 # for example, quit messages caused by signals (if SIGTERM or SIGINT is first
722 # received, try to shut down cleanly, and if such a signal is received a second
726 exit 1 if $quitting++;
727 $channels{system}->send("quit SIGINT");
730 exit 1 if $quitting++;
731 $channels{system}->send("quit SIGTERM");
736 # Create the two channels to gateway between...
738 $channels{irc} = new Channel::Line(new Connection::Socket(tcp => $config{irc_local} => $config{irc_server} => 6667));
739 $channels{dp} = new Channel::QW(my $dpsock = new Connection::Socket(udp => $config{dp_listen} => $config{dp_server} => 26000), $config{dp_password});
740 $config{dp_listen} = $dpsock->sockname();
741 print "Listening on $config{dp_listen}\n";
743 $channels{irc}->throttle(0.5, 5);
746 # Utility routine to write to a channel by name, also outputting what's been written and some status
750 my $nothrottle = shift;
751 my $chan = $channels{$chanstr};
754 print "UNDEFINED: $chanstr, ignoring message\n";
757 @_ = $chan->join_commands(@_);
760 my $result = $chan->send($_, $nothrottle);
763 print " $chanstr << $_\n";
767 print "FLOOD: $chanstr << $_\n";
771 print "ERROR: $chanstr << $_\n";
772 $channels{system}->send("error $chanstr", 0);
779 # Schedule a task for later execution by the main loop; usage: schedule sub {
780 # task... }, $time; When a scheduled task is run, a reference to the task's own
781 # sub is passed as first argument; that way, the task is able to re-schedule
782 # itself so it gets periodically executed.
785 my ($sub, $time) = @_;
786 push @tasks, [time() + $time, $sub];
789 # On IRC error, delete some data store variables of the connection, and
790 # reconnect to the IRC server soon (but only if someone is actually playing)
793 # prevent multiple instances of this timer
794 return if $store{irc_error_active};
795 $store{irc_error_active} = 1;
797 delete $channels{irc};
800 if(!defined $store{slots_full})
802 # DP is not running, then delay IRC reconnecting
803 #use Data::Dumper; print Dumper \$timer;
804 schedule $timer => 1;;
806 # this will keep irc_error_active
808 $channels{irc} = new Channel::Line(new Connection::Socket(tcp => "" => $config{irc_server}));
809 delete $store{$_} for grep { /^irc_/ } keys %store;
810 $store{irc_nick} = "";
813 out dp => 0, 'sv_cmd bans', 'status 1', 'log_dest_udp';
814 $store{status_waiting} = -1;
816 # this will clear irc_error_active
827 next if $found{$_}++;
833 # IRC joining (if this is called as response to a nick name collision, $is433 is set);
834 # among other stuff, it performs NickServ or Quakenet authentication. This is to be called
835 # until the channel has been joined for every message that may be "interesting" (basically,
836 # IRC 001 hello messages, 443 nick collision messages and some notices by services).
842 if $store{irc_joined_channel};
844 #use Data::Dumper; print Dumper \%store;
848 if(length $store{irc_nick})
850 # we already have another nick, but couldn't change to the new one
851 # try ghosting and then get the nick again
852 if(length $config{irc_nickserv_password})
854 if(++$store{irc_nickserv_ghost_attempts} <= $config{irc_nickserv_ghost_attempts})
856 $store{irc_nick_requested} = $config{irc_nick};
857 out irc => 1, sprintf($config{irc_nickserv_ghost}, $config{irc_nick}, $config{irc_nickserv_password});
859 out irc => 1, "NICK $config{irc_nick}";
861 return; # we'll get here again for the NICK success message, or for a 433 failure
863 # otherwise, we failed to ghost and will continue with the wrong
864 # nick... also, no need to try to identify here
866 # otherwise, we can't handle this and will continue with our wrong nick
870 # we failed to get an initial nickname
871 # change ours a bit and try again
873 my @alternates = uniq ($config{irc_nick}, grep { $_ ne "" } split /\s+/, $config{irc_nick_alternates});
874 my $nextnick = undef;
875 for(0..@alternates-2)
877 if($store{irc_nick_requested} eq $alternates[$_])
879 $nextnick = $alternates[$_+1];
882 if($store{irc_nick_requested} eq $alternates[@alternates-1]) # this will only happen once
884 $store{irc_nick_requested} = $alternates[0];
885 # but don't set nextnick, so we edit it
887 if(defined $nextnick)
889 $store{irc_nick_requested} = $nextnick;
895 if(length $store{irc_nick_requested} < 9)
897 $store{irc_nick_requested} .= '_';
901 substr $store{irc_nick_requested}, int(rand length $store{irc_nick_requested}), 1, chr(97 + int rand 26);
903 last unless grep { $_ eq $store{irc_nick_requested} } @alternates;
906 out irc => 1, "NICK $store{irc_nick_requested}";
907 return; # when it fails, we'll get here again, and when it succeeds, we will continue
911 # we got a 001 or a NICK message, so $store{irc_nick} has been updated
912 if(length $config{irc_nickserv_password})
914 if($store{irc_nick} eq $config{irc_nick})
917 out irc => 1, sprintf($config{irc_nickserv_identify}, $config{irc_nick}, $config{irc_nickserv_password});
922 if(++$store{irc_nickserv_ghost_attempts} <= $config{irc_nickserv_ghost_attempts})
924 $store{irc_nick_requested} = $config{irc_nick};
925 out irc => 1, sprintf($config{irc_nickserv_ghost}, $config{irc_nick}, $config{irc_nickserv_password});
927 out irc => 1, "NICK $config{irc_nick}";
929 return; # we'll get here again for the NICK success message, or for a 433 failure
931 # otherwise, we failed to ghost and will continue with the wrong
932 # nick... also, no need to try to identify here
936 # we are on Quakenet. Try to authenticate.
937 if(length $config{irc_quakenet_password} and length $config{irc_quakenet_authname})
939 if(defined $store{irc_quakenet_challenge})
941 if($store{irc_quakenet_challenge} =~ /^MD5 (.*)/)
943 out irc => 1, "$config{irc_quakenet_challengeauth} $config{irc_quakenet_authname} " . Digest::MD5::md5_hex("$config{irc_quakenet_password} $1");
948 out irc => 1, $config{irc_quakenet_getchallenge};
950 # we get here again when Q asks us
954 # if we get here, we are on IRC
955 $store{irc_joined_channel} = 1;
957 out irc => 1, "JOIN $config{irc_channel}";
962 my $RE_FAIL = qr/$ $/;
963 my $RE_SUCCEED = qr//;
966 return $_[0] ? $RE_FAIL : $RE_SUCCEED;
970 # List of all handlers on the various sockets. Additional handlers can be added by a plugin.
972 # detect a server restart and set it up again
973 [ dp => q{ *(?:Warning: Could not expand \$|Unknown command ")(?:rcon2irc_[a-z0-9_]*)[" ]*} => sub {
975 'alias rcon2irc_eval "$*"',
977 'sv_logscores_console 0',
978 'sv_logscores_bots 1',
980 'sv_eventlog_console 1',
981 'alias rcon2irc_say_as "set say_as_restorenick \"$sv_adminnick\"; sv_adminnick \"$1^3\"; say \"^7$2\"; rcon2irc_say_as_restore"',
982 'alias rcon2irc_say_as_restore "set sv_adminnick \"$say_as_restorenick\""',
983 'alias rcon2irc_quit "echo \"quitting rcon2irc $1: log_dest_udp is $log_dest_udp\""'; # note: \\\\\\" ->perl \\\" ->console \"
987 # detect missing entry in log_dest_udp and fix it
988 [ dp => q{"log_dest_udp" is "([^"]*)" \["[^"]*"\]} => sub {
990 my @dests = split ' ', $dest;
991 return 0 if grep { $_ eq $config{dp_listen} } @dests;
992 out dp => 0, 'log_dest_udp "' . join(" ", @dests, $config{dp_listen}) . '"';
996 # retrieve list of banned hosts
997 [ dp => q{#(\d+): (\S+) is still banned for (\S+) seconds} => sub {
998 return 0 unless $store{status_waiting} < 0;
999 my ($id, $ip, $time) = @_;
1000 $store{bans_new} = [] if $id == 0;
1001 $store{bans_new}[$id] = { ip => $ip, 'time' => $time };
1005 # retrieve hostname from status replies
1006 [ dp => q{host: (.*)} => sub {
1007 return 0 unless $store{status_waiting} < 0;
1009 $store{dp_hostname} = $name;
1010 $store{bans} = $store{bans_new};
1014 # retrieve version from status replies
1015 [ dp => q{version: (.*)} => sub {
1016 return 0 unless $store{status_waiting} < 0;
1018 $store{dp_version} = $version;
1022 # retrieve player names
1023 [ dp => q{players: (\d+) active \((\d+) max\)} => sub {
1024 return 0 unless $store{status_waiting} < 0;
1025 my ($active, $max) = @_;
1026 my $full = ($active >= $max);
1027 $store{slots_max} = $max;
1028 $store{slots_active} = $active;
1029 $store{status_waiting} = $active;
1030 $store{playerslots_active_new} = [];
1031 if($store{status_waiting} == 0)
1033 $store{playerslots_active} = $store{playerslots_active_new};
1035 if($full != ($store{slots_full} || 0))
1037 $store{slots_full} = $full;
1039 if $store{lms_blocked};
1042 out irc => 0, "PRIVMSG $config{irc_channel} :\001ACTION is full!\001";
1046 my $slotsstr = nex_slotsstring();
1047 out irc => 0, "PRIVMSG $config{irc_channel} :\001ACTION can be joined again$slotsstr!\001";
1053 # retrieve player names
1054 [ dp => q{\^\d(\S+)\s+(\d+)\s+(\d+)\s+(\S+)\s+(-?\d+)\s+\#(\d+)\s+\^\d(.*)} => sub {
1055 return 0 unless $store{status_waiting} > 0;
1056 my ($ip, $pl, $ping, $time, $frags, $no, $name) = ($1, $2, $3, $4, $5, $6, $7);
1057 $store{"playerslot_$no"} = { ip => $ip, pl => $pl, ping => $ping, 'time' => $time, frags => $frags, no => $no, name => $name };
1058 push @{$store{playerslots_active_new}}, $no;
1059 if(--$store{status_waiting} == 0)
1061 $store{playerslots_active} = $store{playerslots_active_new};
1066 # IRC admin commands
1067 [ irc => q{:(([^! ]*)![^ ]*) (?i:PRIVMSG) [^&#%]\S* :(.*)} => sub {
1068 return 0 unless $config{irc_admin_password} ne '';
1070 my ($hostmask, $nick, $command) = @_;
1071 my $dpnick = color_dpfix $nick;
1073 if($command eq "login $config{irc_admin_password}")
1075 $store{logins}{$hostmask} = time() + $config{irc_admin_timeout};
1076 out irc => 0, "PRIVMSG $nick :my wish is your command";
1080 if($command =~ /^login /)
1082 out irc => 0, "PRIVMSG $nick :invalid password";
1086 if(($store{logins}{$hostmask} || 0) < time())
1088 out irc => 0, "PRIVMSG $nick :authentication required";
1092 if($command =~ /^status(?: (.*))?$/)
1097 for my $slot(@{$store{playerslots_active} || []})
1099 my $s = $store{"playerslot_$slot"};
1101 if(not defined $match or index(color_dp2none($s->{name}), $match) >= 0)
1103 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};
1112 out irc => 0, "PRIVMSG $nick :the server is empty";
1116 out irc => 0, "PRIVMSG $nick :no nicknames match";
1122 if($command =~ /^kick # (\d+) (.*)$/)
1124 my ($id, $reason) = ($1, $2);
1125 my $dpreason = color_irc2dp $reason;
1126 $dpreason =~ s/^(~?)(.*)/$1irc $dpnick: $2/g;
1127 $dpreason =~ s/(["\\])/\\$1/g;
1128 out dp => 0, "kick # $id $dpreason";
1129 my $slotnik = "playerslot_$id";
1130 out irc => 0, "PRIVMSG $nick :kicked #$id (@{[color_dp2irc $store{$slotnik}{name}]} @ $store{$slotnik}{ip}) ($reason)";
1134 if($command =~ /^kickban # (\d+) (\d+) (\d+) (.*)$/)
1136 my ($id, $bantime, $mask, $reason) = ($1, $2, $3, $4);
1137 my $dpreason = color_irc2dp $reason;
1138 $dpreason =~ s/^(~?)(.*)/$1irc $dpnick: $2/g;
1139 $dpreason =~ s/(["\\])/\\$1/g;
1140 out dp => 0, "kickban # $id $bantime $mask $dpreason";
1141 my $slotnik = "playerslot_$id";
1142 out irc => 0, "PRIVMSG $nick :kickbanned #$id (@{[color_dp2irc $store{$slotnik}{name}]} @ $store{$slotnik}{ip}), netmask $mask, for $bantime seconds ($reason)";
1146 if($command eq "bans")
1150 map { "$_ ($store{bans}[$_]{ip}, $store{bans}[$_]{time}s)" }
1151 0..@{$store{bans} || []}-1;
1152 $banlist = "no bans"
1154 out irc => 0, "PRIVMSG $nick :$banlist";
1158 if($command =~ /^unban (\d+)$/)
1161 out dp => 0, "unban $id";
1162 out irc => 0, "PRIVMSG $nick :removed ban $id ($store{bans}[$id]{ip})";
1166 out irc => 0, "PRIVMSG $nick :unknown command (supported: status [substring], kick # id reason, kickban # id bantime mask reason, bans, unban banid)";
1171 # LMS: detect "no more lives" message
1172 [ dp => q{\^4.*\^4 has no more lives left} => sub {
1173 if(!$store{lms_blocked})
1175 $store{lms_blocked} = 1;
1176 if(!$store{slots_full})
1179 if($store{lms_blocked})
1181 out irc => 0, "PRIVMSG $config{irc_channel} :\001ACTION can't be joined until next round (a player has no more lives left)\001";
1188 # detect IRC errors and reconnect
1189 [ irc => q{ERROR .*} => \&irc_error ],
1190 [ system => q{error irc} => \&irc_error ],
1193 [ irc => q{:[^ ]* 433 .*} => sub {
1194 return irc_joinstage(433);
1198 [ irc => q{:[^ ]* 001 .*} => sub {
1199 $store{irc_seen_welcome} = 1;
1200 $store{irc_nick} = $store{irc_nick_requested};
1201 return irc_joinstage(0);
1204 # IRC my nickname changed
1205 [ irc => q{:(?i:(??{$store{irc_nick}}))![^ ]* (?i:NICK) :(.*)} => sub {
1207 $store{irc_nick} = $n;
1208 return irc_joinstage(0);
1211 # Quakenet: challenge from Q
1212 [ irc => q{(??{$config{irc_quakenet_challengeprefix}}) (.*)} => sub {
1213 $store{irc_quakenet_challenge} = $1;
1214 return irc_joinstage(0);
1217 # shut down everything on SIGINT
1218 [ system => q{quit (.*)} => sub {
1220 out irc => 1, "QUIT :$cause";
1221 $store{quitcookie} = int rand 1000000000;
1222 out dp => 0, "rcon2irc_quit $store{quitcookie}";
1225 # remove myself from the log destinations and exit everything
1226 [ dp => q{quitting rcon2irc (??{$store{quitcookie}}): log_dest_udp is (.*) *} => sub {
1228 my @dests = grep { $_ ne $config{dp_listen} } split ' ', $dest;
1229 out dp => 0, 'log_dest_udp "' . join(" ", @dests) . '"';
1235 [ irc => q{PING (.*)} => sub {
1237 out irc => 1, "PONG $data";
1242 [ irc => q{:[^ ]* PONG .* :(.*)} => sub {
1245 if not defined $store{irc_pingtime};
1247 if $data ne $store{irc_pingtime};
1248 print "* measured IRC line delay: @{[time() - $store{irc_pingtime}]}\n";
1249 undef $store{irc_pingtime};
1253 # detect channel join message and note hostname length to get the maximum allowed line length
1254 [ irc => q{(:(?i:(??{$store{irc_nick}}))![^ ]* )(?i:JOIN) :(?i:(??{$config{irc_channel}}))} => sub {
1255 $store{irc_maxlen} = 510 - length($1);
1256 $store{irc_joined_channel} = 1;
1257 print "* detected maximum line length for channel messages: $store{irc_maxlen}\n";
1261 # chat: Nexuiz server -> IRC channel
1262 [ dp => q{\001(.*?)\^7: (.*)} => sub {
1263 my ($nick, $message) = map { color_dp2irc $_ } @_;
1264 out irc => 0, "PRIVMSG $config{irc_channel} :<$nick\017> $message";
1268 # chat: Nexuiz server -> IRC channel, nick set
1269 [ dp => q{:join:(\d+):(\d+):([^:]*):(.*)} => sub {
1270 my ($id, $slot, $ip, $nick) = @_;
1271 $nick = color_dp2irc $nick;
1272 $store{"playernick_byid_$id"} = $nick;
1273 $store{"playerip_byid_$id"} = $ip;
1274 $store{"playerslot_byid_$id"} = $slot;
1275 $store{"playerid_byslot_$slot"} = $id;
1279 # chat: Nexuiz server -> IRC channel, nick change/set
1280 [ dp => q{:name:(\d+):(.*)} => sub {
1281 my ($id, $nick) = @_;
1282 $nick = color_dp2irc $nick;
1283 my $oldnick = $store{"playernick_byid_$id"};
1284 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 is now known as $nick";
1285 $store{"playernick_byid_$id"} = $nick;
1289 # chat: Nexuiz server -> IRC channel, vote call
1290 [ dp => q{:vote:vcall:(\d+):(.*)} => sub {
1291 my ($id, $command) = @_;
1292 $command = color_dp2irc $command;
1293 my $oldnick = $id ? $store{"playernick_byid_$id"} : "(console)";
1294 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 calls a vote for \"$command\017\"";
1298 # chat: Nexuiz server -> IRC channel, vote stop
1299 [ dp => q{:vote:vstop:(\d+)} => sub {
1301 my $oldnick = $id ? $store{"playernick_byid_$id"} : "(console)";
1302 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 stopped the vote";
1306 # chat: Nexuiz server -> IRC channel, master login
1307 [ dp => q{:vote:vlogin:(\d+)} => sub {
1309 my $oldnick = $id ? $store{"playernick_byid_$id"} : "(console)";
1310 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 logged in as master";
1314 # chat: Nexuiz server -> IRC channel, master do
1315 [ dp => q{:vote:vdo:(\d+):(.*)} => sub {
1316 my ($id, $command) = @_;
1317 $command = color_dp2irc $command;
1318 my $oldnick = $id ? $store{"playernick_byid_$id"} : "(console)";
1319 out irc => 0, "PRIVMSG $config{irc_channel} :* $oldnick\017 used his master status to do \"$command\017\"";
1323 # chat: Nexuiz server -> IRC channel, result
1324 [ dp => q{:vote:v(yes|no|timeout):(\d+):(\d+):(\d+):(\d+):(-?\d+)} => sub {
1325 my ($result, $yes, $no, $abstain, $not, $min) = @_;
1326 my $spam = "$yes:$no" . (($min >= 0) ? " ($min needed)" : "") . ", $abstain didn't care, $not didn't vote";
1327 out irc => 0, "PRIVMSG $config{irc_channel} :* the vote ended with $result: $spam";
1331 # chat: IRC channel -> Nexuiz server
1332 [ irc => q{:([^! ]*)![^ ]* (?i:PRIVMSG) (?i:(??{$config{irc_channel}})) :(?i:(??{$store{irc_nick}}))(?: |: ?|, ?)(.*)} => sub {
1333 my ($nick, $message) = @_;
1334 $nick = color_dpfix $nick;
1335 # allow the nickname to contain colors in DP format! Therefore, NO color_irc2dp on the nickname!
1336 $message = color_irc2dp $message;
1337 $message =~ s/(["\\])/\\$1/g;
1338 out dp => 0, "rcon2irc_say_as \"$nick on IRC\" \"$message\"";
1343 length $config{irc_trigger}
1345 [ irc => q{:([^! ]*)![^ ]* (?i:PRIVMSG) (?i:(??{$config{irc_channel}})) :(?i:(??{$config{irc_trigger}}))(?: |: ?|, ?)(.*)} => sub {
1346 my ($nick, $message) = @_;
1347 $nick = color_dpfix $nick;
1348 # allow the nickname to contain colors in DP format! Therefore, NO color_irc2dp on the nickname!
1349 $message = color_irc2dp $message;
1350 $message =~ s/(["\\])/\\$1/g;
1351 out dp => 0, "rcon2irc_say_as \"$nick on IRC\" \"$message\"";
1358 # irc: CTCP VERSION reply
1359 [ irc => q{:([^! ]*)![^ ]* (?i:PRIVMSG) (?i:(??{$store{irc_nick}})) :\001VERSION( .*)?\001} => sub {
1361 my $ver = $store{dp_version} or return 0;
1362 $ver .= ", rcon2irc $VERSION";
1363 out irc => 0, "NOTICE $nick :\001VERSION $ver\001";
1366 # on game start, notify the channel
1367 [ dp => q{:gamestart:(.*):[0-9.]*} => sub {
1369 $store{playing} = 1;
1371 $store{map_starttime} = time();
1372 my $slotsstr = nex_slotsstring();
1373 out irc => 0, "PRIVMSG $config{irc_channel} :\00304" . $map . "\017 has begun$slotsstr";
1374 delete $store{lms_blocked};
1378 # on game over, clear the current map
1379 [ dp => q{:gameover} => sub {
1380 $store{playing} = 0;
1384 # scores: Nexuiz server -> IRC channel (start)
1385 [ dp => q{:scores:(.*):(\d+)} => sub {
1386 my ($map, $time) = @_;
1387 $store{scores} = {};
1388 $store{scores}{map} = $map;
1389 $store{scores}{time} = $time;
1390 $store{scores}{players} = [];
1391 delete $store{lms_blocked};
1395 # scores: Nexuiz server -> IRC channel, legacy format
1396 [ dp => q{:player:(-?\d+):(\d+):(\d+):(\d+):(\d+):(.*)} => sub {
1397 my ($frags, $deaths, $time, $team, $id, $name) = @_;
1398 return if not exists $store{scores};
1399 push @{$store{scores}{players}}, [$frags, $team, $name]
1400 unless $frags <= -666; # no spectators
1404 # scores: Nexuiz server -> IRC channel (CTF), legacy format
1405 [ dp => q{:teamscores:(\d+:-?\d*(?::\d+:-?\d*)*)} => sub {
1407 return if not exists $store{scores};
1408 $store{scores}{teams} = {split /:/, $teams};
1412 # scores: Nexuiz server -> IRC channel, new format
1413 [ dp => q{:player:see-labels:(-?\d+)[-0-9,]*:(\d+):(\d+):(\d+):(.*)} => sub {
1414 my ($frags, $time, $team, $id, $name) = @_;
1415 return if not exists $store{scores};
1416 push @{$store{scores}{players}}, [$frags, $team, $name];
1420 # scores: Nexuiz server -> IRC channel (CTF), new format
1421 [ dp => q{:teamscores:see-labels:(-?\d+)[-0-9,]*:(\d+)} => sub {
1422 my ($frags, $team) = @_;
1423 return if not exists $store{scores};
1424 $store{scores}{teams}{$team} = $frags;
1428 # scores: Nexuiz server -> IRC channel
1429 [ dp => q{:end} => sub {
1430 return if not exists $store{scores};
1431 my $s = $store{scores};
1432 delete $store{scores};
1433 my $teams_matter = nex_is_teamplay($s->{map});
1440 # put players into teams
1442 for(@{$s->{players}})
1444 my $thisteam = ($t{$_->[1]} ||= {score => 0, team => $_->[1], players => []});
1445 push @{$thisteam->{players}}, [$_->[0], $_->[1], $_->[2]];
1448 $thisteam->{score} = $s->{teams}{$_->[1]};
1452 $thisteam->{score} += $_->[0];
1456 # sort by team score
1457 @t = sort { $b->{score} <=> $a->{score} } values %t;
1459 # sort by player score
1463 @{$_->{players}} = sort { $b->[0] <=> $a->[0] } @{$_->{players}};
1464 push @p, @{$_->{players}};
1469 @p = sort { $b->[0] <=> $a->[0] } @{$s->{players}};
1472 # no display for empty server
1476 # make message fit somehow
1477 for my $maxnamelen(reverse 3..64)
1479 my $scores_string = "PRIVMSG $config{irc_channel} :\00304" . $s->{map} . "\017 ended:";
1485 $scores_string .= $sep . sprintf "\003%02d\%d\017", $color_team2irc_table{$_->{team}}, $_->{score};
1492 my ($frags, $team, $name) = @$_;
1493 $name = color_dpfix substr($name, 0, $maxnamelen);
1496 $name = "\003" . $color_team2irc_table{$team} . " " . color_dp2none $name;
1500 $name = " " . color_dp2irc $name;
1502 $scores_string .= "$sep$name\017 $frags";
1505 if(length($scores_string) <= ($store{irc_maxlen} || 256))
1507 out irc => 0, $scores_string;
1511 out irc => 0, "PRIVMSG $config{irc_channel} :\001ACTION would have LIKED to put the scores here, but they wouldn't fit :(\001";
1515 # complain when system load gets too high
1516 [ dp => q{timing: (([0-9.]*)% CPU, ([0-9.]*)% lost, offset avg ([0-9.]*)ms, max ([0-9.]*)ms, sdev ([0-9.]*)ms)} => sub {
1517 my ($all, $cpu, $lost, $avg, $max, $sdev) = @_;
1518 return 0 # don't complain when just on the voting screen
1519 if !$store{playing};
1520 return 0 # don't complain if it was less than 0.5%
1522 return 0 # don't complain if nobody is looking
1523 if $store{slots_active} == 0;
1524 return 0 # don't complain in the first two minutes
1525 if time() - $store{map_starttime} < 120;
1526 return 0 # don't complain if it was already at least half as bad in this round
1527 if $store{map_starttime} == $store{timingerror_map_starttime} and $lost <= 2 * $store{timingerror_lost};
1528 $store{timingerror_map_starttime} = $store{map_starttime};
1529 $store{timingerror_lost} = $lost;
1530 out dp => 0, 'rcon2irc_say_as server "There are currently some severe system load problems. The admins have been notified."';
1531 out irc => 1, "PRIVMSG $config{irc_channel} :\001ACTION has big trouble on $store{map} after @{[int(time() - $store{map_starttime})]}s: $all\001";
1532 #out irc => 1, "PRIVMSG OpBaI :\001ACTION has big trouble on $store{map} after @{[int(time() - $store{map_starttime})]}s: $all\001";
1539 # Load plugins and add them to the handler list in the front.
1540 for my $p(split ' ', $config{plugins})
1542 my @h = eval { do $p; }
1543 or die "Invalid plugin $p: $@";
1546 ref $_ eq 'ARRAY' or die "Invalid plugin $p: did not return a list of arrays";
1547 @$_ == 3 or die "Invalid plugin $p: did not return a list of three-element arrays";
1548 !ref $_->[0] && !ref $_->[1] && ref $_->[2] eq 'CODE' or die "Invalid plugin $p: did not return a list of string-string-sub arrays";
1549 unshift @handlers, $_;
1555 # verify that the server is up by letting it echo back a string that causes
1556 # re-initialization of the required aliases
1557 out dp => 0, 'echo "Unknown command \"rcon2irc_eval\""'; # assume the server has been restarted
1561 # regularily, query the server status and if it still is connected to us using
1562 # the log_dest_udp feature. If not, we will detect the response to this rcon
1563 # command and re-initialize the server's connection to us (either by log_dest_udp
1564 # not containing our own IP:port, or by rcon2irc_eval not being a defined command).
1567 out dp => 0, 'sv_cmd bans', 'status 1', 'log_dest_udp', 'rcon2irc_eval set dummy 1';
1568 $store{status_waiting} = -1;
1569 schedule $timer => (exists $store{dp_hostname} ? $config{dp_status_delay} : 1);;
1574 # Continue with connecting to IRC as soon as we get our first status reply from
1575 # the DP server (which contains the server's hostname that we'll use as
1576 # realname for IRC).
1580 # log on to IRC when needed
1581 if(exists $store{dp_hostname} && !exists $store{irc_logged_in})
1583 $store{irc_nick_requested} = $config{irc_nick};
1584 out irc => 1, "NICK $config{irc_nick}", "USER $config{irc_user} localhost localhost :$store{dp_hostname}";
1585 $store{irc_logged_in} = 1;
1586 undef $store{irc_maxlen};
1587 undef $store{irc_pingtime};
1590 schedule $timer => 1;;
1595 # Regularily ping the IRC server to detect if the connection is down. If it is,
1596 # schedule an IRC error that will cause reconnection later.
1600 if($store{irc_logged_in})
1602 if(defined $store{irc_pingtime})
1604 # IRC connection apparently broke
1605 # so... KILL IT WITH FIRE
1606 $channels{system}->send("error irc", 0);
1610 # everything is fine, send a new ping
1611 $store{irc_pingtime} = time();
1612 out irc => 1, "PING $store{irc_pingtime}";
1616 schedule $timer => $config{irc_ping_delay};;
1624 # Build up an IO::Select object for all our channels.
1625 my $s = IO::Select->new();
1626 for my $chan(values %channels)
1628 $s->add($_) for $chan->fds();
1631 # wait for something to happen on our sockets, or wait 2 seconds without anything happening there
1633 my @errors = $s->has_exception(0);
1635 # on every channel, look for incoming messages
1637 for my $chanstr(keys %channels)
1639 my $chan = $channels{$chanstr};
1640 my @chanfds = $chan->fds();
1642 for my $chanfd(@chanfds)
1644 if(grep { $_ == $chanfd } @errors)
1646 # STOP! This channel errored!
1647 $channels{system}->send("error $chanstr", 0);
1654 for my $line($chan->recv())
1656 # found one! Check if it matches the regular expression of one of
1660 for my $h(@handlers)
1662 my ($chanstr_wanted, $re, $sub) = @$h;
1664 if $chanstr_wanted ne $chanstr;
1666 my @matches = ($line =~ /^$re$/s);
1670 # and if it is a match, handle it.
1672 my $result = $sub->(@matches);
1678 # print the message, together with info on whether it has been handled or not
1681 print " $chanstr >> (private)\n";
1685 print " $chanstr >> $line\n";
1689 print "unhandled: $chanstr >> $line\n";
1694 if($@ eq "read error\n")
1696 $channels{system}->send("error $chanstr", 0);
1707 # handle scheduled tasks...
1710 # by emptying the list of tasks...
1714 my ($time, $sub) = @$_;
1717 # calling them if they are schedled for the "past"...
1722 # or re-adding them to the task list if they still are scheduled for the "future"
1723 push @tasks, [$time, $sub];