openwferu 0.9.13 → 0.9.14

data/lib/openwfe/expressions/environment.rb

@@ -29,6 +29,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 # POSSIBILITY OF SUCH DAMAGE.
 #++
+#
 
 #
 # "made in Japan"
@@ -100,6 +101,8 @@ module OpenWFE
         def delete (key)
             synchronize do
 
+                ldebug { "#{fei.to_debug_s} delete() '#{key}'" }
+
                 @variables.delete key
                 store_itself()
             end
@@ -113,13 +116,18 @@ module OpenWFE
         #
         def unbind ()
 
+            #ldebug { "unbind() for #{fei.to_s}" }
+
             @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
+
                     value.cancel
                 end
             end
@@ -129,7 +137,8 @@ module OpenWFE
         # Returns true if this environment is the engine environment
         #
         def is_engine_environment?
-            return @fei == get_expression_pool().engine_environment_id
+
+            (@fei == get_expression_pool().engine_environment_id)
         end
 
         #
@@ -137,6 +146,7 @@ module OpenWFE
         # for the Schedulable aspect of an environment expression.
         #
         def trigger (params)
+
             raise "an environment should never get directly triggered"
         end
 

data/lib/openwfe/expressions/fe_command.rb

@@ -38,7 +38,6 @@
 #
 
 require 'openwfe/expressions/condition'
-#require 'openwfe/expressions/flowexpression'
 
 
 module OpenWFE
@@ -193,6 +192,20 @@ module OpenWFE
     #         buy_stuff
     #     end
     #
+    # The 'rif' attribute may be used instead of the 'if' attribute. Its value
+    # is some ruby code that, when evaluating to true will let the command
+    # be executed.
+    #
+    #     _skip 2, :rif => "workitem.customers.size % 2 == 0"
+    #         #
+    #         # skips if the nb of customers is pair
+    #
+    # Note that the 'rif' attribute will work only if the 
+    # <tt>:ruby_eval_allowed</tt> parameter is set to true in the engine's
+    # application context.
+    #
+    #     engine.application_context[:ruby_eval_allowed] = true
+    #
     class CursorCommandExpression < FlowExpression
         include CommandConstants
         include ConditionMixin

data/lib/openwfe/expressions/fe_cron.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -39,7 +37,6 @@
 # John Mettraux at openwfe.org
 #
 
-#require 'openwfe/rudefinitions'
 require 'openwfe/utils'
 require 'openwfe/util/otime'
 require 'openwfe/util/scheduler'
@@ -65,12 +62,22 @@ 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' :
+    #
+    #     cron :every => "10m3s" do
+    #         send_reminder
+    #     end
+    #
+    # The subprocess 'send_reminder' will thus be triggered every ten minutes 
+    # and three seconds.
+    #
     class CronExpression < TimeExpression
 
         names :cron
 
         attr_accessor \
-            :raw_child, :tab, :name, :counter
+            :raw_child, :tab, :every, :name, :counter
 
         def apply (workitem)
 
@@ -85,7 +92,10 @@ module OpenWFE
             @applied_workitem.flow_expression_id = nil
 
             @tab = lookup_attribute(:tab, workitem)
+            @every = lookup_attribute(:every, workitem)
+
             @name = lookup_attribute(:name, workitem)
+            @name = fei.to_s unless @name
 
             @raw_child, _fei = get_expression_pool.fetch(@children[0])
             @raw_child.parent_id = nil
@@ -104,7 +114,7 @@ module OpenWFE
             # (have to do it after the reschedule, so that the schedule
             # info is stored within the variable)
 
-            set_variable(@name, self) if @name
+            set_variable(@name, self)
 
             #
             # resume flow
@@ -122,13 +132,11 @@ module OpenWFE
             # implemented in parent TimeExpression class
 
         #
-        # This is the method called each time, the scheduler triggers
+        # This is the method called each time the scheduler triggers
         # this cron. The contained segment of process will get 
         # executed.
         #
         def trigger (params)
-            #
-            # launch raw child
 
             ldebug { "trigger() cron : #{@fei.to_debug_s}" }
 
@@ -144,7 +152,7 @@ module OpenWFE
 
                 @counter += 1
 
-                set_variable(@name, self) if @name
+                #set_variable(@name, self)
 
             rescue
                 lerror do 
@@ -166,12 +174,19 @@ module OpenWFE
             @scheduler_job_id = @name.dup
 
             @scheduler_job_id = "#{@fei.wfid}__#{@scheduler_job_id}" \
