openwferu 0.9.13 → 0.9.14

data/lib/openwfe/expressions/flowexpression.rb

@@ -29,6 +29,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 # POSSIBILITY OF SUCH DAMAGE.
 #++
+#
 
 #
 # "made in Japan"
@@ -46,6 +47,12 @@ require 'openwfe/util/dollar'
 
 module OpenWFE
 
+    #
+    # When this variable is set to true (at the process root),
+    # it means the process is paused.
+    #
+    VAR_PAUSED = '/__paused__'
+
     #
     # FlowExpression
     #
@@ -76,6 +83,8 @@ module OpenWFE
             @application_context = app_context
             @attributes = attributes
 
+            @children = []
+
             @apply_time = nil
 
             #ldebug do
@@ -93,6 +102,7 @@ module OpenWFE
         # parent expression
         #
         def apply (workitem)
+
             get_parent().reply(workitem) if @parent_id
         end
 
@@ -101,6 +111,7 @@ module OpenWFE
         # parent expression
         #
         def reply (workitem)
+
             reply_to_parent(workitem)
         end
 
@@ -111,6 +122,7 @@ module OpenWFE
         # should resume without them.
         #
         def reply_to_parent (workitem)
+
             get_expression_pool.reply_to_parent(self, workitem)
         end
 
@@ -186,21 +198,23 @@ module OpenWFE
         # 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
 
@@ -230,7 +244,15 @@ module OpenWFE
             #    "   env  #{vi.to_debug_s}"
             #end
 
-            return ei == vi
+            ei == vi
+        end
+
+        #
+        # Returns true if this expression belongs to a paused flow
+        #
+        def paused?
+
+            lookup_variable(VAR_PAUSED) == true
         end
 
         #
@@ -278,6 +300,8 @@ module OpenWFE
             env.delete var
         end
 
+        alias :unset_variable :delete_variable
+
         #
         # Looks up the value for an attribute of this expression.
         #
@@ -341,7 +365,8 @@ module OpenWFE
 
             value = lookup_attribute(attname, workitem)
             return default if not value
-            return value.downcase == 'true'
+
+            (value.downcase == 'true')
         end
 
         #
@@ -399,7 +424,8 @@ module OpenWFE
                 elt = elt.strip
                 result << elt if elt.length > 0
             end
-            return result
+
+            result
         end
 
         #
@@ -427,7 +453,7 @@ module OpenWFE
 
             ldebug { "new_environment() is #{env.fei.to_debug_s}" }
 
-            return env.store_itself()
+            env.store_itself()
         end
 
         #
@@ -437,12 +463,14 @@ module OpenWFE
         # 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
+
+            env.store_itself
         end
 
         #
@@ -476,7 +504,7 @@ module OpenWFE
         #
         def get_binding
 
-            return binding()
+            binding()
         end
 
         #
@@ -528,7 +556,9 @@ module OpenWFE
         #
         def lookup_value (workitem, prefix='')
 
-            lookup_vf_attribute(workitem, 'value', prefix)
+            v = lookup_vf_attribute(workitem, 'value', prefix)
+            v = lookup_vf_attribute(workitem, 'val', prefix) unless v
+            v
         end
 
         #

data/lib/openwfe/expressions/raw.rb

@@ -37,10 +37,9 @@
 # John Mettraux at openwfe.org
 #
 
-#require 'rexml/document'
-
-require 'openwfe/rudefinitions'
+require 'openwfe/exceptions'
 require 'openwfe/expressions/flowexpression'
+require 'openwfe/rudefinitions'
 
 
 module OpenWFE
@@ -53,8 +52,8 @@ module OpenWFE
     #
     class RawExpression < FlowExpression
 
-        def initialize \
-            (fei, parent_id, env_id, application_context, raw_representation)
+        def initialize (
+            fei, parent_id, env_id, application_context, raw_representation)
 
             super(fei, parent_id, env_id, application_context, nil)
 
@@ -65,12 +64,13 @@ module OpenWFE
                 # now done in the launch methods of the expression pool
         end
 
-        def instantiate_real_expression \
-            (workitem, exp_class=nil, attributes=nil)
+        def instantiate_real_expression (
+            workitem, exp_name=nil, exp_class=nil, attributes=nil)
 
