rims 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29c18b0a88fc771e30319973c66baff76e8a4c6c9d7bc9c8c239dd78cf25b9c1
-  data.tar.gz: d6e6f213bfea0ff8684de0b79e625face9f6ad22c6e6f94d23aaa900ca526805
+  metadata.gz: 299a57cf042b4a2854a5e040af070bbef170044d8cedbac0c4587559018deb45
+  data.tar.gz: f9f6f5a9654c9b84c7978c4d6aa15d6243150811ee7a70b6110ee1e40eb1753f
 SHA512:
-  metadata.gz: ee07de390442b50d654e4290488be4ca99b72ee42ca6f4dcae6a745a43155d001284d8356a56ab4231ecd3dfc19a02965efd6fd007e5ec44c2f3128d9e296896
-  data.tar.gz: 4519d3182df3ada8bf8a9cf6fa1a8d89673db9fdb7f500735fbf703e211dce4a851e5e9630976be3de89839eb79541aec75d87fc409a11560005d1b10a110064
+  metadata.gz: 8f7009d59c5a09874933e75a9cea109367fb8f1ef4f1a2718a19536df1055fe7f5e7a60392bc50cf14b964e103ee7c2aa43493b6bf6790c8cba8083605edf3f8
+  data.tar.gz: 78c978afee91b8f5a7ef769a55d4a62d5b2e138d7ef8c6d9ddf5942a997ea772dc1aa317915f72973c42e6b77b7a2cd7acce8a8bae6f9f402d19268524e3b8dc

data/ChangeLog

@@ -1,8 +1,41 @@
+2019-03-06  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* RIMS version 0.2.2 is released.
+
+2019-03-03  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/test.rb: key-value store. closed error at test utility
+	is able to changed.
+
+	* test/test_cksum_kvs.rb, test/test_db.rb,
+	test/test_db_recovery.rb, test/test_lock.rb,
+	test/test_mail_store.rb, test/test_protocol_decoder.rb,
+	test/test_protocol_fetch.rb: check error messages at test.
+
+	* lib/rims/channel.rb: refactor channel for untagged server
+	response.
+
+2019-03-02  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/channel.rb, lib/rims/mail_store.rb: untagged servere
+	response mechanism is changed. server response queue is replaced
+	to server response channel.
+
+2019-02-26  TOKI Yoshinori  <toki@freedom.ne.jp>
+
+	* lib/rims/mail_store.rb, lib/rims/pool.rb: generic object
+	pool. object's Lock has to be owned to the object that needs to
+	lock.
+
+	object pool no longer has object lock.
+	mail store now has read-write lock.
+	response queue bundle now has mutex lock.
+
 2019-02-18  TOKI Yoshinori  <toki@freedom.ne.jp>
 
-	* README.md, rims.gemspec: fixed for release to rubygems.
+	* RIMS version 0.2.1 is released.
 
-	* lib/rims/version.rb : start to version 0.2.1.
+	* README.md, rims.gemspec: fixed for release to rubygems.
 
 2018-12-02  TOKI Yoshinori  <toki@freedom.ne.jp>
 

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2013-2014 TOKI Yoshinori
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2013-2019 TOKI Yoshinori
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/rims.rb

@@ -33,6 +33,7 @@ module RIMS
   autoload :ReadLockTimeoutError, 'rims/lock'
   autoload :ReadWriteLock, 'rims/lock'
   autoload :Server, 'rims/server'
+  autoload :ServerResponseChannel, 'rims/channel'
   autoload :SyntaxError, 'rims/protocol'
   autoload :Test, 'rims/test'
   autoload :WriteLockError, 'rims/lock'

