openwferu 0.9.12 → 0.9.12.863

data/examples/engine_template.rb

@@ -16,6 +16,7 @@ require 'openwfe/participants/participants'
 #
 
 #application_context = {}
+
 #application_context[:work_directory] = "work"
     #
     # OpenWFEru engines take one optional argument : application_context
@@ -28,8 +29,27 @@ require 'openwfe/participants/participants'
     # ...
     #
 
+#application_context[:remote_definitions_allowed] = true
+    #
+    # unless this parameter is set to true, the engine will not accept
+    # to launch processes whose definition is given by a URL, only
+    # local process definitions (file:) or direct process definitions 
+    # will be allowed.
+
+#application_context[:ruby_eval_allowed] = true
+    #
+    # if this parameter is set to true, evaluation of ruby code in process
+    # definition strings will be allowed as well as the ruby version of 
+    # certain expression attributes like :
+    #
+    #     <participant name="${ruby:LDAP::lookup(customer_id)" />
+    # or
+    #     <if rtest="var % 2 == 0"> ...
+    #
+
 
 #engine = OpenWFE::Engine.new
+#engine = OpenWFE::Engine.new(application_context)
     #
     # an in-memory, totally transient engine
     #
@@ -37,17 +57,27 @@ require 'openwfe/participants/participants'
     # process definitions to run
 
 #engine = OpenWFE::FilePersistedEngine.new
+#engine = OpenWFE::FilePersistedEngine.new(application_context)
     #
     # a file persisted engine, slow, used only within unit tests
     # do not use
 
 engine = OpenWFE::CachedFilePersistedEngine.new
+#engine = OpenWFE::CachedFilePersistedEngine.new(application_context)
     #
     # a file persisted engine, with an in-memory cache.
     # use that
     #
     # persistence is done by default under ./work/
 
+at_exit do
+    #
+    # making sure that the engine gets properly stopped when
+    # Ruby exits.
+    #
+    engine.stop
+end
+
 # -- a console
 
 #engine.enable_irb_console

data/lib/openwfe/contextual.rb

@@ -87,6 +87,27 @@ module OpenWFE
             s
         end
 
+        #
+        # Returns the work directory for the OpenWFE[ru] application context
+        # (if any).
+        #
+        def get_work_directory (context_or_dir=nil)
+
+            dir = if context_or_dir.is_a?(String)
+                context_or_dir
+            elsif context_or_dir.respond_to?(:[])
+                context_or_dir[:work_directory]
+            else
+                @application_context[:work_directory] if @application_context
+            end
+
+            dir = DEFAULT_WORK_DIRECTORY unless dir
+
+            FileUtils.makedirs(dir) unless File.exist?(dir)
+
+            dir
+        end
+
     end
 
 end

data/lib/openwfe/engine/engine.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -137,10 +135,11 @@ module OpenWFE
         end
 
         #
-        # Call this method once the participant for a persisted engine
+        # Call this method once the participants for a persisted engine
         # have been [re]added.
-        # If you call this method too soon, missing participants will 
-        # cause troubles... Call this method after all the participants
+        #
+        # If this method is called too soon, missing participants will 
+        # cause trouble... Call this method after all the participants
         # have been added.
         #
         def reschedule
@@ -152,7 +151,7 @@ module OpenWFE
         #
         # When 'parameters' are used at the top of a process definition, this
         # method can be used to assert a launchitem before launch.
-        # An expression will get raised if the parameters do not match the
+        # An expression will be raised if the parameters do not match the
         # requirements.
         #
         # Note that the launch method will raise those exceptions as well.
@@ -420,31 +419,32 @@ module OpenWFE
                 fei_or_wfid
             end
 
-            #Thread.pass
-            #    #
-            #    # let the flow 'stabilize' or progress before enquiring
-            #fexp = get_expression_pool.fetch_expression(fei)
-            #return unless fexp
-                #
-                # doesn't work well
-
             t = Thread.new { Thread.stop }
 
-            get_expression_pool.add_observer(:terminate) do |channel, fe, wi|
+            to = get_expression_pool.add_observer(:terminate) do |c, fe, wi|
                 t.wakeup if fe.fei.workflow_instance_id == wfid
             end
+            te = get_expression_pool.add_observer(:error) do |c, fei, m, wi, se|
+                t.wakeup if fei.parent_wfid == wfid
+            end
 
             ldebug { "wait_for() #{wfid}" }
 
             t.join
