pin: caller_module_name is not a topscope variable
[puppet-modules/puppetlabs-apt.git] / manifests / pin.pp
index 2431af2a4d0dc02b4df666c1a470a13285b207f3..2563fc468176d8c62844654a435c5f0eb7ec7de1 100644 (file)
@@ -2,16 +2,19 @@
 # pin a release in apt, useful for unstable repositories
 
 define apt::pin(
-  $ensure     = present,
-  $explanation = "${::caller_module_name}: ${name}",
-  $order      = '',
-  $packages   = '*',
-  $priority   = 0,
-  $release    = '',
-  $codename   = '',
-  $origin     = '',
-  $originator = '',
-  $version    = ''
+  $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
@@ -22,25 +25,60 @@ define apt::pin(
     fail('Only integers are allowed in the apt::pin order param')
   }
 
-  if $release != '' {
-    $pin = "release a=${release}"
-  } elsif $codename != '' {
-    $pin = "release n=${codename}"
-  } elsif $origin != '' {
-    $pin = "origin \"${origin}\""
-  } elsif $originator != '' {
-    $pin = "release o=${originator}"
-  } elsif $version != '' {
-    $pin = "version ${version}"
+  $pin_release_array = [
+    $release,
+    $codename,
+    $release_version,
+    $component,
+    $originator,
+    $label]
+  $pin_release = join($pin_release_array, '')
+
+  # 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 is_array($packages) {
+    $packages_string = join($packages, ' ')
   } else {
-    $pin = "release a=${name}"
+    $packages_string = $packages
+  }
+
+  if $packages_string != '*' { # 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":
+
+  # 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')
+
+  file { "${file_name}.pref":
     ensure  => $ensure,
     path    => $path,
     owner   => root,