clogger 0.0.3 → 0.0.4

data/GNUmakefile

@@ -72,6 +72,7 @@ release: package Manifest.txt $(release_notes) $(release_changes)
 	  clogger clogger $(VERSION) pkg/clogger-$(VERSION).tgz
 	rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
 	  clogger clogger_ext $(VERSION) pkg/clogger_ext-$(VERSION).gem
+	rake post_news
 endif
 
 .PHONY: test doc Manifest.txt release

data/History.txt

@@ -1,3 +1,19 @@
+=== 0.0.4 / 2009-09-02
+
+    The pure Ruby version now escapes with uppercase A-F
+    characters to match nginx log output.  There are now extra
+    checks against badly behaving Rack applications and 500
+    errors will be logged before TypeError is raised if the
+    application response does not conform (minimally) to Rack
+    expectations.  Finally, handling of $request (requests
+    without "HTTP_VERSION" set in the Rack env) should now be
+    logged correctly without unnecessary trailing characters.
+
+    Hackers: the primary git repository has been moved to
+    git://git.bogomips.org/clogger.git for now since I'm having
+    issues with pushing to Rubyforge (seems related to Support
+    Requests item #26185).
+
 === 0.0.3 / 2009-08-29
 
     The MRI extension clogger_ext gets GC bug fix and

data/README.txt

@@ -78,13 +78,13 @@ somewhere inside the "Rails::Initializer.run do |config|" block:
 
 The latest development happens in git and is published to the following:
 
-   git://rubyforge.org/clogger.git
-   git://git.bogomips.org/mirrors/clogger.git
+   git://git.bogomips.org/clogger.git
+   git://repo.or.cz/clogger.git
 
 You may also browse and download snapshot tarballs:
 
-* http://clogger.rubyforge.org/git?p=clogger.git (gitweb)
-* http://git.bogomips.org/cgit/mirrors/clogger.git (cgit)
+* http://git.bogomips.org/cgit/clogger.git (cgit)
+* http://repo.or.cz/w/clogger.git (gitweb)
 
 The mailing list (see below) is central for coordination and
 development.  Patches should always be sent inline

data/ext/clogger_ext/clogger.c

@@ -55,7 +55,7 @@ enum clogger_special {
 	CL_SP_response_length,
 	CL_SP_ip,
 	CL_SP_pid,
-	CL_SP_request_uri,
+	CL_SP_request_uri
 };
 
 struct clogger {
@@ -185,7 +185,7 @@ static int str_case_eq(VALUE a, VALUE b)
 struct response_ops { long nr; VALUE ops; };
 
 /* this can be worse than O(M*N) :<... but C loops are fast ... */
-static VALUE swap_sent_headers(VALUE kv, VALUE memo)
+static VALUE swap_sent_headers_unsafe(VALUE kv, VALUE memo)
 {
 	struct response_ops *tmp = (struct response_ops *)memo;
 	VALUE key = rb_obj_as_string(RARRAY_PTR(kv)[0]);
@@ -214,6 +214,15 @@ static VALUE swap_sent_headers(VALUE kv, VALUE memo)
 	return Qnil;
 }
 
+static VALUE swap_sent_headers(VALUE kv, VALUE memo)
+{
+	if (TYPE(kv) != T_ARRAY)
+		rb_raise(rb_eTypeError, "headers not returning pairs");
+	if (RARRAY_LEN(kv) < 2)
+		rb_raise(rb_eTypeError, "headers not returning pairs");
+	return swap_sent_headers_unsafe(kv, memo);
+}
+
 static VALUE sent_headers_ops(struct clogger *c)
 {
 	struct response_ops tmp;
@@ -452,12 +461,12 @@ static void append_request(struct clogger *c)
 
 	append_request_uri(c);
 
-	rb_str_buf_append(c->log_buf, g_space);
-
 	/* HTTP_VERSION can be injected by malicious clients */
 	tmp = rb_hash_aref(c->env, g_HTTP_VERSION);
-	if (!NIL_P(tmp))
+	if (!NIL_P(tmp)) {
+		rb_str_buf_append(c->log_buf, g_space);
 		rb_str_buf_append(c->log_buf, byte_xs(tmp));
+	}
 }
 
 static void append_request_length(struct clogger *c)

data/lib/clogger.rb

@@ -1,6 +1,6 @@
 # -*- encoding: binary -*-
 class Clogger
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
   OP_LITERAL = 0
   OP_REQUEST = 1

data/lib/clogger/pure.rb

@@ -62,7 +62,7 @@ private
   def byte_xs(s)
     s = s.dup
     s.force_encoding(Encoding::BINARY) if defined?(Encoding::BINARY)
-    s.gsub!(/(['"\x00-\x1f])/) { |x| "\\x#{$1.unpack('H2').first}" }
+    s.gsub!(/(['"\x00-\x1f])/) { |x| "\\x#{$1.unpack('H2').first.upcase}" }
     s
   end
 
@@ -83,11 +83,11 @@ private
       status = status.to_i
       status >= 100 && status <= 999 ? ('%03d' % status) : '-'
     when :request
+      version = env['HTTP_VERSION'] and version = " #{byte_xs(version)}"
       qs = env['QUERY_STRING']
       qs.empty? or qs = "?#{byte_xs(qs)}"
       "#{env['REQUEST_METHOD']} " \
-        "#{request_uri(env)} " \
-        "#{byte_xs(env['HTTP_VERSION'])}"
+        "#{request_uri(env)}#{version}"
     when :request_uri
       request_uri(env)
     when :request_length
@@ -133,7 +133,12 @@ private
   end
 
   def get_sent_header(headers, match)
-    headers.each { |key, value| match == key.downcase and return value }
+    headers.each do |pair|
+      Array === pair && pair.size >= 2 or
+        raise TypeError, "headers not returning pairs"
+      key, value = pair
+      match == key.downcase and return value
+    end
     "-"
   end
 

data/test/test_clogger.rb

@@ -333,6 +333,18 @@ class TestClogger < Test::Unit::TestCase
     assert_equal expect, str.string
   end
 
+  # rack allows repeated headers with "\n":
+  # { 'Set-Cookie' => "a\nb" } =>
+  #   Set-Cookie: a
+  #   Set-Cookie: b
+  def test_escape_header_newlines
+    str = StringIO.new
+    app = lambda { |env| [302, { 'Set-Cookie' => "a\nb" }, [] ] }
+    cl = Clogger.new(app, :logger => str, :format => '$sent_http_set_cookie')
+    cl.call(@req)
+    assert_equal "a\\x0Ab\n", str.string
+  end
+
   def test_request_uri_fallback
     str = StringIO.new
     app = lambda { |env| [ 200, {}, [] ] }
@@ -373,4 +385,21 @@ class TestClogger < Test::Unit::TestCase
     assert_match %r{#{e}$}m, str
   end
 
+  def test_broken_header_response
+    str = StringIO.new
+    app = lambda { |env| [302, [ %w(a) ], []] }
+    cl = Clogger.new(app, :logger => str, :format => '$sent_http_set_cookie')
+    assert_raise(TypeError) { cl.call(@req) }
+  end
+
+  def test_http_09_request
+    str = StringIO.new
+    app = lambda { |env| [302, [ %w(a) ], []] }
+    cl = Clogger.new(app, :logger => str, :format => '$request')
+    req = @req.dup
+    req.delete 'HTTP_VERSION'
+    cl.call(req)
+    assert_equal "GET /hello?goodbye=true\n", str.string
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clogger
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Eric Wong
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-29 00:00:00 -07:00
+date: 2009-09-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency