postal/app/models/route.rb

# == Schema Information
#
# Table name: routes
#
#  id            :integer          not null, primary key
#  uuid          :string(255)
#  server_id     :integer
#  domain_id     :integer
#  endpoint_id   :integer
#  endpoint_type :string(255)
#  name          :string(255)
#  spam_mode     :string(255)
#  created_at    :datetime
#  updated_at    :datetime
#  token         :string(255)
#  mode          :string(255)
#
# Indexes
#
#  index_routes_on_token  (token)
#

class Route < ApplicationRecord

  MODES = ['Endpoint', 'Accept', 'Hold', 'Bounce', 'Reject']

  include HasUUID

  belongs_to :server
  belongs_to :domain, :optional => true
  belongs_to :endpoint, :polymorphic => true, :optional => true
  has_many :additional_route_endpoints, :dependent => :destroy

  SPAM_MODES = ['Mark', 'Quarantine', 'Fail']
  ENDPOINT_TYPES = ['SMTPEndpoint', 'HTTPEndpoint', 'AddressEndpoint']

  validates :name, :presence => true, :format => /\A(([a-z0-9\-\.]*)|(\*)|(__returnpath__))\z/
  validates :spam_mode, :inclusion => {:in => SPAM_MODES}
  validates :endpoint, :presence => {:if => proc { self.mode == 'Endpoint' }}
  validates :domain_id, :presence => {:unless => :return_path?}
  validate :validate_route_is_routed
  validate :validate_domain_belongs_to_server
  validate :validate_endpoint_belongs_to_server
  validate :validate_name_uniqueness
  validate :validate_return_path_route_endpoints
  validate :validate_no_additional_routes_on_non_endpoint_route

  after_save :save_additional_route_endpoints

  random_string :token, :type => :chars, :length => 8, :unique => true

  def return_path?
    name == "__returnpath__"
  end

  def description
    if return_path?
      "Return Path"
    else
      "#{name}@#{domain.name}"
    end
  end

  def _endpoint
    @endpoint ||= begin
      if self.mode == 'Endpoint'
        endpoint ? "#{endpoint.class}##{endpoint.uuid}" : nil
      else
        self.mode
      end
    end
  end

  def _endpoint=(value)
    if value.blank?
      self.endpoint = nil
      self.mode = nil
    else
      if value =~ /\#/
        class_name, id = value.split('#', 2)
        unless ENDPOINT_TYPES.include?(class_name)
          raise Postal::Error, "Invalid endpoint class name '#{class_name}'"
        end
        self.endpoint = class_name.constantize.find_by_uuid(id)
        self.mode = 'Endpoint'
      else
        self.endpoint = nil
        self.mode = value
      end
    end
  end

  def forward_address
    @forward_address ||= "#{token}@#{Postal.config.dns.route_domain}"
  end

  def wildcard?
    self.name == '*'
  end

  def additional_route_endpoints_array
    @additional_route_endpoints_array ||= additional_route_endpoints.map(&:_endpoint)
  end

  def additional_route_endpoints_array=(array)
    @additional_route_endpoints_array = array.reject(&:blank?)
  end

  def save_additional_route_endpoints
    if @additional_route_endpoints_array
      seen = []
      @additional_route_endpoints_array.each do |item|
        if existing = additional_route_endpoints.find_by_endpoint(item)
          seen << existing.id
        else
          route = additional_route_endpoints.build(:_endpoint => item)
          if route.save
            seen << route.id
          else
            route.errors.each do |field, message|
              errors.add :base, message
            end
            raise ActiveRecord::RecordInvalid
          end
        end
      end
      additional_route_endpoints.where.not(:id => seen).destroy_all
    end
  end

  #
  # This message will create a suitable number of message objects for messages that
  # are destined for this route. It receives a block which can set the message content
  # but most information is specified already.
  #
  # Returns an array of created messages.
  #
  def create_messages(&block)
    messages = []
    message = self.build_message
    if self.mode == 'Endpoint' && self.server.message_db.schema_version >= 18
      message.endpoint_type = self.endpoint_type
      message.endpoint_id = self.endpoint_id
    end
    block.call(message)
    message.save
    messages << message

    # Also create any messages for additional endpoints that might exist
    if self.mode == 'Endpoint' && self.server.message_db.schema_version >= 18
      self.additional_route_endpoints.each do |endpoint|
        next unless endpoint.endpoint
        message = self.build_message
        message.endpoint_id = endpoint.endpoint_id
        message.endpoint_type = endpoint.endpoint_type
        block.call(message)
        message.save
        messages << message
      end
    end

    messages
  end

  def build_message
    message = self.server.message_db.new_message
    message.scope = 'incoming'
    message.rcpt_to = self.description
    message.domain_id = self.domain&.id
    message.route_id = self.id
    message
  end

  private

  def validate_route_is_routed
    if self.mode.nil?
      errors.add :endpoint, "must be chosen"
    end
  end

  def validate_domain_belongs_to_server
    if self.domain && ![self.server, self.server.organization].include?(self.domain.owner)
      errors.add :domain, :invalid
    end

    if self.domain && !self.domain.verified?
      errors.add :domain, "has not been verified yet"
    end
  end

  def validate_endpoint_belongs_to_server
    if self.endpoint && self.endpoint&.server != self.server
      errors.add :endpoint, :invalid
    end
  end

  def validate_name_uniqueness
    return if self.server.nil?
    if self.domain
      if route = Route.includes(:domain).where(:domains => {:name => self.domain.name}, :name => self.name).where.not(:id => self.id).first
        errors.add :name, "is configured on the #{route.server.full_permalink} mail server"
      end
    else
      if route = Route.where(:name => "__returnpath__").where.not(:id => self.id).exists?
        errors.add :base, "A return path route already exists for this server"
      end
    end
  end

  def validate_return_path_route_endpoints
    if return_path?
      if self.mode != 'Endpoint' || self.endpoint_type != 'HTTPEndpoint'
        errors.add :base, "Return path routes must point to an HTTP endpoint"
      end
    end
  end

  def validate_no_additional_routes_on_non_endpoint_route
    if self.mode != 'Endpoint' && !self.additional_route_endpoints_array.empty?
      errors.add :base, "Additional routes are not permitted unless the primary route is an actual endpoint"
    end
  end

  def self.find_by_name_and_domain(name, domain)
    route = Route.includes(:domain).where(:name => name, :domains => {:name => domain}).first
    if route.nil?
      route = Route.includes(:domain).where(:name => '*', :domains => {:name => domain}).first
    end
    route
  end

end