ruote 0.9.20 → 2.1.1

data/lib/openwfe/engine/update_exp_methods.rb

@@ -1,119 +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.
-#++
-
-
-module OpenWFE
-
-  #
-  # The methods of the engine for updating live expressions
-  # (in flight modifications of process instances)
-  #
-  module UpdateExpMethods
-
-    #
-    # Use only when doing "process gardening".
-    #
-    # This method updates an expression, the 'data' parameter is expected
-    # to be a hash. If the expression is an Environment, the variables
-    # will be merged with the ones found in the data param.
-    # If the expression is not an Environment, the data will be merged
-    # into the 'applied_workitem' if any.
-    #
-    # If the merge is not possible, an exception will be raised.
-    #
-    def update_expression_data (fei, data)
-
-      fexp = fetch_exp fei
-
-      original = if fexp.is_a?(Environment)
-
-        fexp.variables
-      else
-
-        fexp.applied_workitem.attributes
-      end
-
-      original.merge! data
-
-      get_expression_pool.update fexp
-    end
-
-    #
-    # A variant of update_expression() that directly replaces
-    # the raw representation stored within an expression
-    #
-    # Useful for modifying [not yet reached] segments of processes.
-    #
-    # If the index argument is set, only the raw child pointed by the index
-    # will get updated.
-    #
-    def update_expression_tree (fei, representation, index=nil)
-
-      fexp = fetch_exp(fei)
-
-      #raise "cannot update already applied expression" \
-      #  unless fexp.is_a?(RawExpression)
-
-      if index
-        #
-        # update just one child
-        #
-
-        fexp.raw_representation = fexp.raw_representation.dup
-        fexp.raw_representation[2] = fexp.raw_representation[2].dup
-          # those dups are for the InMemory case ...
-
-        fexp.raw_representation[2][index] = representation
-      else
-        #
-        # update whole tree
-        #
-        fexp.raw_representation = representation
-      end
-
-      fexp.raw_rep_updated = true
-
-      get_expression_pool.update(fexp)
-    end
-
-    alias :update_raw_expression :update_expression_tree
-
-    #
-    # Replaces an expression in the pool with a newer version of it.
-    #
-    # (useful when fixing processes on the fly)
-    #
-    def update_expression (fexp)
-
-      fexp.application_context = application_context
-
-      fexp.raw_rep_updated = true
-
-      get_expression_pool.update(fexp)
-    end
-
-  end
-
-end
-

data/lib/openwfe/expool/def_parser.rb

