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