Class: Gem::Package::TarWriter

Inherits:
Object
  • Object
show all
Defined in:
lib/rubygems/package/tar_writer.rb

Overview

Allows writing of tar files

Defined Under Namespace

Classes: BoundedStream, FileOverflow, RestrictedStream

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(io) ⇒ TarWriter

Creates a new TarWriter that will write to io



94
95
96
97
 
# File 'lib/rubygems/package/tar_writer.rb', line 94

def initialize(io)
  @io = io
  @closed = false
end

Class Method Details

.new(io) ⇒ Object

Creates a new TarWriter, yielding it if a block is given



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/rubygems/package/tar_writer.rb', line 77

def self.new(io)
  writer = super

  return writer unless block_given?

  begin
    yield writer
  ensure
    writer.close
  end

  nil
end

Instance Method Details

#add_file(name, mode) {|RestrictedStream.new(@io)| ... } ⇒ Object

Adds file name with permissions mode, and yields an IO for writing the file to

Yields:

Raises:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/rubygems/package/tar_writer.rb', line 103

def add_file(name, mode) # :yields: io
  check_closed

  raise Gem::Package::NonSeekableIO unless @io.respond_to? :pos=

  name, prefix = split_name name

  init_pos = @io.pos
  @io.write "\0" * 512 # placeholder for the header

  yield RestrictedStream.new(@io) if block_given?

  size = @io.pos - init_pos - 512

  remainder = (512 - (size % 512)) % 512
  @io.write "\0" * remainder

  final_pos = @io.pos
  @io.pos = init_pos

  header = Gem::Package::TarHeader.new :name => name, :mode => mode,
                                       :size => size, :prefix => prefix

  @io.write header
  @io.pos = final_pos

  self
end

#add_file_digest(name, mode, digest_algorithms) ⇒ Object

Adds name with permissions mode to the tar, yielding io for writing the file. The digest_algorithm is written to a read-only name.sum file following the given file contents containing the digest name and hexdigest separated by a tab.

The created digest object is returned.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/rubygems/package/tar_writer.rb', line 140

def add_file_digest name, mode, digest_algorithms # :yields: io
  digests = digest_algorithms.map do |digest_algorithm|
    digest = digest_algorithm.new
    [digest.name, digest]
  end

  digests = Hash[*digests.flatten]

  add_file name, mode do |io|
    Gem::Package::DigestIO.wrap io, digests do |digest_io|
      yield digest_io
    end
  end

  digests
end

#add_file_signed(name, mode, signer) ⇒ Object

Adds name with permissions mode to the tar, yielding io for writing the file. The signer is used to add a digest file using its digest_algorithm per add_file_digest and a cryptographic signature in name.sig. If the signer has no key only the checksum file is added.

Returns the digest.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/rubygems/package/tar_writer.rb', line 165

def add_file_signed name, mode, signer
  digest_algorithms = [
    signer.digest_algorithm,
    OpenSSL::Digest::SHA512,
  ].uniq

  digests = add_file_digest name, mode, digest_algorithms do |io|
    yield io
  end

  signature_digest = digests.values.find do |digest|
    digest.name == signer.digest_name
  end

  signature = signer.sign signature_digest.digest

  add_file_simple "#{name}.sig", 0444, signature.length do |io|
    io.write signature
  end if signature

  digests
end

#add_file_simple(name, mode, size) {|os| ... } ⇒ Object

Add file name with permissions mode size bytes long. Yields an IO to write the file to.

Yields:

  • (os) 


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/rubygems/package/tar_writer.rb', line 192

def add_file_simple(name, mode, size) # :yields: io
  check_closed

  name, prefix = split_name name

  header = Gem::Package::TarHeader.new(:name => name, :mode => mode,
                                       :size => size, :prefix => prefix).to_s

  @io.write header
  os = BoundedStream.new @io, size

  yield os if block_given?

  min_padding = size - os.written
  @io.write("\0" * min_padding)

  remainder = (512 - (size % 512)) % 512
  @io.write("\0" * remainder)

  self
end

#check_closed ⇒ Object

Raises IOError if the TarWriter is closed

Raises:

  • (IOError) 


217
218
219
 
# File 'lib/rubygems/package/tar_writer.rb', line 217

def check_closed
  raise IOError, "closed #{self.class}" if closed?
end

#close ⇒ Object

Closes the TarWriter



224
225
226
227
228
229
230
231
 
# File 'lib/rubygems/package/tar_writer.rb', line 224

def close
  check_closed

  @io.write "\0" * 1024
  flush

  @closed = true
end

#closed? ⇒ Boolean

Is the TarWriter closed?

Returns:

  • (Boolean) 


236
237
238
 
# File 'lib/rubygems/package/tar_writer.rb', line 236

def closed?
  @closed
end

#flush ⇒ Object

Flushes the TarWriter’s IO



243
244
245
246
247
 
# File 'lib/rubygems/package/tar_writer.rb', line 243

def flush
  check_closed

  @io.flush if @io.respond_to? :flush
end

#mkdir(name, mode) ⇒ Object

Creates a new directory in the tar file name with mode



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/rubygems/package/tar_writer.rb', line 252

def mkdir(name, mode)
  check_closed

  name, prefix = split_name(name)

  header = Gem::Package::TarHeader.new :name => name, :mode => mode,
                                       :typeflag => "5", :size => 0,
                                       :prefix => prefix

  @io.write header

  self
end

#split_name(name) ⇒ Object

Splits name into a name and prefix that can fit in the TarHeader

Raises:



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/rubygems/package/tar_writer.rb', line 269

def split_name(name) # :nodoc:
  raise Gem::Package::TooLongFileName if name.bytesize > 256

  if name.bytesize <= 100 then
    prefix = ""
  else
    parts = name.split(/\//)
    newname = parts.pop
    nxt = ""

    loop do
      nxt = parts.pop
      break if newname.bytesize + 1 + nxt.bytesize > 100
      newname = nxt + "/" + newname
    end

    prefix = (parts + [nxt]).join "/"
    name = newname

    if name.bytesize > 100 or prefix.bytesize > 155 then
      raise Gem::Package::TooLongFileName
    end
  end

  return name, prefix
end