@@ -1,196 +0,0 @@
-#--
-# Copyright (c) 2008-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 'uri'
-require 'yaml'
-require 'openwfe/rexml'
-require 'openwfe/service'
-require 'openwfe/contextual'
-require 'openwfe/util/treechecker'
-require 'openwfe/util/xml'
-require 'openwfe/util/json'
-require 'openwfe/expressions/rprocdef'
-require 'openwfe/expressions/expression_map'
-
-require 'rufus/verbs' # sudo gem install 'rufus-verbs'
-
-
-module OpenWFE
-
-  #
-  # A process definition parser.
-  #
-  # Currently supports XML, Ruby process definitions, YAML and JSON.
-  #
-  class DefParser < Service
-    include OwfeServiceLocator
-
-    #
-    # a static version of the parse method,
-    # by default checks the tree if it's Ruby code that is passed.
-    #
-    def self.parse (pdef, use_ruby_treechecker=true)
-
-      # preparing a small ad-hoc env (app context) for this parsing
-
-      ac = { :use_ruby_treechecker => use_ruby_treechecker }
-
-      ac[:s_tree_checker] = TreeChecker.new(:s_tree_checker, ac)
-      ac[:s_def_parser] = DefParser.new(:s_def_parser, ac)
-      ac[:s_expression_map] = ExpressionMap.new
-
-      ac[:s_def_parser].parse(pdef)
-    end
-
-    #
-    # the classical initialize() of Ruote services
-    #
-    def initialize (service_name, application_context)
-      super
-    end
-
-    #
-    # This is the only point in the expression pool where an URI
-    # is read, so this is where the :remote_definitions_allowed
-    # security check is enforced.
-    #
-    def read_uri (uri)
-
-      u = URI.parse(uri.to_s)
-
-      raise(':remote_definitions_allowed is set to false') \
-        if (ac[:remote_definitions_allowed] != true and
-          u.scheme and
-          u.scheme != 'file')
-
-      f = Rufus::Verbs.fopen(u) # Rufus::Verbs is OK with redirections
-      result = f.read
-      f.close if f.respond_to?(:close)
-
-      result
-    end
-
-    #
-    # Returns the tree representation into behind the param (uri, string, ...)
-    #
-    def determine_rep (param)
-
-      param = param.is_a?(URI) ? read_uri(param) : param
-      parse(param)
-    end
-
-    #
-    # in : a process pdefinition
-    # out : a tree [ name, attributes, children ]
-    #
-    def parse (pdef)
-
-      tree = case pdef
-        when Array then pdef
-        when String then parse_string(pdef)
-        when Class then pdef.do_make
-        when ProcessDefinition then pdef.do_make
-        when SimpleExpRepresentation then pdef.do_make # legacy...
-        else
-          raise "cannot handle pdefinition of class #{pdef.class.name}"
-      end
-
-      tree = [ 'define', { 'name' => 'NoName', 'revision' => '0' }, [ tree ] ] \
-        unless get_expression_map.is_definition?(tree.first)
-          #
-          # making sure the first expression in the tree is a DefineExpression
-          # (an alias for 'process-definition')
-
-      tree
-    end
-
-    X_START = /^</
-    Y_START = /^--- /
-    J_ARRAY = /^\[.*\]$/
-      #
-      # TODO : place that somewhere in utils/
-
-    def parse_string (pdef)
-
-      pdef = pdef.strip
-
-      return parse_xml(pdef) if pdef.match(X_START)
-      return YAML.load(pdef) if pdef.match(Y_START)
-
-      #(json = (OpenWFE::Json.from_json(pdef) rescue nil)) and return json
-      return OpenWFE::Json.from_json(pdef) if pdef.match(J_ARRAY)
-
-      #
-      # else it's some ruby code to eval
-
-      get_tree_checker.check(pdef)
-
-      # no exception, green for eval...
-
-      ProcessDefinition.eval_ruby_process_definition(pdef)
-    end
-
-    #
-    # The process definition is expressed as XML, turn that into
-    # an expression tree.
-    #
-    def parse_xml (xml)
-
-      xml = REXML::Document.new(xml) \
-        if xml.is_a?(String)
-
-      xml = xml.root \
-        if xml.is_a?(REXML::Document)
-
-      if xml.is_a?(REXML::Text)
-
-        s = xml.to_s.strip
-
-        return s if s.length > 0
-
-        return nil
-      end
-
-      return nil if xml.is_a?(REXML::Comment)
-
-      # then it's a REXML::Element
-
-      rep = [
-        xml.name,
-        xml.attributes.inject({}) { |r, (k, v)| r[k] = v; r },
-        [] ]
-
-      xml.children.each do |c|
-
-        r = parse_xml(c)
-
-        rep.last << r if r
-      end
-
-      rep
-    end
-  end
-end
-

data/lib/openwfe/expool/errorjournal.rb

