openwferu 0.9.16 → 0.9.17

data/lib/openwfe/expressions/environment.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -37,8 +37,8 @@
 # John Mettraux at openwfe.org
 #
 
+require 'rufus/scheduler'
 require 'openwfe/utils'
-require 'openwfe/util/scheduler'
 require 'openwfe/expressions/flowexpression'
 
 
@@ -49,20 +49,44 @@ module OpenWFE
     # It's an expression thus it's storable in the expression pool.
     #
     class Environment < FlowExpression
-        include Schedulable
+        include Rufus::Schedulable
 
         names :environment
 
+        V_PAUSED = VAR_PAUSED[1..-1]
+
+        #
+        # the variables stored in this environment.
+        #
         attr_accessor :variables
 
-        def initialize \
-            (fei, parent, environment_id, application_context, attributes)
+        #def initialize (
+        #    fei, parent, environment_id, application_context, attributes)
+        #    super(fei, parent, environment_id, application_context, attributes)
+        #    @variables = {}
+        #end
 
-            super(fei, parent, environment_id, application_context, attributes)
+        def initialize
+
+            super
 
             @variables = {}
         end
 
+        def self.new_env (
+            fei, parent_id, environment_id, app_context, attributes)
+
+            env = self.new
+
+            env.fei = fei
+            env.parent_id = parent_id
+            env.environment_id = environment_id
+            env.application_context = app_context
+            env.attributes = attributes
+
+            env
+        end
+
         #
         # Looks up for the value of a variable in this environment.
         #
@@ -91,7 +115,7 @@ module OpenWFE
             synchronize do
 
                 @variables[key] = value
-                store_itself()
+                store_itself
             end
         end
 
@@ -104,7 +128,7 @@ module OpenWFE
                 ldebug { "#{fei.to_debug_s} delete() '#{key}'" }
 
                 @variables.delete key
-                store_itself()
+                store_itself
             end
         end
 
@@ -122,11 +146,11 @@ module OpenWFE
 
                 #ldebug { "unbind() '#{key}' => #{value.class}" }
 
-                if value.kind_of? FlowExpressionId
+                if value.kind_of?(FlowExpressionId)
 
-                    get_expression_pool().remove(value)
+                    get_expression_pool.remove value
 
-                elsif value.kind_of? FlowExpression
+                elsif value.kind_of?(FlowExpression)
 
                     value.cancel
                 end
@@ -138,7 +162,7 @@ module OpenWFE
         #
         def is_engine_environment?
 
-            (@fei == get_expression_pool().engine_environment_id)
+            (@fei == get_expression_pool.engine_environment_id)
         end
 
         #
@@ -161,12 +185,16 @@ module OpenWFE
 
                 #ldebug { "reschedule()  - item of class #{value.class}" }
 
-                next unless value.kind_of? Schedulable
+                get_expression_pool.paused_instances[@fei.wfid] = true \
+                    if key == V_PAUSED
+
+                next unless value.kind_of?(Rufus::Schedulable)
+
                 value.application_context = @application_context
                 value.reschedule(scheduler)
             end
 
-            store_itself()
+            store_itself
         end
 
         #
@@ -182,18 +210,20 @@ module OpenWFE
             get_parent.get_root_environment
         end
 
+        #--
         #def get_subprocess_environment
         #    return self if not @parent_id
         #    return self if @parent_id.sub_instance_id != @fei.sub_instance_id
         #    get_parent.get_subprocess_environment
         #end
+        #++
 
         #
         # Returns a deep copy of this environment.
         #
         def dup
 
