hermeneutics 1.21 → 1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e095f585149d4c8a07af7a415cfcc003a3958cc45f4611490b3a018f19b94b
-  data.tar.gz: 20e963ec38f9c4dbace27a15c6c39097ab6bbf6a52528a2b5d4e40aaba15c193
+  metadata.gz: df19436c205dec9d79e7ea6329b0039f73c0df18785684b3497a5beacba86de0
+  data.tar.gz: 71249e9f95d7d3b7a5cc4c69de6dcdf8d50312db07d6b4e06e75df798e24a7f6
 SHA512:
-  metadata.gz: 760bea637b51c7852ee0b6678af340f60e98fcab925f3376ff5e7ff147106a3d4532b1e7f8e3a3d0eada210826fa26467adb50c99a4c81978bdb08b795b819bf
-  data.tar.gz: 1e34626ab27cb6210a20d57f0e30bab31475b8d4040406fcab0636ca97f5a69c4edce39c8f3e9ceee5ddeb425b7e32816680c3c0f9fb6a2149a1a8181e5a0856
+  metadata.gz: 53de39c130f7134771b2ae8a03047ddd58ddf8daed8bf1b62e32f3627fe0125324e89a33aec4072cd38e4c5194261322e32d6069533fed8845c352982ca714fc
+  data.tar.gz: f3b02d37c1397fa5ddc2bf76247d85b1eef0d99a74d0c3afda583e97d1938ab1a7542c3ea557eec95c0deef199ddd1dfa5e73f3618598af009b8848f7def97d9

data/LICENSE

@@ -1,6 +1,6 @@
 = Hermeneutics  --  Ruby mail and CGI handling
 
-Copyright (c) 2011-2013, Bertram Scharpf <software@bertram-scharpf.de>.
+Copyright (c) 2011-2024, Bertram Scharpf <software@bertram-scharpf.de>.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/lib/hermeneutics/addrs.rb

@@ -6,7 +6,7 @@
 
 =begin rdoc
 
-:section: Classes definied here
+:section: Classes defined here
 
 Hermeneutics::Addr      is a single address
 Hermeneutics::AddrList  is a list of addresses in mail header fields.
@@ -306,22 +306,6 @@ module Hermeneutics
           end
         end
 
-        def lexer_decode str, &block
-          if block_given? then
-            HeaderExt.lexer str do |k,s|
-              case k
-                when :decoded then yield Token[ :char, s, true]
-                when :plain   then lexer s, &block
-                when :space   then yield Token[ :space]
-              end
-            end
-          else
-            r = []
-            lexer_decode str do |t| r.push t end
-            r
-          end
-        end
-
         private
 
         def escaped h, c
@@ -432,7 +416,7 @@ module Hermeneutics
       #   #   "Möller, Fritz" <fmoeller@example.com>
       #
       def parse_decode str, &block
-        l = Token.lexer_decode str
+        l = Token.lexer str
         compile l, &block
       end
 
@@ -577,7 +561,8 @@ module Hermeneutics
 
     class <<self
       def parse cont
-        new.add_encoded cont
+        str = HeaderExt.decode cont
+        new.add_quoted str
       end
     end
 
@@ -596,7 +581,7 @@ module Hermeneutics
     def push addrs
       case addrs
         when nil    then
-        when String then add_encoded addrs
+        when String then add_quoted addrs
         when Addr   then @list.push addrs
         else             addrs.each { |a| push a }
       end
@@ -681,13 +666,6 @@ module Hermeneutics
       self
     end
 
-    def add_encoded cont
-      Addr.parse_decode cont.to_s do |a,|
-        @list.push a
-      end
-      self
-    end
-
   end
 
 end

data/lib/hermeneutics/cgi.rb

@@ -129,7 +129,7 @@ module Hermeneutics
 
     def parameters nl: false, sym: false, strip: false
       if block_given? then
-        data.parse do |k,v,**kw|
+        parameter_data.parse do |k,v,**kw|
           k = k.to_sym if sym
           if v then
             v.strip! if strip
@@ -146,33 +146,28 @@ module Hermeneutics
       end
     end
 
-    def data
+    def parameter_data
       case request_method
         when "GET", "HEAD" then
-          Data::UrlEnc.new query_string
+          dc, d = Data::UrlEnc, query_string
         when "POST"        then
