openwferu 0.9.3 → 0.9.4

data/examples/flowtracing.rb

@@ -0,0 +1,22 @@
+
+#
+# a little script that traces the flow given as input
+#
+
+require 'openwfe/expressions/raw_prog'
+require 'openwfe/tools/flowtracer'
+
+class MyProcessDefinition < OpenWFE::ProcessDefinition
+    def make
+        process_definition :name => "mpd", :revision => "0" do
+            sequence do
+                participant "alpha"
+                set :field => "toto", :value => "toto value"
+                participant "bravo"
+            end
+        end
+    end
+end
+
+OpenWFE::trace_flow(MyProcessDefinition)
+

data/lib/openwfe/contextual.rb

@@ -68,10 +68,13 @@ module OpenWFE
         #
         # Use reflection to instantiate the new service,and 
         # add it to the application context
+        # The service_name can be a String or a Symbol (which will be
+        # turned into a String).
         #
         def init_service (service_name, service_class)
-            @application_context[service_name] = \
-                service_class.new(service_name,@application_context)
+
+            @application_context[service_name.to_s] =
+                service_class.new(service_name, @application_context)
         end
 
     end

data/lib/openwfe/def.rb

@@ -0,0 +1,47 @@
+#
+#--
+# 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: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+#
+# just a redirection
+#
+#     require 'openwfe/def'
+#
+# being shorter and easier to remember than
+#
+#     require 'openwfe/expressions/raw_prog'
+#
+
+require 'openwfe/expressions/raw_prog'
+

data/lib/openwfe/engine/engine.rb

@@ -112,7 +112,7 @@ module OpenWFE
         #
         def reply (workitem)
 
-            get_expression_pool.reply(workitem.last_expression_id, workitem)
+            get_expression_pool.reply(workitem.flow_expression_id, workitem)
         end
 
         #

data/lib/openwfe/engine/file_persisted_engine.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, Nicolas Modryzk, OpenWFE.org
+# Copyright (c) 2006-2007, Nicolas Modryzk and John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -52,14 +52,12 @@ module OpenWFE
     class FilePersistedEngine < Engine
 
       #
-      # overrides the method already found in Engine with a persisted 
+      # Overrides the method already found in Engine with a persisted 
       # expression storage
       #
       def build_expression_storage ()
-          #FileExpressionStorage \
-          #    .new(S_EXPRESSION_STORAGE, @application_context, ENV['HOME'])
 
-          @application_context[:file_expression_storage_path] = "./work"
+          @application_context[:work_directory] = "./work"
 
           init_service(S_EXPRESSION_STORAGE, YamlFileExpressionStorage)
       end

data/lib/openwfe/expool/expressionpool.rb

@@ -51,6 +51,7 @@ require 'openwfe/rudefinitions'
 require 'openwfe/flowexpressionid'
 require 'openwfe/util/stoppable'
 require 'openwfe/util/lru_cache'
+require 'openwfe/util/observable'
 require 'openwfe/expressions/environment'
 require 'openwfe/expressions/raw_xml'
 
@@ -122,7 +123,12 @@ module OpenWFE
     # expressions.
     #
     class ExpressionPool
-        include ServiceMixin, MonitorMixin, OwfeServiceLocator, Stoppable
+        include \
+            ServiceMixin, 
+            MonitorMixin, 
+            OwfeServiceLocator, 
+            Stoppable, 
+            Observable
 
         @@last_given_instance_id = -1
             #
@@ -136,6 +142,8 @@ module OpenWFE
 
             @monitors = MonitorProvider.new(application_context)
 
+            @observers = {}
+
             reschedule_a_bit_later
         end
 
@@ -145,6 +153,8 @@ module OpenWFE
         def stop
             # would an alias be better ?
             do_stop
+            
+            onotify :stop
         end
 
         #
@@ -161,6 +171,8 @@ module OpenWFE
         #
         def launch (launchitem)
 
