clogger 2.2.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97fb2f9fb82bfc33a07ee55de5b946830c6562dc9fc9d11f5c75d89323f3543e
-  data.tar.gz: 96062fd19c193f6b9a5418ebf237b2425966f56f23133ad389c19bf1de1ebcd1
+  metadata.gz: f07e1211c59e3f7ab5272febd94b6f19cc384d9add4043a2fc1815a3d3579518
+  data.tar.gz: bf4af6f34c84c24542831150a159fc4f89f5bbccf39f8b35f81cf0b2fcb1658d
 SHA512:
-  metadata.gz: '019753504c2aa28353ed40da5b4612ed9c6e8f94daa91fcfdc7090a7486d45a18448ae03cd75519f79a557b8e7dd576f0939f6e62ef1a65d928c5e9844aed503'
-  data.tar.gz: b4c50eafffa057ccfae3dc9473a19f33a7f1efddf534dd73623002e2d4545daae19a4ea2e1156b539a5d32df56afac3eda351524eb49007a46ae50b936981a1b
+  metadata.gz: 47a615c6cb5ad51d3b391dbd2fccfe8c0413d8301cef29789394d06be886a66343ef448e8f6746a651fe17118e807530242fca6cc67b3dac1e41f9a8f03b37be
+  data.tar.gz: 7167c4bd8881f5452e15852e6c51f8e898bdf548d967c322957c31cdf127f9e7fbf8e8ec31f7439b1be398faf629a1ae7d7513a82299717f7a144c05c6f5a607

data/.olddoc.yml

@@ -1,13 +1,15 @@
 ---
-rdoc_url: https://yhbt.net/clogger/
-cgit_url: https://yhbt.net/clogger.git
-git_url: git://yhbt.net/clogger.git
-public_email: clogger-public@yhbt.net
+rdoc_url: https://YHBT.net/clogger/
+cgit_url: https://YHBT.net/clogger.git
+git_url: https://YHBT.net/clogger.git
+public_email: clogger-public@YHBT.net
 ml_url:
-- https://yhbt.net/clogger-public/
-- http://ou63pmih66umazou.onion/clogger-public/
-- nntp://news.public-inbox.org/inbox.comp.lang.ruby.clogger
+- https://YHBT.net/clogger-public/
+- http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/clogger-public/
+- imaps://YHBT.net/inbox.comp.lang.ruby.clogger.0
+- imap://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.lang.ruby.clogger.0
+- nntps://news.public-inbox.org/inbox.comp.lang.ruby.clogger
+- nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.lang.ruby.clogger
 source_code:
-- git clone git://yhbt.net/clogger.git
-- git clone https://yhbt.net/clogger.git
-- torsocks git clone http://ou63pmih66umazou.onion/clogger.git
+- git clone https://YHBT.net/clogger.git
+- torsocks git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/clogger.git

data/GIT-VERSION-FILE

@@ -1 +1 @@
-GIT_VERSION = 2.2.1
+GIT_VERSION = 2.4.0

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v2.2.1
+DEF_VER=v2.4.0
 
 LF='
 '

data/GNUmakefile

@@ -1,5 +1,5 @@
 all::
-RSYNC_DEST := yhbt.net:/srv/yhbt/clogger/
+RSYNC_DEST := YHBT.net:/srv/yhbt/clogger/
 rfpackage := clogger
 include pkg.mk
 test-ext:

data/LATEST

@@ -1,9 +1,9 @@
-=== clogger 2.2.1 - move away from .org TLD / 2020-01-08 09:46 UTC
+=== clogger 2.4.0 / 2022-06-16 16:53 UTC
 
-  Just doc and website updates to point our email address
-  and website to yhbt.net because bogomips.org won't be
-  affordable due to extortionists, soon.
+  Only 2 code changes, neither of which is really relevant for 99% of
+  users using the C extension and strict HTTP parsers.
 
-    doc: switch to dark216 for website
-    doc: replace bogomips.org with yhbt.net
+        escape env['REQUEST_METHOD'] for non-strict HTTP servers
+        pure: fix time.rb incompatibility in Ruby 3.1+
+        doc: drop git:// URLs, use shorter domain for IMAP links
 

data/NEWS