-                if not OpenWFE::starts_with(@name, "//")
-
-            get_scheduler.schedule(
-                @tab, 
-                { :schedulable => self, :job_id => @scheduler_job_id })
+                unless OpenWFE::starts_with(@name, "//")
+
+            if @tab
+                get_scheduler.schedule(
+                    @tab, 
+                    { :schedulable => self, :job_id => @scheduler_job_id })
+            else
+                get_scheduler.schedule_every(
+                    @every, 
+                    { :schedulable => self, :job_id => @scheduler_job_id })
+            end
 
+            ldebug { "reschedule() name is   '#{@name}'" }
             ldebug { "reschedule() job id is '#{@scheduler_job_id}'" }
 
             #store_itself()

data/lib/openwfe/expressions/fe_define.rb

@@ -29,6 +29,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 # POSSIBILITY OF SUCH DAMAGE.
 #++
+#
 
 #
 # "made in Japan"
@@ -61,8 +62,10 @@ module OpenWFE
         def evaluate (workitem)
 
             @eval_only = true
+
             apply workitem
-            return @body_fei
+
+            @body_fei
         end
 
         #
@@ -86,6 +89,28 @@ module OpenWFE
             get_expression_pool.apply fei, workitem
         end
 
+        #
+        # Overrides the set_variable in FlowExpression to
+        # make sure to intercept requests for binding subprocesses
+        # at the engine level and to store a copy of the raw expression,
+        # not only the flow expression id.
+        #
+        def set_variable (name, fei)
+
+            if name[0, 2] == "//"
+
+                raw_exp = get_expression_pool.fetch_expression(fei).dup
+                raw_exp.parent_id = nil
+                raw_exp.fei = raw_exp.fei.dup
+                fei = raw_exp.fei
+                fei.wfid = get_wfid_generator.generate 
+
+                raw_exp.store_itself
+            end
+
+            super name, fei
+        end
+
         protected
 
             def get_to_next_child

data/lib/openwfe/expressions/fe_iterator.rb

@@ -71,6 +71,8 @@ module OpenWFE
     #         end
     #     end
     #
+    # For more information about those commands, see CursorCommandExpression.
+    #
     class IteratorExpression < WithTemplateExpression
         include CommandMixin
 

data/lib/openwfe/expressions/fe_losfor.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -47,8 +45,15 @@ module OpenWFE
     #
     # Triggers the first (and supposedly unique child of this expression)
     # but never wait for its reply (lose it).
+    #
     # A 'lose' expression never replies to its parent expression.
     #
+    #     <lose>
+    #         <participant ref="toto" />
+    #     </lose>
+    #
+    # Useful only some special process cases.
+    #
     class LoseExpression < FlowExpression
 
         names :lose
@@ -77,23 +82,23 @@ module OpenWFE
 
                 wi = workitem.dup
 
-                Thread.new do
-                    begin
+                #Thread.new do
+                    #begin
 
-                        child = @children[0]
-                        get_expression_pool.forget(self, child)
-                        get_expression_pool.apply(child, wi)
+                child = @children[0]
+                get_expression_pool.forget(self, child)
+                get_expression_pool.apply(child, wi)
 
-                    rescue Exception => e
-                        lwarn do
-                            "apply() failed to apply child to forget "+
-                            OpenWFE::exception_to_s(e)
-                        end
-                    end
-                end
+                    #rescue Exception => e
+                    #    lwarn do
+                    #        "apply() failed to apply child to forget "+
+                    #        OpenWFE::exception_to_s(e)
+                    #    end
+                    #end
+                #end
             end
 
-            reply_to_parent(workitem)
+            reply_to_parent workitem
         end
 
         def reply (workitem)

data/lib/openwfe/expressions/fe_misc.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"

data/lib/openwfe/expressions/fe_participant.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -106,9 +104,21 @@ module OpenWFE
     # the same FlowExpressionId as the initial workitem and the participant
     # implementation is responsible for the cancel application).
     #
+    # The participant expression accepts an optional 'if' (or 'unless') 
+    # attribute. It's used for conditional execution of the participant :
+    #
+    #     participant :ref => "toto", :if => "${weather} == raining"
+    #         # the participant toto will receive a workitem only if
+    #         # it's raining
+    #
+    #     boss :unless => "#{f:matter} == 'very trivial'"
+    #         # the boss will not participate in the proces if the matter
+    #         # is 'very trivial'
+    #
     class ParticipantExpression < FlowExpression
         include FilterMixin
         include TimeoutMixin
