openwferu 0.9.4 → 0.9.5

data/lib/openwfe/expressions/fe_value.rb

@@ -41,9 +41,9 @@
 
 require 'openwfe/workitem'
 require 'openwfe/flowexpressionid'
+require 'openwfe/expressions/condition'
 require 'openwfe/expressions/flowexpression'
 require 'openwfe/expressions/fe_utils'
-require 'openwfe/expressions/fe_condition'
 
 
 #

data/lib/openwfe/expressions/flowexpression.rb

@@ -162,7 +162,7 @@ module OpenWFE
         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)
+            return get_expression_pool().update(self)
         end
 
         #
@@ -222,7 +222,7 @@ module OpenWFE
         # or by // to indicate engine level (global) scope.
         #
         def lookup_variable (varname)
-            return get_environment()[varname]
+            get_environment()[varname]
         end
 
         #
@@ -307,6 +307,21 @@ module OpenWFE
             return result
         end
 
+        #
+        # For an expression like
+        #
+        #     iterator :on_value => "a, b, c", to-variable => "v0" do
+        #         # ...
+        #     end
+        #
+        # this call
+        #
+        #     lookup_comma_list_attribute(:on_value, wi)
+        #
+        # will return
+        #
+        #     [ 'a', 'b', 'c' ]
+        #
         def lookup_comma_list_attribute (attname, workitem, default=nil)
 
             a = lookup_attribute(attname, workitem, default)
@@ -344,7 +359,7 @@ module OpenWFE
 
             ldebug { "new_environment() is #{env.fei.to_debug_s}" }
 
-            env.store_itself()
+            return env.store_itself()
         end
 
         #
@@ -377,9 +392,13 @@ module OpenWFE
         #
         def synchronize
 
+            #ldebug { "synchronize() ---in--- for  #{@fei.to_debug_s}" }
+
             get_expression_pool.get_monitor(@fei).synchronize do
                 yield
             end
+
+            #ldebug { "synchronize() --out--  for  #{@fei.to_debug_s}" }
         end
 
         #
@@ -420,24 +439,5 @@ module OpenWFE
             end
     end
 
-    #
-    # A parent class for CursorExpression and IteratorExpression.
-    # Takes care of removing templates before replying to the parent 
-    # expression.
-    #
-    class WithTemplateExpression < FlowExpression
-
-        #
-        # this overriden method takes care of removing all the children
-        # (templates) before replying to its parent.
-        #
-        def reply_to_parent (workitem)
-            @children.each do |child|
-                get_expression_pool.remove(child)
-            end
-            super(workitem)
-        end
-    end
-
 end
 

data/lib/openwfe/expressions/raw_prog.rb

@@ -175,51 +175,32 @@ module OpenWFE
     #
     class ProcessDefinition
 
-        def initialize (exp_names=nil)
+        #def initialize (exp_names=nil)
+        def initialize ()
 
             super()
 
-            if not exp_names
-                exp_names = $EXPRESSION_NAMES if $EXPRESSION_NAMES
-            else
-                if exp_names.kind_of? ExpressionMap
-                    exp_names = exp_names.expression_names
-                elsif exp_names.kind_of? Engine
-                    exp_names = exp_names.get_expression_map.expression_names
-                elsif exp_names.kind_of? Hash
-                    exp_names = exp_names[S_EXPRESSION_MAP].expression_names
-                elsif not exp_names.kind_of? Array
-                    exp_names = $EXPRESSION_NAMES
-                end
-            end
-
-            if not exp_names
-                raise "no expression names found, please provide them"
-            end
-
-            @exp_names = exp_names
-
-            #exp_names.each do |exp_name|
-            #    register_expression(exp_name)
+            #if not exp_names
+            #    exp_names = $EXPRESSION_NAMES if $EXPRESSION_NAMES
+            #else
+            #    if exp_names.kind_of? ExpressionMap
+            #        exp_names = exp_names.expression_names
+            #    elsif exp_names.kind_of? Engine
+            #        exp_names = exp_names.get_expression_map.expression_names
+            #    elsif exp_names.kind_of? Hash
+            #        exp_names = exp_names[S_EXPRESSION_MAP].expression_names
+            #    elsif not exp_names.kind_of? Array
+            #        exp_names = $EXPRESSION_NAMES
+            #    end
             #end
+            #if not exp_names
+            #    raise "no expression names found, please provide them"
+            #end
+            #@exp_names = exp_names
 
             @previous_parent_expression = []
         end
 
