sbsm 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4c300971692a328081c6b56bd30d327fdb02252
-  data.tar.gz: dcd9b428233ca4fb56e372a76601c8e289a280ac
+  metadata.gz: 9709fd562058b81d1408b0bc88142076bddad4f5
+  data.tar.gz: 2976e9b526e9112093bd5aab2993abd5e385eec1
 SHA512:
-  metadata.gz: 9100a0913b65ca6f7fc7b3a39cf9f6ecd026a2bc92e785dd4f5a462f20a6212bbcb78509b7391c2a1df67c55d3f6a0354282fd554ff34ceafa393a4e8a228958
-  data.tar.gz: b31394abfa5c3ff78f2cdbb640e5fbf7a92c4300dc07969397d5d6d09ffa8f855eefccb5da99d4745bbdea83e950a1bca0cd99270ea6e2bdee568dfce1a36a0e
+  metadata.gz: ddcbee6256f6fe7d1c19512b7c03c4291988968c0730e8cf53717f2b59f5a2b004cc9abfe21ea124030d7f36c1522f4f399d9936b265db2e7fb50566cda7d29c
+  data.tar.gz: 1d5e713387d3a460bd6beccf6003836f438d7c65dbd2ea84ea4213e2c6b593ee3a1ea14b3825912e57c1ed4e97f03139f43e630562ecf7031ba3d51328d709d7

data/.gitignore

@@ -1,4 +1,9 @@
+.ruby-version
+Gemfile.lock
+etc/
 .bundle/
+doc/
 vendor/
 pkg/
 coverage/
+*.log

data/.travis.yml

@@ -12,15 +12,14 @@ sudo: false
 before_install:
   - gem --version
 
-script: bundle exec test/suite.rb
-
 bundler_args: --without debugger
 
 rvm:
   - ruby-head
-  - 2.1.7
   - 2.2.3
   - 2.3.0
 matrix:
   allow_failures:
+    # On november 1 had failure compiling the child_processes
     - rvm: ruby-head
+    - rvm: 2.2.3

data/Gemfile

@@ -1,12 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
-
-group :debugger do
-  if RUBY_VERSION.match(/^1/)
-    gem 'pry-debugger'
-  else
-    gem 'pry-byebug'
-    gem 'pry-doc'
-  end
-end

data/History.txt

@@ -1,3 +1,17 @@
+=== 1.3.1 / 9.11.2016
+* Moved from mod_ruby to using webrick/rack interface
+* Incompatible changes to 1.3.0 are that all trans_handlers must be fixed, as the parameters are
+* changed now in the params field (to be compatible with Rack::Request). The SBSM::Request field notes has gone!
+* See changes in steinwies.ch which were minimal
+** Removed an unused require 'sbsm/request' in src/view/navbar.rb
+** added a config.ru
+** Changed Steinwies::App to derive from SBSM::App instead of SBSM::DRbServer and its initialize method
+** The Session.initialize method had to pass a validator when calling super
+
+* Open problems
+** Handling redirects is not tested (and probably will not work)
+** Handling passthru is not tested (and probably will not work)
+
 === 1.3.0 / 08.08.2016
 * Add a support to avoid offline mode by CGI.new in test purpose
 

data/README.md

@@ -4,11 +4,16 @@
 
 ## DESCRIPTION:
 
-Application framework for state based session management
+Application framework for state based session management. See lib/sbsm.rb
 
 ## FEATURES/PROBLEMS:
 
-* Could be replaced by Ramaze one day. But lets see.
+* Open problems
+** There is no real integration test using rack-test to prove that a minimal app is working
+** Handling a POST request for handling a form does not work yet
+** Handling redirects is not tested (and probably will not work)
+** Handling passthru is not tested (and probably will not work)
+** I get often the error `Errno::EACCES at / Permission denied @ rb_sysopen - /tmp/sbsm_lock`. Reloading the page once or twices fixes the problem.
 
 ## REQUIREMENTS:
 

data/Rakefile

@@ -4,9 +4,13 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sbsm/version'
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+config = File.expand_path('../etc/config.yml', __FILE__)
+if !File.exist?(config)
+  FileUtils.makedirs(File.dirname(config))
+  File.open(config, 'w+') {|file| file.puts("---") }
+end
 
 # dependencies are now declared in sbsm.gemspec
 
