rubyzip 2.4.1 → 3.0.0.rc1

data/lib/zip/entry.rb

@@ -1,21 +1,44 @@
+# frozen_string_literal: true
+
 require 'pathname'
+
+require_relative 'dirtyable'
+
 module Zip
+  # Zip::Entry represents an entry in a Zip archive.
   class Entry
-    STORED   = 0
-    DEFLATED = 8
+    include Dirtyable
+
+    # Constant used to specify that the entry is stored (i.e., not compressed).
+    STORED   = ::Zip::COMPRESSION_METHOD_STORE
+
+    # Constant used to specify that the entry is deflated (i.e., compressed).
+    DEFLATED = ::Zip::COMPRESSION_METHOD_DEFLATE
+
     # Language encoding flag (EFS) bit
-    EFS = 0b100000000000
-
-    attr_accessor :comment, :compressed_size, :crc, :extra, :compression_method,
-                  :name, :size, :local_header_offset, :zipfile, :fstype, :external_file_attributes,
-                  :internal_file_attributes,
-                  :gp_flags, :header_signature, :follow_symlinks,
-                  :restore_times, :restore_permissions, :restore_ownership,
-                  :unix_uid, :unix_gid, :unix_perms,
-                  :dirty
-    attr_reader :ftype, :filepath # :nodoc:
-
-    def set_default_vars_values
+    EFS = 0b100000000000 # :nodoc:
+
+    # Compression level flags (used as part of the gp flags).
+    COMPRESSION_LEVEL_SUPERFAST_GPFLAG = 0b110 # :nodoc:
+    COMPRESSION_LEVEL_FAST_GPFLAG = 0b100      # :nodoc:
+    COMPRESSION_LEVEL_MAX_GPFLAG = 0b010       # :nodoc:
+
+    attr_accessor :comment, :compressed_size, :follow_symlinks, :name,
+                  :restore_ownership, :restore_permissions, :restore_times,
+                  :unix_gid, :unix_perms, :unix_uid
+
+    attr_accessor :crc, :external_file_attributes, :fstype, :gp_flags,
+                  :internal_file_attributes, :local_header_offset # :nodoc:
+
+    attr_reader :extra, :compression_level, :filepath # :nodoc:
+
+    attr_writer :size # :nodoc:
+
+    mark_dirty :comment=, :compressed_size=, :external_file_attributes=,
+               :fstype=, :gp_flags=, :name=, :size=,
+               :unix_gid=, :unix_perms=, :unix_uid=
+
+    def set_default_vars_values # :nodoc:
       @local_header_offset      = 0
       @local_header_size        = nil # not known until local entry is created or read
       @internal_file_attributes = 1
@@ -34,175 +57,222 @@ module Zip
       end
       @follow_symlinks = false
 
-      @restore_times       = false
-      @restore_permissions = false
-      @restore_ownership   = false
+      @restore_times       = DEFAULT_RESTORE_OPTIONS[:restore_times]
+      @restore_permissions = DEFAULT_RESTORE_OPTIONS[:restore_permissions]
+      @restore_ownership   = DEFAULT_RESTORE_OPTIONS[:restore_ownership]
       # BUG: need an extra field to support uid/gid's
       @unix_uid            = nil
       @unix_gid            = nil
       @unix_perms          = nil
-      # @posix_acl = nil
-      # @ntfs_acl = nil
-      @dirty               = false
     end
 
-    def check_name(name)
-      return unless name.start_with?('/')
-
-      raise ::Zip::EntryNameError, "Illegal ZipEntry name '#{name}', name must not start with /"
+    def check_name(name) # :nodoc:
+      raise EntryNameError, name if name.start_with?('/')
+      raise EntryNameError if name.length > 65_535
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    def initialize(zipfile = nil, name = nil, *args)
-      name ||= ''
-      check_name(name)
+    # Create a new Zip::Entry.
+    def initialize(
+      zipfile = '', name = '',
+      comment: '', size: nil, compressed_size: 0, crc: 0,
+      compression_method: DEFLATED,
+      compression_level: ::Zip.default_compression,
+      time: ::Zip::DOSTime.now, extra: ::Zip::ExtraField.new
+    )
+      super()
+      @name = name
+      check_name(@name)
 
       set_default_vars_values
       @fstype = ::Zip::RUNNING_ON_WINDOWS ? ::Zip::FSTYPE_FAT : ::Zip::FSTYPE_UNIX
 
