ruote 0.9.19 → 0.9.20

data/lib/openwfe/expool/yaml_errorjournal.rb

@@ -0,0 +1,187 @@
+#--
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+require 'find'
+require 'fileutils'
+
+require 'openwfe/expool/errorjournal'
+
+
+module OpenWFE
+
+  #
+  # A Journal that only keep track of error in process execution.
+  #
+  class YamlErrorJournal < ErrorJournal
+
+    attr_reader :workdir
+
+    def initialize (service_name, application_context)
+
+      super
+
+      @workdir = get_work_directory + '/ejournal'
+      #@workdir = File.expand_path(@workdir)
+
+      FileUtils.makedirs(@workdir) unless File.exist?(@workdir)
+    end
+
+    #
+    # Returns a list (older first) of the errors for a process
+    # instance identified by its fei or wfid.
+    #
+    # Will return an empty list if there a no errors for the process
+    # instances.
+    #
+    def get_error_log (wfid)
+
+      path = get_path(wfid)
+
+      return [] unless File.exist?(path)
+
+      read_error_log_from(path)
+    end
+
+    #
+    # Copies the error log of a process instance to a give path (and
+    # filename).
+    #
+    # Could be useful when one has to perform replay operations and wants
+    # to keep a copy of the original error[s].
+    #
+    def copy_error_log_to (wfid, path)
+
+      original_path = get_path(wfid)
+      FileUtils.copy_file(original_path, path)
+    end
+
+    #
+    # Reads an error log from a specific file (possibly as copied over
+    # via copy_error_log_to()).
+    #
+    def read_error_log_from (path)
+
+      raise "no error log file at #{path}" unless File.exist?(path)
+
+      File.open(path) do |f|
+        s = YAML.load_stream(f)
+        s.documents
+      end
+    end
+
+    #
+    # Removes the error log of a specific process instance.
+    # Could be a good idea after a succesful replay operation.
+    #
+    # 'wfid' may be either a workflow instance id (String) either
+    # a FlowExpressionId instance.
+    #
+    def remove_error_log (wfid)
+
+      path = get_path(wfid)
+
+      File.delete(path) if File.exist?(path)
+    end
+
+    #
+    # Removes a list of errors from this error journal.
+    #
+    def remove_errors (wfid, errors)
+
+      errors = Array(errors)
+
+      # load all errors
+
+      log = get_error_log(wfid)
+
+      # remove the given errors
+
+      errors.each { |e| log.delete(e) }
+
+      # rewrite error file
+
+      path = get_path wfid
+
+      if log.size > 0
+
+        File.open(path, 'w') do |f|
+          log.each do |e|
+            f.puts e.to_yaml
+          end
+        end
+      else
+
+        File.delete(path)
+      end
+    end
+
+    #
+    # Reads all the error logs currently stored.
+    # Returns a hash wfid --> error list.
+    #
+    def get_error_logs
+
+      result = {}
+
+      Find.find(@workdir) do |path|
+
+        next unless path.match(/\.ejournal$/)
+
+        log = read_error_log_from(path)
+        result[log.first.fei.wfid] = log
+      end
+
+      result
+    end
+
+    protected
+
+      #
+      # logs the error as a yaml string in an error log file
+      # (there is one error log file per workflow instance).
+      #
+      def record_error (error)
+
+        path = get_path(error.fei)
+
+        dirpath = File.dirname(path)
+
+        FileUtils.mkdir_p(dirpath) unless File.exist?(dirpath)
+
+        File.open(path, 'a+') do |f|
+          f.puts(error.to_yaml)
+        end
+      end
+
+      #
+      # Returns the path to the error log file of a specific process
+      # instance.
+      #
+      def get_path (fei_or_wfid)
+
+        "#{@workdir}/#{extract_wfid(fei_or_wfid, true)}.ejournal"
+      end
+  end
+end

data/lib/openwfe/expressions/condition.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2007-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:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . 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.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . 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.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# 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.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/util/treechecker'
 
