## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-Max_Write_Queue_Size = 1000
-Max_Identifier_Length = 32
-Default_Timeout = 60 # for single socket operation
-
-Default_Game_Name = "default-1500-0"
-
-One_Time = 10
-Least_Time_Per_Move = 1
-Login_Time = 300 # time for LOGIN
-
-Release = "$Name$".split[1].sub(/\A[^\d]*/, '').gsub(/_/, '.')
-Release.concat("-") if (Release == "")
-Revision = "$Revision$".gsub(/[^\.\d]/, '')
-
-STDOUT.sync = true
-STDERR.sync = true
-
require 'getoptlong'
require 'thread'
require 'timeout'
require 'yaml'
require 'yaml/store'
require 'digest/md5'
-
-TCPSocket.do_not_reverse_lookup = true
-Thread.abort_on_exception = true
+require 'webrick'
+require 'fileutils'
class TCPSocket
end
rescue TimeoutError
return :timeout
- rescue
- return nil
+ rescue Exception => ex
+ log_error("#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
+ return :exception
end
else
begin
end
+module ShogiServer # for a namespace
+
+Max_Write_Queue_Size = 1000
+Max_Identifier_Length = 32
+Default_Timeout = 60 # for single socket operation
+
+Default_Game_Name = "default-1500-0"
+
+One_Time = 10
+Least_Time_Per_Move = 1
+Login_Time = 300 # time for LOGIN
+
+Release = "$Name$".split[1].sub(/\A[^\d]*/, '').gsub(/_/, '.')
+Release.concat("-") if (Release == "")
+Revision = "$Revision$".gsub(/[^\.\d]/, '')
+
+
class League
def initialize
@games = Hash::new
@players = Hash::new
@event = nil
- @db = YAML::Store.new( File.join(File.dirname(__FILE__), "players.yaml") )
+ @dir = File.dirname(__FILE__)
+ end
+ attr_accessor :players, :games, :event, :dir
+
+ # this should be called just after instanciating a League object.
+ def setup_players_database
+ @db = YAML::Store.new(File.join(@dir, "players.yaml"))
end
- attr_accessor :players, :games, :event
def add(player)
self.load(player) if player.id
hash = search(player.id)
if hash
# a current user
- player.name = hash['name']
- player.rate = hash['rate']
- player.modified_at = hash['last_modified']
+ player.name = hash['name']
+ player.rate = hash['rate']
+ player.modified_at = hash['last_modified']
+ player.rating_group = hash['rating_group']
end
end
def search(id)
hash = nil
@db.transaction do
- hash = @db[id]
+ break unless @db["players"]
+ @db["players"].each do |group, players|
+ hash = players[id]
+ break if hash
+ end
end
hash
end
def rated_players
players = []
@db.transaction(true) do
- @db.roots.each do |id|
- players << id
+ break unless @db["players"]
+ @db["players"].each do |group, players_hash|
+ players << players_hash.keys
end
end
- return players.collect do |id|
+ return players.flatten.collect do |id|
p = BasicPlayer.new
p.id = id
self.load(p)
end
+######################################################
+# Processes the LOGIN command.
+#
+class Login
+ def Login.good_login?(str)
+ tokens = str.split
+ if (((tokens.length == 3) || ((tokens.length == 4) && tokens[3] == "x1")) &&
+ (tokens[0] == "LOGIN") &&
+ (good_identifier?(tokens[1])))
+ return true
+ else
+ return false
+ end
+ end
+
+ def Login.good_game_name?(str)
+ if ((str =~ /^(.+)-\d+-\d+$/) && (good_identifier?($1)))
+ return true
+ else
+ return false
+ end
+ end
+
+ def Login.good_identifier?(str)
+ if str =~ /\A[\w\d_@\-\.]{1,#{Max_Identifier_Length}}\z/
+ return true
+ else
+ return false
+ end
+ end
+
+ def Login.factory(str, player)
+ (login, player.name, password, ext) = str.chomp.split
+ if (ext)
+ return Loginx1.new(player, password)
+ else
+ return LoginCSA.new(player, password)
+ end
+ end
+
+ attr_reader :player
+
+ # the first command that will be executed just after LOGIN.
+ # If it is nil, the default process will be started.
+ attr_reader :csa_1st_str
+
+ def initialize(player, password)
+ @player = player
+ @csa_1st_str = nil
+ parse_password(password)
+ end
+
+ def process
+ @player.write_safe(sprintf("LOGIN:%s OK\n", @player.name))
+ log_message(sprintf("user %s run in %s mode", @player.name, @player.protocol))
+ end
+
+ def incorrect_duplicated_player(str)
+ @player.write_safe("LOGIN:incorrect\n")
+ @player.write_safe(sprintf("username %s is already connected\n", @player.name)) if (str.split.length >= 4)
+ sleep 3 # wait for sending the above messages.
+ @player.name = "%s [duplicated]" % [@player.name]
+ @player.finish
+ end
+end
+
+######################################################
+# Processes LOGIN for the CSA standard mode.
+#
+class LoginCSA < Login
+ PROTOCOL = "CSA"
+
+ def initialize(player, password)
+ @gamename = nil
+ super
+ @player.protocol = PROTOCOL
+ end
+
+ def parse_password(password)
+ if Login.good_game_name?(password)
+ @gamename = password
+ @player.set_password(nil)
+ elsif password.split(",").size > 1
+ @gamename, *trip = password.split(",")
+ @player.set_password(trip.join(","))
+ else
+ @player.set_password(password)
+ @gamename = Default_Game_Name
+ end
+ @gamename = self.class.good_game_name?(@gamename) ? @gamename : Default_Game_Name
+ end
+
+ def process
+ super
+ @csa_1st_str = "%%GAME #{@gamename} *"
+ end
+end
+
+######################################################
+# Processes LOGIN for the extented mode.
+#
+class Loginx1 < Login
+ PROTOCOL = "x1"
+
+ def initialize(player, password)
+ super
+ @player.protocol = PROTOCOL
+ end
+
+ def parse_password(password)
+ @player.set_password(password)
+ end
+
+ def process
+ super
+ @player.write_safe(sprintf("##[LOGIN] +OK %s\n", PROTOCOL))
+ end
+end
+
+
class BasicPlayer
# Idetifier of the player in the rating system
attr_accessor :id
# Score in the rating sysem
attr_accessor :rate
+ # Group in the rating system
+ attr_accessor :rating_group
+
# Last timestamp when the rate was modified
attr_accessor :modified_at
-
-
def initialize
@name = nil
@password = nil
end
end
+
class Player < BasicPlayer
def initialize(str, socket)
super()
@game_name = ""
@mytime = 0 # set in start method also
@sente = nil
- @writer_thread = nil
- @main_thread = nil
@write_queue = Queue::new
- login(str)
+ @main_thread = Thread::current
+ @writer_thread = Thread::start do
+ Thread.pass
+ writer()
+ end
end
attr_accessor :socket, :status
if (@status != "finished")
@status = "finished"
log_message(sprintf("user %s finish", @name))
+ # TODO you should confirm that there is no message in the queue.
Thread::kill(@writer_thread) if @writer_thread
begin
- @socket.close if (! @socket.closed?)
+# @socket.close if (! @socket.closed?)
rescue
log_message(sprintf("user %s finish failed", @name))
end
def writer
while (str = @write_queue.pop)
- @socket.write_safe(str)
+ begin
+ @socket.write(str)
+ rescue Exception => ex
+ log_error("Failed to send a message to #{@name}.")
+ log_error("#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
+ return
+ end
end
end
end
end
- def write_help
- @socket.write_safe('##[HELP] available commands "%%WHO", "%%CHAT str", "%%GAME game_name +", "%%GAME game_name -"')
- end
-
- def login(str)
- str =~ /([\r\n]*)$/
- @eol = $1
- str.chomp!
- (login, @name, password, ext) = str.split
- set_password(password)
- if (ext)
- @protocol = "x1"
- else
- @protocol = "CSA"
- end
- @main_thread = Thread::current
- @writer_thread = Thread::start do
- writer()
- end
- end
-
- def run
- write_safe(sprintf("LOGIN:%s OK\n", @name))
- if (@protocol != "CSA")
- log_message(sprintf("user %s run in %s mode", @name, @protocol))
- write_safe(sprintf("##[LOGIN] +OK %s\n", @protocol))
- else
- log_message(sprintf("user %s run in CSA mode", @name))
- if (good_game_name?(@password))
- csa_1st_str = "%%GAME #{@password} *"
- else
- csa_1st_str = "%%GAME #{Default_Game_Name} *"
- end
- end
-
+ def run(csa_1st_str=nil)
while (csa_1st_str || (str = @socket.gets_safe(Default_Timeout)))
begin
+ if (@writer_thread == nil || @writer_thread.status == false)
+ # The writer_thread has been killed because of socket errors.
+ return
+ end
+
$mutex.lock
if (csa_1st_str)
str = csa_1st_str
if (@status == "finished")
return
end
- str.chomp! if (str.class == String)
+ str.chomp! if (str.class == String) # may be strip! ?
case str
+ when ""
+ # Application-level protocol for Keep-Alive
+ # If the server gets LF, it sends back LF.
+ # 30 sec rule (client may not send LF again within 30 sec) is not implemented yet.
+ write_safe("\n")
when /^[\+\-][^%]/
if (@status == "game")
array_str = str.split(",")
end
s = @game.handle_one_move(move, self)
@game.fh.print("#{comment}\n") if (comment && !s)
- return if (s && @protocol == "CSA")
+ return if (s && @protocol == LoginCSA::PROTOCOL)
end
when /^%[^%]/, :timeout
if (@status == "game")
s = @game.handle_one_move(str, self)
- return if (s && @protocol == "CSA")
+ return if (s && @protocol == LoginCSA::PROTOCOL)
+ # else
+ # begin
+ # @socket.write("##[KEEPALIVE] #{Time.now}\n")
+ # rescue Exception => ex
+ # log_error("Failed to send a keepalive to #{@name}.")
+ # log_error("#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
+ # return
+ # end
end
+ when :exception
+ log_error("Failed to receive a message from #{@name}.")
+ return
when /^REJECT/
if (@status == "agree_waiting")
@game.reject(@name)
- return if (@protocol == "CSA")
+ return if (@protocol == LoginCSA::PROTOCOL)
else
write_safe(sprintf("##[ERROR] you are in %s status. AGREE is valid in agree_waiting status\n", @status))
end
LEAGUE.games[game_id].monitoroff(self)
end
when /^%%HELP/
- write_help
+ write_safe(
+ %!##[HELP] available commands "%%WHO", "%%CHAT str", "%%GAME game_name +", "%%GAME game_name -"\n!)
when /^%%RATING/
players = LEAGUE.rated_players
players.sort {|a,b| b.rate <=> a.rate}.each do |p|
command_name = $1
game_name = $2
my_sente_str = $3
- if (! good_game_name?(game_name))
+ if (! Login::good_game_name?(game_name))
write_safe(sprintf("##[ERROR] bad game name\n"))
next
elsif ((@status == "connected") || (@status == "game_waiting"))
when /^%%CHAT\s+(.+)/
message = $1
LEAGUE.players.each do |name, player|
- if (player.protocol != "CSA")
+ if (player.protocol != LoginCSA::PROTOCOL)
player.write_safe(sprintf("##[CHAT][%s] %s\n", @name, message))
end
end
@status = "connected"
write_safe("LOGOUT:completed\n")
return
+ when /^CHALLENGE/
+ # This command is only available for CSA's official testing server.
+ # So, this means nothing for this program.
+ write_safe("CHALLENGE ACCEPTED\n")
when /^\s*$/
## ignore null string
else
- write_safe(sprintf("##[ERROR] unknown command %s\n", str))
+ msg = "##[ERROR] unknown command %s\n" % [str]
+ write_safe(msg)
+ log_error(msg)
end
ensure
$mutex.unlock
return true
end
+ # sente is nil only if tests in test_board run
def handle_one_move(str, sente=nil)
if (str =~ /^([\+\-])(\d)(\d)(\d)(\d)([A-Z]{2})/)
sg = $1
return :illegal
end
+
if (sg == "+")
- sente = true
+ sente = true if sente == nil # deprecated
+ return :illegal unless sente == true # black player's move must be black
hands = @sente_hands
else
- sente = false
+ sente = false if sente == nil # deprecated
+ return :illegal unless sente == false # white player's move must be white
hands = @gote_hands
end
@id = sprintf("%s+%s+%s+%s+%s",
LEAGUE.event, @game_name, @sente.name, @gote.name, issue_current_time)
- @logfile = @id + ".csa"
+ @logfile = File.join(LEAGUE.dir, @id + ".csa")
LEAGUE.games[@id] = self
@sente.status = "connected"
@gote.status = "connected"
- if (@current_player.protocol == "CSA")
+ if (@current_player.protocol == LoginCSA::PROTOCOL)
@current_player.finish
end
- if (@next_player.protocol == "CSA")
+ if (@next_player.protocol == LoginCSA::PROTOCOL)
@next_player.finish
end
@monitors = Array::new
end
end
end
+end # module ShogiServer
#################################################
# MAIN
shogi-server - server for CSA server protocol
SYNOPSIS
- shogi-server event_name port_number
+ shogi-server [OPTIONS] event_name port_number
DESCRIPTION
server for CSA server protocol
OPTIONS
--pid-file file
specify filename for logging process ID
+ --daemon dir
+ run as a daemon. Log files will be put in dir.
LICENSE
this file is distributed under GPL version2 and might be compiled by Exerb
SEE ALSO
RELEASE
- #{Release}
+ #{ShogiServer::Release}
REVISION
- #{Revision}
+ #{ShogiServer::Revision}
EOM
end
def log_message(str)
- printf("%s message: %s\n", Time::new.to_s, str)
+ $logger.info(str)
end
def log_warning(str)
- printf("%s warning: %s\n", Time::new.to_s, str)
+ $logger.warn(str)
end
def log_error(str)
- printf("%s error: %s\n", Time::new.to_s, str)
+ $logger.error(str)
end
def parse_command_line
options = Hash::new
- parser = GetoptLong.new
- parser.ordering = GetoptLong::REQUIRE_ORDER
- parser.set_options(
- ["--pid-file", GetoptLong::REQUIRED_ARGUMENT])
-
+ parser = GetoptLong.new( ["--daemon", GetoptLong::REQUIRED_ARGUMENT],
+ ["--pid-file", GetoptLong::REQUIRED_ARGUMENT]
+ )
parser.quiet = true
begin
parser.each_option do |name, arg|
return options
end
-def good_game_name?(str)
- if ((str =~ /^(.+)-\d+-\d+$/) &&
- (good_identifier?($1)))
- return true
- else
- return false
- end
-end
-
-def good_identifier?(str)
- if str =~ /\A[\w\d_@\-\.]{1,#{Max_Identifier_Length}}\z/
- return true
- else
- return false
- end
-end
-
-def good_login?(str)
- tokens = str.split
- if (((tokens.length == 3) || ((tokens.length == 4) && tokens[3] == "x1")) &&
- (tokens[0] == "LOGIN") &&
- (good_identifier?(tokens[1])))
- return true
- else
- return false
- end
-end
-
-def write_pid_file(file)
+def write_pid_file(file)
open(file, "w") do |fh|
fh.print Process::pid, "\n"
end
end
def main
+
$mutex = Mutex::new
Thread::start do
Thread.pass
write_pid_file($options["pid-file"]) if ($options["pid-file"])
- server = TCPserver.open(port)
+ dir = $options["daemon"] || nil
+ if dir && ! File.exist?(dir)
+ FileUtils.mkdir(dir)
+ end
+ log_file = dir ? File.join(dir, "shogi-server.log") : STDOUT
+ $logger = WEBrick::Log.new(log_file)
+
+ LEAGUE.dir = dir || File.dirname(__FILE__)
+ LEAGUE.setup_players_database
+
+ config = {}
+ config[:Port] = port
+ config[:ServerType] = WEBrick::Daemon if $options["daemon"]
+ config[:Logger] = $logger
+
+ server = WEBrick::GenericServer.new(config)
+ ["INT", "TERM"].each {|signal| trap(signal){ server.shutdown } }
+ $stderr.puts("server started as a deamon") if $options["daemon"]
log_message("server started")
- while true
- Thread::start(server.accept) do |client|
- Thread.pass
- client.sync = true
+ server.start do |client|
+ # client.sync = true # this is already set in WEBrick
+ client.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+ # Keepalive time can be set by /proc/sys/net/ipv4/tcp_keepalive_time
player = nil
- while (str = client.gets_timeout(Login_Time))
+ login = nil
+ while (str = client.gets_timeout(ShogiServer::Login_Time))
begin
$mutex.lock
str =~ /([\r\n]*)$/
eol = $1
- if (good_login?(str))
- player = Player::new(str, client)
+ if (ShogiServer::Login::good_login?(str))
+ player = ShogiServer::Player::new(str, client)
+ player.eol = eol
+ login = ShogiServer::Login::factory(str, player)
if (LEAGUE.players[player.name])
if ((LEAGUE.players[player.name].password == player.password) &&
(LEAGUE.players[player.name].status != "game"))
log_message(sprintf("user %s login forcely", player.name))
LEAGUE.players[player.name].kill
else
- client.write_safe("LOGIN:incorrect" + eol)
- client.write_safe(sprintf("username %s is already connected%s", player.name, eol)) if (str.split.length >= 4)
- client.close
- Thread::exit
- return
+ login.incorrect_duplicated_player(str)
+ #Thread::exit
+ #return
+ # TODO
+ player = nil
+ break
end
end
LEAGUE.add(player)
end
end # login loop
if (! player)
- client.close
- Thread::exit
- return
+ #client.close
+ #Thread::exit
+ #return
+ next
end
log_message(sprintf("user %s login", player.name))
- player.run
+ login.process
+ player.run(login.csa_1st_str)
begin
$mutex.lock
if (player.game)
ensure
$mutex.unlock
end
- end
end
end
+
if ($0 == __FILE__)
- LEAGUE = League::new
+ STDOUT.sync = true
+ STDERR.sync = true
+ TCPSocket.do_not_reverse_lookup = true
+ Thread.abort_on_exception = true
+
+ LEAGUE = ShogiServer::League::new
main
end
OSDN Git Service
