rims 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d256a00569dbf130c60b1ce0a2e81eaaaee80c8f05bd539951044050d8730ed8
-  data.tar.gz: dadb9184722598429f498a3c024bb911717f2cacd28e8b2b72073704401c6af1
+  metadata.gz: 302a70ed845d6af656e11c2a6fde78cfda71a33b1d5673654594634b7fe92f63
+  data.tar.gz: 468e136c3796d1ea15d9e554be3f6dd38b5d34fe3089c7db71a0d7a87d73e9cb
 SHA512:
-  metadata.gz: d630fcd4aea66809516f8878d5b0f9511331c3afaf1fc71a6f0ac08f5a4329345868f5a5cf2665e54a9985dd7939c7b478da2c8f7cfe1a686603f621519cef75
-  data.tar.gz: 6a34c95ce5f6a6012da5e790326e2e991ecccc0cb186ac53fd8c6b2b1f829df0b41c8087fa567970dbf912295901ed4e4a83865117e1c564df90da43b7874807
+  metadata.gz: 96c2d58c1990e724743581436c0e373bcb147e4afd799f8c9860146cf2c4fa33b5652a2937a4185590a5b7a79c2309bf899d16268eeed92765b08572c74d3884
+  data.tar.gz: 816e5242fbf6c361d81306f516c27eab7046d73829ae7a08065a44788ef28afba71923b0eb6b200d7a0b6f2791fda24e8f7c4a6d481ff9502333fa4fc2179c03

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 Change Log
 ==========
 
