sc2 0.0.5

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sc2.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sc2.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bindata'
+require 'bzip2-ruby'
+Dir['./wrappers/*.rb'].each { |f| require f }
+Dir['./magick/*.rb'].each { |f| require f }
+
+module Sc2
+  class Replay
+    def initialize rep_file
+    @reader = Reader.new rep_file
+      @replay = Hash[:details, Parser.parse(@reader.read_file('replay.details')), 
+      :initData, InitData.read(@reader.read_file('replay.initData')),
+      :userData, Parser.parse(@reader.user_hdr.user_data),
+      :gameVersion, '']
+      @replay[:gameVersion] = { :major => @replay[:userData][1][1], :minor => @replay[:userData][1][2], :patch => @replay[:userData[1][3]], :build => @replay[:userData][1][4] }
+      @replay[:players] = p_players
+    end
+
+    def map
+      @replay[:details][1]
+    end
+
+    def winner
+      @replay[:players].each { |player| return player if player.win? }
+    end
+    
+    def loser
+      @replay[:players].each { |player| return player if !player.win? }
+    end
+
+    def players
+      @replay[:players]
+    end
+
+  private
+    def attributes
+      return @attributes if defined? @attributes
+      data = @reader.read_file "replay.attributes.events"
+      data.slice! 0, (@replay[:gameVersion][:build] < 17326 ? 4 : 5)
+      @attributes = []
+      data.slice!(0, 4).unpack("V")[0].times { @attributes << Attribute.read(data.slice!(0, 13)) }
+      @attributes
+    end
+
+    def p_players
+      return @players if defined? @players
+      player_id = 0
+      @players = @replay[:details][0].map { |player| Player.new ({ :name => player[0], :outcome => player[8], :id => player_id += 1, :attrs =>  attributes.map { |attr| { :attr_id => attr[:id], :value => attr[:val] } if attr[:player] == player_id } }) }
+    end
+  end
+end

data/lib/sc2/magick/hasher.rb

@@ -0,0 +1,45 @@
+module Sc2
+  class Hasher
+    def initialize
+      set_enc_tbl
+    end
+
+    def hash_for hash_type, s
+      hash_type = [:table_offset, :hash_a, :hash_b, :table].index hash_type
+      seed1, seed2 = 0x7FED7FED, 0xEEEEEEEE
+      s.upcase.each_byte do |c|
+        value = @encryption_table[(hash_type << 8) + c]
+        seed1 = (value ^ (seed1 + seed2)) & 0xFFFFFFFF
+        seed2 = (c + seed1 + seed2 + (seed2 << 5) + 3) & 0xFFFFFFFF
+      end
+      seed1
+    end
+
+    def decrypt data, seed1
+      seed2 = 0xEEEEEEEE
+      data.unpack('V*').map do |value|
+        seed2 = (seed2 + @encryption_table[0x400 + (seed1 & 0xFF)]) & 0xFFFFFFFF
+        value = (value ^ (seed1 + seed2)) & 0xFFFFFFFF
+        seed1 = (((~seed1 << 0x15) + 0x11111111) | (seed1 >> 0x0B)) & 0xFFFFFFFF
+        seed2 = (value + seed2 + (seed2 << 5) + 3) & 0xFFFFFFFF
+        value
+      end.pack('V*')
+    end
+
+  private
+    def set_enc_tbl
+      seed = 0x00100001
+      @encryption_table = {}
+      (0..255).each do |i|
+        index = i
+        (0..4).each do |j|
+          seed = (seed * 125 + 3) % 0x2AAAAB
+          tmp1 = (seed & 0xFFFF) << 0x10
+          seed = (seed * 125 + 3) % 0x2AAAAB
+          tmp2 = (seed & 0xFFFF)
+          @encryption_table[i + j * 0x100] = (tmp1 | tmp2)
+        end
+      end
+    end
+  end
+end

data/lib/sc2/magick/parser.rb

