-#! /usr/bin/env ruby
+#! /usr/bin/ruby
# $Id$
#
# Author:: NABEYA Kenichi, Daigo Moriwaki
#
#--
# Copyright (C) 2004 NABEYA Kenichi (aka nanami@2ch)
-# Copyright (C) 2007-2008 Daigo Moriwaki (daigo at debian dot org)
+# Copyright (C) 2007-2012 Daigo Moriwaki (daigo at debian dot org)
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
$league = nil
$logger = nil
$config = nil
-$:.unshift File.dirname(__FILE__)
+$:.unshift(File.dirname(File.expand_path(__FILE__)))
require 'shogi_server'
require 'shogi_server/config'
require 'shogi_server/util'
require 'shogi_server/league/floodgate_thread.rb'
+require 'pathname'
require 'tempfile'
#################################################
# MAIN
#
+ONE_DAY = 3600 * 24 # in seconds
+
ShogiServer.reload
# Return
def usage
print <<EOM
NAME
- shogi-server - server for CSA server protocol
+ shogi-server - server for CSA server protocol
SYNOPSIS
- shogi-server [OPTIONS] event_name port_number
+ shogi-server [OPTIONS] event_name port_number
DESCRIPTION
- server for CSA server protocol
+ server for CSA server protocol
OPTIONS
- --pid-file file
- specify filename for logging process ID
+ event_name
+ a prefix of record files.
+ port_number
+ a port number for the server to listen.
+ 4081 is often used.
+ --least-time-per-move n
+ Least time in second per move: 0, 1 (default 1).
+ - 0: The new rule that CSA introduced in November 2014.
+ - 1: The old rule before it.
+ --max-identifier n
+ maximum length of an identifier
+ --max-moves n
+ when a game with the n-th move played does not end, make the game a draw.
+ Default 256. 0 disables this feature.
+ --pid-file file
+ a file path in which a process ID will be written.
+ Use with --daemon option.
--daemon dir
run as a daemon. Log files will be put in dir.
--floodgate-games game_A[,...]
- enable Floodgate with various game names.
+ enable Floodgate with various game names (separated by a comma)
--player-log-dir dir
- log network messages for each player. Log files
+ enable to log network messages for players. Log files
will be put in the dir.
+EXAMPLES
+
+ 1. % ./shogi-server test 4081
+ Run the shogi-server. Then clients can connect to port#4081.
+ The server output logs to the stdout.
+
+ 2. % ./shogi-server --max-moves 0 --least-time-per-move 1 test 4081
+ Run the shogi-server in compliance with CSA Protocol V1.1.2 or before.
+
+ 3. % ./shogi-server --daemon . --pid-file ./shogi-server.pid \
+ --player-log-dir ./player-logs \
+ test 4081
+ Run the shogi-server as a daemon. The server outputs regular logs
+ to shogi-server.log located in the current directory and network
+ messages in ./player-logs directory.
+
+ 4. % ./shogi-server --daemon . --pid-file ./shogi-server.pid \
+ --player-log-dir ./player-logs \
+ --floodgate-games floodgate-900-0,floodgate-3600-0 \
+ test 4081
+ Run the shogi-server with two groups of Floodgate games.
+ Configuration files allow you to schedule starting times. Consult
+ floodgate-0-240.conf.sample or shogi_server/league/floodgate.rb
+ for format details.
+
+GRACEFUL SHUTDOWN
+
+ A file named "STOP" in the base directory prevents the server from
+ starting new games including Floodgate matches.
+ When you want to stop the server gracefully, first, create a STOP file
+
+ $ touch STOP
+
+ then wait for a while until all the running games complete.
+ Now you can stop the process with no game interruptted by the 'kill'
+ command.
+
+ Note that when a server gets started, a STOP file, if any, will be
+ deleted automatically.
+
+FLOODGATE SCHEDULE CONFIGURATIONS
+
+ You need to set starting times of floodgate groups in
+ configuration files under the top directory. Each floodgate
+ group requires a corresponding configuration file named
+ "<game_name>.conf". The file will be re-read once just after a
+ game starts.
+
+ For example, a floodgate-3600-30 game group requires
+ floodgate-3600-30.conf. However, for floodgate-900-0 and
+ floodgate-3600-0, which were default enabled in previous
+ versions, configuration files are optional if you are happy with
+ default time settings.
+ File format is:
+ Line format:
+ # This is a comment line
+ DoW Time
+ ...
+ where
+ DoW := "Sun" | "Mon" | "Tue" | "Wed" | "Thu" | "Fri" | "Sat" |
+ "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" |
+ "Friday" | "Saturday"
+ Time := HH:MM
+
+ For example,
+ Sat 13:00
+ Sat 22:00
+ Sun 13:00
+
+ PAREMETER SETTING
+
+ In addition, this configuration file allows to set parameters
+ for the specific Floodaget group. A list of parameters is the
+ following:
+
+ * pairing_factory:
+ Specifies a factory function name generating a pairing
+ method which will be used in a specific Floodgate game.
+ ex. set pairing_factory floodgate_zyunisen
+ * sacrifice:
+ Specifies a sacrificed player.
+ ex. set sacrifice gps500+e293220e3f8a3e59f79f6b0efffaa931
+
LICENSE
- GPL versoin 2 or later
+ GPL versoin 2 or later
SEE ALSO
-RELEASE
- #{ShogiServer::Release}
-
REVISION
- #{ShogiServer::Revision}
+ #{ShogiServer::Revision}
EOM
end
def parse_command_line
options = Hash::new
parser = GetoptLong.new(
- ["--daemon", GetoptLong::REQUIRED_ARGUMENT],
- ["--floodgate-games", GetoptLong::REQUIRED_ARGUMENT],
- ["--pid-file", GetoptLong::REQUIRED_ARGUMENT],
- ["--player-log-dir", GetoptLong::REQUIRED_ARGUMENT])
+ ["--daemon", GetoptLong::REQUIRED_ARGUMENT],
+ ["--floodgate-games", GetoptLong::REQUIRED_ARGUMENT],
+ ["--least-time-per-move", GetoptLong::REQUIRED_ARGUMENT],
+ ["--max-identifier", GetoptLong::REQUIRED_ARGUMENT],
+ ["--max-moves", GetoptLong::REQUIRED_ARGUMENT],
+ ["--pid-file", GetoptLong::REQUIRED_ARGUMENT],
+ ["--player-log-dir", GetoptLong::REQUIRED_ARGUMENT])
parser.quiet = true
begin
parser.each_option do |name, arg|
if $options["pid-file"]
$options["pid-file"] = File.expand_path($options["pid-file"], $topdir)
+ path = Pathname.new($options["pid-file"])
+ path.dirname().mkpath()
unless ShogiServer::is_writable_file? $options["pid-file"]
usage
$stderr.puts "Can not create the pid file: %s" % [$options["pid-file"]]
$stderr.puts "WARNING: --floodgate-history has been deprecated."
$options["floodgate-history"] = nil
end
+
+ $options["max-moves"] ||= ShogiServer::Default_Max_Moves
+ $options["max-moves"] = $options["max-moves"].to_i
+
+ $options["max-identifier"] ||= ShogiServer::Default_Max_Identifier_Length
+ $options["max-identifier"] = $options["max-identifier"].to_i
+
+ $options["least-time-per-move"] ||= ShogiServer::Default_Least_Time_Per_Move
+ $options["least-time-per-move"] = $options["least-time-per-move"].to_i
end
# See if a file can be created in the directory.
player = ShogiServer::Player::new(str, client, eol)
login = ShogiServer::Login::factory(str, player)
if (current_player = $league.find(player.name))
+ # Even if a player is in the 'game' state, when the status of the
+ # player has not been updated for more than a day, it is very
+ # likely that the player is stalling. In such a case, a new player
+ # can override the current player.
if (current_player.password == player.password &&
- current_player.status != "game")
- log_message(sprintf("user %s login forcely", player.name))
+ (current_player.status != "game" ||
+ Time.now - current_player.last_command_at > ONE_DAY))
+ log_message("player %s login forcibly, nudging the former player" % [player.name])
+ log_message(" the former player was in %s and received the last command at %s" % [current_player.status, current_player.last_command_at])
current_player.kill
else
login.incorrect_duplicated_player(str)
$league.dir = $topdir
config = {}
+ config[:BindAddress] = "0.0.0.0"
config[:Port] = port
config[:ServerType] = WEBrick::Daemon if $options["daemon"]
config[:Logger] = $logger
$stderr.puts("server started as a deamon [Revision: #{ShogiServer::Revision}]") if $options["daemon"]
log_message("server started [Revision: #{ShogiServer::Revision}]")
+ if ShogiServer::STOP_FILE.exist?
+ log_message("Deleted the STOP file")
+ ShogiServer::STOP_FILE.delete
+ end
+
server.start do |client|
+ begin
# 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, login = login_loop(client) # loop
- next unless player
+ unless player
+ log_error("Detected a timed out login attempt")
+ next
+ end
log_message(sprintf("user %s login", player.name))
login.process
if (player.game)
player.game.kill(player)
end
- player.finish # socket has been closed
+ player.finish
$league.delete(player)
log_message(sprintf("user %s logout", player.name))
ensure
$mutex.unlock
end
+ player.wait_write_thread_finish(1000) # milliseconds
+ rescue Exception => ex
+ log_error("server.start: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
+ end
end
end
OSDN Git Service
