openwferu 0.9.15 → 0.9.16

data/lib/openwfe/listeners/listener.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -44,61 +42,54 @@ require 'openwfe/workitem'
 require 'openwfe/contextual'
 
 
-#
-# some base listener implementation
-#
 module OpenWFE
 
     #
-    # The only thing this mixin module provides is a #reply_to_engine method.
-    # The details on how the workitems arrive are left to the implementations.
+    # this mixin module provides two protected methods, handle_item() and
+    # filter_item(). They can be easily overriden to add some special
+    # behaviours.
     #
     module WorkItemListener
         include Contextual, Logging, OwfeServiceLocator
 
-        @accept_launchitems = true
-
-        #
-        # Determines if the listener should accept or not incoming
-        # launchitems.
-        #
-        def accept_launchitems= (b)
-            raise ArgumentError.new("boolean value expected") \
-                if b != true and b != false
-            @accept_launchitems = b
-        end
-
-        #
-        # Returns true if the listener accepts workitems.
-        # If launchitems are not accepted, the listener will simply
-        # discard them (with a log info message).
-        #
-        def accept_launchitems?
-            @accept_launchitems
-        end
-
         protected
 
             #
             # Simply considers the object as a workitem and feeds it to the 
             # engine.
             #
-            def handle_object (object)
+            def handle_item (item)
 
-                return nil if filter_out_launchitems(object)
+                filter_items item
 
-                get_engine.reply(object)
+                get_engine.reply item
             end
 
             #
-            # Returns true if the listener doesn't accept LaunchItem instances
-            # and the item is one of them.
+            # The base implementation is just empty, feel free to override it
+            # if you need to filter workitems.
             #
-            def filter_out_launchitems (item)
-
-                return false unless item.is_a? OpenWFE::LaunchItem
+            # One example :
+            #
+            #     class MyListener
+            #         include WorkItemListener
+            #
+            #         protected
+            #
+            #             #
+            #             # MyListener doesn't accept launchitems
+            #             #
+            #             def filter_items (item)
+            #                 raise "launchitems not allowed" \
+            #                     if item.is_a?(OpenWFE::LaunchItem)
+            #             end
+            #     end
+            #
+            def filter_items (item)
 
-                return (not accept_launchitems?)
+                #raise(
+                #    "listener of class '#{self.class.name}' "+
+                #    "doesn't accept launchitems")
             end
     end
 

data/lib/openwfe/listeners/listeners.rb

@@ -102,7 +102,7 @@ module OpenWFE
 
                     object = load_object(path)
 
-                    handle_object(object) if object
+                    handle_item(object) if object
 
                 rescue Exception => e
 

data/lib/openwfe/listeners/socketlisteners.rb

@@ -44,7 +44,7 @@ require 'openwfe/utils'
 require 'openwfe/service'
 require 'openwfe/workitem'
 require 'openwfe/rudefinitions'
-require 'openwfe/rest/xmlcodec'
+require 'openwfe/orest/xmlcodec'
 require 'openwfe/listeners/listener'
 
 
@@ -166,6 +166,7 @@ module OpenWFE
         # and maybe only allow a certain range of hosts...
         #
         def is_allowed? (socket)
+
             true
         end
 
@@ -191,7 +192,7 @@ module OpenWFE
                     return unless socket
 
                     OpenWFE.call_in_thread(@service_name, self) do
-                        handle_socket(socket) if socket and is_allowed? socket 
+                        handle_socket(socket) if socket and is_allowed?(socket)
                     end
                 end
             end
@@ -226,17 +227,6 @@ module OpenWFE
                     socket.close
                     return
 
-                elsif wi.kind_of? InFlowWorkItem
-
-                    ldebug do
-                        "handle_socket() received wi for #{wi.fei.to_debug_s}"
-                    end
-
-                elsif wi.kind_of? LaunchItem
-
-                    ldebug do
-                        "handle_socket() received li for #{wi.wfdurl}"
-                    end
                 else
 
                     ldebug do
@@ -249,7 +239,8 @@ module OpenWFE
 
                 begin
 
-                    result = get_engine.reply(wi)
+                    #result = get_engine.reply(wi)
+                    result = handle_item(wi)
 
                     ldebug { "handle_socket() result is >>#{result}<<" }
 
@@ -267,9 +258,10 @@ module OpenWFE
             end
 
             def pop_line (s)
+
                 i = s.index("\n")
                 return s unless i
-                return s[i+1..-1]
+                s[i+1..-1]
             end
     end
 

data/lib/openwfe/logging.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -41,7 +39,6 @@
 
 require 'logger'
 require 'openwfe/utils'
-#require 'openwfe/rudefinitions'
 
 
 module OpenWFE
@@ -75,6 +72,10 @@ module OpenWFE
             do_log(:unknown, message, &block)
         end
 
