2 # pin a release in apt, useful for unstable repositories
6 $explanation = "${caller_module_name}: ${name}",
14 $release_version = '', # v=
16 $originator = '', # o=
21 $preferences_d = $apt::params::preferences_d
23 if $order != '' and !is_integer($order) {
24 fail('Only integers are allowed in the apt::pin order param')
27 $pin_release_array = [
34 $pin_release = join($pin_release_array, '')
36 # Read the manpage 'apt_preferences(5)', especially the chapter
37 # 'The Effect of APT Preferences' to understand the following logic
38 # and the difference between specific and general form
39 if is_array($packages) {
40 $packages_string = join($packages, ' ')
42 $packages_string = $packages
45 if $packages_string != '*' { # specific form
46 if ( $pin_release != '' and ( $origin != '' or $version != '' )) or
47 ( $version != '' and ( $pin_release != '' or $origin != '' )) {
48 fail('parameters release, origin, and version are mutually exclusive')
50 } else { # general form
52 fail('parameter version cannot be used in general form')
54 if ( $pin_release != '' and $origin != '' ) {
55 fail('parameters release and origin are mutually exclusive')
60 # According to man 5 apt_preferences:
61 # The files have either no or "pref" as filename extension
62 # and only contain alphanumeric, hyphen (-), underscore (_) and period
63 # (.) characters. Otherwise APT will print a notice that it has ignored a
64 # file, unless that file matches a pattern in the
65 # Dir::Ignore-Files-Silently configuration list - in which case it will
66 # be silently ignored.
67 $file_name = regsubst($title, '[^0-9a-z\-_\.]', '_', 'IG')
70 '' => "${preferences_d}/${file_name}.pref",
71 default => "${preferences_d}/${order}-${file_name}.pref",
73 file { "${file_name}.pref":
79 content => template('apt/pin.pref.erb'),