openwferu 0.9.1 → 0.9.2

data/lib/openwfe/participants/atomparticipants.rb

@@ -0,0 +1,144 @@
+#
+#--
+# 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$
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+#
+# this participant requires atom-tools from
+#
+# http://code.necronomicorp.com/trac/atom-tools 
+#
+# The license is X11/MIT
+#
+
+require 'monitor'
+
+require 'rubygems'
+require 'atom/collection'
+
+require 'openwfe/participants/participants'
+
+
+module OpenWFE
+
+    #
+    # Stores the incoming workitem into an 'atom feed'
+    #
+    # An example :
+    # <tt>
+    #     feed0 = AtomParticipant.new(
+    #         20,
+    #         """
+    #         <p>
+    #             <h1>${f:colour}</h1>
+    #         </p>
+    #         """)
+    # </tt>
+    #
+    class AtomParticipant < LocalParticipant
+        include MonitorMixin
+
+        attr_accessor \
+            :content_type       # blocks may manipulate them
+
+        def initialize (max_item_count, template=nil, &block)
+
+            super()
+
+            @template = template
+            @max_item_count = max_item_count
+            @block_template = block
+
+            @feed = Atom::Collection.new("http://localhost")
+            @content_type = "xhtml"
+        end
+
+        def consume (workitem)
+
+            e = Atom::Entry.new
+
+            e.id = \
+                "#{workitem.fei.workflow_instance_id}--" +
+                "#{workitem.fei.expression_id}"
+
+            e.title = workitem.atom_entry_title
+            e.content = render(workitem)
+
+            e.content["type"] = @content_type
+
+            @feed << e
+
+            @feed = @feed[0, @max_item_count] \
+                if @feed.length > @max_item_count
+
+            publish(workitem)
+
+            reply_to_engine(workitem)
+        end
+
+        protected
+
+            def render (workitem)
+
+                fe = get_flow_expression(workitem)
+
+                template = if @block_template
+                    @block_template.call(fe, self, workitem)
+                else
+                    @template
+                end
+
+                return OpenWFE::dosub(template, fe, workitem)
+            end
+
+            #
+            # For the moment, just dumps the feed into a file.
+            #
+            def publish (workitem)
+                synchronize do
+                    filename = "atom_#{workitem.participant_name}.xml"
+                    f = File.open(filename, "w")
+                    f << @feed.to_s
+                    f.close()
+                end
+            end
+    end
+
+end
+

data/lib/openwfe/participants/enoparticipant.rb

@@ -0,0 +1,73 @@
+#
+#--
+# Copyright (c) 2007, Alain Hoang, 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.
+#++
+#
+#
+
+#
+# "made in Japan"
+#
+# Alain Hoang at openwfe.org
+#
+
+require 'net/smtp'
+
+module OpenWFE
+
+
+    #
+    # This participant is used to send an email notification
+    class EmailNotificationParticipant < LocalParticipant
+
+        # 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)
+            @smtp_server = smtp_server
+            @smtp_port = smtp_port
+            @from_address = from_address
+            @template = template
+        end
+
+        def consume (workitem)
+            fe = get_flow_expression(workitem)
+            to_address = workitem.email_target
+            # 1. Expand variables
+            msg = OpenWFE::dosub(@template, fe, workitem)
+            # 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)
+        end
+
+    end
+end

data/lib/openwfe/participants/participant.rb

@@ -0,0 +1,85 @@
+#
+#--
+# 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/contextual'
+require 'openwfe/rudefinitions'
+
+
+module OpenWFE
+
+    #
+    # The 'participant' concept is displayed as a module, so that 
+    # other pieces of code may easily 'mix it in'.
+    #
+    module Participant
+        include Contextual
+
+        #
+        # A participant will be receiving workitems via this method.
+        # It may also receive cancelitems via this method.
+        # If the participant provides a cancel(cancelitem) method, cancel
+        # items will be fed to this cancel() and not to consume().
+        #
+        def consume (workitem)
+        end
+
+        #
+        # (optional)
+        #
+        #def cancel (cancelitem)
+        #end
+
+        #
+        # Returns the FlowExpression instance that triggered this
+        # participant. 
+        # A ParticipantExpression instance will most likely be returned.
+        #
+        def get_flow_expression (workitem)
+
+            return nil if not @application_context
+
+            @application_context[S_EXPRESSION_POOL]\
+                .fetch_expression(workitem.flow_expression_id)
+        end
+    end
+
+end
+