+        def llog (level, message=nil, &block)
+            do_log(level, message, &block)
+        end
+
         #
         # A simplification of caller_to_s for direct usage when debugging
         #
@@ -100,7 +101,7 @@ module OpenWFE
             end
 
             def log_prepare (message)
-                return log_author() if not message
+                return log_author() unless message
                 return "#{log_author} - #{message}"
             end
 

data/lib/openwfe/{rest → orest}/controlclient.rb

@@ -30,16 +30,14 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: controlclient.rb 3454 2006-10-08 16:51:00Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica"
 #
 
-require 'openwfe/rest/xmlcodec'
-require 'openwfe/rest/restclient'
-require 'openwfe/rest/definitions'
+require 'openwfe/orest/xmlcodec'
+require 'openwfe/orest/restclient'
+require 'openwfe/orest/definitions'
 
 
 module OpenWFE

data/lib/openwfe/{rest → orest}/definitions.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 3454 2006-10-08 16:51:00Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica"

data/lib/openwfe/{rest → orest}/oldrestservlet.rb

@@ -41,7 +41,7 @@
 require 'thread'
 require 'webrick'
 require 'rexml/document'
-require 'openwfe/rest/xmlcodec'
+require 'openwfe/orest/xmlcodec'
 
 
 module OpenWFE

data/lib/openwfe/{rest → orest}/osocket.rb

@@ -33,7 +33,7 @@
 
 require 'socket'
 
-require 'openwfe/rest/xmlcodec'
+require 'openwfe/orest/xmlcodec'
 
 
 module OpenWFE

data/lib/openwfe/{rest → orest}/restclient.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: restclient.rb 3454 2006-10-08 16:51:00Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica"

data/lib/openwfe/orest/workitem.rb

@@ -0,0 +1,206 @@
+#
+#--
+# Copyright (c) 2005-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.
+#++
+#
+
+#
+# "hecho en Costa Rica"
+#
+# john.mettraux@openwfe.org
+#
+
+require 'base64'
+
+require 'openwfe/utils'
+
+
+module OpenWFE
+
+    #--
+    # HISTORY ITEM
+    #
+    # (currently not used in OpenWFEru itself :( )
+    #++
+
+    #
+    # HistoryItem instances are used to keep track of what happened to
+    # a workitem.
+    #
+    class HistoryItem
+
+        attr_accessor \
+            :date,
+            :author,
+            :host,
+            :text,
+            :wfd_name,
+            :wfd_revision,
+            :wf_instance_id,
+            :expression_id
+        
+        def dup
+            OpenWFE::fulldup(self)
+        end
+    end
+
+
+    #--
+    # STORES
+    #++
+
+    #
+    # Models the information about a store as viewed by the current user 
+    # (upon calling the listStores or getStoreNames methods)
+    #
+    class Store
+
+        attr_accessor :name, :workitem_count, :permissions
+
+        def initialize ()
+            super()
+            #@name = nil
+            #@workitem_count = nil
+            #@permissions = nil
+        end
+
+        #
+        # Returns true if the current user may read headers and workitems
+        # from this store
+        #
+        def may_read? ()
+            return @permissions.index('r') > -1
+        end
+
+        #
+        # Returns true if the current user may modify workitems (and at least
+        # proceed/forward them) in this store
+        #
+        def may_write? ()
+            @permissions.index('w') > -1
+        end
+
+        #
+        # Returns true if the current user may browse the headers of this
+        # store
+        #
+        def may_browse? ()
+            @permissions.index('b') > -1
+        end
+
+        #
+        # Returns true if the current user may delegate workitems to this store
+        #
+        def may_delegate? ()
+            @permissions.index('d') > -1
+        end
+    end
+
+    #
+    # A header is a summary of a workitem, returned by the getHeader
+    # worklist method.
+    #
+    # (Only used when accessing an OpenWFEja engine)
+    #
+    class Header < InFlowWorkItem
+
+        attr_accessor :locked
+    end
+
+
+    #--
+    # MISC ATTRIBUTES
+    #
+    # in openwfe-ruby, OpenWFE attributes are immediately mapped to
+    # Ruby instances, but some attributes still deserve their own class
+    #
+    # (Only used when accessing an OpenWFEja engine)
+    #++
+
+    #
+    # a wrapper for some binary content
+    #
+    class Base64Attribute
+
+        attr_accessor :content
+
+        def initialize (base64content)
+
+            @content = base64content
+        end
+
+        #
+        # dewraps (decode) the current content and returns it
+        #
+        def dewrap ()
+
+            Base64.decode64(@content)
+        end
+
+        #
+        # wraps some binary content and stores it in this attribute
+        # (class method)
+        #
+        def Base64Attribute.wrap (binaryData)
+
+            Base64Attribute.new(Base64.encode64(binaryData))
+        end
+    end
+
+
+    #--
+    # LAUNCHABLE
+    #++
+
+    #
+    # A worklist will return list of Launchable instances indicating
+    # what processes (URL) a user may launch on which engine.
+    #
+    # (Only used when accessing an OpenWFEja engine)
+    #
+    class Launchable
+
+        attr_accessor :url, :engine_id
+    end
+
+
+    #
+    # Expression, somehow equivalent to FlowExpression, but only used 
+    # by the control interface.
+    #
+    # (Only used when accessing an OpenWFEja engine)
+    #
+    class Expression
+
+        attr_accessor :id, :apply_time, :state, :state_since
+    end
+
+end
+

