sisimai 4.25.3 → 4.25.8

data/lib/sisimai/address.rb

@@ -30,7 +30,7 @@ module Sisimai
     #           # => Sisimai::Address object
     def self.make(argvs)
       return nil unless argvs.is_a? Hash
-      return nil unless argvs.key?(:address)
+      return nil unless argvs[:address]
       return nil if argvs[:address].empty?
 
       thing = Sisimai::Address.new(argvs[:address])
@@ -69,7 +69,7 @@ module Sisimai
 
       while e = characters.shift do
         # Check each characters
-        if Delimiters.key?(e)
+        if Delimiters[e]
           # The character is a delimiter character
           if e == ','
             # Separator of email addresses or not
@@ -283,7 +283,7 @@ module Sisimai
     #   expand_verp('bounce+neko=example.org@example.org') #=> 'neko@example.org'
     def self.expand_verp(email)
       return nil unless email.is_a? Object::String
-      return nil unless cv = email.split('@', 2).first.match(/\A[-_\w]+?[+](\w[-._\w]+\w)[=](\w[-.\w]+\w)\z/)
+      return nil unless cv = email.split('@', 2).first.match(/\A[-\w]+?[+](\w[-.\w]+\w)[=](\w[-.\w]+\w)\z/)
       verp0 = cv[1] + '@' + cv[2]
       return verp0 if Sisimai::RFC5322.is_emailaddress(verp0)
     end
@@ -297,23 +297,19 @@ module Sisimai
       return nil unless Sisimai::RFC5322.is_emailaddress(email)
 
       local = email.split('@')
-      return nil unless cv = local[0].match(/\A([-_\w]+?)[+].+\z/)
+      return nil unless cv = local[0].match(/\A([-\w]+?)[+].+\z/)
       return cv[1] + '@' + local[1]
     end
 
-    @@roaccessors = [
-      :address, # [String] Email address
-      :user,    # [String] local part of the email address
-      :host,    # [String] domain part of the email address
-      :verp,    # [String] VERP
-      :alias,   # [String] alias of the email address
-    ]
-    @@rwaccessors = [
-      :name,    # [String] Display name
-      :comment, # [String] Comment
-    ]
-    @@roaccessors.each { |e| attr_reader   e }
-    @@rwaccessors.each { |e| attr_accessor e }
+    # :address, # [String] Email address
+    # :user,    # [String] local part of the email address
+    # :host,    # [String] domain part of the email address
+    # :verp,    # [String] VERP
+    # :alias,   # [String] alias of the email address
+    # :name,    # [String] Display name
+    # :comment, # [String] Comment
+    attr_reader   :address, :user, :host, :verp, :alias
+    attr_accessor :name, :comment
 
     # Constructor of Sisimai::Address
     # @param <str>  [String] argv1          Email address

data/lib/sisimai/arf.rb

@@ -3,7 +3,7 @@ module Sisimai
   module ARF
     # Imported from p5-Sisimail/lib/Sisimai/ARF.pm
     class << self
-      require 'sisimai/bite/email'
+      require 'sisimai/lhost'
       require 'sisimai/rfc5322'
 
       # http://tools.ietf.org/html/rfc5965
@@ -13,7 +13,7 @@ module Sisimai
       # Netease DMARC uses:    This is a spf/dkim authentication-failure report for an email message received from IP
       # OpenDMARC 1.3.0 uses:  This is an authentication failure report for an email message received from IP
       # Abusix ARF uses        this is an autogenerated email abuse complaint regarding your network.
-      Indicators = Sisimai::Bite::Email.INDICATORS
+      Indicators = Sisimai::Lhost.INDICATORS
       StartingOf = { rfc822: ['Content-Type: message/rfc822', 'Content-Type: text/rfc822-headers'] }.freeze
       MarkingsOf = {
         message: %r{\A(?>
@@ -26,12 +26,11 @@ module Sisimai
           )
         }x,
       }.freeze
