# A service, such as an ssh server or web server, running on a {#host}.
class Mdm::Service < ActiveRecord::Base
  #
  # CONSTANTS
  #

  # Valid values for {#state}.
  STATES = ['open', 'closed', 'filtered', 'unknown']

  #
  # Associations
  #

  # @!attribute [rw] task_services
  #   Details about what Tasks touched this service
  #
  #   @return [Array<Mdm::TaskService>]
  has_many :task_services, :dependent => :destroy, :class_name => 'Mdm::TaskService'

  # @!attribute [rw] tasks
  #   Tasks that touched this service
  #
  #   @return [Array<Mdm::Task>]
  has_many :tasks, :through => :task_services, :class_name => 'Mdm::Task'

  # @!attribute [rw] creds
  #   Credentials gathered from this service.
  #
  #   @return [Array<Mdm::Cred>]
  has_many :creds, :dependent => :destroy, :class_name => 'Mdm::Cred'

  # @!attribute [rw] exploited_hosts
  #   @todo https://www.pivotaltracker.com/story/show/48993731
  #   @return [Array<Mdm::ExploitHost>]
  has_many :exploited_hosts, :dependent => :destroy, :class_name => 'Mdm::ExploitedHost'

  # @!attribute [rw] host
  #   The host on which this service runs.
  #
  #   @return [Mdm::Host]
  belongs_to :host, :class_name => 'Mdm::Host', :counter_cache => :service_count

  # @!attribute [rw] notes
  #   Notes about this service.
  #
  #   @return [Array<Mdm::Note>]
  has_many :notes, :dependent => :destroy, :class_name => 'Mdm::Note'

  # @!attribute [rw] vulns
  #   Vulnerabilities found in this service.
  #
  #   @return [Array<Mdm::Vuln>]
  has_many :vulns, :dependent => :destroy, :class_name => 'Mdm::Vuln'

  # @!attribute [rw] web_sites
  #   Web sites running on top of this service.
  #
  #   @return [Array<Mdm::WebSite>]
  has_many :web_sites, :dependent => :destroy, :class_name => 'Mdm::WebSite'

  #
  # Through :web_sites
  #

  # @!attribute [r] web_pages
  #   Web pages in the {#web_sites} on top of this service.
  #
  #   @return [Array<Mdm::WebPages>]
  has_many :web_pages, :through => :web_sites, :class_name => 'Mdm::WebPage'

  # @!attribute [r] web_forms
  #   Form in the {#web_sites} on top of this service.
  #
  #   @return [Array<Mdm::WebForm>]
  has_many :web_forms, :through => :web_sites, :class_name => 'Mdm::WebForm'

  # @!attribute [r] web_vulns
  #   Vulnerabilities found in the {#web_sites} on top of this service.
  #
  #   @return [Array<Mdm::WebVuln>]
  has_many :web_vulns, :through => :web_sites, :class_name => 'Mdm::WebVuln'

  #
  # Attributes
  #

  # @!attribute [rw] info
  #   Additional information about the service that does not fit in the {#name} or {#proto}.
  #
  #   @return [String]

  # @!attribute [rw] port
  #   The port on which this service runs on the {#host}.
  #
  #   @return [Integer]

  # @!attribute [rw] name
  #    The name of the service.
  #
  #    @return [String]

  # @!attribute [rw] proto
  #   The protocol used by this service
  #
  #   @return [String]

  # @!attribute [rw] state
  #   Whether this service is opened, closed, filtered, or in an unknown state.
  #
  #   @return [String] element of {STATES}.

  #
  # Callbacks
  #

  after_save :normalize_host_os

  #
  # Scopes
  #

  scope :inactive, where("services.state != 'open'")
  scope :with_state, lambda { |a_state|  where("services.state = ?", a_state)}
  scope :search, lambda { |*args|
    where([
              "services.name ILIKE ? OR " +
                  "services.info ILIKE ? OR " +
                  "services.proto ILIKE ? OR " +
                  "services.port = ? ",
              "%#{args[0]}%", "%#{args[0]}%", "%#{args[0]}%", (args[0].to_i > 0) ? args[0].to_i : 99999
          ])
  }

  #
  # Validations
  #
  validates :port,
            numericality: {
                only_integer: true
            }
  validates :proto, presence: true

  # {Mdm::Host::OperatingSystemNormalization#normalize_os Normalizes the host operating system} whenever {#info} has
  # changed.
  #
  # @return [void]
  def normalize_host_os
    if info_changed?
      host.normalize_os
    end
  end

  ActiveSupport.run_load_hooks(:mdm_service, self)
end