-      @zipfile            = zipfile || ''
-      @name               = name
-
-      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.kind_of?(::Zip::ExtraField)
-    end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
+      @zipfile            = zipfile
+      @comment            = comment || ''
+      @compression_method = compression_method || DEFLATED
+      @compression_level  = compression_level || ::Zip.default_compression
+      @compressed_size    = compressed_size || 0
+      @crc                = crc || 0
+      @size               = size
+      @time               = case time
+                            when ::Zip::DOSTime
+                              time
+                            when Time
+                              ::Zip::DOSTime.from_time(time)
+                            else
+                              ::Zip::DOSTime.now
+                            end
+      @extra              =
+        extra.kind_of?(ExtraField) ? extra : ExtraField.new(extra.to_s)
+
+      set_compression_level_flags
+    end
+
+    # Is this entry encrypted?
     def encrypted?
       gp_flags & 1 == 1
     end
 
-    def incomplete?
+    def incomplete? # :nodoc:
       gp_flags & 8 == 8
     end
 
-    def time
-      if @extra['UniversalTime']
-        @extra['UniversalTime'].mtime
-      elsif @extra['NTFS']
-        @extra['NTFS'].mtime
-      else
-        # Standard time field in central directory has local time
-        # under archive creator. Then, we can't get timezone.
-        @time
-      end
+    # The uncompressed size of the entry.
+    def size
+      @size || 0
+    end
+
+    # Get a timestamp component of this entry.
+    #
+    # Returns modification time by default.
+    def time(component: :mtime)
+      time =
+        if @extra['UniversalTime']
+          @extra['UniversalTime'].send(component)
+        elsif @extra['NTFS']
+          @extra['NTFS'].send(component)
+        end
+
+      # Standard time field in central directory has local time
+      # under archive creator. Then, we can't get timezone.
+      time || (@time if component == :mtime)
     end
 
     alias mtime time
 
-    def time=(value)
+    # Get the last access time of this entry, if available.
+    def atime
+      time(component: :atime)
+    end
+
+    # Get the creation time of this entry, if available.
+    def ctime
+      time(component: :ctime)
+    end
+
+    # Set a timestamp component of this entry.
+    #
+    # Sets modification time by default.
+    def time=(value, component: :mtime)
+      @dirty = true
       unless @extra.member?('UniversalTime') || @extra.member?('NTFS')
         @extra.create('UniversalTime')
       end
-      (@extra['UniversalTime'] || @extra['NTFS']).mtime = value
-      @time = value
+
+      value = DOSTime.from_time(value)
+      comp = "#{component}=" unless component.to_s.end_with?('=')
+      (@extra['UniversalTime'] || @extra['NTFS']).send(comp, value)
+      @time = value if component == :mtime
     end
 
-    def file_type_is?(type)
-      raise InternalError, "current filetype is unknown: #{inspect}" unless @ftype
+    alias mtime= time=
+
+    # Set the last access time of this entry.
+    def atime=(value)
+      send(:time=, value, component: :atime)
+    end
+
+    # Set the creation time of this entry.
+    def ctime=(value)
+      send(:time=, value, component: :ctime)
+    end
 
