ruote 0.9.18

data/lib/openwfe/expressions/fe_timeout.rb

@@ -0,0 +1,127 @@
+#
+#--
+# 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 'openwfe/expressions/timeout'
+
+
+#
+# 'timeout' as a simple expression
+#
+
+module OpenWFE
+
+    #
+    # The timeout concept begun with the participant expression. When a
+    # participant doesn't reply for a certain amount of time, a specified
+    # timeout can get triggered.
+    # Sometimes something more complex than a single participant needs a 
+    # timeout setting, this expression sets a timeout for the expression[s]
+    # nested within it.
+    #
+    #     <timeout after="2d">
+    #         <sequence>
+    #             (...)
+    #         </sequence>
+    #     </timeout>
+    #
+    class TimeoutExpression < FlowExpression
+        include TimeoutMixin
+
+        names :timeout
+
+        attr_accessor :applied_workitem
+
+        def apply (workitem)
+
+            if @children.size < 1
+                reply_to_parent workitem
+                return
+            end
+
+            @applied_workitem = workitem.dup
+
+            schedule_timeout(:after)
+
+            get_expression_pool.apply @children[0], workitem
+        end
+
+        #
+        # The child expression replies, make sure to unschedule the timeout
+        # before replying (to our own parent expression).
+        #
+        def reply (workitem)
+
+            unschedule_timeout()
+
+            super
+        end
+
+        #
+        # Cancel order : cancels the child expression (if applied) and 
+        # unschedule the timeout (if any).
+        #
+        def cancel
+
+            get_expression_pool.cancel(@children[0]) if @applied_workitem
+
+            unschedule_timeout()
+
+            super
+        end
+
+        #
+        # The timeout trigger, cancels the nested process segment (the
+        # nested expression).
+        #
+        def trigger (scheduler)
+
+            ldebug { "trigger() timeout requested for #{@fei.to_debug_s}" }
+
+            set_timedout_flag(@applied_workitem)
+
+            cancel()
+
+            reply_to_parent @applied_workitem
+        end
+    end
+
+end
+

data/lib/openwfe/expressions/fe_wait.rb

@@ -0,0 +1,78 @@
+#
+#--
+# 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.
+#++
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+#require 'openwfe/expressions/time'
+require 'openwfe/expressions/fe_when'
+
+
+module OpenWFE
+
+    #
+    # The 'wait' expression simply blocks/waits until the given condition
+    # evaluates to true.
+    # This expression accepts a timeout (else it will block ad eternam).
+    #
+    #     sequence do
+    #         wait :until => "${done} == true"
+    #         participant :toto
+    #     end
+    #
+    # Participant 'toto' will receive a workitem after the variable 'done' is
+    # set to true (somewhere else in the process definition).
+    #
+    #     sequence do
+    #         wait :runtil => "Time.new.to_i % 7 == 0"
+    #         participant :toto
+    #     end 
+    #
+    # Participant 'toto' will receive a workitem after a certain condition
+    # expressed directly in Ruby evaluates to true.
+    #
+    # 'wait' is different than 'when' : when it times out (if a timeout is set,
+    # the wait ceases and the flow resumes. On a timeout, 'when' will not
+    # execute its nested 'consequence' child.
+    #
+    class WaitExpression < WaitingExpression
+
+        names :wait
+        conditions :until
+    end
+
+end
+

data/lib/openwfe/expressions/fe_when.rb

