ruote 0.9.19 → 0.9.20

data/lib/openwfe/expool/tc_expstorage.rb

@@ -0,0 +1,239 @@
+#--
+# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+#
+# 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 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.
+#
+# Made in Japan.
+#++
+
+
+require 'base64'
+
+require 'openwfe/flowexpressionid'
+require 'openwfe/expool/expstorage'
+
+require 'rufus/tokyo' # sudo gem install rufus-tokyo
+
+begin
+  require 'tokyocabinet' # attempting to load Hirabayashi-san's native bindings
+  require 'rufus/edo'
+rescue LoadError
+end
+
+
+module OpenWFE
+
+  #
+  # Tokyo Cabinet based expstorage.
+  #
+  # Places all the expressions under expstorage.tch in the work directory.
+  #
+  class TcExpressionStorage
+    include ServiceMixin
+    include OwfeServiceLocator
+    include ExpressionStorageBase
+
+    attr_reader :db, :path
+
+    def initialize (service_name, application_context)
+
+      service_init(service_name, application_context)
+
+      klass = (defined?(TokyoCabinet) &&
+        ( ! application_context[:use_rufus_tokyo])) ?
+        Rufus::Edo::Table : Rufus::Tokyo::Table
+
+      linfo { "using #{klass} to access TokyoCabinet" }
+
+      @path =
+        application_context[:expstorage_path] ||
+        get_work_directory + '/expstorage.tct'
+
+      @db = klass.new(@path)
+
+      set_indexes
+
+      observe_expool
+    end
+
+    #
+    # Takes care of closing the cabinet
+    #
+    def stop
+
+      self.close
+      super
+    end
+
+    #
+    # Returns the count of stored expressions
+    #
+    def size
+
+      @db.size
+    end
+    alias :length :size
+
+    def [] (fei)
+
+      v = @db[fei.as_string_key]
+
+      return nil unless v
+
+      fexp = Marshal.load(Base64.decode64(v['fexp']))
+
+      fexp.application_context = @application_context
+      fexp
+    end
+
+    def []= (fei, fexp)
+
+      @db[fei.as_string_key] = {
+        'wfid' => fexp.fei.wfid,
+        'pwfid' => fexp.fei.parent_workflow_instance_id,
+        'class' => fexp.class.name,
+        'fexp' => Base64.encode64(Marshal.dump(fexp))
+      }
+    end
+
+    def delete (fei)
+
+      @db.delete(fei.as_string_key)
+    end
+
+    def purge
+
+      @db.clear
+    end
+
+    #
+    # Finds expressions matching the given criteria (returns a list
+    # of expressions).
+    #
+    # This methods is called by the expression pool, it's thus not
+    # very "public" (not used directly by integrators, who should
+    # just focus on the methods provided by the Engine).
+    #
+    # :wfid ::
+    #   will list only one process,
+    #   <tt>:wfid => '20071208-gipijiwozo'</tt>
+    # :parent_wfid ::
+    #   will list only one process, and its subprocesses,
+    #   <tt>:parent_wfid => '20071208-gipijiwozo'</tt>
+    # :consider_subprocesses ::
+    #   if true, "process-definition" expressions
+    #   of subprocesses will be returned as well.
+    # :wfid_prefix ::
+    #   allows your to query for specific workflow instance
+    #   id prefixes. for example :
+    #   <tt>:wfid_prefix => "200712"</tt>
+    #   for the processes started in December.
+    # :include_classes ::
+    #   excepts a class or an array of classes, only instances of these
+    #   classes will be returned. Parent classes or mixins can be
+    #   given.
+    #   <tt>:includes_classes => OpenWFE::SequenceExpression</tt>
+    # :exclude_classes ::
+    #   works as expected.
+    # :wfname ::
+    #   will return only the expressions who belongs to the given
+    #   workflow [name].
+    # :wfrevision ::
+    #   usued in conjuction with :wfname, returns only the expressions
+    #   with a given workflow revision.
+    # :applied ::
+    #   if this option is set to true, will only return the expressions
+    #   that have been applied (exp.apply_time != nil).
+    #
+    def find_expressions (options={})
+
+      values = if wfid = options.delete(:wfid)
+        @db.query { |q|
+          q.add('wfid', :equals, wfid)
+        }
+      elsif pwfid = options.delete(:parent_wfid)
+        @db.query { |q|
+          q.add('pwfid', :equals, pwfid)
+        }
+      elsif wfidp = options.delete(:wfid_prefix)
+        @db.query { |q|
+          q.add('wfid', :starts_with, wfidp)
+        }
+      else
+        @db.values # everything
+      end
+
+      values.inject([]) { |a, v|
+        fexp = Marshal.load(Base64.decode64(v['fexp']))
+        if does_match?(options, fexp)
+          fexp.application_context = @application_context
+          a << fexp
+        end
+        a
+      }
+    end
+
+    #
+    # Attempts at fetching the root expression of a given process
+    # instance.
+    #
+    def fetch_root (wfid)
+
+      find_expressions(
+        :wfid => wfid,
+        :consider_subprocesses => false,
+        :include_classes => DefineExpression)[0]
+    end
+
+    #
+    # Used only by pooltool.ru
+    #
+    def each
+
+      return unless block_given?
+
+      @db.each do |k, v|
+        fexp = Marshal.load(Base64.decode64(v['fexp']))
+        yield(fexp.fei, fexp)
+      end
+    end
+
+    #
+    # Closes the underlying database
+    #
+    def close
+
+      @db.close
+      @db = nil
+    end
+
+    protected
+
+    #
+    # Sets the indexes for the Tokyo Cabinet/Tyrant table.
+    #
+    def set_indexes
+
+      @db.set_index(:pk, :lexical)
+      @db.set_index('wfid', :lexical)
+      @db.set_index('pwfid', :lexical)
+    end
+  end
+
+end

