Class: Zip::Entry

Inherits:
Object
  • Object
show all
Includes:
Dirtyable
Defined in:
lib/zip/entry.rb

Overview

Zip::Entry represents an entry in a Zip archive.

Direct Known Subclasses

StreamableDirectory, StreamableStream

Constant Summary collapse

STORED =

Constant used to specify that the entry is stored (i.e., not compressed).

::Zip::COMPRESSION_METHOD_STORE
DEFLATED =

Constant used to specify that the entry is deflated (i.e., compressed).

::Zip::COMPRESSION_METHOD_DEFLATE
EFS =

Language encoding flag (EFS) bit

0b100000000000
COMPRESSION_LEVEL_SUPERFAST_GPFLAG =

Compression level flags (used as part of the gp flags).

0b110
COMPRESSION_LEVEL_FAST_GPFLAG =

:nodoc:

0b100
COMPRESSION_LEVEL_MAX_GPFLAG =

:nodoc:

0b010

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dirtyable

#dirty?, included

Constructor Details

#initialize(zipfile = '', name = '', comment: '', size: nil, compressed_size: 0, crc: 0, compression_method: DEFLATED, compression_level: ::Zip.default_compression, time: ::Zip::DOSTime.now, extra: ::Zip::ExtraField.new) ⇒ Entry

Create a new Zip::Entry.



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

def initialize(
  zipfile = '', name = '',
  comment: '', size: nil, compressed_size: 0, crc: 0,
  compression_method: DEFLATED,
  compression_level: ::Zip.default_compression,
  time: ::Zip::DOSTime.now, extra: ::Zip::ExtraField.new
)
  super()
  @name = name
  check_name(@name)

  set_default_vars_values
  @fstype = ::Zip::RUNNING_ON_WINDOWS ? ::Zip::FSTYPE_FAT : ::Zip::FSTYPE_UNIX

  @zipfile            = zipfile
  @comment            = comment || ''
  @compression_method = compression_method || DEFLATED
  @compression_level  = compression_level || ::Zip.default_compression
  @compressed_size    = compressed_size || 0
  @crc                = crc || 0
  @size               = size
  @time               = case time
                        when ::Zip::DOSTime
                          time
                        when Time
                          ::Zip::DOSTime.from_time(time)
                        else
                          ::Zip::DOSTime.now
                        end
  @extra              =
    extra.kind_of?(ExtraField) ? extra : ExtraField.new(extra.to_s)

  set_compression_level_flags
end

Instance Attribute Details

#comment ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def comment
  @comment
end

#compressed_size ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def compressed_size
  @compressed_size
end

#compression_level ⇒ Object (readonly)

:nodoc:



33
34
35
 
# File 'lib/zip/entry.rb', line 33

def compression_level
  @compression_level
end

#crc ⇒ Object

Returns the value of attribute crc.



30
31
32
 
# File 'lib/zip/entry.rb', line 30

def crc
  @crc
end

#external_file_attributes ⇒ Object

Returns the value of attribute external_file_attributes.



30
31
32
 
# File 'lib/zip/entry.rb', line 30

def external_file_attributes
  @external_file_attributes
end

#extra ⇒ Object (readonly)

:nodoc:



33
34
35
 
# File 'lib/zip/entry.rb', line 33

def extra
  @extra
end

#filepath ⇒ Object (readonly)

:nodoc:



33
34
35
 
# File 'lib/zip/entry.rb', line 33

def filepath
  @filepath
end

#follow_symlinks ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def follow_symlinks
  @follow_symlinks
end

#fstype ⇒ Object

Returns the value of attribute fstype.



30
31
32
 
# File 'lib/zip/entry.rb', line 30

def fstype
  @fstype
end

#gp_flags ⇒ Object

Returns the value of attribute gp_flags.



30
31
32
 
# File 'lib/zip/entry.rb', line 30

def gp_flags
  @gp_flags
end

#internal_file_attributes ⇒ Object

Returns the value of attribute internal_file_attributes.



30
31
32
 
# File 'lib/zip/entry.rb', line 30

def internal_file_attributes
  @internal_file_attributes
end

#local_header_offset ⇒ Object

Returns the value of attribute local_header_offset.



30
31
32
 
# File 'lib/zip/entry.rb', line 30