+            onotify :launch, launchitem.workflow_definition_url
+
             rawExpression = buildRawExpression(launchitem)
 
             wi = build_workitem(launchitem)
@@ -188,6 +200,8 @@ module OpenWFE
 
             ldebug { "launch_template() request for #{rawexp.fei.to_debug_s}" }
 
+            onotify :launch_template, rawexp.fei
+
             rawexp = rawexp.dup()
             rawexp.fei = rawexp.fei.dup()
 
@@ -226,8 +240,12 @@ module OpenWFE
 
             rawexp.store_itself()
 
+            workitem.flow_expression_id = rawexp.fei
+
             rawexp.apply(workitem)
 
+            # why not : launch in a thread and reply immediately
+
             return workitem.flow_expression_id
         end
 
@@ -249,16 +267,18 @@ module OpenWFE
 
             exp, fei = fetch(exp)
 
-            ldebug { "apply()  '#{fei}' (#{fei.class})" }
+            #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}" }
+            #ldebug { "apply()  #{fei.to_debug_s}" }
+
+            onotify :apply, fei, workitem
 
-            workitem.last_expression_id = exp.fei
+            workitem.flow_expression_id = exp.fei
 
             exp.apply(workitem)
         end
@@ -277,6 +297,8 @@ module OpenWFE
 
             ldebug { "cancel() for  #{fei.to_debug_s}" }
 
+            onotify :cancel, fei
+
             inflowitem = exp.cancel()
             remove(exp)
 
@@ -293,6 +315,8 @@ module OpenWFE
 
             return if not exp
 
+            onotify :forget, fei
+
             exp.parent_id = GONE_PARENT_ID
             exp.store_itself()
         end
@@ -306,6 +330,8 @@ module OpenWFE
 
             workitem.last_expression_id = fei
 
+            onotify :reply_to_parent, fei, workitem
+
             #remove(exp, workitem)
             remove(exp)
 
@@ -347,6 +373,8 @@ module OpenWFE
                 return
             end
 
+            onotify :reply, fei, workitem
+
             exp.reply(workitem)
         end
 
@@ -355,6 +383,8 @@ module OpenWFE
         #
         def update (flowExpression)
 
+            onotify :update, flowExpression.fei, flowExpression
+
             get_expression_storage()[flowExpression.fei] = flowExpression
         end
 
@@ -422,6 +452,8 @@ module OpenWFE
 
             ldebug { "remove()  fe  #{fei.to_debug_s}" }
 
+            onotify :remove, fei
+
             synchronize do
 
                 @monitors.delete(fei)
@@ -462,6 +494,8 @@ module OpenWFE
 
                     ldebug { "reschedule() for  #{fe.fei.to_debug_s}..." }
 
+                    onotify :reschedule, fe.fei
+
                     fe.reschedule(get_scheduler)
                 end
 
@@ -478,7 +512,7 @@ module OpenWFE
             synchronize do
                 return @eei if @eei
                 @eei = FlowExpressionId.new
-                @eei.owfe_version = OPENWFE_VERSION
+                @eei.owfe_version = OPENWFERU_VERSION
                 @eei.engine_id = get_engine.service_name
                 @eei.initial_engine_id = @eei.engine_id
                 @eei.workflow_definition_url = 'ee'
@@ -517,8 +551,13 @@ module OpenWFE
             end
 
             def remove_environment (environment_id)
+
+                ldebug { "remove_environment()  #{environment_id.to_debug_s}" }
+
                 env, fei = fetch(environment_id)
+
                 env.unbind()
+
                 get_expression_storage().delete(environment_id)
             end
 
@@ -586,7 +625,7 @@ module OpenWFE
 
                 fei = FlowExpressionId.new
 
-                fei.owfe_version = OPENWFE_VERSION
+                fei.owfe_version = OPENWFERU_VERSION
                 fei.engine_id = get_engine.service_name
                 fei.initial_engine_id = fei.engine_id
                 fei.workflow_definition_url = flow_url

