OSDN Git Service

Experimantal implementation for specified games, codenamed Buoy.
[shogi-server/shogi-server.git] / 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.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
80     # TODO take observers from the game object
81     if Buoy.game_name?(@game.game_name)
82       add_observer(BuoyObserver.new)
83     end
84   end
85
86   def process
87     raise "Implement me!"
88   end
89
90   def notify
91     changed
92     notify_observers(self)
93   end
94
95   def log(str)
96     @game.log_game(str)
97   end
98
99   def log_board
100     log(@game.board.to_s.gsub(/^/, "\'").chomp)
101   end
102
103 end
104
105 class GameResultWin < GameResult
106   attr_reader :winner, :loser
107
108   def initialize(game, winner, loser)
109     super
110     @winner, @loser = winner, loser
111     @winner.last_game_win = true
112     @loser.last_game_win  = false
113   end
114
115   def log_summary(type)
116     log_board
117
118     black_result = white_result = ""
119     if @black == @winner
120       black_result = "win"
121       white_result = "lose"
122     else
123       black_result = "lose"
124       white_result = "win"
125     end
126     log("'summary:%s:%s %s:%s %s" % [type, 
127                                      @black.name, black_result,
128                                      @white.name, white_result])
129
130   end
131 end
132
133 class GameResultAbnormalWin < GameResultWin
134   def process
135     @winner.write_safe("%TORYO\n#RESIGN\n#WIN\n")
136     @loser.write_safe( "%TORYO\n#RESIGN\n#LOSE\n")
137     log("%TORYO")
138     log_summary("abnormal")
139     @result_type = "%TORYO"
140     notify
141   end
142 end
143
144 class GameResultTimeoutWin < GameResultWin
145   def process
146     @winner.write_safe("#TIME_UP\n#WIN\n")
147     @loser.write_safe( "#TIME_UP\n#LOSE\n")
148     log_summary("time up")
149     @result_type = "#TIME_UP"
150     notify
151   end
152 end
153
154 # A player declares (successful) Kachi
155 class GameResultKachiWin < GameResultWin
156   def process
157     @winner.write_safe("%KACHI\n#JISHOGI\n#WIN\n")
158     @loser.write_safe( "%KACHI\n#JISHOGI\n#LOSE\n")
159     log("%KACHI")
160     log_summary("kachi")
161     @result_type = "%KACHI"
162     notify
163   end
164 end
165
166 # A player declares wrong Kachi
167 class GameResultIllegalKachiWin < GameResultWin
168   def process
169     @winner.write_safe("%KACHI\n#ILLEGAL_MOVE\n#WIN\n")
170     @loser.write_safe( "%KACHI\n#ILLEGAL_MOVE\n#LOSE\n")
171     log("%KACHI")
172     log_summary("illegal kachi")
173     @result_type = "%KACHI"
174     notify
175   end
176 end
177
178 class GameResultIllegalWin < GameResultWin
179   def initialize(game, winner, loser, cause)
180     super(game, winner, loser)
181     @cause = cause
182   end
183
184   def process
185     @winner.write_safe("#ILLEGAL_MOVE\n#WIN\n")
186     @loser.write_safe( "#ILLEGAL_MOVE\n#LOSE\n")
187     log_summary(@cause)
188     @result_type = "#ILLEGAL_MOVE"
189     notify
190   end
191 end
192
193 class GameResultIllegalMoveWin < GameResultIllegalWin
194   def initialize(game, winner, loser)
195     super(game, winner, loser, "illegal move")
196   end
197 end
198
199 class GameResultUchifuzumeWin < GameResultIllegalWin
200   def initialize(game, winner, loser)
201     super(game, winner, loser, "uchifuzume")
202   end
203 end
204
205 class GameResultOuteKaihiMoreWin < GameResultIllegalWin
206   def initialize(game, winner, loser)
207     super(game, winner, loser, "oute_kaihimore")
208   end
209 end
210
211 class GameResultOutoriWin < GameResultWin
212   def initialize(game, winner, loser)
213     super(game, winner, loser)
214   end
215 end
216
217 class GameResultToryoWin < GameResultWin
218   def process
219     @winner.write_safe("%TORYO\n#RESIGN\n#WIN\n")
220     @loser.write_safe( "%TORYO\n#RESIGN\n#LOSE\n")
221     log("%TORYO")
222     log_summary("toryo")
223     @result_type = "%TORYO"
224     notify
225   end
226 end
227
228 class GameResultOuteSennichiteWin < GameResultWin
229   def process
230     @winner.write_safe("#OUTE_SENNICHITE\n#WIN\n")
231     @loser.write_safe( "#OUTE_SENNICHITE\n#LOSE\n")
232     log_summary("oute_sennichite")
233     @result_type = "#OUTE_SENNICHITE"
234     notify
235   end
236 end
237
238 class GameResultDraw < GameResult
239   def initialize(game, p1, p2)
240     super
241     p1.last_game_win = false
242     p2.last_game_win = false
243   end
244   
245   def log_summary(type)
246     log_board
247     log("'summary:%s:%s draw:%s draw" % [type, @black.name, @white.name])
248   end
249 end
250
251 class GameResultSennichiteDraw < GameResultDraw
252   def process
253     @players.each do |player|
254       player.write_safe("#SENNICHITE\n#DRAW\n")
255     end
256     log_summary("sennichite")
257     @result_type = "#SENNICHITE"
258     notify
259   end
260 end
261
262 class Game
263   # When this duration passes after this object instanciated (i.e.
264   # the agree_waiting or start_waiting state lasts too long),
265   # the game will be rejected by the Server.
266   WAITING_EXPIRATION = 120 # seconds
267
268   @@mutex = Mutex.new
269   @@time  = 0
270   def initialize(game_name, player0, player1, board)
271     @monitors = Array::new
272     @game_name = game_name
273     if (@game_name =~ /-(\d+)-(\d+)$/)
274       @total_time = $1.to_i
275       @byoyomi = $2.to_i
276     end
277
278     if (player0.sente)
279       @sente, @gote = player0, player1
280     else
281       @sente, @gote = player1, player0
282     end
283     @sente.socket_buffer.clear
284     @gote.socket_buffer.clear
285     @board = board
286     if @board.teban
287       @current_player, @next_player = @sente, @gote
288     else
289       @current_player, @next_player = @gote, @sente
290     end
291     @sente.game = self
292     @gote.game  = self
293
294     @last_move = @board.initial_moves.empty? ? "" : "%s,T1" % [@board.initial_moves.last]
295     @current_turn = @board.initial_moves.size
296
297     @sente.status = "agree_waiting"
298     @gote.status  = "agree_waiting"
299
300     @game_id = sprintf("%s+%s+%s+%s+%s", 
301                   $league.event, @game_name, 
302                   @sente.name, @gote.name, issue_current_time)
303     
304     # The time when this Game instance was created.
305     # Don't be confused with @start_time when the game was started to play.
306     @prepared_time = Time.now 
307     log_dir_name = File.join($league.dir, 
308                              @prepared_time.strftime("%Y"),
309                              @prepared_time.strftime("%m"),
310                              @prepared_time.strftime("%d"))
311     FileUtils.mkdir_p(log_dir_name) unless File.exist?(log_dir_name)
312     @logfile = File.join(log_dir_name, @game_id + ".csa")
313
314     $league.games[@game_id] = self
315
316     log_message(sprintf("game created %s", @game_id))
317
318     @start_time = nil
319     @fh = open(@logfile, "w")
320     @fh.sync = true
321     @result = nil
322
323     propose
324   end
325   attr_accessor :game_name, :total_time, :byoyomi, :sente, :gote, :game_id, :board, :current_player, :next_player, :fh, :monitors
326   attr_accessor :last_move, :current_turn
327   attr_reader   :result, :prepared_time
328
329   # Path of a log file for this game.
330   attr_reader   :logfile
331
332   def rated?
333     @sente.rated? && @gote.rated?
334   end
335
336   def turn?(player)
337     return player.status == "game" && @current_player == player
338   end
339
340   def monitoron(monitor)
341     @monitors.delete(monitor)
342     @monitors.push(monitor)
343   end
344
345   def monitoroff(monitor)
346     @monitors.delete(monitor)
347   end
348
349   def each_monitor
350     @monitors.each do |monitor|
351       yield monitor
352     end
353   end
354
355   def log_game(str)
356     if @fh.closed?
357       log_error("Failed to write to Game[%s]'s log file: %s" %
358                 [@game_id, str])
359     end
360     @fh.printf("%s\n", str)
361   end
362
363   def reject(rejector)
364     @sente.write_safe(sprintf("REJECT:%s by %s\n", @game_id, rejector))
365     @gote.write_safe(sprintf("REJECT:%s by %s\n", @game_id, rejector))
366     finish
367   end
368
369   def kill(killer)
370     [@sente, @gote].each do |player|
371       if ["agree_waiting", "start_waiting"].include?(player.status)
372         reject(killer.name)
373         return # return from this method
374       end
375     end
376     
377     if (@current_player == killer)
378       result = GameResultAbnormalWin.new(self, @next_player, @current_player)
379       result.process
380       finish
381     end
382   end
383
384   def finish
385     log_message(sprintf("game finished %s", @game_id))
386     @fh.printf("'$END_TIME:%s\n", Time::new.strftime("%Y/%m/%d %H:%M:%S"))    
387     @fh.close
388
389     @sente.game = nil
390     @gote.game = nil
391     @sente.status = "connected"
392     @gote.status = "connected"
393
394     if (@current_player.protocol == LoginCSA::PROTOCOL)
395       @current_player.finish
396     end
397     if (@next_player.protocol == LoginCSA::PROTOCOL)
398       @next_player.finish
399     end
400     @monitors = Array::new
401     @sente = nil
402     @gote = nil
403     @current_player = nil
404     @next_player = nil
405     $league.games.delete(@game_id)
406   end
407
408   # class Game
409   def handle_one_move(str, player)
410     unless turn?(player)
411       return false if str == :timeout
412
413       @fh.puts("'Deferred %s" % [str])
414       log_warning("Deferred a move [%s] scince it is not %s 's turn." %
415                   [str, player.name])
416       player.socket_buffer << str # always in the player's thread
417       return nil
418     end
419
420     finish_flag = true
421     @end_time = Time::new
422     t = [(@end_time - @start_time).floor, Least_Time_Per_Move].max
423     
424     move_status = nil
425     if ((@current_player.mytime - t <= -@byoyomi) && 
426         ((@total_time > 0) || (@byoyomi > 0)))
427       status = :timeout
428     elsif (str == :timeout)
429       return false            # time isn't expired. players aren't swapped. continue game
430     else
431       @current_player.mytime -= t
432       if (@current_player.mytime < 0)
433         @current_player.mytime = 0
434       end
435
436       move_status = @board.handle_one_move(str, @sente == @current_player)
437       # log_debug("move_status: %s for %s's %s" % [move_status, @sente == @current_player ? "BLACK" : "WHITE", str])
438
439       if [:illegal, :uchifuzume, :oute_kaihimore].include?(move_status)
440         @fh.printf("'ILLEGAL_MOVE(%s)\n", str)
441       else
442         if [:normal, :outori, :sennichite, :oute_sennichite_sente_lose, :oute_sennichite_gote_lose].include?(move_status)
443           # Thinking time includes network traffic
444           @sente.write_safe(sprintf("%s,T%d\n", str, t))
445           @gote.write_safe(sprintf("%s,T%d\n", str, t))
446           @fh.printf("%s\nT%d\n", str, t)
447           @last_move = sprintf("%s,T%d", str, t)
448           @current_turn += 1
449         end
450
451         @monitors.each do |monitor|
452           monitor.write_safe(show.gsub(/^/, "##[MONITOR][#{@game_id}] "))
453           monitor.write_safe(sprintf("##[MONITOR][%s] +OK\n", @game_id))
454         end
455       end
456     end
457
458     result = nil
459     if (@next_player.status != "game") # rival is logout or disconnected
460       result = GameResultAbnormalWin.new(self, @current_player, @next_player)
461     elsif (status == :timeout)
462       # current_player losed
463       result = GameResultTimeoutWin.new(self, @next_player, @current_player)
464     elsif (move_status == :illegal)
465       result = GameResultIllegalMoveWin.new(self, @next_player, @current_player)
466     elsif (move_status == :kachi_win)
467       result = GameResultKachiWin.new(self, @current_player, @next_player)
468     elsif (move_status == :kachi_lose)
469       result = GameResultIllegalKachiWin.new(self, @next_player, @current_player)
470     elsif (move_status == :toryo)
471       result = GameResultToryoWin.new(self, @next_player, @current_player)
472     elsif (move_status == :outori)
473       # The current player captures the next player's king
474       result = GameResultOutoriWin.new(self, @current_player, @next_player)
475     elsif (move_status == :oute_sennichite_sente_lose)
476       result = GameResultOuteSennichiteWin.new(self, @gote, @sente) # Sente is checking
477     elsif (move_status == :oute_sennichite_gote_lose)
478       result = GameResultOuteSennichiteWin.new(self, @sente, @gote) # Gote is checking
479     elsif (move_status == :sennichite)
480       result = GameResultSennichiteDraw.new(self, @current_player, @next_player)
481     elsif (move_status == :uchifuzume)
482       # the current player losed
483       result = GameResultUchifuzumeWin.new(self, @next_player, @current_player)
484     elsif (move_status == :oute_kaihimore)
485       # the current player losed
486       result = GameResultOuteKaihiMoreWin.new(self, @next_player, @current_player)
487     else
488       finish_flag = false
489     end
490     result.process if result
491     finish() if finish_flag
492     @current_player, @next_player = @next_player, @current_player
493     @start_time = Time::new
494     return finish_flag
495   end
496
497   def is_startable_status?
498     return (@sente && @gote &&
499             (@sente.status == "start_waiting") &&
500             (@gote.status  == "start_waiting"))
501   end
502
503   def start
504     log_message(sprintf("game started %s", @game_id))
505     @sente.status = "game"
506     @gote.status  = "game"
507     @sente.write_safe(sprintf("START:%s\n", @game_id))
508     @gote.write_safe(sprintf("START:%s\n", @game_id))
509     @sente.mytime = @total_time
510     @gote.mytime = @total_time
511     @start_time = Time::new
512   end
513
514   def propose
515     @fh.puts("V2")
516     @fh.puts("N+#{@sente.name}")
517     @fh.puts("N-#{@gote.name}")
518     @fh.puts("$EVENT:#{@game_id}")
519
520     @sente.write_safe(propose_message("+"))
521     @gote.write_safe(propose_message("-"))
522
523     now = Time::new.strftime("%Y/%m/%d %H:%M:%S")
524     @fh.puts("$START_TIME:#{now}")
525     @fh.print <<EOM
526 P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
527 P2 * -HI *  *  *  *  * -KA * 
528 P3-FU-FU-FU-FU-FU-FU-FU-FU-FU
529 P4 *  *  *  *  *  *  *  *  * 
530 P5 *  *  *  *  *  *  *  *  * 
531 P6 *  *  *  *  *  *  *  *  * 
532 P7+FU+FU+FU+FU+FU+FU+FU+FU+FU
533 P8 * +KA *  *  *  *  * +HI * 
534 P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
535 +
536 EOM
537     if rated?
538       black_name = @sente.rated? ? @sente.player_id : @sente.name
539       white_name = @gote.rated?  ? @gote.player_id  : @gote.name
540       @fh.puts("'rating:%s:%s" % [black_name, white_name])
541     end
542     unless @board.initial_moves.empty?
543       @fh.puts "'buoy game starting with %d moves" % [@board.initial_moves.size]
544       @board.initial_moves.each do |move|
545         @fh.puts move
546         @fh.puts "T1"
547       end
548     end
549   end
550
551   def show()
552     str0 = <<EOM
553 BEGIN Game_Summary
554 Protocol_Version:1.1
555 Protocol_Mode:Server
556 Format:Shogi 1.0
557 Declaration:Jishogi 1.1
558 Game_ID:#{@game_id}
559 Name+:#{@sente.name}
560 Name-:#{@gote.name}
561 Rematch_On_Draw:NO
562 To_Move:+
563 BEGIN Time
564 Time_Unit:1sec
565 Total_Time:#{@total_time}
566 Byoyomi:#{@byoyomi}
567 Least_Time_Per_Move:#{Least_Time_Per_Move}
568 Remaining_Time+:#{@sente.mytime}
569 Remaining_Time-:#{@gote.mytime}
570 Last_Move:#{@last_move}
571 Current_Turn:#{@current_turn}
572 END Time
573 BEGIN Position
574 EOM
575
576     str1 = <<EOM
577 END Position
578 END Game_Summary
579 EOM
580
581     return str0 + @board.to_s + str1
582   end
583
584   def propose_message(sg_flag)
585     str = <<EOM
586 BEGIN Game_Summary
587 Protocol_Version:1.1
588 Protocol_Mode:Server
589 Format:Shogi 1.0
590 Declaration:Jishogi 1.1
591 Game_ID:#{@game_id}
592 Name+:#{@sente.name}
593 Name-:#{@gote.name}
594 Your_Turn:#{sg_flag}
595 Rematch_On_Draw:NO
596 To_Move:+
597 BEGIN Time
598 Time_Unit:1sec
599 Total_Time:#{@total_time}
600 Byoyomi:#{@byoyomi}
601 Least_Time_Per_Move:#{Least_Time_Per_Move}
602 END Time
603 BEGIN Position
604 #{@board.to_s.chomp}
605 END Position
606 END Game_Summary
607 EOM
608     return str
609   end
610
611   def prepared_expire?
612     if @prepared_time && (@prepared_time + WAITING_EXPIRATION < Time.now)
613       return true
614     end
615
616     return false
617   end
618   
619   private
620   
621   def issue_current_time
622     time = Time::new.strftime("%Y%m%d%H%M%S").to_i
623     @@mutex.synchronize do
624       while time <= @@time do
625         time += 1
626       end
627       @@time = time
628     end
629   end
630 end
631
632 end # ShogiServer