rubyzip 1.0.0 → 1.2.0

data/lib/zip/deflater.rb

@@ -1,23 +1,28 @@
 module Zip
   class Deflater < Compressor #:nodoc:all
-
-    def initialize(output_stream, level = ::Zlib::DEFAULT_COMPRESSION)
+    def initialize(output_stream, level = Zip.default_compression, encrypter = NullEncrypter.new)
       super()
       @output_stream = output_stream
       @zlib_deflater = ::Zlib::Deflate.new(level, -::Zlib::MAX_WBITS)
       @size          = 0
       @crc           = ::Zlib.crc32
+      @encrypter     = encrypter
     end
 
-    def << (data)
+    def <<(data)
       val   = data.to_s
-      @crc  = Zlib::crc32(val, @crc)
+      @crc  = Zlib.crc32(val, @crc)
       @size += val.bytesize
-      @output_stream << @zlib_deflater.deflate(data)
+      buffer = @zlib_deflater.deflate(data)
+      if buffer.empty?
+        @output_stream
+      else
+        @output_stream << @encrypter.encrypt(buffer)
+      end
     end
 
     def finish
-      @output_stream << @zlib_deflater.finish until @zlib_deflater.finished?
+      @output_stream << @encrypter.encrypt(@zlib_deflater.finish) until @zlib_deflater.finished?
     end
 
     attr_reader :size, :crc

data/lib/zip/dos_time.rb

@@ -1,7 +1,6 @@
 module Zip
   class DOSTime < Time #:nodoc:all
-
-    #MS-DOS File Date and Time format as used in Interrupt 21H Function 57H:
+    # MS-DOS File Date and Time format as used in Interrupt 21H Function 57H:
 
     # Register CX, the Time:
     # Bits 0-4  2 second increments (0-29)
@@ -14,7 +13,7 @@ module Zip
     # bits 9-15 year (four digit year minus 1980)
 
     def to_binary_dos_time
-      (sec/2) +
+      (sec / 2) +
         (min << 5) +
         (hour << 11)
     end
@@ -27,7 +26,7 @@ module Zip
 
     # Dos time is only stored with two seconds accuracy
     def dos_equals(other)
-      to_i/2 == other.to_i/2
+      to_i / 2 == other.to_i / 2
     end
 
     def self.parse_binary_dos_format(binaryDosDate, binaryDosTime)
@@ -38,7 +37,7 @@ module Zip
       month  = (0b111100000 & binaryDosDate) >> 5
       year   = ((0b1111111000000000 & binaryDosDate) >> 9) + 1980
       begin
-        self.local(year, month, day, hour, minute, second)
+        local(year, month, day, hour, minute, second)
       end
     end
   end

data/lib/zip/entry.rb

@@ -15,13 +15,13 @@ module Zip
 
     def set_default_vars_values
       @local_header_offset      = 0
-      @local_header_size        = 0
+      @local_header_size        = nil # not known until local entry is created or read
       @internal_file_attributes = 1
       @external_file_attributes = 0
       @header_signature         = ::Zip::CENTRAL_DIRECTORY_ENTRY_SIGNATURE
 
       @version_needed_to_extract = VERSION_NEEDED_TO_EXTRACT
-      @version                   = 52 # this library's version
+      @version                   = VERSION_MADE_BY
 
       @ftype           = nil          # unspecified or unknown
       @filepath        = nil
@@ -39,15 +39,14 @@ module Zip
       @unix_uid            = nil
       @unix_gid            = nil
       @unix_perms          = nil
-      #@posix_acl = nil
-      #@ntfs_acl = nil
+      # @posix_acl = nil
+      # @ntfs_acl = nil
       @dirty               = false
     end
 
     def check_name(name)
-      if name.start_with?('/')
-        raise ::Zip::ZipEntryNameError, "Illegal ZipEntry name '#{name}', name must not start with /"
-      end
+      return unless name.start_with?('/')
+      raise ::Zip::EntryNameError, "Illegal ZipEntry name '#{name}', name must not start with /"
     end
 
     def initialize(*args)
