ruote 0.9.20 → 2.1.1

data/lib/openwfe/expool/yaml_errorjournal.rb

@@ -1,187 +0,0 @@
-#--
-# 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,226 +0,0 @@
-#--
-# 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 'openwfe/util/treechecker'
-
-
-module OpenWFE
-
-  #
-  # A ConditionMixin is a mixin for flow expressions like 'if' and 'break' for
-  # example.
-  # It allows for shorter notations like
-  #
-  #   <if test="${f:approved} == true"/>
-  #
-  # or
-  #
-  #   _loop do
-  #     participant :graphical_designer
-  #     participant :business_analyst
-  #     _break :if => "${f:approved}"
-  #   end
-  #
-  module ConditionMixin
-
-    #
-    # This is the method brought to expression classes including this
-    # mixin. Easy evaluation of a conditon expressed in an attribute.
-    #
-    def eval_condition (attname, workitem, nattname=nil)
-
-      #positive = nil
-      negative = nil
-
-      positive = do_eval_condition(attname, workitem)
-      negative = do_eval_condition(nattname, workitem) if nattname
-
-      negative = (not negative) if negative != nil
-
-      return positive if positive != nil
-
-      negative
-    end
-
-    #
-    # Returns nil if the cited attname (without or without 'r' prefix)
-    # is not present.
-    #
-    # Attname may be a String or a Symbol, or an Array of String or Symbol
-    # instances.
-    #
-    # Returns the Symbol the attribute if present.
-    #
-    def determine_condition_attribute (attname)
-
-      #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}")
-      end
-
-      nil
-    end
-
-    protected
-
-      def do_eval_condition (attname, workitem)
-
-        conditional = lookup_attribute(attname, workitem)
-        rconditional = lookup_attribute("r#{attname.to_s}", workitem)
-
-        return do_eval(rconditional, workitem) \
-          if rconditional and not conditional
-
-        return nil if conditional.nil?
-
-        conditional = unescape(conditional)
-
-        r = eval_set(conditional)
-        return r if r != nil
-
-        begin
-          return to_boolean(do_eval(conditional, workitem))
-        rescue Exception => e
-          # probably needs some quoting...
-          ldebug { "do_eval_condition() e : #{e}" }
-        end
-
-        conditional = do_quote(conditional)
-
-        to_boolean(do_eval(conditional, workitem))
-      end
-
-      SET_REGEX = /(\S*?)( is)?( not)? set$/
-
-      #
-      # Evals the 'x [ is][ not] set' notation...
-      #
-      def eval_set (cond)
-
-        m = SET_REGEX.match cond
-
-        return nil unless m
-
-        val = m[1]
-        n = m[3]
-
-        ldebug do
-          "eval_set() for >#{cond}<  "+
-          "m[1] is '#{val}', m[3] is '#{n}'"
-        end
-
-        val = val.strip if val
-        val = (val != nil and val != '')
-        n = (n and n.strip == 'not')
-
-        n ? (not val) : val
-      end
-
-    private
-
-      #
-      # Returns true if result is the "true" String or the true
-      # boolean value. Returns false else.
-      #
-      def to_boolean (o)
-
-        #(o == "true" or o == true)
-        o = o.strip if o.is_a?(String)
-        r = ! (o == nil || o == false || o == 'false' || o == '')
-
-        ldebug { "to_boolean() o is _#{o}_ => #{r}" }
-
-        r
-      end
-
-      #
-      # unescapes '>' and '<'
-      #
-      def unescape (s)
-
-        s.to_s.gsub('&amp;', '&').gsub('&gt;', '>').gsub('&lt;', '<')
-      end
-
-      #
-      # Quotes the given string so that it can easily get evaluated
-      # as Ruby code (a string comparison actually).
-      #
-      def do_quote (string)
-
-        op = find_operator string
-
-        return "\"#{string}\"" unless op
-
-        op, i = op
-
-        s = '"'
-        s << string[0..i-1].strip
-        s << '" '
-        s << string[i, op.length]
-        s << ' "'
-        s << string[i+op.length..-1].strip
-        s << '"'
-        s
-      end
-
-      #
-      # Returns the operator and its index (position) in the string.
-      # Returns nil if not operator was found in the string.
-      #
-      def find_operator (string)
-
-        %w{ == != <= >= < > }.each do |op|
-          i = string.index(op)
-          return [ op, i ] if i
-        end
-
-        nil
-      end
-
-      #
-      # Evaluates the given code (after security checks)
-      #
-      def do_eval (s, workitem)
-
-        get_tree_checker.check_conditional s
-
-        # ok, green for eval
-
-        wi = workitem
-        fe = self
-          #
-          # wi and fe are thus available as well
-          # (as self and workitem)
-
-        eval(s, binding())
-      end
-  end
-
-end
-

