steam-condenser 1.2.0 → 1.2.1

data/pkg/steam-condenser-1.2.0/lib/steam/sockets/master_server_socket.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 '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
+
+    SteamPacketFactory.packet_from_data(@buffer.get)
+  end
+
+end

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

@@ -0,0 +1,94 @@
+# 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 'ipaddr'
+require 'socket'
+require 'timeout'
+
+require 'errors/rcon_ban_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
+    @socket = nil
+  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
+  # @return [RCONPacket] The packet replied from the server
+  def reply
+    raise RCONBanError if receive_packet(4) == 0
+
+    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
+
+    RCONPacketFactory.packet_from_data(packet_data)
+  end
+
+end

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

@@ -0,0 +1,78 @@
+# 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/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
+
+    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
+
+        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
+
+      if is_compressed
+        packet = SteamPacketFactory.reassemble_packet(split_packets, true, packet_checksum)
+      else
+        packet = SteamPacketFactory.reassemble_packet(split_packets)
+      end
+    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.2.0/lib/steam/sockets/steam_socket.rb

@@ -0,0 +1,86 @@
+# 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 '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
+
+    data = @socket.recv @buffer.remaining
+    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

data/pkg/steam-condenser-1.2.0/lib/steam/steam_player.rb

@@ -0,0 +1,143 @@
+# 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/steam_condenser_error'
+
+# The SteamPlayer class represents a player connected to a server
+#
+# @author Sebastian Staudt
+class SteamPlayer
+
+  # Returns the client port of this player
+  #
+  # @return [Fixnum] The client port of the player
+  attr_reader :client_port
+
+  # Returns the time this player is connected to the server
+  #
+  # @return [Float] The connection time of the player
+  attr_reader :connect_time
+
+  # Returns the ID of this player
+  #
+  # @return [Fixnum] The ID of this player
+  attr_reader :id
+
+  # Returns the IP address of this player
+  #
+  # @return [String] The IP address of this player
+  attr_reader :ip_address
+
+  # Returns the nickname of this player
+  #
+  # @return [String] The name of this player
+  attr_reader :name
+
+  # Returns the packet loss of this player's connection
+  #
+  # @return [String] The packet loss of this player's connection
+  attr_reader :loss
+
+  # Returns the ping of this player
+  #
+  # @return [Fixnum] The ping of this player
+  attr_reader :ping
+
+  # Returns the rate of this player
+  #
+  # @return [Fixnum] The rate of this player
+  attr_reader :rate
+
+  # Returns the real ID (as used on the server) of this player
+  #
+  # @return [Fixnum] The real ID of this player
+  attr_reader :real_id
+
+  # Returns the score of this player
+  #
+  # @return [Fixnum] The score of this player
+  attr_reader :score
+
+  # Returns the connection state of this player
+  #
+  # @return [String] The connection state of this player
+  attr_reader :state
+
+  # Returns the SteamID of this player
+  #
+  # @return [String] The SteamID of this player
+  attr_reader :steam_id
+
+  # Creates a new player instance with the given information
+  #
+  # @param [Fixnum] id The ID of the player on the server
+  # @param [String] name The name of the player
+  # @param [Fixnum] score The score of the player
+  # @param [Float] connect_time The time the player is connected to the server
+  def initialize(id, name, score, connect_time)
+    @connect_time = connect_time
+    @id = id
+    @name = name
+    @score = score
+    @extended = false
+  end
+
+  # Extends a player object with information retrieved from a RCON call to
+  # the status command
+  #
+  # @param [String] player_data The player data retrieved from `rcon status`
+  # @raise [SteamCondenserError] if the information belongs to another
+  #         player
+  def add_info(player_data)
+    unless player_data[:name] == @name
+      raise SteamCondenserError, 'Information to add belongs to a different player.'
+    end
+
+    @extended = true
+
+    @real_id  = player_data[:userid].to_i
+    @steam_id = player_data[:uniqueid]
+    @state    = player_data[:state] if player_data.key? :state
+
+    if !bot?
+      @loss = player_data[:loss].to_i
+      @ping = player_data[:ping].to_i
+
+      if player_data.key? :adr
+        @ip_address, @client_port  = player_data[:adr].split(':')
+        @client_port = @client_port.to_i
+      end
+
+      @rate  = player_data[:rate].to_i if player_data.key? :rate
+    end
+  end
+
+  # Returns whether this player is a bot
+  #
+  # @return bool `true` if this player is a bot
+  def bot?
+    @steam_id == 'BOT'
+  end
+
+  # Returns whether this player object has extended information gathered
+  # using RCON
+  #
+  # @return bool `true` if extended information for this player is available
+  def extended?
+    @extended
+  end
+
+  # Returns a string representation of this player
+  #
+  # @return [String] A string representing this player
+  def to_s
+    if @extended
+      "\##@real_id \"#@name\", SteamID: #@steam_id, Score: #@score, Time: #@connect_time"
+    else
+      "\##@id \"#@name\", Score: #@score, Time: #@connect_time"
+    end
+  end
+
+end

data/pkg/steam-condenser-1.2.0/steam-condenser.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/lib/steam-condenser/version')
+
+Gem::Specification.new do |s|
+  s.name        = 'steam-condenser'
+  s.version     = SteamCondenser::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = [ 'Sebastian Staudt' ]
+  s.email       = [ 'koraktor@gmail.com' ]
+  s.homepage    = 'http://koraktor.de/steam-condenser'
+  s.summary     = 'Steam Condenser - A Steam query library'
+  s.description = 'A multi-language library for querying the Steam Community, Source, GoldSrc servers and Steam master servers'
+
+  s.add_dependency 'bzip2-ruby', '~> 0.2.7'
+  s.add_dependency 'multi_json', '~> 1.3.1'
+  s.add_dependency 'multi_xml', '~> 0.4.1'
+
+  s.add_development_dependency 'mocha', '~> 0.11.1'
+  s.add_development_dependency 'rake', '~> 0.9.2'
+  s.add_development_dependency 'shoulda-context', '~> 1.0.0'
+  s.add_development_dependency 'yard', '~> 0.7.2'
+
+  s.files              = Dir.glob '**/*'
+  s.test_files         = Dir.glob 'test/**/*'
+  s.require_paths      = [ 'lib' ]
+end