summaryrefslogtreecommitdiffstats
path: root/lib/puppet/log.rb
blob: 62fe98fdf4882b1bb5f33a682f591436ed846024 (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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
require 'syslog'

module Puppet # :nodoc:
    # Pass feedback to the user.  Log levels are modeled after syslog's, and it is
    # expected that that will be the most common log destination.  Supports
    # multiple destinations, one of which is a remote server.
	class Log
        PINK=""
        GREEN=""
        YELLOW=""
        SLATE=""
        ORANGE=""
        BLUE=""
        RESET=""

        @levels = [:debug,:info,:notice,:warning,:err,:alert,:emerg,:crit]
        @loglevel = 2

		@colors = {
			:debug => SLATE,
			:info => GREEN,
			:notice => PINK,
			:warning => ORANGE,
			:err => YELLOW,
            :alert => BLUE,
            :emerg => RESET,
            :crit => RESET
		}

        @destinations = {:syslog => Syslog.open("puppet")}

        # Reset all logs to basics.  Basically just closes all files and undefs
        # all of the other objects.
        def Log.close(dest = nil)
            if dest
                if @destinations.include?(dest)
                    Puppet.warning "Closing %s" % dest
                    if @destinations.respond_to?(:close)
                        @destinations[dest].close
                    end
                    @destinations.delete(dest)
                end
            else
                @destinations.each { |type, dest|
                    if dest.respond_to?(:flush)
                        dest.flush
                    end
                    if dest.respond_to?(:close)
                        dest.close
                    end
                }
                @destinations = {}
            end

            Puppet.info "closed"
        end

        # Flush any log destinations that support such operations.
        def Log.flush
            @destinations.each { |type, dest|
                if dest.respond_to?(:flush)
                    dest.flush
                end
            }
        end

        # Create a new log message.  The primary role of this method is to
        # avoid creating log messages below the loglevel.
        def Log.create(hash)
            if @levels.index(hash[:level]) >= @loglevel 
                return Puppet::Log.new(hash)
            else
                return nil
            end
        end

        # Yield each valid level in turn
        def Log.eachlevel
            @levels.each { |level| yield level }
        end

        # Return the current log level.
        def Log.level
            return @levels[@loglevel]
        end

        # Set the current log level.
        def Log.level=(level)
            unless level.is_a?(Symbol)
                level = level.intern
            end

            unless @levels.include?(level)
                raise Puppet::DevError, "Invalid loglevel %s" % level
            end

            @loglevel = @levels.index(level)
        end

        # Create a new log destination.
        def Log.newdestination(dest)
            # Each destination can only occur once.
            if @destinations.include?(dest)
                return
            end

            case dest
            when "syslog", :syslog
                if Syslog.opened?
                    Syslog.close
                end
                @destinations[:syslog] = Syslog.open("puppet")
            when /^\// # files
                Puppet.info "opening %s as a log" % dest
                # first make sure the directory exists
                unless FileTest.exist?(File.dirname(dest))
                    begin
                        Puppet.recmkdir(File.dirname(dest))
                        Puppet.info "Creating log directory %s" %
                            File.dirname(dest)
                    rescue => detail
                        Log.destination = :console
                        Puppet.err "Could not create log directory: %s" %
                            detail
                        return
                    end
                end

                begin
                    # create the log file, if it doesn't already exist
                    file = File.open(dest,File::WRONLY|File::CREAT|File::APPEND)
                rescue => detail
                    Log.destination = :console
                    Puppet.err "Could not create log file: %s" %
                        detail
                    return
                end
                @destinations[dest] = file
            when "console", :console
                @destinations[:console] = :console
            when Puppet::Server::Logger
                @destinations[dest] = dest
            else
                Puppet.info "Treating %s as a hostname" % dest
                args = {}
                if dest =~ /:(\d+)/
                    args[:Port] = $1
                    args[:Server] = dest.sub(/:\d+/, '')
                else
                    args[:Server] = dest
                end
                @destinations[dest] = Puppet::Client::LogClient.new(args)
            end
        end

        # Route the actual message. FIXME There are lots of things this method should
        # do, like caching, storing messages when there are not yet destinations,
        # a bit more.
        # It's worth noting that there's a potential for a loop here, if
        # the machine somehow gets the destination set as itself.
        def Log.newmessage(msg)
            @destinations.each { |type, dest|
                case dest
                when Module # This is the Syslog module
                    next if msg.remote
                    # XXX Syslog currently has a bug that makes it so you
                    # cannot log a message with a '%' in it.  So, we get rid
                    # of them.
                    if msg.source == "Puppet"
                        dest.send(msg.level, msg.to_s.gsub("%", ''))
                    else
                        dest.send(msg.level, "(%s) %s" %
                            [msg.source.to_s.gsub("%", ""), msg.to_s.gsub("%", '')]
                        )
                    end
                when File:
                    dest.puts("%s %s (%s): %s" %
                        [msg.time, msg.source, msg.level, msg.to_s])
                when :console
                    if msg.source == "Puppet"
                        puts @colors[msg.level] + "%s: %s" % [
                            msg.level, msg.to_s
                        ] + RESET
                    else
                        puts @colors[msg.level] + "%s (%s): %s" % [
                            msg.source, msg.level, msg.to_s
                        ] + RESET
                    end
                when Puppet::Client::LogClient
                    unless msg.is_a?(String) or msg.remote
                        begin
                            #puts "would have sent %s" % msg
                            #puts "would have sent %s" %
                            #    CGI.escape(Marshal::dump(msg))
                            begin
                                tmp = CGI.escape(Marshal::dump(msg))
                            rescue => detail
                                puts "Could not dump: %s" % detail.to_s
                                return
                            end
                            dest.addlog(tmp)
                            #dest.addlog(msg.to_s)
                            sleep(0.5)
                        rescue => detail
                            Puppet.err detail
                            @destinations.delete(type)
                        end
                    end
                else
                    raise Puppet::Error, "Invalid log destination %s" % dest
                    #puts "Invalid log destination %s" % dest.inspect
                end
            }
        end

        # Reopen all of our logs.
        def Log.reopen
            types = @destinations.keys
            @destinations.each { |type, dest|
                if dest.respond_to?(:close)
                    dest.close
                end
            }
            @destinations.clear
            # We need to make sure we always end up with some kind of destination
            begin
                types.each { |type|
                    Log.newdestination(type)
                }
            rescue => detail
                if @destinations.empty?
                    Log.newdestination(:syslog)
                    Puppet.err detail.to_s
                end
            end
        end

        # Is the passed level a valid log level?
        def self.validlevel?(level)
            @levels.include?(level)
        end

		attr_accessor :level, :message, :source, :time, :tags, :remote

		def initialize(args)
			unless args.include?(:level) && args.include?(:message)
				raise Puppet::DevError, "Puppet::Log called incorrectly"
			end

			if args[:level].class == String
				@level = args[:level].intern
			elsif args[:level].class == Symbol
				@level = args[:level]
			else
				raise Puppet::DevError,
                    "Level is not a string or symbol: #{args[:level].class}"
			end
			@message = args[:message]
			@time = Time.now
			# this should include the host name, and probly lots of other
			# stuff, at some point
			unless self.class.validlevel?(level)
				raise Puppet::DevError, "Invalid message level #{level}"
			end

            if args.include?(:tags)
                @tags = args[:tags]
            end

            if args.include?(:source)
                # We can't store the actual source, we just store the path
                if args[:source].respond_to?(:path)
                    @source = args[:source].path
                else
                    @source = args[:source].to_s
                end
                unless defined? @tags and @tags
                    if args[:source].respond_to?(:tags)
                        @tags = args[:source].tags
                    end
                end
            else
                @source = "Puppet"
            end

            Log.newmessage(self)
		end

		def to_s
            return @message
		end
	end
end

# $Id$