rack 0.3.0 → 0.4.0

data/lib/rack/mock.rb

@@ -119,6 +119,7 @@ module Rack
         values.each { |value|
           @headers[field] = value
         }
+        @headers[field] = ""  if values.empty?
       }
 
       @body = ""

data/lib/rack/request.rb

@@ -24,6 +24,38 @@ module Rack
     def port;            @env["SERVER_PORT"].to_i                 end
     def request_method;  @env["REQUEST_METHOD"]                   end
     def query_string;    @env["QUERY_STRING"].to_s                end
+    def content_length;  @env['CONTENT_LENGTH']                   end
+    def content_type;    @env['CONTENT_TYPE']                     end
+
+    # The media type (type/subtype) portion of the CONTENT_TYPE header
+    # without any media type parameters. e.g., when CONTENT_TYPE is
+    # "text/plain;charset=utf-8", the media-type is "text/plain".
+    #
+    # For more information on the use of media types in HTTP, see:
+    # http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
+    def media_type
+      content_type && content_type.split(/\s*[;,]\s*/, 2)[0].downcase
+    end
+
+    # The media type parameters provided in CONTENT_TYPE as a Hash, or
+    # an empty Hash if no CONTENT_TYPE or media-type parameters were
+    # provided.  e.g., when the CONTENT_TYPE is "text/plain;charset=utf-8",
+    # this method responds with the following Hash:
+    #   { 'charset' => 'utf-8' }
+    def media_type_params
+      return {} if content_type.nil?
+      content_type.split(/\s*[;,]\s*/)[1..-1].
+        collect { |s| s.split('=', 2) }.
+        inject({}) { |hash,(k,v)| hash[k.downcase] = v ; hash }
+    end
+
+    # The character set of the request body if a "charset" media type
+    # parameter was given, or nil if no "charset" was specified. Note
+    # that, per RFC2616, text/* media types that specify no explicit
+    # charset are to be considered ISO-8859-1.
+    def content_charset
+      media_type_params['charset']
+    end
 
     def host
       # Remove port number.
@@ -37,6 +69,25 @@ module Rack
     def post?;           request_method == "POST"                 end
     def put?;            request_method == "PUT"                  end
     def delete?;         request_method == "DELETE"               end
+    def head?;           request_method == "HEAD"                 end
+
+    # The set of form-data media-types. Requests that do not indicate
+    # one of the media types presents in this list will not be eligible
+    # for form-data / param parsing.
+    FORM_DATA_MEDIA_TYPES = [
+      nil,
+      'application/x-www-form-urlencoded',
+      'multipart/form-data'
+    ]
+
+    # Determine whether the request body contains form-data by checking
+    # the request media_type against registered form-data media-types:
+    # "application/x-www-form-urlencoded" and "multipart/form-data". The
+    # list of form-data media types can be modified through the
+    # +FORM_DATA_MEDIA_TYPES+ array.
+    def form_data?
+      FORM_DATA_MEDIA_TYPES.include?(media_type)
+    end
 
     # Returns the data recieved in the query string.
     def GET
@@ -54,9 +105,9 @@ module Rack
     # This method support both application/x-www-form-urlencoded and
     # multipart/form-data.
     def POST
-      if @env["rack.request.form_input"] == @env["rack.input"]
+      if @env["rack.request.form_input"].eql? @env["rack.input"]
         @env["rack.request.form_hash"]
-      else
+      elsif form_data?
         @env["rack.request.form_input"] = @env["rack.input"]
         unless @env["rack.request.form_hash"] =
             Utils::Multipart.parse_multipart(env)
@@ -64,12 +115,16 @@ module Rack
           @env["rack.request.form_hash"] = Utils.parse_query(@env["rack.request.form_vars"])
         end
         @env["rack.request.form_hash"]
+      else
+        {}
       end
     end
 
     # The union of GET and POST data.
     def params
       self.GET.update(self.POST)
+    rescue EOFError => e
+      self.GET
     end
 
     # shortcut for request.params[key]
@@ -138,5 +193,17 @@ module Rack
       path << "?" << query_string  unless query_string.empty?
       path
     end