-          data = $stdin.binmode.read
-          data.bytesize == content_length.to_i or
-            warn "Content length #{content_length} is wrong (#{data.bytesize})."
+          d = $stdin.binmode.read
+          d.bytesize == content_length.to_i or
+            warn "Content length #{content_length} is wrong (#{d.bytesize})."
           ct = ContentType.parse content_type
-          data.force_encoding ct[ :charset]||Encoding::ASCII_8BIT
-          case ct.fulltype
-            when "application/x-www-form-urlencoded" then
-              Data::UrlEnc.new data
-            when "multipart/form-data" then
-              Data::Multiparted.new data, ct.hash
-            when "text/plain" then
-              Data::Plain.new data
-            when "application/json" then
-              Data::Json.new data
-            when "application/x-yaml", "application/yaml" then
-              Data::Yaml.new data
-            else
-              Data::UrlEnc.new data
+          d.force_encoding ct[ :charset]||Encoding::ASCII_8BIT
+          dc = case ct.fulltype
+            when "application/x-www-form-urlencoded"      then Data::UrlEnc
+            when "multipart/form-data"                    then a = [ ct.hash] ; Data::Multiparted
+            when "text/plain"                             then Data::Plain
+            when "application/json"                       then Data::Json
+            when "application/x-yaml", "application/yaml" then Data::Yaml
+            else                                               Data::UrlEnc
           end
         else
-          Data::Lines.new read_interactive
+          dc, d = Data::Lines, read_interactive
       end
+      dc.new d, *a
     end
 
 
@@ -208,8 +203,9 @@ module Hermeneutics
       class Lines < Plain
         def initialize lines
           @lines = lines
+          super nil
         end
