sbsm 1.0.0

data/lib/sbsm/lookandfeel.rb

@@ -0,0 +1,176 @@
+#!/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
+#
+# Lookandfeel -- sbsm -- hwyss@ywesee.com
+
+require 'sbsm/time'
+require 'cgi'
+
+module SBSM
+  class Lookandfeel
+    attr_reader :language, :flavor, :session
+    DICTIONARIES = {}
+		DISABLED = []
+		ENABLED = []
+		HTML_ATTRIBUTES = {}
+		RESOURCES = {}
+		RESOURCE_BASE = "resources"
+		TXT_RESOURCES = "/resources"
+		class << self
+			def txt_file(filename)
+				Proc.new {
+					path = File.expand_path(filename, self::TXT_RESOURCES)
+					File.read(path).strip.gsub(/(\r\n)|(\n)|(\r)/, '<br>')
+				}
+			end
+		end
+		def initialize(session)
+      @session = session
+      @flavor = @session.flavor
+      @language = @session.language
+      set_dictionary(@language)
+		end
+		def attributes(key)
+      self::class::HTML_ATTRIBUTES.fetch(key.to_sym, {}).dup rescue {}
+		end
+		def base_url
+			[@session.http_protocol + ':/', @session.server_name, @language, @flavor].compact.join("/")
+		end
+		def direct_event
+			@session.direct_event
+		end
+		def disabled?(event)
+			self::class::DISABLED.include?(event)
+		end
+		def enabled?(event, default=true)
+			default || self::class::ENABLED.include?(event)
+		end
+		def event_url(event=direct_event, args={}, anchor=nil)
+			_event_url(event, args, anchor=nil) { |args|
+				unless(@session.is_crawler? || args.include?('state_id'))
+					args.unshift(:state_id, @session.state.object_id)
+				end
+			}
+		end
+		def _event_url(event=direct_event, args={}, anchor=nil, &block)
+			args = args.collect { |*pair| pair }.flatten
+			args = args.collect { |value| CGI.escape(value.to_s) }
+			if(block_given?)
+				yield(args)
+			end
+			url = [base_url(), event, args].compact.join('/')
+			if(anchor)
+				url << "#" << anchor.to_s
+			end
+			url
+		end
+		def languages
+			@languages ||= self::class::DICTIONARIES.keys.sort
+		end
+		def language_url(language)
+			[@session.http_protocol + ':/', @session.server_name, language, @flavor].compact.join("/")
+		end
+    def lookup(key, *args, &block)
+      _lookup(key, *args) || (block.call if block)
+    end
+		def _lookup(key, *args)
+			key = key.intern if key.is_a? String
+			if(args.size > 0)
+				result = ""
+				args.each_with_index { |text, index|
+					result << (lookup(key.to_s + index.to_s) || ' ')
+					result << text.to_s
+				}
+				tail = lookup(key.to_s + args.size.to_s)
+				result << tail if(tail)
+			else
+				result = @dictionary[key] if @dictionary
+				if(result.is_a? Proc)
+					result.call
+				elsif(result.nil?)
+					def_lan = @session.default_language
+					if(dict = self::class::DICTIONARIES[def_lan])
+						dict[key]
+					end
+				else
+					result
+				end
+			end
+		end
+		def format_date(date)
+			date.strftime(lookup(:date_format))
+		end
+		def format_price(price, currency=nil)
+			if(price.to_i > 0)
+				[currency, sprintf('%.2f', price.to_f/100.0)].compact.join(' ')
+			end
+		end
+		def format_time(time)
+			time.strftime(lookup(:time_format))
+		end
+		def navigation(filter=false)
+			@session.navigation
+		end
+		def resource(rname, rstr=nil)
+			collect_resource([ self::class::RESOURCE_BASE, @session.flavor ], 
+                         rname, rstr)
+		end
+		def resource_external(rname)
+			self::class::RESOURCES[rname]
+		end
+		def resource_global(rname, rstr=nil)
+			collect_resource(self::class::RESOURCE_BASE, rname, rstr)
+		end
+		def resource_localized(rname, rstr=nil, lang=@language)
+			result = resource([rname, lang].join('_').intern, rstr)
+			if(result.nil? && (lang != @session.default_language))
+				result = resource_localized(rname, rstr, @session.default_language)
+			end
+			result
+		end
+		def zone_navigation(filter=false)
+			@session.zone_navigation
+		end
+		def zones(filter=false)
+			@session.zones
+		end
+		private
+		def collect_resource(base, rname, rstr=nil)
+			varpart = self::class::RESOURCES[rname]
+      if(varpart.is_a?(Array))
+        varpart.collect { |part|
+          _collect_resource(base, part, rstr)
+        }
+      elsif(!varpart.nil?)
+        _collect_resource(base, varpart, rstr)
+      end
+		end
+    def _collect_resource(base, part, rstr)
+      [ @session.http_protocol + ':/', 
+        @session.server_name, 
+        base, part, rstr].flatten.compact.join('/')
+    end
+    def set_dictionary(language)
+      @dictionary = self::class::DICTIONARIES[language] || {}
+    end
+  end
+end

