rbstarbound 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d05f85c2aa5f0cfb19c28e8d45f9c378da343273
-  data.tar.gz: 2be0f43338decdda10062f93a5f0018e4db6f33e
+  metadata.gz: 598e73b703c140b4ae530217f71e8e18fb6d6b7f
+  data.tar.gz: 77208c31fee555eacacff7b493d80fc02fda2f61
 SHA512:
-  metadata.gz: 9cc42be3a1e207957bac7e4252572e0b1a764f10c40959b1e0a6275291e3123ed0b3ca6b225fb54f629a6ffd43cb3e0fa4513f08320a053d0d5e85d05550e1dc
-  data.tar.gz: 181f76077841725a6f27e916b7b7c8f4892bd4b7dfab3ae6cf2080ce54052930cd6294d20e97007d45e3cec60a51ce9fe20ae5e0e0c7b51b6ed2a9d69335a0a6
+  metadata.gz: 3732239fd5c8ed9be66cec4f717acbe0dd29d8cc3949c28ee475730beeb58620a2cbf0c84c6b3686ad28822951261e5b2cc6f90c1cbfa655a129ecb137514f51
+  data.tar.gz: e8d67c1fbc7d7d03370952cbcf469cb8fb0060ecf39adde40280bd78b232800cf557157cc832eda915dac957fbe5c6b6c2f7996dd71a97d42e6ed961d21544aa

data/lib/rbstarbound.rb

@@ -5,6 +5,7 @@ require 'rbstarbound/exceptions'
 require 'rbstarbound/utils'
 require 'rbstarbound/sbvj01'
 require 'rbstarbound/sbon'
+require 'rbstarbound/sbasset6'
 require 'rbstarbound/exit_codes'
 require 'rbstarbound/main_command'
 

data/lib/rbstarbound/commands/export.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module RBStarbound
+  class ExportCommand < Clamp::Command
+    option ['-d', '--dir'], 'DIR', 'directory to extract the files to',
+           required: true
+    option ['-p', '--package'], 'PAK', 'the package file to extract from',
+           required: true
+    option ['-v', '--verbose'], :flag, 'be verbose', default: false
+
+    def execute
+      start = Time.now.to_i
+      extracted = 0
+      begin
+        File.open(package.to_s, 'rb') do |file|
+          RBStarbound::SBAsset6.verbose = true if verbose?
+          RBStarbound::SBAsset6.package(file)
+          if verbose?
+            puts "Extracting #{RBStarbound::SBAsset6.file_count} files..."
+          end
+          percentage = [RBStarbound::SBAsset6.file_count / 100, 1].max
+          RBStarbound::SBAsset6.index.each_key do |path|
+            dest_path = dir + path
+            dest_dir, = File.split(dest_path)
+            FileUtils.mkdir_p(dest_dir) unless Dir.exist?(dest_dir)
+            data = RBStarbound::SBAsset6.get(path)
+            File.open(dest_path, 'wb') { |f| f.write(data) }
+            extracted += 1
+            next unless verbose?
+            putc '.' if (extracted % percentage).zero?
+          end
+        end
+        return RBStarbound::EX_OK unless verbose?
+        puts
+        puts "Extracted #{extracted} files in #{Time.now.to_i - start} seconds."
+        return RBStarbound::EX_OK
+      rescue StandardError => e
+        RBStarbound.print_error(e)
+        return RBStarbound::EX_ERR
+      end
+    end
+  end
+end

data/lib/rbstarbound/exceptions.rb

@@ -2,4 +2,5 @@ module RBStarbound
   class NotImplementedError < StandardError; end
   class SBVJ01Error < StandardError; end
   class ValueError < StandardError; end
+  class SBAsset6Error < StandardError; end
 end

data/lib/rbstarbound/main_command.rb

@@ -4,6 +4,7 @@ require 'clamp'
 require 'rbstarbound/exit_codes'
 require 'rbstarbound/commands/dump'
 require 'rbstarbound/commands/serialize'
+require 'rbstarbound/commands/export'
 
 module RBStarbound
   class MainCommand < Clamp::Command