@@ -1,294 +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/service'
-require 'openwfe/omixins'
-require 'openwfe/rudefinitions'
-
-
-module OpenWFE
-
-  #
-  # Encapsulating process error information.
-  #
-  # Instances of this class may be used to replay_at_error
-  #
-  class ProcessError
-
-    #
-    # When did the error occur.
-    #
-    attr_reader :date
-
-    #
-    # The FlowExpressionId instance uniquely pointing at the expression
-    # which 'failed'.
-    #
-    attr_reader :fei
-
-    #
-    # Generally something like :apply or :reply
-    #
-    attr_reader :message
-
-    #
-    # The workitem accompanying the message (apply(workitem) /
-    # reply (workitem)).
-    #
-    attr_reader :workitem
-
-    #
-    # The String stack trace of the error.
-    #
-    attr_reader :stacktrace
-
-    alias :backtrace :stacktrace
-
-    #
-    # The error class (String) of the top level error
-    #
-    attr_reader :error_class
-
-    def initialize (*args)
-
-      @date = Time.new
-      @fei, @message, @workitem, @error_class, @stacktrace = args
-    end
-
-    #
-    # Returns the parent workflow instance id (process id) of this
-    # ProcessError instance.
-    #
-    def wfid
-      @fei.parent_wfid
-    end
-
-    alias :parent_wfid :wfid
-
-    #
-    # Produces a human readable version of the information in the
-    # ProcessError instance.
-    #
-    def to_s
-      s = ""
-      s << "-- #{self.class.name} --\n"
-      s << "   date :    #{@date}\n"
-      s << "   fei :     #{@fei}\n"
-      s << "   message :   #{@message}\n"
-      s << "   workitem :  ...\n"
-      s << "   error_class : #{@error_class}\n"
-      s << "   stacktrace :  #{@stacktrace[0, 80]}\n"
-      s
-    end
-
-    #
-    # Returns a hash
-    #
-    def hash
-      to_s.hash
-        #
-        # a bit costly but as it's only used by resume_process()...
-    end
-
-    #
-    # Returns true if the other instance is a ProcessError and is the
-    # same error as this one.
-    #
-    def == (other)
-      return false unless other.is_a?(OpenWFE::ProcessError)
-      return to_s == other.to_s
-        #
-        # a bit costly but as it's only used by resume_process()...
-    end
-  end
-
-  #
-  # This is a base class for all error journal, don't instantiate,
-  # work rather with InMemoryErrorJournal (only for testing envs though),
-  # or YamlErrorJournal.
-  #
-  class ErrorJournal < Service
-
-    include OwfeServiceLocator
-    include FeiMixin
-
-    def initialize (service_name, application_context)
-
-      super
-
-      @observers = []
-
-      @observers << get_expression_pool.add_observer(:error) do |evt, *args|
-        #
-        # logs each error occurring in the expression pool
-
-        begin
-
-          record_error(OpenWFE::ProcessError.new(*args))
-
-        rescue Exception => e
-          lwarn { "(failed to record error : #{e})\n#{e.backtrace.join("\n")}" }
-          lwarn { "*** process error : \n#{args.join("\n")}" }
-        end
-      end
-
-      @observers << get_expression_pool.add_observer(:terminate) do |evt, *args|
-        #
-        # removes error log when a process terminates
-
-        fei = args[0].fei
-
-        remove_error_log(fei.wfid) if fei.is_in_parent_process?
-      end
-    end
-
-    #
-    # Stops this journal, takes care of 'unobserving' the expression pool
-    #
-    def stop
-
-      super
-
-      @observers.each { |o| get_expression_pool.remove_observer(o) }
-    end
-
-    #
-    # Returns true if the given wfid (or fei) (process instance id)
-    # has had errors.
-    #
-    def has_errors? (wfid)
-
-      get_error_log(wfid).size > 0
-    end
-
-    #
-    # Takes care of removing an error from the error journal and
-    # they replays its process at that point.
-    #
-    def replay_at_error (error)
-
-      error = error.as_owfe_error if error.respond_to?(:as_owfe_error)
-
-      remove_errors(
-        error.fei.parent_wfid,
-        error)
-
-      get_workqueue.push(
-        get_expression_pool,
-        :do_apply_reply,
-        error.message,
-        error.fei,
-        error.workitem)
-    end
-
-    #
-    # A utility method : given a list of errors, will make sure that for
-    # each flow expression only one expression (the most recent) will get
-    # listed.
-    # Returns a list of errors, from the oldest to the most recent.
-    #
-    # Could be useful when considering a process where multiple replay
-    # attempts failed.
-    #
-    def ErrorJournal.reduce_error_list (errors)
-
-      errors.inject({}) { |h, e|
-        h[e.fei] = e; h
-          # last errors do override previous errors for the same fei
-      }.values.sort { |error_a, error_b|
-        error_a.date <=> error_b.date
-      }
-    end
-  end
-
-  #
-  # Stores all the errors in a hash... For testing purposes only, like
-  # the InMemoryExpressionStorage.
-  #
-  class InMemoryErrorJournal < ErrorJournal
-
-    def initialize (service_name, application_context)
-
-      super
-
-      @per_processes = {}
-    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)
-
-      wfid = extract_wfid(wfid, true)
-      @per_processes[wfid] || []
-    end
-
-    #
-    # Removes the error log for a process instance.
-    #
-    def remove_error_log (wfid)
-
-      wfid = extract_wfid(wfid, true)
-      @per_processes.delete(wfid)
-    end
-
-    #
-    # Removes a list of errors from the error journal.
-    #
-    # The 'errors' parameter may be a single error (instead of an array).
-    #
-    def remove_errors (wfid, errors)
-
-      errors = Array(errors)
-
-      log = get_error_log(wfid)
-
-      errors.each do |e|
-        log.delete(e)
-      end
-    end
-
-    #
-    # Reads all the error logs currently stored.
-    # Returns a hash wfid --> error list.
-    #
-    def get_error_logs
-
-      @per_processes
-    end
-
-    protected
-
-      def record_error (error)
-
-        (@per_processes[error.wfid] ||= []) << error
-          # not that unreadable after all...
-      end
-  end
-end