openra 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34349d5f69e993dc5c62afef3b1faabf20bd56c6
+  data.tar.gz: ee22bb04ead0b72e1a5526448bc901b9fb447cea
+SHA512:
+  metadata.gz: c0f19e0167ac3ec21e7edeab7e58495e8cc3414e56b98da98b3519430510fcce723b5693877777abb68e3da075f6453c0515a4ddbc123dd518b13725a6401626
+  data.tar.gz: b88312025fe593bd92996790f618b87489dc69a1af381885696424396a4476ef8edc78f1ab9a3ca294fcc65309fd2fbe4e35497eaf2adde163a124bb7f0b0cf8

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Andy Holland
+
+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.md

@@ -0,0 +1,15 @@
+# Openra Rubygem
+
+### Current state
+Early WIP, expermimental.
+
+### Installation
+```
+gem install openra
+```
+
+### Example usage
+
+```sh
+openra replay-data /payh/to/replay.orarep [--format json|pretty-json]
+```

data/Rakefile

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

data/bin/openra

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'openra-cli'
+
+Openra::CLI.new.call

data/lib/big_integer.rb

@@ -0,0 +1,43 @@
+class BigInteger < BinData::BasePrimitive
+  def value_to_binary_string(value)
+    value = value.abs
+    bytes = []
+
+    loop do
+      seven_bit_byte = value & 0x7f
+      value >>= 7
+      has_more = value.nonzero? ? 0x80 : 0
+      byte = has_more | seven_bit_byte
+      bytes.push(byte)
+
+      break if has_more.zero?
+    end
+
+    bytes.collect { |b| b.chr }.join
+  end
+
+  def read_and_return_value(io)
+    value = 0
+    bit_shift = 0
+
+    loop do
+      byte = read_uint8(io)
+      has_more = byte & 0x80
+      seven_bit_byte = byte & 0x7f
+      value |= seven_bit_byte << bit_shift
+      bit_shift += 7
+
+      break if has_more.zero?
+    end
+
+    value
+  end
+
+  def sensible_default
+    0
+  end
+
+  def read_uint8(io)
+    io.readbytes(1).unpack("C").at(0)
+  end
+end

data/lib/openra-cli.rb

@@ -0,0 +1 @@
+require 'openra/cli'

data/lib/openra.rb

@@ -0,0 +1,2 @@
+require 'openra/version'
+require 'openra/replays'

data/lib/openra/cli.rb

@@ -0,0 +1,11 @@
+require 'hanami/cli'
+require 'openra'
+require 'openra/cli/command_registry'
+
+module Openra
+  class CLI
+    def call(*args)
+      Hanami::CLI.new(CommandRegistry).call(*args)
+    end
+  end
+end

data/lib/openra/cli/command_registry.rb

@@ -0,0 +1,13 @@
+require 'openra/cli/commands/replay_data'
+require 'openra/cli/commands/version'
+
+module Openra
+  class CLI
+    class CommandRegistry
+      extend Hanami::CLI::Registry
+
+      register 'replay-data', Commands::ReplayData
+      register 'version', Commands::Version
+    end
+  end
+end

data/lib/openra/cli/commands/replay_data.rb

@@ -0,0 +1,97 @@
+require 'json'
+
+module Openra
+  class CLI
+    module Commands
+      class ReplayData < Hanami::CLI::Command
+        desc 'Output replay data to stdout'
+
+        argument :replay, required: true, desc: 'Path of the replay file to read data from'
+        option :format, default: 'json', values: %w(json pretty-json), desc: 'Output format'
+
+        def call(replay:, **options)
+          replay = Openra::Replays::Replay.new(replay)
+
+          client_index_mapping = {}
+          players = replay.metadata.each_with_object([]) do |(key, value), arr|
+            next unless key.start_with?('Player')
+            arr << value['Name']
+          end
+
+          replay_data = {
+            mod: replay.mod,
+            version: replay.version,
+            map: {
+              name: replay.map_title,
+              hash: replay.map_id
+            },
+            game: {
+              start_time: replay.start_time,
+              end_time: replay.end_time,
+              duration: replay.duration
+            },
+            clients: [],
+            chat: []
+          }
+
+          # Get all clients
+          replay.orders.select { |order| order.command == 'SyncLobbyClients' }.each do |order|
+            clients = Openra::YAML.load(order.target)
+            clients.each_pair do |_, client|
+              next if client_index_mapping.include?(client['Index'])
+
+              replay_data[:clients] << {
+                index: client['Index'],
+                name: client['Name'],
+                preferred_color: client['PreferredColor'],
+                color: client['Color'],
+                faction: client['Faction'],
+                ip: client['IpAddress'],
+                team: client['Team'] == 0 ? nil : client['Team'],
+                is_bot: client['Bot'].nil? ? false : true,
+                is_admin: client['IsAdmin'] == 'True',
+                is_player: players.include?(client['Name']),
+                build: []
+              }
+
+              client_index_mapping[client['Index']] = client
+            end
+          end
+
+          replay.orders.each do |order|
+            case order.command
+            when 'PlaceBuilding'
+              client = replay_data[:clients].find do |candidate|
+                candidate[:index] == order.client_index.to_s
+              end
+
+              client[:build] << {
+                structure: order.target_string,
+                placement: {
+                  x: order.target_x,
+                  y: order.target_y
+                }
+              }
+            when 'Chat'
+              client = replay_data[:clients].find do |candidate|
+                candidate[:index] == order.client_index.to_s
+              end
+
+              replay_data[:chat] << {
+                name: client[:name],
+                message: order.target
+              }
+            end
+          end
+
+          case options[:format]
+          when 'json'
+            puts JSON.dump(replay_data)
+          when 'pretty-json'
+            puts JSON.pretty_generate(replay_data)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openra/cli/commands/version.rb

