ffi-libarchive 1.0.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9b6e6ed6fbbaf0e493767d47541307f64cfcffd32e23d33f0f47ab3efd6a35a
-  data.tar.gz: c85cb44e37fdbe3bec65f7408fc7e0eb821393bec658c929f6252d2ca01c6ecf
+  metadata.gz: ad607029b63e0c23ad8bf7ab667c246ec99d122ae09a60430657b1fa6ddd8126
+  data.tar.gz: 57c455b2d4e159da7ccee28faa0f4c347d98e6b92a8ffe70b5c00e6b02a60414
 SHA512:
-  metadata.gz: f3bf10cbcfa75efc763348bce05f35f4891717a5c8aed5ab38e5ab2cd6c0d162b179fb2c3defb9af7c6e039e12f385590e66c8534b0eafd394706afc20b7ea55
-  data.tar.gz: 07cba89aa39ec4be250d187cb75113ae1b1f2c21b20b3854926fed0bc2f7ff413ba24c526fa5a2d2c7a3e27b2a8bc6ec2b27dfab54a6b7370c3ce8aea3c4dfc9
+  metadata.gz: 35b3c1c4737846dedf71efa6925f6c594ff997156cd793a2df39e001d7d874fc74f20a36f38aa0c593718c28ef9bbd64029ec28aadf6e8d2317469e002aaf330
+  data.tar.gz: 5d054df7e653dd6e14f1897cddd0859cdf90e3f26970f2d09701ee0a2ae8c2a89496fe1035850426f7634e01d7fad91cb5ab7b5c7392849d03c8eceace2fe15c

data/lib/ffi-libarchive/archive.rb

@@ -1,4 +1,4 @@
-require "ffi"
+require "ffi" unless defined?(FFI)
 
 module Archive
   module C
@@ -123,6 +123,7 @@ module Archive
     attach_function :archive_write_set_bytes_in_last_block, %i{pointer int}, :int
 
     attach_function :archive_entry_new, [], :pointer
+    attach_function :archive_entry_clone, [:pointer], :pointer
     attach_function :archive_entry_free, [:pointer], :void
     attach_function :archive_entry_atime, [:pointer], :time_t
     attach_function :archive_entry_atime_nsec, %i{pointer time_t long}, :void
@@ -155,8 +156,8 @@ module Archive
     attach_function :archive_entry_fflags, %i{pointer pointer pointer}, :void
     attach_function :archive_entry_set_fflags, %i{pointer ulong ulong}, :void
     attach_function :archive_entry_fflags_text, [:pointer], :string
-    attach_function :archive_entry_gid, [:pointer], :gid_t
-    attach_function :archive_entry_set_gid, %i{pointer gid_t}, :void
+    attach_function :archive_entry_gid, [:pointer], :uint
+    attach_function :archive_entry_set_gid, %i{pointer uint}, :void
     attach_function :archive_entry_gname, [:pointer], :string
     attach_function :archive_entry_set_gname, %i{pointer string}, :void
     attach_function :archive_entry_hardlink, [:pointer], :string
@@ -185,8 +186,8 @@ module Archive
     attach_function :archive_entry_strmode, [:pointer], :string
     attach_function :archive_entry_symlink, [:pointer], :string
     attach_function :archive_entry_set_symlink, %i{pointer string}, :void
-    attach_function :archive_entry_uid, [:pointer], :uid_t
-    attach_function :archive_entry_set_uid, %i{pointer uid_t}, :void
+    attach_function :archive_entry_uid, [:pointer], :uint
+    attach_function :archive_entry_set_uid, %i{pointer uint}, :void
     attach_function :archive_entry_uname, [:pointer], :string
     attach_function :archive_entry_set_uname, %i{pointer string}, :void
     attach_function :archive_entry_copy_stat, %i{pointer pointer}, :void

data/lib/ffi-libarchive/entry.rb

@@ -17,14 +17,14 @@ module Archive
     CHARACTER_SPECIAL = 0020000 #  character device
     FIFO              = 0010000 #  FIFO
 
-    def self.from_pointer(entry)
-      new entry
+    def self.from_pointer(entry, clone: false)
+      new entry, clone: clone
     end
 
-    def initialize(entry = nil)
+    def initialize(entry = nil, clone: false)
       @entry_free = [true]
       if entry
-        @entry = entry
+        @entry = clone ? C.archive_entry_clone(entry) : entry
         yield self if block_given?
       else
         @entry = C.archive_entry_new
@@ -34,7 +34,7 @@ module Archive
           result = yield self
           C.archive_entry_free(@entry)
           @entry = nil
-          return result
+          result
         else
           @entry_free[0] = false
           ObjectSpace.define_finalizer(self, Entry.finalizer(@entry, @entry_free))
@@ -462,10 +462,10 @@ module Archive
       value = FFI::MemoryPointer.new :pointer
       size = FFI::MemoryPointer.new :size_t
       if C.archive_entry_xattr_next(entry, name, value, size) != C::OK
-        return nil
+        nil
       else
         # TODO: someday size.read_size_t could work
