openwferu 0.9.0

data/lib/controlclient.rb

@@ -0,0 +1,115 @@
+#
+# 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: controlclient.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+#
+
+require 'definitions'
+require 'restclient'
+require 'codec'
+
+
+module OpenWFE
+
+
+    class ControlClient < RestClient
+
+        def initialize (server, port, username, password)
+
+            super('http://'+server+':'+port.to_s(), username, password)
+        end
+
+        def initialize (url, username, password)
+
+            super(url, username, password)
+        end
+
+        #
+        # Returns the list of controlable expressions
+        #
+        def listExpressions ()
+
+            r = self.get('listexpressions', nil, nil)
+            return decode(r)
+        end
+
+        #
+        # Cancels a given expression (and potentially its whole subtree)
+        #
+        def cancelExpression (flowExpressionId)
+
+            fei = OpenWFE.encode(flowExpressionId)
+
+            params = {}
+
+            return decode(self.post('cancelexpression', nil, params, fei))
+        end
+
+        #
+        # Freezes an expression (and potentially its whole subtree)
+        #
+        def freezeExpression (flowExpressionId)
+
+            fei = OpenWFE.encode(flowExpressionId)
+
+            params = {}
+
+            return decode(self.post('freezeexpression', nil, params, fei))
+        end
+
+        #
+        # Unfreezes an expression (and potentially its whole subtree)
+        #
+        def unfreezeExpression (flowExpressionId)
+
+            fei = OpenWFE.encode(flowExpressionId)
+
+            params = {}
+
+            return decode(self.post('unfreezeexpression', nil, params, fei))
+        end
+
+
+        protected
+
+            def decode (reply)
+
+                xml = REXML::Document.new(reply.body)
+                return OpenWFE.decode(xml.root)
+            end
+
+    end
+
+end
+

data/lib/definitions.rb

@@ -0,0 +1,112 @@
+#
+# 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: definitions.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+#
+
+module OpenWFE
+
+    NAME = 'name'
+    STORE = 'store'
+    STORES = 'stores'
+    WORKITEM_COUNT = 'workitem-count'
+    PERMISSIONS = 'permissions'
+    HEADER = 'header'
+    HEADERS = 'headers'
+    A_LAST_MODIFIED = 'last-modified'
+    A_LOCKED = 'locked'
+    FLOW_EXPRESSION_ID = 'flow-expression-id'
+    ATTRIBUTES = 'attributes'
+
+    OWFE_VERSION = 'owfe-version'
+    ENGINE_ID = 'engine-id'
+    INITIAL_ENGINE_ID = 'initial-engine-id'
+    WORKFLOW_DEFINITION_URL = 'workflow-definition-url'
+    WORKFLOW_DEFINITION_NAME = 'workflow-definition-name'
+    WORKFLOW_DEFINITION_REVISION = 'workflow-definition-revision'
+    WORKFLOW_INSTANCE_ID = 'workflow-instance-id'
+    EXPRESSION_NAME = 'expression-name'
+    EXPRESSION_ID = 'expression-id'
+
+    E_STRING = 'string'
+    E_INTEGER = 'integer'
+    E_BOOLEAN = 'boolean'
+    E_LONG = 'long'
+    E_DOUBLE = 'double'
+
+    E_XML = 'raw-xml'
+    E_BASE64 = 'base64'
+
+    E_LIST = 'list'
+    E_MAP = 'map'
+    E_SMAP = 'smap'
+
+    M_ENTRY = 'entry'
+    M_KEY = 'key'
+    M_VALUE = 'value'
+
+    MAP_TYPE = '___map_type'
+
+    FLOW_EXPRESSION_IDS = 'flow-expression-ids'
+
+    E_LAUNCHITEM = 'launchitem'
+    ENGINEID = "engineid"
+    OK = "ok"
+    A_FLOW_ID = "flow-id"
+
+    IN_FLOW_WORKITEM = 'workitem'
+    A_DISPATCH_TIME = 'dispatch-time'
+    A_PARTICIPANT_NAME = 'participant-name'
+    E_LAST_EXPRESSION_ID = 'last-expression-id'
+
+    LAUNCHABLES = 'launchables'
+    LAUNCHABLE = 'launchable'
+    URL = 'url'
+
+    TARGETSTORE = 'targetstore'
+
+    EXPRESSIONS = 'expressions'
+    EXPRESSION = 'expression'
+    APPLY_TIME = 'apply-time'
+    STATE = 'state'
+    STATE_SINCE = 'state-since'
+
+    HISTORY = 'history'
+    HISTORY_ITEM = 'history-item'
+    A_AUTHOR = 'author'
+    A_DATE = 'date'
+    A_HOST = 'host'
+
+end
+

data/lib/exception.rb

@@ -0,0 +1,60 @@
+#
+# 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: exception.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+#
+# john.mettraux@openwfe.org
+#
+
+
+module OpenWFE
+
+    #
+    # EXCEPTION(S)
+    #
+
+    class OwfeException < RuntimeError
+
+        def initialize ()
+            super.initialize()
+        end
+
+        def initialize (message)
+            super.initialize(message)
+        end
+
+    end
+
+end
+

data/lib/flowexpressionid.rb