+<!--
+subsections:
+### Added
+### Changed
+### Removed
+### Fixed
+-->
+
+0.3.0
+-----
+
+### Added
+- Input size limits.
+  [#34](https://github.com/y10k/rims/issues/34)
+- Configurable bulk_response_size parameter.
+  [#36](https://github.com/y10k/rims/issues/36)
+
+### Changed
+- Ready to Ruby 2.7.
+  [#35](https://github.com/y10k/rims/issues/35)
+- Semantic versioning.
+  [#37](https://github.com/y10k/rims/issues/37)
+
 0.2.9
 -----
 Released on 2019-12-12.

data/lib/rims.rb

@@ -5,35 +5,37 @@ require "rims/version"
 autoload :OpenSSL, 'openssl'
 
 module RIMS
-  autoload :Authentication, 'rims/auth'
-  autoload :Checksum_KeyValueStore, 'rims/cksum_kvs'
-  autoload :Cmd, 'rims/cmd'
-  autoload :DB, 'rims/db'
-  autoload :Error, 'rims/error'
-  autoload :GDBM_KeyValueStore, 'rims/gdbm_kvs'
-  autoload :GlobalDB, 'rims/db'
-  autoload :Hash_KeyValueStore, 'rims/hash_kvs'
-  autoload :IllegalLockError, 'rims/lock'
-  autoload :KeyValueStore, 'rims/kvs'
-  autoload :LockError, 'rims/lock'
-  autoload :MailFolder, 'rims/mail_store'
-  autoload :MailStore, 'rims/mail_store'
-  autoload :MailboxDB, 'rims/db'
-  autoload :MessageDB, 'rims/db'
-  autoload :MessageSetSyntaxError, 'rims/protocol'
-  autoload :Password, 'rims/passwd'
-  autoload :Protocol, 'rims/protocol'
-  autoload :ProtocolError, 'rims/protocol'
-  autoload :RFC822, 'rims/rfc822'
-  autoload :ReadLockError, 'rims/lock'
-  autoload :ReadLockTimeoutError, 'rims/lock'
-  autoload :ReadWriteLock, 'rims/lock'
-  autoload :ServerResponseChannel, 'rims/channel'
-  autoload :Service, 'rims/service'
-  autoload :SyntaxError, 'rims/protocol'
-  autoload :Test, 'rims/test'
-  autoload :WriteLockError, 'rims/lock'
-  autoload :WriteLockTimeoutError, 'rims/lock'
+  autoload :Authentication,           'rims/auth'
+  autoload :Checksum_KeyValueStore,   'rims/cksum_kvs'
+  autoload :Cmd,                      'rims/cmd'
+  autoload :CommandSizeTooLargeError, 'rims/protocol'
+  autoload :DB,                       'rims/db'
+  autoload :Error,                    'rims/error'
+  autoload :GDBM_KeyValueStore,       'rims/gdbm_kvs'
+  autoload :Hash_KeyValueStore,       'rims/hash_kvs'
+  autoload :IllegalLockError,         'rims/lock'
+  autoload :KeyValueStore,            'rims/kvs'
+  autoload :LineTooLongError,         'rims/protocol'
+  autoload :LiteralSizeTooLargeError, 'rims/protocol'
+  autoload :LockError,                'rims/lock'
+  autoload :MailFolder,               'rims/mail_store'
+  autoload :MailStore,                'rims/mail_store'
+  autoload :MessageSetSyntaxError,    'rims/protocol'
+  autoload :Password,                 'rims/passwd'
+  autoload :Protocol,                 'rims/protocol'
+  autoload :ProtocolError,            'rims/protocol'
+  autoload :RFC822,                   'rims/rfc822'
+  autoload :ReadLockError,            'rims/lock'
+  autoload :ReadLockTimeoutError,     'rims/lock'
+  autoload :ReadSizeError,            'rims/protocol'
+  autoload :ReadWriteLock,            'rims/lock'
+  autoload :RecoverableReadSizeError, 'rims/protocol'
+  autoload :ServerResponseChannel,    'rims/channel'
+  autoload :Service,                  'rims/service'
+  autoload :SyntaxError,              'rims/protocol'
+  autoload :Test,                     'rims/test'
+  autoload :WriteLockError,           'rims/lock'
+  autoload :WriteLockTimeoutError,    'rims/lock'
 end
 
 # Local Variables:

data/lib/rims/cmd.rb

@@ -472,6 +472,33 @@ module RIMS
                  })
         }
       end
+      options.on('--line-length-limit=SIZE',
+                 Integer
+                ) do |size|
+        build.chain{|c|
+          c.load(protocol: {
+                   line_length_limit: size
+                 })
+        }
+      end
+      options.on('--literal-size-limit=SIZE',
+                 Integer
+                ) do |size|
+        build.chain{|c|
+          c.load(protocol: {
+                   literal_size_limit: size
+                 })
+        }
+      end
+      options.on('--command-size-limit=SIZE',
+                 Integer
+                ) do |size|
+        build.chain{|c|
+          c.load(protocol: {
+                   command_size_limit: size
+                 })
+        }
+      end
       options.on('--[no-]use-default-charset-aliases'
                 ) do |use_default_aliases|
         build.chain{|c|
@@ -533,7 +560,7 @@ module RIMS
                  })
         }
       end
-      options.on('--drb-load-limit=NUMBER',
+      options.on('--drb-load-limit=SIZE',
                  Integer
                 ) do |size|
         build.chain{|c|
@@ -552,6 +579,16 @@ module RIMS
                  })
         }
       end
+      options.on('--bulk-response-size=SIZE',
+                 Integer) do |size|
+        build.chain{|c|
+          c.load(drb_services: {
+                   engine: {
+                     bulk_response_size: size
+                   }
+                 })
+        }
+      end
       options.on('--read-lock-timeout=SECONDS',
                  Float
                 ) do |seconds|

data/lib/rims/protocol.rb

@@ -4,6 +4,27 @@ module RIMS
   class ProtocolError < Error
   end
 
+  class ReadSizeError < ProtocolError
+  end
+
+  class LineTooLongError < ReadSizeError
+  end
+
+  class RecoverableReadSizeError < ReadSizeError
+    def initialize(message=nil, command_tag=nil, **kw_args)
+      super(message, **kw_args)
+      @command_tag = command_tag
+    end
+
+    attr_reader :command_tag
+  end
+
+  class LiteralSizeTooLargeError < RecoverableReadSizeError
+  end
+
+  class CommandSizeTooLargeError < RecoverableReadSizeError
+  end
+
   class SyntaxError < ProtocolError
   end
 
@@ -57,14 +78,14 @@ module RIMS
     end
     module_function :decode_base64
 