@@ -0,0 +1,142 @@
+#
+#--
+# Copyright (c) 2006-2008, 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.
+#++
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'openwfe/utils'
+require 'openwfe/expressions/time'
+require 'openwfe/expressions/timeout'
+require 'openwfe/expressions/condition'
+
+
+#
+# 'when' and 'wait'
+#
+
+module OpenWFE
+
+    #
+    # The 'when' expression will trigger a consequence when a condition
+    # is met, like in
+    #
+    #     <when test="${variable:over} == true">
+    #         <participant ref="toto" />
+    #     </when>
+    #
+    # where the participant "toto" will receive a workitem when the (local)
+    # variable "over" has the value true.
+    #
+    # This is also possible :
+    #
+    #     <when>
+    #         <equals field-value="done" other-value="true" />
+    #         <participant ref="toto" />
+    #     </when>
+    #
+    # The 'when' expression by defaults, evaluates every 10 seconds its
+    # condition clause.
+    # A different frequency can be stated via the "frequency" attribute :
+    #
+    #     _when :test => "${completion_level} == 4", :frequency => "1s"
+    #         participant "next_stage"
+    #     end
+    #
+    # will check for the completion_level value every second. The scheduler 
+    # itself is by default 'waking up' every 250 ms, so setting a frequency to 
+    # something smaller than that value might prove useless.
+    # (Note than in the Ruby process definition, the 'when' got escaped to
+    # '_when' not to conflict with the 'when' keyword of the Ruby language).
+    #
+    # The when expression understands the 'timeout' attribute like the 
+    # participant expression does. Thus
+    #
+    #     _when :test => "${cows} == 'do fly'", :timeout => "1y"
+    #         participant "me"
+    #     end
+    #
+    # will timeout after one year (participant "me" will not receive a 
+    # workitem).
+    #
+    class WhenExpression < WaitingExpression
+
+        names :when
+        conditions :test
+
+        attr_accessor \
+            :consequence_triggered,
+            :condition_sub_id
+
+        def apply (workitem)
+
+            return reply_to_parent(workitem) \
+                if raw_children.size < 1
+
+            @condition_sub_id = -1
+            @consequence_triggered = false
+
+            super workitem
+        end
+
+        def reply (workitem)
+
+            #ldebug do 
+            #    "reply() @consequence_triggered is '#{@consequence_triggered}'"
+            #end
+
+            return reply_to_parent(workitem) \
+                if @consequence_triggered
+
+            super workitem
+        end
+
+        protected
+
+            def apply_consequence (workitem)
+
+                @consequence_triggered = true
+
+                store_itself
+
+                i = 1
+                i = 0 if @children.size == 1
+
+                get_expression_pool.apply @children[i], workitem
+            end
+    end
+
+end
+

data/lib/openwfe/expressions/filter.rb

@@ -0,0 +1,104 @@
+#
+#--
+# 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 'openwfe/filterdef'
+
+
+module OpenWFE
+
+    #
+    # This mixin adds filtering capabilities to a FlowExpression.
+    #
+    # It's used by the 'participant' and 'filter' expressions.
+    #
+    module FilterMixin
+
+        attr_accessor :filter
+
+        #
+        # Used when the workitem enters the 'filtered zone'. Will replace
+        # the attributes of the workitem with filtered ones.
+        # Assumes the original workitem is kept under @applied_workitem.
+        #
+        def filter_in workitem, filter_attribute_name=:filter
+
+            @filter = get_filter filter_attribute_name, workitem
+
+            return unless @filter
+
+            workitem.attributes = @filter.filter_in workitem.attributes
+            workitem.filter = @filter.dup
+        end
+
+        #
+        # Prepares the workitem for leaving the 'filtered zone'. Makes sure
+        # hidden and unwritable fields haven't been tampered with. Enforces
+        # the 'add_ok', 'remove_ok', 'closed' filter directives.
+        # Assumes the original workitem is kept under @applied_workitem.
+        #
+        def filter_out incoming_workitem
+
+            return unless @filter
+
+            incoming_workitem.filter = nil
+
+            incoming_workitem.attributes = @filter.filter_out(
+                @applied_workitem.attributes, incoming_workitem.attributes)
+        end
+
+        protected
+
+            #
+            # Fetches the filter pointed at via the 'filter' attribute
+            # of the including expression class.
+            #
+            def get_filter filter_attribute_name, workitem
+
+                filter_name = lookup_attribute filter_attribute_name, workitem
+
+                return nil unless filter_name
+
+                lookup_variable filter_name
+            end
+    end
+
+end
+