sbsm 1.3.0 → 1.3.1

data/lib/sbsm/exception.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-#
+#--
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
 #
@@ -22,7 +22,7 @@
 # hwyss@ywesee.com
 #
 # Exception -- sbsm -- 22.10.2002 -- hwyss@ywesee.com 
-
+#++
 module SBSM
 	class ProcessingError < RuntimeError
 	end

data/lib/sbsm/index.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-#
+#--
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
 #
@@ -22,6 +22,7 @@
 # hwyss@ywesee.com
 #
 # Index -- sbsm -- 04.03.2003 -- hwyss@ywesee.com 
+#++
 
 module SBSM
   class Index

data/lib/sbsm/logger.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+#--
+# State Based Session Management
+# Copyright (C) 2016 Niklaus Giger
+#
+# 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
+# ngiger@ywesee.com
+#++
+
+require 'chrono_logger'
+require 'sbsm/version'
+module SBSM
+  @@logger = ChronoLogger.new("/tmp/sbsm_#{VERSION}.log.%Y%m%d")
+  @@logger.level= :warn
+  def self.logger=(logger)
+    @@logger = logger
+  end
+  def self.logger
+    @@logger
+  end
+  # a simple logger, which makes it easy to compare the timing of the entries
+  # by the different process. Should probably later be replaced by a Rack based logger
+  def self.info(msg)
+    info = "#{File.basename(caller[0])} #{msg}"
+    @@logger.info(info) if @@logger
+  end
+  def self.debug(msg)
+    info = "#{File.basename(caller[0])} #{msg}"
+    @@logger.debug(info) if @@logger
+  end
+end

data/lib/sbsm/lookandfeel.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-#
+#--
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
 #
@@ -22,7 +22,7 @@
 # hwyss@ywesee.com
 #
 # Lookandfeel -- sbsm -- hwyss@ywesee.com
-
+#++
 require 'sbsm/time'
 require 'cgi'
 

data/lib/sbsm/lookandfeelfactory.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-#
+#--
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
 #
@@ -22,7 +22,7 @@
 # hwyss@ywesee.com
 #
 # LookandfeelFactory -- sbsm -- hwyss@ywesee.com
-
+#++
 require 'sbsm/lookandfeel'
 
 module SBSM

data/lib/sbsm/lookandfeelwrapper.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-#
+#--
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
 #
@@ -22,6 +22,7 @@
 # hwyss@ywesee.com
 #
 # LookandfeelWrapper -- sbsm -- hwyss@ywesee.com
+#++
 
 require "sbsm/lookandfeel"
 

data/lib/sbsm/redirector.rb

@@ -1,17 +1,18 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 # Redirector -- sbsm -- 02.11.2006 -- hwyss@ywesee.com
-
+#++
 module SBSM
   module Redirector
     def http_headers
-      if(redirect?) 
+      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

data/lib/sbsm/session.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-#
+#--
 # State Based Session Management
 #	Copyright (C) 2004 Hannes Wyss
 #
@@ -24,19 +24,21 @@
 # SBSM::Session -- sbsm -- 27.09.2012 -- yasaka@ywesee.com
 # SBSM::Session -- sbsm -- 17.01.2012 -- mhatakeyama@ywesee.com
 # SBSM::Session -- sbsm -- 22.10.2002 -- hwyss@ywesee.com
+#++
 
 require 'cgi'
-
 require 'sbsm/cgi'
 require 'sbsm/drb'
 require 'sbsm/state'
 require 'sbsm/lookandfeelfactory'
 require 'delegate'
+require 'sbsm/trans_handler'
 
 module SBSM
   class	Session < SimpleDelegator
-		attr_reader :user, :active_thread, :app, :key, :cookie_input,
+		attr_reader :user, :active_thread, :key, :cookie_input,
 			:unsafe_input, :valid_input, :request_path, :cgi
+    attr_writer :trans_handler, :app, :validator
 		include DRbUndumped
 		PERSISTENT_COOKIE_NAME = "sbsm-persistent-cookie"
 		DEFAULT_FLAVOR = 'sbsm'
@@ -90,6 +92,7 @@ module SBSM
 			touch()
       reset_input()
 			reset_cookie()
+      raise "Must pass key and app and validator to session" unless key && app # && validator
       @app = app
       @key = key
 			@validator = validator
@@ -100,6 +103,7 @@ module SBSM
 			@variables = {}
       @mutex = Mutex.new
       @cgi = CGI.initialize_without_offline_prompt('html4')
+      SBSM.debug "session initialized #{self} key #{key} app #{app.class}  #{validator.class} with @cgi #{@cgi}"
 			super(app)
     end
     def age(now=Time.now)
@@ -107,8 +111,7 @@ module SBSM
     end
 		def cap_max_states
 			if(@attended_states.size > self::class::CAP_MAX_THRESHOLD)