data/lib/openwfe/expool/history.rb

@@ -0,0 +1,117 @@
+#
+#--
+# 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: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+#require 'monitor'
+
+require 'openwfe/service'
+require 'openwfe/rudefinitions'
+
+
+module OpenWFE
+    
+    #
+    # The base implementation for History modules
+    #
+    module HistoryMixin
+        include ServiceMixin, OwfeServiceLocator
+
+        def service_init (service_name, application_context)
+
+            super
+
+            get_expression_pool.add_observer(:all) do |event, *args|
+                log(event, *args)
+            end
+        end
+
+        def log (event, *args)
+            raise NotImplementedError.new(
+                "please provide an implementation of log(e, fei, wi)")
+        end
+    end
+
+    #
+    # The simplest implementation, stores all history entries in memory.
+    #
+    # DO NOT USE IN PRODUCTION, it will trigger an 'out of memory' error
+    # sooner or later.
+    #
+    # Is only used for unit testing purposes.
+    #
+    class InMemoryHistory 
+        include HistoryMixin
+
+        attr_reader :entries
+
+        def initialize (service_name, application_context)
+
+            super()
+
+            @entries = []
+
+            service_init(service_name, application_context)
+        end
+
+        def log (event, *args)
+            msg = ""
+            msg << event.to_s
+
+            msg << " #{args[0].to_s}" \
+                if args.length > 0
+
+            #msg << " #{args[1].to_s}" \
+            #    if args.length > 1
+
+            @entries << msg
+        end
+
+        def to_s
+            s = ""
+            @entries.each do |entry|
+                s << entry.to_s
+                s << "\n"
+            end
+            s
+        end
+    end
+
+end
+

data/lib/openwfe/expool/yamlexpstorage.rb

@@ -62,16 +62,27 @@ module OpenWFE
     # yaml serialization
     #
     
+    #
     # opening for tuning yaml persistence
     #
     class FlowExpression
+
         def to_yaml_properties
+
             l = super()
+
             l.delete("@application_context")
+
+            l.delete("@timeout_job_id")
+            l.delete("@scheduler_job_id")
+                #
+                # scheduler ids should not get persisted
+
             return l
         end
     end
     
+    #
     # opening for tuning yaml persistence
     #
     class XmlRawExpression
@@ -89,12 +100,15 @@ module OpenWFE
         include OwfeServiceLocator
         
         def initialize (service_name, application_context)
+
             path = if (@application_context) 
-                @application_context[:file_expression_storage_path] 
+                @application_context[:work_directory]
             else 
-                DEFAULT_FILE_STORAGE_PATH 
+                DEFAULT_WORK_DIRECTORY
             end
-            super(service_name, application_context, path + "/expool")
+            path = path + '/expool'
+
+            super(service_name, application_context, path)
         end
 
         #
@@ -123,9 +137,10 @@ module OpenWFE
         end
 
         def to_s
+
             s = "\n\n==== #{self.class} ===="
             s << "\n"
-            each_expression_path do |path|
+            each_object_path do |path|
                 s << path
                 s << "\n"
             end
@@ -152,10 +167,12 @@ module OpenWFE
             end        
 
             def matches (path, exp_names)
+
                 exp_names.each do |exp_name|
                     return true \
                         if OpenWFE::ends_with(path, "_#{exp_name}.yaml")
                 end
+
                 return false
             end
         

data/lib/openwfe/expressions/environment.rb

@@ -124,6 +124,9 @@ module OpenWFE
         def unbind ()
 
             @variables.each do |key, value|
+
+                ldebug { "unbind() '#{key}' => #{value.class}" }
+
                 if value.kind_of? FlowExpressionId
                     get_expression_pool().remove(value)
                 elsif value.kind_of? FlowExpression

data/lib/openwfe/expressions/expressionmap.rb

@@ -89,6 +89,7 @@ module OpenWFE
 
             @map["sleep"] = SleepExpression
             @map["cron"] = CronExpression