-        def data ; @lines.join "\n" ; end
+        def data ; @data ||= @lines.join "\n" ; end
         def parse
           @lines.each { |s|
             k, v = s.split %r/=/

data/lib/hermeneutics/cli/imap.rb

@@ -16,7 +16,6 @@ module Hermeneutics
 
       PORT, PORT_SSL = 143, 993
 
-      class Error          < StandardError ; end
       class UnspecResponse < Error         ; end
       class ServerBye      < Error         ; end
       class ServerError    < Error         ; end
@@ -37,7 +36,7 @@ module Hermeneutics
 
       def initialize *args
         super
-        @tag = "H%04d" % 0
+        @tag = "%s%04d" % [ TAG_PREFIX, 0]
         @info = [ get_response]
         start_watch
       end

data/lib/hermeneutics/cli/lmtp.rb

@@ -0,0 +1,183 @@
+#
+#  lib/hermeneutics/cli/lmtp.rb  --  LMTP client
+#
+
+require "hermeneutics/cli/protocol"
+
+module Hermeneutics
+
+  module Cli
+
+    class LMTP < Protocol
+
+      CRLF = true
+
+      class UnspecError     < Error         ; end
+      class ServerNotReady  < Error         ; end
+      class NotOk           < Error         ; end
+      class NotReadyForData < Error         ; end
+      class Unused          < Error         ; end
+      class Uncaught        < Error         ; end
+
+      class <<self
+        private :new
+        def open socketfile
+          UNIXSocket.open socketfile do |s|
+            i = new s, nil
+            yield i
+          end
+        end
+      end
+
+      attr_reader :domain, :greet
+      attr_reader :advertised
+      attr_reader :last_response
+
+      def initialize *args
+        super
+        get_response.ok? or raise ServerNotReady, @last_response.msg
+        @rcpt = 0
+      end
+
+      def size
+        @advertised && @advertised[ :SIZE]
+      end
+
+
+      def lhlo host = nil
+        @advertised = {}
+        write_cmd "LHLO", host||Socket.gethostname
+        get_response_ok do |code,msg|
+          unless @domain then
+            @domain, @greet = msg.split nil, 2
+            next
+          end
+          keyword, param = msg.split nil, 2
+          keyword.upcase!
+          keyword = keyword.to_sym
+          case keyword
+            when :SIZE then param = Integer param
+            when :AUTH then param = param.split.map { |p| p.upcase! ; p.to_sym }
+          end
+          @advertised[ keyword] = param || true
+        end
+        unless @domain then
+          @domain, @greet = @last_response.msg.split nil, 2
+        end
+      end
+
+      def mail_from from
+        cmd "MAIL", "FROM:<#{from}>"
+      end
+
+      def rcpt_to to
+        cmd "RCPT", "TO:<#{to}>"
+        @rcpt += 1
+      end
+
+      def data reader
+        write_cmd "DATA"
+        get_response.waiting? or raise NotReadyForData, @last_response.msg
+        reader.each_line { |l|
+          l =~ /\A\./ and l = ".#{l}"
+          writeline l
+        }
+        writeline "."
+        get_response_rcpts
+      end
+
+      def bdat data
+        data.each { |d|
+          write_cmd "BDAT", d.bytesize
+          write d
+          get_response_ok
+        }
+        write_cmd "BDAT", 0, "LAST"
+        get_response_rcpts
+      end
+
+      def rset
+        cmd "RSET"
+      ensure
+        @rcpt = 0
+      end
+
+      def noop str = nil
+        cmd "NOOP"
+      end
+
+      def quit
+        cmd "QUIT"
+      end
+
+
+      private
+
+      def cmd name, *args, &block
+        write_cmd name, *args
+        get_response_ok &block
+      end
+
+      def write_cmd name, *args
+        l = [ name, *args].join " "
+        writeline l
+      end
+
+      class Response
+
+        attr_reader :code, :msg
+
+        def initialize code, msg
+          @code, @msg = code, msg
+        end
+
+        def kat ; code / 100 ; end
+
+        def to_s ; "%03d %s" % [ @code, @msg] ; end
+
+        def prelim?  ; kat == 1 ; end
+        def ok?      ; kat == 2 ; end
+        def waiting? ; kat == 3 ; end
+        def error?   ; kat == 4 ; end
+        def fatal?   ; kat == 5 ; end
+
+      end
+
+      def get_response_ok &block
+        get_response &block
+        @last_response.ok? or raise NotOk, @last_response.msg
+        true
+      end
+
+      def get_response
+        loop do
+          r = readline
+          if r =~ /\A(\d\d\d) / then
+            @last_response = Response.new $1.to_i, $'
+            break @last_response
+          elsif r =~ /\A(\d\d\d)-/ then
+            block_given? or raise Uncaught, r
+            yield $1.to_i, $'
+          else
+            raise UnspecError, r
+          end
+        end
+      end
+
+      def get_response_rcpts
+        r = []
+        @rcpt.times {
+          r.push get_response
+          @last_response.ok? or raise NotOk, @last_response.msg
+        }
+        r
+      ensure
+        @rcpt = 0
+      end
+
+    end
+
+  end
+
+end
+

data/lib/hermeneutics/cli/pop3.rb

@@ -14,7 +14,6 @@ module Hermeneutics
 
       PORT, PORT_SSL = 110, 995
 
-      class Error       < StandardError ; end
       class UnspecError < Error         ; end
       class AuthFail    < Error         ; end
       class Check       < Error         ; end

data/lib/hermeneutics/cli/protocol.rb

@@ -22,8 +22,12 @@ module Hermeneutics
 
   module Cli
 
+
     class Protocol
 
+      class Error   < StandardError ; end
+      class Timeout < Error         ; end
+
       class <<self
         private :new
         def open host, port, timeout: nil, ssl: false
@@ -80,7 +84,7 @@ module Hermeneutics
       end
 
       def readline
-        @socket.wait @timeout||0
+        wait
         r = @socket.readline
         r.chomp!
         @trace and $stderr.puts "S: #{r}"
@@ -94,7 +98,7 @@ module Hermeneutics
       end
 
       def read bytes
-        @socket.wait @timeout||0
+        wait
         r = @socket.read bytes
         @trace and $stderr.puts "S- #{r.inspect}"
         r
@@ -105,6 +109,12 @@ module Hermeneutics
         not @socket.ready?
       end
 
+      def wait
+        if @timeout then
+          raise Timeout unless @socket.wait @timeout
+        end
+      end
+
     end
 
 

data/lib/hermeneutics/cli/smtp.rb

@@ -14,7 +14,6 @@ module Hermeneutics
 
       PORT, PORT_SSL = 25, 465
 
-      class Error           < StandardError ; end
       class UnspecError     < Error         ; end
       class ServerNotReady  < Error         ; end
       class NotOk           < Error         ; end
@@ -194,7 +193,7 @@ module Hermeneutics
           r = readline
           if r =~ /\A(\d\d\d) / then
             @last_response = Response.new $1.to_i, $'
-            break
+            break @last_response
           elsif r =~ /\A(\d\d\d)-/ then
             block_given? or raise Uncaught, r
             yield $1.to_i, $'
@@ -202,12 +201,6 @@ module Hermeneutics
             raise UnspecError, r
           end
         end
-        @last_response
-      ensure
-        unless done? then
-          r = readline
-          r and raise Unused, "Unexpected data: #{r.inspect}"
-        end
       end
 
     end

data/lib/hermeneutics/color.rb

@@ -4,7 +4,7 @@
 
 =begin rdoc
 
-:section: Classes definied here
+:section: Classes defined here
 
 Hermeneutics::Color handles 24-bit colors.
 

data/lib/hermeneutics/contents.rb

@@ -4,7 +4,7 @@
 
 =begin rdoc
 
-:section: Classes definied here
+:section: Classes defined here
 
 Hermeneutics::Contents is a content field parser.
 
@@ -44,9 +44,9 @@ module Hermeneutics
       #   ds[ "a"]  #=> "0123456"
       #
       def parse line
-        rest = line.strip
-        hash = parse_hash rest
-        new hash
+        rest = HeaderExt.decode line
+        rest.strip!
+        new *(build_args rest)
       end
 
       def urltext
@@ -55,7 +55,7 @@ module Hermeneutics
 
       private
 
-      def parse_hash rest
+      def build_args rest
         hash = Hash.new { |h,k| h[ k] = [] }
         asts = {}
         while rest.notempty? do
@@ -66,6 +66,7 @@ module Hermeneutics
           else
             [ rest.dup, ""]
           end
+          rest.lstrip!
           key.downcase!
           key = key.to_sym
           asts[ key] = ast
@@ -91,7 +92,7 @@ module Hermeneutics
           end
           r[ k] = v
         }
