steam-condenser 0.12.0 → 0.13.0

data/lib/steam/packets/s2a_logstring_packet.rb

@@ -0,0 +1,24 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'steam/packets/steam_packet'
+
+# The S2A_LOGSTRING packet type is used to transfer log messages.
+class S2A_LOGSTRING_Packet
+
+  include SteamPacket
+
+  # The log message contained in this packet
+  attr_reader :message
+
+  # Creates a new log message packet
+  def initialize(data)
+    super S2A_LOGSTRING_HEADER, data
+
+    @content_data.byte
+    @message = @content_data.string
+  end
+
+end

data/lib/steam/packets/s2a_player_packet.rb

@@ -1,7 +1,7 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 

data/lib/steam/packets/s2a_rules_packet.rb

@@ -1,7 +1,7 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
@@ -15,7 +15,7 @@ class S2A_RULES_Packet
 
   # Creates a S2A_RULES response object based on the data received.
   def initialize(content_data)
-    raise Exception.new('Wrong formatted A2A_RULES response packet.') if content_data.nil?
+    raise Exception.new('Wrong formatted S2A_RULES response packet.') if content_data.nil?
 
     super SteamPacket::S2A_RULES_HEADER, content_data
 

data/lib/steam/packets/s2c_challenge_packet.rb

@@ -1,7 +1,7 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
@@ -11,7 +11,7 @@ class S2C_CHALLENGE_Packet
 
   include SteamPacket
 
-  # Creates a AS2C_CHALLENGE response object based on the data received.
+  # Creates a S2C_CHALLENGE response object based on the data received.
   def initialize(challenge_number)
     super S2C_CHALLENGE_HEADER, challenge_number
   end

data/lib/steam/packets/s2m_heartbeat2_packet.rb

@@ -0,0 +1,57 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'steam/packets/steam_packet'
+
+# The S2M_HEARTBEAT2 packet type is used to signal a game servers availability
+# and status to the master servers.
+class S2M_HEARTBEAT2_Packet
+
+  include SteamPacket
+
+  DEFAULT_DATA = {
+    :appid     => 320,
+    :bots      => 0,
+    :challenge => nil,
+    :dedicated => 0,
+    :gamedir   => 'hl2mp',
+    :gameport  => 27015,
+    :gametype  => 'ctf',
+    :lan       => 1,
+    :map       => 'null',
+    :max       => 24,
+    :os        => 'l',
+    :password  => 0,
+    :players   => 0,
+    :product   => 'hl2dm',
+    :protocol  => 7,
+    :region    => 255,
+    :secure    => 0,
+    :specport  => 0,
+    :type      => 'd',
+    :version   => '1.0.0.0'
+  }
+
+  # Creates a new heartbeat packet to send to a master server
+  def initialize(data = {})
+    data = DEFAULT_DATA.merge data
+
+    if data[:challenge].nil?
+      raise SteamCondenserException.new 'You have to provide a challenge number when sending a heartbeat to a master server.'
+    end
+
+    bytes = 0x0A.chr
+    data.each { |k, v| bytes += "\\#{k}\\#{v}" }
+    bytes += 0x0A.chr
+
+    super S2M_HEARTBEAT2_HEADER, bytes
+  end
+
+  # Returns a byte array representation of the packet data
+  def to_s
+    [@header_data, @content_data.string].pack('ca*')
+  end
+
+end

data/lib/steam/packets/steam_packet.rb

@@ -1,30 +1,33 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'stringio_additions'
 
 # This class represents a packet used by the Source query protocol
 module SteamPacket
 
-  A2A_ACK_HEADER = 0x6A
-  A2A_PING_HEADER = 0x69
   A2M_GET_SERVERS_BATCH2_HEADER = 0x31
   A2S_INFO_HEADER = 0x54
   A2S_PLAYER_HEADER = 0x55
   A2S_RULES_HEADER = 0x56
   A2S_SERVERQUERY_GETCHALLENGE_HEADER = 0x57
+  C2M_CHECKMD5_HEADER = 0x4D
   M2A_SERVER_BATCH_HEADER = 0x66
+  M2C_ISVALIDMD5_HEADER = 0x4E
+  M2S_REQUESTRESTART_HEADER = 0x4F
   RCON_GOLDSRC_CHALLENGE_HEADER = 0x63
   RCON_GOLDSRC_NO_CHALLENGE_HEADER = 0x39
   RCON_GOLDSRC_RESPONSE_HEADER = 0x6c
   S2A_INFO_DETAILED_HEADER = 0x6D
   S2A_INFO2_HEADER = 0x49
