1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
|
# frozen_string_literal: true
require 'forwardable'
require_relative 'dirtyable'
module Zip
class CentralDirectory # :nodoc:
extend Forwardable
include Dirtyable
END_OF_CD_SIG = 0x06054b50
ZIP64_END_OF_CD_SIG = 0x06064b50
ZIP64_EOCD_LOCATOR_SIG = 0x07064b50
STATIC_EOCD_SIZE = 22
ZIP64_STATIC_EOCD_SIZE = 56
ZIP64_EOCD_LOC_SIZE = 20
MAX_FILE_COMMENT_SIZE = (1 << 16) - 1
MAX_END_OF_CD_SIZE =
MAX_FILE_COMMENT_SIZE + STATIC_EOCD_SIZE + ZIP64_EOCD_LOC_SIZE
attr_accessor :comment
def_delegators :@entry_set,
:<<, :delete, :each, :entries, :find_entry, :glob,
:include?, :size
mark_dirty :<<, :comment=, :delete
def initialize(entries = EntrySet.new, comment = '') # :nodoc:
super(dirty_on_create: false)
@entry_set = entries.kind_of?(EntrySet) ? entries : EntrySet.new(entries)
@comment = comment
end
def read_from_stream(io)
read_eocds(io)
read_central_directory_entries(io)
end
def write_to_stream(io, suppress_extra_fields: false) # :nodoc:
cdir_offset = io.tell
@entry_set.each do |entry|
entry.write_c_dir_entry(io, suppress_extra_fields: suppress_extra_fields)
end
eocd_offset = io.tell
cdir_size = eocd_offset - cdir_offset
if Zip.write_zip64_support &&
(cdir_offset > 0xFFFFFFFF || cdir_size > 0xFFFFFFFF || @entry_set.size > 0xFFFF)
write_64_e_o_c_d(io, cdir_offset, cdir_size)
write_64_eocd_locator(io, eocd_offset)
end
write_e_o_c_d(io, cdir_offset, cdir_size)
end
# Reads the End of Central Directory Record (and the Zip64 equivalent if
# needs be) and returns the number of entries in the archive. This is a
# convenience method that avoids reading in all of the entry data to get a
# very quick entry count.
def count_entries(io)
read_eocds(io)
@size
end
def ==(other) # :nodoc:
return false unless other.kind_of?(CentralDirectory)
@entry_set.entries.sort == other.entries.sort && comment == other.comment
end
private
def write_e_o_c_d(io, offset, cdir_size) # :nodoc:
tmp = [
END_OF_CD_SIG,
0, # @numberOfThisDisk
0, # @numberOfDiskWithStartOfCDir
@entry_set ? [@entry_set.size, 0xFFFF].min : 0,
@entry_set ? [@entry_set.size, 0xFFFF].min : 0,
[cdir_size, 0xFFFFFFFF].min,
[offset, 0xFFFFFFFF].min,
@comment ? @comment.bytesize : 0
]
io << tmp.pack('VvvvvVVv')
io << @comment
end
def write_64_e_o_c_d(io, offset, cdir_size) # :nodoc:
tmp = [
ZIP64_END_OF_CD_SIG,
44, # size of zip64 end of central directory record (excludes signature and field itself)
VERSION_MADE_BY,
VERSION_NEEDED_TO_EXTRACT_ZIP64,
0, # @numberOfThisDisk
0, # @numberOfDiskWithStartOfCDir
@entry_set ? @entry_set.size : 0, # number of entries on this disk
@entry_set ? @entry_set.size : 0, # number of entries total
cdir_size, # size of central directory
offset # offset of start of central directory in its disk
]
io << tmp.pack('VQ<vvVVQ<Q<Q<Q<')
end
def write_64_eocd_locator(io, zip64_eocd_offset)
tmp = [
ZIP64_EOCD_LOCATOR_SIG,
0, # number of disk containing the start of zip64 eocd record
zip64_eocd_offset, # offset of the start of zip64 eocd record in its disk
1 # total number of disks
]
io << tmp.pack('VVQ<V')
end
def unpack_64_e_o_c_d(buffer) # :nodoc:
_, # ZIP64_END_OF_CD_SIG. We know we have this at this point.
@size_of_zip64_e_o_c_d,
@version_made_by,
@version_needed_for_extract,
@number_of_this_disk,
@number_of_disk_with_start_of_cdir,
@total_number_of_entries_in_cdir_on_this_disk,
@size,
@size_in_bytes,
@cdir_offset = buffer.unpack('VQ<vvVVQ<Q<Q<Q<')
zip64_extensible_data_size =
@size_of_zip64_e_o_c_d - ZIP64_STATIC_EOCD_SIZE + 12
@zip64_extensible_data = if zip64_extensible_data_size.zero?
''
else
buffer.slice(
ZIP64_STATIC_EOCD_SIZE,
zip64_extensible_data_size
)
end
end
def unpack_64_eocd_locator(buffer) # :nodoc:
_, # ZIP64_EOCD_LOCATOR_SIG. We know we have this at this point.
_, zip64_eocd_offset, = buffer.unpack('VVQ<V')
zip64_eocd_offset
end
# Unpack the EOCD and return a boolean indicating whether this header is
# complete without needing Zip64 extensions.
def unpack_e_o_c_d(buffer) # :nodoc: # rubocop:disable Naming/PredicateMethod
_, # END_OF_CD_SIG. We know we have this at this point.
@number_of_this_disk,
@number_of_disk_with_start_of_cdir,
@total_number_of_entries_in_cdir_on_this_disk,
@size,
@size_in_bytes,
@cdir_offset,
comment_length = buffer.unpack('VvvvvVVv')
@comment = if comment_length.positive?
buffer.slice(STATIC_EOCD_SIZE, comment_length)
else
''
end
!([@number_of_this_disk, @number_of_disk_with_start_of_cdir,
@total_number_of_entries_in_cdir_on_this_disk, @size].any?(0xFFFF) ||
@size_in_bytes == 0xFFFFFFFF || @cdir_offset == 0xFFFFFFFF)
end
def read_central_directory_entries(io) # :nodoc:
# `StringIO` doesn't raise `EINVAL` if you seek beyond the current end,
# so we need to catch that *and* query `io#eof?` here.
eof = false
begin
io.seek(@cdir_offset, IO::SEEK_SET)
rescue Errno::EINVAL
eof = true
end
raise Error, 'Zip consistency problem while reading central directory entry' if eof || io.eof?
@entry_set = EntrySet.new
@size.times do
entry = Entry.read_c_dir_entry(io)
next unless entry
offset = if entry.zip64?
entry.extra[:zip64].relative_header_offset
else
entry.local_header_offset
end
unless offset.nil?
io_save = io.tell
io.seek(offset, IO::SEEK_SET)
entry.read_extra_field(read_local_extra_field(io), local: true)
io.seek(io_save, IO::SEEK_SET)
end
@entry_set << entry
end
end
def read_local_extra_field(io)
buf = io.read(::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH) || ''
return '' unless buf.bytesize == ::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH
head, _, _, _, _, _, _, _, _, _, n_len, e_len = buf.unpack('VCCvvvvVVVvv')
return '' unless head == ::Zip::LOCAL_ENTRY_SIGNATURE
io.seek(n_len, IO::SEEK_CUR) # Skip over the entry name.
io.read(e_len)
end
def read_eocds(io) # :nodoc:
base_location, data = eocd_data(io)
eocd_location = data.rindex([END_OF_CD_SIG].pack('V'))
raise Error, 'Zip end of central directory signature not found' unless eocd_location
# Parse the EOCD and return if it is complete without Zip64 extensions.
return if unpack_e_o_c_d(data.slice(eocd_location..-1))
# Need to read in the Zip64 EOCD locator and then the Zip64 EOCD.
zip64_eocd_locator = data.rindex([ZIP64_EOCD_LOCATOR_SIG].pack('V'), eocd_location)
unless zip64_eocd_locator
raise Error, 'Zip64 end of central directory locator signature expected but not found'
end
# Do we already have the Zip64 EOCD in the data we've read?
zip64_eocd_location = data.rindex([ZIP64_END_OF_CD_SIG].pack('V'), zip64_eocd_locator)
zip64_eocd_data =
if zip64_eocd_location
# Yes.
data.slice(zip64_eocd_location..zip64_eocd_locator)
else
# No. Read its location from the locator and then read it in.
zip64_eocd_location = unpack_64_eocd_locator(
data.slice(zip64_eocd_locator..eocd_location)
)
unless zip64_eocd_location
raise Error, 'Zip64 end of central directory signature not found'
end
io.seek(zip64_eocd_location, IO::SEEK_SET)
io.read(base_location + zip64_eocd_locator - zip64_eocd_location)
end
# Finally, unpack the Zip64 EOCD.
unpack_64_e_o_c_d(zip64_eocd_data)
end
def eocd_data(io)
begin
io.seek(-MAX_END_OF_CD_SIZE, IO::SEEK_END)
rescue Errno::EINVAL
io.seek(0, IO::SEEK_SET)
end
[io.tell, io.read]
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.
|