shogi_server/game.rb

   1 ## $Id$
   2
   3 ## Copyright (C) 2004 NABEYA Kenichi (aka nanami@2ch)
   4 ## Copyright (C) 2007-2008 Daigo Moriwaki (daigo at debian dot org)
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 2 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, write to the Free Software
  18 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20 require 'shogi_server/league/floodgate'
  21 require 'observer'
  22
  23 module ShogiServer # for a namespace
  24
  25 # MonitorObserver obserers GameResult to send messages to the monotors
  26 # watching the game
  27 #
  28 class MonitorObserver
  29   def update(game_result)
  30     game_result.game.each_monitor do |monitor|
  31       monitor.write_safe("##[MONITOR][%s] %s\n" % [game_result.game.game_id, game_result.type])
  32     end
  33   end
  34 end
  35
  36 # Base class for a game result
  37 #
  38 class GameResult
  39   include Observable
  40
  41   # Game object
  42   attr_reader :game
  43   # Array of players
  44   attr_reader :players
  45   # Black player object
  46   attr_reader :black
  47   # White plyer object
  48   attr_reader :white
  49   # Command to send monitors such as '%%TORYO' etc...
  50   attr_reader :result_type
  51
  52   def initialize(game, p1, p2)
  53     @game = game
  54     @players = [p1, p2]
  55     if p1.sente && !p2.sente
  56       @black, @white = p1, p2
  57     elsif !p1.sente && p2.sente
  58       @black, @white = p2, p1
  59     else
  60       raise "Never reached!"
  61     end
  62     @players.each do |player|
  63       player.status = "connected"
  64     end
  65     @result_type = ""
  66
  67     regist_observers
  68   end
  69
  70   def regist_observers
  71     add_observer MonitorObserver.new
  72
  73     if League::Floodgate.game_name?(@game.game_name) &&
  74        @game.sente.player_id &&
  75        @game.gote.player_id &&
  76        $options["floodgate-history"]
  77       add_observer League::Floodgate::History.factory
  78     end
  79   end
  80
  81   def process
  82     raise "Implement me!"
  83   end
  84
  85   def notify
  86     changed
  87     notify_observers(self)
  88   end
  89
  90   def log(str)
  91     @game.log_game(str)
  92   end
  93
  94   def log_board
  95     log(@game.board.to_s.gsub(/^/, "\'"))
  96   end
  97
  98 end
  99
 100 class GameResultWin < GameResult
 101   attr_reader :winner, :loser
 102
 103   def initialize(game, winner, loser)
 104     super
 105     @winner, @loser = winner, loser
 106     @winner.last_game_win = true
 107     @loser.last_game_win  = false
 108   end
 109
 110   def log_summary(type)
 111     log_board
 112
 113     black_result = white_result = ""
 114     if @black == @winner
 115       black_result = "win"
 116       white_result = "lose"
 117     else
 118       black_result = "lose"
 119       white_result = "win"
 120     end
 121     log("'summary:%s:%s %s:%s %s\n" % [type,
 122                                        @black.name, black_result,
 123                                        @white.name, white_result])
 124
 125   end
 126 end
 127
 128 class GameResultAbnormalWin < GameResultWin
 129   def process
 130     @winner.write_safe("%TORYO\n#RESIGN\n#WIN\n")
 131     @loser.write_safe( "%TORYO\n#RESIGN\n#LOSE\n")
 132     log("%%TORYO\n")
 133     log_summary("abnormal")
 134     @result_type = "%%TORYO"
 135     notify
 136   end
 137 end
 138
 139 class GameResultTimeoutWin < GameResultWin
 140   def process
 141     @winner.write_safe("#TIME_UP\n#WIN\n")
 142     @loser.write_safe( "#TIME_UP\n#LOSE\n")
 143     log_summary("time up")
 144     @result_type = "#TIME_UP"
 145     notify
 146   end
 147 end
 148
 149 # A player declares (successful) Kachi
 150 class GameResultKachiWin < GameResultWin
 151   def process
 152     @winner.write_safe("%KACHI\n#JISHOGI\n#WIN\n")
 153     @loser.write_safe( "%KACHI\n#JISHOGI\n#LOSE\n")
 154     log("%%KACHI\n")
 155     log_summary("kachi")
 156     @result_type = "%%KACHI"
 157     notify
 158   end
 159 end
 160
 161 # A player declares wrong Kachi
 162 class GameResultIllegalKachiWin < GameResultWin
 163   def process
 164     @winner.write_safe("%KACHI\n#ILLEGAL_MOVE\n#WIN\n")
 165     @loser.write_safe( "%KACHI\n#ILLEGAL_MOVE\n#LOSE\n")
 166     log("%%KACHI\n")
 167     log_summary("illegal kachi")
 168     @result_type = "%%KACHI"
 169     notify
 170   end
 171 end
 172
 173 class GameResultIllegalWin < GameResultWin
 174   def initialize(game, winner, loser, cause)
 175     super(game, winner, loser)
 176     @cause = cause
 177   end
 178
 179   def process
 180     @winner.write_safe("#ILLEGAL_MOVE\n#WIN\n")
 181     @loser.write_safe( "#ILLEGAL_MOVE\n#LOSE\n")
 182     log_summary(@cause)
 183     @result_type = "#ILLEGAL_MOVE"
 184     notify
 185   end
 186 end
 187
 188 class GameResultIllegalMoveWin < GameResultIllegalWin
 189   def initialize(game, winner, loser)
 190     super(game, winner, loser, "illegal move")
 191   end
 192 end
 193
 194 class GameResultUchifuzumeWin < GameResultIllegalWin
 195   def initialize(game, winner, loser)
 196     super(game, winner, loser, "uchifuzume")
 197   end
 198 end
 199
 200 class GameResultOuteKaihiMoreWin < GameResultWin
 201   def initialize(game, winner, loser)
 202     super(game, winner, loser, "oute_kaihimore")
 203   end
 204 end
 205
 206 class GameResultOutoriWin < GameResultWin
 207   def initialize(game, winner, loser)
 208     super(game, winner, loser, "outori")
 209   end
 210 end
 211
 212 class GameReulstToryoWin < GameResultWin
 213   def process
 214     @winner.write_safe("%TORYO\n#RESIGN\n#WIN\n")
 215     @loser.write_safe( "%TORYO\n#RESIGN\n#LOSE\n")
 216     log("%%TORYO\n")
 217     log_summary("toryo")
 218     @result_type = "%%TORYO"
 219     notify
 220   end
 221 end
 222
 223 class GameResultOuteSennichiteWin < GameResultWin
 224   def process
 225     @winner.write_safe("#OUTE_SENNICHITE\n#WIN\n")
 226     @loser.write_safe( "#OUTE_SENNICHITE\n#LOSE\n")
 227     log_summary("oute_sennichite")
 228     @result_type = "#OUTE_SENNICHITE"
 229     notify
 230   end
 231 end
 232
 233 class GameResultDraw < GameResult
 234   def initialize(game, p1, p2)
 235     super
 236     p1.last_game_win = false
 237     p2.last_game_win = false
 238   end
 239
 240   def log_summary(type)
 241     log_board
 242     log("'summary:%s:%s draw:%s draw\n" % [type, @black.name, @white.name])
 243   end
 244 end
 245
 246 class GameResultSennichiteDraw < GameResultDraw
 247   def process
 248     @players.each do |player|
 249       player.write_safe("#SENNICHITE\n#DRAW\n")
 250     end
 251     log_summary("sennichite")
 252     @result_type = "#SENNICHITE"
 253     notify
 254   end
 255 end
 256
 257 class Game
 258   @@mutex = Mutex.new
 259   @@time  = 0
 260
 261   def initialize(game_name, player0, player1)
 262     @monitors = Array::new
 263     @game_name = game_name
 264     if (@game_name =~ /-(\d+)-(\d+)$/)
 265       @total_time = $1.to_i
 266       @byoyomi = $2.to_i
 267     end
 268
 269     if (player0.sente)
 270       @sente, @gote = player0, player1
 271     else
 272       @sente, @gote = player1, player0
 273     end
 274     @sente.socket_buffer.clear
 275     @gote.socket_buffer.clear
 276     @current_player, @next_player = @sente, @gote
 277     @sente.game = self
 278     @gote.game  = self
 279
 280     @last_move = ""
 281     @current_turn = 0
 282
 283     @sente.status = "agree_waiting"
 284     @gote.status  = "agree_waiting"
 285
 286     @game_id = sprintf("%s+%s+%s+%s+%s",
 287                   LEAGUE.event, @game_name,
 288                   @sente.name, @gote.name, issue_current_time)
 289
 290     now = Time.now
 291     log_dir_name = File.join(LEAGUE.dir,
 292                              now.strftime("%Y"),
 293                              now.strftime("%m"),
 294                              now.strftime("%d"))
 295     FileUtils.mkdir_p(log_dir_name) unless File.exist?(log_dir_name)
 296     @logfile = File.join(log_dir_name, @game_id + ".csa")
 297
 298     LEAGUE.games[@game_id] = self
 299
 300     log_message(sprintf("game created %s", @game_id))
 301
 302     @board = Board::new
 303     @board.initial
 304     @start_time = nil
 305     @fh = open(@logfile, "w")
 306     @fh.sync = true
 307     @result = nil
 308
 309     propose
 310   end
 311   attr_accessor :game_name, :total_time, :byoyomi, :sente, :gote, :game_id, :board, :current_player, :next_player, :fh, :monitors
 312   attr_accessor :last_move, :current_turn
 313   attr_reader   :result
 314
 315   def rated?
 316     @sente.rated? && @gote.rated?
 317   end
 318
 319   def turn?(player)
 320     return player.status == "game" && @current_player == player
 321   end
 322
 323   def monitoron(monitor)
 324     @monitors.delete(monitor)
 325     @monitors.push(monitor)
 326   end
 327
 328   def monitoroff(monitor)
 329     @monitors.delete(monitor)
 330   end
 331
 332   def each_monitor
 333     @monitors.each do |monitor|
 334       yield monitor
 335     end
 336   end
 337
 338   def log_game(str)
 339     if @fh.closed?
 340       log_error("Failed to write to Game[%s]'s log file: %s" %
 341                 [@game_id, str])
 342     end
 343     @fh.printf("%s\n", str)
 344   end
 345
 346   def reject(rejector)
 347     @sente.write_safe(sprintf("REJECT:%s by %s\n", @game_id, rejector))
 348     @gote.write_safe(sprintf("REJECT:%s by %s\n", @game_id, rejector))
 349     finish
 350   end
 351
 352   def kill(killer)
 353     if ["agree_waiting", "start_waiting"].include?(@sente.status)
 354       reject(killer.name)
 355     elsif (@current_player == killer)
 356       result = GameResultAbnormalWin.new(self, @next_player, @current_player)
 357       result.process
 358       finish
 359     end
 360   end
 361
 362   def finish
 363     log_message(sprintf("game finished %s", @game_id))
 364     @fh.printf("'$END_TIME:%s\n", Time::new.strftime("%Y/%m/%d %H:%M:%S"))
 365     @fh.close
 366
 367     @sente.game = nil
 368     @gote.game = nil
 369     @sente.status = "connected"
 370     @gote.status = "connected"
 371
 372     if (@current_player.protocol == LoginCSA::PROTOCOL)
 373       @current_player.finish
 374     end
 375     if (@next_player.protocol == LoginCSA::PROTOCOL)
 376       @next_player.finish
 377     end
 378     @monitors = Array::new
 379     @sente = nil
 380     @gote = nil
 381     @current_player = nil
 382     @next_player = nil
 383     LEAGUE.games.delete(@game_id)
 384   end
 385
 386   # class Game
 387   def handle_one_move(str, player)
 388     unless turn?(player)
 389       return false if str == :timeout
 390
 391       @fh.puts("'Deferred %s" % [str])
 392       log_warning("Deferred a move [%s] scince it is not %s 's turn." %
 393                   [str, player.name])
 394       player.socket_buffer << str # always in the player's thread
 395       return nil
 396     end
 397
 398     finish_flag = true
 399     @end_time = Time::new
 400     t = [(@end_time - @start_time).floor, Least_Time_Per_Move].max
 401
 402     move_status = nil
 403     if ((@current_player.mytime - t <= -@byoyomi) &&
 404         ((@total_time > 0) || (@byoyomi > 0)))
 405       status = :timeout
 406     elsif (str == :timeout)
 407       return false            # time isn't expired. players aren't swapped. continue game
 408     else
 409       @current_player.mytime -= t
 410       if (@current_player.mytime < 0)
 411         @current_player.mytime = 0
 412       end
 413
 414       move_status = @board.handle_one_move(str, @sente == @current_player)
 415       # log_debug("move_status: %s for %s's %s" % [move_status, @sente == @current_player ? "BLACK" : "WHITE", str])
 416
 417       if [:illegal, :uchifuzume, :oute_kaihimore].include?(move_status)
 418         @fh.printf("'ILLEGAL_MOVE(%s)\n", str)
 419       else
 420         if [:normal, :outori, :sennichite, :oute_sennichite_sente_lose, :oute_sennichite_gote_lose].include?(move_status)
 421           # Thinking time includes network traffic
 422           @sente.write_safe(sprintf("%s,T%d\n", str, t))
 423           @gote.write_safe(sprintf("%s,T%d\n", str, t))
 424           @fh.printf("%s\nT%d\n", str, t)
 425           @last_move = sprintf("%s,T%d", str, t)
 426           @current_turn += 1
 427         end
 428
 429         @monitors.each do |monitor|
 430           monitor.write_safe(show.gsub(/^/, "##[MONITOR][#{@game_id}] "))
 431           monitor.write_safe(sprintf("##[MONITOR][%s] +OK\n", @game_id))
 432         end
 433       end
 434     end
 435
 436     result = nil
 437     if (@next_player.status != "game") # rival is logout or disconnected
 438       result = GameResultAbnormalWin.new(self, @current_player, @next_player)
 439     elsif (status == :timeout)
 440       # current_player losed
 441       result = GameResultTimeoutWin.new(self, @next_player, @current_player)
 442     elsif (move_status == :illegal)
 443       result = GameResultIllegalMoveWin.new(self, @next_player, @current_player)
 444     elsif (move_status == :kachi_win)
 445       result = GameResultKachiWin.new(self, @current_player, @next_player)
 446     elsif (move_status == :kachi_lose)
 447       result = GameResultIllegalKachiWin.new(self, @next_player, @current_player)
 448     elsif (move_status == :toryo)
 449       result = GameReulstToryoWin.new(self, @next_player, @current_player)
 450     elsif (move_status == :outori)
 451       # The current player captures the next player's king
 452       result = GameResultOutoriWin.new(self, @current_player, @next_player)
 453     elsif (move_status == :oute_sennichite_sente_lose)
 454       result = GameResultOuteSennichiteWin.new(self, @gote, @sente) # Sente is checking
 455     elsif (move_status == :oute_sennichite_gote_lose)
 456       result = GameResultOuteSennichiteWin.new(self, @sente, @gote) # Gote is checking
 457     elsif (move_status == :sennichite)
 458       result = GameResultSennichiteDraw.new(self, @current_player, @next_player)
 459     elsif (move_status == :uchifuzume)
 460       # the current player losed
 461       result = GameResultUchifuzumeWin.new(self, @next_player, @current_player)
 462     elsif (move_status == :oute_kaihimore)
 463       # the current player losed
 464       result = GameResultOuteKaihiMoreWin.new(self, @next_player, @current_player)
 465     else
 466       finish_flag = false
 467     end
 468     result.process if result
 469     finish() if finish_flag
 470     @current_player, @next_player = @next_player, @current_player
 471     @start_time = Time::new
 472     return finish_flag
 473   end
 474
 475   def start
 476     log_message(sprintf("game started %s", @game_id))
 477     @sente.write_safe(sprintf("START:%s\n", @game_id))
 478     @gote.write_safe(sprintf("START:%s\n", @game_id))
 479     @sente.mytime = @total_time
 480     @gote.mytime = @total_time
 481     @start_time = Time::new
 482   end
 483
 484   def propose
 485     @fh.puts("V2")
 486     @fh.puts("N+#{@sente.name}")
 487     @fh.puts("N-#{@gote.name}")
 488     @fh.puts("$EVENT:#{@game_id}")
 489
 490     @sente.write_safe(propose_message("+"))
 491     @gote.write_safe(propose_message("-"))
 492
 493     now = Time::new.strftime("%Y/%m/%d %H:%M:%S")
 494     @fh.puts("$START_TIME:#{now}")
 495     @fh.print <<EOM
 496 P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
 497 P2 * -HI *  *  *  *  * -KA *
 498 P3-FU-FU-FU-FU-FU-FU-FU-FU-FU
 499 P4 *  *  *  *  *  *  *  *  *
 500 P5 *  *  *  *  *  *  *  *  *
 501 P6 *  *  *  *  *  *  *  *  *
 502 P7+FU+FU+FU+FU+FU+FU+FU+FU+FU
 503 P8 * +KA *  *  *  *  * +HI *
 504 P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
 505 +
 506 EOM
 507     if rated?
 508       black_name = @sente.rated? ? @sente.player_id : @sente.name
 509       white_name = @gote.rated?  ? @gote.player_id  : @gote.name
 510       @fh.puts("'rating:%s:%s" % [black_name, white_name])
 511     end
 512   end
 513
 514   def show()
 515     str0 = <<EOM
 516 BEGIN Game_Summary
 517 Protocol_Version:1.1
 518 Protocol_Mode:Server
 519 Format:Shogi 1.0
 520 Declaration:Jishogi 1.1
 521 Game_ID:#{@game_id}
 522 Name+:#{@sente.name}
 523 Name-:#{@gote.name}
 524 Rematch_On_Draw:NO
 525 To_Move:+
 526 BEGIN Time
 527 Time_Unit:1sec
 528 Total_Time:#{@total_time}
 529 Byoyomi:#{@byoyomi}
 530 Least_Time_Per_Move:#{Least_Time_Per_Move}
 531 Remaining_Time+:#{@sente.mytime}
 532 Remaining_Time-:#{@gote.mytime}
 533 Last_Move:#{@last_move}
 534 Current_Turn:#{@current_turn}
 535 END Time
 536 BEGIN Position
 537 EOM
 538
 539     str1 = <<EOM
 540 END Position
 541 END Game_Summary
 542 EOM
 543
 544     return str0 + @board.to_s + str1
 545   end
 546
 547   def propose_message(sg_flag)
 548     str = <<EOM
 549 BEGIN Game_Summary
 550 Protocol_Version:1.1
 551 Protocol_Mode:Server
 552 Format:Shogi 1.0
 553 Declaration:Jishogi 1.1
 554 Game_ID:#{@game_id}
 555 Name+:#{@sente.name}
 556 Name-:#{@gote.name}
 557 Your_Turn:#{sg_flag}
 558 Rematch_On_Draw:NO
 559 To_Move:+
 560 BEGIN Time
 561 Time_Unit:1sec
 562 Total_Time:#{@total_time}
 563 Byoyomi:#{@byoyomi}
 564 Least_Time_Per_Move:#{Least_Time_Per_Move}
 565 END Time
 566 BEGIN Position
 567 P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
 568 P2 * -HI *  *  *  *  * -KA *
 569 P3-FU-FU-FU-FU-FU-FU-FU-FU-FU
 570 P4 *  *  *  *  *  *  *  *  *
 571 P5 *  *  *  *  *  *  *  *  *
 572 P6 *  *  *  *  *  *  *  *  *
 573 P7+FU+FU+FU+FU+FU+FU+FU+FU+FU
 574 P8 * +KA *  *  *  *  * +HI *
 575 P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
 576 P+
 577 P-
 578 +
 579 END Position
 580 END Game_Summary
 581 EOM
 582     return str
 583   end
 584
 585   private
 586
 587   def issue_current_time
 588     time = Time::new.strftime("%Y%m%d%H%M%S").to_i
 589     @@mutex.synchronize do
 590       while time <= @@time do
 591         time += 1
 592       end
 593       @@time = time
 594     end
 595   end
 596 end
 597
 598 end # ShogiServer