src/icsconnection.cpp

   1 /*
   2   Copyright (c) 2006 Paolo Capriotti <p.capriotti@sns.it>
   3             (c) 2006 Maurizio Monge <maurizio.monge@kdemail.net>
   4
   5   This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or
   8   (at your option) any later version.
   9 */
  10
  11 #include <iostream>
  12 #include <QRegExp>
  13 #include <QStringList>
  14
  15 #include "icsconnection.h"
  16 #include "poolinfo.h"
  17 #include "positioninfo.h"
  18 #include "algebraicnotation.h"
  19 #include "player.h"
  20 #include "gameinfo.h"
  21 #include "pgnparser.h"
  22 #include "icslistener.h"
  23 #include "variants/variants.h"
  24
  25 using namespace boost;
  26
  27 QRegExp ICSConnection::pressReturn("^Press return to enter the server as \"\\S+\":");
  28
  29 // example: Creating: azsxdc (++++) Hispanico (1684) unrated crazyhouse 3 0
  30 QRegExp ICSConnection::creating("^Creating: (\\S+)\\s+\\((\\S*)\\)\\s+(\\S+)\\s+\\((\\S*)\\)"
  31                               "\\s+(\\S+)\\s+(\\S+)\\s+(\\d+)\\s+(\\d+)\\s*.*$");
  32
  33 // example: {Game 149 (azsxdc vs. Hispanico) Creating unrated crazyhouse match.}
  34 // example: {Game 149 (azsxdc vs. Hispanico) Game aborted on move 1} *
  35 QRegExp ICSConnection::game("^\\{Game\\s+(\\d+)\\s+\\((\\S+)\\s+vs\\.\\s+(\\S+)\\)\\s+"
  36                                            "(\\S+.*)\\}(?:\\s+(\\S+.*)|\\s*)$");
  37 QRegExp ICSConnection::unexamine("^You\\s+are\\s+no\\s+longer\\s+examining\\s+game\\s+(\\d+)");
  38 QRegExp ICSConnection::unobserve("^Removing\\s+game\\s+(\\d+)\\s+from\\s+observation\\s+list\\s*");
  39
  40 // example: 124  848 shanmark    1155 damopn     [ br  2  12]   2:04 -  2:08 (39-39) W:  3
  41 //QRegExp ICSConnection::gameInfo("^(\\d+)\\s+(\\S+)\\s+(\\S+)\\s+(\\S+)\\s+(\\S+)\\s+"
  42 //                                              "\\[\\s+(\\S+)\\s+(\\d+)\\s+(\\d+)\\s+\\]");
  43
  44 //                 1     2        3     4      5       6     7  8  9
  45 // example: Game 124: shanmark ( 848) damopn (1155) rated blitz 2 12
  46 //          Game 170: AstralVision (2167) vladx (2197) rated standard 15 0
  47 QRegExp ICSConnection::observed_game("^Game\\s+(\\d+):\\s+(\\S+)\\s+\\(\\s*(\\S+)\\s*\\)\\s+"
  48                                                      "(\\S+)\\s+\\(\\s*(\\S+)\\s*\\)\\s+"
  49                                                      "(\\S+)\\s+(\\S+)\\s+(\\d+)\\s+(\\d+)");
  50
  51 QRegExp ICSConnection::login("^login: $");
  52 QRegExp ICSConnection::password("^password: $");
  53 QRegExp ICSConnection::fics("^\\S+% ");
  54 QRegExp ICSConnection::beep("^\a");
  55
  56 //ex: Movelist for game 95:
  57 QRegExp ICSConnection::move_list_start("^Movelist\\s+for\\s+game\\s+(\\d+):");
  58 //ex: npssnt (1586) vs. mikkk (1487) --- Sun Sep  3, 18:16 PDT 2006
  59 QRegExp ICSConnection::move_list_players("^(\\S+)\\s+\\((\\S*)\\)\\s+vs.\\s+(\\S+)\\s+\\((\\S*)\\)\\s*.*");
  60 //ex: Unrated blitz match, initial time: 3 minutes, increment: 0 seconds.
  61 QRegExp ICSConnection::move_list_game("^(\\S+)\\s+(\\S+)\\s+.*initial\\s+time:\\s*(\\d+)"
  62                                                        "\\s+.*increment:\\s*(\\d+)\\s*.*");
  63 //ex: Move  npssnt             mikkk
  64 QRegExp ICSConnection::move_list_ignore1("^Move\\s+(\\S+)\\s+(\\S+)");
  65 //ex: ----  ----------------   ----------------
  66 QRegExp ICSConnection::move_list_ignore2("^( +|-+)+");
  67 QRegExp ICSConnection::move_list_terminator("^\\s*$");
  68
  69 QRegExp ICSConnection::goForward("^Game (\\d+): (\\S+) goes forward (\\d+) moves?\\.");
  70 QRegExp ICSConnection::goBack("^Game (\\d+): (\\S+) backs up (\\d+) moves?\\.");
  71
  72
  73 ICSConnection::ICSConnection()
  74 : incomingGameInfo(0)
  75 , m_move_list_game_info(NULL)
  76 , m_move_list_position_info(NULL)
  77 , m_move_list_pool_info(NULL) {
  78   state = Normal;
  79   connect(this, SIGNAL(receivedLine(QString, int)), this, SLOT(process(QString)));
  80   connect(this, SIGNAL(receivedText(QString, int)), this, SLOT(processPartialLine(QString)));
  81 }
  82
  83 bool ICSConnection::test(const QRegExp& pattern, const QString& str) {
  84   if (pattern.indexIn(str, m_processed_offset, QRegExp::CaretAtOffset) >= 0) {
  85     m_processed_offset = pattern.matchedLength();
  86     return true;
  87   }
  88   else return false;
  89 }
  90
  91 void ICSConnection::processPartialLine(QString str) {
  92 //  std::cout << "processing (partial) " << str << std::endl;
  93   if (test(fics, str)) {
  94 //    std::cout << "matched prompt" << std::endl;
  95     prompt();
  96   }
  97   else if (test(beep, str)) {
  98     notification();
  99   }
 100   else if (test(pressReturn, str)) {
 101     registeredNickname();
 102   }
 103   else if (test(login, str)) {
 104     loginPrompt();
 105   }
 106   else if (test(password, str)) {
 107     passwordPrompt();
 108   }
 109   else {
 110     // no match, but it could be a partial command
 111     m_processed_offset = 0;
 112   }
 113 }
 114
 115 void ICSConnection::process(QString str) {
 116   switch(state) {
 117   case Normal:
 118     if (test(creating, str)) {
 119       delete incomingGameInfo;
 120       incomingGameInfo = new GameInfo(creating, 1);
 121     }
 122     else if(test(observed_game, str)) {
 123       if(incomingGameInfo)
 124         delete incomingGameInfo;
 125       incomingGameInfo = new GameInfo(Player(observed_game.cap(2), observed_game.cap(3).toInt()),
 126                                           Player(observed_game.cap(4), observed_game.cap(5).toInt()),
 127                                           observed_game.cap(6), observed_game.cap(7),
 128                                           observed_game.cap(8).toInt(), observed_game.cap(9).toInt() );
 129       int number = observed_game.cap(1).toInt();
 130       incomingGameInfo->setGameNumber(number);
 131       m_games[number] = ICSGameData(-1, incomingGameInfo->type());
 132       //std::cout << "ok, obs " << number << " of type " << incomingGameInfo->type() << std::endl;
 133     }
 134     else if (test(game, str)) {
 135       //std::cout << "matched game. incomingGameInfo = " << incomingGameInfo << std::endl;
 136       if(game.cap(4).startsWith("Creating") || game.cap(4).startsWith("Continuing") ) {
 137         if (!incomingGameInfo) {
 138           //this should really never happen, but anyway...
 139           QStringList info = game.cap(4).split(' ');
 140           if(info.size() >= 3)
 141             incomingGameInfo = new GameInfo(Player(game.cap(2), 0),
 142                                           Player(game.cap(3), 0),
 143                                           info[1], info[2], 0, 0 );
 144         }
 145         if (incomingGameInfo) {
 146           int number = game.cap(1).toInt();
 147           incomingGameInfo->setGameNumber(number);
 148           m_games.insert(std::make_pair(number, ICSGameData(-1, incomingGameInfo->type())));
 149         }
 150       }
 151       else {
 152         if (!incomingGameInfo) {
 153           int number = game.cap(1).toInt();
 154           //std::cout << "matching game " << number << " end" << std::endl;
 155           m_games.erase(number);
 156           QString what = game.cap(4);
 157           QString result = game.cap(5);
 158           endingGame(what, result);
 159         }
 160       }
 161     }
 162     else if (test(unexamine, str)) {
 163       //std::cout << "matching examined game end" << std::endl;
 164       int gameNumber = unexamine.cap(1).toInt();
 165       m_games.erase(gameNumber);
 166       endingExaminedGame(gameNumber);
 167     }
 168     else if (test(unobserve, str)) {
 169       int gameNumber = unobserve.cap(1).toInt();
 170       m_games.erase(gameNumber);
 171       endingObservedGame(gameNumber);
 172     }
 173     else if (test(move_list_start, str)) {
 174       //std::cout << "entering move list state" << std::endl;
 175       m_move_list_game_num = move_list_start.cap(1).toInt();
 176       state = MoveListHeader;
 177     }
 178     else {
 179       PositionInfo positionInfo(m_games, str);
 180       if (positionInfo.valid) {
 181         // if this is the first style12 for this game, notify game creation
 182         int gameNumber = positionInfo.gameNumber;
 183         bool game_start =  ( !m_games.count(gameNumber)
 184                             || (incomingGameInfo &&
 185                               (incomingGameInfo->gameNumber() == gameNumber
 186                                 || incomingGameInfo->gameNumber()==-1) ) );
 187
 188         if (game_start) {
 189           //std::cout << "notifying game creation" << std::endl;
 190           if(!m_games.count(gameNumber))
 191             m_games[gameNumber] = ICSGameData(-1, "unknown"); //???
 192
 193           if (incomingGameInfo && (incomingGameInfo->gameNumber() != -1)
 194                 && (incomingGameInfo->gameNumber() != gameNumber) ) {
 195             m_games.erase(incomingGameInfo->gameNumber());
 196             delete incomingGameInfo;
 197             incomingGameInfo = NULL; // discard game info
 198           }
 199
 200           if (!incomingGameInfo) {
 201             std::cout << "warning, got unexpected style12!!! " << gameNumber << std::endl;
 202             incomingGameInfo = new GameInfo(Player(positionInfo.whitePlayer, 0),
 203                                           Player(positionInfo.blackPlayer, 0),
 204                                           "rated", "unknown", 0, 0 );
 205           }
 206
 207           switch (positionInfo.relation) {
 208             case PositionInfo::NotMyMove:
 209             case PositionInfo::MyMove:
 210               //std::cout << "creating game" << std::endl;
 211               creatingGame(incomingGameInfo, positionInfo);
 212               break;
 213             case PositionInfo::Examining:
 214               //std::cout << "creating examination" << std::endl;
 215               creatingExaminedGame(incomingGameInfo, positionInfo);
 216               break;
 217             case PositionInfo::ObservingPlayed:
 218             case PositionInfo::ObservingExamined:
 219               //std::cout << "creating obs " << gameNumber << " " << incomingGameInfo->type() << std::endl;
 220               creatingObservedGame(incomingGameInfo, positionInfo);
 221               break;
 222             default:
 223               // unknown relation: ignoring
 224               break;
 225           }
 226           delete incomingGameInfo;
 227           incomingGameInfo = NULL;
 228         }
 229
 230         m_games[positionInfo.gameNumber].index = positionInfo.index();
 231         if (shared_ptr<ICSListener> listener = m_games[positionInfo.gameNumber].listener.lock())
 232           listener->notifyStyle12(positionInfo, game_start);
 233 //        time(positionInfo.whiteTime, positionInfo.blackTime);
 234         if (positionInfo.relation == PositionInfo::MyMove) {
 235           notification();
 236         }
 237       }
 238       else {
 239         PoolInfo pool_info(m_games, str);
 240         if (pool_info.m_valid) {
 241           // BROKEN
 242           if (!pool_info.m_added_piece) {
 243             if (shared_ptr<ICSListener> listener = m_games[pool_info.m_game_num].listener.lock())
 244               listener->notifyPool(pool_info);
 245           }
 246         }
 247       }
 248     }
 249     break;
 250
 251   case MoveListHeader:
 252     if (test(move_list_players, str)){
 253       //std::cout << "move list players: " << str << std::endl;
 254       m_move_list_players = move_list_players.capturedTexts();
 255     }
 256     else if (test(move_list_game, str)){
 257       //std::cout << "move list game: " << str << std::endl;
 258       if (m_move_list_game_info)
 259         delete m_move_list_game_info;
 260
 261       if (m_move_list_players.size()>=5)
 262         m_move_list_game_info = new GameInfo(
 263                     Player(m_move_list_players[1], m_move_list_players[2].toInt()),
 264                     Player(m_move_list_players[3], m_move_list_players[4].toInt()),
 265                     move_list_game.cap(1).toLower(), move_list_game.cap(2),
 266                     move_list_game.cap(3).toInt(), move_list_game.cap(4).toInt()
 267                 );
 268       else
 269         m_move_list_game_info = new GameInfo( Player("unknown",0), Player("unknown",0),
 270                     move_list_game.cap(1).toLower(), move_list_game.cap(2),
 271                     move_list_game.cap(3).toInt(), move_list_game.cap(4).toInt()
 272                 );
 273       m_move_list_game_info->setGameNumber(m_move_list_game_num);
 274
 275       //NOTE: here is where an unknown variant will be "upgraded" to the correct variant
 276       m_games[m_move_list_game_num].setType(move_list_game.cap(2));
 277     }
 278     else if (test(move_list_terminator, str)) {
 279       //std::cout << "move list ign3: " << str << std::endl;
 280     }
 281     else if (test(move_list_ignore1, str)){
 282       //std::cout << "move list ign1: " << str << std::endl;
 283     }
 284     else if (test(move_list_ignore2, str)) {
 285       //std::cout << "move list ign2: " << str << std::endl;
 286       state = MoveListMoves;
 287     }
 288     else {
 289       PositionInfo pi(m_games, str);
 290       if (pi.valid)
 291         m_move_list_position_info = new PositionInfo(pi);
 292       else {
 293         PoolInfo pooli(m_games, str);
 294         if(pooli.m_valid)
 295           m_move_list_pool_info = new PoolInfo(pooli);
 296       }
 297     }
 298     break;
 299   case MoveListMoves:
 300     if (test(move_list_terminator, str)){
 301       if (shared_ptr<ICSListener> listener = m_games[m_move_list_game_num].listener.lock()) {
 302         AbstractPosition::Ptr p;
 303         if (m_move_list_position_info)
 304           p = m_move_list_position_info->position;
 305         else {
 306           std::map<int, ICSGameData>::const_iterator gi = m_games.find(m_move_list_game_num);
 307           if (gi == m_games.end()) {
 308             ERROR("BUG: Received move list for unknown game  " << m_move_list_game_num);
 309           }
 310           else {
 311             VariantInfo* variant = gi->second.variant;
 312             p = variant->createPosition();
 313             p->setup();
 314           }
 315         }
 316
 317         if (p) {
 318           if (m_move_list_pool_info) {
 319             //BROKEN
 320             //p->setPool(m_move_list_pool_info->m_pool);
 321           }
 322
 323           PGN pgn(m_move_list);
 324           if (!pgn.valid())
 325             std::cout << "parse error on move list" << std::endl;
 326           else
 327             listener->notifyMoveList(m_move_list_game_num, p, pgn);
 328         }
 329       }
 330
 331       if (m_move_list_game_info)
 332         delete m_move_list_game_info;
 333       if (m_move_list_position_info)
 334         delete m_move_list_position_info;
 335       if (m_move_list_pool_info)
 336         delete m_move_list_pool_info;
 337       m_move_list_game_info = NULL;
 338       m_move_list_position_info = NULL;
 339       m_move_list_pool_info = NULL;
 340       m_move_list = QString();
 341       state = Normal;
 342     }
 343     else
 344       m_move_list += str;
 345     break;
 346   }
 347
 348   m_processed_offset = 0;
 349 }
 350
 351 void ICSConnection::setListener(int gameNumber, const weak_ptr<ICSListener>& listener) {
 352   m_games[gameNumber].listener = listener;
 353 }
 354
 355 void ICSConnection::startup() {
 356   sendText("alias $ @");
 357   sendText("iset startpos 1");
 358   sendText("iset ms 1");
 359   sendText("iset lock 1");
 360   sendText("set interface Tagua-0.10 (http://www.tagua-project.org)");
 361   sendText("set style 12");
 362 }
 363