@@ -19,3 +23,26 @@ task :spec => :clean
 
 require 'rake/clean'
 CLEAN.include FileList['pkg/*.gem']
+
+desc "create RDoc documentation"
+
+task :rdoc do
+  cmd = "bundle exec rdoc --exclude='/coverage|vendor|test|data|etc|Manifest|.*.lock|.*.css|.*.js|.*.gemspec|.*.patch/' --include=lib" +
+      " --main=lib/sbsm.rb --title='SBSM: a framework for state based session management'"
+  puts cmd
+  res = system(cmd)
+  puts "Running test/suite.rb returned #{res.inspect}. Output is found in the doc sub-directory"
+  exit 1 unless res
+end
+
+
+desc "Run tests"
+task :default => :test
+
+task :test do
+  log_file = 'suite.log'
+  res = system("bash -c 'set -o pipefail && bundle exec ruby test/suite.rb 2>&1 | tee #{log_file}'")
+  puts "Running test/suite.rb returned #{res.inspect}. Output was redirected to #{log_file}"
+  exit 1 unless res
+end
+

data/lib/cgi/drbsession.rb

@@ -1,12 +1,14 @@
 # encoding: utf-8
+#--
 # DRbSession - CGI::Session session database manager using DRb.
 # Copyright (C) 2001 by Tietew. All Rights Reserved.
-#
+#++
 require 'drb/drb'
-
+require 'sbsm/logger'
 class CGI
   class Session
     class DRbSession
+      attr_reader :obj
       def initialize(session, option={})
         unless uri = option['drbsession_uri']
           raise ArgumentError, "drbsession_uri not specified"

data/lib/sbsm.rb

@@ -0,0 +1,31 @@
+#--
+# Copyright 2016 Niklaus Giger <ngiger@ywesee.com>
+#++
+#
+# *SBSM:* Application framework for state based session management.
+#
+# We document here a few aspects of SBSM. As it is written over 10 years
+# after the creation of one of the few users, who never had the chance to
+# discuss with the creator of this piece of software, errors/obmission
+# are found quite often.
+#
+# The behaviour of SBSM can be extended or overriden in many ways.
+# Often in derived classes you simply define a few constants, these
+# extension points can be spotted by searching for occurrences of
+# -self::class::- in the implementation of SBSM.
+#
+# * *lookandfeel*: offers a simple way to customize views, constants
+#   for different languages
+#
+# * *viralstate*: Used in bbmb and sandoz.com
+#
+# * *session*: Used in bbmb and sandoz.com
+#
+# * *request*: Used in bbmb and sandoz.com
+#
+# * *transhandler*: Responsible for converting an URI into a hash of
+#   option values, e.g. /de/gcc/fachinfo/reg/58980
+#
+module SBSM
+
+end

