Class: FPM::Package::FreeBSD

Inherits:
FPM::Package show all
Defined in:
lib/fpm/package/freebsd.rb

Constant Summary collapse

SCRIPT_MAP = 
{
  :before_install     => "pre-install",
  :after_install      => "post-install",
  :before_remove      => "pre-deinstall",
  :after_remove       => "post-deinstall",
}

Instance Attribute Summary

Attributes inherited from FPM::Package

#architecture, #attributes, #attrs, #category, #config_files, #conflicts, #dependencies, #description, #directories, #epoch, #iteration, #license, #maintainer, #name, #provides, #replaces, #scripts, #url, #vendor, #version

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from FPM::Package

apply_options, #build_path, #cleanup, #cleanup_build, #cleanup_staging, #convert, #converted_from, default_attributes, #edit_file, #files, inherited, #initialize, #input, option, #script, #staging_path, #type, type, types

Methods included from Util

#copied_entries, #copy_entry, #copy_metadata, #default_shell, #execmd, #expand_pessimistic_constraints, #logger, #mknod_w, #program_exists?, #program_in_path?, #safesystem, #safesystemout, #tar_cmd

Constructor Details

This class inherits a constructor from FPM::Package

Class Method Details

.default_abi ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/fpm/package/freebsd.rb', line 15

def self.default_abi
  abi_name = %x{uname -s}.chomp
  abi_version = %x{uname -r}.chomp.split(".")[0]
  abi_arch = %x{uname -m}.chomp

  [abi_name, abi_version, abi_arch].join(":")
end

Instance Method Details

#add_path(tar, tar_path, path) ⇒ Object

def output



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/fpm/package/freebsd.rb', line 113

def add_path(tar, tar_path, path)
  stat = File.lstat(path)
  if stat.directory?
    tar.mkdir(tar_path, stat.mode)
  elsif stat.symlink?
    tar.add_symlink(tar_path, File.readlink(path), stat.mode)
  else
    tar.add_file_simple(tar_path, stat.mode, stat.size) do |io|
      File.open(path) do |fd|
        chunk = nil
        size = 0
        while chunk = fd.read(16384) do
          size += io.write(chunk)
        end
        if size != stat.size
          raise "Failed to add #{path} to the archive; expected to " +
                "write #{stat.size} bytes, only wrote #{size}"
        end
      end
    end # tar.tar.add_file_simple
  end
end

#output(output_path) ⇒ Object 



31
32
33
34
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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/fpm/package/freebsd.rb', line 31

def output(output_path)
  # See https://github.com/jordansissel/fpm/issues/1090
  # require xz later, because this triggers a load of liblzma.so.5 that is
  # unavailable on older CentOS/RH distros.
  require "xz"
  output_check(output_path)

  # Build the packaging metadata files.
  checksums = {}
  self.files.each do |f|
    path = staging_path(f)
    if File.symlink?(path)
      checksums[f] = "-"
    elsif File.file?(path)
      checksums[f] = Digest::SHA256.file(path).hexdigest
    end
  end

  pkg_origin = attributes[:freebsd_origin]
  if pkg_origin == "fpm/<name>"  # fill in default
    pkg_origin = "fpm/#{name}"
  end

  # Follow similar rules to these used in ``to_s_fullversion`` method.
  # FIXME: maybe epoch should also be introduced somehow ("#{version},#{epoch})?
  #        should it go to pkgdata["version"] or to another place?
  # https://www.freebsd.org/doc/en/books/porters-handbook/makefile-naming.html
  pkg_version = (iteration and (iteration.to_i > 0)) ?  "#{version}-#{iteration}" : "#{version}"

  pkgdata = {
    "abi" => attributes[:freebsd_abi],
    "name" => name,
    "version" => pkg_version,
    "comment" => description,
    "desc" => description,
    "origin" => pkg_origin,
    "maintainer" => maintainer,
    "www" => url,
    # prefix is required, but it doesn't seem to matter
    "prefix" => "/",
  }

  # Write +COMPACT_MANIFEST, without the "files" section.
  File.open(staging_path("+COMPACT_MANIFEST"), "w+") do |file|
    file.write(pkgdata.to_json + "\n")
  end

  # Populate files + checksums, then write +MANIFEST.
  pkgdata["files"] = {}
  checksums.each do |f, shasum|
    # pkg expands % URL-style escapes, so make sure to escape % as %25
    pkgdata["files"]["/" + f.gsub("%", "%25")] = shasum
  end

  # Populate scripts
  pkgdata["scripts"] = {}
  scripts.each do |name, data|
    pkgdata["scripts"][SCRIPT_MAP[name]] = data
  end

  File.open(staging_path("+MANIFEST"), "w+") do |file|
    file.write(pkgdata.to_json + "\n")
  end

  # Create the .txz package archive from the files in staging_path.
  File.open(output_path, "wb") do |file|
    XZ::StreamWriter.new(file) do |xz|
      FPM::Util::TarWriter.new(xz) do |tar|
        # The manifests must come first for pkg.
        add_path(tar, "+COMPACT_MANIFEST",
                 File.join(staging_path, "+COMPACT_MANIFEST"))
        add_path(tar, "+MANIFEST",
                 File.join(staging_path, "+MANIFEST"))

        checksums.keys.each do |path|
          add_path(tar, "/" + path, File.join(staging_path, path))
        end
      end
    end
  end
end

#to_s(format = nil) ⇒ Object 



144
145
146
 
# File 'lib/fpm/package/freebsd.rb', line 144

def to_s(format=nil)
  return super(format.nil? ? "NAME-FULLVERSION.EXTENSION" : format)
end

#to_s_extension ⇒ Object

def add_path



136
 
# File 'lib/fpm/package/freebsd.rb', line 136

def to_s_extension; "txz"; end

#to_s_fullversion ⇒ Object 



138
139
140
141
142
 
# File 'lib/fpm/package/freebsd.rb', line 138

def to_s_fullversion()
  # iteration (PORTREVISION on FreeBSD) shall be appended only(?) if non-zero.
  # https://www.freebsd.org/doc/en/books/porters-handbook/makefile-naming.html
  (iteration and (iteration.to_i > 0)) ?  "#{version}_#{iteration}" : "#{version}"
end