@@ -0,0 +1,13 @@
+module Openra
+  class CLI
+    module Commands
+      class Version < Hanami::CLI::Command
+        desc 'Print current version number'
+
+        def call(*)
+          puts Openra::VERSION
+        end
+      end
+    end
+  end
+end

data/lib/openra/replays.rb

@@ -0,0 +1,13 @@
+require 'bindata'
+require 'big_integer'
+require 'pascal_string'
+require 'openra/yaml'
+require 'openra/replays/order_decorator'
+require 'openra/replays/order'
+require 'openra/replays/order_list'
+require 'openra/replays/packet'
+require 'openra/replays/packet_list'
+require 'openra/replays/metadata_marker'
+require 'openra/replays/metadata'
+require 'openra/replays/file'
+require 'openra/replays/replay'

data/lib/openra/replays/file.rb

@@ -0,0 +1,39 @@
+module Openra
+  module Replays
+    class File
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def packets
+        @packets ||= PacketList.read(fs)
+      end
+
+      def orders
+        @orders ||= packets.orders
+      end
+
+      def metadata
+        metadata_fs = fs
+        offset = -(metadata_marker.data_length + 4)
+        metadata_fs.seek(offset, IO::SEEK_END)
+
+        @metadata ||= Metadata.read(metadata_fs)
+      end
+
+
+      private
+
+      attr_reader :filename
+
+      def fs
+        @fs ||= ::File.open(filename, 'rb')
+        @fs.tap(&:rewind)
+      end
+
+      def metadata_marker
+        @metadata_marker ||= MetadataMarker.read(fs)
+      end
+    end
+  end
+end

data/lib/openra/replays/metadata.rb

@@ -0,0 +1,9 @@
+module Openra
+  module Replays
+    class Metadata < BinData::Record
+      endian :little
+      count_bytes_remaining :total_size
+      string :data, length: -> { total_size - 8 }
+    end
+  end
+end

data/lib/openra/replays/metadata_marker.rb

@@ -0,0 +1,10 @@
+module Openra
+  module Replays
+    class MetadataMarker < BinData::Record
+      endian :little
+      count_bytes_remaining :total_size
+      skip to_abs_offset: -> { total_size - 8 }
+      int32 :data_length
+    end
+  end
+end

data/lib/openra/replays/order.rb

