openwferu 0.9.5 → 0.9.6

data/lib/openwfe/listeners/sqslisteners.rb

@@ -0,0 +1,145 @@
+#
+#--
+# 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 'yaml'
+require 'base64'
+require 'monitor'
+
+require 'openwfe/service'
+#require 'openwfe/rudefinitions'
+require 'openwfe/util/scheduler'
+require 'openwfe/listeners/listener'
+
+require 'openwfe/util/sqs'
+
+
+#
+# some base listener implementations
+#
+module OpenWFE
+
+    #
+    # Polls an Amazon SQS queue for workitems
+    #
+    # Workitems can be instances of InFlowWorkItem or LaunchItem.
+    #
+    #     require 'openwfe/listeners/sqslisteners'
+    #
+    #     ql = OpenWFE::SqsListener("workqueue1", engine.application_context)
+    #
+    #     engine.add_workitem_listener(ql, "2m30s")
+    #         #
+    #         # thus, the engine will poll our "workqueue1" SQS queue
+    #         # every 2 minutes and 30 seconds
+    #
+    class SqsListener < Service
+        include MonitorMixin, WorkItemListener, Schedulable
+
+        attr_reader :queue_name
+
+        def initialize (queue_name, application_context)
+
+            @queue_name = queue_name.to_s
+
+            service_name = "#{self.class}::#{@queue_name}"
+
+            super(service_name, application_context)
+
+            linfo { "new() queue is '#{@queue_name}'" }
+        end
+
+        #
+        # Will 'find' files in the work directory (by default ./work/in/),
+        # extract the workitem in them and feed it back to the engine.
+        #
+        def trigger (params)
+            synchronize do
+
+                ldebug { "trigger()" }
+
+                qs = SQS::QueueService.new
+
+                qs.create_queue(@queue_name)
+                    # just to be sure it is there
+
+                while true
+
+                    l = qs.get_messages(
+                        @queue_name, :timeout => 0, :count => 255)
+
+                    break if l.length < 1
+
+                    l.each do |msg|
+
+                        o = decode_object(msg)
+
+                        handle_object(o)
+
+                        msg.delete
+
+                        ldebug do 
+                            "trigger() " +
+                            "handled successfully msg #{msg.message_id}" 
+                        end
+                    end
+                end
+            end
+        end
+
+        #
+        # Extracts a workitem from the message's body.
+        #
+        # By default, this listeners assumes the workitem is stored in
+        # its "hash form" (not directly as a Ruby InFlowWorkItem instance).
+        #
+        # LaunchItem instances (as hash as well) are also accepted.
+        #
+        def decode_object (message)
+
+            o = Base64.decode64(message.message_body)
+            o = YAML.load(o)
+            o = OpenWFE::workitem_from_h(o)
+            o
+        end
+    end
+
+end
+

data/lib/openwfe/participants/{enoparticipant.rb → enoparticipants.rb}

@@ -90,7 +90,7 @@ module OpenWFE
     #             "eno@outoftheblue.co.jp",
     #             File.new("path/to/my/mail/template.txt")))
     #
-    # You can also define the email template as a ruby block :
+    # 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 |
     #

data/lib/openwfe/participants/participantmap.rb

@@ -79,10 +79,26 @@ module OpenWFE
                 participant = BlockParticipant.new(block)
             end
 
+            ldebug do 
+                "register_participant() "+
+                "participant class is #{participant.class}"
+            end
+
             if participant.kind_of? Class
+
+                ldebug { "register_participant() class #{participant}" }
+
                 begin
+
                     participant = participant.new(regex, @application_context)
-                rescue
+
+                rescue Exception => e
+                    #ldebug do 
+                    #    "register_participant() " +
+                    #    "falling back to no param constructor because of \n" +
+                    #    OpenWFE::exception_to_s(e)
+                    #end
+
                     participant = participant.new
                 end
             end
@@ -109,6 +125,22 @@ module OpenWFE
             return nil
         end
 
+        #
+        # Deletes the first participant matching the given name.
+        #
+        def unregister_participant (participant_name)
+
+            pos = -1
+            @participants.each_with_index do |tuple, index|
+                if tuple[0].match(participant_name)
+                    pos = index
+                    break
+                end
+            end
+            @participants.delete(pos) if pos > -1
+            return pos > -1
+        end
+
         #
         # Dispatches to the given participant.
         # The workitem will be fed to the consume() method of that participant.

