sisimai 4.21.1 → 4.22.0

data/lib/sisimai/mta/opensmtpd.rb

@@ -1,195 +0,0 @@
-module Sisimai
-  module MTA
-    # Sisimai::MTA::OpenSMTPD parses a bounce email which created by OpenSMTPD.
-    # Methods in the module are called from only Sisimai::Message.
-    module OpenSMTPD
-      # Imported from p5-Sisimail/lib/Sisimai/MTA/OpenSMTPD.pm
-      class << self
-        require 'sisimai/mta'
-        require 'sisimai/rfc5322'
-
-        Re0 = {
-          :from     => %r/\AMailer Daemon [<][^ ]+[@]/,
-          :subject  => %r/\ADelivery status notification/,
-          :received => %r/[ ][(]OpenSMTPD[)][ ]with[ ]/,
-        }
-        # http://www.openbsd.org/cgi-bin/man.cgi?query=smtpd&sektion=8
-        # opensmtpd-5.4.2p1/smtpd/
-        #   bounce.c/317:#define NOTICE_INTRO \
-        #   bounce.c/318:    "    Hi!\n\n"    \
-        #   bounce.c/319:    "    This is the MAILER-DAEMON, please DO NOT REPLY to this e-mail.\n"
-        #   bounce.c/320:
-        #   bounce.c/321:const char *notice_error =
-        #   bounce.c/322:    "    An error has occurred while attempting to deliver a message for\n"
-        #   bounce.c/323:    "    the following list of recipients:\n\n";
-        #   bounce.c/324:
-        #   bounce.c/325:const char *notice_warning =
-        #   bounce.c/326:    "    A message is delayed for more than %s for the following\n"
-        #   bounce.c/327:    "    list of recipients:\n\n";
-        #   bounce.c/328:
-        #   bounce.c/329:const char *notice_warning2 =
-        #   bounce.c/330:    "    Please note that this is only a temporary failure report.\n"
-        #   bounce.c/331:    "    The message is kept in the queue for up to %s.\n"
-        #   bounce.c/332:    "    You DO NOT NEED to re-send the message to these recipients.\n\n";
-        #   bounce.c/333:
-        #   bounce.c/334:const char *notice_success =
-        #   bounce.c/335:    "    Your message was successfully delivered to these recipients.\n\n";
-        #   bounce.c/336:
-        #   bounce.c/337:const char *notice_relay =
-        #   bounce.c/338:    "    Your message was relayed to these recipients.\n\n";
-        #   bounce.c/339:
-        Re1 = {
-          :begin  => %r/\A[ \t]*This is the MAILER-DAEMON, please DO NOT REPLY to this e[-]?mail[.]\z/,
-          :rfc822 => %r/\A[ \t]*Below is a copy of the original message:\z/,
-          :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
-        }
-        ReFailure = {
-          expired: %r{
-            # smtpd/queue.c:221|  envelope_set_errormsg(&evp, "Envelope expired");
-            Envelope[ ]expired
-          }x,
-          hostunknown: %r{(?:
-            # smtpd/mta.c:976|  relay->failstr = "Invalid domain name";
-             Invalid[ ]domain[ ]name
-            # smtpd/mta.c:980|  relay->failstr = "Domain does not exist";
-            |Domain[ ]does[ ]not[ ]exist
-            )
-          }x,
-          notaccept: %r{
-            # smtp/mta.c:1085|  relay->failstr = "Destination seem to reject all mails";
-            Destination[ ]seem[ ]to[ ]reject[ ]all[ ]mails
-          }x,
-          networkerror: %r{(?>
-            #  smtpd/mta.c:972|  relay->failstr = "Temporary failure in MX lookup";
-             Address[ ]family[ ]mismatch[ ]on[ ]destination[ ]MXs
-            |All[ ]routes[ ]to[ ]destination[ ]blocked
-            |bad[ ]DNS[ ]lookup[ ]error[ ]code
-            |Could[ ]not[ ]retrieve[ ]source[ ]address
-            |Loop[ ]detected
-            |Network[ ]error[ ]on[ ]destination[ ]MXs
-            |No[ ](?>
-               MX[ ]found[ ]for[ ](?:domain|destination)
-              |valid[ ]route[ ]to[ ](?:remote[ ]MX|destination)
-              )
-            |Temporary[ ]failure[ ]in[ ]MX[ ]lookup
-            )
-          }x,
-          securityerror: %r{
-            # smtpd/mta.c:1013|  relay->failstr = "Could not retrieve credentials";
-            Could[ ]not[ ]retrieve[ ]credentials
-          }x,
-        }
-        Indicators = Sisimai::MTA.INDICATORS
-
-        def description; return 'OpenSMTPD'; end
-        def smtpagent;   return Sisimai::MTA.smtpagent(self); end
-        def headerlist;  return []; end
-        def pattern;     return Re0; end
-
-        # Parse bounce messages from OpenSMTPD
-        # @param         [Hash] mhead       Message header of a bounce email
-        # @options mhead [String] from      From header
-        # @options mhead [String] date      Date header
-        # @options mhead [String] subject   Subject header
-        # @options mhead [Array]  received  Received headers
-        # @options mhead [String] others    Other required headers
-        # @param         [String] mbody     Message body of a bounce email
-        # @return        [Hash, Nil]        Bounce data list and message/rfc822
-        #                                   part or nil if it failed to parse or
-        #                                   the arguments are missing
-        def scan(mhead, mbody)
-          return nil unless mhead
-          return nil unless mbody
-          return nil unless mhead['subject'] =~ Re0[:subject]
-          return nil unless mhead['from']    =~ Re0[:from]
-          return nil unless mhead['received'].find { |a| a =~ Re0[:received] }
-
-          dscontents = [Sisimai::MTA.DELIVERYSTATUS]
-          hasdivided = mbody.split("\n")
-          rfc822list = []     # (Array) Each line in message/rfc822 part string
-          blanklines = 0      # (Integer) The number of blank lines
-          readcursor = 0      # (Integer) Points the current cursor position
-          recipients = 0      # (Integer) The number of 'Final-Recipient' header
-          v = nil
-
-          hasdivided.each do |e|
-            if readcursor.zero?
-              # Beginning of the bounce message or delivery status part
-              if e =~ Re1[:begin]
-                readcursor |= Indicators[:deliverystatus]
-                next
-              end
-            end
-
-            if readcursor & Indicators[:'message-rfc822'] == 0
-              # Beginning of the original message part
-              if e =~ Re1[:rfc822]
-                readcursor |= Indicators[:'message-rfc822']
-                next
-              end
-            end
-
-            if readcursor & Indicators[:'message-rfc822'] > 0
-              # After "message/rfc822"
-              if e.empty?
-                blanklines += 1
-                break if blanklines > 1
-                next
-              end
-              rfc822list << e
-
-            else
-              # Before "message/rfc822"
-              next if readcursor & Indicators[:deliverystatus] == 0
-              next if e.empty?
-
-              #    Hi!
-              #
-              #    This is the MAILER-DAEMON, please DO NOT REPLY to this e-mail.
-              #
-              #    An error has occurred while attempting to deliver a message for
-              #    the following list of recipients:
-              #
-              # kijitora@example.jp: 550 5.2.2 <kijitora@example>... Mailbox Full
-              #
-              #    Below is a copy of the original message:
-              v = dscontents[-1]
-
-              if cv = e.match(/\A([^ ]+?[@][^ ]+?):?[ ](.+)\z/)
-                # kijitora@example.jp: 550 5.2.2 <kijitora@example>... Mailbox Full
-                if v['recipient']
-                  # There are multiple recipient addresses in the message body.
-                  dscontents << Sisimai::MTA.DELIVERYSTATUS
-                  v = dscontents[-1]
-                end
-                v['recipient'] = cv[1]
-                v['diagnosis'] = cv[2]
-                recipients += 1
-              end
-            end
-          end
-          return nil if recipients.zero?
-          require 'sisimai/string'
-
-          dscontents.map do |e|
-            e['agent']     = Sisimai::MTA::OpenSMTPD.smtpagent
-            e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
-
-            ReFailure.each_key do |r|
-              # Verify each regular expression of session errors
-              next unless e['diagnosis'] =~ ReFailure[r]
-              e['reason'] = r.to_s
-              break
-            end
-            e.each_key { |a| e[a] ||= '' }
-          end
-
-          rfc822part = Sisimai::RFC5322.weedout(rfc822list)
-          return { 'ds' => dscontents, 'rfc822' => rfc822part }
-        end
-
-      end
-    end
-  end
-end
-

