rims 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7acc91008294ca9589a19ecb657d5a04cc9d21c17e6349e059dd371bba0f4dbb
-  data.tar.gz: f750c5ef8ea6064033d1b6e1e0329964db61e56f1e9e1535883a19fcb1738aa3
+  metadata.gz: 302a70ed845d6af656e11c2a6fde78cfda71a33b1d5673654594634b7fe92f63
+  data.tar.gz: 468e136c3796d1ea15d9e554be3f6dd38b5d34fe3089c7db71a0d7a87d73e9cb
 SHA512:
-  metadata.gz: 003c20745f575ba8801f6b72956b42b3329f45fc84f70fe68146767fae15a657f9a3cb1767f759877e8cf442738873a05182c835d697c702e4fad7a575b560d3
-  data.tar.gz: 449554fe7059796dd4fbbce1c433b7abc2a411ad5ee24acccc0618bb1043e2fb6b9a006dc0e93eb5c32813409a80b2bb677c37e39437e819153c38233cbaa194
+  metadata.gz: 96c2d58c1990e724743581436c0e373bcb147e4afd799f8c9860146cf2c4fa33b5652a2937a4185590a5b7a79c2309bf899d16268eeed92765b08572c74d3884
+  data.tar.gz: 816e5242fbf6c361d81306f516c27eab7046d73829ae7a08065a44788ef28afba71923b0eb6b200d7a0b6f2791fda24e8f7c4a6d481ff9502333fa4fc2179c03

data/.gitignore

@@ -14,6 +14,9 @@
 /tmp/
 /vendor/
 /Gemfile.lock
+/Gemfile_local*
 /README.html
 *~
+.#*
+\#*
 *.log

data/CHANGELOG.md