data/lib/sbsm/app.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+#--
+# 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
+# ngiger@ywesee.com
+#
+# App -- sbsm -- ngiger@ywesee.com
+#++
+require 'cgi'
+require 'cgi/session'
+require 'sbsm/cgi'
+require 'cgi/drbsession'
+require 'sbsm/drbserver'
+module SBSM
+  ###
+  # App a base class for Webrick server
+  class App < SBSM::DRbServer
+    include DRbUndumped
+    PERSISTENT_COOKIE_NAME = "cookie-persistent-sbsm-1.3.1"
+    SBSM.info "PERSISTENT_COOKIE_NAME #{PERSISTENT_COOKIE_NAME}"
+
+    attr_reader :sbsm, :my_self, :validator
+
+    OPTIONS = [ :app, :config_file, :trans_handler, :validator, :persistence_layer, :server_uri, :session, :unknown_user ]
+    COOKIE_ID = 'sbsm-persistent-cookie-id'
+
+    OPTIONS.each{ |opt| eval "attr_reader :#{opt}" }
+
+    # Base class for a SBSM based WebRick HTTP server
+    # * offers a start_server() method to launch a DRB server for handling the DRB-requests
+    # * offer a call(env) method form handling the WebRick requests
+    # This is all what is needed to be compatible with WebRick
+    #
+    # === arguments
+    #
+    # * +validator+ -         A Ruby class overriding the SBSM::Validator class
+    # * +trans_handler+ -     A Ruby class overriding the SBSM::TransHandler class
+    # * +persistence_layer+ - Persistence Layer to use
+    #
+    # === Examples
+    # Look at steinwies.ch
+    # * https://github.com/zdavatz/steinwies.ch (simple, mostly static files, one form, no persistence layer)
+    #
+    def initialize(app:, validator:, trans_handler:, persistence_layer: nil)
+      @app = app
+      @trans_handler = trans_handler
+      @validator = validator
+      SBSM.info "initialize @app is now #{@app.class} validator #{validator} th #{trans_handler} "
+      super(persistence_layer)
+    end
+
+    def call(env) ## mimick sbsm/lib/app.rb
+      request = Rack::Request.new(env)
+      response = Rack::Response.new
+      if request.cookies[PERSISTENT_COOKIE_NAME] && request.cookies[PERSISTENT_COOKIE_NAME].length > 1
+        session_id = request.cookies[PERSISTENT_COOKIE_NAME]
+      else
+        session_id = rand((2**(0.size * 8 -2) -1)*10240000000000).to_s(16)
+      end
+      file_name = File.expand_path(File.join('doc', request.path))
+      if File.file?(file_name)
+        if /css/i.match(File.basename(file_name))
+          response.set_header('Content-Type', 'text/css')
+        else
+          response.set_header('Content-Type', 'text/plain')
+        end
+        response.write(File.open(file_name, File::RDONLY){|file| file.read})
+        return response
+      end
+
+      return [400, {}, []] if /favicon.ico/i.match(request.path)
+      SBSM.debug "#{request.path}: cookies are #{request.cookies} for session_id #{session_id}"
+      @drb_uri ||= @app.drb_uri
+      args = {
+        'database_manager'  =>  CGI::Session::DRbSession,
+        'drbsession_uri'    =>  @drb_uri,
+        'session_path'      =>  '/',
+        PERSISTENT_COOKIE_NAME => session_id,
+      }
+      @cgi = CGI.initialize_without_offline_prompt('html4')
+      @session = CGI::Session.new(@cgi, args)
+      saved = self[session_id]
+      @proxy  = DRbObject.new(saved, server_uri)
+      @proxy.trans_handler = @trans_handler
+      @proxy.app = @app
+      res = @proxy.drb_process(self, request)
+      response.write res
+      response.headers['Content-Type'] ||= 'text/html; charset=utf-8'
+      response.set_cookie(PERSISTENT_COOKIE_NAME, session_id)
+      @proxy.cookie_input.each{|key, value| response.set_cookie(key, value) }
+      SBSM.debug "finish session_id #{session_id}: header #{response.headers}"
+      response.finish
+    end
+  end
+end

data/lib/sbsm/cgi.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-#
+#--
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
 #
@@ -21,6 +21,7 @@
 # ywesee - intellectual capital connected, Winterthurerstrasse 52, CH-8006 Zürich, Switzerland
 # hwyss@ywesee.com
 #
+#++
 # CGI redefinitions
 
 require 'cgi'
@@ -42,55 +43,4 @@ class CGI
     end
     cgi
   end
