openwferu 0.9.0 → 0.9.1

data/lib/ru/fe_define.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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.
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #

data/lib/ru/fe_misc.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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.
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -92,5 +94,50 @@ module OpenWFEru
         end
     end
 
+    #
+    # Triggers the first (and supposedly unique child of this expression)
+    # but never wait for its reply (lose it).
+    # A 'lose' expression never replies to its parent expression.
+    #
+    class LoseExpression < FlowExpression
+
+        def apply (workitem)
+            get_expression_pool.apply(children[0], workitem) \
+                if (@children and @children.length > 0)
+        end
+
+        def reply (workitem)
+            # does nothing at all
+        end
+    end
+
+    #
+    # This method triggers its child (in its own thread) and then
+    # forgets about it. It immediately replies to its parent expression.
+    #
+    class ForgetExpression < LoseExpression
+
+        def apply (workitem)
+
+            if (@children and @children.length > 0)
+
+                wi = workitem.dup
+
+                Thread.new do
+                    begin
+                        get_expression_pool.apply(@children[0], wi)
+                    rescue Exception => e
+                        lwarn do
+                            "apply() failed to apply child to forget "+
+                            OpenWFEru::exception_to_s(e)
+                        end
+                    end
+                end
+            end
+
+            reply_to_parent(wi)
+        end
+    end
+
 end
 

data/lib/ru/fe_participant.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/fe_raw.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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.
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -64,34 +66,38 @@ module OpenWFEru
             new_environment() if not @environment_id
         end
 
-        def apply (workitem)
-            #ldebug { "apply() parent is #{@parent_id}" }
+        def instantiate_real_expression (workitem)
 
             attributes = extract_attributes()
 
-            #ldebug { "apply() expression_name  is '#{expression_name()}'" }
-            #ldebug { "apply() expression_class is '#{expression_class()}'" }
-
-            template = lookup_variable(expression_name())
-
-            if template and template.kind_of? OpenWFE::FlowExpressionId
-                get_expression_pool().launch_template(\
-                    self, 
-                    template, 
-                    workitem, 
-                    lookup_attributes(attributes, workitem))
-                return
-            end
-
             eclass = expression_class()
+
             raise "unknown expression '#{expression_name}'" if not eclass
 
-            expression = eclass.new(@fei, @parent_id, @environment_id, @application_context, attributes)
+            expression = eclass.new(
+                @fei, 
+                @parent_id, 
+                @environment_id, 
+                @application_context, 
+                attributes)
+
             expression.children = extract_children()
 
             expression.store_itself()
 
-            expression.apply(workitem)
+            return expression
+        end
+
+        def apply (workitem)
+
+            template = lookup_variable(expression_name())
+
+            if template and template.kind_of? OpenWFE::FlowExpressionId
+                launch_template(template, workitem)
+            else
+                expression = instantiate_real_expression(workitem)
+                expression.apply(workitem)
+            end
         end
 
         #def reply (workitem)
@@ -115,12 +121,22 @@ module OpenWFEru
         end
         
         def definition_name ()
-            #return @xml_element.attributes['name'].to_str
             return @xml_element.attributes['name'].to_s
         end
 
         protected
 
+            def launch_template (template, workitem)
+
+                attributes = extract_attributes()
+
+                get_expression_pool().launch_template(\
+                    self, 
+                    template, 
+                    workitem, 
+                    lookup_attributes(attributes, workitem))
+            end
+
             def extract_attributes ()
                 result = {}
                 @xml_element.attributes.each_attribute do |a|

data/lib/ru/fe_subprocess.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/fe_time.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/fe_utils.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/fe_value.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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.
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -63,8 +65,7 @@ module OpenWFEru
             child = @children[0]
 
             if child.kind_of? OpenWFE::FlowExpressionId
-                store_itself()
-                get_expression_pool().apply(child, workitem)
+                handle_child(child, workitem)
                 return
             end
 
@@ -95,20 +96,30 @@ module OpenWFEru
 
         protected 
 
-            def determine_value (workitem)
+            def handle_child (child, workitem)
 
-                if @children.length > 0
-                    child = @children[0]
+                child = get_expression_pool().fetch(child)
 
-                    if child.kind_of? FlowExpressionId
-                        return "nada"
-                    else
-                        return child
-                    end
+                if child.is_definition?
+                    fei = get_expression_pool().evaluate(child, workitem)
+                    workitem.attributes[FIELD_RESULT] = fei
+                    reply(workitem)
+                else
+                    get_expression_pool().apply(child, workitem)
                 end
-
-                return OpenWFEru::lookup_value(self, workitem)
             end
+
+            #def determine_value (workitem)
+            #    if @children.length > 0
+            #        child = @children[0]
+            #        if child.kind_of? FlowExpressionId
+            #            return "nada"
+            #        else
+            #            return child
+            #        end
+            #    end
+            #    return OpenWFEru::lookup_value(self, workitem)
+            #end
     end
 
     class UnsetValueExpression < FlowExpression

data/lib/ru/flowexpression.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,8 +28,9 @@
 # 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 $
+#  $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
 
 #
@@ -80,14 +82,19 @@ module OpenWFEru
         #
         # the two most important methods for flow expressions
 
+        #
+        # this default implementation immediately replies to the
+        # parent expression
+        #
         def apply (workitem)
             get_parent().reply(workitem) if @parent_id
         end
 
+        #
+        # this default implementation immediately replies to the
+        # parent expression
+        #
         def reply (workitem)
-            #
-            # a default implementation
-            #
             reply_to_parent(workitem)
         end
 