@@ -0,0 +1,42 @@
+module Sc2
+  class Parser
+    def self.parse data
+      self.parse_recur String.new data
+    end
+
+    def self.parse_recur data
+      case data.slice!(0).bytes.next
+        when 2
+          data.slice! 0, vlf(data)
+        when 4
+          data.slice! 0, 2
+          (0...vlf(data)).map {|i| parse_recur data }
+        when 5
+          Hash.[]((0...vlf(data)).map do |i| 
+            [vlf(data), parse_recur(data)]
+          end)
+        when 6
+          data.slice! 0
+        when 7
+          data.slice!(0, 4).unpack("V")[0]
+        when 9
+          vlf data
+        else
+          nil
+      end
+    end
+
+    def self.vlf data
+      ret, shift = 0, 0
+      loop do
+        char = data.slice!(0)
+        return nil unless char
+        byte = char.bytes.next
+        ret += (byte & 0x7F) << (7 * shift)
+        break if byte & 0x80 == 0
+        shift += 1
+      end
+      (ret >> 1) * ((ret & 0x1) == 0 ? 1 : -1)
+    end
+  end
+end

data/lib/sc2/magick/reader.rb

@@ -0,0 +1,60 @@
+module Sc2
+  class Reader
+    attr_reader :user_hdr
+    def initialize rep_file
+      @rep_file = rep_file
+      set_hdrs
+      set_tbls
+    end
+
+    def read_file file
+      hasher = Hasher.new
+      hash_a = hasher.hash_for :hash_a, file
+      hash_b = hasher.hash_for :hash_b, file
+      hash_entry = @hash_tbl.find { |h| [h.hash_a, h.hash_b] == [hash_a, hash_b] }
+      block_entry = @block_tbl[hash_entry.block_index]
+      @rep_file.seek @user_hdr.archive_header_offset + block_entry.block_offset
+      file_data = @rep_file.read block_entry.archived_size
+      if block_entry.single_unit?
+        file_data = Bzip2.uncompress file_data[1, file_data.length] if block_entry.compressed? && file_data.bytes.next == 16
+        return file_data
+      end
+      sector_size = 512 << @archive_hdr.sector_size_shift
+      sectors = block_entry.size / sector_size + 1
+      sectors += 1 if block_entry.has_checksums
+      positions = file_data[0, 4 * (sectors + 1)].unpack "V#{sectors + 1}"
+      sectors = []
+      positions.each_with_index do |pos, i|
+        break if i + 1 == positions.length
+        sector = file_data[pos, positions[i + 1] - pos]
+        sector = Bzip2.uncompress sector if block_entry.compressed? && block_entry.size > block_entry.archived_size && sector.bytes.next == 16
+        sectors << sector
+      end
+      sectors.join ''
+    end
+
+  private
+    def set_hdrs
+      @user_hdr = UserHeader.read @rep_file
+      @rep_file.seek @user_hdr.archive_header_offset
+      @archive_hdr = ArchiveHeader.read @rep_file
+    end
+
+    def set_tbls
+      @hash_tbl = read_tbl 'hash'
+      @block_tbl = read_tbl 'block'
+    end
+
+    def read_tbl type
+      tbl_offset = @archive_hdr[type + '_table_offset']
+      @rep_file.seek @user_hdr.archive_header_offset + tbl_offset
+      tbl_entries = @archive_hdr[type + '_table_entries']
+      hasher = Hasher.new
+      key = hasher.hash_for :table, "(#{type} table)"
+      data = @rep_file.read tbl_entries * 16
+      data = hasher.decrypt data, key
+      layout = type == 'hash' ? HashTableEntry : BlockTableEntry
+      (0...tbl_entries).map { |i| layout.read(data[i * 16, 16]) }
+    end
+  end
+end

data/lib/sc2/version.rb

@@ -0,0 +1,3 @@
+module Sc2
+  VERSION = "0.0.4"
+end

data/lib/sc2/wrappers/archive_header.rb

@@ -0,0 +1,18 @@
+module Sc2
+  class ArchiveHeader < BinData::Record
+    endian :little
+    string :archive_magic, :length => 4
+    int32  :header_size
+    int32  :archive_size
+    int16  :format_version
+    int8   :sector_size_shift
+    int8
+    int32  :hash_table_offset
+    int32  :block_table_offset
+    int32  :hash_table_entries
+    int32  :block_table_entries
+    int64  :extended_block_table_offset
+    int16  :hash_table_offset_high
+    int16  :block_table_offset_high
+  end
+end

data/lib/sc2/wrappers/attribute.rb

