sisimai 4.14.2

data/lib/sisimai/order.rb

@@ -0,0 +1,217 @@
+module Sisimai
+  # Sisimai::Order makes optimized order list which include MTA/MSP modules to be
+  # loaded on first from MTA specific headers in the bounce mail headers such as
+  # X-Failed-Recipients. This module are called from only Sisimai::Message.
+  module Order
+    # Imported from p5-Sisimail/lib/Sisimai/RFC3464.pm
+    class << self
+      require 'sisimai/mta'
+      require 'sisimai/msp'
+
+      AnotherList1 = [
+        # These modules have many subject patterns or have MIME encoded subjects
+        # which is hard to code as regular expression
+        'Sisimai::MTA::Exim',
+        'Sisimai::MTA::Exchange',
+      ]
+      AnotherList2 = [
+        # These modules have no MTA specific header and did not listed in the
+        # following subject header based regular expressions.
+        'Sisimai::MSP::US::Facebook',
+        'Sisimai::MSP::JP::KDDI',
+      ]
+      AnotherList3 = [
+        # These modules have no MTA specific header but listed in the following
+        # subject header based regular expressions.
+        'Sisimai::MTA::Qmail',
+        'Sisimai::MTA::Notes',
+        'Sisimai::MTA::MessagingServer',
+        'Sisimai::MTA::Domino',
+        'Sisimai::MSP::DE::EinsUndEins',
+        'Sisimai::MTA::OpenSMTPD',
+        'Sisimai::MTA::MXLogic',
+        'Sisimai::MTA::Postfix',
+        'Sisimai::MTA::Sendmail',
+        'Sisimai::MTA::Courier',
+        'Sisimai::MTA::IMailServer',
+        'Sisimai::MSP::US::SendGrid',
+        'Sisimai::MSP::US::Bigfoot',
+        'Sisimai::MTA::X4',
+      ]
+      AnotherList4 = [
+        # These modules have no MTA specific headers and there are few samples or
+        # too old MTA
+        'Sisimai::MSP::US::Verizon',
+        'Sisimai::MTA::InterScanMSS',
+        'Sisimai::MTA::MailFoundry',
+        'Sisimai::MTA::ApacheJames',
+        'Sisimai::MSP::JP::Biglobe',
+        'Sisimai::MSP::JP::EZweb',
+        'Sisimai::MTA::X5',
+        'Sisimai::MTA::X3',
+        'Sisimai::MTA::X2',
+        'Sisimai::MTA::X1',
+        'Sisimai::MTA::V5sendmail',
+      ]
+      AnotherList5 = [
+        # These modules have one or more MTA specific headers but other headers
+        # also required for detecting MTA name
+        'Sisimai::MSP::US::Google',
+        'Sisimai::MSP::US::Outlook',
+        'Sisimai::MSP::RU::MailRu',
+        'Sisimai::MSP::UK::MessageLabs',
+        'Sisimai::MTA::MailMarshalSMTP',
+        'Sisimai::MTA::MFILTER',
+      ]
+      AnotherList9 = [
+        # These modules have one or more MTA specific headers
+        'Sisimai::MSP::US::Aol',
+        'Sisimai::MSP::US::Yahoo',
+        'Sisimai::MSP::US::AmazonSES',
+        'Sisimai::MSP::DE::GMX',
+        'Sisimai::MSP::RU::Yandex',
+        'Sisimai::MSP::US::ReceivingSES',
+        'Sisimai::MSP::US::Zoho',
+        'Sisimai::MTA::McAfee',
+        'Sisimai::MTA::Activehunter',
+        'Sisimai::MTA::SurfControl',
+      ]
+
+      # This variable don't hold MTA/MSP name which have one or more MTA specific
+      # header such as X-AWS-Outgoing, X-Yandex-Uniq.
+      PatternTable = {
+        'subject' => {
+          %r/delivery/i => [
+            'Sisimai::MTA::Exim',
+            'Sisimai::MTA::Courier',
+            'Sisimai::MSP::US::Google',
+            'Sisimai::MSP::US::Outlook',
+            'Sisimai::MTA::Domino',
+            'Sisimai::MTA::OpenSMTPD',
+            'Sisimai::MSP::DE::EinsUndEins',
+            'Sisimai::MTA::InterScanMSS',
+            'Sisimai::MTA::MailFoundry',
+            'Sisimai::MTA::X4',
+            'Sisimai::MTA::X3',
+            'Sisimai::MTA::X2',
+          ],
+          %r/noti(?:ce|fi)/i => [
+            'Sisimai::MTA::Qmail',
+            'Sisimai::MTA::Sendmail',
+            'Sisimai::MSP::US::Google',
+            'Sisimai::MSP::US::Outlook',
+            'Sisimai::MTA::Courier',
+            'Sisimai::MTA::MessagingServer',
+            'Sisimai::MTA::OpenSMTPD',
+            'Sisimai::MTA::X4',
+            'Sisimai::MTA::X3',
+            'Sisimai::MTA::MFILTER',
+          ],
+          %r/return/i => [
+            'Sisimai::MTA::Postfix',
+            'Sisimai::MTA::Sendmail',
+            'Sisimai::MSP::US::SendGrid',
+            'Sisimai::MSP::US::Bigfoot',
+            'Sisimai::MTA::X1',
+            'Sisimai::MSP::DE::EinsUndEins',
+            'Sisimai::MSP::JP::Biglobe',
+            'Sisimai::MTA::V5sendmail',
+          ],
+          %r/undeliver/i => [
+            'Sisimai::MTA::Postfix',
+            'Sisimai::MTA::Exchange',
+            'Sisimai::MTA::Notes',
+            'Sisimai::MSP::US::Verizon',
+            'Sisimai::MSP::US::SendGrid',
+            'Sisimai::MTA::IMailServer',
+            'Sisimai::MTA::MailMarshalSMTP',
+          ],
+          %r/failure/i => [
+            'Sisimai::MTA::Qmail',
+            'Sisimai::MTA::Domino',
+            'Sisimai::MSP::US::Google',
+            'Sisimai::MSP::US::Outlook',
+            'Sisimai::MSP::RU::MailRu',
+            'Sisimai::MTA::X4',
+            'Sisimai::MTA::X2',
+            'Sisimai::MTA::MFILTER',
+          ],
+          %r/warning/i => [
+            'Sisimai::MTA::Postfix',
+            'Sisimai::MTA::Sendmail',
+            'Sisimai::MTA::Exim',
+          ],
+        },
+      }
+
+      make_default_order = lambda do
+        # Make default order of MTA/MSP modules to be loaded
+        rv = []
+        begin
+          rv.concat(Sisimai::MTA.index.map { |e| 'Sisimai::MTA::' + e })
+          rv.concat(Sisimai::MSP.index.map { |e| 'Sisimai::MSP::' + e })
+        rescue
+          # Failed to load MTA/MSP module
+          next
+        end
+        return rv
+      end
+      DefaultOrder = make_default_order.call
+
+      # Get regular expression patterns for specified field
+      # @param    [String] group  Group name for "ORDER BY"
+      # @return   [Hash]          Pattern table for the group
+      def by(group  = '')
+        return {} unless group.size > 0
+        return PatternTable[group] if PatternTable.key?(group)
+        return {}
+      end
+
+      # Make default order of MTA/MSP modules to be loaded
+      # @return   [Array] Default order list of MTA/MSP modules
+      def default
+        return DefaultOrder
+      end
+
+      # Make MTA/MSP module list as a spare
+      # @return   [Array] Ordered module list
+      def another
+        rv = []
+        rv.concat(AnotherList1)
+        rv.concat(AnotherList2)
+        rv.concat(AnotherList3)
+        rv.concat(AnotherList4)
+        rv.concat(AnotherList5)
+        return rv
+      end
+
+      # Make email header list in each MTA module
+      # @return   [Hash] Header list to be parsed
+      def headers
+        order = self.default
+        table = {}
+        skips = { 'return-path' => 1, 'x-mailer' => 1 }
+
+        order.each do |e|
+          # Load email headers from each MTA,MSP module
+          begin
+            require e.gsub('::', '/').downcase
+          rescue LoadError
+            warn ' ***warning: Failed to load ' + e
+            next
+          end
+
+          Module.const_get(e).headerlist.each do |v|
+            # Get header name which required each MTA/MSP module
+            q = v.downcase
+            next if skips.key?(q)
+            table[q]  ||= {}
+            table[q][e] = 1
+          end
+        end
+        return table
+      end
+
+    end
+  end
+end

