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 = 
::Zip::COMPRESSION_METHOD_STORE
DEFLATED = 
::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 = 
0b100
COMPRESSION_LEVEL_MAX_GPFLAG = 
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

Returns a new instance of Entry.



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

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

Returns the value of attribute comment.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def comment
  @comment
end

#compressed_size ⇒ Object

Returns the value of attribute compressed_size.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def compressed_size
  @compressed_size
end

#compression_level ⇒ Object (readonly)

:nodoc:



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

def compression_level
  @compression_level
end

#crc ⇒ Object

Returns the value of attribute crc.



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

def crc
  @crc
end

#external_file_attributes ⇒ Object

Returns the value of attribute external_file_attributes.



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

def external_file_attributes
  @external_file_attributes
end

#extra ⇒ Object (readonly)

:nodoc:



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

def extra
  @extra
end

#filepath ⇒ Object (readonly)

:nodoc:



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

def filepath
  @filepath
end

#follow_symlinks ⇒ Object

Returns the value of attribute follow_symlinks.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def follow_symlinks
  @follow_symlinks
end

#fstype ⇒ Object

Returns the value of attribute fstype.



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

def fstype
  @fstype
end

#gp_flags ⇒ Object

Returns the value of attribute gp_flags.



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

def gp_flags
  @gp_flags
end

#internal_file_attributes ⇒ Object

Returns the value of attribute internal_file_attributes.



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

def internal_file_attributes
  @internal_file_attributes
end

#local_header_offset ⇒ Object

Returns the value of attribute local_header_offset.



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

def local_header_offset
  @local_header_offset
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def name
  @name
end

#restore_ownership ⇒ Object

Returns the value of attribute restore_ownership.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def restore_ownership
  @restore_ownership
end

#restore_permissions ⇒ Object

Returns the value of attribute restore_permissions.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def restore_permissions
  @restore_permissions
end

#restore_times ⇒ Object

Returns the value of attribute restore_times.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def restore_times
  @restore_times
end

#size ⇒ Object 



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

def size
  @size || 0
end

#unix_gid ⇒ Object

Returns the value of attribute unix_gid.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def unix_gid
  @unix_gid
end

#unix_perms ⇒ Object

Returns the value of attribute unix_perms.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def unix_perms
  @unix_perms
end

#unix_uid ⇒ Object

Returns the value of attribute unix_uid.



23
24
25
 
# File 'lib/zip/entry.rb', line 23

def unix_uid
  @unix_uid
end

Class Method Details

.read_c_dir_entry(io) ⇒ Object

:nodoc:all



278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/zip/entry.rb', line 278

def read_c_dir_entry(io) #:nodoc:all
  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 



291
292
293
294
295
296
297
298
299
 
# File 'lib/zip/entry.rb', line 291

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

Instance Method Details

#<=>(other) ⇒ Object 



597
598
599
 
# File 'lib/zip/entry.rb', line 597

def <=>(other)
  to_s <=> other.to_s
end

#==(other) ⇒ Object 



588
589
590
591
592
593
594
595
 
# File 'lib/zip/entry.rb', line 588

def ==(other)
  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

#atime ⇒ Object 



133
134
135
 
# File 'lib/zip/entry.rb', line 133

def atime
  time(component: :atime)
end

#atime=(value) ⇒ Object 



155
156
157
 
# File 'lib/zip/entry.rb', line 155

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

#calculate_local_header_size ⇒ Object

:nodoc:all



226
227
228
 
# File 'lib/zip/entry.rb', line 226

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

#cdir_header_size ⇒ Object

:nodoc:all



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

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

#check_c_dir_entry_comment_size ⇒ Object

Raises:



452
453
454
455
456
 
# File 'lib/zip/entry.rb', line 452

def check_c_dir_entry_comment_size
  return if @comment && @comment.bytesize == @comment_length

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

#check_c_dir_entry_signature ⇒ Object

Raises:



446
447
448
449
450
 
# File 'lib/zip/entry.rb', line 446

def check_c_dir_entry_signature
  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

Raises:



440
441
442
443
444
 
# File 'lib/zip/entry.rb', line 440

def check_c_dir_entry_static_header_length(buf)
  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

Raises:



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

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

#clean_up ⇒ Object 



691
692
693
 
# File 'lib/zip/entry.rb', line 691

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

#comment_size ⇒ Object 



222
223
224
 
# File 'lib/zip/entry.rb', line 222

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

