OSDN Git Service

4d246b94add78c0375d0b01a8c8f3fc3e22a33d5
[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 'shogi_server/game_result'
22 require 'shogi_server/util'
23
24 module ShogiServer # for a namespace
25
26 class Game
27   # When this duration passes after this object instanciated (i.e.
28   # the agree_waiting or start_waiting state lasts too long),
29   # the game will be rejected by the Server.
30   WAITING_EXPIRATION = 120 # seconds
31
32   @@mutex = Mutex.new
33   @@time  = 0
34
35   # Decide an actual turn of each player according to their turn preferences.
36   # p2 is a rival player of the p1 player.
37   # p1_sente_string must be "*", "+" or "-".
38   # After this call, the sente value of each player is always true or false, not
39   # nil.
40   #
41   def Game.decide_turns(p1, p1_sente_string, p2)
42     if ((p1_sente_string == "*") && (p2.sente == nil))
43       if (rand(2) == 0)
44         p1.sente = true
45         p2.sente = false
46       else
47         p1.sente = false
48         p2.sente = true
49       end
50     elsif (p2.sente == true) # rival has higher priority
51       p1.sente = false
52     elsif (p2.sente == false)
53       p1.sente = true
54     elsif (p1_sente_string == "+")
55       p1.sente = true
56       p2.sente = false
57     elsif (p1_sente_string == "-")
58       p1.sente = false
59       p2.sente = true
60     else
61       ## never reached
62     end
63   end
64
65
66   # options may or may not have follwing keys: :sente_time, :gote_time; they
67   # are used for %%FORK command to set remaining times at the restart.
68   #
69   def initialize(game_name, player0, player1, board, options={})
70     @monitors = Array::new # array of MonitorHandler*
71     @game_name = game_name
72     if (@game_name =~ /-(\d+)-(\d+)$/)
73       @total_time = $1.to_i
74       @byoyomi = $2.to_i
75     end
76
77     if (player0.sente)
78       @sente, @gote = player0, player1
79     else
80       @sente, @gote = player1, player0
81     end
82     @sente.socket_buffer.clear
83     @gote.socket_buffer.clear
84     @board = board
85     if @board.teban
86       @current_player, @next_player = @sente, @gote
87     else
88       @current_player, @next_player = @gote, @sente
89     end
90     @sente.game = self
91     @gote.game  = self
92
93     @last_move = @board.initial_moves.empty? ? "" : "%s,T1" % [@board.initial_moves.last]
94     @current_turn = @board.initial_moves.size
95
96     @sente.status = "agree_waiting"
97     @gote.status  = "agree_waiting"
98
99     @game_id = sprintf("%s+%s+%s+%s+%s", 
100                   $league.event, @game_name, 
101                   @sente.name, @gote.name, issue_current_time)
102     
103     # The time when this Game instance was created.
104     # Don't be confused with @start_time when the game was started to play.
105     @prepared_time = Time.now 
106     log_dir_name = File.join($league.dir, 
107                              @prepared_time.strftime("%Y"),
108                              @prepared_time.strftime("%m"),
109                              @prepared_time.strftime("%d"))
110     @logfile = File.join(log_dir_name, @game_id + ".csa")
111     Mkdir.mkdir_for(@logfile)
112
113     $league.games[@game_id] = self
114
115     log_message(sprintf("game created %s", @game_id))
116
117     @start_time = nil
118     @fh = open(@logfile, "w")
119     @fh.sync = true
120     @result = nil
121
122     @options = options.dup
123
124     propose
125   end
126   attr_accessor :game_name, :total_time, :byoyomi, :sente, :gote, :game_id, :board, :current_player, :next_player, :fh, :monitors
127   attr_accessor :last_move, :current_turn
128   attr_reader   :result, :prepared_time
129
130   # Path of a log file for this game.
131   attr_reader   :logfile
132
133   def rated?
134     @sente.rated? && @gote.rated?
135   end
136
137   def turn?(player)
138     return player.status == "game" && @current_player == player
139   end
140
141   def monitoron(monitor_handler)
142     monitoroff(monitor_handler)
143     @monitors.push(monitor_handler)
144   end
145
146   def monitoroff(monitor_handler)
147     @monitors.delete_if {|mon| mon == monitor_handler}
148   end
149
150   def each_monitor
151     @monitors.each do |monitor_handler|
152       yield monitor_handler
153     end
154   end
155
156   def log_game(str)
157     if @fh.closed?
158       log_error("Failed to write to Game[%s]'s log file: %s" %
159                 [@game_id, str])
160     end
161     @fh.printf("%s\n", str)
162   end
163
164   def reject(rejector)
165     @sente.write_safe(sprintf("REJECT:%s by %s\n", @game_id, rejector))
166     @gote.write_safe(sprintf("REJECT:%s by %s\n", @game_id, rejector))
167     finish
168   end
169
170   def kill(killer)
171     [@sente, @gote].each do |player|
172       if ["agree_waiting", "start_waiting"].include?(player.status)
173         reject(killer.name)
174         return # return from this method
175       end
176     end
177     
178     if (@current_player == killer)
179       @result = GameResultAbnormalWin.new(self, @next_player, @current_player)
180       @result.process
181       finish
182     end
183   end
184
185   def finish
186     log_message(sprintf("game finished %s", @game_id))
187
188     # In a case where a player in agree_waiting or start_waiting status is
189     # rejected, a GameResult object is not yet instanciated.
190     # See test/TC_before_agree.rb.
191     end_time = @result ? @result.end_time : Time.now
192     @fh.printf("'$END_TIME:%s\n", end_time.strftime("%Y/%m/%d %H:%M:%S"))    
193     @fh.close
194
195     @sente.game = nil
196     @gote.game = nil
197     @sente.status = "connected"
198     @gote.status = "connected"
199
200     if (@current_player.protocol == LoginCSA::PROTOCOL)
201       @current_player.finish
202     end
203     if (@next_player.protocol == LoginCSA::PROTOCOL)
204       @next_player.finish
205     end
206     @monitors = Array::new
207     @sente = nil
208     @gote = nil
209     @current_player = nil
210     @next_player = nil
211     $league.games.delete(@game_id)
212   end
213
214   # class Game
215   def handle_one_move(str, player, end_time)
216     unless turn?(player)
217       return false if str == :timeout
218
219       @fh.puts("'Deferred %s" % [str])
220       log_warning("Deferred a move [%s] scince it is not %s 's turn." %
221                   [str, player.name])
222       player.socket_buffer << str # always in the player's thread
223       return nil
224     end
225
226     finish_flag = true
227     @end_time = end_time
228     t = [(@end_time - @start_time).floor, Least_Time_Per_Move].max
229     
230     move_status = nil
231     if ((@current_player.mytime - t <= -@byoyomi) && 
232         ((@total_time > 0) || (@byoyomi > 0)))
233       status = :timeout
234     elsif (str == :timeout)
235       return false            # time isn't expired. players aren't swapped. continue game
236     else
237       @current_player.mytime -= t
238       if (@current_player.mytime < 0)
239         @current_player.mytime = 0
240       end
241
242       move_status = @board.handle_one_move(str, @sente == @current_player)
243       # log_debug("move_status: %s for %s's %s" % [move_status, @sente == @current_player ? "BLACK" : "WHITE", str])
244
245       if [:illegal, :uchifuzume, :oute_kaihimore].include?(move_status)
246         @fh.printf("'ILLEGAL_MOVE(%s)\n", str)
247       else
248         if :toryo != move_status
249           # Thinking time includes network traffic
250           @sente.write_safe(sprintf("%s,T%d\n", str, t))
251           @gote.write_safe(sprintf("%s,T%d\n", str, t))
252           @fh.printf("%s\nT%d\n", str, t)
253           @last_move = sprintf("%s,T%d", str, t)
254           @current_turn += 1
255
256           @monitors.each do |monitor_handler|
257             monitor_handler.write_one_move(@game_id, self)
258           end
259         end # if
260         # if move_status is :toryo then a GameResult message will be sent to monitors   
261       end # if
262     end
263
264     @result = nil
265     if (@next_player.status != "game") # rival is logout or disconnected
266       @result = GameResultAbnormalWin.new(self, @current_player, @next_player)
267     elsif (status == :timeout)
268       # current_player losed
269       @result = GameResultTimeoutWin.new(self, @next_player, @current_player)
270     elsif (move_status == :illegal)
271       @result = GameResultIllegalMoveWin.new(self, @next_player, @current_player)
272     elsif (move_status == :kachi_win)
273       @result = GameResultKachiWin.new(self, @current_player, @next_player)
274     elsif (move_status == :kachi_lose)
275       @result = GameResultIllegalKachiWin.new(self, @next_player, @current_player)
276     elsif (move_status == :toryo)
277       @result = GameResultToryoWin.new(self, @next_player, @current_player)
278     elsif (move_status == :outori)
279       # The current player captures the next player's king
280       @result = GameResultOutoriWin.new(self, @current_player, @next_player)
281     elsif (move_status == :oute_sennichite_sente_lose)
282       @result = GameResultOuteSennichiteWin.new(self, @gote, @sente) # Sente is checking
283     elsif (move_status == :oute_sennichite_gote_lose)
284       @result = GameResultOuteSennichiteWin.new(self, @sente, @gote) # Gote is checking
285     elsif (move_status == :sennichite)
286       @result = GameResultSennichiteDraw.new(self, @current_player, @next_player)
287     elsif (move_status == :uchifuzume)
288       # the current player losed
289       @result = GameResultUchifuzumeWin.new(self, @next_player, @current_player)
290     elsif (move_status == :oute_kaihimore)
291       # the current player losed
292       @result = GameResultOuteKaihiMoreWin.new(self, @next_player, @current_player)
293     else
294       finish_flag = false
295     end
296     @result.process if @result
297     finish() if finish_flag
298     @current_player, @next_player = @next_player, @current_player
299     @start_time = Time.now
300     return finish_flag
301   end
302
303   def is_startable_status?
304     return (@sente && @gote &&
305             (@sente.status == "start_waiting") &&
306             (@gote.status  == "start_waiting"))
307   end
308
309   def start
310     log_message(sprintf("game started %s", @game_id))
311     @sente.status = "game"
312     @gote.status  = "game"
313     @sente.write_safe(sprintf("START:%s\n", @game_id))
314     @gote.write_safe(sprintf("START:%s\n", @game_id))
315     @sente.mytime = @options[:sente_time] || @total_time
316     @gote.mytime  = @options[:gote_time]  || @total_time
317     @start_time = Time.now
318   end
319
320   def propose
321     @fh.puts("V2")
322     @fh.puts("N+#{@sente.name}")
323     @fh.puts("N-#{@gote.name}")
324     @fh.puts("$EVENT:#{@game_id}")
325
326     @sente.write_safe(propose_message("+"))
327     @gote.write_safe(propose_message("-"))
328
329     now = Time.now.strftime("%Y/%m/%d %H:%M:%S")
330     @fh.puts("$START_TIME:#{now}")
331     @fh.print(@board.initial_string)
332     if rated?
333       black_name = @sente.rated? ? @sente.player_id : @sente.name
334       white_name = @gote.rated?  ? @gote.player_id  : @gote.name
335       @fh.puts("'rating:%s:%s" % [black_name, white_name])
336     end
337     unless @board.initial_moves.empty?
338       @fh.puts "'buoy game starting with %d moves" % [@board.initial_moves.size]
339       @board.initial_moves.each do |move|
340         @fh.puts move
341         @fh.puts "T1"
342       end
343     end
344   end
345
346   def show()
347     str0 = <<EOM
348 BEGIN Game_Summary
349 Protocol_Version:1.1
350 Protocol_Mode:Server
351 Format:Shogi 1.0
352 Declaration:Jishogi 1.1
353 Game_ID:#{@game_id}
354 Name+:#{@sente.name}
355 Name-:#{@gote.name}
356 Rematch_On_Draw:NO
357 To_Move:+
358 BEGIN Time
359 Time_Unit:1sec
360 Total_Time:#{@total_time}
361 Byoyomi:#{@byoyomi}
362 Least_Time_Per_Move:#{Least_Time_Per_Move}
363 Remaining_Time+:#{@sente.mytime}
364 Remaining_Time-:#{@gote.mytime}
365 Last_Move:#{@last_move}
366 Current_Turn:#{@current_turn}
367 END Time
368 BEGIN Position
369 EOM
370
371     str1 = <<EOM
372 END Position
373 END Game_Summary
374 EOM
375
376     return str0 + @board.to_s + str1
377   end
378
379   def propose_message(sg_flag)
380     time = @total_time
381     if @options[:sente_time] && sg_flag == "+"
382       time = @options[:sente_time]
383     elsif @options[:gote_time] && sg_flag == "-"
384       time = @options[:gote_time]
385     end
386
387     str = <<EOM
388 BEGIN Game_Summary
389 Protocol_Version:1.1
390 Protocol_Mode:Server
391 Format:Shogi 1.0
392 Declaration:Jishogi 1.1
393 Game_ID:#{@game_id}
394 Name+:#{@sente.name}
395 Name-:#{@gote.name}
396 Your_Turn:#{sg_flag}
397 Rematch_On_Draw:NO
398 To_Move:#{@board.teban ? "+" : "-"}
399 BEGIN Time
400 Time_Unit:1sec
401 Total_Time:#{time}
402 Byoyomi:#{@byoyomi}
403 Least_Time_Per_Move:#{Least_Time_Per_Move}
404 END Time
405 BEGIN Position
406 #{@board.initial_string.chomp}
407 #{@board.initial_moves.collect {|m| m + ",T1"}.join("\n")}
408 END Position
409 END Game_Summary
410 EOM
411     # An empty @board.initial_moves causes an empty line, which should be
412     # eliminated.
413     return str.gsub("\n\n", "\n")
414   end
415
416   def prepared_expire?
417     if @prepared_time && (@prepared_time + WAITING_EXPIRATION < Time.now)
418       return true
419     end
420
421     return false
422   end
423
424   # Read the .csa file and returns an array of moves.
425   # ex. ["+7776FU", "-3334FU"]
426   #
427   def read_moves
428     ret = []
429     IO.foreach(@logfile) do |line|
430       if /^[\+\-]\d{4}[A-Z]{2}/ =~ line
431         ret << line.chomp
432       end
433     end
434     return ret
435   end
436   
437   private
438   
439   def issue_current_time
440     time = Time.now.strftime("%Y%m%d%H%M%S").to_i
441     @@mutex.synchronize do
442       while time <= @@time do
443         time += 1
444       end
445       @@time = time
446     end
447   end
448 end
449
450 end # ShogiServer