openwferu 0.9.8 → 0.9.9

data/lib/openwfe/expressions/fe_value.rb

@@ -44,10 +44,6 @@ require 'openwfe/flowexpressionid'
 require 'openwfe/expressions/flowexpression'
 
 
-#
-# expressions like 'set' and 'unset' and their utility methods
-#
-
 module OpenWFE
 
     #
@@ -61,10 +57,17 @@ module OpenWFE
     #
     # (Notice the usage of the dollar notation in the last exemple).
     #
+    # 'set' expressions may be placed outside of a process-definition body,
+    # they will be evaluated sequentially before the body gets applied 
+    # (executed).
+    #
     class SetValueExpression < FlowExpression
 
+        is_definition
+
         names :set
 
+
         def apply (workitem)
 
             if @children.length < 1
@@ -120,18 +123,6 @@ module OpenWFE
                     get_expression_pool().apply(child, workitem)
                 end
             end
-
-            #def determine_value (workitem)
-            #    if @children.length > 0
-            #        child = @children[0]
-            #        if child.kind_of? FlowExpressionId
-            #            return "nada"
-            #        else
-            #            return child
-            #        end
-            #    end
-            #    return lookup_value(workitem)
-            #end
     end
 
     #
@@ -159,9 +150,6 @@ module OpenWFE
 
             reply_to_parent(workitem)
         end
-
-        #def reply (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
+

data/lib/openwfe/expressions/flowexpression.rb

@@ -148,9 +148,10 @@ module OpenWFE
         # Returns the parent expression (not as a FlowExpressionId but directly
         # as the FlowExpression instance it is).
         #
-        def get_parent ()
-            parent, parent_fei = get_expression_pool().fetch(@parent_id)
-            parent
+        def get_parent
+            #parent, parent_fei = get_expression_pool.fetch @parent_id
+            #parent
+            get_expression_pool.fetch_expression @parent_id
         end
 
         #
@@ -160,10 +161,10 @@ module OpenWFE
         # Else this information would be lost at engine restart or 
         # simply if the expression got swapped out of memory and reloaded later.
         #
-        def store_itself ()
+        def store_itself
             ldebug { "store_itself() for  #{@fei.to_debug_s}" }
             #ldebug { "store_itself() \n#{OpenWFE::caller_to_s(0, 6)}" }
-            get_expression_pool().update(self)
+            get_expression_pool.update self
         end
 
         #
@@ -172,17 +173,47 @@ module OpenWFE
         # definition.
         # Environments themselves are FlowExpression instances.
         #
-        def get_environment ()
-            return nil if not @environment_id
-            env, fei = get_expression_pool().fetch(@environment_id)
+        def get_environment
+
+            #return nil if not @environment_id
+            #env, fei = get_expression_pool().fetch(@environment_id)
+            #env
+
+            env = fetch_environment
+            env = get_expression_pool.fetch_engine_environment unless env
             env
         end
 
+        #
+        # A shortcut for fetch_environment.get_root_environment
+        #
+        # Returns the environment of the top process (the environement
+        # just before the engine environment in the hierarchy).
+        #
+        def get_root_environment
+            fetch_environment.get_root_environment
+        end
+
+        #
+        # A shortcut for fetch_environment.get_process_environment
+        #
+        #def get_subprocess_environment
+        #    fetch_environment.get_subprocess_environment
+        #end
+
+        #
+        # Just fetches the environment for this expression.
+        #
+        def fetch_environment
+            #return nil unless @environment_id
+            get_expression_pool.fetch_expression @environment_id
+        end
+
         #
         # Returns true if the expression's environment was generated
         # for itself (usually DefineExpression do have such envs)
         #
-        def owns_its_environment? ()
+        def owns_its_environment?
 
             #ldebug do 
             #    "owns_its_environment?()\n" +
@@ -192,8 +223,8 @@ module OpenWFE
 
             return false if not @environment_id
 
-            ei = @fei.dup()
-            vi = @environment_id.dup()
+            ei = @fei.dup
+            vi = @environment_id.dup
 
             ei.expression_name = "neutral"
             vi.expression_name = "neutral"
@@ -216,9 +247,13 @@ module OpenWFE
         #
         def set_variable (varname, value)
 
-            #get_environment()[varname] = value
-
             env, var = lookup_environment(varname)
+
+            #ldebug do 
+            #    "set_variable() '#{varname}' to '#{value}' " +
+            #    "in  #{env.fei.to_debug_s}"
+            #end
+
             env[var] = value
         end
 
@@ -232,8 +267,6 @@ module OpenWFE
         #
         def lookup_variable (varname)
 
-            #get_environment()[varname]
-
             env, var = lookup_environment(varname)
             env[var]
         end
