steam-condenser 0.10.1 → 0.11.0

data/lib/steam/sockets/goldsrc_socket.rb

@@ -1,12 +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-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "byte_buffer"
-require "steam/packets/steam_packet_factory"
-require "steam/packets/rcon/rcon_goldsrc_request"
-require "steam/sockets/steam_socket"
+require 'stringio_additions'
+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.
@@ -21,18 +21,18 @@ class GoldSrcSocket < SteamSocket
   # 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
+  def reply
+    bytes_read = receive_packet 1400
+
+    if @buffer.long == 0xFFFFFFFE
+      split_packets = []
       begin
         # Parsing of split packet headers
-        request_id = @buffer.get_long
-        packet_number_and_count = @buffer.get_byte.to_i
+        request_id = @buffer.long
+        packet_number_and_count = @buffer.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
 
@@ -41,68 +41,65 @@ class GoldSrcSocket < SteamSocket
         # Receiving the next packet
         if split_packets.size < packet_count
           begin
-            bytes_read = self.receive_packet
+            bytes_read = receive_packet
           rescue TimeoutException
             bytes_read = 0
           end
         else
           bytes_read = 0
         end
-      end while bytes_read > 0 && @buffer.get_long == 0xFFFFFFFE
-      
+      end while bytes_read > 0 && @buffer.long == 0xFFFFFFFE
+
       packet = SteamPacketFactory.reassemble_packet(split_packets)
-        
     else
-      packet = SteamPacketFactory.get_packet_from_data(@buffer.get)
+      packet = SteamPacketFactory.packet_from_data(@buffer.get)
     end
 
     puts "Got reply of type \"#{packet.class.to_s}\"." if $DEBUG
 
-    return packet
+    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}"
+    rcon_challenge if @rcon_challenge.nil? or @is_hltv
+
+    rcon_send "rcon #{@rcon_challenge} #{password} #{command}"
     if @is_hltv
       begin
-        response = self.get_reply.get_response
+        response = reply.response
       rescue TimeoutException
-        response = ""
+        response = ''
       end
     else
-      response = self.get_reply.get_response
+      response = reply.response
     end
-    
-    if response.strip == "Bad rcon_password." or response.strip == "You have been banned from this server."
-      raise RCONNoAuthException.new
+
+    if response.strip == 'Bad rcon_password.' or response.strip == 'You have been banned from this server.'
+      raise RCONNoAuthException
     end
-    
+
     begin
-      while true
-        response_part = self.get_reply.get_response
+      loop do
+        response_part = reply.response
         response << response_part
       end
     rescue TimeoutException
     end
-    
-    return response
+
+    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
-    
+
+  def rcon_challenge
+    rcon_send 'challenge rcon'
+    response = reply.response.strip
+
+    raise RCONNoAuthException if response == 'You have been banned from this server.'
+
     @rcon_challenge = response[14..-1]
   end
-  
+
   def rcon_send(command)
-    self.send RCONGoldSrcRequest.new(command)
+    send RCONGoldSrcRequest.new(command)
   end
-  
+
 end

data/lib/steam/sockets/master_server_socket.rb

@@ -1,20 +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-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "steam/sockets/steam_socket"
+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)
+
+  def reply
+    receive_packet 1500
+
+    raise Exception.new("Master query response has wrong packet header.") unless @buffer.long == 0xFFFFFFFF
+
+    SteamPacketFactory.packet_from_data(@buffer.get)
   end
-  
-end
+
+end

data/lib/steam/sockets/rcon_socket.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-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
 require 'socket_channel'
 require 'exceptions/rcon_ban_exception'
@@ -17,35 +17,33 @@ class RCONSocket < SteamSocket
   end
 
   def send(data_packet)
-    if !@channel.connected?
-      @channel.connect @remote_socket
-    end
+    @channel.connect @remote_socket unless @channel.connected?
 
-    @buffer = ByteBuffer.wrap data_packet.get_bytes
+    @buffer = StringIO.new data_packet.bytes
     @channel.write @buffer
   end
 
-  def get_reply
-    if self.receive_packet(1440) == 0
-      raise RCONBanException
-    end
-    packet_data = @buffer.array[0..@buffer.limit]
-    packet_size = @buffer.get_long + 4
+  def reply
+    raise RCONBanException if receive_packet(1440) == 0
+
+    packet_data = @buffer.get
+    packet_size = @buffer.long + 4
+    @buffer.rewind
 
     if packet_size > 1440
-      remaining_bytes = packet_size - @buffer.limit
+      remaining_bytes = packet_size - @buffer.size
       begin
         if remaining_bytes < 1440
-          self.receive_packet remaining_bytes
+          receive_packet remaining_bytes
         else
-          self.receive_packet 1440
+          receive_packet 1440
         end
-        packet_data << @buffer.array[0..@buffer.limit]
-        remaining_bytes -= @buffer.limit
+        packet_data << @buffer.get
+        remaining_bytes -= @buffer.size
       end while remaining_bytes > 0
     end
 
-    return RCONPacketFactory.get_packet_from_data(packet_data)
+    RCONPacketFactory.packet_from_data(packet_data)
   end
 
 end

