rubyzip 1.0.0 → 2.4.1

data/lib/zip/output_stream.rb

@@ -24,18 +24,25 @@ module Zip
 
     # Opens the indicated zip file. If a file with that name already
     # exists it will be overwritten.
-    def initialize(fileName, stream=false)
+    def initialize(file_name, dep_stream = false, dep_encrypter = nil, stream: false, encrypter: nil)
       super()
-      @fileName = fileName
-      if stream
-        @output_stream = ::StringIO.new
-      else
-        @output_stream = ::File.new(@fileName, "wb")
-      end
+
+      Zip.warn_about_v3_api('Zip::OutputStream.new') if dep_stream || !dep_encrypter.nil?
+
+      @file_name = file_name
+      @output_stream = if stream || dep_stream
+                         iostream = @file_name.dup
+                         iostream.reopen(@file_name)
+                         iostream.rewind
+                         iostream
+                       else
+                         ::File.new(@file_name, 'wb')
+                       end
       @entry_set = ::Zip::EntrySet.new
       @compressor = ::Zip::NullCompressor.instance
+      @encrypter = encrypter || dep_encrypter || ::Zip::NullEncrypter.new
       @closed = false
-      @currentEntry = nil
+      @current_entry = nil
       @comment = nil
     end
 
@@ -43,25 +50,32 @@ module Zip
     # stream is passed to the block and closed when the block
     # returns.
     class << self
-      def open(fileName)
-        return new(fileName) unless block_given?
-        zos = new(fileName)
+      def open(file_name, dep_encrypter = nil, encrypter: nil)
+        return new(file_name) unless block_given?
+
+        Zip.warn_about_v3_api('Zip::OutputStream.open') unless dep_encrypter.nil?
+
+        zos = new(file_name, stream: false, encrypter: (encrypter || dep_encrypter))
         yield zos
       ensure
         zos.close if zos
       end
 
-	    # Same as #open but writes to a filestream instead
-      def write_buffer
-        zos = new('', true)
+      # Same as #open but writes to a filestream instead
+      def write_buffer(io = ::StringIO.new, dep_encrypter = nil, encrypter: nil)
+        Zip.warn_about_v3_api('Zip::OutputStream.write_buffer') unless dep_encrypter.nil?
+
+        io.binmode if io.respond_to?(:binmode)
+        zos = new(io, stream: true, encrypter: (encrypter || dep_encrypter))
         yield zos
-        return zos.close_buffer
+        zos.close_buffer
       end
     end
 
     # Closes the stream and writes the central directory to the zip file
     def close
       return if @closed
+
       finalize_current_entry
       update_local_headers
       write_central_directory
@@ -72,6 +86,7 @@ module Zip
     # Closes the stream and writes the central directory to the zip file
     def close_buffer
       return @output_stream if @closed
+
       finalize_current_entry
       update_local_headers
       write_central_directory
@@ -79,66 +94,79 @@ module Zip
       @output_stream
     end
 
-	  # Closes the current entry and opens a new for writing.
+    # Closes the current entry and opens a new for writing.
     # +entry+ can be a ZipEntry object or a string.
-    def put_next_entry(entryname, comment = nil, extra = nil, compression_method = Entry::DEFLATED,  level = Zlib::DEFAULT_COMPRESSION)
-      raise ZipError, "zip stream is closed" if @closed
-      if entryname.kind_of?(Entry)
-        new_entry = entryname
-      else
-        new_entry = Entry.new(@fileName, entryname.to_s)
-      end
-      new_entry.comment = comment if !comment.nil?
-      if (!extra.nil?)
-        new_entry.extra = ExtraField === extra ? extra : ExtraField.new(extra.to_s)
+    def put_next_entry(entry_name, comment = nil, extra = nil, compression_method = Entry::DEFLATED, level = Zip.default_compression)
+      raise Error, 'zip stream is closed' if @closed
+
+      new_entry = if entry_name.kind_of?(Entry)
+                    entry_name
+                  else
+                    Entry.new(@file_name, entry_name.to_s)
+                  end
+      new_entry.comment = comment unless comment.nil?
+      unless extra.nil?
+        new_entry.extra = extra.kind_of?(ExtraField) ? extra : ExtraField.new(extra.to_s)
       end
-      new_entry.compression_method = compression_method if !compression_method.nil?
+      new_entry.compression_method = compression_method unless compression_method.nil?
       init_next_entry(new_entry, level)
-      @currentEntry = new_entry
+      @current_entry = new_entry
     end
 
     def copy_raw_entry(entry)
       entry = entry.dup
