Class: Zip::ZipCentralDirectory

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/zip/zip_central_directory.rb

Direct Known Subclasses

ZipFile

Constant Summary collapse

END_OF_CENTRAL_DIRECTORY_SIGNATURE = 
0x06054b50
MAX_END_OF_CENTRAL_DIRECTORY_STRUCTURE_SIZE = 
65536 + 18
STATIC_EOCD_SIZE = 
22

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(entries = ZipEntrySet.new, comment = "") ⇒ ZipCentralDirectory

:nodoc:



16
17
18
19
20
 
# File 'lib/zip/zip_central_directory.rb', line 16

def initialize(entries = ZipEntrySet.new, comment = "")  #:nodoc:
  super()
  @entrySet = entries.kind_of?(ZipEntrySet) ? entries : ZipEntrySet.new(entries)
  @comment = comment
end

Instance Attribute Details

#comment ⇒ Object (readonly)

Returns the value of attribute comment.



9
10
11
 
# File 'lib/zip/zip_central_directory.rb', line 9

def comment
  @comment
end

Class Method Details

.read_from_stream(io) ⇒ Object

:nodoc:



128
129
130
131
132
133
134
 
# File 'lib/zip/zip_central_directory.rb', line 128

def ZipCentralDirectory.read_from_stream(io)  #:nodoc:
  cdir  = new
  cdir.read_from_stream(io)
  return cdir
rescue ZipError
  return nil
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:



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

def ==(other) #:nodoc:
  return false unless other.kind_of?(ZipCentralDirectory)
  @entrySet.entries.sort == other.entries.sort && comment == other.comment
end

#each(&proc) ⇒ Object

For iterating over the entries.



118
119
120
 
# File 'lib/zip/zip_central_directory.rb', line 118

def each(&proc)
  @entrySet.each(&proc)
end

#entries ⇒ Object

Returns an Enumerable containing the entries.



12
13
14
 
# File 'lib/zip/zip_central_directory.rb', line 12

def entries
  @entrySet.entries
end

#get_e_o_c_d(io) ⇒ Object

:nodoc:

Raises:



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
112
113
114
115
 
# File 'lib/zip/zip_central_directory.rb', line 85

def get_e_o_c_d(io)  #:nodoc:
  begin
    io.seek(-MAX_END_OF_CENTRAL_DIRECTORY_STRUCTURE_SIZE, IO::SEEK_END)
  rescue Errno::EINVAL
    io.seek(0, IO::SEEK_SET)
  rescue Errno::EFBIG # FreeBSD 4.9 raise Errno::EFBIG instead of Errno::EINVAL
    io.seek(0, IO::SEEK_SET)
  end

  # 'buf = io.read' substituted with lump of code to work around FreeBSD 4.5 issue
  retried = false
  buf = nil
  begin
    buf = io.read
  rescue Errno::EFBIG # FreeBSD 4.5 may raise Errno::EFBIG
    raise if (retried)
    retried = true
    io.seek(0, IO::SEEK_SET)
    retry
  end

  sigIndex = buf.rindex([END_OF_CENTRAL_DIRECTORY_SIGNATURE].pack('V'))
  raise ZipError, "Zip end of central directory signature not found" unless sigIndex
  buf = buf.slice!((sigIndex + 4)...(buf.bytesize))

  def buf.read(count)
    slice!(0, count)
  end

  buf
end

#read_central_directory_entries(io) ⇒ Object

:nodoc:



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/zip/zip_central_directory.rb', line 67

def read_central_directory_entries(io)  #:nodoc:
  begin
    io.seek(@cdirOffset, IO::SEEK_SET)
  rescue Errno::EINVAL
    raise ZipError, "Zip consistency problem while reading central directory entry"
  end
  @entrySet = ZipEntrySet.new
  @size.times do
    tmp = ZipEntry.read_c_dir_entry(io)
    @entrySet << tmp
  end
end

#read_e_o_c_d(io) ⇒ Object

:nodoc:

Raises:



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/zip/zip_central_directory.rb', line 54

def read_e_o_c_d(io) #:nodoc:
  buf = get_e_o_c_d(io)
  @numberOfThisDisk                     = ZipEntry.read_zip_short(buf)
  @numberOfDiskWithStartOfCDir          = ZipEntry.read_zip_short(buf)
  @totalNumberOfEntriesInCDirOnThisDisk = ZipEntry.read_zip_short(buf)
  @size                                 = ZipEntry.read_zip_short(buf)
  @sizeInBytes                          = ZipEntry.read_zip_long(buf)
  @cdirOffset                           = ZipEntry.read_zip_long(buf)
  commentLength                         = ZipEntry.read_zip_short(buf)
  @comment                              = buf.read(commentLength)
  raise ZipError, "Zip consistency problem while reading eocd structure" unless buf.size == 0
end

#read_from_stream(io) ⇒ Object

:nodoc:



80
81
82
83
 
# File 'lib/zip/zip_central_directory.rb', line 80

def read_from_stream(io)  #:nodoc:
  read_e_o_c_d(io)
  read_central_directory_entries(io)
end

#size ⇒ Object

Returns the number of entries in the central directory (and consequently in the zip archive).



124
125
126
 
# File 'lib/zip/zip_central_directory.rb', line 124

def size
  @entrySet.size
end

#write_to_stream(io) ⇒ Object

:nodoc:



22
23
24
25
26
 
# File 'lib/zip/zip_central_directory.rb', line 22

def write_to_stream(io)  #:nodoc:
  offset = io.tell
  @entrySet.each { |entry| entry.write_c_dir_entry(io) }
  write_e_o_c_d(io, offset)
end