data/lib/sisimai/reason.rb

@@ -0,0 +1,235 @@
+module Sisimai
+  # Sisimai::Reason detects the bounce reason from the content of Sisimai::Data
+  # object as an argument of get() method. This class is called only Sisimai::Data
+  # class.
+  module Reason
+    # Imported from p5-Sisimail/lib/Sisimai/Reason.pm
+    class << self
+      # Reason list better to retry detecting an error reason
+      # @return   [Array] Reason list
+      def retry
+        return ['undefined', 'onhold', 'systemerror', 'securityerror', 'networkerror']
+      end
+      RetryReasons = Sisimai::Reason.retry
+
+      # All the error reason list Sisimai support
+      # @return   [Array] Reason list
+      def index
+        return %w[
+          Blocked ContentError ExceedLimit Expired Filtered HasMoved HostUnknown
+          MailboxFull MailerError MesgTooBig NetworkError NotAccept OnHold
+          Rejected NoRelaying SpamDetected SecurityError Suspend SystemError
+          SystemFull TooManyConn UserUnknown
+        ]
+      end
+
+      # Detect the bounce reason
+      # @param    [Sisimai::Data] argvs   Parsed email object
+      # @return   [String, Undef]         Bounce reason or Undef if the argument
+      #                                   is missing or invalid object
+      # @see anotherone
+      def get(argvs)
+        return nil unless argvs
+        return nil unless argvs.is_a? Sisimai::Data
+
+        unless RetryReasons.index(argvs.reason)
+          # Return reason text already decided except reason match with the
+          # regular expression of ->retry() method.
+          return argvs.reason if argvs.reason.size > 0
+        end
+
+        reasontext = ''
+        classorder = [
+          'MailboxFull', 'MesgTooBig', 'ExceedLimit', 'Suspend', 'HasMoved',
+          'NoRelaying', 'UserUnknown', 'Filtered', 'Rejected', 'HostUnknown',
+          'SpamDetected', 'TooManyConn', 'Blocked',
+        ]
+
+        if argvs.diagnostictype == 'SMTP' || argvs.diagnostictype == ''
+          # Diagnostic-Code: SMTP; ... or empty value
+          classorder.each do |e|
+            # Check the value of Diagnostic-Code: and the value of Status:, it is a
+            # deliverystats, with true() method in each Sisimai::Reason::* class.
+            p = 'Sisimai::Reason::' + e
+            r = nil
+            begin
+              require p.downcase.gsub('::', '/')
+              r = Module.const_get(p)
+            rescue
+              warn ' ***warning: Failed to load ' + p
+              next
+            end
+            next unless r.true(argvs)
+            reasontext = r.text
+            break
+          end
+        end
+
+        if reasontext.empty? || reasontext == 'undefined'
+          # Bounce reason is not detected yet.
+          loop do
+            p = 'Sisimai::Reason::OnHold' # Onhold ?
+            r = nil
+            begin
+              require p.downcase.gsub('::', '/')
+              r = Module.const_get(p)
+              reasontext = r.text if r.true(argvs)
+            rescue
+              warn ' ***warning: Failed to load ' + p
+            end
+            break if reasontext.size > 0
+
+            # Other reason ?
+            reasontext = self.anotherone(argvs)
+            break
+          end
+
+          if reasontext == 'undefined' || reasontext.empty?
+            # Action: delayed => "expired"
+            if reasontext.nil? || reasontext.empty?
+              reasontext = 'expired' if argvs.action == 'delayed'
+            end
+            if reasontext.nil? || reasontext.empty?
+              reasontext = 'onhold'  if argvs.diagnosticcode.size > 0
+            end
+          end
+          reasontext = 'undefined' if reasontext.nil? || reasontext.empty?
+        end
+        return reasontext
+      end
+
+      # Detect the other bounce reason, fall back method for get()
+      # @param    [Sisimai::Data] argvs   Parsed email object
+      # @return   [String, Undef]         Bounce reason or Undef if the argument
+      #                                   is missing or invalid object
+      # @see get
+      def anotherone(argvs)
+        return nil unless argvs
+        return nil unless argvs.is_a? Sisimai::Data
+        return argvs.reason if argvs.reason.size > 0
+
+        statuscode = argvs.deliverystatus || ''
+        diagnostic = argvs.diagnosticcode || ''
+        commandtxt = argvs.smtpcommand    || ''
+        reasontext = ''
+        classorder = [
+          'MailboxFull', 'SpamDetected', 'SecurityError', 'SystemError',
+          'NetworkError', 'Suspend', 'Expired', 'ContentError',
+          'SystemFull', 'NotAccept', 'MailerError',
+        ]
+
+        require 'sisimai/smtp/status'
+        reasontext = Sisimai::SMTP::Status.name(statuscode)
+
+        if reasontext.empty? || reasontext == 'userunknown' || RetryReasons.index(reasontext)
+          # Could not decide the reason by the value of Status:
+          classorder.each do |e|
+            # Trying to match with other patterns in Sisimai::Reason::* classes
+            p = 'Sisimai::Reason::' + e
+            r = nil
+            begin
+              require p.downcase.gsub('::', '/')
+              r = Module.const_get(p)
+            rescue
+              warn ' ***warning: Failed to load ' + p
+              next
+            end
+
+            next unless r.match(diagnostic)
+            reasontext = e.downcase
+            break
+          end
+
+          if reasontext.empty?
+            # Check the value of Status:
+            v = statuscode[0, 3]
+            if v == '5.6' || v == '4.6'
+              #  X.6.0   Other or undefined media error
+              reasontext = 'contenterror'
+
+            elsif v == '5.7' || v == '4.7'
+              #  X.7.0   Other or undefined security status
+              reasontext = 'securityerror'
+
+            elsif argvs.diagnostictype =~ /\AX-(?:UNIX|POSTFIX)\z/
+              # Diagnostic-Code: X-UNIX; ...
+              reasontext = 'mailererror'
+            end
+          end
+
+          if reasontext.empty?
+            # Check the value of Action: field, first
+            if argvs.action =~ /\A(?:delayed|expired)/
+              # Action: delayed, expired
+              reasontext = 'expired'
+
+            else
+              # Check the value of SMTP command
+              if commandtxt =~ /\A(?:EHLO|HELO)\z/
+                # Rejected at connection or after EHLO|HELO
+                reasontext = 'blocked'
+              end
+            end
+          end
+        end
+        return reasontext
+      end
+
+      # Detect the bounce reason from given text
+      # @param    [String] argv1  Error message
+      # @return   [String]        Bounce reason
+      def match(argv1)
+        return nil unless argv1
+        require 'sisimai/smtp/status'
+
+        reasontext = ''
+        typestring = ''
+        classorder = [
+          'MailboxFull', 'MesgTooBig', 'ExceedLimit', 'Suspend', 'UserUnknown',
+          'Filtered', 'Rejected', 'HostUnknown', 'SpamDetected', 'TooManyConn',
+          'Blocked', 'SpamDetected', 'SecurityError', 'SystemError',
+          'NetworkError', 'Suspend', 'Expired', 'ContentError', 'HasMoved',
+          'SystemFull', 'NotAccept', 'MailerError', 'NoRelaying', 'OnHold',
+        ]
+
+        statuscode = Sisimai::SMTP::Status.find(argv1)
+        if cv = argv1.match(/\A(SMTP|X-.+);/i)
+          typestring = cv[1].upcase
+        end
+
+        # Diagnostic-Code: SMTP; ... or empty value
+        classorder.each do |e|
+          # Check the value of Diagnostic-Code: and the value of Status:, it is a
+          # deliverystats, with true() method in each Sisimai::Reason::* class.
+          p = 'Sisimai::Reason::' + e
+          r = nil
+          begin
+            require p.downcase.gsub('::', '/')
+            r = Module.const_get(p)
+          rescue
+            warn ' ***warning: Failed to load ' + p
+            next
+          end
+
+          next unless r.match(argv1)
+          reasontext = r.text
+          break
+        end
+
+        if reasontext.empty?
+          # Check the value of $typestring
+          if typestring == 'X-UNIX'
+            # X-Unix; ...
+            reasontext = 'mailererror'
+          else
+            # Detect the bounce reason from "Status:" code
+            reasontext = Sisimai::SMTP::Status.name(statuscode) || 'undefined'
+          end
+        end
+        return reasontext
+      end
+
+    end
+  end
+end
+