4 # remoteglot - Connects an abitrary UCI-speaking engine to ICS for easier post-game
5 # analysis, or for live analysis of relayed games. (Do not use for
6 # cheating! Cheating is bad for your karma, and your abuser flag.)
8 # Copyright 2007 Steinar H. Gunderson <sgunderson@bigfoot.com>
9 # Licensed under the GNU General Public License, version 2.
20 my $server = "freechess.org";
22 # my $engine = "/usr/games/toga2";
23 my $engine = "wine Rybkav2.3.2a.mp.w32.exe";
24 my $telltarget = undef; # undef to be silent
25 my @tell_intervals = (5, 20, 60, 120, 240, 480, 960); # after each move
26 my $uci_assume_full_compliance = 1; # dangerous :-)
34 $SIG{ALRM} = sub { output_screen(); };
38 open(FICSLOG, ">ficslog.txt")
39 or die "ficslog.txt: $!";
40 print FICSLOG "Log starting.\n";
44 open(UCILOG, ">ucilog.txt")
45 or die "ucilog.txt: $!";
46 print UCILOG "Log starting.\n";
51 # open the chess engine
52 my $pid = IPC::Open2::open2(*UCIREAD, *UCIWRITE, $engine);
55 my ($last_move, $last_tell);
57 my $last_told_text = '';
58 my ($pos_waiting, $pos_calculating);
68 uciprint("setoption name UCI_AnalyseMode value true");
69 # uciprint("setoption name Preserve Analysis value true");
70 uciprint("setoption name NalimovPath value c:\\nalimov");
71 uciprint("setoption name NalimovUsage value Rarely");
72 uciprint("setoption name Hash value 1024");
73 uciprint("setoption name MultiPV value 3");
74 # uciprint("setoption name Contempt value 1000");
75 # uciprint("setoption name Outlook value Ultra Optimistic");
76 uciprint("ucinewgame");
78 print "Chess engine ready.\n";
81 my $t = Net::Telnet->new(Timeout => 10, Prompt => '/fics% /');
82 $t->input_log(\*FICSLOG);
85 $t->waitfor('/Press return to enter the server/');
89 $t->cmd("set shout 0");
90 $t->cmd("set seek 0");
91 $t->cmd("set style 12");
92 $t->cmd("observe $target");
95 print "FICS ready.\n";
99 vec($rin, fileno(UCIREAD), 1) = 1;
100 vec($rin, fileno($t), 1) = 1;
102 my ($nfound, $timeleft) = select($rout=$rin, undef, undef, 5.0);
106 my $line = $t->getline(Timeout => 0, errmode => 'return');
107 last if (!defined($line));
111 if ($line =~ /^<12> /) {
112 my $pos = style12_to_fen($line);
114 # if this is already in the queue, ignore it
115 next if (defined($pos_waiting) && $pos->{'fen'} eq $pos_waiting->{'fen'});
117 # if we're already chewing on this and there's nothing else in the queue,
119 next if (!defined($pos_waiting) && defined($pos_calculating) &&
120 $pos->{'fen'} eq $pos_calculating->{'fen'});
122 # if we're already thinking on something, stop and wait for the engine
124 if (defined($pos_calculating)) {
125 if (!defined($pos_waiting)) {
128 if ($uci_assume_full_compliance) {
131 uciprint("position fen " . $pos->{'fen'});
132 uciprint("go infinite");
133 $pos_calculating = $pos;
136 # it's wrong just to give the FEN (the move history is useful,
137 # and per the UCI spec, we should really have sent "ucinewgame"),
139 uciprint("position fen " . $pos->{'fen'});
140 uciprint("go infinite");
141 $pos_calculating = $pos;
148 # Output a command every move to note that we're
149 # still paying attention -- this is a good tradeoff,
150 # since if no move has happened in the last half
151 # hour, the analysis/relay has most likely stopped
152 # and we should stop hogging server resources.
156 if ($line =~ /^([A-Za-z]+)(?:\([A-Z]+\))* tells you: (.*)$/) {
157 my ($who, $msg) = ($1, $2);
159 next if (grep { $_ eq $who } (@masters) == 0);
161 if ($msg =~ /^fics (.*?)$/) {
162 $t->cmd("tell $who Executing '$1' on FICS.");
164 } elsif ($msg =~ /^uci (.*?)$/) {
165 $t->cmd("tell $who Sending '$1' to the engine.");
166 print UCIWRITE "$1\n";
168 $t->cmd("tell $who Couldn't understand '$msg', sorry.");
171 #print "FICS: [$line]\n";
175 # any fun on the UCI channel?
176 if ($nfound > 0 && vec($rout, fileno(UCIREAD), 1) == 1) {
178 # Read until we've got a full line -- if the engine sends part of
179 # a line and then stops we're pretty much hosed, but that should
183 while ($line !~ /\n/) {
185 my $ret = sysread UCIREAD, $tmp, 1;
187 if (!defined($ret)) {
189 die "error in reading from the UCI engine: $!";
190 } elsif ($ret == 0) {
191 die "EOF from UCI engine";
201 # don't update too often
202 Time::HiRes::alarm(0.2);
213 print UCILOG localtime() . " <= $line\n";
214 if ($line =~ /^info/) {
215 my (@infos) = split / /, $line;
220 if ($line =~ /^id/) {
221 my (@ids) = split / /, $line;
226 if ($line =~ /^bestmove/ && $uci_assume_full_compliance) {
227 if (defined($pos_waiting)) {
228 uciprint("position fen " . $pos_waiting->{'fen'});
229 uciprint("go infinite");
231 $pos_calculating = $pos_waiting;
232 $pos_waiting = undef;
241 while (scalar @x > 0) {
242 if ($x[0] =~ 'multipv') {
247 if ($x[0] =~ /^(currmove|currmovenumber|cpuload)$/) {
249 my $value = shift @x;
250 $uciinfo{$key} = $value;
253 if ($x[0] =~ /^(depth|seldepth|hashfull|time|nodes|nps|tbhits)$/) {
255 my $value = shift @x;
256 $uciinfo{$key . $mpv} = $value;
259 if ($x[0] eq 'score') {
262 delete $uciinfo{'score_cp' . $mpv};
263 delete $uciinfo{'score_mate' . $mpv};
265 while ($x[0] =~ /^(cp|mate|lowerbound|upperbound)$/) {
268 $uciinfo{'score_cp' . $mpv} = shift @x;
269 } elsif ($x[0] eq 'mate') {
271 $uciinfo{'score_mate' . $mpv} = shift @x;
279 $uciinfo{'pv' . $mpv} = [ @x[1..$#x] ];
282 if ($x[0] eq 'string' || $x[0] eq 'UCI_AnalyseMode' || $x[0] eq 'setting' || $x[0] eq 'contempt') {
286 #print "unknown info '$x[0]', trying to recover...\n";
288 die "Unknown info '" . join(',', @x) . "'";
296 while (scalar @x > 0) {
297 if ($x[0] =~ /^(name|author)$/) {
299 my $value = join(' ', @x);
300 $uciid{$key} = $value;
312 my (@x) = split / /, $str;
314 $pos{'board'} = [ @x[1..8] ];
315 $pos{'toplay'} = $x[9];
318 my (@board) = @x[1..8];
319 for my $rank (0..7) {
320 $board[$rank] =~ s/(-+)/length($1)/ge;
322 my $fen = join('/', @board);
324 # white/black to move
330 $castling .= "K" if ($x[11] == 1);
331 $castling .= "Q" if ($x[12] == 1);
332 $castling .= "k" if ($x[13] == 1);
333 $castling .= "q" if ($x[14] == 1);
334 $castling = "-" if ($castling eq "");
342 my $nep = (qw(a b c d e f g h))[$col];
351 # Showing the en passant square when actually no capture can be made
352 # seems to confuse at least Rybka. Thus, check if there's actually
353 # a pawn of the opposite side that can do the en passant move, and if
354 # not, just lie -- it doesn't matter anyway. I'm unsure what's the
355 # "right" thing as per the standard, though.
358 $ep = $nep if ($col > 0 && substr($pos{'board'}[4], $col-1, 1) eq 'p');
359 $ep = $nep if ($col < 7 && substr($pos{'board'}[4], $col+1, 1) eq 'p');
361 $ep = $nep if ($col > 0 && substr($pos{'board'}[3], $col-1, 1) eq 'P');
362 $ep = $nep if ($col < 7 && substr($pos{'board'}[3], $col+1, 1) eq 'P');
377 $pos{'move_num'} = $x[26];
378 $pos{'last_move'} = $x[29];
384 my ($board, @pvs) = @_;
386 if (scalar @pvs == 0 || !defined($pvs[0])) {
393 my $from_col = ord(substr($pv, 0, 1)) - ord('a');
394 my $from_row = 7 - (ord(substr($pv, 1, 1)) - ord('1'));
395 my $to_col = ord(substr($pv, 2, 1)) - ord('a');
396 my $to_row = 7 - (ord(substr($pv, 3, 1)) - ord('1'));
399 my $piece = substr($board->[$from_row], $from_col, 1);
405 # white short castling
406 if ($pv eq 'e1g1' && $piece eq 'K') {
408 substr($nb[7], 4, 1, '-');
409 substr($nb[7], 6, 1, $piece);
412 substr($nb[7], 7, 1, '-');
413 substr($nb[7], 5, 1, 'R');
415 return ('0-0', prettyprint_pv(\@nb, @pvs));
418 # white long castling
419 if ($pv eq 'e1c1' && $piece eq 'K') {
421 substr($nb[7], 4, 1, '-');
422 substr($nb[7], 2, 1, $piece);
425 substr($nb[7], 0, 1, '-');
426 substr($nb[7], 3, 1, 'R');
428 return ('0-0-0', prettyprint_pv(\@nb, @pvs));
431 # black short castling
432 if ($pv eq 'e8g8' && $piece eq 'k') {
434 substr($nb[0], 4, 1, '-');
435 substr($nb[0], 6, 1, $piece);
438 substr($nb[0], 7, 1, '-');
439 substr($nb[0], 5, 1, 'r');
441 return ('0-0', prettyprint_pv(\@nb, @pvs));
444 # black long castling
445 if ($pv eq 'e8c8' && $piece eq 'k') {
447 substr($nb[0], 4, 1, '-');
448 substr($nb[0], 2, 1, $piece);
451 substr($nb[0], 0, 1, '-');
452 substr($nb[0], 3, 1, 'r');
454 return ('0-0-0', prettyprint_pv(\@nb, @pvs));
457 # check if the from-piece is a pawn
458 if (lc($piece) eq 'p') {
460 if ($from_col != $to_col) {
461 $pretty = substr($pv, 0, 1) . 'x' . substr($pv, 2, 2);
464 if (substr($board->[$to_row], $to_col, 1) eq '-') {
466 substr($nb[$to_row + 1], $to_col, 1, '-');
468 substr($nb[$to_row - 1], $to_col, 1, '-');
472 $pretty = substr($pv, 2, 2);
474 if (length($pv) == 5) {
477 $pretty .= uc(substr($pv, 4, 1));
480 $piece = substr($pv, 4, 1);
482 $piece = uc(substr($pv, 4, 1));
487 $pretty = uc($piece);
489 # see how many of these pieces could go here, in all
493 next unless (substr($board->[$row], $col, 1) eq $piece);
494 ++$num_total if (can_reach($board, $piece, $row, $col, $to_row, $to_col));
498 # see how many of these pieces from the given row could go here
501 next unless (substr($board->[$from_row], $col, 1) eq $piece);
502 ++$num_row if (can_reach($board, $piece, $from_row, $col, $to_row, $to_col));
505 # and same for columns
508 next unless (substr($board->[$row], $from_col, 1) eq $piece);
509 ++$num_col if (can_reach($board, $piece, $row, $from_col, $to_row, $to_col));
512 # see if we need to disambiguate
513 if ($num_total > 1) {
515 $pretty .= substr($pv, 0, 1);
516 } elsif ($num_row == 1) {
517 $pretty .= substr($pv, 1, 1);
519 $pretty .= substr($pv, 0, 2);
524 if (substr($board->[$to_row], $to_col, 1) ne '-') {
528 $pretty .= substr($pv, 2, 2);
532 substr($nb[$from_row], $from_col, 1, '-');
533 substr($nb[$to_row], $to_col, 1, $piece);
537 } elsif (in_check(\@nb) ne 'none') {
541 return ($pretty, prettyprint_pv(\@nb, @pvs));
547 return if (!defined($pos_calculating));
550 # Check the PVs first. if they're invalid, just wait, as our data
551 # is most likely out of sync. This isn't a very good solution, as
552 # it can frequently miss stuff, but it's good enough for most users.
556 if (exists($uciinfo{'pv'})) {
557 $dummy = prettyprint_pv($pos_calculating->{'board'}, @{$uciinfo{'pv'}});
561 while (exists($uciinfo{'pv' . $mpv})) {
562 $dummy = prettyprint_pv($pos_calculating->{'board'}, @{$uciinfo{'pv' . $mpv}});
571 my $text = 'Analysis';
572 if ($pos_calculating->{'last_move'} ne 'none') {
573 if ($pos_calculating->{'toplay'} eq 'W') {
574 $text .= sprintf ' after %u. ... %s', ($pos_calculating->{'move_num'}-1), $pos_calculating->{'last_move'};
576 $text .= sprintf ' after %u. %s', $pos_calculating->{'move_num'}, $pos_calculating->{'last_move'};
578 if (exists($uciid{'name'})) {
583 if (exists($uciid{'name'})) {
584 $text .= " by $uciid{'name'}:\n\n";
589 return unless (exists($pos_calculating->{'board'}));
592 # Some programs _always_ report MultiPV, even with only one PV.
593 # In this case, we simply use that data as if MultiPV was never
596 if (exists($uciinfo{'pv1'}) && !exists($uciinfo{'pv2'})) {
597 for my $key qw(pv score_cp score_mate nodes nps depth seldepth tbhits) {
598 if (exists($uciinfo{$key . '1'}) && !exists($uciinfo{$key})) {
599 $uciinfo{$key} = $uciinfo{$key . '1'};
604 if (exists($uciinfo{'pv1'}) && exists($uciinfo{'pv2'})) {
607 while (exists($uciinfo{'pv' . $mpv})) {
608 $text .= sprintf " PV%2u", $mpv;
609 my $score = short_score(\%uciinfo, $pos_calculating, $mpv);
610 $text .= " ($score)" if (defined($score));
613 if (exists($uciinfo{'tbhits' . $mpv}) && $uciinfo{'tbhits' . $mpv} > 0) {
614 if ($uciinfo{'tbhits' . $mpv} == 1) {
615 $tbhits = ", 1 tbhit";
617 $tbhits = sprintf ", %u tbhits", $uciinfo{'tbhits' . $mpv};
621 if (exists($uciinfo{'nodes' . $mpv}) && exists($uciinfo{'nps' . $mpv}) && exists($uciinfo{'depth' . $mpv})) {
622 $text .= sprintf " (%5u kn, %3u kn/s, %2u ply$tbhits)",
623 $uciinfo{'nodes' . $mpv} / 1000, $uciinfo{'nps' . $mpv} / 1000, $uciinfo{'depth' . $mpv};
627 $text .= " " . join(', ', prettyprint_pv($pos_calculating->{'board'}, @{$uciinfo{'pv' . $mpv}})) . "\n";
633 my $score = long_score(\%uciinfo, $pos_calculating, '');
634 $text .= " $score\n" if defined($score);
635 $text .= " PV: " . join(', ', prettyprint_pv($pos_calculating->{'board'}, @{$uciinfo{'pv'}}));
638 if (exists($uciinfo{'nodes'}) && exists($uciinfo{'nps'}) && exists($uciinfo{'depth'})) {
639 $text .= sprintf " %u nodes, %7u nodes/sec, depth %u ply",
640 $uciinfo{'nodes'}, $uciinfo{'nps'}, $uciinfo{'depth'};
642 if (exists($uciinfo{'tbhits'}) && $uciinfo{'tbhits'} > 0) {
643 if ($uciinfo{'tbhits'} == 1) {
644 $text .= ", one Nalimov hit";
646 $text .= sprintf ", %u Nalimov hits", $uciinfo{'tbhits'};
649 if (exists($uciinfo{'seldepth'})) {
650 $text .= sprintf " (%u selective)", $uciinfo{'seldepth'};
655 if ($last_text ne $text) {
656 print "
\e[H
\e[2J"; # clear the screen
661 # Now construct the tell text, if any
662 return if (!defined($telltarget));
666 if (exists($uciid{'name'})) {
667 $tell_text .= "Analysis by $uciid{'name'} -- see http://analysis.sesse.net/ for more information\n";
669 $tell_text .= "Computer analysis -- http://analysis.sesse.net/ for more information\n";
672 if (exists($uciinfo{'pv1'}) && exists($uciinfo{'pv2'})) {
675 while (exists($uciinfo{'pv' . $mpv})) {
676 $tell_text .= sprintf " PV%2u", $mpv;
677 my $score = short_score(\%uciinfo, $pos_calculating, $mpv);
678 $tell_text .= " ($score)" if (defined($score));
680 if (exists($uciinfo{'depth' . $mpv})) {
681 $tell_text .= sprintf " (%2u ply)", $uciinfo{'depth' . $mpv};
685 $tell_text .= join(', ', prettyprint_pv($pos_calculating->{'board'}, @{$uciinfo{'pv' . $mpv}}));
691 my $score = long_score(\%uciinfo, $pos_calculating, '');
692 $tell_text .= " $score\n" if defined($score);
693 $tell_text .= " PV: " . join(', ', prettyprint_pv($pos_calculating->{'board'}, @{$uciinfo{'pv'}}));
694 if (exists($uciinfo{'depth'})) {
695 $tell_text .= sprintf " (depth %u ply)", $uciinfo{'depth'};
700 # see if a new tell is called for -- it is if the delay has expired _and_
701 # this is not simply a repetition of the last one
702 if ($last_told_text ne $tell_text) {
704 for my $iv (@tell_intervals) {
705 last if ($now - $last_move < $iv);
706 next if ($last_tell - $last_move >= $iv);
708 for my $line (split /\n/, $tell_text) {
709 $t->print("tell $telltarget [$target] $line");
712 $last_told_text = $text;
722 my ($wkr, $wkc, $bkr, $bkc);
726 my $piece = substr($board->[$row], $col, 1);
728 ($wkr, $wkc) = ($row, $col);
729 } elsif ($piece eq 'k') {
730 ($bkr, $bkc) = ($row, $col);
735 return ($wkr, $wkc, $bkr, $bkc);
740 my $check = in_check($board);
741 return 0 if ($check eq 'none');
743 # try all possible moves for the side in check
746 my $piece = substr($board->[$row], $col, 1);
747 next if ($piece eq '-');
749 if ($check eq 'white') {
750 next if ($piece eq lc($piece));
752 next if ($piece eq uc($piece));
755 for my $dest_row (0..7) {
756 for my $dest_col (0..7) {
757 next if ($row == $dest_row && $col == $dest_col);
758 next unless (can_reach($board, $piece, $row, $col, $dest_row, $dest_col));
761 substr($nb[$row], $col, 1, '-');
762 substr($nb[$dest_row], $dest_col, 1, $piece);
764 my $new_check = in_check(\@nb);
765 return 0 if ($new_check ne $check && $new_check ne 'both');
771 # nothing to do; mate
777 my ($black_check, $white_check) = (0, 0);
779 my ($wkr, $wkc, $bkr, $bkc) = find_kings($board);
781 # check all pieces for the possibility of threatening the two kings
784 my $piece = substr($board->[$row], $col, 1);
785 next if ($piece eq '-');
787 if (uc($piece) eq $piece) {
789 $black_check = 1 if (can_reach($board, $piece, $row, $col, $bkr, $bkc));
792 $white_check = 1 if (can_reach($board, $piece, $row, $col, $wkr, $wkc));
797 if ($black_check && $white_check) {
799 } elsif ($black_check) {
801 } elsif ($white_check) {
809 my ($board, $piece, $from_row, $from_col, $to_row, $to_col) = @_;
811 # can't eat your own piece
812 my $dest_piece = substr($board->[$to_row], $to_col, 1);
813 if ($dest_piece ne '-') {
814 return 0 if (($piece eq lc($piece)) == ($dest_piece eq lc($dest_piece)));
817 if (lc($piece) eq 'k') {
818 return (abs($from_row - $to_row) <= 1 && abs($from_col - $to_col) <= 1);
820 if (lc($piece) eq 'r') {
821 return 0 unless ($from_row == $to_row || $from_col == $to_col);
823 # check that there's a clear passage
824 if ($from_row == $to_row) {
825 if ($from_col > $to_col) {
826 ($to_col, $from_col) = ($from_col, $to_col);
829 for my $c (($from_col+1)..($to_col-1)) {
830 my $middle_piece = substr($board->[$to_row], $c, 1);
831 return 0 if ($middle_piece ne '-');
836 if ($from_row > $to_row) {
837 ($to_row, $from_row) = ($from_row, $to_row);
840 for my $r (($from_row+1)..($to_row-1)) {
841 my $middle_piece = substr($board->[$r], $to_col, 1);
842 return 0 if ($middle_piece ne '-');
848 if (lc($piece) eq 'b') {
849 return 0 unless (abs($from_row - $to_row) == abs($from_col - $to_col));
851 my $dr = ($to_row - $from_row) / abs($to_row - $from_row);
852 my $dc = ($to_col - $from_col) / abs($to_col - $from_col);
854 my $r = $from_row + $dr;
855 my $c = $from_col + $dc;
857 while ($r != $to_row) {
858 my $middle_piece = substr($board->[$r], $c, 1);
859 return 0 if ($middle_piece ne '-');
867 if (lc($piece) eq 'n') {
868 my $diff_r = abs($from_row - $to_row);
869 my $diff_c = abs($from_col - $to_col);
870 return 1 if ($diff_r == 2 && $diff_c == 1);
871 return 1 if ($diff_r == 1 && $diff_c == 2);
875 return (can_reach($board, 'r', $from_row, $from_col, $to_row, $to_col) ||
876 can_reach($board, 'b', $from_row, $from_col, $to_row, $to_col));
879 return (can_reach($board, 'R', $from_row, $from_col, $to_row, $to_col) ||
880 can_reach($board, 'B', $from_row, $from_col, $to_row, $to_col));
884 if ($to_col == $from_col && $to_row == $from_row + 1) {
885 return ($dest_piece eq '-');
887 if (abs($to_col - $from_col) == 1 && $to_row == $from_row + 1) {
888 return ($dest_piece ne '-');
894 if ($to_col == $from_col && $to_row == $from_row - 1) {
895 return ($dest_piece eq '-');
897 if (abs($to_col - $from_col) == 1 && $to_row == $from_row - 1) {
898 return ($dest_piece ne '-');
909 print UCIWRITE "$msg\n";
910 print UCILOG localtime() . " => $msg\n";
914 my ($uciinfo, $pos, $mpv) = @_;
916 if (defined($uciinfo{'score_mate' . $mpv})) {
917 return sprintf "M%3d", $uciinfo{'score_mate' . $mpv};
919 if (exists($uciinfo{'score_cp' . $mpv})) {
920 my $score = $uciinfo{'score_cp' . $mpv} * 0.01;
921 if ($pos->{'toplay'} eq 'B') {
924 return sprintf "%+5.2f", $score;
932 my ($uciinfo, $pos, $mpv) = @_;
934 if (defined($uciinfo{'score_mate' . $mpv})) {
935 my $mate = $uciinfo{'score_mate' . $mpv};
936 if ($pos->{'toplay'} eq 'B') {
940 return sprintf "White mates in %u", $mate;
942 return sprintf "Black mates in %u", -$mate;
945 if (exists($uciinfo{'score_cp' . $mpv})) {
946 my $score = $uciinfo{'score_cp' . $mpv} * 0.01;
947 if ($pos->{'toplay'} eq 'B') {
950 return sprintf "Score: %+5.2f", $score;