openwferu 0.9.5 → 0.9.6

data/lib/openwfe/participants/sqsparticipants.rb

@@ -0,0 +1,121 @@
+#
+#--
+# Copyright (c) 2007, 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 'yaml'
+require 'base64'
+
+#require 'openwfe/utils'
+#require 'openwfe/rudefinitions'
+require 'openwfe/participants/participant'
+
+
+module OpenWFE
+
+    #
+    # This participant dispatches its workitem to an Amazon SQS queue.
+    #
+    # If the queue doesn't exist, the participant will create it.
+    #
+    # a small example :
+    #
+    #     # ...
+    #     engine.register_participant(:sqs0, SqsParticipant.new("workqueue0"))
+    #     # ...
+    #
+    # For more details about SQS :
+    # http://aws.amazon.com
+    #
+    class SqsParticipant 
+        include LocalParticipant
+
+        attr_reader :queue, :queue_service
+
+        #
+        # Builds an SqsParticipant instance pointing to a given queue.
+        # (Refer to the SQS service on how to set up AWS key ids).
+        #
+        # By default the host_name is 'queue.amazonaws.com'
+        #
+        def initialize (queue_name, host_name=nil)
+
+            @queue_name = queue_name
+
+            @queue_service = SQS::QueueService.new(host_name)
+
+            @queue_service.create_queue(@queue_name)
+                # make sure the queue exists
+
+            @queue = @queue_service.get_queue(@queue_name)
+        end
+
+        #
+        # The method called by the engine when it has a workitem for this
+        # participant.
+        #
+        def consume (workitem)
+
+            msg = encode_workitem(workitem)
+
+            msg_id = @queue_service.put_message(@queue, msg)
+
+            ldebug do 
+                "consume() msg sent to queue #{@queue.path} id is #{msg_id}"
+            end
+        end
+
+        protected
+
+            #
+            # Turns the workitem into a Hash, pass it through YAML and
+            # encode64 the result.
+            #
+            # Override this method as needed.
+            #
+            # Something of 'text/plain' flavour should be returned.
+            #
+            def encode_workitem (wi)
+
+                msg = wi.to_h
+                msg = YAML.dump(msg)
+                msg = Base64.encode64(msg)
+                msg
+            end
+    end
+end

data/lib/openwfe/rest/definitions.rb

@@ -82,7 +82,7 @@ module OpenWFE
 
     FLOW_EXPRESSION_IDS = 'flow-expression-ids'
 
-    E_LAUNCHITEM = 'launchitem'
+    LAUNCHITEM = 'launchitem'
     ENGINEID = "engineid"
     OK = "ok"
     A_FLOW_ID = "flow-id"

data/lib/openwfe/{osocket.rb → rest/osocket.rb}

@@ -34,12 +34,17 @@
 #
 
 require 'socket'
-require 'xmlcodec'
+
+require 'openwfe/rest/xmlcodec'
 
 
 module OpenWFE
 
-    class SocketListener < TCPServer
+    #
+    # This code was blogged about at
+    # http://jmettraux.wordpress.com/2006/06/01/openwfe-ruby/
+    #
+    class OldSocketListener < TCPServer
 
         #
         # starts to listen on a given interface (IP) and port
@@ -50,6 +55,9 @@ module OpenWFE
 
         def listen ()
             while (session = accept())
+                #
+                # how does it scale ?
+
                 s = session.gets
 
                 if s[0..8] != 'xmlCoder '
@@ -74,10 +82,7 @@ module OpenWFE
                 session.print "<ok-reply/>"
                 session.close
 
-                #yield sXml
-
-                xml = REXML::Document.new(sXml)
-                yield OpenWFE.decode(xml.root)
+                yield OpenWFE.xml_decode(xml.root)
             end
         end
     end
@@ -96,11 +101,14 @@ module OpenWFE
         socket.puts
         socket.puts sXml
         socket.puts
+        socket.close_write
 
         reply = socket.gets
-        reply = reply + socket.gets
+
+        #reply = reply + socket.gets
             #
             # a bit ridiculous, but it works
+            # socket.close_write fixed it
 
         socket.close
 
@@ -113,7 +121,7 @@ end
 #
 # some test code
 
-#sl = OpenWFE::SocketListener.new('127.0.0.1', 7010)
+#sl = OpenWFE::OldSocketListener.new('127.0.0.1', 7010)
 #
 #puts "..ready.."
 #

data/lib/openwfe/rest/xmlcodec.rb

@@ -37,7 +37,6 @@
 # "hecho en Costa Rica"
 #
 
-#require 'base64'
 require 'rexml/document'
 
 require 'openwfe/utils'
