Commit: 36b41e7cb23be85e2c766bc3ee2b27bce2c870c3 - shogi-server (git)

shogi-server source

Commit MetaInfo

• Revision: 36b41e7cb23be85e2c766bc3ee2b27bce2c870c3 (tree)
• Time: 2020-12-06 18:48:46
• Author: Daigo Moriwaki <beatles@sgtp...>
• Commiter: Daigo Moriwaki

Log Message

Merge branch 'master' into wdoor-stable

Change Summary

• modified: changelog
• modified: shogi-server
• modified: shogi_server.rb
• modified: shogi_server/board.rb
• modified: shogi_server/command.rb
• modified: test/TC_board.rb
• modified: test/TC_command.rb
• modified: test/mock_log_message.rb

Incremental Difference

--- a/changelog
+++ b/changelog
@@ -1,3 +1,20 @@
[phone]  Daigo Moriwaki <daigo at debian dot org>
+
+	* [shogi-server] Improve timed-up detection (continued).
+	  The server now checks timed up when it receives a-single-space keep
+	  alive messages as well.
+	  Thanks to mizar for reports and patches.
+	  (Closes #40821)
+	* [shogi-server] Support listening on IPv6 addresses
+	  Thanks to mizar for a patch.
+	  (Closes #40822)
+	* [shogi-server] Make invalid comments illegal
+	  Some client sent moves with comments in an invalid format like
+	  "+7776FU '* 30 -3334FU +2726FU". Such messages are now deemed
+	  illegal.
+	  Thanks to mizar for a report.
+	* [shogi-server] Bump up the revision to 20201206
+
 2020-10-04  Daigo Moriwaki <daigo at debian dot org>
 
 	* [shogi-server] Improve timed-up detection.

--- a/shogi-server
+++ b/shogi-server
@@ -440,7 +440,7 @@ def main
   $players = Set.new
 
   config = {}
-  config[:BindAddress] = "0.0.0.0"
+  config[:BindAddress] = nil # both IPv4 and IPv6
   config[:Port]       = port
   config[:ServerType] = WEBrick::Daemon if $options["daemon"]
   config[:Logger]     = $logger

--- a/shogi_server.rb
+++ b/shogi_server.rb
@@ -53,7 +53,7 @@ Default_Max_Moves = 256
 Default_Least_Time_Per_Move = 0
 One_Time = 10
 Login_Time = 300                # time for LOGIN
-Revision = "20201004"
+Revision = "20201206"
 
 RELOAD_FILES = ["shogi_server/league/floodgate.rb",
                 "shogi_server/league/persistent.rb",

--- a/shogi_server/board.rb
+++ b/shogi_server/board.rb
@@ -642,7 +642,7 @@ EOF
   #   - :max_moves
   #
   def handle_one_move(str, sente=nil)
-    if (str =~ /^([\+\-])(\d)(\d)(\d)(\d)([A-Z]{2})/)
+    if (str =~ /^([\+\-])(\d)(\d)(\d)(\d)([A-Z]{2})$/)
       sg = $1
       x0 = $2.to_i
       y0 = $3.to_i

--- a/shogi_server/command.rb
+++ b/shogi_server/command.rb
@@ -28,7 +28,7 @@ module ShogiServer
     def Command.factory(str, player, time=Time.now)
       cmd = nil
       case str
-      when "", /^%[^%]/, :timeout
+      when "", " ", /^%[^%]/, :timeout
         cmd = SpecialCommand.new(str, player)
       when /^[\+\-][^%]/
         cmd = MoveCommand.new(str, player)
@@ -174,9 +174,15 @@ module ShogiServer
 
   # Command like "%TORYO", :timeout, or keep alive
   #
-  # Keep Alive is an application-level protocol. Whenever the server receives
-  # an LF, it sends back an LF.  Note that the 30 sec rule (client may not send
-  # LF again within 30 sec) is not implemented yet.
+  # Keep Alive is an application-level protocol here. There are two representations:
+  # 1) LF (empty string)
+  #    The server sends back an LF (empty string).
+  #    Note that the 30 sec rule (client may not send LF again within 30 sec)
+  #    is not implemented yet.
+  #    This is compliant with CSA's protocol in certain situations.
+  # 2) Space + LF (a single space)
+  #    The sever replies nothing.
+  #    This is an enhancement to CSA's protocol.
   #
   class SpecialCommand < Command
     def initialize(str, player)
@@ -186,9 +192,9 @@ module ShogiServer
     def call
       rc = :continue
 
-      if @str == "" # keep alive
+      if @str == "" || @str == " " # keep alive
         log_debug("received keep alive from #{@player.name}")
-        @player.write_safe("\n")
+        @player.write_safe("\n") if @str == ""
         # Fall back to :timeout to check the game gets timed up
         @str = :timeout
       end

--- a/test/TC_board.rb
+++ b/test/TC_board.rb
@@ -998,3 +998,23 @@ class TestSplitMoves < Test::Unit::TestCase
     end
   end
 end
+
+
+class Test_illegal < Test::Unit::TestCase
+  def test_invaild_comment
+    b = ShogiServer::Board.new
+    b.set_from_str(<<EOM)
+P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
+P2 * -HI *  *  *  *  * -KA * 
+P3-FU-FU-FU-FU-FU-FU-FU-FU-FU
+P4 *  *  *  *  *  *  *  *  * 
+P5 *  *  *  *  *  *  *  *  * 
+P6 *  *  *  *  *  *  *  *  * 
+P7+FU+FU+FU+FU+FU+FU+FU+FU+FU
+P8 * +KA *  *  *  *  * +HI * 
+P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
+EOM
+
+    assert_equal(:illegal, b.handle_one_move("+7776FU '* 30 -3334FU +2726FU"))
+  end
+end

--- a/test/TC_command.rb
+++ b/test/TC_command.rb
@@ -90,7 +90,12 @@ class TestFactoryMethod < Test::Unit::TestCase
 
   def test_keep_alive_command
     cmd = ShogiServer::Command.factory("", @p)
-    assert_instance_of(ShogiServer::KeepAliveCommand, cmd)
+    assert_instance_of(ShogiServer::SpecialCommand, cmd)
+  end
+
+  def test_keep_alive_command_space
+    cmd = ShogiServer::Command.factory(" ", @p)
+    assert_instance_of(ShogiServer::SpecialCommand, cmd)
   end
 
   def test_move_command
@@ -214,7 +219,7 @@ class TestFactoryMethod < Test::Unit::TestCase
   end
 
   def test_space_command
-    cmd = ShogiServer::Command.factory(" ", @p)
+    cmd = ShogiServer::Command.factory("  ", @p)
     assert_instance_of(ShogiServer::SpaceCommand, cmd)
   end
 
@@ -315,20 +320,6 @@ end
 
 #
 #
-class TestKeepAliveCommand < Test::Unit::TestCase 
-  def setup
-    @p = MockPlayer.new
-  end
-
-  def test_call
-    cmd = ShogiServer::KeepAliveCommand.new("", @p)
-    rc = cmd.call
-    assert_equal(:continue, rc)
-  end
-end
-
-#
-#
 class TestMoveCommand < Test::Unit::TestCase
   def setup
     @p = MockPlayer.new
@@ -350,6 +341,13 @@ class TestMoveCommand < Test::Unit::TestCase
     assert_equal("'*comment", @game.log.first)
   end
 
+  def test_comment_illegal
+    cmd = ShogiServer::MoveCommand.new("+7776FU 'comment", @p)
+    rc = cmd.call
+    assert_equal(:continue, rc)
+    assert_nil(@game.log.first)
+  end
+
   def test_x1_return
     @game.finish_flag = true
     @p.protocol = ShogiServer::LoginCSA::PROTOCOL
@@ -417,6 +415,18 @@ class TestSpecialComand < Test::Unit::TestCase
     rc = cmd.call
     assert_equal(:continue, rc)
   end
+
+  def test_keep_alive
+    cmd = ShogiServer::SpecialCommand.new("", @p)
+    rc = cmd.call
+    assert_equal(:continue, rc)
+  end
+
+  def test_keep_alive_space
+    cmd = ShogiServer::SpecialCommand.new(" ", @p)
+    rc = cmd.call
+    assert_equal(:continue, rc)
+  end
 end
 
 #
@@ -822,7 +832,7 @@ class TestSpaceCommand < Test::Unit::TestCase
   end
 
   def test_call
-    cmd = ShogiServer::SpaceCommand.new("", @p)
+    cmd = ShogiServer::SpaceCommand.new("  ", @p)
     rc = cmd.call
 
     assert_equal(:continue, rc)

--- a/test/mock_log_message.rb
+++ b/test/mock_log_message.rb
@@ -30,3 +30,7 @@ def log_info(msg)
   $logger.info(msg)
 end
 
+def log_debug(msg)
+  $logger.info(msg)
+end
+