ffi-libarchive 0.4.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3c37895c915096d5ae42cbb50b8fd6167c7d48cd8590a015349044fdb85fb96
-  data.tar.gz: 0764ac29c260a47fea958e91ef79c8e66e6851891b855ba9d589e91b60edc66a
+  metadata.gz: e9b6e6ed6fbbaf0e493767d47541307f64cfcffd32e23d33f0f47ab3efd6a35a
+  data.tar.gz: c85cb44e37fdbe3bec65f7408fc7e0eb821393bec658c929f6252d2ca01c6ecf
 SHA512:
-  metadata.gz: fa7e534b9756c8c749060dc73c2b7abee2143c043b35883a923b6495efa2cf72c830217a2363860e1bd5236ef00643419cb150568535a140416d1dbfd0e9afd0
-  data.tar.gz: 9a3d0063fecd54c132b1df706d8da790b3826b065443c27ce6e7dd5ba02a80ebef65287745e91a898bf12aa018d833a223c07140092ac4269dfbb880f5bffb5e
+  metadata.gz: f3bf10cbcfa75efc763348bce05f35f4891717a5c8aed5ab38e5ab2cd6c0d162b179fb2c3defb9af7c6e039e12f385590e66c8534b0eafd394706afc20b7ea55
+  data.tar.gz: 07cba89aa39ec4be250d187cb75113ae1b1f2c21b20b3854926fed0bc2f7ff413ba24c526fa5a2d2c7a3e27b2a8bc6ec2b27dfab54a6b7370c3ce8aea3c4dfc9

data/lib/ffi-libarchive.rb

@@ -46,7 +46,8 @@ module Archive
   def self.require_all_libs_relative_to(fname, dir = nil)
     dir ||= ::File.basename(fname, ".*")
     search_me = ::File.expand_path(
-      ::File.join(::File.dirname(fname), dir, "**", "*.rb"))
+      ::File.join(::File.dirname(fname), dir, "**", "*.rb")
+    )
 
     Dir.glob(search_me).sort.each { |rb| require rb }
   end

data/lib/ffi-libarchive/archive.rb

@@ -16,15 +16,24 @@ module Archive
     attach_function :archive_errno, [:pointer], :int
 
     attach_function :archive_read_new, [], :pointer
-    attach_function :archive_read_open_filename, [:pointer, :string, :size_t], :int
-    attach_function :archive_read_open_memory, [:pointer, :pointer, :size_t], :int
-    attach_function :archive_read_support_compression_program, [:pointer, :string], :int
+    attach_function :archive_read_open_filename, %i{pointer string size_t}, :int
+    attach_function :archive_read_open_memory, %i{pointer pointer size_t}, :int
+    attach_function :archive_read_open1, [:pointer], :int
+    attach_function :archive_read_support_compression_program, %i{pointer string}, :int
     attach_function :archive_read_support_compression_all, [:pointer], :int
 
-    attach_function_maybe :archive_read_set_format, [:pointer, :int], :int
-    attach_function_maybe :archive_read_append_filter, [:pointer, :int], :int
-    attach_function_maybe :archive_read_append_filter_program, [:pointer, :pointer], :int
-    attach_function_maybe :archive_read_append_filter_program_signature, [:pointer, :string, :pointer, :size_t], :int
+    callback :archive_read_callback, %i{pointer pointer pointer}, :int
+    callback :archive_skip_callback, %i{pointer pointer int64}, :int
+    callback :archive_seek_callback, %i{pointer pointer int64 int}, :int
+    attach_function :archive_read_set_read_callback, %i{pointer archive_read_callback}, :int
+    attach_function :archive_read_set_callback_data, %i{pointer pointer}, :int
+    attach_function :archive_read_set_skip_callback, %i{pointer archive_skip_callback}, :int
+    attach_function :archive_read_set_seek_callback, %i{pointer archive_seek_callback}, :int
+
+    attach_function_maybe :archive_read_set_format, %i{pointer int}, :int
+    attach_function_maybe :archive_read_append_filter, %i{pointer int}, :int
+    attach_function_maybe :archive_read_append_filter_program, %i{pointer pointer}, :int
+    attach_function_maybe :archive_read_append_filter_program_signature, %i{pointer string pointer size_t}, :int
 
     attach_function_maybe :archive_read_support_filter_all, [:pointer], :int
     attach_function_maybe :archive_read_support_filter_bzip2, [:pointer], :int
