Class: Zip64::ZipWriter

Inherits:
Object
  • Object
show all
Defined in:
lib/zip64/writer.rb

Direct Known Subclasses

EventMachineWriter

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(io) ⇒ ZipWriter

Returns a new instance of ZipWriter.



27
28
29
30
31
32
33
34
# File 'lib/zip64/writer.rb', line 27

def initialize(io)
	@io, @offset = io, 0
	@dir_entries = []
	if block_given?
		yield(self)
		close
	end
end

Class Method Details

.get_io_size(io) ⇒ Object



280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/zip64/writer.rb', line 280

def self.get_io_size(io)
	if io.respond_to?(:stat)
		size = io.stat.size
	elsif io.respond_to?(:size)
		size = io.size
	else
		pos = io.tell
		io.seek(0, IO::SEEK_END)
		size = io.tell
		io.seek(pos, IO::SEEK_START)
	end
	size
end

.predict_size64(files) ⇒ Object



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/zip64/writer.rb', line 294

def self.predict_size64(files)
	file_overhead = LocalFileHeader.base_size +
			Zip64ExtraField.base_size

	cd_overhead = CDFileHeader.base_size +
		Zip64CDExtraField.base_size

	total = 0
	names_size = 0
	dolls = 0
	doll_names_size = 0
	files.each do |file|
		names_size += file[:name].size
		total += get_io_size(file[:io]) + file[:name].size + file_overhead

		if file[:russiandolls]
			file[:russiandolls].each do |doll|
				total += doll[:name].size + file_overhead + 4
				dolls += 1
				doll_names_size += doll[:name].size
			end
		end
	end

	until (total%4).zero?
		total += 1
	end

	total += files.size * cd_overhead
	total += names_size

	total += dolls * cd_overhead
	total += doll_names_size

	total += EOCDR.base_size + Zip64EOCDL.base_size + Zip64EOCDR.base_size

	total
end

Instance Method Details

#add_entry(io, info) ⇒ Object



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
# File 'lib/zip64/writer.rb', line 113

def add_entry(io, info)
	info = (io, info)

	data = io.read.to_s
	crc = Zlib.crc32(data, 0)

	# XXX: this doesn't fit well with the planned usage :(
	entry = { :offset => @offset, :len => data.size }
	@dir_entries << entry

	header = make_entry(info, data, crc)

	entry[:zip64] = header.zip64?

	if info[:russiandolls]
		first_header = header
		last_header = header

		info[:russiandolls].each_with_index do |doll,index|
			io.rewind
			doll_header = make_entry(info.merge(doll), data, crc)
			doll_prefix = [0x4343, doll_header.size].pack('vv')

			if (doll_header.to_string.size + doll_prefix.size) +
					first_header.to_string.size > local_header_max
				STDERR.puts "Can't add any more dolls! Dolls #{index}-#{dolls.size-1} omitted."
			else
				offset = @offset + first_header.to_string.size + doll_prefix.size
				last_header.extra_field << doll_prefix << doll_header
				@dir_entries << {
					:offset => offset,
					:len => data.size,
					:local_header => doll_header,
					:zip64 => doll_header.zip64?
				}
				last_header = doll_header
			end
		end
	end

	entry[:local_header] = header

	# write output
	write header.to_string

	# write data (& any compression?)
	write data


	# write descriptor - not need with current strategy
	# write DD64.new(:crc32 => crc,
	#			:data_len => data.size,
	#			:raw_data_len => data.size).to_string
end


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/zip64/writer.rb', line 91

def add_link(target, info)
	info = (nil, info)
	crc = Zlib.crc32('', 0)
	make_entry(info, '', crc)

	entry = { :offset => @offset, :len => 0 }
	@dir_entries << entry

	header = make_entry(info, '', crc)
	header.extra_field.push(UnixExtraField.new(:atime => info[:mtime].to_i,
											   :mtime => info[:mtime].to_i,
											   :uid   => info[:uid].to_i,
											   :gid   => info[:gid].to_i,
											   :data  => target))

	entry[:zip64] = header.zip64?
	entry[:local_header] = header

	# write output
	write header.to_string
end

#closeObject



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/zip64/writer.rb', line 257

def close
	# [archive decryption header]
	#  ignore
	# [archive extra data record]
	#  ignore

	# [central directory]
	write_central_directory()

	if @dir_entries.any? { |entry| entry[:zip64] }
		# [zip64 end of central directory record]
		write_zip64_end_of_central_directory()

		# [zip64 end of central directory locator]
		write_zip64_end_of_central_directory_locator()
	end

	# [end of central directory record]
	write_end_of_central_directory_record()

	write_last()
end

#ensure_metadata(io, info) ⇒ Object



36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/zip64/writer.rb', line 36

def (io, info)
	info = info.dup

	info[:mtime] ||= Time.now
	info[:gid]   ||= Process.gid
	info[:uid]   ||= Process.uid

	info[:name] ||= File.basename(io.path) if io.respond_to?(:path) && io.path
	info[:name] ||= "file-#{@dir_entries.size+2}.dat"

	info
