demo-reader 0.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 aekym
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= demo-reader
+
+A library to parse warsow demo files
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 aekym. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "demo-reader"
+    gem.summary = %Q{A library to read warsow and defrag demo files}
+    gem.description = %Q{A library to read warsow and defrag demo files}
+    gem.email = "me@aekym.com"
+    gem.homepage = "http://github.com/aekym/demo-reader"
+    gem.authors = ["aekym"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "demo-reader #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/demo-reader.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{demo-reader}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["aekym"]
+  s.date = %q{2010-01-16}
+  s.description = %q{A library to read warsow and defrag demo files}
+  s.email = %q{me@aekym.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "demo-reader.gemspec",
+     "lib/demo-reader.rb",
+     "lib/demo_reader_warsow.rb",
+     "test/demo_reader_test.rb",
+     "test/demo_reader_warsow_wd10_race_test.rb",
+     "test/demo_reader_warsow_wd11_race_test.rb",
+     "test/fixtures/warsow/wd10/racesow_0.42.b2/dinirun2_racesow_0.42.b2.wd10",
+     "test/fixtures/warsow/wd10/racesow_local/boris.wd10",
+     "test/fixtures/warsow/wd10/racesow_local/die11.7.wd10",
+     "test/fixtures/warsow/wd10/racesow_local/dvr_antr.wd10",
+     "test/fixtures/warsow/wd10/racesow_local/e-lava.wd10",
+     "test/fixtures/warsow/wd10/racesow_local/j4n12.8.wd10",
+     "test/fixtures/warsow/wd10/racesow_local/terror.wd10",
+     "test/fixtures/warsow/wd10/racesow_local/yescomp006-2.wd10",
+     "test/fixtures/warsow/wd10/racesow_local/zugo.wd10",
+     "test/fixtures/warsow/wd10/trouble_making/2.wd10",
+     "test/fixtures/warsow/wd10/trouble_making/boris_cab1.wd10",
+     "test/fixtures/warsow/wd10/trouble_making/very_short_demo.wd10",
+     "test/fixtures/warsow/wd11/bomb_wbomb1_b2uberspot.wd11",
+     "test/fixtures/warsow/wd11/race_bardok-lick-revamped_54.882.wd11",
+     "test/fixtures/warsow/wd11/race_cwrace5.wd11",
+     "test/fixtures/warsow/wd11/race_killua-hykon.wd11",
+     "test/fixtures/warsow/wd11/race_st1_07.848.wd11",
+     "test/fixtures/warsow/wd11/race_wdm16_unfinished.wd11",
+     "test/fixtures/warsow/wd11/race_wrc03-3_28.684.wd11",
+     "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/aekym/demo-reader}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A library to read warsow and defrag demo files}
+  s.test_files = [
+    "test/demo_reader_test.rb",
+     "test/demo_reader_warsow_wd10_race_test.rb",
+     "test/demo_reader_warsow_wd11_race_test.rb",
+     "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/demo-reader.rb

@@ -0,0 +1,25 @@
+require "demo_reader_warsow"
+
+
+class DemoReader
+
+
+  # tries to parse the given demo file in order to detect a warsow demo
+  #
+  # @returns an instance of DemoReaderWarsow or nil on failure
+  #
+  def self.parse(filename)
+    try_warsow(filename)
+  end
+
+
+  protected
+
+  def self.try_warsow(filename)
+    demo = DemoReaderWarsow.new(filename)
+
+    demo.valid ? demo : nil
+  end
+
+end
+

data/lib/demo_reader_warsow.rb

@@ -0,0 +1,225 @@
+class DemoReaderWarsow
+  attr_reader :filename, :version, :mapname, :time, :playernames, :scoreboards, :gamemode, :player, :basegamedir, :gamedir, :valid
+
+
+  def initialize(filename)
+    @filename = filename
+    @version = -1
+    @mapname = nil
+    @time = nil
+    @time_in_msec = nil
+    @playernames = []
+    @scoreboards = []
+    @gamemode = nil
+    @player = nil
+    @basegamedir = nil
+    @gamedir = nil
+    @valid = false
+
+    self.init()
+  end
+
+
+
+  def init
+    file = File.new(@filename, 'r')
+
+    return if file.stat.size < 10
+
+    @version = detect_version(file)
+
+    # just support some wd* file versions
+    return unless [8, 9, 10, 11].include? @version
+
+    # skip 4 bytes "svs.spawncount"
+    file.pos += 4
+
+    # skip 2 bytes "cl.snapFrameTime"
+    file.pos += 2 if [10, 11].include? @version
+
+    # skip 4 bytes "cl.baseServerTime"
+    file.pos += 4 if @version == 10
+
+
+    # FS_BaseGameDirectory
+    @basegamedir = file.gets("\0").chop
+
+    # FS_GameDirectory
+    @gamedir = file.gets("\0").chop
+
+    # skip short "playernum"
+    file.pos += 2
+
+
+    # mapname
+    @mapname = file.gets("\0").chop.downcase
+
+    content = file.gets nil
+    file.close
+
+
+
+
+    # detect scoreboard
+
+    regex = /scb \"([^\"]+)/
+    matchdata = regex.match(content)
+
+    while matchdata
+      @scoreboards.push matchdata[1]
+      matchdata = regex.match(matchdata.post_match)
+    end
+
+
+
+    # detect game mode
+
+    if @version == 11
+      @gamemode = gamemode_wd11(content)
+    else
+      regex = /&([^ ]+) /
+
+      gamemodes = []
+      @scoreboards.each do |scb|
+        matchdata = regex.match(scb)
+        gamemodes.push matchdata[1]
+      end
+      gamemodes.uniq!
+      if gamemodes.length.zero?
+        @gamemode = 'unknown'
+      else
+        if gamemodes.length == 1
+          @gamemode = gamemodes.first
+          @gamemode.chop! if ['races', 'dms', 'ctfs'].include? @gamemode
+        else
+          @gamemode = "multiple gamemodes found: #{gamemodes.join(', ')}!"
+        end
+      end
+    end
+
+
+
+    # detect time by sent message string with time from server
+    if ['race', 'unknown'].include?(@gamemode)
+      matches = []
+      regex = /(server record|race finished)(?:!.*(?:current|times\^7 ))?: (\d+):(\d+)\.(\d+)/im
+      matchdata = regex.match(content)
+
+      while matchdata
+        matches.push("%02d:%02d.%03d" % [$2,$3,$4].map(&:to_i))
+        matchdata = regex.match(matchdata.post_match)
+      end
+
+      if matches.length > 0
+        @time = matches.sort.first
+        @gamemode = 'race' if @gamemode == 'unknown'
+      end
+    end
+
+
+
+    #detect all player names
+    matches = []
+    regex = /cs ([0-9]+) \"\\name\\([^\0]*)\\hand/
+    rest_content = content
+    matchdata = regex.match(rest_content)
+    first_no = matchdata[1].to_i
+
+    while matchdata
+      # damit werden doppelte eintraege durch den letzten aktuellen ueberschrieben
+      matches[matchdata[1].to_i - first_no] = matchdata[2]
+      rest_content = matchdata.post_match
+      matchdata = regex.match(rest_content)
+    end
+
+    if matches.length > 0
+      # save player names only
+      @playernames = []
+      matches.each_with_index { |player, number|
+        #playernames.push [number, player].join(': ')
+        @playernames[number] = player
+      }
+    end
+
+
+
+    # detect player
+
+    playernames = @playernames.compact.sort.uniq
+    if playernames.length == 1
+      @player = playernames.first
+    else
+      if @time && @gamemode == 'race' && !@scoreboards.empty? && !playernames.empty?
+        min, sec, msec = @time.scan(/^([0-9]+):([0-9]+)\.([0-9]+)$/).flatten.map { |x| x.to_i }
+        min = 9 if min > 9                                                      # scoreboard does not support race times > 9:55:999; max minute value is 9 !
+        t = "#{min}#{sec}#{msec}"
+        regex = Regexp.new("&p ([0-9]+) #{t}")
+        playerids = @scoreboards.join('').scan(regex).flatten.uniq
+        if playerids.length == 1
+          @player = @playernames[playerids.first.to_i]
+        end
+      end
+    end
+
+    @valid = true
+  end
+
+
+
+  def detect_version(file)
+    # try to detect version 8, 9 or 10
+    #
+    file.pos = 0
+
+    file.pos += 4 # skip 4 byte message length
+    file.pos += 1  # skip 1 byte "svc_serverdata"
+
+    # version
+    # reads 4 bytes and decodes the little-endian format
+    version = file.read(4).unpack('V')[0]
+
+    return version if [8, 9, 10].include? version
+
+
+    # try to detect version 11
+    #
+    file.pos = 0
+
+    file.pos += 1  # skip 1 byte "svc_demoinfo"
+
+    file.pos += 4  # skip 4 byte "initial server time"
+    file.pos += 4  # skip 4 byte "demo duration in milliseconds"
+    file.pos += 4  # skip 4 byte "file offset at which the final -1 was written"
+
+    file.pos += 1  # skip 1 byte "svc_serverdata"
+
+    file.pos += 4  # skip 4 byte "UNKNOWN! - not documented in source, but is needed to fit demos!"
+
+    # version
+    # reads 4 bytes and decodes the little-endian format
+    version = file.read(4).unpack('V')[0]
+
+    return version if version == 11
+
+    nil # could not detect any known version
+  end
+
+
+  def time_in_msec
+    return @time_in_msec unless @time_in_msec.nil?
+
+    # time str to int
+    if @time.kind_of? String
+      min, sec, msec = @time.scan(/^([0-9]+):([0-9]+)\.([0-9]+)$/).flatten.map { |x| x.to_i }
+      @time_in_msec = msec + sec * 1000 + min * 60 * 1000
+    end
+  end
+
+
+  def gamemode_wd11(file_content)
+    if file_content =~ /cs 12 "(.*?)"/
+      $1
+    end
+  end
+end
+

data/test/demo_reader_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/helper'
+
+class DemoReaderTest < Test::Unit::TestCase
+
+  def test_interface
+    assert DemoReader.respond_to?(:parse)
+  end
+
+end
+

data/test/demo_reader_warsow_wd10_race_test.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/helper'
+
+class DemoReaderWarsowWd10RaceTest < Test::Unit::TestCase
+
+  version = 10
+
+  [
+    %w(racesow_0.42.b2/dinirun2_racesow_0.42.b2 dinirun2 00:21.870),
+    %w(racesow_local/boris boris_75m 00:16.336),
+    %w(racesow_local/die11.7 die 00:11.737),
+    %w(racesow_local/dvr_antr dvr_antr 00:09.485),
+    %w(racesow_local/e-lava e-lavastore 00:06.313),
+    %w(racesow_local/j4n12.8 j4n_wtf 00:12.814),
+    %w(racesow_local/terror terror-box 00:18.553),
+    %w(racesow_local/yescomp006-2 un-dead!020_4 00:14.971),
+    %w(racesow_local/zugo zugo 00:14.894),
+    %w(trouble_making/2 gu3#8-bomb 00:12.834),
+    %w(trouble_making/boris_cab1 boris_cab1 16:34.514),
+    %w(trouble_making/very_short_demo gu3-bored 00:02.748)
+  ].each do |entry|
+
+    file, map, time = entry
+
+    define_method "test_warsow_wd#{version}_demo_#{file.gsub(/[^a-z_0-9]/, "_")}" do
+      demo = DemoReader.parse("test/fixtures/warsow/wd#{version}/#{file}.wd#{version}")
+
+      assert demo.valid
+      assert_equal "race", demo.gamemode
+      assert_equal version, demo.version
+      assert_equal map, demo.mapname
+      assert_equal time, demo.time
+    end
+
+  end
+
+end
+

data/test/demo_reader_warsow_wd11_race_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/helper'
+
+class DemoReaderWarsowWd11RaceTest < Test::Unit::TestCase
+
+  version = 11
+
+  [
+    %w(race_cwrace5 cwrace5),
+    %w(race_killua-hykon killua-hykon),
+    %w(race_st1_07.848 st1 00:07.848),
+    %w(race_wdm16_unfinished wdm16),
+    %w(race_bardok-lick-revamped_54.882 bardok-lick-revamped 00:54.882),
+    %w(race_wrc03-3_28.684 wrc03-3 00:28.684)
+  ].each do |entry|
+
+    file, map, time = entry
+
+    define_method "test_warsow_wd#{version}_demo_#{file.gsub(/[^a-z_0-9]/, "_")}" do
+      demo = DemoReader.parse("test/fixtures/warsow/wd#{version}/#{file}.wd#{version}")
+
+      assert demo.valid
+      assert_equal "race", demo.gamemode
+      assert_equal version, demo.version
+      assert_equal map, demo.mapname
+      assert_equal time, demo.time if time
+    end
+
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'demo-reader'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: demo-reader
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- aekym
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-16 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A library to read warsow and defrag demo files
+email: me@aekym.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- demo-reader.gemspec
+- lib/demo-reader.rb
+- lib/demo_reader_warsow.rb
+- test/demo_reader_test.rb
+- test/demo_reader_warsow_wd10_race_test.rb
+- test/demo_reader_warsow_wd11_race_test.rb
+- test/fixtures/warsow/wd10/racesow_0.42.b2/dinirun2_racesow_0.42.b2.wd10
+- test/fixtures/warsow/wd10/racesow_local/boris.wd10
+- test/fixtures/warsow/wd10/racesow_local/die11.7.wd10
+- test/fixtures/warsow/wd10/racesow_local/dvr_antr.wd10
+- test/fixtures/warsow/wd10/racesow_local/e-lava.wd10
+- test/fixtures/warsow/wd10/racesow_local/j4n12.8.wd10
+- test/fixtures/warsow/wd10/racesow_local/terror.wd10
+- test/fixtures/warsow/wd10/racesow_local/yescomp006-2.wd10
+- test/fixtures/warsow/wd10/racesow_local/zugo.wd10
+- test/fixtures/warsow/wd10/trouble_making/2.wd10
+- test/fixtures/warsow/wd10/trouble_making/boris_cab1.wd10
+- test/fixtures/warsow/wd10/trouble_making/very_short_demo.wd10
+- test/fixtures/warsow/wd11/bomb_wbomb1_b2uberspot.wd11
+- test/fixtures/warsow/wd11/race_bardok-lick-revamped_54.882.wd11
+- test/fixtures/warsow/wd11/race_cwrace5.wd11
+- test/fixtures/warsow/wd11/race_killua-hykon.wd11
+- test/fixtures/warsow/wd11/race_st1_07.848.wd11
+- test/fixtures/warsow/wd11/race_wdm16_unfinished.wd11
+- test/fixtures/warsow/wd11/race_wrc03-3_28.684.wd11
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/aekym/demo-reader
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A library to read warsow and defrag demo files
+test_files: 
+- test/demo_reader_test.rb
+- test/demo_reader_warsow_wd10_race_test.rb
+- test/demo_reader_warsow_wd11_race_test.rb
+- test/helper.rb