-      raise ZipError, "zip stream is closed" if @closed
-      raise ZipError, "entry is not a ZipEntry" if !entry.kind_of?(Entry)
+      raise Error, 'zip stream is closed' if @closed
+      raise Error, 'entry is not a ZipEntry' unless entry.kind_of?(Entry)
+
       finalize_current_entry
       @entry_set << entry
-      src_pos = entry.local_entry_offset
+      src_pos = entry.local_header_offset
       entry.write_local_entry(@output_stream)
       @compressor = NullCompressor.instance
       entry.get_raw_input_stream do |is|
         is.seek(src_pos, IO::SEEK_SET)
+        ::Zip::Entry.read_local_entry(is)
         IOExtras.copy_stream_n(@output_stream, is, entry.compressed_size)
       end
       @compressor = NullCompressor.instance
-      @currentEntry = nil
+      @current_entry = nil
     end
 
     private
 
     def finalize_current_entry
-      return unless @currentEntry
+      return unless @current_entry
+
       finish
-      @currentEntry.compressed_size = @output_stream.tell - @currentEntry.local_header_offset - @currentEntry.calculate_local_header_size
-      @currentEntry.size = @compressor.size
-      @currentEntry.crc = @compressor.crc
-      @currentEntry = nil
-      @compressor = NullCompressor.instance
+      @current_entry.compressed_size = @output_stream.tell - \
+                                       @current_entry.local_header_offset - \
+                                       @current_entry.calculate_local_header_size
+      @current_entry.size = @compressor.size
+      @current_entry.crc = @compressor.crc
+      @output_stream << @encrypter.data_descriptor(@current_entry.crc, @current_entry.compressed_size, @current_entry.size)
+      @current_entry.gp_flags |= @encrypter.gp_flags
+      @current_entry = nil
+      @compressor = ::Zip::NullCompressor.instance
     end
 
-    def init_next_entry(entry, level = Zlib::DEFAULT_COMPRESSION)
+    def init_next_entry(entry, level = Zip.default_compression)
       finalize_current_entry
       @entry_set << entry
       entry.write_local_entry(@output_stream)
+      @encrypter.reset!
+      @output_stream << @encrypter.header(entry.mtime)
       @compressor = get_compressor(entry, level)
     end
 
     def get_compressor(entry, level)
       case entry.compression_method
-        when Entry::DEFLATED then Deflater.new(@output_stream, level)
-        when Entry::STORED   then PassThruCompressor.new(@output_stream)
-      else raise ZipCompressionMethodError,
-        "Invalid compression method: '#{entry.compression_method}'"
+      when Entry::DEFLATED
+        ::Zip::Deflater.new(@output_stream, level, @encrypter)
+      when Entry::STORED
+        ::Zip::PassThruCompressor.new(@output_stream)
+      else
+        raise ::Zip::CompressionMethodError,
+              "Invalid compression method: '#{entry.compression_method}'"
       end
     end
 
@@ -146,7 +174,7 @@ module Zip
       pos = @output_stream.pos
       @entry_set.each do |entry|
         @output_stream.pos = entry.local_header_offset
-        entry.write_local_entry(@output_stream)
+        entry.write_local_entry(@output_stream, true)
       end
       @output_stream.pos = pos
     end
@@ -163,9 +191,11 @@ module Zip
     end
 
     public
+
     # Modeled after IO.<<
-    def << (data)
+    def <<(data)
       @compressor << data
+      self
     end
   end
 end

data/lib/zip/pass_thru_compressor.rb

@@ -1,15 +1,15 @@
 module Zip
   class PassThruCompressor < Compressor #:nodoc:all
-    def initialize(outputStream)
+    def initialize(output_stream)
       super()
-      @output_stream = outputStream
-      @crc = Zlib::crc32
+      @output_stream = output_stream
+      @crc = Zlib.crc32
       @size = 0
     end
-    
-    def << (data)
+
+    def <<(data)
       val = data.to_s
-      @crc = Zlib::crc32(val, @crc)
+      @crc = Zlib.crc32(val, @crc)
       @size += val.bytesize
       @output_stream << val
     end

data/lib/zip/pass_thru_decompressor.rb

@@ -1,39 +1,29 @@
 module Zip
-  class PassThruDecompressor < Decompressor  #:nodoc:all
-
-    def initialize(input_stream, chars_to_read)
-      super(input_stream)
-      @chars_to_read = chars_to_read
+  class PassThruDecompressor < Decompressor #:nodoc:all
+    def initialize(*args)
+      super
       @read_so_far = 0
-      @has_returned_empty_string = false
     end
 