@@ -1,3 +1,36 @@
+=== clogger 2.4.0 / 2022-06-16 16:53 UTC
+
+  Only 2 code changes, neither of which is really relevant for 99% of
+  users using the C extension and strict HTTP parsers.
+
+        escape env['REQUEST_METHOD'] for non-strict HTTP servers
+        pure: fix time.rb incompatibility in Ruby 3.1+
+        doc: drop git:// URLs, use shorter domain for IMAP links
+
+=== clogger 2.3.1 / 2021-05-25 23:39 UTC
+
+  This release fixes compatibility with GC.compact on Ruby 3.x.
+  Thanks to Ngan Pham for the patch and Aaron Patterson for the
+  feedback for the (obsolete) kgio RubyGem:
+
+    https://yhbt.net/kgio-public/CAAvYYt5Z5f2rMuXO5DMpR1-6uRvu_gXKDvqcyoZ+oNcLiTH39g@mail.gmail.com/T/
+
+=== clogger 2.3.0 - $request_time{POWER,PRECISION} support / 2020-08-10 23:01 UTC
+
+  The $request_time can now be multiplied by a power-of-10,
+  allowing up to nanosecond resolution without decimals.
+
+  Thanks to Josh Natanson for contributing this feature:
+
+  https://yhbt.net/clogger-public/CAPdx2swO4eaOWaqL4-rMLq1H7pH6w-i760vPJTb92tyKfcc01Q@mail.gmail.com/
+  https://yhbt.net/clogger-public/CAPdx2szjqUuFjUtrgoeXXwmz0HzfdnWe+2h2Sp_ywDkTDVL0-g@mail.gmail.com/T/
+
+  There's also some minor fixes and doc updates:
+
+    clogger: fix _BSD_SOURCE and _SVID_SOURCE deprecation warnings
+    doc: update with IMAPS, NNTPS, and .onion mail archive URLs
+    doc: document Fiber.current
+
 === clogger 2.2.1 - move away from .org TLD / 2020-01-08 09:46 UTC
 
   Just doc and website updates to point our email address

data/README

@@ -69,10 +69,12 @@ that receives a "<<" method:
 * $request_uri - the URI requested ($path_info?$query_string)
 * $request - the first line of the HTTP request
   ($request_method $request_uri $http_version)
-* $request_time, $request_time{PRECISION} - time taken for request
-  (including response body iteration).  PRECISION defaults to 3
-  (milliseconds) if not specified but may be specified anywhere from
-  0(seconds) to 6(microseconds).
+* $request_time, $request_time{PRECISION}, $request_time{POWER,PRECISION} -
+  time taken for request (including response body iteration). PRECISION
+  defaults to 3 (milliseconds) if not specified but may be specified
+  anywhere from 0(seconds) to 6(microseconds). POWER will raise the time to
+  the provided power of 10, useful for converting to micro- or nanoseconds.
+  POWER defaults to 0 if not specified but may be specified any from 0 to 9
 * $time_iso8601 - current local time in ISO 8601 format,
   e.g. "1970-01-01T00:00:00+00:00"
 * $time_local - current local time in Apache log format,
@@ -87,7 +89,7 @@ that receives a "<<" method:
 * $ip - X-Forwarded-For request header if available, $remote_addr if not
 * $pid - process ID of the current process
 * $e{Thread.current} - Thread processing the request
-* $e{Actor.current} - Actor processing the request (Revactor or Rubinius)
+* $e{Fiber.current} - Fiber processing the request
 * $env{variable_name} - any Rack environment variable (e.g. rack.url_scheme)
 
 == REQUIREMENTS
@@ -98,28 +100,40 @@ that receives a "<<" method:
 
 The latest development happens in git and is published to the following:
 
-   git clone https://yhbt.net/clogger.git
-   git clone git://repo.or.cz/clogger.git
+   git clone https://YHBT.net/clogger.git
+   git clone https://repo.or.cz/clogger.git
 
 You may also browse and download snapshot tarballs:
 
-* https://yhbt.net/clogger.git
-* http://repo.or.cz/w/clogger.git (gitweb)
+* https://YHBT.net/clogger.git
+* https://repo.or.cz/w/clogger.git (gitweb)
 