-      @ftype == type
+    # Does this entry return time fields with accurate timezone information?
+    def absolute_time?
+      @extra.member?('UniversalTime') || @extra.member?('NTFS')
+    end
+
+    # Return the compression method for this entry.
+    #
+    # Returns STORED if the entry is a directory or if the compression
+    # level is 0.
+    def compression_method
+      return STORED if ftype == :directory || @compression_level == 0
+
+      @compression_method
+    end
+
+    # Set the compression method for this entry.
+    def compression_method=(method)
+      @dirty = true
+      @compression_method = (ftype == :directory ? STORED : method)
+    end
+
+    # Does this entry use the ZIP64 extensions?
+    def zip64?
+      !@extra['Zip64'].nil?
+    end
+
+    def file_type_is?(type) # :nodoc:
+      ftype == type
+    end
+
+    def ftype # :nodoc:
+      @ftype ||= name_is_directory? ? :directory : :file
     end
 
     # Dynamic checkers
     %w[directory file symlink].each do |k|
-      define_method "#{k}?" do
+      define_method :"#{k}?" do
         file_type_is?(k.to_sym)
       end
     end
 
-    def name_is_directory? #:nodoc:all
+    def name_is_directory? # :nodoc:
       @name.end_with?('/')
     end
 
     # Is the name a relative path, free of `..` patterns that could lead to
     # path traversal attacks? This does NOT handle symlinks; if the path
     # contains symlinks, this check is NOT enough to guarantee safety.
-    def name_safe?
+    def name_safe? # :nodoc:
       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
+      naive = ::File.join(root, cleanpath.to_s)
+      # Allow for Windows drive mappings at the root.
+      ::File.absolute_path(cleanpath.to_s, root).match?(/([A-Z]:)?#{naive}/i)
     end
 
-    def local_entry_offset #:nodoc:all
+    def local_entry_offset # :nodoc:
       local_header_offset + @local_header_size
     end
 
-    def name_size
+    def name_size # :nodoc:
       @name ? @name.bytesize : 0
     end
 
-    def extra_size
+    def extra_size # :nodoc:
       @extra ? @extra.local_size : 0
     end
 
-    def comment_size
+    def comment_size # :nodoc:
       @comment ? @comment.bytesize : 0
     end
 
-    def calculate_local_header_size #:nodoc:all
+    def calculate_local_header_size # :nodoc:
       LOCAL_ENTRY_STATIC_HEADER_LENGTH + name_size + extra_size
     end
 
     # check before rewriting an entry (after file sizes are known)
     # that we didn't change the header size (and thus clobber file data or something)
-    def verify_local_header_size!
+    def verify_local_header_size! # :nodoc:
       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
+      return unless @local_header_size != new_size
+
+      raise Error,
+            "Local header size changed (#{@local_header_size} -> #{new_size})"
     end
 
-    def cdir_header_size #:nodoc:all
+    def cdir_header_size # :nodoc:
       CDIR_ENTRY_STATIC_HEADER_LENGTH + name_size +
         (@extra ? @extra.c_dir_size : 0) + comment_size
     end
 
-    def next_header_offset #:nodoc:all
-      local_entry_offset + compressed_size + data_descriptor_size
-    end
-
-    # Extracts entry to file dest_path (defaults to @name).
-    # 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?
-        warn "WARNING: skipped '#{@name}' as unsafe."
-        return self
-      end
-
-      dest_path ||= @name
-      block ||= proc { ::Zip.on_exists_proc }
-
-      raise "unknown file type #{inspect}" unless directory? || file? || symlink?
-
-      __send__("create_#{@ftype}", dest_path, &block)
-      self
+    def next_header_offset # :nodoc:
+      local_entry_offset + compressed_size
     end
 
     # Extracts this entry to a file at `entry_path`, with
@@ -210,7 +280,7 @@ module Zip
     #
     # 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)
+    def extract(entry_path = @name, destination_directory: '.', &block)
       dest_dir = ::File.absolute_path(destination_directory || '.')
       extract_path = ::File.absolute_path(::File.join(dest_dir, entry_path))
 
@@ -227,24 +297,12 @@ module Zip
       self
     end
 
-    def to_s
+    def to_s # :nodoc:
       @name
     end
 
     class << self
-      def read_zip_short(io) # :nodoc:
-        io.read(2).unpack1('v')
-      end
-
-      def read_zip_long(io) # :nodoc:
-        io.read(4).unpack1('V')
-      end
-
-      def read_zip_64_long(io) # :nodoc:
-        io.read(8).unpack1('Q<')
-      end
-
-      def read_c_dir_entry(io) #:nodoc:all
+      def read_c_dir_entry(io) # :nodoc:
         path = if io.respond_to?(:path)
                  io.path
                else
@@ -257,16 +315,18 @@ module Zip
         nil
       end
 
-      def read_local_entry(io)
+      def read_local_entry(io) # :nodoc:
         entry = new(io)
         entry.read_local_entry(io)
         entry
+      rescue SplitArchiveError
+        raise
       rescue Error
         nil
       end
     end
 
-    def unpack_local_entry(buf)
+    def unpack_local_entry(buf) # :nodoc:
       @header_signature,
         @version,
         @fstype,
@@ -281,7 +341,8 @@ module Zip
         @extra_length = buf.unpack('VCCvvvvVVVvv')
     end
 
-    def read_local_entry(io) #:nodoc:all
+    def read_local_entry(io) # :nodoc:
+      @dirty = false # No changes at this point.
       @local_header_offset = io.tell
 
       static_sized_fields_buf = io.read(::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH) || ''
@@ -292,51 +353,53 @@ module Zip
 
       unpack_local_entry(static_sized_fields_buf)
 
-      unless @header_signature == ::Zip::LOCAL_ENTRY_SIGNATURE
-        raise ::Zip::Error, "Zip local header magic not found at location '#{local_header_offset}'"
+      unless @header_signature == LOCAL_ENTRY_SIGNATURE
+        if @header_signature == SPLIT_FILE_SIGNATURE
+          raise SplitArchiveError
+        end
+
+        raise 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)
-      extra = io.read(@extra_length)
-
-      @name.tr!('\\', '/')
       if ::Zip.force_entry_names_encoding
         @name.force_encoding(::Zip.force_entry_names_encoding)
       end