@@ -68,12 +67,14 @@ module Zip
       @time               = args[8] || ::Zip::DOSTime.now
 
       @ftype = name_is_directory? ? :directory : :file
-      @extra = ::Zip::ExtraField.new(@extra.to_s) unless ::Zip::ExtraField === @extra
+      @extra = ::Zip::ExtraField.new(@extra.to_s) unless @extra.is_a?(::Zip::ExtraField)
     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.
@@ -81,18 +82,18 @@ module Zip
       end
     end
 
-    alias :mtime :time
+    alias mtime time
 
     def time=(value)
-      unless @extra.member?('UniversalTime')
+      unless @extra.member?('UniversalTime') || @extra.member?('NTFS')
         @extra.create('UniversalTime')
       end
-      @extra['UniversalTime'].mtime = value
+      (@extra['UniversalTime'] || @extra['NTFS']).mtime = value
       @time                         = value
     end
 
     def file_type_is?(type)
-      raise ZipInternalError, "current filetype is unknown: #{self.inspect}" unless @ftype
+      raise InternalError, "current filetype is unknown: #{inspect}" unless @ftype
       @ftype == type
     end
 
@@ -124,17 +125,24 @@ module Zip
     end
 
     def calculate_local_header_size #:nodoc:all
-      fix_zip64_sizes!
       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!
+      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
+
     def cdir_header_size #:nodoc:all
       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 + self.compressed_size
+      local_entry_offset + compressed_size + data_descriptor_size
     end
 
     # Extracts entry to file dest_path (defaults to @name).
@@ -142,9 +150,9 @@ module Zip
       block ||= proc { ::Zip.on_exists_proc }
 
       if directory? || file? || symlink?
-        self.__send__("create_#{@ftype}", dest_path, &block)
+        __send__("create_#{@ftype}", dest_path, &block)
       else
-        raise RuntimeError, "unknown file type #{self.inspect}"
+        raise "unknown file type #{inspect}"
       end
 
       self
@@ -154,8 +162,6 @@ module Zip
       @name
     end
 
-    protected
-
     class << self
       def read_zip_short(io) # :nodoc:
         io.read(2).unpack('v')[0]
@@ -166,25 +172,29 @@ module Zip
       end
 
       def read_zip_64_long(io) # :nodoc:
-        io.read(8).unpack('V')[0]
+        io.read(8).unpack('Q<')[0]
       end
 
       def read_c_dir_entry(io) #:nodoc:all
-        entry = new(io.path)
+        path = if io.respond_to?(:path)
+                 io.path
+               else
+                 io
+               end
+        entry = new(path)
         entry.read_c_dir_entry(io)
         entry
-      rescue ZipError
+      rescue Error
         nil
       end
 
       def read_local_entry(io)
-        entry = new(io.path)
+        entry = new(io)
         entry.read_local_entry(io)
         entry
-      rescue ZipError
+      rescue Error
         nil
       end
-
     end
 
     public
@@ -207,16 +217,16 @@ module Zip
     def read_local_entry(io) #:nodoc:all
       @local_header_offset = io.tell
 
-      static_sized_fields_buf = io.read(::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH)
+      static_sized_fields_buf = io.read(::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH) || ''
 
       unless static_sized_fields_buf.bytesize == ::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH
-        raise ZipError, "Premature end of file. Not enough data for zip entry local header"
+        raise Error, 'Premature end of file. Not enough data for zip entry local header'
       end
 
       unpack_local_entry(static_sized_fields_buf)
 
       unless @header_signature == ::Zip::LOCAL_ENTRY_SIGNATURE
-        raise ::Zip::ZipError, "Zip local header magic not found at location '#{local_header_offset}'"
+        raise ::Zip::Error, "Zip local header magic not found at location '#{local_header_offset}'"
       end
       set_time(@last_mod_date, @last_mod_time)
 
