steam-condenser 1.2.0 → 1.2.1

data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info_base_packet.rb

@@ -0,0 +1,35 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2011, Sebastian Staudt
+
+require 'steam/packets/steam_packet'
+
+# This module implements methods to generate and access server information from
+# S2A_INFO_DETAILED and S2A_INFO2 response packets
+#
+# @author Sebastian Staudt
+# @see S2A_INFO_DETAILED_Packet
+# @see S2A_INFO2_Packet
+module S2A_INFO_BasePacket
+
+  include SteamPacket
+
+  # Returns the information provided by the server
+  #
+  # @return [Hash<String, Object>] The information provided by the server
+  attr_reader :info_hash
+
+  protected
+
+  # Generates a hash of server properties from the instance variables of the
+  # including packet object
+  def generate_info_hash
+    @info_hash = Hash[
+      *instance_variables.map { |var|
+        [var[1..-1].to_sym, instance_variable_get(var)] if var != '@content_data' && var != '@header_data'
+      }.compact.flatten
+    ]
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info_detailed_packet.rb

@@ -0,0 +1,61 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2011 Sebastian Staudt
+
+require 'steam/packets/s2a_info_base_packet'
+
+# This class represents a S2A_INFO_DETAILED response packet sent by a GoldSrc
+# server
+#
+# @author Sebastian Staudt
+# @deprecated Only outdated GoldSrc servers (before 10/24/2008) use this
+#             format. Newer ones use the same format as Source servers now (see
+#             {S2A_INFO2_Packet}).
+# @see GameServer#update_server_info
+class S2A_INFO_DETAILED_Packet
+
+  include S2A_INFO_BasePacket
+
+  # Creates a new S2A_INFO_DETAILED response object based on the given data
+  #
+  # @param [String] data The raw packet data replied from the server
+  # @see S2A_INFO_BasePacket#generate_info_hash
+  def initialize(data)
+    super S2A_INFO_DETAILED_HEADER, data
+
+    @game_ip = @content_data.cstring
+    @server_name = @content_data.cstring
+    @map_name = @content_data.cstring
+    @game_directory = @content_data.cstring
+    @game_description = @content_data.cstring
+    @number_of_players = @content_data.byte
+    @max_players = @content_data.byte
+    @network_version = @content_data.byte
+    @dedicated = @content_data.byte.chr
+    @operating_system = @content_data.byte.chr
+    @password_needed = @content_data.byte == 1
+    @is_mod = @content_data.byte == 1
+
+    if @is_mod
+      @mod_info = {}
+      @mod_info[:url_info] = @content_data.cstring
+      @mod_info[:url_dl] = @content_data.cstring
+      @content_data.byte
+      if @content_data.remaining == 12
+        @mod_info[:mod_version] = @content_data.long
+        @mod_info[:mod_size] = @content_data.long
+        @mod_info[:sv_only] = @content_data.byte == 1
+        @mod_info[:cl_dll] = @content_data.byte == 1
+        @secure = @content_data.byte == 1
+        @number_of_bots = @content_data.byte
+      end
+    else
+      @secure = @content_data.byte == 1
+      @number_of_bots = @content_data.byte
+    end
+
+    generate_info_hash
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_logstring_packet.rb

@@ -0,0 +1,30 @@
+# 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'
+
+# This class represents a S2A_LOGSTRING packet used to transfer log messages
+#
+# @author Sebastian Staudt
+class S2A_LOGSTRING_Packet
+
+  include SteamPacket
+
+  # Returns the log message contained in this packet
+  #
+  # @return [String] The log message
+  attr_reader :message
+
+  # Creates a new S2A_LOGSTRING object based on the given data
+  #
+  # @param [String] data The raw packet data sent by the server
+  def initialize(data)
+    super S2A_LOGSTRING_HEADER, data
+
+    @content_data.byte
+    @message = @content_data.string
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_player_packet.rb