+      @name.tr!('\\', '/') # Normalise filepath separators after encoding set.
+
+      # We need to do this here because `initialize` has so many side-effects.
+      # :-(
+      @ftype = name_is_directory? ? :directory : :file
 
+      extra = io.read(@extra_length)
       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
-        @extra = ::Zip::ExtraField.new(extra)
-      end
-
+      read_extra_field(extra, local: true)
       parse_zip64_extra(true)
       @local_header_size = calculate_local_header_size
     end
 
-    def pack_local_entry
+    def pack_local_entry # :nodoc:
       zip64 = @extra['Zip64']
       [::Zip::LOCAL_ENTRY_SIGNATURE,
        @version_needed_to_extract, # version needed to extract
        @gp_flags, # @gp_flags
-       @compression_method,
+       compression_method,
        @time.to_binary_dos_time, # @last_mod_time
        @time.to_binary_dos_date, # @last_mod_date
        @crc,
        zip64 && zip64.compressed_size ? 0xFFFFFFFF : @compressed_size,
-       zip64 && zip64.original_size ? 0xFFFFFFFF : @size,
+       zip64 && zip64.original_size ? 0xFFFFFFFF : (@size || 0),
        name_size,
        @extra ? @extra.local_size : 0].pack('VvvvvvVVVvv')
     end
 
-    def write_local_entry(io, rewrite = false) #:nodoc:all
-      prep_zip64_extra(true)
+    def write_local_entry(io, rewrite: false) # :nodoc:
+      prep_local_zip64_extra
       verify_local_header_size! if rewrite
       @local_header_offset = io.tell
 
@@ -347,7 +410,7 @@ module Zip
       @local_header_size = io.tell - @local_header_offset
     end
 
-    def unpack_c_dir_entry(buf)
+    def unpack_c_dir_entry(buf) # :nodoc:
       @header_signature,
         @version, # version of encoding software
         @fstype, # filesystem type
