rubyzip 2.0.0 → 2.4.1

data/lib/zip/entry.rb

@@ -34,7 +34,7 @@ module Zip
       end
       @follow_symlinks = false
 
-      @restore_times       = true
+      @restore_times       = false
       @restore_permissions = false
       @restore_ownership   = false
       # BUG: need an extra field to support uid/gid's
@@ -48,28 +48,52 @@ module Zip
 
     def check_name(name)
       return unless name.start_with?('/')
+
       raise ::Zip::EntryNameError, "Illegal ZipEntry name '#{name}', name must not start with /"
     end
 
-    def initialize(*args)
-      name = args[1] || ''
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def initialize(zipfile = nil, name = nil, *args)
+      name ||= ''
       check_name(name)
 
       set_default_vars_values
       @fstype = ::Zip::RUNNING_ON_WINDOWS ? ::Zip::FSTYPE_FAT : ::Zip::FSTYPE_UNIX
 
-      @zipfile            = args[0] || ''
+      @zipfile            = zipfile || ''
       @name               = name
-      @comment            = args[2] || ''
-      @extra              = args[3] || ''
-      @compressed_size    = args[4] || 0
-      @crc                = args[5] || 0
-      @compression_method = args[6] || ::Zip::Entry::DEFLATED
-      @size               = args[7] || 0
-      @time               = args[8] || ::Zip::DOSTime.now
+
+      if (args_hash = args.first).kind_of?(::Hash)
+        @comment            = args_hash[:comment] || ''
+        @extra              = args_hash[:extra] || ''
+        @compressed_size    = args_hash[:compressed_size] || 0
+        @crc                = args_hash[:crc] || 0
+        @compression_method = args_hash[:compression_method] || ::Zip::Entry::DEFLATED
+        @size               = args_hash[:size] || 0
+        @time               = args_hash[:time] || ::Zip::DOSTime.now
+      else
+        Zip.warn_about_v3_api('Zip::Entry.new') unless args.empty?
+
+        @comment            = args[0] || ''
+        @extra              = args[1] || ''
+        @compressed_size    = args[2] || 0
+        @crc                = args[3] || 0
+        @compression_method = args[4] || ::Zip::Entry::DEFLATED
+        @size               = args[5] || 0
+        @time               = args[6] || ::Zip::DOSTime.now
+      end
 
       @ftype = name_is_directory? ? :directory : :file
-      @extra = ::Zip::ExtraField.new(@extra.to_s) unless @extra.is_a?(::Zip::ExtraField)
+      @extra = ::Zip::ExtraField.new(@extra.to_s) unless @extra.kind_of?(::Zip::ExtraField)
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    def encrypted?
+      gp_flags & 1 == 1
+    end
+
+    def incomplete?
+      gp_flags & 8 == 8
     end
 
     def time
@@ -91,11 +115,12 @@ module Zip
         @extra.create('UniversalTime')
       end
       (@extra['UniversalTime'] || @extra['NTFS']).mtime = value
-      @time                         = value
+      @time = value
     end
 
     def file_type_is?(type)
       raise InternalError, "current filetype is unknown: #{inspect}" unless @ftype
+
       @ftype == type
     end
 
@@ -116,6 +141,7 @@ module Zip
     def name_safe?
       cleanpath = Pathname.new(@name).cleanpath
       return false unless cleanpath.relative?
+
       root = ::File::SEPARATOR
       naive_expanded_path = ::File.join(root, cleanpath.to_s)
       ::File.absolute_path(cleanpath.to_s, root) == naive_expanded_path
@@ -145,6 +171,7 @@ module Zip
     # that we didn't change the header size (and thus clobber file data or something)
     def verify_local_header_size!
       return if @local_header_size.nil?
+
       new_size = calculate_local_header_size
       raise Error, "local header size changed (#{@local_header_size} -> #{new_size})" if @local_header_size != new_size
     end
@@ -162,20 +189,41 @@ module Zip
     # NB: The caller is responsible for making sure dest_path is safe, if it
     # is passed.
     def extract(dest_path = nil, &block)
+      Zip.warn_about_v3_api('Zip::Entry#extract')
+
       if dest_path.nil? && !name_safe?