data/lib/sisimai/mta/postfix.rb

@@ -1,312 +0,0 @@
-module Sisimai
-  module MTA
-    # Sisimai::MTA::Postfix parses a bounce email which created by Postfix.
-    # Methods in the module are called from only Sisimai::Message.
-    module Postfix
-      # Imported from p5-Sisimail/lib/Sisimai/MTA/Postfix.pm
-      class << self
-        require 'sisimai/mta'
-        require 'sisimai/rfc5322'
-
-        # Postfix manual - bounce(5) - http://www.postfix.org/bounce.5.html
-        Re0 = {
-          :from    => %r/ [(]Mail Delivery System[)]\z/,
-          :subject => %r/\AUndelivered Mail Returned to Sender\z/,
-        }
-        Re1 = {
-          :begin => %r{\A(?>
-             [ ]+The[ ](?:
-               Postfix[ ](?:
-                 program\z              # The Postfix program
-                |on[ ].+[ ]program\z    # The Postfix on <os name> program
-                )
-              |\w+[ ]Postfix[ ]program\z  # The <name> Postfix program
-              |mail[ \t]system\z             # The mail system
-              |\w+[ \t]program\z             # The <custmized-name> program
-              )
-            |This[ ]is[ ]the[ ](?:
-               Postfix[ ]program          # This is the Postfix program
-              |\w+[ ]Postfix[ ]program    # This is the <name> Postfix program
-              |\w+[ ]program              # This is the <customized-name> Postfix program
-              |mail[ ]system[ ]at[ ]host  # This is the mail system at host <hostname>.
-              )
-            )
-          }x,
-          :rfc822 => %r!\AContent-Type:[ \t]*(?:message/rfc822|text/rfc822-headers)\z!x,
-          :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
-        }
-        Indicators = Sisimai::MTA.INDICATORS
-
-        def description; return 'Postfix'; end
-        def smtpagent;   return Sisimai::MTA.smtpagent(self); end
-        def headerlist;  return []; end
-        def pattern;     return Re0; end
-
-        # Parse bounce messages from Postfix
-        # @param         [Hash] mhead       Message header of a bounce email
-        # @options mhead [String] from      From header
-        # @options mhead [String] date      Date header
-        # @options mhead [String] subject   Subject header
-        # @options mhead [Array]  received  Received headers
-        # @options mhead [String] others    Other required headers
-        # @param         [String] mbody     Message body of a bounce email
-        # @return        [Hash, Nil]        Bounce data list and message/rfc822
-        #                                   part or nil if it failed to parse or
-        #                                   the arguments are missing
-        def scan(mhead, mbody)
-          return nil unless mhead
-          return nil unless mbody
-          return nil unless mhead['subject'] =~ Re0[:subject]
-
-          dscontents = [Sisimai::MTA.DELIVERYSTATUS]
-          hasdivided = mbody.split("\n")
-          havepassed = ['']
-          rfc822list = []     # (Array) Each line in message/rfc822 part string
-          blanklines = 0      # (Integer) The number of blank lines
-          readcursor = 0      # (Integer) Points the current cursor position
-          recipients = 0      # (Integer) The number of 'Final-Recipient' header
-          commandset = []     # (Array) ``in reply to * command'' list
-          connvalues = 0      # (Integer) Flag, 1 if all the value of $connheader have been set
-          connheader = {
-            'date'  => '',    # The value of Arrival-Date header
-            'lhost' => '',    # The value of Received-From-MTA header
-          }
-          anotherset = {}     # Another error information
-          v = nil
-
-          hasdivided.each do |e|
-            # Save the current line for the next loop
-            havepassed << e
-            p = havepassed[-2]
-
-            if readcursor.zero?
-              # Beginning of the bounce message or delivery status part
-              if e =~ Re1[:begin]
-                readcursor |= Indicators[:deliverystatus]
-                next
-              end
-            end
-
-            if readcursor & Indicators[:'message-rfc822'] == 0
-              # Beginning of the original message part
-              if e =~ Re1[:rfc822]
-                readcursor |= Indicators[:'message-rfc822']
-                next
-              end
-            end
-
-            if readcursor & Indicators[:'message-rfc822'] > 0
-              # After "message/rfc822"
-              if e.empty?
-                blanklines += 1
-                break if blanklines > 1
-                next
-              end
-              rfc822list << e
-
-            else
-              # Before "message/rfc822"
-              next if readcursor & Indicators[:deliverystatus] == 0
-              next if e.empty?
-
-              if connvalues == connheader.keys.size
-                # Final-Recipient: RFC822; userunknown@example.jp
-                # X-Actual-Recipient: RFC822; kijitora@example.co.jp
-                # Action: failed
-                # Status: 5.1.1
-                # Remote-MTA: DNS; mx.example.jp
-                # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
-                # Last-Attempt-Date: Fri, 14 Feb 2014 12:30:08 -0500
-                v = dscontents[-1]
-                if cv = e.match(/\A[Ff]inal-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*(.+)\z/)
-                  # Final-Recipient: RFC822; userunknown@example.jp
-                  if v['recipient']
-                    # There are multiple recipient addresses in the message body.
-                    dscontents << Sisimai::MTA.DELIVERYSTATUS
-                    v = dscontents[-1]
-                  end
-                  v['recipient'] = cv[1]
-                  recipients += 1
-
-                elsif cv = e.match(/\A[Xx]-[Aa]ctual-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/) ||
-                           e.match(/\A[Oo]riginal-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/)
-                  # X-Actual-Recipient: RFC822; kijitora@example.co.jp
-                  # Original-Recipient: rfc822;kijitora@example.co.jp
-                  v['alias'] = cv[1]
-
-                elsif cv = e.match(/\A[Aa]ction:[ ]*(.+)\z/)
-                  # Action: failed
-                  v['action'] = cv[1].downcase
-
-                elsif cv = e.match(/\A[Ss]tatus:[ ]*(\d[.]\d+[.]\d+)/)
-                  # Status: 5.1.1
-                  # Status:5.2.0
-                  # Status: 5.1.0 (permanent failure)
-                  v['status'] = cv[1]
-
-                elsif cv = e.match(/\A[Rr]emote-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
-                  # Remote-MTA: DNS; mx.example.jp
-                  v['rhost'] = cv[1].downcase
-
-                elsif cv = e.match(/\A[Ll]ast-[Aa]ttempt-[Dd]ate:[ ]*(.+)\z/)
-                  # Last-Attempt-Date: Fri, 14 Feb 2014 12:30:08 -0500
-                  #
-                  # src/bounce/bounce_notify_util.c:
-                  #   681  #if 0
-                  #   682      if (dsn->time > 0)
-                  #   683          post_mail_fprintf(bounce, "Last-Attempt-Date: %s",
-                  #   684                            mail_date(dsn->time));
-                  #   685  #endif
-                  v['date'] = cv[1]
-
-                else
-                  if cv = e.match(/\A[Dd]iagnostic-[Cc]ode:[ ]*(.+?);[ ]*(.+)\z/)
-                    # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
-                    v['spec'] = cv[1].upcase
-                    v['diagnosis'] = cv[2]
-                    v['spec'] = 'SMTP' if v['spec'] == 'X-POSTFIX'
-
-                  elsif p =~ /\A[Dd]iagnostic-[Cc]ode:[ ]*/ && cv = e.match(/\A[ \t]+(.+)\z/)
-                    # Continued line of the value of Diagnostic-Code header
-                    v['diagnosis'] ||= ''
-                    v['diagnosis']  += ' ' + cv[1]
-                    havepassed[-1] = 'Diagnostic-Code: ' + e
-                  end
-                end
-
-              else
-                # If you do so, please include this problem report. You can
-                # delete your own text from the attached returned message.
-                #
-                #           The mail system
-                #
-                # <userunknown@example.co.jp>: host mx.example.co.jp[192.0.2.153] said: 550
-                # 5.1.1 <userunknown@example.co.jp>... User Unknown (in reply to RCPT TO
-                # command)
-                if cv = e.match(/[ \t][(]in reply to ([A-Z]{4}).*/)
-                  # 5.1.1 <userunknown@example.co.jp>... User Unknown (in reply to RCPT TO
-                  commandset << cv[1]
-                  anotherset['diagnosis'] ||= ''
-                  anotherset['diagnosis'] += ' ' + e
-
-                elsif cv = e.match(/([A-Z]{4})[ \t]*.*command[)]\z/)
-                  # to MAIL command)
-                  commandset << cv[1]
-                  anotherset['diagnosis'] ||= ''
-                  anotherset['diagnosis'] += ' ' + e
-
-                else
-                  if cv = e.match(/\A[Rr]eporting-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
-                    # Reporting-MTA: dns; mx.example.jp
-                    next if connheader['lhost'].size > 0
-                    connheader['lhost'] = cv[1].downcase
-                    connvalues += 1
-
-                  elsif cv = e.match(/\A[Aa]rrival-[Dd]ate:[ ]*(.+)\z/)
-                    # Arrival-Date: Wed, 29 Apr 2009 16:03:18 +0900
-                    next if connheader['date'].size > 0
-                    connheader['date'] = 1
-                    connvalues += 1
-
-                  elsif cv = e.match(/\A(X-Postfix-Sender):[ ]*rfc822;[ ]*(.+)\z/)
-                    # X-Postfix-Sender: rfc822; shironeko@example.org
-                    rfc822list << sprintf('%s: %s', cv[1], cv[2])
-
-                  else
-                    # Alternative error message and recipient
-                    if cv = e.match(/\A[<]([^ ]+[@][^ ]+)[>] [(]expanded from [<](.+)[>][)]:[ \t]*(.+)\z/)
-                      # <r@example.ne.jp> (expanded from <kijitora@example.org>): user ...
-                      anotherset['recipient'] = cv[1]
-                      anotherset['alias']     = cv[2]
-                      anotherset['diagnosis'] = cv[3]
-
-                    elsif cv = e.match(/\A[<]([^ ]+[@][^ ]+)[>]:(.*)\z/)
-                      # <kijitora@exmaple.jp>: ...
-                      anotherset['recipient'] = cv[1]
-                      anotherset['diagnosis'] = cv[2]
-
-                    else
-                      # Get error message continued from the previous line
-                      next unless anotherset['diagnosis']
-                      if e =~ /\A[ \t]{4}(.+)\z/
-                        #    host mx.example.jp said:...
-                        anotherset['diagnosis'] += ' ' + e
-                      end
-                    end
-
-                  end
-                end
-              end
-            end # End of if: rfc822
-          end
-
-          if recipients.zero?
-            # Fallback: set recipient address from error message
-            if anotherset['recipient'] && anotherset['recipient'].size > 0
-              # Set recipient address
-              dscontents[-1]['recipient'] = anotherset['recipient']
-              recipients += 1
-            end
-          end
-          return nil if recipients.zero?
-
-          require 'sisimai/string'
-          require 'sisimai/smtp/status'
-          require 'sisimai/smtp/reply'
-
-          dscontents.map do |e|
-            # Set default values if each value is empty.
-            connheader.each_key { |a| e[a] ||= connheader[a] || '' }
-
-            e['agent']   = Sisimai::MTA::Postfix.smtpagent
-            e['command'] = commandset.shift || ''
-
-            if anotherset['diagnosis']
-              # Copy alternative error message
-              e['diagnosis'] = anotherset['diagnosis'] unless e['diagnosis']
-
-              if e['diagnosis'] =~ /\A\d+\z/
-                e['diagnosis'] = anotherset['diagnosis']
-              else
-                # More detailed error message is in "$anotherset"
-                as = nil  # status
-                ar = nil  # replycode
-
-                if e['status'] == '' || e['status'] =~ /\A[45][.]0[.]0\z/
-                  # Check the value of D.S.N. in $anotherset
-                  as = Sisimai::SMTP::Status.find(anotherset['diagnosis'])
-                  if as.size > 0 && as[-3, 3] != '0.0'
-                    # The D.S.N. is neither an empty nor *.0.0
-                    e['status'] = as
-                  end
-                end
-
-                if e['replycode'] == '' || e['replycode'] =~ /\A[45]00\z/
-                  # Check the value of SMTP reply code in $anotherset
-                  ar = Sisimai::SMTP::Reply.find(anotherset['diagnosis'])
-                  if ar.size > 0 && ar[-2, 2].to_i != 0
-                    # The SMTP reply code is neither an empty nor *00
-                    e['replycode'] = ar
-                  end
-                end
-
-                if ( as || ar ) && ( anotherset['diagnosis'].size > e['diagnosis'].size )
-                  # Update the error message in $e->{'diagnosis'}
-                  e['diagnosis'] = anotherset['diagnosis']
-                end
-              end
-            end
-
-            e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
-            e['spec']    ||= 'SMTP' if e['diagnosis'] =~ /host .+ said:/
-            e.each_key { |a| e[a] ||= '' }
-          end
-
-          rfc822part = Sisimai::RFC5322.weedout(rfc822list)
-          return { 'ds' => dscontents, 'rfc822' => rfc822part }
-        end
-
-      end
-    end
-  end
-end