openwferu 0.9.9 → 0.9.10

data/examples/kotoba.rb

@@ -0,0 +1,22 @@
+
+require 'pp'
+require 'rubygems'
+require 'openwfe/util/kotoba'
+
+3.times do
+
+    i = (rand * 1000000).to_i
+    s = Kotoba::from_integer i
+
+    puts "#{i} => #{s}"
+    puts "#{s} => #{Kotoba::to_integer(s)}"
+        # forth and back
+
+    a = Kotoba::split s
+
+    print "#{s} => "; pp a
+        # showing how the 'word' is split
+
+    puts "."
+end
+

data/lib/openwfe/engine/engine.rb

@@ -128,13 +128,10 @@ module OpenWFE
         # either a String containing the URL of the process definition
         # to launch (with an empty LaunchItem created on the fly).
         #
-        # If async is set to true, the process will be launched asynchronously
-        # (in his own thread).
+        # Returns the FlowExpressionId instance of the expression at the
+        # root of the newly launched process.
         #
-        # Returns a FlowExpressionId instance or a tuple FlowExpressionId / 
-        # Thread object if async is set to true.
-        #
-        def launch (launch_object, async=false)
+        def launch (launch_object)
 
             launchitem = if launch_object.kind_of?(OpenWFE::LaunchItem)
 
@@ -158,7 +155,7 @@ module OpenWFE
                 li
             end
 
-            get_expression_pool.launch launchitem, async
+            get_expression_pool.launch launchitem
         end
 
         #
@@ -172,11 +169,11 @@ module OpenWFE
 
             if workitem.kind_of?(InFlowWorkItem)
 
-                get_expression_pool.reply(workitem.flow_expression_id, workitem)
+                get_expression_pool.reply workitem.flow_expression_id, workitem
 
             elsif workitem.kind_of?(LaunchItem)
 
-                get_expression_pool.launch(workitem, false)
+                get_expression_pool.launch workitem
 
             else
 
@@ -300,7 +297,7 @@ module OpenWFE
             OpenWFE::trap_int_irb(binding)
         end
 
-        #
+        #--
         # Makes sure that hitting CTRL-C will actually kill the engine VM and
         # not open an IRB console.
         #
@@ -310,6 +307,7 @@ module OpenWFE
         #        exit 0
         #    end
         #end
+        #++
 
         #
         # Stopping the engine will stop all the services in the
@@ -398,6 +396,44 @@ module OpenWFE
             get_expression_pool.forget(exp_or_fei)
         end
 
+        #
+        # Waits for a given process instance to terminate.
+        # The method only exits when the flow terminates, but beware : if
+        # the process already terminated, the method will never exit.
+        #
+        # The parameter can be a FlowExpressionId instance, for example the
+        # one given back by a launch(), or directly a workflow instance id 
+        # (String).
+        #
+        # This method is mainly used in utests.
+        #
+        def wait_for (fei_or_wfid)
+
+            wfid = if fei_or_wfid.kind_of?(FlowExpressionId)
+                fei_or_wfid.workflow_instance_id
+            else
+                fei_or_wfid
+            end
+
+            #Thread.pass
+            #    #
+            #    # let the flow 'stabilize' or progress before enquiring
+            #fexp = get_expression_pool.fetch_expression(fei)
+            #return unless fexp
+                #
+                # doesn't work well
+
+            t = Thread.new { Thread.stop }
+
+            get_expression_pool.add_observer(:terminate) do |channel, fe, wi|
+                t.wakeup if fe.fei.workflow_instance_id == wfid
+            end
+
+            ldebug { "wait_for() #{wfid}" }
+
+            t.join
+        end
+
         protected
 
             #

data/lib/openwfe/expool/expressionpool.rb

@@ -51,6 +51,7 @@ require 'openwfe/rudefinitions'
 require 'openwfe/flowexpressionid'
 require 'openwfe/util/lru'
 require 'openwfe/util/safe'
+require 'openwfe/util/workqueue'
 require 'openwfe/util/observable'
 require 'openwfe/expressions/environment'
 require 'openwfe/expressions/raw_xml'
@@ -130,7 +131,8 @@ module OpenWFE
             ServiceMixin, 
             MonitorMixin, 
             OwfeServiceLocator, 
-            Observable
+            Observable,
+            WorkqueueMixin
 
         SAFETY_LEVEL = 2
             #
@@ -148,6 +150,8 @@ module OpenWFE
             @observers = {}
 
             @stopped = false
+
+            start_workqueue
         end
 
         #
@@ -155,6 +159,7 @@ module OpenWFE
         #
         def stop
             @stopped = true
+            stop_workqueue
             onotify :stop
         end
 
