sisimai 4.25.3 → 4.25.8

data/lib/sisimai/lhost/sendmail.rb

@@ -0,0 +1,207 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Sendmail parses a bounce email which created by
+  # v8 Sendmail. Methods in the module are called from only Sisimai::Message.
+  module Sendmail
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Sendmail.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r<^Content-Type:[ ](?:message/rfc822|text/rfc822-headers)>.freeze
+      StartingOf = {
+        # Error text regular expressions which defined in sendmail/savemail.c
+        #   savemail.c:1040|if (printheader && !putline("   ----- Transcript of session follows -----\n",
+        #   savemail.c:1041|          mci))
+        #   savemail.c:1042|  goto writeerr;
+        #   savemail.c:1360|if (!putline(
+        #   savemail.c:1361|    sendbody
+        #   savemail.c:1362|    ? "   ----- Original message follows -----\n"
+        #   savemail.c:1363|    : "   ----- Message header follows -----\n",
+        message: ['   ----- Transcript of session follows -----'],
+        error:   ['... while talking to '],
+      }.freeze
+
+      # Parse bounce messages from Sendmail
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
+      def make(mhead, mbody)
+        return nil unless mhead['subject'] =~ /(?:see transcript for details\z|\AWarning: )/
+        return nil if mhead['x-aol-ip']
+
+        require 'sisimai/rfc1894'
+        fieldtable = Sisimai::RFC1894.FIELDTABLE
+        permessage = {}     # (Hash) Store values of each Per-Message field
+
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
+        bodyslices = emailsteak[0].split("\n")
+        readslices = ['']
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        commandtxt = ''     # (String) SMTP Command name begin with the string '>>>'
+        esmtpreply = []     # (Array) Reply from remote server on SMTP session
+        sessionerr = false  # (Boolean) Flag, "true" if it is SMTP session error
+        anotherset = {}     # Another error information
+        v = nil
+
+        while e = bodyslices.shift do
+          # Read error messages and delivery status lines from the head of the email
+          # to the previous line of the beginning of the original message.
+          readslices << e # Save the current line for the next loop
+
+          if readcursor == 0
+            # Beginning of the bounce message or message/delivery-status part
+            readcursor |= Indicators[:deliverystatus] if e.start_with?(StartingOf[:message][0])
+            next
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          if f = Sisimai::RFC1894.match(e)
+            # "e" matched with any field defined in RFC3464
+            o = Sisimai::RFC1894.field(e) || next
+            v = dscontents[-1]
+
+            if o[-1] == 'addr'
+              # Final-Recipient: rfc822; kijitora@example.jp
+              # X-Actual-Recipient: rfc822; kijitora@example.co.jp
+              if o[0] == 'final-recipient'
+                # Final-Recipient: rfc822; kijitora@example.jp
+                if v['recipient']
+                  # There are multiple recipient addresses in the message body.
+                  dscontents << Sisimai::Lhost.DELIVERYSTATUS
+                  v = dscontents[-1]
+                end
+                v['recipient'] = o[2]
+                recipients += 1
+              else
+                # X-Actual-Recipient: rfc822; kijitora@example.co.jp
+                v['alias'] = o[2]
+              end
+            elsif o[-1] == 'code'
+              # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
+              v['spec'] = o[1]
+              v['diagnosis'] = o[2]
+            else
+              # Other DSN fields defined in RFC3464
+              next unless fieldtable[o[0]]
+              v[fieldtable[o[0]]] = o[2]
+
+              next unless f == 1
+              permessage[fieldtable[o[0]]] = o[2]
+            end
+          else
+            # The line does not begin with a DSN field defined in RFC3464
+            #
+            # ----- Transcript of session follows -----
+            # ... while talking to mta.example.org.:
+            # >>> DATA
+            # <<< 550 Unknown user recipient@example.jp
+            # 554 5.0.0 Service unavailable
+            # ...
+            # Reporting-MTA: dns; mx.example.jp
+            # Received-From-MTA: DNS; x1x2x3x4.dhcp.example.ne.jp
+            # Arrival-Date: Wed, 29 Apr 2009 16:03:18 +0900
+            unless e.start_with?(' ')
+              if cv = e.match(/\A[>]{3}[ ]+([A-Z]{4})[ ]?/)
+                # >>> DATA
+                commandtxt = cv[1]
+
+              elsif cv = e.match(/\A[<]{3}[ ]+(.+)\z/)
+                # <<< Response
+                esmtpreply << cv[1] unless esmtpreply.index(cv[1])
+              else
+                # Detect SMTP session error or connection error
+                next if sessionerr
+                if e.start_with?(StartingOf[:error][0])
+                  # ----- Transcript of session follows -----
+                  # ... while talking to mta.example.org.:
+                  sessionerr = true
+                  next
+                end
+
+                if cv = e.match(/\A[<](.+)[>][.]+ (.+)\z/)
+                  # <kijitora@example.co.jp>... Deferred: Name server: example.co.jp.: host name lookup failure
+                  anotherset['recipient'] = cv[1]
+                  anotherset['diagnosis'] = cv[2]
+                else
+                  # ----- Transcript of session follows -----
+                  # Message could not be delivered for too long
+                  # Message will be deleted from queue
+                  next if e =~ /\A[ \t]*[-]+/
+                  if cv = e.match(/\A[45]\d\d[ \t]([45][.]\d[.]\d)[ \t].+/)
+                    # 550 5.1.2 <kijitora@example.org>... Message
+                    #
+                    # DBI connect('dbname=...')
+                    # 554 5.3.0 unknown mailer error 255
+                    anotherset['status'] = cv[1]
+                    anotherset['diagnosis'] ||= ''
+                    anotherset['diagnosis'] << ' ' << e
+
+                  elsif e.start_with?('Message ', 'Warning: ')
+                    # Message could not be delivered for too long
+                    # Warning: message still undelivered after 4 hours
+                    anotherset['diagnosis'] ||= ''
+                    anotherset['diagnosis'] << ' ' << e
+                  end
+                end
+              end
+            else
+              # Continued line of the value of Diagnostic-Code field
+              next unless readslices[-2].start_with?('Diagnostic-Code:')
+              next unless cv = e.match(/\A[ \t]+(.+)\z/)
+              v['diagnosis'] << ' ' << cv[1]
+              readslices[-1] = 'Diagnostic-Code: ' << e
+            end
+          end
+        end # End of message/delivery-status
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          # Set default values if each value is empty.
+          e['lhost'] ||= permessage['rhost']
+          permessage.each_key { |a| e[a] ||= permessage[a] || '' }
+
+          e['command'] ||= commandtxt
+          if e['command'].empty?
+            e['command'] = 'EHLO' unless esmtpreply.empty?
+          end
+
+          if anotherset['diagnosis']
+            # Copy alternative error message
+            e['diagnosis'] = anotherset['diagnosis'] if e['diagnosis'] =~ /\A[ \t]+\z/
+            e['diagnosis'] = anotherset['diagnosis'] unless e['diagnosis']
+            e['diagnosis'] = anotherset['diagnosis'] if e['diagnosis'] =~ /\A\d+\z/
+          end
+          unless esmtpreply.empty?
+            # Replace the error message in "diagnosis" with the ESMTP Reply
+            r = esmtpreply.join(' ')
+            e['diagnosis'] = r if r.size > e['diagnosis'].to_s.size
+          end
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+
+          if anotherset['status']
+            # Check alternative status code
+            if e['status'].empty? || e['status'] !~ /\A[45][.]\d[.]\d\z/
+              # Override alternative status code
+              e['status'] = anotherset['status']
+            end
+          end
+
+          unless e['recipient'] =~ /\A[^ ]+[@][^ ]+\z/
+            # @example.jp, no local part
+            if cv = e['diagnosis'].match(/[<]([^ ]+[@][^ ]+)[>]/)
+              # Get email address from the value of Diagnostic-Code header
+              e['recipient'] = cv[1]
+            end
+          end
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'V8Sendmail: /usr/sbin/sendmail'; end
+    end
+  end
+end