@@ -246,8 +279,6 @@ module OpenWFE
         #
         def delete_variable (varname)
 
-            #get_environment().delete(varname)
-
             env, var = lookup_environment(varname)
             env.delete var
         end
@@ -285,6 +316,16 @@ module OpenWFE
             OpenWFE::dosub(text, self, workitem)
         end
 
+        #
+        # Like lookup_attribute() but returns the value downcased.
+        # Returns nil if no such attribute was found.
+        #
+        def lookup_downcase_attribute (attname, workitem, default=nil)
+            result = lookup_attribute attname, workitem, default
+            result = result.downcase if result
+            result
+        end
+
         #
         # Returns true if the expression has the given attribute.
         # The attname parameter can be a String or a Symbol.
@@ -369,7 +410,7 @@ module OpenWFE
         #
         # creates a new environment just for this expression
         #
-        def new_environment ()
+        def new_environment (initial_vars=nil)
 
             ldebug { "new_environment() for #{@fei.to_debug_s}" }
 
@@ -384,14 +425,31 @@ module OpenWFE
 
             parent_fei = parent.environment_id if parent
 
-            env = Environment\
-                .new(@environment_id, parent_fei, nil, @application_context, nil)
+            env = Environment.new(
+                @environment_id, parent_fei, nil, @application_context, nil)
+            
+            env.variables.merge!(initial_vars) if initial_vars
 
             ldebug { "new_environment() is #{env.fei.to_debug_s}" }
 
             return env.store_itself()
         end
 
+        #
+        # This method is called in expressionpool.forget(). It duplicates
+        # the expression's current environment (deep copy) and attaches
+        # it as the expression own environment.
+        # Returns the duplicated environment.
+        #
+        def dup_environment
+            env = fetch_environment
+            env = env.dup
+            env.fei = @fei.dup
+            env.fei.expression_name = EN_ENVIRONMENT
+            @environment_id = env.fei
+            return env.store_itself
+        end
+
         #
         # Takes care of removing all the children of this expression, if any.
         #
@@ -501,26 +559,24 @@ module OpenWFE
 
             s = "* #{@fei.to_debug_s}"
 
-            if @parent_id
-                s << "\n   `--p--> #{@parent_id.to_debug_s}"
-            end
+            s << "\n   `--p--> #{@parent_id.to_debug_s}" \
+                if @parent_id
 
-            if @environment_id
-                s << "\n   `--e--> #{@environment_id.to_debug_s}"
-            end
+            s << "\n   `--e--> #{@environment_id.to_debug_s}" \
+                if @environment_id
 
-            if @children
-                @children.each do |c|
-                    sc = if c.kind_of?(OpenWFE::FlowExpressionId)
-                        c.to_debug_s
-                    else
-                        ">#{c.to_s}<"
-                    end
-                    s << "\n   `--c--> #{sc}"
+            return s unless @children
+
+            @children.each do |c|
+                sc = if c.kind_of?(OpenWFE::FlowExpressionId)
+                    c.to_debug_s
+                else
+                    ">#{c.to_s}<"
                 end
+                s << "\n   `--c--> #{sc}"
             end
 
-            return s
+            s
         end
 
         #
@@ -528,6 +584,7 @@ module OpenWFE
         # Expression classes.
         # 
         def self.names (*exp_names)
+
             exp_names = exp_names.collect do |n|
                 n.to_s
             end
@@ -536,6 +593,15 @@ module OpenWFE
             end
         end
 
+        def self.is_definition?
+            false
+        end
+        def self.is_definition
+            meta_def :is_definition? do
+                true
+            end
+        end
+        
         protected
 
             #
@@ -560,7 +626,7 @@ module OpenWFE
                     ]
                 end
 
-                return [ get_environment, varname]
+                [ get_environment, varname]
             end
 
             #

data/lib/openwfe/expressions/merge.rb

@@ -0,0 +1,80 @@
+#
+#--
+# 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/utils'
+
+
+module OpenWFE
+
+    #
+    # Gathering methods for mixing (merging) workitems.
+    #
+    module MergeMixin
+
+        #
+        # Merges a source workitem into a target workitem (the fields
+        # of the source will overwrite the fields in the target).
+        #
+        # Returns the resulting (merged) workitem.
+        #
+        def merge_workitems (wiTarget, wiSource, override=false)
+        
+            return wiSource unless wiTarget
+            return wiTarget unless wiSource
+
+            return wiSource if override
+        
+            wiSource.attributes.each do |k, v|
+        
+                #puts "merge() '#{k}' => '#{v}'"
+        
+                nk = OpenWFE::fulldup(k)
+                nv = OpenWFE::fulldup(v)
+        
+                wiTarget.attributes[nk] = nv
+            end
+        
+            wiTarget
+        end
+    end
+
+end
+