fpm-itchio 1.4.0

data/lib/fpm/rake_task.rb

@@ -0,0 +1,59 @@
+require "ostruct"
+require "rake"
+require "rake/tasklib"
+
+class FPM::RakeTask < Rake::TaskLib
+  attr_reader :options
+
+  def initialize(package_name, opts = {}, &block)
+    @options = OpenStruct.new(:name => package_name.to_s)
+    @source, @target = opts.values_at(:source, :target).map(&:to_s)
+    @directory = File.expand_path(opts[:directory].to_s)
+
+    (@source.empty? || @target.empty? || options.name.empty?) &&
+      abort("Must specify package name, source and output")
+
+    desc "Package #{@name}" unless ::Rake.application.last_comment
+
+    task(options.name) do |_, task_args|
+      block.call(*[options, task_args].first(block.arity)) if block_given?
+      abort("Must specify args") unless options.respond_to?(:args)
+      @args = options.delete_field(:args)
+      run_cli
+    end
+  end
+
+  private
+
+  def parsed_options
+    options.to_h.map do |option, value|
+      opt = option.to_s.tr("_", "-")
+
+      case
+      when value.is_a?(String), value.is_a?(Symbol)
+        %W(--#{opt} #{value})
+      when value.is_a?(Array)
+        value.map { |v| %W(--#{opt} #{v}) }
+      when value.is_a?(TrueClass)
+        "--#{opt}"
+      when value.is_a?(FalseClass)
+        "--no-#{opt}"
+      else
+        fail TypeError, "Unexpected type: #{value.class}"
+      end
+    end
+  end
+
+  def run_cli
+    require "fpm"
+    require "fpm/command"
+
+    args = %W(-t #{@target} -s #{@source} -C #{@directory})
+    args << parsed_options
+    args << @args
+
+    args.flatten!.compact!
+
+    exit(FPM::Command.new("fpm").run(args) || 0)
+  end
+end

data/lib/fpm/util.rb

@@ -0,0 +1,253 @@
+require "fpm/namespace"
+require "childprocess"
+require "ffi"
+
+# Some utility functions
+module FPM::Util
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
+
+  # mknod is __xmknod in glibc a wrapper around mknod to handle
+  # various stat struct formats. See bits/stat.h in glibc source
+  begin
+    attach_function :mknod, :mknod, [:string, :uint, :ulong], :int
+  rescue FFI::NotFoundError
+    # glibc/io/xmknod.c int __xmknod (int vers, const char *path, mode_t mode, dev_t *dev)
+    attach_function :xmknod, :__xmknod, [:int, :string, :uint, :pointer], :int
+  end
+
+  # Raised if safesystem cannot find the program to run.
+  class ExecutableNotFound < StandardError; end
+
+  # Raised if a safesystem program exits nonzero
+  class ProcessFailed < StandardError; end
+
+  # Is the given program in the system's PATH?
+  def program_in_path?(program)
+    # return false if path is not set
+    return false unless ENV['PATH']
+    # Scan path to find the executable
+    # Do this to help the user get a better error message.
+    envpath = ENV["PATH"].split(":")
+    return envpath.select { |p| File.executable?(File.join(p, program)) }.any?
+  end # def program_in_path
+
+  def program_exists?(program)
+    # Scan path to find the executable
+    # Do this to help the user get a better error message.
+    return program_in_path?(program) if !program.include?("/")
+    return File.executable?(program)
+  end # def program_exists?
+
+  def default_shell
+    shell = ENV["SHELL"]
+    return "/bin/sh" if shell.nil? || shell.empty?
+    return shell
+  end
+
+  # Run a command safely in a way that gets reports useful errors.
+  def safesystem(*args)
+    # ChildProcess isn't smart enough to run a $SHELL if there's
+    # spaces in the first arg and there's only 1 arg.
+    if args.size == 1
+      args = [ default_shell, "-c", args[0] ]
+    end
+    program = args[0]
+
+    if !program_exists?(program)
+      raise ExecutableNotFound.new(program)
+    end
+
+    logger.debug("Running command", :args => args)
+
+    # Create a pair of pipes to connect the
+    # invoked process to the cabin logger
+    stdout_r, stdout_w = IO.pipe
+    stderr_r, stderr_w = IO.pipe
+
+    process           = ChildProcess.build(*args)
+    process.io.stdout = stdout_w
+    process.io.stderr = stderr_w
+
+    process.start
+    stdout_w.close; stderr_w.close
+    logger.debug('Process is running', :pid => process.pid)
+    # Log both stdout and stderr as 'info' because nobody uses stderr for
+    # actually reporting errors and as a result 'stderr' is a misnomer.
+    logger.pipe(stdout_r => :info, stderr_r => :info)
+
+    process.wait
+    success = (process.exit_code == 0)
+
+    if !success
+      raise ProcessFailed.new("#{program} failed (exit code #{process.exit_code})" \
+                              ". Full command was:#{args.inspect}")
+    end
+    return success
+  end # def safesystem
+
+  # Run a command safely in a way that captures output and status.
+  def safesystemout(*args)
+    if args.size == 1
+      args = [ ENV["SHELL"], "-c", args[0] ]
+    end
+    program = args[0]
+
+    if !program.include?("/") and !program_in_path?(program)
+      raise ExecutableNotFound.new(program)
+    end
+
+    logger.debug("Running command", :args => args)
+
+    stdout_r, stdout_w = IO.pipe
+    stderr_r, stderr_w = IO.pipe
+
+    process           = ChildProcess.build(*args)
+    process.io.stdout = stdout_w
+    process.io.stderr = stderr_w
+
+    process.start
+    stdout_w.close; stderr_w.close
+    stdout_r_str = stdout_r.read
+    stdout_r.close; stderr_r.close
+    logger.debug("Process is running", :pid => process.pid)
+
+    process.wait
+    success = (process.exit_code == 0)
+
+    if !success
+      raise ProcessFailed.new("#{program} failed (exit code #{process.exit_code})" \
+                              ". Full command was:#{args.inspect}")
+    end
+
+    return stdout_r_str
+  end # def safesystemout
+
+  # Get the recommended 'tar' command for this platform.
+  def tar_cmd
+    # Rely on gnu tar for solaris and OSX.
+    case %x{uname -s}.chomp
+    when "SunOS"
+      return "gtar"
+    when "Darwin"
+      # Try running gnutar, it was renamed(??) in homebrew to 'gtar' at some point, I guess? I don't know.
+      ["gnutar", "gtar"].each do |tar|
+        system("#{tar} > /dev/null 2> /dev/null")
+        return tar unless $?.exitstatus == 127
+      end
+    when "FreeBSD"
+      # use gnutar instead
+      return "gtar"
+    else
+      return "tar"
+    end
+  end # def tar_cmd
+
+  # wrapper around mknod ffi calls
+  def mknod_w(path, mode, dev)
+    rc = -1
+    case %x{uname -s}.chomp
+    when 'Linux'
+      # bits/stat.h #define _MKNOD_VER_LINUX  0
+      rc = xmknod(0, path, mode, FFI::MemoryPointer.new(dev))
+    else
+      rc = mknod(path, mode, dev)
+    end
+    rc
+  end
+
+  def copy_metadata(source, destination)
+    source_stat = File::lstat(source)
+    dest_stat = File::lstat(destination)
+
+    # If this is a hard-link, there's no metadata to copy.
+    # If this is a symlink, what it points to hasn't been copied yet.
+    return if source_stat.ino == dest_stat.ino || dest_stat.symlink?
+
+    File.utime(source_stat.atime, source_stat.mtime, destination)
+    mode = source_stat.mode
+    begin
+      File.lchown(source_stat.uid, source_stat.gid, destination)
+    rescue Errno::EPERM
+      # clear setuid/setgid
+      mode &= 01777
+    end
+
+    unless source_stat.symlink?
+      File.chmod(mode, destination)
+    end
+  end # def copy_metadata
+
+
+  def copy_entry(src, dst, preserve=false, remove_destination=false)
+    case File.ftype(src)
+    when 'fifo', 'characterSpecial', 'blockSpecial', 'socket'
+      st = File.stat(src)
+      rc = mknod_w(dst, st.mode, st.dev)
+      raise SystemCallError.new("mknod error", FFI.errno) if rc == -1
+    when 'directory'
+      FileUtils.mkdir(dst) unless File.exists? dst
+    else
+      # if the file with the same dev and inode has been copied already -
+      # hard link it's copy to `dst`, otherwise make an actual copy
+      st = File.lstat(src)
+      known_entry = copied_entries[[st.dev, st.ino]]
+      if known_entry
+        FileUtils.ln(known_entry, dst)
+      else
+        FileUtils.copy_entry(src, dst, preserve=preserve,
+                             remove_destination=remove_destination)
+        copied_entries[[st.dev, st.ino]] = dst
+      end
+    end # else...
+  end # def copy_entry
+
+  def copied_entries
+    # TODO(sissel): I wonder that this entry-copy knowledge needs to be put
+    # into a separate class/module. As is, calling copy_entry the same way
+    # in slightly different contexts will result in weird or bad behavior.
+    # What I mean is if we do:
+    #   pkg = FPM::Package::Dir...
+    #   pkg.output()...
+    #   pkg.output()...
+    # The 2nd output call will fail or behave weirdly because @copied_entries
+    # is already populated. even though this is anew round of copying.
+    return @copied_entries ||= {}
+  end # def copied_entries
+
+  def expand_pessimistic_constraints(constraint)
+    name, op, version = constraint.split(/\s+/)
+
+    if op == '~>'
+
+      new_lower_constraint = "#{name} >= #{version}"
+
+      version_components = version.split('.').collect { |v| v.to_i }
+
+      version_prefix = version_components[0..-3].join('.')
+      portion_to_work_with = version_components.last(2)
+
+      prefix = ''
+      unless version_prefix.empty?
+        prefix = version_prefix + '.'
+      end
+
+      one_to_increment = portion_to_work_with[0].to_i
+      incremented = one_to_increment + 1
+
+      new_version = ''+ incremented.to_s + '.0'
+
+      upper_version = prefix + new_version
+
+      new_upper_constraint = "#{name} < #{upper_version}"
+
+      return [new_lower_constraint,new_upper_constraint]
+    else
+      return [constraint]
+    end
+  end #def expand_pesimistic_constraints
+
+  def logger
+    @logger ||= Cabin::Channel.get
+  end # def logger
+end # module FPM::Util

data/lib/fpm/version.rb

@@ -0,0 +1,3 @@
+module FPM
+  VERSION = "1.4.0"
+end

data/templates/deb.erb

@@ -0,0 +1,52 @@
+Package: <%= name %>
+Version: <%= "#{epoch}:" if epoch %><%= version %><%= "-" + iteration.to_s if iteration %>
+License: <%= license %>
+<% if !vendor.nil? and !vendor.empty? -%>
+Vendor: <%= vendor %>
+<% end -%>
+Architecture: <%= architecture %>
+Maintainer: <%= maintainer  %>
+Installed-Size: <%= attributes[:deb_installed_size] %>
+<% if !dependencies.empty? and !attributes[:no_depends?] -%>
+Depends: <%= dependencies.collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
+<% if !conflicts.empty? -%>
+Conflicts: <%= conflicts.collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
+<% if attributes[:deb_breaks] -%>
+Breaks: <%= attributes[:deb_breaks].collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
+<% if attributes[:deb_pre_depends_given?] -%>
+Pre-Depends: <%= attributes[:deb_pre_depends].collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
+<% if attributes[:deb_build_depends_given?] -%>
+Build-Depends: <%= attributes[:deb_build_depends].collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
+<% if !provides.empty? -%>
+<%# Turn each provides from 'foo = 123' to simply 'foo' because Debian :\ -%>
+<%#  http://www.debian.org/doc/debian-policy/ch-relationships.html -%>
+Provides: <%= provides.map {|p| p.split(" ").first}.join ", " %>
+<% end -%>
+<% if !replaces.empty? -%>
+Replaces: <%= replaces.join(", ") %>
+<% end -%>
+<% if attributes[:deb_recommends_given?] -%>
+Recommends: <%= attributes[:deb_recommends].collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
+<% if attributes[:deb_suggests_given?] -%>
+Suggests: <%= attributes[:deb_suggests].collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
+Section: <%= category %>
+Priority: <%= attributes[:deb_priority] %>
+Homepage: <%= url or "http://nourlgiven.example.com/" %>
+<% lines = (description or "no description given").split("\n") -%>
+<% firstline, *remainder = lines -%>
+Description: <%= firstline %>
+<% if remainder.any? -%>
+<%= remainder.collect { |l| l =~ /^ *$/ ? " ." : " #{l}" }.join("\n") %>
+<% end -%>
+<% if attributes[:deb_field_given?] -%>
+<%   attributes[:deb_field].each do |field, value| -%>
+<%= field %>: <%= value %>
+<%   end -%>
+<% end -%>

data/templates/deb/changelog.erb

@@ -0,0 +1,5 @@
+<%= name %> (<%= "#{epoch}:" if epoch %><%= version %><%= "-" + iteration.to_s if iteration %>) whatever; urgency=medium
+
+  * Package created with FPM.
+
+ -- <%= maintainer %>  <%= Time.now.strftime("%a, %d %b %Y %T %z") %>

data/templates/deb/ldconfig.sh.erb

@@ -0,0 +1,13 @@
+#!/bin/sh
+# This script is automatically added by fpm when you specify
+# conditions that usually require running ldconfig upon
+# package installation and removal.
+#
+# For example, if you set '--deb-shlibs' in creating your package,
+# fpm will use this script if you don't provide your own --after-install or
+# --after-remove
+set -e
+
+case $1 in
+  configure|remove) ldconfig ;;
+esac

data/templates/deb/postinst_upgrade.sh.erb

@@ -0,0 +1,62 @@
+#!/bin/sh
+after_upgrade() {
+<%# Making sure that at least one command is in the function -%>
+<%# avoids a lot of potential errors, including the case that -%>
+<%# the script is non-empty, but just whitespace and/or comments -%>
+    :
+<% if script?(:after_upgrade) -%>
+<%=  script(:after_upgrade) %>
+<% end -%>
+
+<% if attributes[:deb_systemd] -%>
+systemctl --system daemon-reload >/dev/null || true
+if ! systemctl is-enabled <%= attributes[:deb_systemd] %> >/dev/null 
+then
+    systemctl enable <%= attributes[:deb_systemd] %> >/dev/null || true
+    systemctl start <%= attributes[:deb_systemd] %> >/dev/null || true
+<% if attributes[:deb_systemd_restart_after_upgrade?] -%>
+else
+    systemctl restart <%= attributes[:deb_systemd] %> >/dev/null || true
+<% end -%>
+fi
+<% end -%>
+}
+
+after_install() {
+<%# Making sure that at least one command is in the function -%>
+<%# avoids a lot of potential errors, including the case that -%>
+<%# the script is non-empty, but just whitespace and/or comments -%>
+    :
+<% if script?(:after_install) -%>
+<%=  script(:after_install) %>
+<% end -%>
+
+<% if attributes[:deb_systemd] -%>
+systemctl --system daemon-reload >/dev/null || true
+systemctl enable <%= attributes[:deb_systemd] %> >/dev/null || true
+systemctl start <%= attributes[:deb_systemd] %> >/dev/null || true
+<% end -%>
+}
+
+if [ "${1}" = "configure" -a -z "${2}" ] || \
+   [ "${1}" = "abort-remove" ]
+then
+    # "after install" here
+    # "abort-remove" happens when the pre-removal script failed.
+    #   In that case, this script, which should be idemptoent, is run
+    #   to ensure a clean roll-back of the removal.
+    after_install
+elif [ "${1}" = "configure" -a -n "${2}" ]
+then
+    upgradeFromVersion="${2}"
+    # "after upgrade" here
+    # NOTE: This slot is also used when deb packages are removed,
+    # but their config files aren't, but a newer version of the
+    # package is installed later, called "Config-Files" state.
+    # basically, that still looks a _lot_ like an upgrade to me.
+    after_upgrade "${2}"
+elif echo "${1}" | grep -E -q "(abort|fail)"
+then
+    echo "Failed to install before the post-installation script was run." >&2
+    exit 1
+fi