-        puts "WARNING: skipped #{@name} as unsafe"
+        warn "WARNING: skipped '#{@name}' as unsafe."
         return self
       end
 
       dest_path ||= @name
       block ||= proc { ::Zip.on_exists_proc }
 
-      if directory? || file? || symlink?
-        __send__("create_#{@ftype}", dest_path, &block)
-      else
-        raise "unknown file type #{inspect}"
+      raise "unknown file type #{inspect}" unless directory? || file? || symlink?
+
+      __send__("create_#{@ftype}", dest_path, &block)
+      self
+    end
+
+    # Extracts this entry to a file at `entry_path`, with
+    # `destination_directory` as the base location in the filesystem.
+    #
+    # NB: The caller is responsible for making sure `destination_directory` is
+    # safe, if it is passed.
+    def extract_v3(entry_path = @name, destination_directory: '.', &block)
+      dest_dir = ::File.absolute_path(destination_directory || '.')
+      extract_path = ::File.absolute_path(::File.join(dest_dir, entry_path))
+
+      unless extract_path.start_with?(dest_dir)
+        warn "WARNING: skipped extracting '#{@name}' to '#{extract_path}' as unsafe."
+        return self
       end
 
+      block ||= proc { ::Zip.on_exists_proc }
+
+      raise "unknown file type #{inspect}" unless directory? || file? || symlink?
+
+      __send__(:"create_#{ftype}", extract_path, &block)
       self
     end
 
@@ -185,15 +233,15 @@ module Zip
 
     class << self
       def read_zip_short(io) # :nodoc:
-        io.read(2).unpack('v')[0]
+        io.read(2).unpack1('v')
       end
 
       def read_zip_long(io) # :nodoc:
-        io.read(4).unpack('V')[0]
+        io.read(4).unpack1('V')
       end
 
       def read_zip_64_long(io) # :nodoc:
-        io.read(8).unpack('Q<')[0]
+        io.read(8).unpack1('Q<')
       end
 
       def read_c_dir_entry(io) #:nodoc:all
@@ -218,8 +266,6 @@ module Zip
       end
     end
 
-    public
-
     def unpack_local_entry(buf)
       @header_signature,
         @version,
@@ -249,6 +295,7 @@ module Zip
       unless @header_signature == ::Zip::LOCAL_ENTRY_SIGNATURE
         raise ::Zip::Error, "Zip local header magic not found at location '#{local_header_offset}'"
       end
+
       set_time(@last_mod_date, @last_mod_time)
 
       @name = io.read(@name_length)
@@ -261,13 +308,14 @@ module Zip
 
       if extra && extra.bytesize != @extra_length
         raise ::Zip::Error, 'Truncated local zip entry header'
+      end
+
+      if @extra.kind_of?(::Zip::ExtraField)
+        @extra.merge(extra) if extra
       else
-        if @extra.is_a?(::Zip::ExtraField)
-          @extra.merge(extra) if extra
-        else
-          @extra = ::Zip::ExtraField.new(extra)
-        end
+        @extra = ::Zip::ExtraField.new(extra)
       end
+
       parse_zip64_extra(true)
       @local_header_size = calculate_local_header_size
     end
@@ -354,21 +402,24 @@ module Zip
 
     def check_c_dir_entry_static_header_length(buf)
       return if buf.bytesize == ::Zip::CDIR_ENTRY_STATIC_HEADER_LENGTH
+
       raise Error, 'Premature end of file. Not enough data for zip cdir entry header'
     end
 
     def check_c_dir_entry_signature
       return if header_signature == ::Zip::CENTRAL_DIRECTORY_ENTRY_SIGNATURE
+
       raise Error, "Zip local header magic not found at location '#{local_header_offset}'"
     end
 
     def check_c_dir_entry_comment_size
       return if @comment && @comment.bytesize == @comment_length
+
       raise ::Zip::Error, 'Truncated cdir zip entry header'
     end
 
     def read_c_dir_extra_field(io)
-      if @extra.is_a?(::Zip::ExtraField)
+      if @extra.kind_of?(::Zip::ExtraField)
         @extra.merge(io.read(@extra_length))
       else
         @extra = ::Zip::ExtraField.new(io.read(@extra_length))