+
+            get_expression_pool.remove_observer to, :terminate
+            get_expression_pool.remove_observer te, :error
+                #
+                # it would work as well without specifying the channel,
+                # but it's thus a little bit faster
         end
 
         #
         # Returns a hash of ProcessStatus instances. The keys of the hash
         # are workflow instance ids.
         #
-        # A ProcessStatus is a description of the state of a process instance
-        # it enumerates the expressions where the process is currently
+        # A ProcessStatus is a description of the state of a process instance.
+        # It enumerates the expressions where the process is currently
         # located (waiting certainly) and the errors the process currently
         # has (hopefully none).
         #
@@ -500,13 +500,13 @@ module OpenWFE
         # Lists all workflow (process) instances currently in the expool (in
         # the engine).
         # This method will return a list of "process-definition" expressions
-        # (root of flows).
-        #
-        # "wfid_prefix" allows your to query for specific workflow instance
-        # id prefixes.
+        # (i.e. OpenWFE::DefineExpression objects -- each representing the root
+        # element of a flow).
         #
-        # If consider_subprocesses is set to true, "process-definition" 
-        # expressions of subprocesses will be returned as well.
+        # consider_subprocesses :: if true, "process-definition" expressions of 
+        #                          subprocesses will be returned as well.
+        # wfid_prefix :: allows your to query for specific workflow instance
+        #                id prefixes.
         #
         def list_processes (consider_subprocesses=false, wfid_prefix=nil)
 
@@ -636,7 +636,7 @@ module OpenWFE
     end
 
     #
-    # ProcessStatus gathers information about the status of a business
+    # ProcessStatus represents information about the status of a workflow
     # process instance.
     #
     # The status is mainly a list of expressions and a hash of errors.

data/lib/openwfe/expool/errorjournal.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id$
-#
 
 #
 # "made in Japan"
@@ -274,7 +272,7 @@ module OpenWFE
 
             super
 
-            @workdir = OpenWFE::get_work_directory + "/ejournal"
+            @workdir = get_work_directory + "/ejournal"
 
             FileUtils.makedirs(@workdir) unless File.exist?(@workdir)
         end

data/lib/openwfe/expool/expressionpool.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -69,7 +67,7 @@ module OpenWFE
     #
     # This special flow expression id is used by the forget() method
     # (which is used by the forget expression and the concurrence
-    #  synchronization expressions)
+    # synchronization expressions)
     #
     GONE_PARENT_ID = FlowExpressionId.new
     GONE_PARENT_ID.owfe_version = "any"
@@ -90,18 +88,18 @@ module OpenWFE
     # expressions.
     #
     class ExpressionPool
-        include \
-            ServiceMixin, 
-            MonitorMixin, 
-            OwfeServiceLocator, 
-            Observable,
-            WorkqueueMixin,
-            FeiMixin
+        include ServiceMixin
+        include OwfeServiceLocator 
+        include Observable
+        include WorkqueueMixin
+        include FeiMixin
+        include MonitorMixin 
 
+        #
+        # code loaded from a remote URI will get evaluated with 
+        # that security level
+        #
         SAFETY_LEVEL = 2
-            #
-            # code loaded from a remote URI will get evaluated with 
-            # that security level
 
         def initialize (service_name, application_context)
 
@@ -122,8 +120,13 @@ module OpenWFE
         # Stops this expression pool (especially its workqueue).
         #
         def stop
+
             @stopped = true
+
             stop_workqueue
+                #
+                # flushes the work queue
+
             onotify :stop
         end
 
@@ -133,6 +136,7 @@ module OpenWFE
         # the monitor mixin by themselves
         #
         def get_monitor (fei)
+
             return @monitors[fei]
         end
 
@@ -851,7 +855,7 @@ module OpenWFE
                 #    "determine_representation() from class #{param.class.name}"
                 #end
 
-                param = read_uri(param) if param.is_a? URI
+                param = read_uri(param) if param.is_a?(URI)
 
                 #ldebug do 
                 #    "determine_representation() " +
@@ -966,16 +970,17 @@ module OpenWFE
 
         def [] (key)
             synchronize do
