openwferu 0.9.16 → 0.9.17

data/lib/openwfe/expressions/timeout.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -37,8 +37,7 @@
 # John Mettraux at openwfe.org
 #
 
-require 'openwfe/util/otime'
-require 'openwfe/util/scheduler'
+require 'rufus/otime'
 
 
 #
@@ -52,7 +51,7 @@ module OpenWFE
     # to mix it in into ParticipantExpression and WhenExpression.
     #
     module TimeoutMixin
-        include Schedulable
+        include Rufus::Schedulable
 
         attr_accessor \
             :timeout_at,
@@ -70,7 +69,7 @@ module OpenWFE
             timeout = lookup_attribute(timeout_attname, @applied_workitem)
             return unless timeout
 
-            timeout = OpenWFE::parse_time_string(timeout)
+            timeout = Rufus::parse_time_string(timeout)
             @timeout_at = Time.new.to_f + timeout
         end
 
@@ -92,7 +91,7 @@ module OpenWFE
             to_reschedule(get_scheduler)
         end
 
-        #
+        #--
         # Overrides the parent method to make sure a potential
         # timeout schedules gets removed.
         #
@@ -103,11 +102,13 @@ module OpenWFE
         #    unschedule_timeout()
         #    super(workitem)
         #end
+        #++
 
         #
         # Places a "__timed_out__" field in the workitem.
         #
         def set_timedout_flag (workitem)
+
             workitem.attributes["__timed_out__"] = "true"
         end
 
@@ -115,6 +116,7 @@ module OpenWFE
         # Removes any "__timed_out__" field in the workitem.
         #
         def remove_timedout_flag (workitem)
+
             workitem.attributes.delete("__timed_out__")
         end
 
@@ -144,7 +146,7 @@ module OpenWFE
 
                 ldebug do 
                     "to_reschedule() will timeout at " +
-                    "#{OpenWFE::to_iso8601_date(@timeout_at)}" +
+                    "#{Rufus::to_iso8601_date(@timeout_at)}" +
                     " @timeout_job_id is #{@timeout_job_id}" +
                     " (oid #{object_id})"
                 end

data/lib/openwfe/expressions/value.rb

@@ -0,0 +1,126 @@
+#
+#--
+# 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
+#
+
+module OpenWFE
+
+    #
+    # A small mixin providing value for looking up the attributes
+    # variable/var/v and field/fld/f.
+    #
+    module ValueMixin
+
+        #
+        # Expressions that include the ValueMixin let it gather values and
+        # then, in their reply() methods do the job with the values.
+        # The gathering task is performed by the ValueMixin.
+        #
+        def apply (workitem)
+
+            escape = lookup_boolean_attribute('escape', workitem, false)
+
+            if @children.length < 1
+
+                workitem.attributes[FIELD_RESULT] =
+                    lookup_value workitem, :escape => escape
+
+                reply workitem
+                return
+            end
+
+            child = @children[0]
+
+            if child.kind_of?(OpenWFE::FlowExpressionId)
+
+                handle_child child, workitem
+                return
+            end
+
+            workitem.attributes[FIELD_RESULT] =
+                fetch_text_content workitem, escape
+
+            reply workitem
+        end
+
+        def lookup_variable_attribute (workitem)
+
+            lookup [ "variable", "var", "v" ], workitem
+        end
+
+        def lookup_field_attribute (workitem)
+
+            lookup [ "field", "fld", "f" ], workitem
+        end
+
+        protected 
+
+            def handle_child (child, workitem)
+
+                raw_child, _fei = get_expression_pool.fetch(child)
+
+                if raw_child.is_definition?
+
+                    #body_fei = get_expression_pool.evaluate child, workitem
+                    #workitem.attributes[FIELD_RESULT] = body_fei
+
+                    workitem.attributes[FIELD_RESULT] = raw_child
+                        #
+                        # storing the child raw expression
+
+                    reply workitem
+                else
+
+                    get_expression_pool.apply raw_child, workitem
+                end
+            end
+
+        private
+
+            def lookup (name_array, workitem)
+
+                name_array.each do |n|
+                    v = lookup_string_attribute n, workitem
+                    return v if v
+                end
+
+                nil
+            end
+    end
+
+end
+

data/lib/openwfe/flowexpressionid.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2005-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -67,19 +67,29 @@ module OpenWFE
 
         FIELDS.each { |f| attr_accessor f }
 
-        #
-        # A shortcut for fei.workflow_instance_id.
-        # There's also fei.parent_wfid.
-        #
-        alias :wfid :workflow_instance_id
-        alias :wfid= :workflow_instance_id=
         alias :expid :expression_id
         alias :expid= :expression_id=
 
         alias :expname :expression_name
+        alias :wfurl :workflow_definition_url
         alias :wfname :workflow_definition_name
         alias :wfrevision :workflow_definition_revision
 
+        #
+        # This method return @workflow_instance_id. If parent is set to
+        # true, if will return the same result as 
+        # parent_workflow_instance_id().
+        #
+        def wfid (parent=false)
+
+            if parent
+                parent_workflow_instance_id
+            else
+                workflow_instance_id
+            end
+        end
+        alias :wfid= :workflow_instance_id=
+
         #
         # the old 'initial_engine_id' is now deprecated, the methods
         # are still around though.
@@ -97,7 +107,7 @@ module OpenWFE
         # Overrides the classical to_s()
         #
         def to_s