@@ -402,20 +453,25 @@ module Zip
 
     def get_extra_attributes_from_path(path) # :nodoc:
       return if Zip::RUNNING_ON_WINDOWS
+
       stat        = file_stat(path)
       @unix_uid   = stat.uid
       @unix_gid   = stat.gid
       @unix_perms = stat.mode & 0o7777
+      @time = ::Zip::DOSTime.from_time(stat.mtime)
     end
 
-    def set_unix_permissions_on_path(dest_path)
-      # BUG: does not update timestamps into account
+    def set_unix_attributes_on_path(dest_path)
       # ignore setuid/setgid bits by default.  honor if @restore_ownership
       unix_perms_mask = 0o1777
       unix_perms_mask = 0o7777 if @restore_ownership
       ::FileUtils.chmod(@unix_perms & unix_perms_mask, dest_path) if @restore_permissions && @unix_perms
       ::FileUtils.chown(@unix_uid, @unix_gid, dest_path) if @restore_ownership && @unix_uid && @unix_gid && ::Process.egid == 0
-      # File::utimes()
+
+      # Restore the timestamp on a file. This will either have come from the
+      # original source file that was copied into the archive, or from the
+      # creation date of the archive if there was no original source file.
+      ::FileUtils.touch(dest_path, mtime: time) if @restore_times
     end
 
     def set_extra_attributes_on_path(dest_path) # :nodoc:
@@ -423,7 +479,7 @@ module Zip
 
       case @fstype
       when ::Zip::FSTYPE_UNIX
-        set_unix_permissions_on_path(dest_path)
+        set_unix_attributes_on_path(dest_path)
       end
     end
 
@@ -484,11 +540,12 @@ module Zip
 
     def ==(other)
       return false unless other.class == self.class
+
       # Compares contents of local entry and exposed fields
       keys_equal = %w[compression_method crc compressed_size size name extra filepath].all? do |k|
         other.__send__(k.to_sym) == __send__(k.to_sym)
       end
-      keys_equal && time.dos_equals(other.time)
+      keys_equal && time == other.time
     end
 
     def <=>(other)
@@ -514,7 +571,7 @@ module Zip
           raise "unknown @file_type #{@ftype}"
         end
       else
-        zis = ::Zip::InputStream.new(@zipfile, local_header_offset)
+        zis = ::Zip::InputStream.new(@zipfile, offset: local_header_offset)
         zis.instance_variable_set(:@complete_entry, self)
         zis.get_next_entry
         if block_given?
@@ -591,7 +648,7 @@ module Zip
     def set_time(binary_dos_date, binary_dos_time)
       @time = ::Zip::DOSTime.parse_binary_dos_format(binary_dos_date, binary_dos_time)
     rescue ArgumentError
-      warn 'Invalid date/time in zip entry' if ::Zip.warn_invalid_date
+      warn 'WARNING: invalid date/time in zip entry.' if ::Zip.warn_invalid_date
     end
 
     def create_file(dest_path, _continue_on_exists_proc = proc { Zip.continue_on_exists_proc })
@@ -601,30 +658,29 @@ module Zip
       end
       ::File.open(dest_path, 'wb') do |os|
         get_input_stream do |is|
-          set_extra_attributes_on_path(dest_path)
-
           bytes_written = 0
           warned = false
-          buf = ''.dup
+          buf = +''
           while (buf = is.sysread(::Zip::Decompressor::CHUNK_SIZE, buf))
             os << buf
             bytes_written += buf.bytesize
-            if bytes_written > size && !warned
-              message = "Entry #{name} should be #{size}B but is larger when inflated"
-              if ::Zip.validate_entry_sizes
-                raise ::Zip::EntrySizeError, message
-              else
-                puts "WARNING: #{message}"
-                warned = true
-              end
-            end
+            next unless bytes_written > size && !warned
+
+            message = "entry '#{name}' should be #{size}B, but is larger when inflated."
+            raise ::Zip::EntrySizeError, message if ::Zip.validate_entry_sizes
+
+            warn "WARNING: #{message}"
+            warned = true
           end
         end
       end
+
+      set_extra_attributes_on_path(dest_path)
     end
 
     def create_directory(dest_path)
       return if ::File.directory?(dest_path)
