openwferu 0.9.1 → 0.9.2

data/lib/{ru/fe_base.rb → openwfe/expressions/fe_sequence.rb}

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -39,68 +39,73 @@
 # John Mettraux at openwfe.org
 #
 
-require 'workitem'
-require 'ru/flowexpression'
-require 'ru/fe_utils'
+require 'openwfe/expressions/flowexpression'
+require 'openwfe/expressions/fe_utils'
 
 
 #
-# base expressions like 'sequence' and 'concurrence'
+# The 'sequence' expression implementation
 #
 
-module OpenWFEru
+module OpenWFE
 
+    #
+    # This expression sequentially executes each of its children expression.
+    # For a more sophisticated version of it, see the 'cursor' expression
+    # (fe_cursor.rb).
+    #
     class SequenceExpression < FlowExpression
 
         attr_accessor \
-            :current_child_fei
+            :current_child_id
 
         #
         # apply / reply
 
         def apply (workitem)
 
+            @current_child_id = -1
+
             reply(workitem)
         end
 
         def reply (workitem)
 
-            @current_child_fei = next_fei()
-
-            #ldebug { "reply() next_fei is #{@current_child_fei}" }
+            cfei = get_to_next_child()
 
-            if @current_child_fei
-                store_itself()
-                get_expression_pool().apply(@current_child_fei, workitem)
-            else
+            if not cfei
                 reply_to_parent(workitem)
+                return
             end
+
+            #ldebug do 
+            #    "reply() self : \n#{self.to_s}\n" + \
+            #    "reply() next is #{@current_child_id} : #{cfei.to_debug_s}"
+            #end
+
+            store_itself()
+
+            get_expression_pool().apply(cfei, workitem)
         end
 
         protected
 
-            def next_fei ()
-                if not @current_child_fei
-                    return @children.each do |c|
-                        return c if c.kind_of?(OpenWFE::FlowExpressionId)
-                    end
-                    return nil
-                end
-                found = false
-                @children.each do |c|
-                    #ldebug { "next_fei() considering #{c} (found ? #{found})" }
-                    ldebug { "next_fei() considering #{c}" }
-                    if found 
-                        return c if c.kind_of?(OpenWFE::FlowExpressionId)
-                        next
-                    end
-                    if c.kind_of?(OpenWFE::FlowExpressionId) and \
-                       c == @current_child_fei
-
-                        found = true
-                    end
+            def get_to_next_child ()
+
+                return nil if @children.length < 1
+
+                @current_child_id = @current_child_id + 1
+
+                @children[@current_child_id..-1].each do |c|
+
+                    return c if c.kind_of? OpenWFE::FlowExpressionId
+
+                    @current_child_id = @current_child_id + 1
                 end
-                return nil
+
+                return nil 
+                    #
+                    # did not find any child expression
             end
     end
 

data/lib/{ru → openwfe/expressions}/fe_subprocess.rb

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -39,25 +39,40 @@
 # John Mettraux at openwfe.org
 #
 
-#require 'workitem'
-#require 'ru/flowexpression'
-#require 'ru/fe_utils'
+require 'openwfe/expressions/fe_utils'
 
 
 #
 # the subprocess expression
 #
 
-module OpenWFEru
-
-    class SubprocessRefExpression < FlowExpression
+module OpenWFE
+
+    #
+    # This expression is used to launch/call a subprocess.
+    #
+    # For example :
+    #
+    #     <process-definition name="subtest0" revision="0">
+    #         <sequence>
+    #             <subprocess ref="sub0" a="A" b="B" c="C" />
+    #             <sub0 a="A" b="B" c="C" />
+    #         </sequence>
+    #     
+    #         <process-definition name="sub0">
+    #             <print>${a}${b}${c}</print>
+    #         </process-definition>
+    #     
+    #     </process-definition>
+    #
+    class SubProcessRefExpression < FlowExpression
 
         #
         # apply / reply
 
         def apply (workitem)
 
-            ref = OpenWFEru::lookup_ref(self, workitem)
+            ref = OpenWFE::lookup_ref(self, workitem)
 
             raise "'subprocess' expression misses a 'ref', 'field-ref' or 'variable-ref' attribute" if not ref
 