-	module TagMaker
-    def nOE_element_def(element, append = nil)
-      s = <<-END
-          "<#{element.upcase}" + attributes.collect{|name, value|
-            next unless value
-            " " + name.to_s +
-            if true == value
-              ""
-            else
-              '="' + CGI::escapeHTML(value) + '"'
-            end
-          }.to_s + ">"
-      END
-      s.sub!(/\Z/, " +") << append if append
-      s
-    end
-	end
-	class Session
-		attr_reader :output_cookies
-	end
-  def CGI::pretty(string, shift = "  ")
-    lines = string.gsub(/(?!\A)<(?!\/(pre|textarea))(?:.)*?>/ni, "\n\\0").gsub(/<(?!(pre|textarea))(?:.)*?>(?!\n)/i, "\\0\n")
-	  end_pos = 0
-		preformatted = []
-		while (end_pos = lines.index(/<\/pre\s*>/i, end_pos)) \
-      && (start_pos = lines.rindex(/<pre(\s+[^>]+)?>/i, end_pos))
-			start_pos += $~[0].length
-			preformatted.push(lines[ start_pos ... end_pos ])
-			lines[ start_pos ... end_pos ] = ''
-			end_pos	= start_pos + 6
-		end
-    end_pos = 0
-    while end_pos = lines.index(/^<\/(\w+)/, end_pos)
-      element = $1.dup
-      start_pos = lines.rindex(/^\s*<#{element}/i, end_pos)
-      lines[start_pos ... end_pos] = "__" + lines[start_pos ... end_pos].gsub(/\n(?!\z)/, "\n" + shift) + "__"
-    end
-    pretty = lines.gsub(/^((?:#{Regexp::quote(shift)})*)__(?=<\/?\w)/, '\1')
-		pos = 0
-		preformatted.each { |pre|
-			if(pos = pretty.index(/<\/pre\s*>/i, pos))
-				pretty[pos,0] = pre
-				pos += pre.length + 6
-			end
-		}
-		pretty
-  end
-	def CGI::escapeHTML(string)
-    s = string.to_s.frozen? ? string.to_s : string.to_s.force_encoding('UTF-8')
-		s.gsub(/&(?![^;]{2,6};)/, '&amp;').gsub(/\"/, '&quot;').gsub(/>/, '&gt;').gsub(/</, '&lt;')
-	end
 end

data/lib/sbsm/drb.rb

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 # DRb::DRbObject -- fix bug respond_to argument -- 22.08.2011 -- mhatakeyama@ywesee.com
 # DRb::DRbObject -- fix bug in ruby -- 23.09.2005 -- hwyss@ywesee.com
-
+#++
 require 'drb'
 
 module DRb

data/lib/sbsm/drbserver.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 #
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
@@ -22,6 +23,7 @@
 # hwyss@ywesee.com
 #
 # DrbServer -- sbsm -- hwyss@ywesee.com
+#++
 
 require 'delegate'
 require 'sbsm/drb'
@@ -29,6 +31,8 @@ require 'sbsm/session'
 require 'sbsm/user'
 require 'thread'
 require 'digest/md5'
+require 'sbsm/logger'
+require 'sbsm/validator'
 
 module SBSM
 	class DRbServer < SimpleDelegator
@@ -81,7 +85,7 @@ module SBSM
 		end
 		def cap_max_sessions(now = Time.now)
 			if(@sessions.size > self::class::CAP_MAX_THRESHOLD)
-				puts "too many sessions! Keeping only #{self::class::MAX_SESSIONS}"
+				SBSM.info "too many sessions! Keeping only #{self::class::MAX_SESSIONS}"
         sess = nil
 				sorted = @sessions.values.sort
 				sorted[0...(-self::class::MAX_SESSIONS)].each { |sess|
@@ -90,7 +94,7 @@ module SBSM
 				}
         if(sess)
           age = sess.age(now)
-          puts sprintf("deleted all sessions that had not been accessed for more than %im %is", age / 60, age % 60)
+          SBSM.info sprintf("deleted all sessions that had not been accessed for more than %im %is", age / 60, age % 60)
         end
 			end
 		end
@@ -145,19 +149,19 @@ module SBSM
 		def unknown_user
 			self::class::UNKNOWN_USER.new
 		end
-		def [](key)
-			@mutex.synchronize {
-				unless((s = @sessions[key]) && !s.expired?)
-					args = [key, self]
-					if(klass = self::class::VALIDATOR)
-						args.push(klass.new)
-					end
-					s = @sessions[key] = self::class::SESSION.new(*args.compact)
-				end
-				s.reset()
-				s.touch()
-				s
-			}
-		end
+    def [](key)
+      @mutex.synchronize {
+        unless((s = @sessions[key]) && !s.expired?)
+          args = [key, self]
+          if(klass = self::class::VALIDATOR)
+            args.push(klass.new)
+          end
+          s = @sessions[key] = self::class::SESSION.new(*args.compact)
+        end
+        s.reset()
+        s.touch()
+        s
+      }
+    end
 	end
 end