-    autoload :FetchBody, 'rims/protocol/parser'
-    autoload :RequestReader, 'rims/protocol/parser'
+    autoload :FetchBody,            'rims/protocol/parser'
+    autoload :RequestReader,        'rims/protocol/parser'
     autoload :AuthenticationReader, 'rims/protocol/parser'
-    autoload :SearchParser, 'rims/protocol/parser'
-    autoload :FetchParser, 'rims/protocol/parser'
-    autoload :ConnectionLimits, 'rims/protocol/connection'
-    autoload :ConnectionTimer, 'rims/protocol/connection'
-    autoload :Decoder, 'rims/protocol/decoder'
+    autoload :SearchParser,         'rims/protocol/parser'
+    autoload :FetchParser,          'rims/protocol/parser'
+    autoload :ConnectionLimits,     'rims/protocol/connection'
+    autoload :ConnectionTimer,      'rims/protocol/connection'
+    autoload :Decoder,              'rims/protocol/decoder'
 
     def body(symbol: nil, option: nil, section: nil, section_list: nil, partial_origin: nil, partial_size: nil)
       FetchBody.new(symbol, option, section, section_list, partial_origin, partial_size)

data/lib/rims/protocol/decoder.rb

@@ -37,7 +37,6 @@ module RIMS
       end
 
       def self.repl(decoder, limits, input, output, logger)