data/lib/openwfe/participants/participants.rb

@@ -39,6 +39,9 @@
 # John Mettraux at openwfe.org
 #
 
+require 'yaml'
+
+require 'openwfe/utils'
 require 'openwfe/participants/participant'
 
 
@@ -48,27 +51,90 @@ require 'openwfe/participants/participant'
 module OpenWFE
 
     #
-    # The PrintParticipant will just emit its name to the
-    # test tracer if any or to stdout else.
-    # Used by some unit tests.
+    # Just dumps the incoming workitem in a file as a YAML String.
     #
-    class PrintParticipant 
+    # By default, this participant will not reply to the engine once
+    # the workitem got dumped to its file, but you can set its 
+    # reply_anyway field to true to make it reply anyway...
+    #
+    class FileParticipant
         include LocalParticipant
 
-        def consume (workitem)
+        attr_accessor :reply_anyway, :workdir
 
-            tracer = @application_context['__tracer']
+        #
+        # The constructor expects as a unique optional param either the 
+        # application_context either the 'output' dir for the participant.
+        #
+        def initialize (context_or_dir=nil)
 
-            if tracer
-                tracer << workitem.participant_name
+            if context_or_dir.kind_of? Hash
+                @application_context = context_or_dir
+                @workdir = @application_context[:work_directory]
             else
-                puts workitem.participant_name
+                @workdir = context_or_dir
             end
 
-            reply_to_engine(workitem)
+            @workdir = OpenWFE::DEFAULT_WORK_DIRECTORY unless @workdir
+            @workdir = "#{@workdir}/out/"
+
+            @reply_anyway = false
         end
-    end
 
+        #
+        # The method called by the engine for each incoming workitem.
+        #
+        def consume (workitem)
+
+            FileUtils.makedirs(@workdir) unless File.exist?(@workdir)
+
+            file_name = @workdir + determine_file_name(workitem)
+
+            dump_to_file(file_name, workitem)
+
+            reply_to_engine(workitem) if @reply_anyway
+        end
+
+        #
+        # This method does the actual job of dumping the workitem (as some
+        # YAML to a file).
+        # It can be easily overriden.
+        #
+        def dump_to_file (file_name, workitem)
+
+            File.open(file_name, "w") do |file|
+                file.print encode_workitem(workitem)
+            end
+        end
+
+        #
+        # You can override this method to control into which file (name)
+        # each workitem gets dumped.
+        # You could even have a unique file for all workitems transiting
+        # through this participant.
+        #
+        def determine_file_name (workitem)
+
+            fei = workitem.fei
+
+            OpenWFE::ensure_for_filename(
+                "#{fei.wfid}_#{fei.expression_id}__" +
+                "#{fei.workflow_definition_name}__" +
+                "#{fei.workflow_definition_revision}" +
+                "#{workitem.participant_name}.yaml")
+        end
+
+        protected
+
+            #
+            # By default, uses YAML to serialize the workitem
+            # (of course you can override this method).
+            #
+            def encode_workitem (wi)
+                YAML.dump(wi)
+            end
+    end
+        
     #
     # This participant is used by the register_participant() method of
     # Engine class.
@@ -119,5 +185,27 @@ module OpenWFE
         end
     end
 
+    #
+    # The PrintParticipant will just emit its name to the
+    # test tracer if any or to stdout else.
+    # Used by some unit tests.
+    #
+    class PrintParticipant 
+        include LocalParticipant
+
+        def consume (workitem)
+
+            tracer = @application_context['__tracer']
+
+            if tracer
+                tracer << workitem.participant_name
+            else
+                puts workitem.participant_name
+            end
+
+            reply_to_engine(workitem)
+        end
+    end
+
 end
 

data/lib/openwfe/participants/soapparticipants.rb

@@ -57,8 +57,8 @@ module OpenWFE
     #     
     #     engine.register_participant("quote_service", quote_service)
     #
-    # TODO #8425 : use blocks as hooks for the mapping (pre/post)
-    # of workitems into webservice operation params.
+    # You can override the method handle_call_result for better mappings 
+    # between web service calls and the workitems.
     #
     class SoapParticipant 
         include LocalParticipant