@@ -64,18 +73,18 @@ module Archive
     attach_function_maybe :archive_read_support_format_zip_seekable, [:pointer], :int
 
     attach_function :archive_read_finish, [:pointer], :int
-    attach_function :archive_read_extract, [:pointer, :pointer, :int], :int
+    attach_function :archive_read_extract, %i{pointer pointer int}, :int
     attach_function :archive_read_header_position, [:pointer], :int
-    attach_function :archive_read_next_header, [:pointer, :pointer], :int
-    attach_function :archive_read_data, [:pointer, :pointer, :size_t], :size_t
-    attach_function :archive_read_data_into_fd, [:pointer, :int], :int
+    attach_function :archive_read_next_header, %i{pointer pointer}, :int
+    attach_function :archive_read_data, %i{pointer pointer size_t}, :size_t
+    attach_function :archive_read_data_into_fd, %i{pointer int}, :int
 
     attach_function :archive_write_new, [], :pointer
-    attach_function :archive_write_open_filename, [:pointer, :string], :int
-    callback :archive_open_callback, [:pointer, :pointer], :int
-    callback :archive_write_callback, [:pointer, :pointer, :pointer, :size_t], :int
-    callback :archive_close_callback, [:pointer, :pointer], :int
-    attach_function :archive_write_open, [:pointer, :pointer, :pointer, :archive_write_callback, :pointer], :int
+    attach_function :archive_write_open_filename, %i{pointer string}, :int
+    callback :archive_open_callback, %i{pointer pointer}, :int
+    callback :archive_write_callback, %i{pointer pointer pointer size_t}, :int
+    callback :archive_close_callback, %i{pointer pointer}, :int
+    attach_function :archive_write_open, %i{pointer pointer pointer archive_write_callback pointer}, :int
     attach_function :archive_write_set_compression_none, [:pointer], :int
     attach_function_maybe :archive_write_set_compression_gzip, [:pointer], :int
     attach_function_maybe :archive_write_set_compression_bzip2, [:pointer], :int
@@ -83,7 +92,7 @@ module Archive
     attach_function_maybe :archive_write_set_compression_compress, [:pointer], :int
     attach_function_maybe :archive_write_set_compression_lzma, [:pointer], :int
     attach_function_maybe :archive_write_set_compression_xz, [:pointer], :int
-    attach_function :archive_write_set_compression_program, [:pointer, :string], :int
+    attach_function :archive_write_set_compression_program, %i{pointer string}, :int
 
     def self.archive_write_set_compression(archive, compression)
       case compression
@@ -106,94 +115,94 @@ module Archive
       end
     end
 
-    attach_function :archive_write_set_format, [:pointer, :int], :int
-    attach_function :archive_write_data, [:pointer, :pointer, :size_t], :ssize_t
-    attach_function :archive_write_header, [:pointer, :pointer], :int
+    attach_function :archive_write_set_format, %i{pointer int}, :int
+    attach_function :archive_write_data, %i{pointer pointer size_t}, :ssize_t
+    attach_function :archive_write_header, %i{pointer pointer}, :int
     attach_function :archive_write_finish, [:pointer], :void
     attach_function :archive_write_get_bytes_in_last_block, [:pointer], :int
-    attach_function :archive_write_set_bytes_in_last_block, [:pointer, :int], :int
+    attach_function :archive_write_set_bytes_in_last_block, %i{pointer int}, :int
 
     attach_function :archive_entry_new, [], :pointer
     attach_function :archive_entry_free, [:pointer], :void
     attach_function :archive_entry_atime, [:pointer], :time_t
-    attach_function :archive_entry_atime_nsec, [:pointer, :time_t, :long], :void
+    attach_function :archive_entry_atime_nsec, %i{pointer time_t long}, :void
     attach_function_maybe :archive_entry_atime_is_set, [:pointer], :int
-    attach_function :archive_entry_set_atime, [:pointer, :time_t, :long], :int
+    attach_function :archive_entry_set_atime, %i{pointer time_t long}, :int
     attach_function_maybe :archive_entry_unset_atime, [:pointer], :int
     attach_function_maybe :archive_entry_birthtime, [:pointer], :time_t
-    attach_function_maybe :archive_entry_birthtime_nsec, [:pointer, :time_t, :long], :void
+    attach_function_maybe :archive_entry_birthtime_nsec, %i{pointer time_t long}, :void
     attach_function_maybe :archive_entry_birthtime_is_set, [:pointer], :int