+      ReportFrom = /(?:staff[@]hotmail[.]com|complaints[@]email-abuse[.]amazonses[.]com)\z/.freeze
       LongFields = Sisimai::RFC5322.LONGFIELDS
       RFC822Head = Sisimai::RFC5322.HEADERFIELDS
 
       def description; return 'Abuse Feedback Reporting Format'; end
-      def smtpagent;   return 'FeedBack-Loop'; end
-      def headerlist;  return []; end
 
       # Email is a Feedback-Loop message or not
       # @param    [Hash] heads    Email header including "Content-Type", "From",
@@ -49,13 +48,8 @@ module Sisimai
         elsif heads['content-type'].start_with?('multipart/mixed')
           # Microsoft (Hotmail, MSN, Live, Outlook) uses its own report format.
           # Amazon SES Complaints bounces
-          hfrom = Sisimai::Address.s3s4(heads['from'])
-          mfrom = %r{(?:
-             staff[@]hotmail[.]com
-            |complaints[@]email-abuse[.]amazonses[.]com
-            )\z
-          }x
-          if hfrom =~ mfrom && heads['subject'].include?('complaint about message from ')
+          p = Sisimai::Address.s3s4(heads['from'])
+          if p =~ ReportFrom && heads['subject'].include?('complaint about message from ')
             # From: staff@hotmail.com
             # From: complaints@email-abuse.amazonses.com
             # Subject: complaint about message from 192.0.2.1
@@ -66,21 +60,15 @@ module Sisimai
       end
 
       # Detect an error for Feedback Loop
-      # @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)
+      # @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 self.is_arf(mhead)
 
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
-        hasdivided = mbody.split("\n")
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        bodyslices = mbody.split("\n")
         rfc822part = ''   # (String) message/rfc822-headers part
         previousfn = ''   # (String) Previous field name
         readcursor = 0    # (Integer) Points the current cursor position
@@ -120,7 +108,7 @@ module Sisimai
         #      generator is using to generate the report.  The version number in
         #      this specification is set to "1".
         #
-        while e = hasdivided.shift do
+        while e = bodyslices.shift do
           if readcursor == 0
             # Beginning of the bounce message or message/delivery-status part
             if e =~ MarkingsOf[:message]
@@ -153,11 +141,18 @@ module Sisimai
             elsif cv = e.match(/\AFrom:[ ]*(.+)\z/)
               # Microsoft ARF: original sender.
               commondata['from'] = Sisimai::Address.s3s4(cv[1]) if commondata['from'].empty?
+              previousfn = 'from'
 
             elsif e.start_with?(' ', "\t")
               # Continued line from the previous line
-              rfc822part << e + "\n" if LongFields.key?(previousfn)
-              next unless e.empty?
+              if previousfn == 'from'
+                # Multiple lines at "From:" field
+                commondata['from'] << e
+                next
+              else
+                rfc822part << e + "\n" if LongFields[previousfn]
+                next unless e.empty?
+              end
               rcptintext << e if previousfn == 'to'
 
             else
@@ -167,7 +162,7 @@ module Sisimai
               lhs.downcase!
 
               previousfn = ''
-              next unless RFC822Head.key?(lhs)
+              next unless RFC822Head[lhs]
 
               previousfn  = lhs
               rfc822part << e + "\n"
@@ -195,7 +190,7 @@ module Sisimai
               # Redacted-Address: localpart@
               if v['recipient']
                 # There are multiple recipient addresses in the message body.
-                dscontents << Sisimai::Bite.DELIVERYSTATUS
+                dscontents << Sisimai::Lhost.DELIVERYSTATUS
                 v = dscontents[-1]
               end
               v['recipient'] = Sisimai::Address.s3s4(cv[1])
@@ -278,7 +273,7 @@ module Sisimai
         if cv = mhead['subject'].match(/complaint about message from (\d{1,3}[.]\d{1,3}[.]\d{1,3}[.]\d{1,3})/)
           # Microsoft ARF: remote host address.
           arfheaders['rhost'] = cv[1]
