openwferu 0.9.0

data/lib/otime.rb

@@ -0,0 +1,171 @@
+#
+# Copyright (c) 2005-2006, 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.
+#
+# $Id: otime.rb 3509 2006-10-21 12:00:52Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+#
+# john.mettraux@openwfe.org
+#
+
+require 'parsedate'
+
+
+module OpenWFE
+
+    TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
+
+    #
+    # Returns the current time as an ISO date string
+    #
+    def OpenWFE.now ()
+        return to_iso_date(Time.new())
+    end
+
+    def OpenWFE.to_iso_date (date)
+
+        if date.kind_of?(Float)
+            date = Time.at(date)
+        end
+
+        s = date.getutc().strftime(TIME_FORMAT)
+        o = date.utc_offset / 3600
+        o = o.to_s() + "00"
+        o = "0" + o if o.length < 4
+        o = "+" + o unless o[0..1] == '-'
+        return s + " " + o.to_s()
+    end
+
+    #
+    # Returns a Ruby time
+    #
+    def OpenWFE.toRubyTime (isoDate)
+
+        res = ParseDate.parsedate(isoDate)
+        return Time.local(*res)
+    end
+
+    #
+    # An Ruby-friendly alias for toRubyTime()
+    #
+    def OpenWFE.to_ruby_time (iso_date)
+
+        return toRubyTime(iso_date)
+    end
+
+    #def OpenWFE.parse_date (date)
+    #end
+
+    #
+    # equivalent to java.lang.System.currentTimeMillis()
+    #
+    def OpenWFE.current_time_millis ()
+        t = Time.new()
+        t = t.to_f * 1000
+        return t.to_i
+    end
+
+    #
+    # turns a string like '1m10s' into a float like '70.0'
+    #
+    # w -> week
+    # d -> day
+    # h -> hour
+    # m -> minute
+    # s -> second
+    # M -> month
+    # y -> year
+    # 'nada' -> millisecond
+    #
+    def OpenWFE.parse_time_string (string)
+
+        string = string.strip
+
+        index = -1
+        result = 0.0
+
+        number = ""
+
+        while true
+            index = index + 1
+
+            if index >= string.length
+                if number.length > 0
+                    result = result + (Integer(number) / 1000)
+                end
+                break
+            end
+
+            c = string[index, 1]
+
+            if is_digit?(c)
+                number = number + c
+                next
+            end
+
+            value = Integer(number)
+            number = ""
+
+            multiplier = DURATIONS[c]
+
+            raise "unknown time char '#{c}'" \
+                if not multiplier
+
+            result = result + (value * multiplier)
+        end
+
+        return result
+    end
+
+    #
+    # returns true if the character c is a digit
+    #
+    def OpenWFE.is_digit? (c)
+        return false if not c.kind_of?(String)
+        return false if c.length > 1
+        return (c >= "0" and c <= "9")
+    end
+
+    protected
+
+        DURATIONS = {
+            "y" => 365 * 24 * 3600,
+            "M" => 30 * 24 * 3600,
+            "w" => 7 * 24 * 3600,
+            "d" => 24 * 3600,
+            "h" => 3600,
+            "m" => 60,
+            "s" => 1
+        }
+
+end
+

data/lib/restclient.rb

