openrareplay 0.1.1

data/README.md

@@ -0,0 +1,49 @@
+# OpenRA Replay
+>    Copyright (C) 2018  Luke Spangler
+>
+>    This program is free software: you can redistribute it and/or modify
+>    it under the terms of the GNU Affero General Public License as
+>    published by the Free Software Foundation, either version 3 of the
+>    License, or (at your option) any later version.
+>
+>    This program is distributed in the hope that it will be useful,
+>    but WITHOUT ANY WARRANTY; without even the implied warranty of
+>    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+>    GNU Affero General Public License for more details.
+
+## Description
+A library and executable that can parse OpenRA replay files and produce "sanitized" versions, without pings, exact timestamps, or other unnecessary information. The long term goal is to produce a full gem project packaging both a library and an executable for reading and writing  to OpenRA replay files. However, the library will never support parsing non-YAML data beyond preserving it as a chunk. Examples of non-YAML data includes unit and building orders.
+
+## Requirements:
+A relatively recent version of Ruby.
+
+## Installation:
+```
+gem install openrareplay
+
+```
+
+## Usage:
+```
+Usage: openra-sanitize [options] in_file out_file
+Reads an OpenRA replay file, trims/masks it, and outputs the result as a new file
+
+Specific options:
+    -p, --ping                       Trim all ping-related content
+    -m, --message                    Trim all server messages
+    -c, --chat                       Trim all chat messages
+    -i, --ip                         Trim all IP addresses
+    -t, --time                       Mask all dates and times
+    -P, --password                   Trims the server password
+    -n, --player-name                Masks all player names
+    -s, --server-name                Trim the server name
+    -f, --force                      Force overwriting out_file
+
+Common options:
+    -h, --help                       Show this message
+        --version                    Show version
+```
+Keep in mind that some options might not make sense without another. For instance, without removing server messages, player names would still be revealed in those messages.
+
+![Logo of the Affero General Public License](https://www.gnu.org/graphics/agplv3-155x51.png)
+

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/exe/openra-sanitize

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require 'openrareplay/sanitize/cli'
+
+OpenRAReplay::Sanitize::CLI.new(ARGV).sanitize

data/lib/openrareplay.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require_relative 'openrareplay/version'
+require_relative 'openrareplay/miniyaml'
+require_relative 'openrareplay/binary'
+require_relative 'openrareplay/order'
+require_relative 'openrareplay/packet'
+require_relative 'openrareplay/sanitize'

data/lib/openrareplay/binary.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+module OpenRAReplay
+  module Binary
+    def encode_uleb128(val)
+      bytes = ''.force_encoding('ASCII-8BIT')
+      loop do
+        byte = val & 0x7F
+        val >>= 7
+        byte |= 0x80 unless val.zero?
+        bytes += byte.chr
+        break if val.zero?
+      end
+      bytes
+    end
+
+    def decode_uleb128_io(input, hash = {})
+      val = 0
+      shift = 0
+      read_bytes = ''.force_encoding('ASCII-8BIT')
+      loop do
+        byte = input.read 1
+        read_bytes += byte if hash[:output_read]
+        byte = byte.ord
+        val |= (byte & 0x7F) << shift
+        break if (byte >> 7).zero?
+        shift += 7
+      end
+      return [val, read_bytes] if hash[:output_read]
+      val
+    end
+
+    def encode_u32(integer)
+      [integer].pack('_L')
+    end
+
+    def decode_u32(string)
+      string.unpack('_L').first
+    end
+
+    def decode_u8(string)
+      string.unpack('C').first
+    end
+  end
+end

data/lib/openrareplay/miniyaml.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require 'psych'
+require 'time'
+
+module OpenRAReplay
+  module MiniYaml
+    def self.load(str)
+      thing = str.gsub("\t", '  ')
+      searches = []
+      thing.scan(/MapTitle: (.+?)\n/m).each do |match|
+        match = match.first
+        searches.append [
+          "MapTitle: #{match}\n",
+          "MapTitle: '#{match.gsub("'", "''")}'\n"
+        ]
+      end
+      thing.scan(/Name: (.+?)\n/m).each do |match|
+        match = match.first
+        searches.append ["Name: #{match}\n", "Name: '#{match.gsub("'", "''")}'\n"]
+      end
+      searches.each do |pair|
+        thing.gsub!(pair.first, pair.last)
+      end
+      (Psych.safe_load thing)
+    end
+
+    def self.dump(object)
+      thing = (Psych.dump object, indentation: 1)
+              .force_encoding('ASCII-8BIT').gsub(/^---\n/m, '')
+              .gsub('  ', "\t").gsub(': false', ': False')
+              .gsub(': true', ': True').gsub(": \n", ":\n")
+      searches = []
+      thing.scan(/: '(.+?)'\n/m).each do |match|
+        match = match.first
+        searches.append [
+          ": '#{match}'\n",
+          ": #{match.gsub("''", "'")}\n"
+        ]
+      end
+      thing.scan(/: "(.+?)"\n/m).each do |match|
+        match = match.first
+        searches.append [
+          ": \"#{match}\"\n",
+          ": #{match.gsub('\"', '"').gsub('\\\\', '\\')}\n"
+        ]
+      end
+      searches.each do |pair|
+        thing.gsub!(pair.first, pair.last)
+      end
+      thing
+    end
+
+    def self.load_time(str)
+      Time.strptime(str + ' UTC', '%Y-%m-%d %H-%M-%S %Z')
+    end
+
+    def self.dump_time(time)
+      time.utc.strftime('%Y-%m-%d %H-%M-%S')
+    end
+  end
+end

data/lib/openrareplay/order.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require_relative 'order/order'
+require_relative 'order/server'
+require_relative 'order/client'
+require_relative 'order/notanorder'

data/lib/openrareplay/order/client.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require_relative 'order'
+
+module OpenRAReplay
+  class ClientOrder < Order
+    def self.construct(input)
+      command_length = decode_uleb128_io input
+      command = input.read(command_length)
+
+      # Credit to AMHOL for figuring out the structure
+      # of these orders
+      data = input.read(5) # subject id + flag
+      flags = decode_u8(data[-1])
+      if (flags & 1) == 1 # if the order has a target
+        data += input.read(1)
+        target_type = decode_u8(data[-1])
+        case target_type
+        when 1 # target is an actor
+          data += input.read(4) # actor_id
+        when 2 # target is the terrain
+          data += if (flags & 64) == 64 # target is a cell
+                    input.read(13) # target x, y, layer,
+                  # and subcell
+                  else # target is not a cell
+                    input.read(12) # pos x, y, and z
+                  end
+        when 3 # target is a frozen actor
+          data += input.read(8) # player actor id + frozen actor id
+        end
+      end
+      if (flags & 4) == 4 # has target string
+        strlen, out = decode_uleb128_io input, output_read: true
+        data += out + input.read(strlen)
+      end
+      if (flags & 16) == 16 # has extra location data
+        data += input.read(9) # extra x, y, and layer
+      end
+      if (flags & 32) == 32 # has extra data
+        data += input.read(4) # has extra data
+      end
+      new(command: command, data: data)
+    end
+
+    def serialize
+      (Order::CLIENT_COMMAND + encode_uleb128(command.length) +
+       command + data)
+    end
+
+    def client_order?
+      true
+    end
+  end
+end

data/lib/openrareplay/order/notanorder.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require_relative 'order'
+
+module OpenRAReplay
+  class NotAnOrder < Order
+    attr_reader :special_command
+
+    def initialize(*args)
+      @unknown = !!args.last[:special_command]
+      super(*args)
+    end
+
+    def self.construct(input, char, special_command)
+      new(
+        command: char,
+        data: input.read,
+        special_command: special_command
+      )
+    end
+
+    def serialize
+      (command + data)
+    end
+
+    def special_command?
+      special_command
+    end
+
+    def order?
+      false
+    end
+  end
+end

data/lib/openrareplay/order/order.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require_relative '../binary'
+
+module OpenRAReplay
+  class Order
+    extend Binary
+    include Binary
+
+    attr_reader :command, :data
+
+    SERVER_COMMAND = 254.chr.freeze
+    CLIENT_COMMAND = 255.chr.freeze
+    SPECIAL_COMMAND = 191.chr.freeze
+
+    def initialize(hash = {})
+      @command = hash[:command] || ''
+      @data = hash[:data] || ''
+    end
+
+    def self.construct(input)
+      char = input.read(1)
+      case char
+      when SERVER_COMMAND
+        return ServerOrder.construct(input)
+      when CLIENT_COMMAND
+        return ClientOrder.construct(input)
+      else
+        return NotAnOrder.construct(input, char, char == SPECIAL_COMMAND)
+      end
+    end
+
+    def serialize
+      ''
+    end
+
+    def to_s
+      "<#{self.class.name} command: #{command} data: #{data}>"
+    end
+
+    def server_order?
+      false
+    end
+
+    def client_order?
+      false
+    end
+
+    def unknown?
+      false
+    end
+
+    def special_command?
+      false
+    end
+
+    def order?
+      true
+    end
+
+    alias is_fe? server_order?
+    alias is_ff? client_order?
+  end
+end
+
+require_relative 'client'
+require_relative 'server'
+require_relative 'notanorder'