class Gem::Package::TarHeader

A header for a tar file

Constants

FIELDS

Fields in the tar header

PACK_FORMAT

Pack format for a tar header

UNPACK_FORMAT

Unpack format for a tar header

Public Class Methods

from(stream) click to toggle source

Creates a tar header from IO stream

# File lib/rubygems/package/tar_header.rb, line 98
def self.from(stream)
  header = stream.read 512
  empty = (header == "\0" * 512)

  fields = header.unpack UNPACK_FORMAT

  new :name     => fields.shift,
      :mode     => fields.shift.oct,
      :uid      => fields.shift.oct,
      :gid      => fields.shift.oct,
      :size     => fields.shift.oct,
      :mtime    => fields.shift.oct,
      :checksum => fields.shift.oct,
      :typeflag => fields.shift,
      :linkname => fields.shift,
      :magic    => fields.shift,
      :version  => fields.shift.oct,
      :uname    => fields.shift,
      :gname    => fields.shift,
      :devmajor => fields.shift.oct,
      :devminor => fields.shift.oct,
      :prefix   => fields.shift,

      :empty => empty
end
new(vals) click to toggle source

Creates a new TarHeader using vals

# File lib/rubygems/package/tar_header.rb, line 127
def initialize(vals)
  unless vals[:name] && vals[:size] && vals[:prefix] && vals[:mode] then
    raise ArgumentError, ":name, :size, :prefix and :mode required"
  end

  vals[:uid] ||= 0
  vals[:gid] ||= 0
  vals[:mtime] ||= 0
  vals[:checksum] ||= ""
  vals[:typeflag] = "0" if vals[:typeflag].nil? || vals[:typeflag].empty?
  vals[:magic] ||= "ustar"
  vals[:version] ||= "00"
  vals[:uname] ||= "wheel"
  vals[:gname] ||= "wheel"
  vals[:devmajor] ||= 0
  vals[:devminor] ||= 0

  FIELDS.each do |name|
    instance_variable_set "@#{name}", vals[name]
  end

  @empty = vals[:empty]
end

Public Instance Methods

empty?() click to toggle source

Is the tar entry empty?

# File lib/rubygems/package/tar_header.rb, line 154
def empty?
  @empty
end
update_checksum() click to toggle source

Updates the TarHeader's checksum

# File lib/rubygems/package/tar_header.rb, line 186
def update_checksum
  header = header " " * 8
  @checksum = oct calculate_checksum(header), 6
end

Private Instance Methods

calculate_checksum(header) click to toggle source
# File lib/rubygems/package/tar_header.rb, line 193
def calculate_checksum(header)
  header.unpack("C*").inject { |a, b| a + b }
end
header(checksum = @checksum) click to toggle source
# File lib/rubygems/package/tar_header.rb, line 197
def header(checksum = @checksum)
  header = [
    name,
    oct(mode, 7),
    oct(uid, 7),
    oct(gid, 7),
    oct(size, 11),
    oct(mtime, 11),
    checksum,
    " ",
    typeflag,
    linkname,
    magic,
    oct(version, 2),
    uname,
    gname,
    oct(devmajor, 7),
    oct(devminor, 7),
    prefix
  ]

  header = header.pack PACK_FORMAT

  header << ("\0" * ((512 - header.size) % 512))
end
oct(num, len) click to toggle source
# File lib/rubygems/package/tar_header.rb, line 223
def oct(num, len)
  "%0#{len}o" % num
end