-          commondata['diagnosis'] = 
+          commondata['diagnosis'] =
             'This is a Microsoft email abuse report for an email message received from IP' << arfheaders['rhost'] + ' on ' << mhead['date']
         end
 
@@ -294,7 +289,7 @@ module Sisimai
           e['diagnosis']  = commondata['diagnosis'] unless e['diagnosis']
           e['date']       = mhead['date'] if e['date'].empty?
           e['reason']     = 'feedback'
-          e['agent']      = self.smtpagent if e['agent'].empty?
+          e['agent']      = 'Feedback-Loop'
           %w[command action status alias].each { |a| e[a] = '' }
 
           # Get the remote IP address from the message body
@@ -308,7 +303,6 @@ module Sisimai
             # from IP address 24.64.1.1 on Thu, 29 Apr 2010 00:00:00 +0000
             e['rhost'] = cv[1]
           end
-
         end
         return { 'ds' => dscontents, 'rfc822' => rfc822part }
       end

data/lib/sisimai/data.rb

@@ -8,6 +8,7 @@ module Sisimai
     require 'sisimai/rhost'
     require 'sisimai/time'
     require 'sisimai/datetime'
+    require 'sisimai/smtp/error'
 
     @@rwaccessors = [
       :catch,           # [?] Results generated by hook method
@@ -18,6 +19,7 @@ module Sisimai
       :listid,          # [String] List-Id header of each ML
       :reason,          # [String] Bounce reason
       :action,          # [String] The value of Action: header
+      :origin,          # [String] Email path as a data source
       :subject,         # [String] UTF-8 Subject text
       :timestamp,       # [Sisimai::Time] Date: header in the original message
       :addresser,       # [Sisimai::Address] From address
@@ -35,12 +37,10 @@ module Sisimai
       :deliverystatus,  # [String] Delivery Status(DSN)
       :timezoneoffset,  # [Integer] Time zone offset(seconds)
     ]
-    @@rwaccessors.each { |e| attr_accessor e }
+    attr_accessor(*@@rwaccessors)
 
-    EndOfEmail = Sisimai::String.EOM
     RetryIndex = Sisimai::Reason.retry
     RFC822Head = Sisimai::RFC5322.HEADERFIELDS(:all)
-    AddrHeader = { addresser: RFC822Head[:addresser], recipient: RFC822Head[:recipient] }.freeze
 
     # Constructor of Sisimai::Data
     # @param    [Hash] argvs    Data
@@ -77,6 +77,7 @@ module Sisimai
       @smtpcommand    = argvs['smtpcommand']    || ''
       @feedbacktype   = argvs['feedbacktype']   || ''
       @action         = argvs['action']         || ''
+      @origin         = argvs['origin']         || ''
       @replycode      = argvs['replycode']      || ''
       @replycode      = Sisimai::SMTP::Reply.find(argvs['diagnosticcode']).to_s if @replycode.empty?
       @softbounce     = argvs['softbounce']     || ''
@@ -94,35 +95,11 @@ module Sisimai
 
       messageobj = data
       rfc822data = messageobj.rfc822
-      fieldorder = { :recipient => [], :addresser => [] }
       objectlist = []
-      givenorder = argvs[:order] || {}
       delivered1 = argvs[:delivered] || false
 
       return nil unless messageobj.ds
       return nil unless messageobj.rfc822
-      require 'sisimai/smtp'
-
-      # Decide the order of email headers: user specified or system default.
-      if givenorder.is_a?(Hash) && !givenorder.empty?
-        # If the order of headers for searching is specified, use the order
-        # for detecting an email address.
-        fieldorder.each_key do |e|
-          # The order should be "Array Reference".
-          next unless givenorder[e]
-          next unless givenorder[e].is_a? Array
-          next if givenorder[e].empty?
-          fieldorder[e] += givenorder[e]
-        end
-      end
-
-      fieldorder.each_key do |e|
-        # If the order is empty, use default order.
-        next unless fieldorder[e].empty?
-
-        # Load default order of each accessor.
-        fieldorder[e] = AddrHeader[e]
-      end
 
       eachobject = messageobj.ds.dup
       while e = eachobject.shift do
