class Puppet::Settings

# File lib/puppet/settings.rb, line 117
def [](param)
  if @deprecated_setting_names.include?(param)
    issue_deprecation_warning(setting(param), "Accessing '#{param}' as a setting is deprecated.")
  end
  value(param)
end

# File lib/puppet/settings.rb, line 128
def []=(param, value)
  if @deprecated_setting_names.include?(param)
    issue_deprecation_warning(setting(param), "Modifying '#{param}' as a setting is deprecated.")
  end
  @value_sets[:memory].set(param, value)
  unsafe_flush_cache
end

# File lib/puppet/settings.rb, line 152
def addargs(options)
  # Add all of the settings as valid options.
  self.each { |name, setting|
    setting.getopt_args.each { |args| options << args }
  }

  options
end

# File lib/puppet/settings.rb, line 328
def app_defaults_initialized?
  @app_defaults_initialized
end

# File lib/puppet/settings.rb, line 672
def apply_metadata_from_section(section)
  section.settings.each do |setting|
    if setting.has_metadata? && type = @config[setting.name]
      type.set_meta(setting.meta)
    end
  end
end

# File lib/puppet/settings.rb, line 173
def boolean?(param)
  param = param.to_sym
  @config.include?(param) and @config[param].kind_of?(BooleanSetting)
end

# File lib/puppet/settings.rb, line 179
def clear
  unsafe_clear
end

# File lib/puppet/settings.rb, line 215
def clear_environment_settings(environment)

  if environment.nil?
    return
  end

  @cache[environment.to_sym].clear
  @values[environment.to_sym] = {}
end

# File lib/puppet/settings.rb, line 251
def clearused
  @cache.clear
  @used = []
end

# File lib/puppet/settings.rb, line 869
def define_settings(section, defs)
  section = section.to_sym
  call = []
  defs.each do |name, hash|
    raise ArgumentError, "setting definition for '#{name}' is not a hash!" unless hash.is_a? Hash

    name = name.to_sym
    hash[:name] = name
    hash[:section] = section
    raise ArgumentError, "Setting #{name} is already defined" if @config.include?(name)
    tryconfig = newsetting(hash)
    if short = tryconfig.short
      if other = @shortnames[short]
        raise ArgumentError, "Setting #{other.name} is already using short name '#{short}'"
      end
      @shortnames[short] = tryconfig
    end
    @config[name] = tryconfig

    # Collect the settings that need to have their hooks called immediately.
    # We have to collect them so that we can be sure we're fully initialized before
    # the hook is called.
    if tryconfig.has_hook?
      if tryconfig.call_hook_on_define?
        call << tryconfig
      elsif tryconfig.call_hook_on_initialize?
        @hooks_to_call_on_application_initialization << tryconfig
      end
    end

    @deprecated_setting_names << name if tryconfig.deprecated?
  end

  call.each do |setting|
    setting.handle(self.value(setting.name))
  end
end

# File lib/puppet/settings.rb, line 366
def description(name)
  if obj = @config[name.to_sym]
    obj.desc
  else
    nil
  end
end

# File lib/puppet/settings.rb, line 377
def eachsection
  yielded = []
  @config.each do |name, object|
    section = object.section
    unless yielded.include? section
      yield section
      yielded << section
    end
  end
end

# File lib/puppet/settings.rb, line 235
def flush_cache
  unsafe_flush_cache
end

# File lib/puppet/settings.rb, line 473
def generate_config
  puts to_config
  true
end

# File lib/puppet/settings.rb, line 478
def generate_manifest
  puts to_manifest
  true
end

# File lib/puppet/settings.rb, line 256
def global_defaults_initialized?()
  @global_defaults_initialized
end

