# frozen_string_literal: true
#
# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
#
# Copyright (c) 2022-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# ronin-db-activerecord is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ronin-db-activerecord is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/db/model'

require 'active_record'
require 'resolv'

module Ronin
  module DB
    #
    # Represents a DNS query.
    #
    # @since 0.2.0
    #
    class DNSQuery < ActiveRecord::Base

      include Model

      # @!attribute [rw] id
      #   The primary ID for the DNS query.
      #
      #   @return [Integer]
      attribute :id, :integer

      # @!attribute [rw] type
      #   The queried record type.
      #
      #   @return [String]
      enum type: {
        a:     'A',
        aaaa:  'AAAA',
        any:   'ANY',
        cname: 'CNAME',
        hinfo: 'HINFO',
        loc:   'LOC',
        mx:    'MX',
        ns:    'NS',
        ptr:   'PTR',
        soa:   'SOA',
        srv:   'SRV',
        txt:   'TXT',
        wks:   'WKS'
      }, _suffix: :query
      validates :type, presence: true

      # @!attribute [rw] label
      #   The queried domain label.
      #
      #   @return [String]
      attribute :label, :string
      validates :label, presence: true

      # @!attribute [rw] source_addr
      #   The source IP Address.
      #
      #   @return [String]
      attribute :source_addr, :string
      validates :source_addr, length: { maximum: 39 },
                              format: {
                                with: /#{Resolv::IPv4::Regex}|#{Resolv::IPv6::Regex}/,
                                message: 'Must be a valid IP address'
                              }

      # @!attribute [rw] created_at
      #   When the DNS query request was created.
      #
      #   @return [Time]
      attribute :created_at, :datetime

      # @!attribute [rw] records
      #   The optional DNS records associated with the DNS query.
      #
      #   @return [Array<DNSRecord>]
      has_many :records, class_name: 'DNSRecord'

    end
  end
end

require 'ronin/db/dns_record'