OSDN Git Service

* [shogi-server]
[shogi-server/shogi-server.git] / shogi_server / player.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 module ShogiServer # for a namespace
21
22 class BasicPlayer
23   def initialize
24     @player_id = nil
25     @name = nil
26     @password = nil
27     @rate = 0
28     @win  = 0
29     @loss = 0
30     @last_game_win = false
31   end
32
33   # Idetifier of the player in the rating system
34   attr_accessor :player_id
35
36   # Name of the player
37   attr_accessor :name
38   
39   # Password of the player, which does not include a trip
40   attr_accessor :password
41
42   # Score in the rating sysem
43   attr_accessor :rate
44
45   # Number of games for win and loss in the rating system
46   attr_accessor :win, :loss
47   
48   # Group in the rating system
49   attr_accessor :rating_group
50
51   # Last timestamp when the rate was modified
52   attr_accessor :modified_at
53
54   # Whether win the previous game or not
55   attr_accessor :last_game_win
56
57   def modified_at
58     @modified_at || Time.now
59   end
60
61   def rate=(new_rate)
62     if @rate != new_rate
63       @rate = new_rate
64       @modified_at = Time.now
65     end
66   end
67
68   def rated?
69     @player_id != nil
70   end
71
72   def last_game_win?
73     return @last_game_win
74   end
75
76   def simple_player_id
77     if @trip
78       simple_name = @name.gsub(/@.*?$/, '')
79       "%s+%s" % [simple_name, @trip[0..8]]
80     else
81       @name
82     end
83   end
84
85   ##
86   # Parses str in the LOGIN command, sets up @player_id and @trip
87   #
88   def set_password(str)
89     if str && !str.empty?
90       @password = str.strip
91       @player_id   = "%s+%s" % [@name, Digest::MD5.hexdigest(@password)]
92     else
93       @player_id = @password = nil
94     end
95   end
96 end
97
98
99 class Player < BasicPlayer
100   WRITE_THREAD_WATCH_INTERVAL = 20 # sec
101   def initialize(str, socket, eol=nil)
102     super()
103     @socket = socket
104     @status = "connected"       # game_waiting -> agree_waiting -> start_waiting -> game -> finished
105
106     @protocol = nil             # CSA or x1
107     @eol = eol || "\m"          # favorite eol code
108     @game = nil
109     @game_name = ""
110     @mytime = 0                 # set in start method also
111     @sente = nil
112     @socket_buffer = []
113     @main_thread = Thread::current
114     @write_queue = ShogiServer::TimeoutQueue.new(WRITE_THREAD_WATCH_INTERVAL)
115     @player_logger = nil
116     start_write_thread
117   end
118
119   attr_accessor :socket, :status
120   attr_accessor :protocol, :eol, :game, :mytime, :game_name, :sente
121   attr_accessor :main_thread
122   attr_reader :socket_buffer
123   
124   def setup_logger(dir)
125     log_file = File.join(dir, "%s.log" % [simple_player_id])
126     @player_logger = Logger.new(log_file, 'daily')
127     @player_logger.formatter = ShogiServer::Formatter.new
128     @player_logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO  
129     @player_logger.datetime_format = "%Y-%m-%d %H:%M:%S"
130   end
131
132   def log(level, direction, message)
133     return unless @player_logger
134     str = message.chomp
135     case direction
136       when :in
137         str = "IN: %s" % [str]
138       when :out
139         str = "OUT: %s" % [str]
140       else
141         str = "UNKNOWN DIRECTION: %s %s" % [direction, str]
142     end
143     case level
144       when :debug
145         @player_logger.debug(str)
146       when :info
147         @player_logger.info(str)
148       when :warn
149         @player_logger.warn(str)
150       when :error
151         @player_logger.error(str)
152       else
153         @player_logger.debug("UNKNOWN LEVEL: %s %s" % [level, str])
154     end
155   rescue Exception => ex
156     log_error("#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
157   end
158
159   def kill
160     log_message(sprintf("user %s killed", @name))
161     if (@game)
162       @game.kill(self)
163     end
164     finish
165     Thread::kill(@main_thread)  if @main_thread
166     Thread::kill(@write_thread) if @write_thread
167   end
168
169   def finish
170     if (@status != "finished")
171       @status = "finished"
172       log_message(sprintf("user %s finish", @name))    
173       begin
174         log_debug("Terminating %s's write thread..." % [@name])
175         if @write_thread && @write_thread.alive?
176           write_safe(nil)
177           @write_thread.join
178         end
179         @player_logger.close if @player_logger
180         log_debug("done.")
181       rescue
182         log_message(sprintf("user %s finish failed", @name))    
183       end
184     end
185   end
186
187   def start_write_thread
188     @write_thread = Thread.start do
189       Thread.pass
190       while !@socket.closed?
191         begin
192           str = @write_queue.deq
193           if (str == nil)
194             log_debug("%s's write thread terminated" % [@name])
195             break
196           end
197           if (str == :timeout)
198             log_debug("%s's write queue timed out. Try again..." % [@name])
199             next
200           end
201
202           if r = select(nil, [@socket], nil, 20)
203             r[1].first.write(str)
204             log(:info, :out, str)
205           else
206             log_error("Gave a try to send a message to #{@name}, but it timed out.")
207             break
208           end
209         rescue Exception => ex
210           log_error("Failed to send a message to #{@name}. #{ex.class}: #{ex.message}\t#{ex.backtrace[0]}")
211           break
212         end
213       end # while loop
214       log_error("%s's socket closed." % [@name]) if @socket.closed?
215       log_message("At least %d messages are not sent to the client." % 
216                   [@write_queue.get_messages.size])
217     end # thread
218   end
219
220   #
221   # Note that sending a message is included in the giant lock.
222   #
223   def write_safe(str)
224     @write_queue.enq(str)
225   end
226
227   def to_s
228     if ["game_waiting", "start_waiting", "agree_waiting", "game"].include?(status)
229       if (@sente)
230         return sprintf("%s %s %s %s +", rated? ? @player_id : @name, @protocol, @status, @game_name)
231       elsif (@sente == false)
232         return sprintf("%s %s %s %s -", rated? ? @player_id : @name, @protocol, @status, @game_name)
233       elsif (@sente == nil)
234         return sprintf("%s %s %s %s *", rated? ? @player_id : @name, @protocol, @status, @game_name)
235       end
236     else
237       return sprintf("%s %s %s", rated? ? @player_id : @name, @protocol, @status)
238     end
239   end
240
241   def run(csa_1st_str=nil)
242     while ( csa_1st_str || 
243             str = gets_safe(@socket, (@socket_buffer.empty? ? Default_Timeout : 1)) )
244       log(:info, :in, str) if str && str.instance_of?(String) 
245       $mutex.lock
246       begin
247         if !@write_thread.alive?
248           log_error("%s's write thread is dead. Aborting..." % [@name])
249           return
250         end
251         if (@game && @game.turn?(self))
252           @socket_buffer << str
253           str = @socket_buffer.shift
254         end
255         log_debug("%s (%s)" % [str, @socket_buffer.map {|a| String === a ? a.strip : a }.join(",")])
256
257         if (csa_1st_str)
258           str = csa_1st_str
259           csa_1st_str = nil
260         end
261
262         if (@status == "finished")
263           return
264         end
265         str.chomp! if (str.class == String) # may be strip! ?
266         case str 
267         when "" 
268           # Application-level protocol for Keep-Alive
269           # If the server gets LF, it sends back LF.
270           # 30 sec rule (client may not send LF again within 30 sec) is not implemented yet.
271           write_safe("\n")
272         when /^[\+\-][^%]/
273           if (@status == "game")
274             array_str = str.split(",")
275             move = array_str.shift
276             additional = array_str.shift
277             if /^'(.*)/ =~ additional
278               comment = array_str.unshift("'*#{$1.toeuc}")
279             end
280             s = @game.handle_one_move(move, self)
281             @game.fh.print("#{Kconv.toeuc(comment.first)}\n") if (comment && comment.first && !s)
282             return if (s && @protocol == LoginCSA::PROTOCOL)
283           end
284         when /^%[^%]/, :timeout
285           if (@status == "game")
286             s = @game.handle_one_move(str, self)
287             return if (s && @protocol == LoginCSA::PROTOCOL)
288           end
289         when :exception
290           log_error("Failed to receive a message from #{@name}.")
291           return
292         when /^REJECT/
293           if (@status == "agree_waiting")
294             @game.reject(@name)
295             return if (@protocol == LoginCSA::PROTOCOL)
296           else
297             write_safe(sprintf("##[ERROR] you are in %s status. AGREE is valid in agree_waiting status\n", @status))
298           end
299         when /^AGREE/
300           if (@status == "agree_waiting")
301             @status = "start_waiting"
302             if ((@game.sente.status == "start_waiting") &&
303                 (@game.gote.status == "start_waiting"))
304               @game.start
305               @game.sente.status = "game"
306               @game.gote.status = "game"
307             end
308           else
309             write_safe(sprintf("##[ERROR] you are in %s status. AGREE is valid in agree_waiting status\n", @status))
310           end
311         when /^%%SHOW\s+(\S+)/
312           game_id = $1
313           if ($league.games[game_id])
314             write_safe($league.games[game_id].show.gsub(/^/, '##[SHOW] '))
315           end
316           write_safe("##[SHOW] +OK\n")
317         when /^%%MONITORON\s+(\S+)/
318           game_id = $1
319           if ($league.games[game_id])
320             $league.games[game_id].monitoron(self)
321             write_safe($league.games[game_id].show.gsub(/^/, "##[MONITOR][#{game_id}] "))
322             write_safe("##[MONITOR][#{game_id}] +OK\n")
323           end
324         when /^%%MONITOROFF\s+(\S+)/
325           game_id = $1
326           if ($league.games[game_id])
327             $league.games[game_id].monitoroff(self)
328           end
329         when /^%%HELP/
330           write_safe(
331             %!##[HELP] available commands "%%WHO", "%%CHAT str", "%%GAME game_name +", "%%GAME game_name -"\n!)
332         when /^%%RATING/
333           players = $league.rated_players
334           players.sort {|a,b| b.rate <=> a.rate}.each do |p|
335             write_safe("##[RATING] %s \t %4d @%s\n" % 
336                        [p.simple_player_id, p.rate, p.modified_at.strftime("%Y-%m-%d")])
337           end
338           write_safe("##[RATING] +OK\n")
339         when /^%%VERSION/
340           write_safe "##[VERSION] Shogi Server revision #{Revision}\n"
341           write_safe("##[VERSION] +OK\n")
342         when /^%%GAME\s*$/
343           if ((@status == "connected") || (@status == "game_waiting"))
344             @status = "connected"
345             @game_name = ""
346           else
347             write_safe(sprintf("##[ERROR] you are in %s status. GAME is valid in connected or game_waiting status\n", @status))
348           end
349         when /^%%(GAME|CHALLENGE)\s+(\S+)\s+([\+\-\*])\s*$/
350           command_name = $1
351           game_name = $2
352           my_sente_str = $3
353           if (! Login::good_game_name?(game_name))
354             write_safe(sprintf("##[ERROR] bad game name\n"))
355             next
356           elsif ((@status == "connected") || (@status == "game_waiting"))
357             ## continue
358           else
359             write_safe(sprintf("##[ERROR] you are in %s status. GAME is valid in connected or game_waiting status\n", @status))
360             next
361           end
362
363           rival = nil
364           if (League::Floodgate.game_name?(game_name))
365             if (my_sente_str != "*")
366               write_safe(sprintf("##[ERROR] You are not allowed to specify TEBAN %s for the game %s\n", my_sente_str, game_name))
367               next
368             end
369             @sente = nil
370           else
371             if (my_sente_str == "*")
372               rival = $league.get_player("game_waiting", game_name, nil, self) # no preference
373             elsif (my_sente_str == "+")
374               rival = $league.get_player("game_waiting", game_name, false, self) # rival must be gote
375             elsif (my_sente_str == "-")
376               rival = $league.get_player("game_waiting", game_name, true, self) # rival must be sente
377             else
378               ## never reached
379               write_safe(sprintf("##[ERROR] bad game option\n"))
380               next
381             end
382           end
383
384           if (rival)
385             @game_name = game_name
386             if ((my_sente_str == "*") && (rival.sente == nil))
387               if (rand(2) == 0)
388                 @sente = true
389                 rival.sente = false
390               else
391                 @sente = false
392                 rival.sente = true
393               end
394             elsif (rival.sente == true) # rival has higher priority
395               @sente = false
396             elsif (rival.sente == false)
397               @sente = true
398             elsif (my_sente_str == "+")
399               @sente = true
400               rival.sente = false
401             elsif (my_sente_str == "-")
402               @sente = false
403               rival.sente = true
404             else
405               ## never reached
406             end
407             Game::new(@game_name, self, rival)
408           else # rival not found
409             if (command_name == "GAME")
410               @status = "game_waiting"
411               @game_name = game_name
412               if (my_sente_str == "+")
413                 @sente = true
414               elsif (my_sente_str == "-")
415                 @sente = false
416               else
417                 @sente = nil
418               end
419             else                # challenge
420               write_safe(sprintf("##[ERROR] can't find rival for %s\n", game_name))
421               @status = "connected"
422               @game_name = ""
423               @sente = nil
424             end
425           end
426         when /^%%CHAT\s+(.+)/
427           message = $1
428           $league.players.each do |name, player|
429             if (player.protocol != LoginCSA::PROTOCOL)
430               player.write_safe(sprintf("##[CHAT][%s] %s\n", @name, message)) 
431             end
432           end
433         when /^%%LIST/
434           buf = Array::new
435           $league.games.each do |id, game|
436             buf.push(sprintf("##[LIST] %s\n", id))
437           end
438           buf.push("##[LIST] +OK\n")
439           write_safe(buf.join)
440         when /^%%WHO/
441           buf = Array::new
442           $league.players.each do |name, player|
443             buf.push(sprintf("##[WHO] %s\n", player.to_s))
444           end
445           buf.push("##[WHO] +OK\n")
446           write_safe(buf.join)
447         when /^LOGOUT/
448           @status = "connected"
449           write_safe("LOGOUT:completed\n")
450           return
451         when /^CHALLENGE/
452           # This command is only available for CSA's official testing server.
453           # So, this means nothing for this program.
454           write_safe("CHALLENGE ACCEPTED\n")
455         when /^\s*$/
456           ## ignore null string
457         else
458           msg = "##[ERROR] unknown command %s\n" % [str]
459           write_safe(msg)
460           log_error(msg)
461         end
462       ensure
463         $mutex.unlock
464       end
465     end # enf of while
466   end # def run
467 end # class
468
469 end # ShogiServer