rubyzip 2.4.1 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/Changelog.md +538 -0
  3. data/LICENSE.md +24 -0
  4. data/README.md +222 -43
  5. data/Rakefile +15 -13
  6. data/lib/rubyzip.rb +3 -0
  7. data/lib/zip/central_directory.rb +194 -125
  8. data/lib/zip/compressor.rb +3 -1
  9. data/lib/zip/constants.rb +29 -21
  10. data/lib/zip/crypto/aes_encryption.rb +123 -0
  11. data/lib/zip/crypto/decrypted_io.rb +27 -15
  12. data/lib/zip/crypto/encryption.rb +4 -2
  13. data/lib/zip/crypto/null_encryption.rb +5 -13
  14. data/lib/zip/crypto/traditional_encryption.rb +13 -7
  15. data/lib/zip/decompressor.rb +4 -3
  16. data/lib/zip/deflater.rb +12 -8
  17. data/lib/zip/dirtyable.rb +32 -0
  18. data/lib/zip/dos_time.rb +64 -6
  19. data/lib/zip/entry.rb +396 -269
  20. data/lib/zip/entry_set.rb +11 -9
  21. data/lib/zip/errors.rb +152 -16
  22. data/lib/zip/extra_field/aes.rb +50 -0
  23. data/lib/zip/extra_field/generic.rb +10 -11
  24. data/lib/zip/extra_field/ntfs.rb +6 -4
  25. data/lib/zip/extra_field/old_unix.rb +5 -3
  26. data/lib/zip/extra_field/universal_time.rb +3 -1
  27. data/lib/zip/extra_field/unix.rb +7 -5
  28. data/lib/zip/extra_field/unknown.rb +35 -0
  29. data/lib/zip/extra_field/zip64.rb +19 -5
  30. data/lib/zip/extra_field.rb +25 -23
  31. data/lib/zip/file.rb +174 -267
  32. data/lib/zip/file_split.rb +91 -0
  33. data/lib/zip/filesystem/dir.rb +86 -0
  34. data/lib/zip/filesystem/directory_iterator.rb +48 -0
  35. data/lib/zip/filesystem/file.rb +263 -0
  36. data/lib/zip/filesystem/file_stat.rb +110 -0
  37. data/lib/zip/filesystem/zip_file_name_mapper.rb +81 -0
  38. data/lib/zip/filesystem.rb +27 -596
  39. data/lib/zip/inflater.rb +13 -10
  40. data/lib/zip/input_stream.rb +99 -60
  41. data/lib/zip/ioextras/abstract_input_stream.rb +146 -58
  42. data/lib/zip/ioextras/abstract_output_stream.rb +13 -3
  43. data/lib/zip/ioextras.rb +11 -8
  44. data/lib/zip/null_compressor.rb +3 -1
  45. data/lib/zip/null_decompressor.rb +6 -3
  46. data/lib/zip/null_input_stream.rb +3 -1
  47. data/lib/zip/output_stream.rb +68 -59
  48. data/lib/zip/pass_thru_compressor.rb +3 -1
  49. data/lib/zip/pass_thru_decompressor.rb +12 -9
  50. data/lib/zip/streamable_directory.rb +3 -1
  51. data/lib/zip/streamable_stream.rb +4 -1
  52. data/lib/zip/version.rb +4 -1
  53. data/lib/zip.rb +28 -23
  54. data/rubyzip.gemspec +39 -0
  55. data/samples/example.rb +8 -3
  56. data/samples/example_filesystem.rb +3 -2
  57. data/samples/example_recursive.rb +3 -1
  58. data/samples/gtk_ruby_zip.rb +5 -3
  59. data/samples/qtzip.rb +7 -6
  60. data/samples/write_simple.rb +2 -1
  61. data/samples/zipfind.rb +1 -0
  62. metadata +87 -52
  63. data/TODO +0 -15
  64. data/lib/zip/extra_field/zip64_placeholder.rb +0 -15
@@ -1,5 +1,7 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Zip
2
- module NullEncryption
4
+ module NullEncryption # :nodoc:
3
5
  def header_bytesize
4
6
  0
5
7
  end
@@ -9,7 +11,7 @@ module Zip
9
11
  end
10
12
  end
11
13
 
12
- class NullEncrypter < Encrypter
14
+ class NullEncrypter < Encrypter # :nodoc:
13
15
  include NullEncryption
14
16
 
15
17
  def header(_mtime)
@@ -20,22 +22,12 @@ module Zip
20
22
  data
21
23
  end
22
24
 
23
- def data_descriptor(_crc32, _compressed_size, _uncomprssed_size)
25
+ def data_descriptor(_crc32, _compressed_size, _uncompressed_size)
24
26
  ''
25
27
  end
26
28
 
27
29
  def reset!; end
28
30
  end
