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 require 'shogi_server/command'
  21
  22 module ShogiServer # for a namespace
  23
  24 class BasicPlayer
  25   def initialize
  26     @player_id = nil
  27     @name = nil
  28     @password = nil
  29     @rate = 0
  30     @win  = 0
  31     @loss = 0
  32     @last_game_win = false
  33     @rating_group = nil
  34     @modified_at = nil
  35     @sente = nil
  36     @game_name = ""
  37   end
  38
  39   # Idetifier of the player in the rating system
  40   attr_accessor :player_id
  41
  42   # Name of the player
  43   attr_accessor :name
  44
  45   # Password of the player, which does not include a trip
  46   attr_accessor :password
  47
  48   # Score in the rating sysem
  49   attr_accessor :rate
  50
  51   # Number of games for win and loss in the rating system
  52   attr_accessor :win, :loss
  53
  54   # Group in the rating system
  55   attr_accessor :rating_group
  56
  57   # Last timestamp when the rate was modified
  58   attr_accessor :modified_at
  59
  60   # Whether win the previous game or not
  61   attr_accessor :last_game_win
  62
  63   # true for Sente; false for Gote
  64   attr_accessor :sente
  65
  66   # game name
  67   attr_accessor :game_name
  68
  69   def is_human?
  70     return [%r!_human$!, %r!_human@!].any? do |re|
  71       re.match(@name)
  72     end
  73   end
  74
  75   def is_computer?
  76     return !is_human?
  77   end
  78
  79   def modified_at
  80     @modified_at || Time.now
  81   end
  82
  83   def rate=(new_rate)
  84     if @rate != new_rate
  85       @rate = new_rate
  86       @modified_at = Time.now
  87     end
  88   end
  89
  90   def rated?
  91     @player_id != nil
  92   end
  93
  94   def last_game_win?
  95     return @last_game_win
  96   end
  97
  98   def simple_player_id
  99     if @trip
 100       simple_name = @name.gsub(/@.*?$/, '')
 101       "%s+%s" % [simple_name, @trip[0..8]]
 102     else
 103       @name
 104     end
 105   end
 106
 107   ##
 108   # Parses str in the LOGIN command, sets up @player_id and @trip
 109   #
 110   def set_password(str)
 111     if str && !str.empty?
 112       @password = str.strip
 113       @player_id   = "%s+%s" % [@name, Digest::MD5.hexdigest(@password)]
 114     else
 115       @player_id = @password = nil
 116     end
 117   end
 118
 119   def set_sente_from_str(str)
 120     case str
 121     when "+": @sente = true
 122     when "-": @sente = false
 123     else
 124       # str should be "*"
 125       @sente = nil
 126     end
 127   end
 128 end
 129
 130
 131 class Player < BasicPlayer
 132   WRITE_THREAD_WATCH_INTERVAL = 20 # sec
 133   def initialize(str, socket, eol=nil)
 134     super()
 135     @socket = socket
 136     @status = "connected"       # game_waiting -> agree_waiting -> start_waiting -> game -> finished
 137
 138     @protocol = nil             # CSA or x1
 139     @eol = eol || "\m"          # favorite eol code
 140     @game = nil
 141     @mytime = 0                 # set in start method also
 142     @socket_buffer = []
 143     @main_thread = Thread::current
 144     @write_queue = ShogiServer::TimeoutQueue.new(WRITE_THREAD_WATCH_INTERVAL)
 145     @player_logger = nil
 146     start_write_thread
 147   end
 148
 149   attr_accessor :socket, :status
 150   attr_accessor :protocol, :eol, :game, :mytime
 151   attr_accessor :main_thread
 152   attr_reader :socket_buffer
 153
 154   def setup_logger(dir)
 155     log_file = File.join(dir, "%s.log" % [simple_player_id])
 156     @player_logger = Logger.new(log_file, 'daily')
 157     @player_logger.formatter = ShogiServer::Formatter.new
 158     @player_logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
 159     @player_logger.datetime_format = "%Y-%m-%d %H:%M:%S"
 160   end
 161
 162   def log(level, direction, message)
 163     return unless @player_logger
 164     str = message.chomp
 165     case direction
 166       when :in
 167         str = "IN: %s" % [str]
 168       when :out
 169         str = "OUT: %s" % [str]
 170       else
 171         str = "UNKNOWN DIRECTION: %s %s" % [direction, str]
 172     end
 173     case level
 174       when :debug
 175         @player_logger.debug(str)
 176       when :info
 177         @player_logger.info(str)
 178       when :warn
 179         @player_logger.warn(str)
 180       when :error
 181         @player_logger.error(str)
 182       else
 183         @player_logger.debug("UNKNOWN LEVEL: %s %s" % [level, str])
 184     end
 185   rescue Exception => ex
 186     log_error("#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
 187   end
 188
 189   def kill
 190     log_message(sprintf("user %s killed", @name))
 191     if (@game)
 192       @game.kill(self)
 193     end
 194     finish
 195     Thread::kill(@main_thread)  if @main_thread
 196     Thread::kill(@write_thread) if @write_thread
 197   end
 198
 199   def finish
 200     if (@status != "finished")
 201       @status = "finished"
 202       log_message(sprintf("user %s finish", @name))
 203       begin
 204         log_debug("Terminating %s's write thread..." % [@name])
 205         if @write_thread && @write_thread.alive?
 206           write_safe(nil)
 207           Thread.pass # help the write_thread to terminate
 208         end
 209         @player_logger.close if @player_logger
 210         log_debug("done.")
 211       rescue
 212         log_message(sprintf("user %s finish failed", @name))
 213       end
 214     end
 215   end
 216
 217   def start_write_thread
 218     @write_thread = Thread.start do
 219       Thread.pass
 220       while !@socket.closed?
 221         begin
 222           str = @write_queue.deq
 223           if (str == nil)
 224             log_debug("%s's write thread terminated" % [@name])
 225             break
 226           end
 227           if (str == :timeout)
 228             log_debug("%s's write queue timed out. Try again..." % [@name])
 229             next
 230           end
 231
 232           if r = select(nil, [@socket], nil, 20)
 233             r[1].first.write(str)
 234             log(:info, :out, str)
 235           else
 236             log_error("Gave a try to send a message to #{@name}, but it timed out.")
 237             break
 238           end
 239         rescue Exception => ex
 240           log_error("Failed to send a message to #{@name}. #{ex.class}: #{ex.message}\t#{ex.backtrace[0]}")
 241           break
 242         end
 243       end # while loop
 244       log_error("%s's socket closed." % [@name]) if @socket.closed?
 245       log_message("At least %d messages are not sent to the client." %
 246                   [@write_queue.get_messages.size])
 247     end # thread
 248   end
 249
 250   #
 251   # Note that sending a message is included in the giant lock.
 252   #
 253   def write_safe(str)
 254     @write_queue.enq(str)
 255   end
 256
 257   def to_s
 258     if ["game_waiting", "start_waiting", "agree_waiting", "game"].include?(status)
 259       if (@sente)
 260         return sprintf("%s %s %s %s +", rated? ? @player_id : @name, @protocol, @status, @game_name)
 261       elsif (@sente == false)
 262         return sprintf("%s %s %s %s -", rated? ? @player_id : @name, @protocol, @status, @game_name)
 263       elsif (@sente == nil)
 264         return sprintf("%s %s %s %s *", rated? ? @player_id : @name, @protocol, @status, @game_name)
 265       end
 266     else
 267       return sprintf("%s %s %s", rated? ? @player_id : @name, @protocol, @status)
 268     end
 269   end
 270
 271   def run(csa_1st_str=nil)
 272     while ( csa_1st_str ||
 273             str = gets_safe(@socket, (@socket_buffer.empty? ? Default_Timeout : 1)) )
 274       time = Time.now
 275       log(:info, :in, str) if str && str.instance_of?(String)
 276       $mutex.lock
 277       begin
 278         if !@write_thread.alive?
 279           log_error("%s's write thread is dead. Aborting..." % [@name])
 280           return
 281         end
 282         if (@game && @game.turn?(self))
 283           @socket_buffer << str
 284           str = @socket_buffer.shift
 285         end
 286         log_debug("%s (%s)" % [str, @socket_buffer.map {|a| String === a ? a.strip : a }.join(",")])
 287
 288         if (csa_1st_str)
 289           str = csa_1st_str
 290           csa_1st_str = nil
 291         end
 292
 293         if (@status == "finished")
 294           return
 295         end
 296         str.chomp! if (str.class == String) # may be strip! ?
 297
 298         delay = Time.now - time
 299         if delay > 5
 300           log_warning("Detected a long delay: %.2f sec" % [delay])
 301         end
 302         cmd = ShogiServer::Command.factory(str, self, time)
 303         case cmd.call
 304         when :return
 305           return
 306         when :continue
 307           # do nothing
 308         else
 309           # TODO never reach
 310         end
 311
 312       ensure
 313         $mutex.unlock
 314       end
 315     end # enf of while
 316     log_warning("%s's socket was suddenly closed" % [@name])
 317   end # def run
 318 end # class
 319
 320 end # ShogiServer