Class: Zip::File

Inherits:
Object
  • Object
show all
Extended by:
Forwardable, FileSplit
Includes:
Enumerable, FileSystem
Defined in:
lib/zip/file.rb,
lib/zip/filesystem.rb

Overview

:nodoc:

Constant Summary collapse

IO_METHODS =

:nodoc:

[:tell, :seek, :read, :eof, :close].freeze

Constants included from FileSplit

Zip::FileSplit::DATA_BUFFER_SIZE, Zip::FileSplit::MAX_SEGMENT_SIZE, Zip::FileSplit::MIN_SEGMENT_SIZE

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FileSplit

get_partial_zip_file_name, get_segment_count_for_split, get_segment_size_for_split, put_split_signature, save_splited_part, split

Methods included from FileSystem

#dir, #file

Constructor Details

#initialize(path_or_io, create: false, buffer: false, restore_ownership: , restore_permissions: , restore_times: , compression_level: ::Zip.default_compression) ⇒ File

Opens a zip archive. Pass create: true to create a new archive if it doesn’t exist already.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zip/file.rb', line 75

def initialize(path_or_io, create: false, buffer: false,
               restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
               restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
               restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
               compression_level: ::Zip.default_compression)
  super()

  @name    = path_or_io.respond_to?(:path) ? path_or_io.path : path_or_io
  @create  = create ? true : false # allow any truthy value to mean true

  initialize_cdir(path_or_io, buffer: buffer)

  @restore_ownership   = restore_ownership
  @restore_permissions = restore_permissions
  @restore_times       = restore_times
  @compression_level   = compression_level
end

Instance Attribute Details

#name ⇒ Object (readonly)

The name of this zip archive.



60
61
62
 
# File 'lib/zip/file.rb', line 60

def name
  @name
end

#restore_ownership ⇒ Object

default -> false.



63
64
65
 
# File 'lib/zip/file.rb', line 63

def restore_ownership
  @restore_ownership
end

#restore_permissions ⇒ Object

default -> true.



66
67
68
 
# File 'lib/zip/file.rb', line 66

def restore_permissions
  @restore_permissions
end

#restore_times ⇒ Object

default -> true.



69
70
71
 
# File 'lib/zip/file.rb', line 69

def restore_times
  @restore_times
end

Class Method Details

.count_entries(path_or_io) ⇒ Object

Count the entries in a zip archive without reading the whole set of entry data into memory.



164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/zip/file.rb', line 164

def count_entries(path_or_io)
  cdir = ::Zip::CentralDirectory.new

  if path_or_io.kind_of?(String)
    ::File.open(path_or_io, 'rb') do |f|
      cdir.count_entries(f)
    end
  else
    cdir.count_entries(path_or_io)
  end
end

.foreach(zip_file_name, &block) ⇒ Object

Iterates over the contents of the ZipFile. This is more efficient than using a ZipInputStream since this methods simply iterates through the entries in the central directory structure in the archive whereas ZipInputStream jumps through the entire archive accessing the local entry headers (which contain the same information as the central directory).



156
157
158
159
160
 
# File 'lib/zip/file.rb', line 156

def foreach(zip_file_name, &block)
  ::Zip::File.open(zip_file_name) do |zip_file|
    zip_file.each(&block)
  end
end

.open(file_name, create: false, restore_ownership: , restore_permissions: , restore_times: , compression_level: ::Zip.default_compression) ⇒ Object

Similar to ::new. If a block is passed the Zip::File object is passed to the block and is automatically closed afterwards, just as with ruby’s builtin File::open method.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/zip/file.rb', line 97

def open(file_name, create: false,
         restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
         restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
         restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
         compression_level: ::Zip.default_compression)
  zf = ::Zip::File.new(file_name, create:              create,
                                  restore_ownership:   restore_ownership,
                                  restore_permissions: restore_permissions,
                                  restore_times:       restore_times,
                                  compression_level:   compression_level)

  return zf unless block_given?

  begin
    yield zf
  ensure
    zf.close
  end
end

.open_buffer(io = ::StringIO.new, create: false, restore_ownership: , restore_permissions: , restore_times: , compression_level: ::Zip.default_compression) {|zf| ... } ⇒ Object

Like #open, but reads zip archive contents from a String or open IO stream, and outputs data to a buffer. (This can be used to extract data from a downloaded zip archive without first saving it to disk.)

Yields:

  • (zf) 


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
 