+
       if ::File.exist?(dest_path)
         if block_given? && yield(self, dest_path)
           ::FileUtils.rm_f dest_path
@@ -642,13 +698,14 @@ module Zip
     def create_symlink(dest_path)
       # TODO: Symlinks pose security challenges. Symlink support temporarily
       # removed in view of https://github.com/rubyzip/rubyzip/issues/369 .
-      puts "WARNING: skipped symlink #{dest_path}"
+      warn "WARNING: skipped symlink '#{dest_path}'."
     end
 
     # apply missing data from the zip64 extra information field, if present
     # (required when file sizes exceed 2**32, but can be used for all files)
     def parse_zip64_extra(for_local_header) #:nodoc:all
       return if @extra['Zip64'].nil?
+
       if for_local_header
         @size, @compressed_size = @extra['Zip64'].parse(@size, @compressed_size)
       else
@@ -663,6 +720,7 @@ module Zip
     # create a zip64 extra information field if we need one
     def prep_zip64_extra(for_local_header) #:nodoc:all
       return unless ::Zip.write_zip64_support
+
       need_zip64 = @size >= 0xFFFFFFFF || @compressed_size >= 0xFFFFFFFF
       need_zip64 ||= @local_header_offset >= 0xFFFFFFFF unless for_local_header
       if need_zip64

data/lib/zip/entry_set.rb

@@ -50,6 +50,7 @@ module Zip
 
     def ==(other)
       return false unless other.kind_of?(EntrySet)
+
       @entry_set.values == other.entry_set.values
     end
 
@@ -60,6 +61,7 @@ module Zip
     def glob(pattern, flags = ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH | ::File::FNM_EXTGLOB)
       entries.map do |entry|
         next nil unless ::File.fnmatch(pattern, entry.name.chomp('/'), flags)
+
         yield(entry) if block_given?
         entry
       end.compact

data/lib/zip/errors.rb

@@ -7,6 +7,7 @@ module Zip
   class EntrySizeError < Error; end
   class InternalError < Error; end
   class GPFBit3Error < Error; end
+  class DecompressionError < Error; end
 
   # Backwards compatibility with v1 (delete in v2)
   ZipError = Error

data/lib/zip/extra_field/generic.rb

@@ -1,9 +1,9 @@
 module Zip
   class ExtraField::Generic
     def self.register_map
-      if const_defined?(:HEADER_ID)
-        ::Zip::ExtraField::ID_MAP[const_get(:HEADER_ID)] = self
-      end
+      return unless const_defined?(:HEADER_ID)
+
+      ::Zip::ExtraField::ID_MAP[const_get(:HEADER_ID)] = self
     end
 
     def self.name
@@ -12,18 +12,19 @@ module Zip
 
     # return field [size, content] or false
     def initial_parse(binstr)
-      if !binstr
-        # If nil, start with empty.
-        return false
-      elsif binstr[0, 2] != self.class.const_get(:HEADER_ID)
-        $stderr.puts 'Warning: weired extra feild header ID. skip parsing'
+      return false unless binstr
+
+      if binstr[0, 2] != self.class.const_get(:HEADER_ID)
+        warn 'WARNING: weird extra field header ID. Skip parsing it.'
         return false
       end
-      [binstr[2, 2].unpack('v')[0], binstr[4..-1]]
+
+      [binstr[2, 2].unpack1('v'), binstr[4..-1]]
     end
 
     def ==(other)
       return false if self.class != other.class
+
       each do |k, v|
         return false if v != other[k]
       end

data/lib/zip/extra_field/ntfs.rb

@@ -19,6 +19,7 @@ module Zip
 
     def merge(binstr)
       return if binstr.empty?
+
       size, content = initial_parse(binstr)
       (size && content) || return
 
@@ -27,6 +28,7 @@ module Zip
 
       tag1 = tags[1]
       return unless tag1
+
       ntfs_mtime, ntfs_atime, ntfs_ctime = tag1.unpack('Q<Q<Q<')
       ntfs_mtime && @mtime ||= from_ntfs_time(ntfs_mtime)
       ntfs_atime && @atime ||= from_ntfs_time(ntfs_atime)
