steam-condenser 0.8.0

data/lib/steam/servers/goldsrc_server.rb

@@ -0,0 +1,36 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require "steam/servers/game_server"
+require "steam/sockets/goldsrc_socket"
+
+class GoldSrcServer < GameServer
+
+  # Splits the player status obtained with +rcon status+
+  def self.split_player_status(player_status)
+    player_data = player_status.match(/#( \d|\d\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
+  end
+
+  def initialize(ip_address, port_number = 27015, is_hltv = false)
+    super port_number
+    @socket = GoldSrcSocket.new ip_address, port_number, is_hltv
+  end
+  
+  def rcon_auth(password)
+    @rcon_password = password
+    return true
+  end
+  
+  def rcon_exec(command)
+    return @socket.rcon_exec(@rcon_password, command).strip
+  end
+  
+end

data/lib/steam/servers/master_server.rb

@@ -0,0 +1,60 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, Sebastian Staudt
+#
+# $Id$
+
+require "steam/packets/a2m_get_servers_batch2_packet"
+require "steam/sockets/master_server_socket"
+
+class MasterServer
+  
+  GOLDSRC_MASTER_SERVER = "hl1master.steampowered.com", 27010
+  SOURCE_MASTER_SERVER = "hl2master.steampowered.com", 27011
+
+  REGION_US_EAST_COAST = 0x00
+  REGION_US_WEST_COAST = 0x01
+  REGION_SOUTH_AMERICA = 0x02
+  REGION_EUROPE = 0x03
+  REGION_ASIA = 0x04
+  REGION_AUSTRALIA = 0x05
+  REGION_MIDDLE_EAST = 0x06
+  REGION_AFRICA = 0x07
+  REGION_ALL = 0xFF
+  
+  def initialize(master_server_address, master_server_port)
+    @socket = MasterServerSocket.new master_server_address, master_server_port
+    @server_array = Array.new
+  end
+  
+  def get_servers(region_code = MasterServer::REGION_ALL, filters = "")
+    if @server_array.empty?
+      self.update_servers region_code, filters
+    end
+    
+    return @server_array
+  end
+  
+  def update_servers(region_code, filters)
+    finished = false
+    current_server = "0.0.0.0:0"
+    
+    begin
+      @socket.send A2M_GET_SERVERS_BATCH2_Packet.new(region_code, current_server, filters)
+      begin
+        servers = @socket.get_reply.get_servers
+        servers.each do |server|
+          if server == "0.0.0.0:0"
+            finished = true
+          else
+            current_server = server
+            @server_array << server.split(":")
+          end
+        end
+      rescue TimeoutException
+      end
+    end while !finished
+  end
+  
+end

data/lib/steam/servers/source_server.rb

@@ -0,0 +1,65 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, 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/servers/game_server"
+require "steam/sockets/rcon_socket"
+require "steam/sockets/source_socket"
+
+class SourceServer < GameServer
+
+  # Splits the player status obtained with +rcon status+
+  def self.split_player_status(player_status)
+    player_data = player_status.match(/#( \d|\d\d) +"(.*)" +(.*)/).to_a[1..-1]
+    player_data[2] = player_data[2].split
+    player_data.flatten
+  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
+  end
+  
+  def rcon_auth(password)
+    @rcon_request_id = rand 2**16
+    
+    @rcon_socket.send RCONAuthRequest.new(@rcon_request_id, password)
+    @rcon_socket.get_reply
+    reply = @rcon_socket.get_reply
+    
+    if reply.request_id == -1
+      raise RCONNoAuthException.new
+    end
+    
+    return reply.get_request_id == @rcon_request_id
+  end
+  
+  def rcon_exec(command)
+    @rcon_socket.send RCONExecRequest.new(@rcon_request_id, command)
+    response_packets = Array.new
+    
+    begin
+      begin
+        response_packet = @rcon_socket.get_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 = String.new
+    response_packets.each do |packet|
+      response << packet.get_response
+    end
+    
+    return response.strip
+  end
+
+end

data/lib/steam/sockets/goldsrc_socket.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-2009, Sebastian Staudt
+
+require "byte_buffer"
+require "steam/packets/steam_packet_factory"
+require "steam/packets/rcon/rcon_goldsrc_request"
+require "steam/sockets/steam_socket"
+
+# The SourceSocket class is a sub class of SteamSocket respecting the
+# specifications of the Source query protocol.
+class GoldSrcSocket < SteamSocket
+
+  def initialize(ipaddress, port_number = 27015, is_hltv = false)
+    super ipaddress, port_number
+    @is_hltv = is_hltv
+  end
+
+  # Reads a packet from the channel. The Source query protocol specifies a
+  # maximum packet size of 1400 byte. Greater packets will be split over several
+  # UDP packets. This method reassembles split packets into single packet
+  # objects.
+  def get_reply
+    bytes_read = self.receive_packet 1400
+    
+    if @buffer.get_long == 0xFFFFFFFE
+      split_packets = Array.new
+      begin
+        # Parsing of split packet headers
+        request_id = @buffer.get_long
+        packet_number_and_count = @buffer.get_byte.to_i
+        packet_count = packet_number_and_count & 0xF
+        packet_number = (packet_number_and_count >> 4) + 1
+        
+        # Caching of split packet data
+        split_packets[packet_number - 1] = @buffer.get
+        
+        warn "Received packet #{packet_number} of #{packet_count} for request ##{request_id}"
+        
+        # Receiving the next packet
+        if split_packets.size < packet_count
+          begin
+            bytes_read = self.receive_packet
+          rescue TimeoutException
+            bytes_read = 0
+          end
+        else
+          bytes_read = 0
+        end
+      end while bytes_read > 0 && @buffer.get_long == 0xFFFFFFFE
+      
+      packet = SteamPacketFactory.reassemble_packet(split_packets)
+        
+    else
+      packet = SteamPacketFactory.get_packet_from_data(@buffer.get)
+    end
+    
+    warn "Got reply of type \"#{packet.class.to_s}\"."
+    
+    return packet
+  end
+  
+  def rcon_exec(password, command)
+    self.rcon_get_challenge if @rcon_challenge.nil? or @is_hltv
+    
+    self.rcon_send "rcon #{@rcon_challenge} #{password} #{command}"
+    if @is_hltv
+      begin
+        response = self.get_reply.get_response
+      rescue TimeoutException
+        response = ""
+      end
+    else
+      response = self.get_reply.get_response
+    end
+    
+    if response.strip == "Bad rcon_password." or response.strip == "You have been banned from this server."
+      raise RCONNoAuthException.new
+    end
+    
+    begin
+      while true
+        response_part = self.get_reply.get_response
+        response << response_part
+      end
+    rescue TimeoutException
+    end
+    
+    return response
+  end
+  
+  def rcon_get_challenge
+    self.rcon_send "challenge rcon"
+    response = self.get_reply.get_response.strip
+    
+    if response == "You have been banned from this server."
+      raise RCONNoAuthException.new;
+    end
+    
+    @rcon_challenge = response[14..-1]
+  end
+  
+  def rcon_send(command)
+    self.send RCONGoldSrcRequest.new(command)
+  end
+  
+end

data/lib/steam/sockets/master_server_socket.rb

@@ -0,0 +1,20 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require "steam/sockets/steam_socket"
+
+class MasterServerSocket < SteamSocket
+  
+  def get_reply
+    self.receive_packet 1500
+    
+    if @buffer.get_long != 0xFFFFFFFF
+      raise Exception.new("Master query response has wrong packet header.")
+    end
+    
+    return SteamPacketFactory.get_packet_from_data(@buffer.get)
+  end
+  
+end

data/lib/steam/sockets/rcon_socket.rb

@@ -0,0 +1,50 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008, Sebastian Staudt
+#
+# $Id$
+
+require "socket_channel"
+require "steam/packets/rcon/rcon_packet"
+require "steam/packets/rcon/rcon_packet_factory"
+require "steam/sockets/steam_socket"
+
+class RCONSocket < SteamSocket
+  
+  def initialize(ip_address, port_number)
+    super ip_address, port_number
+    @channel = SocketChannel.open
+  end
+  
+  def send(data_packet)
+    if !@channel.connected?
+      @channel.connect @remote_socket
+    end
+    
+    @buffer = ByteBuffer.wrap data_packet.get_bytes
+    @channel.write @buffer
+  end
+  
+  def get_reply
+    self.receive_packet 1440
+    packet_data = @buffer.array[0..@buffer.limit]
+    packet_size = @buffer.get_long + 4
+    
+    if packet_size > 1440
+      remaining_bytes = packet_size - 1440
+      begin
+        if remaining_bytes < 1440
+          self.receive_packet remaining_bytes
+        else
+          self.receive_packet 1440
+        end
+        packet_data << @buffer.array[0..@buffer.limit]
+        remaining_bytes -= @buffer.limit
+      end while remaining_bytes > 0
+    end
+    
+    return RCONPacketFactory.get_packet_from_data(packet_data)
+  end
+  
+end

data/lib/steam/sockets/source_socket.rb

@@ -0,0 +1,72 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require "byte_buffer"
+require "steam/sockets/steam_socket"
+
+# The SourceSocket class is a sub class of SteamSocket respecting the
+# specifications of the Source query protocol.
+class SourceSocket < SteamSocket
+
+  # Reads a packet from the channel. The Source query protocol specifies a
+  # maximum packet size of 1400 byte. Greater packets will be split over several
+  # UDP packets. This method reassembles split packets into single packet
+  # objects.
+  def get_reply
+    bytes_read = self.receive_packet 1400
+    is_compressed = false
+
+    if @buffer.get_long == 0xFFFFFFFE
+      split_packets = Array.new
+      begin
+        # Parsing of split packet headers
+        request_id = @buffer.get_long
+        is_compressed = ((request_id & 0x80000000) != 0)
+        packet_count = @buffer.get_byte.to_i
+        packet_number = @buffer.get_byte.to_i + 1
+        
+        if is_compressed
+          split_size = @buffer.get_long
+          packet_checksum = @buffer.get_long
+        else
+          split_size = @buffer.get_short
+        end
+
+        # Caching of split packet data
+        split_packets[packet_number - 1] = @buffer.get
+        
+        warn "Received packet #{packet_number} of #{packet_count} for request ##{request_id}"
+
+        # Receiving the next packet
+        if split_packets.size < packet_count
+          begin
+            bytes_read = self.receive_packet
+          rescue TimeoutException
+            bytes_read = 0
+          end
+        else
+          bytes_read = 0
+        end
+      end while bytes_read > 0 && @buffer.get_long == 0xFFFFFFFE
+      
+      if is_compressed
+        packet = SteamPacketFactory.reassemble_packet(split_packets, true, packet_checksum)
+      else
+        packet = SteamPacketFactory.reassemble_packet(split_packets)
+      end
+    else
+      packet = SteamPacketFactory.get_packet_from_data(@buffer.get)
+    end
+
+    if is_compressed
+      warn "Got compressed reply of type \"#{packet.class.to_s}\"."
+    else
+      warn "Got reply of type \"#{packet.class.to_s}\"."
+    end
+    
+    return packet
+  end
+  
+end

data/lib/steam/sockets/steam_socket.rb

@@ -0,0 +1,63 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008, Sebastian Staudt
+#
+# $Id$
+
+require "abstract_class"
+require "byte_buffer"
+require "datagram_channel"
+require "ipaddr"
+require "exceptions/timeout_exception"
+
+# The SteamSocket class is a sub class of CondenserSocket respecting the
+# specifications of the Source query protocol.
+class SteamSocket
+  
+  include AbstractClass
+  
+  def initialize(*args)
+    @channel = DatagramChannel.open
+    @channel.connect *args
+    @channel.configure_blocking false
+    
+    @remote_socket = Socket.getaddrinfo args[0].to_s, args[1]
+  end
+
+  # Abstract get_reply method
+  def get_reply
+    raise NotImplementedError
+  end
+  
+  def receive_packet(buffer_length = 0)
+    if select([@channel.socket], nil, nil, 1) == nil
+        raise TimeoutException.new
+    end
+
+    if buffer_length == 0
+      @buffer.clear
+    else
+      @buffer = ByteBuffer.allocate buffer_length
+    end
+    
+    @channel.read @buffer
+    bytes_read = @buffer.position
+    @buffer.rewind
+    @buffer.limit = bytes_read
+    
+    return bytes_read
+  end
+  
+  def send(data_packet)
+    warn "Sending data packet of type \"#{data_packet.class.to_s}\"."
+    
+    @buffer = ByteBuffer.wrap data_packet.to_s
+    @channel.write @buffer
+  end
+  
+  def finalize
+    @channel.close
+  end
+  
+end