@@ -371,7 +434,7 @@ module Zip
         @comment = buf.unpack('VCCvvvvvVVVvvvvvVV')
     end
 
-    def set_ftype_from_c_dir_entry
+    def set_ftype_from_c_dir_entry # :nodoc:
       @ftype = case @fstype
                when ::Zip::FSTYPE_UNIX
                  @unix_perms = (@external_file_attributes >> 16) & 0o7777
@@ -383,8 +446,9 @@ module Zip
                  when ::Zip::FILE_TYPE_SYMLINK
                    :symlink
                  else
-                   # best case guess for whether it is a file or not
-                   # Otherwise this would be set to unknown and that entry would never be able to extracted
+                   # Best case guess for whether it is a file or not.
+                   # Otherwise this would be set to unknown and that
+                   # entry would never be able to be extracted.
                    if name_is_directory?
                      :directory
                    else
@@ -400,43 +464,47 @@ module Zip
                end
     end
 
-    def check_c_dir_entry_static_header_length(buf)
-      return if buf.bytesize == ::Zip::CDIR_ENTRY_STATIC_HEADER_LENGTH
+    def check_c_dir_entry_static_header_length(buf) # :nodoc:
+      return unless buf.nil? || 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
+    def check_c_dir_entry_signature # :nodoc:
+      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
+    def check_c_dir_entry_comment_size # :nodoc:
       return if @comment && @comment.bytesize == @comment_length
 
       raise ::Zip::Error, 'Truncated cdir zip entry header'
     end
 
-    def read_c_dir_extra_field(io)
+    def read_extra_field(buf, local: false) # :nodoc:
       if @extra.kind_of?(::Zip::ExtraField)
-        @extra.merge(io.read(@extra_length))
+        @extra.merge(buf, local: local) if buf
       else
-        @extra = ::Zip::ExtraField.new(io.read(@extra_length))
+        @extra = ::Zip::ExtraField.new(buf, local: local)
       end
     end
 
-    def read_c_dir_entry(io) #:nodoc:all
+    def read_c_dir_entry(io) # :nodoc:
+      @dirty = false # No changes at this point.
       static_sized_fields_buf = io.read(::Zip::CDIR_ENTRY_STATIC_HEADER_LENGTH)
       check_c_dir_entry_static_header_length(static_sized_fields_buf)
       unpack_c_dir_entry(static_sized_fields_buf)
       check_c_dir_entry_signature
       set_time(@last_mod_date, @last_mod_time)
+
       @name = io.read(@name_length)
       if ::Zip.force_entry_names_encoding
         @name.force_encoding(::Zip.force_entry_names_encoding)
       end
-      read_c_dir_extra_field(io)
+      @name.tr!('\\', '/') # Normalise filepath separators after encoding set.
+
+      read_extra_field(io.read(@extra_length))
       @comment = io.read(@comment_length)
       check_c_dir_entry_comment_size
       set_ftype_from_c_dir_entry
@@ -452,27 +520,27 @@ module Zip
     end
 
     def get_extra_attributes_from_path(path) # :nodoc:
-      return if Zip::RUNNING_ON_WINDOWS
+      stat = file_stat(path)
+      @time = DOSTime.from_time(stat.mtime)
+      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_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
-
-      # 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
+    # rubocop:disable Style/GuardClause
+    def set_unix_attributes_on_path(dest_path) # :nodoc:
+      # Ignore setuid/setgid bits by default. Honour if @restore_ownership.
+      unix_perms_mask = (@restore_ownership ? 0o7777 : 0o1777)
+      if @restore_permissions && @unix_perms
+        ::FileUtils.chmod(@unix_perms & unix_perms_mask, dest_path)
+      end
+      if @restore_ownership && @unix_uid && @unix_gid && ::Process.egid == 0
+        ::FileUtils.chown(@unix_uid, @unix_gid, dest_path)
+      end
     end
+    # rubocop:enable Style/GuardClause
 
     def set_extra_attributes_on_path(dest_path) # :nodoc:
       return unless file? || directory?