-            env = Environment.new(
+            env = Environment.new_env(
                 @fei.dup, 
                 @parent_id, 
                 @environment_id, 

data/lib/openwfe/expressions/expressionmap.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -37,10 +37,11 @@
 # John Mettraux at openwfe.org
 #
 
+require 'openwfe/expressions/raw'
 require 'openwfe/expressions/environment'
 require 'openwfe/expressions/fe_define'
 require 'openwfe/expressions/fe_misc'
-require 'openwfe/expressions/fe_value'
+require 'openwfe/expressions/fe_set'
 require 'openwfe/expressions/fe_if'
 require 'openwfe/expressions/fe_equals'
 require 'openwfe/expressions/fe_sequence'
@@ -142,9 +143,18 @@ module OpenWFE
 
             register TimeoutExpression
 
+            register EvalExpression
+            register ExpExpression
+
             register Environment
                 #
                 # only used by get_expression_names()
+
+            register_ancestors RawExpression
+            #register_ancestors XmlRawExpression
+            #register_ancestors ProgRawExpression
+                #
+                # just register the ancestors for those two
         end
 
         #
@@ -185,7 +195,7 @@ module OpenWFE
         def get_expression_names (expression_class)
 
             return expression_class.expression_names \
-                if expression_class.method_defined? :expression_names
+                if expression_class.method_defined?(:expression_names)
 
             names = []
             @expressions.each do |k, v|
@@ -194,6 +204,23 @@ module OpenWFE
             names
         end
 
+        #
+        # Returns an array of expression classes that have the given 
+        # class/module among their ancestors.
+        #
+        def get_expression_classes (ancestor)
+
+            @ancestors[ancestor]
+        end
+
+        def to_s
+            s = ""
+            @expressions.keys.sort.each do |name|
+                s << "- '#{name}' -> '#{@expressions[name].to_s}'\n"
+            end
+            s
+        end
+
         #
         # Registers an Expression class within this expression map.
         # This method is usually never called from out of the ExpressionMap
@@ -206,27 +233,20 @@ module OpenWFE
                 name = OpenWFE::to_dash(name)
                 @expressions[name] = expression_class
             end
-            expression_class.ancestors.each do |ancestor|
-                (@ancestors[ancestor] ||= []) << expression_class
-            end
+            register_ancestors expression_class
         end
 
-        #
-        # Returns an array of expression classes that have the given 
-        # class/module among their ancestors.
-        #
-        def get_expression_classes (ancestor)
+        protected
 
-            @ancestors[ancestor]
-        end
+            #
+            # registers all the ancestors of an expression class
+            #
+            def register_ancestors (expression_class)
 
-        def to_s
-            s = ""
-            @expressions.keys.sort.each do |name|
-                s << "- '#{name}' -> '#{@expressions[name].to_s}'\n"
+                expression_class.ancestors.each do |ancestor|
+                    (@ancestors[ancestor] ||= []) << expression_class
+                end
             end
-            s
-        end
     end
 
 end

data/lib/openwfe/expressions/fe_concurrence.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -209,7 +209,21 @@ module OpenWFE
     # It understands the same attributes and behaves as an interator that
     # forks its children concurrently.
     #
-    # (See ConcurrenceExpression and IteratorExpression).
+    # Some examples :
+    #
+    #     <concurrent-iterator on-value="sales, logistics, lob2" to-field="p">
+    #         <participant field-ref="p" />
+    #     </concurrent-iterator>
+    #
+    # Within a Ruby process definition :
+    #
+    #     sequence do
+    #       set :field => f, :value => %w{ Alan, Bob, Clarence }
+    #       #... 
+    #       concurrent_iterator :on_field => "f", :to_field => "p" do
+    #         participant "${p}"
+    #       end
+    #     end
     #
     class ConcurrentIteratorExpression < ConcurrenceExpression
 
@@ -219,10 +233,8 @@ module OpenWFE
 
         def apply (workitem)
 
-            if @children.length < 1
-                reply_to_parent workitem
-                return
-            end
+            return reply_to_parent(workitem) \
+                if @children.length < 1
 
             @template = @children[0]
 
@@ -232,10 +244,8 @@ module OpenWFE
 
             iterator = Iterator.new(self, workitem)
 
-            unless iterator.has_next?
-                reply_to_parent workitem
-                return
-            end
+            return reply_to_parent(workitem) \
+                unless iterator.has_next?
 
             while iterator.has_next?
 
@@ -246,7 +256,7 @@ module OpenWFE
                 vars = iterator.next wi
 
                 rawexp = get_expression_pool.prepare_from_template(
-                    self, iterator.index, template, vars)
+                    self, nil, iterator.index, template, vars)
 
                 @children << rawexp.fei
             end
@@ -257,6 +267,7 @@ module OpenWFE
         def reply_to_parent (workitem)
 
             get_expression_pool.remove(@template)
+
             super
         end
 
@@ -321,7 +332,7 @@ module OpenWFE
             merge_type = synchable.lookup_sym_attribute(
                 :merge_type, workitem, :default => :mix)
 
-            #synchable.ldebug { "new() merge_type is '#{merge_type}'" }
+            synchable.ldebug { "new() merge_type is '#{merge_type}'" }
 
             @merge_array = MergeArray.new synchable.fei, merge, merge_type
 
@@ -439,7 +450,7 @@ module OpenWFE
 
                 workitem = @merge_array.do_merge
 
-                synchable.reply_to_parent(workitem)
+                synchable.reply_to_parent workitem
             end
 
             def treat_remaining_children (synchable)

data/lib/openwfe/expressions/fe_cron.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -38,8 +38,6 @@
 #
 
 require 'openwfe/utils'
-require 'openwfe/util/otime'
-require 'openwfe/util/scheduler'
 require 'openwfe/expressions/time'
 
 
@@ -62,8 +60,7 @@ module OpenWFE
     # engine is a persisted one, the cron will continue when the engine
     # restarts).
     #
-    # Since OpenWFEru 0.9.14, it's possible to specify 'every' instead of
-    # 'tab' :
+    # It's possible to specify 'every' instead of 'tab' :
     #
     #     cron :every => "10m3s" do
     #         send_reminder
@@ -79,14 +76,13 @@ module OpenWFE
         attr_accessor \
             :raw_child, :tab, :every, :name, :counter
 
+
         def apply (workitem)
 
-            @counter = 0
+            return reply_to_parent(workitem) \
+                if @children.size < 1
 
-            if @children.size < 1
-                reply_to_parent workitem
-                return
-            end
+            @counter = 0
 
             @applied_workitem = workitem.dup
             @applied_workitem.flow_expression_id = nil
@@ -100,7 +96,7 @@ module OpenWFE
             @raw_child, _fei = get_expression_pool.fetch(@children[0])
             @raw_child.parent_id = nil
 
-            clean_children()
+            clean_children
 
             @children = nil
 
@@ -109,7 +105,7 @@ module OpenWFE
             #
             # schedule self
             
-            reschedule(get_scheduler)
+            reschedule get_scheduler
 
             #
             # store self as a variable
@@ -142,14 +138,18 @@ module OpenWFE
             begin
 
                 get_expression_pool.launch_template(
-                    @fei.wfid, @counter, @raw_child, @applied_workitem.dup)
+                    @fei.wfid, nil, @counter, @raw_child, @applied_workitem.dup)
 
                 #
                 # update count and store self
 
                 @counter += 1
 