-        input_gets = input.method(:gets)
         output_write = lambda{|data|
           begin
             if (data == :flush) then
@@ -85,90 +84,112 @@ module RIMS
         apply_imap_command.call(:ok_greeting)
 
         conn_timer = ConnectionTimer.new(limits, input.to_io)
-        request_reader = RequestReader.new(input, output, logger)
+        request_reader = decoder.make_requrest_reader(input, output)
+        input_gets = request_reader.method(:gets)
 
-        until (conn_timer.command_wait_timeout?)
-          conn_timer.command_wait or break
+        begin
+          until (conn_timer.command_wait_timeout?)
+            conn_timer.command_wait or break
 
-          begin
-            atom_list = request_reader.read_command
-          rescue
-            logger.error('invalid client command.')
-            logging_error_chain($!, logger)
-            response_write.call("* BAD client command syntax error\r\n")
-            next
-          end
+            begin
+              atom_list = request_reader.read_command
+            rescue LineTooLongError
+              raise
+            rescue LiteralSizeTooLargeError
+              logger.error('literal size too large error.')
+              logging_error_chain($!, logger)
+              response_write.call("#{request_reader.command_tag || '*'} BAD literal size too large\r\n")
+              next
+            rescue CommandSizeTooLargeError
+              logger.error('command size too large error.')
+              logging_error_chain($!, logger)
+              response_write.call("#{request_reader.command_tag || '*'} BAD command size too large\r\n")
+              next
+            rescue
+              logger.error('invalid client command.')
+              logging_error_chain($!, logger)
+              response_write.call("#{request_reader.command_tag || '*'} BAD client command syntax error\r\n")
+              next
+            end
 
-          break unless atom_list
+            break unless atom_list
 
-          tag, command, *opt_args = atom_list
-          normalized_command = imap_command_normalize(command)
-          logger.info("client command: #{tag} #{command}")
-          if (logger.debug?) then
-            case (normalized_command)
-            when 'LOGIN'
-              log_opt_args = opt_args.dup
-              log_opt_args[-1] = '********'
-            when 'AUTHENTICATE'
-              if (opt_args[1]) then
+            tag, command, *opt_args = atom_list
+            normalized_command = imap_command_normalize(command)
+            logger.info("client command: #{tag} #{command}")
+            if (logger.debug?) then
+              case (normalized_command)
+              when 'LOGIN'
                 log_opt_args = opt_args.dup
-                log_opt_args[1] = '********'
+                log_opt_args[-1] = '********'
+              when 'AUTHENTICATE'
+                if (opt_args[1]) then
+                  log_opt_args = opt_args.dup
+                  log_opt_args[1] = '********'
+                else
+                  log_opt_args = opt_args
+                end
               else
                 log_opt_args = opt_args
               end
-            else
-              log_opt_args = opt_args
+              logger.debug("client command parameter: #{log_opt_args.inspect}")
             end
-            logger.debug("client command parameter: #{log_opt_args.inspect}")
-          end
 
-          begin
-            if (name = IMAP_CMDs[normalized_command]) then
-              case (name)
-              when :uid
-                unless (opt_args.empty?) then
-                  uid_command, *uid_args = opt_args
-                  logger.info("uid command: #{uid_command}")
-                  logger.debug("uid parameter: #{uid_args}") if logger.debug?
-                  if (uid_name = UID_CMDs[imap_command_normalize(uid_command)]) then
-                    apply_imap_command.call(uid_name, tag, *uid_args, uid: true)
+            begin
+              if (name = IMAP_CMDs[normalized_command]) then
+                case (name)
+                when :uid
+                  unless (opt_args.empty?) then
+                    uid_command, *uid_args = opt_args
+                    logger.info("uid command: #{uid_command}")
+                    logger.debug("uid parameter: #{uid_args}") if logger.debug?
+                    if (uid_name = UID_CMDs[imap_command_normalize(uid_command)]) then
+                      apply_imap_command.call(uid_name, tag, *uid_args, uid: true)
+                    else
+                      logger.error("unknown uid command: #{uid_command}")
+                      response_write.call("#{tag} BAD unknown uid command\r\n")
+                    end
                   else
-                    logger.error("unknown uid command: #{uid_command}")
-                    response_write.call("#{tag} BAD unknown uid command\r\n")
+                    logger.error('empty uid parameter.')
+                    response_write.call("#{tag} BAD empty uid parameter\r\n")
                   end
+                when :authenticate
+                  apply_imap_command.call(:authenticate, tag, input_gets, server_output_write, *opt_args)
+                when :idle
+                  apply_imap_command.call(:idle, tag, input_gets, server_output_write, conn_timer, *opt_args)
                 else
-                  logger.error('empty uid parameter.')
-                  response_write.call("#{tag} BAD empty uid parameter\r\n")
+                  apply_imap_command.call(name, tag, *opt_args)
                 end
-              when :authenticate
-                apply_imap_command.call(:authenticate, tag, input_gets, server_output_write, *opt_args)
-              when :idle
-                apply_imap_command.call(:idle, tag, input_gets, server_output_write, conn_timer, *opt_args)
               else
-                apply_imap_command.call(name, tag, *opt_args)
+                logger.error("unknown command: #{command}")
+                response_write.call("#{tag} BAD unknown command\r\n")
               end
-            else
-              logger.error("unknown command: #{command}")
-              response_write.call("#{tag} BAD unknown command\r\n")
+            rescue LineTooLongError
+              raise
+            rescue
+              logger.error('unexpected error.')
+              logging_error_chain($!, logger)
+              response_write.call("#{tag} BAD unexpected error\r\n")
             end
-          rescue
-            logger.error('unexpected error.')
-            logging_error_chain($!, logger)
-            response_write.call("#{tag} BAD unexpected error\r\n")
-          end
-
-          if (normalized_command == 'LOGOUT') then
-            break
-          end
 
-          decoder = decoder.next_decoder
-        end
+            if (normalized_command == 'LOGOUT') then
+              break
+            end
 
-        if (conn_timer.command_wait_timeout?) then
-          if (limits.command_wait_timeout_seconds > 0) then
-            response_write.call("* BYE server autologout: idle for too long\r\n")
-          else
-            response_write.call("* BYE server autologout: shutdown\r\n")
+            decoder = decoder.next_decoder
+          end
+        rescue LineTooLongError
+          logger.error('line too long error.')
+          logging_error_chain($!, logger)
+          response_write.call("* BAD line too long\r\n")
+          response_write.call("* BYE server autologout: connection terminated\r\n")
+        else
+          if (conn_timer.command_wait_timeout?) then
+            if (limits.command_wait_timeout_seconds > 0) then
+              response_write.call("* BYE server autologout: idle for too long\r\n")
+            else
+              response_write.call("* BYE server autologout: shutdown\r\n")
+            end
           end
         end
 
@@ -198,6 +219,8 @@ module RIMS
           else
             __send__(imap_command, tag, *args, **kw_args, &block)
           end
+        rescue LineTooLongError
+          raise
         rescue SyntaxError
           @logger.error('client command syntax error.')
           logging_error_chain($!)
@@ -334,13 +357,26 @@ module RIMS
       end
 
       def initialize(drb_services, auth, logger,
-                     mail_delivery_user: Service::DEFAULT_CONFIG.mail_delivery_user)
+                     mail_delivery_user: Service::DEFAULT_CONFIG.mail_delivery_user,
+                     line_length_limit: Service::DEFAULT_CONFIG.protocol_line_length_limit,
+                     literal_size_limit: Service::DEFAULT_CONFIG.protocol_literal_size_limit,
+                     command_size_limit: Service::DEFAULT_CONFIG.protocol_command_size_limit)
         super(auth, logger)
         @drb_services = drb_services
         @mail_delivery_user = mail_delivery_user
