openwferu 0.9.1 → 0.9.2

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

@@ -1,6 +1,6 @@
 #
 #--
-# 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 
@@ -37,7 +37,7 @@
 # "made in Japan"
 #
 
-module OpenWFEru
+module OpenWFE
 
     #OPENWFE_VERSION = '1.7.2pre17'
     OPENWFE_VERSION = '0.9.2'
@@ -45,8 +45,9 @@ module OpenWFEru
     #
     # service names
 
-    S_LOGGER = 'logger'
+    S_LOGGER = :logger
 
+    S_ENGINE = 'engine'
     S_EXPRESSION_MAP = 'expressionMap'
     S_EXPRESSION_POOL = 'expressionPool'
     S_EXPRESSION_STORAGE = 'expressionStorage'
@@ -66,12 +67,39 @@ module OpenWFEru
     #
     # some expression attribute names
 
-    A_FORGET = 'forget'
+    #A_FORGET = 'forget'
+        # replaced by a symbol
 
     A_SYNC = 'sync'
     A_COUNT = 'count'
     A_REMAINING = 'remaining'
     REM_CANCEL = 'cancel'
+    
+    # 
+    # some file storage default values
+    DEFAULT_FILE_STORAGE_PATH = "./work"
+
+    #
+    # A mixin for easy OpenWFE service lookup
+    # (assumes the presence of an application context instance var)
+    #
+    module OwfeServiceLocator
+        def get_engine
+            return @application_context[S_ENGINE]
+        end
+        def get_expression_map
+            return @application_context[S_EXPRESSION_MAP]
+        end
+        def get_expression_pool
+            return @application_context[S_EXPRESSION_POOL]
+        end
+        def get_expression_storage
+            return @application_context[S_EXPRESSION_STORAGE]
+        end
+        def get_participant_map
+            return @application_context[S_PARTICIPANT_MAP]
+        end
+    end
 
 end
 

data/lib/{ru → openwfe}/service.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 $
 #
@@ -39,28 +39,40 @@
 # John Mettraux at openwfe.org
 #
 
-require 'ru/logging'
-require 'ru/contextual'
+require 'openwfe/logging'
+require 'openwfe/contextual'
 
 
-module OpenWFEru
+module OpenWFE
 
     module ServiceMixin
         include Contextual, Logging
 
         attr_accessor \
             :service_name
+
+        def service_init (service_name, application_context)
+
+            @service_name = service_name
+            @application_context = application_context
+        end
     end
 
     class Service
         include ServiceMixin
 
         def initialize (service_name, application_context)
-            @service_name = service_name
-            @application_context = application_context
+
+            service_init(service_name, application_context)
         end
 
     end
 
+    def register (service)
+
+        service.application_context[service.service_name] = service
+        return service
+    end
+
 end
 

data/lib/openwfe/storage/yamlfilestorage.rb

@@ -0,0 +1,159 @@
+#
+#--
+# Copyright (c) 2006-2007, Nicolas Modryzk and 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"
+#
+# Nicolas Modrzyk at openwfe.org
+# John Mettraux at openwfe.org
+#
+
+require 'yaml'
+require 'fileutils'
+
+require 'openwfe/utils'
+require 'openwfe/service'
+
+require 'openwfe/expressions/flowexpression'
+require 'openwfe/expressions/raw_xml'
+    #
+    # making sure classes in those files are loaded
+    # before their yaml persistence is tuned
+    # (else the reopening of the class is interpreted as
+    # a definition of the class...)
+
+
+module OpenWFE
+    
+    
+    #
+    # yaml expression storage
+    #
+    class YamlFileStorage  
+        include ServiceMixin
+        
+        attr_accessor :basepath
+        
+        def initialize (service_name, application_context, path)
+            service_init(service_name, application_context)
+            @basepath = path
+            FileUtils.makedirs @basepath 
+        end
+        
+        def []= (id, object)
+            
+            fei_path = compute_file_path(id)
+            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
+            end
+            
+            #
+            # deletes the whole storage directory... beware...
+            #
+            def purge
+                FileUtils.remove_dir @basepath
+            end 
+            
+            #
+            # check whether the key has a file  in the file storage
+            def has_key? (fei)
+                File.exist?(compute_file_path(fei))
+            end
+            
+            def remove (fei, workitem)
+                
+                fei_path = compute_file_path(fei)
+                
+                if File.exist?(fei_path)
+                    File.delete(fei_path)
+                else
+                    raise "Object not found at #{fei_path}"
+                end
+            end
+            
+            def [] (fei)
+                fei_path = compute_file_path(fei)
+                
+                return nil if not File.exist?(fei_path)
+                
+                data = IO.read(compute_file_path(fei))
+                object = YAML.load(data)
+                
+                object.application_context = @application_context
+                
+                return object
+            end
+            
+            def length
+                return count_expression(0, @basepath)
+            end
+            
+            protected 
+            
+            def count_expression (count, item)
+                
+                return count + 1 if OpenWFE::ends_with(item, ".yaml")
+                
+                if File.stat(item).directory?
+                    
+                    d = Dir.new(item)
+                    d.each do |i|
+                        next if i == "." or i == ".."
+                        i = item + "/" + i
+                        count = count_expression(count, i)
+                    end
+                    d.close()
+                end
+                
+                return count
+            end
+            
+            def compute_file_path (fei)
+                raise "this should be implemented in a subclass"
+            end
+            
+        end        
+        
+    end