@@ -0,0 +1,9 @@
+module Sc2
+  class Attribute < BinData::Record
+    endian :little
+    string :header, :length => 4
+    uint32 :id
+    uint8  :player
+    string :val, :length => 4
+  end
+end

data/lib/sc2/wrappers/block_table_entry.rb

@@ -0,0 +1,25 @@
+module Sc2
+  class BlockTableEntry < BinData::Record
+    endian :little
+    int32  :block_offset
+    int32  :archived_size
+    int32  :file_size
+    uint32 :flags
+
+    def file?
+	    (flags & 0x80000000) != 0
+    end
+
+    def compressed?
+	    (flags & 0x00000200) != 0
+    end
+
+    def encrypted?
+	    (flags & 0x00010000) != 0
+    end
+
+    def single_unit?
+	    (flags & 0x01000000) != 0
+    end
+  end
+end

data/lib/sc2/wrappers/hash_table_entry.rb

@@ -0,0 +1,11 @@
+module Sc2
+  class HashTableEntry < BinData::Record
+    endian :little
+    uint32 :hash_a
+    uint32 :hash_b
+    int16  :language
+    int8   :platform
+    int8
+    int32  :block_index
+  end
+end

data/lib/sc2/wrappers/init_data.rb

@@ -0,0 +1,14 @@
+module Sc2
+  class InitData < BinData::Record
+    uint8 :num_players
+    array :players, :initial_length => :num_players do
+      uint8 :player_name_length
+      string :player_name, :length => :player_name_length
+      skip :length => 5
+    end
+    string :unknown_24, :length => 24
+    uint8 :account_length
+    string :account, :length => :account_length
+    rest :rest
+  end
+end

data/lib/sc2/wrappers/player.rb

@@ -0,0 +1,34 @@
+module Sc2
+  class Player
+    OUTCOMES = [:unknown, :win, :loss]
+    ATTRIBUTES = { :player_race => { "RAND" => :random, "Terr" => 'terran', "Prot" => 'protoss', "Zerg" => 'zerg' } }
+    def initialize params
+      @params = params
+      @params[:outcome] = OUTCOMES[@params[:outcome]]
+      @params[:attrs].compact!
+      @params[:attrs].each { |attr| attr[:value].reverse! }
+    end
+
+    def race
+      @params[:attrs].each do |attr|
+        return ATTRIBUTES[:player_race][attr[:value]] if attr[:attr_id] == 3001
+      end
+    end
+
+    def id
+      @params[:id]
+    end
+
+    def name
+      @params[:name]
+    end
+
+    def win?
+      @params[:outcome] == :win
+    end
+
+    def loss?
+      @params[:outcome] == :loss
+    end
+  end
+end

data/lib/sc2/wrappers/user_header.rb

@@ -0,0 +1,10 @@
+module Sc2
+  class UserHeader < BinData::Record
+    endian :little
+    string :user_magic, :length => 4
+    uint32 :user_data_max_length
+    uint32 :archive_header_offset
+    uint32 :user_data_length
+    string :user_data, :length => :user_data_length
+  end
+end

data/sc2.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sc2"
+  s.version     = "0.0.5"
+  s.authors     = ["vasechika"]
+  s.email       = ["second.pilot@gmail.com"]
+  s.homepage    = "https://github.com/vasechika/sc2"
+  s.summary     = "SC 2"
+  s.description = "Gem for parsing Starcraft 2 replays"
+
+  s.rubyforge_project = "sc2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "rspec"
+  s.add_dependency "bindata"
+  s.add_dependency "bzip2-ruby"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: sc2
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- vasechika
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bindata
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bzip2-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Gem for parsing Starcraft 2 replays
+email: 
+- second.pilot@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/sc2.rb
+- lib/sc2/magick/hasher.rb
+- lib/sc2/magick/parser.rb
+- lib/sc2/magick/reader.rb
+- lib/sc2/version.rb
+- lib/sc2/wrappers/archive_header.rb
+- lib/sc2/wrappers/attribute.rb
+- lib/sc2/wrappers/block_table_entry.rb
+- lib/sc2/wrappers/hash_table_entry.rb
+- lib/sc2/wrappers/init_data.rb
+- lib/sc2/wrappers/player.rb
+- lib/sc2/wrappers/user_header.rb
+- sc2.gemspec
+homepage: https://github.com/vasechika/sc2
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sc2
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: SC 2
+test_files: []
+