-    def sysread(number_of_bytes = nil, buf = nil)
-      if input_finished?
-        has_returned_empty_string_val = @has_returned_empty_string
-        @has_returned_empty_string = true
-        return '' unless has_returned_empty_string_val
-        return
-      end
+    def read(length = nil, outbuf = ''.b)
+      return (length.nil? || length.zero? ? '' : nil) if eof
 
-      if (number_of_bytes == nil || @read_so_far + number_of_bytes > @chars_to_read)
-        number_of_bytes = @chars_to_read - @read_so_far
+      if length.nil? || (@read_so_far + length) > decompressed_size
+        length = decompressed_size - @read_so_far
       end
-      @read_so_far += number_of_bytes
-      @input_stream.read(number_of_bytes, buf)
-    end
 
-    def produce_input
-      sysread(::Zip::Decompressor::CHUNK_SIZE)
+      @read_so_far += length
+      input_stream.read(length, outbuf)
     end
 
-    def input_finished?
-      @read_so_far >= @chars_to_read
+    def eof
+      @read_so_far >= decompressed_size
     end
 
-    alias :eof :input_finished?
-    alias :eof? :input_finished?
+    alias eof? eof
   end
+
+  ::Zip::Decompressor.register(::Zip::COMPRESSION_METHOD_STORE, ::Zip::PassThruDecompressor)
 end
 
 # Copyright (C) 2002, 2003 Thomas Sondergaard

data/lib/zip/streamable_directory.rb

@@ -1,11 +1,11 @@
 module Zip
   class StreamableDirectory < Entry
-    def initialize(zipfile, entry, srcPath = nil, permissionInt = nil)
+    def initialize(zipfile, entry, src_path = nil, permission = nil)
       super(zipfile, entry)
 
       @ftype = :directory
-      entry.get_extra_attributes_from_path(srcPath) if (srcPath)
-      @unix_perms = permissionInt if (permissionInt)
+      entry.get_extra_attributes_from_path(src_path) if src_path
+      @unix_perms = permission if permission
     end
   end
 end

data/lib/zip/streamable_stream.rb

@@ -1,43 +1,48 @@
 module Zip
-  class StreamableStream < DelegateClass(Entry) #nodoc:all
+  class StreamableStream < DelegateClass(Entry) # :nodoc:all
     def initialize(entry)
       super(entry)
-      @tempFile = Tempfile.new(::File.basename(name), ::File.dirname(zipfile))
-      @tempFile.binmode
+      @temp_file = Tempfile.new(::File.basename(name))
+      @temp_file.binmode
     end
 
     def get_output_stream
       if block_given?
         begin
-          yield(@tempFile)
+          yield(@temp_file)
         ensure
-          @tempFile.close
+          @temp_file.close
         end
       else
-        @tempFile
+        @temp_file
       end
     end
 
     def get_input_stream
-      if ! @tempFile.closed?
+      unless @temp_file.closed?
         raise StandardError, "cannot open entry for reading while its open for writing - #{name}"
       end
-      @tempFile.open # reopens tempfile from top
-      @tempFile.binmode
+
+      @temp_file.open # reopens tempfile from top
+      @temp_file.binmode
       if block_given?
         begin
-          yield(@tempFile)
+          yield(@temp_file)
         ensure
-          @tempFile.close
+          @temp_file.close
         end
       else
-        @tempFile
+        @temp_file
       end
     end
-    
-    def write_to_zip_output_stream(aZipOutputStream)
-      aZipOutputStream.put_next_entry(self)
-      get_input_stream { |is| ::Zip::IOExtras.copy_stream(aZipOutputStream, is) }
+
+    def write_to_zip_output_stream(output_stream)
+      output_stream.put_next_entry(self)
+      get_input_stream { |is| ::Zip::IOExtras.copy_stream(output_stream, is) }
+    end
+
+    def clean_up
+      @temp_file.unlink
     end
   end
 end

data/lib/zip/version.rb

@@ -1,3 +1,3 @@
 module Zip
-  VERSION = '1.0.0'
+  VERSION = '2.4.1'
 end

data/lib/zip.rb

@@ -1,9 +1,11 @@
+require 'English'
 require 'delegate'
 require 'singleton'
 require 'tempfile'
 require 'fileutils'
 require 'stringio'
 require 'zlib'
+require 'zip/constants'
 require 'zip/dos_time'
 require 'zip/ioextras'
 require 'rbconfig'
@@ -21,22 +23,59 @@ require 'zip/null_compressor'
 require 'zip/null_input_stream'
 require 'zip/pass_thru_compressor'
 require 'zip/pass_thru_decompressor'
