rubyzip 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1b8a6d42ff819b19645f78ce2afb3c9fc7f6e36
-  data.tar.gz: 7319bb5eb51c46fdd78fffb43ead4452f2e3d947
+  metadata.gz: 21b11d72a619a00f577f3ac15a65d309d07ab57b
+  data.tar.gz: d2c28c4157e692118e26478c34205094eb2ca055
 SHA512:
-  metadata.gz: 5e59f7e789b618c7e7746efac11152c2272ced20cb63977c045bbbf3dd75ce4fe8bfe1b7da75d490bd7a9bbcddfa1ec93f2924c5f6e7ebcdf94c45ddd23e7042
-  data.tar.gz: 97fbb6781a474c5ba51b586033f0da491044687e32f40fe5dcec253305ff55e0ab49d9c22a5732616eaa8203c1e5b768b9d661a77ec0692fa298b89a6598974c
+  metadata.gz: 935e9064b3fc98693e8e0eef68f147b9a62ba4dcf25c9f42cf9828a544665d749fd8ff5866b52183a569171fd3aecddb09613d526da1bc43bf34c0b556bcea02
+  data.tar.gz: b9e36842ed0830befe3ca556b954757975291f8c523be419213c5974015742e41c4bb4a4b44c88a746ad22f7656f23162cf5e5d5e7591d917927ae9830ad8dae

data/README.md

@@ -1,7 +1,8 @@
 # rubyzip
