apt::pin: handling all apt preferences properties
[puppet-modules/puppetlabs-apt.git] / manifests / pin.pp
1 # pin.pp
2 # pin a release in apt, useful for unstable repositories
3
4 define apt::pin(
5   $ensure          = present,
6   $explanation     = "${::caller_module_name}: ${name}",
7   $order           = '',
8   $packages        = '*',
9   $priority        = 0,
10   $release         = '', # a=
11   $origin          = '',
12   $version         = '',
13   $codename        = '', # n=
14   $release_version = '', # v=
15   $component       = '', # c=
16   $originator      = '', # o=
17   $label           = '', # l=
18 ) {
19
20   include apt::params
21
22   $preferences_d = $apt::params::preferences_d
23
24   if $order != '' and !is_integer($order) {
25     fail('Only integers are allowed in the apt::pin order param')
26   }
27
28   $pin_release = join([
29     $release,
30     $codename,
31     $release_version,
32     $component,
33     $originator,
34     $label], '')
35
36   # Read the manpage 'apt_preferences(5)', especially the chapter
37   # 'Thea Effect of APT Preferences' to understand the following logic
38   # and the difference between specific and general form
39   if $packages != '*' { # specific form
40
41     if ( $pin_release != '' and ( $origin != '' or $version != '' )) or
42       ( $origin != '' and ( $pin_release != '' or $version != '' )) or
43       ( $version != '' and ( $pin_release != '' or $origin != '' )) {
44       fail('parameters release, origin, and version are mutually exclusive')
45     }
46
47   } else { # general form
48
49     if $version != '' {
50       fail('parameter version cannot be used in general form')
51     }
52
53     if ( $pin_release != '' and $origin != '' ) or
54       ( $origin != '' and $pin_release != '' ) {
55       fail('parmeters release and origin are mutually exclusive')
56     }
57
58   }
59
60   $path = $order ? {
61     ''      => "${preferences_d}/${name}.pref",
62     default => "${preferences_d}/${order}-${name}.pref",
63   }
64   file { "${name}.pref":
65     ensure  => $ensure,
66     path    => $path,
67     owner   => root,
68     group   => root,
69     mode    => '0644',
70     content => template('apt/pin.pref.erb'),
71   }
72 }