openrareplay 0.1.1

data/lib/openrareplay/order/server.rb

@@ -0,0 +1,44 @@
+#!/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 ServerOrder < Order
+    def self.construct(input)
+      # Credit to Stekke for putting me on the right
+      # direction for these orders
+      command_length = decode_uleb128_io input
+      command = input.read(command_length)
+      data_length = decode_uleb128_io input
+      data = input.read(data_length)
+      new(command: command, data: data)
+    end
+
+    def server_order?
+      true
+    end
+
+    def serialize
+      (Order::SERVER_COMMAND + encode_uleb128(command.length) +
+       command + encode_uleb128(data.length) + data)
+    end
+  end
+end

data/lib/openrareplay/packet.rb

@@ -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_relative 'packet/packet'
+require_relative 'packet/metadata_packet'
+require_relative 'packet/packet_parser'

data/lib/openrareplay/packet/metadata_packet.rb

@@ -0,0 +1,67 @@
+#!/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 'packet'
+
+module OpenRAReplay
+  class MetadataPacket < Packet
+    METADATA_HEADER = "\xFF\xFF\xFF\xFF".force_encoding('ASCII-8BIT').freeze
+    METADATA_VERSION = "\x01\x00\x00\x00".force_encoding('ASCII-8BIT').freeze
+    METADATA_FOOTER = "\xFE\xFF\xFF\xFF".force_encoding('ASCII-8BIT').freeze
+
+    def unknown?
+      false
+    end
+
+    def metadata?
+      true
+    end
+
+    private
+
+    def parse_byte_array
+      header = byte_array[0..3]
+      raise "Metadata header is not a header: #{header.inspect}" unless header == METADATA_HEADER
+      version = byte_array[4..7]
+      raise "Metadata version doesn't match current version: #{version.inspect}" unless version == METADATA_VERSION
+      @length = decode_u32 byte_array[8..11]
+      @client_id = -1
+      @frame = -1
+      @data = byte_array[12..(11 + length)]
+      length2 = decode_u32 byte_array[(12 + length)..(15 + length)]
+      raise "Appended length isn't correct: #{length2} vs expected #{length + 4}" unless length2 == (length + 4)
+      footer = byte_array[(16 + length)..(19 + length)]
+      raise "Metadata footer is not a footer: #{footer.inspect}" unless footer == METADATA_FOOTER
+      @orders = []
+    end
+
+    def construct_byte_array(type)
+      raise "#{self.class.name} only supports :data construction!" unless type == :data
+      @orders = []
+      @client_id = -1
+      @frame = -1
+      @length = data.length
+      @byte_array = METADATA_HEADER + METADATA_VERSION +
+                    (encode_u32 length) +
+                    data.force_encoding('ASCII-8BIT') +
+                    encode_u32(length + 4) + METADATA_FOOTER
+    end
+  end
+end

data/lib/openrareplay/packet/packet.rb

@@ -0,0 +1,102 @@
+#!/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'
+require_relative '../order/order'
+
+module OpenRAReplay
+  class Packet
+    include Binary
+
+    attr_reader :client_id, :length, :frame,
+                :data, :orders,
+                :byte_array
+
+    SERVER_LOBBY_PACKET = 0
+
+    def initialize(options = {})
+      if options[:byte_array]
+        @byte_array = options[:byte_array]
+        parse_byte_array
+      elsif options[:orders]
+        @client_id = options[:client_id]
+        @frame = options[:frame]
+        @orders = options[:orders]
+        construct_byte_array :orders
+      elsif options[:data]
+        @client_id = options[:client_id]
+        @frame = options[:frame]
+        @data = options[:data]
+        construct_byte_array :data
+      else
+        raise "Improper options given to initialize! #{options}"
+      end
+    end
+
+    def server_lobby_packet?
+      (frame == SERVER_LOBBY_PACKET)
+    end
+
+    alias to_s byte_array
+
+    def inspect
+      byte_array.inspect
+    end
+
+    def unknown?
+      if orders.length == 1
+        order = orders.first
+        return false unless order.order? || order.special_command?
+      end
+      false
+    end
+
+    def metadata?
+      false
+    end
+
+    private
+
+    def parse_byte_array
+      @client_id = decode_u32 byte_array[0..3]
+      @length = decode_u32 byte_array[4..7]
+      @frame = decode_u32 byte_array[8..11]
+      @data = byte_array[12..-1]
+      @orders = []
+      d = StringIO.new(data)
+      @orders.append Order.construct(d) until d.eof?
+    end
+
+    def construct_byte_array(type)
+      case type
+      when :data
+        @length = data.length + 4
+        @byte_array = (encode_u32 client_id) + (encode_u32 length) +
+                      (encode_u32 frame) + data
+      when :orders
+        @data = ''.force_encoding('ASCII-8BIT')
+        orders.each do |order|
+          @data += order.serialize
+        end
+        construct_byte_array :data
+      end
+    end
+  end
+end

data/lib/openrareplay/packet/packet_parser.rb

