openwferu 0.9.6 → 0.9.7

data/lib/openwfe/expool/journal_replay.rb

@@ -0,0 +1,121 @@
+#
+#--
+# Copyright (c) 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.
+#++
+#
+# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'openwfe/flowexpressionid'
+
+
+module OpenWFE
+    
+    #
+    # Keeping a replayable track of the events in an OpenWFEru engine
+    #
+    module JournalReplay
+
+        def replay (file_path)
+
+            events = File.open(file_path) do |f|
+                s = YAML.load_stream f
+                s.documents
+            end
+
+            #
+            # what to do with Sleep and When ?
+
+            events = events[0..-20]
+
+            participants = {}
+
+            seen = {}
+            static = []
+            events.reverse.each do |e|
+
+                etype = e[0]
+                fei = e[2]
+
+                next if etype == :apply
+                next if etype == :reply
+                next if etype == :reply_to_parent
+                next if seen[fei]
+
+                seen[fei] = true
+
+                next if etype == :remove
+
+                static << e
+
+                participants[fei] = true \
+                    if e[3].is_a? OpenWFE::ParticipantExpression
+            end
+
+            seen = {}
+            dynamic = []
+            events.reverse.each do |e|
+                etype = e[0]
+                fei = e[2]
+                next if etype == :update
+                next if etype == :remove
+                #next if etype == :reply_to_parent
+                next if seen[fei]
+                next unless participants[fei]
+                seen[fei] = true
+                dynamic << e
+            end
+
+            puts
+            puts "static :"
+            static.each do |e|
+                puts " - #{e[0]}   #{e[2].to_short_s}"
+            end
+
+            puts
+            puts "participants :"
+            participants.each do |fei, v|
+                puts " - #{fei.to_short_s}"
+            end
+
+            puts
+            puts "dynamic :"
+            dynamic.each do |e|
+                puts " - #{e[0]}   #{e[2].to_short_s}"
+            end
+        end
+    end
+end

data/lib/openwfe/expool/wfidgen.rb