@@ -48,6 +47,9 @@ require 'openwfe/rest/definitions'
 
 module OpenWFE
 
+    #
+    # Ugly XML codec for OpenWFE workitems
+    #
     class XmlCodec
 
         #
@@ -56,7 +58,13 @@ module OpenWFE
         #
         def decode (xmlElt)
 
-            return nil if not xmlElt
+            return nil unless xmlElt
+
+            if xmlElt.kind_of? String
+
+                xmlElt = REXML::Document.new(xmlElt)
+                xmlElt = xmlElt.root
+            end
 
             #puts "decode() xmlElt.name is >#{xmlElt.name}<"
 
@@ -77,6 +85,8 @@ module OpenWFE
 
             return decode_inflowworkitem(xmlElt) \
                 if xmlElt.name == IN_FLOW_WORKITEM
+            return decode_launchitem(xmlElt) \
+                if xmlElt.name == LAUNCHITEM
 
             return decode_list(xmlElt) if xmlElt.name == LAUNCHABLES
             return decode_launchable(xmlElt) if xmlElt.name == LAUNCHABLE
@@ -240,12 +250,12 @@ module OpenWFE
                     return map
                 end
 
-                #puts xmldoc_to_string(xmlElt.document())
+                #puts OpenWFE.xmldoc_to_string(xmlElt.document())
 
                 raise \
                     ArgumentError, \
                     "Cannot decode <#{xmlElt.name}/> in \n"+\
-                    xmldoc_to_string(xmlElt.document())
+                    OpenWFE.xmldoc_to_string(xmlElt.document())
             end
 
             def decode_entry (xmlElt, map)
@@ -323,6 +333,20 @@ module OpenWFE
             end
 
 
+            def decode_launchitem (xmlElt)
+
+                li = LaunchItem.new()
+
+                li.workflow_definition_url = 
+                    xmlElt.attributes[WORKFLOW_DEFINITION_URL]
+
+                li.attributes = 
+                    decode(OpenWFE.first_element(xmlElt, ATTRIBUTES))
+
+                li
+            end
+
+
             #
             # ENCODE
             #
@@ -344,7 +368,7 @@ module OpenWFE
 
                 doc = REXML::Document.new()
 
-                root = REXML::Element.new(E_LAUNCHITEM)
+                root = REXML::Element.new(LAUNCHITEM)
 
                 encode_item(launchitem, root)
 
@@ -550,15 +574,27 @@ module OpenWFE
     end
 
     XMLCODEC = XmlCodec.new
+        #
+        # some kind of a singleton, rather a lonelyton
 
+    #
+    # Decodes any XML blurb produced by OpenWFE[ja] into a Ruby instance.
+    #
     def OpenWFE.xml_decode (xmlelt)
         XMLCODEC.decode(xmlelt)
     end
 
+    #
+    # Encodes to XML (OpenWFE dialect ;) ) workitems and launch items.
+    #
     def OpenWFE.xml_encode (owfedata)
         XMLCODEC.encode(owfedata)
     end
 
+    #
+    # Just turns some XML to a String (if decl is set to false, no 
+    # XML declaration will be printed).
+    #
     def OpenWFE.xmldoc_to_string (xml, decl=true)
 
         s = ""

data/lib/openwfe/storage/yamlfilestorage.rb

@@ -86,20 +86,17 @@ module OpenWFE
         #
         def []= (fei, object)
             synchronize do
+
                 fei_path = compute_file_path(fei)
 
                 fei_parent_path = File.dirname(fei_path)
                 
                 FileUtils.makedirs(fei_parent_path) \
-                    if not File.exist?(fei_parent_path)
-                    
-                fd = IO.sysopen(fei_path , "w+")
-                io = IO.open(fd , "w+")
-                
-                data = YAML.dump(object)
-                
-                io.write(data)
-                io.close
+                    unless File.exist?(fei_parent_path)
+
+                File.open(fei_path, "w") do |file|
+                    YAML.dump(object, file)
+                end
             end
         end
             
@@ -164,13 +161,14 @@ module OpenWFE
 
             def load_object (path)
 
-                data = IO.read(path)
-                object = YAML.load(data)
+                #data = IO.read(path)
+                #object = YAML.load(data)
+                object = YAML.load_file(path)
                 
                 object.application_context = @application_context \
                     if object.respond_to? :application_context=
                 
-                return object
+                object
             end
             
             def count_objects
@@ -201,7 +199,6 @@ module OpenWFE
             # Passes each object to the given block
             #
             def each_object (&block)
-                return unless block
                 each_object_path do |path|
                     block.call load_object(path)
                 end

data/lib/openwfe/util/dollar.rb

@@ -39,7 +39,8 @@
 # John Mettraux at openwfe.org
 #
 