@@ -151,9 +128,8 @@ module Sisimai
 
         # EMAIL_ADDRESS:
         # Detect email address from message/rfc822 part
-        fieldorder[:addresser].each do |f|
+        RFC822Head[:addresser].each do |f|
           # Check each header in message/rfc822 part
-          next unless rfc822data.key?(f)
           next unless rfc822data[f]
           next if rfc822data[f].empty?
 
@@ -236,7 +212,7 @@ module Sisimai
         # Subject: header of the original message
         p['subject'] = rfc822data['subject'] || ''
         p['subject'].scrub!('?')
-        p['subject'].chomp!("\r") if p['subject'].end_with?("\r");
+        p['subject'].chomp!("\r") if p['subject'].end_with?("\r")
 
         # The value of "List-Id" header
         p['listid'] = rfc822data['list-id'] || ''
@@ -258,8 +234,6 @@ module Sisimai
 
         # CHECK_DELIVERY_STATUS_VALUE:
         # Cleanup the value of "Diagnostic-Code:" header
-        p['diagnosticcode'].sub!(/[ \t.]+#{EndOfEmail}/, '')
-
         unless p['diagnosticcode'].empty?
           # Count the number of D.S.N. and SMTP Reply Code
           vs = Sisimai::SMTP::Status.find(p['diagnosticcode'])
@@ -297,6 +271,7 @@ module Sisimai
 
         # Check the value of SMTP command
         p['smtpcommand'] = '' unless %w[EHLO HELO MAIL RCPT DATA QUIT].include?(p['smtpcommand'])
+        p['origin'] = argvs[:origin]  # Set the path to the original email
 
         if p['action'].empty?
           # Check the value of "action"
@@ -312,12 +287,15 @@ module Sisimai
         o = Sisimai::Data.new(p)
         next unless o.recipient
 
-        if o.reason.empty? || RetryIndex.key?(o.reason)
+        if o.reason.empty? || RetryIndex[o.reason]
           # Decide the reason of email bounce
-          r = ''
-          r = Sisimai::Rhost.get(o) if Sisimai::Rhost.match(o.rhost) # Remote host dependent error
-          r = Sisimai::Reason.get(o) if r.empty?
-          r = 'undefined' if r.empty?
+          r = ''; r = Sisimai::Rhost.get(o) if Sisimai::Rhost.match(o.rhost)
+          if r.empty?
+            # Failed to detect a bounce reason by the value of "rhost"
+            r = Sisimai::Rhost.get(o, o.destination) if Sisimai::Rhost.match(o.destination)
+            r = Sisimai::Reason.get(o) if r.empty?
+            r = 'undefined' if r.empty?
+          end
           o.reason = r
         end
 
@@ -348,9 +326,8 @@ module Sisimai
             textasargv = (o.replycode + ' ' + p['diagnosticcode']).lstrip
             getchecked = Sisimai::SMTP::Error.is_permanent(textasargv)
             tmpfailure = getchecked.nil? ? false : (getchecked ? false : true)
-            pseudocode = Sisimai::SMTP::Status.code(o.reason, tmpfailure)
 
-            if pseudocode
+            if pseudocode = Sisimai::SMTP::Status.code(o.reason, tmpfailure)
               # Set the value of "deliverystatus" and "softbounce"
               o.deliverystatus = pseudocode
 

data/lib/sisimai/datetime.rb

@@ -43,7 +43,7 @@ module Sisimai
         abbr: %w[Sun Mon Tue Wed Thu Fri Sat],
       }.freeze
 