-The mailing list (see below) is central for coordination and
-development.  Patches should always be sent inline
-(git format-patch -M + git send-email) so we can reply to them inline.
+We use email for coordination and development, see below:
 
 == CONTACT
 
 All feedback (bug reports, user/development discussion, patches, pull
-requests) go to the public mailing list.
+requests) is done via publicly-archived email:
 
-* mailto:clogger-public@yhbt.net
+* https://YHBT.net/clogger-public/
+* imaps://YHBT.net/inbox.comp.lang.ruby.clogger.0
+* nntps://news.public-inbox.org/inbox.comp.lang.ruby.clogger
 
-Do not send HTML mail or attachments.  Do not top post.
+Tor users may also access HTTP, IMAP, and NNTP archives via .onion:
 
-Homepage: https://yhbt.net/clogger/
+* http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/clogger-public/
+* imap://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.lang.ruby.clogger.0
+* nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.lang.ruby.clogger
+
+AUTH=ANONYMOUS is supported for IMAP and IMAPS, and any
+username + password will work.
+
+No subscription or real names will ever be required to email us.
+Do not send HTML email, do not top post.
+
+* mailto:clogger-public@YHBT.net
+
+Homepage: https://YHBT.net/clogger/
 
 == INSTALL
 

data/clogger.gemspec

@@ -3,12 +3,12 @@ manifest = File.exist?('.manifest') ?
 
 Gem::Specification.new do |s|
   s.name = %q{clogger}
-  s.version = (ENV['VERSION'] || '2.1.0').dup
-  s.homepage = 'https://yhbt.net/clogger/'
+  s.version = (ENV['VERSION'] || '2.4.0').dup
+  s.homepage = 'https://YHBT.net/clogger/'
   s.authors = ["cloggers"]
   s.summary = 'configurable request logging for Rack'
   s.description = File.read('README').split("\n\n")[1]
-  s.email = %q{clogger-public@yhbt.net}
+  s.email = %q{clogger-public@YHBT.net}
   s.extra_rdoc_files = IO.readlines('.document').map!(&:chomp!).keep_if do |f|
     File.exist?(f)
   end

data/ext/clogger_ext/clogger.c

@@ -1,3 +1,6 @@
+/* quiet deprecation for _BSD_SOURCE and _SVID_SOURCE: */
+#define _DEFAULT_SOURCE 1
+
 #include <ruby.h>
 #ifdef HAVE_RUBY_IO_H
 #  include <ruby/io.h>
@@ -374,12 +377,40 @@ static void append_ts(struct clogger *c, VALUE op, struct timespec *ts)
 	rb_str_buf_cat(c->log_buf, buf, nr);
 }
 
+#define NANO_PER_SEC (1000 * 1000 * 1000)
 static void append_request_time_fmt(struct clogger *c, VALUE op)
 {
 	struct timespec now;
+	unsigned long ipow = NUM2ULONG(rb_ary_entry(op, 3));
 
 	clock_gettime(hopefully_CLOCK_MONOTONIC, &now);
 	clock_diff(&now, &c->ts_start);
+	if (ipow) {
+		struct timespec prev;
+		unsigned long adj = 1;
+		/*
+		  * n.b. timespec.tv_sec may not be time_t on some platforms,
+		  * so we use a full timespec struct instead of time_t:
+		  */
+		prev.tv_sec = now.tv_sec;
+		do { adj *= 10; } while (--ipow);
+		now.tv_sec *= adj;
+		now.tv_nsec *= adj;
+		if (now.tv_nsec >= NANO_PER_SEC) {
+			int64_t add = now.tv_nsec / NANO_PER_SEC;
+			now.tv_sec += add;
+			now.tv_nsec %= NANO_PER_SEC;
+		}
+		if (now.tv_sec < prev.tv_sec) { /* overflowed */
+			now.tv_nsec = NANO_PER_SEC - 1;
+			/*
+			  * some platforms may use unsigned .tv_sec, but
+			  * they're not worth supporting, so keep unsigned:
+			  */
+			now.tv_sec = (time_t)(sizeof(now.tv_sec) == 4 ?
+			             INT_MAX : LONG_MAX);
+		}
+	}
 	append_ts(c, op, &now);
 }
 