+        @line_length_limit = line_length_limit
+        @literal_size_limit = literal_size_limit
+        @command_size_limit = command_size_limit
         @logger.debug("RIMS::Protocol::InitialDecoder#initialize at #{self}") if @logger.debug?
       end
 
+      def make_requrest_reader(input, output)
+        RequestReader.new(input, output, @logger,
+                          line_length_limit: @line_length_limit,
+                          literal_size_limit: @literal_size_limit,
+                          command_size_limit: @command_size_limit)
+      end
+
       def auth?
         false
       end
@@ -868,22 +904,40 @@ module RIMS
 
         class << self
           def imap_command_authenticated(name, **guard_optional)
+            name = name.to_sym
             orig_name = "_#{name}".to_sym
             alias_method orig_name, name
-            define_method name, lambda{|token, tag, *args, **kw_args, &block|
-              guard_authenticated(orig_name, token, tag, *args, **kw_args, **guard_optional, &block)
-            }
-            name.to_sym
+
+            guard_options_name = "_#{name}_guard_options".to_sym
+            define_method guard_options_name, lambda{ guard_optional }
+            private guard_options_name
+
+            class_eval(<<-EOF, __FILE__, __LINE__ + 1)
+              def #{name}(token, tag, *args, **kw_args, &block)
+                guard_authenticated(:#{orig_name}, token, tag, *args, **kw_args, **#{guard_options_name}, &block)
+              end
+            EOF
+
+            name
           end
           private :imap_command_authenticated
 
           def imap_command_selected(name, **guard_optional)
+            name = name.to_sym
             orig_name = "_#{name}".to_sym
             alias_method orig_name, name
-            define_method name, lambda{|token, tag, *args, **kw_args, &block|
-              guard_selected(orig_name, token, tag, *args, **kw_args, **guard_optional, &block)
-            }
-            name.to_sym
+
+            guard_options_name = "_#{name}_guard_options".to_sym
+            define_method guard_options_name, lambda{ guard_optional }
+            private guard_options_name
+
+            class_eval(<<-EOF, __FILE__, __LINE__ + 1)
+              def #{name}(token, tag, *args, **kw_args, &block)
+                guard_selected(:#{orig_name}, token, tag, *args, **kw_args, **#{guard_options_name}, &block)
+              end
+            EOF
+
+            name
           end
           private :imap_command_selected
         end
@@ -1884,7 +1938,7 @@ module RIMS
       end
       imap_command :check
 
-      def close(tag, &block)
+      def close(tag)
         ret_val = nil
         old_token = @token
         @token = nil
@@ -1946,7 +2000,7 @@ module RIMS
       end
       imap_command :store
 
-      def copy(tag, msg_set, mbox_name, uid: false, &block)
+      def copy(tag, msg_set, mbox_name, uid: false)
         ret_val = nil
         @engine.copy(@token, tag, msg_set, mbox_name, uid: uid) {|res|
           for response in res
@@ -1958,7 +2012,7 @@ module RIMS
       end
       imap_command :copy
 
-      def idle(tag, client_input_gets, server_output_write, connection_timer, &block)
+      def idle(tag, client_input_gets, server_output_write, connection_timer)
         ret_val = nil
         @engine.idle(@token, tag, client_input_gets, server_output_write, connection_timer) {|res|
           for response in res