data/lib/openwfe/expressions/environment.rb

@@ -1,232 +0,0 @@
-#--
-# Copyright (c) 2006-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 'rufus/scheduler'
-require 'openwfe/utils'
-require 'openwfe/expressions/flowexpression'
-
-
-module OpenWFE
-
-  #
-  # An environment is a store for variables.
-  # It's an expression thus it's storable in the expression pool.
-  #
-  class Environment < FlowExpression
-    include Rufus::Schedulable
-
-    names :environment
-
-    V_PAUSED = VAR_PAUSED[1..-1]
-
-    #
-    # the variables stored in this environment.
-    #
-    attr_accessor :variables
-
-    def initialize
-
-      super
-      @variables = {}
-    end
-
-    def self.new_env (
-      fei, parent_id, environment_id, app_context, attributes, variables=nil)
-
-      env = self.new
-
-      env.fei = fei
-      env.parent_id = parent_id
-      env.environment_id = environment_id
-      env.application_context = app_context
-      env.attributes = attributes
-      env.variables = variables if variables
-
-      env
-    end
-
-    #
-    # Looks up for the value of a variable in this environment.
-    #
-    def [] (key)
-
-      return @variables[key] \
-        if @variables.has_key?(key) or is_engine_environment?
-
-      # 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
-
-    #
-    # Binds a variable in this environment.
-    #
-    def []= (key, value)
-
-      @variables[key] = value
-      store_itself
-    end
-
-    #
-    # Removes a variable from this environment.
-    #
-    def delete (key)
-
-      @variables.delete(key)
-      store_itself
-    end
-
-    #
-    # This method is usually called before the environment gets wiped
-    # out of the expression pool.
-    # It takes care of removing subprocess templates pointed at by
-    # variables in this environment.
-    #
-    def unbind
-
-      @variables.each do |key, value|
-
-        if value.kind_of?(FlowExpressionId)
-
-          get_expression_pool.remove(value)
-
-        #elsif value.kind_of?(FlowExpression)
-        #  value.cancel
-        end
-      end
-    end
-
-    #
-    # Returns true if this environment is the engine environment
-    #
-    def is_engine_environment?
-
-      (@fei == get_expression_pool.engine_environment_id)
-    end
-
-    #
-    # Should never get used, only the reschedule() method is relevant
-    # for the Schedulable aspect of an environment expression.
-    #
-    def trigger (params)
-
-      raise "an environment should never get directly triggered"
-    end
-
-    #
-    # Will reschedule any 'Schedulable' variable found in this environment
-    # this method especially targets cron expressions that are stored
-    # as variables and need to be rescheduled upon engine restart.
-    #
-    def reschedule (scheduler)
-
-      @fei.owfe_version = OPENWFERU_VERSION \
-        if @fei.wfurl == 'ee' and @fei.wfname =='ee'
-          #
-          # so that older versions of engine envs get accepted
-
-      @variables.each do |key, value|
-
-        #ldebug { "reschedule()  - item of class #{value.class}" }
-
-        get_expression_pool.paused_instances[@fei.wfid] = true \
-          if key == V_PAUSED
-
-        next unless value.kind_of?(Rufus::Schedulable)
-
-        linfo { "reschedule() for instance of #{value.class.name}" }
-
-        value.application_context = @application_context
-        value.reschedule(scheduler)
-      end
-
-      store_itself
-    end
-
-    #
-    # Returns the top environment for the process instance (the
-    # environment just before the engine environment).
-    #
-    def get_root_environment
-
-      @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 stack if is_engine_environment?
-      return get_parent.lookup_variable_stack(varname, stack) if @parent_id
-
-      get_engine_environment.lookup_variable_stack(varname, stack)
-    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
-
-      Environment.new_env(
-        @fei.dup,
-        @parent_id,
-        @environment_id,
-        @application_context,
-        OpenWFE::fulldup(@attributes),
-        OpenWFE::fulldup(self.variables))
-    end
-  end
-
-end
-