webrick 1.3.1 → 1.5.0

data/lib/webrick/utils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # utils.rb -- Miscellaneous utilities
 #
@@ -9,45 +10,34 @@
 # $IPR: utils.rb,v 1.10 2003/02/16 22:22:54 gotoyuzo Exp $
 
 require 'socket'
-require 'fcntl'
-begin
-  require 'etc'
-rescue LoadError
-  nil
-end
+require 'io/nonblock'
+require 'etc'
 
 module WEBrick
   module Utils
     ##
     # Sets IO operations on +io+ to be non-blocking
     def set_non_blocking(io)
-      flag = File::NONBLOCK
-      if defined?(Fcntl::F_GETFL)
-        flag |= io.fcntl(Fcntl::F_GETFL)
-      end
-      io.fcntl(Fcntl::F_SETFL, flag)
+      io.nonblock = true if io.respond_to?(:nonblock=)
     end
     module_function :set_non_blocking
 
     ##
     # Sets the close on exec flag for +io+
     def set_close_on_exec(io)
-      if defined?(Fcntl::FD_CLOEXEC)
-        io.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
-      end
+      io.close_on_exec = true if io.respond_to?(:close_on_exec=)
     end
     module_function :set_close_on_exec
 
     ##
     # Changes the process's uid and gid to the ones of +user+
     def su(user)
-      if defined?(Etc)
-        pw = Etc.getpwnam(user)
+      if pw = Etc.getpwnam(user)
         Process::initgroups(user, pw.gid)
         Process::Sys::setgid(pw.gid)
         Process::Sys::setuid(pw.uid)
       else
-        warn("WEBrick::Utils::su doesn't work on this platform")
+        warn("WEBrick::Utils::su doesn't work on this platform", uplevel: 1)
       end
     end
     module_function :su
@@ -68,30 +58,17 @@ module WEBrick
     # Creates TCP server sockets bound to +address+:+port+ and returns them.
     #
     # It will create IPV4 and IPV6 sockets on all interfaces.
-    def create_listeners(address, port, logger=nil)
+    def create_listeners(address, port)
       unless port
         raise ArgumentError, "must specify port"
       end