@@ -0,0 +1,155 @@
+#
+# Copyright (c) 2005-2006, 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.
+#
+# $Id: restclient.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+#
+
+require 'base64'
+require 'net/http'
+require 'rexml/document'
+
+
+module OpenWFE
+
+    class RestClient
+
+        attr_reader :host, :port, :resource, :sessionId
+
+        def initialize (url, username, password)
+
+            splitUrl(url)
+            @username = username
+
+            connect(password)
+        end
+
+        #
+        # Closes this REST client
+        #
+        def close ()
+
+            post('endWorkSession', nil, {}, nil)
+        end
+
+        protected
+
+            def get (action, subResourceName, params)
+
+                return @httpclient\
+                    .get(computeResource(action, subResourceName, params))
+            end
+
+            def post (action, subResourceName, params, data)
+
+                data = data.to_s()
+
+                return @httpclient\
+                    .post(computeResource(action, subResourceName, params), data)
+            end
+
+        private
+
+            def splitUrl (url)
+
+                @host = nil
+                @port = nil
+                @resource = nil
+
+                url = url[7..-1] if url[0..6] == 'http://'
+
+                i = url.index('/')
+                if i < 0
+                    @resource = '/defaultrestresource'
+                else
+                    @resource = url[i..-1]
+                    url = url[0..i]
+                end
+
+                @host, @port = url.split(':')
+
+                if @port == nil
+                    @port = 5080
+                else
+                    @port = Integer(@port[0..-2])
+                end
+            end
+
+            def connect (password)
+
+                @httpclient = Net::HTTP.new(@host, @port)
+
+                hs = {}
+                hs['Authorization'] = \
+                    'Basic ' + Base64.encode64(@username+":"+password)
+                hs['RestClient'] = 'openwfe-ruby'
+
+                r = @httpclient.get(@resource, hs)
+
+                xml = REXML::Document.new(r.body)
+
+                @sessionId = Integer(xml.root.attributes["id"])
+            end
+
+            def computeResource (action, subResourceName, params)
+
+                resource = @resource
+                resource = resource+'/'+subResourceName if subResourceName
+
+                resource = resource+\
+                    '?session='+@sessionId.to_s()+'&action='+action
+
+                if params
+                    params.keys.each do |k|
+                        resource = resource+'&'+k.to_s()+'='+params[k].to_s()
+                    end
+                end
+
+                return resource
+            end
+    end
+end
+
+
+# for test purposes
+#
+#client = RestClient::RestClient\
+#   .new("127.0.0.1:5080/worklist", "alice", "alice")
+#client = OpenWFE::RestClient\
+#   .new("http://127.0.0.1:5080/worklist", "alice", "alice")
+#
+#puts "sessionId : #{client.sessionId}"
+#
+#puts client.get('getstorenames', nil, nil)
+#puts client.get('getheaders', 'Store.alpha', nil)
+

data/lib/ru/contextual.rb

@@ -0,0 +1,63 @@
+#
+# Copyright (c) 2006, 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.
+#
+# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+module OpenWFEru
+
+    module Contextual
+
+        attr_accessor :application_context
+
+        #
+        # Looks up something in the application context, if the given
+        # key is a class, then the first value in the context of that
+        # class is returned.
+        #
+        def lookup (key)
+            if key.kind_of? Class
+                @application_context.each do |k, value|
+                    return value if value.class == key
+                end
+                return nil
+            end
+            return @application_context[key]
+        end
+
+    end
+
+end

data/lib/ru/dollar.rb

@@ -0,0 +1,163 @@
+#
+# Copyright (c) 2006, 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.
+#
+# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+#require 'ru/flowexpression'
+
+#
+# 'dollar notation' implementation in Ruby
+#
+
+module OpenWFEru
+
+    def OpenWFEru.dsub (text, dict)
+
+        #puts "### text is >#{text}<"
+
+        j = text.index("}")
+
+        return text if not j
+
+        t = text[0, j]
+
+        i = t.rindex("${")
+        ii = t.rindex("\\${")
+
+        #puts "i  is #{i}"
+        #puts "ii is #{ii}"
+
+        return text if not i
+
+        return unescape(text) if (i) and (i != 0) and (ii == i-1)
+            #
+            # found "\${"
+
+        key = text[i+2..j-1]
+
+        #puts "### key is '#{key}'"
+
+        value = dict[key]
+
+        #puts "### value 0 is '#{value}'"
+
+        if value
+            value = value.to_s 
+        else
+            if dict.has_key? key
+                value = "false"
+            else
+                value = ""
+            end
+        end
+
+        #puts "### value 1 is '#{value}'"
+
+        #puts "pre is  >#{text[0..i-1]}<"
+        #puts "post is >#{text[j+1..-1]}<"
+
+        pre = ""
+        if i > 0 
+            pre = text[0..i-1]
+        end
+
+        return dsub("#{pre}#{value}#{text[j+1..-1]}", dict)
+    end
+
+    def OpenWFEru.unescape (text)
+        return text.gsub("\\\\\\$\\{", "\\${")
+    end
+
+    def OpenWFEru.dosub (text, flow_expression, workitem)
+        return dsub(text, FlowDict.new(flow_expression, workitem))
+    end
+
+    class FlowDict < Hash
+
+        def initialize (flow_expression, workitem)
+            @flow_expression = flow_expression
+            @workitem = workitem
+        end
+
+        def [] (key)
+            p, k = extract_prefix(key)
+
+            #puts "### p, k is '#{p}', '#{k}'"
+
+            return '' if k == ''
+
+            return @workitem.attributes[k] if p == 'f'
+            return @flow_expression.lookup_variable(k) if p == 'v'
+            return call_function(k) if p == 'c'
+            return call_ruby(k) if p == 'r'
+            # TODO : implement constant lookup
+
+            return @workitem.attributes[key]
+        end
+
+        def has_key? (key)
+            p, k = extract_prefix(key)
+
+            return false if k == ''
+
+            return @workitem.attributes.has_key?(k) if p == 'f'
+            return (@flow_expression.lookup_variable(k) != nil) if p == 'v'
+            return true if p == 'c'
+            return true if p == 'r'
+            # TODO : implement constant lookup
+
+            return @workitem.attributes.has_key?(key)
+        end
+
+        protected
+
+            def extract_prefix (key)
+                i = key.index(':')
+                return 'v', key if not i
+                return key[0..0], key[i+1..-1]
+            end
+
+            def call_function (function_name)
+            end
+
+            def call_ruby (ruby_code)
+                eval(ruby_code).to_s
+            end
+    end
+
+end
+