+            exp_name = expression_name() unless exp_name
             exp_class = expression_class() unless exp_class
 
-            raise "unknown expression '#{expression_name}'" \
+            raise "unknown expression '#{exp_name}'" \
                 unless exp_class
 
             #ldebug do 
@@ -97,50 +97,16 @@ module OpenWFE
             expression
         end
 
+        #
+        # When a raw expression is applied, it gets turned into the
+        # real expression which then gets applied.
+        #
         def apply (workitem)
 
-            exp_name = expression_name()
-
-            exp_class = expression_class()
-            attributes = nil
-
-            template = lookup_variable(exp_name)
-                #
-                # is it a subprocess ?
-
-            if ((not template) and (not exp_class))
-
-                template = get_participant_map.lookup_participant(exp_name)
-
-                unless template
-                    exp_name = OpenWFE::to_underscore(exp_name)
-                    template = get_participant_map.lookup_participant(exp_name)
-                end
-            end
-                #
-                # is it a directly a participant ?
-
-            if template 
-
-                if template.kind_of? OpenWFE::FlowExpressionId
-
-                    exp_class = OpenWFE::SubProcessRefExpression
-                    attributes = extract_attributes()
-                    attributes["ref"] = exp_name
-
-                elsif template.kind_of? OpenWFE::Participant
-
-                    exp_class = OpenWFE::ParticipantExpression
-                    attributes = extract_attributes()
-                    attributes["ref"] = exp_name
-                end
-            end
-
-            #
-            # the classical case...
+            exp_name, exp_class, attributes = determine_real_expression
 
             expression = instantiate_real_expression(
-                workitem, exp_class, attributes)
+                workitem, exp_name, exp_class, attributes)
 
             #expression.apply_time = OpenWFE::now()
                 #
@@ -195,6 +161,65 @@ module OpenWFE
         
         protected
 
+            #
+            # looks up a participant in the participant map, considers
+            # "my-participant" and "my_participant" as the same
+            # (by doing two lookups).
+            #
+            def lookup_participant (name)
+
+                p = get_participant_map.lookup_participant(name)
+
+                unless p
+                    name = OpenWFE::to_underscore(name)
+                    p = get_participant_map.lookup_participant(name)
+                end
+
+                if p 
+                    name
+                else
+                    nil
+                end
+            end
+
+            #
+            # Determines if this raw expression points to a classical 
+            # expression, a participant or a subprocess, or nothing at all...
+            #
+            def determine_real_expression ()
+
+                exp_name = expression_name()
+
+                exp_class = expression_class()
+                attributes = nil
+
+                var_value = lookup_variable(exp_name)
+
+                var_value = exp_name if (not exp_class and not var_value)
+
+                if var_value
+                    attributes = extract_attributes()
+                end
+
+                if var_value.is_a?(String)
+
+                    participant_name = lookup_participant(var_value)
+
+                    if participant_name
+                        exp_name = participant_name
+                        exp_class = OpenWFE::ParticipantExpression
+                        attributes['ref'] = participant_name
+                    end
+
+                elsif var_value.is_a?(OpenWFE::FlowExpressionId)
+
+                    exp_class = OpenWFE::SubProcessRefExpression
+                    attributes['ref'] = exp_name
+                end
+
+                [ exp_name, exp_class, attributes ]
+            end
+
             #
             # Takes care of extracting the process definition descriptions
             # if any and to set the description variables accordingly.

data/lib/openwfe/expressions/raw_prog.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -92,9 +90,8 @@ module OpenWFE
 
         def self.method_missing (m, *args, &block)
 
-            #puts "__c_method_missing >>>#{m}<<<<"
-
-            @ccontext = Context.new() unless @ccontext
+            @ccontext = Context.new() \
+                if (not @ccontext) or @ccontext.discarded?
 
             ProcessDefinition.make_expression(
                 @ccontext, 
@@ -103,14 +100,6 @@ module OpenWFE
                 &block)
         end
 
-        #
-        # This method has to be overriden in order to define
-        # a process definition.
-        #
-        def make
-            raise "make() implementation is missing, please provide one"
-        end
-
         def self.make_expression (context, exp_name, params, &block)
 
             string_child = nil