@@ -204,16 +209,15 @@ module OpenWFE
         #
         # Instantiates a workflow definition and launches it.
         #
-        # If async is set to true, the launch will occur in its own thread.
+        # This method call will return immediately, it could even return
+        # before the actual launch is completely over.
         #
         # Returns the FlowExpressionId instance of the root expression of
         # the newly launched flow.
-        # If async is set to true, returns a tuple FlowExpressionId /
-        # Thread instance used.
         #
-        def launch (launchitem, async=false)
+        def launch (launchitem)
 
-            raw_expression = prepare_raw_expression(launchitem)
+            raw_expression = prepare_raw_expression launchitem
                 #
                 # will raise an exception if there are requirements
                 # and one of them is not met
@@ -224,25 +228,15 @@ module OpenWFE
                 # it has to have an environment for all the variables of 
                 # the process instance
 
-            wi = build_workitem(launchitem)
+            wi = build_workitem launchitem
 
             fei = raw_expression.fei
 
-            onotify :launch, launchitem.workflow_definition_url
-
-            if async
-
-                t = OpenWFE::call_in_thread "launch()", self do
-                    apply(raw_expression, wi)
-                end
-
-                return fei, t
-            end
+            onotify :launch, fei, launchitem
 
-            apply(raw_expression, wi)
+            apply raw_expression, wi
 
-            return fei
-            #return fei, Thread.current
+            fei
         end
 
         #
@@ -266,10 +260,6 @@ module OpenWFE
             #raise "did not find expression at #{template.to_s}" \
             #    unless rawexp
 
-            ldebug { "launch_template() request for #{rawexp.fei.to_debug_s}" }
-
-            onotify :launch_template, rawexp.fei
-
             rawexp = rawexp.dup()
             rawexp.fei = rawexp.fei.dup()
 
@@ -322,6 +312,8 @@ module OpenWFE
 
             workitem.flow_expression_id = rawexp.fei
 
+            onotify :launch_template, rawexp.fei, workitem
+
             apply rawexp, workitem
 
             rawexp.fei
@@ -349,26 +341,17 @@ module OpenWFE
         #
         def apply (exp, workitem)
 
-            exp, fei = fetch(exp) if exp.kind_of? FlowExpressionId
-
-            #ldebug { "apply()  '#{fei}' (#{fei.class})" }
-
-            if not exp
-                lwarn { "apply() cannot apply missing  #{fei.to_debug_s}" }
-                return
-            end
-
-            #ldebug { "apply()  #{fei.to_debug_s}" }
-
-            #exp.apply_time = OpenWFE::now()
-                #
-                # this is done in RawExpression
-
-            workitem.flow_expression_id = exp.fei
+            #do_apply exp, workitem
+            queue_work :do_apply, exp, workitem
+        end
 
-            onotify :apply, exp.fei, workitem
+        #
+        # Replies to a given expression
+        #
+        def reply (exp, workitem)
 
-            exp.apply(workitem)
+            #do_reply exp, workitem
+            queue_work :do_reply, exp, workitem
         end
 
         #
@@ -387,7 +370,7 @@ module OpenWFE
 
             ldebug { "cancel() for  #{fei.to_debug_s}" }
 
-            onotify :cancel, fei
+            onotify :cancel, exp
 
             inflowitem = exp.cancel()
             remove(exp)
@@ -401,7 +384,7 @@ module OpenWFE
         #
         def cancel_flow (exp_or_wfid)
 
-            ldebug { "cancel_flow() from  #{exp_or_wfid}" }
+            #ldebug { "cancel_flow() from  #{exp_or_wfid}" }
 
             root = fetch_root(exp_or_wfid)
             cancel(root)
@@ -420,7 +403,7 @@ module OpenWFE
 
             return if not exp
 
-            onotify :forget, fei
+            onotify :forget, exp
 
             parent_exp.children.delete(fei)
 
@@ -440,7 +423,7 @@ module OpenWFE
 
             workitem.last_expression_id = exp.fei
 
-            onotify :reply_to_parent, exp.fei, workitem
+            onotify :reply_to_parent, exp, workitem
 
             if remove
 
@@ -465,12 +448,13 @@ module OpenWFE
             # flow terminated ?
 
             if not exp.parent_id
+
                 ldebug do 
                     "reply_to_parent() process " +
                     "#{exp.fei.workflow_instance_id} terminated"
                 end
 
-                onotify :terminate, exp.fei
+                onotify :terminate, exp, workitem
 
                 return
             end
@@ -493,27 +477,6 @@ module OpenWFE
             reply exp.parent_id, workitem
         end
 