@@ -79,17 +79,37 @@ module OpenWFE
 
         def consume (workitem)
 
-            call_params = []
+            call_params = prepare_call_params(workitem)
 
-            @params.each do |param|
-                call_params << get_param(workitem, param)
+            call_result = @driver.send(@method_name, *call_params)
+
+            handle_call_result(call_result, workitem)
+
+            reply_to_engine(workitem)
+        end
+
+        #
+        # The base implementation : assumes that for each webservice operation
+        # param there is a workitem field with the same name.
+        #
+        # Feel free to override this method.
+        #
+        def prepare_call_params (workitem)
+
+            @params.collect do |param|
+                get_param(workitem, param)
             end
+        end
 
-            result = @driver.send(@method_name, *call_params)
+        #
+        # This implementation simply stuffs the result into the workitem
+        # as an attribute named "__result__".
+        #
+        # Feel free to override this method.
+        #
+        def handle_call_result (result, workitem)
 
             workitem.attributes["__result__"] = result
-
-            reply_to_engine(workitem)
         end
 
         protected

data/lib/openwfe/participants/socketparticipants.rb

@@ -0,0 +1,172 @@
+#
+#--
+# 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 'yaml'
+require 'socket'
+
+#require 'openwfe/utils'
+require 'openwfe/rest/xmlcodec'
+require 'openwfe/participants/participant'
+
+
+#
+# some base participant implementations
+#
+module OpenWFE
+
+    #
+    # This participant implementation dispatches workitems over TCP sockets.
+    # By default the workitem are dumped as YAML strings, but you can override 
+    # the encode_workitem(wi) method.
+    #
+    # A small example :
+    #
+    #     require 'openwfe/particpants/socketparticipants'
+    #
+    #     sp = OpenWFE::SocketParticipant.new("target.host.xx", 7007)
+    #
+    #     engine.register_participant("Alfred", sp)
+    #
+    class SocketParticipant
+
+        attr_accessor :host, :port
+
+        #
+        # The constructor
+        #
+        def initialize (host, port)
+
+            @host = host
+            @port = port
+        end
+
+        #
+        # The method called by the engine for each incoming workitem.
+        #
+        def consume (workitem)
+
+            socket = TCPSocket.new(@host, @port)
+            socket.puts encode_workitem(workitem)
+            socket.close_write
+
+            reply = ""
+            while true
+                r = socket.gets
+                break unless r
+                reply << r
+            end
+            socket.close
+
+            decode_reply(reply)
+        end
+
+        #
+        # A 'static' method for dispatching workitems, you can use it
+        # directly, without instantiating the SocketParticipant :
+        #
+        #     require 'openwfe/participants/socketparticipants'
+        #
+        #     SocketParticipant.dispatch("127.0.0.1", 7007, workitem)
+        #
+        def SocketParticipant.dispatch (host, port, workitem)
+
+            SocketParticipant.new(host, port).consume(workitem)
+        end
+
+        protected
+
+            #
+            # By default, uses YAML to serialize the workitem
+            # (of course you can override this method).
+            #
+            def encode_workitem (wi)
+                YAML.dump(wi)
+            end
+
+            #
+            # By default, will just return the reply without touching it
+            #
+            def decode_reply (r)
+                r
+            end
+    end
+
+    #
+    # This extension of of SocketParticipant can be used to dispatch
+    # workitems towards an OpenWFEja instance, but OpenWFEru's SocketListener
+    # understands XML workitems as well.
+    #
+    class XmlSocketParticipant < SocketParticipant
+
+        #def initialize (host, port)
+        #    super
+        #end
+
+        #
+        # A 'static' method for dispatching workitems, you can use it
+        # directly, without instantiating the SocketParticipant :
+        #
+        #     require 'openwfe/participants/socketparticipants'
+        #
+        #     SocketParticipant.dispatch("127.0.0.1", 7007, workitem)
+        #
+        def XmlSocketParticipant.dispatch (host, port, workitem)
+
+            XmlSocketParticipant.new(host, port).consume(workitem)
+        end
+
+        protected
+
+            def encode_workitem (wi)
+
+                sxml = OpenWFE::xml_encode(wi)
+
+                s = "xmlCoder #{sxml.length}\n"
+                s << "\n"
+                s << sxml
+                s << "\n"
+                s << "\n"
+                s
+            end
+    end
+
+end
+