data/lib/steam/sockets/source_socket.rb

@@ -1,10 +1,10 @@
 # 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
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "byte_buffer"
-require "steam/sockets/steam_socket"
+require 'stringio_additions'
+require 'steam/sockets/steam_socket'
 
 # The SourceSocket class is a sub class of SteamSocket respecting the
 # specifications of the Source query protocol.
@@ -14,24 +14,24 @@ class SourceSocket < SteamSocket
   # 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
+  def reply
+    bytes_read = receive_packet 1400
     is_compressed = false
 
-    if @buffer.get_long == 0xFFFFFFFE
-      split_packets = Array.new
+    if @buffer.long == 0xFFFFFFFE
+      split_packets = []
       begin
         # Parsing of split packet headers
-        request_id = @buffer.get_long
+        request_id = @buffer.long
         is_compressed = ((request_id & 0x80000000) != 0)
-        packet_count = @buffer.get_byte.to_i
-        packet_number = @buffer.get_byte.to_i + 1
-        
+        packet_count = @buffer.byte.to_i
+        packet_number = @buffer.byte.to_i + 1
+
         if is_compressed
-          split_size = @buffer.get_long
-          packet_checksum = @buffer.get_long
+          @buffer.long
+          packet_checksum = @buffer.long
         else
-          split_size = @buffer.get_short
+          @buffer.short
         end
 
         # Caching of split packet data
@@ -42,22 +42,22 @@ class SourceSocket < SteamSocket
         # Receiving the next packet
         if split_packets.size < packet_count
           begin
-            bytes_read = self.receive_packet
+            bytes_read = receive_packet
           rescue TimeoutException
             bytes_read = 0
           end
         else
           bytes_read = 0
         end
-      end while bytes_read > 0 && @buffer.get_long == 0xFFFFFFFE
-      
+      end while bytes_read > 0 && @buffer.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)
+      packet = SteamPacketFactory.packet_from_data(@buffer.get)
     end
 
     if is_compressed
@@ -65,8 +65,8 @@ class SourceSocket < SteamSocket
     else
       puts "Got reply of type \"#{packet.class.to_s}\"." if $DEBUG
     end
-    
-    return packet
+
+    packet
   end
-  
+
 end

data/lib/steam/sockets/steam_socket.rb

@@ -1,60 +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-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "abstract_class"
-require "byte_buffer"
-require "datagram_channel"
-require "ipaddr"
-require "exceptions/timeout_exception"
+require 'abstract_class'
+require 'datagram_channel'
+require 'ipaddr'
+require 'stringio_additions'
+require 'exceptions/timeout_exception'
 
-# The SteamSocket class is a sub class of CondenserSocket respecting the
-# specifications of the Source query protocol.
+# Defines common methods for sockets used to connect to game and master
+# servers.
 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
+  # Abstract +reply+ method
+  def reply
     raise NotImplementedError
   end
-  
+
   def receive_packet(buffer_length = 0)
-    if select([@channel.socket], nil, nil, 1) == nil
-        raise TimeoutException.new
-    end
+    raise TimeoutException if select([@channel.socket], nil, nil, 1).nil?
 
     if buffer_length == 0
-      @buffer.clear
+      @buffer.truncate @buffer.size
     else
-      @buffer = ByteBuffer.allocate buffer_length
+      @buffer = StringIO.allocate buffer_length
     end
-    
-    bytes_read = @channel.read(@buffer)
+
+    bytes_read = @channel.read @buffer
     @buffer.rewind
-    @buffer.limit = bytes_read
-    
+
     bytes_read
   end
-  
+
   def send(data_packet)
     puts "Sending data packet of type \"#{data_packet.class.to_s}\"." if $DEBUG
 
-    @buffer = ByteBuffer.wrap(data_packet.to_s)
-    @channel.write(@buffer)
+    @buffer = StringIO.new data_packet.to_s
+    @channel.write @buffer
   end
-  
+
   def finalize
     @channel.close
   end
-  
+
 end

data/lib/steam/steam_player.rb

@@ -25,7 +25,9 @@ class SteamPlayer
   def add_info(real_id, name, steam_id, *player_data)
     @extended = true
 
-    raise SteamCondenserException.new('Information to add belongs to a different player.') unless name == @name
+    unless name == @name
+      raise SteamCondenserException.new('Information to add belongs to a different player.')
+    end
 
     @real_id  = real_id
     @steam_id = steam_id

data/lib/stringio_additions.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) 2010, Sebastian Staudt
+
+require 'stringio'
+
+class StringIO
+
+  alias_method :data, :string
+
+  def self.allocate(size)
+    new "\0" * size
+  end
+
+  def byte
+    read(1)[0]
+  end
+
+  def float
+    read(4).unpack('e')[0]
+  end
+
+  def get
+    read remaining
+  end
+
+  def long
+    read(4).unpack('V')[0]
+  end
+
+  def remaining
+    size - pos
+  end
+
+  def short
+    read(2).unpack('v')[0]
+  end
+
+  def signed_long
+    read(4).unpack('l')[0]
+  end
+
+  def string
+    gets("\0")[0..-2]
+  end
+
+end