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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
|
# The scope class, which handles storing and retrieving variables and types and
# such.
require 'puppet/parser/parser'
require 'puppet/parser/templatewrapper'
require 'puppet/transportable'
class Puppet::Parser::Scope
require 'puppet/parser/resource'
AST = Puppet::Parser::AST
# This doesn't actually work right now.
Puppet.config.setdefaults(:puppet,
:lexical => [false, "Whether to use lexical scoping (vs. dynamic)."],
:templatedir => ["$vardir/templates",
"Where Puppet looks for template files."
]
)
Puppet::Util.logmethods(self)
include Enumerable
include Puppet::Util::Errors
attr_accessor :parent, :level, :interp, :source, :host
attr_accessor :name, :type, :topscope, :base, :keyword, :namespace
attr_accessor :top, :context, :translated, :exported
# Whether we behave declaratively. Note that it's a class variable,
# so all scopes behave the same.
@@declarative = true
# Retrieve and set the declarative setting.
def self.declarative
return @@declarative
end
def self.declarative=(val)
@@declarative = val
end
# This handles the shared tables that all scopes have. They're effectively
# global tables, except that they're only global for a single scope tree,
# which is why I can't use class variables for them.
def self.sharedtable(*names)
attr_accessor(*names)
@@sharedtables ||= []
@@sharedtables += names
end
# This is probably not all that good of an idea, but...
# This way a parent can share its tables with all of its children.
sharedtable :classtable, :definedtable, :exportable, :overridetable, :collecttable
# Is the value true? This allows us to control the definition of truth
# in one place.
def self.true?(value)
if value == false or value == ""
return false
else
return true
end
end
# Is the type a builtin type?
def builtintype?(type)
if typeklass = Puppet::Type.type(type)
return typeklass
else
return false
end
end
# Create a new child scope.
def child=(scope)
@children.push(scope)
# Copy all of the shared tables over to the child.
@@sharedtables.each do |name|
scope.send(name.to_s + "=", self.send(name))
end
end
# Verify that the given object isn't defined elsewhere.
def chkobjectclosure(obj)
if @definedtable.include?(obj.ref)
typeklass = Puppet::Type.type(obj.type)
if typeklass and ! typeklass.isomorphic?
Puppet.info "Allowing duplicate %s" % type
else
exobj = @definedtable[obj.ref]
# Either it's a defined type, which are never
# isomorphic, or it's a non-isomorphic type.
msg = "Duplicate definition: %s is already defined" % obj.ref
if exobj.file and exobj.line
msg << " in file %s at line %s" %
[exobj.file, exobj.line]
end
if obj.line or obj.file
msg << "; cannot redefine"
end
raise Puppet::ParseError.new(msg)
end
end
return true
end
# Return the list of collections.
def collections
@collecttable
end
def declarative=(val)
self.class.declarative = val
end
def declarative
self.class.declarative
end
# Test whether a given scope is declarative. Even though it's
# a global value, the calling objects don't need to know that.
def declarative?
@@declarative
end
# Remove a specific child.
def delete(child)
@children.delete(child)
end
# Remove a resource from the various tables. This is only used when
# a resource maps to a definition and gets evaluated.
def deleteresource(resource)
if @definedtable[resource.ref]
@definedtable.delete(resource.ref)
end
if @children.include?(resource)
@children.delete(resource)
end
end
# Are we the top scope?
def topscope?
@level == 1
end
# Return a list of all of the defined classes.
def classlist
unless defined? @classtable
raise Puppet::DevError, "Scope did not receive class table"
end
return @classtable.keys.reject { |k| k == "" }
end
# Yield each child scope in turn
def each
@children.each { |child|
yield child
}
end
# Evaluate a list of classes.
def evalclasses(*classes)
retval = []
classes.each do |klass|
if obj = findclass(klass)
obj.safeevaluate :scope => self
retval << klass
end
end
end
def exported?
self.exported
end
def findclass(name)
interp.findclass(namespace, name)
end
def finddefine(name)
interp.finddefine(namespace, name)
end
def findresource(string, name = nil)
if name
string = "%s[%s]" % [string, name]
end
@definedtable[string]
end
# Recursively complete the whole tree, in preparation for
# translation or storage.
def finish
self.each do |obj|
obj.finish
end
end
# Initialize our new scope. Defaults to having no parent and to
# being declarative.
def initialize(hash = {})
@parent = nil
@type = nil
@name = nil
@finished = false
hash.each { |name, val|
method = name.to_s + "="
if self.respond_to? method
self.send(method, val)
else
raise Puppet::DevError, "Invalid scope argument %s" % name
end
}
@tags = []
if @parent.nil?
unless hash.include?(:declarative)
hash[:declarative] = true
end
self.istop(hash[:declarative])
@inside = nil
else
# This is here, rather than in newchild(), so that all
# of the later variable initialization works.
@parent.child = self
@level = @parent.level + 1
@interp = @parent.interp
@source = hash[:source] || @parent.source
@topscope = @parent.topscope
@context = @parent.context
@inside = @parent.inside
@host = @parent.host
@type ||= @parent.type
end
# Our child scopes and objects
@children = []
# The symbol table for this scope
@symtable = Hash.new(nil)
# All of the defaults set for types. It's a hash of hashes,
# with the first key being the type, then the second key being
# the parameter.
@defaultstable = Hash.new { |dhash,type|
dhash[type] = Hash.new(nil)
}
# Map the names to the tables.
@map = {
"variable" => @symtable,
"defaults" => @defaultstable
}
unless @interp
raise Puppet::DevError, "Scopes require an interpreter"
end
end
# Associate the object directly with the scope, so that contained objects
# can look up what container they're running within.
def inside(arg = nil)
return @inside unless arg
old = @inside
@inside = arg
yield
ensure
#Puppet.warning "exiting %s" % @inside.name
@inside = old
end
# Mark that we're the top scope, and set some hard-coded info.
def istop(declarative = true)
# the level is mostly used for debugging
@level = 1
# The table for storing class singletons. This will only actually
# be used by top scopes and node scopes.
@classtable = Hash.new(nil)
self.class.declarative = declarative
# The table for all defined objects.
@definedtable = {}
# The list of objects that will available for export.
@exportable = {}
# The list of overrides. This is used to cache overrides on objects
# that don't exist yet. We store an array of each override.
@overridetable = Hash.new do |overs, ref|
overs[ref] = []
end
# Eventually, if we support sites, this will allow definitions
# of nodes with the same name in different sites. For now
# the top-level scope is always the only site scope.
@sitescope = true
@namespace = ""
# The list of collections that have been created. This is a global list,
# but they each refer back to the scope that created them.
@collecttable = []
@context = nil
@topscope = self
@type = "puppet"
@name = "top"
end
# Collect all of the defaults set at any higher scopes.
# This is a different type of lookup because it's additive --
# it collects all of the defaults, with defaults in closer scopes
# overriding those in later scopes.
def lookupdefaults(type)
values = {}
# first collect the values from the parents
unless @parent.nil?
@parent.lookupdefaults(type).each { |var,value|
values[var] = value
}
end
# then override them with any current values
# this should probably be done differently
if @defaultstable.include?(type)
@defaultstable[type].each { |var,value|
values[var] = value
}
end
#Puppet.debug "Got defaults for %s: %s" %
# [type,values.inspect]
return values
end
# Look up all of the exported objects of a given type. Just like
# lookupobject, this only searches up through parent classes, not
# the whole scope tree.
def lookupexported(type)
@definedtable.find_all do |name, r|
r.type == type and r.exported?
end
end
def lookupoverrides(obj)
@overridetable[obj.ref]
end
# Look up a defined type.
def lookuptype(name)
finddefine(name) || findclass(name)
end
# Look up a variable. The simplest value search we do. Default to returning
# an empty string for missing values, but support returning a constant.
def lookupvar(name, usestring = true)
value = lookup("variable", name)
if value == :undefined
if usestring
return ""
else
return :undefined
end
else
return value
end
end
# Add a collection to the global list.
def newcollection(coll)
@collecttable << coll
end
# Create a new scope.
def newscope(hash = {})
hash[:parent] = self
#debug "Creating new scope, level %s" % [self.level + 1]
return Puppet::Parser::Scope.new(hash)
end
# Return the list of remaining overrides.
def overrides
@overridetable.collect { |name, overs| overs }.flatten
end
def resources
@definedtable.values
end
def setclass?(obj)
if obj.respond_to?(:fqname)
@classtable.has_key?(obj.fqname)
else
@classtable[obj]
end
end
# Store the fact that we've evaluated a given class. We use a hash
# that gets inherited from the top scope down, rather than a global
# hash. We store the object ID, not class name, so that we
# can support multiple unrelated classes with the same name.
def setclass(obj)
if obj.is_a?(AST::HostClass)
unless obj.fqname
raise Puppet::DevError, "Got a %s with no fully qualified name" %
obj.class
end
@classtable[obj.fqname] = obj
else
raise Puppet::DevError, "Invalid class %s" % obj.inspect
end
end
# Set all of our facts in the top-level scope.
def setfacts(facts)
facts.each { |var, value|
self.setvar(var, value)
}
end
# Add a new object to our object table and the global list, and do any necessary
# checks.
def setresource(obj)
self.chkobjectclosure(obj)
@children << obj
# The global table
@definedtable[obj.ref] = obj
return obj
end
# Override a parameter in an existing object. If the object does not yet
# exist, then cache the override in a global table, so it can be flushed
# at the end.
def setoverride(resource)
resource.override = true
if obj = @definedtable[resource.ref]
obj.merge(resource)
else
@overridetable[resource.ref] << resource
end
end
# Set defaults for a type. The typename should already be downcased,
# so that the syntax is isolated. We don't do any kind of type-checking
# here; instead we let the resource do it when the defaults are used.
def setdefaults(type, params)
table = @defaultstable[type]
# if we got a single param, it'll be in its own array
params = [params] unless params.is_a?(Array)
params.each { |param|
#Puppet.debug "Default for %s is %s => %s" %
# [type,ary[0].inspect,ary[1].inspect]
if @@declarative
if table.include?(param.name)
self.fail "Default already defined for %s { %s }" %
[type,param.name]
end
else
if table.include?(param.name)
# we should maybe allow this warning to be turned off...
Puppet.warning "Replacing default for %s { %s }" %
[type,param.name]
end
end
table[param.name] = param
}
end
# Set a variable in the current scope. This will override settings
# in scopes above, but will not allow variables in the current scope
# to be reassigned if we're declarative (which is the default).
def setvar(name,value)
#Puppet.debug "Setting %s to '%s' at level %s" %
# [name.inspect,value,self.level]
if @@declarative and @symtable.include?(name)
raise Puppet::ParseError, "Cannot reassign variable %s" % name
else
if @symtable.include?(name)
Puppet.warning "Reassigning %s to %s" % [name,value]
end
@symtable[name] = value
end
end
# Return an interpolated string.
def strinterp(string)
newstring = string.gsub(/\\\$|\$\{(\w+)\}|\$(\w+)/) do |value|
# If it matches the backslash, then just retun the dollar sign.
if value == '\\$'
'$'
else # look the variable up
var = $1 || $2
lookupvar($1 || $2)
end
end
return newstring.gsub(/\\t/, "\t").gsub(/\\n/, "\n").gsub(/\\s/, "\s")
end
# Add a tag to our current list. These tags will be added to all
# of the objects contained in this scope.
def tag(*ary)
ary.each { |tag|
unless tag =~ /^\w[-\w]+$/
fail Puppet::ParseError, "Invalid tag %s" % tag
end
if tag.nil? or tag == ""
puts caller
Puppet.debug "got told to tag with %s" % tag.inspect
next
end
tag = tag.to_s
unless @tags.include?(tag)
#Puppet.info "Tagging scope %s with %s" % [self.object_id, tag]
@tags << tag
end
}
end
# Return the tags associated with this scope. It's basically
# just our parents' tags, plus our type. We don't cache this value
# because our parent tags might change between calls.
def tags
tmp = [] + @tags
unless ! defined? @type or @type.nil? or @type == ""
tmp << @type.to_s
end
if @parent
#info "Looking for tags in %s" % @parent.type
@parent.tags.each { |tag|
if tag.nil? or tag == ""
Puppet.debug "parent returned tag %s" % tag.inspect
next
end
unless tmp.include?(tag)
tmp << tag
end
}
end
return tmp.sort.uniq
end
# Used mainly for logging
def to_s
if self.name
return "%s[%s]" % [@type, @name]
else
return self.type.to_s
end
end
# Convert all of our objects as necessary.
def translate
ret = @children.collect do |child|
case child
when self.class
child.translate
when Puppet::Parser::Resource
child.to_trans
else
devfail "Got %s for translation" % child.class
end
end.reject { |o| o.nil? }
bucket = Puppet::TransBucket.new ret
unless self.type
devfail "A Scope with no type"
end
if @type == ""
bucket.type = "main"
else
bucket.type = @type
end
if self.name
bucket.name = self.name
end
return bucket
end
# Undefine a variable; only used for testing.
def unsetvar(var)
if @symtable.include?(var)
@symtable.delete(var)
end
end
# Return an array of all of the unevaluated objects
def unevaluated
ary = @definedtable.find_all do |name, object|
! object.builtin? and ! object.evaluated?
end.collect { |name, object| object }
if ary.empty?
return nil
else
return ary
end
end
protected
# This method abstracts recursive searching. It accepts the type
# of search being done and then either a literal key to search for or
# a Proc instance to do the searching.
def lookup(type,sub, usecontext = false)
table = @map[type]
if table.nil?
self.fail "Could not retrieve %s table at level %s" %
[type,self.level]
end
if sub.is_a?(Proc) and obj = sub.call(table)
return obj
elsif table.include?(sub)
return table[sub]
elsif ! @parent.nil?
# Context is used for retricting overrides.
if usecontext and self.context != @parent.context
return :undefined
else
return @parent.lookup(type,sub, usecontext)
end
else
return :undefined
end
end
end
# $Id$
|