-        #
-        # previous trick
-        #
-        # kept for the record.
-        #
-        #def register_expression (expression_name)
-        #    _exp_name = OpenWFE.make_safe(exp_name)
-        #    self.instance_eval """
-        #        def #{_exp_name} (params={}, &block)
-        #            make_expression('#{exp_name}', params, &block)
-        #        end
-        #    """
-        #end
-
         def method_missing (m, *args, &block)
 
             methodname = m.to_s
@@ -298,8 +279,8 @@ module OpenWFE
         # A class method for actually "making" the process 
         # segment raw representation
         #
-        def ProcessDefinition.do_make (exp_names=nil)
-            self.new(exp_names).make
+        def ProcessDefinition.do_make ()
+            self.new().make
         end
     end
 

data/lib/openwfe/expressions/raw_xml.rb

@@ -66,13 +66,13 @@ module OpenWFE
         end
 
         def raw_representation
-            synchronize do
-                if not @raw_representation
-                    @raw_representation = \
-                        REXML::Document.new(@raw_representation_s).root
-                end
-                return @raw_representation
+            #synchronize do
+            if not @raw_representation
+                @raw_representation = \
+                    REXML::Document.new(@raw_representation_s).root
             end
+            return @raw_representation
+            #end
         end
 
         protected

data/lib/openwfe/expressions/timeout.rb

@@ -73,9 +73,6 @@ module OpenWFE
             @timeout_at = Time.new.to_f + timeout
         end
 
-        #
-        # Overrides the parent method to make sure a potential
-        #
         def reschedule (scheduler)
             to_reschedule(scheduler)
         end
@@ -89,6 +86,14 @@ module OpenWFE
             super(workitem)
         end
 
+        def set_timedout_flag (workitem)
+            workitem.attributes["__timed_out__"] = "true"
+        end
+
+        def remove_timedout_flag (workitem)
+            workitem.attributes.delete("__timed_out__")
+        end
+
         protected
 
             #

data/lib/openwfe/expressions/wtemplate.rb

@@ -0,0 +1,67 @@
+#
+#--
+# Copyright (c) 2006-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/flowexpression'
+
+
+module OpenWFE
+
+    #
+    # A parent class for CursorExpression and IteratorExpression.
+    # Takes care of removing templates before replying to the parent 
+    # expression.
+    #
+    class WithTemplateExpression < FlowExpression
+
+        #
+        # this overriden method takes care of removing all the children
+        # (templates) before replying to its parent.
+        #
+        def reply_to_parent (workitem)
+            @children.each do |child|
+                get_expression_pool.remove(child)
+            end
+            super(workitem)
+        end
+    end
+
+end
+

data/lib/openwfe/flowexpressionid.rb

@@ -96,10 +96,13 @@ module OpenWFE
 
         alias eql? ==
 
-        alias to_debug_s to_s
+        #alias to_debug_s to_s
         #def to_debug_s
         #    "#{to_s}  (h#{hash}) (i#{object_id})"
         #end
+        def to_debug_s
+            "(fei #{@workflow_definition_name} #{@workflow_definition_revision} #{@workflow_instance_id} #{@expression_id} #{@expression_name})"
+        end
 
         #
         # Returns the workflow instance id without any subflow indices.

data/lib/openwfe/participants/atomparticipants.rb

@@ -70,6 +70,12 @@ module OpenWFE
     #         </p>
     #         """)                         # the template for each entry
     #
+    # The 'template' parameter may contain an instance of File instead of
+    # an instance of String.
+    #
+    #     feed0 = AtomParticipant.new(
+    #         20, File.new("path/to/my/atom/template.txt")
+    #
     # The template can be passed as the second parameter (after the max entry
     # count) or as a block :
     #
@@ -144,8 +150,14 @@ module OpenWFE
 
                 template = if @block_template
                     @block_template.call(fe, self, workitem)
+                elsif @template
+                    if @template.kind_of? File
+                        @template.readlines
+                    else
+                        @template.to_s
+                    end
                 else
-                    @template
+                    "(no template given)"
                 end
 
                 return OpenWFE::dosub(template, fe, workitem)

data/lib/openwfe/participants/enoparticipant.rb

@@ -74,13 +74,44 @@ module OpenWFE
     #                         "Monsieur Toto"
     #                     end
     #                     participant :ref => 'eno'
-    #                     print "ok"
     #                 end
     #             end
     #         end
     #     end
     #