@@ -65,7 +51,7 @@ module OpenWFE
     #
     def eval_condition (attname, workitem, nattname=nil)
 
-      positive = nil
+      #positive = nil
       negative = nil
 
       positive = do_eval_condition(attname, workitem)
@@ -89,12 +75,13 @@ module OpenWFE
     #
     def determine_condition_attribute (attname)
 
-      attname = [ attname ] unless attname.is_a?(Array)
+      #attname = [ attname ] unless attname.is_a?(Array)
+      attname = Array(attname)
 
       attname.each do |aname|
         aname = aname.intern if aname.is_a?(String)
         return aname if has_attribute(aname)
-        return aname if has_attribute("r" + aname.to_s)
+        return aname if has_attribute("r#{aname.to_s}")
       end
 
       nil
@@ -104,25 +91,17 @@ module OpenWFE
 
       def do_eval_condition (attname, workitem)
 
-        #attname = pick_attribute(attname) \
-        #  if attname.is_a?(Array)
-
         conditional = lookup_attribute(attname, workitem)
-        rconditional = lookup_attribute("r"+attname.to_s, workitem)
+        rconditional = lookup_attribute("r#{attname.to_s}", workitem)
 
         return do_eval(rconditional, workitem) \
           if rconditional and not conditional
 
-        return nil \
-          unless conditional
-
-        ldebug { "do_eval_condition() 0 for  >#{conditional}<" }
-
-        conditional = unescape conditional
+        return nil if conditional.nil?
 
-        ldebug { "do_eval_condition() 1 for  >#{conditional}<" }
+        conditional = unescape(conditional)
 
-        r = eval_set conditional
+        r = eval_set(conditional)
         return r if r != nil
 
         begin
@@ -134,8 +113,6 @@ module OpenWFE
 
         conditional = do_quote(conditional)
 
-        ldebug { "do_eval_condition() 2 for  >#{conditional}<" }
-
         to_boolean(do_eval(conditional, workitem))
       end
 
@@ -187,7 +164,7 @@ module OpenWFE
       #
       def unescape (s)
 
-        s.gsub("&amp;", "&").gsub("&gt;", ">").gsub("&lt;", "<")
+        s.to_s.gsub('&amp;', '&').gsub('&gt;', '>').gsub('&lt;', '<')
       end
 
       #
@@ -198,7 +175,7 @@ module OpenWFE
 
         op = find_operator string
 
-        return '"' + string + '"' unless op
+        return "\"#{string}\"" unless op
 
         op, i = op
 
@@ -218,20 +195,19 @@ module OpenWFE
       #
       def find_operator (string)
 
-        [ "==", "!=", "<=", ">=", "<", ">" ].each do |op|
-          i = string.index op
-          next unless i
-          return [ op, i ]
+        %w{ == != <= >= < > }.each do |op|
+          i = string.index(op)
+          return [ op, i ] if i
         end
+
         nil
       end
 
       #
-      # Evalutates the given code (after security checks)
+      # Evaluates the given code (after security checks)
       #
       def do_eval (s, workitem)
 
-        #TreeChecker.check_conditional s
         get_tree_checker.check_conditional s
 
         # ok, green for eval
@@ -242,8 +218,7 @@ module OpenWFE
           # wi and fe are thus available as well
           # (as self and workitem)
 
-        #Rufus::eval_safely(s, 4, binding())
-        eval s, binding()
+        eval(s, binding())
       end
   end
 

data/lib/openwfe/expressions/environment.rb

@@ -1,41 +1,27 @@
-#
 #--
-# 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:
+# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . 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.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . 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.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# 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.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'rufus/scheduler'
 require 'openwfe/utils'
@@ -60,21 +46,14 @@ module OpenWFE
     #
     attr_accessor :variables
 
-    #def initialize (
-    #  fei, parent, environment_id, application_context, attributes)
-    #  super(fei, parent, environment_id, application_context, attributes)
-    #  @variables = {}
-    #end
-
     def initialize
 
       super