-#require 'ru/flowexpression'
+require 'openwfe/utils'
+require 'openwfe/util/safe'
 
 #
 # 'dollar notation' implementation in Ruby
@@ -47,6 +48,16 @@
 
 module OpenWFE
 
+    SAFETY_LEVEL = 3
+        #
+        # Ruby code ${ruby:...} will be evaluated with this
+        # safety level.
+        # (see http://www.rubycentral.com/book/taint.html )
+
+    #
+    # Performs 'dollar substitution' on a piece of text with a given 
+    # dictionary.
+    #
     def OpenWFE.dsub (text, dict)
 
         #puts "### text is >#{text}<"
@@ -107,6 +118,10 @@ module OpenWFE
         return text.gsub("\\\\\\$\\{", "\\${")
     end
 
+    #
+    # Performs 'dollar substitution' on a piece of text with as input
+    # a flow expression and a workitem (fields and variables).
+    #
     def OpenWFE.dosub (text, flow_expression, workitem)
         return dsub(text, FlowDict.new(flow_expression, workitem))
     end
@@ -179,6 +194,11 @@ module OpenWFE
 
                 wi = @workitem
                 workitem = @workitem
+
+                fexp = nil
+                flow_expression = nil
+                fei = nil
+
                 if @flow_expression
                     fexp = @flow_expression
                     flow_expression = @flow_expression
@@ -189,7 +209,8 @@ module OpenWFE
                     # notations
 
                 #eval(ruby_code, binding).to_s
-                eval(ruby_code).to_s
+                #eval(ruby_code).to_s
+                OpenWFE::eval_safely(ruby_code, SAFETY_LEVEL, binding()).to_s
             end
     end
 

data/lib/openwfe/util/otime.rb

@@ -51,7 +51,7 @@ module OpenWFE
     # Returns the current time as an ISO date string
     #
     def OpenWFE.now ()
-        return to_iso_date(Time.new())
+        return to_iso8601_date(Time.new())
     end
 
     def OpenWFE.to_iso8601_date (date)

data/lib/openwfe/util/safe.rb

@@ -0,0 +1,149 @@
+#
+#--
+# Copyright (c) 2007, 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: utils.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# john.mettraux@openwfe.org
+#
+
+require 'tmpdir'
+require 'open-uri'
+
+
+module OpenWFE
+
+    #
+    # Runs some remote code (uri) at a different $SAFE level.
+    #
+    def OpenWFE.load_safely (uri, safe_level)
+
+        source = ""
+
+        source << "#\n"
+        source << "# loaded from #{uri}\n"
+        source << "#\n"
+
+        source << open(uri).read
+
+        load_eval_safely(source, safe_level)
+    end
+
+    #
+    # Makes sure that a piece of Ruby code is run at certain safe level.
+    # Saves in a temp file that is reloaded in its own anonymous namespace.
+    #
+    # (no binding passing allowed like in the basic Kernel.eval() method).
+    #
+    def OpenWFE.load_eval_safely (code, safe_level)
+
+        tmpfname = 
+            "#{Dir.tmpdir}/"+
+            "owfe_#{code.object_id}_#{Time.new.to_f}.tmp.rb"
+
+        File.open tmpfname, "w" do |file|
+            file.print code
+        end
+
+        Thread.new do
+            $SAFE = safe_level
+            load(tmpfname, true)
+        end.join
+
+        begin
+            File.delete tmpfname
+        rescue Excpetion => e
+            # ignore
+        end
+    end
+
+    #
+    # Runs some code within an instance's realm at a certain safety level.
+    #
+    def OpenWFE.instance_eval_safely (instance, code, safe_level)
+
+        r = nil
+
+        Thread.new do
+            $SAFE = safe_level
+            r = instance.instance_eval(code)
+        end.join
+
+        r
+    end
+
+    #
+    # Runs an eval() call at a certain safety level.
+    #
+    def OpenWFE.eval_safely (code, safe_level, binding=nil)
+
+        code.untaint
+
+        r = nil
+
+        Thread.new do
+            $SAFE = safe_level
+            r = eval(code, binding)
+        end.join
+
+        r
+    end
+
+    #
+    # - not used currently -
+    #
+    # evals "requires" at the current safe level and the rest of the code
+    # at the requested safety level.
+    #
+    def OpenWFE.eval_r_safely (code, safe_level, binding=nil)
+
+        code.untaint
+
+        c = ""
+
+        code.split("\n").each do |line|
+            if line.match "^ *require " and not line.index(";")
+                eval(line, binding)
+            else
+                c << line
+                c << "\n"
+            end
+        end
+
+        eval_safely(c, safe_level, binding)
+    end
+    
+end
+