-    # TODO #8426 : use a block to define template
+    # The 'template' parameter may contain an instance of File instead of
+    # an instance of String.
+    #
+    #     @engine.register_participant(
+    #         'eno', 
+    #         EmailNotificationParticipant.new(
+    #             "googlemail.l.google.com",
+    #             25,
+    #             "eno@outoftheblue.co.jp",
+    #             File.new("path/to/my/mail/template.txt")))
+    #
+    # You can also define the email template as a ruby block :
+    #
+    #     p = EmailNotificationParticipant.new("googlemail.l.google.com", 25, "eno@co.co.jp") do | flowexpression, participant, workitem |
+    #
+    #         # generally, only the workitem is used within a template
+    #
+    #         s = ""
+    #
+    #         # the header of the message
+    #
+    #         s << "Subject: #{workitem.subject}\n\n"
+    #
+    #         # then, the body
+    #
+    #         workitem.attributes.each do |key, value|
+    #             s << "- '#{k}' => '#{value}'\n"
+    #         end
+    #         s << "\ndone.\n"
+    #     end
+    #
+    # Note that the template integrates the subject and requires then a double
+    # newline before the message body.
     #
     class EmailNotificationParticipant 
         include LocalParticipant
@@ -89,24 +120,54 @@ module OpenWFE
         # Create a new email notification participant.  Requires
         # a mail server, port, a from address, and a mail message template
         #
-        def initialize (smtp_server, smtp_port, from_address, template)
+        def initialize (
+            smtp_server, smtp_port, from_address, template=nil, &block)
+
             @smtp_server = smtp_server
             @smtp_port = smtp_port
             @from_address = from_address
             @template = template
+
+            @block_template = block
         end
 
+        #
+        # The method called each time a workitem reaches this participant
+        #
         def consume (workitem)
+
             fe = get_flow_expression(workitem)
             to_address = workitem.email_target
+
+            #
             # 1. Expand variables
-            msg = OpenWFE::dosub(@template, fe, workitem)
+
+            msg  = if @block_template
+                @block_template.call(fe, self, workitem)
+            elsif @template
+                template = if @template.kind_of? File
+                    @template.readlines
+                else
+                    @template.to_s
+                end
+                OpenWFE::dosub(template, fe, workitem)
+            else
+                "(no template given)"
+            end
+
+            puts "msg >>>\n#{msg}<<<"
+
+            #
             # 2. Send message
+
             Net::SMTP.start(@smtp_server, @smtp_port) do |smtp|
                 smtp.send_message(msg, @from_address, to_address)
             end
+
+            #
             # 3. Reply to engine
-           reply_to_engine(workitem)
+
+            reply_to_engine(workitem)
         end
 
     end

data/lib/openwfe/participants/participantmap.rb

@@ -67,6 +67,8 @@ module OpenWFE
         # This method is called by the engine's own register_participant()
         # method.
         #
+        # The participant instance is returned by this method call
+        #
         def register_participant (regex, participant=nil, &block)
 
             if not participant
@@ -77,12 +79,22 @@ module OpenWFE
                 participant = BlockParticipant.new(block)
             end
 
+            if participant.kind_of? Class
+                begin
+                    participant = participant.new(regex, @application_context)
+                rescue
+                    participant = participant.new
+                end
+            end
+
             regex = Regexp.new(regex.to_s) unless regex.kind_of? Regexp
 
             participant.application_context = @application_context \
                 if participant.respond_to? :application_context=
 
             @participants << [ regex, participant ]
+
+            return participant
         end
 
         #

data/lib/openwfe/rudefinitions.rb

@@ -37,14 +37,12 @@
 # "made in Japan"
 #
 
+require 'openwfe/utils'
 require 'openwfe/version'
 
 
 module OpenWFE
 
-    #OPENWFE_VERSION = '1.7.2pre17'
-    #OPENWFE_VERSION = '0.9.4'
-
     #
     # service names
 
@@ -77,6 +75,7 @@ module OpenWFE
     # (assumes the presence of an application context instance var)
     #
     module OwfeServiceLocator
+
         def get_engine
             return @application_context[S_ENGINE]
         end
@@ -95,6 +94,19 @@ module OpenWFE
         def get_participant_map
             return @application_context[S_PARTICIPANT_MAP]
         end
+        
+        #
+        # Returns all the expression storage in the application context
+        # (there is usually a cache and a persisted exp storage).
+        #
+        def get_expression_storages
+            result = []
+            @application_context.each do |k, v|
+                result << v \
+                    if OpenWFE::starts_with(k.to_s, S_EXPRESSION_STORAGE)
+            end
+            return result
+        end
     end
 
 end

data/lib/openwfe/service.rb

@@ -76,11 +76,10 @@ module OpenWFE
 
     end
 
-    def register (service)
-
-        service.application_context[service.service_name] = service
-        return service
-    end
+    #def register (service)
+    #    service.application_context[service.service_name] = service
+    #    return service
+    #end
 
 end