+require 'zip/crypto/decrypted_io'
+require 'zip/crypto/encryption'
+require 'zip/crypto/null_encryption'
+require 'zip/crypto/traditional_encryption'
 require 'zip/inflater'
 require 'zip/deflater'
 require 'zip/streamable_stream'
 require 'zip/streamable_directory'
-require 'zip/constants'
 require 'zip/errors'
 
 module Zip
+  V3_API_WARNING_MSG = <<~END_MSG
+    You have called '%s' (from %s).
+    This method is changing or deprecated in version 3.0.0. Please see
+      https://github.com/rubyzip/rubyzip/wiki/Updating-to-version-3.x
+    for more information.
+  END_MSG
+
+  def self.warn_about_v3_api(method)
+    return unless ENV['RUBYZIP_V3_API_WARN']
+
+    loc = caller_locations(2, 1)[0]
+    from = "#{loc.path.split('/').last}:#{loc.lineno}"
+    warn format(V3_API_WARNING_MSG, method, from)
+  end
+
+  if ENV['RUBYZIP_V3_API_WARN'] && RUBY_VERSION < '3.0'
+    warn 'RubyZip 3.0 will require Ruby 3.0 or later.'
+  end
+
   extend self
-  attr_accessor :unicode_names, :on_exists_proc, :continue_on_exists_proc
+  attr_accessor :unicode_names,
+                :on_exists_proc,
+                :continue_on_exists_proc,
+                :sort_entries,
+                :default_compression,
+                :write_zip64_support,
+                :warn_invalid_date,
+                :case_insensitive_match,
+                :force_entry_names_encoding,
+                :validate_entry_sizes
 
   def reset!
     @_ran_once = false
     @unicode_names = false
     @on_exists_proc = false
     @continue_on_exists_proc = false
+    @sort_entries = false
+    @default_compression = ::Zlib::DEFAULT_COMPRESSION
+    @write_zip64_support = false
+    @warn_invalid_date = true
+    @case_insensitive_match = false
+    @validate_entry_sizes = true
   end
 
   def setup
@@ -49,4 +88,4 @@ end
 
 # Copyright (C) 2002, 2003 Thomas Sondergaard
 # rubyzip is free software; you can redistribute it and/or
-# modify it under the terms of the ruby license.
+# modify it under the terms of the ruby license.

data/samples/example.rb

@@ -1,89 +1,79 @@
 #!/usr/bin/env ruby
 
-$: << "../lib"
-system("zip example.zip example.rb gtkRubyzip.rb")
+$LOAD_PATH << '../lib'
+system('zip example.zip example.rb gtk_ruby_zip.rb')
 
-require 'zip/zip'
+require 'zip'
 
 ####### Using ZipInputStream alone: #######
 
-Zip::InputStream.open("example.zip") {
-  |zis|
+Zip::InputStream.open('example.zip') do |zis|
   entry = zis.get_next_entry
   print "First line of '#{entry.name} (#{entry.size} bytes):  "
   puts "'#{zis.gets.chomp}'"
   entry = zis.get_next_entry
   print "First line of '#{entry.name} (#{entry.size} bytes):  "
   puts "'#{zis.gets.chomp}'"
-}
-
+end
 
 ####### Using ZipFile to read the directory of a zip file: #######
 
-zf = Zip::File.new("example.zip")
-zf.each_with_index {
-  |entry, index|
-  
+zf = Zip::File.new('example.zip')
+zf.each_with_index do |entry, index|
   puts "entry #{index} is #{entry.name}, size = #{entry.size}, compressed size = #{entry.compressed_size}"
   # use zf.get_input_stream(entry) to get a ZipInputStream for the entry
   # entry can be the ZipEntry object or any object which has a to_s method that
   # returns the name of the entry.
-}
-
+end
 
 ####### Using ZipOutputStream to write a zip file: #######
 
-Zip::OutputStream.open("exampleout.zip") {
-  |zos|
-  zos.put_next_entry("the first little entry")
-  zos.puts "Hello hello hello hello hello hello hello hello hello"
+Zip::OutputStream.open('exampleout.zip') do |zos|
+  zos.put_next_entry('the first little entry')
+  zos.puts 'Hello hello hello hello hello hello hello hello hello'
 
-  zos.put_next_entry("the second little entry")
-  zos.puts "Hello again"
+  zos.put_next_entry('the second little entry')
+  zos.puts 'Hello again'
 
   # Use rubyzip or your zip client of choice to verify
   # the contents of exampleout.zip
-}
+end
 
 ####### Using ZipFile to change a zip file: #######
 