+            @map["when"] = WhenExpression
 
             @map["reval"] = RevalExpression
             @map["print"] = PrintExpression

data/lib/openwfe/expressions/fe_concurrence.rb

@@ -57,11 +57,10 @@ module OpenWFE
 
         def apply (workitem)
 
-            sync = lookup_attribute(A_SYNC, workitem)
-            sync = "generic" if not sync
+            sync = lookup_attribute(:sync, workitem, :generic)
 
             @sync_expression = \
-                get_expression_map().get_sync_class(sync).new(@attributes)
+                get_expression_map().get_sync_class(sync).new(self, workitem)
 
             @children.each do |child|
                 @sync_expression.add_child(child)
@@ -132,15 +131,15 @@ module OpenWFE
             :cancel_remaining,
             :unready_queue
 
-        def initialize (attributes)
+        def initialize (synchable, workitem)
 
             super()
 
             @remaining_children = []
             @reply_count = 0
 
-            @count = determine_count(attributes)
-            @cancel_remaining = determine_remaining(attributes)
+            @count = determine_count(synchable, workitem)
+            @cancel_remaining = cancel_remaining?(synchable, workitem)
 
             @unready_queue = []
         end
@@ -213,7 +212,15 @@ module OpenWFE
                 if @count > 0 and @reply_count >= @count
                     treat_remaining_children(synchable)
                     synchable.reply_to_parent(workitem)
+                    return
                 end
+
+                synchable.store_itself()
+
+                #synchable.ldebug do
+                #    "#{self.class}.do_reply() not replying to parent "+
+                #    "#{workitem.last_expression_id.to_debug_s}"
+                #end
             end
 
             def treat_remaining_children (synchable)
@@ -237,14 +244,17 @@ module OpenWFE
                 end
             end
 
-            def determine_remaining (attributes)
-                a = attributes[A_REMAINING]
-                return true if not a
-                return a == REM_CANCEL
+            def cancel_remaining? (synchable_expression, workitem)
+
+                s = synchable_expression.lookup_attribute(
+                    :remaining, workitem, :cancel)
+
+                return s == :cancel.to_s
             end
 
-            def determine_count (attributes)
-                s = attributes[A_COUNT]
+            def determine_count (synchable_expression, workitem)
+
+                s = synchable_expression.lookup_attribute(:count, workitem)
                 return -1 if not s
                 i = s.to_i
                 return -1 if i < 1

data/lib/openwfe/expressions/fe_iterator.rb

@@ -116,7 +116,9 @@ module OpenWFE
                 .lookup_attribute(:to_variable, workitem)
 
             @value_separator = iterator_expression\
-                .lookup_attribute(:value_separator, workitem, /,\s*/)
+                .lookup_attribute(:value_separator, workitem)
+
+            @value_separator = /,\s*/ unless @value_separator
 
             @counter = 0
 

data/lib/openwfe/expressions/fe_participant.rb

@@ -77,6 +77,7 @@ module OpenWFE
                 unless @participant_name
 
             determine_timeout()
+            reschedule(get_scheduler)
 
             store_itself()
 
@@ -95,10 +96,6 @@ module OpenWFE
 
             wi = super()
 
-            if @scheduler_job_id
-                get_scheduler.unschedule(@scheduler_job_id)
-            end
-
             return wi unless @applied_workitem
 
             #

data/lib/openwfe/expressions/fe_raw.rb

@@ -100,7 +100,7 @@ module OpenWFE
 
             exp_name = expression_name()
 
-            exp_class = nil
+            exp_class = expression_class()
             attributes = nil
 
             template = lookup_variable(exp_name)
@@ -108,7 +108,7 @@ module OpenWFE
                 # is it a subprocess ?
 
             template = get_participant_map.lookup_participant(exp_name) \
-                unless template
+                if (not template) and (not exp_class)
                     #
                     # is it a directly a participant ?