+        include ConditionMixin
 
         names :participant
 
@@ -118,15 +128,28 @@ module OpenWFE
 
         def apply (workitem)
 
-            remove_timedout_flag workitem
+            conditional = eval_condition(:if, workitem, :unless)
 
-            @applied_workitem = workitem.dup
+            if conditional == false
+                super_reply_to_parent workitem
+                return
+            end
 
             @participant_name = lookup_ref workitem
 
             @participant_name = fetch_text_content workitem \
                 unless @participant_name
 
+            participant = \
+                get_participant_map.lookup_participant(@participant_name)
+
+            raise "No participant named '#{@participant_name}'" \
+                unless participant
+
+            remove_timedout_flag workitem
+
+            @applied_workitem = workitem.dup
+
             schedule_timeout()
 
             filter_in workitem
@@ -135,14 +158,32 @@ module OpenWFE
             
             workitem.params = lookup_attributes workitem
 
-            get_participant_map.dispatch @participant_name, workitem
-            get_participant_map.onotify @participant_name, :apply, workitem
-                #
-                # these two pmap calls were combined, but with the :reply
-                # notification in reply_to_parent() it feels more
-                # elegant like that
+            #
+            # threading AFTER the store_itself()
+            #
+            Thread.new do
+                begin
+
+                    # these two pmap calls were combined, but with the :reply
+                    # notification in reply_to_parent() it feels more
+                    # elegant like that
+
+                    get_participant_map.dispatch(
+                        participant, @participant_name, workitem)
+
+                    get_participant_map.onotify(
+                        @participant_name, :apply, workitem)
+
+                rescue Exception => e
+
+                    get_expression_pool.notify_error(
+                        e, fei, :do_apply, workitem)
+                end
+            end
         end
 
+        alias :super_reply_to_parent :reply_to_parent
+
         def reply_to_parent (workitem)
 
             get_participant_map.onotify @participant_name, :reply, workitem
@@ -165,17 +206,9 @@ module OpenWFE
         #
         def cancel
 
-            unschedule_timeout()
-
-            wi = super()
-
-            return wi unless @applied_workitem
+            unschedule_timeout
 
-            #
-            # have to cancel the workitem on the participant side
-
-            cancelitem = OpenWFE::CancelItem.new(@applied_workitem)
-            get_participant_map.dispatch(@participant_name, cancelitem)
+            cancel_participant
 
             nil
         end
@@ -186,7 +219,7 @@ module OpenWFE
         #
         def trigger (scheduler)
 
-            ldebug { "trigger() timeout requested for #{@fei.to_debug_s}" }
+            linfo { "trigger() timeout requested for #{@fei.to_debug_s}" }
 
             begin
 
@@ -194,11 +227,11 @@ module OpenWFE
                     #
                     # so that cancel won't unschedule without need 
 
-                cancel()
+                cancel_participant
 
-                set_timedout_flag(@applied_workitem)
+                set_timedout_flag @applied_workitem
 
-                reply_to_parent(@applied_workitem)
+                reply_to_parent @applied_workitem
             rescue
                 lerror do
                     "trigger() problem while timing out\n"+
@@ -206,6 +239,27 @@ module OpenWFE
                 end
             end
         end
+
+        protected
+
+            #
+            # Have to cancel the workitem on the participant side
+            #
+            def cancel_participant
+
+                return unless @applied_workitem
+                    #
+                    # if there is an applied workitem, it means there
+                    # is a participant to cancel...
+
+                participant = \
+                    get_participant_map.lookup_participant(@participant_name)
+
+                cancelitem = CancelItem.new(@applied_workitem)
+
+                get_participant_map.dispatch(
+                    participant, @participant_name, cancelitem)
+            end
     end
 
 end

data/lib/openwfe/expressions/fe_reserve.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"

data/lib/openwfe/expressions/fe_sleep.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -70,7 +68,6 @@ module OpenWFE
             :awakening_time
 
         def apply (workitem)
-            #synchronize do
 
             sfor = lookup_attribute(:for, workitem)
             suntil = lookup_attribute(:until, workitem)
@@ -102,7 +99,6 @@ module OpenWFE
             @applied_workitem = workitem.dup
 
             reschedule(get_scheduler)
-            #end
         end
 
         #def reply (workitem)

