steam-condenser 1.3.9 → 1.3.10

data/pkg/steam-condenser-1.3.9/lib/steam/sockets/goldsrc_socket.rb

@@ -0,0 +1,142 @@
+# 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/rcon_ban_error'
+require 'errors/rcon_no_auth_error'
+require 'errors/timeout_error'
+require 'steam/packets/steam_packet_factory'
+require 'steam/packets/rcon/rcon_goldsrc_request'
+require 'steam/sockets/steam_socket'
+
+# This class represents a socket used to communicate with game servers based on
+# the GoldSrc engine (e.g. Half-Life, Counter-Strike)
+#
+# @author Sebastian Staudt
+class GoldSrcSocket
+
+  include SteamSocket
+
+  # Creates a new socket to communicate with the server on the given IP address
+  # and port
+  #
+  # @param [String] ipaddress Either the IP address or the DNS name of the
+  #        server
+  # @param [Fixnum] port_number The port the server is listening on
+  # @param [Boolean] is_hltv `true` if the target server is a HTLV instance.
+  #        HLTV behaves slightly different for RCON commands, this flag
+  #        increases compatibility.
+  def initialize(ipaddress, port_number = 27015, is_hltv = false)
+    super ipaddress, port_number
+
+    @is_hltv = is_hltv
+  end
+
+  # Reads a packet from the socket
+  #
+  # The Source query protocol specifies a maximum packet size of 1,400 bytes.
+  # Bigger packets will be split over several UDP packets. This method
+  # reassembles split packets into single packet objects.
+  #
+  # @return [SteamPacket] The packet replied from the server
+  def reply
+    receive_packet 1400
+
+    if @buffer.long == 0xFFFFFFFE
+      split_packets = []
+      begin
+        request_id = @buffer.long
+        packet_number_and_count = @buffer.byte
+        packet_count = packet_number_and_count & 0xF
+        packet_number = (packet_number_and_count >> 4) + 1
+
+        split_packets[packet_number - 1] = @buffer.get
+
+        puts "Received packet #{packet_number} of #{packet_count} for request ##{request_id}" if $DEBUG
+
+        if split_packets.size < packet_count
+          begin
+            bytes_read = receive_packet
+          rescue SteamCondenser::TimeoutError
+            bytes_read = 0
+          end
+        else
+          bytes_read = 0
+        end
+      end while bytes_read > 0 && @buffer.long == 0xFFFFFFFE
+
+      packet = SteamPacketFactory.reassemble_packet(split_packets)
+    else
+      packet = SteamPacketFactory.packet_from_data(@buffer.get)
+    end
+
+    puts "Got reply of type \"#{packet.class.to_s}\"." if $DEBUG
+
+    packet
+  end
+
+  # Executes the given command on the server via RCON
+  #
+  # @param [String] password The password to authenticate with the server
+  # @param [String] command The command to execute on the server
+  # @raise [RCONBanError] if the IP of the local machine has been banned on the
+  #        game server
+  # @raise [RCONNoAuthError] if the password is incorrect
+  # @return [RCONGoldSrcResponse] The response replied by the server
+  # @see #rcon_challenge
+  # @see #rcon_send
+  def rcon_exec(password, command)
+    rcon_challenge if @rcon_challenge.nil? || @is_hltv
+
+    rcon_send "rcon #@rcon_challenge #{password} #{command}"
+    rcon_send "rcon #@rcon_challenge #{password}"
+    if @is_hltv
+      begin
+        response = reply.response
+      rescue SteamCondenser::TimeoutError
+        response = ''
+      end
+    else
+      response = reply.response
+    end
+
+    if response.strip == 'Bad rcon_password.'
+      raise RCONNoAuthError
+    elsif response.strip == 'You have been banned from this server.'
+      raise RCONBanError
+    end
+
+    begin
+      response_part = reply.response
+      response << response_part
+    end while response_part.size > 0
+
+    response
+  end
+
+  # Requests a challenge number from the server to be used for further requests
+  #
+  # @raise [RCONBanError] if the IP of the local machine has been banned on the
+  #        game server
+  # @see #rcon_send
+  def rcon_challenge
+    rcon_send 'challenge rcon'
+    response = reply.response.strip
+
+    if response.strip == 'You have been banned from this server.'
+      raise RCONBanError
+    end
+
+    @rcon_challenge = response[14..-1]
+  end
+
+  # Wraps the given command in a RCON request packet and send it to the server
+  #
+  # @param [String] command The RCON command to send to the server
+  def rcon_send(command)
+    send RCONGoldSrcRequest.new(command)
+  end
+
+end

