summaryrefslogtreecommitdiffstats
path: root/lib/puppet/type/resources.rb
blob: fc7109c381e590f2f74d7a4dc315e5aa38110d08 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
#  Created by Luke Kanies on 2006-12-12.
#  Copyright (c) 2006. All rights reserved.

require 'puppet'

Puppet::Type.newtype(:resources) do
    @doc = "This is a metatype that can manage other resource types.  Any
        metaparams specified here will be passed on to any generated resources,
        so you can purge umanaged resources but set ``noop`` to true so the
        purging is only logged and does not actually happen."


    newparam(:name) do
        desc "The name of the type to be managed."

        validate do |name|
            raise ArgumentError, "Could not find resource type '#{name}'" unless Puppet::Type.type(name)
        end

        munge { |v| v.to_s }
    end

    newparam(:purge, :boolean => true) do
        desc "Purge unmanaged resources.  This will delete any resource
            that is not specified in your configuration
            and is not required by any specified resources."

        newvalues(:true, :false)

        validate do |value|
            if [:true, true, "true"].include?(value)
                unless @resource.resource_type.respond_to?(:instances)
                    raise ArgumentError, "Purging resources of type #{@resource[:name]} is not supported, since they cannot be queried from the system"
                end
                raise ArgumentError, "Purging is only supported on types that accept 'ensure'" unless @resource.resource_type.validproperty?(:ensure)
            end
        end
    end

    newparam(:unless_system_user) do
        desc "This keeps system users from being purged.  By default, it
            does not purge users whose UIDs are less than or equal to 500, but you can specify
            a different UID as the inclusive limit."

        newvalues(:true, :false, /^\d+$/)

        munge do |value|
            case value
            when /^\d+/
                Integer(value)
            when :true, true
                500
            when :false, false
                false
            when Integer; value
            else
                raise ArgumentError, "Invalid value #{value.inspect}"
            end
        end

        defaultto {
            if @resource[:name] == "user"
                500
            else
                nil
            end
        }
    end

    def check(resource)
        @checkmethod = "#{self[:name]}_check" unless defined?(@checkmethod)
        @hascheck = respond_to?(@checkmethod) unless defined?(@hascheck)
        if @hascheck
            return send(@checkmethod, resource)
        else
            return true
        end
    end

    def able_to_ensure_absent?(resource)
            resource[:ensure] = :absent
    rescue ArgumentError, Puppet::Error => detail
            err "The 'ensure' attribute on #{self[:name]} resources does not accept 'absent' as a value"
            false
    end

    # Generate any new resources we need to manage.  This is pretty hackish
    # right now, because it only supports purging.
    def generate
        return [] unless self.purge?
        resource_type.instances.
            reject { |r| catalog.resource_refs.include? r.ref }.
            select { |r| check(r) }.
            select { |r| r.class.validproperty?(:ensure) }.
            select { |r| able_to_ensure_absent?(r) }.
            each { |resource|
                @parameters.each do |name, param|
                    resource[name] = param.value if param.metaparam?
                end

                # Mark that we're purging, so transactions can handle relationships
                # correctly
                resource.purging
            }
    end

    def resource_type
        unless defined?(@resource_type)
            unless type = Puppet::Type.type(self[:name])
                raise Puppet::DevError, "Could not find resource type"
            end
            @resource_type = type
        end
        @resource_type
    end

    # Make sure we don't purge users below a certain uid, if the check
    # is enabled.
    def user_check(resource)
        return true unless self[:name] == "user"
        return true unless self[:unless_system_user]

        resource[:audit] = :uid
        current_values = resource.retrieve_resource

        return false if system_users().include?(resource[:name])

        current_values[resource.property(:uid)] > self[:unless_system_user]
    end

    def system_users
        %w{root nobody bin noaccess daemon sys}
    end
end