ruote 0.9.19 → 0.9.20

data/lib/openwfe/participants/participantmap.rb

@@ -1,249 +0,0 @@
-#
-#--
-# Copyright (c) 2006-2008, 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.
-#++
-#
-
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
-
-require 'openwfe/workitem'
-require 'openwfe/service'
-require 'openwfe/util/observable'
-require 'openwfe/participants/participants'
-
-
-module OpenWFE
-
-  #
-  # A very simple directory of participants
-  #
-  class ParticipantMap < Service
-    include OwfeObservable
-
-    attr_accessor :participants
-
-    def initialize (service_name, application_context)
-
-      super
-
-      @participants = []
-      @observers = {}
-    end
-
-    #
-    # Returns how many participants are currently registered here.
-    #
-    def size
-
-      @participants.size
-    end
-
-    #
-    # Adds a participant to this map.
-    # This method is called by the engine's own register_participant()
-    # method.
-    #
-    # The participant instance is returned by this method call.
-    #
-    # The know params are :participant (a participant instance or
-    # class) and :position (which can be null or :first).
-    #
-    # By default (if :position is not set to :first), the participant
-    # will appear at the bottom of the participant list.
-    #
-    def register_participant (regex, params, &block)
-
-      participant = params[:participant]
-      position = params[:position]
-
-      if not participant
-
-        raise "please provide a participant instance or a block" \
-          if not block
-
-        participant = BlockParticipant.new block
-      end
-
-      ldebug do
-        "register_participant() "+
-        "participant class is #{participant.class}"
-      end
-
-      if participant.is_a?(Class)
-
-        ldebug { "register_participant() class #{participant}" }
-
-        begin
-
-          participant = participant.new(regex, @application_context)
-
-        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
-
-      original_string = regex.to_s
-
-      unless regex.kind_of?(Regexp)
-
-        regex = regex.to_s
-        regex = "^" + regex unless regex[0, 1] == "^"
-        regex = regex  + "$" unless regex[-1, 1] == "$"
-
-        ldebug { "register_participant() '#{regex}'" }
-
-        regex = Regexp.new(regex)
-      end
-
-      class << regex
-        attr_reader :original_string
-      end
-      regex.instance_variable_set '@original_string', original_string
-
-      participant.application_context = @application_context \
-        if participant.respond_to?(:application_context=)
-
-      # now add the participant to the list
-
-      entry = [ regex, participant ]
-
-      index = (position == :first) ? 0 : -1
-
-      @participants.insert index, entry
-
-      participant
-    end
-
-    #
-    # Looks up a participant given a participant_name.
-    # Will return the first participant whose name matches.
-    #
-    def lookup_participant (participant_name)
-
-      #ldebug { "lookup_participant() '#{participant_name}'" }
-
-      participant_name = participant_name.to_s
-
-      @participants.each do |tuple|
-        return tuple[1] if tuple[0].match(participant_name)
-      end
-
-      nil
-    end
-
-    #
-    # Deletes the first participant matching the given name.
-    #
-    # If 'participant_name' is an integer, will remove the participant
-    # at that position in the participant list.
-    #
-    def unregister_participant (participant_name)
-
-      return (@participants.delete_at(participant_name) != nil) \
-        if participant_name.is_a?(Integer)
-
-      participant_name = participant_name.to_s
-
-      p = @participants.find do |tuple|
-        tuple[0].original_string == participant_name
-      end
-      @participants.delete(p) if p
-
-      (p != nil)
-    end
-
-    #
-    # Dispatches to the given participant (participant name (string) or
-    # 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, participant_name, workitem)
-
-      unless participant
-
-        participant = lookup_participant participant_name
-
-        raise "there is no participant named '#{participant_name}'" \
-          unless participant
-      end
-
-      workitem.participant_name = participant_name
-
-      return cancel(participant, workitem) \
-        if workitem.is_a?(CancelItem)
-
-      onotify :dispatch, :before_consume, workitem
-
-      workitem.dispatch_time = Time.now
-
-      participant.consume workitem
-
-      onotify :dispatch, :after_consume, workitem
-    end
-
-    #
-    # The method onotify (from Osbservable) is made public so that
-    # ParticipantExpression instances may notify the pmap of applies
-    # and replies.
-    #
-    public :onotify
-
-    protected
-
-      #
-      # Will call the cancel method of the participant if it has
-      # one, or will simply discard the cancel item else.
-      #
-      def cancel (participant, cancel_item)
-
-        participant.cancel(cancel_item) \
-          if participant.respond_to?(:cancel)
-
-        onotify :dispatch, :cancel, cancel_item
-          #
-          # maybe it'd be better to specifically log that
-          # a participant has no cancel() method, but it's OK
-          # like that for now.
-      end
-  end
-
-end
-

data/lib/openwfe/participants/socketparticipants.rb

@@ -1,202 +0,0 @@
-#
-#--
-# Copyright (c) 2007-2008, 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.
-#++
-#
-
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
-
-require 'yaml'
-require 'socket'
-require 'timeout'
-
-require 'openwfe/orest/xmlcodec'
-require 'openwfe/participants/participant'
-
-
-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.
-    # Will dispatch the workitem over a TCP connection.
-    #
-    def consume (workitem)
-
-      dispatch(workitem)
-    end
-
-    def dispatch (workitem)
-
-      socket = TCPSocket.new(@host, @port)
-      socket.puts encode_workitem(workitem)
-      socket.puts
-      socket.close_write
-
-      #print "\n__socket.closed? #{socket.closed?}"
-
-      reply = fetch_reply(socket)
-
-      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).dispatch(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
-
-      #
-      # The code that waits for the reply from the server, nicely
-      # wrapped inside a timeout and a rescue block.
-      #
-      def fetch_reply (socket)
-
-        reply = ""
-
-        begin
-
-          timeout(7) do
-            while true
-              r = socket.gets
-              break unless r
-              reply << r
-            end
-          end
-
-        rescue Exception => e
-          puts e
-          raise "timeout while waiting for reply"
-        end
-
-        reply
-      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
-
-      #
-      # This implementation encodes the workitem as an XML document.
-      # This is compatible with OpenWFEja.
-      #
-      def encode_workitem (wi)
-
-        sxml = OpenWFE::XmlCodec::encode(wi)
-
-        s = "xmlCoder #{sxml.length}\n"
-        s << "\n"
-        s << sxml
-        s << "\n"
-        s << "\n"
-        s
-      end
-  end
-
-end
-