# File lib/puppet/settings.rb, line 395
def handlearg(opt, value = nil)
  @cache.clear

  if value.is_a?(FalseClass)
    value = "false"
  elsif value.is_a?(TrueClass)
    value = "true"
  end

  value &&= @translate[value]
  str = opt.sub(/^--/,'')

  bool = true
  newstr = str.sub(/^no-/, '')
  if newstr != str
    str = newstr
    bool = false
  end
  str = str.intern

  if @config[str].is_a?(Puppet::Settings::BooleanSetting)
    if value == "" or value.nil?
      value = bool
    end
  end

  if s = @config[str]
    @deprecated_settings_that_have_been_configured << s if s.completely_deprecated?
  end

  @value_sets[:cli].set(str, value)
  unsafe_flush_cache
end

# File lib/puppet/settings.rb, line 429
def include?(name)
  name = name.intern if name.is_a? String
  @config.include?(name)
end

# File lib/puppet/settings.rb, line 332
def initialize_app_defaults(app_defaults)
  REQUIRED_APP_SETTINGS.each do |key|
    raise SettingsError, "missing required app default setting '#{key}'" unless app_defaults.has_key?(key)
  end

  app_defaults.each do |key, value|
    if key == :run_mode
      self.preferred_run_mode = value
    else
      @value_sets[:application_defaults].set(key, value)
      unsafe_flush_cache
    end
  end
  apply_metadata
  call_hooks_deferred_to_application_initialization
  issue_deprecations

  @app_defaults_initialized = true
end

# File lib/puppet/settings.rb, line 260
def initialize_global_settings(args = [])
  raise Puppet::DevError, "Attempting to initialize global default settings more than once!" if global_defaults_initialized?

  # The first two phases of the lifecycle of a puppet application are:
  # 1) Parse the command line options and handle any of them that are
  #    registered, defined "global" puppet settings (mostly from defaults.rb).
  # 2) Parse the puppet config file(s).

  parse_global_options(args)
  parse_config_files

  @global_defaults_initialized = true
end

# File lib/puppet/settings.rb, line 494
def metadata(param)
  if obj = @config[param.to_sym] and obj.is_a?(FileSetting)
    {
      :owner => obj.owner,
      :group => obj.group,
      :mode => obj.mode
    }.delete_if { |key, value| value.nil? }
  else
    nil
  end
end

# File lib/puppet/settings.rb, line 507
def mkdir(default)
  obj = get_config_file_default(default)

  Puppet::Util::SUIDManager.asuser(obj.owner, obj.group) do
    mode = obj.mode || 0750
    Dir.mkdir(obj.value, mode)
  end
end

# File lib/puppet/settings.rb, line 163
def optparse_addargs(options)
  # Add all of the settings as valid options.
  self.each { |name, setting|
    options << setting.optparse_args
  }

  options
end

# File lib/puppet/settings.rb, line 145
def override_default(param, value)
  @value_sets[:overridden_defaults].set(param, value)
  unsafe_flush_cache
end

# File lib/puppet/settings.rb, line 538
def params(section = nil)
  if section
    section = section.intern if section.is_a? String
    @config.find_all { |name, obj|
      obj.section == section
    }.collect { |name, obj|
      name
    }
  else
    @config.keys
  end
end

# File lib/puppet/settings.rb, line 551
def parse_config(text, file = "text")
  begin
    data = @config_file_parser.parse_file(file, text)
  rescue => detail
    Puppet.log_exception(detail, "Could not parse #{file}: #{detail}")
    return
  end

  # If we get here and don't have any data, we just return and don't muck with the current state of the world.
  return if data.nil?

  # If we get here then we have some data, so we need to clear out any
  # previous settings that may have come from config files.
  unsafe_clear(false, false)

  record_deprecations_from_puppet_conf(data)

  # And now we can repopulate with the values from our last parsing of the config files.
  @configuration_file = data

  # Determine our environment, if we have one.
  if @config[:environment]
    env = self.value(:environment).to_sym
  else
    env = "none"
  end

  # Call any hooks we should be calling.
  value_sets = value_sets_for(env, preferred_run_mode)
  @config.values.select(&:has_hook?).each do |setting|
    value_sets.each do |source|
      if source.include?(setting.name)
        # We still have to use value to retrieve the value, since
        # we want the fully interpolated value, not $vardir/lib or whatever.
        # This results in extra work, but so few of the settings
        # will have associated hooks that it ends up being less work this
        # way overall.
        if setting.call_hook_on_initialize?
          @hooks_to_call_on_application_initialization << setting
        else
          setting.handle(ChainedValues.new(
            preferred_run_mode,
            env,
            value_sets,
            @config).interpolate(setting.name))
        end
        break
      end
    end
  end

  call_hooks_deferred_to_application_initialization :ignore_interpolation_dependency_errors => true
  apply_metadata