-Zip::File.open("exampleout.zip") {
-  |zf|
-  zf.add("thisFile.rb", "example.rb")
-  zf.rename("thisFile.rb", "ILikeThisName.rb")
-  zf.add("Again", "example.rb")
-}
+Zip::File.open('exampleout.zip') do |zip_file|
+  zip_file.add('thisFile.rb', 'example.rb')
+  zip_file.rename('thisFile.rb', 'ILikeThisName.rb')
+  zip_file.add('Again', 'example.rb')
+end
 
 # Lets check
-Zip::File.open("exampleout.zip") {
-  |zf|
-  puts "Changed zip file contains: #{zf.entries.join(', ')}"
-  zf.remove("Again")
-  puts "Without 'Again': #{zf.entries.join(', ')}"
-}
+Zip::File.open('exampleout.zip') do |zip_file|
+  puts "Changed zip file contains: #{zip_file.entries.join(', ')}"
+  zip_file.remove('Again')
+  puts "Without 'Again': #{zip_file.entries.join(', ')}"
+end
 
 ####### Using ZipFile to split a zip file: #######
 
 # Creating large zip file for splitting
-Zip::OutputStream.open("large_zip_file.zip") do |zos|
-  puts "Creating zip file..."
+Zip::OutputStream.open('large_zip_file.zip') do |zos|
+  puts 'Creating zip file...'
   10.times do |i|
     zos.put_next_entry("large_entry_#{i}.txt")
-    zos.puts "Hello" * 104857600
+    zos.puts 'Hello' * 104_857_600
   end
 end
 
 # Splitting created large zip file
-part_zips_count = Zip::File.split("large_zip_file.zip", 2097152, false)
+part_zips_count = Zip::File.split('large_zip_file.zip', 2_097_152, false)
 puts "Zip file splitted in #{part_zips_count} parts"
 
 # Track splitting an archive
-Zip::File.split("large_zip_file.zip", 1048576, true, 'part_zip_file') do
-  |part_count, part_index, chunk_bytes, segment_bytes|
-  puts "#{part_index} of #{part_count} part splitting: #{(chunk_bytes.to_f/segment_bytes.to_f * 100).to_i}%"
+Zip::File.split('large_zip_file.zip', 1_048_576, true, 'part_zip_file') do |part_count, part_index, chunk_bytes, segment_bytes|
+  puts "#{part_index} of #{part_count} part splitting: #{(chunk_bytes.to_f / segment_bytes * 100).to_i}%"
 end
 
-
 # For other examples, look at zip.rb and ziptest.rb
 
 # Copyright (C) 2002 Thomas Sondergaard

data/samples/example_filesystem.rb

@@ -1,30 +1,28 @@
 #!/usr/bin/env ruby
 
-$: << "../lib"
+$LOAD_PATH << '../lib'
 
-require 'zip/zipfilesystem'
+require 'zip/filesystem'
 
-EXAMPLE_ZIP = "filesystem.zip"
+EXAMPLE_ZIP = 'filesystem.zip'
 
-File.delete(EXAMPLE_ZIP) if File.exists?(EXAMPLE_ZIP)
+File.delete(EXAMPLE_ZIP) if File.exist?(EXAMPLE_ZIP)
 
-Zip::File.open(EXAMPLE_ZIP, Zip::File::CREATE) {
-  |zf|
-  zf.file.open("file1.txt", "w") { |os| os.write "first file1.txt" }
-  zf.dir.mkdir("dir1")
-  zf.dir.chdir("dir1")
-  zf.file.open("file1.txt", "w") { |os| os.write "second file1.txt" }
-  puts zf.file.read("file1.txt")
-  puts zf.file.read("../file1.txt")
-  zf.dir.chdir("..")
-  zf.file.open("file2.txt", "w") { |os| os.write "first file2.txt" }
+Zip::File.open(EXAMPLE_ZIP, Zip::File::CREATE) do |zf|
+  zf.file.open('file1.txt', 'w') { |os| os.write 'first file1.txt' }
+  zf.dir.mkdir('dir1')
+  zf.dir.chdir('dir1')
+  zf.file.open('file1.txt', 'w') { |os| os.write 'second file1.txt' }
+  puts zf.file.read('file1.txt')
+  puts zf.file.read('../file1.txt')
+  zf.dir.chdir('..')
+  zf.file.open('file2.txt', 'w') { |os| os.write 'first file2.txt' }
   puts "Entries:                   #{zf.entries.join(', ')}"
-}
+end
 
-Zip::File.open(EXAMPLE_ZIP) {
-  |zf|
+Zip::File.open(EXAMPLE_ZIP) do |zf|
   puts "Entries from reloaded zip: #{zf.entries.join(', ')}"
-}
+end
 
 # For other examples, look at zip.rb and ziptest.rb