steam-condenser 1.2.0 → 1.2.1

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

@@ -0,0 +1,34 @@
+# 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 packet class represents a M2S_ISVALIDMD5 response replied by a master
+# server
+#
+# It is used to provide a challenge number to a game server
+#
+# @author Sebastian Staudt
+# @see MasterServer#challenge
+class M2C_ISVALIDMD5_Packet
+
+  include SteamPacket
+
+  # Returns the challenge number to use for master server communication
+  #
+  # @return [Fixnum] The challenge number
+  attr_reader :challenge
+
+  # Creates a new M2S_ISVALIDMD5 response object based on the given data
+  #
+  # @param [String] data The raw packet data replied from the server
+  def initialize(data)
+    super M2C_ISVALIDMD5_HEADER, data
+
+    @content_data.byte
+    @challenge = @content_data.long
+  end
+
+end

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

@@ -0,0 +1,34 @@
+# 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 packet class represent a M2S_REQUESTRESTART response replied from a
+# master server
+#
+# It is used to request a game server restart, e.g. when the server is
+# outdated.
+#
+# @author Sebastian Staudt
+# @see MasterServer#send_heartbeat
+class M2S_REQUESTRESTART_Packet
+
+  include SteamPacket
+
+  # Returns the challenge number used for master server communication
+  #
+  # @return [Fixnum] The challenge number
+  attr_reader :challenge
+
+  # Creates a new M2S_REQUESTRESTART response object based on the given data
+  #
+  # @param [String] data The raw packet data replied from the server
+  def initialize(data)
+    super M2S_REQUESTRESTART_HEADER, data
+
+    @challenge = @content_data.long
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_auth_request.rb

@@ -0,0 +1,28 @@
+# 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/rcon/rcon_packet'
+
+# This packet class represents a SERVERDATA_AUTH request sent to a Source
+# server
+#
+# It is used to authenticate the client for RCON communication.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_auth
+class RCONAuthRequest
+
+  include RCONPacket
+
+  # Creates a RCON authentication request for the given request ID and RCON
+  # password
+  #
+  # @param [Fixnum] request_id The request ID of the RCON connection
+  # @param [String] rcon_password The RCON password of the server
+  def initialize(request_id, rcon_password)
+    super request_id, SERVERDATA_AUTH, rcon_password
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_auth_response.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) 2008-2011, Sebastian Staudt
+
+require 'steam/packets/rcon/rcon_packet'
+
+# This packet class represents a SERVERDATA_AUTH_RESPONSE packet sent by a
+# Source server
+#
+# It is used to indicate the success or failure of an authentication attempt
+# of a client for RCON communication.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_auth
+class RCONAuthResponse
+
+  include RCONPacket
+
+  # Creates a RCON authentication response for the given request ID
+  #
+  # The request ID of the packet will match the client's request if
+  # authentication was successful
+  #
+  # @param [Fixnum] request_id The request ID of the RCON connection
+  def initialize(request_id)
+    super request_id, SERVERDATA_AUTH_RESPONSE, ''
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_exec_request.rb

@@ -0,0 +1,28 @@
+# 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/rcon/rcon_packet'
+
+# This packet class represents a SERVERDATA_EXECCOMMAND packet sent to a
+# Source server
+#
+# It is used to request a command execution on the server.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_exec
+class RCONExecRequest
+
+  include RCONPacket
+
+  # Creates a RCON command execution request for the given request ID and
+  # command
+  #
+  # @param [Fixnum] request_id The request ID of the RCON connection
+  # @param [String] rcon_command The command to execute on the server
+  def initialize(request_id, rcon_command)
+    super request_id, SERVERDATA_EXECCOMMAND, rcon_command
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_exec_response.rb

@@ -0,0 +1,37 @@
+# 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/rcon/rcon_packet'
+
+# This packet class represents a SERVERDATA_RESPONSE_VALUE packet sent by a
+# Source server
+#
+# It is used to transport the output of a command from the server to the client
+# which requested the command execution.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_exec
+class RCONExecResponse
+
+  include RCONPacket
+
+  # Creates a RCON command response for the given request ID and command
+  # output
+  #
+  # @param [Fixnum] request_id The request ID of the RCON connection
+  # @param [String] command_response The output of the command executed on the
+  #        server
+  def initialize(request_id, command_response)
+    super request_id, SERVERDATA_RESPONSE_VALUE, command_response
+  end
+
+  # Returns the output of the command execution
+  #
+  # @return [String] The output of the command
+  def response
+    @content_data.string[0..-3]
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_goldsrc_request.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 RCON request packet sent to a GoldSrc server
+#
+# It is used to request a command execution on the server.
+#
+# @author Sebastian Staudt
+# @see GoldSrcServer#rcon_exec
+class RCONGoldSrcRequest
+
+  include SteamPacket
+
+  # Creates a request for the given request string
+  #
+  # The request string has the form `rcon {challenge number} {RCON password}
+  # {command}`.
+  #
+  # @param [String] request The request string to send to the server
+  def initialize(request)
+    super 0x00, request
+  end
+
+  # Returns the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this request packet
+  def to_s
+    [0xFFFFFFFF, @content_data.string].pack('Va*')
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_goldsrc_response.rb