-                #ldebug { "[] caller :\n" + OpenWFE::caller_to_s(8) }
-                mon = @monitors[key]
-                if not mon
-                    #ldebug { "[] creating new Monitor for  #{key}" }
-                    mon = Monitor.new
-                    @monitors[key] = mon
-                else
-                    #ldebug { "[] already had Monitor for  #{key}" }
-                end
-                return mon
+
+                (@monitors[key] ||= Monitor.new)
+                #if not mon
+                #    #ldebug { "[] creating new Monitor for  #{key}" }
+                #    mon = Monitor.new
+                #    @monitors[key] = mon
+                #else
+                #    #ldebug { "[] already had Monitor for  #{key}" }
+                #end
+                #
+                #mon
             end
         end
 

data/lib/openwfe/expool/history.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -153,7 +151,7 @@ module OpenWFE
 
             super
 
-            @output = OpenWFE::get_work_directory + "/history.log"
+            @output = get_work_directory + "/history.log"
             @output = File.open(@output, "w+")
 
             linfo { "new() outputting history to #{@output.path}" }

data/lib/openwfe/expool/journal.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -73,7 +71,7 @@ module OpenWFE
 
             @buckets = {}
 
-            @workdir = OpenWFE::get_work_directory + "/journal"
+            @workdir = get_work_directory + "/journal"
             @donedir = @workdir + "/done"
 
             FileUtils.makedirs(@donedir) unless File.exist?(@donedir)

data/lib/openwfe/expool/wfidgen.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -61,7 +59,7 @@ module OpenWFE
             @last = -1
             @mutex = Mutex.new
 
-            @last_fn = OpenWFE::get_work_directory + '/wfidgen.last'
+            @last_fn = get_work_directory + '/wfidgen.last'
 
             load_last()
 

data/lib/openwfe/expool/yamlexpstorage.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 'openwfe/utils'
-require 'openwfe/rudefinitions'
 require 'openwfe/storage/yamlextras'
 require 'openwfe/storage/yamlfilestorage'
 
@@ -57,16 +54,15 @@ require 'openwfe/expressions/raw_xml'
 module OpenWFE
     
     #
-    # yaml expression storage
+    # YAML expression storage. Expressions (atomic pieces of process instances)
+    # are stored in a hierarchy of YAML files.
     #
     class YamlFileExpressionStorage  < YamlFileStorage
         include OwfeServiceLocator
         
         def initialize (service_name, application_context)
 
-            path = OpenWFE::get_work_directory + '/expool'
-
-            super(service_name, application_context, path)
+            super(service_name, application_context, '/expool')
 
             observe_expool()
         end
@@ -117,6 +113,10 @@ module OpenWFE
 
         alias :real_each :each
 
+        #
+        # Returns a human-readable list of the current YAML file paths.
+        # (one expression per path).
+        #
         def to_s
 
             s = "\n\n==== #{self.class} ===="

data/lib/openwfe/expressions/environment.rb

@@ -29,9 +29,6 @@
 # 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"
@@ -55,8 +52,7 @@ module OpenWFE
 
         names :environment
 
-        attr_accessor \
-            :variables
+        attr_accessor :variables
 
         def initialize \
             (fei, parent, environment_id, application_context, attributes)
@@ -66,6 +62,9 @@ module OpenWFE
             @variables = {}
         end
 
+        #
+        # Looks up for the value of a variable in this environment.
+        #
         def [] (key)
 
             value = @variables[key]
@@ -75,10 +74,19 @@ module OpenWFE
 
             return get_parent[key] if @parent_id
 
-            return get_expression_pool.fetch_engine_environment[key]
+            get_expression_pool.fetch_engine_environment[key]
         end
 
+        #
+        # Binds a variable in this environment.
+        #
         def []= (key, value)
+
+            #ldebug do 
+            #    "#{fei.to_debug_s} []= "+
+            #    "'#{key}' => '#{value}' (#{value.class.name})"
+            #end
+
             synchronize do
 
                 @variables[key] = value
@@ -86,6 +94,9 @@ module OpenWFE
             end
         end
 
+        #
+        # Removes a variable from this environment.
+        #
         def delete (key)
             synchronize do
 

data/lib/openwfe/expressions/expressionmap.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -55,6 +53,7 @@ require 'openwfe/expressions/fe_when'
 require 'openwfe/expressions/fe_wait'
 require 'openwfe/expressions/fe_reserve'
 require 'openwfe/expressions/fe_losfor'
+require 'openwfe/expressions/fe_command'
 require 'openwfe/expressions/fe_cursor'
 require 'openwfe/expressions/fe_iterator'
 require 'openwfe/expressions/fe_fqv'