-        #
-        # Triggers the reply expression of the expression given by its id.
-        #
-        def reply (exp, workitem)
-
-            exp, fei = fetch(exp)
-
-            ldebug { "reply() to   #{fei.to_debug_s}" }
-            ldebug { "reply() from #{workitem.last_expression_id.to_debug_s}" }
-
-            if not exp
-                #raise "cannot reply to missing  #{fei.to_debug_s}"
-                lwarn { "reply() cannot reply to missing  #{fei.to_debug_s}" }
-                return
-            end
-
-            onotify :reply, fei, workitem
-
-            exp.reply(workitem)
-        end
-
         #
         # Adds or updates a flow expression in this pool
         #
@@ -754,9 +717,59 @@ module OpenWFE
 
         protected
 
-            #def evaluate_definition (raw_definition, workitem)
-            #    expression = raw_definition.instantiate(workitem)
-            #end
+            def do_process_workelement elt
+
+                message, fei, workitem = elt
+                send message, fei, workitem
+            end
+
+            #
+            # The real apply work.
+            #
+            def do_apply (exp, workitem)
+
+                exp, fei = fetch(exp) if exp.kind_of? FlowExpressionId
+
+                #ldebug { "apply()  '#{fei}' (#{fei.class})" }
+
+                if not exp
+                    lwarn { "apply() cannot apply missing  #{fei.to_debug_s}" }
+                    return
+                end
+
+                #ldebug { "apply()  #{fei.to_debug_s}" }
+
+                #exp.apply_time = OpenWFE::now()
+                    #
+                    # this is done in RawExpression
+
+                workitem.flow_expression_id = exp.fei
+
+                onotify :apply, exp, workitem
+
+                exp.apply(workitem)
+            end
+
+            #
+            # The real reply work is done here
+            #
+            def do_reply (exp, workitem)
+
+                exp, fei = fetch(exp)
+
+                ldebug { "reply() to   #{fei.to_debug_s}" }
+                ldebug { "reply() from #{workitem.last_expression_id.to_debug_s}" }
+
+                if not exp
+                    #raise "cannot reply to missing  #{fei.to_debug_s}"
+                    lwarn { "reply() cannot reply to missing  #{fei.to_debug_s}" }
+                    return
+                end
+
+                onotify :reply, exp, workitem
+
+                exp.reply(workitem)
+            end
 
             #
             # Removes an environment, especially takes care of unbinding

data/lib/openwfe/expool/history.rb

@@ -42,6 +42,7 @@
 #require 'date'
 
 require 'openwfe/service'
+require 'openwfe/omixins'
 require 'openwfe/rudefinitions'
 
 
@@ -73,6 +74,7 @@ module OpenWFE
     #
     class BaseHistory 
         include HistoryMixin
+        include FeiMixin
 
         attr_reader :entries
 
@@ -93,8 +95,10 @@ module OpenWFE
 
             msg << event.to_s
 
-            msg << " #{args[0].to_s}" \
-                if args.length > 0
+            if args.length > 0
+                fei = extract_fei args[0]
+                msg << " #{fei.to_s}"
+            end
 
             #msg << " #{args[1].to_s}" \
             #    if args.length > 1

data/lib/openwfe/expool/journal.rb

@@ -43,6 +43,7 @@ require 'monitor'
 require 'fileutils'
 
 require 'openwfe/service'
+require 'openwfe/omixins'
 require 'openwfe/rudefinitions'
 require 'openwfe/flowexpressionid'
 require 'openwfe/util/otime'
@@ -58,6 +59,7 @@ module OpenWFE
     class Journal < Service
         include MonitorMixin, OwfeServiceLocator
         include JournalReplay
+        include FeiMixin
 
         attr_reader :workdir, :donedir
 
@@ -77,7 +79,7 @@ module OpenWFE
             FileUtils.makedirs(@donedir) unless File.exist?(@donedir)
 
             get_expression_pool.add_observer(:all) do |event, *args|
-                #ldebug { ":#{event}  for #{args[0].to_debug_s}" }
+                #ldebug { ":#{event}  for #{args[0].class.name}" }
                 queue_event(event, *args)
             end
 
@@ -109,8 +111,12 @@ module OpenWFE
                     return if event == :launch
                     return if event == :reschedule
 
-                    wfid = args[0].parent_wfid
-                    #puts "__#{wfid} : #{event}"
+                    #wfid = args[0].parent_wfid
+                    wfid = extract_fei(args[0]).parent_wfid
+                        #
+                        # maybe args[0] could be a FlowExpression instead
+                        # of a FlowExpressionId instance
+                    #puts "___#{event}__wfid : #{wfid}"
 
                     e = serialize_event(event, *args)
 

data/lib/openwfe/expool/journal_replay.rb

