openwferu 0.9.1 → 0.9.2

data/lib/openwfe/flowexpressionid.rb

@@ -0,0 +1,148 @@
+#
+#--
+# Copyright (c) 2005-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: workitem.rb 3555 2006-11-13 00:47:53Z jmettraux $
+#
+
+#
+# "hecho en Costa Rica"
+# enhanced in Japan
+#
+# john.mettraux@openwfe.org
+#
+
+
+module OpenWFE
+
+    #
+    # FlowExpressionId
+    #
+    class FlowExpressionId
+
+        attr_accessor \
+            :owfe_version, \
+            :engine_id, \
+            :initial_engine_id, \
+            :workflow_definition_url, \
+            :workflow_definition_name, \
+            :workflow_definition_revision, \
+            :workflow_instance_id, \
+            :expression_name, \
+            :expression_id
+
+        #
+        # overrides the classical to_s()
+        #
+        def to_s ()
+            return "(fei #{@owfe_version} #{@engine_id}/#{@initial_engine_id} #{@workflow_definition_url} #{@workflow_definition_name} #{@workflow_definition_revision} #{@workflow_instance_id} #{@expression_name} #{@expression_id})"
+        end
+
+        def hash ()
+            return to_s().hash()
+        end
+
+        def == (other)
+            return false if not other.kind_of?(FlowExpressionId)
+
+            @owfe_version == other.owfe_version and 
+            @engine_id == other.engine_id and 
+            @initial_engine_id == other.initial_engine_id and
+            @workflow_definition_url == other.workflow_definition_url and
+            @workflow_definition_name == other.workflow_definition_name and
+            @workflow_definition_revision == other.workflow_definition_revision and
+            @workflow_instance_id == other.workflow_instance_id and
+            @expression_name == other.expression_name and
+            @expression_id == other.expression_id
+        end
+
+        def dup
+            n = FlowExpressionId.new
+            n.owfe_version = @owfe_version.dup
+            n.engine_id = @engine_id.dup
+            n.initial_engine_id = @initial_engine_id.dup
+            n.workflow_definition_url = @workflow_definition_url.dup
+            n.workflow_definition_name = @workflow_definition_name.dup
+            n.workflow_definition_revision = @workflow_definition_revision.dup
+            n.workflow_instance_id = @workflow_instance_id.dup
+            n.expression_name = @expression_name.dup
+            n.expression_id = @expression_id.dup
+            return n
+        end
+
+        alias eql? ==
+
+        alias to_debug_s to_s
+        #def to_debug_s
+        #    "#{to_s}  (h#{hash}) (i#{object_id})"
+        #end
+
+        #
+        # Returns the workflow instance id without any subflow indices.
+        # For example, if the wfid is "1234.0.1", this method will
+        # return "1234".
+        #
+        def parent_workflow_instance_id
+            i = workflow_instance_id.index(".")
+            return workflow_instance_id if not i
+            #return workflow_instance_id[0..i]
+            return workflow_instance_id[0..i-1]
+        end
+
+        #
+        # This class method parses a string into a FlowExpressionId instance
+        #
+        def FlowExpressionId.to_fei (string)
+
+            fei = FlowExpressionId.new()
+
+            ss = string.split(" ")
+            #puts "\n#{ss}"
+
+            fei.owfe_version = ss[1]
+
+            ssRawEngineId = ss[2].split("/")
+            fei.engine_id= ssRawEngineId[0]
+            fei.initial_engine_id= ssRawEngineId[1]
+
+            fei.workflow_definition_url = ss[3]
+            fei.workflow_definition_name = ss[4]
+            fei.workflow_definition_revision = ss[5]
+            fei.workflow_instance_id = ss[6]
+            fei.expression_name = ss[7]
+            fei.expression_id = ss[8][0..-2]
+
+            return fei
+        end
+    end
+
+end
+

data/lib/{ru → openwfe}/logging.rb

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
 #
@@ -40,10 +40,14 @@
 #
 
 require 'logger'
-require 'ru/rudefinitions'
+require 'openwfe/rudefinitions'
 
-module OpenWFEru
 
+module OpenWFE
+
+    #
+    # A Mixin for adding logging method to any class
+    #
     module Logging
 
         def init_default_logging (filename)
@@ -74,7 +78,7 @@ module OpenWFEru
             end
 
             def who
-                if respond_to?(:service_name)
+                if respond_to? :service_name
                     "#{self.class} '#{self.service_name}'"
                 else
                     "#{self.class}"

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

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,13 +28,14 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: codec.rb 2515 2006-04-26 18:38:39Z jmettraux $
 #
 
 require 'socket'
-require 'codec'
+require 'xmlcodec'
+
 
 module OpenWFE
 
@@ -82,11 +83,14 @@ module OpenWFE
     end
 
     #
