path: root/lib/puppet/type/dns_zone2.rb

require 'puppet/type/file'

Puppet::Type.newtype(:dns_zone2, self_refresh: true) do
  @doc = <<~EOF
  A complete DNS zonefile.

  The SOA record comes backed in, this for two reasons:
  1. A SOA record is REQUIRED in all zonefiles, so it doesn't make
     sense to allow it to be emitted.
  2. This is the only way to ensure that our serial is only updated
     when something else has actually changed in the zone.
  EOF

  ensurable

  def refresh
    catalog.resource("File[#{self[:directory]}/#{self[:name]}db]")[:content] = should_content(1)
  end

  # List of all DNS records (at all)
  #
  # Should ideally be limited to records in this zone here instead of
  # further down.
  def records
    catalog.resources.filter do |r|
      r.is_a?(Puppet::Type.type(:dns_record2))
    end
  end

  def create
    print("Create called\n")
  end

  # Create the file resource for us.
  # We also propagate some parameters and metaparameters to the
  # underlying file here
  def generate
    params = {
      ensure: self[:ensure],
      path: provider.filename,
      # notify: self[:notify],
      validate_cmd: "#{self[:named_checkzone]} #{self[:origin]} %"
    }

    [:owner,
     :group,
     :backup,
     :selinux_ignore_defaults,
     :selrange,
     :selrole,
     :seltype,
     :seluser,
     :show_diff].each do |param|
      params[param] = self[param] unless self[param].nil?
    end

    excluded_metaparams = [:before, :notify, :require, :subscribe, :tag]

    Puppet::Type.metaparams.each do |metaparam|
      unless self[metaparam].nil? || excluded_metaparams.include?(metaparam)
        params[metaparam] = self[metaparam]
      end
    end

    [Puppet::Type.type(:file).new(params)]
  end

  newparam(:named_checkzone) do
    desc <<-EOF
    Absolute path to the named-checkzone binary.
    EOF

    defaultto '/usr/bin/named-checkzone'
  end

  newparam(:named_checkconf) do
    desc <<-EOF
    Absolute pathto the named-checkconf binary
    EOF
    defaultto '/usr/bin/named-checkconf'
  end

  newparam(:rndc) do
    desc <<-EOF
    Absolute path to the rndc binary
    EOF
    defaultto '/usr/bin/rndc'
  end

  # Returning "our" file resource causes errors on the file to
  # propagate out from us (which is NEEDED for `validate_cmd` to
  # work).
  #
  # This always sets the content, but is run is *before* refresh
  # eventns. This means that this works for creation events, but not
  # refresh events. For refresh events we simply generate the content
  # a second time, overriding this instance.
  #
  # Ideally we wouldn't generate content here, but instead in
  # `create`. But that method isn't called
  def eval_generate
    catalog.resource("File[#{self[:directory]}/#{self[:name]}db]")[:content] = should_content(0)
    [catalog.resource("File[#{provider.filename}]")]
  end

  def should_content(serial_change)
    provider.zone_content(records, serial_change)
  end

  newparam(:origin, namevar: true) do
    desc <<-EOF
    Origin parameter of the source.
    Should almost always be the same as the name of the zone.
    EOF
    munge do |value|
      if value[-1] == '.'
        value
      else
        "#{value}."
      end
    end
  end

  newparam(:cls) do
    desc <<-EOF
    DNS class of the zone.
    EOF
    defaultto :IN
  end

  newparam(:view) do
    desc <<-EOF
    Named view this zone belongs to.
    TODO: support views
    EOF
    defaultto '_default'
  end

  newparam(:type) do
    desc <<-EOF
    The type of the zone.
    TODO: support types
    Currently only master is tested.
    EOF

    newvalues(:master, :slave,
              :mirror, :hint, :stub, :static_stub, :forward, :redirect)
    aliasvalue :primary, :master
    aliasvalue :secondary, :slave
    defaultto :master
  end

  newparam(:default_ttl) do
    desc <<-EOF
    TTL for all records in zone without an explicit TTL set.
    EOF
    defaultto '300'
  end

  newparam(:mname) do
    desc <<-EOF
    Domain name of zone master.

    Part of the SOA record.
    EOF
    munge do |value|
      if value[-1] == '.'
        value
      else
        "#{value}."
      end
    end
  end

  newparam(:rname) do
    desc <<-EOF
    Email to the zone admin, but with the '@' replaced with a period ('.')

    Part of the SOA record.
    EOF
    munge do |value|
      if value[-1] == '.'
        value
      else
        "#{value}."
      end
    end
  end

  newparam(:soa_ttl) do
    desc <<-EOF
    TTL of the SOA record.
    EOF
  end

  newparam(:refresh) do
    desc <<-EOF
    Refresh value in the SOA record.
    EOF
  end

  newparam(:retry) do
    desc <<-EOF
    Retry value in the SOA record.
    EOF
  end

  newparam(:expire) do
    desc <<-EOF
    Expire value in the SOA record.
    EOF
  end

  newparam(:negative_ttl) do
    desc <<-EOF
    Negative TTL value in the SOA value.

    This file is sometimes call Minimum TTL due to historical reasons.
    EOF
  end

  newparam(:owner, parent: Puppet::Type::File::Owner) do
    desc <<-EOF
    Owner of the zonefile.
    EOF
  end

  newparam(:group, parent: Puppet::Type::File::Group) do
    desc <<-EOF
    Group of the zonefile.
    EOF
  end

  newparam(:backup) do
    desc <<-EOF
    Should the pre-existing file be backed up.

    See the file resource's documentation for details.
    EOF

    validate do |value|
      unless [TrueClass, FalseClass, String].include?(value.class)
        raise ArgumentError, _('Backup must be a Boolean or String')
      end
    end
  end

  newparam(:selinux_ignore_defaults, boolean: true, parent: Puppet::Parameter::Boolean) do
    desc <<-EOF
    See the file resource's documentation for details.
    EOF
  end

  newparam(:selrange) do
    desc <<-EOF
    See the file resource's documentation for details.
    EOF

    validate do |value|
      unless value.is_a?(String)
        raise ArgumentError, _('Selrange must be a String')
      end
    end
  end

  newparam(:selrole) do
    desc <<-EOF
    See the file resource's documentation for details.
    EOF

    validate do |value|
      unless value.is_a?(String)
        raise ArgumentError, _('Selrole must be a String')
      end
    end
  end

  newparam(:seltype) do
    desc <<-EOF
    See the file resource's documentation for details.
    EOF

    validate do |value|
      unless value.is_a?(String)
        raise ArgumentError, _('Seltype must be a String')
      end
    end
  end

  newparam(:seluser) do
    desc <<-EOF
    See the file resource's documentation for details.
    EOF

    validate do |value|
      unless value.is_a?(String)
        raise ArgumentError, _('Seluser must be a String')
      end
    end
  end

  newparam(:show_diff, boolean: true, parent: Puppet::Parameter::Boolean) do
    desc <<-EOF
    See the file resource's documentation for details.
    EOF
  end

  newparam(:directory) do
    desc <<-EOF
    Directory in which zone files will be stored.
    EOF

    defaultto '/var/named/zones'
  end

  autorequire(:file) { || [value(:directory)] }
  autorequire(:file) { || [provider.filename] }
end