-                #set_variable(@name, self)
+                if @name[0, 2] == '//'
+                    set_variable @name, self
+                else
+                    store_itself
+                end
 
             rescue
                 lerror do 
@@ -168,10 +168,11 @@ module OpenWFE
 
             #return unless @applied_workitem
 
-            @scheduler_job_id = @name.dup
-
-            @scheduler_job_id = "#{@fei.wfid}__#{@scheduler_job_id}" \
-                unless OpenWFE::starts_with(@name, "//")
+            @scheduler_job_id = if @name[0, 2] == "//"
+                @name
+            else
+                "#{@fei.wfid}__#{@scheduler_job_id}"
+            end
 
             if @tab
                 get_scheduler.schedule(

data/lib/openwfe/expressions/fe_cursor.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -78,39 +78,43 @@ module OpenWFE
 
         names :cursor
 
-        attr_accessor \
-            :loop_id,
-            :current_child_id,
-            :current_child_fei
+        #
+        # the integer identifier for the current loop
+        #
+        attr_accessor :loop_id
+
+        #
+        # what is the index of the child we're currently executing
+        #
+        attr_accessor :current_child_id
+
 
         def apply (workitem)
 
+            new_environment
+
             @loop_id = 0
 
             @current_child_id = -1
 
-            clean_children_list()
+            clean_children_list
 
-            reply(workitem)
+            reply workitem
         end
 
         def reply (workitem)
 
-            if @children.length < 1
-                #
-                # well, currently, no infinite empty loop allowed
-                #
-                reply_to_parent(workitem)
-                return
-            end
+            return reply_to_parent(workitem) \
+                if @children.length < 1
+                    #
+                    # well, currently, no infinite empty loop allowed
 
             command, step = determine_command_and_step workitem
 
             ldebug { "reply() command is '#{command} #{step}'" }
 
             if command == C_BREAK or command == C_CANCEL
-                reply_to_parent workitem
-                return
+                return reply_to_parent(workitem)
             end
 
             if command == C_REWIND or command == C_CONTINUE
@@ -132,26 +136,29 @@ module OpenWFE
                 @current_child_id = 0 if @current_child_id < 0
 
                 if @current_child_id >= @children.length
-                    if not is_loop
-                        reply_to_parent(workitem)
-                        return
-                    end
+
+                    return reply_to_parent(workitem) unless is_loop
+
                     @loop_id += 1
                     @current_child_id = 0
                 end
             end
 
-            @current_child_fei = nil
-
-            store_itself()
-
-            @current_child_fei = @children[@current_child_id]
+            template_fei = @children[@current_child_id]
 
             #
             # launch the next child as a template
 
+            #@current_child_fei = get_expression_pool.launch_template(
             get_expression_pool.launch_template(
-                self, @loop_id, @current_child_fei, workitem, nil)
+                self, 
+                @environment_id, 
+                @loop_id, 
+                template_fei,
+                workitem, 
+                nil)
+
+            store_itself
         end
 
         #