@@ -66,13 +81,14 @@ module OpenWFEru
             raise "did not find any subprocess named '#{ref}'" \
                 if not template_fei
 
-            sForget = lookup_attribute(A_FORGET, workitem)
+            forget = lookup_boolean_attribute(:forget, workitem)
 
             requester = @fei
-            requester = @fei.workflowInstanceId \
-                if sForget and sForget.downcase == 'true'
+            requester = @fei.workflowInstanceId if forget
+
+            params = lookup_attributes(workitem)
 
-            params = list_attributes(workitem)
+            #puts " ... params are #{params.to_s}"
 
             get_expression_pool()\
                 .launch_template(requester, template_fei, workitem, params)

data/lib/{ru → openwfe/expressions}/fe_time.rb

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -39,16 +39,16 @@
 # John Mettraux at openwfe.org
 #
 
-require 'otime'
-require 'ru/scheduler'
-require 'ru/rudefinitions'
+require 'openwfe/otime'
+require 'openwfe/rudefinitions'
+require 'openwfe/util/scheduler'
 
 
 #
 # expressions like 'sleep' and 'cron'
 #
 
-module OpenWFEru
+module OpenWFE
 
     #
     # A parent class for CronExpression and SleepExpression, is never
@@ -58,9 +58,28 @@ module OpenWFEru
     #
     class TimeExpression < FlowExpression
 
+        attr_accessor \
+            :scheduler_job_id
+
         def get_scheduler
             return @application_context[S_SCHEDULER]
         end
+
+        #
+        # Makes sure to cancel any scheduler job associated with this
+        # expression
+        #
+        def cancel ()
+            synchronize do
+
+                ldebug { "cancel() @scheduler_job_id is #{@scheduler_job_id}" }
+
+                get_scheduler.unschedule(@scheduler_job_id) \
+                    if @scheduler_job_id
+
+                return super()
+            end
+        end
     end
 
     #
@@ -83,38 +102,41 @@ module OpenWFEru
             :awakening_time
 
         def apply (workitem)
+            synchronize do
 
-            sfor = lookup_attribute("for", workitem)
-            suntil = lookup_attribute("until", workitem)
+                sfor = lookup_attribute(:for, workitem)
+                suntil = lookup_attribute(:until, workitem)
 
-            tuntil = nil
+                tuntil = nil
 
-            if suntil
-                tuntil = suntil
-            elsif sfor
-                tfor = OpenWFE::parse_time_string(sfor)
-                now = Time.new
-                #tuntil = now.to_f + now.gmt_offset + tfor
-                tuntil = now.to_f + tfor
-            end
+                if suntil
+                    tuntil = suntil
+                elsif sfor
+                    tfor = OpenWFE::parse_time_string(sfor)
+                    ldebug { "apply() tfor is '#{tfor}'" }
+                    tuntil = Time.new.to_f + tfor
+                end
 
-            if not tuntil
-                reply_to_parent(workitem)
-                return
-            end
+                if not tuntil
+                    reply_to_parent(workitem)
+                    return
+                end
+
+                @awakening_time = tuntil
+                @sleeping_workitem = workitem.dup
 
-            @awakening_time = tuntil
-            @sleeping_workitem = workitem.dup
+                ldebug do 
+                    "apply() " + 
+                    "will sleep until '#{tuntil}' " +
+                    "(#{OpenWFE::to_iso8601_date(tuntil)})"
+                end
 
-            store_itself()
+                @scheduler_job_id = get_scheduler.schedule_at(tuntil, self, nil)
 
-            #ldebug do 
-            #    "apply() " + 
-            #    "will sleep until '#{tuntil}' " +
-            #    "(#{OpenWFE::to_iso_date(tuntil)})"
-            #end
+                ldebug { "apply() @scheduler_job_id is #{@scheduler_job_id}" }
 
-            get_scheduler.schedule_at(tuntil, self, nil)
+                store_itself()
+            end
         end
 
         #def reply (workitem)
@@ -126,10 +148,16 @@ module OpenWFEru
         # over
         #
         def trigger (params)
+            ldebug do 
+                "trigger() #{@fei.to_debug_s} waking up (#{Time.new.to_f})"
+            end
             reply_to_parent(@sleeping_workitem)
         end
     end
 