@@ -0,0 +1,137 @@
+#
+# 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: workitem.rb 3555 2006-11-13 00:47:53Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+# enhanced in Japan
+#
+# john.mettraux@openwfe.org
+#
+
+require 'base64'
+
+require 'definitions'
+
+
+module OpenWFE
+
+    #
+    # FlowExpressionId
+    #
+    class FlowExpressionId
+
+        attr_accessor \
+            :owfeVersion, \
+            :engineId, \
+            :initialEngineId, \
+            :workflowDefinitionUrl, \
+            :workflowDefinitionName, \
+            :workflowDefinitionRevision, \
+            :workflowInstanceId, \
+            :expressionName, \
+            :expressionId
+
+        #
+        # overrides the classical to_s()
+        #
+        def to_s ()
+            return "(fei #{@owfeVersion} #{@engineId}/#{@initialEngineId} #{@workflowDefinitionUrl} #{@workflowDefinitionName} #{@workflowDefinitionRevision} #{@workflowInstanceId} #{@expressionName} #{@expressionId} )"
+        end
+
+        #
+        # This class method parses a string into a FlowExpressionId instance
+        #
+        def FlowExpressionId.strToFei (string)
+
+            fei = FlowExpressionId.new()
+
+            ss = string.split(" ")
+
+            fei.owfeVersion = ss[2]
+
+            ssRawEngineId = ss[3].split("/")
+            fei.engineId= ssRawEngineId[0]
+            fei.initialEngineId= ssRawEngineId[1]
+
+            fei.workflowDefinitionUrl = ss[4]
+            fei.workflowDefinitionName = ss[5]
+            fei.workflowDefinitionRevision = ss[6]
+            fei.workflowInstanceId = ss[7]
+            fei.expressionName = ss[8]
+            fei.expressionId = ss[9]
+
+            return fei
+        end
+
+        def hash ()
+            return to_s().hash()
+        end
+
+        def == (other)
+            return false if not other.kind_of?(FlowExpressionId)
+
+            @owfeVersion == other.owfeVersion and 
+            @engineId == other.engineId and 
+            @initialEngineId == other.initialEngineId and
+            @workflowDefinitionUrl == other.workflowDefinitionUrl and
+            @workflowDefinitionName == other.workflowDefinitionName and
+            @workflowDefinitionRevision == other.workflowDefinitionRevision and
+            @workflowInstanceId == other.workflowInstanceId and
+            @expressionName == other.expressionName and
+            @expressionId == other.expressionId
+        end
+
+        def dup
+            n = FlowExpressionId.new
+            n.owfeVersion = @owfeVersion.dup
+            n.engineId = @engineId.dup
+            n.initialEngineId = @initialEngineId.dup
+            n.workflowDefinitionUrl = @workflowDefinitionUrl.dup
+            n.workflowDefinitionName = @workflowDefinitionName.dup
+            n.workflowDefinitionRevision = @workflowDefinitionRevision.dup
+            n.workflowInstanceId = @workflowInstanceId.dup
+            n.expressionName = @expressionName.dup
+            n.expressionId = @expressionId.dup
+            return n
+        end
+
+        alias eql? ==
+
+        #alias to_debug_s to_s
+        def to_debug_s
+            "#{to_s}  (h#{hash}) (i#{object_id})"
+        end
+    end
+
+end
+

data/lib/openwferu.rb

@@ -0,0 +1,43 @@
+#
+# 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.
+#
+#++
+#
+# = openwferu -- Open Workflow Engine in Ruby
+#
+# This is the main file for the openwferu engine.  It is normally
+# referenced as a library via a require statement.
+#
+
+require 'workitem'
+require 'ru/engine'
+require 'ru/rudefinitions'
+require 'ru/participants'
+

data/lib/osocket.rb

@@ -0,0 +1,138 @@
+#
+# 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: codec.rb 2515 2006-04-26 18:38:39Z jmettraux $
+#
+
+require 'socket'
+require 'codec'
+
+module OpenWFE
+
+    class SocketListener < TCPServer
+
+        #
+        # starts to listen on a given interface (IP) and port
+        #
+        def initialize (iface, port)
+            super(iface, port)
+        end
+
+        def listen ()
+            while (session = accept())
+                s = session.gets
+
+                if s[0..8] != 'xmlCoder '
+                    session.close
+                    break
+                end
+
+                l = s[9..-1].to_i
+
+                s = session.gets
+                    #
+                    # skipping the empty line between the
+                    # header and the actual workitem
+
+                sXml = ''
+
+                while sXml.length < l
+                    s = session.gets
+                    sXml = "#{sXml}#{s}"
+                end
+
+                session.print "<ok-reply/>"
+                session.close
+
+                #yield sXml
+
+                xml = REXML::Document.new(sXml)
+                yield OpenWFE.decode(xml.root)
+            end
+        end
+    end
+
+    #
+    # dispatches a workitem over TCP
+    #
+    def OpenWFE.dispatchWorkitem (host, port, workitem)
+
+        sXml = OpenWFE.encode(workitem)
+        socket = TCPSocket.new(host, port)
+        socket.puts "xmlCoder #{sXml.length}"
+        socket.puts
+        socket.puts sXml
+        socket.puts
+
+        reply = socket.gets
+        reply = reply + socket.gets
+            #
+            # a bit ridiculous, but it works
+
+        socket.close
+
+        #puts "dispatch() reply is >#{reply}<"
+    end
+
+    class OwfeHook
+    end
+
+end
+
+
+#
+# some test code
+
+sl = OpenWFE::SocketListener.new('127.0.0.1', 7010)
+
+puts "..ready.."
+
+sl.listen do |workitem|
+
+    #puts workitem
+    #next
+
+    puts workitem.flowExpressionId
+    puts "...history length : #{workitem.history.length}"
+
+    #puts workitem.history
+    workitem.history.each do |hi|
+        puts ".....hi = '#{hi.text}' #{hi.date}"
+    end
+
+    #hi = OpenWFE::HistoryItem.new
+    #hi.author = 'osocket.rb'
+    #workitem.history.push(hi)
+
+    workitem.attributes['ruby?'] = 'yes'
+
+    OpenWFE.dispatchWorkitem('127.0.0.1', 7007, workitem)
+end
+