-    attach_function_maybe :archive_entry_set_birthtime, [:pointer, :time_t, :long], :int
+    attach_function_maybe :archive_entry_set_birthtime, %i{pointer time_t long}, :int
     attach_function_maybe :archive_entry_unset_birthtime, [:pointer], :int
     attach_function :archive_entry_ctime, [:pointer], :time_t
-    attach_function :archive_entry_ctime_nsec, [:pointer, :time_t, :long], :void
+    attach_function :archive_entry_ctime_nsec, %i{pointer time_t long}, :void
     attach_function_maybe :archive_entry_ctime_is_set, [:pointer], :int
-    attach_function :archive_entry_set_ctime, [:pointer, :time_t, :long], :int
+    attach_function :archive_entry_set_ctime, %i{pointer time_t long}, :int
     attach_function_maybe :archive_entry_unset_ctime, [:pointer], :int
     attach_function :archive_entry_mtime, [:pointer], :time_t
-    attach_function :archive_entry_mtime_nsec, [:pointer, :time_t, :long], :void
+    attach_function :archive_entry_mtime_nsec, %i{pointer time_t long}, :void
     attach_function_maybe :archive_entry_mtime_is_set, [:pointer], :int
-    attach_function :archive_entry_set_mtime, [:pointer, :time_t, :long], :int
+    attach_function :archive_entry_set_mtime, %i{pointer time_t long}, :int
     attach_function_maybe :archive_entry_unset_mtime, [:pointer], :int
     attach_function :archive_entry_dev, [:pointer], :dev_t
-    attach_function :archive_entry_set_dev, [:pointer, :dev_t], :void
+    attach_function :archive_entry_set_dev, %i{pointer dev_t}, :void
     attach_function :archive_entry_devmajor, [:pointer], :dev_t
-    attach_function :archive_entry_set_devmajor, [:pointer, :dev_t], :void
+    attach_function :archive_entry_set_devmajor, %i{pointer dev_t}, :void
     attach_function :archive_entry_devminor, [:pointer], :dev_t
-    attach_function :archive_entry_set_devminor, [:pointer, :dev_t], :void
+    attach_function :archive_entry_set_devminor, %i{pointer dev_t}, :void
     attach_function :archive_entry_filetype, [:pointer], :mode_t
-    attach_function :archive_entry_set_filetype, [:pointer, :mode_t], :void
-    attach_function :archive_entry_fflags, [:pointer, :pointer, :pointer], :void
-    attach_function :archive_entry_set_fflags, [:pointer, :ulong, :ulong], :void
+    attach_function :archive_entry_set_filetype, %i{pointer mode_t}, :void
+    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, [:pointer, :gid_t], :void
+    attach_function :archive_entry_set_gid, %i{pointer gid_t}, :void
     attach_function :archive_entry_gname, [:pointer], :string
-    attach_function :archive_entry_set_gname, [:pointer, :string], :void
+    attach_function :archive_entry_set_gname, %i{pointer string}, :void
     attach_function :archive_entry_hardlink, [:pointer], :string
-    attach_function :archive_entry_set_hardlink, [:pointer, :string], :void
-    attach_function :archive_entry_set_link, [:pointer, :string], :void
+    attach_function :archive_entry_set_hardlink, %i{pointer string}, :void
+    attach_function :archive_entry_set_link, %i{pointer string}, :void
     attach_function :archive_entry_ino, [:pointer], :ino_t
-    attach_function :archive_entry_set_ino, [:pointer, :ino_t], :void
+    attach_function :archive_entry_set_ino, %i{pointer ino_t}, :void
     attach_function :archive_entry_mode, [:pointer], :mode_t
-    attach_function :archive_entry_set_mode, [:pointer, :mode_t], :void
-    attach_function :archive_entry_set_perm, [:pointer, :mode_t], :void
+    attach_function :archive_entry_set_mode, %i{pointer mode_t}, :void
+    attach_function :archive_entry_set_perm, %i{pointer mode_t}, :void
     attach_function :archive_entry_nlink, [:pointer], :uint
-    attach_function :archive_entry_set_nlink, [:pointer, :uint], :void
+    attach_function :archive_entry_set_nlink, %i{pointer uint}, :void
     attach_function :archive_entry_pathname, [:pointer], :string
-    attach_function :archive_entry_set_pathname, [:pointer, :string], :void
+    attach_function :archive_entry_set_pathname, %i{pointer string}, :void
     attach_function :archive_entry_rdev, [:pointer], :dev_t