29
-
30
- class NullDecrypter < Decrypter
31
- include NullEncryption
32
-
33
- def decrypt(data)
34
- data
35
- end
36
-
37
- def reset!(_header); end
38
- end
39
31
  end
40
32
 
41
33
  # Copyright (C) 2002, 2003 Thomas Sondergaard
@@ -1,5 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'securerandom'
4
+
1
5
  module Zip
2
- module TraditionalEncryption
6
+ module TraditionalEncryption # :nodoc:
3
7
  def initialize(password)
4
8
  @password = password
5
9
  reset_keys!
@@ -26,7 +30,7 @@ module Zip
26
30
 
27
31
  def update_keys(num)
28
32
  @key0 = ~Zlib.crc32(num, ~@key0)
29
- @key1 = ((@key1 + (@key0 & 0xff)) * 134_775_813 + 1) & 0xffffffff
33
+ @key1 = (((@key1 + (@key0 & 0xff)) * 134_775_813) + 1) & 0xffffffff
30
34
  @key2 = ~Zlib.crc32((@key1 >> 24).chr, ~@key2)
31
35
  end
32
36
 
@@ -36,13 +40,13 @@ module Zip
36
40
  end
37
41
  end
38
42
 
39
- class TraditionalEncrypter < Encrypter
43
+ class TraditionalEncrypter < Encrypter # :nodoc:
40
44
  include TraditionalEncryption
41
45
 
42
46
  def header(mtime)
43
47
  [].tap do |header|
44
48
  (header_bytesize - 2).times do
45
- header << Random.rand(0..255)
49
+ header << SecureRandom.rand(0..255)
46
50
  end
47
51
  header << (mtime.to_binary_dos_time & 0xff)
48
52
  header << (mtime.to_binary_dos_time >> 8)
@@ -53,8 +57,8 @@ module Zip
53
57
  data.unpack('C*').map { |x| encode x }.pack('C*')
54
58
  end
55
59
 
56
- def data_descriptor(crc32, compressed_size, uncomprssed_size)
57
- [0x08074b50, crc32, compressed_size, uncomprssed_size].pack('VVVV')
60
+ def data_descriptor(crc32, compressed_size, uncompressed_size)
61
+ [0x08074b50, crc32, compressed_size, uncompressed_size].pack('VVVV')
58
62
  end
59
63
 
60
64
  def reset!
@@ -70,7 +74,7 @@ module Zip
70
74
  end
71
75
  end
72
76
 
73
- class TraditionalDecrypter < Decrypter
77
+ class TraditionalDecrypter < Decrypter # :nodoc:
74
78
  include TraditionalEncryption
75
79
 
76
80
  def decrypt(data)
@@ -84,6 +88,8 @@ module Zip
84
88
  end
85
89
  end
86
90
 
91
+ def check_integrity!(_io); end
92
+
87
93
  private
88
94
 
89
95
  def decode(num)
@@ -1,5 +1,7 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Zip
2
- class Decompressor #:nodoc:all
4
+ class Decompressor # :nodoc:all
3
5
  CHUNK_SIZE = 32_768
4
6
 
5
7
  def self.decompressor_classes
@@ -14,8 +16,7 @@ module Zip
14
16
  decompressor_classes[compression_method]
15
17
  end
16
18
 
17
- attr_reader :input_stream
18
- attr_reader :decompressed_size
19
+ attr_reader :decompressed_size, :input_stream
19
20
 
20
21
  def initialize(input_stream, decompressed_size = nil)
21
22
  super()
data/lib/zip/deflater.rb CHANGED
@@ -1,5 +1,7 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Zip
2
- class Deflater < Compressor #:nodoc:all
4
+ class Deflater < Compressor # :nodoc:all
3
5
  def initialize(output_stream, level = Zip.default_compression, encrypter = NullEncrypter.new)
4
6
  super()
5
7
  @output_stream = output_stream
@@ -13,16 +15,18 @@ module Zip
13
15
  val = data.to_s
14
16
  @crc = Zlib.crc32(val, @crc)
15
17
  @size += val.bytesize
16
- buffer = @zlib_deflater.deflate(data)
17
- if buffer.empty?
18
- @output_stream
19
- else
20
- @output_stream << @encrypter.encrypt(buffer)
21
- end
18
+
19
+ # When JRuby#3962 is fixed, we can remove the flushing parameter here.
20
+ buffer = @zlib_deflater.deflate(data, Zip::ZLIB_FLUSHING_STRATEGY)
21
+ return @output_stream if buffer.empty?
22
+
23
+ @output_stream << @encrypter.encrypt(buffer)
22
24
  end
23
25
 
24
26
  def finish
25
- @output_stream << @encrypter.encrypt(@zlib_deflater.finish) until @zlib_deflater.finished?
27
+ buffer = @zlib_deflater.finish
28
+ @output_stream << @encrypter.encrypt(buffer) unless buffer.empty?
29
+ @zlib_deflater.close
26
30
  end
27
31
 