data/lib/sbsm/lookandfeelfactory.rb

@@ -0,0 +1,50 @@
+#!/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
+#
+# LookandfeelFactory -- sbsm -- hwyss@ywesee.com
+
+require 'sbsm/lookandfeel'
+
+module SBSM
+  class LookandfeelFactory 
+		WRAPPERS = {}
+		BASE = Lookandfeel
+    class << self
+      def create(session)
+        lnf = self::BASE.new(session)
+        if(wrappers = self::WRAPPERS[session.flavor])
+					lnf = wrappers.inject(lnf) { |lnf, klass| 
+						klass.new(lnf)
+					}
+				end
+        lnf
+			rescue StandardError => e
+				puts e.class
+				puts e.message
+				puts e.backtrace
+      end
+			def include?(str)
+				self::WRAPPERS.include?(str)
+			end
+    end
+  end
+end

data/lib/sbsm/lookandfeelwrapper.rb

@@ -0,0 +1,109 @@
+#!/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
+#
+# LookandfeelWrapper -- sbsm -- hwyss@ywesee.com
+
+require "sbsm/lookandfeel"
+
+module SBSM
+	class LookandfeelWrapper < Lookandfeel
+		def initialize(component)
+			@component = component
+			super(@component.session)
+		end 
+		def method_missing(symbol, *args, &block)
+			@component.send(symbol, *args, &block)
+		end
+		def attributes(key)
+			self::class::HTML_ATTRIBUTES.fetch(key.to_sym) {
+				@component.attributes(key)
+			}
+		end
+		def disabled?(event)
+			self::class::DISABLED.include?(event) \
+				|| @component.disabled?(event)
+		end
+		def enabled?(event, default=false)
+			self::class::ENABLED.include?(event) \
+				|| @component.enabled?(event, default)
+		end
+		def languages
+			unless(@languages)
+				super
+				if(@languages.empty?) 
+					@languages = @component.languages
+				end
+			end
+			@languages
+		end
+		def lookup(key, *args, &block)
+			_lookup(key, *args) || @component.lookup(key, *args, &block)
+		end
+		def navigation(filter=true)
+			nav = @component.navigation(false)
+			if(filter)
+				nav.select { |item| 
+					key = (item.is_a? Symbol) ? item : item.direct_event
+					enabled?(key)
+				}
+			else
+				nav
+			end
+		end
+		def resource(rname, rstr=nil)
+			if(self::class::RESOURCES.include?(rname))
+				super
+			else
+				@component.resource(rname, rstr)
+			end
+		end
+		def resource_global(rname, rstr=nil)
+			if(self::class::RESOURCES.include?(rname))
+				super
+			else
+				@component.resource_global(rname, rstr)
+			end
+		end
+		def zone_navigation(filter=true)
+			nav = @component.zone_navigation(false)
+			if(filter)
+				nav.select { |item| 
+					key = (item.is_a? Symbol) ? item : item.direct_event
+					enabled?(key)
+				}
+			else
+				nav
+			end
+		end
+		def zones(filter=true)
+			nav = @component.zones(false)
+			if(filter)
+				nav.select { |item| 
+					key = (item.is_a? Symbol) ? item : item.direct_event
+					enabled?(key)
+				}
+			else
+				nav
+			end
+		end
+	end
+end

data/lib/sbsm/redefine_19_cookie.rb

@@ -0,0 +1,4 @@
+#class CGI
+#  remove_const 'Cookie'
+#end
+#load '/usr/lib/ruby19/1.9.1/cgi/cookie.rb'

data/lib/sbsm/redirector.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# Redirector -- sbsm -- 02.11.2006 -- hwyss@ywesee.com
+
+module SBSM
+  module Redirector
+    def http_headers
+      if(redirect?) 
+        @redirected = @state.redirected = true
+        event, *args = @state.direct_event
+        if(args.first.is_a? Hash)
+          args = args.first
+        end
+        { 
+          "Location" => lookandfeel._event_url(event, args || {}),
+        }
+      else
+        @redirected = @state.redirected = false
+        super 
+      end
+    end
+    def redirect?
+      direct = @state.direct_event
+      if(direct.is_a?(Array))
+        direct = direct.first
+      end
+      direct && (@request_method != 'GET' \
+                 || ![direct, :sort].include?(event))
+    end
+    def to_html
+      if(redirect?)
+        ''
+      else
+        super
+      end
+    end
+  end
+end

data/lib/sbsm/request.rb