@@ -226,18 +236,20 @@ module Zip
       @name.gsub!('\\', '/')
 
       if extra && extra.bytesize != @extra_length
-        raise ::Zip::ZipError, "Truncated local zip entry header"
+        raise ::Zip::Error, 'Truncated local zip entry header'
       else
-        if ::Zip::ExtraField === @extra
-          @extra.merge(extra)
+        if @extra.is_a?(::Zip::ExtraField)
+          @extra.merge(extra) if extra
         else
           @extra = ::Zip::ExtraField.new(extra)
         end
       end
+      parse_zip64_extra(true)
       @local_header_size = calculate_local_header_size
     end
 
     def pack_local_entry
+      zip64 = @extra['Zip64']
       [::Zip::LOCAL_ENTRY_SIGNATURE,
        @version_needed_to_extract, # version needed to extract
        @gp_flags, # @gp_flags                  ,
@@ -245,19 +257,22 @@ module Zip
        @time.to_binary_dos_time, # @last_mod_time              ,
        @time.to_binary_dos_date, # @last_mod_date              ,
        @crc,
-       @compressed_size,
-       @size,
+       (zip64 && zip64.compressed_size) ? 0xFFFFFFFF : @compressed_size,
+       (zip64 && zip64.original_size) ? 0xFFFFFFFF : @size,
        name_size,
        @extra ? @extra.local_size : 0].pack('VvvvvvVVVvv')
     end
 
-    def write_local_entry(io) #:nodoc:all
+    def write_local_entry(io, rewrite = false) #:nodoc:all
+      prep_zip64_extra(true)
+      verify_local_header_size! if rewrite
       @local_header_offset = io.tell
 
       io << pack_local_entry
 
       io << @name
-      io << (@extra ? @extra.to_local_bin : '')
+      io << @extra.to_local_bin if @extra
+      @local_header_size = io.tell - @local_header_offset
     end
 
     def unpack_c_dir_entry(buf)
@@ -296,8 +311,8 @@ 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 extracted
                    if name_is_directory?
                      :directory
                    else
@@ -314,21 +329,18 @@ module Zip
     end
 
     def check_c_dir_entry_static_header_length(buf)
-      unless buf.bytesize == ::Zip::CDIR_ENTRY_STATIC_HEADER_LENGTH
-        raise ZipError, 'Premature end of file. Not enough data for zip cdir entry header'
-      end
+      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
-      unless header_signature == ::Zip::CENTRAL_DIRECTORY_ENTRY_SIGNATURE
-        raise ZipError, "Zip local header magic not found at location '#{local_header_offset}'"
-      end
+      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
-      unless @comment && @comment.bytesize == @comment_length
-        raise ::Zip::ZipError, "Truncated cdir zip entry header"
-      end
+      return if @comment && @comment.bytesize == @comment_length
+      raise ::Zip::Error, 'Truncated cdir zip entry header'
     end
 
     def read_c_dir_extra_field(io)
@@ -345,29 +357,28 @@ module Zip
       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).gsub('\\', '/')
+      @name = io.read(@name_length).tr('\\', '/')
       read_c_dir_extra_field(io)
       @comment = io.read(@comment_length)
       check_c_dir_entry_comment_size
       set_ftype_from_c_dir_entry
-      @local_header_size = calculate_local_header_size
+      parse_zip64_extra(false)
     end
 
     def file_stat(path) # :nodoc:
       if @follow_symlinks
-        ::File::stat(path)
+        ::File.stat(path)
       else
-        ::File::lstat(path)
+        ::File.lstat(path)
       end
     end
 
     def get_extra_attributes_from_path(path) # :nodoc:
