ruote 0.9.19 → 0.9.20

data/lib/openwfe/expressions/fe_sleep.rb

@@ -1,173 +0,0 @@
-#
-#--
-# 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:
-#
-# . 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.
-#++
-#
-
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
-
-require 'rufus/otime'
-require 'openwfe/expressions/time'
-
-
-module OpenWFE
-
-  #
-  # The 'sleep' expression expects one attribute, either 'for', either
-  # 'until'.
-  #
-  #   <sequence>
-  #     <sleep for="10m12s" />
-  #     <participant ref="alpha" />
-  #   </sequence>
-  #
-  # will wait for 10 minutes and 12 seconds before sending a workitem
-  # to participant 'alpha'.
-  #
-  # In a Ruby process definition, that might look like :
-  #
-  #   sleep :for => "3m"
-  #   sleep "3m"
-  #     #
-  #     # both meaning 'sleep for 3 minutes'
-  #
-  #   sleep :until => "Mon Dec 03 10:41:58 +0900 2007"
-  #     #
-  #     # sleep until the given point in time
-  #
-  # If the 'until' attribute points to a time in the past, the sleep
-  # expression will simply let the process resume.
-  #
-  # === scheduler tags
-  #
-  # Scheduler tags can be set like this :
-  #
-  #   sleep "10y", :scheduler_tags => "la_belle_au_bois_dormant"
-  #
-  # This is an advanced feature that most users won't need.
-  #
-  class SleepExpression < TimeExpression
-
-    names :sleep
-
-    attr_accessor :awakening_time
-
-    def apply (workitem)
-
-      sfor = lookup_string_attribute(:for, workitem)
-      suntil = lookup_string_attribute(:until, workitem)
-
-      sfor = fetch_text_content(workitem) \
-        if sfor == nil and suntil == nil
-
-      #ldebug { "apply() sfor is '#{sfor}'" }
-      #ldebug { "apply() suntil is '#{suntil}'" }
-
-      tuntil = nil
-
-      if suntil
-
-        tuntil = suntil
-
-      elsif sfor
-
-        tfor = Rufus::parse_time_string(sfor)
-        #ldebug { "apply() tfor is '#{tfor}'" }
-        tuntil = Time.new.to_f + tfor
-      end
-
-      #ldebug { "apply() tuntil is '#{tuntil}'" }
-
-      return reply_to_parent(workitem) \
-        if not tuntil
-
-      @awakening_time = tuntil
-      @applied_workitem = workitem.dup
-
-      determine_scheduler_tags
-
-      reschedule(get_scheduler)
-    end
-
-    #
-    # This is the method called by the Scheduler instance attached to
-    # the workflow engine when the 'sleep' of this expression is
-    # over
-    #
-    def trigger (params)
-
-      ldebug do
-        "trigger() #{@fei.to_debug_s} waking up (#{Time.new.to_f}) "+
-        "(scheduler #{get_scheduler.object_id})"
-      end
-
-      reply_to_parent(@applied_workitem)
-    end
-
-    #
-    # [Re]schedules this expression, effectively registering it within
-    # the scheduler.
-    # This method is called when the expression is applied and each
-    # time the owning engine restarts.
-    #
-    def reschedule (scheduler)
-
-      return unless @awakening_time
-
-      ldebug do
-        "[re]schedule() " +
-        "will sleep until '#{@awakening_time}' " +
-        "(#{Rufus::to_iso8601_date(@awakening_time)})"
-      end
-
-      @scheduler_job_id = "sleep_#{self.fei.to_s}"
-
-      scheduler.schedule_at(
-        @awakening_time,
-        {
-          :schedulable => self,
-          :job_id => @scheduler_job_id,
-          :tags => @scheduler_tags })
-
-      ldebug do
-        "[re]schedule() @scheduler_job_id is '#{@scheduler_job_id}' "+
-        " (scheduler #{scheduler.object_id})"
-      end
-
-      store_itself
-    end
-  end
-
-end
-

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