@@ -47,7 +47,7 @@ module OpenWFE
     #
     # The code decicated to replay and reconstitute journal.
     #
-    module JournalReplay
+    module JournalReplay 
 
         #
         # Replays a given journal file.
@@ -83,10 +83,12 @@ module OpenWFE
 
             return unless trigger_action
 
+            #puts "sds : #{state.dynamic.size}"
+
             state.dynamic.each do |ply|
 
                 message = ply[0]
-                fei = ply[2]
+                fei = extract_fei(ply[2])
                 wi = ply[3]
 
                 if wi
@@ -203,7 +205,7 @@ module OpenWFE
                 dynamic = []
                 events.reverse.each do |e|
                     etype = e[0]
-                    fei = e[2]
+                    fei = extract_fei e[2]
                     next if etype == :update
                     next if etype == :remove
                     #next if etype == :reply_to_parent
@@ -217,6 +219,7 @@ module OpenWFE
             end
 
             class ExpoolState
+                include FeiMixin
 
                 attr_accessor \
                     :offset,
@@ -241,13 +244,13 @@ module OpenWFE
                     s << "\n"
                     s << "static :\n"
                     @static.each do |e|
-                        s << " - #{e[0]}   #{e[2].to_short_s}\n"
+                        s << " - #{e[0]}   #{extract_fei(e[2]).to_short_s}\n"
                     end
 
                     s << "\n"
                     s << "dynamic :\n"
                     @dynamic.each do |e|
-                        s << " - #{e[0]}   #{e[2].to_short_s}\n"
+                        s << " - #{e[0]}   #{extract_fei(e[2]).to_short_s}\n"
                     end
 
                     #s << "\n"

data/lib/openwfe/expressions/fe_participant.rb

@@ -57,9 +57,40 @@ module OpenWFE
     # to it to the Participant instance it looks up in the participant map
     # tied to the engine.
     #
+    #     <participant ref="alpha" />
+    #         <!-- direct reference to participant alpha -->
+    #
+    #     <participant field-ref="target" />
+    #     <participant ref="${f:target}" />
+    #         <!-- the name of the participant is the value found in 
+    #              the field 'target' -->
+    #
+    #     <participant variable-ref="target" />
+    #     <participant ref="${target}" />
+    #         <!-- the name of the participant is the value found in 
+    #              the variable 'target' -->
+    #
+    #     <alpha />
+    #         <!-- direct reference to participant 'alpha'
+    #              if a subprocess named 'alpha' has been defined, the 
+    #              subprocess will be called instead -->
+    #
     # The Participant expressions includes the FilterMixin and thus
     # understands and applies the "filter" attribute.
     #
+    # Since OpenWFE 0.9.9, the attributes of the participant expression are
+    # set inside a hash field named 'params' just available to the participant.
+    # Thus in
+    #
+    #     <participant ref="toto" task="play golf" location="Minami Center" />
+    #
+    # participant 'toto' will receive a workitem with a field named 'params'
+    # containing the hash 
+    # { "ref"=>"toto", "task"=>"play golf", "location"=>"Minami Center" }.
+    # 
+    # When the workitem gets back from the participant, the field 'params' is 
+    # deleted.
+    #
     class ParticipantExpression < FlowExpression
         include FilterMixin
         include TimeoutMixin
@@ -91,7 +122,7 @@ module OpenWFE
             
             workitem.params = lookup_attributes workitem
 
-            get_participant_map.dispatch(@participant_name, workitem)
+            get_participant_map.dispatch @participant_name, workitem
         end
 
         def reply_to_parent (workitem)

data/lib/openwfe/filterdef.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, Nicolas Modrzyk OpenWFE.org
+# Copyright (c) 2007, John Mettraux OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 

data/lib/openwfe/omixins.rb

@@ -0,0 +1,70 @@
+#
+#--
+# Copyright (c) 2007, 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:
+# 
+# . Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.  
+# 
+# . 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.
+# 
+# . 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.
+# 
+# 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.
+#++
+#
+# $Id: utils.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# john.mettraux@openwfe.org
+#
+
+require 'openwfe/flowexpressionid'
+
+
+module OpenWFE
+
+    #
+    # A few methods about FlowExpressionIds
+    #
+    module FeiMixin
+
+        #
+        # Makes sure to return a FlowExpressionId instance.
+        #
+        def extract_fei (object)
+
+            if object.kind_of?(FlowExpressionId)
+                object
+            elsif object.kind_of?(FlowExpression) or object.kind_of?(InFlowItem)
+                object.fei
+            elsif object.kind_of?(String)
+                FlowExpressionId.to_fei object
+            else
+                raise "cannot extract FlowExpressionId out of #{object.inspect}"
+            end
+        end
+    end
+    
+end
+