Class: Puppet::Indirector::Msgpack

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

Overview

The base class for MessagePack indirection terminus implementations.

This should generally be preferred to the PSON base for any future implementations, since it is ~ 30 times faster

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, 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

#initialize(*args) ⇒ Msgpack

Returns a new instance of Msgpack.



11
12
13
14
15
16
17
 
# File 'lib/puppet/indirector/msgpack.rb', line 11

def initialize(*args)
  unless Puppet.features.msgpack?
    raise _("MessagePack terminus not supported without msgpack library")
  end

  super
end

Instance Method Details

#destroy(request) ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/puppet/indirector/msgpack.rb', line 32

def destroy(request)
  Puppet::FileSystem.unlink(path(request.key))
rescue => detail
  unless detail.is_a? Errno::ENOENT
    raise Puppet::Error, _("Could not destroy %{name} %{request}: %{detail}") % { name: name, request: request.key, detail: detail }, detail.backtrace
  end

  1 # emulate success...
end

#find(request) ⇒ Object 



19
20
21
 
# File 'lib/puppet/indirector/msgpack.rb', line 19

def find(request)
  load_msgpack_from_file(path(request.key), request.key)
end

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

Return the path to a given node’s file.



49
50
51
52
53
54
55
56
57
 
# File 'lib/puppet/indirector/msgpack.rb', line 49

def path(name, ext = '.msgpack')
  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[:server_datadir] : Puppet[:client_datadir]
  File.join(base, self.class.indirection_name.to_s, name.to_s + ext)
end

#save(request) ⇒ Object 



23
24
25
26
27
28
29
30
 
# File 'lib/puppet/indirector/msgpack.rb', line 23

def save(request)
  filename = path(request.key)
  FileUtils.mkdir_p(File.dirname(filename))

  Puppet::FileSystem.replace_file(filename, 0o660) { |f| f.print to_msgpack(request.instance) }
rescue TypeError => detail
  Puppet.log_exception(detail, _("Could not save %{name} %{request}: %{detail}") % { name: name, request: request.key, detail: detail })
end

#search(request) ⇒ Object 



42
43
44
45
46
 
# File 'lib/puppet/indirector/msgpack.rb', line 42

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