+  S2A_LOGSTRING_HEADER = 0x52
   S2A_PLAYER_HEADER = 0x44
   S2A_RULES_HEADER = 0x45
   S2C_CONNREJECT_HEADER = 0x39
   S2C_CHALLENGE_HEADER = 0x41
+  S2M_HEARTBEAT2_HEADER = 0x30
 
   # Creates a new SteamPacket object with given header and content data
   def initialize(header_data, content_data = '')

data/lib/steam/packets/steam_packet_factory.rb

@@ -1,16 +1,12 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
-
-require 'zlib'
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'exceptions/steam_condenser_exception'
 require 'steam/packets/s2a_info_detailed_packet'
 require 'steam/packets/a2s_info_packet'
 require 'steam/packets/s2a_info2_packet'
-require 'steam/packets/a2a_ping_packet'
-require 'steam/packets/a2a_ack_packet'
 require 'steam/packets/a2s_player_packet'
 require 'steam/packets/s2a_player_packet'
 require 'steam/packets/a2s_rules_packet'
@@ -19,6 +15,9 @@ require 'steam/packets/a2s_serverquery_getchallenge_packet'
 require 'steam/packets/s2c_challenge_packet'
 require 'steam/packets/a2m_get_servers_batch2_packet'
 require 'steam/packets/m2a_server_batch_packet'
+require 'steam/packets/m2c_isvalidmd5_packet'
+require 'steam/packets/m2s_requestrestart_packet'
+require 'steam/packets/s2a_logstring_packet'
 require 'steam/packets/rcon/rcon_goldsrc_response'
 
 module SteamPacketFactory
@@ -35,10 +34,6 @@ module SteamPacketFactory
         return A2S_INFO_Packet.new
       when SteamPacket::S2A_INFO2_HEADER
         return S2A_INFO2_Packet.new(data)
-      when SteamPacket::A2A_PING_HEADER
-        return A2A_PING_Packet.new
-      when SteamPacket::A2A_ACK_HEADER
-        return A2A_ACK_Packet.new(data)
       when SteamPacket::A2S_PLAYER_HEADER
         return A2S_PLAYER_Packet.new
       when SteamPacket::S2A_PLAYER_HEADER
@@ -55,10 +50,16 @@ module SteamPacketFactory
         return A2M_GET_SERVERS_BATCH2_Packet.new(data)
       when SteamPacket::M2A_SERVER_BATCH_HEADER
         return M2A_SERVER_BATCH_Packet.new(data)
+      when SteamPacket::M2C_ISVALIDMD5_HEADER
+        return M2C_ISVALIDMD5_Packet.new(data)
+      when SteamPacket::M2S_REQUESTRESTART_HEADER
+        return M2S_REQUESTRESTART_Packet.new(data)
       when SteamPacket::RCON_GOLDSRC_CHALLENGE_HEADER,
            SteamPacket::RCON_GOLDSRC_NO_CHALLENGE_HEADER,
            SteamPacket::RCON_GOLDSRC_RESPONSE_HEADER
         return RCONGoldSrcResponse.new(data)
+      when SteamPacket::S2A_LOGSTRING_HEADER
+        return S2A_LOGSTRING_Packet.new(data)
       else
         raise SteamCondenserException.new("Unknown packet with header 0x#{header.to_s(16)} received.")
     end
@@ -68,6 +69,8 @@ module SteamPacketFactory
     packet_data = split_packets.join ''
 
     if is_compressed
+      require 'zlib'
+
       begin
         require 'bz2'
         packet_data = BZ2.uncompress(packet_data)

data/lib/steam/servers/game_server.rb

@@ -1,12 +1,11 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'exceptions/steam_condenser_exception'
 require 'steam/steam_player'
 require 'steam/packets/a2s_info_packet'
-require 'steam/packets/a2a_ping_packet'
 require 'steam/packets/a2s_player_packet'
 require 'steam/packets/a2s_rules_packet'
 require 'steam/packets/a2s_serverquery_getchallenge_packet'
@@ -14,14 +13,59 @@ require 'steam/packets/s2a_info_base_packet'
 require 'steam/packets/s2a_player_packet'
 require 'steam/packets/s2a_rules_packet'
 require 'steam/packets/s2c_challenge_packet'