-        r
+        [ r]
       end
 
     end
@@ -236,11 +237,9 @@ module Hermeneutics
       #   c.caption         #=> "text/html"
       #   c[ :boundary]     #=> "0123456"
       #
-      def parse line
-        rest = line.strip
+      def build_args rest
         caption, rest = rest.split Dictionary::RES, 2
-        hash = parse_hash rest
-        new caption, hash
+        [ caption, *(super rest)]
       end
 
     end

data/lib/hermeneutics/escape.rb

@@ -9,7 +9,7 @@ require "supplement"
 
 =begin rdoc
 
-:section: Classes definied here
+:section: Classes defined here
 
 Hermeneutics::Entities encodes to and decodes from HTML-Entities
 (+&+ etc.)
@@ -235,7 +235,7 @@ module Hermeneutics
   # representing the ASCII code.  Eight bit characters should be masked the
   # same way.
   #
-  # An URL line does not store encoding information by itself.  A locator may
+  # A URL line does not store encoding information by itself.  A locator may
   # either say one of these:
   #
   #    http://www.example.com/subdir/index.html?umlfield=%C3%BCber+alles
@@ -401,11 +401,12 @@ module Hermeneutics
     #
     def mkurl path, hash = nil, anchor = nil
       unless Hash === hash then
-        hash, anchor = anchor, hash
+        hash, anchor = anchor, nil
       end
-      r = "#{path}"
-      r << "?#{encode_hash hash}" if hash
-      r << "##{anchor}" if anchor
+      r = ""
+      r << path.to_s
+      r << "?" << (encode_hash hash) if hash
+      r << "#" << anchor.to_s        if anchor
       r
     end
 
@@ -726,28 +727,18 @@ module Hermeneutics
       #
       def decode str
         r, e = [], []
