openwferu 0.9.0

data/lib/ru/fe_subprocess.rb

@@ -0,0 +1,84 @@
+#
+# Copyright (c) 2006, 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 'workitem'
+#require 'ru/flowexpression'
+#require 'ru/fe_utils'
+
+
+#
+# the subprocess expression
+#
+
+module OpenWFEru
+
+    class SubprocessRefExpression < FlowExpression
+
+        #
+        # apply / reply
+
+        def apply (workitem)
+
+            ref = OpenWFEru::lookup_ref(self, workitem)
+
+            raise "'subprocess' expression misses a 'ref', 'field-ref' or 'variable-ref' attribute" if not ref
+
+            template_fei = lookup_variable(ref)
+
+            raise "did not find any subprocess named '#{ref}'" \
+                if not template_fei
+
+            sForget = lookup_attribute(A_FORGET, workitem)
+
+            requester = @fei
+            requester = @fei.workflowInstanceId \
+                if sForget and sForget.downcase == 'true'
+
+            params = list_attributes(workitem)
+
+            get_expression_pool()\
+                .launch_template(requester, template_fei, workitem, params)
+        end
+
+        #def reply (workitem)
+        #end
+    end
+
+end
+

data/lib/ru/fe_time.rb

@@ -0,0 +1,135 @@
+#
+# Copyright (c) 2006, 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 'otime'
+require 'ru/scheduler'
+require 'ru/rudefinitions'
+
+
+#
+# expressions like 'sleep' and 'cron'
+#
+
+module OpenWFEru
+
+    #
+    # A parent class for CronExpression and SleepExpression, is never
+    # used directly.
+    # It contains a simple get_scheduler() method simplifying the scheduler
+    # localization for <sleep/> and <cron/>.
+    #
+    class TimeExpression < FlowExpression
+
+        def get_scheduler
+            return @application_context[S_SCHEDULER]
+        end
+    end
+
+    #
+    # The 'sleep' expression expects one attribute, either 'for', either
+    # 'until'.
+    #
+    #  <sequence>
+    #      <sleep for="10m12s" />
+    #      <participant ref="alpha" />
+    #  </sequence>
+    #
+    # will wait for 10 minutes and 12 seconds before sending a workitem
+    # to participant 'alpha'.
+    #
+    class SleepExpression < TimeExpression
+        include Schedulable
+
+        attr_accessor \
+            :sleeping_workitem,
+            :awakening_time
+
+        def apply (workitem)
+
+            sfor = lookup_attribute("for", workitem)
+            suntil = lookup_attribute("until", workitem)
+
+            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 not tuntil
+                reply_to_parent(workitem)
+                return
+            end
+
+            @awakening_time = tuntil
+            @sleeping_workitem = workitem.dup
+
+            store_itself()
+
+            #ldebug do 
+            #    "apply() " + 
+            #    "will sleep until '#{tuntil}' " +
+            #    "(#{OpenWFE::to_iso_date(tuntil)})"
+            #end
+
+            get_scheduler.schedule_at(tuntil, self, nil)
+        end
+
+        #def reply (workitem)
+        #end
+
+        #
+        # This is the method called by the Scheduler instance attached to
+        # the workflow engine when the 'sleep' of this expression is 
+        # over
+        #
+        def trigger (params)
+            reply_to_parent(@sleeping_workitem)
+        end
+    end
+
+    class CronExpression < TimeExpression
+    end
+
+end
+

data/lib/ru/fe_utils.rb

@@ -0,0 +1,123 @@
+#
+# Copyright (c) 2006, 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 'ru/fe_raw'
+require 'ru/dollar'
+require 'ru/rudefinitions'
+
+#
+# a few help methods for expressions
+
+module OpenWFEru
+
+    #
+    # Returns the text stored as the children of the given expression
+    # 
+    def OpenWFEru.fetch_text_content (expression, workitem, escape=false)
+
+        text = ""
+
+        expression.children.each do |child|
+            if child.kind_of?(RawExpression)
+                text << child.fei.to_s
+            else
+                text << child.to_s
+            end
+            text << "\n"
+        end
+
+        text = dosub(text, expression, workitem) \
+            if not escape
+
+        return text
+    end
+
+    #
+    # looks up for 'value', 'variable-value' and then for 'field-value'
+    # if necessary.
+    #
+    def OpenWFEru.lookup_value (flow_expression, workitem, prefix='')
+
+        return OpenWFEru\
+            .lookup_vf_attribute(flow_expression, workitem, 'value', prefix)
+    end
+
+    #
+    # looks up for 'ref', 'variable-ref' and then for 'field-ref'
+    # if necessary.
+    #
+    def OpenWFEru.lookup_ref (flow_expression, workitem, prefix='')
+
+        return OpenWFEru\
+            .lookup_vf_attribute(flow_expression, workitem, 'ref', prefix)
+    end
+
+    #
+    # looks up for value attributes like 'field-ref' or 'variable-value'
+    #
+    def OpenWFEru.lookup_vf_attribute \
+        (flow_expression, workitem, att_name, prefix='')
+
+        prefix = "#{prefix}-" 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
+
+        if not v
+            v = flow_expression\
+                .lookup_attribute("#{prefix}field-#{att_name}", workitem)
+        end
+
+        return v
+    end
+
+    #
+    # sets the '__result__' field of the workitem
+    #
+    def OpenWFEru.set_result (workitem, result)
+
+        workitem.attributes[FIELD_RESULT] = result
+    end
+
+end
+