@@ -49,7 +51,7 @@ module Zip
       # reserved 0 and tag 1
       s = [0, 1].pack('Vv')
 
-      tag1 = ''.force_encoding(Encoding::BINARY)
+      tag1 = ''.b
       if @mtime
         tag1 << [to_ntfs_time(@mtime)].pack('Q<')
         if @atime
@@ -65,12 +67,14 @@ module Zip
 
     def parse_tags(content)
       return {} if content.nil?
+
       tags = {}
       i = 0
       while i < content.bytesize
         tag, size = content[i, 4].unpack('vv')
         i += 4
         break unless tag && size
+
         value = content[i, size]
         i += size
         tags[tag] = value

data/lib/zip/extra_field/old_unix.rb

@@ -16,14 +16,16 @@ module Zip
 
     def merge(binstr)
       return if binstr.empty?
+
       size, content = initial_parse(binstr)
       # size: 0 for central directory. 4 for local header
       return if !size || size == 0
+
       atime, mtime, uid, gid = content.unpack('VVvv')
       @uid ||= uid
       @gid ||= gid
       @atime ||= atime
-      @mtime ||= mtime
+      @mtime ||= mtime # rubocop:disable Naming/MemoizedInstanceVariableName
     end
 
     def ==(other)

data/lib/zip/extra_field/universal_time.rb

@@ -4,24 +4,54 @@ module Zip
     HEADER_ID = 'UT'
     register_map
 
+    ATIME_MASK = 0b010
+    CTIME_MASK = 0b100
+    MTIME_MASK = 0b001
+
     def initialize(binstr = nil)
       @ctime = nil
       @mtime = nil
       @atime = nil
-      @flag  = nil
-      binstr && merge(binstr)
+      @flag  = 0
+
+      merge(binstr) unless binstr.nil?
+    end
+
+    attr_reader :atime, :ctime, :mtime, :flag
+
+    def atime=(time)
+      @flag = time.nil? ? @flag & ~ATIME_MASK : @flag | ATIME_MASK
+      @atime = time
+    end
+
+    def ctime=(time)
+      @flag = time.nil? ? @flag & ~CTIME_MASK : @flag | CTIME_MASK
+      @ctime = time
     end
 
-    attr_accessor :atime, :ctime, :mtime, :flag
+    def mtime=(time)
+      @flag = time.nil? ? @flag & ~MTIME_MASK : @flag | MTIME_MASK
+      @mtime = time
+    end
 
     def merge(binstr)
       return if binstr.empty?
+
       size, content = initial_parse(binstr)
-      size || return
-      @flag, mtime, atime, ctime = content.unpack('CVVV')
-      mtime && @mtime ||= ::Zip::DOSTime.at(mtime)
-      atime && @atime ||= ::Zip::DOSTime.at(atime)
-      ctime && @ctime ||= ::Zip::DOSTime.at(ctime)
+      return if !size || size <= 0
+
+      @flag, *times = content.unpack('Cl<l<l<')
+
+      # Parse the timestamps, in order, based on which flags are set.
+      return if times[0].nil?
+
+      @mtime ||= ::Zip::DOSTime.at(times.shift) unless @flag & MTIME_MASK == 0
+      return if times[0].nil?
+
+      @atime ||= ::Zip::DOSTime.at(times.shift) unless @flag & ATIME_MASK == 0
+      return if times[0].nil?
+
+      @ctime ||= ::Zip::DOSTime.at(times.shift) unless @flag & CTIME_MASK == 0
     end
 
     def ==(other)
@@ -32,15 +62,15 @@ module Zip
 
     def pack_for_local
       s = [@flag].pack('C')
-      @flag & 1 != 0 && s << [@mtime.to_i].pack('V')
-      @flag & 2 != 0 && s << [@atime.to_i].pack('V')
-      @flag & 4 != 0 && s << [@ctime.to_i].pack('V')
+      s << [@mtime.to_i].pack('l<') unless @flag & MTIME_MASK == 0
+      s << [@atime.to_i].pack('l<') unless @flag & ATIME_MASK == 0
+      s << [@ctime.to_i].pack('l<') unless @flag & CTIME_MASK == 0
       s
     end
 
     def pack_for_c_dir
       s = [@flag].pack('C')
