ruote 0.9.20 → 2.1.1

data/lib/openwfe/expressions/timeout.rb

@@ -1,184 +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 'rufus/otime'
-
-
-module OpenWFE
-
-  #
-  # The timeout behaviour is implemented here, making it easy
-  # to mix it in into ParticipantExpression and WhenExpression.
-  #
-  module TimeoutMixin
-    include Rufus::Schedulable
-
-    attr_accessor :timeout_at
-    attr_accessor :timeout_job_id
-
-    #
-    # Looks for the "timeout" attribute in its process definition
-    # and then sets the @timeout_at field (if there is a timeout).
-    #
-    def determine_timeout (workitem, timeout_attname=:timeout)
-
-      #@timeout_at = nil
-      #@timeout_job_id = nil
-
-      s_timeout = lookup_attribute(timeout_attname, @applied_workitem)
-      return unless s_timeout
-
-      timeout = Rufus::parse_time_string(s_timeout)
-      @timeout_at = Time.new.to_f + timeout
-
-      stamp_workitem(workitem, s_timeout)
-    end
-
-    #
-    # Providing a default reschedule() implementation for the expressions
-    # that use this mixin.
-    # This default implementation just reschedules the timeout.
-    #
-    def reschedule (scheduler)
-      to_reschedule(scheduler)
-    end
-
-    #
-    # Combines a call to determine_timeout and to reschedule.
-    #
-    def schedule_timeout (workitem, timeout_attname=:timeout)
-
-      determine_timeout(workitem, timeout_attname)
-      to_reschedule(get_scheduler)
-    end
-
-    #--
-    # Overrides the parent method to make sure a potential
-    # timeout schedules gets removed.
-    #
-    # Well... Leave that to classes that mix this in...
-    # No method override in a mixin...
-    #
-    #def reply_to_parent (workitem)
-    #  unschedule_timeout(workitem)
-    #  super(workitem)
-    #end
-    #++
-
-    #
-    # Places a "__timed_out__" field in the workitem.
-    #
-    def set_timedout_flag (workitem)
-
-      workitem.attributes['__timed_out__'] = 'true'
-    end
-
-    #
-    # Removes any "__timed_out__" field in the workitem.
-    #
-    def remove_timedout_flag (workitem)
-
-      workitem.attributes.delete('__timed_out__')
-    end
-
-    protected
-
-    def stamp_workitem (wi, timeout)
-
-      return unless wi
-
-      key = "#{@fei.wfid}__#{@fei.expid}"
-
-      stamp = [
-        self.class.name, @fei.expname, Time.now.to_f, timeout, @timeout_at
-      ]
-
-      (wi.attributes['__timeouts__'] ||= {})[key] = stamp
-    end
-
-    def unstamp_workitem (wi)
-
-      return unless wi
-
-      stamps = wi.attributes['__timeouts__']
-      return unless stamps
-
-      stamps.delete("#{@fei.wfid}__#{@fei.expid}")
-    end
-
-    #
-    # prefixed with "to_" for easy mix in
-    #
-    def to_reschedule (scheduler)
-
-      #return if @timeout_job_id
-        #
-        # already rescheduled
-
-      return unless @timeout_at
-        #
-        # no need for a timeout
-
-      @timeout_job_id = "timeout_#{self.fei.to_s}"
-
-      scheduler.schedule_at(
-        @timeout_at,
-        { :schedulable => self,
-          :job_id => @timeout_job_id,
-          :do_timeout! => true,
-          :tags => [ "timeout", self.class.name ] })
-
-      ldebug do
-        "to_reschedule() will timeout at " +
-        "#{Rufus::to_iso8601_date(@timeout_at)}" +
-        " @timeout_job_id is #{@timeout_job_id}" +
-        " (oid #{object_id})"
-      end
-
-      #store_itself()
-        #
-        # done in the including expression
-    end
-
-    #
-    # Unschedules the timeout
-    #
-    def unschedule_timeout (workitem)
-
-      #ldebug do
-      #  "unschedule_timeout() " +
-      #  "@timeout_job_id is #{@timeout_job_id}" +
-      #  " (oid #{object_id})"
-      #end
-
-      return unless @timeout_job_id
-
-      get_scheduler.unschedule(@timeout_job_id)
-      unstamp_workitem(workitem)
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/value.rb