data/lib/ru/fe_value.rb

@@ -0,0 +1,225 @@
+#
+# Copyright (c) 2006, 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 'workitem'
+require 'flowexpressionid'
+require 'ru/flowexpression'
+require 'ru/fe_utils'
+
+
+#
+# expressions like 'set' and 'unset' and their utility methods
+#
+
+module OpenWFEru
+
+    class SetValueExpression < FlowExpression
+
+        def apply (workitem)
+
+            if @children.length < 1
+                workitem.attributes[FIELD_RESULT] = \
+                    OpenWFEru::lookup_value(self, workitem)
+                reply(workitem)
+                return
+            end
+
+            child = @children[0]
+
+            if child.kind_of? OpenWFE::FlowExpressionId
+                store_itself()
+                get_expression_pool().apply(child, workitem)
+                return
+            end
+
+            workitem.attributes[FIELD_RESULT] = child.to_s
+
+            reply(workitem)
+        end
+
+        def reply (workitem)
+
+            vkey = lookup_attribute("variable", workitem)
+            fkey = lookup_attribute("field", workitem)
+
+            value = workitem.attributes[FIELD_RESULT]
+
+            #puts "value is '#{value}'"
+
+            if vkey
+                set_variable(vkey, value)
+            elsif fkey
+                workitem.attributes[fkey] = value
+            else
+                raise "'variable' or 'field' attribute missing from 'set' expression"
+            end
+
+            reply_to_parent(workitem)
+        end
+
+        protected 
+
+            def determine_value (workitem)
+
+                if @children.length > 0
+                    child = @children[0]
+
+                    if child.kind_of? FlowExpressionId
+                        return "nada"
+                    else
+                        return child
+                    end
+                end
+
+                return OpenWFEru::lookup_value(self, workitem)
+            end
+    end
+
+    class UnsetValueExpression < FlowExpression
+
+        def apply (workitem)
+
+            vkey = lookup_attribute("variable", workitem)
+            fkey = lookup_attribute("field", workitem)
+
+            if vkey
+                delete_variable(vkey)
+            elsif fkey
+                workitem.attributes.delete(fkey)
+            else
+                raise "attribute 'variable' or 'field' is missing for 'unset' expression"
+            end
+
+            reply_to_parent(workitem)
+        end
+
+        #def reply (workitem)
+        #end
+    end
+
+    class ComparisonExpression < FlowExpression
+
+        def apply (workitem)
+
+            value_a = OpenWFEru::lookup_value(self, workitem)
+            value_b = OpenWFEru::lookup_value(self, workitem, 'other')
+
+            result = compare(value_a, value_b)
+
+            ldebug { "apply() result is '#{result}'  #{@fei.to_debug_s}" }
+
+            OpenWFEru::set_result(workitem, result)
+
+            reply_to_parent(workitem)
+        end
+
+        protected
+
+            def compare (a, b)
+                raise "not yet implemented : '#{@fei.expressionName}'"
+            end
+    end
+
+    #
+    # <equals/>
+    #
+    class EqualsExpression < ComparisonExpression
+
+        protected
+
+            def compare (a, b)
+                return a == b
+            end
+    end
+
+    #
+    # <if/>
+    #
+    class IfExpression < FlowExpression
+
+        attr_accessor \
+            :condition_replied
+
+        def apply (workitem)
+
+            reply_to_parent(workitem) if @children.length < 1
+
+            @condition_replied = false
+
+            store_itself()
+
+            get_expression_pool.apply(@children[0], workitem)
+        end
+
+        def reply (workitem)
+
+            if @condition_replied
+                reply_to_parent(workitem)
+                return
+            end
+
+            result = workitem.attributes[FIELD_RESULT]
+
+            @condition_replied = true
+
+            if result
+                apply_consequence(1, workitem)
+            else
+                apply_consequence(2, workitem)
+            end
+        end
+
+        def reply_to_parent(workitem)
+            clean_children()
+            super(workitem)
+        end
+
+        protected
+
+            def apply_consequence (index, workitem)
+                if index >= @children.length
+                    reply_to_parent(workitem)
+                else
+                    get_expression_pool.apply(@children[index], workitem)
+                end
+            end
+    end
+
+end
+