@@ -18,5 +19,8 @@ module RBStarbound
     subcommand 'serialize',
                'serialize a player save file form a formatted file',
                RBStarbound::SerializeCommand
+    subcommand 'export',
+               'extract all the files from a .pak file',
+               RBStarbound::ExportCommand
   end
 end

data/lib/rbstarbound/sbasset6.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RBStarbound
+  module SBAsset6
+    @verbose = false
+
+    def self.package(io)
+      @package = io
+      raise SBAsset6Error, 'No package file given' if @package.nil?
+      read_header
+      read_index
+    end
+
+    def self.get(path)
+      raise SBAsset6Error, 'No package file given' if @package.nil?
+      offset, length = @index[path]
+      rewind_to(offset)
+      @package.read(length)
+    end
+
+    def self.read_header
+      rewind_to(0)
+      header, @metadata_offset = @package.read(16).unpack('A8Q>')
+      raise SBAsset6Error, 'Invalid header' unless header == 'SBAsset6'
+      read_metadata
+    end
+
+    def self.read_index
+      puts 'Loading index...' if @verbose
+      rewind_to(@index_offset)
+      @index = {}
+      @file_count.times do
+        path = RBStarbound::SBON.read_string(@package)
+        offset, length = @package.read(16).unpack('Q>Q>')
+        @index[path] = [offset, length]
+      end
+      puts 'Index loaded.' if @verbose
+    end
+
+    def self.read_metadata
+      rewind_to(@metadata_offset)
+      raise SBAsset6Error, 'Invalid index data' unless meta_header == 'INDEX'
+      @metadata = RBStarbound::SBON.read_map(@package)
+      @file_count = RBStarbound::SBON.read_varint(@package)
+      @index_offset = @package.pos
+    end
+
+    def self.rewind_to(pos)
+      @package.seek(pos, IO::SEEK_SET)
+    end
+
+    def self.meta_header
+      @package.read(5)
+    end
+
+    class << self
+      attr_accessor :verbose
+      attr_reader :metadata, :file_count, :metadata_offset, :index_offset,
+                  :index
+      private :rewind_to, :read_header, :read_index, :read_metadata
+    end
+  end
+end

data/lib/rbstarbound/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBStarbound
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/test/sbasset6_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class SBAsset6Test < Minitest::Test
+  def test_it_requires_package_file
+    assert_raises RBStarbound::SBAsset6Error do
+      ::RBStarbound::SBAsset6.package(nil)
+      ::RBStarbound::SBAsset6.get('path')
+    end
+  end
+
+  def test_it_raises_header_error
+    file = Tempfile.new('sbasset6_header_test_temp')
+    begin
+      file.write('NotAHeader')
+      error = assert_raises RBStarbound::SBAsset6Error do
+        ::RBStarbound::SBAsset6.package(file)
+      end
+      assert_match(/Invalid header/, error.message)
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbstarbound
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Oleh Fedorenko
@@ -79,11 +79,13 @@ files:
 - bin/rbstarbound
 - lib/rbstarbound.rb
 - lib/rbstarbound/commands/dump.rb
+- lib/rbstarbound/commands/export.rb
 - lib/rbstarbound/commands/serialize.rb
 - lib/rbstarbound/exceptions.rb
 - lib/rbstarbound/exit_codes.rb
 - lib/rbstarbound/main_command.rb
 - lib/rbstarbound/player.rb
+- lib/rbstarbound/sbasset6.rb
 - lib/rbstarbound/sbon.rb
 - lib/rbstarbound/sbvj01.rb
 - lib/rbstarbound/utils.rb
@@ -94,6 +96,7 @@ files:
 - test/data/1.3.3/test.yaml
 - test/player_test.rb
 - test/rbstarbound_test.rb
+- test/sbasset6_test.rb
 - test/sbvj01_test.rb
 - test/test_helper.rb
 homepage: https://github.com/JetPirate/rb-starbound
@@ -128,4 +131,5 @@ test_files:
 - test/rbstarbound_test.rb
 - test/commands/dump_test.rb
 - test/commands/serialize_test.rb
+- test/sbasset6_test.rb
 - test/test_helper.rb