sisimai 4.25.16 → 5.0.0

data/lib/sisimai/rfc3834.rb

@@ -1,67 +1,65 @@
 module Sisimai
   # Sisimai::RFC3834 - RFC3834 auto reply message detector
   module RFC3834
-    # Imported from p5-Sisimail/lib/Sisimai/RFC3834.pm
     class << self
       # http://tools.ietf.org/html/rfc3834
-      MarkingsOf = { :boundary => %r/\A__SISIMAI_PSEUDO_BOUNDARY__\z/ }
-      AutoReply1 = {
-        # http://www.iana.org/assignments/auto-submitted-keywords/auto-submitted-keywords.xhtml
-        'auto-submitted' => %r/\Aauto-(?:generated|replied|notified)/,
-        'x-apple-action' => %r/\Avacation\z/,
-        'precedence' => %r/\Aauto_reply\z/,
-        'subject' => %r/\A(?>
-             auto:
-            |auto[ ]response:
-            |automatic[ ]reply:
-            |out[ ]of[ ](?:the[ ])*office:
-          )
-        /x,
+      MarkingsOf = { :boundary => '__SISIMAI_PSEUDO_BOUNDARY__' }
+      LowerLabel = %w[from to subject auto-submitted precedence x-apple-action].freeze
+      DoNotParse = {
+        'from'    => ['root@', 'postmaster@', 'mailer-daemon@'],
+        'to'      => ['root@'],
+        'subject' => [
+            'security information for', # sudo(1)
+            'mail failure -',           # Exim
+        ],
       }.freeze
-      Excludings = {
-        'subject' => %r/(?:
-             security[ ]information[ ]for  # sudo
-            |mail[ ]failure[ ][-]          # Exim
-            )
-        /x,
-        'from' => %r/(?:root|postmaster|mailer-daemon)[@]/,
-        'to'   => %r/root[@]/,
+      AutoReply0 = {
+        # http://www.iana.org/assignments/auto-submitted-keywords/auto-submitted-keywords.xhtml
+        'auto-submitted' => ['auto-generated', 'auto-replied', 'auto-notified'],
+        'precedence'     => ['auto_reply'],
+        'subject'        => ['auto:', 'auto response:', 'automatic reply:', 'out of office:', 'out of the office:'],
+        'x-apple-action' => ['vacation'],
       }.freeze
       SubjectSet = %r{\A(?>
-         (?:.+?)?Re:
-        |Auto(?:[ ]Response):
-        |Automatic[ ]reply:
-        |Out[ ]of[ ]Office:
+         (?:.+?)?re:
+        |auto(?:[ ]response):
+        |automatic[ ]reply:
+        |out[ ]of[ ]office:
         )
         [ ]*(.+)\z
-      }xi.freeze
+      }x.freeze
 
       # Detect auto reply message as RFC3834
       # @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)
+      def inquire(mhead, mbody)
         leave = 0
         match = 0
+        lower = {} 
+
+        LowerLabel.each do |e|
+          # Set lower-cased value of each header related to auto-response
+          next unless mhead.has_key?(e)
+          lower[e] = mhead[e].downcase
+        end
 
         # DETECT_EXCLUSION_MESSAGE
-        Excludings.each_key do |e|
+        DoNotParse.each_key do |e|
           # Exclude message from root@
-          next unless mhead[e]
-          next unless mhead[e]
-          next unless mhead[e].downcase =~ Excludings[e]
+          next unless lower[e]
+          next unless DoNotParse[e].any? { |a| lower[e].include?(a) }
           leave = 1
           break
         end
         return nil if leave > 0
 
-        # DETECT_AUTO_REPLY_MESSAGE
-        AutoReply1.each_key do |e|
+        # DETECT_AUTO_REPLY_MESSAGE0
+        AutoReply0.each_key do |e|
           # RFC3834 Auto-Submitted and other headers
-          next unless mhead[e]
-          next unless mhead[e]
-          next unless mhead[e].downcase =~ AutoReply1[e]
+          next unless lower[e]
+          next unless AutoReply0[e].any? { |a| lower[e].include?(a) }
           match += 1
           break
         end
@@ -95,16 +93,15 @@ module Sisimai
         return nil unless recipients > 0
 
         if mhead['content-type']
-          # Get the boundary string and set regular expression for matching with
-          # the boundary string.
-          b0 = Sisimai::MIME.boundary(mhead['content-type'], 0) || ''
-          MarkingsOf[:boundary] = %r/\A\Q#{b0}\E\z/ unless b0.empty?
+          # Get the boundary string and set regular expression for matching with the boundary string.
+          q = Sisimai::RFC2045.boundary(mhead['content-type'], 0) || ''
+          MarkingsOf[:boundary] = q unless q.empty?
         end
 
         # BODY_PARSER: Get vacation message
         while e = bodyslices.shift do
           # Read the first 5 lines except a blank line
-          countuntil += 1 if e =~ MarkingsOf[:boundary]
+          countuntil += 1 if e.include?(MarkingsOf[:boundary])
 
           if e.empty?
             # Check a blank line
@@ -113,8 +110,8 @@ module Sisimai
             next
           end
           next unless e.include?(' ')
-          next if e.start_with?('Content-Type')
-          next if e.start_with?('Content-Transfer')
+          next if     e.start_with?('Content-Type')
+          next if     e.start_with?('Content-Transfer')
 
           v['diagnosis'] ||= ''
           v['diagnosis']  << e + ' '
@@ -127,7 +124,7 @@ module Sisimai
         v['date']      = mhead['date']
         v['status']    = ''
 
-        if cv = mhead['subject'].match(SubjectSet)
+        if cv = lower['subject'].match(SubjectSet)
           # Get the Subject header from the original message
           rfc822part = 'Subject: ' << cv[1] + "\n"
         end

data/lib/sisimai/rfc5322.rb

@@ -1,8 +1,8 @@
 module Sisimai
   # Sisimai::RFC5322 provide methods for checking email address.
   module RFC5322
-    # Imported from p5-Sisimail/lib/Sisimai/RFC5322.pm
     class << self
+      require 'sisimai/string'
       HeaderTable = {
         :messageid => %w[message-id],
         :subject   => %w[subject],
@@ -12,46 +12,26 @@ module Sisimai
         :recipient => %w[to delivered-to forward-path envelope-to x-envelope-to resent-to apparently-to],
       }.freeze
 
-      build_regular_expressions = lambda do
-        # See http://www.ietf.org/rfc/rfc5322.txt
-        #  or http://www.ex-parrot.com/pdw/Mail-RFC822-Address.html ...
-        #   addr-spec       = local-part "@" domain
-        #   local-part      = dot-atom / quoted-string / obs-local-part
-        #   domain          = dot-atom / domain-literal / obs-domain
-        #   domain-literal  = [CFWS] "[" *([FWS] dcontent) [FWS] "]" [CFWS]
-        #   dcontent        = dtext / quoted-pair
-        #   dtext           = NO-WS-CTL /     ; Non white space controls
-        #                     %d33-90 /       ; The rest of the US-ASCII
-        #                     %d94-126        ;  characters not including "[",
-        #                                     ;  "]", or "\"
-        re             = { rfc5322: nil, ignored: nil, domain: nil }
-        atom           = %r([a-zA-Z0-9_!#\$\%&'*+/=?\^`{}~|\-]+)o
-        quoted_string  = %r/"(?:\\[^\r\n]|[^\\"])*"/o
-        domain_literal = %r/\[(?:\\[\x01-\x09\x0B-\x0c\x0e-\x7f]|[\x21-\x5a\x5e-\x7e])*\]/o
-        dot_atom       = %r/#{atom}(?:[.]#{atom})*/o
-        local_part     = %r/(?:#{dot_atom}|#{quoted_string})/o
-        domain         = %r/(?:#{dot_atom}|#{domain_literal})/o
-
-        re[:rfc5322]   = %r/\A#{local_part}[@]#{domain}\z/o
-        re[:ignored]   = %r/\A#{local_part}[.]*[@]#{domain}\z/o
-        re[:domain]    = %r/\A#{domain}\z/o
-
-        return re
-      end
-
       build_flatten_rfc822header_list = lambda do
-        # Convert HEADER: structured hash table to flatten hash table for being
-        # called from Sisimai::Lhost::*
+        # Convert HEADER: structured hash table to flatten hash table for being called from Sisimai::Lhost::*
         fv = {}
         HeaderTable.each_value do |e|
           e.each { |ee| fv[ee] = true }
         end
         return fv
       end
-
-      Re          = build_regular_expressions.call
       HeaderIndex = build_flatten_rfc822header_list.call
 
+      def FIELDINDEX
+        return %w[
+          Resent-Date From Sender Reply-To To Message-ID Subject Return-Path Received Date X-Mailer
+          Content-Type Content-Transfer-Encoding Content-Description Content-Disposition
+        ]
+        # The following fields are not referred in Sisimai
+        #   Resent-From Resent-Sender Resent-Cc Cc Bcc Resent-Bcc In-Reply-To References
+        #   Comments Keywords
+      end
+
       # Grouped RFC822 headers
       # @param    [Symbol] group  RFC822 Header group name
       # @return   [Array,Hash]    RFC822 Header list
@@ -67,66 +47,37 @@ module Sisimai
         return { 'to' => true, 'from' => true, 'subject' => true, 'message-id' => true }
       end
 
-      # Check that the argument is an email address or not
-      # @param    [String] email  Email address string
-      # @return   [True,False]    true: is an email address
-      #                           false: is not an email address
-      def is_emailaddress(email)
-        return false unless email.is_a?(::String)
-        return false if email =~ %r/(?:[\x00-\x1f]|\x1f)/
-        return false if email.size > 254
-        return true  if email =~ Re[:ignored]
-        return false
-      end
-
-      # Check that the argument is mailer-daemon or not
-      # @param    [String] email  Email address
-      # @return   [True,False]    true: mailer-daemon
-      #                           false: Not mailer-daemon
-      def is_mailerdaemon(email)
-        return false unless email.is_a?(::String)
-        regex = %r/(?:
-           (?:mailer-daemon|postmaster)[@]
-          |[<(](?:mailer-daemon|postmaster)[)>]
-          |\A(?:mailer-daemon|postmaster)\z
-          |[ ]?mailer-daemon[ ]
-          )
-        /x.freeze
-        return true if email.downcase =~ regex
-        return false
-      end
-
       # Convert Received headers to a structured data
-      # @param    [String] argvs  Received header
+      # @param    [String] argv1  Received header
       # @return   [Array]         Received header as a structured data
-      def received(argvs)
-        return [] unless argvs.is_a?(::String)
+      def received(argv1)
+        return [] unless argv1.is_a?(::String)
 
         hosts = []
         value = { 'from' => '', 'by' => '' }
 
         # Received: (qmail 10000 invoked by uid 999); 24 Apr 2013 00:00:00 +0900
-        return [] if argvs =~ /qmail[ ]+.+invoked[ ]+/
+        return [] if argv1.include?('(qmail ') && argv1.include?(' invoked ')
+
+        p1 = argv1.index('from ')     || -1
+        p2 = argv1.index('by ')       || -1
+        p3 = argv1.index(' ', p2 + 3) || -1
 
-        if cr = argvs.match(/\Afrom[ ]+(.+)[ ]+by[ ]+([^ ]+)/)
-          # Received: from localhost (localhost)
-          #   by nijo.example.jp (V8/cf) id s1QB5ma0018057;
+        if p1 == 0 && p2 > 1 && p2 < p3
+          # Received: from localhost (localhost) by nijo.example.jp (V8/cf) id s1QB5ma0018057;
           #   Wed, 26 Feb 2014 06:05:48 -0500
-          value['from'] = cr[1]
-          value['by']   = cr[2]
-
-        elsif cr = argvs.match(/\bby[ ]+([^ ]+)(.+)/)
-          # Received: by 10.70.22.98 with SMTP id c2mr1838265pdf.3; Fri, 18 Jul 2014
-          #   00:31:02 -0700 (PDT)
-          value['from'] = cr[1] + cr[2]
-          value['by']   = cr[1]
+          value['from'] = Sisimai::String.sweep(argv1[p1 + 5, p2 - p1 - 5])
+          value['by']   = Sisimai::String.sweep(argv1[p2 + 3, p3 - p2 - 3])
+
+        elsif p1 != 0 && p2 > -1
+          # Received: by 10.70.22.98 with SMTP id c2mr1838265pdf.3; Fri, 18 Jul 2014 00:31:02 -0700 (PDT)
+          value['from'] = Sisimai::String.sweep(argv1[p2 + 3, argv1.size])
+          value['by']   = Sisimai::String.sweep(argv1[p2 + 3, p3 - p2 - 3])
         end
 
         if value['from'].include?(' ')
-          # Received: from [10.22.22.222] (smtp-gateway.kyoto.ocn.ne.jp [192.0.2.222])
-          #   (authenticated bits=0)
-          #   by nijo.example.jp (V8/cf) with ESMTP id s1QB5ka0018055;
-          #   Wed, 26 Feb 2014 06:05:47 -0500
+          # Received: from [10.22.22.222] (smtp.kyoto.ocn.ne.jp [192.0.2.222]) (authenticated bits=0)
+          #   by nijo.example.jp (V8/cf) with ESMTP id s1QB5ka0018055; Wed, 26 Feb 2014 06:05:47 -0500
           received = value['from'].split(' ')
           namelist = []
           addrlist = []
@@ -135,13 +86,13 @@ module Sisimai
 
           while e = received.shift do
             # Received: from [10.22.22.222] (smtp-gateway.kyoto.ocn.ne.jp [192.0.2.222])
-            if e =~ /\A[\[(]\d+[.]\d+[.]\d+[.]\d+[)\]]\z/
+            cv = Sisimai::String.ipv4(e) || []
+            if cv.size > 0
               # [192.0.2.1] or (192.0.2.1)
-              e = e.delete('[]()')
-              addrlist << e
+              addrlist.append(*cv)
             else
               # hostname
-              e = e.delete('()')
+              e = e.delete('()').strip
               namelist << e
             end
           end
@@ -176,31 +127,55 @@ module Sisimai
         return hosts
       end
 
-      # Split given entire message body into error message lines and the original
-      # message part only include email headers
-      # @param    [String] mbody  Entire message body
-      # @param    [Regexp] regex  Regular expression of the message/rfc822 or the
-      #                           beginning of the original message part
+      # Split given entire message body into error message lines and the original message part only
+      # include email headers
+      # @param    [String] email  Entire message body
+      # @param    [Array]  cutby  List of strings which is a boundary of the original message part
+      # @param    [Bool]   keeps  Flag for keeping strings after "\n\n"
       # @return   [Array]         [Error message lines, The original message]
-      # @since    v4.25.5
-      def fillet(mbody = '', regex)
-        return nil if mbody.empty?
-        return nil unless regex
+      # @since    v5.0.0
+      def part(email = '', cutby = [], keeps = false)
+        return nil if email.empty?
+        return nil if cutby.empty?
+
+        boundaryor = ''   # A boundary string divides the error message part and the original message part
+        positionor = nil  # A Position of the boundary string
+        formerpart = ''   # The error message part
+        latterpart = ''   # The original message part
+
+        cutby.each do |e|
+          # Find a boundary string(2nd argument) from the 1st argument
+          positionor = email.index(e); next unless positionor
+          boundaryor = e
+          break
+        end
 
-        v = mbody.split(regex, 2)
-        v[1] ||= ''
+        if positionor
+          # There is the boundary string in the message body
+          formerpart = email[0, positionor]
+          latterpart = email[positionor + boundaryor.size + 1, email.size - positionor]
+        else
+          # Substitute the entire message to the former part when the boundary string is not included
+          # the "email"
+          formerpart = email
+          latterpart = ''
+        end
 
-        unless v[1].empty?
+        if latterpart.size > 0
           # Remove blank lines, the message body of the original message, and append "\n" at the end
           # of the original message headers
           # 1. Remove leading blank lines
           # 2. Remove text after the first blank line: \n\n
           # 3. Append "\n" at the end of test block when the last character is not "\n"
-          v[1].sub!(/\A[\r\n\s]+/, '')
-          v[1] = v[1][0, v[1].index("\n\n")] if v[1].include?("\n\n")
-          v[1] << "\n" unless v[1].end_with?("\n")
+          latterpart.sub!(/\A[\r\n\s]+/, '')
+          if keeps == false
+            #  Remove text after the first blank line: \n\n when "keeps" is false
+            latterpart = latterpart[0, latterpart.index("\n\n")] if latterpart.include?("\n\n")
+          end
+          latterpart << "\n" unless latterpart.end_with?("\n")
         end
-        return v
+
+        return [formerpart, latterpart]
       end
 
     end

data/lib/sisimai/rfc5965.rb

@@ -0,0 +1,31 @@
+module Sisimai
+  # Sisimai::RFC5965 - A class for An Extensible Format for Email Feedback Reports
+  module RFC5965
+    class << self
+      # https://datatracker.ietf.org/doc/html/rfc5965
+      def FIELDINDEX
+        return [
+          # Required Fields
+          # The following report header fields MUST appear exactly once:
+          'Feedback-Type', 'User-Agent', 'Version',
+
+          # Optional Fields Appearing Once
+          # The following header fields are optional and MUST NOT appear more than once:
+          # - "Reporting-MTA" is defined in Sisimai::RFC1894->FIELDINDEX()
+          'Original-Envelope-Id', 'Original-Mail-From', 'Arrival-Date', 'Source-IP', 'Incidents',
+
+          # Optional Fields Appearing Multiple Times
+          # The following set of header fields are optional and may appear any number of times as
+          # appropriate:
+          'Authentication-Results', 'Original-Rcpt-To', 'Reported-Domain', 'Reported-URI',
+
+          # The historic field "Received-Date" SHOULD also be accepted and interpreted identically
+          # to "Arrival-Date".  However, if both are present, the report is malformed and SHOULD be
+          # treated as described in Section 4.
+          'Received-Date',
+        ]
+      end
+    end
+  end
+end
+

data/lib/sisimai/rhost/cox.rb

@@ -1,11 +1,10 @@
 module Sisimai
   module Rhost
-    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Data
-    # object as an argument of get() method when the value of "destination" of
-    # the object is "charter.net". This class is called only Sisimai::Data class.
+    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument
+    # of get() method when the value of "destination" of the object is "charter.net". This class is
+    # called only Sisimai::Fact class.
     module Cox
       class << self
-        # Imported from p5-Sisimail/lib/Sisimai/Rhost/Cox.pm
         ErrorCodes = {
           # https://www.cox.com/residential/support/email-error-codes.html
           'CXBL'      => 'blocked',       # The sending IP address has been blocked by Cox due to exhibiting spam-like behavior.
@@ -79,11 +78,11 @@ module Sisimai
         }.freeze
 
         # Detect bounce reason from https://cox.com/
-        # @param    [Sisimai::Data] argvs   Parsed email object
+        # @param    [Sisimai::Fact] argvs   Parsed email object
         # @return   [String, Nil]           The bounce reason at Cox
         # @since v4.25.8
         def get(argvs)
-          statusmesg = argvs.diagnosticcode
+          statusmesg = argvs['diagnosticcode']
           codenumber = 0
 
           if cv = statusmesg.match(/AUP#([0-9A-Z]+)/)

data/lib/sisimai/rhost/franceptt.rb

@@ -1,12 +1,10 @@
 module Sisimai
   module Rhost
-    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Data
-    # object as an argument of get() method when the value of "rhost" of the object
-    # is "*.laposte.net" or "*.orange.fr".
-    # This class is called only Sisimai::Data class.
+    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument
+    # of get() method when the value of "rhost" of the object is "*.laposte.net" or "*.orange.fr".
+    # This class is called only Sisimai::Fact class.
     module FrancePTT
       class << self
-        # Imported from p5-Sisimail/lib/Sisimai/Rhost/FrancePTT.pm
         ErrorCodes = {
           # 550 5.7.1 Service unavailable; client [X.X.X.X] blocked using Spamhaus
           # Les emails envoyes vers la messagerie Laposte.net ont ete bloques par nos services.
@@ -133,12 +131,12 @@ module Sisimai
         }.freeze
 
         # Detect bounce reason from Oranage or La Poste
-        # @param    [Sisimai::Data] argvs   Parsed email object
+        # @param    [Sisimai::Fact] argvs   Parsed email object
         # @return   [String]                The bounce reason for Orange or La Poste
         def get(argvs)
-          return argvs.reason unless argvs.reason.empty?
+          return argvs['reason'] unless argvs['reason'].empty?
 
-          statusmesg = argvs.diagnosticcode
+          statusmesg = argvs['diagnosticcode']
           reasontext = ''
 
           if cv = statusmesg.match(/\b(LPN|LPNAAA|OFR|OUK)(_[0-9]{3}|[0-9]{3}[-_][0-9]{3})\b/i)

data/lib/sisimai/rhost/godaddy.rb

@@ -1,14 +1,13 @@
 module Sisimai
   module Rhost
-    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Data
-    # object as an argument of get() method when the value of "rhost" of the object
-    # is "*.secureserver.net". This class is called only Sisimai::Data class.
+    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument
+    # of get() method when the value of "rhost" of the object is "*.secureserver.net". This class is
+    # called only Sisimai::Fact class.
     module GoDaddy
       class << self
-        # Imported from p5-Sisimail/lib/Sisimai/Rhost/GoDaddy.pm
         # https://www.godaddy.com/help/what-does-my-email-bounceback-mean-3568
         ErrorCodes = {
-          'IB103' => 'blocked',       # 554 Connection refused. This IP has a poor reputation on Cloudmark Sender Intelligence (CSI). IB103
+          'IB103' => 'badreputation', # 554 Connection refused. This IP has a poor reputation on Cloudmark Sender Intelligence (CSI). IB103
           'IB104' => 'blocked',       # 554 Connection refused. This IP is listed on the Spamhaus Block List (SBL). IB104
           'IB105' => 'blocked',       # 554 Connection refused. This IP is listed on the Exploits Block List (XBL). IB105
           'IB106' => 'blocked',       # 554 Connection refused. This IP is listed on the Policy Block List (PBL). IB106
@@ -39,19 +38,19 @@ module Sisimai
         }.freeze
 
         # Detect bounce reason from GoDaddy
-        # @param    [Sisimai::Data] argvs   Parsed email object
+        # @param    [Sisimai::Fact] argvs   Parsed email object
         # @return   [String]                The bounce reason for GoDaddy
         # @see      https://www.godaddy.com/help/what-does-my-email-bounceback-mean-3568
         def get(argvs)
-          return argvs.reason unless argvs.reason.empty?
+          return argvs['reason'] unless argvs['reason'].empty?
 
-          statusmesg = argvs.diagnosticcode
+          statusmesg = argvs['diagnosticcode']
+          positionib = statusmesg.index(' IB') || -1
           reasontext = ''
 
-          if cv = statusmesg.match(/\s(IB\d{3})\b/)
-            # 192.0.2.22 has sent to too many recipients this hour. IB607 ...
-            reasontext = ErrorCodes[cv[1]]
-          else
+          # 192.0.2.22 has sent to too many recipients this hour. IB607 ...
+          reasontext = ErrorCodes[statusmesg[positionib + 1, 5]] || '' if positionib > 1
+          if reasontext.empty?
             # 553 http://www.spamhaus.org/query/bl?ip=192.0.0.222
             MessagesOf.each_key do |e|
               MessagesOf[e].each do |f|
@@ -62,6 +61,7 @@ module Sisimai
               break unless reasontext.empty?
             end
           end
+
           return reasontext
         end