@@ -481,9 +549,14 @@ module Zip
       when ::Zip::FSTYPE_UNIX
         set_unix_attributes_on_path(dest_path)
       end
+
+      # 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 pack_c_dir_entry
+    def pack_c_dir_entry # :nodoc:
       zip64 = @extra['Zip64']
       [
         @header_signature,
@@ -491,12 +564,12 @@ module Zip
         @fstype, # filesystem type
         @version_needed_to_extract, # @versionNeededToExtract
         @gp_flags, # @gp_flags
-        @compression_method,
+        compression_method,
         @time.to_binary_dos_time, # @last_mod_time
         @time.to_binary_dos_date, # @last_mod_date
         @crc,
         zip64 && zip64.compressed_size ? 0xFFFFFFFF : @compressed_size,
-        zip64 && zip64.original_size ? 0xFFFFFFFF : @size,
+        zip64 && zip64.original_size ? 0xFFFFFFFF : (@size || 0),
         name_size,
         @extra ? @extra.c_dir_size : 0,
         comment_size,
@@ -510,11 +583,12 @@ module Zip
       ].pack('VCCvvvvvVVVvvvvvVV')
     end
 
-    def write_c_dir_entry(io) #:nodoc:all
-      prep_zip64_extra(false)
+    def write_c_dir_entry(io) # :nodoc:
+      prep_cdir_zip64_extra
+
       case @fstype
       when ::Zip::FSTYPE_UNIX
-        ft = case @ftype
+        ft = case ftype
              when :file
                @unix_perms ||= 0o644
                ::Zip::FILE_TYPE_FILE
@@ -527,7 +601,7 @@ module Zip
              end
 
         unless ft.nil?
-          @external_file_attributes = (ft << 12 | (@unix_perms & 0o7777)) << 16
+          @external_file_attributes = ((ft << 12) | (@unix_perms & 0o7777)) << 16
         end
       end
 
@@ -538,43 +612,42 @@ module Zip
       io << @comment
     end
 
-    def ==(other)
+    def ==(other) # :nodoc:
       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|
+      %w[compression_method crc compressed_size size name extra filepath time].all? do |k|
         other.__send__(k.to_sym) == __send__(k.to_sym)
       end
-      keys_equal && time == other.time
     end
 
-    def <=>(other)
+    def <=>(other) # :nodoc:
       to_s <=> other.to_s
     end
 
     # Returns an IO like object for the given ZipEntry.
     # Warning: may behave weird with symlinks.
     def get_input_stream(&block)
-      if @ftype == :directory
-        yield ::Zip::NullInputStream if block_given?
+      if ftype == :directory
+        yield ::Zip::NullInputStream if block
         ::Zip::NullInputStream
       elsif @filepath
-        case @ftype
+        case ftype
         when :file
           ::File.open(@filepath, 'rb', &block)
         when :symlink
           linkpath = ::File.readlink(@filepath)
           stringio = ::StringIO.new(linkpath)
-          yield(stringio) if block_given?
+          yield(stringio) if block
           stringio
         else
-          raise "unknown @file_type #{@ftype}"
+          raise "unknown @file_type #{ftype}"
         end
       else
         zis = ::Zip::InputStream.new(@zipfile, offset: local_header_offset)
         zis.instance_variable_set(:@complete_entry, self)
         zis.get_next_entry
-        if block_given?
+        if block
           begin
             yield(zis)
           ensure
@@ -593,7 +666,7 @@ module Zip
                  if name_is_directory?
                    raise ArgumentError,
                          "entry name '#{newEntry}' indicates directory entry, but " \
-                             "'#{src_path}' is not a directory"
+                         "'#{src_path}' is not a directory"
                  end
                  :file
                when 'directory'
@@ -603,7 +676,7 @@ module Zip
                  if name_is_directory?
                    raise ArgumentError,
                          "entry name '#{newEntry}' indicates directory entry, but " \