end

# File lib/puppet/settings.rb, line 1092
def parse_file(file)
  @config_file_parser.parse_file(file, read_file(file))
end

# File lib/puppet/settings.rb, line 726
def persection(section)
  section = section.to_sym
  self.each { |name, obj|
    if obj.section == section
      yield obj
    end
  }
end

# File lib/puppet/settings.rb, line 517
def preferred_run_mode
  @preferred_run_mode_name || :user
end

# File lib/puppet/settings.rb, line 527
def preferred_run_mode=(mode)
  mode = mode.to_s.downcase.intern
  raise ValidationError, "Invalid run mode '#{mode}'" unless [:master, :agent, :user].include?(mode)
  @preferred_run_mode_name = mode
  # Changing the run mode has far-reaching consequences. Flush any cached
  # settings so they will be re-generated.
  flush_cache
  mode
end

# File lib/puppet/settings.rb, line 442
def print_config_options
  env = value(:environment)
  val = value(:configprint)
  if val == "all"
    hash = {}
    each do |name, obj|
      val = value(name,env)
      val = val.inspect if val == ""
      hash[name] = val
    end
    hash.sort { |a,b| a[0].to_s <=> b[0].to_s }.each do |name, val|
      puts "#{name} = #{val}"
    end
  else
    val.split(/\s*,\s*/).sort.each do |v|
      if include?(v)
        #if there is only one value, just print it for back compatibility
        if v == val
          puts value(val,env)
          break
        end
        puts "#{v} = #{value(v,env)}"
      else
        puts "invalid setting: #{v}"
        return false
      end
    end
  end
  true
end

# File lib/puppet/settings.rb, line 483
def print_configs
  return print_config_options if value(:configprint) != ""
  return generate_config if value(:genconfig)
  generate_manifest if value(:genmanifest)
end

# File lib/puppet/settings.rb, line 489
def print_configs?
  (value(:configprint) != "" || value(:genconfig) || value(:genmanifest)) && true
end

# File lib/puppet/settings.rb, line 736
def reparse_config_files
  if files
    if filename = any_files_changed?
      Puppet.notice "Config file #{filename} changed; triggering re-parse of all config files."
      parse_config_files
      reuse
    end
  end
end

# File lib/puppet/settings.rb, line 769
def reuse
  return unless defined?(@used)
  new = @used
  @used = []
  self.use(*new)
end

# File lib/puppet/settings.rb, line 777
def searchpath(environment = nil)
  [:memory, :cli, environment, :run_mode, :main, :application_defaults, :overridden_defaults].compact
end

# File lib/puppet/settings.rb, line 782
def sectionlist
  sectionlist = []
  self.each { |name, obj|
    section = obj.section || "puppet"
    sections[section] ||= []
    sectionlist << section unless sectionlist.include?(section)
    sections[section] << obj
  }

  return sectionlist, sections
end

# File lib/puppet/settings.rb, line 806
def service_group_available?
  return @service_group_available if defined?(@service_group_available)

  if self[:group]
    group = Puppet::Type.type(:group).new :name => self[:group], :audit => :ensure

    @service_group_available = group.exists?
  else
    @service_group_available = false
  end
end