data/lib/rims/channel.rb

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+
+module RIMS
+  class ServerResponseChannel
+    def initialize
+      @mutex = Thread::Mutex.new
+      @channel = {}
+    end
+
+    def make_pub_sub_pair(mbox_id)
+      pub = ServerResponsePublisher.new(self, mbox_id)
+      sub = ServerResponseSubscriber.new(self, mbox_id, pub.pub_sub_pair_key)
+      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.'
+        @channel[sub.mbox_id][sub.pub_sub_pair_key] = sub
+      }
+
+      sub
+    end
+    private :attach
+
+    # do not call this method directly, call the following method
+    # instead.
+    #   - ServerResponsePublisher#detach
+    #   - 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.'
+
+        @channel[sub.mbox_id].delete(sub.pub_sub_pair_key)
+        if (@channel[sub.mbox_id].empty?) then
+          @channel.delete(sub.mbox_id)
+        end
+      }
+
+      nil
+    end
+
+    # do not call this method directly, call the following method
+    # instead.
+    #   - ServerResponsePublisher#publish
+    def publish(mbox_id, pub_sub_pair_key, response_message)
+      @mutex.synchronize{
+        @channel[mbox_id].each_value do |sub|
+          if (sub.pub_sub_pair_key != pub_sub_pair_key) then
+            sub.publish(response_message)
+          end
+        end
+      }
+
+      nil
+    end
+  end
+
+  class ServerResponsePublisher
+    # do not call this method directly, call the following method
+    # instead.
+    #   - ServerResponseChannel#make_pub_sub_pair
+    def initialize(channel, mbox_id)
+      @channel = channel
+      @mbox_id = mbox_id
+    end
+
+    attr_reader :mbox_id
+
+    def pub_sub_pair_key
+      object_id
+    end
+
+    def publish(response_message)
+      @channel or raise 'detached publisher.'
+      @channel.publish(@mbox_id, pub_sub_pair_key, response_message)
+      nil
+    end
+
+    def detach
+      @channel = nil
+      nil
+    end
+  end
+
+  class ServerResponseSubscriber
+    # 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)
+      @channel = channel
+      @mbox_id = mbox_id
+      @pub_sub_pair_key = pub_sub_pair_key
+      @queue = Thread::Queue.new
+    end
+
+    attr_reader :mbox_id
+    attr_reader :pub_sub_pair_key
+
+    # do not call this method directly, call the following method
+    # instead.
+    #   - ServerResponsePublisher#publish
+    def publish(response_message)
+      @queue.push(response_message)
+      nil
+    end
+
+    def detach
+      @channel.detach(self)
+      nil
+    end
+
+    def message?
+      ! @queue.empty?
+    end
+
+    def fetch
+      while (message?)
+        response_message = @queue.pop(true)
+        yield(response_message)
+      end
+
+      nil
+    end
+
+    def idle_wait
+      catch(:idle_interrupt) {
+        while (response_message = @queue.pop(false))
+          message_list = [ response_message ]
+          fetch{|next_response_message|
+            if (next_response_message) then
+              message_list << next_response_message
+            else
+              yield(message_list)
+              throw(:idle_interrupt)
+            end
+          }
+          yield(message_list)
+        end
+      }
+
+      nil
+    end
+
+    def idle_interrupt
+      @queue.push(nil)
+      nil
+    end
+  end
+end
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/lib/rims/cmd.rb

@@ -706,11 +706,11 @@ module RIMS
       conf.help_option(add_banner: <<-'EOF'.chomp)
  passwd_plain.yml
 Example
-  $ cat passwd_plain.yml 
+  $ cat passwd_plain.yml
   - { user: foo, pass: open_sesame }
   - { user: "#postman", pass: "#postman" }
-  $ rims pass-hash passwd_plain.yml >passwd_hash.yml 
-  $ cat passwd_hash.yml 
+  $ rims pass-hash passwd_plain.yml >passwd_hash.yml
+  $ cat passwd_hash.yml
   ---
   - user: foo
     hash: SHA256:10000:YkslZucwN2QJ7LOft59Pgw==:d5dca9109cc787220eba65810e40165079ce3292407e74e8fbd5c6a8a9b12204

data/lib/rims/mail_store.rb

@@ -3,13 +3,16 @@
 require 'forwardable'
 require 'logger'
 require 'set'
-require 'thread'
 
 module RIMS
   class MailStore
+    extend Forwardable
+
     MSG_FLAG_NAMES = %w[ answered flagged deleted seen draft recent ].each{|n| n.freeze }.freeze
 
     def initialize(meta_db, msg_db, &mbox_db_factory) # :yields: mbox_id
+      @rw_lock = ReadWriteLock.new
+
       @meta_db = meta_db
       @msg_db = msg_db
       @mbox_db_factory = mbox_db_factory
@@ -26,11 +29,11 @@ module RIMS
         @meta_db.dirty = true
       end
 
-      @server_response_queue_pool = RIMS::ObjectPool.new{|object_pool, mbox_id, object_lock|
-        MailboxServerResponseQueueBundleHolder.new(object_pool, mbox_id, object_lock)
-      }
+      @channel = ServerResponseChannel.new
     end
 
+    def_delegators :@rw_lock, :read_synchronize, :write_synchronize
+
     def get_mbox_db(mbox_id)
       if (@mbox_db.key? mbox_id) then
         @mbox_db[mbox_id] ||= @mbox_db_factory.call(mbox_id)
@@ -347,29 +350,30 @@ module RIMS
 
     def select_mbox(mbox_id)
       @meta_db.mbox_name(mbox_id) or raise "not found a mailbox: #{mbox_id}."
-      MailFolder.new(mbox_id, self).attach_server_response_queue(@server_response_queue_pool)
+      MailFolder.new(mbox_id, self).attach(@channel)
     end
 
     def examine_mbox(mbox_id)
       @meta_db.mbox_name(mbox_id) or raise "not found a mailbox: #{mbox_id}."
-      MailFolder.new(mbox_id, self, read_only: true).attach_server_response_queue(@server_response_queue_pool)
+      MailFolder.new(mbox_id, self, read_only: true).attach(@channel)
     end
 
     def self.build_pool(kvs_meta_open, kvs_text_open)