+    #
+    # TODO #6929 : implement me
+    #
     class CronExpression < TimeExpression
     end
 

data/lib/{ru → openwfe/expressions}/fe_utils.rb

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -39,19 +39,19 @@
 # John Mettraux at openwfe.org
 #
 
-require 'ru/fe_raw'
-require 'ru/dollar'
-require 'ru/rudefinitions'
+require 'openwfe/rudefinitions'
+require 'openwfe/util/dollar'
+require 'openwfe/expressions/fe_raw'
 
 #
 # a few help methods for expressions
 
-module OpenWFEru
+module OpenWFE
 
     #
     # Returns the text stored as the children of the given expression
     # 
-    def OpenWFEru.fetch_text_content (expression, workitem, escape=false)
+    def OpenWFE.fetch_text_content (expression, workitem, escape=false)
 
         text = ""
 
@@ -61,7 +61,7 @@ module OpenWFEru
             else
                 text << child.to_s
             end
-            text << "\n"
+            #text << "\n"
         end
 
         text = dosub(text, expression, workitem) \
@@ -74,9 +74,9 @@ module OpenWFEru
     # looks up for 'value', 'variable-value' and then for 'field-value'
     # if necessary.
     #
-    def OpenWFEru.lookup_value (flow_expression, workitem, prefix='')
+    def OpenWFE.lookup_value (flow_expression, workitem, prefix='')
 
-        return OpenWFEru\
+        return OpenWFE\
             .lookup_vf_attribute(flow_expression, workitem, 'value', prefix)
     end
 
@@ -84,39 +84,55 @@ module OpenWFEru
     # looks up for 'ref', 'variable-ref' and then for 'field-ref'
     # if necessary.
     #
-    def OpenWFEru.lookup_ref (flow_expression, workitem, prefix='')
+    def OpenWFE.lookup_ref (flow_expression, workitem, prefix='')
 
-        return OpenWFEru\
+        return OpenWFE\
             .lookup_vf_attribute(flow_expression, workitem, 'ref', prefix)
     end
 
     #
-    # looks up for value attributes like 'field-ref' or 'variable-value'
+    # Looks up for value attributes like 'field-ref' or 'variable-value'
     #
-    def OpenWFEru.lookup_vf_attribute \
+    def OpenWFE.lookup_vf_attribute \
         (flow_expression, workitem, att_name, prefix='')
 
-        prefix = "#{prefix}-" if prefix != ''
+        prefix = "#{prefix.to_s}-" if prefix != ''
 
         v = flow_expression.lookup_attribute("#{prefix}#{att_name}", workitem)
 
-        if not v
-            v = flow_expression\
-                .lookup_attribute("#{prefix}variable-#{att_name}", workitem)
-        end
+        return v if v
 
-        if not v
-            v = flow_expression\
-                .lookup_attribute("#{prefix}field-#{att_name}", workitem)
-        end
+        v = flow_expression\
+            .lookup_attribute("#{prefix}variable-#{att_name}", workitem)
+
+        return flow_expression.lookup_variable(v) if v
+
+        v = flow_expression\
+            .lookup_attribute("#{prefix}field-#{att_name}", workitem)
 
-        return v
+        return workitem.attributes[v] if v
+
+        return nil
     end
 
+    #
+    # Looks up for a value, a variable or a field (in that order).
+    # 
+    #def OpenWFE.lookup_vvf_attribute (flow_expression, workitem, prefix)
+    #    raise "missing prefix" unless prefix
+    #    v = flow_expression.lookup_attribute("#{prefix}-value", workitem)
+    #    return v if v
+    #    v = flow_expression.lookup_attribute("#{prefix}-variable", workitem)
+    #    return flow_expression.lookup_variable(v) if v
+    #    v = flow_expression.lookup_attribute("#{prefix}-field", workitem)
+    #    return workitem.attributes[v] if v
+    #    return nil
+    #end
+
     #
     # sets the '__result__' field of the workitem
     #
-    def OpenWFEru.set_result (workitem, result)
+    def OpenWFE.set_result (workitem, result)
 
         workitem.attributes[FIELD_RESULT] = result
     end