email_address 0.1.2 → 0.2.4

data/lib/email_address/host.rb

@@ -1,6 +1,5 @@
-require 'simpleidn'
-require 'resolv'
-require 'netaddr'
+require "simpleidn"
+require "resolv"
 
 module EmailAddress
   ##############################################################################
@@ -32,16 +31,16 @@ module EmailAddress
   class Host
     attr_reader :host_name
     attr_accessor :dns_name, :domain_name, :registration_name,
-                  :tld, :tld2, :subdomains, :ip_address, :config, :provider,
-                  :comment
+      :tld, :tld2, :subdomains, :ip_address, :config, :provider,
+      :comment, :error_message, :reason, :locale
     MAX_HOST_LENGTH = 255
 
     # Sometimes, you just need a Regexp...
-    DNS_HOST_REGEX  = / [\p{L}\p{N}]+ (?: (?: \-{1,2} | \.) [\p{L}\p{N}]+ )*/x
+    DNS_HOST_REGEX = / [\p{L}\p{N}]+ (?: (?: -{1,2} | \.) [\p{L}\p{N}]+ )*/x
 
     # The IPv4 and IPv6 were lifted from Resolv::IPv?::Regex and tweaked to not
     # \A...\z anchor at the edges.
-    IPv6_HOST_REGEX = /\[IPv6:
+    IPV6_HOST_REGEX = /\[IPv6:
       (?: (?:(?x-mi:
       (?:[0-9A-Fa-f]{1,4}:){7}
          [0-9A-Fa-f]{1,4}
@@ -60,7 +59,7 @@ module EmailAddress
       (?: \d+)\.(?: \d+)\.(?: \d+)\.(?: \d+)
       )))\]/ix
 
-    IPv4_HOST_REGEX = /\[((?x-mi:0
+    IPV4_HOST_REGEX = /\[((?x-mi:0
                |1(?:[0-9][0-9]?)?
                |2(?:[0-4][0-9]?|5[0-5]?|[6-9])?
                |[3-9][0-9]?))\.((?x-mi:0
@@ -79,49 +78,50 @@ module EmailAddress
 
     # Matches Host forms: DNS name, IPv4, or IPv6 formats
     STANDARD_HOST_REGEX = /\A (?: #{DNS_HOST_REGEX}
-                              | #{IPv4_HOST_REGEX} | #{IPv6_HOST_REGEX}) \z/ix
+                              | #{IPV4_HOST_REGEX} | #{IPV6_HOST_REGEX}) \z/ix
 
     # host name -
     #   * host type - :email for an email host, :mx for exchanger host
-    def initialize(host_name, config={})
-      @original            = host_name ||= ''
+    def initialize(host_name, config = {}, locale = "en")
+      @original = host_name ||= ""
+      @locale = locale
       config[:host_type] ||= :email
-      @config              = config
+      @config = config.is_a?(Hash) ? Config.new(config) : config
+      @error = @error_message = nil
       parse(host_name)
     end
 
     # Returns the String representation of the host name (or IP)
     def name
-      if self.ipv4?
-        "[#{self.ip_address}]"
-      elsif self.ipv6?
-        "[IPv6:#{self.ip_address}]"
+      if ipv4?
+        "[#{ip_address}]"
+      elsif ipv6?
+        "[IPv6:#{ip_address}]"
       elsif @config[:host_encoding] && @config[:host_encoding] == :unicode
-        ::SimpleIDN.to_unicode(self.host_name)
+        ::SimpleIDN.to_unicode(host_name)
       else
-        self.dns_name
+        dns_name
       end
     end
-    alias :to_s :name
+    alias_method :to_s, :name
 
     # The canonical host name is the simplified, DNS host name
     def canonical
-      self.dns_name
+      dns_name
     end
 
     # Returns the munged version of the name, replacing everything after the
     # initial two characters with "*****" or the configured "munge_string".
     def munge
-      self.host_name.sub(/\A(.{1,2}).*/) { |m| $1 + @config[:munge_string] }
+      host_name.sub(/\A(.{1,2}).*/) { |m| $1 + @config[:munge_string] }
     end
 
     ############################################################################
     # Parsing
     ############################################################################
 
-
     def parse(host) # :nodoc:
-      host = self.parse_comment(host)
+      host = parse_comment(host)
 
       if host =~ /\A\[IPv6:(.+)\]/i
         self.ip_address = $1
@@ -143,62 +143,96 @@ module EmailAddress
     end
 
     def host_name=(name)
-      @host_name = name = name.strip.downcase.gsub(' ', '').gsub(/\(.*\)/, '')
-      @dns_name  = ::SimpleIDN.to_ascii(self.host_name)
+      name = fully_qualified_domain_name(name.downcase)
+      @host_name = name
+      if @config[:host_remove_spaces]
+        @host_name = @host_name.delete(" ")
+      end
+      @dns_name = if /[^[:ascii:]]/.match?(host_name)
+        ::SimpleIDN.to_ascii(host_name)
+      else
+        host_name
+      end
 
       # Subdomain only (root@localhost)
-      if name.index('.').nil?
+      if name.index(".").nil?
         self.subdomains = name
 
       # Split sub.domain from .tld: *.com, *.xx.cc, *.cc
       elsif name =~ /\A(.+)\.(\w{3,10})\z/ ||
-            name =~ /\A(.+)\.(\w{1,3}\.\w\w)\z/ ||
-            name =~ /\A(.+)\.(\w\w)\z/
+          name =~ /\A(.+)\.(\w{1,3}\.\w\w)\z/ ||
+          name =~ /\A(.+)\.(\w\w)\z/
 
         sub_and_domain, self.tld2 = [$1, $2] # sub+domain, com || co.uk
-        self.tld = self.tld2.sub(/\A.+\./, '') # co.uk => uk
+        self.tld = tld2.sub(/\A.+\./, "") # co.uk => uk
         if sub_and_domain =~ /\A(.+)\.(.+)\z/ # is subdomain? sub.example [.tld2]
-          self.subdomains        = $1
+          self.subdomains = $1
           self.registration_name = $2
         else
           self.registration_name = sub_and_domain
-          #self.domain_name = sub_and_domain + '.' + self.tld2
+          # self.domain_name = sub_and_domain + '.' + self.tld2
         end
-        self.domain_name = self.registration_name + '.' + self.tld2
-        self.find_provider
+        self.domain_name = registration_name + "." + tld2
+        find_provider
+      else # Bad format
+        self.subdomains = self.tld = self.tld2 = ""
+        self.domain_name = self.registration_name = name
       end
     end
 
-    def find_provider # :nodoc:
-      return self.provider if self.provider
-
-      EmailAddress::Config.providers.each do |provider, config|
-        if config[:host_match] && self.matches?(config[:host_match])
-          return self.set_provider(provider, config)
+    def fully_qualified_domain_name(host_part)
+      dn = @config[:address_fqdn_domain]
+      if !dn
+        if (host_part.nil? || host_part <= " ") && @config[:host_local] && @config[:host_auto_append]
+          "localhost"
+        else
+          host_part
         end
+      elsif host_part.nil? || host_part <= " "
+        dn
+      elsif !host_part.include?(".")
+        host_part + "." + dn
+      else
+        host_part
       end
+    end
+
+    # True if host is hosted at the provider, not a public provider host name
+    def hosted_service?
+      return false unless registration_name
+      find_provider
+      return false unless config[:host_match]
+      !matches?(config[:host_match])
+    end
 
-      return self.set_provider(:default) unless self.dns_enabled?
+    def find_provider # :nodoc:
+      return provider if provider
 
-      provider = self.exchangers.provider
-      if provider != :default
-        self.set_provider(provider,
-          EmailAddress::Config.provider(provider))
+      Config.providers.each do |provider, config|
+        if config[:host_match] && matches?(config[:host_match])
+          return set_provider(provider, config)
+        end
       end
 
-      self.provider ||= self.set_provider(:default)
+      return set_provider(:default) unless dns_enabled?
+
+      self.provider ||= set_provider(:default)
     end
 
-    def set_provider(name, provider_config={}) # :nodoc:
-      self.config = EmailAddress::Config.all_settings(provider_config, @config)
-      self.provider = name
+    def set_provider(name, provider_config = {}) # :nodoc:
+      config.configure(provider_config)
+      @provider = name
     end
 
     # Returns a hash of the parts of the host name after parsing.
     def parts
-      { host_name:self.host_name, dns_name:self.dns_name, subdomain:self.subdomains,
-        registration_name:self.registration_name, domain_name:self.domain_name,
-        tld2:self.tld2, tld:self.tld, ip_address:self.ip_address }
+      {host_name: host_name, dns_name: dns_name, subdomain: subdomains,
+       registration_name: registration_name, domain_name: domain_name,
+       tld2: tld2, tld: tld, ip_address: ip_address}
+    end
+
+    def hosted_provider
+      Exchanger.cached(dns_name).provider
     end
 
     ############################################################################
@@ -207,19 +241,19 @@ module EmailAddress
 
     # Is this a fully-qualified domain name?
     def fqdn?
-      self.tld ? true : false
+      tld ? true : false
     end
 
     def ip?
-      self.ip_address.nil? ? false : true
+      !!ip_address
     end
 
     def ipv4?
-      self.ip? && self.ip_address.include?(".")
+      ip? && ip_address.include?(".")
     end
 
     def ipv6?
-      self.ip? && self.ip_address.include?(":")
+      ip? && ip_address.include?(":")
     end
 
     ############################################################################
@@ -237,25 +271,25 @@ module EmailAddress
       rules = Array(rules)
       return false if rules.empty?
       rules.each do |rule|
-        return rule if rule == self.domain_name || rule == self.dns_name
+        return rule if rule == domain_name || rule == dns_name
         return rule if registration_name_matches?(rule)
         return rule if tld_matches?(rule)
         return rule if domain_matches?(rule)
         return rule if self.provider && provider_matches?(rule)
-        return rule if self.ip_matches?(rule)
+        return rule if ip_matches?(rule)
       end
       false
     end
 
     # Does "example." match any tld?
     def registration_name_matches?(rule)
-      self.registration_name + '.' == rule ? true : false
+      rule == "#{registration_name}."
     end
 
     # Does "sub.example.com" match ".com" and ".example.com" top level names?
     # Matches TLD (uk) or TLD2 (co.uk)
     def tld_matches?(rule)
-      rule.match(/\A\.(.+)\z/) && ($1 == self.tld || $1 == self.tld2) ? true : false
+      rule.match(/\A\.(.+)\z/) && ($1 == tld || $1 == tld2) # ? true : false
     end
 
     def provider_matches?(rule)
@@ -266,24 +300,17 @@ module EmailAddress
     # Requires optionally starts with a "@".
     def domain_matches?(rule)
       rule = $1 if rule =~ /\A@(.+)/
-      return rule if File.fnmatch?(rule, self.domain_name)
-      return rule if File.fnmatch?(rule, self.dns_name)
+      return rule if domain_name && File.fnmatch?(rule, domain_name)
+      return rule if dns_name && File.fnmatch?(rule, dns_name)
       false
     end
 
     # True if the host is an IP Address form, and that address matches
     # the passed CIDR string ("10.9.8.0/24" or "2001:..../64")
     def ip_matches?(cidr)
-      return false unless self.ip_address
-      return cidr if !cidr.include?("/") && cidr == self.ip_address
-
-      c = NetAddr::CIDR.create(cidr)
-      if cidr.include?(":") && self.ip_address.include?(":")
-        return cidr if c.matches?(self.ip_address)
-      elsif cidr.include?(".") && self.ip_address.include?(".")
-        return cidr if c.matches?(self.ip_address)
-      end
-      false
+      return false unless ip_address
+      net = IPAddr.new(cidr)
+      net.include?(IPAddr.new(ip_address))
     end
 
     ############################################################################
@@ -292,45 +319,50 @@ module EmailAddress
 
     # True if the :dns_lookup setting is enabled
     def dns_enabled?
-      EmailAddress::Config.setting(:dns_lookup).equal?(:off) ? false : true
-    end
-
-    # True if the host name has a DNS A Record
-    def has_dns_a_record?
-      dns_a_record.size > 0 ? true : false
+      return false if @config[:dns_lookup] == :off
+      return false if @config[:host_validation] == :syntax
+      true
     end
 
     # Returns: [official_hostname, alias_hostnames, address_family, *address_list]
     def dns_a_record
-      @_dns_a_record ||= Socket.gethostbyname(self.dns_name)
+      @_dns_a_record = "0.0.0.0" if @config[:dns_lookup] == :off
+      @_dns_a_record ||= Addrinfo.getaddrinfo(dns_name, 80) # Port 80 for A rec, 25 for MX
     rescue SocketError # not found, but could also mean network not work
       @_dns_a_record ||= []
     end
 
-    # Returns an array of EmailAddress::Exchanger hosts configured in DNS.
+    # Returns an array of Exchanger hosts configured in DNS.
     # The array will be empty if none are configured.
     def exchangers
-      return nil if @config[:host_type] != :email || !self.dns_enabled?
-      @_exchangers ||= EmailAddress::Exchanger.cached(self.dns_name)
+      # return nil if @config[:host_type] != :email || !self.dns_enabled?
+      @_exchangers ||= Exchanger.cached(dns_name, @config)
     end
 
     # Returns a DNS TXT Record
-    def txt(alternate_host=nil)
+    def txt(alternate_host = nil)
+      return nil unless dns_enabled?
       Resolv::DNS.open do |dns|
-        records = dns.getresources(alternate_host || self.dns_name,
-                         Resolv::DNS::Resource::IN::TXT)
+        dns.timeouts = @config[:dns_timeout] if @config[:dns_timeout]
+        records = begin
+          dns.getresources(alternate_host || dns_name,
+            Resolv::DNS::Resource::IN::TXT)
+        rescue Resolv::ResolvTimeout
+          []
+        end
+
         records.empty? ? nil : records.map(&:data).join(" ")
       end
     end
 
     # Parses TXT record pairs into a hash
-    def txt_hash(alternate_host=nil)
+    def txt_hash(alternate_host = nil)
       fields = {}
-      record = self.txt(alternate_host)
+      record = txt(alternate_host)
       return fields unless record
 
       record.split(/\s*;\s*/).each do |pair|
-        (n,v) = pair.split(/\s*=\s*/)
+        (n, v) = pair.split(/\s*=\s*/)
         fields[n.to_sym] = v
       end
       fields
@@ -339,7 +371,7 @@ module EmailAddress
     # Returns a hash of the domain's DMARC (https://en.wikipedia.org/wiki/DMARC)
     # settings.
     def dmarc
-      self.dns_name ? self.txt_hash("_dmarc." + self.dns_name) : {}
+      dns_name ? txt_hash("_dmarc." + dns_name) : {}
     end
 
     ############################################################################
@@ -347,34 +379,124 @@ module EmailAddress
     ############################################################################
 
     # Returns true if the host name is valid according to the current configuration
-    def valid?(rule=@config[:dns_lookup]||:mx)
-      if self.provider != :default # well known
+    def valid?(rules = {})
+      host_validation = rules[:host_validation] || @config[:host_validation] || :mx
+      dns_lookup = rules[:dns_lookup] || host_validation
+      self.error_message = nil
+      if host_name && !host_name.empty? && !@config[:host_size].include?(host_name.size)
+        return set_error(:invalid_host)
+      end
+      if ip_address
+        valid_ip?
+      elsif !valid_format?
+        false
+      elsif dns_lookup == :connect
+        valid_mx? && connect
+      elsif dns_lookup == :mx
+        valid_mx?
+      elsif dns_lookup == :a
+        valid_dns?
+      else
         true
-      elsif self.ip_address
-        @config[:host_allow_ip] && self.valid_ip?
-      elsif rule == :mx
-        self.exchangers.mx_ips.size > 0
-      elsif rule == :a
-        self.has_dns_a_record?
-      elsif rule == :off
-        self.to_s.size <= MAX_HOST_LENGTH
+      end
+    end
+
+    # True if the host name has a DNS A Record
+    def valid_dns?
+      return true unless dns_enabled?
+      dns_a_record.size > 0 || set_error(:domain_unknown)
+    end
+
+    # True if the host name has valid MX servers configured in DNS
+    def valid_mx?
+      return true unless dns_enabled?
+      if exchangers.nil?
+        set_error(:domain_unknown)
+      elsif exchangers.mx_ips.size > 0
+        if localhost? && !@config[:host_local]
+          set_error(:domain_no_localhost)
+        else
+          true
+        end
+      elsif @config[:dns_timeout].nil? && valid_dns?
+        set_error(:domain_does_not_accept_email)
       else
-        false
+        set_error(:domain_unknown)
       end
     end
 
+    # True if the host_name passes Regular Expression match and size limits.
+    def valid_format?
+      if host_name =~ CANONICAL_HOST_REGEX && to_s.size <= MAX_HOST_LENGTH
+        if localhost?
+          return @config[:host_local] ? true : set_error(:domain_no_localhost)
+        end
+
+        return true if !@config[:host_fqdn]
+        return true if host_name.include?(".") # require FQDN
+      end
+      set_error(:domain_invalid)
+    end
+
     # Returns true if the IP address given in that form of the host name
     # is a potentially valid IP address. It does not check if the address
     # is reachable.
     def valid_ip?
-      if self.ip_address.nil?
-        false
-      elsif self.ip_address.include?(":")
-        self.ip_address =~ Resolv::IPv6::Regex
-      elsif self.ip_address.include?(".")
-        self.ip_address =~ Resolv::IPv4::Regex
+      if !@config[:host_allow_ip]
+        bool = set_error(:ip_address_forbidden)
+      elsif ip_address.include?(":")
+        bool = ip_address.match(Resolv::IPv6::Regex) ? true : set_error(:ipv6_address_invalid)
+      elsif ip_address.include?(".")
+        bool = ip_address.match(Resolv::IPv4::Regex) ? true : set_error(:ipv4_address_invalid)
       end
+      if bool && (localhost? && !@config[:host_local])
+        bool = set_error(:ip_address_no_localhost)
+      end
+      bool
+    end
+
+    def localhost?
+      return true if host_name == "localhost"
+      return false unless ip_address
+      IPAddr.new(ip_address).loopback?
     end
 
+    # Connects to host to test it can receive email. This should NOT be performed
+    # as an email address check, but is provided to assist in problem resolution.
+    # If you abuse this, you *could* be blocked by the ESP.
+    #
+    # timeout is the number of seconds to wait before timing out the request and
+    # returns false as the connection was unsuccessful.
+    #
+    # > NOTE: As of Ruby 3.1, Net::SMTP was moved from the standard library to the
+    # > 'net-smtp' gem. In order to avoid adding that dependency for this *experimental*
+    # > feature, please add the gem to your Gemfile and require it to use this feature.
+    def connect(timeout = nil)
+      smtp = Net::SMTP.new(host_name || ip_address)
+      smtp.open_timeout = timeout || @config[:host_timeout]
+      smtp.start(@config[:helo_name] || "localhost")
+      smtp.finish
+      true
+    rescue Net::SMTPFatalError => e
+      set_error(:server_not_available, e.to_s)
+    rescue SocketError => e
+      set_error(:server_not_available, e.to_s)
+    rescue Net::OpenTimeout => e
+      set_error(:server_not_available, e.to_s)
+    ensure
+      smtp.finish if smtp&.started?
+    end
+
+    def set_error(err, reason = nil)
+      @error = err
+      @reason = reason
+      @error_message = Config.error_message(err, locale)
+      false
+    end
+
+    # The inverse of valid? -- Returns nil (falsey) if valid, otherwise error message
+    def error
+      valid? ? nil : @error_message
+    end
   end
 end