data/lib/openwfe/{rest → orest}/worklistclient.rb

@@ -30,20 +30,30 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: worklistclient.rb 3454 2006-10-08 16:51:00Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica"
 #
 
-require 'openwfe/rest/xmlcodec'
-require 'openwfe/rest/definitions'
-require 'openwfe/rest/restclient'
+require 'openwfe/workitem'
+require 'openwfe/orest/xmlcodec'
+require 'openwfe/orest/definitions'
+require 'openwfe/orest/restclient'
 
 
 module OpenWFE
 
+    #
+    # Reopening WorkItem to set the MAP_TYPE (as it's used by OpenWFEja...)
+    #
+    class WorkItem
+        def initialize
+            @last_modified = nil
+            @attributes = {}
+            @attributes[MAP_TYPE] = E_SMAP
+        end
+    end
+
     #
     # a client to an OpenWFE worklists.
     #

data/lib/openwfe/{rest → orest}/xmlcodec.rb

@@ -41,7 +41,8 @@ require 'rexml/document'
 require 'openwfe/utils'
 require 'openwfe/workitem'
 require 'openwfe/flowexpressionid'
-require 'openwfe/rest/definitions'
+require 'openwfe/orest/definitions'
+require 'openwfe/orest/workitem'
 
 
 module OpenWFE
@@ -49,6 +50,8 @@ module OpenWFE
     #
     # Ugly XML codec for OpenWFE workitems
     #
+    # (one of the first things I wrote in Ruby...)
+    #
     module XmlCodec
 
         #

data/lib/openwfe/participants/enoparticipants.rb

@@ -41,6 +41,7 @@
 require 'net/smtp'
 
 require 'openwfe/participants/participant'
+require 'openwfe/participants/participants'
 
 
 module OpenWFE
@@ -89,6 +90,7 @@ module OpenWFE
     #
     class MailParticipant
         include LocalParticipant
+        include TemplateMixin
 
         def initialize (params, &block)
 
@@ -116,23 +118,11 @@ module OpenWFE
             #
             # 1. Expand variables
 
-            msg  = if @block_template
-                #@block_template.call(fe, self, workitem)
-                call_block @block_template, 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
+            msg  = eval_template workitem
 
             from_address = workitem.email_from rescue @from_address
 
-            puts "msg >>>\n#{msg}<<<"
+            #puts "msg >>>\n#{msg}<<<"
 
             #
             # 2. Send message

data/lib/openwfe/participants/participantmap.rb

@@ -61,7 +61,6 @@ module OpenWFE
             super
 
             @participants = []
-
             @observers = {}
         end
 
@@ -87,7 +86,7 @@ module OpenWFE
                 raise "please provide a participant instance or a block" \
                     if not block
 
-                participant = BlockParticipant.new(block)
+                participant = BlockParticipant.new block
             end
 
             ldebug do 
@@ -95,7 +94,7 @@ module OpenWFE
                 "participant class is #{participant.class}"
             end
 
-            if participant.kind_of? Class
+            if participant.kind_of?(Class)
 
                 ldebug { "register_participant() class #{participant}" }
 
@@ -114,7 +113,9 @@ module OpenWFE
                 end
             end
 
-            unless regex.kind_of? Regexp
+            original_string = regex.to_s
+
+            unless regex.kind_of?(Regexp)
 
                 regex = regex.to_s
                 regex = "^" + regex unless regex[0, 1] == "^"
@@ -124,6 +125,11 @@ module OpenWFE
 
                 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=
@@ -155,16 +161,14 @@ module OpenWFE
         #
         def unregister_participant (participant_name)
 
-            pos = -1
-            @participants.each_with_index do |tuple, index|
-                if tuple[0].match(participant_name)
-                    pos = index
-                    break
-                end
+            participant_name = participant_name.to_s
+
+            p = @participants.find do |tuple|
+                tuple[0].original_string == participant_name
             end
-            @participants.delete(pos) if pos > -1
+            @participants.delete(p) if p
             
-            pos > -1
+            (p != nil)
         end
 
         #