def local_header_offset
  @local_header_offset
end

#name ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def name
  @name
end

#restore_ownership ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def restore_ownership
  @restore_ownership
end

#restore_permissions ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def restore_permissions
  @restore_permissions
end

#restore_times ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def restore_times
  @restore_times
end

#size ⇒ Object

The uncompressed size of the entry.



120
121
122
 
# File 'lib/zip/entry.rb', line 120

def size
  @size || 0
end

#unix_gid ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def unix_gid
  @unix_gid
end

#unix_perms ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def unix_perms
  @unix_perms
end

#unix_uid ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/zip/entry.rb', line 26

def unix_uid
  @unix_uid
end

Class Method Details

.read_c_dir_entry(io) ⇒ Object

:nodoc:



305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/zip/entry.rb', line 305

def read_c_dir_entry(io) # :nodoc:
  path = if io.respond_to?(:path)
           io.path
         else
           io
         end
  entry = new(path)
  entry.read_c_dir_entry(io)
  entry
rescue Error
  nil
end

.read_local_entry(io) ⇒ Object

:nodoc:



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

def read_local_entry(io) # :nodoc:
  entry = new(io)
  entry.read_local_entry(io)
  entry
rescue SplitArchiveError
  raise
rescue Error
  nil
end

Instance Method Details

#<=>(other) ⇒ Object

:nodoc:



625
626
627
 
# File 'lib/zip/entry.rb', line 625

def <=>(other) # :nodoc:
  to_s <=> other.to_s
end

#==(other) ⇒ Object

:nodoc:



616
617
618
619
620
621
622
623
 
# File 'lib/zip/entry.rb', line 616

def ==(other) # :nodoc:
  return false unless other.class == self.class

  # Compares contents of local entry and exposed fields
  %w[compression_method crc compressed_size size name extra filepath time].all? do |k|
    other.__send__(k.to_sym) == __send__(k.to_sym)
  end
end

#absolute_time? ⇒ Boolean

Does this entry return time fields with accurate timezone information?

Returns:

  • (Boolean) 


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

def absolute_time?
  @extra.member?('UniversalTime') || @extra.member?('NTFS')
end

#atime ⇒ Object

Get the last access time of this entry, if available.



143
144
145
 
# File 'lib/zip/entry.rb', line 143

def atime
  time(component: :atime)
end

#atime=(value) ⇒ Object

Set the last access time of this entry.



170
171
172
 
# File 'lib/zip/entry.rb', line 170

def atime=(value)
  send(:time=, value, component: :atime)
end

#calculate_local_header_size ⇒ Object

:nodoc:



253
254
255
 
# File 'lib/zip/entry.rb', line 253

def calculate_local_header_size # :nodoc:
  LOCAL_ENTRY_STATIC_HEADER_LENGTH + name_size + extra_size
end

#cdir_header_size ⇒ Object

:nodoc:



269
270
271
272
 
# File 'lib/zip/entry.rb', line 269

def cdir_header_size # :nodoc:
  CDIR_ENTRY_STATIC_HEADER_LENGTH + name_size +
    (@extra ? @extra.c_dir_size : 0) + comment_size
end

#check_c_dir_entry_comment_size ⇒ Object

:nodoc:

Raises:



480
481
482
483
484
 
# File 'lib/zip/entry.rb', line 480

def check_c_dir_entry_comment_size # :nodoc:
  return if @comment && @comment.bytesize == @comment_length

  raise ::Zip::Error, 'Truncated cdir zip entry header'
end

#check_c_dir_entry_signature ⇒ Object

:nodoc:

Raises:



474
475
476
477
478
 
# File 'lib/zip/entry.rb', line 474

def check_c_dir_entry_signature # :nodoc:
  return if @header_signature == ::Zip::CENTRAL_DIRECTORY_ENTRY_SIGNATURE

  raise Error, "Zip local header magic not found at location '#{local_header_offset}'"
end

#check_c_dir_entry_static_header_length(buf) ⇒ Object

:nodoc:

Raises:



468
469
470
471
472
 
# File 'lib/zip/entry.rb', line 468

def check_c_dir_entry_static_header_length(buf) # :nodoc:
  return unless buf.nil? || buf.bytesize != ::Zip::CDIR_ENTRY_STATIC_HEADER_LENGTH

  raise Error, 'Premature end of file. Not enough data for zip cdir entry header'