data/lib/{ru → openwfe/participants}/participantmap.rb

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -39,12 +39,17 @@
 # John Mettraux at openwfe.org
 #
 
-require 'workitem'
-require 'ru/service'
+require 'openwfe/workitem'
+require 'openwfe/service'
 
+include OpenWFE
 
-module OpenWFEru
 
+module OpenWFE
+
+    #
+    # A very simple directory of participants
+    #
     class ParticipantMap < Service
 
         attr_accessor \
@@ -56,7 +61,20 @@ module OpenWFEru
             @participants = []
         end
 
-        def register_participant (regex, participant)
+        #
+        # Adds a participant to this map.
+        # This method is called by the engine's own register_participant()
+        # method.
+        #
+        def register_participant (regex, participant=nil, &block)
+
+            if not participant
+
+                raise "please provide a participant instance or a block" \
+                    if not block
+
+                participant = BlockParticipant.new(block)
+            end
 
             regex = Regexp.new(regex) if not regex.kind_of? Regexp
 
@@ -65,15 +83,24 @@ module OpenWFEru
             @participants << [ regex, participant ]
         end
 
+        #
+        # Looks up a participant given a participant_name.
+        # Will return the first participant whose name matches.
+        #
         def lookup_participant (participant_name)
 
             @participants.each do |tuple|
                 return tuple[1] if tuple[0].match(participant_name)
             end
-
             return nil
         end
 
+        #
+        # Dispatches to the given participant.
+        # The workitem will be fed to the consume() method of that participant.
+        # If it's a cancelitem and the participant has a cancel() method,
+        # it will get called instead.
+        #
         def dispatch (participant_name, workitem)
 
             participant = lookup_participant(participant_name)
@@ -81,13 +108,14 @@ module OpenWFEru
             raise "Didn't find participant named '#{participant_name}'" \
                 if not participant
 
-            workitem.participantName = participant_name
+            workitem.participant_name = participant_name
 
-            if workitem.kind_of? OpenWFE::CancelItem
+            if workitem.kind_of? CancelItem and participant.respond_to? :cancel
                 participant.cancel(workitem)
-            else
-                participant.consume(workitem)
+                return
             end
+
+            participant.consume(workitem)
         end
     end
 

data/lib/{ru → openwfe/participants}/participants.rb

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -39,21 +39,21 @@
 # John Mettraux at openwfe.org
 #
 
-require 'ru/participant'
-require 'ru/rudefinitions'
+require 'openwfe/rudefinitions'
+require 'openwfe/participants/participant'
 
 
 #
 # some base participant implementations
-
-module OpenWFEru
+#
+module OpenWFE
 
     class LocalParticipant
-        include Participant
+        include Participant, OwfeServiceLocator
 
         def reply_to_engine (workitem)
-            @application_context[S_EXPRESSION_POOL]\
-                .reply(workitem.lastExpressionId, workitem)
+
+            get_expression_pool.reply(workitem.last_expression_id, workitem)
         end
     end
 
@@ -64,13 +64,42 @@ module OpenWFEru
             tracer = @application_context['__tracer']
 
             if tracer
-                tracer << workitem.participantName
+                tracer << workitem.participant_name
             else
-                puts workitem.participantName
+                puts workitem.participant_name
             end
 
             reply_to_engine(workitem)
         end
     end
+
+    #
+    # This participant is used by the register_participant() method of
+    # Engine class.
+    #
+    # <tt>
+    # engine.register_participant("the_boss") do |workitem|
+    #     puts "the boss received a workitem"
+    # end
+    # </tt>
+    #
+    # After the block executes, the BlockParticipant immediately replies
+    # to the engine.
+    #
+    class BlockParticipant < LocalParticipant
+
+        def initialize (block)
+            @block = block
+        end
+
+        def consume (workitem)
+
+            @block.call workitem
+
+            reply_to_engine(workitem) \
+                if workitem.kind_of? InFlowWorkItem
+            # else it's a cancel item
+        end
+    end
 end