-				#puts "too many states in session! Keeping only #{self::class::MAX_STATES}"
-				#$stdout.flush
+				SBSM.info "too many states in session! Keeping only #{self::class::MAX_STATES}"
 				sorted = @attended_states.values.sort
 				sorted[0...(-self::class::MAX_STATES)].each { |state|
 					state.__checkout
@@ -152,22 +155,31 @@ module SBSM
 			@cookie_input[key]
 		end
 		def cookie_name
-			self::class::PERSISTENT_COOKIE_NAME
+			# self::class::PERSISTENT_COOKIE_NAME
+      nil
 		end
 		def default_language
 			self::class::DEFAULT_LANGUAGE
 		end
 		def direct_event
+      # used when
 			@state.direct_event
 		end
-    def drb_process(request)
+    def drb_process(app, rack_request)
       start = Time.now
+      @request_path ||= rack_request.path
+      SBSM.debug("rack_request #{rack_request.class} #{@request_path} #{rack_request.request_method} #{@cgi}")
+      rack_request.params.each { |key, val| @cgi.params.store(key, val) }
+      @trans_handler.translate_uri(rack_request)
       html = @mutex.synchronize do
-        process(request)
+        process(rack_request)
         to_html
       end
       (@@stats[@request_path] ||= []).push(Time.now - start)
       html
+    rescue  => err
+        SBSM.info "Error in drb_process #{err.backtrace[0..5].join("\n")}"
+        raise err
     end
 		def error(key)
 			@state.error(key) if @state.respond_to?(:error)
@@ -200,40 +212,40 @@ module SBSM
 		def import_cookies(request)
 			reset_cookie()
       return if request.cookies.is_a?(DRb::DRbUnknown)
-      if(cuki = request.cookies[self::class::PERSISTENT_COOKIE_NAME])
-        cuki.each { |cuki_str|
-          CGI.parse(CGI.unescape(cuki_str)).each { |key, val|
-            key = key.intern
-            valid = @validator.validate(key, val.compact.last)
-            @cookie_input.store(key, valid)
-          }
+      if(cuki_str = request.cookies[self::class::PERSISTENT_COOKIE_NAME])
+        CGI.parse(CGI.unescape(cuki_str)).each { |key, val|
+          key = key.intern
+          valid = @validator.validate(key, val.compact.last)
+          @cookie_input.store(key, valid)
         }
       end
 		end
     @@hash_ptrn = /([^\[]+)((\[[^\]]+\])+)/
     @@index_ptrn = /[^\[\]]+/
-    def import_user_input(request)
+    def import_user_input(rack_req)
 			# attempting to read the cgi-params more than once results in a
 			# DRbConnectionRefused Exception. Therefore, do it only once...
 			return if(@user_input_imported)
-      request.params.each { |key, value|
-				#puts "importing #{key} -> #{value}"
+      hash = rack_req.env.merge rack_req.params
+      hash.each do |key, value|
+        next if /^rack\./.match(key)
 				index = nil
 				@unsafe_input.push([key.to_s.dup, value.to_s.dup])
 				unless(key.nil? || key.empty?)
 					if match = @@hash_ptrn.match(key)
 						key = match[1]
 						index = match[2]
-						#puts key, index
+            #puts key, index
 					end
 					key = key.intern
 					if(key == :confirm_pass)
-						pass = request.params["pass"]
-						#puts "pass:#{pass} - confirm:#{value}"
+						pass = rack_req.params["pass"]
+						# puts "pass:#{pass} - confirm:#{value}"
 						@valid_input[key] = @valid_input[:set_pass] \
 							= @validator.set_pass(pass, value)
 					else
 						valid = @validator.validate(key, value)
+            # puts "Checking #{key} -> #{value}  valid #{valid.inspect} index #{index.inspect}"
 						if(index)
               target = (@valid_input[key] ||= {})
               indices = []
@@ -247,13 +259,15 @@ module SBSM
               target.store(last, valid)
 						else
 							@valid_input[key] = valid
+              # puts "@valid_input #{key} -> #{value}  valid #{valid.inspect} index #{index.inspect}"
               "dummy" # Some statement is necessary here to avoid Date data loading error on Ruby 1.9.3
 						end
 					end
 				end
 				#puts "imported #{key} -> #{value} => #{@valid_input[key].inspect}"
-      }
+      end
 			@user_input_imported = true
+      @valid_input
 			#puts @unsafe_input.inspect
 			#puts @valid_input.inspect
 			#$stdout.flush
@@ -277,10 +291,14 @@ module SBSM
 		end
 		def login
 			if(user = @app.login(self))
+          SBSM.debug "user is #{user}  #{request_path.inspect}"
 				@user = user
+      else
+        SBSM.debug "login no user #{request_path.inspect}"
 			end
 		end
 		def logout
+      SBSM.debug "logout #{request_path.inspect} setting @state #{self::class::DEFAULT_STATE.new(self, @user)}"
 			__checkout
 			@user = @app.unknown_user()
 			@active_state = @state = self::class::DEFAULT_STATE.new(self, @user)
@@ -316,9 +334,7 @@ module SBSM
     rescue DRb::DRbConnError
       raise
 		rescue NameError, StandardError => err
-      puts "error in SBSM::Session#http_headers: #@request_path"
-      puts err.class, err.message
-      puts err.backtrace[0,5]
+      SBSM.info "NameError, StandardError: #@request_path"
 			{'Content-Type' => 'text/plain'}
 		end
 		def http_protocol
@@ -345,15 +361,16 @@ module SBSM
 				@persistent_user_input[key]
 			end
 		end
-		def process(request)
-			begin
-				@request = request
-        @request_method = request.request_method
-        @request_path = @request.unparsed_uri
-				@validator.reset_errors() if @validator
-				import_user_input(request)
-				import_cookies(request)
-				@state = active_state.trigger(event())
+    def process(rack_request)
+      begin
+        @request_method =rack_request.request_method
+        @request = rack_request
+        @request_method ||= @request.request_method
+        @request_path = @request.path
+        @validator.reset_errors() if @validator && @validator.respond_to?(:reset_errors)
+        import_user_input(rack_request)
+        import_cookies(rack_request)
+        @state = active_state.trigger(event())
         #FIXME: is there a better way to distinguish returning states?
         #       ... we could simply refuse to init if event == :sort, but that
         #       would not solve the problem cleanly, I think.
@@ -361,38 +378,22 @@ module SBSM
           @state.request_path = @request_path
           @state.init
         end
-				unless @state.volatile?
-					@active_state = @state
-					@attended_states.store(@state.object_id, @state)
-				end
-				@zone = @active_state.zone
-				@active_state.touch
-				cap_max_states
+        unless @state.volatile?
+          SBSM.debug "Changing to #{@state.class}"
+          @active_state = @state
+          @attended_states.store(@state.object_id, @state)
+        end
+        @zone = @active_state.zone
+        @active_state.touch
+        cap_max_states
       rescue DRb::DRbConnError
         raise
-			rescue StandardError => err
-        #@state = @state.previous
-				puts "error in SBSM::Session#process: #@request_path"
-				puts err.class, err.message
-				puts err.backtrace[0,5]
-				$stdout.flush
 			ensure
 				@user_input_imported = false
 			end
 			''
 		end
 		def reset
-=begin
-			if(@active_thread \
-				&& @active_thread.alive? \
-				&& @active_thread != Thread.current)
-				begin
-					#@active_thread.exit
-				rescue StandardError
-				end
-			end
-			@active_thread = Thread.current
-=end
       if @redirected
         @redirected = false
       else
@@ -443,10 +444,7 @@ module SBSM
     rescue DRb::DRbConnError
       raise
 		rescue StandardError => err
-      puts "error in SBSM::Session#to_html: #@request_path"
-      puts err.class, err.message
-      puts err.backtrace#[0,5]
-      $stdout.flush
+      SBSM.info "StandardError: #@request_path"
 			[ err.class, err.message ].join("\n")
 		end
     def user_agent
@@ -487,13 +485,9 @@ module SBSM
 		end
     # CGI::SessionHandler compatibility
     def restore
-			#puts "restore was called"
-			#@unix_socket = DRb.start_service('drbunix:', self)
       hash = {
-				#:proxy   =>  DRbObject.new(self, @unix_socket.uri)
-				:proxy	=>	self,
+        :proxy	=>	self,
       }
-			hash.extend(DRbUndumped) # added for Ruby1.8 compliance
       hash
     end
     def update

data/lib/sbsm/state.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-#
+#--
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
 #
@@ -23,6 +23,8 @@
 #
 # SBSM::State -- sbsm -- 15.05.2012 -- yasaka@ywesee.com
 # SBSM::State -- sbsm -- 22.10.2002 -- hwyss@ywesee.com
+#++
+require 'sbsm/logger'
 
 module SBSM
 	class ProcessingError < RuntimeError
@@ -121,29 +123,19 @@ module SBSM
 				@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
+    def extend(mod)
+      if(mod.constants.include?(:VIRAL))
+        @viral_modules.push(mod)
       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
+      if(mod.constants.include?(:EVENT_MAP))
+        @events.update(mod::EVENT_MAP)
       end
+      super
     end
 		def http_headers
-			@http_headers || view.http_headers
+      return @http_headers if @http_headers
+      name = view
+      name ? view.http_headers : {}
 		end
 		def info?
 			!@infos.empty?
@@ -178,7 +170,8 @@ module SBSM
 			@mtime = Time.now
 		end
 		def to_html(context)
-			view.to_html(context)
+      name = view
+      name ? name.to_html(context) : ''
 		end
 		def trigger(event)
       if(@redirected)
@@ -197,6 +190,7 @@ module SBSM
 			if(state.respond_to?(:previous=))
 				state.previous = self
 			end
+      # puts "state.rb #{__LINE__} state #{state.inspect}"
 			state
 		end
     def _trigger(event)
@@ -236,6 +230,7 @@ module SBSM
 		end
 		def view
       klass = @default_view
+      return nil unless @default_view
       if(klass.is_a?(Hash))
         klass = klass.fetch(@session.user.class) {
           klass[:default]