Print more friendly mate information.
[remoteglot] / remoteglot.pl
1 #! /usr/bin/perl
2
3 #
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.)
7 #
8 # Copyright 2007 Steinar H. Gunderson <sgunderson@bigfoot.com>
9 # Licensed under the GNU General Public License, version 2.
10 #
11
12 use Net::Telnet;
13 use FileHandle;
14 use IPC::Open2;
15 use Time::HiRes;
16 use strict;
17 use warnings;
18
19 $SIG{ALRM} = sub { output_screen(); };
20
21 $| = 1;
22
23 my $server = "freechess.org";
24 my $target = "Sesse";
25 # my $engine = "/usr/games/toga2";
26 my $engine = "wine Rybkav2.3.2a.mp.w32.exe";
27
28 open(FICSLOG, ">ficslog.txt")
29         or die "ficslog.txt: $!";
30 print FICSLOG "Log starting.\n";
31 select(FICSLOG);
32 $| = 1;
33
34 open(UCILOG, ">ucilog.txt")
35         or die "ucilog.txt: $!";
36 print UCILOG "Log starting.\n";
37 select(UCILOG);
38 $| = 1;
39 select(STDOUT);
40
41 # open the chess engine
42 my $pid = IPC::Open2::open2(*UCIREAD, *UCIWRITE, $engine);
43 my %uciinfo = ();
44 my %ficsinfo = ();
45
46 uciprint("uci");
47
48 # gobble the options
49 while (<UCIREAD>) {
50         /uciok/ && last;
51 }
52
53 uciprint("setoption name UCI_AnalyseMode value true");
54 uciprint("setoption name NalimovPath value c:\\nalimov");
55 uciprint("setoption name NalimovUsage value Rarely");
56 uciprint("setoption name Hash value 1024");
57 # uciprint("setoption name MultiPV value 3");
58 # uciprint("setoption name Contempt value 1000");
59 # uciprint("setoption name Outlook value Ultra Optimistic");
60 uciprint("ucinewgame");
61
62 print "Chess engine ready.\n";
63
64 # now talk to FICS
65 my $t = Net::Telnet->new(Timeout => 10, Prompt => '/fics% /');
66 $t->input_log(\*FICSLOG);
67 $t->open($server);
68 $t->print("guest");
69 $t->waitfor('/Press return to enter the server/');
70 $t->cmd("");
71
72 # set some options
73 $t->cmd("set shout 0");
74 $t->cmd("set seek 0");
75 $t->cmd("set style 12");
76 $t->cmd("observe $target");
77
78 # main loop
79 print "FICS ready.\n";
80 while (1) {
81         my $rin = '';
82         my $rout;
83         vec($rin, fileno(UCIREAD), 1) = 1;
84         vec($rin, fileno($t), 1) = 1;
85
86         my ($nfound, $timeleft) = select($rout=$rin, undef, undef, 5.0);
87         my $sleep = 1.0;
88
89         while (1) {
90                 my $line = $t->getline(Timeout => 0, errmode => 'return');
91                 last if (!defined($line));
92
93                 chomp $line;
94                 $line =~ tr/\r//d;
95                 if ($line =~ /^<12> /) {
96                         my $fen = style12_to_fen($line);
97                         uciprint("stop");
98                         uciprint("position fen $fen");
99                         uciprint("go infinite");
100                 }
101                 #print "FICS: [$line]\n";
102                 $sleep = 0;
103         }
104         
105         # any fun on the UCI channel?
106         if ($nfound > 0 && vec($rout, fileno(UCIREAD), 1) == 1) {
107                 my $line = <UCIREAD>;
108                 chomp $line;
109                 $line =~ tr/\r//d;
110                 print UCILOG "<= $line\n";
111                 if ($line =~ /^info/) {
112                         my (@infos) = split / /, $line;
113                         shift @infos;
114
115                         parse_infos(@infos);
116                 }
117                 $sleep = 0;
118
119                 # don't update too often
120                 Time::HiRes::alarm(0.2);
121         }
122
123         sleep $sleep;
124 }
125
126 sub parse_infos {
127         my (@x) = @_;
128         my $mpv = '';
129
130         while (scalar @x > 0) {
131                 if ($x[0] =~ 'multipv') {
132                         shift @x;
133                         $mpv = shift @x;
134                         next;
135                 }
136                 if ($x[0] =~ /^(currmove|currmovenumber|cpuload)$/) {
137                         my $key = shift @x;
138                         my $value = shift @x;
139                         $uciinfo{$key} = $value;
140                         next;
141                 }
142                 if ($x[0] =~ /^(depth|seldepth|hashfull|time|nodes|nps|tbhits)$/) {
143                         my $key = shift @x;
144                         my $value = shift @x;
145                         $uciinfo{$key . $mpv} = $value;
146                         next;
147                 }
148                 if ($x[0] eq 'score') {
149                         shift @x;
150
151                         delete $uciinfo{'score_cp' . $mpv};
152                         delete $uciinfo{'score_mate' . $mpv};
153
154                         while ($x[0] =~ /^(cp|mate|lowerbound|upperbound)$/) {
155                                 if ($x[0] eq 'cp') {
156                                         shift @x;
157                                         $uciinfo{'score_cp' . $mpv} = shift @x;
158                                 } elsif ($x[0] eq 'mate') {
159                                         shift @x;
160                                         $uciinfo{'score_mate' . $mpv} = shift @x;
161                                 } else {
162                                         shift @x;
163                                 }
164                         }
165                         next;
166                 }
167                 if ($x[0] eq 'pv') {
168                         $uciinfo{'pv' . $mpv} = [ @x[1..$#x] ];
169                         last;
170                 }
171                 if ($x[0] eq 'string' || $x[0] eq 'UCI_AnalyseMode' || $x[0] eq 'setting' || $x[0] eq 'contempt') {
172                         last;
173                 }
174
175                 #print "unknown info '$x[0]', trying to recover...\n";
176                 #shift @x;
177                 die "Unknown info '" . join(',', @x) . "'";
178
179         }
180 }
181
182 sub style12_to_fen {
183         my $str = shift; 
184         my (@x) = split / /, $str;
185         
186         $ficsinfo{'board'} = [ @x[1..8] ];
187         $ficsinfo{'toplay'} = $x[9];
188         
189         # the board itself
190         my (@board) = @x[1..8];
191         for my $rank (0..7) {
192                 $board[$rank] =~ s/(-+)/length($1)/ge;
193         }
194         my $fen = join('/', @board);
195
196         # white/black to move
197         $fen .= " ";
198         $fen .= lc($x[9]);
199
200         # castling
201         my $castling = "";
202         $castling .= "K" if ($x[11] == 1);
203         $castling .= "Q" if ($x[12] == 1);
204         $castling .= "k" if ($x[13] == 1);
205         $castling .= "q" if ($x[14] == 1);
206         $castling = "-" if ($castling eq "");
207         $fen .= " ";
208         $fen .= $castling;
209
210         # en passant
211         my $ep = "-";
212         if ($x[10] != -1) {
213                 my $col = $x[10];
214                 my $nep = (qw(a b c d e f g h))[$col];
215
216                 if ($x[9] eq 'B') {
217                         $nep .= "3";
218                 } else {
219                         $nep .= "6";
220                 }
221                 
222                 #
223                 # Showing the en passant square when actually no capture can be made
224                 # seems to confuse at least Rybka. Thus, check if there's actually
225                 # a pawn of the opposite side that can do the en passant move, and if
226                 # not, just lie -- it doesn't matter anyway. I'm unsure what's the
227                 # "right" thing as per the standard, though.
228                 #
229                 if ($x[9] eq 'B') {
230                         $ep = $nep if ($col > 0 && substr($board[4], $col-1, 1) eq 'p');
231                         $ep = $nep if ($col < 7 && substr($board[4], $col+1, 1) eq 'p');
232                 } else {
233                         $ep = $nep if ($col > 0 && substr($board[3], $col-1, 1) eq 'P');
234                         $ep = $nep if ($col < 7 && substr($board[3], $col+1, 1) eq 'P');
235                 }
236         }
237         $fen .= " ";
238         $fen .= $ep;
239
240         # half-move clock
241         $fen .= " ";
242         $fen .= $x[15];
243
244         # full-move clock
245         $fen .= " ";
246         $fen .= $x[26];
247
248         return $fen;
249 }
250
251 sub prettyprint_pv {
252         my ($board, @pvs) = @_;
253         
254         if (scalar @pvs == 0 || !defined($pvs[0])) {
255                 return ();
256         }
257
258         my $pv = shift @pvs;
259         my $from_col = ord(substr($pv, 0, 1)) - ord('a');
260         my $from_row = 7 - (ord(substr($pv, 1, 1)) - ord('1'));
261         my $to_col   = ord(substr($pv, 2, 1)) - ord('a');
262         my $to_row   = 7 - (ord(substr($pv, 3, 1)) - ord('1'));
263
264         my $pretty;
265         my $piece = substr($board->[$from_row], $from_col, 1);
266
267         # white short castling
268         if ($pv eq 'e1g1' && $piece eq 'K') {
269                 my @nb = @$board;
270
271                 # king
272                 substr($nb[7], 4, 1, '-');
273                 substr($nb[7], 6, 1, $piece);
274                 
275                 # rook
276                 substr($nb[7], 7, 1, '-');
277                 substr($nb[7], 5, 1, 'R');
278                                 
279                 return ('0-0', prettyprint_pv(\@nb, @pvs));
280         }
281
282         # white long castling
283         if ($pv eq 'e1c1' && $piece eq 'K') {
284                 my @nb = @$board;
285
286                 # king
287                 substr($nb[7], 4, 1, '-');
288                 substr($nb[7], 2, 1, $piece);
289                 
290                 # rook
291                 substr($nb[7], 0, 1, '-');
292                 substr($nb[7], 3, 1, 'R');
293                                 
294                 return ('0-0-0', prettyprint_pv(\@nb, @pvs));
295         }
296
297         # black short castling
298         if ($pv eq 'e8g8' && $piece eq 'k') {
299                 my @nb = @$board;
300
301                 # king
302                 substr($nb[0], 4, 1, '-');
303                 substr($nb[0], 6, 1, $piece);
304                 
305                 # rook
306                 substr($nb[0], 7, 1, '-');
307                 substr($nb[0], 5, 1, 'r');
308                                 
309                 return ('0-0', prettyprint_pv(\@nb, @pvs));
310         }
311
312         # black long castling
313         if ($pv eq 'e8c8' && $piece eq 'k') {
314                 my @nb = @$board;
315
316                 # king
317                 substr($nb[0], 4, 1, '-');
318                 substr($nb[0], 2, 1, $piece);
319                 
320                 # rook
321                 substr($nb[0], 0, 1, '-');
322                 substr($nb[0], 3, 1, 'r');
323                                 
324                 return ('0-0-0', prettyprint_pv(\@nb, @pvs));
325         }
326
327         # check if the from-piece is a pawn
328         if (lc($piece) eq 'p') {
329                 # attack?
330                 if (substr($board->[$to_row], $to_col, 1) ne '-') {
331                         $pretty = substr($pv, 0, 1) . 'x' . substr($pv, 2, 2);
332                 } else {
333                         $pretty = substr($pv, 2, 2);
334
335                         if (length($pv) == 5) {
336                                 # promotion
337                                 $pretty .= "=";
338                                 $pretty .= uc(substr($pv, 4, 1));
339
340                                 if ($piece eq 'p') {
341                                         $piece = substr($pv, 4, 1);
342                                 } else {
343                                         $piece = uc(substr($pv, 4, 1));
344                                 }
345                         }
346                 }
347         } else {
348                 $pretty = uc($piece);
349
350                 # see how many of these pieces could go here, in all
351                 my $num_total = 0;
352                 for my $col (0..7) {
353                         for my $row (0..7) {
354                                 next unless (substr($board->[$row], $col, 1) eq $piece);
355                                 ++$num_total if (can_reach($board, $piece, $row, $col, $to_row, $to_col));
356                         }
357                 }
358
359                 # see how many of these pieces from the given row could go here
360                 my $num_row = 0;
361                 for my $col (0..7) {
362                         next unless (substr($board->[$from_row], $col, 1) eq $piece);
363                         ++$num_row if (can_reach($board, $piece, $from_row, $col, $to_row, $to_col));
364                 }
365                 
366                 # and same for columns
367                 my $num_col = 0;
368                 for my $row (0..7) {
369                         next unless (substr($board->[$row], $from_col, 1) eq $piece);
370                         ++$num_col if (can_reach($board, $piece, $row, $from_col, $to_row, $to_col));
371                 }
372                 
373                 # see if we need to disambiguate
374                 if ($num_total > 1) {
375                         if ($num_col == 1) {
376                                 $pretty .= substr($pv, 0, 1);
377                         } elsif ($num_row == 1) {
378                                 $pretty .= substr($pv, 1, 1);
379                         } else {
380                                 $pretty .= substr($pv, 0, 2);
381                         }
382                 }
383
384                 # attack?
385                 if (substr($board->[$to_row], $to_col, 1) ne '-') {
386                         $pretty .= 'x';
387                 }
388
389                 $pretty .= substr($pv, 2, 2);
390         }
391
392         # update the board
393         my @nb = @$board;
394         substr($nb[$from_row], $from_col, 1, '-');
395         substr($nb[$to_row], $to_col, 1, $piece);
396
397         if (in_mate(\@nb)) {
398                 $pretty .= '#';
399         } elsif (in_check(\@nb) ne 'none') {
400                 $pretty .= '+';
401         }
402
403         return ($pretty, prettyprint_pv(\@nb, @pvs));
404 }
405
406 sub output_screen {
407         #return;
408
409         print  "\ecAnalysis:\n";
410
411         return unless (exists($ficsinfo{'board'}));
412
413         if (exists($uciinfo{'pv1'})) {
414                 # multi-PV
415                 my $mpv = 1;
416                 while (exists($uciinfo{'pv' . $mpv})) {
417                         printf "  PV%2u", $mpv;
418
419                         if (defined($uciinfo{'score_mate' . $mpv})) {
420                                 printf " (M%3d)", $uciinfo{'score_mate' . $mpv};
421                         } else {
422                                 if (exists($uciinfo{'score_cp' . $mpv})) {
423                                         my $score = $uciinfo{'score_cp' . $mpv} * 0.01;
424                                         if ($ficsinfo{'toplay'} eq 'B') {
425                                                 $score = -$score;
426                                         }
427                                         printf " (%+5.2f)", $score;
428                                 }
429                         }
430                         
431                         if (exists($uciinfo{'nodes' . $mpv}) && exists($uciinfo{'nps' . $mpv}) && exists($uciinfo{'depth' . $mpv})) {
432                                 printf " (%5u kn, %3u kn/s, %2u ply)",
433                                         $uciinfo{'nodes' . $mpv} / 1000, $uciinfo{'nps' . $mpv} / 1000, $uciinfo{'depth' . $mpv};
434                         }
435
436                         print ":\n";
437                         print "  ", join(', ', prettyprint_pv($ficsinfo{'board'}, @{$uciinfo{'pv' . $mpv}})), "\n";
438                         print "\n";
439                         ++$mpv;
440                 }
441         } else {
442                 # single-PV
443                 if (defined($uciinfo{'score_mate'})) {
444                         my $mate = $uciinfo{'score_mate'};
445                         if ($ficsinfo{'toplay'} eq 'B') {
446                                 $mate = -$mate;
447                         }
448                         if ($mate > 0) {
449                                 printf "  White mates in %u\n", $mate;
450                         } else {
451                                 printf "  Black mates in %u\n", -$mate;
452                         }
453                 } else {
454                         if (exists($uciinfo{'score_cp'})) {
455                                 my $score = $uciinfo{'score_cp'} * 0.01;
456                                 if ($ficsinfo{'toplay'} eq 'B') {
457                                         $score = -$score;
458                                 }
459                                 printf "  Score: %+5.2f\n", $score;
460                         }
461                 }
462
463                 print  "  PV: ", join(', ', prettyprint_pv($ficsinfo{'board'}, @{$uciinfo{'pv'}}));
464                 print  "\n";
465
466                 if (exists($uciinfo{'nodes'}) && exists($uciinfo{'nps'}) && exists($uciinfo{'depth'})) {
467                         printf "  %u nodes, %7u nodes/sec, depth %u ply",
468                                 $uciinfo{'nodes'}, $uciinfo{'nps'}, $uciinfo{'depth'};
469                 }
470                 if (exists($uciinfo{'tbhits'})) {
471                         printf ", %u Nalimov hits", $uciinfo{'tbhits'};
472                 }
473                 if (exists($uciinfo{'seldepth'})) {
474                         printf " (%u selective)", $uciinfo{'seldepth'};
475                 }
476                 print  "\n\n";
477         }
478 }
479
480 sub find_kings {
481         my $board = shift;
482         my ($wkr, $wkc, $bkr, $bkc);
483
484         for my $row (0..7) {
485                 for my $col (0..7) {
486                         my $piece = substr($board->[$row], $col, 1);
487                         if ($piece eq 'K') {
488                                 ($wkr, $wkc) = ($row, $col);
489                         } elsif ($piece eq 'k') {
490                                 ($bkr, $bkc) = ($row, $col);
491                         }
492                 }
493         }
494
495         return ($wkr, $wkc, $bkr, $bkc);
496 }
497
498 sub in_mate {
499         my $board = shift;
500         my $check = in_check($board);
501         return 0 if ($check eq 'none');
502
503         # try all possible moves for the side in check
504         for my $row (0..7) {
505                 for my $col (0..7) {
506                         my $piece = substr($board->[$row], $col, 1);
507                         next if ($piece eq '-');
508
509                         if ($check eq 'white') {
510                                 next if ($piece eq lc($piece));
511                         } else {
512                                 next if ($piece eq uc($piece));
513                         }
514
515                         for my $dest_row (0..7) {
516                                 for my $dest_col (0..7) {
517                                         next if ($row == $dest_row && $col == $dest_col);
518                                         next unless (can_reach($board, $piece, $row, $col, $dest_row, $dest_col));
519
520                                         my @nb = @$board;
521                                         substr($nb[$row], $col, 1, '-');
522                                         substr($nb[$dest_row], $dest_col, 1, $piece);
523
524                                         my $new_check = in_check(\@nb);
525                                         return 0 if ($new_check ne $check && $new_check ne 'both');
526                                 }
527                         }
528                 }
529         }
530
531         # nothing to do; mate
532         return 1;
533 }
534
535 sub in_check {
536         my $board = shift;
537         my ($black_check, $white_check) = (0, 0);
538
539         my ($wkr, $wkc, $bkr, $bkc) = find_kings($board);
540
541         # check all pieces for the possibility of threatening the two kings
542         for my $row (0..7) {
543                 for my $col (0..7) {
544                         my $piece = substr($board->[$row], $col, 1);
545                         next if ($piece eq '-' || lc($piece) eq 'k');
546                 
547                         if (uc($piece) eq $piece) {
548                                 # white piece
549                                 $black_check = 1 if (can_reach($board, $piece, $row, $col, $bkr, $bkc));
550                         } else {
551                                 # black piece
552                                 $white_check = 1 if (can_reach($board, $piece, $row, $col, $wkr, $wkc));
553                         }
554                 }
555         }
556
557         if ($black_check && $white_check) {
558                 return 'both';
559         } elsif ($black_check) {
560                 return 'black';
561         } elsif ($white_check) {
562                 return 'white';
563         } else {
564                 return 'none';
565         }
566 }
567
568 sub can_reach {
569         my ($board, $piece, $from_row, $from_col, $to_row, $to_col) = @_;
570         
571         # can't eat your own piece
572         my $dest_piece = substr($board->[$to_row], $to_col, 1);
573         if ($dest_piece ne '-') {
574                 return 0 if (($piece eq lc($piece)) == ($dest_piece eq lc($dest_piece)));
575         }
576
577         if (lc($piece) eq 'k') {
578                 return (abs($from_row - $to_row) <= 1 && abs($from_col - $to_col) <= 1);
579         }
580         if (lc($piece) eq 'r') {
581                 return 0 unless ($from_row == $to_row || $from_col == $to_col);
582
583                 # check that there's a clear passage
584                 if ($from_row == $to_row) {
585                         if ($from_col > $to_col) {
586                                 ($to_col, $from_col) = ($from_col, $to_col);
587                         }
588
589                         for my $c (($from_col+1)..($to_col-1)) {
590                                 my $middle_piece = substr($board->[$to_row], $c, 1);
591                                 return 0 if ($middle_piece ne '-');     
592                         }
593
594                         return 1;
595                 } else {
596                         if ($from_row > $to_row) {
597                                 ($to_row, $from_row) = ($from_row, $to_row);
598                         }
599
600                         for my $r (($from_row+1)..($to_row-1)) {
601                                 my $middle_piece = substr($board->[$r], $to_col, 1);
602                                 return 0 if ($middle_piece ne '-');     
603                         }
604
605                         return 1;
606                 }
607         }
608         if (lc($piece) eq 'b') {
609                 return 0 unless (abs($from_row - $to_row) == abs($from_col - $to_col));
610
611                 my $dr = ($to_row - $from_row) / abs($to_row - $from_row);
612                 my $dc = ($to_col - $from_col) / abs($to_col - $from_col);
613
614                 my $r = $from_row + $dr;
615                 my $c = $from_col + $dc;
616
617                 while ($r != $to_row) {
618                         my $middle_piece = substr($board->[$r], $c, 1);
619                         return 0 if ($middle_piece ne '-');
620                         
621                         $r += $dr;
622                         $c += $dc;
623                 }
624
625                 return 1;
626         }
627         if (lc($piece) eq 'n') {
628                 my $diff_r = abs($from_row - $to_row);
629                 my $diff_c = abs($from_col - $to_col);
630                 return 1 if ($diff_r == 2 && $diff_c == 1);
631                 return 1 if ($diff_r == 1 && $diff_c == 2);
632                 return 0;
633         }
634         if ($piece eq 'q') {
635                 return (can_reach($board, 'r', $from_row, $from_col, $to_row, $to_col) ||
636                         can_reach($board, 'b', $from_row, $from_col, $to_row, $to_col));
637         }
638         if ($piece eq 'Q') {
639                 return (can_reach($board, 'R', $from_row, $from_col, $to_row, $to_col) ||
640                         can_reach($board, 'B', $from_row, $from_col, $to_row, $to_col));
641         }
642         if ($piece eq 'p') {
643                 # black pawn
644                 if ($to_col == $from_col && $to_row == $from_row + 1) {
645                         return ($dest_piece eq '-');
646                 }
647                 if (abs($to_col - $from_col) == 1 && $to_row == $from_row + 1) {
648                         return ($dest_piece ne '-');
649                 }
650                 return 0;
651         }
652         if ($piece eq 'P') {
653                 # white pawn
654                 if ($to_col == $from_col && $to_row == $from_row - 1) {
655                         return ($dest_piece eq '-');
656                 }
657                 if (abs($to_col - $from_col) == 1 && $to_row == $from_row - 1) {
658                         return ($dest_piece ne '-');
659                 }
660                 return 0;
661         }
662         
663         # unknown piece
664         return 0;
665 }
666
667 sub uciprint {
668         my $msg = shift;
669         print UCIWRITE "$msg\n";
670         print UCILOG "=> $msg\n";
671 }