data/lib/openwfe/expool/{threadedexpstorage.rb → threaded_expstorage.rb}

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'thread'
 
@@ -63,12 +49,12 @@ module OpenWFE
     # makes sure that the queue isn't actually preparing a batch
     # before returning a result.
     #
-    def find_expressions (options)
+    def find_expressions (options={})
 
       Thread.pass
 
       @mutex.synchronize do
-        super
+        super(options)
       end
     end
 
@@ -93,7 +79,7 @@ module OpenWFE
               14.times { Thread.pass }
                 #
                 # gather some steam :
-                # let job accumulate
+                # let jobs accumulate
 
               @queue.size.times do
                 events << @queue.pop
@@ -146,7 +132,7 @@ module OpenWFE
           if event == :update
             self[fei] = fexp
           else
-            safe_delete fei
+            self.delete(fei)
           end
         rescue Exception => e
           lwarn do
@@ -156,20 +142,6 @@ module OpenWFE
         end
       end
 
-      #
-      # a call to delete that tolerates missing .yaml files
-      #
-      def safe_delete (fei)
-        begin
-          self.delete fei
-        rescue Exception => e
-        #  lwarn do
-        #    "safe_delete() exception\n" +
-        #    OpenWFE::exception_to_s(e)
-        #  end
-        end
-      end
-
       #
       # Adds the queue() method as an observer to the update and remove
       # events of the expression pool.
@@ -179,12 +151,12 @@ module OpenWFE
       def observe_expool
 
         get_expression_pool.add_observer(:update) do |event, fei, fe|
-          ldebug { ":update  for #{fei.to_debug_s}" }
-          queue event, fei, fe
+          #ldebug { ":update  for #{fei.to_debug_s}" }
+          queue(event, fei, fe)
         end
         get_expression_pool.add_observer(:remove) do |event, fei|
-          ldebug { ":remove  for #{fei.to_debug_s}" }
-          queue event, fei
+          #ldebug { ":remove  for #{fei.to_debug_s}" }
+          queue(event, fei)
         end
       end
   end

data/lib/openwfe/expool/tt_expstorage.rb

@@ -0,0 +1,55 @@
+#--
+# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+#
+# 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 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.
+#
+# Made in Japan.
+#++
+
+
+require 'openwfe/expool/tc_expstorage'
+
+require 'rufus/tokyo/tyrant' # sudo gem install rufus-tokyo
+
+# TODO : maybe implement a ntt_expstorage...
+
+
+module OpenWFE
+
+  #
+  # A Tokyo Tyrant based persistence for Ruote expressions.
+  #
+  class TtExpressionStorage < TcExpressionStorage
+
+    def initialize (service_name, application_context)
+
+      service_init(service_name, application_context)
+
+      host = application_context[:tyrant_expstorage_host] || '127.0.0.1'
+      port = application_context[:tyrant_expstorage_port] || 1978
+
+      @db = Rufus::Tokyo::TyrantTable.new(host, port)
+
+      set_indexes
+
+      observe_expool
+    end
+  end
+end
+

data/lib/openwfe/expool/wfidgen.rb

@@ -1,41 +1,26 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
-
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'thread'
 
@@ -63,7 +48,7 @@ module OpenWFE
 
       @last_fn = get_work_directory + '/wfidgen.last'
 
-      load_last()
+      load_last
 
       ensure_last_f
     end
@@ -164,14 +149,9 @@ module OpenWFE
 
           if File.exist?(@last_fn)
             begin
-              s = File.open(@last_fn, "r") do |f|
-                f.readline
-              end
+              s = File.open(@last_fn, 'r') { |f| f.readline }
               @last = Integer(s)
-              #puts @last
             rescue Exception => e
-              #puts
-              #puts e.to_s
             end
           end
 
@@ -208,8 +188,8 @@ module OpenWFE
       i = numeric_id % (10 * 1000 * 60 * 60 * 24)
       t = Time.now.gmtime
 
-      s = sprintf "%4d%02d%02d", t.year, t.month, t.day
-      s << "-"
+      s = sprintf '%4d%02d%02d', t.year, t.month, t.day
+      s << '-'
       s << Rufus::Mnemo::from_integer(i)
       s
     end
@@ -367,8 +347,8 @@ module OpenWFE
   #
 
   SPLIT_MAP = {
-    "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" => UuidWfidGenerator,
-    "[0-9]{8}-[a-z]*" => KotobaWfidGenerator
+    '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' => UuidWfidGenerator,
+    '[0-9]{8}-[a-z]*' => KotobaWfidGenerator
   }
 
   #