end

#check_name(name) ⇒ Object

:nodoc:

Raises:



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

def check_name(name) # :nodoc:
  raise EntryNameError, name if name.start_with?('/')
  raise EntryNameError if name.length > 65_535
end

#clean_up ⇒ Object

:nodoc:



719
720
721
 
# File 'lib/zip/entry.rb', line 719

def clean_up # :nodoc:
  @dirty = false # Any changes are written at this point.
end

#comment_size ⇒ Object

:nodoc:



249
250
251
 
# File 'lib/zip/entry.rb', line 249

def comment_size # :nodoc:
  @comment ? @comment.bytesize : 0
end

#compression_method ⇒ Object

Return the compression method for this entry.

Returns STORED if the entry is a directory or if the compression level is 0.



188
189
190
191
192
 
# File 'lib/zip/entry.rb', line 188

def compression_method
  return STORED if ftype == :directory || @compression_level == 0

  @compression_method
end

#compression_method=(method) ⇒ Object

Set the compression method for this entry.



195
196
197
198
 
# File 'lib/zip/entry.rb', line 195

def compression_method=(method)
  @dirty = true
  @compression_method = (ftype == :directory ? STORED : method)
end

#ctime ⇒ Object

Get the creation time of this entry, if available.



148
149
150
 
# File 'lib/zip/entry.rb', line 148

def ctime
  time(component: :ctime)
end

#ctime=(value) ⇒ Object

Set the creation time of this entry.



175
176
177
 
# File 'lib/zip/entry.rb', line 175

def ctime=(value)
  send(:time=, value, component: :ctime)
end

#encrypted? ⇒ Boolean

Is this entry encrypted?

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/zip/entry.rb', line 111

def encrypted?
  gp_flags & 1 == 1
end

#extra_size ⇒ Object

:nodoc:



245
246
247
 
# File 'lib/zip/entry.rb', line 245

def extra_size # :nodoc:
  @extra ? @extra.local_size : 0
end

#extract(entry_path = @name, destination_directory: '.', &block) ⇒ Object

Extracts this 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.



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

def extract(entry_path = @name, destination_directory: '.', &block)
  dest_dir = ::File.absolute_path(destination_directory || '.')
  extract_path = ::File.absolute_path(::File.join(dest_dir, entry_path))

  unless extract_path.start_with?(dest_dir)
    warn "WARNING: skipped extracting '#{@name}' to '#{extract_path}' as unsafe."
    return self
  end

  block ||= proc { ::Zip.on_exists_proc }

  raise "unknown file type #{inspect}" unless directory? || file? || symlink?

  __send__(:"create_#{ftype}", extract_path, &block)
  self
end

#file_stat(path) ⇒ Object

:nodoc:



515
516
517
518
519
520
521
 
# File 'lib/zip/entry.rb', line 515

def file_stat(path) # :nodoc:
  if @follow_symlinks
    ::File.stat(path)
  else
    ::File.lstat(path)
  end
end

#file_type_is?(type) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


205
206
207
 
# File 'lib/zip/entry.rb', line 205

def file_type_is?(type) # :nodoc:
  ftype == type
end

#ftype ⇒ Object

:nodoc:



209
210
211
 
# File 'lib/zip/entry.rb', line 209

def ftype # :nodoc:
  @ftype ||= name_is_directory? ? :directory : :file
end

#gather_fileinfo_from_srcpath(src_path) ⇒ Object

:nodoc:



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/zip/entry.rb', line 663

def gather_fileinfo_from_srcpath(src_path) # :nodoc:
  stat   = file_stat(src_path)
  @ftype = case stat.ftype
           when 'file'
             if name_is_directory?
               raise ArgumentError,
                     "entry name '#{newEntry}' indicates directory entry, but " \
                     "'#{src_path}' is not a directory"
             end
             :file
           when 'directory'
             @name += '/' unless name_is_directory?
             :directory
           when 'link'
             if name_is_directory?
               raise ArgumentError,
                     "entry name '#{newEntry}' indicates directory entry, but " \
                     "'#{src_path}' is not a directory"
             end
             :symlink
           else
             raise "unknown file type: #{src_path.inspect} #{stat.inspect}"
           end

  @filepath = src_path
  @size = stat.size
  get_extra_attributes_from_path(@filepath)
end

#get_extra_attributes_from_path(path) ⇒ Object

:nodoc:



523
524
525
526
527
528
529
530
531
 
# File 'lib/zip/entry.rb', line 523

def get_extra_attributes_from_path(path) # :nodoc:
  stat = file_stat(path)
  @time = DOSTime.from_time(stat.mtime)
  return if ::Zip::RUNNING_ON_WINDOWS

  @unix_uid   = stat.uid
  @unix_gid   = stat.gid
  @unix_perms = stat.mode & 0o7777
end

#get_input_stream(&block) ⇒ Object

Returns an IO like object for the given ZipEntry. Warning: may behave weird with symlinks.



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/zip/entry.rb', line 631

def get_input_stream(&block)
  if ftype == :directory
    yield ::Zip::NullInputStream if block
    ::Zip::NullInputStream
  elsif @filepath
    case ftype
    when :file
      ::File.open(@filepath, 'rb', &block)
    when :symlink
      linkpath = ::File.readlink(@filepath)
      stringio = ::StringIO.new(linkpath)
      yield(stringio) if block
      stringio
    else
      raise "unknown @file_type #{ftype}"
    end
  else
    zis = ::Zip::InputStream.new(@zipfile, offset: local_header_offset)
    zis.instance_variable_set(:@complete_entry, self)
    zis.get_next_entry
    if block
      begin
        yield(zis)
      ensure
        zis.close
      end
    else
      zis
    end
  end
end

#get_raw_input_stream(&block) ⇒ Object

:nodoc:



711
712
713
714
715
716
717
 
# File 'lib/zip/entry.rb', line 711

def get_raw_input_stream(&block) # :nodoc:
  if @zipfile.respond_to?(:seek) && @zipfile.respond_to?(:read)
    yield @zipfile
  else
    ::File.open(@zipfile, 'rb', &block)
  end
end

#incomplete? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/zip/entry.rb', line 115

def incomplete? # :nodoc:
  (gp_flags & 8 == 8) && (crc == 0 || size == 0 || compressed_size == 0)
end

#local_entry_offset ⇒ Object

:nodoc:



237
238
239
 
# File 'lib/zip/entry.rb', line 237

def local_entry_offset # :nodoc:
  local_header_offset + @local_header_size
end

#name_is_directory? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

def name_is_directory? # :nodoc:
  @name.end_with?('/')
end

#name_safe? ⇒ Boolean

Is the name a relative path, free of ‘..` patterns that could lead to path traversal attacks? This does NOT handle symlinks; if the path contains symlinks, this check is NOT enough to guarantee safety.

Returns:

  • (Boolean) 


227
228
229
230
231
232
233
234
235
 
# File 'lib/zip/entry.rb', line 227

def name_safe? # :nodoc:
  cleanpath = Pathname.new(@name).cleanpath
  return false unless cleanpath.relative?

  root = ::File::SEPARATOR
  naive = ::File.join(root, cleanpath.to_s)
  # Allow for Windows drive mappings at the root.
  ::File.absolute_path(cleanpath.to_s, root).match?(/([A-Z]:)?#{naive}/i)
end

#name_size ⇒ Object

:nodoc:



241
242
243
 
# File 'lib/zip/entry.rb', line 241

def name_size # :nodoc:
  @name ? @name.bytesize : 0
end

#next_header_offset ⇒ Object

:nodoc:



274
275
276
 
# File 'lib/zip/entry.rb', line 274

def next_header_offset # :nodoc:
  local_entry_offset + compressed_size
end

#pack_c_dir_entry ⇒ Object

:nodoc:



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/zip/entry.rb', line 560

def pack_c_dir_entry # :nodoc:
  zip64 = @extra['Zip64']
  [
    @header_signature,
    @version, # version of encoding software
    @fstype, # filesystem type
    @version_needed_to_extract, # @versionNeededToExtract
    @gp_flags, # @gp_flags
    compression_method,
    @time.to_binary_dos_time, # @last_mod_time
    @time.to_binary_dos_date, # @last_mod_date
    @crc,
    zip64 && zip64.compressed_size ? 0xFFFFFFFF : @compressed_size,
    zip64 && zip64.original_size ? 0xFFFFFFFF : (@size || 0),
    name_size,
    @extra ? @extra.c_dir_size : 0,
    comment_size,
    zip64 && zip64.disk_start_number ? 0xFFFF : 0, # disk number start
    @internal_file_attributes, # file type (binary=0, text=1)
    @external_file_attributes, # native filesystem attributes
    zip64 && zip64.relative_header_offset ? 0xFFFFFFFF : @local_header_offset,
    @name,
    @extra,
    @comment
  ].pack('VCCvvvvvVVVvvvvvVV')
end

#pack_local_entry ⇒ Object

:nodoc:



387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/zip/entry.rb', line 387

def pack_local_entry # :nodoc:
  zip64 = @extra['Zip64']
  [::Zip::LOCAL_ENTRY_SIGNATURE,
   @version_needed_to_extract, # version needed to extract
   @gp_flags, # @gp_flags
   compression_method,
   @time.to_binary_dos_time, # @last_mod_time
   @time.to_binary_dos_date, # @last_mod_date
   @crc,
   zip64 && zip64.compressed_size ? 0xFFFFFFFF : @compressed_size,
   zip64 && zip64.original_size ? 0xFFFFFFFF : (@size || 0),
   name_size,
   @extra ? @extra.local_size : 0].pack('VvvvvvVVVvv')
end

#parent_as_string ⇒ Object

:nodoc:



705
706
707
708
709
 
# File 'lib/zip/entry.rb', line 705

def parent_as_string # :nodoc:
  entry_name  = name.chomp('/')
  slash_index = entry_name.rindex('/')
  slash_index ? entry_name.slice(0, slash_index + 1) : nil
end

#read_c_dir_entry(io) ⇒ Object

:nodoc:



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/zip/entry.rb', line 494

def read_c_dir_entry(io) # :nodoc:
  @dirty = false # No changes at this point.
  static_sized_fields_buf = io.read(::Zip::CDIR_ENTRY_STATIC_HEADER_LENGTH)
  check_c_dir_entry_static_header_length(static_sized_fields_buf)
  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)
  if ::Zip.force_entry_names_encoding
    @name.force_encoding(::Zip.force_entry_names_encoding)
  end
  @name.tr!('\\', '/') # Normalise filepath separators after encoding set.

  read_extra_field(io.read(@extra_length))
  @comment = io.read(@comment_length)
  check_c_dir_entry_comment_size
  set_ftype_from_c_dir_entry
  parse_zip64_extra(false)
end

#read_extra_field(buf, local: false) ⇒ Object

:nodoc:



486
487
488
489
490
491
492
 
# File 'lib/zip/entry.rb', line 486

def read_extra_field(buf, local: false) # :nodoc:
  if @extra.kind_of?(::Zip::ExtraField)
    @extra.merge(buf, local: local) if buf
  else
    @extra = ::Zip::ExtraField.new(buf, local: local)
  end
end

#read_local_entry(io) ⇒ Object

:nodoc:



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/zip/entry.rb', line 344

def read_local_entry(io) # :nodoc:
  @dirty = false # No changes at this point.
  current_offset = io.tell

  read_local_header_fields(io)

  if @header_signature == SPLIT_FILE_SIGNATURE
    raise SplitArchiveError if current_offset.zero?

    # Rewind, skipping the data descriptor, then try to read the local header again.
    current_offset += 16
    io.seek(current_offset)
    read_local_header_fields(io)
  end

  unless @header_signature == LOCAL_ENTRY_SIGNATURE
    raise Error, "Zip local header magic not found at location '#{current_offset}'"
  end

  @local_header_offset = current_offset

  set_time(@last_mod_date, @last_mod_time)

  @name = io.read(@name_length)
  if ::Zip.force_entry_names_encoding
    @name.force_encoding(::Zip.force_entry_names_encoding)
  end
  @name.tr!('\\', '/') # Normalise filepath separators after encoding set.

  # We need to do this here because `initialize` has so many side-effects.
  # :-(
  @ftype = name_is_directory? ? :directory : :file

  extra = io.read(@extra_length)
  if extra && extra.bytesize != @extra_length
    raise ::Zip::Error, 'Truncated local zip entry header'
  end

  read_extra_field(extra, local: true)
  parse_zip64_extra(true)
  @local_header_size = calculate_local_header_size
end

#set_default_vars_values ⇒ Object

:nodoc:



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

def set_default_vars_values # :nodoc:
  @local_header_offset      = 0
  @local_header_size        = nil # not known until local entry is created or read
  @internal_file_attributes = 1
  @external_file_attributes = 0
  @header_signature         = ::Zip::CENTRAL_DIRECTORY_ENTRY_SIGNATURE

  @version_needed_to_extract = VERSION_NEEDED_TO_EXTRACT
  @version                   = VERSION_MADE_BY

  @ftype           = nil          # unspecified or unknown
  @filepath        = nil
  @gp_flags        = 0
  if ::Zip.unicode_names
    @gp_flags |= EFS
    @version = 63
  end
  @follow_symlinks = false

  @restore_times       = DEFAULT_RESTORE_OPTIONS[:restore_times]
  @restore_permissions = DEFAULT_RESTORE_OPTIONS[:restore_permissions]
  @restore_ownership   = DEFAULT_RESTORE_OPTIONS[:restore_ownership]
  # BUG: need an extra field to support uid/gid's
  @unix_uid            = nil
  @unix_gid            = nil
  @unix_perms          = nil
end

#set_extra_attributes_on_path(dest_path) ⇒ Object

rubocop:enable Style/GuardClause



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/zip/entry.rb', line 546

def set_extra_attributes_on_path(dest_path) # :nodoc:
  return unless file? || directory?

  case @fstype
  when ::Zip::FSTYPE_UNIX
    set_unix_attributes_on_path(dest_path)
  end

  # Restore the timestamp on a file. This will either have come from the
  # original source file that was copied into the archive, or from the
  # creation date of the archive if there was no original source file.
  ::FileUtils.touch(dest_path, mtime: time) if @restore_times
end

#set_ftype_from_c_dir_entry ⇒ Object

:nodoc:



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/zip/entry.rb', line 438

def set_ftype_from_c_dir_entry # :nodoc:
  @ftype = case @fstype
           when ::Zip::FSTYPE_UNIX
             @unix_perms = (@external_file_attributes >> 16) & 0o7777
             case (@external_file_attributes >> 28)
             when ::Zip::FILE_TYPE_DIR
               :directory
             when ::Zip::FILE_TYPE_FILE
               :file
             when ::Zip::FILE_TYPE_SYMLINK
               :symlink
             else
               # Best case guess for whether it is a file or not.
               # Otherwise this would be set to unknown and that
               # entry would never be able to be extracted.
               if name_is_directory?
                 :directory
               else
                 :file
               end
             end
           else
             if name_is_directory?
               :directory
             else
               :file
             end
           end
end

#set_unix_attributes_on_path(dest_path) ⇒ Object

rubocop:disable Style/GuardClause



534
535
536
537
538
539
540
541
542
543
 
# File 'lib/zip/entry.rb', line 534

def set_unix_attributes_on_path(dest_path) # :nodoc:
  # Ignore setuid/setgid bits by default. Honour if @restore_ownership.
  unix_perms_mask = (@restore_ownership ? 0o7777 : 0o1777)
  if @restore_permissions && @unix_perms
    ::FileUtils.chmod(@unix_perms & unix_perms_mask, dest_path)
  end
  if @restore_ownership && @unix_uid && @unix_gid && ::Process.egid == 0
    ::FileUtils.chown(@unix_uid, @unix_gid, dest_path)
  end
end

#time(component: :mtime) ⇒ Object Also known as: mtime

Get a timestamp component of this entry.

Returns modification time by default.



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/zip/entry.rb', line 127

def time(component: :mtime)
  time =
    if @extra['UniversalTime']
      @extra['UniversalTime'].send(component)
    elsif @extra['NTFS']
      @extra['NTFS'].send(component)
    end

  # Standard time field in central directory has local time
  # under archive creator. Then, we can't get timezone.
  time || (@time if component == :mtime)
end

#time=(value, component: :mtime) ⇒ Object Also known as: mtime=

Set a timestamp component of this entry.

Sets modification time by default.



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/zip/entry.rb', line 155

def time=(value, component: :mtime)
  @dirty = true
  unless @extra.member?('UniversalTime') || @extra.member?('NTFS')
    @extra.create('UniversalTime')
  end

  value = DOSTime.from_time(value)
  comp = "#{component}=" unless component.to_s.end_with?('=')
  (@extra['UniversalTime'] || @extra['NTFS']).send(comp, value)
  @time = value if component == :mtime
end

#to_s ⇒ Object

:nodoc:



300
301
302
 
# File 'lib/zip/entry.rb', line 300

def to_s # :nodoc:
  @name
end

#unpack_c_dir_entry(buf) ⇒ Object

:nodoc:



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/zip/entry.rb', line 414

def unpack_c_dir_entry(buf) # :nodoc:
  @header_signature,
    @version, # version of encoding software
    @fstype, # filesystem type
    @version_needed_to_extract,
    @gp_flags,
    @compression_method,
    @last_mod_time,
    @last_mod_date,
    @crc,
    @compressed_size,
    @size,
    @name_length,
    @extra_length,
    @comment_length,
    _, # diskNumberStart
    @internal_file_attributes,
    @external_file_attributes,
    @local_header_offset,
    @name,
    @extra,
    @comment = buf.unpack('VCCvvvvvVVVvvvvvVV')
end

#unpack_local_entry(buf) ⇒ Object

:nodoc:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/zip/entry.rb', line 329

def unpack_local_entry(buf) # :nodoc:
  @header_signature,
    @version,
    @fstype,
    @gp_flags,
    @compression_method,
    @last_mod_time,
    @last_mod_date,
    @crc,
    @compressed_size,
    @size,
    @name_length,
    @extra_length = buf.unpack('VCCvvvvVVVvv')
end

#verify_local_header_size! ⇒ Object

check before rewriting an entry (after file sizes are known) that we didn’t change the header size (and thus clobber file data or something)

Raises:



259
260
261
262
263
264
265
266
267
 
# File 'lib/zip/entry.rb', line 259

def verify_local_header_size! # :nodoc:
  return if @local_header_size.nil?

  new_size = calculate_local_header_size
  return unless @local_header_size != new_size

  raise Error,
        "Local header size changed (#{@local_header_size} -> #{new_size})"
end

#write_c_dir_entry(io) ⇒ Object

:nodoc:



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/zip/entry.rb', line 587

def write_c_dir_entry(io) # :nodoc:
  prep_cdir_zip64_extra

  case @fstype
  when ::Zip::FSTYPE_UNIX
    ft = case ftype
         when :file
           @unix_perms ||= 0o644
           ::Zip::FILE_TYPE_FILE
         when :directory
           @unix_perms ||= 0o755
           ::Zip::FILE_TYPE_DIR
         when :symlink
           @unix_perms ||= 0o755
           ::Zip::FILE_TYPE_SYMLINK
         end

    unless ft.nil?
      @external_file_attributes = ((ft << 12) | (@unix_perms & 0o7777)) << 16
    end
  end

  io << pack_c_dir_entry

  io << @name
  io << (@extra ? @extra.to_c_dir_bin : '')
  io << @comment
end

#write_local_entry(io, rewrite: false) ⇒ Object

:nodoc:



402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/zip/entry.rb', line 402

def write_local_entry(io, rewrite: false) # :nodoc:
  prep_local_zip64_extra
  verify_local_header_size! if rewrite
  @local_header_offset = io.tell

  io << pack_local_entry

  io << @name
  io << @extra.to_local_bin if @extra
  @local_header_size = io.tell - @local_header_offset
end

#write_to_zip_output_stream(zip_output_stream) ⇒ Object

:nodoc:



692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/zip/entry.rb', line 692

def write_to_zip_output_stream(zip_output_stream) # :nodoc:
  if ftype == :directory
    zip_output_stream.put_next_entry(self)
  elsif @filepath
    zip_output_stream.put_next_entry(self)
    get_input_stream do |is|
      ::Zip::IOExtras.copy_stream(zip_output_stream, is)
    end
  else
    zip_output_stream.copy_raw_entry(self)
  end
end

#zip64? ⇒ Boolean

Does this entry use the ZIP64 extensions?

Returns:

  • (Boolean) 


201
202
203
 
# File 'lib/zip/entry.rb', line 201

def zip64?
  !@extra['Zip64'].nil?
end