excavate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9ac901b1d15ed4e916d2e76c0b902070918d518169f177fdf338df564a002e4
+  data.tar.gz: f3d5f8d33256c59bd63d3d517e66ab46eda8cf1e02f3d26a732add451e8d92a7
+SHA512:
+  metadata.gz: 2e9dcda07eec36ef7c4dbcced2927e26ad2b4daff57f3544a79aeac7c5a4da4fb44fd3d16e5868ae17387614ea549838aa61565fd283d19036e6aa0e02f8e54a
+  data.tar.gz: 9fd35d2d181083bf78a5c4250fb9ee22ff925f8b9d5964243f2d1f810f90dc04183973c9ff0d1c7c778879512e70749a5757ac4b9d81029e2b5a56331ba35c12

data/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - run: bundle exec rspec
+
+      - name: Publish to rubygems.org
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.FONTIST_CI_RUBYGEMS_API_KEY}}
+        run: |
+          gem install gem-release
+          touch ~/.gem/credentials
+          cat > ~/.gem/credentials << EOF
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          git status
+          gem release

data/.github/workflows/rspec.yml

@@ -0,0 +1,47 @@
+name: rspec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  build:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '3.0'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '3.0'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '3.0'
+            os: 'macos-latest'
+            experimental: true
+
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.rubocop-*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - 'https://raw.githubusercontent.com/fontist/oss-guides/master/ci/rubocop.yml'

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "gem-release"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.2"
+gem "rubocop", "0.75.0"
+gem "rubocop-performance"
+gem "rubocop-rails"

data/LICENSE.adoc

@@ -0,0 +1,13 @@
+= BSD 3-Clause License
+
+Copyright (c) 2020 Ribose Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,102 @@
+= Excavate: Ruby gem to extract nested archives
+
+Extract nested archives with a single command.
+
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem "excavate"
+----
+
+And then execute:
+
+[source,sh]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,sh]
+----
+$ gem install excavate
+----
+
+
+== Usage
+
+To extract an archive containing other archives inside:
+
+[source,ruby]
+----
+archive = "path/to/archive.cab"
+target = Dir.mktmpdir
+Excavate::Archive.new(archive).extract(target, recursive_packages: true)
+----
+
+The same but allowing to choose only necessary files inside:
+
+[source,ruby]
+----
+Excavate::Archive.new("path/to/archive.cab").files(recursive_packages: true) do |path|
+  FileUtils.mv(path, Dir.mktmpdir) if path.end_with?(".txt")
+end
+----
+
+
+== Development
+
+We are following Sandi Metz's Rules for this gem, you can read the
+http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers[description of the rules here].
+All new code should follow these
+rules. If you make changes in a pre-existing file that violates these rules you
+should fix the violations as part of your contribution.
+
+
+== Releasing
+
+Releasing is done automatically with GitHub Action. Just bump and tag with `gem-release`.
+
+For a patch release (0.0.x) use:
+
+[source,ruby]
+----
+gem bump --version patch --tag --push
+----
+
+For a minor release (0.x.0) use:
+
+[source,ruby]
+----
+gem bump --version minor --tag --push
+----
+
+
+== Contributing
+
+First, thank you for contributing! We love pull requests from everyone. By
+participating in this project, you hereby grant https://www.ribose.com[Ribose Inc.] the
+right to grant or transfer an unlimited number of non exclusive licenses or
+sub-licenses to third parties, under the copyright covering the contribution
+to use the contribution by all means.
+
+Here are a few technical guidelines to follow:
+
+1. Open an https://github.com/fontist/excavate/issues[issue] to discuss a new feature.
+1. Write tests to support your new feature.
+1. Make sure the entire test suite passes locally and on CI.
+1. Open a Pull Request.
+1. https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature[Squash your commits]
+  after receiving feedback.
+1. Party!
+
+
+== License
+
+This gem is distributed with a BSD 3-Clause license.
+
+This gem is developed, maintained and funded by https://www.ribose.com/[Ribose Inc.]

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/excavate.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/excavate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "excavate"
+  spec.version       = Excavate::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Extract nested archives with a single command."
+  spec.description   = "Extract nested archives with a single command."
+  spec.homepage      = "https://github.com/fontist/excavate"
+  spec.license       = "BSD-3-Clause"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fontist/excavate"
+  spec.metadata["changelog_uri"] = "https://github.com/fontist/excavate"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|bin)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "arr-pm", "~> 0.0"
+  spec.add_runtime_dependency "libmspack", "~> 0.1"
+  spec.add_runtime_dependency "ruby-ole", "~> 1.0"
+  spec.add_runtime_dependency "rubyzip", "~> 2.3"
+  spec.add_runtime_dependency "seven_zip_ruby", "~> 1.0"
+end