# File lib/puppet/settings.rb, line 794
def service_user_available?
  return @service_user_available if defined?(@service_user_available)

  if self[:user]
    user = Puppet::Type.type(:user).new :name => self[:user], :audit => :ensure

    @service_user_available = user.exists?
  else
    @service_user_available = false
  end
end

# File lib/puppet/settings.rb, line 821
def set_by_cli?(param)
  param = param.to_sym
  !@value_sets[:cli].lookup(param).nil?
end

# File lib/puppet/settings.rb, line 826
def set_value(param, value, type, options = {})
  Puppet.deprecation_warning("Puppet.settings.set_value is deprecated. Use Puppet[]= instead.")
  if @value_sets[type]
    @value_sets[type].set(param, value)
    unsafe_flush_cache
  end
end

# File lib/puppet/settings.rb, line 835
def setdefaults(section, defs)
  Puppet.deprecation_warning("'setdefaults' is deprecated and will be removed; please call 'define_settings' instead")
  define_settings(section, defs)
end

# File lib/puppet/settings.rb, line 109
def setting(name)
  @config[name]
end

# File lib/puppet/settings.rb, line 435
def shortinclude?(short)
  short = short.intern if name.is_a? String
  @shortnames.include?(short)
end

# File lib/puppet/settings.rb, line 908
def to_catalog(*sections)
  sections = nil if sections.empty?

  catalog = Puppet::Resource::Catalog.new("Settings", Puppet::Node::Environment::NONE)
  @config.keys.find_all { |key| @config[key].is_a?(FileSetting) }.each do |key|
    next if (key == :manifestdir && should_skip_manifestdir?())
    file = @config[key]
    next unless (sections.nil? or sections.include?(file.section))
    next unless resource = file.to_resource
    next if catalog.resource(resource.ref)

    Puppet.debug("Using settings: adding file resource '#{key}': '#{resource.inspect}'")

    catalog.add_resource(resource)
  end

  add_user_resources(catalog, sections)
  add_environment_resources(catalog, sections)

  catalog
end

# File lib/puppet/settings.rb, line 938
  def to_config
    str = %Q{The configuration file for #{Puppet.run_mode.name}.  Note that this file
is likely to have unused settings in it; any setting that's
valid anywhere in Puppet can be in any config file, even if it's not used.

Every section can specify three special parameters: owner, group, and mode.
These parameters affect the required permissions of any files specified after
their specification.  Puppet will sometimes use these parameters to check its
own configured state, so they can be used to make Puppet a bit more self-managing.

The file format supports octothorpe-commented lines, but not partial-line comments.

Generated on #{Time.now}.

}.gsub(/^/, "# ")

#         Add a section heading that matches our name.
    str += "[#{preferred_run_mode}]\n"
    eachsection do |section|
      persection(section) do |obj|
        str += obj.to_config + "\n" unless obj.name == :genconfig
      end
    end

    return str
  end

# File lib/puppet/settings.rb, line 966
def to_manifest
  catalog = to_catalog
  catalog.resource_refs.collect do |ref|
    catalog.resource(ref).to_manifest
  end.join("\n\n")
end

# File lib/puppet/settings.rb, line 1011
def uninterpolated_value(param, environment = nil)
  Puppet.deprecation_warning("Puppet.settings.uninterpolated_value is deprecated. Use Puppet.settings.value instead")
  param = param.to_sym
  environment &&= environment.to_sym

  values(environment, self.preferred_run_mode).lookup(param)
end

# File lib/puppet/settings.rb, line 975
def use(*sections)
  sections = sections.collect { |s| s.to_sym }
  sections = sections.reject { |s| @used.include?(s) }

  return if sections.empty?

  begin
    catalog = to_catalog(*sections).to_ral
  rescue => detail
    Puppet.log_and_raise(detail, "Could not create resources for managing Puppet's files and directories in sections #{sections.inspect}: #{detail}")
  end

  catalog.host_config = false
  catalog.apply do |transaction|
    if transaction.any_failed?
      report = transaction.report
      status_failures = report.resource_statuses.values.select { |r| r.failed? }
      status_fail_msg = status_failures.
        collect(&:events).
        flatten.
        select { |event| event.status == 'failure' }.
        collect { |event| "#{event.resource}: #{event.message}" }.join("; ")

      raise "Got #{status_failures.length} failure(s) while initializing: #{status_fail_msg}"
    end
  end

  sections.each { |s| @used << s }
  @used.uniq!