-      RIMS::ObjectPool.new{|object_pool, unique_user_id, object_lock|
-        RIMS::MailStoreHolder.build(object_pool, unique_user_id, object_lock, kvs_meta_open, kvs_text_open)
+      RIMS::ObjectPool.new{|object_pool, unique_user_id|
+        RIMS::MailStoreHolder.build(object_pool, unique_user_id, kvs_meta_open, kvs_text_open)
       }
     end
   end
 
   class MailFolder
+    extend Forwardable
+
     MessageStruct = Struct.new(:uid, :num)
 
     def initialize(mbox_id, mail_store, read_only: false)
       @mbox_id = mbox_id
       @mail_store = mail_store
       @read_only = read_only
-      @mail_folder_key = object_id
 
       # late loding
       @cnum = nil
@@ -377,50 +381,16 @@ module RIMS
       @uid_map = nil
     end
 
-    def attach_server_response_queue(server_response_queue_pool)
-      @server_response_queue_bundle = server_response_queue_pool.get(@mbox_id)
-      @server_response_queue = @server_response_queue_bundle.attach_queue(@mail_folder_key)
-      self
-    end
-
-    def server_response_multicast_push(server_response_message)
-      @server_response_queue_bundle.multicast_push(server_response_message, @mail_folder_key)
-      self
-    end
-
-    def server_response?
-      ! @server_response_queue.empty?
-    end
-
-    def server_response_fetch
-      while (server_response?)
-        server_response_message = @server_response_queue.pop(true)
-        yield(server_response_message)
-      end
-      self
-    end
-
-    def server_response_idle_wait
-      catch(:server_response_idle_wait_interrupt) {
-        while (server_response_message = @server_response_queue.pop(false))
-          server_response_list = [ server_response_message ]
-          server_response_fetch{|next_response_message|
-            if (next_response_message) then
-              server_response_list.push(next_response_message)
-            else
-              yield(server_response_list)
-              throw(:server_response_idle_wait_interrupt)
-            end
-          }
-          yield(server_response_list)
-        end
-      }
+    def attach(server_response_channel)
+      @pub, @sub = server_response_channel.make_pub_sub_pair(@mbox_id)
       self
     end
 
-    def server_response_idle_interrupt
-      @server_response_queue.push(nil)
-    end
+    def_delegator :@pub, :publish,        :server_response_multicast_push
+    def_delegator :@sub, :message?,       :server_response?
+    def_delegator :@sub, :fetch,          :server_response_fetch
+    def_delegator :@sub, :idle_wait,      :server_response_idle_wait
+    def_delegator :@sub, :idle_interrupt, :server_response_idle_interrupt
 
     def reload
       @cnum = @mail_store.cnum
@@ -532,11 +502,8 @@ module RIMS
         end
       end
       @mail_store = nil
-
-      @server_response_queue_bundle.detach_queue(@mail_folder_key)
-      @server_response_queue_bundle.return_pool
-      @server_response_queue_bundle = nil
-
+      @pub.detach
+      @sub.detach
       self
     end
 
@@ -596,7 +563,7 @@ module RIMS
   class MailStoreHolder < ObjectPool::ObjectHolder
     extend Forwardable
 
-    def self.build(object_pool, unique_user_id, object_lock, kvs_meta_open, kvs_text_open)
+    def self.build(object_pool, unique_user_id, kvs_meta_open, kvs_text_open)
       kvs_build = proc{|kvs_open, db_name|
         kvs_open.call(MAILBOX_DATA_STRUCTURE_VERSION, unique_user_id, db_name)
       }
@@ -607,54 +574,23 @@ module RIMS
       }
       mail_store.add_mbox('INBOX') unless mail_store.mbox_id('INBOX')
 
-      new(object_pool, unique_user_id, object_lock, mail_store)
+      new(object_pool, unique_user_id, mail_store)
     end
 
-    def initialize(object_pool, unique_user_id, object_lock, mail_store)
+    def initialize(object_pool, unique_user_id, mail_store)
       super(object_pool, unique_user_id)
-      @object_lock = object_lock
       @mail_store = mail_store
     end
 
     alias unique_user_id object_key
     attr_reader :mail_store
 
-    def_delegator :@object_lock, :read_synchronize
-    def_delegator :@object_lock, :write_synchronize
+    def_delegators :@mail_store, :read_synchronize, :write_synchronize
 
     def object_destroy
       @mail_store.close
     end
   end
-
-  class MailboxServerResponseQueueBundleHolder < ObjectPool::ObjectHolder
-    def initialize(object_pool, mbox_id, object_lock)
-      super(object_pool, mbox_id)
-      @object_lock = object_lock
-      @queue_map = Hash.new{|h, k| h[k] = Thread::Queue.new }
-    end
-
-    alias mbox_id object_id
-
-    def attach_queue(mail_folder_key)
-      @object_lock.write_synchronize{ @queue_map[mail_folder_key] }
-    end
-
-    def detach_queue(mail_folder_key)
-      @object_lock.write_synchronize{ @queue_map.delete(mail_folder_key) } or raise "not found a queue at mail folder key: #{mail_folder_key}"
-      self
-    end
-
-    def multicast_push(server_response_message, this_mail_folder_key)
-      @object_lock.read_synchronize{
-        for mail_folder_key, queue in @queue_map
-          next if (mail_folder_key == this_mail_folder_key)
-          queue.push(server_response_message)
-        end
-      }
-      self
-    end
-  end
 end
 
 # Local Variables: