openwferu 0.9.0

data/lib/ru/fe_base.rb

@@ -0,0 +1,105 @@
+#
+# 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'
+
+
+#
+# base expressions like 'sequence' and 'concurrence'
+#
+
+module OpenWFEru
+
+    class SequenceExpression < FlowExpression
+
+        attr_accessor \
+            :current_child_fei
+
+        #
+        # apply / reply
+
+        def apply (workitem)
+
+            reply(workitem)
+        end
+
+        def reply (workitem)
+
+            @current_child_fei = next_fei()
+
+            #ldebug { "reply() next_fei is #{@current_child_fei}" }
+
+            if @current_child_fei
+                store_itself()
+                get_expression_pool().apply(@current_child_fei, workitem)
+            else
+                reply_to_parent(workitem)
+            end
+        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})" }
+                    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
+                end
+                return nil
+            end
+    end
+
+end
+

data/lib/ru/fe_concurrence.rb

@@ -0,0 +1,122 @@
+#
+# 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/flowexpression'
+require 'ru/rudefinitions'
+require 'ru/ruutils'
+
+
+#
+# base expressions like 'sequence' and 'concurrence'
+#
+
+module OpenWFEru
+
+    class ConcurrenceExpression < SequenceExpression
+
+        attr_accessor \
+            :sync_expression
+
+        def apply (workitem)
+
+            sync = lookup_attribute(A_SYNC, workitem)
+            sync = "generic" if not sync
+            @sync_expression = get_expression_map().get_sync_class(sync).new()
+
+            #threads = []
+
+            @children.each do |child|
+                t = Thread.new do
+                    begin
+                        @sync_expression.apply_child(self, child, workitem)
+                    rescue Exception => e
+                        lwarn do 
+                            "apply() caught exception in concurrent child\n" + 
+                            OpenWFEru::exception_to_s(e)
+                        end
+                    end
+                end
+
+                #threads << t
+            end
+        end
+
+        def reply (workitem)
+            done = @sync_expression.reply(self, workitem)
+            reply_to_parent(done) if done
+        end
+    end
+
+    class SyncExpression
+        include Logging, MonitorMixin
+
+        #def initialize()
+        #    super()
+        #end
+    end
+
+    class GenericSyncExpression < SyncExpression
+
+        def initialize ()
+            super()
+            @reply_count = 0
+        end
+
+        def apply_child (synchable, child, workitem)
+            synchronize do
+                @application_context = synchable.application_context
+                ldebug { "apply_child()  #{child.to_debug_s}" }
+                synchable.get_expression_pool().apply(child, workitem.dup)
+            end
+        end
+
+        def reply (synchable, workitem)
+            synchronize do
+                @application_context = synchable.application_context
+                ldebug { "reply()  #{workitem.lastExpressionId.to_debug_s}" }
+                @reply_count = @reply_count + 1
+                return workitem \
+                    if @reply_count >= synchable.children.length
+                return nil
+            end
+        end
+    end
+
+end
+

data/lib/ru/fe_define.rb

@@ -0,0 +1,101 @@
+#
+# 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/rudefinitions'
+require 'ru/flowexpression'
+
+
+module OpenWFEru
+
+    class DefineExpression < FlowExpression
+
+        def evaluate (workitem)
+
+            #ldebug { "evaluate()  #{@fei.to_s}" }
+
+            #
+            # spot the body of this expression
+            # define each sub-definition
+
+            body_fei = nil
+
+            @children.each do |fei|
+
+                #ldebug { "evaluate() looking at  #{fei.to_debug_s}" }
+
+                rawchild = get_expression_pool().fetch(fei)
+
+                if not rawchild.is_definition?
+                    body_fei = rawchild.fei if not body_fei
+                    next
+                end
+
+                # then it's a definition
+
+                get_environment()[rawchild.definition_name()] = fei
+            end
+            
+            #
+            # store self
+
+            store_itself()
+
+            #
+            # return the id of the body
+
+            return body_fei
+        end
+
+        #
+        # apply / reply
+
+        def apply (workitem)
+            #
+            # apply the body
+
+            body_fei = evaluate(workitem)
+            get_expression_pool().apply(body_fei, workitem)
+        end
+
+        #def reply (workitem)
+        #end
+    end
+
+end
+

data/lib/ru/fe_misc.rb