@@ -0,0 +1,96 @@
+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.
+
+### Added
+- Add `umask(2)` configuration parameter. [#29](https://github.com/y10k/rims/issues/29)
+- Add debug logging for conflicted subscriber error. This problem is
+  not solved because it does not reappear. [#28](https://github.com/y10k/rims/issues/28)
+
+### Changed
+- Ready to Ruby 2.7. [#35](https://github.com/y10k/rims/issues/35)
+
+### Fixed
+- Fix a bug of detached thread finishing a protocol decoder engine.
+- Make bulk message size of inter-process communication not exceeding `DRb`'s `load_limit`.
+  [#30](https://github.com/y10k/rims/issues/30)
+  [#33](https://github.com/y10k/rims/issues/33)
+
+0.2.8
+-----
+Released on 2019-10-10.
+
+0.2.7
+-----
+Released on 2019-07-27.
+
+0.2.6
+-----
+Released on 2019-07-09.
+
+0.2.5
+-----
+Released on 2019-06-10.
+
+0.2.4
+-----
+Released on 2019-04-25.
+
+0.2.3
+-----
+Released on 2019-04-10.
+
+0.2.2
+-----
+Released on 2019-03-06.
+
+0.2.1
+-----
+Released on 2019-02-18.
+
+0.1.0
+-----
+Released on 2015-02-22.
+
+0.0.4
+-----
+Released on 2014-06-08.
+
+0.0.3
+-----
+Released on 2014-04-15.
+
+0.0.2
+-----
+Released on 2014-03-05.
+
+0.0.1
+-----
+Released on 2014-02-24.
+

data/ChangeLog

@@ -1,3 +1,112 @@
+2019-12-12  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* ChangeLog: updates to this file have been stopped.
+	see CHANGELOG.md from now on.
+
+2019-10-10  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* RIMS version 0.2.8 is released.
+
+2019-08-12  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/cmd.rb, lib/rims/service.rb: DRb service load_limit
+	option.
+
+2019-07-27  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* RIMS version 0.2.7 is released.
+
+2019-07-25  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/cmd.rb, lib/rims/protocol/decoder.rb,
+	lib/rims/protocol/parser.rb, lib/rims/service.rb: message charset
+	encoding conversion options.
+
+2019-07-22  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/cmd.rb, lib/rims/protocol/decoder.rb,
+	lib/rims/protocol/parser.rb, lib/rims/service.rb: charset aliases
+	option.
+
+2019-07-20  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/protocol/decoder.rb, lib/rims/protocol/parser.rb:
+	case-insensitive matching of SEARCH command.
+
+	See RFC3501 / 6.4.4. SEARCH Command
+	<https://tools.ietf.org/html/rfc3501#section-6.4.4>
+
+	    In all search keys that use strings, a message matches the key if
+	    the string is a substring of the field. The matching is
+	    case-insensitive.
+
+	* lib/rims/protocol/parser.rb: search for MIME encoded header
+	fields.
+
+2019-07-09  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* RIMS version 0.2.6 is released.
+
+2019-07-08  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/cmd.rb: disable plug-in name list on plug-in command
+	options.
+
+	* lib/rims/cmd.rb: environment command is defined.
+
+2019-07-02  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/protocol/decoder.rb: ALERT message notified to client
+	immediately.
+
+2019-07-01  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/protocol/decoder.rb, lib/rims/protocol/parser.rb: skip
+	encoding error on SEARCH command.
+
+	* lib/rims/protocol/decoder.rb: BADCHARSET response code for
+	unknown charset on SERCH command.
+
+	See RFC 3501 / 6.4.4.  SEARCH Command
+	<https://tools.ietf.org/html/rfc3501#section-6.4.4>
+
+	    If the server does not support the specified [CHARSET], it MUST
+	    return a tagged NO response (not a BAD).  This response SHOULD
+	    contain the BADCHARSET response code, which MAY list the
+	    [CHARSET]s supported by the server.
+
+2019-06-29  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/protocol/decoder.rb: line break before error response
+	interrupting search command.
+
+2019-06-25  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/protocol/parser.rb: delete unnecessary private methods.
+
+2019-06-23  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/protocol/parser.rb: add extension data to
+	bodystructure.
+
+2019-06-21  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/rfc822.rb, rims.gemspec, test/test_rfc822.rb: repladced
+	`RIMS::RFC822' to a external rubygem.
+
+2019-06-15  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/protocol/parser.rb: not allowed empty body field
+	parameters at attribute parser.
+
+	when body field parameters are empty, a command to fetch
+	`bodystructure' should response `NIL' instead of `()'.
+
+	see RFC 3501 / 9. Formal Syntax:
+	<https://tools.ietf.org/html/rfc3501#section-9>
+
+        body-fld-param  = "(" string SP string *(SP string SP string) ")" / nil
+
 2019-06-10  TOKI Yoshinori  <toki@freedom.ne.jp>
 
 	* RIMS version 0.2.5 is released.

data/Rakefile

@@ -28,14 +28,18 @@ Rake::RDocTask.new do |rd|
   rd.rdoc_files.include('lib/**/*.rb')
 end
 
+rule '.html' => '.md' do |t|
+  sh "pandoc --from=markdown --to=html5 --standalone --self-contained --css=$HOME/.pandoc/github.css --output=#{t.name} #{t.source}"
+end
+
 desc 'Build README.html from markdown source'
 task :readme => %w[ README.html ]
-
-file 'README.html' => [ 'README.md' ] do
-  sh "pandoc --from=markdown --to=html5 --standalone --self-contained --css=$HOME/.pandoc/github.css --output=README.html README.md"
-end
 CLOBBER.include 'README.html'
 
+desc 'Build CHANGELOG.html from markdown source'
+task :changelog => %w[ CHANGELOG.html ]
+CLOBBER.include 'CHANGELOG.html'
+
 namespace :test_cert do
   tls_dir = Pathname('test/tls')
 

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/channel.rb

@@ -1,6 +1,20 @@
 # -*- coding: utf-8 -*-
 
+require 'forwardable'
+
 module RIMS
+  class ServerResponseChannelError < Error
+  end
+
+  class ServerResponseChannelAttachError < ServerResponseChannelError
+  end
+
+  class ServerResponseChannelDetachError < ServerResponseChannelError
+  end
+
+  class ServerResponseChannelPublishError < ServerResponseChannelError
+  end
+
   class ServerResponseChannel
     def initialize
       @mutex = Thread::Mutex.new
@@ -9,14 +23,16 @@ module RIMS
 
     def make_pub_sub_pair(mbox_id)
       pub = ServerResponsePublisher.new(self, mbox_id)
-      sub = ServerResponseSubscriber.new(self, mbox_id, pub.pub_sub_pair_key)
+      sub = ServerResponseSubscriber.new(self, pub)
       return pub, attach(sub)
     end
 
     def attach(sub)
       @mutex.synchronize{
         @channel[sub.mbox_id] ||= {}
-        (@channel[sub.mbox_id].key? sub.pub_sub_pair_key) and raise ArgumentError, 'conflicted subscriber.'
+        if (@channel[sub.mbox_id].key? sub.pub_sub_pair_key) then
+          raise ServerResponseChannelAttachError.new('conflicted subscriber.', channel: self, subscriber: sub)
+        end
         @channel[sub.mbox_id][sub.pub_sub_pair_key] = sub
       }
 
@@ -30,8 +46,13 @@ module RIMS
     #   - ServerResponseSubscriber#detach
     def detach(sub)
       @mutex.synchronize{
-        ((@channel.key? sub.mbox_id) && (@channel[sub.mbox_id].key? sub.pub_sub_pair_key)) or raise ArgumentError, 'unregistered pub-sub pair.'
-        (@channel[sub.mbox_id][sub.pub_sub_pair_key] == sub) or raise 'internal error: mismatched subscriber.'
+        unless ((@channel.key? sub.mbox_id) && (@channel[sub.mbox_id].key? sub.pub_sub_pair_key)) then
+          raise ServerResponseChannelDetachError.new('unregistered pub-sub pair.', channel: self, subscriber: sub)
+        end
+
+        unless (@channel[sub.mbox_id][sub.pub_sub_pair_key] == sub) then
+          raise ServerResponseChannelDetachError.new('internal error: mismatched subscriber.', channel: self, subscribe: sub)
+        end
 
         @channel[sub.mbox_id].delete(sub.pub_sub_pair_key)
         if (@channel[sub.mbox_id].empty?) then
@@ -74,7 +95,12 @@ module RIMS
     end
 
     def publish(response_message)
-      @channel or raise 'detached publisher.'
+      unless (@channel) then
+        raise ServerResponseChannelPublishError.new('detached publisher.',
+                                                    publisher: self,
+                                                    pub_sub_pair_key: pub_sub_pair_key,
+                                                    message: response_message)
+      end
       @channel.publish(@mbox_id, pub_sub_pair_key, response_message)
       nil
     end
@@ -89,15 +115,14 @@ module RIMS
     # do not call this method directly, call the following method
     # instead.
     #   - ServerResponseChannel#make_pub_sub_pair
-    def initialize(channel, mbox_id, pub_sub_pair_key)
+    def initialize(channel, pub)
       @channel = channel
-      @mbox_id = mbox_id
-      @pub_sub_pair_key = pub_sub_pair_key
+      @pub = pub
       @queue = Thread::Queue.new
     end
 
-    attr_reader :mbox_id
-    attr_reader :pub_sub_pair_key
+    extend Forwardable
+    def_delegators :@pub, :mbox_id, :pub_sub_pair_key
 
     # do not call this method directly, call the following method
     # instead.

data/lib/rims/cmd.rb

@@ -1,13 +1,10 @@
 # -*- coding: utf-8 -*-
 
 require 'json'
-require 'logger'
 require 'net/imap'
 require 'optparse'
 require 'pp'if $DEBUG
 require 'riser'
-require 'syslog'
-require 'syslog/logger'
 require 'yaml'
 
 OptionParser.accept(JSON) do |json_data, *_|
@@ -61,7 +58,7 @@ module RIMS
       puts "commands:"
       w = CMDs.keys.map{|k| k.length }.max + 4
       fmt = "    %- #{w}s%s"
-      CMDs.each do |cmd_name, cmd_entry|
+      CMDs.sort_by{|cmd_name, _| cmd_name }.each do |cmd_name, cmd_entry|
         if ((! show_debug_command) && (cmd_name =~ /\A debug/x)) then
           next
         end
@@ -328,6 +325,16 @@ module RIMS
                  })
         }
       end
+      options.on('--daemon-umask=UMASK',
+                 Integer,
+                 "Umask(2). effective only with daemon command. default is `#{'%04o' % Service::DEFAULT_CONFIG.daemon_umask}'."
+                ) do |umask|
+        build.chain{|c|
+          c.load(daemon: {
+                   umask: umask
+                 })
+        }
+      end
       options.on('--status-file=FILE',
                  String,
                  "Name of status file. effective only with daemon command. default is `#{Service::DEFAULT_CONFIG.status_file}'."
@@ -465,6 +472,85 @@ 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|
+          c.load(charset: {
+                   use_default_aliases: use_default_aliases
+                 })
+        }
+      end
+      options.on('--add-charset-alias=NAME_TO_ENCODING',
+                 /\A \S+,\S+ \z/x,
+                 "Set the alias name and encoding separated with comma (,)."
+                ) do |name_to_encoding|
+        name, encoding = name_to_encoding.split(',', 2)
+        build.chain{|c|
+          c.load(charset: {
+                   aliases: [
+                     { name: name, encoding: encoding }
+                   ]
+                 })
+        }
+      end
+      options.on('--[no-]replace-charset-invalid'
+                ) do |replace|
+        build.chain{|c|
+          c.load(charset: {
+                   convert_options: {
+                     replace_invalid_byte_sequence: replace
+                   }
+                 })
+        }
+      end
+      options.on('--[no-]replace-charset-undef'
+                ) do |replace|
+        build.chain{|c|
+          c.load(charset: {
+                   convert_options: {
+                     replace_undefined_character: replace
+                   }
+                 })
+        }
+      end
+      options.on('--charset-replaced-mark=MARK',
+                 String
+                ) do |mark|
+        build.chain{|c|
+          c.load(charset: {
+                   convert_options: {
+                     replaced_mark: mark
+                   }
+                 })
+        }
+      end
       options.on('--drb-process-num=NUMBER',
                  Integer
                 ) do |num|
@@ -474,6 +560,15 @@ module RIMS
                  })
         }
       end
+      options.on('--drb-load-limit=SIZE',
+                 Integer
+                ) do |size|
+        build.chain{|c|
+          c.load(drb_services: {
+                   load_limit: size
+                 })
+        }
+      end
       options.on('--bulk-response-count=COUNT',
                  Integer) do |count|
         build.chain{|c|
@@ -484,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|
@@ -518,14 +623,7 @@ module RIMS
         }
       end
       options.on('--meta-kvs-type=TYPE',
-                 KeyValueStore::FactoryBuilder.plug_in_names,
-                 "Choose key-value store type of mailbox meta-data database" +
-                 if (KeyValueStore::FactoryBuilder.plug_in_names.length > 1) then
-                   ' (' + KeyValueStore::FactoryBuilder.plug_in_names.join(' ') + ')'
-                 else
-                   ''
-                 end +
-                 ". default is `" +
+                 "Choose key-value store type of mailbox meta-data database. default is `" +
                  KeyValueStore::FactoryBuilder.plug_in_names[0] +
                  "'."
                 ) do |kvs_type|
@@ -567,14 +665,7 @@ module RIMS
         }
       end
       options.on('--text-kvs-type=TYPE',
-                 KeyValueStore::FactoryBuilder.plug_in_names,
-                 "Choose key-value store type of mailbox text-data database" +
-                 if (KeyValueStore::FactoryBuilder.plug_in_names.length > 1) then
-                   ' (' + KeyValueStore::FactoryBuilder.plug_in_names.join(' ') + ')'
-                 else
-                   ''
-                 end +
-                 ". default is `" +
+                 "Choose key-value store type of mailbox text-data database. default is `" +
                  KeyValueStore::FactoryBuilder.plug_in_names[0] +
                  "'."
                 ) do |kvs_type|
@@ -627,7 +718,7 @@ module RIMS
       end
       options.on('--passwd-config=TYPE_JSONDATA',
                  /([^:]+)(?::(.*))?/,
-                 "Password source type (#{Authentication.plug_in_names.join(',')}) and configuration. format is `[type]:[json_data]'."
+                 "Password source type and configuration. format is `[type]:[json_data]'."
                 ) do |_, type, json_data|
         build.chain{|c|
           c.load(authentication: {
@@ -641,7 +732,7 @@ module RIMS
       end
       options.on('--passwd-file=TYPE_FILE',
                  /([^:]+):(.+)/,
-                 "Password source type (#{Authentication.plug_in_names.join(',')}) and configuration file. format is `[type]:[file]'."
+                 "Password source type and configuration file. format is `[type]:[file]'."
                 ) do |_, type, path|
         build.chain{|c|
           c.load(authentication: {
@@ -699,7 +790,6 @@ module RIMS
         build.chain{|c| c.load(ip_port: port) }
       end
       options.on('--kvs-type=TYPE',
-                 KeyValueStore::FactoryBuilder.plug_in_names,
                  'Deplicated.'
                 ) do |kvs_type|
         warn("warning: `--kvs-type=TYPE' is deplicated option and should use `--meta-kvs-type=TYPE' or `--text-kvs-type=TYPE'.")
@@ -907,14 +997,7 @@ module RIMS
       def key_value_store_option
         @conf[:key_value_store_type] = GDBM_KeyValueStore
         @options.on('--kvs-type=TYPE',
-                    KeyValueStore::FactoryBuilder.plug_in_names,
-                    "Choose key-value store type of mailbox database" +
-                    if (KeyValueStore::FactoryBuilder.plug_in_names.length > 1) then
-                      ' (' + KeyValueStore::FactoryBuilder.plug_in_names.join(' ') + ')'
-                    else
-                      ''
-                    end +
-                    ". default is `" +
+                    "Choose key-value store type of mailbox database. default is `" +
                     KeyValueStore::FactoryBuilder.plug_in_names[0] +
                     "'."
                    ) do |kvs_type|
@@ -1096,6 +1179,7 @@ module RIMS
         Riser::Daemon.start_daemon(daemonize: svc_conf.daemonize?,
                                    daemon_name: svc_conf.daemon_name,
                                    daemon_debug: svc_conf.daemon_debug?,
+                                   daemon_umask: svc_conf.daemon_umask,
                                    status_file: svc_conf.status_file,
                                    listen_address: proc{
                                      # to reload on server restart
@@ -1145,6 +1229,44 @@ module RIMS
     end
     command_function :cmd_daemon, "Daemon start/stop/status tool."
 
+    def cmd_environment(options, args)
+      format = {
+        yaml: lambda{|env|
+          YAML.dump(env)
+        },
+        json: lambda{|env|
+          JSON.pretty_generate(env)
+        }
+      }
+
+      conf = Config.new(options,
+                        [ [ :format_type,
+                            format.keys.first,
+                            '--format=FORMAT',
+                            format.keys,
+                            "Choose display format (#{format.keys.join(' ')})."
+                          ]
+                        ])
+      conf.required_feature_option
+      conf.setup_option_list
+      conf.parse_options!(args)
+
+      env = {
+        'RIMS Environment' => [
+          { 'RUBY VERSION' => RUBY_DESCRIPTION },
+          { 'RIMS VERSION' => RIMS::VERSION },
+          { 'AUTHENTICATION PLUG-IN' => Authentication.plug_in_names },
+          { 'KEY-VALUE STORE PLUG-IN' => KeyValueStore::FactoryBuilder.plug_in_names }
+        ]
+      }
+
+      formatter = format[conf[:format_type]]
+      puts formatter.call(env)
+
+      0
+    end
+    command_function :cmd_environment, 'Show rims environment.'
+
     def imap_append(imap, mailbox, message, store_flags: [], date_time: nil, verbose: false)
       puts "message date: #{date_time}" if (verbose && date_time)
       store_flags = nil if store_flags.empty?