Class: Puppet::Indirector::Yaml

Inherits:
Terminus show all
Defined in:
lib/puppet/indirector/yaml.rb

Overview

The base class for YAML indirection termini.

Constant Summary

Constants included from Util

Util::ALNUM, Util::ALPHA, Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::ESCAPED, Util::HEX, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RESERVED, Util::RFC_3986_URI_REGEX, Util::UNRESERVED, Util::UNSAFE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Instance Attribute Summary

Attributes included from Util::Docs

#doc, #nodoc

Instance Method Summary collapse

Methods inherited from Terminus

abstract_terminus?, #allow_remote_requests?, const2name, #indirection, indirection_name, inherited, #initialize, mark_as_abstract_terminus, model, #model, #name, name2const, register_terminus_class, #require_environment?, terminus_class, terminus_classes, #terminus_type, #validate, #validate_key, #validate_model

Methods included from Util::InstanceLoader

#instance_hash, #instance_load, #instance_loader, #instance_loading?, #loaded_instance, #loaded_instances

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, create_erb, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Constructor Details

This class inherits a constructor from Puppet::Indirector::Terminus

Instance Method Details

#destroy(request) ⇒ Object 



49
50
51
52
 
# File 'lib/puppet/indirector/yaml.rb', line 49

def destroy(request)
  file_path = path(request.key)
  Puppet::FileSystem.unlink(file_path) if Puppet::FileSystem.exist?(file_path)
end

#find(request) ⇒ Object

Read a given name’s file in and convert it from YAML.



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/puppet/indirector/yaml.rb', line 9

def find(request)
  file = path(request.key)
  return nil unless Puppet::FileSystem.exist?(file)

  begin
    load_file(file)
  rescue Puppet::Util::Yaml::YamlLoadError => detail
    raise Puppet::Error, _("Could not parse YAML data for %{indirection} %{request}: %{detail}") % { indirection: indirection.name, request: request.key, detail: detail }, detail.backtrace
  end
end

#path(name, ext = '.yaml') ⇒ Object

Return the path to a given node’s file.



39
40
41
42
43
44
45
46
47
 
# File 'lib/puppet/indirector/yaml.rb', line 39

def path(name, ext = '.yaml')
  if name =~ Puppet::Indirector::BadNameRegexp then
    Puppet.crit(_("directory traversal detected in %{indirection}: %{name}") % { indirection: self.class, name: name.inspect })
    raise ArgumentError, _("invalid key")
  end

  base = Puppet.run_mode.server? ? Puppet[:yamldir] : Puppet[:clientyamldir]
  File.join(base, self.class.indirection_name.to_s, name.to_s + ext)
end

#save(request) ⇒ Object

Convert our object to YAML and store it to the disk.

Raises:

  • (ArgumentError) 


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/puppet/indirector/yaml.rb', line 21

def save(request)
  raise ArgumentError, _("You can only save objects that respond to :name") unless request.instance.respond_to?(:name)

  file = path(request.key)

  basedir = File.dirname(file)

  # This is quite likely a bad idea, since we're not managing ownership or modes.
  Dir.mkdir(basedir) unless Puppet::FileSystem.exist?(basedir)

  begin
    Puppet::Util::Yaml.dump(request.instance, file)
  rescue TypeError => detail
    Puppet.err _("Could not save %{indirection} %{request}: %{detail}") % { indirection: name, request: request.key, detail: detail }
  end
end

#search(request) ⇒ Object 



54
55
56
57
58
 
# File 'lib/puppet/indirector/yaml.rb', line 54

def search(request)
  Dir.glob(path(request.key, '')).collect do |file|
    load_file(file)
  end
end