end

# File lib/puppet/settings.rb, line 1006
def valid?(param)
  param = param.to_sym
  @config.has_key?(param)
end

# File lib/puppet/settings.rb, line 1043
def value(param, environment = nil, bypass_interpolation = false)
  param = param.to_sym
  environment &&= environment.to_sym

  setting = @config[param]

  # Short circuit to nil for undefined settings.
  return nil if setting.nil?

  # Check the cache first.  It needs to be a per-environment
  # cache so that we don't spread values from one env
  # to another.
  if @cache[environment||"none"].has_key?(param)
    return @cache[environment||"none"][param]
  elsif bypass_interpolation
    val = values(environment, self.preferred_run_mode).lookup(param)
  else
    val = values(environment, self.preferred_run_mode).interpolate(param)
  end

  @cache[environment||"none"][param] = val
  val
end

# File lib/puppet/settings.rb, line 1026
def values(environment, section)
  @values[environment][section] ||= ChainedValues.new(
    section,
    environment,
    value_sets_for(environment, section),
    @config)
end

# File lib/puppet/settings.rb, line 1080
def which_configuration_file
  if explicit_config_file? or Puppet.features.root? then
    return main_config_file
  else
    return user_config_file
  end
end

# File lib/puppet/settings.rb, line 42
def self.app_defaults_for_run_mode(run_mode)
  {
      :name     => run_mode.to_s,
      :run_mode => run_mode.name,
      :confdir  => run_mode.conf_dir,
      :vardir   => run_mode.var_dir,
      :rundir   => run_mode.run_dir,
      :logdir   => run_mode.log_dir,
  }
end

# File lib/puppet/settings.rb, line 317
def self.clean_opt(opt, val)
  # rewrite --[no-]option to --no-option if that's what was given
  if opt =~ /\[no-\]/ and !val
    opt = opt.gsub(/\[no-\]/,'no-')
  end
  # otherwise remove the [no-] prefix to not confuse everybody
  opt = opt.gsub(/\[no-\]/, '')
  [opt, val]
end

# File lib/puppet/settings.rb, line 53
def self.default_certname()
  hostname = hostname_fact
  domain = domain_fact
  if domain and domain != ""
    fqdn = [hostname, domain].join(".")
  else
    fqdn = hostname
  end
  fqdn.to_s.gsub(/\.$/, '')
end

# File lib/puppet/settings.rb, line 72
def self.default_config_file_name
  "puppet.conf"
end

# File lib/puppet/settings.rb, line 68
def self.domain_fact()
  Facter["domain"].value
end

# File lib/puppet/settings.rb, line 64
def self.hostname_fact()
  Facter["hostname"].value
end

# File lib/puppet/settings.rb, line 77
def initialize
  @config = {}
  @shortnames = {}

  @created = []

  # Keep track of set values.
  @value_sets = {
    :cli => Values.new(:cli, @config),
    :memory => Values.new(:memory, @config),
    :application_defaults => Values.new(:application_defaults, @config),
    :overridden_defaults => Values.new(:overridden_defaults, @config),
  }
  @configuration_file = nil

  # And keep a per-environment cache
  @cache = Hash.new { |hash, key| hash[key] = {} }
  @values = Hash.new { |hash, key| hash[key] = {} }

  # The list of sections we've used.
  @used = []

  @hooks_to_call_on_application_initialization = []
  @deprecated_setting_names = []
  @deprecated_settings_that_have_been_configured = []

  @translate = Puppet::Settings::ValueTranslator.new
  @config_file_parser = Puppet::Settings::ConfigFile.new(@translate)
end