data/lib/sisimai/lhost/surfcontrol.rb

@@ -0,0 +1,105 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::SurfControl parses a bounce email which created by
+  # WebSense SurfControl.
+  # Methods in the module are called from only Sisimai::Message.
+  module SurfControl
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/SurfControl.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Content-Type:[ ]message/rfc822|.freeze
+      StartingOf = { message: ['Your message could not be sent.'] }.freeze
+
+      # Parse bounce messages from SurfControl
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
+      def make(mhead, mbody)
+        # X-SEF-ZeroHour-RefID: fgs=000000000
+        # X-SEF-Processed: 0_0_0_000__2010_04_29_23_34_45
+        # X-Mailer: SurfControl E-mail Filter
+        return nil unless mhead['x-sef-processed']
+        return nil unless mhead['x-mailer']
+        return nil unless mhead['x-mailer'] == 'SurfControl E-mail Filter'
+
+        require 'sisimai/rfc1894'
+        fieldtable = Sisimai::RFC1894.FIELDTABLE
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
+        bodyslices = emailsteak[0].split("\n")
+        readslices = ['']
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        v = nil
+
+        while e = bodyslices.shift do
+          # Read error messages and delivery status lines from the head of the email
+          # to the previous line of the beginning of the original message.
+          readslices << e # Save the current line for the next loop
+
+          if readcursor == 0
+            # Beginning of the bounce message or delivery status part
+            readcursor |= Indicators[:deliverystatus] if e == StartingOf[:message][0]
+            next
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          # Your message could not be sent.
+          # A transcript of the attempts to send the message follows.
+          # The number of attempts made: 1
+          # Addressed To: kijitora@example.com
+          #
+          # Thu 29 Apr 2010 23:34:45 +0900
+          # Failed to send to identified host,
+          # kijitora@example.com: [192.0.2.5], 550 kijitora@example.com... No such user
+          # --- Message non-deliverable.
+          v = dscontents[-1]
+
+          if cv = e.match(/\AAddressed To:[ ]*([^ ]+?[@][^ ]+?)\z/)
+            # Addressed To: kijitora@example.com
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Lhost.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+            v['recipient'] = cv[1]
+            recipients += 1
+
+          elsif e =~ /\A(?:Sun|Mon|Tue|Wed|Thu|Fri|Sat)[ ,]/
+            # Thu 29 Apr 2010 23:34:45 +0900
+            v['date'] = e
+
+          elsif cv = e.match(/\A[^ ]+[@][^ ]+:[ ]*\[(\d+[.]\d+[.]\d+[.]\d)\],[ ]*(.+)\z/)
+            # kijitora@example.com: [192.0.2.5], 550 kijitora@example.com... No such user
+            v['rhost'] = cv[1]
+            v['diagnosis'] = cv[2]
+          else
+            # Fallback, parse RFC3464 headers.
+            if f = Sisimai::RFC1894.match(e)
+              # "e" matched with any field defined in RFC3464
+              next unless o = Sisimai::RFC1894.field(e)
+              next if o[1] == 'final-recipient'
+              next unless fieldtable[o[0]]
+              v[fieldtable[o[0]]] = o[2]
+            else
+              # Continued line of the value of Diagnostic-Code field
+              next unless readslices[-2].start_with?('Diagnostic-Code:')
+              next unless cv = e.match(/\A[ \t]+(.+)\z/)
+              v['diagnosis'] << ' ' << cv[1]
+              readslices[-1] = 'Diagnostic-Code: ' << e
+            end
+          end
+        end
+        return nil unless recipients > 0
+
+        dscontents.each { |e| e['diagnosis'] = Sisimai::String.sweep(e['diagnosis']) }
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'WebSense SurfControl'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/v5sendmail.rb