@@ -416,10 +447,11 @@ static void append_request(struct clogger *c)
 {
 	VALUE tmp;
 
-	/* REQUEST_METHOD doesn't need escaping, Rack::Lint governs it */
 	tmp = rb_hash_aref(c->env, g_REQUEST_METHOD);
-	if (!NIL_P(tmp))
+	if (!NIL_P(tmp)) {
+		tmp = byte_xs(tmp);
 		rb_str_buf_append(c->log_buf, tmp);
+	}
 
 	rb_str_buf_append(c->log_buf, g_space);
 
@@ -1073,6 +1105,7 @@ void Init_clogger_ext(void)
 	tmp = rb_const_get(rb_cObject, rb_intern("Rack"));
 	tmp = rb_const_get(tmp, rb_intern("Utils"));
 	cHeaderHash = rb_const_get(tmp, rb_intern("HeaderHash"));
+	rb_ary_push(mark_ary, cHeaderHash);
 
 	rb_obj_freeze(mark_ary);
 }

data/lib/clogger/pure.rb

@@ -118,8 +118,7 @@ private
       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)}#{version}"
+      "#{byte_xs(env['REQUEST_METHOD'] || '')} #{request_uri(env)}#{version}"
     when :request_uri
       request_uri(env)
     when :request_length
@@ -134,17 +133,10 @@ private
     when :time_iso8601
       Time.now.iso8601
     when :time_local
-      t = Time.now
-      off = t.utc_offset
-      sign = off < 0 ? '-' : '+'
-      sprintf("%02d/%s/%d:%02d:%02d:%02d #{sign}%02d%02d",
-              t.mday, Time::RFC2822_MONTH_NAME[t.mon - 1],
-              t.year, t.hour, t.min, t.sec, *(off.abs / 60).divmod(60))
+      # %b in Ruby is locale-independent, unlike strftime(3) in C
+      Time.now.strftime('%d/%b/%Y:%H:%M:%S %z')
     when :time_utc
-      t = Time.now.utc
-      sprintf("%02d/%s/%d:%02d:%02d:%02d +0000",
-              t.mday, Time::RFC2822_MONTH_NAME[t.mon - 1],
-              t.year, t.hour, t.min, t.sec)
+      Time.now.utc.strftime('%d/%b/%Y:%H:%M:%S %z')
     else
       raise "EDOOFUS #{special_nr}"
     end
@@ -166,6 +158,7 @@ private
       when OP_TIME_UTC; Time.now.utc.strftime(op[1])
       when OP_REQUEST_TIME
         t = mono_now - start
+        t = t * (10 ** op[3])
         time_format(t.to_i, (t - t.to_i) * 1000000, op[1], op[2])
       when OP_TIME
         t = Time.now

data/lib/clogger.rb

@@ -51,7 +51,7 @@ private
 
   SCAN = /([^$]*)(\$+(?:env\{\w+(?:\.[\w\.]+)?\}|
                         e\{[^\}]+\}|
-                        (?:request_)?time\{\d+\}|
+                        (?:request_)?time\{\d+(?:,\d+)?\}|
                         time_(?:utc|local)\{[^\}]+\}|
                         \w*))?([^$]*)/x
 
@@ -92,7 +92,14 @@ private
         when /\A\$time\{(\d+)\}\z/
           rv << [ OP_TIME, *usec_conv_pair(tok, $1.to_i) ]
         when /\A\$request_time\{(\d+)\}\z/
-          rv << [ OP_REQUEST_TIME, *usec_conv_pair(tok, $1.to_i) ]
+          rv << [ OP_REQUEST_TIME, *usec_conv_pair(tok, $1.to_i), 0 ]
+        when /\A\$request_time\{(\d+),(\d+)\}\z/
+          ipow = $1.to_i
+          prec = $2.to_i
+          if ipow > 9 # nanosecond precision is the highest POSIX goes
+            raise ArgumentError, "#{tok}: too big: #{ipow} (max=9)"
+          end
+          rv << [ OP_REQUEST_TIME, *usec_conv_pair(tok, prec), ipow ]
         else
           tok_sym = tok[1..-1].to_sym
           if special_code = SPECIAL_VARS[tok_sym]

data/pkg.mk

@@ -127,7 +127,8 @@ publish_doc:
 	-git set-file-times
 	$(MAKE) doc
 	$(MAKE) doc_gz