data/lib/openwfe/expressions/fe_subprocess.rb

@@ -72,13 +72,45 @@ module OpenWFE
     #         end
     #     end
     #
+    # The 'subprocess' expression accepts a 'forget' attribute :
+    #
+    #     class AnotherDefinition1 < OpenWFE::ProcessDefinition
+    #         sequence do
+    #             subprocess :ref => "my_subprocess", :forget => true
+    #             participant :ref => "ringo"
+    #         end
+    #         process-definition :name => "my_subprocess" do
+    #             participant :ref => "fake steve jobs"
+    #         end
+    #     end
+    #
+    # The 'subprocess' expression accepts an 'if' (or 'unless') attribute :
+    #
+    #     subprocess :ref => "interview_process", :if => "${f:screened}"
+    #         # will trigger the subprocess only if the field screened
+    #         # contains the string 'true' or the boolean 'true'
+    #
+    #     interview_process :if => "${f:screened}"
+    #         # idem
+    #
+    #     interview_process :unless => "${f:has_had_problem_with_justice_?}"
+    #         # well...
+    #
     class SubProcessRefExpression < FlowExpression
+        include ConditionMixin
 
         names :subprocess
 
 
         def apply (workitem)
 
+            conditional = eval_condition(:if, workitem, :unless)
+
+            if conditional == false
+                reply_to_parent workitem
+                return
+            end
+
             ref = lookup_ref(workitem)
 
             raise "'subprocess' expression misses a 'ref', 'field-ref' or 'variable-ref' attribute" unless ref
@@ -106,6 +138,8 @@ module OpenWFE
 
             get_expression_pool.launch_template(
                 requester, get_next_sub_id, template, workitem, params)
+
+            reply_to_parent(workitem) if forget
         end
 
         #def reply (workitem)

data/lib/openwfe/expressions/fe_value.rb

@@ -29,6 +29,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 # POSSIBILITY OF SUCH DAMAGE.
 #++
+#
 
 #
 # "made in Japan"
@@ -43,6 +44,35 @@ require 'openwfe/expressions/flowexpression'
 
 module OpenWFE
 
+    #
+    # A small mixin providing value for looking up the attributes
+    # variable/var/v and field/fld/f.
+    #
+    module ValueMixin
+
+        def lookup_variable_attribute (workitem)
+
+            lookup [ "variable", "var", "v" ], workitem
+        end
+
+        def lookup_field_attribute (workitem)
+
+            lookup [ "field", "fld", "f" ], workitem
+        end
+
+        private
+
+            def lookup (name_array, workitem)
+
+                name_array.each do |n|
+                    v = lookup_attribute(n, workitem)
+                    return v if v
+                end
+
+                nil
+            end
+    end
+
     #
     # The 'set' expression is used to set the value of a (process) variable or
     # a (workitem) field.
@@ -58,7 +88,18 @@ module OpenWFE
     # they will be evaluated sequentially before the body gets applied 
     # (executed).
     #
+    # Since OpenWFEru 0.9.14, shorter attributes are OK :
+    #
+    #     <set f="price" val="CHF 12.00" />
+    #     <set v="/stage" val="3" />
+    #     <set v="/stage" field-val="f_stage" />
+    #     <set f="stamp" val="${r:Time.now.to_i}" />
+    #
+    #     set :f => "price", :val => "USD 12.50"
+    #     set :v => "toto", :val => "elvis"
+    #
     class SetValueExpression < FlowExpression
+        include ValueMixin
 
         is_definition
 
@@ -88,8 +129,8 @@ module OpenWFE
 
         def reply (workitem)
 
-            vkey = lookup_attribute("variable", workitem)
-            fkey = lookup_attribute("field", workitem)
+            vkey = lookup_variable_attribute(workitem)
+            fkey = lookup_field_attribute(workitem)
 
             value = workitem.attributes[FIELD_RESULT]
 
@@ -129,13 +170,14 @@ module OpenWFE
     #     unset :variable => "eval_result"
     #
     class UnsetValueExpression < FlowExpression
+        include ValueMixin
 
         names :unset
 
         def apply (workitem)
 
-            vkey = lookup_attribute("variable", workitem)
-            fkey = lookup_attribute("field", workitem)
+            vkey = lookup_variable_attribute(workitem)
+            fkey = lookup_field_attribute(workitem)
 
             if vkey
                 delete_variable(vkey)

data/lib/openwfe/expressions/fe_wait.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"