sisimai 4.21.1-java → 4.22.0-java

data/lib/sisimai/bite/email/surfcontrol.rb

@@ -0,0 +1,162 @@
+module Sisimai::Bite::Email
+  module SurfControl
+    # Sisimai::Bite::Email::SurfControl parses a bounce email which created by
+    # WebSense SurfControl.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/SurfControl.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :'from'     => %r/ [(]Mail Delivery System[)]\z/,
+        :'x-mailer' => %r/\ASurfControl E-mail Filter\z/,
+      }
+      Re1 = {
+        :begin  => %r/\AYour message could not be sent[.]\z/,
+        :error  => %r/\AFailed to send to identified host,\z/,
+        :rfc822 => %r|\AContent-Type: message/rfc822\z|,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'WebSense SurfControl'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      # 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
+      def headerlist;  return ['X-SEF-Processed', 'X-Mailer']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from SurfControl
+      # @param         [Hash] mhead       Message headers 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['x-sef-processed']
+        return nil unless mhead['x-mailer']
+        return nil unless mhead['x-mailer'] =~ Re0[:'x-mailer']
+
+        dscontents = [Sisimai::Bite.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
+        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?
+
+            # 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::Bite.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 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]
+
+              elsif p =~ /\A[Dd]iagnostic-[Cc]ode:[ ]*/ && cv = e.match(/\A[ ]+(.+)\z/)
+                # Continued line of the value of Diagnostic-Code header
+                v['diagnosis'] ||= ''
+                v['diagnosis']  += ' ' + cv[1]
+                havepassed[-1] = 'Diagnostic-Code: ' + e
+
+              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.0.-
+                v['status'] = cv[1]
+              end
+            end
+          end
+        end
+        return nil if recipients.zero?
+        require 'sisimai/string'
+
+        dscontents.map do |e|
+          e['agent']     = self.smtpagent
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+          e.each_key { |a| e[a] ||= '' }
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

data/lib/sisimai/bite/email/userdefined.rb

@@ -0,0 +1,129 @@
+module Sisimai::Bite::Email
+  module UserDefined
+    # Sisimai::Bite::Email::UserDefined is an example module as a template to
+    # implement your custom MTA module.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/UserDefined.pm
+      require 'sisimai/bite/email'
+
+      # Re0 is a regular expression to match with message headers which are
+      # given as the first argument of scan() method.
+      Re0 = {
+        :from    => %r/\AMail Sysmet/,
+        :subject => %r/\AError Mail Report/,
+      }
+
+      # Re1 is delimiter set of these sections:
+      #   begin:  The first line of a bounce message to be parsed.
+      #   error:  The first line of an error message to get an error reason, recipient
+      #           addresses, or other bounce information.
+      #   rfc822: The first line of the original message.
+      #   endof:  Fixed string ``__END_OF_EMAIL_MESSAGE__''
+      Re1 = {
+        :begin   => %r/\A[ \t]+[-]+ Transcript of session follows [-]+\z/,
+        :error   => %r/\A[.]+ while talking to .+[:]\z/,
+        :rfc822  => %r{\AContent-Type:[ ]*(?:message/rfc822|text/rfc822-headers)\z},
+        :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Module description'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return ['X-Some-UserDefined-Header']; end
+      def pattern;     return Re0; end
+
+      # @abstract Template for User-Defined MTA module
+      # @param         [Hash] mhead       Message headers 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
+
+        match = 0
+        # 1. Check some value in mhead using regular expression or "==" operator
+        #    whether the bounce message should be parsed by this module or not.
+        #   - Matched 1 or more values: Proceed to the step 2.
+        #   - Did not matched:          return nil
+        #
+        match += 1 if mhead['subject'] =~ Re0[:subject]
+        match += 1 if mhead['from']    =~ Re0[:from]
+        match += 1 if mhead['x-some-userdefined-header']
+        return nil if match.zero?
+
+        # 2. Parse message body(mbody) of the bounce message. See some modules
+        #    in lib/sisimai/bite/email directory to implement codes.
+        dscontents = [Sisimai::Bite.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
+
+        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?
+
+          end
+        end
+
+        # The following code is dummy to be passed "make test".
+        dscontents[0]['recipient'] = 'kijitora@example.jp'
+        dscontents[0]['diagnosis'] = '550 something wrong'
+        dscontents[0]['status']    = '5.1.1'
+        dscontents[0]['spec']      = 'SMTP'
+        dscontents[0]['date']      = 'Thu 29 Apr 2010 23:34:45 +0900'
+        dscontents[0]['agent']     = self.smtpagent
+        recipients = 1 if dscontents[0]['recipient']
+
+        rfc822list << 'From: shironeko@example.org'
+        rfc822list << 'Subject: Nyaaan'
+        rfc822list << 'Message-Id: 000000000000@example.jp'
+
+        # 3. Return undef when there is no recipient address which is failed to
+        #    delivery in the bounce message
+        return nil if recipients.zero?
+
+        # 4. Return the following variable.
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

data/lib/sisimai/bite/email/v5sendmail.rb

@@ -0,0 +1,208 @@
+module Sisimai::Bite::Email
+  module V5sendmail
+    # Sisimai::Bite::Email::V5sendmail parses a bounce email which created by
+    # Sendmail version 5.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/V5sendmail.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :from    => %r/\AMail Delivery Subsystem/,
+        :subject => %r/\AReturned mail: [A-Z]/,
+      }
+      # 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);
+      Re1 = {
+        :begin  => %r/\A[ \t]+[-]+ Transcript of session follows [-]+\z/,
+        :error  => %r/\A[.]+ while talking to .+[:]\z/,
+        :rfc822 => %r{\A[ \t]+-----[ ](?:
+           Unsent[ ]message[ ]follows
+          |No[ ]message[ ]was[ ]collected
+          )[ ]-----
+        }x,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Sendmail version 5'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return []; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Sendmail version 5
+      # @param         [Hash] mhead       Message headers 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::Bite.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
+        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
+
+        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?
+
+            #    ----- 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::Bite.DELIVERYSTATUS
+                v = dscontents[-1]
+              end
+              v['recipient'] = cv[1]
+              v['diagnosis'] = cv[2]
+
+              if responding[recipients]
+                # Concatenate the response of the server and error message
+                v['diagnosis'] ||= ''
+                v['diagnosis']  += ': ' + responding[recipients]
+              end
+              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 =~ Re1[: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
+        end
+        return nil if readcursor & Indicators[:'message-rfc822'] == 0
+
+        if recipients.zero?
+          # Get the recipient address from the original message
+          rfc822list.each do |e|
+            if cv = e.match(/^To: (.+)$/m)
+              # The value of To: header in the original message
+              dscontents[0]['recipient'] = Sisimai::Address.s3s4(cv[1])
+              recipients = 1
+              break
+            end
+          end
+        end
+        return nil if recipients.zero?
+        require 'sisimai/string'
+
+        dscontents.map do |e|
+          errorindex += 1
+          e['agent']   = self.smtpagent
+          e['command'] = commandset[errorindex] || ''
+
+          if anotherset['diagnosis'] && anotherset['diagnosis'].size > 0
+            # Copy alternative error message
+            e['diagnosis'] ||= anotherset['diagnosis']
+
+          else
+            # Set server response as a error message
+            e['diagnosis'] ||= 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')
+          e.each_key { |a| e[a] ||= '' }
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+