-      TimeZoneAbbr = {
+      TimeZones = {
         # http://en.wikipedia.org/wiki/List_of_time_zone_abbreviations
         #'ACDT' => '+1030', # Australian Central Daylight Time  UTC+10:30
         #'ACST' => '+0930', # Australian Central Standard Time  UTC+09:30
@@ -399,7 +399,7 @@ module Sisimai
       #   abbr2tz('JST')  #=> '+0900'
       def abbr2tz(argv1)
         return nil unless argv1.is_a?(::String)
-        return TimeZoneAbbr[argv1]
+        return TimeZones[argv1]
       end
 
       # Convert to second
@@ -428,7 +428,7 @@ module Sisimai
           return ztime
 
         elsif argv1 =~ /\A[A-Za-z]+\z/
-          return tz2second(TimeZoneAbbr[argv1])
+          return tz2second(TimeZones[argv1])
         else
           return nil
         end

data/lib/sisimai/lhost.rb

@@ -0,0 +1,79 @@
+module Sisimai
+  # Sisimai::Lhost - Base class for Sisimai::Lhost::*
+  module Lhost
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost.pm
+      require 'sisimai/rfc5322'
+
+      # Data structure for parsed bounce messages
+      # @return [Hash] Data structure for delivery status
+      # @private
+      def DELIVERYSTATUS
+        return {
+          'spec'         => nil,  # Protocl specification
+          'date'         => nil,  # The value of Last-Attempt-Date header
+          'rhost'        => nil,  # The value of Remote-MTA header
+          'lhost'        => nil,  # The value of Received-From-MTA header
+          'alias'        => nil,  # The value of alias entry(RHS)
+          'agent'        => nil,  # MTA module name
+          'action'       => nil,  # The value of Action header
+          'status'       => nil,  # The value of Status header
+          'reason'       => nil,  # Temporary reason of bounce
+          'command'      => nil,  # SMTP command in the message body
+          'replycode'    => nil,  # SMTP Reply code
+          'diagnosis'    => nil,  # The value of Diagnostic-Code header
+          'recipient'    => nil,  # The value of Final-Recipient header
+          'softbounce'   => nil,  # Soft bounce or not
+          'feedbacktype' => nil,  # Feedback Type
+        }
+      end
+
+      # @abstract Flags for position variable
+      # @return   [Hash] Position flag data
+      # @private
+      def INDICATORS
+        return {
+          :'deliverystatus' => (1 << 1),
+          :'message-rfc822' => (1 << 2),
+        }
+      end
+
+      # @abstract MTA list
+      # @return   [Array] MTA list with order
+      def index
+        return %w[
+          Activehunter Amavis AmazonSES AmazonWorkMail Aol ApacheJames Barracuda Bigfoot
+          Biglobe Courier Domino EZweb EinsUndEins Exchange2003 Exchange2007 Exim FML
+          Facebook GMX GSuite GoogleGroups Gmail IMailServer InterScanMSS KDDI MXLogic
+          MailFoundry MailMarshalSMTP MailRu McAfee MessageLabs MessagingServer Notes
+          Office365 OpenSMTPD Outlook Postfix PowerMTA ReceivingSES SendGrid Sendmail
+          SurfControl V5sendmail Verizon X1 X2 X3 X4 X5 X6 Yahoo Yandex Zoho MFILTER
+          Qmail
+        ]
+      end
+
+      # @abstract Returns Sisimai::Lhost::* module path table
+      # @return [Hash] Module path table
+      # @since  v4.25.6
+      def path
+        index = Sisimai::Lhost.index
+        table = {
+          'Sisimai::ARF'     => 'sisimai/arf',
+          'Sisimai::RFC3464' => 'sisimai/rfc3464',
+          'Sisimai::RFC3834' => 'sisimai/rfc3834',
+        }
+        index.each { |e| table['Sisimai::Lhost::' << e] = 'sisimai/lhost/' << e.downcase }
+        return table
+      end
+
+      # @abstract Parse bounce messages
+      # @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; return nil; end
+      def description; return ''; end
+    end
+  end
+end
+