@@ -0,0 +1,318 @@
+#
+#--
+# Copyright (c) 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.
+#++
+#
+# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'thread'
+
+require 'openwfe/service'
+require 'openwfe/rudefinitions'
+require 'openwfe/util/kotoba'
+
+
+module OpenWFE
+    
+    #
+    # This default wfid generator outputs a long integer as a String.
+    # The last given id (in order to prevent clocks being put back) is
+    # stored in the work directory in the file "wfidgen.last"
+    #
+    class DefaultWfidGenerator < Service
+
+        def initialize (service_name, application_context)
+            super
+
+            @last = -1
+            @mutex = Mutex.new
+
+            @last_fn = OpenWFE::get_work_directory + '/wfidgen.last'
+
+            load_last()
+
+            @last_f = File.open(@last_fn, "w")
+        end
+
+        #
+        # Returns a new workflow instance id
+        #
+        def generate
+            wfid = nil
+            @mutex.synchronize do
+                wfid = now
+                wfid = @last + 1 if wfid <= @last
+                @last = wfid
+                save_last
+            end
+            to_string(wfid)
+        end
+
+        #
+        # The actual job of turning the numeric result into a String.
+        # This method is overriden in extension of this class.
+        #
+        def to_string (numeric_id)
+            numeric_id.to_s
+        end
+
+        #
+        # Is a simple call to OpenWFE::split_wfid()
+        #
+        def split_wfid (wfid)
+            OpenWFE.split_wfid(wfid)
+        end
+
+        #
+        # This method is called by OpenWFE::split_wfid() when it has detected
+        # a wfid following this 'defaut' scheme.
+        #
+        def self.split_wfid (wfid)
+            r = []
+            0.upto(wfid.length-1) do |i|
+                r << wfid[i, 1]
+            end
+            r
+        end
+
+        #
+        # Stops this service.
+        # In this particular implementation, makes sure the "wfidgen.last"
+        # file is closed.
+        #
+        def stop
+            @last_f.close
+        end
+
+        protected
+
+            def now
+                wfid = Time.now.to_f * 1000 * 10
+                wfid.to_i
+            end
+
+            def save_last
+                @last_f.pos = 0
+                @last_f.puts @last
+            end
+
+            def load_last
+                @mutex.synchronize do
+
+                    if File.exist?(@last_fn)
+                        begin
+                            s = File.open(@last_fn, "r+") do |f|
+                                f.readline
+                            end
+                            @last = Integer(s)
+                            #puts @last
+                        rescue Exception => e
+                            #puts
+                            #puts e.to_s
+                        end
+                    end
+
+                    n = now
+
+                    @last = n if (not @last) or (@last < n)
+                end
+            end
+    end
+
+    #
+    # This extension of DefaultWfidGenerator produces ids like
+    # "20070318-jonowoguya" or "20071224-jesoshimoha" that are a bit
+    # easier to grasp than full integer wfids.
+    #
+    class KotobaWfidGenerator < DefaultWfidGenerator
+
+        #
+        # Overrides the to_string() method of the DefaultWfidGenerator,
+        #
+        def to_string (numeric_id)
+
+            self.class.to_string(numeric_id)
+        end
+
+        #
+        # That's here that the numeric wfid gets turned into a 'kotoba'.
+        # A static method easily accessible by any.
+        #
+        def self.to_string (numeric_id)
+
+            i = numeric_id % (10 * 1000 * 60 * 60 * 24)
+            t = Time.now.gmtime
+
+            s = sprintf "%4d%02d%02d", t.year, t.month, t.day
+            s << "-"
+            s << Kotoba::from_integer(i)
+            s
+        end
+
+        #
+        # This method is called by OpenWFE::split_wfid() when it has detected
+        # a wfid following the 'kotoba' scheme.
+        # Returns the 'kotoba' wfid split into its syllables
+        #
+        def self.split_wfid (wfid)
+            Kotoba::split(wfid[9..-1])
+        end
+
+        #
+        # Turns a KotobaWfidGenerator produced wfid into a UTC date.
+        #
+        def self.to_time (wfid)
+
+            year = wfid[0, 4]
+            month = wfid[4, 2]
+            day = wfid[6, 2]
+
+            s = wfid[9..-1]
+
+            i = Kotoba::to_integer(s)
+
+            hour = (i / (10000 * 60 * 60)) % 24
+            min = (i / (10000 * 60)) % 60
+            sec = (i / 10000) % 60
+            usec = (i * 100) % 1000000
+
+            #puts "hms #{hour} #{min} #{sec} #{usec}"
+
+            Time.utc(year, month, day, hour, min, sec, usec)
+        end
+
+        def self.from_time (t)
+            to_string (t.to_f * 10 * 1000).to_i
+        end
+    end
+
+    #
+    # A wfid generator that uses any underlying "uuidgen" command it might
+    # find.
+    # By default, it favours "uuidgen -t".
+    #
+    # You can specifying a command by passing a :uuid_command param in the 
+    # application context, or simply by overriding the generate() method.
+    #
+    class UuidWfidGenerator < Service
+
+        COMMANDS = [
+            "uuidgen -t",
+            "uuidgen"
+        ]
+
+        def initialize (service_name, application_context)
+
+            super
+
+            @command = @application_context[:uuid_command] \
+                if @application_context
+
+            unless @command
+                COMMANDS.each do |c|
+                    c = "#{c} 2> /dev/null"
+                    s = `#{c}`
+                    h = s[0, 8].hex
+                    if h > 0
+                        @command = c
+                        break
+                    end
+                end
+            end
+
+            raise "no command found for generating an uuid found..." \
+                unless @command
+
+            linfo { "new() command that will be used : '#{@command}'" }
+        end
+
+        #
+        # Generates a brand new UUID
+        #
+        def generate
+            return `#{@command}`.chomp
+        end
+
+        #
+        # Is a simple call to OpenWFE::split_wfid()
+        #
+        def split_wfid (wfid)
+            OpenWFE.split_wfid(wfid)
+        end
+
+        #
+        # This method is called by OpenWFE::split_wfid() when it has detected
+        # a wfid that is a UUID.
+        #
+        # Splits the first part of the uuid (will be used for the
+        # expression storage directory structure).
+        #
+        def self.split_wfid (wfid)
+            s = wfid[0, 8]
+            a = []
+            4.times do |i|
+                a << s[i*2, 2]
+            end
+            a
+        end
+    end
+
+    #
+    # "module methods"
+    #
+
+    SPLIT_MAP = {
+        "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" => UuidWfidGenerator,
+        "[0-9]{8}-[a-z]*" => KotobaWfidGenerator
+    }
+
+    #
+    # This method should be able to split any wfid whose scheme is implemented
+    # here.
+    #
+    def OpenWFE.split_wfid (wfid)
+        SPLIT_MAP.each do |regex, clazz|
+            return clazz.split_wfid(wfid) if wfid.match(regex) 
+        end
+        #
+        # else
+        #
+        DefaultWfidGenerator.split_wfid(wfid)
+    end
+
+end
+

data/lib/openwfe/expool/yamlexpstorage.rb

@@ -42,6 +42,7 @@
 
 require 'openwfe/utils'
 require 'openwfe/rudefinitions'