#compression_method ⇒ Object 



163
164
165
166
167
 
# File 'lib/zip/entry.rb', line 163

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

  @compression_method
end

#compression_method=(method) ⇒ Object 



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

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

#ctime ⇒ Object 



137
138
139
 
# File 'lib/zip/entry.rb', line 137

def ctime
  time(component: :ctime)
end

#ctime=(value) ⇒ Object 



159
160
161
 
# File 'lib/zip/entry.rb', line 159

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

#encrypted? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/zip/entry.rb', line 106

def encrypted?
  gp_flags & 1 == 1
end

#extra_size ⇒ Object 



218
219
220
 
# File 'lib/zip/entry.rb', line 218

def extra_size
  @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.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/zip/entry.rb', line 256

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:



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

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

#file_type_is?(type) ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/zip/entry.rb', line 178

def file_type_is?(type)
  ftype == type
end

#ftype ⇒ Object

:nodoc:



182
183
184
 
# File 'lib/zip/entry.rb', line 182

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

#gather_fileinfo_from_srcpath(src_path) ⇒ Object

:nodoc:



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

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:



495
496
497
498
499
500
501
502
503
 
# File 'lib/zip/entry.rb', line 495

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.



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/zip/entry.rb', line 603

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 



683
684
685
686
687
688
689
 
# File 'lib/zip/entry.rb', line 683

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

#incomplete? ⇒ Boolean

Returns:

  • (Boolean) 


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

def incomplete?
  gp_flags & 8 == 8
end

#local_entry_offset ⇒ Object

:nodoc:all



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

def local_entry_offset #:nodoc:all
  local_header_offset + @local_header_size
end

#name_is_directory? ⇒ Boolean

:nodoc:all

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/zip/entry.rb', line 193

def name_is_directory? #:nodoc:all
  @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) 


200
201
202
203
204
205
206
207
208
 
# File 'lib/zip/entry.rb', line 200

def name_safe?
  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 



214
215
216
 
# File 'lib/zip/entry.rb', line 214

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

#next_header_offset ⇒ Object

:nodoc:all



247
248
249
 
# File 'lib/zip/entry.rb', line 247

def next_header_offset #:nodoc:all
  local_entry_offset + compressed_size
end

#pack_c_dir_entry ⇒ Object 



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/zip/entry.rb', line 532

def pack_c_dir_entry
  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 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/zip/entry.rb', line 359

def pack_local_entry
  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 



677
678
679
680
681
 
# File 'lib/zip/entry.rb', line 677

def parent_as_string
  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:all



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/zip/entry.rb', line 466

def read_c_dir_entry(io) #:nodoc:all
  @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 



458
459
460
461
462
463
464
 
# File 'lib/zip/entry.rb', line 458

def read_extra_field(buf, local: false)
  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:all



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/zip/entry.rb', line 317

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

  static_sized_fields_buf = io.read(::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH) || ''

  unless static_sized_fields_buf.bytesize == ::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH
    raise Error, 'Premature end of file. Not enough data for zip entry local header'
  end

  unpack_local_entry(static_sized_fields_buf)

  unless @header_signature == LOCAL_ENTRY_SIGNATURE
    if @header_signature == SPLIT_FILE_SIGNATURE
      raise SplitArchiveError
    end

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

  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 



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

def set_default_vars_values
  @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



518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/zip/entry.rb', line 518

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 



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

def set_ftype_from_c_dir_entry
  @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



506
507
508
509
510
511
512
513
514
515
 
# File 'lib/zip/entry.rb', line 506

def set_unix_attributes_on_path(dest_path)
  # 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 



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/zip/entry.rb', line 118

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= 



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/zip/entry.rb', line 141

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 



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

def to_s
  @name
end

#unpack_c_dir_entry(buf) ⇒ Object 



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/zip/entry.rb', line 386

def unpack_c_dir_entry(buf)
  @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 



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

def unpack_local_entry(buf)
  @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:



232
233
234
235
236
237
238
239
240
 
# File 'lib/zip/entry.rb', line 232

def verify_local_header_size!
  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:all



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

def write_c_dir_entry(io) #:nodoc:all
  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:all



374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/zip/entry.rb', line 374

def write_local_entry(io, rewrite: false) #:nodoc:all
  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:all



664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/zip/entry.rb', line 664

def write_to_zip_output_stream(zip_output_stream) #:nodoc:all
  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

Returns:

  • (Boolean) 


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

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