Class: Zip::Entry

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

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: 0, 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.


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

def initialize(
  zipfile = '', name = '',
  comment: '', size: 0, 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
  @ftype = name_is_directory? ? :directory : :file

  @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 || 0
  @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.


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

def comment
  @comment
end

#compressed_size ⇒ Object

Returns the value of attribute compressed_size.


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

def compressed_size
  @compressed_size
end

#compression_level ⇒ Object (readonly)

:nodoc:


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

def compression_level
  @compression_level
end

#crc ⇒ Object

Returns the value of attribute crc.


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

def crc
  @crc
end

#external_file_attributes ⇒ Object

Returns the value of attribute external_file_attributes.


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

def external_file_attributes
  @external_file_attributes
end

#extra ⇒ Object (readonly)

:nodoc:


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

def extra
  @extra
end

#filepath ⇒ Object (readonly)

:nodoc:


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

def filepath
  @filepath
end

#follow_symlinks ⇒ Object

Returns the value of attribute follow_symlinks.


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

def follow_symlinks
  @follow_symlinks
end

#fstype ⇒ Object

Returns the value of attribute fstype.


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

def fstype
  @fstype
end

#ftype ⇒ Object (readonly)

:nodoc:


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

def ftype
  @ftype
end

#gp_flags ⇒ Object

Returns the value of attribute gp_flags.


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

def gp_flags
  @gp_flags
end

#internal_file_attributes ⇒ Object

Returns the value of attribute internal_file_attributes.


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

def internal_file_attributes
  @internal_file_attributes
end

#local_header_offset ⇒ Object

Returns the value of attribute local_header_offset.


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

def local_header_offset
  @local_header_offset
end

#name ⇒ Object

Returns the value of attribute name.


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

def name
  @name
end

#restore_ownership ⇒ Object

Returns the value of attribute restore_ownership.


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

def restore_ownership
  @restore_ownership
end

#restore_permissions ⇒ Object

Returns the value of attribute restore_permissions.


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

def restore_permissions
  @restore_permissions
end

#restore_times ⇒ Object

Returns the value of attribute restore_times.


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

def restore_times
  @restore_times
end

#size ⇒ Object

Returns the value of attribute size.


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

def size
  @size
end

#unix_gid ⇒ Object

Returns the value of attribute unix_gid.


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

def unix_gid
  @unix_gid
end

#unix_perms ⇒ Object

Returns the value of attribute unix_perms.


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

def unix_perms
  @unix_perms
end

#unix_uid ⇒ Object

Returns the value of attribute unix_uid.


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

def unix_uid
  @unix_uid
end

Class Method Details

.read_c_dir_entry(io) ⇒ Object

:nodoc:all


275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/zip/entry.rb', line 275

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 


288
289
290
291
292
293
294
295
296
 
# File 'lib/zip/entry.rb', line 288

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 


590
591
592
 
# File 'lib/zip/entry.rb', line 590

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

#==(other) ⇒ Object 


581
582
583
584
585
586
587
588
 
# File 'lib/zip/entry.rb', line 581

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 


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

def atime
  time(component: :atime)
end

#atime=(value) ⇒ Object 


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

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

#calculate_local_header_size ⇒ Object

:nodoc:all


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

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

#cdir_header_size ⇒ Object

:nodoc:all


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

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:


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

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:


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

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:


434
435
436
437
438
 
# File 'lib/zip/entry.rb', line 434

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:


63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/zip/entry.rb', line 63

def check_name(name)
  error =
    if name.start_with?('/')
      "Illegal entry name '#{name}'. Names must not start with '/'"
    elsif name.length > 65_535
      'Illegal entry name. Names must have fewer than 65,536 characters'
    else
      ''
    end
  return if error.empty?

  raise EntryNameError, error
end

#clean_up ⇒ Object 


683
684
685
 
# File 'lib/zip/entry.rb', line 683

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

#comment_size ⇒ Object 


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

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

#compression_method ⇒ Object 


166
167
168
169
170
 
# File 'lib/zip/entry.rb', line 166

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

  @compression_method
end

#compression_method=(method) ⇒ Object 


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

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

#ctime ⇒ Object 


140
141
142
 
# File 'lib/zip/entry.rb', line 140

def ctime
  time(component: :ctime)
end

#ctime=(value) ⇒ Object 


162
163
164
 
# File 'lib/zip/entry.rb', line 162

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

#encrypted? ⇒ Boolean

Returns:

  • (Boolean) 

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

def encrypted?
  gp_flags & 1 == 1
end

#extra_size ⇒ Object 


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

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

#extract(dest_path = nil, &block) ⇒ Object

Extracts entry to file dest_path (defaults to @name). NB: The caller is responsible for making sure dest_path is safe, if it is passed.


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

def extract(dest_path = nil, &block)
  if dest_path.nil? && !name_safe?
    warn "WARNING: skipped '#{@name}' as unsafe."
    return self
  end

  dest_path ||= @name
  block ||= proc { ::Zip.on_exists_proc }

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

  __send__("create_#{@ftype}", dest_path, &block)
  self
end

#file_stat(path) ⇒ Object

:nodoc:


481
482
483
484
485
486
487
 
# File 'lib/zip/entry.rb', line 481

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

#file_type_is?(type) ⇒ Boolean

Returns:

  • (Boolean)

Raises:


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

def file_type_is?(type)
  raise InternalError, "current filetype is unknown: #{inspect}" unless @ftype

  @ftype == type
end

#gather_fileinfo_from_srcpath(src_path) ⇒ Object

:nodoc:


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/zip/entry.rb', line 628

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
  get_extra_attributes_from_path(@filepath)
end

#get_extra_attributes_from_path(path) ⇒ Object

:nodoc:


489
490
491
492
493
494
495
496
497
 
# File 'lib/zip/entry.rb', line 489

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.


596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/zip/entry.rb', line 596

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 


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

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) 

117
118
119
 
# File 'lib/zip/entry.rb', line 117

def incomplete?
  gp_flags & 8 == 8
end

#local_entry_offset ⇒ Object

:nodoc:all


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

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

#name_is_directory? ⇒ Boolean

:nodoc:all

Returns:

  • (Boolean) 

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

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) 

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

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 


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

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

#next_header_offset ⇒ Object

:nodoc:all


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

def next_header_offset #:nodoc:all
  local_entry_offset + compressed_size
end

#pack_c_dir_entry ⇒ Object 


526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/zip/entry.rb', line 526

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,
    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 


353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/zip/entry.rb', line 353

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,
   name_size,
   @extra ? @extra.local_size : 0].pack('VvvvvvVVVvv')
end

#parent_as_string ⇒ Object 


669
670
671
672
673
 
# File 'lib/zip/entry.rb', line 669

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


460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/zip/entry.rb', line 460

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 


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

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


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

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,
            'Rubyzip cannot extract from split archives at this time'
    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.

  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 


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

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


512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/zip/entry.rb', line 512

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 


404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/zip/entry.rb', line 404

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


500
501
502
503
504
505
506
507
508
509
 
# File 'lib/zip/entry.rb', line 500

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 


121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/zip/entry.rb', line 121

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= 


144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/zip/entry.rb', line 144

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 


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

def to_s
  @name
end

#unpack_c_dir_entry(buf) ⇒ Object 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/zip/entry.rb', line 380

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 


299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/zip/entry.rb', line 299

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:


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

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


553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/zip/entry.rb', line 553

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


368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/zip/entry.rb', line 368

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


656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/zip/entry.rb', line 656

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) 

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

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