OSDN Git Service

Apply CSA Protocol V1.2.1 for MAX_MOVES
[shogi-server/shogi-server.git] / shogi-server
index 1058135..8468b1f 100755 (executable)
@@ -1,4 +1,4 @@
-#! /usr/bin/env ruby
+#! /usr/bin/ruby
 # $Id$
 #
 # Author:: NABEYA Kenichi, Daigo Moriwaki
@@ -6,7 +6,7 @@
 #
 #--
 # 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
@@ -29,10 +29,11 @@ $topdir = nil
 $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 'tempfile'
 
 #################################################
@@ -41,6 +42,12 @@ require 'tempfile'
 
 ShogiServer.reload
 
+# Return
+#   - a received string
+#   - :timeout
+#   - :exception
+#   - nil when a socket is closed
+#
 def gets_safe(socket, timeout=nil)
   if r = select([socket], nil, nil, timeout)
     return r[0].first.gets
@@ -55,33 +62,110 @@ end
 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-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 (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 --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.
+
+        3. % ./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.
+
+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
@@ -114,9 +198,12 @@ end
 def parse_command_line
   options = Hash::new
   parser = GetoptLong.new(
-    ["--daemon",            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-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|
@@ -168,10 +255,29 @@ def check_command_line
     end
   end
 
+  if $options["floodgate-games"]
+    names = $options["floodgate-games"].split(",")
+    new_names = 
+      names.select do |name|
+        ShogiServer::League::Floodgate::game_name?(name)
+      end
+    if names.size != new_names.size
+      $stderr.puts "Found a wrong Floodgate game: %s" % [names.join(",")]
+      exit 6
+    end
+    $options["floodgate-games"] = new_names
+  end
+
   if $options["floodgate-history"]
     $stderr.puts "WARNING: --floodgate-history has been deprecated."
     $options["floodgate-history"] = nil
   end
+
+  $options["max-moves"] ||= 256
+  $options["max-moves"] = $options["max-moves"].to_i
+
+  $options["least-time-per-move"] ||= 0
+  $options["least-time-per-move"] = $options["least-time-per-move"].to_i
 end
 
 # See if a file can be created in the directory.
@@ -278,73 +384,6 @@ def setup_watchdog_for_giant_lock
   end
 end
 
-def floodgate_reload_log(leagues)
-  floodgate = leagues.min {|a,b| a.next_time <=> b.next_time}
-  diff = floodgate.next_time - Time.now
-  log_message("Floodgate reloaded. The next match will start at %s in %d seconds" % 
-              [floodgate.next_time, diff])
-end
-
-def setup_floodgate(game_names)
-  return Thread.start(game_names) do |game_names|
-    Thread.pass
-    leagues = game_names.collect do |game_name|
-      ShogiServer::League::Floodgate.new($league, 
-                                         {:game_name => game_name})
-    end
-    leagues.delete_if do |floodgate|
-      ret = false
-      unless floodgate.next_time 
-        log_error("Unsupported game name: %s" % floodgate.game_name)
-        ret = true
-      end
-      ret
-    end
-    if leagues.empty?
-      log_error("No valid Floodgate game names found")
-      return # exit from this thread
-    end
-    floodgate_reload_log(leagues)
-
-    while (true)
-      begin
-        floodgate = leagues.min {|a,b| a.next_time <=> b.next_time}
-        diff = floodgate.next_time - Time.now
-        if diff > 0
-          floodgate_reload_log(leagues) if $DEBUG
-          sleep(diff/2)
-          next
-        end
-        next_array = leagues.collect do |floodgate|
-          if (floodgate.next_time - Time.now) > 0
-            [floodgate.game_name, floodgate.next_time]
-          else
-            log_message("Starting Floodgate games...: %s" % [floodgate.game_name])
-            $league.reload
-            floodgate.match_game
-            floodgate.charge
-            [floodgate.game_name, floodgate.next_time] # next_time has been updated
-          end
-        end
-        $mutex.synchronize do
-          log_message("Reloading source...")
-          ShogiServer.reload
-        end
-        # Regenerate floodgate instances after ShogiServer.realod
-        leagues = next_array.collect do |game_name, next_time|
-          floodgate = ShogiServer::League::Floodgate.new($league, 
-                                                         {:game_name => game_name,
-                                                          :next_time => next_time})
-        end
-        floodgate_reload_log(leagues)
-      rescue Exception => ex 
-        # ignore errors
-        log_error("[in Floodgate's thread] #{ex} #{ex.backtrace}")
-      end
-    end
-  end
-end
-
 def main
   
   $options = parse_command_line
@@ -362,11 +401,12 @@ def main
   $league.dir = $topdir
 
   config = {}
+  config[:BindAddress] = "0.0.0.0"
   config[:Port]       = port
   config[:ServerType] = WEBrick::Daemon if $options["daemon"]
   config[:Logger]     = $logger
 
-  fg_thread = nil
+  setup_floodgate = nil
 
   config[:StartCallback] = Proc.new do
     srand
@@ -375,7 +415,8 @@ def main
     end
     setup_watchdog_for_giant_lock
     $league.setup_players_database
-    fg_thread = setup_floodgate(["floodgate-900-0", "floodgate-3600-0"])
+    setup_floodgate = ShogiServer::SetupFloodgate.new($options["floodgate-games"])
+    setup_floodgate.start
   end
 
   config[:StopCallback] = Proc.new do
@@ -389,7 +430,7 @@ def main
   ["INT", "TERM"].each do |signal| 
     trap(signal) do
       server.shutdown
-      fg_thread.kill if fg_thread
+      setup_floodgate.kill
     end
   end
   unless (RUBY_PLATFORM.downcase =~ /mswin|mingw|cygwin|bccwin/)
@@ -401,11 +442,15 @@ def main
   log_message("server started [Revision: #{ShogiServer::Revision}]")
 
   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
@@ -416,12 +461,16 @@ def main
         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