# File 'lib/zip/file.rb', line 121

def open_buffer(io = ::StringIO.new, create: false,
                restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
                restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
                restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
                compression_level: ::Zip.default_compression)
  unless IO_METHODS.map { |method| io.respond_to?(method) }.all? || io.kind_of?(String)
    raise 'Zip::File.open_buffer expects a String or IO-like argument' \
          "(responds to #{IO_METHODS.join(', ')}). Found: #{io.class}"
  end

  io = ::StringIO.new(io) if io.kind_of?(::String)

  zf = ::Zip::File.new(io, create: create, buffer: true,
                           restore_ownership:   restore_ownership,
                           restore_permissions: restore_permissions,
                           restore_times:       restore_times,
                           compression_level:   compression_level)

  return zf unless block_given?

  yield zf

  begin
    zf.write_buffer(io)
  rescue IOError => e
    raise unless e.message == 'not opened for writing'
  end
end

Instance Method Details

#add(entry, src_path, &continue_on_exists_proc) ⇒ Object

Convenience method for adding the contents of a file to the archive



225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/zip/file.rb', line 225

def add(entry, src_path, &continue_on_exists_proc)
  continue_on_exists_proc ||= proc { ::Zip.continue_on_exists_proc }
  check_entry_exists(entry, continue_on_exists_proc, 'add')
  new_entry = if entry.kind_of?(::Zip::Entry)
                entry
              else
                ::Zip::Entry.new(
                  @name, entry.to_s,
                  compression_level: @compression_level
                )
              end
  new_entry.gather_fileinfo_from_srcpath(src_path)
  @cdir << new_entry
end

#add_stored(entry, src_path, &continue_on_exists_proc) ⇒ Object

Convenience method for adding the contents of a file to the archive in Stored format (uncompressed)



242
243
244
245
246
247
 
# File 'lib/zip/file.rb', line 242

def add_stored(entry, src_path, &continue_on_exists_proc)
  entry = ::Zip::Entry.new(
    @name, entry.to_s, compression_method: ::Zip::Entry::STORED
  )
  add(entry, src_path, &continue_on_exists_proc)
end

#close ⇒ Object

Closes the zip file committing any changes that has been made.



312
313
314
 
# File 'lib/zip/file.rb', line 312

def close
  commit
end

#commit ⇒ Object

Commits changes that has been made since the previous commit to the zip archive.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/zip/file.rb', line 285

def commit
  return if name.kind_of?(StringIO) || !commit_required?

  on_success_replace do |tmp_file|
    ::Zip::OutputStream.open(tmp_file) do |zos|
      @cdir.each do |e|
        e.write_to_zip_output_stream(zos)
        e.clean_up
      end
      zos.comment = comment
    end
    true
  end
  initialize_cdir(@name)
end

#commit_required? ⇒ Boolean

Returns true if any changes has been made to this archive since the previous commit

Returns:

  • (Boolean) 


318
319
320
321
322
323
324
325
326
 
# File 'lib/zip/file.rb', line 318

def commit_required?
  return true if @create || @cdir.dirty?

  @cdir.each do |e|
    return true if e.dirty?
  end

  false
end

#extract(entry, entry_path = nil, destination_directory: '.', &block) ⇒ Object

Extracts ‘entry` to a file at `entry_path`, with `destination_directory` as the base location in the filesystem.

NB: The caller is responsible for making sure ‘destination_directory` is safe, if it is passed.



276
277
278
279
280
281
 
# File 'lib/zip/file.rb', line 276

def extract(entry, entry_path = nil, destination_directory: '.', &block)
  block ||= proc { ::Zip.on_exists_proc }
  found_entry = get_entry(entry)
  entry_path ||= found_entry.name
  found_entry.extract(entry_path, destination_directory: destination_directory, &block)
end

#find_entry(entry_name) ⇒ Object

Searches for entry with the specified name. Returns nil if no entry is found. See also get_entry



330
331
332
333
334
335
336
337
338
 
# File 'lib/zip/file.rb', line 330

def find_entry(entry_name)
  selected_entry = @cdir.find_entry(entry_name)
  return if selected_entry.nil?

  selected_entry.restore_ownership   = @restore_ownership
  selected_entry.restore_permissions = @restore_permissions
  selected_entry.restore_times       = @restore_times
  selected_entry
end

#get_entry(entry) ⇒ Object

Searches for an entry just as find_entry, but throws Errno::ENOENT if no entry is found.