+require 'openwfe/storage/yamlextras'
 require 'openwfe/storage/yamlfilestorage'
 
 require 'openwfe/expressions/flowexpression'
@@ -55,42 +56,6 @@ require 'openwfe/expressions/raw_xml'
 
 module OpenWFE
     
-    #
-    # reopening some classes in order to facilitate their
-    # yaml serialization
-    #
-    
-    #
-    # opening for tuning yaml persistence
-    #
-    class FlowExpression
-
-        def to_yaml_properties
-
-            l = super()
-
-            l.delete("@application_context")
-
-            l.delete("@timeout_job_id")
-            l.delete("@scheduler_job_id")
-                #
-                # scheduler ids should not get persisted
-
-            return l
-        end
-    end
-    
-    #
-    # opening for tuning yaml persistence
-    #
-    class XmlRawExpression
-        def to_yaml_properties
-            l = super()
-            l.delete("@raw_representation")
-            return l
-        end
-    end
-    
     #
     # yaml expression storage
     #
@@ -99,12 +64,13 @@ module OpenWFE
         
         def initialize (service_name, application_context)
 
-            path = if (@application_context) 
-                @application_context[:work_directory]
-            else 
-                DEFAULT_WORK_DIRECTORY
-            end
-            path = path + '/expool'
+            #path = if (@application_context) 
+            #    @application_context[:work_directory]
+            #else 
+            #    DEFAULT_WORK_DIRECTORY
+            #end
+            #path = path + '/expool'
+            path = OpenWFE::get_work_directory + '/expool'
 
             super(service_name, application_context, path)
 
@@ -182,11 +148,13 @@ module OpenWFE
                     if fei.workflow_instance_id == "0"
                     
                 wfid = fei.parent_workflow_instance_id
+
+                #a_wfid = OpenWFE::split_wfid(wfid)
+                a_wfid = get_wfid_generator.split_wfid(wfid)
                 
                 @basepath +
-                #wfid[-3, 1] + "/" +
-                wfid[-2, 1] + "/" +
-                wfid[-1, 1] + "/" +
+                a_wfid[-2] + "/" +
+                a_wfid[-1] + "/" +
                 fei.workflow_instance_id + "__" +
                 fei.expression_id + "_" + 
                 fei.expression_name + ".yaml"
@@ -209,6 +177,10 @@ module OpenWFE
     #
     class ThreadedYamlFileExpressionStorage < YamlFileExpressionStorage
 
+        FREQ = "400" # milliseconds
+            #
+            # the frequency at which the event queue should be processed
+
         def initialize (service_name, application_context)
 
             super
@@ -216,9 +188,9 @@ module OpenWFE
             @events = {}
             @op_count = 0
 
-            @stopped = false
-
             start_processing_thread()
+                #
+                # which sets @thread_id
         end
 
         #
@@ -226,7 +198,7 @@ module OpenWFE
         #
         def stop
 
-            @stopped = true
+            get_scheduler.unschedule(@thread_id) if @thread_id
 
             process_queue()
                 #
@@ -258,12 +230,9 @@ module OpenWFE
         protected
 
             def start_processing_thread
-                Thread.new do
-                    while true
-                        sleep(0.33)
-                        break if @stopped
-                        process_queue()
-                    end
+
+                @thread_id = get_scheduler.schedule_every(FREQ) do
+                    process_queue()
                 end
             end
 

data/lib/openwfe/expressions/condition.rb

@@ -39,6 +39,8 @@
 # John Mettraux at openwfe.org
 #
 
+require 'openwfe/util/safe'
+
 
 module OpenWFE
 
@@ -65,7 +67,8 @@ module OpenWFE
             rconditional = lookup_attribute("r"+attname.to_s, workitem)
 
             if rconditional and not conditional
-                return instance_eval(rconditional)
+                #return instance_eval(rconditional)
+                return do_eval(rconditional)
             end
 
             return nil unless conditional
@@ -80,7 +83,8 @@ module OpenWFE
 
             ldebug { "eval_condition() 2 for  '#{conditional}'" }
 
-            result = instance_eval(conditional)
+            #result = instance_eval(conditional)
+            result = do_eval(conditional)
 
             ldebug { "eval_condition() 3 result is  '#{result}'" }
 
@@ -114,6 +118,14 @@ module OpenWFE
                 string[i+2..-1].strip +
                 '"'
             end
+
+            #
+            # Runs the given given within an instance_eval() at a $SAFE
+            # level of 3.
+            #
+            def do_eval (s)
+                OpenWFE::instance_eval_safely(self, s, 3)
+            end
     end
 
 end