summaryrefslogtreecommitdiffstats
path: root/lib/puppet/provider/cron/crontab.rb
blob: 73ca78cf5d1e94126c15289704d6ec8b5a18658e (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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
require 'puppet/provider/parsedfile'

tab = case Facter.value(:operatingsystem)
    when "Solaris"
        :suntab
    when "AIX"
        :aixtab
    else
        :crontab
    end



            Puppet::Type.type(:cron).provide(
                :crontab,
    :parent => Puppet::Provider::ParsedFile,
    :default_target => ENV["USER"] || "root",
        
    :filetype => tab
) do
    commands :crontab => "crontab"

    text_line :comment, :match => %r{^#}, :post_parse => proc { |record|
        record[:name] = $1 if record[:line] =~ /Puppet Name: (.+)\s*$/
    }

    text_line :blank, :match => %r{^\s*$}

    text_line :environment, :match => %r{^\w+=}

    record_line :freebsd_special, :fields => %w{special command},
        :match => %r{^@(\w+)\s+(.+)$}, :pre_gen => proc { |record|
            record[:special] = "@" + record[:special]
        }

    crontab = record_line :crontab, :fields => %w{minute hour monthday month weekday command},
        :match => %r{^\s*(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(.+)$},
        :optional => %w{minute hour weekday month monthday}, :absent => "*"

    class << crontab
        def numeric_fields
            fields - [:command]
        end
        # Do some post-processing of the parsed record.  Basically just
        # split the numeric fields on ','.
        def post_parse(record)
            numeric_fields.each do |field|
                if val = record[field] and val != :absent
                    record[field] = record[field].split(",")
                end
            end
        end

        # Join the fields back up based on ','.
        def pre_gen(record)
            numeric_fields.each do |field|
                if vals = record[field] and vals.is_a?(Array)
                    record[field] = vals.join(",")
                end
            end
        end


        # Add name and environments as necessary.
        def to_line(record)
            str = ""
            str = "# Puppet Name: #{record[:name]}\n" if record[:name]
            if record[:environment] and record[:environment] != :absent and record[:environment] != [:absent]
                record[:environment].each do |env|
                    str += env + "\n"
                end
            end

            if record[:special]
                str += "@#{record[:special]} #{record[:command]}"
            else
                str += join(record)
            end
            str
        end
    end


    # Return the header placed at the top of each generated file, warning
    # users that modifying this file manually is probably a bad idea.
    def self.header
%{# HEADER: This file was autogenerated at #{Time.now} by puppet.
# HEADER: While it can still be managed manually, it is definitely not recommended.
# HEADER: Note particularly that the comments starting with 'Puppet Name' should
# HEADER: not be deleted, as doing so could cause duplicate cron jobs.\n}
    end

    # See if we can match the record against an existing cron job.
    def self.match(record, resources)
        resources.each do |name, resource|
            # Match the command first, since it's the most important one.
            next unless record[:target] == resource.value(:target)
            next unless record[:command] == resource.value(:command)

            # Then check the @special stuff
            if record[:special]
                next unless resource.value(:special) == record[:special]
            end

            # Then the normal fields.
            matched = true
            record_type(record[:record_type]).fields().each do |field|
                next if field == :command
                next if field == :special
                if record[field] and ! resource.value(field)
                    #Puppet.info "Cron is missing %s: %s and %s" %
                    #    [field, record[field].inspect, resource.value(field).inspect]
                    matched = false
                    break
                end

                if ! record[field] and resource.value(field)
                    #Puppet.info "Hash is missing %s: %s and %s" %
                    #    [field, resource.value(field).inspect, record[field].inspect]
                    matched = false
                    break
                end

                # Yay differing definitions of absent.
                next if (record[field] == :absent and resource.value(field) == "*")

                # Everything should be in the form of arrays, not the normal text.
                next if (record[field] == resource.value(field))
                #Puppet.info "Did not match %s: %s vs %s" %
                #    [field, resource.value(field).inspect, record[field].inspect]
                matched = false
                break
            end
            return resource if matched
        end

        false
    end

    # Collapse name and env records.
    def self.prefetch_hook(records)
        name = nil
        envs = nil
        result = records.each { |record|
            case record[:record_type]
            when :comment
                if record[:name]
                    name = record[:name]
                    record[:skip] = true

                    # Start collecting env values
                    envs = []
                end
            when :environment
                # If we're collecting env values (meaning we're in a named cronjob),
                # store the line and skip the record.
                if envs
                    envs << record[:line]
                    record[:skip] = true
                end
            when :blank
                # nothing
            else
                if name
                    record[:name] = name
                    name = nil
                end
                if envs.nil? or envs.empty?
                    record[:environment] = :absent
                else
                    # Collect all of the environment lines, and mark the records to be skipped,
                    # since their data is included in our crontab record.
                    record[:environment] = envs

                    # And turn off env collection again
                    envs = nil
                end
            end
        }.reject { |record| record[:skip] }
        result
    end

    def self.to_file(records)
        text = super
        # Apparently Freebsd will "helpfully" add a new TZ line to every
        # single cron line, but not in all cases (e.g., it doesn't do it
        # on my machine).  This is my attempt to fix it so the TZ lines don't
        # multiply.
        if text =~ /(^TZ=.+\n)/
            tz = $1
            text.sub!(tz, '')
            text = tz + text
        end
        text
    end

    def user=(user)
        @property_hash[:user] = user
        @property_hash[:target] = user
    end

    def user
        @property_hash[:user] || @property_hash[:target]
    end
end