@@ -159,8 +166,8 @@ module OpenWFE
         #
         def cancel
 
-            get_expression_pool.cancel(@current_child_fei) \
-                if @current_child_fei
+            cfei = current_child_fei
+            get_expression_pool.cancel(cfei) if cfei
 
             super
         end
@@ -169,11 +176,26 @@ module OpenWFE
         # Returns false, the child class LoopExpression does return true.
         #
         def is_loop
+
             false
         end
 
         protected
 
+            #
+            # Determines the fei of the child being currently executed.
+            # This method is used by cancel().
+            #
+            def current_child_fei
+
+                cfei = @children[@current_child_id].dup
+
+                return nil unless cfei
+
+                cfei.wfid = cfei.wfid + '.' + @loop_id.to_s
+                cfei
+            end
+
             #
             # Makes sure that only flow expression are left in the cursor
             # children list (text and comment nodes get discarded).
@@ -193,11 +215,30 @@ module OpenWFE
     # The 'loop' expression is like 'cursor' but it doesn't exit until
     # it's broken (with 'break' or 'cancel').
     #
+    #     <loop>
+    #         <participant ref="toto" />
+    #         <break if="${f:done} == true" />
+    #     </loop>
+    #
+    # or, in a Ruby process definition :
+    #
+    #     _loop do
+    #         participant "toto"
+    #         _break :if => "${f:done} == true"
+    #     end
+    #
+    # (notice the _ (underscores) to distinguish the OpenWFEru expressions
+    # from the native Ruby ones).
+    #
     class LoopExpression < CursorExpression
 
         names :loop
 
+        #
+        # Returns true as, well, it's a loop...
+        #
         def is_loop
+
             true
         end
     end