@@ -1,100 +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.
-#++
-
-
-module OpenWFE
-
-  #
-  # A small mixin providing value for looking up the attributes
-  # variable/var/v and field/fld/f.
-  #
-  module ValueMixin
-
-    #
-    # Expressions that include the ValueMixin let it gather values and
-    # then, in their reply() methods do the job with the values.
-    # The gathering task is performed by the ValueMixin.
-    #
-    def apply (workitem)
-
-      escape = lookup_boolean_attribute('escape', workitem, false)
-
-      if raw_children.length < 1
-
-        workitem.set_result(lookup_value(workitem, :escape => escape))
-
-        reply(workitem)
-        return
-      end
-
-      child = raw_children.first
-
-      if child.is_a?(Array) # child is an expression
-
-        if get_expression_map.get_class(child[0]) == DefineExpression
-
-          workitem.set_result(child) # bind process
-
-          reply(workitem)
-        else
-
-          apply_child(0, workitem) # apply child
-        end
-
-      else # child is a piece of text
-
-        workitem.set_result(fetch_text_content(workitem, escape))
-
-        reply(workitem)
-      end
-    end
-
-    def lookup_variable_attribute (workitem)
-
-      lookup [ 'variable', 'var', 'v' ], workitem
-    end
-
-    def lookup_field_attribute (workitem)
-
-      lookup [ 'field', 'fld', 'f' ], workitem
-    end
-
-    private
-
-      def lookup (name_array, workitem)
-
-        name_array.each do |n|
-
-          v = lookup_string_attribute(n, workitem)
-
-          return v if v != nil
-            # covers v = false as well
-        end
-
-        nil
-      end
-  end
-
-end
-

data/lib/openwfe/extras/engine/ar_engine.rb

@@ -1,58 +0,0 @@
-#--
-# Copyright (c) 2007-2009, Tomaso Tosolini and John Mettraux, OpenWFE.org
-#
-# 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 Italy.
-#++
-
-
-require 'openwfe/engine/engine'
-require 'openwfe/extras/expool/ar_expstorage'
-require 'openwfe/extras/expool/db_errorjournal'
-
-
-module OpenWFE::Extras
-
-  #
-  # A simple ArPersistedEngine, pure storage, no caching, no optimization.
-  #
-  class ArPersistedEngine < OpenWFE::Engine
-
-    protected
-
-    #
-    # Overrides the method already found in Engine with a persisted
-    # expression storage
-    #
-    def build_expression_storage
-
-      init_storage(ArExpressionStorage)
-    end
-
-    #
-    # Uses a file persisted error journal.
-    #
-    def build_error_journal
-
-      init_service(:s_error_journal, DbErrorJournal)
-    end
-  end
-end
-

data/lib/openwfe/extras/engine/db_persisted_engine.rb

@@ -1,74 +0,0 @@
-#--
-# Copyright (c) 2007-2009, Tomaso Tosolini and John Mettraux, OpenWFE.org
-#
-# 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 Italy.
-#++
-
-
-require 'openwfe/engine/engine'
-require 'openwfe/extras/expool/db_expstorage'
-require 'openwfe/extras/expool/db_errorjournal'
-
-
-module OpenWFE::Extras
-
-  #
-  # A simple DbPersistedEngine.
-  #
-  class DbPersistedEngine < OpenWFE::Engine
-
-    protected
-
-    #
-    # Overrides the method already found in Engine with a persisted
-    # expression storage
-    #
-    def build_expression_storage
-
-      #init_service(:s_expression_storage, DbExpressionStorage)
-      init_storage(DbExpressionStorage)
-    end
-
-    #
-    # Uses a file persisted error journal.
-    #
-    def build_error_journal
-
-      init_service(:s_error_journal, DbErrorJournal)
-    end
-  end
-
-  #
-  # This OpenWFEru engine features database persistence (thanks to
-  # ActiveRecord), with a cache (for faster read operations) and a
-  # threaded wrapper (for buffering out unecessary write operations),
-  # hence it's fast (of course its's slower than in-memory storage.
-  #
-  class CachedDbPersistedEngine < DbPersistedEngine
-
-    protected
-
-    def build_expression_storage
-
-      init_storage(ThreadedDbExpressionStorage)
-    end
-  end
-end