-      @flag & 1 == 1 && s << [@mtime.to_i].pack('V')
+      s << [@mtime.to_i].pack('l<') unless @flag & MTIME_MASK == 0
       s
     end
   end

data/lib/zip/extra_field/unix.rb

@@ -14,12 +14,14 @@ module Zip
 
     def merge(binstr)
       return if binstr.empty?
+
       size, content = initial_parse(binstr)
       # size: 0 for central directory. 4 for local header
       return if !size || size == 0
+
       uid, gid = content.unpack('vv')
       @uid ||= uid
-      @gid ||= gid
+      @gid ||= gid # rubocop:disable Naming/MemoizedInstanceVariableName
     end
 
     def ==(other)

data/lib/zip/extra_field/zip64.rb

@@ -9,7 +9,7 @@ module Zip
       # unparsed binary; we don't actually know what this contains
       # without looking for FFs in the associated file header
       # call parse after initializing with a binary string
-      @content = nil
+      @content                = nil
       @original_size          = nil
       @compressed_size        = nil
       @relative_header_offset = nil
@@ -26,6 +26,7 @@ module Zip
 
     def merge(binstr)
       return if binstr.empty?
+
       _, @content = initial_parse(binstr)
     end
 
@@ -45,19 +46,20 @@ module Zip
     end
 
     def extract(size, format)
-      @content.slice!(0, size).unpack(format)[0]
+      @content.slice!(0, size).unpack1(format)
     end
     private :extract
 
     def pack_for_local
       # local header entries must contain original size and compressed size; other fields do not apply
       return '' unless @original_size && @compressed_size
+
       [@original_size, @compressed_size].pack('Q<Q<')
     end
 
     def pack_for_c_dir
       # central directory entries contain only fields that didn't fit in the main entry part
-      packed = ''.force_encoding('BINARY')
+      packed = ''.b
       packed << [@original_size].pack('Q<') if @original_size
       packed << [@compressed_size].pack('Q<') if @compressed_size
       packed << [@relative_header_offset].pack('Q<') if @relative_header_offset

data/lib/zip/extra_field.rb

@@ -6,27 +6,27 @@ module Zip
       merge(binstr) if binstr
     end
 
-    def extra_field_type_exist(binstr, id, len, i)
+    def extra_field_type_exist(binstr, id, len, index)
       field_name = ID_MAP[id].name
       if member?(field_name)
-        self[field_name].merge(binstr[i, len + 4])
+        self[field_name].merge(binstr[index, len + 4])
       else
-        field_obj        = ID_MAP[id].new(binstr[i, len + 4])
+        field_obj        = ID_MAP[id].new(binstr[index, len + 4])
         self[field_name] = field_obj
       end
     end
 
-    def extra_field_type_unknown(binstr, len, i)
+    def extra_field_type_unknown(binstr, len, index)
       create_unknown_item unless self['Unknown']
-      if !len || len + 4 > binstr[i..-1].bytesize
-        self['Unknown'] << binstr[i..-1]
+      if !len || len + 4 > binstr[index..-1].bytesize
+        self['Unknown'] << binstr[index..-1]
         return
       end
-      self['Unknown'] << binstr[i, len + 4]
+      self['Unknown'] << binstr[index, len + 4]
     end
 
     def create_unknown_item
-      s = ''.dup
+      s = +''
       class << s
         alias_method :to_c_dir_bin, :to_s
         alias_method :to_local_bin, :to_s
@@ -36,10 +36,11 @@ module Zip
 
     def merge(binstr)
       return if binstr.empty?
+
       i = 0
       while i < binstr.bytesize
         id  = binstr[i, 2]
-        len = binstr[i + 2, 2].to_s.unpack('v').first
+        len = binstr[i + 2, 2].to_s.unpack1('v')
         if id && ID_MAP.member?(id)
           extra_field_type_exist(binstr, id, len, i)
         elsif id
@@ -54,6 +55,7 @@ module Zip
       unless (field_class = ID_MAP.values.find { |k| k.name == name })
         raise Error, "Unknown extra field '#{name}'"
       end
+
       self[name] = field_class.new
     end