apt::pin: handling all apt preferences properties

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

diff --git a/manifests/pin.pp b/manifests/pin.pp
index 40695af5fa8f84eb4cba4a2ca26ebd84b57818d4..e6e293e45260db337f3b2d80f4fe2fc74f8bd4d5 100644 (file)
--- a/manifests/pin.pp
+++ b/manifests/pin.pp
@@ -2,18 +2,71 @@
 # pin a release in apt, useful for unstable repositories
 
 define apt::pin(
-  $packages = '*',
-  $priority = 0
+  $ensure          = present,
+  $explanation     = "${::caller_module_name}: ${name}",
+  $order           = '',
+  $packages        = '*',
+  $priority        = 0,
+  $release         = '', # a=
+  $origin          = '',
+  $version         = '',
+  $codename        = '', # n=
+  $release_version = '', # v=
+  $component       = '', # c=
+  $originator      = '', # o=
+  $label           = '', # l=
 ) {
 
   include apt::params
 
+  $preferences_d = $apt::params::preferences_d
+
+  if $order != '' and !is_integer($order) {
+    fail('Only integers are allowed in the apt::pin order param')
+  }
+
+  $pin_release = join([
+    $release,
+    $codename,
+    $release_version,
+    $component,
+    $originator,
+    $label], '')
+
+  # Read the manpage 'apt_preferences(5)', especially the chapter
+  # 'Thea Effect of APT Preferences' to understand the following logic
+  # and the difference between specific and general form
+  if $packages != '*' { # specific form
+
+    if ( $pin_release != '' and ( $origin != '' or $version != '' )) or
+      ( $origin != '' and ( $pin_release != '' 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 != '' ) or
+      ( $origin != '' and $pin_release != '' ) {
+      fail('parmeters release and origin are mutually exclusive')
+    }
+
+  }
+
+  $path = $order ? {
+    ''      => "${preferences_d}/${name}.pref",
+    default => "${preferences_d}/${order}-${name}.pref",
+  }
   file { "${name}.pref":
-    path => "${apt::params::root}/preferences.d/${name}",
-    ensure => file,
-    owner => root,
-    group => root,
-    mode => 644,
-    content => "# ${name}\nPackage: ${packages}\nPin: release a=${name}\nPin-Priority: ${priority}",
+    ensure  => $ensure,
+    path    => $path,
+    owner   => root,
+    group   => root,
+    mode    => '0644',
+    content => template('apt/pin.pref.erb'),
   }
 }