Class: Mixlib::Archive::LibArchive

Inherits:
Object
  • Object
show all
Defined in:
lib/mixlib/archive/lib_archive.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(archive, options = {}) ⇒ LibArchive

Returns a new instance of LibArchive.



15
16
17
18
 
# File 'lib/mixlib/archive/lib_archive.rb', line 15

def initialize(archive, options = {})
  @archive = archive
  @options = options
end

Class Attribute Details

.mutex_chdir ⇒ Object

Returns the value of attribute mutex_chdir.



10
11
12
 
# File 'lib/mixlib/archive/lib_archive.rb', line 10

def mutex_chdir
  @mutex_chdir
end

Instance Attribute Details

#archive ⇒ Object (readonly)

Returns the value of attribute archive.



7
8
9
 
# File 'lib/mixlib/archive/lib_archive.rb', line 7

def archive
  @archive
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



6
7
8
 
# File 'lib/mixlib/archive/lib_archive.rb', line 6

def options
  @options
end

Instance Method Details

#create(files, gzip: false) ⇒ Object

Creates an archive with the given set of files

Parameters

gzip<Boolean>

should the archive be gzipped?



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/mixlib/archive/lib_archive.rb', line 54

def create(files, gzip: false)
  compression = gzip ? ::Archive::COMPRESSION_GZIP : ::Archive::COMPRESSION_NONE
  # "PAX restricted" will use PAX extensions when it has to, but will otherwise
  # use ustar for maximum compatibility
  format = ::Archive::FORMAT_TAR_PAX_RESTRICTED

  ::Archive.write_open_filename(archive, compression, format) do |tar|
    files.each do |fn|
      tar.new_entry do |entry|
        content = nil
        entry.pathname = fn
        stat = File.lstat(fn)
        if File.file?(fn)
          content = File.read(fn)
          entry.size = content.bytesize
        end
        entry.mode = stat.mode
        entry.filetype = resolve_type(stat.ftype)
        entry.atime = stat.atime
        entry.mtime = stat.mtime
        entry.symlink = File.readlink(fn) if File.symlink?(fn)
        tar.write_header(entry)

        tar.write_data(content) unless content.nil?
      end
    end
  end
end

#extract(destination, perms: true, ignore: []) ⇒ Object

Extracts the archive to the given destination

Parameters

perms<Boolean>

should the extracter use permissions from the archive.

ignore

an array of matches of file paths to ignore



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/mixlib/archive/lib_archive.rb', line 25

def extract(destination, perms: true, ignore: [])
  ignore_re = Regexp.union(ignore)
  flags = perms ? ::Archive::EXTRACT_PERM : nil
  FileUtils.mkdir_p(destination)

  # @note Dir.chdir is applied to the process, thus it is not thread-safe
  # and must be synchronized.
  # TODO: figure out a better alternative to chdir
  Mixlib::Archive::LibArchive.mutex_chdir.synchronize do
    Dir.chdir(destination) do
      reader = ::Archive::Reader.open_filename(@archive)

      reader.each_entry do |entry|
        if entry.pathname =~ ignore_re
          Mixlib::Archive::Log.warn "ignoring entry #{entry.pathname}"
          next
        end

        reader.extract(entry, flags.to_i)
      end
      reader.close
    end
  end
end

#resolve_type(type) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/mixlib/archive/lib_archive.rb', line 83

def resolve_type(type)
  case type
  when "characterSpecial"
    ::Archive::Entry::CHARACTER_SPECIAL
  when "blockSpecial"
    ::Archive::Entry::BLOCK_SPECIAL
  when "link"
    ::Archive::Entry::SYMBOLIC_LINK
  else
    ::Archive::Entry.const_get(type.upcase)
  end
end