@@ -1,189 +0,0 @@
-#
-#--
-# Copyright (c) 2007-2008, Tomaso Tosolini, 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.
-#++
-#
-
-#
-# "made in Italy"
-#
-# Tomaso Tosolini
-# John Mettraux
-#
-
-#require 'rubygems'
-
-#require_gem 'activerecord'
-gem 'activerecord'; require 'active_record'
-
-require 'openwfe/omixins'
-require 'openwfe/expool/errorjournal'
-
-
-module OpenWFE::Extras
-
-  #
-  # A migration for creating/dropping the "process errors" table, the
-  # content of this table makes up for an error journal.
-  #
-  # There is one record per process error, the log journal can be
-  # easily rebuilt by doing find_all_by_wfid().
-  #
-  class ProcessErrorTables < ActiveRecord::Migration
-
-    def self.up
-
-      create_table :process_errors do |t|
-
-        t.column :wfid, :string, :null => false
-        t.column :svalue, :text, :null => false
-          # 'value' could be reserved, using 'svalue' instead
-          # It stands for 'serialized value'.
-      end
-      add_index :process_errors, :wfid
-    end
-
-    def self.down
-
-      drop_table :process_errors
-    end
-  end
-
-  #
-  # The active record for process errors. Not much to say.
-  #
-  class ProcessError < ActiveRecord::Base
-
-    serialize :svalue
-
-    #
-    # Returns the OpenWFE process error, as serialized
-    # (but takes care of setting its db_id)
-    #
-    def owfe_error
-
-      result = svalue
-      class << result
-        attr_accessor :db_id
-      end
-      result.db_id = id
-      result
-    end
-  end
-
-  #
-  # A database backed error journal.
-  #
-  # (no synchronization needed it seems)
-  #
-  class DbErrorJournal < OpenWFE::ErrorJournal
-    include OpenWFE::FeiMixin
-
-    def initialize (service_name, application_context)
-
-      require 'openwfe/storage/yamlcustom'
-        # making sure this file has been required at this point
-        # this yamlcustom thing prevents the whole OpenWFE ecosystem
-        # to get serialized :)
-
-      super
-    end
-
-    #
-    # Returns the error log for a given workflow/process instance,
-    # the older error first.
-    #
-    def get_error_log (wfid)
-
-      wfid = extract_wfid wfid, true
-      errors = ProcessError.find_all_by_wfid wfid, :order => "id asc"
-      errors.collect { |e| e.owfe_error }
-    end
-
-    #
-    # Erases all the errors for one given workflow/process instance.
-    #
-    def remove_error_log (wfid)
-
-      ProcessError.destroy_all ["wfid = ?", wfid]
-    end
-
-    #
-    # Returns a map wfid => error log, ie returns 1 error log for
-    # each workflow/process instance that encountered an error.
-    #
-    def get_error_logs
-
-      errors = ProcessError.find :all
-
-      result = {}
-
-      errors.each do |e|
-        (result[e.wfid] ||= []) << e.owfe_error
-      end
-
-      result
-    end
-
-    #
-    # Removes a set of errors. This is used by the expool when
-    # resuming a previously broken process instance.
-    #
-    def remove_errors (wfid, errors)
-
-      errors = Array(errors)
-
-      errors.each do |e|
-        ProcessError.delete e.db_id
-      end
-    end
-
-    protected
-
-      #
-      # This is the inner method used by the error journal to
-      # record a process error (instance of OpenWFE::ProcessError)
-      # that it observed in the expression pool.
-      #
-      # This method will throw an exception in case of trouble with
-      # the database.
-      #
-      def record_error (process_error)
-
-        e = ProcessError.new
-
-        e.wfid = process_error.wfid
-        e.svalue = process_error
-
-        e.save!
-      end
-  end
-end
-

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

@@ -1,355 +0,0 @@
-#
-#--
-# Copyright (c) 2007-2008, Tomaso Tosolini, 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.
-#++
-#
-
-#
-# "made in Italy"
-#
-# Tomaso Tosolini
-# John Mettraux
-#
-
-#require 'rubygems'
-
-#require_gem 'activerecord'
-gem 'activerecord'; require 'active_record'
-
-require 'monitor'
-
-require 'openwfe/service'
-require 'openwfe/rudefinitions'
-require 'openwfe/expool/expstorage'
-require 'openwfe/expool/threadedexpstorage'
-
-
-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 :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, :wfname
-      add_index :expressions, :exp_class
-    end
-
-    def self.down
-
-      drop_table :expressions
-    end
-  end
-
-  #
-  # The ActiveRecord wrapper for an OpenWFEru FlowExpression instance.
-  #
-  class Expression < ActiveRecord::Base
-
-    serialize :svalue
-  end
-
-  #
-  # Storing OpenWFE flow expressions in a database.
-  #
-  class DbExpressionStorage
-    include MonitorMixin
-    include OpenWFE::ServiceMixin
-    include OpenWFE::OwfeServiceLocator
-    include OpenWFE::ExpressionStorageBase
-
-    #
-    # Constructor.
-    #
-    def initialize (service_name, application_context)
-
-      require 'openwfe/storage/yamlcustom'
-        # making sure this file has been required at this point
-        # this yamlcustom thing prevents the whole OpenWFE ecosystem
-        # to get serialized :)
-
-      super() # absolutely necessary as we include MonitorMixin
-      service_init service_name, application_context
-
-      observe_expool
-    end
-
-    #
-    # Stores an expression.
-    #
-    def []= (fei, flow_expression)
-
-      ldebug { "[]= storing #{fei.to_s}" }
-
-      synchronize do
-
-        e = Expression.find_by_fei fei.to_s
-
-        unless e
-          e = Expression.new
-          e.fei = fei.to_s
-          e.wfid = fei.wfid
-          #e.wfname = fei.wfname
-        end
-
-        e.exp_class = flow_expression.class.name
-        e.svalue = flow_expression
-
-        e.save!
-      end
-    end
-
-    #
-    # Retrieves a flow expression.
-    #
-    def [] (fei)
-
-      #synchronize do
-      e = Expression.find_by_fei fei.to_s
-      return nil unless e
-
-      as_owfe_expression e
-      #end
-    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)
-
-      synchronize do
-        Expression.delete_all ["fei = ?", fei.to_s]
-      end
-    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
-
-    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
-
-      #
-      # 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
-
-        fe = record.svalue
-        fe.application_context = @application_context
-        fe
-      end
-  end
-
-  #
-  # A DbExpressionStorage that does less work, for more performance,
-  # thanks to the ThreadedStorageMixin.
-  #
-  class ThreadedDbExpressionStorage < DbExpressionStorage
-    include OpenWFE::ThreadedStorageMixin
-
-    def initialize (service_name, application_context)
-
-      super
-
-      start_queue
-        #
-        # which sets @thread_id
-    end
-  end
-end
-