-            "(fei #{@owfe_version} #{@engine_id} #{@workflow_definition_url} #{@workflow_definition_name} #{@workflow_definition_revision} #{@workflow_instance_id} #{@expression_name} #{@expression_id})"
+            "(fei #{@owfe_version} #{@engine_id} #{wfurl} #{wfname} #{wfrevision} #{wfid} #{expname} #{expid})"
         end
 
         #
@@ -105,9 +115,7 @@ module OpenWFE
         #
         def to_h
 
-            h = {}
-            FIELDS.each { |f| h[f] = instance_eval("@#{f.to_s}") }
-            h
+            FIELDS.inject({}) { |r, f| r[f] = instance_eval("@#{f.to_s}"); r }
         end
 
         #
@@ -115,14 +123,15 @@ module OpenWFE
         #
         def FlowExpressionId.from_h (h)
 
-            fei = FlowExpressionId.new
-            FIELDS.each { |f| fei.instance_variable_set("@#{f}", h[f]) }
-            fei
+            FIELDS.inject FlowExpressionId.new do |fei, f| 
+                fei.instance_variable_set("@#{f}", h[f] || h[f.to_s])
+                fei
+            end
         end
 
-        def hash ()
+        def hash
 
-            to_s().hash()
+            to_s.hash
         end
 
         def == (other)
@@ -178,14 +187,14 @@ module OpenWFE
         alias eql? ==
 
         def to_debug_s
-            "(fei #{@workflow_definition_name} #{@workflow_definition_revision} #{@workflow_instance_id} #{@expression_id} #{@expression_name})"
+            "(fei #{wfname} #{wfrevision} #{wfid} #{expid} #{expname})"
         end
 
         #
         # Returns a very short string representation (fei wfid expid expname).
         #
         def to_short_s
-            "(fei #{@workflow_instance_id} #{@expression_id} #{@expression_name})"
+            "(fei #{wfid} #{expid} #{expname})"
         end
 
         #
@@ -197,7 +206,19 @@ module OpenWFE
         def to_web_s
 
             eid = expid.gsub("\.", "_")
-            URI.escape("#{workflow_instance_id}__#{eid}")
+
+            URI.escape "#{wfid}__#{eid}"
+        end
+
+        #
+        # Splits the web fei into the workflow instance id and the expression
+        # id.
+        #
+        def self.split_web_s (s)
+
+            i = s.rindex("__")
+
+            [ s[0..i-1], s[i+2..-1].gsub("\_", ".") ]
         end
 
         #
@@ -216,9 +237,7 @@ module OpenWFE
         #
         def parent_workflow_instance_id
 
-            i = workflow_instance_id.index(".")
-            return workflow_instance_id unless i
-            workflow_instance_id[0..i-1]
+            FlowExpressionId.to_parent_wfid workflow_instance_id
         end
 
         alias :parent_wfid :parent_workflow_instance_id
@@ -315,6 +334,17 @@ module OpenWFE
 
             to_fei string
         end
+
+        #
+        # If wfid is already a 'parent wfid' (no sub id), returns it. Else
+        # returns the parent wfid (whatever is before the first ".").
+        #
+        def self.to_parent_wfid (wfid)
+
+            i = wfid.index(".")
+            return wfid unless i
+            wfid[0..i-1]
+        end
     end
 
 end

data/lib/openwfe/listeners/listeners.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -43,7 +43,6 @@ require 'fileutils'
 
 require 'openwfe/service'
 require 'openwfe/rudefinitions'
-require 'openwfe/util/scheduler'
 require 'openwfe/listeners/listener'
 
 
@@ -68,7 +67,8 @@ module OpenWFE
     # then YAML.
     #
     class FileListener < Service
-        include WorkItemListener, Schedulable
+        include WorkItemListener
+        include Rufus::Schedulable
 
         attr_reader :workdir
 

data/lib/openwfe/listeners/socketlisteners.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -90,7 +90,7 @@ module OpenWFE
             @server = TCPServer.new(iface, port)
 
             @thread = OpenWFE.call_in_thread(@service_name, self) do
-                listen()
+                listen
             end
         end
 
@@ -179,7 +179,7 @@ module OpenWFE
 
                 linfo { "listen() listening on #{@server.addr.join('  ')}" }
 
-                while true
+                loop do
 
                     socket = nil
 
@@ -210,7 +210,7 @@ module OpenWFE
                 end
 
                 data = ""
-                while true
+                loop do
                     s = socket.gets
                     break unless s
                     data += s
@@ -240,7 +240,10 @@ module OpenWFE
                 begin
 
                     #result = get_engine.reply(wi)
-                    result = handle_item(wi)
+                    #result = handle_item(wi)
+                    handle_item wi
+
+                    result = "<ok-reply/>"
 
                     ldebug { "handle_socket() result is >>#{result}<<" }
 

data/lib/openwfe/logging.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -80,6 +80,7 @@ module OpenWFE
         # A simplification of caller_to_s for direct usage when debugging
         #
         def ldebug_callstack (msg, max_lines=nil)
+
             ldebug { "#{msg}\n" + OpenWFE::caller_to_s(9, max_lines) }
         end
 
@@ -101,12 +102,14 @@ module OpenWFE
             end
 
             def log_prepare (message)
+
                 return log_author() unless message
-                return "#{log_author} - #{message}"
+                "#{log_author} - #{message}"
             end
 
             def log_author
-                if respond_to? :service_name
+
+                if respond_to?(:service_name)
                     "#{self.class} '#{self.service_name}'"
                 else
                     "#{self.class}"