@@ -0,0 +1,150 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::V5sendmail parses a bounce email which created by
+  # Sendmail version 5.
+  # Methods in the module are called from only Sisimai::Message.
+  module V5sendmail
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/V5sendmail.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r/^[ ]+-----[ ](?:Unsent[ ]message[ ]follows|No[ ]message[ ]was[ ]collected)[ ]-----/.freeze
+      StartingOf = { message: ['----- Transcript of session follows -----'] }
+      MarkingsOf = {
+        # Error text regular expressions which defined in src/savemail.c
+        #   savemail.c:485| (void) fflush(stdout);
+        #   savemail.c:486| p = queuename(e->e_parent, 'x');
+        #   savemail.c:487| if ((xfile = fopen(p, "r")) == NULL)
+        #   savemail.c:488| {
+        #   savemail.c:489|   syserr("Cannot open %s", p);
+        #   savemail.c:490|   fprintf(fp, "  ----- Transcript of session is unavailable -----\n");
+        #   savemail.c:491| }
+        #   savemail.c:492| else
+        #   savemail.c:493| {
+        #   savemail.c:494|   fprintf(fp, "   ----- Transcript of session follows -----\n");
+        #   savemail.c:495|   if (e->e_xfp != NULL)
+        #   savemail.c:496|       (void) fflush(e->e_xfp);
+        #   savemail.c:497|   while (fgets(buf, sizeof buf, xfile) != NULL)
+        #   savemail.c:498|       putline(buf, fp, m);
+        #   savemail.c:499|   (void) fclose(xfile);
+        error:   %r/\A[.]+ while talking to .+[:]\z/,
+      }.freeze
+
+      # Parse bounce messages from Sendmail version 5
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
+      def make(mhead, mbody)
+        # :from => %r/\AMail Delivery Subsystem/,
+        return nil unless mhead['subject'] =~ /\AReturned mail: [A-Z]/
+
+        emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
+        return nil if emailsteak[1].empty?
+
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        bodyslices = emailsteak[0].split("\n")
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        responding = []     # (Array) Responses from remote server
+        commandset = []     # (Array) SMTP command which is sent to remote server
+        anotherset = {}     # (Hash) Another error information
+        errorindex = -1     # (Integer)
+        v = nil
+
+        while e = bodyslices.shift do
+          # Read error messages and delivery status lines from the head of the email
+          # to the previous line of the beginning of the original message.
+          if readcursor == 0
+            # Beginning of the bounce message or delivery status part
+            readcursor |= Indicators[:deliverystatus] if e.include?(StartingOf[:message][0])
+            next
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          #    ----- Transcript of session follows -----
+          # While talking to smtp.example.com:
+          # >>> RCPT To:<kijitora@example.org>
+          # <<< 550 <kijitora@example.org>, User Unknown
+          # 550 <kijitora@example.org>... User unknown
+          # 421 example.org (smtp)... Deferred: Connection timed out during user open with example.org
+          v = dscontents[-1]
+
+          if cv = e.match(/\A\d{3}[ ]+[<]([^ ]+[@][^ ]+)[>][.]{3}[ ]*(.+)\z/)
+            # 550 <kijitora@example.org>... User unknown
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Lhost.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+            v['recipient'] = cv[1]
+            v['diagnosis'] = cv[2]
+
+            # Concatenate the response of the server and error message
+            v['diagnosis'] << ': ' << responding[recipients] if responding[recipients]
+            recipients += 1
+
+          elsif cv = e.match(/\A[>]{3}[ ]*([A-Z]{4})[ ]*/)
+            # >>> RCPT To:<kijitora@example.org>
+            commandset[recipients] = cv[1]
+
+          elsif cv = e.match(/\A[<]{3}[ ]+(.+)\z/)
+            # <<< Response
+            # <<< 501 <shironeko@example.co.jp>... no access from mail server [192.0.2.55] which is an open relay.
+            # <<< 550 Requested User Mailbox not found. No such user here.
+            responding[recipients] = cv[1]
+          else
+            # Detect SMTP session error or connection error
+            next if v['sessionerr']
+
+            if e =~ MarkingsOf[:error]
+              # ----- Transcript of session follows -----
+              # ... while talking to mta.example.org.:
+              v['sessionerr'] = true
+              next
+            end
+
+            if cv = e.match(/\A\d{3}[ ]+.+[.]{3}[ \t]*(.+)\z/)
+              # 421 example.org (smtp)... Deferred: Connection timed out during user open with example.org
+              anotherset['diagnosis'] = cv[1]
+            end
+          end
+        end
+
+        if recipients == 0 && cv = emailsteak[1].match(/^To:[ ]*(.+)$/)
+          # Get the recipient address from "To:" header at the original message
+          dscontents[0]['recipient'] = Sisimai::Address.s3s4(cv[1])
+          recipients = 1
+        end
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          errorindex += 1
+          e['command'] = commandset[errorindex] || ''
+          e['diagnosis'] ||= if anotherset['diagnosis'].to_s.size > 0
+                               # Copy alternative error message
+                               anotherset['diagnosis']
+                             else
+                               # Set server response as a error message
+                               responding[errorindex]
+                             end
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+
+          unless e['recipient'] =~ /\A[^ ]+[@][^ ]+\z/
+            # @example.jp, no local part
+            if cv = e['diagnosis'].match(/[<]([^ ]+[@][^ ]+)[>]/)
+              # Get email address from the value of Diagnostic-Code header
+              e['recipient'] = cv[1]
+            end
+          end
+          e.delete('sessionerr')
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Sendmail version 5'; end
+    end
+  end
+end
+