-    # dispatches a workitem over TCP
+    # Dispatches a workitem over TCP, the workitem will be
+    # encoded with XML
+    # The default encode_method is
     #
-    def OpenWFE.dispatchWorkitem (host, port, workitem)
+    def OpenWFE.dispatch_workitem (host, port, workitem)
+
+        sXml = OpenWFE.xml_encode(workitem)
 
-        sXml = OpenWFE.encode(workitem)
         socket = TCPSocket.new(host, port)
         socket.puts "xmlCoder #{sXml.length}"
         socket.puts
@@ -103,38 +107,35 @@ module OpenWFE
         #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
+#sl = OpenWFE::SocketListener.new('127.0.0.1', 7010)
+#
+#puts "..ready.."
+#
+#sl.listen do |workitem|
+#
+#    #puts workitem
+#    #next
+#
+#    puts workitem.flow_expression_id
+#    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.dispatch_workitem('127.0.0.1', 7007, workitem)
+#end
 

data/lib/{otime.rb → openwfe/otime.rb}

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: otime.rb 3509 2006-10-21 12:00:52Z jmettraux $
 #
@@ -39,12 +39,13 @@
 # john.mettraux@openwfe.org
 #
 
-require 'parsedate'
+require 'date'
+#require 'parsedate'
 
 
 module OpenWFE
 
-    TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
+    #TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
 
     #
     # Returns the current time as an ISO date string
@@ -53,35 +54,42 @@ module OpenWFE
         return to_iso_date(Time.new())
     end
 
-    def OpenWFE.to_iso_date (date)
+    def OpenWFE.to_iso8601_date (date)
 
-        if date.kind_of?(Float)
-            date = Time.at(date)
+        if date.kind_of? Float 
+            date = to_datetime(Time.at(date))
+        elsif date.kind_of? Time
+            date = to_datetime(date)
+        elsif not date.kind_of? Date
+            date = DateTime.parse(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()
+        s = date.to_s
+        s[10] = " "
+
+        return s
     end
 
     #
-    # Returns a Ruby time
+    # the old method we used to generate our ISO datetime strings
     #
-    def OpenWFE.toRubyTime (isoDate)
+    def OpenWFE.time_to_iso8601_date (time)
+
+        s = time.getutc().strftime(TIME_FORMAT)
+        o = time.utc_offset / 3600
+        o = o.to_s + "00"
+        o = "0" + o if o.length < 4
+        o = "+" + o unless o[0..1] == '-'
 
-        res = ParseDate.parsedate(isoDate)
-        return Time.local(*res)
+        s + " " + o.to_s
     end
 
     #
-    # An Ruby-friendly alias for toRubyTime()
+    # Returns a Ruby time
     #
     def OpenWFE.to_ruby_time (iso_date)
 
-        return toRubyTime(iso_date)
+        return DateTime.parse(iso_date)
     end
 
     #def OpenWFE.parse_date (date)
@@ -91,6 +99,7 @@ module OpenWFE
     # equivalent to java.lang.System.currentTimeMillis()
     #
     def OpenWFE.current_time_millis ()
+
         t = Time.new()
         t = t.to_f * 1000
         return t.to_i
@@ -122,7 +131,7 @@ module OpenWFE
 
             if index >= string.length
                 if number.length > 0
-                    result = result + (Integer(number) / 1000)
+                    result = result + (Float(number) / 1000.0)
                 end
                 break
             end
@@ -157,6 +166,47 @@ module OpenWFE
         return (c >= "0" and c <= "9")
     end
 
+    #
+    # conversion methods between Date[Time] and Time
+
+    #
+    # Ruby Cookbook 1st edition p.111
+    # http://www.oreilly.com/catalog/rubyckbk/
+    # a must
+    #
+
+    #
+    # converts a Time instance to a DateTime one
+    #
+    def OpenWFE.to_datetime (time)
+
+        s = time.sec + Rational(time.usec, 10**6)
+        o = Rational(time.utc_offset, 3600 * 24)
+
+        begin
+            return DateTime.new(
+                time.year, time.month, time.day, time.hour, time.min, s, o)
+        rescue Exception => e
+            puts \
+                "\n Date.new() problem. Params :"+
+                "\n....y:#{time.year} M:#{time.month} d:#{time.day} "+
+                "h:#{time.hour} m:#{time.min} s:#{s} o:#{o}"
+        end
+    end
+
+    def OpenWFE.to_gm_time (dtime)
+        to_ttime(dtime.new_offset, :gm)
+    end
+
+    def OpenWFE.to_local_time (dtime)
+        to_ttime(dtime.new_offset(DateTime.now.offset-offset), :local)
+    end
+
+    def to_ttime (d, method)
+        usec = (d.sec_fraction * 3600 * 24 * (10**6)).to_i
+        Time.send(method, d.year, d.month, d.day, d.hour, d.min, d.sec, usec)
+    end
+
     protected
 
         DURATIONS = {