postmodern/ruby-nmap

# frozen_string_literal: true

require_relative 'os_class'
require_relative 'os_match'

module Nmap
  class XML
    #
    # Wraps the `os` XML element.
    #
    # @since 1.0.0
    #
    class OS

      include Enumerable

      #
      # Creates a new OS object.
      #
      # @param [Nokogiri::XML::Node] node
      #   The node that contains the OS guessing information.
      #
      def initialize(node)
        @node = node
      end

      #
      # Parses the OS class information.
      #
      # @yield [class]
      #   Passes each OS class to the given block.
      #
      # @yieldparam [OSClass] class
      #   The OS class information.
      #
      # @return [OS, Enumerator]
      #   The OS information. If no block was given, an enumerator object
      #   will be returned.
      #
      def each_class
        return enum_for(__method__) unless block_given?

        @node.xpath("osmatch/osclass").each do |osclass|
          yield OSClass.new(osclass)
        end

        return self
      end

      #
      # Parses the OS class information.
      #
      # @return [Array<OSClass>]
      #   The OS class information.
      #
      def classes
        each_class.to_a
      end

      #
      # Parses the OS match information.
      #
      # @yield [match]
      #   Passes each OS match to the given block.
      #
      # @yieldparam [OSMatch] class
      #   The OS match information.
      #
      # @return [OS, Enumerator]
      #   The OS information. If no block was given, an enumerator object
      #   will be returned.
      #
      def each_match
        return enum_for(__method__) unless block_given?

        @node.xpath("osmatch").each do |osclass|
          os_match = OSMatch.new(
            osclass['name'],
            osclass['accuracy'].to_i
          )

          yield os_match
        end

        return self
      end

      #
      # Parses the OS match information.
      #
      # @return [Array<OSMatch>]
      #   The OS match information.
      #
      def matches
        each_match.to_a
      end

      #
      # Parses the ports used for guessing the OS.
      #
      # @return [Array<Integer>]
      #   The ports used.
      #
      def ports_used
        @ports_used ||= @node.xpath("portused/@portid").map do |port|
          port.inner_text.to_i
        end
      end

      #
      # Parses the OS fingerprint used by Nmap.
      #
      # @return [String]
      #   The OS fingerprint.
      #
      def fingerprint
        @fingerprint ||= if (fingerprint = @node.at_xpath("osfingerprint/@fingerprint"))
                           fingerprint.inner_text
                         end
      end

      #
      # Parses the OS match information.
      #
      # @see #each_match
      #
      def each(&block)
        each_match(&block)
      end

    end
  end
end