+
+    def accept_encoding
+      @env["HTTP_ACCEPT_ENCODING"].to_s.split(/,\s*/).map do |part|
+        m = /^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$/.match(part) # From WEBrick
+
+        if m
+          [m[1], (m[2] || 1.0).to_f]
+        else
+          raise "Invalid value for Accept-Encoding: #{part.inspect}"
+        end
+      end
+    end
   end
 end

data/lib/rack/session/abstract/id.rb

@@ -0,0 +1,140 @@
+# AUTHOR: blink <blinketje@gmail.com>; blink#ruby-lang@irc.freenode.net
+# bugrep: Andreas Zehnder
+
+require 'rack/utils'
+require 'time'
+
+module Rack
+  module Session
+    module Abstract
+      # ID sets up a basic framework for implementing an id based sessioning
+      # service. Cookies sent to the client for maintaining sessions will only
+      # contain an id reference. Only #get_session and #set_session should
+      # need to be overwritten.
+      #
+      # All parameters are optional.
+      # * :key determines the name of the cookie, by default it is
+      #   'rack.session'
+      # * :domain and :path set the related cookie values, by default
+      #   domain is nil, and the path is '/'.
+      # * :expire_after is the number of seconds in which the session
+      #   cookie will expire. By default it is set not to provide any
+      #   expiry time.
+      class ID
+        attr_reader :key
+        DEFAULT_OPTIONS = {
+          :key =>           'rack.session',
+          :path =>          '/',
+          :domain =>        nil,
+          :expire_after =>  nil
+        }
+
+        def initialize(app, options={})
+          @default_options = self.class::DEFAULT_OPTIONS.merge(options)
+          @key = @default_options[:key]
+          @default_context = context app
+        end
+
+        def call(env)
+          @default_context.call(env)
+        end
+
+        def context(app)
+          Rack::Utils::Context.new self, app do |env|
+            load_session env
+            response = app.call(env)
+            commit_session env, response
+            response
+          end
+        end
+
+        private
+
+        # Extracts the session id from provided cookies and passes it and the
+        # environment to #get_session. It then sets the resulting session into
+        # 'rack.session', and places options and session metadata into
+        # 'rack.session.options'.
+        def load_session(env)
+          sid           = (env['HTTP_COOKIE']||'')[/#{@key}=([^,;]+)/,1]
+          sid, session  = get_session(env, sid)
+          unless session.is_a?(Hash)
+            puts 'Session: '+sid.inspect+"\n"+session.inspect if $DEBUG
+            raise TypeError, 'Session not a Hash'
+          end
+
+          options = @default_options.
+            merge({ :id => sid, :by => self, :at => Time.now })
+
+          env['rack.session'] = session
+          env['rack.session.options'] = options
+
+          return true
+        end
+
+        # Acquires the session from the environment and the session id from
+        # the session options and passes them to #set_session. It then
+        # proceeds to set a cookie up in the response with the session's id.
+        def commit_session(env, response)
+          unless response.is_a?(Array)
+            puts 'Response: '+response.inspect if $DEBUG
+            raise ArgumentError, 'Response is not an array.'
+          end
+
+          options = env['rack.session.options']
+          unless options.is_a?(Hash)
+            puts 'Options: '+options.inspect if $DEBUG
+            raise TypeError, 'Options not a Hash'
+          end
+
+          sid, time, z = options.values_at(:id, :at, :by)
+          unless self == z
+            warn "#{self} not managing this session."
+            return
+          end
+
+          unless env['rack.session'].is_a?(Hash)
+            warn 'Session: '+sid.inspect+"\n"+session.inspect if $DEBUG
+            raise TypeError, 'Session not a Hash'
+          end
+
+          unless set_session(env, sid)
+            warn "Session not saved." if $DEBUG
+            warn "#{env['rack.session'].inspect} has been lost."if $DEBUG
+            return false
+          end
+
+          cookie = Utils.escape(@key)+'='+Utils.escape(sid)
+          cookie<< "; domain=#{options[:domain]}" if options[:domain]
+          cookie<< "; path=#{options[:path]}" if options[:path]
+          if options[:expire_after]
+            expiry = time + options[:expire_after]
+            cookie<< "; expires=#{expiry.httpdate}"
+          end
+
+          case a = (h = response[1])['Set-Cookie']
+          when Array then  a << cookie
+          when String then h['Set-Cookie'] = [a, cookie]
+          when nil then    h['Set-Cookie'] = cookie
+          end
+
+          return true
+        end
+
+        # Should return [session_id, session]. All thread safety and session
+        # retrival proceedures should occur here.
+        # If nil is provided as the session id, generation of a new valid id
+        # should occur within.
+        def get_session(env, sid)
+          raise '#get_session needs to be implemented.'
+        end
+
+        # All thread safety and session storage proceedures should occur here.
+        # Should return true or false dependant on whether or not the session
+        # was saved or not.
+        def set_session(env, sid)
+          raise '#set_session needs to be implemented.'
+        end
+      end
+    end
+  end
+end

data/lib/rack/session/memcache.rb

@@ -0,0 +1,97 @@
+# AUTHOR: blink <blinketje@gmail.com>; blink#ruby-lang@irc.freenode.net
+
+require 'rack/session/abstract/id'
+require 'memcache'
+
+module Rack
+  module Session
+    # Rack::Session::Memcache provides simple cookie based session management.
+    # Session data is stored in memcached. The corresponding session key is
+    # maintained in the cookie.
+    # You may treat Session::Memcache as you would Session::Pool with the
+    # following caveats.
+    #
+    # * Setting :expire_after to 0 would note to the Memcache server to hang
+    #   onto the session data until it would drop it according to it's own
+    #   specifications. However, the cookie sent to the client would expire
+    #   immediately.
+    #
+    # Note that memcache does drop data before it may be listed to expire. For
+    # a full description of behaviour, please see memcache's documentation.
+
+    class Memcache < Abstract::ID
+      attr_reader :mutex, :pool
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge({
+        :namespace => 'rack:session',
+        :memcache_server => 'localhost:11211'
+      })
+
+      def initialize(app, options={})
+        super
+        @pool = MemCache.new @default_options[:memcache_server], @default_options
+        unless @pool.servers.any?{|s|s.alive?}
+          raise "#{self} unable to find server during initialization."
+        end
+        @mutex = Mutex.new
+      end
+
+      private
+
+      def get_session(env, sid)
+        session = sid && @pool.get(sid)
+        unless session and session.is_a?(Hash)
+          session = {}
+          lc = 0
+          @mutex.synchronize do
+            begin
+              raise RuntimeError, 'Unique id finding looping excessively' if (lc+=1) > 1000
+              sid = "%08x" % rand(0xffffffff)
+              ret = @pool.add(sid, session)
+            end until /^STORED/ =~ ret
+          end
+        end
+        class << session
+          @deleted = []
+          def delete key
+            (@deleted||=[]) << key
+            super
+          end
+        end
+        [sid, session]
+      rescue MemCache::MemCacheError, Errno::ECONNREFUSED # MemCache server cannot be contacted
+        warn "#{self} is unable to find server."
+        warn $!.inspect
+        return [ nil, {} ]
+      end
+
+      def set_session(env, sid)
+        session = env['rack.session']
+        options = env['rack.session.options']
+        expiry  = options[:expire_after] || 0
+        o, s = @mutex.synchronize do
+          old_session = @pool.get(sid)
+          unless old_session.is_a?(Hash)
+            warn 'Session not properly initialized.' if $DEBUG
+            old_session = {}
+            @pool.add sid, old_session, expiry
+          end
+          session.instance_eval do
+            @deleted.each{|k| old_session.delete(k) } if defined? @deleted
+          end
+          @pool.set sid, old_session.merge(session), expiry
+          [old_session, session]
+        end
+        s.each do |k,v|
+          next unless o.has_key?(k) and v != o[k]
+          warn "session value assignment collision at #{k.inspect}:"+
+            "\n\t#{o[k].inspect}\n\t#{v.inspect}"
+        end if $DEBUG and env['rack.multithread']
+        return true
+      rescue MemCache::MemCacheError, Errno::ECONNREFUSED # MemCache server cannot be contacted
+        warn "#{self} is unable to find server."
+        warn $!.inspect
+        return false
+      end
+    end
+  end
+end

data/lib/rack/session/pool.rb

@@ -1,82 +1,73 @@
 # AUTHOR: blink <blinketje@gmail.com>; blink#ruby-lang@irc.freenode.net
+# THANKS:
+#   apeiros, for session id generation, expiry setup, and threadiness
+#   sergio, threadiness and bugreps
+
+require 'rack/session/abstract/id'
+require 'thread'
 
 module Rack
   module Session
     # Rack::Session::Pool provides simple cookie based session management.
-    # Session data is stored in a hash held by @pool. The corresponding
-    # session key sent to the client.
-    # The pool is unmonitored and unregulated, which means that over
-    # prolonged use the session pool will be very large.
+    # Session data is stored in a hash held by @pool.
+    # In the context of a multithreaded environment, sessions being
+    # committed to the pool is done in a merging manner.
     #
     # Example:
-    #
-    #     use Rack::Session::Pool, :key => 'rack.session',
-    #                              :domain => 'foo.com',
-    #                              :path => '/',
-    #                              :expire_after => 2592000
-    #
-    #     All parameters are optional.
+    #   myapp = MyRackApp.new
+    #   sessioned = Rack::Session::Pool.new(myapp,
+    #     :key => 'rack.session',
+    #     :domain => 'foo.com',
+    #     :path => '/',
+    #     :expire_after => 2592000
+    #   )
+    #   Rack::Handler::WEBrick.run sessioned
 
-    class Pool
-      attr_reader :pool, :key
+    class Pool < Abstract::ID
+      attr_reader :mutex, :pool
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.dup
 
       def initialize(app, options={})
-        @app = app
-        @key = options[:key] || "rack.session"
-        @default_options = {:domain => nil,
-          :path => "/",
-          :expire_after => nil}.merge(options)
+        super
         @pool = Hash.new
-        @default_context = context app, &nil
-      end
-
-
-      def call(env)
-        @default_context.call(env)
-      end
-
-      def context(app, &block)
-        Rack::Utils::Context.new self, app do |env|
-          load_session env
-          block[env] if block
-          response = app.call(env)
-          commit_session env, response
-          response
-        end
+        @mutex = Mutex.new
       end
 
       private
 
-      def load_session(env)
-        sess_id = env.fetch('HTTP_COOKIE','')[/#{@key}=([^,;]+)/,1]
-        begin
-          sess_id = Array.new(8){rand(16).to_s(16)}*''
-        end while @pool.key? sess_id if sess_id.nil? or !@pool.key? sess_id
-
-        session = @pool.fetch sess_id, {}
-        session.instance_variable_set '@dat', [sess_id, Time.now]
-
-        @pool.store sess_id, env['rack.session'] = session
-        env["rack.session.options"] = @default_options.dup
+      def get_session(env, sid)
+        session = @mutex.synchronize do
+          unless sess = @pool[sid] and ((expires = sess[:expire_at]).nil? or expires > Time.now)
+            @pool.delete_if{|k,v| expiry = v[:expire_at] and expiry < Time.now }
+            begin
+              sid = "%08x" % rand(0xffffffff)
+            end while @pool.has_key?(sid)
+          end
+          @pool[sid] ||= {}
+        end
+        [sid, session]
       end
 
-      def commit_session(env, response)
-        session = env['rack.session']
+      def set_session(env, sid)
         options = env['rack.session.options']
-        sdat    = session.instance_variable_get '@dat'
-
-        cookie = Utils.escape(@key)+'='+Utils.escape(sdat[0])
-        cookie<< "; domain=#{options[:domain]}" if options[:domain]
-        cookie<< "; path=#{options[:path]}" if options[:path]
-        cookie<< "; expires=#{sdat[1]+options[:expires_after]}" if options[:expires_after]
-
-        case a = (h = response[1])['Set-Cookie']
-        when Array then  a << cookie
-        when String then h['Set-Cookie'] = [a, cookie]
-        when nil then    h['Set-Cookie'] = cookie
+        expiry = options[:expire_after] && options[:at]+options[:expire_after]
+        @mutex.synchronize do
+          old_session = @pool[sid]
+          old_session[:expire_at] = expiry if expiry
+          session = old_session.merge(env['rack.session'])
+          @pool[sid] = session
+          session.each do |k,v|
+            next unless old_session.has_key?(k) and v != old_session[k]
+            warn "session value assignment collision at #{k}: #{old_session[k]} <- #{v}"
+          end if $DEBUG and env['rack.multithread']
         end
+        return true
+      rescue
+        warn "#{self} is unable to find server."
+        warn "#{env['rack.session'].inspect} has been lost."
+        warn $!.inspect
+        return false
       end
-
     end
   end
 end