Class: FPM::Package::Deb

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

Overview

Support for debian packages (.deb files)

This class supports both input and output of packages.

Constant Summary collapse

SCRIPT_MAP =

Map of what scripts are named.

{
  :before_install     => "preinst",
  :after_install      => "postinst",
  :before_remove      => "prerm",
  :after_remove       => "postrm",
}
COMPRESSION_TYPES =

The list of supported compression types. Default is gz (gzip)

[ "gz", "bzip2", "xz" ]

Instance Attribute Summary

Attributes inherited from FPM::Package

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

Instance Method Summary collapse

Methods inherited from FPM::Package

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

Methods included from Util

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

Constructor Details

#initialize(*args) ⇒ Deb

Returns a new instance of Deb.



151
152
153
154
 
# File 'lib/fpm/package/deb.rb', line 151

def initialize(*args)
  super(*args)
  attributes[:deb_priority] = "extra"
end

Instance Method Details

#add_path(path, allconfigs) ⇒ Object

expand recursively a given path to be put in allconfigs



667
668
669
670
671
672
673
674
 
# File 'lib/fpm/package/deb.rb', line 667

def add_path(path, allconfigs)
  # Strip leading /
  path = path[1..-1] if path[0,1] == "/"
  cfg_path = File.expand_path(path, staging_path)
  Find.find(cfg_path).select { |p| File.file?(p) }.each do |p|
    allconfigs << p.gsub("#{staging_path}/", '')
  end
end

#architecture ⇒ Object

Return the architecture. This will default to native if not yet set. It will also try to use dpkg and ‘uname -m’ to figure out what the native ‘architecture’ value should be.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/fpm/package/deb.rb', line 161

def architecture
  if @architecture.nil? or @architecture == "native"
    # Default architecture should be 'native' which we'll need to ask the
    # system about.
    if program_in_path?("dpkg")
      @architecture = %x{dpkg --print-architecture 2> /dev/null}.chomp
      if $?.exitstatus != 0 or @architecture.empty?
        # if dpkg fails or emits nothing, revert back to uname -m
        @architecture = %x{uname -m}.chomp
      end
    else
      @architecture = %x{uname -m}.chomp
    end
  end

  case @architecture
  when "x86_64"
    # Debian calls x86_64 "amd64"
    @architecture = "amd64"
  when "noarch"
    # Debian calls noarch "all"
    @architecture = "all"
  end
  return @architecture
end

#converted_from(origin) ⇒ Object

def output



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/fpm/package/deb.rb', line 467

def converted_from(origin)
  self.dependencies = self.dependencies.collect do |dep|
    fix_dependency(dep)
  end.flatten
  self.provides = self.provides.collect do |provides|
    fix_provides(provides)
  end.flatten

  if origin == FPM::Package::Deb
    changelog_path = staging_path("usr/share/doc/#{name}/changelog.Debian.gz")
    if File.exists?(changelog_path)
      logger.debug("Found a deb changelog file, using it.", :path => changelog_path)
      attributes[:deb_changelog] = build_path("deb_changelog")
      File.open(attributes[:deb_changelog], "w") do |deb_changelog|
        Zlib::GzipReader.open(changelog_path) do |gz|
          IO::copy_stream(gz, deb_changelog)
        end
      end
      File.unlink(changelog_path)
    end
  end
end

#data_tar_flags ⇒ Object

def to_s



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/fpm/package/deb.rb', line 784

def data_tar_flags
  data_tar_flags = []
  if attributes[:deb_use_file_permissions?].nil?
    if !attributes[:deb_user].nil?
      if attributes[:deb_user] == 'root'
        data_tar_flags += [ "--numeric-owner", "--owner", "0" ]
      else
        data_tar_flags += [ "--owner", attributes[:deb_user] ]
      end
    end

    if !attributes[:deb_group].nil?
      if attributes[:deb_group] == 'root'
        data_tar_flags += [ "--numeric-owner", "--group", "0" ]
      else
        data_tar_flags += [ "--group", attributes[:deb_group] ]
      end
    end
  end
  return data_tar_flags
end

#input(input_path) ⇒ Object

def prefix



221
222
223
224
 
# File 'lib/fpm/package/deb.rb', line 221

def input(input_path)
  extract_info(input_path)
  extract_files(input_path)
end

#name ⇒ Object

Get the name of this package. See also FPM::Package#name

This accessor actually modifies the name if it has some invalid or unwise characters.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/fpm/package/deb.rb', line 191

def name
  if @name =~ /[A-Z]/
    logger.warn("Debian tools (dpkg/apt) don't do well with packages " \
      "that use capital letters in the name. In some cases it will " \
      "automatically downcase them, in others it will not. It is confusing." \
      " Best to not use any capital letters at all. I have downcased the " \
      "package name for you just to be safe.",
      :oldname => @name, :fixedname => @name.downcase)
    @name = @name.downcase
  end

  if @name.include?("_")
    logger.info("Debian package names cannot include underscores; " \
                 "automatically converting to dashes", :name => @name)
    @name = @name.gsub(/[_]/, "-")
  end

  if @name.include?(" ")
    logger.info("Debian package names cannot include spaces; " \
                 "automatically converting to dashes", :name => @name)
    @name = @name.gsub(/[ ]/, "-")
  end

  return @name
end

#output(output_path) ⇒ Object

def extract_files



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/fpm/package/deb.rb', line 349

def output(output_path)
  self.provides = self.provides.collect { |p| fix_provides(p) }
  output_check(output_path)
  # Abort if the target path already exists.

  # create 'debian-binary' file, required to make a valid debian package
  File.write(build_path("debian-binary"), "2.0\n")

  # If we are given --deb-shlibs but no --after-install script, we
  # should implicitly create a before/after scripts that run ldconfig
  if attributes[:deb_shlibs]
    if !script?(:after_install)
      logger.info("You gave --deb-shlibs but no --after-install, so " \
                   "I am adding an after-install script that runs " \
                   "ldconfig to update the system library cache")
      scripts[:after_install] = template("deb/ldconfig.sh.erb").result(binding)
    end
    if !script?(:after_remove)
      logger.info("You gave --deb-shlibs but no --after-remove, so " \
                   "I am adding an after-remove script that runs " \
                   "ldconfig to update the system library cache")
      scripts[:after_remove] = template("deb/ldconfig.sh.erb").result(binding)
    end
  end

  if script?(:before_upgrade) or script?(:after_upgrade)
    if script?(:before_install) or script?(:before_upgrade)
      scripts[:before_install] = template("deb/preinst_upgrade.sh.erb").result(binding)
    end
    if script?(:before_remove)
      scripts[:before_remove] = template("deb/prerm_upgrade.sh.erb").result(binding)
    end
    if script?(:after_install) or script?(:after_upgrade)
      scripts[:after_install] = template("deb/postinst_upgrade.sh.erb").result(binding)
    end
    if script?(:after_remove)
      scripts[:after_remove] = template("deb/postrm_upgrade.sh.erb").result(binding)
    end
  end

  write_control_tarball

  # Tar up the staging_path into data.tar.{compression type}
  case self.attributes[:deb_compression]
    when "gz", nil
      datatar = build_path("data.tar.gz")
      compression = "-z"
    when "bzip2"
      datatar = build_path("data.tar.bz2")
      compression = "-j"
    when "xz"
      datatar = build_path("data.tar.xz")
      compression = "-J"
    else
      raise FPM::InvalidPackageConfiguration,
        "Unknown compression type '#{self.attributes[:deb_compression]}'"
  end

  # Write the changelog file
  dest_changelog = File.join(staging_path, "usr/share/doc/#{name}/changelog.Debian.gz")
  FileUtils.mkdir_p(File.dirname(dest_changelog))
  File.new(dest_changelog, "wb", 0644).tap do |changelog|
    Zlib::GzipWriter.new(changelog, Zlib::BEST_COMPRESSION).tap do |changelog_gz|
      if attributes[:deb_changelog]
        logger.info("Writing user-specified changelog", :source => attributes[:deb_changelog])
        File.new(attributes[:deb_changelog]).tap do |fd|
          chunk = nil
          # Ruby 1.8.7 doesn't have IO#copy_stream
          changelog_gz.write(chunk) while chunk = fd.read(16384)
        end.close
      else
        logger.info("Creating boilerplate changelog file")
        changelog_gz.write(template("deb/changelog.erb").result(binding))
      end
    end.close
  end # No need to close, GzipWriter#close will close it.

  attributes.fetch(:deb_init_list, []).each do |init|
    name = File.basename(init, ".init")
    dest_init = File.join(staging_path, "etc/init.d/#{name}")
    FileUtils.mkdir_p(File.dirname(dest_init))
    FileUtils.cp init, dest_init
    File.chmod(0755, dest_init)
  end

  attributes.fetch(:deb_default_list, []).each do |default|
    name = File.basename(default, ".default")
    dest_default = File.join(staging_path, "etc/default/#{name}")
    FileUtils.mkdir_p(File.dirname(dest_default))
    FileUtils.cp default, dest_default
    File.chmod(0644, dest_default)
  end

  attributes.fetch(:deb_upstart_list, []).each do |upstart|
    name = File.basename(upstart, ".upstart")
    dest_upstart = staging_path("etc/init/#{name}.conf")
    FileUtils.mkdir_p(File.dirname(dest_upstart))
    FileUtils.cp(upstart, dest_upstart)
    File.chmod(0644, dest_upstart)

    # Install an init.d shim that calls upstart
    dest_init = staging_path("/etc/init.d/#{name}")
    FileUtils.mkdir_p(File.dirname(dest_init))
    FileUtils.ln_s("/lib/init/upstart-job", dest_init)
  end

  args = [ tar_cmd, "-C", staging_path, compression ] + data_tar_flags + [ "-cf", datatar, "." ]
  safesystem(*args)

  # pack up the .deb, which is just an 'ar' archive with 3 files
  # the 'debian-binary' file has to be first
  with(File.expand_path(output_path)) do |output_path|
    ::Dir.chdir(build_path) do
      safesystem("ar", "-qc", output_path, "debian-binary", "control.tar.gz", datatar)
    end
  end
end

#prefix ⇒ Object

def name



217
218
219
 
# File 'lib/fpm/package/deb.rb', line 217

def prefix
  return (attributes[:prefix] or "/")
end

#to_s(format = nil) ⇒ Object

def write_md5sums



777
778
779
780
781
782
 
# File 'lib/fpm/package/deb.rb', line 777

def to_s(format=nil)
  # Default format if nil
  # git_1.7.9.3-1_amd64.deb
  return super("NAME_FULLVERSION_ARCH.TYPE") if format.nil?
  return super(format)
end