@@ -0,0 +1,96 @@
+#
+# 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/flowexpression'
+require 'ru/fe_utils'
+
+
+module OpenWFEru
+
+    class PrintExpression < FlowExpression
+
+        #
+        # apply / reply
+
+        def apply (workitem)
+
+            escape = lookup_boolean_attribute('escape', workitem, false)
+
+            text = OpenWFEru::fetch_text_content(self, workitem, escape)
+            tracer = @application_context['__tracer']
+
+            if tracer
+                tracer << text
+            else
+                puts text
+            end
+
+            reply_to_parent(workitem)
+        end
+
+        #def reply (workitem)
+        #end
+
+    end
+
+    #
+    # Evals some Ruby code contained within the process definition 
+    # or within the workitem
+    #
+    class RevalExpression < FlowExpression
+
+        def apply (workitem)
+
+            escape = lookup_boolean_attribute('escape', workitem, false)
+
+            code = OpenWFEru::lookup_vf_attribute(self, workitem, 'code')
+
+            code = OpenWFEru::fetch_text_content(self, workitem, escape) \
+                if not code
+
+            result = eval(code.to_s)
+
+            OpenWFEru::set_result(workitem, result) if result != nil
+
+            reply_to_parent(workitem)
+        end
+    end
+
+end
+

data/lib/ru/fe_participant.rb

@@ -0,0 +1,75 @@
+#
+# 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/rudefinitions'
+require 'ru/fe_utils'
+
+
+#
+# The participant expression, in its own file
+#
+
+module OpenWFEru
+
+    class ParticipantExpression < FlowExpression
+
+        #attr_accessor \
+        #    :applied_workitem
+
+        #
+        # apply / reply
+
+        def apply (workitem)
+
+            #@applied_workitem = workitem
+
+            participant_name = \
+                OpenWFEru::lookup_vf_attribute(self, workitem, 'ref')
+
+            @application_context[S_PARTICIPANT_MAP]\
+                .dispatch(participant_name, workitem)
+        end
+
+        #def reply (workitem)
+        #end
+    end
+
+end
+

data/lib/ru/fe_raw.rb

@@ -0,0 +1,173 @@
+#
+# 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 'rexml/document'
+
+require 'otime'
+require 'workitem'
+require 'ru/engine'
+require 'ru/rudefinitions'
+require 'ru/flowexpression'
+require 'ru/fe_base'
+
+
+module OpenWFEru
+
+    class RawExpression < FlowExpression
+
+        attr_accessor \
+            :xml_element
+
+        def initialize \
+            (fei, parent_id, environment_id, application_context, xml_element)
+
+            super(fei, parent_id, environment_id, application_context, nil)
+
+            @xml_element = xml_element
+
+            new_environment() if not @environment_id
+        end
+
+        def apply (workitem)
+            #ldebug { "apply() parent is #{@parent_id}" }
+
+            attributes = extract_attributes()
+
+            #ldebug { "apply() expression_name  is '#{expression_name()}'" }
+            #ldebug { "apply() expression_class is '#{expression_class()}'" }
+
+            template = lookup_variable(expression_name())
+
+            if template and template.kind_of? OpenWFE::FlowExpressionId
+                get_expression_pool().launch_template(\
+                    self, 
+                    template, 
+                    workitem, 
+                    lookup_attributes(attributes, workitem))
+                return
+            end
+
+            eclass = expression_class()
+            raise "unknown expression '#{expression_name}'" if not eclass
+
+            expression = eclass.new(@fei, @parent_id, @environment_id, @application_context, attributes)
+            expression.children = extract_children()
+
+            expression.store_itself()
+
+            expression.apply(workitem)
+        end
+
+        #def reply (workitem)
+        #end
+
+        def is_expression? ()
+            return false if not @xml_element.kind_of?(REXML::XMLElement)
+            return expression_class() != nil
+        end
+
+        def is_definition? ()
+            return get_expression_map.is_definition?(expression_name())
+        end
+
+        def expression_name ()
+            return @xml_element.name
+        end
+
+        def expression_class ()
+            return get_expression_map().get_class(expression_name())
+        end
+        
+        def definition_name ()
+            #return @xml_element.attributes['name'].to_str
+            return @xml_element.attributes['name'].to_s
+        end
+
+        protected
+
+            def extract_attributes ()
+                result = {}
+                @xml_element.attributes.each_attribute do |a|
+                    result[a.name] = a.value
+                end
+                return result
+            end
+
+            def extract_children ()
+
+                c = []
+                i = 0
+
+                @xml_element.each_child do |elt|
+
+                    if elt.kind_of?(REXML::Element)
+
+                        cfei = @fei.dup
+                        pfei = @fei
+
+                        efei = @environment_id
+
+                        cfei.expressionName = elt.name
+                        cfei.expressionId = "#{cfei.expressionId}.#{i}"
+
+                        rawchild = RawExpression\
+                            .new(cfei, pfei, efei, @application_context, elt)
+
+                        get_expression_pool().update(rawchild)
+                        c << rawchild.fei
+
+                        i = i+1
+
+                    elsif elt.kind_of?(REXML::Comment)
+
+                        next
+
+                    else
+
+                        s = elt.to_s.strip
+                        c << s if s.length > 0
+
+                    end
+                end
+
+                return c
+            end
+    end
+end
+