+require 'steam/servers/server'
 
 module GameServer
 
+  include Server
+
   REQUEST_CHALLENGE = 0
   REQUEST_INFO = 1
   REQUEST_PLAYER = 2
   REQUEST_RULES = 3
 
+  # Parses the player attribute names supplied by +rcon status+
+  def self.player_status_attributes(status_header)
+    status_header.split.map do |attribute|
+      case attribute
+        when '#'
+          :id
+        when 'connected'
+          :time
+        when 'frag'
+          :score
+        else
+          attribute.to_sym
+      end
+    end
+  end
+
+  # Splits the player status obtained with +rcon status+
+  def self.split_player_status(attributes, player_status)
+    data = player_status[1..-1].strip.split '"'
+    data = [ data[0].split, data[1], data[2].split ]
+    data.flatten!
+
+    if attributes.size > data.size + 1
+      data.insert 1, nil
+      data.insert 4, nil, nil, nil
+    end
+
+    player_data = {}
+    data.each_index do |i|
+      player_data[attributes[i]] = data[i]
+    end
+
+    player_data
+  end
+
+  # Creates a new instance of a game server object
+  #
+  # The port defaults to 27015 for game servers
+  def initialize(address, port = 27015)
+    super
+  end
+
   # Returns the last measured response time of this server
   #
   # If there's no data, update_ping is called to measure the current response
@@ -125,14 +169,18 @@ module GameServer
   def update_player_info(rcon_password = nil)
     handle_response_for_request GameServer::REQUEST_PLAYER
 
-    unless rcon_password.nil? or @player_hash.empty?
-      rcon_auth(rcon_password)
-      players = rcon_exec('status').split("\n")[7..-1]
-      players.pop if is_a? GoldSrcServer
+    unless rcon_password.nil? || @player_hash.nil? || @player_hash.empty?
+      rcon_auth rcon_password
+      players = rcon_exec('status').lines.select do |line|
+        line.start_with?('#') && line != "#end\n"
+      end
+      attributes = GameServer.player_status_attributes players.shift
 
       players.each do |player|
-        player_data = self.class.split_player_status(player)
-        @player_hash[player_data[1]].add_info(*player_data) if @player_hash.key?(player_data[1])
+        player_data = GameServer.split_player_status(attributes, player)
+        if @player_hash.key? player_data[:name]
+          @player_hash[player_data[:name]].add_info player_data
+        end
       end
     end
   end
@@ -150,20 +198,13 @@ module GameServer
   end
 
   def update_ping
-    send_request A2A_PING_Packet.new
+    send_request A2S_INFO_Packet.new
     start_time = Time.now
     reply
     end_time = Time.now
     @ping = (end_time - start_time) * 1000
   end
 
-  # Checks whether the listening port number of the server is in a valid range
-  def initialize(port_number = 27015)
-    unless port_number.to_i > 0 and port_number.to_i < 65536
-      raise ArgumentError.new('The listening port of the server has to be a number greater than 0 and less than 65536.')
-    end
-  end
-
   def to_s
     return_string = ''
 

data/lib/steam/servers/goldsrc_server.rb

@@ -10,20 +10,15 @@ class GoldSrcServer
 
   include GameServer
 