@@ -0,0 +1,44 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2011, Sebastian Staudt
+
+require 'errors/packet_format_error'
+require 'steam/packets/steam_packet'
+
+# This class represents a S2A_PLAYER response sent by a game server
+#
+# It is used to transfer a list of players currently playing on the server.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_player_info
+class S2A_PLAYER_Packet
+
+  include SteamPacket
+
+  # Returns the list of active players provided by the server
+  #
+  # @return [Hash<String, SteamPlayer>] All active players on the server
+  attr_reader :player_hash
+
+  # Creates a new S2A_PLAYER response object based on the given data
+  #
+  # @param [String] content_data The raw packet data sent by the server
+  # @raise [PacketFormatError] if the packet data is not well formatted
+  def initialize(content_data)
+    if content_data.nil?
+      raise PacketFormatError, 'Wrong formatted S2A_PLAYER packet.'
+    end
+
+    super S2A_PLAYER_HEADER, content_data
+
+    @content_data.byte
+    @player_hash = {}
+
+    while @content_data.remaining > 0
+      player_data = @content_data.byte, @content_data.cstring, @content_data.signed_long, @content_data.float
+      @player_hash[player_data[1]] = SteamPlayer.new(*player_data[0..3])
+    end
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_rules_packet.rb

@@ -0,0 +1,48 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2011, Sebastian Staudt
+
+require 'steam/packets/steam_packet'
+
+# This class represents a S2A_RULES response sent by a game server
+#
+# It is used to transfer a list of server rules (a.k.a. CVARs) with their
+# active values.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_rules_info
+class S2A_RULES_Packet
+
+  include SteamPacket
+
+  # Returns the list of server rules (a.k.a. CVars) with the current values
+  #
+  # @return [Hash<String, String>] A list of server rules
+  attr_reader :rules_hash
+
+  # Creates a new S2A_RULES response object based on the given data
+  #
+  # @param [String] content_data The raw packet data sent by the server
+  def initialize(content_data)
+    if content_data.nil?
+      raise PacketFormatError, 'Wrong formatted S2A_RULES response packet.'
+    end
+
+    super SteamPacket::S2A_RULES_HEADER, content_data
+
+    rules_count = @content_data.short
+
+    @rules_hash = {}
+
+    rules_count.times do
+      rule  = @content_data.cstring
+      value = @content_data.cstring
+
+      break if rule.empty?
+
+      @rules_hash[rule] = value
+    end
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2c_challenge_packet.rb

@@ -0,0 +1,35 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2011, Sebastian Staudt
+
+require 'steam/packets/steam_packet'
+
+# This packet class represents a S2C_CHALLENGE response replied by a game
+# server
+#
+# It is used to provide a challenge number to a client requesting information
+# from the game server.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_challenge_number
+class S2C_CHALLENGE_Packet
+
+  include SteamPacket
+
+  # Creates a new S2C_CHALLENGE response object based on the given data
+  #
+  # @param [String] challenge_number The raw packet data replied from the
+  #        server
+  def initialize(challenge_number)
+    super S2C_CHALLENGE_HEADER, challenge_number
+  end
+
+  # Returns the challenge number received from the game server
+  #
+  # @return [Fixnum] The challenge number provided by the game server
+  def challenge_number
+    @content_data.rewind
+    @content_data.long
+  end
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2m_heartbeat2_packet.rb

@@ -0,0 +1,71 @@
+# 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'
+
+# This class represents a S2M_HEARTBEAT2 packet sent by game servers to master
+# servers
+#
+# It is used to signal the game server's availability and status to the master
+# servers.
+#
+# @author Sebastian Staudt
+# @see MasterServer#send_heartbeat
+class S2M_HEARTBEAT2_Packet
+
+  include SteamPacket
+
+  # Default data to send with a S2M_HEARTBEAT2 packet
+  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 S2M_HEARTBEAT2 packet object based on the given data
+  #
+  # @param [Hash<Symbol, Object>] data The data to send with the heartbeat. The
+  #        data contents are merge with the values from {DEFAULT_DATA}.
+  # @raise [SteamCondenserError] when the required challenge number is
+  #        missing
+  def initialize(data = {})
+    data = DEFAULT_DATA.merge data
+
+    if data[:challenge].nil?
+      raise SteamCondenserError, '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 the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this request packet
+  def to_s
+    [@header_data, @content_data.string].pack('ca*')
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/steam_packet.rb