data/pkg/steam-condenser-1.3.9/lib/steam/sockets/master_server_socket.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 'errors/packet_format_error'
+require 'steam/sockets/steam_socket'
+
+# This class represents a socket used to communicate with master servers
+#
+# @author Sebastian Staudt
+class MasterServerSocket
+
+  include SteamSocket
+
+  # Reads a single packet from the socket
+  #
+  # @raise [PacketFormatError] if the packet has the wrong format
+  # @return [SteamPacket] The packet replied from the server
+  def reply
+    receive_packet 1500
+
+    unless @buffer.long == 0xFFFFFFFF
+      raise PacketFormatError, 'Master query response has wrong packet header.'
+    end
+
+    packet = SteamPacketFactory.packet_from_data @buffer.get
+
+    puts "Got reply of type \"#{packet.class.to_s}\"." if $DEBUG
+
+    packet
+  end
+
+end

data/pkg/steam-condenser-1.3.9/lib/steam/sockets/rcon_socket.rb

@@ -0,0 +1,107 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2013, Sebastian Staudt
+
+require 'ipaddr'
+require 'socket'
+require 'timeout'
+
+require 'errors/rcon_ban_error'
+require 'errors/rcon_no_auth_error'
+require 'errors/timeout_error'
+require 'steam/packets/rcon/rcon_packet'
+require 'steam/packets/rcon/rcon_packet_factory'
+require 'steam/sockets/steam_socket'
+
+# This class represents a socket used for RCON communication with game servers
+# based on the Source engine (e.g. Team Fortress 2, Counter-Strike: Source)
+#
+# The Source engine uses a stateful TCP connection for RCON communication and
+# uses an additional socket of this type to handle RCON requests.
+#
+# @author Sebastian Staudt
+class RCONSocket
+
+  include SteamSocket
+
+  # Creates a new TCP socket to communicate with the server on the given IP
+  # address and port
+  #
+  # @param [String, IPAddr] ip Either the IP address or the DNS name of the
+  #        server
+  # @param [Fixnum] port The port the server is listening on
+  def initialize(ip, port)
+    ip = IPSocket.getaddress(ip) unless ip.is_a? IPAddr
+
+    @ip     = ip
+    @port   = port
+  end
+
+  # Closes the underlying TCP socket if it exists
+  #
+  # SteamSocket#close
+  def close
+    super unless @socket.nil?
+  end
+
+  # Connects a new TCP socket to the server
+  #
+  # @raise [SteamCondenser::TimeoutError] if the connection could not be
+  #        established
+  def connect
+    begin
+      timeout(@@timeout / 1000.0) { @socket = TCPSocket.new @ip, @port }
+    rescue Timeout::Error
+      raise SteamCondenser::TimeoutError
+    end
+  end
+
+  # Sends the given RCON packet to the server
+  #
+  # @param [RCONPacket] data_packet The RCON packet to send to the server
+  # @see #connect
+  def send(data_packet)
+    connect if @socket.nil? || @socket.closed?
+
+    super
+  end
+
+  # Reads a packet from the socket
+  #
+  # The Source RCON protocol allows packets of an arbitrary sice transmitted
+  # using multiple TCP packets. The data is received in chunks and concatenated
+  # into a single response packet.
+  #
+  # @raise [RCONBanError] if the IP of the local machine has been banned on the
+  #        game server
+  # @raise [RCONNoAuthException] if an authenticated connection has been
+  #        dropped by the server
+  # @return [RCONPacket] The packet replied from the server
+  def reply
+    begin
+      if receive_packet(4) == 0
+        @socket.close
+        return nil
+      end
+    rescue Errno::ECONNRESET
+      return nil
+    end
+
+    remaining_bytes = @buffer.long
+
+    packet_data = ''
+    begin
+      received_bytes = receive_packet remaining_bytes
+      remaining_bytes -= received_bytes
+      packet_data << @buffer.get
+    end while remaining_bytes > 0
+
+    packet = RCONPacketFactory.packet_from_data(packet_data)
+
+    puts "Received packet of type \"#{packet.class}\"." if $DEBUG
+
+    packet
+  end
+
+end

data/pkg/steam-condenser-1.3.9/lib/steam/sockets/source_socket.rb