-        v, l = nil, nil
-        lexer str do |type,piece|
-          case type
-            when :decoded then
-              e.push piece.encoding
-              if l == :space and (v == :decoded or not v) then
-                r.pop
-              elsif l == :plain then
-                r.push SPACE
-              end
-            when :space then
-              nil
-            when :plain then
-              if l == :decoded then
-                r.push SPACE
-              end
+        loop do
+          if str =~ /=\?([a-z0-9_-]+?)\?([QB])\?([!-~]+?)\?=/i then
+            p = $`
+            d = unmask $1, $2, $3
+            str = $'
+          else
+            p = str
           end
-          r.push piece
-          v, l = l, type
-        end
-        if l == :space and v == :decoded then
-          r.pop
+          r.push p if p =~ /\S/
+          d or break
+          r.push d
+          e.push d.encoding
         end
         e.uniq!
         begin
@@ -760,23 +751,6 @@ module Hermeneutics
         end
       end
 
-      def lexer str
-        while str do
-          str =~ /(\s+)|\B=\?(\S*?)\?([QB])\?(\S*?)\?=\B/i
-          if $1 then
-            yield :plain, $` unless $`.empty?
-            yield :space, $&
-          elsif $2 then
-            yield :plain, $` unless $`.empty?
-            d = unmask $2, $3, $4
-            yield :decoded, d
-          else
-            yield :plain, str
-          end
-          str = $'.notempty?
-        end
-      end
-
       private
 
       def unmask cs, tp, txt

data/lib/hermeneutics/mail.rb

@@ -248,7 +248,7 @@ module Hermeneutics
       }
       open_smtp conn do |smtp|
         log :INF, "Sending to", *tos
-        smtp.mail_from headers.from.first.plain
+        headers.from.empty? or smtp.mail_from headers.from.first.plain
         tos.each { |t| smtp.rcpt_to t }
         smtp.data m
       end
@@ -261,22 +261,22 @@ module Hermeneutics
     def open_smtp arg, &block
       if [ :mail_from, :rcpt_to, :data].map { |m| arg.respond_to? m }.all? then
         yield arg
-        return
-      end
-      a = {}
-      case arg
-        when nil       then h, p = "localhost", nil
-        when String    then h, p = arg.split ":" ; p &&= Integer p
-        when Array     then h, p = *arg
-        when Hash      then a = arg.clone ; h, p = (a.delete :host), (a.delete :port)
-        else                h, p = arg.host, arg.port ; arg.scheme == "smtps" and a[ :ssl] = true
-      end
-      require "hermeneutics/cli/smtp"
-      Cli::SMTP.open h, p, **a do |smtp|
-        smtp.helo
-        yield smtp
-      ensure
-        smtp.quit
+      else
+        a = {}
+        case arg
+          when nil       then h, p = "localhost", nil
+          when String    then h, p = arg.split ":" ; p &&= Integer p
+          when Array     then h, p = *arg
+          when Hash      then a = arg.clone ; h, p = (a.delete :host), (a.delete :port)
+          else                h, p = arg.host, arg.port ; arg.scheme == "smtps" and a[ :ssl] = true
+        end
+        require "hermeneutics/cli/smtp"
+        Cli::SMTP.open h, p, **a do |smtp|
+          smtp.helo
+          yield smtp
+        ensure
+          smtp.quit
+        end
       end
     end
 

data/lib/hermeneutics/message.rb

@@ -146,11 +146,7 @@ module Hermeneutics
 
       def contents type = nil
         if type then
-          if @contents then
-            if not @contents.is_a? type then
-              @contents = type.parse @data
-            end
-          else
+          unless @contents and (@contents.is_a? type) then
             @contents = type.parse @data
           end
         else

data/lib/hermeneutics/tags.rb

@@ -4,7 +4,7 @@
 
 =begin rdoc
 
-:section: Classes definied here
+:section: Classes defined here
 
 Hermeneutics::Parser Parses HTML source and builds a tree
 

data/lib/hermeneutics/types.rb

@@ -42,6 +42,12 @@ module Hermeneutics
   end
 
   class Timestamp
+    class <<self
+      def parse str
+        t = DateTime.parse str
+        new t
+      end
+    end
     attr_reader :value
     def initialize value = nil
       self.value = value

data/lib/hermeneutics/version.rb

@@ -13,7 +13,7 @@
 module Hermeneutics
 
   NAME        = "hermeneutics"
-  VERSION     = "1.21".freeze
+  VERSION     = "1.24".freeze
   SUMMARY     = "CGI and mail handling"
 
   DESCRIPTION = <<~EOT

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hermeneutics
 version: !ruby/object:Gem::Version
-  version: '1.21'
+  version: '1.24'
 platform: ruby
 authors:
 - Bertram Scharpf
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: supplement
@@ -59,6 +58,7 @@ files:
 - lib/hermeneutics/cli/imap/commands.rb
 - lib/hermeneutics/cli/imap/parser.rb
 - lib/hermeneutics/cli/imap/utf7imap.rb
+- lib/hermeneutics/cli/lmtp.rb
 - lib/hermeneutics/cli/openssl.rb
 - lib/hermeneutics/cli/pop3.rb
 - lib/hermeneutics/cli/protocol.rb
@@ -77,7 +77,6 @@ homepage: http://www.bertram-scharpf.de
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--charset"
 - utf-8
@@ -97,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby, at least 3.0
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: CGI and mail handling
 test_files: []