-    attach_function :archive_entry_set_rdev, [:pointer, :dev_t], :void
+    attach_function :archive_entry_set_rdev, %i{pointer dev_t}, :void
     attach_function :archive_entry_rdevmajor, [:pointer], :dev_t
-    attach_function :archive_entry_set_rdevmajor, [:pointer, :dev_t], :void
+    attach_function :archive_entry_set_rdevmajor, %i{pointer dev_t}, :void
     attach_function :archive_entry_rdevminor, [:pointer], :dev_t
-    attach_function :archive_entry_set_rdevminor, [:pointer, :dev_t], :void
+    attach_function :archive_entry_set_rdevminor, %i{pointer dev_t}, :void
     attach_function :archive_entry_size, [:pointer], :int64_t
-    attach_function :archive_entry_set_size, [:pointer, :int64_t], :void
+    attach_function :archive_entry_set_size, %i{pointer int64_t}, :void
     attach_function_maybe :archive_entry_unset_size, [:pointer], :void
     attach_function_maybe :archive_entry_size_is_set, [:pointer], :int
     attach_function :archive_entry_sourcepath, [:pointer], :string
     attach_function :archive_entry_strmode, [:pointer], :string
     attach_function :archive_entry_symlink, [:pointer], :string
-    attach_function :archive_entry_set_symlink, [:pointer, :string], :void
+    attach_function :archive_entry_set_symlink, %i{pointer string}, :void
     attach_function :archive_entry_uid, [:pointer], :uid_t
-    attach_function :archive_entry_set_uid, [:pointer, :uid_t], :void
+    attach_function :archive_entry_set_uid, %i{pointer uid_t}, :void
     attach_function :archive_entry_uname, [:pointer], :string
-    attach_function :archive_entry_set_uname, [:pointer, :string], :void
-    attach_function :archive_entry_copy_stat, [:pointer, :pointer], :void
-    attach_function :archive_entry_copy_fflags_text, [:pointer, :string], :string
-    attach_function :archive_entry_copy_gname, [:pointer, :string], :string
-    attach_function :archive_entry_copy_uname, [:pointer, :string], :string
-    attach_function :archive_entry_copy_hardlink, [:pointer, :string], :string
-    attach_function :archive_entry_copy_link, [:pointer, :string], :string
-    attach_function :archive_entry_copy_symlink, [:pointer, :string], :string
-    attach_function :archive_entry_copy_sourcepath, [:pointer, :string], :string
-    attach_function :archive_entry_copy_pathname, [:pointer, :string], :string
+    attach_function :archive_entry_set_uname, %i{pointer string}, :void
+    attach_function :archive_entry_copy_stat, %i{pointer pointer}, :void
+    attach_function :archive_entry_copy_fflags_text, %i{pointer string}, :string
+    attach_function :archive_entry_copy_gname, %i{pointer string}, :string
+    attach_function :archive_entry_copy_uname, %i{pointer string}, :string
+    attach_function :archive_entry_copy_hardlink, %i{pointer string}, :string
+    attach_function :archive_entry_copy_link, %i{pointer string}, :string
+    attach_function :archive_entry_copy_symlink, %i{pointer string}, :string
+    attach_function :archive_entry_copy_sourcepath, %i{pointer string}, :string
+    attach_function :archive_entry_copy_pathname, %i{pointer string}, :string
     attach_function :archive_entry_xattr_clear, [:pointer], :void
-    attach_function :archive_entry_xattr_add_entry, [:pointer, :string, :pointer, :size_t], :void
+    attach_function :archive_entry_xattr_add_entry, %i{pointer string pointer size_t}, :void
     attach_function :archive_entry_xattr_count, [:pointer], :int
     attach_function :archive_entry_xattr_reset, [:pointer], :int
-    attach_function :archive_entry_xattr_next, [:pointer, :pointer, :pointer, :pointer], :int
+    attach_function :archive_entry_xattr_next, %i{pointer pointer pointer pointer}, :int
 
     EOF    = 1
     OK     = 0
@@ -278,6 +287,10 @@ module Archive
     Reader.open_memory string, command, &block
   end
 
+  def self.read_open_stream(reader, &block)
+    Reader.open_stream reader, &block
+  end
+
   def self.write_open_filename(file_name, compression, format, &block)
     Writer.open_filename file_name, compression, format, &block
   end
