class NdrImport::File::SevenZip

This class is a 7zip file handler that returns tables from the extracted files.

Public Class Methods

new(filename, format, options = {}) click to toggle source
Calls superclass method NdrImport::File::Base::new
# File lib/ndr_import/file/seven_zip.rb, line 11
def initialize(filename, format, options = {})
  super
  @pattern = options['pattern'] || //
  @unzip_path = options['unzip_path']
  @password = options['password']

  validate_unzip_path_is_safe!
end

Public Instance Methods

files(&block) click to toggle source
# File lib/ndr_import/file/seven_zip.rb, line 20
def files(&block)
  raise 'Not allowed in external environment' if defined?(::Rails) && ::Rails.env.external?

  return enum_for(:files) unless block

  destination = @unzip_path.join(Time.current.strftime('%H%M%S%L'))
  FileUtils.mkdir_p(SafeFile.safepath_to_string(destination))

  ::File.open(SafeFile.safepath_to_string(@filename), 'rb') do |zipfile|
    unzip_entries(zipfile, destination, &block)
  end
end
tables() click to toggle source

7zip files produce files, never tables.

# File lib/ndr_import/file/seven_zip.rb, line 34
def tables
  raise 'SevenZip#tables should never be called'
end

Private Instance Methods

unzip_entries(zipfile, destination, &block) click to toggle source

Unzip the 7zip file entry and enumerate over it

# File lib/ndr_import/file/seven_zip.rb, line 41
def unzip_entries(zipfile, destination, &block)
  SevenZipRuby::Reader.open(zipfile, password: @password) do |szr|
    szr.entries.each do |entry|
      # SECURE: TPG 2018-11-21: The path is stripped from the zipfile entry when extracted
      basename = ::File.basename(entry.path)
      next unless entry.file? && basename.match(@pattern)

      unzipped_filename = destination.join(basename)
      szr.extract([entry], unzipped_filename)

      unzipped_files(unzipped_filename, &block)
    end
  end
end
unzipped_files(unzipped_filename) { |filename| ... } click to toggle source

Enumerate over an unzipped file like any other

# File lib/ndr_import/file/seven_zip.rb, line 57
def unzipped_files(unzipped_filename)
  Registry.files(unzipped_filename, @options).each do |filename|
    yield(filename)
  end
end
validate_unzip_path_is_safe!() click to toggle source
# File lib/ndr_import/file/seven_zip.rb, line 63
def validate_unzip_path_is_safe!
  SafeFile.safepath_to_string(@unzip_path)
end