data/lib/openwfe/extras/expool/ar_expstorage.rb

@@ -1,337 +0,0 @@
-#--
-# Copyright (c) 2007-2009, Tomaso Tosolini, John Mettraux OpenWFE.org
-#
-# 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 Italy.
-#++
-
-
-require 'base64'
-
-require 'openwfe/service'
-require 'openwfe/rudefinitions'
-require 'openwfe/expool/expstorage'
-require 'openwfe/extras/singlecon'
-
-
-module OpenWFE::Extras
-
-  #
-  # A migration for creating/dropping the "expressions" table.
-  # 'expressions' are atomic pieces of running process instances.
-  #
-  class ExpressionTables < ActiveRecord::Migration
-
-    def self.up
-
-      create_table :expressions do |t|
-
-        t.column :fei, :string, :null => false
-        t.column :wfid, :string, :null => false
-        t.column :expid, :string, :null => false
-        #t.column :wfname, :string, :null => false
-        t.column :exp_class, :string, :null => false
-
-        #t.column :svalue, :text, :null => false
-        t.column :svalue, :text, :null => false, :limit => 1024 * 1024
-          #
-          # 'value' could be reserved, using 'svalue' instead
-          #
-          # :limit patch by Maarten Oelering (a greater value
-          # could be required in some cases)
-      end
-      add_index :expressions, :fei
-      add_index :expressions, :wfid
-      add_index :expressions, :expid
-      #add_index :expressions, :wfname
-      add_index :expressions, :exp_class
-    end
-
-    def self.down
-
-      drop_table :expressions
-    end
-  end
-
-  #
-  # The ActiveRecord wrapper for a ruote FlowExpression instance
-  #
-  class Expression < ActiveRecord::Base
-    include SingleConnectionMixin
-  end
-
-  #
-  # Storing OpenWFE flow expressions in a database.
-  #
-  class ArExpressionStorage
-
-    include OpenWFE::ServiceMixin
-    include OpenWFE::OwfeServiceLocator
-    include OpenWFE::ExpressionStorageBase
-
-    attr_accessor :persist_as_yaml
-
-    #
-    # Constructor.
-    #
-    def initialize (service_name, application_context)
-
-      super()
-      service_init(service_name, application_context)
-
-      @persist_as_yaml = (application_context[:persist_as_yaml] == true)
-
-      observe_expool
-    end
-
-    #
-    # Stores an expression.
-    #
-    def []= (fei, flow_expression)
-
-      e = Expression.find_by_fei(fei.to_s)
-
-      unless e
-        e = Expression.new
-        e.fei = fei.to_s
-        e.wfid = fei.wfid
-        e.expid = fei.expid
-        #e.wfname = fei.wfname
-      end
-
-      e.exp_class = flow_expression.class.name
-
-      e.svalue = @persist_as_yaml ?
-        flow_expression.to_yaml :
-        Base64.encode64(Marshal.dump(flow_expression))
-
-      #e.save!
-      e.save_without_transactions!
-    end
-
-    #
-    # Retrieves a flow expression.
-    #
-    def [] (fei)
-
-      (e = Expression.find_by_fei(fei.to_s)) ? as_owfe_expression(e) : nil
-    end
-
-    #
-    # Returns true if there is a FlowExpression stored with the given id.
-    #
-    def has_key? (fei)
-
-      (Expression.find_by_fei(fei.to_s) != nil)
-    end
-
-    #
-    # Deletes a flow expression.
-    #
-    def delete (fei)
-
-      Expression.delete_all([ 'fei = ?', fei.to_s ])
-    end
-
-    #
-    # Returns the count of expressions currently stored.
-    #
-    def size
-
-      Expression.count
-    end
-
-    alias :length :size
-
-    #
-    # Danger ! Will remove all the expressions in the database.
-    #
-    def purge
-
-      Expression.delete_all
-    end
-
-    #
-    # Gather expressions matching certain parameters.
-    #
-    def find_expressions (options={})
-
-      conditions = determine_conditions(options)
-        # note : this call modifies the options hash...
-
-      #
-      # maximize usage of SQL querying
-
-      exps = Expression.find(:all, :conditions => conditions)
-
-      #
-      # do the rest of the filtering
-
-      exps = exps.collect do |exp|
-        as_owfe_expression(exp)
-      end
-
-      exps.find_all do |fexp|
-        does_match?(options, fexp)
-      end
-    end
-
-    #
-    # Fetches the root of a process instance.
-    #
-    def fetch_root (wfid)
-
-      params = {}
-
-      params[:conditions] = [
-        'wfid = ? AND exp_class = ?',
-        wfid,
-        OpenWFE::DefineExpression.to_s
-      ]
-
-      exps = Expression.find(:all, params)
-
-      e = exps.sort { |fe1, fe2| fe1.fei.expid <=> fe2.fei.expid }[0]
-        #
-        # find the one with the smallest expid
-
-      as_owfe_expression(e)
-    end
-
-    #
-    # Used only by work/pooltool.ru for storage migrations.
-    #
-    def each
-
-      return unless block_given?
-
-      Expression.find(:all).each do |e|
-        fexp = as_owfe_expression(e)
-        yield(fexp.fei, fexp)
-      end
-    end
-
-    #
-    # Closes the underlying database... Does nothing in this implementation.
-    #
-    def close
-
-      # nothing to do here.
-    end
-
-    protected
-
-    #
-    # Grabs the options to build a conditions array for use by
-    # find().
-    #
-    # Note : this method, modifies the options hash (it removes
-    # the args it needs).
-    #
-    def determine_conditions (options)
-
-      wfid = options.delete :wfid
-      wfid_prefix = options.delete :wfid_prefix
-      #parent_wfid = options.delete :parent_wfid
-
-      query = []
-      conditions = []
-
-      if wfid
-        query << 'wfid = ?'
-        conditions << wfid
-      elsif wfid_prefix
-        query << 'wfid LIKE ?'
-        conditions << "#{wfid_prefix}%"
-      end
-
-      add_class_conditions options, query, conditions
-
-      conditions = conditions.flatten
-
-      if conditions.size < 1
-        nil
-      else
-        conditions.insert(0, query.join(' AND '))
-      end
-    end
-
-    #
-    # Used by determine_conditions().
-    #
-    def add_class_conditions (options, query, conditions)
-
-      ic = options.delete :include_classes
-      ic = Array(ic)
-
-      ec = options.delete :exclude_classes
-      ec = Array(ec)
-
-      acc ic, query, conditions, 'OR'
-      acc ec, query, conditions, 'AND'
-    end
-
-    def acc (classes, query, conditions, join)
-
-      return if classes.size < 1
-
-      classes = classes.collect do |kind|
-        get_expression_map.get_expression_classes kind
-      end
-      classes = classes.flatten
-
-      quer = []
-      cond = []
-      classes.each do |cl|
-
-        quer << if join == 'AND'
-          'exp_class != ?'
-        else
-          'exp_class = ?'
-        end
-
-        cond << cl.to_s
-      end
-      quer = quer.join(" #{join} ")
-
-      query << "(#{quer})"
-      conditions << cond
-    end
-
-    Y_START = /--- !/
-
-    #
-    # Extracts the OpenWFE FlowExpression instance from the
-    # active record and makes sure its application_context is set.
-    #
-    def as_owfe_expression (record)
-
-      return nil unless record
-
-      s = record.svalue
-
-      fe = s.match(Y_START) ? YAML.load(s) : Marshal.load(Base64.decode64(s))
-
-      fe.application_context = @application_context
-      fe
-    end
-  end
-end
-