data/lib/{ru → openwfe/util}/dollar.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 $
 #
@@ -45,9 +45,9 @@
 # 'dollar notation' implementation in Ruby
 #
 
-module OpenWFEru
+module OpenWFE
 
-    def OpenWFEru.dsub (text, dict)
+    def OpenWFE.dsub (text, dict)
 
         #puts "### text is >#{text}<"
 
@@ -100,11 +100,11 @@ module OpenWFEru
         return dsub("#{pre}#{value}#{text[j+1..-1]}", dict)
     end
 
-    def OpenWFEru.unescape (text)
+    def OpenWFE.unescape (text)
         return text.gsub("\\\\\\$\\{", "\\${")
     end
 
-    def OpenWFEru.dosub (text, flow_expression, workitem)
+    def OpenWFE.dosub (text, flow_expression, workitem)
         return dsub(text, FlowDict.new(flow_expression, workitem))
     end
 
@@ -154,10 +154,12 @@ module OpenWFEru
             end
 
             def call_function (function_name)
+                #"function '#{function_name}' is not implemented"
+                "functions are not yet implemented"
             end
 
             def call_ruby (ruby_code)
-                eval(ruby_code).to_s
+                eval(ruby_code, @flow_expression.get_binding).to_s
             end
     end
 

data/lib/openwfe/util/lru_cache.rb

@@ -0,0 +1,149 @@
+#
+#--
+# Copyright (c) 2006-2007, Nicolas Modryzk, 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"
+#
+# Nicolas Modrzyk at openwfe.org
+#
+
+module OpenWFE
+
+# Simple LRU cache based on 
+
+	class LRUCache
+
+		# initialize the LRU. 
+		# cache contains the mapping key,value
+		# queue contains the list of keys, according to the LRU
+		# max is the maximum number of items to keep in the cache
+		def initialize(max=20, maxttl=nil)
+			@cache = {}
+			@queue = []
+			@ttl_cache = {}
+			@max = max
+			@maxttl = maxttl
+			@finalizers = []
+		end
+
+		# Check to see if the cache contains the given key.
+		def include?(key)
+			@cache.include?(key)
+		end
+
+		# Return the element identified by the given key.
+		def [](key)
+			r = nil
+			if @cache.has_key? key
+				r = @cache[key]
+				@queue.push @queue.delete(key)
+				@ttl_cache[key] = Time.now.to_i
+			end
+			r
+		end
+
+		# Set the element of the cache identified by the given key.  
+		def []=(key, val)
+			if @queue.length == @max
+				d = @queue.shift
+				@cache.delete d
+			end
+			if @queue.first and @maxttl
+				now = Time.now.to_i
+				while ((@ttl_cache[@queue.first] + @maxttl) < now)
+					d = @queue.shift
+					do_finalization(d,@cache[d])
+					@cache.delete d
+				end
+			end
+			@cache[key] = val
+			@ttl_cache[key] = Time.now.to_i
+			@queue.push key
+		end
+		
+		# delete the key. 
+        # TODO: check this is working 
+		def delete(key)
+		    d = @queue.delete(key)
+		    do_finalization(d,@cache[d])
+		    @cache.delete key
+		end
+
+		# Allows one to set the maximum size of the cache queue.  If the queue
+		# is currently larger than the size that it is being set to, elements
+		# will be expired until the queue is at the maximum size.
+
+		def size=(max)
+			@max = max
+			while @queue.length > @max
+				d = @queue.shift
+				do_finalization(d,@cache[d])
+				@cache.delete d
+			end
+			@max
+		end
+		alias maxsize= size=
+
+		# Return the maximum size of the cache.
+		def maxsize
+			@max
+		end
+
+		# Return the current size of the cache.
+		def size
+			@queue.length
+		end
+
+		# Return a copy of current set of keys to cache elements.
+		def queue
+			@queue.dup
+		end
+		
+		def add_finalizer(*args,&block)
+			@finalizers.push [block,args]
+		end
+		
+		def do_finalization(key,obj)
+			begin
+			@finalizers.each do |f|
+				f[0].call(key,obj,*f[1])
+			end
+			rescue Exception => e
+				puts e, e.backtrace
+				raise e
+			end
+		end
+	end
+end