-      res = Socket::getaddrinfo(address, port,
-                                Socket::AF_UNSPEC,   # address family
-                                Socket::SOCK_STREAM, # socket type
-                                0,                   # protocol
-                                Socket::AI_PASSIVE)  # flag
-      last_error = nil
-      sockets = []
-      res.each{|ai|
-        begin
-          logger.debug("TCPServer.new(#{ai[3]}, #{port})") if logger
-          sock = TCPServer.new(ai[3], port)
-          port = sock.addr[1] if port == 0
-          Utils::set_close_on_exec(sock)
-          sockets << sock
-        rescue => ex
-          logger.warn("TCPServer Error: #{ex}") if logger
-          last_error  = ex
-        end
+      sockets = Socket.tcp_server_sockets(address, port)
+      sockets = sockets.map {|s|
+        s.autoclose = false
+        ts = TCPServer.for_fd(s.fileno)
+        s.close
+        ts
       }
-      raise last_error if sockets.empty?
       return sockets
     end
     module_function :create_listeners
@@ -114,7 +91,6 @@ module WEBrick
 
     ###########
 
-    require "thread"
     require "timeout"
     require "singleton"
 
@@ -149,7 +125,7 @@ module WEBrick
 
       ##
       # Mutex used to synchronize access across threads
-      TimeoutMutex = Mutex.new # :nodoc:
+      TimeoutMutex = Thread::Mutex.new # :nodoc:
 
       ##
       # Registers a new timeout handler
@@ -157,43 +133,82 @@ module WEBrick
       # +time+:: Timeout in seconds
       # +exception+:: Exception to raise when timeout elapsed
       def TimeoutHandler.register(seconds, exception)
-        TimeoutMutex.synchronize{
-          instance.register(Thread.current, Time.now + seconds, exception)
-        }
+        at = Process.clock_gettime(Process::CLOCK_MONOTONIC) + seconds
+        instance.register(Thread.current, at, exception)
       end
 
       ##
       # Cancels the timeout handler +id+
       def TimeoutHandler.cancel(id)
+        instance.cancel(Thread.current, id)
+      end
+
+      def self.terminate
+        instance.terminate
+      end
+
+      ##
+      # Creates a new TimeoutHandler.  You should use ::register and ::cancel
+      # instead of creating the timeout handler directly.
+      def initialize
         TimeoutMutex.synchronize{
-          instance.cancel(Thread.current, id)
+          @timeout_info = Hash.new
         }
+        @queue = Thread::Queue.new
+        @watcher = nil
       end
 
-      def initialize
-        @timeout_info = Hash.new
-        Thread.start{
+      # :nodoc:
+      private \
+        def watch
+          to_interrupt = []
           while true
-            now = Time.now
-            @timeout_info.each{|thread, ary|
-              ary.dup.each{|info|
-                time, exception = *info
-                interrupt(thread, info.object_id, exception) if time < now
+            now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            wakeup = nil
+            to_interrupt.clear
+            TimeoutMutex.synchronize{
+              @timeout_info.each {|thread, ary|
+                next unless ary
+                ary.each{|info|
+                  time, exception = *info
+                  if time < now
+                    to_interrupt.push [thread, info.object_id, exception]
+                  elsif !wakeup || time < wakeup
+                    wakeup = time
+                  end
+                }
               }
             }
-            sleep 0.5
+            to_interrupt.each {|arg| interrupt(*arg)}
+            if !wakeup
+              @queue.pop
+            elsif (wakeup -= now) > 0
+              begin
+                (th = Thread.start {@queue.pop}).join(wakeup)
+              ensure
+                th&.kill&.join
+              end
+            end
+            @queue.clear
           end
-        }
-      end
+        end
+
+      # :nodoc:
+      private \
+        def watcher
+          (w = @watcher)&.alive? and return w # usual case
+          TimeoutMutex.synchronize{
+            (w = @watcher)&.alive? and next w # pathological check
+            @watcher = Thread.start(&method(:watch))
+          }
+        end
 
       ##
       # Interrupts the timeout handler +id+ and raises +exception+
       def interrupt(thread, id, exception)
-        TimeoutMutex.synchronize{
-          if cancel(thread, id) && thread.alive?
-            thread.raise(exception, "execution timeout")
-          end
-        }
+        if cancel(thread, id) && thread.alive?
+          thread.raise(exception, "execution timeout")
+        end
       end
 
       ##
@@ -202,22 +217,36 @@ module WEBrick
       # +time+:: Timeout in seconds
       # +exception+:: Exception to raise when timeout elapsed
       def register(thread, time, exception)
-        @timeout_info[thread] ||= Array.new
-        @timeout_info[thread] << [time, exception]
-        return @timeout_info[thread].last.object_id
+        info = nil
+        TimeoutMutex.synchronize{
+          (@timeout_info[thread] ||= []) << (info = [time, exception])
+        }
+        @queue.push nil
+        watcher
+        return info.object_id
       end
 
       ##
       # Cancels the timeout handler +id+
       def cancel(thread, id)
-        if ary = @timeout_info[thread]
-          ary.delete_if{|info| info.object_id == id }
-          if ary.empty?
-            @timeout_info.delete(thread)
+        TimeoutMutex.synchronize{
+          if ary = @timeout_info[thread]
+            ary.delete_if{|info| info.object_id == id }
+            if ary.empty?
+              @timeout_info.delete(thread)
+            end
+            return true
           end
-          return true
-        end
-        return false
+          return false
+        }
+      end
+
+      ##
+      def terminate
+        TimeoutMutex.synchronize{
+          @timeout_info.clear
+          @watcher&.kill&.join
+        }
       end
     end
 

data/lib/webrick/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #--
 # version.rb -- version and release date
 #
@@ -9,5 +10,9 @@
 # $IPR: version.rb,v 1.74 2003/07/22 19:20:43 gotoyuzo Exp $
 
 module WEBrick
-  VERSION      = "1.3.1"
+
+  ##
+  # The WEBrick version
+
+  VERSION      = "1.5.0"
 end

data/lib/webrick.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # = WEB server toolkit.
 #
@@ -6,9 +7,9 @@
 # logging of both server operations and HTTP access.  WEBrick supports both
 # basic and digest authentication in addition to algorithms not in RFC 2617.
 #
-# A WEBrick servers can be composed of multiple WEBrick servers or servlets to
+# A WEBrick server can be composed of multiple WEBrick servers or servlets to
 # provide differing behavior on a per-host or per-path basis.  WEBrick
-# includes servlets for handling CGI scripts, ERb pages, ruby blocks and
+# includes servlets for handling CGI scripts, ERB pages, Ruby blocks and
 # directory listings.
 #
 # WEBrick also includes tools for daemonizing a process and starting a process
@@ -42,7 +43,7 @@
 #     res.body = 'Hello, world!'
 #   end
 #
-# Remember that <tt>server.mount_proc</tt> must <tt>server.start</tt>.
+# Remember that +server.mount_proc+ must precede +server.start+.
 #
 # == Servlets
 #
@@ -129,9 +130,8 @@
 #
 #   trap 'INT' do proxy.shutdown end
 #
-# Proxies may modifier the content of the response through the
-# +:ProxyContentHandler+ callback which will be invoked with the request and
-# respone after the remote content has been fetched.
+# See WEBrick::HTTPProxy for further details including modifying proxied
+# responses.
 #
 # == Basic and Digest authentication
 #
@@ -212,7 +212,7 @@ require 'webrick/version.rb'
 require 'webrick/config.rb'
 require 'webrick/log.rb'
 require 'webrick/server.rb'
-require 'webrick/utils.rb'
+require_relative 'webrick/utils.rb'
 require 'webrick/accesslog'
 
 require 'webrick/htmlutils.rb'

data/webrick.gemspec

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+begin
+  require_relative 'lib/webrick/version'
+rescue LoadError
+  # for Ruby core repository
+  require_relative 'version'
+end
+
+Gem::Specification.new do |s|
+  s.name = "webrick"
+  s.version = WEBrick::VERSION
+  s.summary = "HTTP server toolkit"
+  s.description = "WEBrick is an HTTP server toolkit that can be configured as an HTTPS server, a proxy server, and a virtual-host server."
+
+  s.require_path = %w{lib}
+  s.files =  [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "bin/console",
+    "bin/setup",
+    "lib/webrick.rb",
+    "lib/webrick/accesslog.rb",
+    "lib/webrick/cgi.rb",
+    "lib/webrick/compat.rb",
+    "lib/webrick/config.rb",
+    "lib/webrick/cookie.rb",
+    "lib/webrick/htmlutils.rb",
+    "lib/webrick/httpauth.rb",
+    "lib/webrick/httpauth/authenticator.rb",
+    "lib/webrick/httpauth/basicauth.rb",
+    "lib/webrick/httpauth/digestauth.rb",
+    "lib/webrick/httpauth/htdigest.rb",
+    "lib/webrick/httpauth/htgroup.rb",
+    "lib/webrick/httpauth/htpasswd.rb",
+    "lib/webrick/httpauth/userdb.rb",
+    "lib/webrick/httpproxy.rb",
+    "lib/webrick/httprequest.rb",
+    "lib/webrick/httpresponse.rb",
+    "lib/webrick/https.rb",
+    "lib/webrick/httpserver.rb",
+    "lib/webrick/httpservlet.rb",
+    "lib/webrick/httpservlet/abstract.rb",
+    "lib/webrick/httpservlet/cgi_runner.rb",
+    "lib/webrick/httpservlet/cgihandler.rb",
+    "lib/webrick/httpservlet/erbhandler.rb",
+    "lib/webrick/httpservlet/filehandler.rb",
+    "lib/webrick/httpservlet/prochandler.rb",
+    "lib/webrick/httpstatus.rb",
+    "lib/webrick/httputils.rb",
+    "lib/webrick/httpversion.rb",
+    "lib/webrick/log.rb",
+    "lib/webrick/server.rb",
+    "lib/webrick/ssl.rb",
+    "lib/webrick/utils.rb",
+    "lib/webrick/version.rb",
+    "webrick.gemspec",
+  ]
+  s.required_ruby_version = ">= 2.3.0"
+
+  s.authors = ["TAKAHASHI Masayoshi", "GOTOU YUUZOU", "Eric Wong"]
+  s.email = [nil, nil, 'normal@ruby-lang.org']
+  s.homepage = "https://www.ruby-lang.org"
+  s.license = "BSD-2-Clause"
+
+  if s.respond_to?(:metadata=)
+    s.metadata = {
+      "bug_tracker_uri" => "https://bugs.ruby-lang.org/projects/ruby-trunk/issues",
+      "homepage_uri" => "https://www.ruby-lang.org",
+      "source_code_uri" => "https://git.ruby-lang.org/ruby.git/"
+    }
+  end
+
+  s.add_development_dependency "rake"
+end

metadata

@@ -1,106 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: webrick
 version: !ruby/object:Gem::Version
-  version: 1.3.1
-  prerelease: 
+  version: 1.5.0
 platform: ruby
 authors:
-- IPR -- Internet Programming with Ruby -- writers
+- TAKAHASHI Masayoshi
+- GOTOU YUUZOU
+- Eric Wong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-28 00:00:00.000000000 Z
-dependencies: []
-description: 
-email: nahi@ruby-lang.org
+date: 2019-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: WEBrick is an HTTP server toolkit that can be configured as an HTTPS
+  server, a proxy server, and a virtual-host server.
+email:
+- 
+- 
+- normal@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/webrick/https.rb
-- lib/webrick/httpservlet/cgi_runner.rb
-- lib/webrick/httpservlet/erbhandler.rb
-- lib/webrick/httpservlet/filehandler.rb
-- lib/webrick/httpservlet/prochandler.rb
-- lib/webrick/httpservlet/abstract.rb
-- lib/webrick/httpservlet/cgihandler.rb
-- lib/webrick/compat.rb
-- lib/webrick/httpresponse.rb
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/webrick.rb
 - lib/webrick/accesslog.rb
-- lib/webrick/httpversion.rb
-- lib/webrick/utils.rb
-- lib/webrick/version.rb
-- lib/webrick/httprequest.rb
-- lib/webrick/httpauth.rb
-- lib/webrick/server.rb
-- lib/webrick/httpproxy.rb
-- lib/webrick/ssl.rb
 - lib/webrick/cgi.rb
-- lib/webrick/httpstatus.rb
-- lib/webrick/htmlutils.rb
-- lib/webrick/httpserver.rb
+- lib/webrick/compat.rb
+- lib/webrick/config.rb
 - lib/webrick/cookie.rb
-- lib/webrick/httputils.rb
+- lib/webrick/htmlutils.rb
+- lib/webrick/httpauth.rb
+- lib/webrick/httpauth/authenticator.rb
 - lib/webrick/httpauth/basicauth.rb
 - lib/webrick/httpauth/digestauth.rb
-- lib/webrick/httpauth/authenticator.rb
 - lib/webrick/httpauth/htdigest.rb
 - lib/webrick/httpauth/htgroup.rb
 - lib/webrick/httpauth/htpasswd.rb
 - lib/webrick/httpauth/userdb.rb
-- lib/webrick/config.rb
+- lib/webrick/httpproxy.rb
+- lib/webrick/httprequest.rb
+- lib/webrick/httpresponse.rb
+- lib/webrick/https.rb
+- lib/webrick/httpserver.rb
 - lib/webrick/httpservlet.rb
+- lib/webrick/httpservlet/abstract.rb
+- lib/webrick/httpservlet/cgi_runner.rb
+- lib/webrick/httpservlet/cgihandler.rb
+- lib/webrick/httpservlet/erbhandler.rb
+- lib/webrick/httpservlet/filehandler.rb
+- lib/webrick/httpservlet/prochandler.rb
+- lib/webrick/httpstatus.rb
+- lib/webrick/httputils.rb
+- lib/webrick/httpversion.rb
 - lib/webrick/log.rb
-- lib/webrick.rb
-- sample/webrick/demo-urlencoded.cgi
-- sample/webrick/demo-multipart.cgi
-- sample/webrick/hello.rb
-- sample/webrick/hello.cgi
-- sample/webrick/httpproxy.rb
-- sample/webrick/httpsd.rb
-- sample/webrick/httpd.rb
-- sample/webrick/demo-app.rb
-- sample/webrick/demo-servlet.rb
-- test/webrick/webrick_long_filename.cgi
-- test/webrick/utils.rb
-- test/webrick/test_httpproxy.rb
-- test/webrick/test_cookie.rb
-- test/webrick/test_server.rb
-- test/webrick/test_httpresponse.rb
-- test/webrick/test_utils.rb
-- test/webrick/test_httpserver.rb
-- test/webrick/test_httprequest.rb
-- test/webrick/test_httpversion.rb
-- test/webrick/webrick.cgi
-- test/webrick/test_httpauth.rb
-- test/webrick/test_cgi.rb
-- test/webrick/test_httputils.rb
-- test/webrick/test_filehandler.rb
-- test/ruby/envutil.rb
-- test/openssl/utils.rb
-- README.txt
-homepage: http://github.com/nahi/webrick
-licenses: []
+- lib/webrick/server.rb
+- lib/webrick/ssl.rb
+- lib/webrick/utils.rb
+- lib/webrick/version.rb
+- webrick.gemspec
+homepage: https://www.ruby-lang.org
+licenses:
+- BSD-2-Clause
+metadata:
+  bug_tracker_uri: https://bugs.ruby-lang.org/projects/ruby-trunk/issues
+  homepage_uri: https://www.ruby-lang.org
+  source_code_uri: https://git.ruby-lang.org/ruby.git/
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
-summary: WEBrick is an HTTP server toolkit that can be configured as an HTTPS server,
+specification_version: 4
+summary: HTTP server toolkit
 test_files: []

data/README.txt

@@ -1,21 +0,0 @@
-= WEB server toolkit.
-
-WEBrick is an HTTP server toolkit that can be configured as an HTTPS server,
-a proxy server, and a virtual-host server.  WEBrick features complete
-logging of both server operations and HTTP access.  WEBrick supports both
-basic and digest authentication in addition to algorithms not in RFC 2617.
-
-A WEBrick servers can be composed of multiple WEBrick servers or servlets to
-provide differing behavior on a per-host or per-path basis.  WEBrick
-includes servlets for handling CGI scripts, ERb pages, ruby blocks and
-directory listings.
-
-WEBrick also includes tools for daemonizing a process and starting a process
-at a higher privilege level and dropping permissions.
-
-== Copyright
-
-Author: IPR -- Internet Programming with Ruby -- writers
-
-Copyright (c) 2000 TAKAHASHI Masayoshi, GOTOU YUUZOU
-Copyright (c) 2002 Internet Programming with Ruby writers. All rights reserved.

data/sample/webrick/demo-app.rb

@@ -1,66 +0,0 @@
-require "pp"
-
-module DemoApplication
-  def initialize(config, enctype)
-    super
-    @enctype = enctype
-  end
-
-  def do_GET(req, res)
-    if req.path_info != "/"
-      res.set_redirect(WEBrick::HTTPStatus::Found, req.script_name + "/")
-    end
-    res.body =<<-_end_of_html_
-      <HTML>
-       <FORM method="POST" enctype=#{@enctype}>
-        text: <INPUT type="text" name="text"><BR>
-        file: <INPUT type="file" name="file"><BR>
-        check:
-        <INPUT type="checkbox" name="check" value="a">a,
-        <INPUT type="checkbox" name="check" value="b">b,
-        <INPUT type="checkbox" name="check" value="c">c,
-        <BR>
-        <INPUT type="submit">
-       </FORM>
-      </HTML>
-    _end_of_html_
-    res['content-type'] = 'text/html; charset=iso-8859-1'
-  end
-
-  def do_POST(req, res)
-    if req["content-length"].to_i > 1024*10
-      raise WEBrick::HTTPStatus::Forbidden, "file size too large"
-    end
-    res.body =<<-_end_of_html_
-      <HTML>
-       <H2>Query Parameters</H2>
-       #{display_query(req.query)}
-       <A href="#{req.path}">return</A>
-       <H2>Request</H2>
-       <PRE>#{WEBrick::HTMLUtils::escape(PP::pp(req, "", 80))}</PRE>
-       <H2>Response</H2>
-       <PRE>#{WEBrick::HTMLUtils::escape(PP::pp(res, "", 80))}</PRE>
-      </HTML>
-    _end_of_html_
-    res['content-type'] = 'text/html; charset=iso-8859-1'
-  end
-
-  private
-
-  def display_query(q)
-    ret = ""
-    q.each{|key, val|
-      ret << "<H3>#{WEBrick::HTMLUtils::escape(key)}</H3>"
-      ret << "<TABLE border=1>"
-      ret << make_tr("val", val.inspect)
-      ret << make_tr("val.to_a", val.to_a.inspect)
-      ret << make_tr("val.to_ary", val.to_ary.inspect)
-      ret << "</TABLE>"
-    }
-    ret
-  end
-
-  def make_tr(arg0, arg1)
-    "<TR><TD>#{arg0}</TD><TD>#{WEBrick::HTMLUtils::escape(arg1)}</TD></TR>"
-  end
-end

data/sample/webrick/demo-multipart.cgi

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-require "webrick/cgi"
-require "webrick/https" # should load if it runs on HTTPS server
-require "./demo-app"
-
-class DemoCGI < WEBrick::CGI
-  include DemoApplication
-end
-
-config = { :NPH => false }
-cgi = DemoCGI.new(config, "multipart/form-data")
-cgi.start

data/sample/webrick/demo-servlet.rb

@@ -1,6 +0,0 @@
-require "webrick"
-require "./demo-app"
-
-class DemoServlet < WEBrick::HTTPServlet::AbstractServlet
-  include DemoApplication
-end