@@ -0,0 +1,73 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2013, Sebastian Staudt
+
+require 'core_ext/stringio'
+require 'errors/timeout_error'
+require 'steam/sockets/steam_socket'
+
+# This class represents a socket used to communicate with game servers based on
+# the Source engine (e.g. Team Fortress 2, Counter-Strike: Source)
+#
+# @author Sebastian Staudt
+class SourceSocket
+
+  include SteamSocket
+
+  # Reads a packet from the socket
+  #
+  # The Source query protocol specifies a maximum packet size of 1,400 bytes.
+  # Bigger packets will be split over several UDP packets. This method
+  # reassembles split packets into single packet objects. Additionally Source
+  # may compress big packets using bzip2. Those packets will be compressed.
+  #
+  # @return [SteamPacket] The packet replied from the server
+  def reply
+    receive_packet 1400
+    is_compressed = false
+    packet_checksum = 0
+
+    if @buffer.long == 0xFFFFFFFE
+      split_packets = []
+      begin
+        request_id = @buffer.long
+        is_compressed = ((request_id & 0x80000000) != 0)
+        packet_count = @buffer.byte
+        packet_number = @buffer.byte + 1
+
+        if is_compressed
+          @buffer.long
+          packet_checksum = @buffer.long
+        else
+          @buffer.short
+        end
+
+        split_packets[packet_number - 1] = @buffer.get
+
+        puts "Received packet #{packet_number} of #{packet_count} for request ##{request_id}" if $DEBUG
+
+        bytes_read = 0
+        if split_packets.size < packet_count
+          begin
+            bytes_read = receive_packet
+          rescue SteamCondenser::TimeoutError
+          end
+        end
+      end while bytes_read > 0 && @buffer.long == 0xFFFFFFFE
+
+      packet = SteamPacketFactory.reassemble_packet(split_packets, is_compressed, packet_checksum)
+    else
+      packet = SteamPacketFactory.packet_from_data(@buffer.get)
+    end
+
+    if is_compressed
+      puts "Got compressed reply of type \"#{packet.class.to_s}\"." if $DEBUG
+    else
+      puts "Got reply of type \"#{packet.class.to_s}\"." if $DEBUG
+    end
+
+    packet
+  end
+
+end

data/pkg/steam-condenser-1.3.9/lib/steam/sockets/steam_socket.rb

@@ -0,0 +1,91 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2013, Sebastian Staudt
+
+require 'ipaddr'
+require 'socket'
+
+require 'core_ext/stringio'
+require 'errors/timeout_error'
+
+# This module implements common functionality for sockets used to connect to
+# game and master servers
+#
+# @author Sebastian Staudt
+module SteamSocket
+
+  # The default socket timeout
+  @@timeout = 1000
+
+  # Sets the timeout for socket operations
+  #
+  # Any request that takes longer than this time will cause a
+  # {SteamCondenser::TimeoutError}.
+  #
+  # @param [Fixnum] timeout The amount of milliseconds before a request times
+  #        out
+  def self.timeout=(timeout)
+    @@timeout = timeout
+  end
+
+  # Creates a new UDP socket to communicate with the server on the given IP
+  # address and port
+  #
+  # @param [String] ip_address Either the IP address or the DNS name of the
+  #        server
+  # @param [Fixnum] port The port the server is listening on
+  def initialize(ip_address, port = 27015)
+    @socket = UDPSocket.new
+    @socket.connect ip_address, port
+  end
+
+  # Closes the underlying socket
+  def close
+    @socket.close
+  end
+
+  # Reads the given amount of data from the socket and wraps it into the buffer
+  #
+  # @param [Fixnum] buffer_length The data length to read from the socket
+  # @raise [SteamCondenser::TimeoutError] if no packet is received on time
+  # @return [Fixnum] The number of bytes that have been read from the socket
+  # @see StringIO
+  def receive_packet(buffer_length = 0)
+    if select([@socket], nil, nil, @@timeout / 1000.0).nil?
+      raise SteamCondenser::TimeoutError
+    end
+
+    if buffer_length == 0
+      @buffer.rewind
+    else
+      @buffer = StringIO.alloc buffer_length
+    end
+
+    begin
+      data = @socket.recv @buffer.remaining
+    rescue Errno::ECONNRESET
+      @socket.close
+      raise $!
+    end
+    bytes_read = @buffer.write data
+    @buffer.truncate bytes_read
+    @buffer.rewind
+
+    bytes_read
+  end
+
+  # Sends the given packet to the server
+  #
+  # This converts the packet into a byte stream first before writing it to the
+  # socket.
+  #
+  # @param [SteamPacket] data_packet The packet to send to the server
+  # @see SteamPacket#to_s
+  def send(data_packet)
+    puts "Sending data packet of type \"#{data_packet.class.to_s}\"." if $DEBUG
+
+    @socket.send data_packet.to_s, 0
+  end
+
+end