-                             "'#{src_path}' is not a directory"
+                         "'#{src_path}' is not a directory"
                  end
                  :symlink
                else
@@ -611,27 +684,30 @@ module Zip
                end
 
       @filepath = src_path
+      @size = stat.size
       get_extra_attributes_from_path(@filepath)
     end
 
-    def write_to_zip_output_stream(zip_output_stream) #:nodoc:all
-      if @ftype == :directory
-        zip_output_stream.put_next_entry(self, nil, nil, ::Zip::Entry::STORED)
+    def write_to_zip_output_stream(zip_output_stream) # :nodoc:
+      if ftype == :directory
+        zip_output_stream.put_next_entry(self)
       elsif @filepath
-        zip_output_stream.put_next_entry(self, nil, nil, compression_method || ::Zip::Entry::DEFLATED)
-        get_input_stream { |is| ::Zip::IOExtras.copy_stream(zip_output_stream, is) }
+        zip_output_stream.put_next_entry(self)
+        get_input_stream do |is|
+          ::Zip::IOExtras.copy_stream(zip_output_stream, is)
+        end
       else
         zip_output_stream.copy_raw_entry(self)
       end
     end
 
-    def parent_as_string
+    def parent_as_string # :nodoc:
       entry_name  = name.chomp('/')
       slash_index = entry_name.rindex('/')
       slash_index ? entry_name.slice(0, slash_index + 1) : nil
     end
 
-    def get_raw_input_stream(&block)
+    def get_raw_input_stream(&block) # :nodoc:
       if @zipfile.respond_to?(:seek) && @zipfile.respond_to?(:read)
         yield @zipfile
       else
@@ -639,8 +715,8 @@ module Zip
       end
     end
 
-    def clean_up
-      # By default, do nothing
+    def clean_up # :nodoc:
+      @dirty = false # Any changes are written at this point.
     end
 
     private
@@ -653,9 +729,9 @@ module Zip
 
     def create_file(dest_path, _continue_on_exists_proc = proc { Zip.continue_on_exists_proc })
       if ::File.exist?(dest_path) && !yield(self, dest_path)
-        raise ::Zip::DestinationFileExistsError,
-              "Destination '#{dest_path}' already exists"
+        raise ::Zip::DestinationExistsError, dest_path
       end
+
       ::File.open(dest_path, 'wb') do |os|
         get_input_stream do |is|
           bytes_written = 0
@@ -666,10 +742,10 @@ module Zip
             bytes_written += buf.bytesize
             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
+            error = ::Zip::EntrySizeError.new(self)
+            raise error if ::Zip.validate_entry_sizes
 
-            warn "WARNING: #{message}"
+            warn "WARNING: #{error.message}"
             warned = true
           end
         end
@@ -682,14 +758,11 @@ module Zip
       return if ::File.directory?(dest_path)
 
       if ::File.exist?(dest_path)
-        if block_given? && yield(self, dest_path)
-          ::FileUtils.rm_f dest_path
-        else
-          raise ::Zip::DestinationFileExistsError,
-                "Cannot create directory '#{dest_path}'. " \
-                    'A file already exists with that name'
-        end
+        raise ::Zip::DestinationExistsError, dest_path unless block_given? && yield(self, dest_path)
+
+        ::FileUtils.rm_f dest_path
       end
+
       ::FileUtils.mkdir_p(dest_path)
       set_extra_attributes_on_path(dest_path)
     end
@@ -703,53 +776,71 @@ module Zip
 
     # 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?
+    def parse_zip64_extra(for_local_header) # :nodoc:
+      return unless zip64?
 
       if for_local_header
         @size, @compressed_size = @extra['Zip64'].parse(@size, @compressed_size)
       else
-        @size, @compressed_size, @local_header_offset = @extra['Zip64'].parse(@size, @compressed_size, @local_header_offset)
+        @size, @compressed_size, @local_header_offset = @extra['Zip64'].parse(
+          @size, @compressed_size, @local_header_offset
+        )
       end
     end
 
