OSDN Git Service

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