4 # Author:: NABEYA Kenichi, Daigo Moriwaki
5 # Homepage:: http://sourceforge.jp/projects/shogi-server/
8 # Copyright (C) 2004 NABEYA Kenichi (aka nanami@2ch)
9 # Copyright (C) 2007-2012 Daigo Moriwaki (daigo at debian dot org)
11 # This program is free software; you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 2 of the License, or
14 # (at your option) any later version.
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with this program; if not, write to the Free Software
23 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 $:.unshift(File.dirname(File.expand_path(__FILE__)))
33 require 'shogi_server'
34 require 'shogi_server/config'
35 require 'shogi_server/util'
36 require 'shogi_server/league/floodgate_thread.rb'
39 #################################################
43 ONE_DAY = 3600 * 24 # in seconds
51 # - nil when a socket is closed
53 def gets_safe(socket, timeout=nil)
54 if r = select([socket], nil, nil, timeout)
55 return r[0].first.gets
59 rescue Exception => ex
60 log_error("gets_safe: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
67 shogi-server - server for CSA server protocol
70 shogi-server [OPTIONS] event_name port_number
73 server for CSA server protocol
77 a prefix of record files.
79 a port number for the server to listen.
82 a file path in which a process ID will be written.
83 Use with --daemon option.
85 run as a daemon. Log files will be put in dir.
86 --floodgate-games game_A[,...]
87 enable Floodgate with various game names (separated by a comma)
89 enable to log network messages for players. Log files
90 will be put in the dir.
94 1. % ./shogi-server test 4081
95 Run the shogi-server. Then clients can connect to port#4081.
96 The server output logs to the stdout.
98 2. % ./shogi-server --daemon . --pid-file ./shogi-server.pid \
99 --player-log-dir ./player-logs \
101 Run the shogi-server as a daemon. The server outputs regular logs
102 to shogi-server.log located in the current directory and network
103 messages in ./player-logs directory.
105 3. % ./shogi-server --daemon . --pid-file ./shogi-server.pid \
106 --player-log-dir ./player-logs \
107 --floodgate-games floodgate-900-0,floodgate-3600-0 \
109 Run the shogi-server with two groups of Floodgate games.
110 Configuration files allow you to schedule starting times. Consult
111 floodgate-0-240.conf.sample or shogi_server/league/floodgate.rb
114 FLOODGATE SCHEDULE CONFIGURATIONS
116 You need to set starting times of floodgate groups in
117 configuration files under the top directory. Each floodgate
118 group requires a corresponding configuration file named
119 "<game_name>.conf". The file will be re-read once just after a
122 For example, a floodgate-3600-30 game group requires
123 floodgate-3600-30.conf. However, for floodgate-900-0 and
124 floodgate-3600-0, which were default enabled in previous
125 versions, configuration files are optional if you are happy with
126 default time settings.
129 # This is a comment line
133 DoW := "Sun" | "Mon" | "Tue" | "Wed" | "Thu" | "Fri" | "Sat" |
134 "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" |
135 "Friday" | "Saturday"
145 In addition, this configuration file allows to set parameters
146 for the specific Floodaget group. A list of parameters is the
150 Specifies a factory function name generating a pairing
151 method which will be used in a specific Floodgate game.
152 ex. set pairing_factory floodgate_zyunisen
154 Specifies a sacrificed player.
155 ex. set sacrifice gps500+e293220e3f8a3e59f79f6b0efffaa931
158 GPL versoin 2 or later
163 #{ShogiServer::Revision}
189 # Parse command line options. Return a hash containing the option strings
190 # where a key is the option name without the first two slashes. For example,
191 # {"pid-file" => "foo.pid"}.
193 def parse_command_line
195 parser = GetoptLong.new(
196 ["--daemon", GetoptLong::REQUIRED_ARGUMENT],
197 ["--floodgate-games", GetoptLong::REQUIRED_ARGUMENT],
198 ["--pid-file", GetoptLong::REQUIRED_ARGUMENT],
199 ["--player-log-dir", GetoptLong::REQUIRED_ARGUMENT])
202 parser.each_option do |name, arg|
204 options[name] = arg.dup
208 raise parser.error_message
213 # Check command line options.
214 # If any of them is invalid, exit the process.
216 def check_command_line
217 if (ARGV.length != 2)
222 if $options["daemon"]
223 $options["daemon"] = File.expand_path($options["daemon"], File.dirname(__FILE__))
224 unless is_writable_dir? $options["daemon"]
226 $stderr.puts "Can not create a file in the daemon directory: %s" % [$options["daemon"]]
231 $topdir = $options["daemon"] || File.expand_path(File.dirname(__FILE__))
233 if $options["player-log-dir"]
234 $options["player-log-dir"] = File.expand_path($options["player-log-dir"], $topdir)
235 unless is_writable_dir?($options["player-log-dir"])
237 $stderr.puts "Can not write a file in the player log dir: %s" % [$options["player-log-dir"]]
242 if $options["pid-file"]
243 $options["pid-file"] = File.expand_path($options["pid-file"], $topdir)
244 unless ShogiServer::is_writable_file? $options["pid-file"]
246 $stderr.puts "Can not create the pid file: %s" % [$options["pid-file"]]
251 if $options["floodgate-games"]
252 names = $options["floodgate-games"].split(",")
254 names.select do |name|
255 ShogiServer::League::Floodgate::game_name?(name)
257 if names.size != new_names.size
258 $stderr.puts "Found a wrong Floodgate game: %s" % [names.join(",")]
261 $options["floodgate-games"] = new_names
264 if $options["floodgate-history"]
265 $stderr.puts "WARNING: --floodgate-history has been deprecated."
266 $options["floodgate-history"] = nil
270 # See if a file can be created in the directory.
271 # Return true if a file is writable in the directory, otherwise false.
273 def is_writable_dir?(dir)
274 unless File.directory? dir
281 temp_file = Tempfile.new("dummy-shogi-server", dir)
290 def write_pid_file(file)
291 open(file, "w") do |fh|
296 def mutex_watchdog(mutex, sec)
304 queue.push(Object.new)
307 log_error("mutex watchdog timeout: %d sec" % [sec])
315 def login_loop(client)
318 while r = select([client], nil, nil, ShogiServer::Login_Time) do
321 break unless str = r[0].first.gets
322 rescue Exception => ex
323 # It is posssible that the socket causes an error (ex. Errno::ECONNRESET)
324 log_error("login_loop: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
327 $mutex.lock # guards $league
331 if (ShogiServer::Login::good_login?(str))
332 player = ShogiServer::Player::new(str, client, eol)
333 login = ShogiServer::Login::factory(str, player)
334 if (current_player = $league.find(player.name))
335 # Even if a player is in the 'game' state, when the status of the
336 # player has not been updated for more than a day, it is very
337 # likely that the player is stalling. In such a case, a new player
338 # can override the current player.
339 if (current_player.password == player.password &&
340 (current_player.status != "game" ||
341 Time.now - current_player.modifiled_at > ONE_DAY))
342 log_message("user %s login forcely (previously modified at %s)" % [player.name, player.modified_at])
345 login.incorrect_duplicated_player(str)
353 client.write("LOGIN:incorrect" + eol)
354 client.write("type 'LOGIN name password' or 'LOGIN name password x1'" + eol) if (str.split.length >= 4)
360 return [player, login]
363 def setup_logger(log_file)
364 logger = ShogiServer::Logger.new(log_file, 'daily')
365 logger.formatter = ShogiServer::Formatter.new
366 logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
367 logger.datetime_format = "%Y-%m-%d %H:%M:%S"
371 def setup_watchdog_for_giant_lock
375 mutex_watchdog($mutex, 10)
381 $options = parse_command_line
383 $config = ShogiServer::Config.new $options
385 $league = ShogiServer::League.new($topdir)
387 $league.event = ARGV.shift
390 log_file = $options["daemon"] ? File.join($options["daemon"], "shogi-server.log") : STDOUT
391 $logger = setup_logger(log_file)
393 $league.dir = $topdir
396 config[:BindAddress] = "0.0.0.0"
398 config[:ServerType] = WEBrick::Daemon if $options["daemon"]
399 config[:Logger] = $logger
401 setup_floodgate = nil
403 config[:StartCallback] = Proc.new do
405 if $options["pid-file"]
406 write_pid_file($options["pid-file"])
408 setup_watchdog_for_giant_lock
409 $league.setup_players_database
410 setup_floodgate = ShogiServer::SetupFloodgate.new($options["floodgate-games"])
411 setup_floodgate.start
414 config[:StopCallback] = Proc.new do
415 if $options["pid-file"]
416 FileUtils.rm($options["pid-file"], :force => true)
421 server = WEBrick::GenericServer.new(config)
422 ["INT", "TERM"].each do |signal|
428 unless (RUBY_PLATFORM.downcase =~ /mswin|mingw|cygwin|bccwin/)
433 $stderr.puts("server started as a deamon [Revision: #{ShogiServer::Revision}]") if $options["daemon"]
434 log_message("server started [Revision: #{ShogiServer::Revision}]")
436 server.start do |client|
438 # client.sync = true # this is already set in WEBrick
439 client.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
440 # Keepalive time can be set by /proc/sys/net/ipv4/tcp_keepalive_time
441 player, login = login_loop(client) # loop
443 log_error("Detected a timed out login attempt")
447 log_message(sprintf("user %s login", player.name))
449 player.setup_logger($options["player-log-dir"]) if $options["player-log-dir"]
450 player.run(login.csa_1st_str) # loop
454 player.game.kill(player)
457 $league.delete(player)
458 log_message(sprintf("user %s logout", player.name))
462 player.wait_write_thread_finish(1000) # milliseconds
463 rescue Exception => ex
464 log_error("server.start: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
473 TCPSocket.do_not_reverse_lookup = true
474 Thread.abort_on_exception = $DEBUG ? true : false
478 rescue Exception => ex
480 log_error("main: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
482 $stderr.puts "main: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}"