@@ -0,0 +1,67 @@
+module Openra
+  module Replays
+    class Order < BinData::Record
+      HEX_FE = ?\xFE.force_encoding('ASCII-8BIT').freeze
+      HEX_FF = ?\xFF.force_encoding('ASCII-8BIT').freeze
+      # NEED TO LEARN HOW TO READ FLAGS AND TARGET TYPE
+      IS_STANDARD_ORDER = -> { order_type == HEX_FF }
+      IS_IMMEDIATE_ORDER = -> { order_type == HEX_FE }
+      HAS_TARGET = -> { instance_exec(&IS_STANDARD_ORDER) && (flags & 1) == 1 }
+      TARGET_IS_ACTOR = -> { instance_exec(&HAS_TARGET) && target_type == 1 }
+      TARGET_IS_TERRAIN = -> { instance_exec(&HAS_TARGET) && target_type == 2 }
+      TARGET_IS_FROZEN_ACTOR = -> { instance_exec(&HAS_TARGET) && target_type == 3 }
+      TARGET_IS_CELL = -> { instance_exec(&TARGET_IS_TERRAIN) && (flags & 64) == 64 }
+      TARGET_NOT_CELL = -> { instance_exec(&TARGET_IS_TERRAIN) && (flags & 64) != 64 }
+      HAS_TARGET_STRING = -> { instance_exec(&IS_STANDARD_ORDER) && (flags & 4) == 4 }
+      HAS_EXTRA_LOCATION = -> { instance_exec(&IS_STANDARD_ORDER) && (flags & 16) == 16 }
+      HAS_EXTRA_DATA = -> { instance_exec(&IS_STANDARD_ORDER) && (flags & 32) == 32 }
+
+      endian :little
+      # Common
+      string :order_type, read_length: 1
+      pascal_string :command
+      # Immediate Order Data
+      pascal_string :target, onlyif: IS_IMMEDIATE_ORDER
+      # Standard Order Data
+      uint32 :subject_id, onlyif: IS_STANDARD_ORDER
+      uint8 :flags, onlyif: IS_STANDARD_ORDER
+      uint8 :target_type, onlyif: HAS_TARGET
+      uint32 :actor_id, onlyif: TARGET_IS_ACTOR
+      uint32 :player_actor_id, onlyif: TARGET_IS_FROZEN_ACTOR
+      uint32 :frozen_actor_id, onlyif: TARGET_IS_FROZEN_ACTOR
+      int32 :target_x, onlyif: TARGET_IS_CELL
+      int32 :target_y, onlyif: TARGET_IS_CELL
+      string :target_layer, read_length: 1, onlyif: TARGET_IS_CELL
+      int32 :target_sub_cell, onlyif: TARGET_IS_CELL
+      int32 :pos_x, onlyif: TARGET_NOT_CELL
+      int32 :pos_y, onlyif: TARGET_NOT_CELL
+      int32 :pos_z, onlyif: TARGET_NOT_CELL
+      pascal_string :target_string, onlyif: HAS_TARGET_STRING
+      int32 :extra_pos_x, onlyif: HAS_EXTRA_LOCATION
+      int32 :extra_pos_y, onlyif: HAS_EXTRA_LOCATION
+      string :extra_pos_layer, read_length: 1, onlyif: HAS_EXTRA_LOCATION
+      uint32 :extra_data, onlyif: HAS_EXTRA_DATA
+
+      def type
+        case order_type
+        when HEX_FF
+          :standard
+        when HEX_FE
+          :immediate
+        end
+      end
+
+      def standard?
+        type == :standard
+      end
+
+      def immediate?
+        type == :immediate
+      end
+
+      def queued?
+        flags & 8 == 8
+      end
+    end
+  end
+end

data/lib/openra/replays/order_decorator.rb

@@ -0,0 +1,12 @@
+module Openra
+  module Replays
+    class OrderDecorator < SimpleDelegator
+      attr_reader :client_index
+
+      def initialize(order, client_index)
+        @client_index = client_index
+        super(order)
+      end
+    end
+  end
+end

data/lib/openra/replays/order_list.rb

@@ -0,0 +1,9 @@
+module Openra
+  module Replays
+    class OrderList < BinData::Record
+      endian :little
+      skip length: 4
+      array :orders, type: :order, read_until: :eof
+    end
+  end
+end

data/lib/openra/replays/packet.rb

@@ -0,0 +1,28 @@
+module Openra
+  module Replays
+    class Packet < BinData::Record
+      endian :little
+      int32 :client_index
+      int32 :data_length
+      string :data, read_length: :data_length
+
+      def orders
+        return unless valid_order_list?
+
+        @orders ||= OrderList.read(data).orders.map do |order|
+          OrderDecorator.new(order, client_index)
+        end
+      end
+
+      def valid_order_list?
+        return @valid_order_list if defined?(@valid_order_list)
+
+        @valid_order_list = begin
+          !(data.bytesize < 5 ||
+            data.bytesize == 5 && data.bytes.last == 0xBF ||
+            data.bytesize >= 5 && data.bytes[4] == 0x65)
+        end
+      end
+    end
+  end
+end

data/lib/openra/replays/packet_list.rb

@@ -0,0 +1,12 @@
+module Openra
+  module Replays
+    class PacketList < BinData::Record
+      endian :little
+      array :packets, type: :packet, read_until: :eof
+
+      def orders
+        @orders ||= packets.select(&:valid_order_list?).flat_map(&:orders)
+      end
+    end
+  end
+end