-  # Splits the player status obtained with +rcon status+
-  def self.split_player_status(player_status)
-    player_data = player_status.match(/# *(\d+) +"(.*)" +(\d+) +(.*)/).to_a[1..-1]
-    player_data[3] = player_data[3].split
-    player_data.flatten!
-    player_data[0] = player_data[2]
-    player_data.delete_at(2)
-    player_data.delete_at(4)
-    player_data
+  def initialize(address, port = 27015, is_hltv = false)
+    super address, port
+
+    @is_hltv = is_hltv
   end
 
-  def initialize(ip_address, port_number = 27015, is_hltv = false)
-    super port_number
-    @socket = GoldSrcSocket.new ip_address, port_number, is_hltv
+  # Initializes the socket to communicate with the GoldSrc server
+  def init_socket
+    @socket = GoldSrcSocket.new @ip_address, @port, @is_hltv
   end
 
   def rcon_auth(password)

data/lib/steam/servers/master_server.rb

@@ -1,13 +1,18 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/a2m_get_servers_batch2_packet'
+require 'steam/packets/c2m_checkmd5_packet'
+require 'steam/packets/s2m_heartbeat2_packet'
+require 'steam/servers/server'
 require 'steam/sockets/master_server_socket'
 
 class MasterServer
 
+  include Server
+
   GOLDSRC_MASTER_SERVER = 'hl1master.steampowered.com', 27010
   SOURCE_MASTER_SERVER = 'hl2master.steampowered.com', 27011
 
@@ -21,11 +26,30 @@ class MasterServer
   REGION_AFRICA = 0x07
   REGION_ALL = 0xFF
 
-  def initialize(master_server_address, master_server_port)
-    @socket = MasterServerSocket.new master_server_address, master_server_port
+  # Creates a new instance of a master server object
+  def initialize(address, port)
+    super
+
     @server_array = []
   end
 
+  # Request a challenge number from the master server. This is used for further
+  # communication with the master server.
+  #
+  # Please note that this is NOT needed for finding servers using the +servers+
+  # method
+  def challenge
+    failsafe do
+      @socket.send C2M_CHECKMD5_Packet.new
+      @socket.reply.challenge
+    end
+  end
+
+  # Initializes the socket to communicate with the master server
+  def init_socket
+    @socket = MasterServerSocket.new @ip_address, @port
+  end
+
   def servers(region_code = MasterServer::REGION_ALL, filters = '')
     update_servers region_code, filters if @server_array.empty?
     @server_array
@@ -36,23 +60,47 @@ class MasterServer
     finished       = false
     current_server = '0.0.0.0:0'
 
-    begin
-      @socket.send A2M_GET_SERVERS_BATCH2_Packet.new(region_code, current_server, filters)
+    failsafe do
       begin
-        servers = @socket.reply.servers
-        servers.each do |server|
-          if server == '0.0.0.0:0'
-            finished = true
-          else
-            current_server = server
-            @server_array << server.split(':')
+        @socket.send A2M_GET_SERVERS_BATCH2_Packet.new(region_code, current_server, filters)
+        begin
+          servers = @socket.reply.servers
+          servers.each do |server|
+            if server == '0.0.0.0:0'
+              finished = true
+            else
+              current_server = server
+              @server_array << server.split(':')
+            end
           end
+          fail_count = 0
+        rescue TimeoutException
+          raise $! if (fail_count += 1) == 3
         end
-        fail_count = 0
+      end while !finished
+    end
+  end
+
+  # Sends a constructed heartbeat to the master server
+  #
+  # This can be used to check server versions externally.
+  #
+  # The reply from the master server – usually zero or more packets. Zero means
+  # either the heartbeat was accepted by the master or there was a timeout. So
+  # usually it's best to repeat a heartbeat a few times when not receiving any
+  # packets.
+  def send_heartbeat(data)
+    failsafe do
+      @socket.send S2M_HEARTBEAT2_Packet.new(data)
+
+      reply_packets = []
+      begin
+        loop { reply_packets << @socket.reply }
       rescue TimeoutException
-        raise $! if (fail_count += 1) == 3
       end
-    end while !finished
+    end
+
+    reply_packets
   end
 
 end

data/lib/steam/servers/server.rb

@@ -0,0 +1,66 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'socket'
+
+# This module is included by all classes implementing server functionality
+#
+# It provides basic name resolution features.
+module Server
+
+  # Creates a new server instance with the given address and port
+  def initialize(address, port = nil)
+    address = address.to_s
+    address, port = address.split(':', 2) if address.include? ':'
+
+    @host_names   = []
+    @ip_addresses = []
+    @ip_index     = 0
+    @port         = port.to_i
+
+    Socket.getaddrinfo(address, port, Socket::AF_INET, Socket::SOCK_DGRAM).
+           each do |address|
+      @host_names << address[2]
+      @ip_addresses << address[3]
+    end
+
+    @ip_address = @ip_addresses.first
+
+    init_socket
+  end
+
+  # Rotate this server's IP address to the next one in the IP list
+  #
+  # This method will return +true+, if the IP list reached its end. If the list
+  # contains only one IP address, this method will instantly return +true+.
+  def rotate_ip
+    return true if @ip_addresses.size == 1
+
+    @ip_index = (@ip_index + 1) % @ip_addresses.size
+    @ip_address = @ip_addresses[@ip_index]
+
+    init_socket
+
+    @ip_index == 0
+  end
+
+  protected
+
+  # Execute an action in the context of this server's current IP address
+  #
+  # Any failure, i.e. an exception, will cause the IP to rotate to the next IP
+  # in the server's IP list and the execution will be repeated for the next IP
+  # address. If the IP rotation reaches the end of the list, the exception will
+  # be reraised.
+  def failsafe(&proc)
+    begin
+      proc.call
+    rescue
+      raise $! if rotate_ip
+      failsafe &proc
+    end
+  end
+
+end

data/lib/steam/servers/source_server.rb

@@ -1,12 +1,13 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'exceptions/rcon_no_auth_exception'
 require 'steam/packets/rcon/rcon_auth_request'
 require 'steam/packets/rcon/rcon_auth_response'
 require 'steam/packets/rcon/rcon_exec_request'
+require 'steam/packets/rcon/rcon_terminator'
 require 'steam/servers/game_server'
 require 'steam/sockets/rcon_socket'
 require 'steam/sockets/source_socket'
@@ -15,19 +16,14 @@ class SourceServer
 
   include GameServer
 
-  # Splits the player status obtained with +rcon status+
-  def self.split_player_status(player_status)
-    player_data = player_status.match(/# *(\d+) +"(.*)" +(.*)/).to_a[1..-1]
-    player_data[2] = player_data[2].split
-    player_data.flatten!
-    player_data.delete_at(3)
-    player_data
+  def initialize(address, port = 27015)
+    super
   end
 
-  def initialize(ip_address, port_number = 27015)
-    super port_number
-    @rcon_socket = RCONSocket.new ip_address, port_number
-    @socket = SourceSocket.new ip_address, port_number
+  # Initializes the sockets to communicate with the Source server
+  def init_socket
+    @rcon_socket = RCONSocket.new @ip_address, @port
+    @socket      = SourceSocket.new @ip_address, @port
   end
 
   def rcon_auth(password)
@@ -44,17 +40,15 @@ class SourceServer
 
   def rcon_exec(command)
     @rcon_socket.send RCONExecRequest.new(@rcon_request_id, command)
+    @rcon_socket.send RCONTerminator.new(@rcon_request_id)
     response_packets = []
 
     begin
-      begin
-        response_packet = @rcon_socket.reply
-        raise RCONNoAuthException.new if response_packet.is_a? RCONAuthResponse
-        response_packets << response_packet
-      end while true
-    rescue TimeoutException
-      raise $! if response_packets.empty?
-    end
+      response_packet = @rcon_socket.reply
+      redo if response_packet.nil?
+      raise RCONNoAuthException.new if response_packet.is_a? RCONAuthResponse
+      response_packets << response_packet
+    end while response_packet.response.size > 0
 
     response = ''
     response_packets.each do |packet|

data/lib/steam/sockets/goldsrc_socket.rb

@@ -1,9 +1,11 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'stringio_additions'
+require 'exceptions/rcon_ban_exception'
+require 'exceptions/rcon_no_auth_exception'
 require 'steam/packets/steam_packet_factory'
 require 'steam/packets/rcon/rcon_goldsrc_request'
 require 'steam/sockets/steam_socket'
@@ -66,6 +68,7 @@ class GoldSrcSocket
     rcon_challenge if @rcon_challenge.nil? or @is_hltv
 
     rcon_send "rcon #{@rcon_challenge} #{password} #{command}"
+    rcon_send "rcon #{@rcon_challenge} #{password}"
     if @is_hltv
       begin
         response = reply.response
@@ -76,17 +79,16 @@ class GoldSrcSocket
       response = reply.response
     end
 
-    if response.strip == 'Bad rcon_password.' or response.strip == 'You have been banned from this server.'
+    if response.strip == 'Bad rcon_password.'
       raise RCONNoAuthException
+    elsif response.strip == 'You have been banned from this server.'
+      raise RCONBanException
     end
 
     begin
-      loop do
-        response_part = reply.response
-        response << response_part
-      end
-    rescue TimeoutException
-    end
+      response_part = reply.response
+      response << response_part
+    end while response_part.size > 0
 
     response
   end
@@ -95,7 +97,9 @@ class GoldSrcSocket
     rcon_send 'challenge rcon'
     response = reply.response.strip
 
-    raise RCONNoAuthException if response == 'You have been banned from this server.'
+    if response == 'You have been banned from this server.'
+      raise RCONBanException
+    end
 
     @rcon_challenge = response[14..-1]
   end