28
32
  attr_reader :size, :crc
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Zip
4
+ module Dirtyable # :nodoc:all
5
+ def initialize(dirty_on_create: true)
6
+ @dirty = dirty_on_create
7
+ end
8
+
9
+ def dirty?
10
+ @dirty
11
+ end
12
+
13
+ module ClassMethods # :nodoc:
14
+ def mark_dirty(*symbols) # :nodoc:
15
+ # Move the original method and call it after we've set the dirty flag.
16
+ symbols.each do |symbol|
17
+ orig_name = "orig_#{symbol}"
18
+ alias_method orig_name, symbol
19
+
20
+ define_method(symbol) do |param|
21
+ @dirty = true
22
+ send(orig_name, param)
23
+ end
24
+ end
25
+ end
26
+ end
27
+
28
+ def self.included(base)
29
+ base.extend(ClassMethods)
30
+ end
31
+ end
32
+ end
data/lib/zip/dos_time.rb CHANGED
@@ -1,5 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rubygems'
4
+
1
5
  module Zip
2
- class DOSTime < Time #:nodoc:all
6
+ class DOSTime < Time # :nodoc:all
3
7
  # MS-DOS File Date and Time format as used in Interrupt 21H Function 57H:
4
8
 
5
9
  # Register CX, the Time:
@@ -12,21 +16,47 @@ module Zip
12
16
  # bits 5-8 month (1-12)
13
17
  # bits 9-15 year (four digit year minus 1980)
14
18
 
19
+ # The MS-DOS date field is seven bits of "year minus 1980", so only
20
+ # 1980-01-01 00:00:00 through 2107-12-31 23:59:58 can be represented.
21
+ # Times outside that are clamped rather than allowed to wrap: the real
22
+ # time is still carried in the universal time (UT) extra field, but the
23
+ # DOS fields have to stay in range for readers that only look at those.
24
+ DOS_EPOCH_YEAR = 1980
25
+ DOS_MAX_YEAR = 2107
26
+ DOS_MIN_DATE = 0x0021 # 1980-01-01
27
+ DOS_MAX_DATE = 0xff9f # 2107-12-31
28
+ DOS_MIN_TIME = 0x0000 # 00:00:00
29
+ DOS_MAX_TIME = 0xbf7d # 23:59:58
30
+
31
+ attr_writer :absolute_time # :nodoc:
32
+
33
+ def absolute_time?
34
+ # If absolute time is not set, we can assume it is an absolute time
35
+ # because times do have timezone information by default.
36
+ @absolute_time.nil? || @absolute_time
37
+ end
38
+
15
39
  def to_binary_dos_time
40
+ return DOS_MIN_TIME if year < DOS_EPOCH_YEAR
41
+ return DOS_MAX_TIME if year > DOS_MAX_YEAR
42
+
16
43
  (sec / 2) +
17
44
  (min << 5) +
18
45
  (hour << 11)
19
46
  end
20
47
 
21
48
  def to_binary_dos_date
49
+ return DOS_MIN_DATE if year < DOS_EPOCH_YEAR
50
+ return DOS_MAX_DATE if year > DOS_MAX_YEAR
51
+
22
52
  day +
23
53
  (month << 5) +
24
- ((year - 1980) << 9)
54
+ ((year - DOS_EPOCH_YEAR) << 9)
25
55
  end
26
56
 
27
- def dos_equals(other)
28
- Zip.warn_about_v3_api('DOSTime#dos_equals')
29
-
57
+ # Deprecated. Remove for version 4.
58
+ def dos_equals(other) # rubocop:disable Naming/PredicateMethod
59
+ warn 'Zip::DOSTime#dos_equals is deprecated. Use `==` instead.'
30
60
  self == other
31
61
  end
32
62
 
@@ -50,7 +80,35 @@ module Zip
50
80
  month = (0b111100000 & bin_dos_date) >> 5
51
81
  year = ((0b1111111000000000 & bin_dos_date) >> 9) + 1980
52
82
 
53
- local(year, month, day, hour, minute, second)
83
+ time = local(year, month, day, hour, minute, second)
84
+ time.absolute_time = false
85
+ time
86
+ end
87
+
88
+ if defined? JRUBY_VERSION && Gem::Version.new(JRUBY_VERSION) < '9.2.18.0'
89
+ module JRubyCMP # :nodoc:
90
+ def ==(other)
91
+ (self <=> other).zero?
92
+ end
93
+
94
+ def <(other)
95
+ (self <=> other).negative?
96
+ end
97
+
98
+ def <=(other)
99
+ (self <=> other) <= 0
100
+ end
101
+
102
+ def >(other)
103
+ (self <=> other).positive?
104
+ end
105
+
106
+ def >=(other)
107
+ (self <=> other) >= 0
108
+ end
109
+ end
110
+
111
+ include JRubyCMP
54
112
  end
55
113
  end
56
114
  end