@@ -0,0 +1,34 @@
+# 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 RCON response packet sent by a GoldSrc server
+#
+# It is used to transport the output of a command from the server to the client
+# which requested the command execution.
+#
+# @author Sebastian Staudt
+# @see GoldSrcServer#rcon_exec
+class RCONGoldSrcResponse
+
+  include SteamPacket
+
+  # Creates a RCON command response for the given command output
+  #
+  # @param [String] command_response The output of the command executed on the
+  #        server
+  def initialize(command_response)
+    super RCON_GOLDSRC_RESPONSE_HEADER, command_response
+  end
+
+  # Returns the output of the command execution
+  #
+  # @return [String] The output of the command
+  def response
+    @content_data.string[0..-3]
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_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) 2008-2011, Sebastian Staudt
+
+require 'steam/packets/steam_packet'
+
+# This module is included by all classes representing a packet used by Source's
+# RCON protocol
+#
+# It provides a basic implementation for initializing and serializing such a
+# packet.
+#
+# @author Sebastian Staudt
+# @see RCONPacketFactory
+module RCONPacket
+
+  include SteamPacket
+
+  # Header for authentication requests
+  SERVERDATA_AUTH = 3
+
+  # Header for replies to authentication attempts
+  SERVERDATA_AUTH_RESPONSE = 2
+
+  # Header for command execution requests
+  SERVERDATA_EXECCOMMAND = 2
+
+  # Header for packets with the output of a command execution
+  SERVERDATA_RESPONSE_VALUE = 0
+
+  # Returns the request ID used to identify the RCON communication
+  #
+  # @return [Fixnum] The request ID used to identify the RCON communication
+  attr_reader :request_id
+
+  # Creates a new RCON packet object with the given request ID, type and
+  # content data
+  #
+  # @param [Fixnum] request_id The request ID for the current RCON
+  #        communication
+  # @param [Fixnum] rcon_header The header for the packet type
+  # @param [String] rcon_data The raw packet data
+  def initialize(request_id, rcon_header, rcon_data)
+    super rcon_header, "#{rcon_data}\0\0"
+
+    @request_id = request_id
+  end
+
+  # Returns the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this RCON packet
+  def to_s
+    [@content_data.length + 8, @request_id, @header_data, @content_data.string].pack('V3a*')
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_packet_factory.rb

@@ -0,0 +1,43 @@
+# 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'
+require 'errors/packet_format_error'
+require 'steam/packets/steam_packet_factory'
+require 'steam/packets/rcon/rcon_auth_response'
+require 'steam/packets/rcon/rcon_exec_response'
+
+# This module provides functionality to handle raw packet data for Source RCON
+#
+# It's is used to transform data bytes into packet objects for RCON
+# communication with Source servers.
+#
+# @author Sebastian Staudt
+# @see RCONPacket
+module RCONPacketFactory
+
+  # 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 [PacketFormatError] if the packet header is not recognized
+  # @return [RCONPacket] The packet object generated from the packet data
+  def self.packet_from_data(raw_data)
+    byte_buffer = StringIO.new raw_data
+
+    request_id = byte_buffer.long
+    header = byte_buffer.long
+    data = byte_buffer.cstring
+
+    case header
+      when RCONPacket::SERVERDATA_AUTH_RESPONSE then
+        return RCONAuthResponse.new(request_id)
+      when RCONPacket::SERVERDATA_RESPONSE_VALUE then
+        return RCONExecResponse.new(request_id, data)
+      else
+        raise PacketFormatError, "Unknown packet with header #{header.to_s(16)} received."
+    end
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_terminator.rb

@@ -0,0 +1,29 @@
+# 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/rcon/rcon_packet'
+
+# This packet class represents a special SERVERDATA_RESPONSE_VALUE packet which
+# is sent to the server
+#
+# It is used to determine the end of a RCON response from Source servers.
+# Packets of this type are sent after the actual RCON command and the empty
+# response packet from the server will indicate the end of the response.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_exec
+class RCONTerminator
+
+  include RCONPacket
+
+  # Creates a new RCON terminator packet instance for the given request ID
+  #
+  # @param [Fixnum] request_id The request ID for the current RCON
+  #        communication
+  def initialize(request_id)
+    super request_id, SERVERDATA_RESPONSE_VALUE, nil
+  end
+
+end

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

@@ -0,0 +1,19 @@
+# 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
+
+# This module implements a method to generate raw packet data used by request
+# packets which send a challenge number
+#
+# @author Sebastian Staudt
+module RequestWithChallenge
+
+  # 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.to_i].pack('c5l')
+  end
+
+end

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

@@ -0,0 +1,62 @@
+# 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 Source or
+# GoldSrc server
+#
+# Out-of-date (before 10/24/2008) GoldSrc servers use an older format (see
+# {S2A_INFO_DETAILED_Packet}).
+#
+# @author Sebastian Staudt
+# @see GameServer#update_server_info
+class S2A_INFO2_Packet
+
+  include S2A_INFO_BasePacket
+
+  # Creates a new S2A_INFO2 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_INFO2_HEADER, data
+
+    @protocol_version = @content_data.byte
+    @server_name = @content_data.cstring
+    @map_name = @content_data.cstring
+    @game_directory = @content_data.cstring
+    @game_description = @content_data.cstring
+    @app_id = @content_data.short
+    @number_of_players = @content_data.byte
+    @max_players = @content_data.byte
+    @number_of_bots = @content_data.byte
+    @dedicated = @content_data.byte.chr
+    @operating_system = @content_data.byte.chr
+    @password_needed = @content_data.byte == 1
+    @secure = @content_data.byte == 1
+    @game_version = @content_data.cstring
+
+    if @content_data.remaining > 0
+      extra_data_flag = @content_data.byte
+
+      @server_port = @content_data.short unless extra_data_flag & 0x80 == 0
+
+      unless extra_data_flag & 0x10 == 0
+        @server_id =  @content_data.long | (@content_data.long << 32)
+      end
+
+      unless extra_data_flag & 0x40 == 0
+        @tv_port = @content_data.short
+        @tv_name = @content_data.cstring
+      end
+
+      @server_tags = @content_data.cstring unless extra_data_flag & 0x20 == 0
+    end
+
+    generate_info_hash
+  end
+
+end