-
       @variables = {}
     end
 
     def self.new_env (
-      fei, parent_id, environment_id, app_context, attributes)
+      fei, parent_id, environment_id, app_context, attributes, variables=nil)
 
       env = self.new
 
@@ -83,6 +62,7 @@ module OpenWFE
       env.environment_id = environment_id
       env.application_context = app_context
       env.attributes = attributes
+      env.variables = variables if variables
 
       env
     end
@@ -92,12 +72,15 @@ module OpenWFE
     #
     def [] (key)
 
-      value = @variables[key]
-
-      return value \
+      return @variables[key] \
         if @variables.has_key?(key) or is_engine_environment?
 
-      return get_parent[key] if @parent_id
+      # else look in parent environment
+
+      return get_parent[key] \
+        if @parent_id
+
+      # finally look in engine (global) environment
 
       get_expression_pool.fetch_engine_environment[key]
     end
@@ -107,29 +90,17 @@ module OpenWFE
     #
     def []= (key, value)
 
-      #ldebug do
-      #  "#{fei.to_debug_s} []= "+
-      #  "'#{key}' => '#{value}' (#{value.class.name})"
-      #end
-
-      #synchronize do
-
       @variables[key] = value
       store_itself
-      #end
     end
 
     #
     # Removes a variable from this environment.
     #
     def delete (key)
-      #synchronize do
 
-      ldebug { "#{fei.to_debug_s} delete() '#{key}'" }
-
-      @variables.delete key
+      @variables.delete(key)
       store_itself
-      #end
     end
 
     #
@@ -140,12 +111,8 @@ module OpenWFE
     #
     def unbind
 
-      #ldebug { "unbind() for #{fei.to_s}" }
-
       @variables.each do |key, value|
 
-        #ldebug { "unbind() '#{key}' => #{value.class}" }
-
         if value.kind_of?(FlowExpressionId)
 
           get_expression_pool.remove(value)
@@ -209,36 +176,55 @@ module OpenWFE
     #
     def get_root_environment
 
-      #ldebug { "get_root_environment\n#{self}" }
+      @parent_id ? get_parent.get_root_environment : self
+    end
+
+    #
+    # A shortcut to get_expression_pool.fetch_engine_environment
+    #
+    def get_engine_environment
+
+      get_expression_pool.fetch_engine_environment
+    end
+
+    #
+    # Fetches in an array (stack) all the values for a given variable from
+    # this environment up to the engine environement (parent chain).
+    #
+    def lookup_variable_stack (varname, stack=[])
+
+      val = self[varname]
+      stack << [ self, val ] unless val.nil?
 
-      return self unless @parent_id
+      return stack if is_engine_environment?
+      return get_parent.lookup_variable_stack(varname, stack) if @parent_id
 
-      get_parent.get_root_environment
+      get_engine_environment.lookup_variable_stack(varname, stack)
     end
 
-    #--
-    #def get_subprocess_environment
-    #  return self if not @parent_id
-    #  return self if @parent_id.sub_instance_id != @fei.sub_instance_id
-    #  get_parent.get_subprocess_environment
-    #end
-    #++
+    #
+    # Returns a brand new hash containing the variables as seen in the
+    # calling environment (doesn't include variables set at the engine level).
+    #
+    def lookup_all_variables
+
+      return @variables unless @parent_id
+
+      get_parent.lookup_all_variables.merge(@variables)
+    end
 
     #
     # Returns a deep copy of this environment.
     #
     def dup
 
-      env = Environment.new_env(
+      Environment.new_env(
         @fei.dup,
         @parent_id,
         @environment_id,
         @application_context,
-        OpenWFE::fulldup(@attributes))
-
-      env.variables = OpenWFE::fulldup self.variables
-
-      env
+        OpenWFE::fulldup(@attributes),
+        OpenWFE::fulldup(self.variables))
     end
   end