-        return [name.null? ? nil : name.read_string,
+        [name.null? ? nil : name.read_string,
                 value.null? ? nil : value.get_string(0, size.read_ulong)]
       end
     end

data/lib/ffi-libarchive/reader.rb

@@ -2,16 +2,16 @@ module Archive
   class Reader < BaseArchive
     private_class_method :new
 
-    def self.open_filename(file_name, command = nil)
+    def self.open_filename(file_name, command = nil, strip_components: 0)
       if block_given?
-        reader = open_filename file_name, command
+        reader = open_filename file_name, command, strip_components: strip_components
         begin
           yield reader
         ensure
           reader.close
         end
       else
-        new file_name: file_name, command: command
+        new file_name: file_name, command: command, strip_components: strip_components
       end
     end
 
@@ -41,9 +41,19 @@ module Archive
       end
     end
 
+    attr_reader :strip_components
+
     def initialize(params = {})
       super C.method(:archive_read_new), C.method(:archive_read_finish)
 
+      if params[:strip_components]
+        raise ArgumentError, "Expected Integer as strip_components" unless params[:strip_components].is_a?(Integer)
+
+        @strip_components = params[:strip_components]
+      else
+        @strip_components = 0
+      end
+
       if params[:command]
         cmd = params[:command]
         raise Error, @archive if C.archive_read_support_compression_program(archive, cmd) != C::OK
@@ -97,9 +107,16 @@ module Archive
       raise
     end
 
-    def extract(entry, flags = 0)
+    def extract(entry, flags = 0, destination: nil)
       raise ArgumentError, "Expected Archive::Entry as first argument" unless entry.is_a? Entry
       raise ArgumentError, "Expected Integer as second argument" unless flags.is_a? Integer
+      raise ArgumentError, "Expected String as destination" if destination && !destination.is_a?(String)
+
+      if destination
+        # We update the pathname here so this will change for the caller as a side effect, but this seems convenient and accurate?
+        pathname = C.archive_entry_pathname(entry.entry)
+        C.archive_entry_set_pathname(entry.entry, "#{destination}/#{pathname}")
+      end
 
       flags |= EXTRACT_FFLAGS
       raise Error, @archive if C.archive_read_extract(archive, entry.entry, flags) != C::OK
@@ -109,11 +126,11 @@ module Archive
       raise Error, @archive if C.archive_read_header_position archive
     end
 
-    def next_header
+    def next_header(clone_entry: false)
       entry_ptr = FFI::MemoryPointer.new(:pointer)
       case C.archive_read_next_header(archive, entry_ptr)
       when C::OK
-        Entry.from_pointer entry_ptr.read_pointer
+        Entry.from_pointer entry_ptr.read_pointer, clone: clone_entry
       when C::EOF
         @eof = true
         nil
@@ -124,12 +141,16 @@ module Archive
 
     def each_entry
       while (entry = next_header)
+        next if strip_entry_components!(entry).nil?
+
         yield entry
       end
     end
 
     def each_entry_with_data(_size = C::DATA_BUFFER_SIZE)
       while (entry = next_header)
+        next if strip_entry_components!(entry).nil?
+
         yield entry, read_data
       end
     end
@@ -164,5 +185,57 @@ module Archive
         raise Error, @archive if C.archive_read_data_into_fd(archive, fd) != C::OK
       end
     end
+
+    private
+
+    #
+    # See:
+    #   1. https://github.com/libarchive/libarchive/blob/6a9dcf9fc429e2dc9fb08e669bf7b0bed4d5edf9/tar/read.c#L346
+    #   2. https://github.com/libarchive/libarchive/blob/a11f15860ae39ecdc8173243a211cdafc8ac893c/tar/util.c#L523-L535
+    #   3. https://github.com/libarchive/libarchive/blob/a11f15860ae39ecdc8173243a211cdafc8ac893c/tar/util.c#L554-L560
+    #
+    # @param entry [Archive::Entry]
+    #
+    # @return [Archive::Entry, nil] entry stripped or nil if entry is no longer relevant due to stripping
+    #
+    def strip_entry_components!(entry)
+      if strip_components > 0
+        name = entry.pathname
+        original_name = name.dup
+        hardlink_name = entry.hardlink
+        original_hardlink_name = hardlink_name.dup
+
+        strip_path_components!(name)
+        return if name.empty?
+
+        unless hardlink_name.nil?
+          strip_path_components!(hardlink_name)
+          return if hardlink_name.empty?
+        end
+
+        if name != original_name
+          entry.copy_pathname(name)
+        end
+        entry.copy_hardlink(hardlink_name) if hardlink_name != original_hardlink_name
+      end
+
+      entry
+    end
+
+    #
+    # @param path [String]
+    #
+    # @return [String]
+    #
+    def strip_path_components!(path)
+      if strip_components > 0
+        is_dir = path.end_with?("/")
+        updated_path = path.split("/").drop(strip_components).join("/")
+        updated_path = is_dir && updated_path != "" ? updated_path + "/" : updated_path
+        path.gsub!(path, updated_path)
+      else
+        path
+      end
+    end
   end
 end

data/lib/ffi-libarchive/version.rb

@@ -1,3 +1,3 @@
 module Archive
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.3".freeze
 end

data/lib/ffi-libarchive.rb

@@ -1,6 +1,6 @@
 module Archive
   # :stopdoc:
-  LIBPATH ||= ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  LIBPATH ||= __dir__ + ::File::SEPARATOR
   PATH ||= ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-libarchive
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.3
 platform: ruby
 authors:
 - John Bellone
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-28 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -26,20 +26,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A Ruby FFI binding to libarchive.
 email:
 - jbellone@bloomberg.net
@@ -69,14 +55,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Ruby FFI binding to libarchive.