racknga 0.9.2 → 0.9.3

data/doc/text/news.textile

@@ -1,5 +1,17 @@
 h1. NEWS
 
+h2. 0.9.3: 2011-11-12
+
+h3. Improvments
+
+  * [access-log-parser] Supported Apache log.
+  * [cache] Fixed unknown name errors.
+  * [cache] Fixed max age.
+  * [nginx] Added NginxRawURI middleware.
+  * [instance-name] Added branch name and Ruby version.
+  * [exception-mail-notifier] Used #message instead of #to_s.
+  * [logger] Logged also X-Runtime.
+
 h2. 0.9.2: 2011-08-07
 
 h3. Improvments

data/lib/racknga.rb

@@ -20,9 +20,10 @@ require 'rack'
 
 require 'racknga/version'
 require 'racknga/utils'
-require "racknga/nginx_access_log_parser"
+require "racknga/access_log_parser"
 require 'racknga/middleware/deflater'
 require 'racknga/middleware/exception_notifier'
 require 'racknga/middleware/jsonp'
 require 'racknga/middleware/range'
 require "racknga/middleware/instance_name"
+require "racknga/middleware/nginx_raw_uri"

data/lib/racknga/access_log_parser.rb

@@ -0,0 +1,147 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  Ryo Onodera <onodera@clear-code.com>
+# Copyright (C) 2011  Kouhei Sutou <kou@clear-code.com>
+#
+# 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
+
+require "racknga/log_entry"
+require "racknga/reverse_line_reader"
+
+module Racknga
+  # Supported formats:
+  #  * combined (nginx's default format)
+  #  * combined (Apache's predefined format)
+  #  * combined_with_time_nginx (custom format with runtime)
+  #  * combined_with_time_apache (custom format with runtime)
+  #
+  # Configurations:
+  #  * combined
+  #    * nginx
+  #      log_format combined '$remote_addr - $remote_user [$time_local]  '
+  #                          '"$request" $status $body_bytes_sent '
+  #                          '"$http_referer" "$http_user_agent"';
+  #      access_log log/access.log combined
+  #    * Apache
+  #      CustomLog ${APACHE_LOG_DIR}/access.log combined
+  #
+  #  * combined_with_time_nginx
+  #    * nginx
+  #      log_format combined_with_time '$remote_addr - $remote_user '
+  #                                    '[$time_local, $upstream_http_x_runtime, $request_time]  '
+  #                                    '"$request" $status $body_bytes_sent '
+  #                                    '"$http_referer" "$http_user_agent"';
+  #      access_log log/access.log combined_with_time
+  #
+  #  * combined_with_time_apache
+  #    * Apache
+  #      LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\" %{X-Runtime}o %D" combined_with_time
+  #      CustomLog ${APACHE_LOG_DIR}/access.log combined_with_time
+  class AccessLogParser
+    include Enumerable
+
+    class FormatError < StandardError
+    end
+
+    def initialize(line_reader)
+      @line_reader = line_reader
+    end
+
+    def each
+      @line_reader.each do |line|
+        line.force_encoding("UTF-8")
+        yield(parse_line(line)) if line.valid_encoding?
+      end
+    end
+
+    private
+    REMOTE_ADDRESS = "[^\\x20]+"
+    REMOTE_USER = "[^\\x20]+"
+    TIME_LOCAL = "[^\\x20]+\\x20\\+\\d{4}"
+    RUNTIME = "(?:[\\d.]+|-)"
+    REQUEST_TIME = "[\\d.]+"
+    REQUEST = ".*?"
+    STATUS = "\\d{3}"
+    BODY_BYTES_SENT = "(?:\\d+|-)"
+    HTTP_REFERER = ".*?"
+    HTTP_USER_AGENT = "(?:\\\"|[^\"])*?"
+    COMBINED_FORMAT =
+      /^(#{REMOTE_ADDRESS})\x20
+        -\x20
+        (#{REMOTE_USER})\x20
+        \[(#{TIME_LOCAL})(?:,\x20(.+))?\]\x20+
+        "(#{REQUEST})"\x20
+        (#{STATUS})\x20
+        (#{BODY_BYTES_SENT})\x20
+        "(#{HTTP_REFERER})"\x20
+        "(#{HTTP_USER_AGENT})"
+        (?:\x20(.+))?$/x
+    def parse_line(line)
+      case line
+      when COMBINED_FORMAT
+        last_match = Regexp.last_match
+        options = {}
+        options[:remote_address] = last_match[1]
+        options[:remote_user] = last_match[2]
+        options[:time_local] = parse_local_time(last_match[3])
+        if last_match[4]
+          if /\A(#{RUNTIME}), (#{REQUEST_TIME})\z/ =~ last_match[4]
+            time_match = Regexp.last_match
+            options[:runtime] = time_match[1]
+            options[:request_time] = time_match[2]
+          else
+            message = "expected 'RUNTIME, REQUEST_TIME' time format: " +
+                      "<#{last_match[4]}>: <#{line}>"
+            raise FormatError.new(message)
+          end
+        end
+        options[:request] = last_match[5]
+        options[:status] = last_match[6].to_i
+        options[:body_bytes_sent] = last_match[7]
+        options[:http_referer] = last_match[8]
+        options[:http_user_agent] = last_match[9]
+        if last_match[10]
+          if /\A(#{RUNTIME}) (#{REQUEST_TIME})\z/ =~ last_match[10]
+            time_match = Regexp.last_match
+            runtime = time_match[1]
+            request_time = time_match[2]
+            request_time = request_time.to_i * 0.000_001 if request_time
+            options[:runtime] = runtime
+            options[:request_time] = request_time
+          else
+            message = "expected 'RUNTIME REQUEST_TIME' time format: " +
+                      "<#{last_match[10]}>: <#{line}>"
+            raise FormatError.new(message)
+          end
+        end
+        LogEntry.new(options)
+      else
+        raise FormatError.new("unsupported format log entry: <#{line}>")
+      end
+    end
+
+    def parse_local_time(token)
+      day, month, year, hour, minute, second, _time_zone = token.split(/[\/: ]/)
+      _ = _time_zone # FIXME: suppress a warning. :<
+      Time.local(year, month, day, hour, minute, second)
+    end
+  end
+
+  class ReversedAccessLogParser < AccessLogParser
+    def initialize(line_reader)
+      @line_reader = ReverseLineReader.new(line_reader)
+    end
+  end
+end

data/lib/racknga/cache_database.rb

@@ -53,17 +53,27 @@ module Racknga
     # process from your Rack application
     # process. (e.g. cron.) It's multi process safe.
     def purge_old_responses
-      age_modulo = 2 ** 32
+      age_modulo = 2 ** 31 - 1
       age = configuration.age
       previous_age = (age - 1).modulo(age_modulo)
-      configuration.age = (age + 1).modulo(age_modulo)
+      next_age = (age + 1).modulo(age_modulo)
 
       target_responses = responses.select do |record|
-        record.age == previous_age
+        record.age == next_age
       end
       target_responses.each do |response|
         response.key.delete
       end
+      configuration.age = next_age
+
+      target_responses = responses.select do |record|
+        record.age <= previous_age
+      end
+      target_responses.each do |response|
+        response.key.delete
+      end
+
+      responses.defrag if responses.respond_to?(:defrag)
     end
 
     def ensure_database

data/lib/racknga/exception_mail_notifier.rb

@@ -149,7 +149,7 @@ Timestamp: #{Time.now.rfc2822}
 --
 URL: #{request.url}
 --
-#{exception.class}: #{exception}
+#{exception.class}: #{exception.message}
 EOB
     end
 

data/lib/racknga/log_database.rb

@@ -95,6 +95,7 @@ module Racknga
           table.reference("path", "Paths")
           table.reference("user_agent", "UserAgents")
           table.float("runtime")
+          table.float("request_time")
           table.short_text("message", :compress => :zlib)
         end
 

data/lib/racknga/log_entry.rb

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  Ryo Onodera <onodera@clear-code.com>
+# Copyright (C) 2011  Kouhei Sutou <kou@clear-code.com>
+#
+# 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
+
+module Racknga
+  class LogEntry
+    ATTRIBUTES = [
+      :remote_address,
+      :remote_user,
+      :time_local,
+      :runtime,
+      :request_time,
+      :request,
+      :status,
+      :body_bytes_sent,
+      :http_referer,
+      :http_user_agent,
+    ]
+
+    attr_reader(*ATTRIBUTES)
+    def initialize(options=nil)
+      options ||= {}
+      @remote_address = options[:remote_address]
+      @remote_user = normalize_string_value(options[:remote_user])
+      @time_local = options[:time_local] || Time.at(0)
+      @runtime = normalize_float_value(options[:runtime])
+      @request_time = normalize_float_value(options[:request_time])
+      @request = options[:request]
+      @status = options[:status]
+      @body_bytes_sent = normalize_int_value(options[:body_bytes_sent])
+      @http_referer = normalize_string_value(options[:http_referer])
+      @http_user_agent = normalize_string_value(options[:http_user_agent])
+    end
+
+    def attributes
+      ATTRIBUTES.collect do |attribute|
+        __send__(attribute)
+      end
+    end
+
+    def ==(other)
+      other.is_a?(self.class) and attributes == other.attributes
+    end
+
+    private
+    def normalize_string_value(value)
+      if value.nil? or value == "-"
+        nil
+      else
+        value.to_s
+      end
+    end
+
+    def normalize_float_value(value)
+      if value.nil?
+        value
+      else
+        value.to_f
+      end
+    end
+
+    def normalize_int_value(value)
+      if value.nil? or value == "-"
+        nil
+      else
+        value.to_i
+      end
+    end
+  end
+end

data/lib/racknga/middleware/cache.rb

@@ -221,9 +221,9 @@ module Racknga
       def log(tag, request)
         return unless Middleware.const_defined?(:Log)
         env = request.env
-        logger = env[Middleware::Log::LOGGER_KEY]
+        logger = env[Middleware::Log::LOGGER]
         return if logger.nil?
-        start_time = env[START_TIME_KEY]
+        start_time = env[START_TIME]
         runtime = Time.now - start_time
         logger.log("cache-#{tag}", request.fullpath, :runtime => runtime)
       end

data/lib/racknga/middleware/deflater.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2011  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -63,7 +63,7 @@ module Racknga
 
       # For Rack.
       def call(environment)
-        if ie6?(environment)
+        if ie6?(environment) or not valid_accept_encoding?(environment)
           @application.call(environment)
         else
           @deflater.call(environment)
@@ -74,6 +74,16 @@ module Racknga
       def ie6?(environment)
         /MSIE 6.0;/ =~ (environment["HTTP_USER_AGENT"] || '')
       end
+
+      def valid_accept_encoding?(environment)
+        request = Rack::Request.new(environment)
+        begin
+          request.accept_encoding
+          true
+        rescue
+          false
+        end
+      end
     end
   end
 end

data/lib/racknga/middleware/exception_notifier.rb

@@ -26,7 +26,6 @@ module Racknga
     #
     # Usage:
     #   require "racknga"
-    #   require "racknga/middleware/exception_notifier"
     #
     #   notifier_options = {
     #     :subject_label => "[YourApplication]",

data/lib/racknga/middleware/instance_name.rb

@@ -68,6 +68,23 @@ module Racknga
         `id --user --name`.strip
       end
 
+      CURRENT_BRANCH_MARKER = /\A\* /
+      def branch
+        current_branch = nil
+        `git branch -a`.each_line do |line|
+          case line
+          when CURRENT_BRANCH_MARKER
+            current_branch = line.sub(CURRENT_BRANCH_MARKER, "").strip
+            break
+          end
+        end
+        current_branch
+      end
+
+      def ruby
+        RUBY_DESCRIPTION
+      end
+
       private
       DEFAULT_HEADER_NAME = "X-Responsed-By"
       def header_name
@@ -83,9 +100,10 @@ module Racknga
       def construct_header
         format_header(format_application_name(application_name),
                       format_version(version),
-                      format_revision(revision),
+                      format_revision(branch, revision),
                       format_server(server),
-                      format_user(user))
+                      format_user(user),
+                      format_ruby(ruby))
       end
 
       def format_header(*arguments)
@@ -104,9 +122,15 @@ module Racknga
         end
       end
 
-      def format_revision(revision)
+      def format_revision(branch, revision)
         format_if_possible(revision) do
-          "(at #{revision})"
+          "(at #{revision}#{format_branch(branch)})"
+        end
+      end
+
+      def format_branch(branch)
+        format_if_possible(branch) do
+          " (#{branch})"
         end
       end
 
@@ -122,12 +146,18 @@ module Racknga
         end
       end
 
+      def format_ruby(ruby)
+        format_if_possible(ruby) do
+          "with #{ruby}"
+        end
+      end
+
       def format_if_possible(data)
         if data and (data.respond_to?(:to_s) and not data.to_s.empty?)
-          result = yield
+          yield
+        else
+          nil
         end
-
-        result
       end
     end
   end

data/lib/racknga/middleware/jsonp.rb

@@ -125,6 +125,7 @@ module Racknga
       def update_content_type(header_hash)
         content_type = header_hash["Content-Type"]
         media_type, parameters = content_type.split(/\s*;\s*/, 2)
+        _ = media_type # FIXME: suppress a warning. :<
         # We should use application/javascript not
         # text/javascript when all IE <= 8 are deprecated. :<
         updated_content_type = ["text/javascript", parameters].compact.join("; ")

data/lib/racknga/middleware/log.rb

@@ -70,9 +70,12 @@ module Racknga
       private
       def log(start_time, end_time, request, status, headers, body)
         request_time = end_time - start_time
+        runtime = headers["X-Runtime"]
+        runtime_in_float = nil
+        runtime_in_float = runtime.to_f if runtime
         length = headers["Content-Length"] || "-"
         length = "-" if length == "0"
-        format = "%s - %s [%s] \"%s %s %s\" %s %s \"%s\" \"%s\" %0.8f"
+        format = "%s - %s [%s] \"%s %s %s\" %s %s \"%s\" \"%s\" %s %0.8f"
         message = format % [request.ip || "-",
                             request.env["REMOTE_USER"] || "-",
                             end_time.dup.utc.strftime("%d/%b/%Y:%H:%M:%S %z"),
@@ -83,12 +86,14 @@ module Racknga
                             length,
                             request.env["HTTP_REFERER"] || "-",
                             request.user_agent || "-",
+                            runtime || "-",
                             request_time]
         @logger.log("access",
                     request.fullpath,
                     :message => message,
                     :user_agent => request.user_agent,
-                    :runtime => request_time)
+                    :runtime => runtime_in_float,
+                    :request_time => request_time)
       end
 
       # @private

data/lib/racknga/middleware/nginx_raw_uri.rb

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  Ryo Onodera <onodera@clear-code.com>
+#
+# 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
+
+module Racknga
+  module Middleware
+    # NOTE:
+    # This is a middleware that restores the unprocessed URI client requests
+    # as is. Usually, nginx-passenger stack unescapes percent encoding in URI
+    # and resolve relative paths (ie "." and "..").
+    # Most of time, processed URI isn't program. However, if you want to
+    # distinguish %2F (ie "/") from "/", it is.
+    #
+    # Passenger 3.x or later is required.
+    #
+    # Use this with following nginx configuration:
+    #
+    #   ... {
+    #      ...
+    #      passenger_set_cgi_param HTTP_X_RAW_REQUEST_URI $request_uri;
+    #   }
+    #
+    # Usage:
+    #   require "racknga"
+    #   use Racknga::Middleware::NginxRawURI
+    #   run YourApplication
+    class NginxRawURI
+      RAW_REQUEST_URI_HEADER_NAME = "HTTP_X_RAW_REQUEST_URI"
+      def initialize(application)
+        @application = application
+      end
+
+      # For Rack.
+      def call(environment)
+        raw_uri = environment[RAW_REQUEST_URI_HEADER_NAME]
+
+        if raw_uri
+          restore_raw_uri(environment, raw_uri)
+        end
+
+        @application.call(environment)
+      end
+
+      private
+      def restore_raw_uri(environment, raw_uri)
+        environment["PATH_INFO"] = raw_uri.split("?").first
+        environment["REQUEST_URI"] = raw_uri
+      end
+    end
+  end
+end

data/lib/racknga/version.rb

@@ -17,5 +17,5 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 module Racknga
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
 end

data/test/{test-nginx-log-parser.rb → test-access-log-parser.rb}

@@ -19,30 +19,33 @@
 
 require 'stringio'
 
-module NginxAccessLogParserTests
+module AccessLogParserTests
   module Data
     private
-    def time_log_component
-      times = ["03/Aug/2011:16:58:01 +0900", runtime, request_time].compact
-      "[#{times.join(', ')}]"
+    def time_local
+      "03/Aug/2011:16:58:01 +0900"
+    end
+
+    def log_line(content)
+      content
     end
 
     def usual_log_line
-      "127.0.0.1 - - #{time_log_component}  " +
-        "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
     end
 
     def usual_log_entry_options
       {
         :remote_address => "127.0.0.1",
-        :remote_user => "-",
+        :remote_user => nil,
         :time_local => Time.local(2011, 8, 3, 16, 58, 1),
         :runtime => runtime,
         :request_time => request_time,
         :request => "GET / HTTP/1.1",
         :status => 200,
         :body_bytes_sent => 613,
-        :http_referer => "-",
+        :http_referer => nil,
         :http_user_agent => "Ruby",
       }
     end
@@ -52,8 +55,8 @@ module NginxAccessLogParserTests
     end
 
     def not_found_log_line
-      "127.0.0.1 - - #{time_log_component}  " +
-        "\"GET /the-truth.html HTTP/1.1\" 404 613 \"-\" \"Ruby\""
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET /the-truth.html HTTP/1.1\" 404 613 \"-\" \"Ruby\"")
     end
 
     def not_found_log_entry
@@ -71,8 +74,8 @@ module NginxAccessLogParserTests
     def valid_utf8_log_line
       path = utf8_path
 
-      "127.0.0.1 - - #{time_log_component}  " +
-        "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
     end
 
     def valid_utf8_log_entry
@@ -90,8 +93,41 @@ module NginxAccessLogParserTests
     def invalid_utf8_log_line
       path = garbled_path
 
-      "127.0.0.1 - - #{time_log_component}  " +
-        "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
+    end
+
+    def ipv6_log_line
+      log_line("::1 - - #{time_log_component}  " +
+               "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
+    end
+
+    def ipv6_log_entry
+      options = {
+        :remote_address => "::1",
+      }
+      create_log_entry(usual_log_entry_options.merge(options))
+    end
+
+    def apache_combined_log_line
+      log_line("127.0.0.1 - - #{time_log_component} " +
+               "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
+    end
+
+    def apache_combined_log_entry
+      usual_log_entry
+    end
+
+    def no_body_bytes_sent_log_line
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET / HTTP/1.1\" 200 - \"-\" \"Ruby\"")
+    end
+
+    def no_body_bytes_sent_log_entry
+      options = {
+        :body_bytes_sent => nil,
+      }
+      create_log_entry(usual_log_entry_options.merge(options))
     end
 
     def bad_log_line
@@ -110,11 +146,11 @@ module NginxAccessLogParserTests
     end
 
     def create_log_parser(file)
-      Racknga::NginxAccessLogParser.new(file)
+      Racknga::AccessLogParser.new(file)
     end
 
     def create_reversed_log_parser(file)
-      Racknga::ReversedNginxAccessLogParser.new(file)
+      Racknga::ReversedAccessLogParser.new(file)
     end
 
     def join_lines(*lines)
@@ -137,18 +173,36 @@ module NginxAccessLogParserTests
   end
 
   module Tests
-    def test_usual_nginx_access_log
+    def test_usual_log
       accesses = parse(join_lines(usual_log_line))
-      access = accesses.first
-      assert_equal(usual_log_entry, access)
+      assert_equal([usual_log_entry],
+                   accesses)
     end
 
-    def test_no_access_log
+    def test_ipv6_log
+      accesses = parse(join_lines(ipv6_log_line))
+      assert_equal([ipv6_log_entry],
+                   accesses)
+    end
+
+    def test_apache_combined_log
+      accesses = parse(join_lines(apache_combined_log_line))
+      assert_equal([apache_combined_log_entry],
+                   accesses)
+    end
+
+    def test_no_body_bytes_sent_log
+      accesses = parse(join_lines(no_body_bytes_sent_log_line))
+      assert_equal([no_body_bytes_sent_log_entry],
+                   accesses)
+    end
+
+    def test_no_log
       accesses = parse(join_lines())
       assert_equal([], accesses)
     end
 
-    def test_multiple_nginx_access_log
+    def test_multiple_logs
       accesses = parse(join_lines(usual_log_line,
                                   usual_log_line,
                                   not_found_log_line))
@@ -158,7 +212,7 @@ module NginxAccessLogParserTests
                    accesses)
     end
 
-    def test_reversed_nginx_access_log
+    def test_reversed_parse
       accesses = reversed_parse(join_lines(usual_log_line,
                                            usual_log_line,
                                            not_found_log_line))
@@ -168,8 +222,8 @@ module NginxAccessLogParserTests
                    accesses)
     end
 
-    def test_bad_nginx_access_log
-      assert_raise(Racknga::NginxAccessLogParser::FormatError) do
+    def test_bad_log
+      assert_raise(Racknga::AccessLogParser::FormatError) do
         parse(join_lines(bad_log_line))
       end
     end
@@ -189,6 +243,12 @@ module NginxAccessLogParserTests
     include Data
     include Tests
 
+    private
+    def time_log_component
+      times = [time_local, runtime, request_time].compact
+      "[#{times.join(', ')}]"
+    end
+
     def runtime
       nil
     end
@@ -198,11 +258,40 @@ module NginxAccessLogParserTests
     end
   end
 
-  class CombinedWithTimeLogTest < Test::Unit::TestCase
+  class CombinedWithTimeNginxLogTest < Test::Unit::TestCase
+    include Environment
+    include Data
+    include Tests
+
+    private
+    def time_log_component
+      times = [time_local, runtime, request_time].compact
+      "[#{times.join(', ')}]"
+    end
+
+    def runtime
+      0.000573
+    end
+
+    def request_time
+      0.001
+    end
+  end
+
+  class CombinedWithTimeApacheLogTest < Test::Unit::TestCase
     include Environment
     include Data
     include Tests
 
+    private
+    def time_log_component
+      "[#{time_local}]"
+    end
+
+    def log_line(content)
+      "#{content} #{runtime} #{(request_time * 1_000_000).to_i}"
+    end
+
     def runtime
       0.000573
     end

data/test/test-middleware-instance-name.rb

@@ -18,39 +18,35 @@ class InstanceNameTest < Test::Unit::TestCase
   include RackngaTestUtils
 
   def test_no_option
-    server = default_instance_name.server
-    user = default_instance_name.user
-    revision = default_instance_name.revision
+    footer_variables = extract_from_default_instance_name
 
     instance_name_options({}) do
       request
-      assert_header("Proc (at #{revision}) on #{server} by #{user}")
+      assert_header("Proc #{default_footer(*footer_variables)}")
     end
   end
 
   def test_application_name
     application_name = "HelloWorld"
-    server = default_instance_name.server
-    user = default_instance_name.user
-    revision = default_instance_name.revision
+    footer_variables = extract_from_default_instance_name
 
     instance_name_options(:application_name => application_name) do
       request
-      assert_header("#{application_name} (at #{revision}) on #{server} by #{user}")
+      assert_header("#{application_name} " +
+                    "#{default_footer(*footer_variables)}")
     end
   end
 
   def test_both_application_name_and_version
     application_name = "HelloWorld"
     version = 1
-    server = default_instance_name.server
-    user = default_instance_name.user
-    revision = default_instance_name.revision
+    footer_variables = extract_from_default_instance_name
 
     instance_name_options(:application_name => application_name,
                           :version => version) do
       request
-      assert_header("#{application_name} v#{version} (at #{revision}) on #{server} by #{user}")
+      assert_header("#{application_name} v#{version} " +
+                    "#{default_footer(*footer_variables)}")
     end
   end
 
@@ -72,7 +68,22 @@ class InstanceNameTest < Test::Unit::TestCase
   end
 
   def default_instance_name
-    @default_instance_name ||= create_instance_name(create_minimal_application).freeze
+    @default_instance_name ||=
+      create_instance_name(create_minimal_application).freeze
+  end
+
+  def extract_from_default_instance_name
+    server = default_instance_name.server
+    user = default_instance_name.user
+    revision = default_instance_name.revision
+    branch = default_instance_name.branch
+    ruby = default_instance_name.ruby
+
+    [server, user, revision, branch, ruby]
+  end
+
+  def default_footer(server, user, revision, branch, ruby)
+    "(at #{revision} (#{branch})) on #{server} by #{user} with #{ruby}"
   end
 
   def create_minimal_application
@@ -93,6 +104,7 @@ class InstanceNameTest < Test::Unit::TestCase
   end
 
   def assert_header(expected_header)
-    assert_equal(expected_header, page.response_headers["X-Responsed-By"])
+    actual_header = page.response_headers["X-Responsed-By"]
+    assert_equal(expected_header, actual_header)
   end
 end

data/test/test-middleware-nginx-raw-uri.rb

@@ -0,0 +1,70 @@
+# Copyright (C) 2011  Ryo Onodera <onodera@clear-code.com>
+#
+# 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
+
+class NginxRawURITest < Test::Unit::TestCase
+  include RackngaTestUtils
+
+  class PseudoNginx
+    def initialize(application)
+      @application = application
+    end
+
+    def call(environment)
+      mimic_nginx_behavior(environment)
+
+      @application.call(environment)
+    end
+
+    private
+    def mimic_nginx_behavior(environment)
+      environment["HTTP_X_RAW_REQUEST_URI"] = environment["PATH_INFO"]
+      environment["PATH_INFO"] = Rack::Utils.unescape(environment["PATH_INFO"])
+    end
+  end
+
+  def app
+    application = Proc.new do |environment|
+      @environment = environment
+
+      response
+    end
+
+    raw_uri = Racknga::Middleware::NginxRawURI.new(application)
+    pseudo_nginx = PseudoNginx.new(raw_uri)
+
+    pseudo_nginx
+  end
+
+  def setup
+    Capybara.app = app
+  end
+
+  def test_slash
+    path_info_with_slash = "/keywords/GNU%2fLinux"
+
+    visit(path_info_with_slash)
+    assert_equal(path_info_with_slash, path_info)
+  end
+
+  private
+  def response
+    [200, {"Content-Type" => "plain/text"}, ["this is a response."]]
+  end
+
+  def path_info
+    @environment["PATH_INFO"]
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: racknga
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: 
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - Kouhei Sutou
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-06 00:00:00 Z
+date: 2011-11-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -145,17 +145,19 @@ files:
 - Rakefile
 - doc/text//news.textile
 - lib/racknga.rb
+- lib/racknga/access_log_parser.rb
 - lib/racknga/cache_database.rb
 - lib/racknga/exception_mail_notifier.rb
 - lib/racknga/log_database.rb
+- lib/racknga/log_entry.rb
 - lib/racknga/middleware/cache.rb
 - lib/racknga/middleware/deflater.rb
 - lib/racknga/middleware/exception_notifier.rb
 - lib/racknga/middleware/instance_name.rb
 - lib/racknga/middleware/jsonp.rb
 - lib/racknga/middleware/log.rb
+- lib/racknga/middleware/nginx_raw_uri.rb
 - lib/racknga/middleware/range.rb
-- lib/racknga/nginx_access_log_parser.rb
 - lib/racknga/reverse_line_reader.rb
 - lib/racknga/utils.rb
 - lib/racknga/version.rb
@@ -166,10 +168,11 @@ files:
 - test/test-middleware-jsonp.rb
 - test/racknga-test-utils.rb
 - test/test-middleware-range.rb
+- test/test-middleware-nginx-raw-uri.rb
 - test/run-test.rb
 - test/test-middleware-instance-name.rb
 - test/test-middleware-cache.rb
-- test/test-nginx-log-parser.rb
+- test/test-access-log-parser.rb
 homepage: http://groonga.rubyforge.org/
 licenses: 
 - LGPLv2.1 or later
@@ -199,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: groonga
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A Rack middleware collection for rroonga features.
@@ -207,7 +210,8 @@ test_files:
 - test/test-middleware-jsonp.rb
 - test/racknga-test-utils.rb
 - test/test-middleware-range.rb
+- test/test-middleware-nginx-raw-uri.rb
 - test/run-test.rb
 - test/test-middleware-instance-name.rb
 - test/test-middleware-cache.rb
-- test/test-nginx-log-parser.rb
+- test/test-access-log-parser.rb

data/lib/racknga/nginx_access_log_parser.rb

@@ -1,139 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2011  Ryo Onodera <onodera@clear-code.com>
-#
-# 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
-
-require "racknga/reverse_line_reader"
-
-module Racknga
-  # Supported formats:
-  #  * combined (default format)
-  #  * combined_with_time (custom format for Passenger)
-  #
-  # Configurations in nginx:
-  #  * combined
-  #    log_format combined '$remote_addr - $remote_user [$time_local]  '
-  #                        '"$request" $status $body_bytes_sent '
-  #                        '"$http_referer" "$http_user_agent"';
-  #    access_log log/access.log combined
-  #
-  #  * combined_with_time
-  #    log_format combined_with_time '$remote_addr - $remote_user '
-  #                                  '[$time_local, $upstream_http_x_runtime, $request_time]  '
-  #                                  '"$request" $status $body_bytes_sent '
-  #                                  '"$http_referer" "$http_user_agent"';
-  #    access_log log/access.log combined_with_time
-  class NginxAccessLogParser
-    include Enumerable
-
-    class FormatError < StandardError
-    end
-
-    def initialize(line_reader)
-      @line_reader = line_reader
-    end
-
-    def each
-      @line_reader.each do |line|
-        line.force_encoding("UTF-8")
-        yield(parse_line(line)) if line.valid_encoding?
-      end
-    end
-
-    REMOTE_ADDRESS = '(?:\d{1,3}\.){3}\d{1,3}'
-    REMOTE_USER = '[^ ]+'
-    TIME_LOCAL = '[^ ]+ \+\d{4}'
-    RUNTIME = '(?:[\d.]+|-)'
-    REQUEST_TIME = '[\d.]+'
-    REQUEST = '.*?'
-    STATUS = '\d{3}'
-    BODY_BYTES_SENT = '\d+'
-    HTTP_REFERER = '.*?'
-    HTTP_USER_AGENT = '(?:\\"|[^\"])*?' # '
-    LOG_FORMAT =
-      /\A(#{REMOTE_ADDRESS}) - (#{REMOTE_USER}) \[(#{TIME_LOCAL})(?:, (#{RUNTIME}), (#{REQUEST_TIME}))?\]  "(#{REQUEST})" (#{STATUS}) (#{BODY_BYTES_SENT}) "(#{HTTP_REFERER})" "(#{HTTP_USER_AGENT})"\n\z/
-    def parse_line(line)
-      if line =~ LOG_FORMAT
-        last_match = Regexp.last_match
-        options = {}
-        options[:remote_address] = last_match[1]
-        options[:remote_user] = last_match[2]
-        parse_time_local(last_match[3], options)
-        options[:runtime] = last_match[4].to_f
-        options[:request_time] = last_match[5].to_f
-        options[:request] = last_match[6]
-        options[:status] = last_match[7].to_i
-        options[:body_bytes_sent] = last_match[8].to_i
-        options[:http_referer] = last_match[9]
-        options[:http_user_agent] = last_match[10]
-        LogEntry.new(options)
-      else
-        raise FormatError.new("ill-formatted log entry: #{line.inspect} !~ #{LOG_FORMAT}")
-      end
-    end
-
-    def parse_time_local(token, options)
-      day, month, year, hour, minute, second, _time_zone = token.split(/[\/: ]/)
-      options[:time_local] = Time.local(year, month, day, hour, minute, second)
-    end
-  end
-
-  class ReversedNginxAccessLogParser < NginxAccessLogParser
-    def initialize(line_reader)
-      @line_reader = ReverseLineReader.new(line_reader)
-    end
-  end
-
-  class LogEntry
-    ATTRIBUTES = [
-      :remote_address,
-      :remote_user,
-      :time_local,
-      :runtime,
-      :request_time,
-      :request,
-      :status,
-      :body_bytes_sent,
-      :http_referer,
-      :http_user_agent,
-    ]
-
-    attr_reader(*ATTRIBUTES)
-    def initialize(options=nil)
-      options ||= {}
-      @remote_address = options[:remote_address]
-      @remote_user = options[:remote_user]
-      @time_local = options[:time_local] || Time.at(0)
-      @runtime = options[:runtime] || 0.0
-      @request_time = options[:request_time] || 0.0
-      @request = options[:request]
-      @status = options[:status]
-      @body_bytes_sent = options[:body_bytes_sent]
-      @http_referer = options[:http_referer]
-      @http_user_agent = options[:http_user_agent]
-    end
-
-    def attributes
-      ATTRIBUTES.collect do |attribute|
-        __send__(attribute)
-      end
-    end
-
-    def ==(other)
-      attributes == other.attributes
-    end
-  end
-end