@@ -336,6 +349,7 @@ module Archive
 
     def archive
       raise Error, "No archive open" unless @archive
+
       @archive
     end
     protected :archive

data/lib/ffi-libarchive/entry.rb

@@ -60,6 +60,7 @@ module Archive
 
     def entry
       raise "No entry object" unless @entry
+
       @entry
     end
 
@@ -182,6 +183,7 @@ module Archive
 
       stat = Archive::Stat.ffi_libarchive_create_lstat(filename)
       raise Error, "Copy stat failed: #{Archive::Stat.ffi_error}" if stat.null?
+
       C.archive_entry_copy_stat(entry, stat)
     ensure
       Archive::Stat.ffi_libarchive_free_stat(stat)
@@ -207,6 +209,7 @@ module Archive
 
       stat = Archive::Stat.ffi_libarchive_create_stat(filename)
       raise Error, "Copy stat failed: #{Archive::Stat.ffi_error}" if stat.null?
+
       C.archive_entry_copy_stat(entry, stat)
     ensure
       Archive::Stat.ffi_libarchive_free_stat(stat)

data/lib/ffi-libarchive/reader.rb

@@ -28,6 +28,19 @@ module Archive
       end
     end
 
+    def self.open_stream(reader)
+      if block_given?
+        reader = new reader: reader
+        begin
+          yield reader
+        ensure
+          reader.close
+        end
+      else
+        new reader: reader
+      end
+    end
+
     def initialize(params = {})
       super C.method(:archive_read_new), C.method(:archive_read_finish)
 
@@ -40,13 +53,44 @@ module Archive
 
       raise Error, @archive if C.archive_read_support_format_all(archive) != C::OK
 
-      if params[:file_name]
+      case
+      when params[:file_name]
         raise Error, @archive if C.archive_read_open_filename(archive, params[:file_name], 1024) != C::OK
-      elsif params[:memory]
+      when params[:memory]
         str = params[:memory]
         @data = FFI::MemoryPointer.new(str.bytesize + 1)
         @data.write_string str, str.bytesize
         raise Error, @archive if C.archive_read_open_memory(archive, @data, str.bytesize) != C::OK
+      when params[:reader]
+        @reader = params[:reader]
+        @buffer = nil
+
+        @read_callback = FFI::Function.new(:int, %i{pointer pointer pointer}) do |_, _, archive_data|
+          data = @reader.call || ""
+          @buffer = FFI::MemoryPointer.new(:char, data.size) if @buffer.nil? || @buffer.size < data.size
+          @buffer.write_bytes(data)
+          archive_data.write_pointer(@buffer)
+          data.size
+        end
+        C.archive_read_set_read_callback(archive, @read_callback)
+
+        if @reader.respond_to?(:skip)
+          @skip_callback = FFI::Function.new(:int, %i{pointer pointer int64}) do |_, _, offset|
+            @reader.skip(offset)
+          end
+          C.archive_read_set_skip_callback(archive, @skip_callback)
+        end
+
+        if @reader.respond_to?(:seek)
+          @seek_callback = FFI::Function.new(:int, %i{pointer pointer int64 int}) do |_, _, offset, whence|
+            @reader.seek(offset, whence)
+          end
+          C.archive_read_set_seek_callback(archive, @seek_callback)
+        end
+
+        # Required or open1 will segfault, even though the callback data is not used.
+        C.archive_read_set_callback_data(archive, nil)
+        raise Error, @archive if C.archive_read_open1(archive) != C::OK
       end
     rescue
       close

data/lib/ffi-libarchive/version.rb

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

data/lib/ffi-libarchive/writer.rb

@@ -58,9 +58,9 @@ module Archive
         end
         @data = write_callback params[:memory]
         raise Error, @archive if C.archive_write_open(archive, nil,
-                                                       nil,
-                                                       @data,
-                                                       nil) != C::OK
+          nil,
+          @data,
+          nil) != C::OK
       end
     rescue
       close
@@ -117,10 +117,12 @@ module Archive
           if (n = C.archive_write_data(ar, str, str.bytesize)) < 1
             return len
           end
+
           len += n
         end
       else
         raise ArgumentError, "wrong number of argument (#{args.size}) for 1)" if args.size != 1
+
         str = args[0]
         C.archive_write_data(archive, str, str.bytesize)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-libarchive
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 1.0.0
 platform: ruby
 authors:
 - John Bellone
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi