Merge pull request #666 from HelenCampbell/release

[puppet-modules/puppetlabs-apt.git] / manifests / pin.pp

diff --git a/manifests/pin.pp b/manifests/pin.pp
index a69df2a695e934bb601cb0b9fbc3f2d52941144c..dff2c297c0c08b3d6f353e69a1d88732dbc904a2 100644 (file)
--- a/manifests/pin.pp
+++ b/manifests/pin.pp
@@ -2,37 +2,79 @@
 # pin a release in apt, useful for unstable repositories
 
 define apt::pin(
-  $ensure     = present,
-  $packages   = '*',
-  $priority   = 0,
-  $release    = '',
-  $origin     = '',
-  $originator = '',
-  $version    = ''
+  $ensure          = present,
+  $explanation     = undef,
+  $order           = 50,
+  $packages        = '*',
+  $priority        = 0,
+  $release         = '', # a=
+  $origin          = '',
+  $version         = '',
+  $codename        = '', # n=
+  $release_version = '', # v=
+  $component       = '', # c=
+  $originator      = '', # o=
+  $label           = ''  # l=
 ) {
+  if $order and !is_integer($order) {
+    fail('Only integers are allowed in the apt::pin order param')
+  }
 
-  include apt::params
+  if $explanation {
+    $_explanation = $explanation
+  } else {
+    if defined('$caller_module_name') { # strict vars check
+      $_explanation = "${caller_module_name}: ${name}"
+    } else {
+      $_explanation = ": ${name}"
+    }
+  }
 
-  $preferences_d = $apt::params::preferences_d
+  $pin_release_array = [
+    $release,
+    $codename,
+    $release_version,
+    $component,
+    $originator,
+    $label]
+  $pin_release = join($pin_release_array, '')
 
-  if $release != '' {
-    $pin = "release a=${release}"
-  } elsif $origin != '' {
-    $pin = "origin \"${origin}\""
-  } elsif $originator != '' {
-    $pin = "release o=${originator}"
-  } elsif $version != '' {
-    $pin = "version ${version}"
+  # Read the manpage 'apt_preferences(5)', especially the chapter
+  # 'The Effect of APT Preferences' to understand the following logic
+  # and the difference between specific and general form
+  if is_array($packages) {
+    $packages_string = join($packages, ' ')
   } else {
-    $pin = "release a=${name}"
+    $packages_string = $packages
   }
 
-  file { "${name}.pref":
-    ensure  => $ensure,
-    path    => "${preferences_d}/${name}.pref",
-    owner   => root,
-    group   => root,
-    mode    => '0644',
-    content => template("apt/pin.pref.erb"),
+  if $packages_string != '*' { # specific form
+    if ( $pin_release != '' and ( $origin != '' or $version != '' )) or
+      ( $version != '' and ( $pin_release != '' or $origin != '' )) {
+      fail('parameters release, origin, and version are mutually exclusive')
+    }
+  } else { # general form
+    if $version != '' {
+      fail('parameter version cannot be used in general form')
+    }
+    if ( $pin_release != '' and $origin != '' ) {
+      fail('parameters release and origin are mutually exclusive')
+    }
+  }
+
+  # According to man 5 apt_preferences:
+  # The files have either no or "pref" as filename extension
+  # and only contain alphanumeric, hyphen (-), underscore (_) and period
+  # (.) characters. Otherwise APT will print a notice that it has ignored a
+  # file, unless that file matches a pattern in the
+  # Dir::Ignore-Files-Silently configuration list - in which case it will
+  # be silently ignored.
+  $file_name = regsubst($title, '[^0-9a-z\-_\.]', '_', 'IG')
+
+  apt::setting { "pref-${file_name}":
+    ensure        => $ensure,
+    priority      => $order,
+    content       => template('apt/_header.erb', 'apt/pin.pref.erb'),
+    notify_update => false,
   }
 }