data/lib/excavate.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "excavate/version"
+require_relative "excavate/extractors"
+require_relative "excavate/archive"
+require_relative "excavate/file_magic"
+require_relative "excavate/utils"
+
+module Excavate
+  class Error < StandardError; end
+  class UnknownArchiveError < Error; end
+end

data/lib/excavate/archive.rb

@@ -0,0 +1,96 @@
+module Excavate
+  class Archive
+    TYPES = { "cab" => Extractors::CabExtractor,
+              "cpio" => Extractors::CpioExtractor,
+              "exe" => Extractors::SevenZipExtractor,
+              "gz" => Extractors::GzipExtractor,
+              "msi" => Extractors::OleExtractor,
+              "rpm" => Extractors::RpmExtractor,
+              "tar" => Extractors::TarExtractor,
+              "zip" => Extractors::ZipExtractor }.freeze
+
+    def initialize(archive)
+      @archive = archive
+    end
+
+    def files(recursive_packages: false)
+      target = Dir.mktmpdir
+      extract(target, recursive_packages: recursive_packages)
+
+      all_files_in(target).map do |file|
+        yield file
+      end
+    ensure
+      FileUtils.rm_rf(target)
+    end
+
+    def extract(target, recursive_packages: false)
+      if recursive_packages
+        extract_recursively(@archive, target)
+      else
+        extract_once(@archive, target)
+      end
+    end
+
+    private
+
+    def extract_recursively(archive, target)
+      extract_once(archive, target)
+
+      all_files_in(target).each do |file|
+        next unless archive?(file)
+
+        extract_and_replace(file)
+      end
+    end
+
+    def extract_once(archive, target)
+      extension = normalized_extension(archive)
+      extractor_class = TYPES[extension]
+      raise(UnknownArchiveError, "Could not unarchive `#{archive}`.") unless extractor_class
+
+      extractor_class.new(archive).extract(target)
+    rescue StandardError => e
+      raise unless extension == "exe" && e.message.start_with?("Invalid file format")
+
+      Extractors::CabExtractor.new(archive).extract(target)
+    end
+
+    def extract_and_replace(archive)
+      target = Dir.mktmpdir
+      extract_recursively(archive, target)
+
+      FileUtils.rm(archive)
+      FileUtils.mv(target, archive)
+    rescue FFI::NullPointerError => e
+      FileUtils.rmdir(target)
+      raise unless normalized_extension(archive) == "exe" &&
+        e.message.start_with?("invalid memory read at address=0x0000000000000000")
+    end
+
+    def normalized_extension(file)
+      fetch_extension(file).downcase
+    end
+
+    def fetch_extension(file)
+      File.extname(filename(file)).sub(/^\./, "")
+    end
+
+    def filename(file)
+      if file.respond_to?(:original_filename)
+        file.original_filename
+      else
+        File.basename(file)
+      end
+    end
+
+    def all_files_in(dir)
+      Dir.glob(File.join(dir, "**", "*"))
+    end
+
+    def archive?(file)
+      ext = normalized_extension(file)
+      TYPES.key?(ext)
+    end
+  end
+end

data/lib/excavate/extractors.rb

@@ -0,0 +1,9 @@
+require_relative "extractors/extractor"
+require_relative "extractors/cab_extractor"
+require_relative "extractors/cpio_extractor"
+require_relative "extractors/gzip_extractor"
+require_relative "extractors/ole_extractor"
+require_relative "extractors/rpm_extractor"
+require_relative "extractors/seven_zip_extractor"
+require_relative "extractors/tar_extractor"
+require_relative "extractors/zip_extractor"

data/lib/excavate/extractors/cab_extractor.rb

@@ -0,0 +1,33 @@
+require "libmspack"
+
+module Excavate
+  module Extractors
+    class CabExtractor < Extractor
+      def extract(target)
+        open_cab(@archive) do |decompressor, cab|
+          file = cab.files
+
+          while file
+            path = File.join(target, file.filename)
+            decompressor.extract(file, path)
+            file = file.next
+          end
+        end
+      end
+
+      private
+
+      def open_cab(archive)
+        decompressor = LibMsPack::CabDecompressor.new
+        cab = Utils.silence_stream(STDERR) do
+          decompressor.search(archive)
+        end
+
+        yield decompressor, cab
+
+        decompressor.close(cab)
+        decompressor.destroy
+      end
+    end
+  end
+end