data/lib/openra/replays/replay.rb

@@ -0,0 +1,53 @@
+module Openra
+  module Replays
+    class Replay
+      attr_reader :file
+
+      def initialize(filename)
+        @file = Openra::Replays::File.new(filename)
+      end
+
+      def metadata
+        @metadata ||= Openra::YAML.load(file.metadata.data)
+      end
+
+      def orders
+        @orders ||= file.orders
+      end
+
+      def mod
+        @mod ||= metadata['Root']['Mod']
+      end
+
+      def version
+        @version ||= metadata['Root']['Version']
+      end
+
+      def map_id
+        @map_id ||= metadata['Root']['MapUid']
+      end
+
+      def map_title
+        @map_title ||= metadata['Root']['MapTitle']
+      end
+
+      def start_time
+        @start_time ||= DateTime.strptime(
+          metadata['Root']['StartTimeUtc'],
+          '%Y-%m-%d %H-%M-%S'
+        ).to_time
+      end
+
+      def end_time
+        @end_time ||= DateTime.strptime(
+          metadata['Root']['EndTimeUtc'],
+          '%Y-%m-%d %H-%M-%S'
+        ).to_time
+      end
+
+      def duration
+        @duration ||= (end_time - start_time).to_i
+      end
+    end
+  end
+end

data/lib/openra/version.rb

@@ -0,0 +1,3 @@
+module Openra
+  VERSION = '0.0.2'.freeze
+end

data/lib/openra/yaml.rb

@@ -0,0 +1,39 @@
+module Openra
+  class YAML
+    MATCHER = /(?<indentation>\t+)?(?<key>[^\:]+)?\:?\s?(?<value>.+)?/.freeze
+
+    def self.load(yaml_string)
+      last_indentation = -1
+      last_key = nil
+      data = {}
+      structs = []
+
+      yaml_string.split("\n").inject(data) do |struct, line|
+        next if line =~ /^\s+$/
+
+        matchdata = line.match(MATCHER)
+        indentation = matchdata[:indentation].to_s.bytesize
+        key = matchdata[:key]
+        value = matchdata[:value]
+
+        if indentation > last_indentation
+          struct[last_key] = {}
+          structs.push(struct[last_key])
+          struct = struct[last_key]
+        elsif indentation < last_indentation
+          diff = last_indentation - indentation
+          structs = structs.slice(0..-diff.next)
+          struct = structs.last
+        end
+
+        struct[key] = value unless key.nil? || value.nil?
+
+        last_key = key
+        last_indentation = indentation
+        struct
+      end
+
+      data[nil]
+    end
+  end
+end

data/lib/pascal_string.rb

@@ -0,0 +1,12 @@
+class PascalString < BinData::Primitive
+  big_integer :len, value: -> { data.length }
+  string :data, read_length: :len
+
+  def get
+    self.data
+  end
+
+  def set(v)
+    self.data = v
+  end
+end

data/openra.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+require File.expand_path('../lib/openra/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'openra'
+  spec.version       = Openra::VERSION
+  spec.authors       = ['Andy Holland']
+  spec.email         = ['andyholland1991@aol.com']
+  spec.summary       = 'Openra Rubygem'
+  spec.homepage      = 'https://github.com/AMHOL/openra-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0") - ['bin/console']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bindata', '2.4.3'
+  spec.add_dependency 'hanami-cli', '0.2.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: openra
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andy Holland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+- !ruby/object:Gem::Dependency
+  name: hanami-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- andyholland1991@aol.com
+executables:
+- openra
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/openra
+- lib/big_integer.rb
+- lib/openra-cli.rb
+- lib/openra.rb
+- lib/openra/cli.rb
+- lib/openra/cli/command_registry.rb
+- lib/openra/cli/commands/replay_data.rb
+- lib/openra/cli/commands/version.rb
+- lib/openra/replays.rb
+- lib/openra/replays/file.rb
+- lib/openra/replays/metadata.rb
+- lib/openra/replays/metadata_marker.rb
+- lib/openra/replays/order.rb
+- lib/openra/replays/order_decorator.rb
+- lib/openra/replays/order_list.rb
+- lib/openra/replays/packet.rb
+- lib/openra/replays/packet_list.rb
+- lib/openra/replays/replay.rb
+- lib/openra/version.rb
+- lib/openra/yaml.rb
+- lib/pascal_string.rb
+- openra.gemspec
+homepage: https://github.com/AMHOL/openra-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Openra Rubygem
+test_files: []