@@ -169,6 +158,8 @@ module OpenWFE
         def ProcessDefinition.do_make (instance=nil)
 
             context = if @ccontext
+                @ccontext.discard
+                    # preventing further additions in case of reevaluation
                 @ccontext
             elsif instance
                 instance.make
@@ -196,9 +187,41 @@ module OpenWFE
             top_expression
         end
 
+        #
+        # Parses the string to find the class name of the process definition
+        # and returns that class (instance).
+        #
+        def self.extract_class (ruby_proc_def_string)
+
+            ruby_proc_def_string.each_line do |l|
+
+                m = l.match " *class *([a-zA-Z0-9]*) *< .*ProcessDefinition"
+                return eval(m[1]) if m
+            end
+
+            nil
+        end
+
+        #
+        # Turns a String containing a ProcessDefinition ...
+        #
+        def self.eval_ruby_process_definition (code, safety_level=2)
+
+            o = OpenWFE::eval_safely(code, safety_level)
+
+            o = extract_class(code) \
+                if (o == nil) or o.is_a?(SimpleExpRepresentation)
+
+            return o.do_make \
+                if o.is_a?(ProcessDefinition) or o.is_a?(Class)
+
+            o
+        end
+
         protected
 
             def ProcessDefinition.pack_args (args)
+
                 return args[0] if args.length == 1
                 a = {}
                 args.each_with_index do |arg, index|
@@ -236,8 +259,8 @@ module OpenWFE
 
             class Context
 
-                attr_accessor :parent_expression
-                attr_reader :top_expressions, :previous_parent_expressions
+                attr_accessor :parent_expression, :top_expressions
+                attr_reader :previous_parent_expressions
 
                 def initialize
                     @parent_expression = nil
@@ -245,6 +268,13 @@ module OpenWFE
                     @previous_parent_expressions = []
                 end
 
+                def discard
+                    @discarded = true
+                end
+                def discarded?
+                    (@discarded == true)
+                end
+
                 #
                 # puts the current parent expression on top of the 'previous
                 # parent expressions' stack, the current parent expression

data/lib/openwfe/expressions/simplerep.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -60,6 +58,7 @@ module OpenWFE
             :children
 
         def initialize (name, attributes)
+
             super()
             @name = name
             @attributes = attributes
@@ -77,7 +76,8 @@ module OpenWFE
         # Always return the ProgRawExpression class.
         #
         def raw_expression_class
-            return ProgRawExpression
+
+            ProgRawExpression
         end
 
         #
@@ -85,11 +85,13 @@ module OpenWFE
         # in the classical OpenWFE process definition language.
         #
         def to_s
+
             doc = REXML::Document.new()
             doc << to_xml
             s = ""
             doc.write(s, 0)
-            return s
+
+            s
         end
 
         #
@@ -112,7 +114,7 @@ module OpenWFE
                 end
             end
 
-            return elt
+            elt
         end
 
         #
@@ -154,6 +156,31 @@ module OpenWFE
             rep
         end
 
+        #
+        # Evals the given code (string) into a SimpleExpRepresentation.
+        #
+        def self.from_code (code)
+
+            ProcessDefinition.eval_ruby_process_definition code
+        end
+
+        #
+        # Evals the given string a return its SimpleExpRepresentation 
+        # equivalent, ready for evaluation or rendering (fluo).
+        #
+        def self.from_s (s)
+
+            s = s.strip
+
+            if s[0, 1] == "<"
+
+                from_xml s
+            else
+
+                from_code s
+            end
+        end
+
         #
         # Returns a string containing the ruby code that generated this
         # raw representation tree.
@@ -176,7 +203,7 @@ module OpenWFE
             if @children.length > 0
                 s << " do\n"
                 @children.each do |child|
-                    if child.respond_to? :to_code_s
+                    if child.respond_to?(:to_code_s)
                         s << child.to_code_s(indentation + 1)
                     else
                         s << ind
@@ -189,7 +216,27 @@ module OpenWFE
                 s << "end"
             end
 