@@ -95,6 +102,21 @@ module OpenWFEru
             get_expression_pool.reply_to_parent(self, workitem)
         end
 
+        #
+        # a default implementation for cancel :
+        # cancels all the children
+        # Attempts to return an InFlowWorkItem
+        #
+        def cancel ()
+            return nil if not @children
+            inflowitem = nil
+            @children.each do |child|
+                i = get_expression_pool().cancel(child)
+                inflowitem = i if not inflowitem
+            end
+            return inflowitem
+        end
+
         #
         # some convenience methods
 

data/lib/ru/logging.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/participant.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/participantmap.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/participants.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/rudefinitions.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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.
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -37,7 +39,8 @@
 
 module OpenWFEru
 
-    OPENWFE_VERSION = '1.7.2pre17'
+    #OPENWFE_VERSION = '1.7.2pre17'
+    OPENWFE_VERSION = '0.9.2'
 
     #
     # service names
@@ -63,8 +66,12 @@ module OpenWFEru
     #
     # some expression attribute names
 
-    A_SYNC = 'sync'
     A_FORGET = 'forget'
 
+    A_SYNC = 'sync'
+    A_COUNT = 'count'
+    A_REMAINING = 'remaining'
+    REM_CANCEL = 'cancel'
+
 end
 

data/lib/ru/ruutils.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,8 +28,9 @@
 # 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 $
+#  $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
 
 #

data/lib/ru/scheduler.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/schedulers.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/ru/service.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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 $
 #

data/lib/test.rb

@@ -1,4 +1,5 @@
 #
+#<tt>
 # Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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: test.rb 3454 2006-10-08 16:51:00Z jmettraux $
 #

data/lib/utils.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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.
+#++
 #
 # $Id: utils.rb 3454 2006-10-08 16:51:00Z jmettraux $
 #
@@ -90,5 +92,52 @@ module OpenWFE
         return object.dup
     end
 
+    #
+    # an automatic dup implementation attempt
+    #
+    def OpenWFE.dup (object)
+
+        return nil if object == nil
+
+        return object if object.kind_of?(Fixnum)
+
+        o = object.class.new
+
+        #
+        # some kind of collection ?
+
+        if object.kind_of?(Array)
+            object.each do |i|
+                o << dup(i)
+            end
+        elsif object.kind_of?(Hash)
+            object.each do |k, v|
+                o[copy(k)] = dup(v)
+            end
+        end
+
+        #
+        # duplicate the attributes of the object
+
+        object.instance_variables.each do | v |
+
+            #puts "v is #{v}"
+
+            value = object.instance_variable_get(v)
+
+            #puts "value is '#{value}'"
+
+            value = dup(value)
+
+            begin
+                o.instance_variable_set(v, value)
+            rescue Exception => e
+                # ignore, must be readonly
+            end
+        end
+
+        return o
+    end
+    
 end
 

data/lib/workitem.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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.
+#++
 #
 # $Id: workitem.rb 3556 2006-11-13 04:15:52Z jmettraux $
 #
@@ -77,6 +79,8 @@ module OpenWFE
         def lastExpressionId= (fei)
             @flowExpressionId = fei
         end
+
+        alias last_expression_id lastExpressionId
     end
 
     class InFlowWorkItem < InFlowItem
@@ -88,16 +92,7 @@ module OpenWFE
             # special : added by the ruby lib, not given by the worklist
 
         def dup
-            c = InFlowWorkItem.new
-            c.lastModified = OpenWFE::copy(@lastModified)
-            c.attributes = OpenWFE::copy(@attributes)
-            c.flowExpressionId = OpenWFE::copy(@flowExpressionId)
-            c.participantName = OpenWFE::copy(@participantName)
-            c.dispatchTime = OpenWFE::copy(@dispatchTime)
-            c.filter = OpenWFE::copy(@filter)
-            c.history = OpenWFE::copy(@history)
-            c.store = OpenWFE::copy(@store)
-            return c
+            return OpenWFE::dup(self)
         end
     end
 
@@ -126,6 +121,10 @@ module OpenWFE
             :wfdRevision, \
             :wfInstanceId, \
             :expressionId
+        
+        def dup
+            return OpenWFE::dup(self)
+        end
     end
 
 

data/lib/worklistclient.rb

@@ -1,4 +1,5 @@
 #
+#--
 # Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
@@ -27,6 +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.
+#++
 #
 # $Id: worklistclient.rb 3454 2006-10-08 16:51:00Z jmettraux $
 #
@@ -188,14 +190,6 @@ module OpenWFE
             return postItem('forwardWorkitem', workitem)
         end
 
-        #
-        # A synonymous for proceedWorkitem (TODO : use ruby's alias trick)
-        #
-        def forwardWorkitem (workitem)
-
-            return proceedWorkitem(workitem)
-        end
-
         #
         # Returns the list of flow URLs the user owning this session may
         # launch.
@@ -238,6 +232,22 @@ module OpenWFE
         #def queryStore (storeName, query)
         #end
 
+        alias list_stores listStores
+        alias get_store_names getStoreNames
+        alias get_headers getHeaders
+        alias find_flow_instance findFlowInstance
+        alias launch_flow launchFlow
+        alias get_workitem getWorkitem
+        alias get_and_lock_workitem getAndLockWorkitem
+        alias query_and_lock_workitem queryAndLockWorkitem
+        alias release_workitem releaseWorkitem
+        alias save_workitem saveWorkitem
+        alias proceed_workitem proceedWorkitem
+        alias forwardWorkitem proceedWorkitem
+        alias forward_workitem proceedWorkitem
+        alias list_launchables listLaunchables
+        alias delegate_to_participant delegateToParticipant
+
 
         protected