sbsm 1.0.0

data/lib/sbsm/state.rb

@@ -0,0 +1,301 @@
+#!/usr/bin/env ruby
+#
+# State Based Session Management
+#	Copyright (C) 2004 Hannes Wyss
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#	ywesee - intellectual capital connected, Winterthurerstrasse 52, CH-8006 Z�rich, Switzerland
+#	hwyss@ywesee.com
+#
+# State -- sbsm -- 22.10.2002 -- hwyss@ywesee.com
+
+module SBSM
+	class ProcessingError < RuntimeError
+		attr_reader :key, :value
+		def initialize(message,	key, value)
+			super(message)
+			@key = key
+			@value = value
+		end
+	end
+	class Warning
+		attr_reader :key, :value, :message
+		def initialize(message, key, value)
+			@message = message
+			@key = key
+			@value = value
+		end
+	end
+	class State
+		attr_reader :errors, :infos, :events, :previous, :warnings, :model
+		attr_accessor :next, :request_path, :redirected
+		DIRECT_EVENT = nil
+		ZONE = nil
+		ZONES = []
+		ZONE_EVENT = nil
+		EVENT_MAP = {}
+		GLOBAL_MAP = {}
+		REVERSE_MAP = {}
+		VIEW = nil
+		VOLATILE = false
+		def State::direct_event
+			self::DIRECT_EVENT
+		end
+		def State::zone
+			self::ZONE
+		end
+		def State::zones
+			self::ZONES
+		end
+		def initialize(session, model)
+			@session = session
+			@model = model
+			@events = self::class::GLOBAL_MAP.dup.update(self::class::EVENT_MAP.dup)
+			@default_view = self::class::VIEW
+			@errors = {}
+			@infos = []
+			@warnings = []
+      @viral_modules = []
+			touch()
+		end
+    def init
+    end
+		def add_warning(message, key, value)
+			if(key.is_a? String)
+				key = key.intern
+			end
+			warning = Warning.new(message, key, value)
+			@warnings.push(warning)
+		end
+		def back
+			@previous
+		end
+		def __checkout
+			return if(@checked_out)
+			@checked_out = true
+			@model = nil
+			if(@next.respond_to?(:unset_previous))
+				@next.unset_previous
+			end
+			@next = nil
+			if(@previous.respond_to?(:__checkout))
+				@previous.__checkout
+			end
+			@previous = nil
+		end
+		def create_error(msg, key, val)
+			ProcessingError.new(msg.to_s, key, val)
+		end
+		def default
+			self
+		end
+		def direct_event
+			self::class::DIRECT_EVENT
+		end
+		def error?
+			!@errors.empty?
+		end
+		def error(key)
+			@errors[key]
+		end
+		def error_check_and_store(key, value, mandatory=[])
+			if(value.is_a? RuntimeError)
+				@errors.store(key, value)
+			elsif(mandatory.include?(key) && mandatory_violation(value))
+				error = create_error('e_missing_' << key.to_s, key, value)
+				@errors.store(key, error)
+			end
+		end
+    if RUBY_VERSION >= '1.9'
+      def extend(mod)
+        if(mod.constants.include?(:VIRAL))
+          @viral_modules.push(mod)
+        end
+        if(mod.constants.include?(:EVENT_MAP))
+          @events.update(mod::EVENT_MAP)
+        end
+        super
+      end
+    else
+      def extend(mod)
+        if(mod.constants.include?('VIRAL'))
+          @viral_modules.push(mod)
+        end
+        if(mod.constants.include?('EVENT_MAP'))
+          @events.update(mod::EVENT_MAP)
+        end
+        super
+      end
+    end
+		def http_headers
+			@http_headers || view.http_headers
+		end
+		def info?
+			!@infos.empty?
+		end
+		def info(key)
+			@infos[key]
+		end
+		def mandatory_violation(value)
+			value.nil? || (value.respond_to?(:empty?) && value.empty?)
+		end
+		def previous=(state)
+			if(@previous.nil? && state.respond_to?(:next=))
+				state.next = self
+				@previous = state
+        while state
+          if state.previous == self
+            state.unset_previous
+          end
+          state = state.previous
+        end
+        @previous
+			end
+		end
+		def sort
+			return self unless @model.respond_to?(:sort!)
+			get_sortby!
+			@model.sort! { |a, b| compare_entries(a, b) }
+			@model.reverse! if(@sort_reverse)
+			self
+		end
+		def touch
+			@mtime = Time.now
+		end
+		def to_html(context)
+			view.to_html(context)
+		end
+		def trigger(event)
+      if(@redirected)
+        @redirected = false
+      else
+        @errors = {}
+        @infos = []
+        @warnings = []
+      end
+			state = if(event && !event.to_s.empty? && self.respond_to?(event))
+				_trigger(event)
+			elsif(klass = @events[event])
+				klass.new(@session, @model)
+			end
+			state ||= self.default
+			if(state.respond_to?(:previous=))
+				state.previous = self
+			end
+			state
+		end
+    def _trigger(event)
+      self.send(event)
+    end
+		def unset_previous
+      if @previous.respond_to?(:next=)
+        @previous.next = nil
+      end
+			@previous = nil
+		end
+		def warning(key)
+			@warnings.select { |warning| warning.key == key }.first
+		end
+		def warning?
+			!@warnings.empty?
+		end
+		def user_input(keys=[], mandatory=[])
+			keys = [keys] unless keys.is_a?(Array)
+			mandatory = [mandatory] unless mandatory.is_a?(Array)
+			if(hash = @session.user_input(*keys))
+        if keys.size == 1
+          unless(error_check_and_store(keys.first, hash, mandatory))
+            hash
+          end
+        else
+          hash.each { |key, value|
+            if(error_check_and_store(key, value, mandatory))
+              hash.delete(key)
+            end
+          }
+          hash
+        end
+			else
+				{}
+			end
+		end
+		def view
+      klass = @default_view
+      if(klass.is_a?(Hash))
+        klass = klass.fetch(@session.user.class) {
+          klass[:default]
+        }
+      end
+      model = @filter ? @filter.call(@model) : @model
+      view = klass.new(model, @session)
+      @http_headers = view.http_headers
+      view
+		end
+		def volatile?
+			self::class::VOLATILE
+		end
+		def zone
+			self::class::ZONE
+		end
+		def zones
+			self::class::ZONES
+		end
+		def zone_navigation
+			[]
+		end
+		def <=>(other)
+			@mtime <=> other.mtime
+		end
+		protected
+		def compare_entries(a, b)
+			@sortby.each { |sortby|
+				aval, bval = nil
+				begin
+					aval = a.send(sortby)
+					bval = b.send(sortby)
+				rescue
+          warn "could not sort by #{sortby}"
+					next
+				end
+				res = if (aval.nil? && bval.nil?)
+					0
+				elsif (aval.nil?)
+					1
+				elsif (bval.nil?)
+					-1
+				else
+					aval <=> bval
+				end
+				return res if(res.nonzero?)
+			}
+			0
+		end
+		def get_sortby!
+			@sortby ||= []
+			if(sortvalue = @session.user_input(:sortvalue))
+        sortvalue = sortvalue.to_sym
+        if(@sortby.first == sortvalue)
+          @sort_reverse = !@sort_reverse
+        else
+          @sort_reverse = self.class::REVERSE_MAP[sortvalue]
+        end
+        @sortby.delete(sortvalue)
+        @sortby.unshift(sortvalue)
+      end
+		end
+		attr_reader :mtime
+	end
+end