Raises:

  • (Errno::ENOENT) 


342
343
344
345
346
347
 
# File 'lib/zip/file.rb', line 342

def get_entry(entry)
  selected_entry = find_entry(entry)
  raise Errno::ENOENT, entry if selected_entry.nil?

  selected_entry
end

#get_input_stream(entry, &a_proc) ⇒ Object

Returns an input stream to the specified entry. If a block is passed the stream object is passed to the block and the stream is automatically closed afterwards just as with ruby’s builtin File.open method.



180
181
182
 
# File 'lib/zip/file.rb', line 180

def get_input_stream(entry, &a_proc)
  get_entry(entry).get_input_stream(&a_proc)
end

#get_output_stream(entry, permissions: nil, comment: nil, extra: nil, compressed_size: nil, crc: nil, compression_method: nil, compression_level: nil, size: nil, time: nil, &a_proc) ⇒ Object

Returns an output stream to the specified entry. If entry is not an instance of Zip::Entry, a new Zip::Entry will be initialized using the arguments specified. If a block is passed the stream object is passed to the block and the stream is automatically closed afterwards just as with ruby’s builtin File.open method.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/zip/file.rb', line 189

def get_output_stream(entry, permissions: nil, comment: nil,
                      extra: nil, compressed_size: nil, crc: nil,
                      compression_method: nil, compression_level: nil,
                      size: nil, time: nil, &a_proc)
  new_entry =
    if entry.kind_of?(Entry)
      entry
    else
      Entry.new(
        @name, entry.to_s, comment: comment, extra: extra,
        compressed_size: compressed_size, crc: crc, size: size,
        compression_method: compression_method,
        compression_level: compression_level, time: time
      )
    end
  if new_entry.directory?
    raise ArgumentError,
          "cannot open stream to directory entry - '#{new_entry}'"
  end
  new_entry.unix_perms = permissions
  zip_streamable_entry = StreamableStream.new(new_entry)
  @cdir << zip_streamable_entry
  zip_streamable_entry.get_output_stream(&a_proc)
end

#mkdir(entry_name, permission = 0o755) ⇒ Object

Creates a directory

Raises:

  • (Errno::EEXIST) 


350
351
352
353
354
355
356
 
# File 'lib/zip/file.rb', line 350

def mkdir(entry_name, permission = 0o755)
  raise Errno::EEXIST, "File exists - #{entry_name}" if find_entry(entry_name)

  entry_name = entry_name.dup.to_s
  entry_name << '/' unless entry_name.end_with?('/')
  @cdir << ::Zip::StreamableDirectory.new(@name, entry_name, nil, permission)
end

#read(entry) ⇒ Object

Returns a string containing the contents of the specified entry



220
221
222
 
# File 'lib/zip/file.rb', line 220

def read(entry)
  get_input_stream(entry, &:read)
end

#remove(entry) ⇒ Object

Removes the specified entry.



250
251
252
 
# File 'lib/zip/file.rb', line 250

def remove(entry)
  @cdir.delete(get_entry(entry))
end

#rename(entry, new_name, &continue_on_exists_proc) ⇒ Object

Renames the specified entry.



255
256
257
258
259
260
261
 
# File 'lib/zip/file.rb', line 255

def rename(entry, new_name, &continue_on_exists_proc)
  found_entry = get_entry(entry)
  check_entry_exists(new_name, continue_on_exists_proc, 'rename')
  @cdir.delete(found_entry)
  found_entry.name = new_name
  @cdir << found_entry
end

#replace(entry, src_path) ⇒ Object

Replaces the specified entry with the contents of src_path (from the file system).



265
266
267
268
269
 
# File 'lib/zip/file.rb', line 265

def replace(entry, src_path)
  check_file(src_path)
  remove(entry)
  add(entry, src_path)
end

#to_s ⇒ Object

Returns the name of the zip archive



215
216
217
 
# File 'lib/zip/file.rb', line 215

def to_s
  @name
end

#write_buffer(io = ::StringIO.new) ⇒ Object

Write buffer write changes to buffer and return



302
303
304
305
306
307
308
309
 
# File 'lib/zip/file.rb', line 302

def write_buffer(io = ::StringIO.new)
  return io unless commit_required?

  ::Zip::OutputStream.write_buffer(io) do |zos|
    @cdir.each { |e| e.write_to_zip_output_stream(zos) }
    zos.comment = comment
  end
end