-	$(RSYNC) -av doc/ $(RSYNC_DEST)/
+	$(RSYNC) -av doc/ $(RSYNC_DEST)/ \
+		--exclude index.html* --exclude created.rid*
 	git ls-files | xargs touch
 endif
 

data/test/test_clogger.rb

@@ -167,10 +167,11 @@ class TestClogger < Test::Unit::TestCase
       ary = compile_format(
         '$remote_addr - $remote_user [$time_local] ' \
         '"$request" $status $body_bytes_sent "$http_referer" ' \
-        '"$http_user_agent" "$http_cookie" $request_time ' \
+        '"$http_user_agent" "$http_cookie" $request_time $request_time{6,0} ' \
         '$env{rack.url_scheme}' \
         "\n")
     }
+
     expect = [
       [ Clogger::OP_REQUEST, "REMOTE_ADDR" ],
       [ Clogger::OP_LITERAL, " - " ],
@@ -190,7 +191,9 @@ class TestClogger < Test::Unit::TestCase
       [ Clogger::OP_LITERAL, "\" \"" ],
       [ Clogger::OP_REQUEST, "HTTP_COOKIE" ],
       [ Clogger::OP_LITERAL, "\" " ],
-      [ Clogger::OP_REQUEST_TIME, '%d.%03d', 1000 ],
+      [ Clogger::OP_REQUEST_TIME, '%d.%03d', 1000, 0],
+      [ Clogger::OP_LITERAL, " " ],
+      [ Clogger::OP_REQUEST_TIME, '%d', 1, 6],
       [ Clogger::OP_LITERAL, " " ],
       [ Clogger::OP_REQUEST, "rack.url_scheme" ],
       [ Clogger::OP_LITERAL, "\n" ],
@@ -209,6 +212,22 @@ class TestClogger < Test::Unit::TestCase
     assert_equal "-#{current}-\n", str.string
   end
 
+  def test_fiber
+    begin
+      current = Fiber.current.to_s
+    rescue NameError => e
+      warn "your Ruby does not support fibers #{e}"
+      return
+    end
+    str = StringIO.new
+    app = lambda { |env| [ 302, {}, [] ] }
+    cl = Clogger.new(app,
+                    :logger => str,
+                    :format => "-$e{Fiber.current}-\n")
+    status, headers, body = cl.call(@req)
+    assert_equal "-#{current}-\n", str.string
+  end
+
   def test_pid
     str = StringIO.new
     app = lambda { |env| [ 302, {}, [] ] }
@@ -721,6 +740,24 @@ class TestClogger < Test::Unit::TestCase
     assert s[-1].to_f <= 0.110
   end
 
+  def test_request_time_with_multiplier
+    s = []
+    app = lambda { |env| sleep(0.1) ; [302, [], [] ] }
+    cl = Clogger.new(app, :logger => s, :format => "$request_time{9,0}")
+    status, headers, body = cl.call(@req)
+    assert_nothing_raised { body.each { |x| } ; body.close }
+    assert s[-1].to_f >= 100000000
+    assert s[-1].to_f <= 300000000
+  end
+
+  def test_request_time_with_invalid_multiplier
+    s = []
+    app = lambda { |env| sleep(0.1) ; [302, [], [] ] }
+    assert_raise(ArgumentError) {
+      cl = Clogger.new(app, :logger => s, :format => "$request_time{10,0}")
+    }
+  end
+
   def test_insanely_long_time_format
     s = []
     app = lambda { |env| [200, [], [] ] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clogger
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.4.0
 platform: ruby
 authors:
 - cloggers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -47,7 +47,7 @@ dependencies:
 description: |-
   clogger is Rack middleware for logging HTTP requests.  The log format
   is customizable so you can specify exactly which fields to log.
-email: clogger-public@yhbt.net
+email: clogger-public@YHBT.net
 executables: []
 extensions:
 - ext/clogger_ext/extconf.rb
@@ -85,7 +85,7 @@ files:
 - setup.rb
 - test/test_clogger.rb
 - test/test_clogger_to_path.rb
-homepage: https://yhbt.net/clogger/
+homepage: https://YHBT.net/clogger/
 licenses:
 - LGPL-2.1+
 metadata: {}