-            return s
+            s
+        end
+
+        #
+        # Turns this simple representation into an array
+        # (something suitable for to_json()).
+        #
+        def to_a
+
+            cs = @children.collect do |child|
+
+                if child.respond_to?(:to_a)
+
+                    child.to_a
+                else
+
+                    child.to_s
+                end
+            end
+
+            [ @name, @attributes, cs ]
         end
     end
 

data/lib/openwfe/expressions/time.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -76,6 +74,10 @@ module OpenWFE
             end
         end
 
+        #
+        # If the expression has been scheduled, a call to this method
+        # will make sure it's unscheduled (removed from the scheduler).
+        #
         def unschedule ()
 
             ldebug { "unschedule() @scheduler_job_id is #{@scheduler_job_id}" }
@@ -145,6 +147,7 @@ module OpenWFE
         end
 
         def cancel ()
+
             to_unschedule()
             super()
         end

data/lib/openwfe/expressions/timeout.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"

data/lib/openwfe/flowexpressionid.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: workitem.rb 3555 2006-11-13 00:47:53Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica"
@@ -77,6 +75,10 @@ module OpenWFE
         alias :expid :expression_id
         alias :expid= :expression_id=
 
+        alias :expname :expression_name
+        alias :wfname :workflow_definition_name
+        alias :wfrevision :workflow_definition_revision
+
         #
         # Overrides the classical to_s()
         #
@@ -88,6 +90,7 @@ module OpenWFE
         # Returns a hash version of this FlowExpressionId instance.
         #
         def to_h ()
+
             h = {}
             FIELDS.each { |f| h[f] = instance_eval("@#{f.to_s}") }
             h
@@ -97,6 +100,7 @@ module OpenWFE
         # Rebuilds a FlowExpressionId from its Hash representation.
         #
         def FlowExpressionId.from_h (h)
+
             fei = FlowExpressionId.new
             FIELDS.each { |f| fei.instance_variable_set("@#{f}", h[f]) }
             fei
@@ -107,6 +111,7 @@ module OpenWFE
         end
 
         def == (other)
+
             return false if not other.kind_of?(FlowExpressionId)
 
             #return self.to_s == other.to_s
@@ -147,7 +152,11 @@ module OpenWFE
             OpenWFE::starts_with other_fei.expression_id, @expression_id
         end
 
+        #
+        # Returns a deep copy of this FlowExpressionId instance.
+        #
         def dup
+
             OpenWFE::fulldup(self)
         end
 
@@ -157,10 +166,25 @@ module OpenWFE
             "(fei #{@workflow_definition_name} #{@workflow_definition_revision} #{@workflow_instance_id} #{@expression_id} #{@expression_name})"
         end
 
+        #
+        # Returns a very short string representation (fei wfid expid expname).
+        #
         def to_short_s
             "(fei #{@workflow_instance_id} #{@expression_id} #{@expression_name})"
         end
 
+        #
+        # Returns a URI escaped string with just the wfid and the expid, like
+        # '20070917-dupibodasa__0.0.1'
+        #
+        # Useful for unique identifier in URIs.
+        #
+        def to_web_s
+
+            eid = expid.gsub("\.", "_")
+            URI.escape("#{workflow_instance_id}__#{eid}")
+        end
+
         #
         # Yet another debugging method. Just returns the sub_instance_id and
         # the expression_id, in a string.

data/lib/openwfe/participants/enoparticipants.rb

@@ -75,6 +75,9 @@ module OpenWFE
     # <tt>email_target</tt> field to "foo@nowhere.com" prior to feeding it
     # to the mail participant.
     #
+    # Likewise, you can also override the :from_address value by setting the
+    # workitems <tt>email_from</tt> field.
+    #
     # When passing the mail template as a block, you have 
     # four possible arities :
     #     { |workitem| ... }
@@ -127,13 +130,15 @@ module OpenWFE
                 "(no template given)"
             end
 
+            from_address = workitem.email_from rescue @from_address
+
             puts "msg >>>\n#{msg}<<<"
 
             #
             # 2. Send message
 
             Net::SMTP.start(@smtp_server, @smtp_port) do |smtp|
-                smtp.send_message(msg, @from_address, to_address)
+                smtp.send_message(msg, from_address, to_address)
             end
 
             #

data/lib/openwfe/participants/participant.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"