-    def data_descriptor_size
-      (@gp_flags & 0x0008) > 0 ? 16 : 0
+    # For DEFLATED compression *only*: set the general purpose flags 1 and 2 to
+    # indicate compression level. This seems to be mainly cosmetic but they are
+    # generally set by other tools - including in docx files. It is these flags
+    # that are used by commandline tools (and elsewhere) to give an indication
+    # of how compressed a file is. See the PKWARE APPNOTE for more information:
+    # https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT
+    #
+    # It's safe to simply OR these flags here as compression_level is read only.
+    def set_compression_level_flags
+      return unless compression_method == DEFLATED
+
+      case @compression_level
+      when 1
+        @gp_flags |= COMPRESSION_LEVEL_SUPERFAST_GPFLAG
+      when 2
+        @gp_flags |= COMPRESSION_LEVEL_FAST_GPFLAG
+      when 8, 9
+        @gp_flags |= COMPRESSION_LEVEL_MAX_GPFLAG
+      end
     end
 
-    # create a zip64 extra information field if we need one
-    def prep_zip64_extra(for_local_header) #:nodoc:all
+    # rubocop:disable Style/GuardClause
+    def prep_local_zip64_extra
       return unless ::Zip.write_zip64_support
+      return if (!zip64? && @size && @size < 0xFFFFFFFF) || !file?
 
-      need_zip64 = @size >= 0xFFFFFFFF || @compressed_size >= 0xFFFFFFFF
-      need_zip64 ||= @local_header_offset >= 0xFFFFFFFF unless for_local_header
-      if need_zip64
+      # Might not know size here, so need ZIP64 just in case.
+      # If we already have a ZIP64 extra (placeholder) then we must fill it in.
+      if zip64? || @size.nil? || @size >= 0xFFFFFFFF || @compressed_size >= 0xFFFFFFFF
         @version_needed_to_extract = VERSION_NEEDED_TO_EXTRACT_ZIP64
-        @extra.delete('Zip64Placeholder')
-        zip64 = @extra.create('Zip64')
-        if for_local_header
-          # local header always includes size and compressed size
-          zip64.original_size = @size
-          zip64.compressed_size = @compressed_size
-        else
-          # central directory entry entries include whichever fields are necessary
-          zip64.original_size = @size if @size >= 0xFFFFFFFF
-          zip64.compressed_size = @compressed_size if @compressed_size >= 0xFFFFFFFF
-          zip64.relative_header_offset = @local_header_offset if @local_header_offset >= 0xFFFFFFFF
-        end
-      else
-        @extra.delete('Zip64')
+        zip64 = @extra['Zip64'] || @extra.create('Zip64')
 
-        # if this is a local header entry, create a placeholder
-        # so we have room to write a zip64 extra field afterward
-        # (we won't know if it's needed until the file data is written)
-        if for_local_header
-          @extra.create('Zip64Placeholder')
-        else
-          @extra.delete('Zip64Placeholder')
-        end
+        # Local header always includes size and compressed size.
+        zip64.original_size = @size || 0
+        zip64.compressed_size = @compressed_size
+      end
+    end
+
+    def prep_cdir_zip64_extra
+      return unless ::Zip.write_zip64_support
+
+      if (@size && @size >= 0xFFFFFFFF) || @compressed_size >= 0xFFFFFFFF ||
+         @local_header_offset >= 0xFFFFFFFF
+        @version_needed_to_extract = VERSION_NEEDED_TO_EXTRACT_ZIP64
+        zip64 = @extra['Zip64'] || @extra.create('Zip64')
+
+        # Central directory entry entries include whichever fields are necessary.
+        zip64.original_size = @size if @size && @size >= 0xFFFFFFFF
+        zip64.compressed_size = @compressed_size if @compressed_size >= 0xFFFFFFFF
+        zip64.relative_header_offset = @local_header_offset if @local_header_offset >= 0xFFFFFFFF
       end
     end
+    # rubocop:enable Style/GuardClause
   end
 end