@@ -0,0 +1,47 @@
+#!/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 'packet'
+require_relative 'metadata_packet'
+
+module OpenRAReplay
+  class PacketParser
+    def initialize(file_stream)
+      @file_stream = file_stream
+    end
+
+    def read_packet
+      byte_array = @file_stream.read 12
+      if byte_array[0..3] == "\xFF\xFF\xFF\xFF".force_encoding('ASCII-8BIT')
+        length = byte_array[8..11].unpack('_L').first + 8
+        byte_array += @file_stream.read length
+        yield OpenRAReplay::MetadataPacket.new(byte_array: byte_array)
+      else
+        length = byte_array[4..7].unpack('_L').first - 4
+        byte_array += @file_stream.read length
+        yield OpenRAReplay::Packet.new(byte_array: byte_array)
+      end
+    end
+
+    def eof?
+      @file_stream.closed? || @file_stream.eof?
+    end
+  end
+end

data/lib/openrareplay/sanitize.rb

@@ -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_relative 'sanitize/packet_sanitizer'
+require_relative 'sanitize/replay_sanitizer'
+require_relative 'sanitize/cli'

data/lib/openrareplay/sanitize/cli.rb

@@ -0,0 +1,160 @@
+#!/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 'replay_sanitizer'
+require_relative '../version'
+require 'optparse'
+
+module OpenRAReplay
+  module Sanitize
+    class CLI
+      attr_accessor :ping, :message, :chat, :ip, :time, :password,
+                    :player_name, :server_name, :in_name, :out_name, :force
+
+      WARN_COUNT = 'Please provide an input and an output file!'.freeze
+      WARN_INPUT = 'Input file must exist!'.freeze
+      WARN_EXIST = "Output file exists! Pass the '--force' argument" \
+                   ' to overwrite it.'.freeze
+
+      def initialize(arguments)
+        OptionParser.new do |parser|
+          header parser
+          option_ping parser
+          option_message parser
+          option_chat parser
+          option_ip parser
+          option_time parser
+          option_password parser
+          option_player_name parser
+          option_server_name parser
+          option_force parser
+          footer parser
+        end.parse! arguments
+        handle_input arguments
+      end
+
+      def sanitize
+        OpenRAReplay::Sanitize::ReplaySanitizer.new(in_name, out_name,
+                                                    ping: ping,
+                                                    message: message,
+                                                    chat: chat,
+                                                    ip: ip,
+                                                    time: time,
+                                                    password: password,
+                                                    player_name: player_name,
+                                                    server_name: server_name).sanitize
+      end
+
+      private
+
+      def header(parser)
+        parser.banner = "Usage: openra-sanitize [options] in_file out_file\n" \
+                        'Reads an OpenRA replay file, trims/masks it, and outputs' \
+                         ' the result as a new file' \
+
+        parser.separator ''
+        parser.separator 'Specific options:'
+      end
+
+      def footer(parser)
+        parser.separator ''
+        parser.separator 'Common options:'
+
+        parser.on_tail('-h', '--help', 'Show this message') do
+          puts parser
+          Kernel.exit
+        end
+
+        parser.on_tail('--version', 'Show version') do
+          puts "OpenRAReplay-Sanitize: #{OpenRAReplay::VERSION}"
+          Kernel.exit
+        end
+      end
+
+      def option_ping(parser)
+        parser.on('-p', '--ping', TrueClass, 'Trim all ping-related content') do |p|
+          self.ping = p
+        end
+      end
+
+      def option_message(parser)
+        parser.on('-m', '--message', TrueClass, 'Trim all server messages') do |m|
+          self.message = m
+        end
+      end
+
+      def option_chat(parser)
+        parser.on('-c', '--chat', TrueClass, 'Trim all chat messages') do |c|
+          self.chat = c
+        end
+      end
+
+      def option_ip(parser)
+        parser.on('-i', '--ip', TrueClass, 'Trim all IP addresses') do |i|
+          self.ip = i
+        end
+      end
+
+      def option_time(parser)
+        parser.on('-t', '--time', TrueClass, 'Mask all dates and times') do |i|
+          self.ip = i
+        end
+      end
+
+      def option_password(parser)
+        parser.on('-P', '--password', TrueClass, 'Trims the server password') do |p|
+          self.password = p
+        end
+      end
+
+      def option_player_name(parser)
+        parser.on('-n', '--player-name', TrueClass, 'Masks all player names') do |n|
+          self.player_name = n
+        end
+      end
+
+      def option_server_name(parser)
+        parser.on('-s', '--server-name', TrueClass, 'Trim the server name') do |s|
+          self.server_name = s
+        end
+      end
+
+      def option_force(parser)
+        parser.on('-f', '--force', TrueClass, 'Force overwriting out_file') do |f|
+          self.force = f
+        end
+      end
+
+      def handle_input(arguments)
+        warn_and_exit WARN_COUNT unless arguments.length == 2
+        warn_and_exit WARN_INPUT unless File.exist? arguments.first
+        warn_and_exit WARN_EXIST unless force || !File.exist?(arguments.last)
+        self.in_name = arguments.first
+        self.out_name = arguments.last
+      end
+
+      def warn_and_exit(text)
+        warn text
+        warn "Try 'openra-sanitize --help' for more information."
+        Kernel.exit 1
+      end
+    end
+  end
+end