data/lib/ru/engine.rb

@@ -0,0 +1,130 @@
+#
+# Copyright (c) 2006, 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.
+#
+# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'rexml/document'
+
+require 'workitem'
+require 'ru/rudefinitions'
+require 'ru/service'
+require 'ru/expressionmap'
+require 'ru/expressionpool'
+require 'ru/expressionstorage'
+require 'ru/participantmap'
+require 'ru/schedulers'
+
+
+module OpenWFEru
+
+    class Engine < Service
+
+        #attr_accessor \
+        #    :application_context
+
+        def initialize()
+
+            super('engine', {})
+
+            @application_context[@service_name] = self
+
+            @application_context[S_EXPRESSION_MAP] = build_expression_map()
+            @application_context[S_EXPRESSION_POOL] = build_expression_pool()
+            @application_context[S_EXPRESSION_STORAGE] = build_expression_storage()
+            @application_context[S_PARTICIPANT_MAP] = build_participant_map()
+
+            @application_context[S_SCHEDULER] = \
+                SchedulerService.new(S_SCHEDULER, @application_context)
+
+            init_default_logging('engine.log')
+        end
+
+        def launch(object)
+
+            launchitem = nil
+
+            #ldebug { "launch() param is #{object.class}" }
+
+            if object.kind_of? OpenWFE::LaunchItem
+                launchitem = object
+            #elsif object.kind_of? REXML::Element
+                #nada
+            elsif object.kind_of? String
+                launchitem = OpenWFE::LaunchItem.new
+                if object[0] == '<'
+                    launchitem.workflowDefinitionUrl = "field:__definition"
+                    launchitem['definition'] = object
+                else
+                    launchitem.workflowDefinitionUrl = object
+                end
+            end
+
+            return @application_context[S_EXPRESSION_POOL].launch(launchitem)
+        end
+
+        #
+        # registers a participant in this [embedded] engine
+        #
+        def register_participant (regex, participant)
+
+            @application_context[S_PARTICIPANT_MAP]\
+                .register_participant(regex, participant)
+        end
+
+        protected
+
+            def build_expression_map ()
+                ExpressionMap.new(S_EXPRESSION_MAP, @application_context)
+            end
+
+            def build_expression_pool ()
+                ExpressionPool.new(S_EXPRESSION_POOL, @application_context)
+            end
+
+            def build_expression_storage ()
+                InMemoryExpressionStorage \
+                    .new(S_EXPRESSION_STORAGE, @application_context)
+            end
+
+            def build_participant_map ()
+                ParticipantMap.new(S_PARTICIPANT_MAP, @application_context)
+            end
+
+    end
+
+end
+