end

#local_header_maxObject



168
169
170
# File 'lib/zip64/writer.rb', line 168

def local_header_max
	1024 * 64
end

#make_entry(info, data, crc) ⇒ Object



83
84
85
86
87
88
89
# File 'lib/zip64/writer.rb', line 83

def make_entry(info, data, crc)
	if info[:use] == 64 || @offset + data.size > self.threshold
		header = make_entry64(info, data, crc)
	else
		header = make_entry32(info, data, crc)
	end
end

#make_entry32(info, data, crc) ⇒ Object



49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/zip64/writer.rb', line 49

def make_entry32(info, data, crc)
	header = LocalFileHeader.new(
		:flags => (1<<11),
		:compression => 0,
		:last_mod_file_time => Zip64.time_to_msdos_time(info[:mtime]),
		:last_mod_file_date => Zip64.date_to_msdos_date(info[:mtime]),
		:crc32 => crc,
		:data_len => data.size,
		:raw_data_len => data.size,
		:filename => info[:name],
		:extra_field => '')

	header
end

#make_entry64(info, data, crc) ⇒ Object



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/zip64/writer.rb', line 64

def make_entry64(info, data, crc)
	header = LocalFileHeader.new(
		:flags => 0,
		:last_mod_file_time => Zip64.time_to_msdos_time(info[:mtime]),
		:last_mod_file_date => Zip64.date_to_msdos_date(info[:mtime]),
		:crc32 => crc,
		:data_len => LEN64,
		:raw_data_len => LEN64,
		:filename => info[:name],
		:extra_field => Zip64ExtraField.new(
			:header_id => Zip64ExtraField::ID,
			:header_len => 16,
			:raw_data_len => data.size,
			:data_len => data.size)
	)

	header
end

#thresholdObject



172
173
174
175
176
177
# File 'lib/zip64/writer.rb', line 172

def threshold
	1024 * # kb
	1024 * # mb
	1024 * # gb
	2 - local_header_max
end

#write_central_directoryObject



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
# File 'lib/zip64/writer.rb', line 179

def write_central_directory
	align
	@central_directory_offset = @offset

	@dir_entries.each do |entry|
		offset = entry[:offset]
		len    = entry[:len]
		header = entry[:local_header]

		extra_field = Zip64CDExtraField.new(
			:data_len => len,
			:raw_data_len => len,
			:relative_offset => offset,
			:disk_no => 0
		)
		write CDFileHeader.new(
			:flags => header.flags,
			:compression => header.compression,
			:made_by => (3 << 8),
			:last_mod_file_time => header.last_mod_file_time,
			:last_mod_file_date => header.last_mod_file_date,
			:crc32 => header.crc32,
			:data_len => entry[:zip64] ? LEN64 : len,
			:raw_data_len => entry[:zip64] ? LEN64 : len,
			:filename => header.filename,
			:extra_field => entry[:zip64] ? extra_field.to_string : '',
			:file_comment => '',
			:disk_no => entry[:zip64] ? 0xffff : 0,
			:internal_file_attributes => 0,
			:external_file_attributes => 0,
			:rel_offset_of_local_header => entry[:zip64] ? LEN64 : offset
		).to_string
	end

	# Central Directory Size
	@central_directory_size = @offset - @central_directory_offset
end

#write_end_of_central_directory_recordObject



244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/zip64/writer.rb', line 244

def write_end_of_central_directory_record
	#align
	write EOCDR.new(
		:disk_no => 0,
		:disk_with_cd_no => 0,
		:total_entries_in_local_cd => @dir_entries.size,
		:total_entries => @dir_entries.size,
		:cd_size => @central_directory_size,
		:offset_to_cd_start => @central_directory_offset,
		:file_comment => ''
	).to_string
end

#write_zip64_end_of_central_directoryObject



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/zip64/writer.rb', line 217

def write_zip64_end_of_central_directory
	#align
	@zip64_central_directory_offset = @offset

	write Zip64EOCDR.new(
		:made_by => 3 << 8,
		:this_disk_no => 0,
		:disk_with_cd_no => 0,
		:total_no_entries_on_this_disk => @dir_entries.size,
		:total_no_entries => @dir_entries.size,
		:size_of_cd => @central_directory_size,
		:offset_of_cd_wrt_disk_no => @central_directory_offset,
		:data => ''
	).to_string
end

#write_zip64_end_of_central_directory_locatorObject



233
234
235
236
237
238
239
240
241
242
# File 'lib/zip64/writer.rb', line 233

def write_zip64_end_of_central_directory_locator
	#align
	write Zip64EOCDL.new(
		:disk_with_z64_eocdr => 0,
		# Assume relative offset is relative to disk, as
		# is case elsewhere in Zip spec
		:relative_offset => @zip64_central_directory_offset,
		:no_disks => 1
	).to_string
end