-      unless Zip::RUNNING_ON_WINDOWS
-        stat        = file_stat(path)
-        @unix_uid   = stat.uid
-        @unix_gid   = stat.gid
-        @unix_perms = stat.mode & 07777
-      end
+      return if Zip::RUNNING_ON_WINDOWS
+      stat        = file_stat(path)
+      @unix_uid   = stat.uid
+      @unix_gid   = stat.gid
+      @unix_perms = stat.mode & 07777
     end
 
     def set_unix_permissions_on_path(dest_path)
@@ -381,7 +392,7 @@ module Zip
     end
 
     def set_extra_attributes_on_path(dest_path) # :nodoc:
-      return unless (file? || directory?)
+      return unless file? || directory?
 
       case @fstype
       when ::Zip::FSTYPE_UNIX
@@ -390,6 +401,7 @@ module Zip
     end
 
     def pack_c_dir_entry
+      zip64 = @extra['Zip64']
       [
         @header_signature,
         @version, # version of encoding software
@@ -400,15 +412,15 @@ module Zip
         @time.to_binary_dos_time, # @last_mod_time                      ,
         @time.to_binary_dos_date, # @last_mod_date                      ,
         @crc,
-        @compressed_size,
-        @size,
+        (zip64 && zip64.compressed_size) ? 0xFFFFFFFF : @compressed_size,
+        (zip64 && zip64.original_size) ? 0xFFFFFFFF : @size,
         name_size,
         @extra ? @extra.c_dir_size : 0,
         comment_size,
-        0, # disk number start
+        (zip64 && zip64.disk_start_number) ? 0xFFFF : 0, # disk number start
         @internal_file_attributes, # file type (binary=0, text=1)
         @external_file_attributes, # native filesystem attributes
-        @local_header_offset,
+        (zip64 && zip64.relative_header_offset) ? 0xFFFFFFFF : @local_header_offset,
         @name,
         @extra,
         @comment
@@ -416,6 +428,7 @@ module Zip
     end
 
     def write_c_dir_entry(io) #:nodoc:all
+      prep_zip64_extra(false)
       case @fstype
       when ::Zip::FSTYPE_UNIX
         ft = case @ftype
@@ -446,21 +459,21 @@ module Zip
       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) == self.__send__(k.to_sym)
+        other.__send__(k.to_sym) == __send__(k.to_sym)
       end
-      keys_equal && self.time.dos_equals(other.time)
+      keys_equal && time.dos_equals(other.time)
     end
 
-    def <=> (other)
-      self.to_s <=> other.to_s
+    def <=>(other)
+      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.instance) if block_given?
-        ::Zip::NullInputStream.instance
+        yield ::Zip::NullInputStream if block_given?
+        ::Zip::NullInputStream
       elsif @filepath
         case @ftype
         when :file
@@ -475,6 +488,7 @@ module Zip
         end
       else
         zis = ::Zip::InputStream.new(@zipfile, local_header_offset)
+        zis.instance_variable_set(:@internal, true)
         zis.get_next_entry
         if block_given?
           begin
@@ -494,22 +508,22 @@ module Zip
                when 'file'
                  if name_is_directory?
                    raise ArgumentError,
-                         "entry name '#{newEntry}' indicates directory entry, but "+
-                           "'#{src_path}' is not a directory"
+                         "entry name '#{newEntry}' indicates directory entry, but " \
+                             "'#{src_path}' is not a directory"
                  end
                  :file
                when 'directory'
-                 @name += "/" unless name_is_directory?
+                 @name += '/' unless name_is_directory?
                  :directory
                when 'link'
                  if name_is_directory?
                    raise ArgumentError,
-                         "entry name '#{newEntry}' indicates directory entry, but "+
-                           "'#{src_path}' is not a directory"
+                         "entry name '#{newEntry}' indicates directory entry, but " \
+                             "'#{src_path}' is not a directory"
                  end
                  :symlink
                else
