Class: Puppet::Indirector::FileServer

Inherits:
Terminus show all
Includes:
FileServing::TerminusHelper
Defined in:
lib/puppet/indirector/file_server.rb

Overview

Look files up using the file server.

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 included from FileServing::TerminusHelper

#path2instance, #path2instances

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

#authorized?(request) ⇒ Boolean

Is the client authorized to perform this action?

Returns:

  • (Boolean)

11
12
13
14
15
16
17
18
19
20
# File 'lib/puppet/indirector/file_server.rb', line 11

def authorized?(request)
  return false unless [:find, :search].include?(request.method)

  mount, _ = configuration.split_path(request)

  # If we're not serving this mount, then access is denied.
  return false unless mount

  true
end

#find(request) ⇒ Object

Find our key using the fileserver.


23
24
25
26
27
28
29
30
31
32
33
# File 'lib/puppet/indirector/file_server.rb', line 23

def find(request)
  mount, relative_path = configuration.split_path(request)

  return nil unless mount

  # The mount checks to see if the file exists, and returns nil
  # if not.
  path = mount.find(relative_path, request)
  return nil unless path
  path2instance(request, path)
end

#search(request) ⇒ Object

Search for files. This returns an array rather than a single file.


37
38
39
40
41
42
43
44
45
46
# File 'lib/puppet/indirector/file_server.rb', line 37

def search(request)
  mount, relative_path = configuration.split_path(request)

  paths = mount.search(relative_path, request) if mount
  unless paths
    Puppet.info _("Could not find filesystem info for file '%{request}' in environment %{env}") % { request: request.key, env: request.environment }
    return nil
  end
  path2instances(request, *paths)
end