@@ -0,0 +1,162 @@
+#!/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
+#
+# Request -- sbsm -- hwyss@ywesee.com
+
+require 'sbsm/cgi'
+require 'sbsm/drb'
+require 'sbsm/redefine_19_cookie'
+require 'cgi/session'
+require 'cgi/drbsession'
+require 'delegate'
+
+module SBSM
+  class Request < SimpleDelegator
+    include DRbUndumped
+		CRAWLER_PATTERN = /archiver|slurp|bot|crawler|jeeves|spider|\.{6}/i
+    attr_reader :cgi
+    def initialize(drb_uri, html_version = "html4", cgiclass = CGI)
+      @cgi = cgiclass.new(html_version)
+			@drb_uri = drb_uri
+			@thread = nil
+			@request = Apache.request
+			super(@cgi)
+    end
+		def cookies
+      @cgi.cookies
+		end
+    def is_crawler?
+			!!CRAWLER_PATTERN.match(@cgi.user_agent)
+		end
+		def passthru(path, disposition='attachment')
+			@passthru = path
+      @disposition = disposition
+			''
+		end
+		def process
+			begin
+				@cgi.params.store('default_flavor', ENV['DEFAULT_FLAVOR'])
+				@request.notes.each { |key, val|
+					@cgi.params.store(key, val)
+				}
+        drb_process()
+				#drb_request()
+				#drb_response()
+			rescue StandardError => e
+				handle_exception(e)
+			ensure
+				@session.close if @session.respond_to?(:close)
+			end
+		end
+		def remote_host(lookup_type=Apache::REMOTE_NOLOOKUP)
+			@request.remote_host(lookup_type)
+		end
+		def unparsed_uri
+			@request.unparsed_uri
+		end
+		private
+		def drb_process
+      args = {
+        'database_manager'	=>	CGI::Session::DRbSession,
+				'drbsession_uri'		=>	@drb_uri,
+				'session_path'			=>	'/',
+      }
+      if(is_crawler?)
+        sleep 0.5
+        sid = [ENV['DEFAULT_FLAVOR'], @cgi.params['language'], @cgi.user_agent].join('-')
+        args.store('session_id', sid)
+      end
+			@session = CGI::Session.new(@cgi, args)
+			@proxy = @session[:proxy]
+			res = @proxy.drb_process(self)
+			cookie_input = @proxy.cookie_input
+			# view.to_html can call passthru instead of sending data
+			if(@passthru)
+				unless(cookie_input.empty?)
+					cookie = generate_cookie(cookie_input)
+					@request.headers_out.add('Set-Cookie', cookie.to_s)
+				end
+				# the variable @passthru is set by a trusted source
+				basename = File.basename(@passthru)
+				fullpath = File.expand_path(@passthru,
+					@request.server.document_root)
+				fullpath.untaint
+				subreq = @request.lookup_file(fullpath)
+				@request.content_type = subreq.content_type
+				@request.headers_out.add('Content-Disposition',
+					"#@disposition; filename=#{basename}")
+				@request.headers_out.add('Content-Length',
+					File.size(fullpath).to_s)
+				begin
+					File.open(fullpath) { |fd| @request.send_fd(fd) }
+        rescue Errno::ENOENT, IOError => err
+          @request.log_reason(err.message, @passthru)
+          return Apache::NOT_FOUND
+        end
+			else
+				begin
+					headers = @proxy.http_headers
+					unless(cookie_input.empty?)
+						cookie = generate_cookie(cookie_input)
+						headers.store('Set-Cookie', [cookie])
+					end
+					@cgi.out(headers) {
+						(@cgi.params.has_key?("pretty")) ? CGI.pretty( res ) : res
+					}
+				rescue StandardError => e
+					handle_exception(e)
+				end
+			end
+		end
+		def generate_cookie(cookie_input)
+			cookie_pairs = cookie_input.collect { |pair|
+				pair.join('=')
+			}.join(';')
+			cookie_hash = {
+				"name"		=>	@proxy.cookie_name || 'sbsm-persistent-cookie',
+				"value"		=>	cookie_pairs,
+				"path"		=>	"/",
+				"expires"	=>	(Time.now + (60 * 60 * 24 * 365 * 10)),
+			}
+			CGI::Cookie.new(cookie_hash).to_s
+		end
+		def handle_exception(e)
+			if defined?(Apache)
+				msg = [
+					[Time.now, self.object_id].join(' - '),
+					e.class,
+					e.message,
+				].join(" - ")
+        uri = unparsed_uri
+        @request.log_reason(msg, uri)
+				e.backtrace.each { |line|
+					@request.log_reason(line, uri)
+				}
+			end
+			hdrs = {
+				'Status' => '302 Moved',
+				'Location' => '/resources/errors/appdown.html',
+			}
+			@cgi.header(hdrs)
+		end
+  end
+end