-                 raise RuntimeError, "unknown file type: #{src_path.inspect} #{stat.inspect}"
+                 raise "unknown file type: #{src_path.inspect} #{stat.inspect}"
                end
 
       @filepath = src_path
@@ -518,9 +532,9 @@ module Zip
 
     def write_to_zip_output_stream(zip_output_stream) #:nodoc:all
       if @ftype == :directory
-        zip_output_stream.put_next_entry(self)
+        zip_output_stream.put_next_entry(self, nil, nil, ::Zip::Entry::STORED)
       elsif @filepath
-        zip_output_stream.put_next_entry(self, nil, nil, nil)
+        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) }
       else
         zip_output_stream.copy_raw_entry(self)
@@ -530,11 +544,19 @@ module Zip
     def parent_as_string
       entry_name  = name.chomp('/')
       slash_index = entry_name.rindex('/')
-      slash_index ? entry_name.slice(0, slash_index+1) : nil
+      slash_index ? entry_name.slice(0, slash_index + 1) : nil
     end
 
     def get_raw_input_stream(&block)
-      ::File.open(@zipfile, "rb", &block)
+      if @zipfile.respond_to?(:seek) && @zipfile.respond_to?(:read)
+        yield @zipfile
+      else
+        ::File.open(@zipfile, 'rb', &block)
+      end
+    end
+
+    def clean_up
+      # By default, do nothing
     end
 
     private
@@ -542,20 +564,20 @@ 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
-      puts "Invalid date/time in zip entry"
+      warn '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 })
-      if ::File.exists?(dest_path) && !yield(self, dest_path)
-        raise ::Zip::ZipDestinationFileExistsError,
+    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"
       end
-      ::File.open(dest_path, "wb") do |os|
+      ::File.open(dest_path, 'wb') do |os|
         get_input_stream do |is|
           set_extra_attributes_on_path(dest_path)
 
           buf = ''
-          while buf = is.sysread(::Zip::Decompressor::CHUNK_SIZE, buf)
+          while (buf = is.sysread(::Zip::Decompressor::CHUNK_SIZE, buf))
             os << buf
           end
         end
@@ -564,13 +586,13 @@ module Zip
 
     def create_directory(dest_path)
       return if ::File.directory?(dest_path)
-      if ::File.exists?(dest_path)
+      if ::File.exist?(dest_path)
         if block_given? && yield(self, dest_path)
-          ::FileUtils::rm_f dest_path
+          ::FileUtils.rm_f dest_path
         else
-          raise ::Zip::ZipDestinationFileExistsError,
-                "Cannot create directory '#{dest_path}'. "+
-                  "A file already exists with that name"
+          raise ::Zip::DestinationFileExistsError,
+                "Cannot create directory '#{dest_path}'. " \
+                    'A file already exists with that name'
         end
       end
       ::FileUtils.mkdir_p(dest_path)
@@ -593,27 +615,67 @@ module Zip
           if ::File.readlink(dest_path) == linkto
             return
           else
-            raise ZipDestinationFileExistsError,
-                  "Cannot create symlink '#{dest_path}'. "+
-                    "A symlink already exists with that name"
+            raise ::Zip::DestinationFileExistsError,
+                  "Cannot create symlink '#{dest_path}'. " \
+                      'A symlink already exists with that name'
           end
         else
-          raise ZipDestinationFileExistsError,
-                "Cannot create symlink '#{dest_path}'. "+
-                  "A file already exists with that name"
+          raise ::Zip::DestinationFileExistsError,
+                "Cannot create symlink '#{dest_path}'. " \
+                    'A file already exists with that name'
         end
       end
 
       ::File.symlink(linkto, dest_path)
     end
 
-    def fix_zip64_sizes! #:nodoc:all
-      if zip64 = @extra["Zip64"]
-        @size = zip64.original_size
-        @compressed_size = zip64.compressed_size
+    # 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
+        @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
+    end
+
+    # 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
+        @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')
+
+        # 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
+      end
+    end
   end
 end