-[![Build Status](https://secure.travis-ci.org/rubyzip/rubyzip.png)](http://travis-ci.org/rubyzip/rubyzip)
-[![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip.png)](https://codeclimate.com/github/rubyzip/rubyzip)
-[![Coverage Status](https://coveralls.io/repos/rubyzip/rubyzip/badge.png?branch=master)](https://coveralls.io/r/rubyzip/rubyzip?branch=master)
+[![Gem Version](https://badge.fury.io/rb/rubyzip.svg)](http://badge.fury.io/rb/rubyzip)
+[![Build Status](https://secure.travis-ci.org/rubyzip/rubyzip.svg)](http://travis-ci.org/rubyzip/rubyzip)
+[![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip.svg)](https://codeclimate.com/github/rubyzip/rubyzip)
+[![Coverage Status](https://img.shields.io/coveralls/rubyzip/rubyzip.svg)](https://coveralls.io/r/rubyzip/rubyzip?branch=master)
 
 rubyzip is a ruby library for reading and writing zip files.
 
@@ -9,7 +10,7 @@ rubyzip is a ruby library for reading and writing zip files.
 
 Rubyzip interface changed!!! No need to do `require "zip/zip"` and `Zip` prefix in class names removed.
 
-If you have issues with any third-party gems what required old version of rubyzip you can use next workaround:
+If you have issues with any third-party gems that require an old version of rubyzip, you can use this workaround:
 
 ```ruby
 gem 'rubyzip', '>= 1.0.0' # will load new rubyzip version
@@ -58,18 +59,52 @@ end
 ```
 
 ### Zipping a directory recursively
+Copy from [here](https://github.com/rubyzip/rubyzip/blob/05916bf89181e1955118fd3ea059f18acac28cc8/samples/example_recursive.rb )
 
 ```ruby
 require 'rubygems'
 require 'zip'
-
-directory = '/Users/me/Desktop/directory_to_zip/'
-zipfile_name = '/Users/me/Desktop/recursive_directory.zip'
-
-Zip::File.open(zipfile_name, Zip::File::CREATE) do |zipfile|
-	Dir[File.join(directory, '**', '**')].each do |file|
-	  zipfile.add(file.sub(directory, ''), file)
-	end
+# This is a simple example which uses rubyzip to
+# recursively generate a zip file from the contents of
+# a specified directory. The directory itself is not
+# included in the archive, rather just its contents.
+#
+# Usage:
+# require /path/to/the/ZipFileGenerator/Class
+# directoryToZip = "/tmp/input"
+# outputFile = "/tmp/out.zip"
+# zf = ZipFileGenerator.new(directoryToZip, outputFile)
+# zf.write()
+
+class ZipFileGenerator
+  # Initialize with the directory to zip and the location of the output archive.
+  def initialize(inputDir, outputFile)
+    @inputDir = inputDir
+    @outputFile = outputFile
+  end
+  # Zip the input directory.
+  def write()
+    entries = Dir.entries(@inputDir); entries.delete("."); entries.delete("..")
+    io = Zip::File.open(@outputFile, Zip::File::CREATE);
+    writeEntries(entries, "", io)
+    io.close();
+  end
+  # A helper method to make the recursion work.
+  private
+  def writeEntries(entries, path, io)
+    entries.each { |e|
+      zipFilePath = path == "" ? e : File.join(path, e)
+      diskFilePath = File.join(@inputDir, zipFilePath)
+      puts "Deflating " + diskFilePath
+      if File.directory?(diskFilePath)
+        io.mkdir(zipFilePath)
+        subdir =Dir.entries(diskFilePath); subdir.delete("."); subdir.delete("..")
+        writeEntries(subdir, zipFilePath, io)
+      else
+        io.get_output_stream(zipFilePath) { |f| f.print(File.open(diskFilePath, "rb").read())}
+      end
+    }
+  end
 end
 ```
 
@@ -111,6 +146,19 @@ Zip::File.open('foo.zip') do |zip_file|
 end
 ```
 
+### Password Protection (Experimental)
+
+RubyZip supports reading/writing zip files with traditional zip encryption (a.k.a. "ZipCrypto"). AES encryption is not yet supported. It can be used with buffer streams, e.g.:
+
+```ruby
+Zip::OutputStream.write_buffer(::StringIO.new(''), Zip::TraditionalEncrypter.new('password')) do |out|
+  out.put_next_entry("my_file.txt")
+  out.write my_data
+end.string
+```
+
+This is an experimental feature and the interface for encryption may change in future versions.
+
 ## Known issues
 
 ### Modify docx file with rubyzip
@@ -158,12 +206,17 @@ If you want to store non english names and want to open properly file on Windows
 Zip.unicode_names = true
 ```
 
+In some zip date of files stored in incorrect format. You can hide warning about it by using:
+
+```ruby
+Zip.warn_invalid_date = false
+```
+
 You can set the default compression level like so:
 
 ```ruby
 Zip.default_compression = Zlib::DEFAULT_COMPRESSION
 ```
-
 It defaults to `Zlib::DEFAULT_COMPRESSION`. Possible values are `Zlib::BEST_COMPRESSION`, `Zlib::DEFAULT_COMPRESSION` and `Zlib::NO_COMPRESSION`
 
 All settings in same time

data/lib/zip.rb

@@ -21,6 +21,9 @@ require 'zip/null_compressor'
 require 'zip/null_input_stream'
 require 'zip/pass_thru_compressor'
 require 'zip/pass_thru_decompressor'
+require 'zip/crypto/encryption'
+require 'zip/crypto/null_encryption'
+require 'zip/crypto/traditional_encryption'
 require 'zip/inflater'
 require 'zip/deflater'
 require 'zip/streamable_stream'
@@ -34,7 +37,7 @@ end
 
 module Zip
   extend self
-  attr_accessor :unicode_names, :on_exists_proc, :continue_on_exists_proc, :sort_entries, :default_compression, :write_zip64_support
+  attr_accessor :unicode_names, :on_exists_proc, :continue_on_exists_proc, :sort_entries, :default_compression, :write_zip64_support, :warn_invalid_date
 
   def reset!
     @_ran_once = false
@@ -44,6 +47,7 @@ module Zip
     @sort_entries = false
     @default_compression = ::Zlib::DEFAULT_COMPRESSION
     @write_zip64_support = false
+    @warn_invalid_date = true
   end
 
   def setup

data/lib/zip/central_directory.rb

@@ -46,7 +46,7 @@ module Zip
         @entry_set ? [@entry_set.size, 0xFFFF].min : 0,
         [cdir_size, 0xFFFFFFFF].min,
         [offset, 0xFFFFFFFF].min,
-        @comment ? @comment.length : 0
+        @comment ? @comment.bytesize : 0
       ]
       io << tmp.pack('VvvvvVVv')
       io << @comment

data/lib/zip/crypto/encryption.rb

@@ -0,0 +1,11 @@
+module Zip
+  class Encrypter #:nodoc:all
+  end
+
+  class Decrypter
+  end
+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.

data/lib/zip/crypto/null_encryption.rb

@@ -0,0 +1,45 @@
+module Zip
+  module NullEncryption
+    def header_bytesize
+      0
+    end
+
+    def gp_flags
+      0
+    end
+  end
+
+  class NullEncrypter < Encrypter
+    include NullEncryption
+
+    def header(mtime)
+      ''
+    end
+
+    def encrypt(data)
+      data
+    end
+
+    def data_descriptor(crc32, compressed_size, uncomprssed_size)
+      ''
+    end
+
+    def reset!
+    end
+  end
+
+  class NullDecrypter < Decrypter
+    include NullEncryption
+
+    def decrypt(data)
+      data
+    end
+
+    def reset!(header)
+    end
+  end
+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.

data/lib/zip/crypto/traditional_encryption.rb

@@ -0,0 +1,99 @@
+module Zip
+  module TraditionalEncryption
+    def initialize(password)
+      @password = password
+      reset_keys!
+    end
+
+    def header_bytesize
+      12
+    end
+
+    def gp_flags
+      0x0001 | 0x0008
+    end
+
+    protected
+
+    def reset_keys!
+      @key0 = 0x12345678
+      @key1 = 0x23456789
+      @key2 = 0x34567890
+      @password.each_byte do |byte|
+        update_keys(byte.chr)
+      end
+    end
+
+    def update_keys(n)
+      @key0 = ~Zlib.crc32(n, ~@key0)
+      @key1 = ((@key1 + (@key0 & 0xff)) * 134775813 + 1) & 0xffffffff
+      @key2 = ~Zlib.crc32((@key1 >> 24).chr, ~@key2)
+    end
+
+    def decrypt_byte
+      temp = (@key2 & 0xffff) | 2
+      ((temp * (temp ^ 1)) >> 8) & 0xff
+    end
+  end
+
+  class TraditionalEncrypter < Encrypter
+    include TraditionalEncryption
+
+    def header(mtime)
+      [].tap do |header|
+        (header_bytesize - 2).times do
+          header << Random.rand(0..255)
+        end
+        header << (mtime.to_binary_dos_time & 0xff)
+        header << (mtime.to_binary_dos_time >> 8)
+      end.map{|x| encode x}.pack("C*")
+    end
+
+    def encrypt(data)
+      data.unpack("C*").map{|x| encode x}.pack("C*")
+    end
+
+    def data_descriptor(crc32, compressed_size, uncomprssed_size)
+      [0x08074b50, crc32, compressed_size, uncomprssed_size].pack("VVVV")
+    end
+
+    def reset!
+      reset_keys!
+    end
+
+    private
+
+    def encode(n)
+      t = decrypt_byte
+      update_keys(n.chr)
+      t ^ n
+    end
+  end
+
+  class TraditionalDecrypter < Decrypter
+    include TraditionalEncryption
+
+    def decrypt(data)
+      data.unpack("C*").map{|x| decode x}.pack("C*")
+    end
+
+    def reset!(header)
+      reset_keys!
+      header.each_byte do |x|
+        decode x
+      end
+    end
+
+    private
+
+    def decode(n)
+      n ^= decrypt_byte
+      update_keys(n.chr)
+      n
+    end
+  end
+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.

data/lib/zip/deflater.rb

@@ -1,23 +1,26 @@
 module Zip
   class Deflater < Compressor #:nodoc:all
 
-    def initialize(output_stream, level = Zip.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
+      @buffer_stream = ::StringIO.new('')
     end
 
     def << (data)
       val   = data.to_s
       @crc  = Zlib::crc32(val, @crc)
       @size += val.bytesize
-      @output_stream << @zlib_deflater.deflate(data)
+      @buffer_stream << @zlib_deflater.deflate(data)
     end
 
     def finish
-      @output_stream << @zlib_deflater.finish until @zlib_deflater.finished?
+      @output_stream << @encrypter.encrypt(@buffer_stream.string)
+      @output_stream << @encrypter.encrypt(@zlib_deflater.finish) until @zlib_deflater.finished?
     end
 
     attr_reader :size, :crc

data/lib/zip/entry.rb

@@ -74,6 +74,8 @@ module Zip
     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.
@@ -84,10 +86,10 @@ module Zip
     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
 
@@ -141,7 +143,7 @@ module Zip
     end
 
     def next_header_offset #:nodoc:all
-      local_entry_offset + self.compressed_size
+      local_entry_offset + self.compressed_size + data_descriptor_size
     end
 
     # Extracts entry to file dest_path (defaults to @name).
@@ -362,7 +364,7 @@ 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
@@ -569,7 +571,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
-      puts "Invalid date/time in zip entry"
+      puts "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 })
@@ -646,6 +648,10 @@ module Zip
       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

data/lib/zip/entry_set.rb

@@ -38,17 +38,13 @@ module Zip
     end
 
     def each(&block)
-      @entry_set = @entry_set.dup.each do |_, value|
+      @entry_set = sorted_entries.dup.each do |_, value|
         block.call(value)
       end
     end
 
     def entries
-      if ::Zip.sort_entries == true
-        @entry_set.values.sort_by{|x| x.name}
-      else
-        @entry_set.values
-      end
+      sorted_entries.values
     end
 
     # deep clone
@@ -74,6 +70,9 @@ module Zip
     end
 
     protected
+    def sorted_entries
+      ::Zip.sort_entries ? Hash[@entry_set.sort] : @entry_set
+    end
 
     private
     def to_key(entry)

data/lib/zip/extra_field.rb

@@ -94,6 +94,7 @@ require 'zip/extra_field/old_unix'
 require 'zip/extra_field/unix'
 require 'zip/extra_field/zip64'
 require 'zip/extra_field/zip64_placeholder'
+require 'zip/extra_field/ntfs'
 
 # Copyright (C) 2002, 2003 Thomas Sondergaard
 # rubyzip is free software; you can redistribute it and/or