data/lib/sbsm/time.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+#
+# State Based Session Management	
+#	Copyright (C) 2004 Hannes Wyss
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#	ywesee - intellectual capital connected, Winterthurerstrasse 52, CH-8006 Z�rich, Switzerland
+#	hwyss@ywesee.com
+#
+# Time -- sbsm -- 20.11.2002 -- hwyss@ywesee.com 
+
+class Time
+	def rfc1123
+		gmtime.strftime('%a, %d %b %Y %H:%M:%S %Z')
+	end
+end

data/lib/sbsm/trans_handler.rb

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+# TransHandler -- sbsm -- 23.09.2004 -- hwyss@ywesee.com
+
+$USING_STRSCAN = true
+require 'rockit/rockit'
+require 'cgi'
+require 'singleton'
+require 'yaml'
+
+module SBSM
+	class AbstractTransHandler
+		attr_reader :parser_name
+		CONFIG_PATH = '../etc/trans_handler.yml'
+		@@empty_check ||= nil
+		@@lang_check ||= nil
+		@@uri_parser ||= nil
+		HANDLER_URI = '/index.rbx'
+		def initialize(name)
+			@parser_name = name
+			@parser_method = "_#{name}_parser"
+			@grammar_path = File.expand_path("../../data/#{name}.grammar", 
+				File.dirname(__FILE__))
+			@parser_path = File.expand_path("#{name}_parser.rb", 
+				File.dirname(__FILE__))
+		end
+    def config(request)
+      config = Hash.new { {} } 
+			begin
+        path = File.expand_path(CONFIG_PATH, request.server.document_root)
+        path.untaint
+        config.update(YAML.load(File.read(path)))
+        config
+			rescue StandardError => err
+				fmt = 'Unable to load url configuration: %s'
+				request.server.log_warn(fmt, err.message)
+				fmt = 'Hint: store configuration in a YAML-File at DOCUMENT_ROOT/%s'
+				request.server.log_notice(fmt, CONFIG_PATH)
+        config
+			end
+    end
+		def handle_shortcut(request, config)
+			if(notes = config['shortcut'][request.uri])
+				notes.each { |key, val|
+					request.notes.add(key, val)
+				}
+				request.uri = HANDLER_URI
+			end
+		end
+		def parse_uri(request)
+			@uri_parser ||= self.uri_parser 
+			ast = @uri_parser.parse(request.uri)
+			values = request.notes
+			ast.children_names.each { |name|
+				case name
+				when'language', 'flavor', 'event', 'zone'
+					values.add(name, ast.send(name).value)
+				when 'variables'
+					ast.variables.each { |pair|
+						key = pair.key.value
+						val = if(pair.children_names.include?('value'))
+							CGI.unescape(pair.value.value.to_s)
+						else
+							''
+						end
+						values.add(key, val)
+					}
+				end
+			}
+		end
+		def translate_uri(request)
+			@@empty_check ||= Regexp.new('^/?$')
+			@@lang_check ||= Regexp.new('^/[a-z]{2}(/|$)')
+      config = config(request)
+      handle_shortcut(request, config)
+      uri = request.uri
+      case uri
+      when @@empty_check
+        request.uri = config['redirect']['/'] || HANDLER_URI
+      when @@lang_check
+        self.parse_uri(request)
+        request.uri = HANDLER_URI
+      end
+      Apache::DECLINED
+		end
+		def uri_parser(grammar_path=@grammar_path, parser_path=@parser_path)
+			if(File.exist?(grammar_path))
+				oldpath = File.expand_path("_" << File.basename(grammar_path), 
+					File.dirname(grammar_path))
+				src = File.read(grammar_path)
+				unless(File.exists?(oldpath) && File.read(oldpath)==src)
+					File.delete(oldpath) if File.exists?(oldpath)
+					Parse.generate_parser_from_file_to_file(grammar_path, 
+						parser_path, @parser_method, 'SBSM')
+					File.open(oldpath, 'w') { |f| f << src }
+				end
+			end
+			require parser_path
+			SBSM.send(@parser_method)
+		end
+	end
+	class TransHandler < AbstractTransHandler
+		include Singleton
+		def initialize
+			super('uri')
+		end
+	end
+	class FlavoredTransHandler < AbstractTransHandler
+		include Singleton
+		def initialize
+			super('flavored_uri')
+		end
+	end
+	class ZoneTransHandler < AbstractTransHandler
+		include Singleton
+		def initialize
+			super('zone_uri')
+		end
+	end
+end