@@ -0,0 +1,52 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2011, Sebastian Staudt
+
+require 'core_ext/stringio'
+
+# This module implements the basic functionality used by most of the packets
+# used in communication with master, Source or GoldSrc servers.
+#
+# @author Sebastian Staudt
+# @see SteamPacketFactory
+module SteamPacket
+
+  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 packet object based on the given data
+  #
+  # @param [Fixnum] header_data The packet header
+  # @param [String] content_data The raw data of the packet
+  def initialize(header_data, content_data = '')
+    @content_data = StringIO.new content_data.to_s
+    @header_data  = header_data
+  end
+
+  # Returns the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this request packet
+  def to_s
+    [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.string].pack('c5a*')
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/steam_packet_factory.rb

@@ -0,0 +1,108 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2011, Sebastian Staudt
+
+require 'bzip2-ruby'
+require 'zlib'
+
+require 'errors/packet_format_error'
+require 'steam/packets/s2a_info_detailed_packet'
+require 'steam/packets/a2s_info_packet'
+require 'steam/packets/s2a_info2_packet'
+require 'steam/packets/a2s_player_packet'
+require 'steam/packets/s2a_player_packet'
+require 'steam/packets/a2s_rules_packet'
+require 'steam/packets/s2a_rules_packet'
+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'
+
+# This module provides functionality to handle raw packet data, including
+# data split into several UDP / TCP packets and BZIP2 compressed data. It's the
+# main utility to transform data bytes into packet objects.
+#
+# @author Sebastian Staudt
+# @see SteamPacket
+module SteamPacketFactory
+
+  # Creates a new packet object based on the header byte of the given raw data
+  #
+  # @param [String] raw_data The raw data of the packet
+  # @raise [SteamCondenserError] if the packet header is not recognized
+  # @return [SteamPacket] The packet object generated from the packet data
+  def self.packet_from_data(raw_data)
+    header = raw_data[0].ord
+    data = raw_data[1..-1]
+
+    case header
+      when SteamPacket::S2A_INFO_DETAILED_HEADER
+        return S2A_INFO_DETAILED_Packet.new(data)
+      when SteamPacket::A2S_INFO_HEADER
+        return A2S_INFO_Packet.new
+      when SteamPacket::S2A_INFO2_HEADER
+        return S2A_INFO2_Packet.new(data)
+      when SteamPacket::A2S_PLAYER_HEADER
+        return A2S_PLAYER_Packet.new
+      when SteamPacket::S2A_PLAYER_HEADER
+        return S2A_PLAYER_Packet.new(data)
+      when SteamPacket::A2S_RULES_HEADER
+        return A2S_RULES_Packet
+      when SteamPacket::S2A_RULES_HEADER
+        return S2A_RULES_Packet.new(data)
+      when SteamPacket::A2S_SERVERQUERY_GETCHALLENGE_HEADER
+        return A2S_SERVERQUERY_GETCHALLENGE_Packet.new
+      when SteamPacket::S2C_CHALLENGE_HEADER
+        return S2C_CHALLENGE_Packet.new(data)
+      when SteamPacket::A2M_GET_SERVERS_BATCH2_HEADER
+        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 PacketFormatError, "Unknown packet with header 0x#{header.to_s(16)} received."
+    end
+  end
+
+  # Reassembles the data of a split and/or compressed packet into a single
+  # packet object
+  #
+  # @param [Array<String>] split_packets An array of packet data
+  # @param [Boolean] is_compressed whether the data of this packet is
+  #        compressed
+  # @param [Fixnum] packet_checksum The CRC32 checksum of the decompressed
+  #        packet data
+  # @raise [SteamCondenserError] if the bz2 gem is not installed
+  # @raise [PacketFormatError] if the calculated CRC32 checksum does not match
+  #        the expected value
+  # @return [SteamPacket] The reassembled packet
+  # @see packet_from_data
+  def self.reassemble_packet(split_packets, is_compressed = false, packet_checksum = 0)
+    packet_data = split_packets.join ''
+
+    if is_compressed
+      packet_data = Bzip2.decompress packet_data
+
+      unless Zlib.crc32(packet_data) == packet_checksum
+        raise PacketFormatError, 'CRC32 checksum mismatch of uncompressed packet data.'
+      end
+    end
+
+    packet_from_data packet_data[4..-1]
+  end
+
+end