RubyGems - webrick - Versions diffs - 1.3.1 → 1.4.0.beta1 - Mend

webrick 1.3.1 → 1.4.0.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of webrick might be problematic. Click here for more details.

Files changed (64) hide show

checksums.yaml +7 -0
data/lib/webrick.rb +6 -6
data/lib/webrick/accesslog.rb +9 -1
data/lib/webrick/cgi.rb +51 -2
data/lib/webrick/compat.rb +2 -1
data/lib/webrick/config.rb +42 -5
data/lib/webrick/cookie.rb +68 -6
data/lib/webrick/htmlutils.rb +4 -2
data/lib/webrick/httpauth.rb +1 -0
data/lib/webrick/httpauth/authenticator.rb +13 -8
data/lib/webrick/httpauth/basicauth.rb +3 -3
data/lib/webrick/httpauth/digestauth.rb +25 -9
data/lib/webrick/httpauth/htdigest.rb +8 -4
data/lib/webrick/httpauth/htgroup.rb +1 -0
data/lib/webrick/httpauth/htpasswd.rb +7 -3
data/lib/webrick/httpauth/userdb.rb +1 -0
data/lib/webrick/httpproxy.rb +47 -14
data/lib/webrick/httprequest.rb +142 -16
data/lib/webrick/httpresponse.rb +96 -24
data/lib/webrick/https.rb +24 -1
data/lib/webrick/httpserver.rb +20 -4
data/lib/webrick/httpservlet.rb +1 -0
data/lib/webrick/httpservlet/abstract.rb +2 -1
data/lib/webrick/httpservlet/cgi_runner.rb +1 -0
data/lib/webrick/httpservlet/cgihandler.rb +19 -5
data/lib/webrick/httpservlet/erbhandler.rb +2 -1
data/lib/webrick/httpservlet/filehandler.rb +87 -34
data/lib/webrick/httpservlet/prochandler.rb +14 -0
data/lib/webrick/httpstatus.rb +24 -10
data/lib/webrick/httputils.rb +129 -13
data/lib/webrick/httpversion.rb +28 -1
data/lib/webrick/log.rb +22 -2
data/lib/webrick/server.rb +203 -60
data/lib/webrick/ssl.rb +80 -5
data/lib/webrick/utils.rb +97 -67
data/lib/webrick/version.rb +6 -1
metadata +59 -69
data/README.txt +0 -21
data/sample/webrick/demo-app.rb +0 -66
data/sample/webrick/demo-multipart.cgi +0 -12
data/sample/webrick/demo-servlet.rb +0 -6
data/sample/webrick/demo-urlencoded.cgi +0 -12
data/sample/webrick/hello.cgi +0 -11
data/sample/webrick/hello.rb +0 -8
data/sample/webrick/httpd.rb +0 -23
data/sample/webrick/httpproxy.rb +0 -25
data/sample/webrick/httpsd.rb +0 -33
data/test/openssl/utils.rb +0 -313
data/test/ruby/envutil.rb +0 -208
data/test/webrick/test_cgi.rb +0 -134
data/test/webrick/test_cookie.rb +0 -131
data/test/webrick/test_filehandler.rb +0 -285
data/test/webrick/test_httpauth.rb +0 -167
data/test/webrick/test_httpproxy.rb +0 -282
data/test/webrick/test_httprequest.rb +0 -411
data/test/webrick/test_httpresponse.rb +0 -49
data/test/webrick/test_httpserver.rb +0 -305
data/test/webrick/test_httputils.rb +0 -96
data/test/webrick/test_httpversion.rb +0 -40
data/test/webrick/test_server.rb +0 -67
data/test/webrick/test_utils.rb +0 -64
data/test/webrick/utils.rb +0 -58
data/test/webrick/webrick.cgi +0 -36
data/test/webrick/webrick_long_filename.cgi +0 -36

data/lib/webrick/httpresponse.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # httpresponse.rb -- HTTPResponse Class
 #
@@ -16,25 +17,81 @@ require 'webrick/httpstatus'
 module WEBrick
   ##
-  # An HTTP response.
+  # An HTTP response.  This is filled in by the service or do_* methods of a
+  # WEBrick HTTP Servlet.
   class HTTPResponse
-    attr_reader :http_version, :status, :header
+    ##
+    # HTTP Response version
+    attr_reader :http_version
+    ##
+    # Response status code (200)
+    attr_reader :status
+    ##
+    # Response header
+    attr_reader :header
+    ##
+    # Response cookies
     attr_reader :cookies
+    ##
+    # Response reason phrase ("OK")
     attr_accessor :reason_phrase
     ##
-    # Body may be a String or IO subclass.
+    # Body may be a String or IO-like object that responds to #read and
+    # #readpartial.
     attr_accessor :body
-    attr_accessor :request_method, :request_uri, :request_http_version
+    ##
+    # Request method for this response
+    attr_accessor :request_method
+    ##
+    # Request URI for this response
+    attr_accessor :request_uri
+    ##
+    # Request HTTP version for this response
+    attr_accessor :request_http_version
+    ##
+    # Filename of the static file in this response.  Only used by the
+    # FileHandler servlet.
     attr_accessor :filename
+    ##
+    # Is this a keep-alive response?
     attr_accessor :keep_alive
-    attr_reader :config, :sent_size
     ##
-    # Creates a new HTTP response object
+    # Configuration for this response
+    attr_reader :config
+    ##
+    # Bytes sent in this response
+    attr_reader :sent_size
+    ##
+    # Creates a new HTTP response object.  WEBrick::Config::HTTP is the
+    # default configuration.
     def initialize(config)
       @config = config
@@ -115,7 +172,7 @@ module WEBrick
     end
     ##
-    # Iterates over each header in the resopnse
+    # Iterates over each header in the response
     def each
       @header.each{|field, value|  yield(field, value) }
@@ -145,7 +202,7 @@ module WEBrick
     ##
     # Sends the response on +socket+
-    def send_response(socket)
+    def send_response(socket) # :nodoc:
       begin
         setup_header()
         send_header(socket)
@@ -162,7 +219,7 @@ module WEBrick
     ##
     # Sets up the headers for sending
-    def setup_header()
+    def setup_header() # :nodoc:
       @reason_phrase    ||= HTTPStatus::reason_phrase(@status)
       @header['server'] ||= @config[:ServerSoftware]
       @header['date']   ||= Time.now.httpdate
@@ -225,7 +282,7 @@ module WEBrick
     ##
     # Sends the headers on +socket+
-    def send_header(socket)
+    def send_header(socket) # :nodoc:
       if @http_version.major > 0
         data = status_line()
         @header.each{|key, value|
@@ -243,10 +300,11 @@ module WEBrick
     ##
     # Sends the body on +socket+
-    def send_body(socket)
-      case @body
-      when IO then send_body_io(socket)
-      else send_body_string(socket)
+    def send_body(socket) # :nodoc:
+      if @body.respond_to? :readpartial then
+        send_body_io(socket)
+      else
+        send_body_string(socket)
       end
     end
@@ -264,7 +322,7 @@ module WEBrick
     #   res.set_redirect WEBrick::HTTPStatus::TemporaryRedirect
     def set_redirect(status, url)
-      @body = "<HTML><A HREF=\"#{url.to_s}\">#{url.to_s}</A>.</HTML>\n"
+      @body = "<HTML><A HREF=\"#{url}\">#{url}</A>.</HTML>\n"
       @header['location'] = url.to_s
       raise status
     end
@@ -294,6 +352,14 @@ module WEBrick
         host, port = @config[:ServerName], @config[:Port]
       end
+      error_body(backtrace, ex, host, port)
+    end
+    private
+    # :stopdoc:
+    def error_body(backtrace, ex, host, port)
       @body = ''
       @body << <<-_end_of_html_
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
@@ -323,20 +389,23 @@ module WEBrick
       _end_of_html_
     end
-    private
     def send_body_io(socket)
       begin
         if @request_method == "HEAD"
           # do nothing
         elsif chunked?
-          while buf = @body.read(@buffer_size)
-            next if buf.empty?
-            data = ""
-            data << format("%x", buf.bytesize) << CRLF
-            data << buf << CRLF
-            _write_data(socket, data)
-            @sent_size += buf.bytesize
+          begin
+            buf  = ''
+            data = ''
+            while true
+              @body.readpartial( @buffer_size, buf ) # there is no need to clear buf?
+              data << format("%x", buf.bytesize) << CRLF
+              data << buf << CRLF
+              _write_data(socket, data)
+              data.clear
+              @sent_size += buf.bytesize
+            end
+          rescue EOFError # do nothing
           end
           _write_data(socket, "0#{CRLF}#{CRLF}")
         else
@@ -395,5 +464,8 @@ module WEBrick
     def _write_data(socket, data)
       socket << data
     end
+    # :startdoc:
   end
 end

data/lib/webrick/https.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # https.rb -- SSL/TLS enhancement for HTTPServer
 #
@@ -15,8 +16,28 @@ module WEBrick
     HTTP.update(SSL)
   end
+  ##
+  #--
+  # Adds SSL functionality to WEBrick::HTTPRequest
   class HTTPRequest
-    attr_reader :cipher, :server_cert, :client_cert
+    ##
+    # HTTP request SSL cipher
+    attr_reader :cipher
+    ##
+    # HTTP request server certificate
+    attr_reader :server_cert
+    ##
+    # HTTP request client certificate
+    attr_reader :client_cert
+    # :stopdoc:
     alias orig_parse parse
@@ -60,5 +81,7 @@ module WEBrick
       end
       meta
     end
+    # :startdoc:
   end
 end

data/lib/webrick/httpserver.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # httpserver.rb -- HTTPServer Class
 #
@@ -8,6 +9,7 @@
 #
 # $IPR: httpserver.rb,v 1.63 2002/10/01 17:16:32 gotoyuzo Exp $
+require 'io/wait'
 require 'webrick/server'
 require 'webrick/httputils'
 require 'webrick/httpstatus'
@@ -72,11 +74,11 @@ module WEBrick
         begin
           timeout = @config[:RequestTimeout]
           while timeout > 0
-            break if IO.select([sock], nil, nil, 0.5)
-            timeout = 0 if @status != :Running
+            break if sock.to_io.wait_readable(0.5)
+            break if @status != :Running
             timeout -= 0.5
           end
-          raise HTTPStatus::EOFError if timeout <= 0
+          raise HTTPStatus::EOFError if timeout <= 0 || @status != :Running
           raise HTTPStatus::EOFError if sock.eof?
           req.parse(sock)
           res.request_method = req.request_method
@@ -138,6 +140,10 @@ module WEBrick
       si.service(req, res)
     end
+    ##
+    # The default OPTIONS request handler says GET, HEAD, POST and OPTIONS
+    # requests are allowed.
     def do_OPTIONS(req, res)
       res["allow"] = "GET,HEAD,POST,OPTIONS"
     end
@@ -207,6 +213,10 @@ module WEBrick
       }
     end
+    ##
+    # Logs +req+ and +res+ in the access logs.  +config+ is used for the
+    # server name.
     def access_log(config, req, res)
       param = AccessLog::setup_params(config, req, res)
       @config[:AccessLog].each{|logger, fmt|
@@ -214,7 +224,13 @@ module WEBrick
       }
     end
-    class MountTable
+    ##
+    # Mount table for the path a servlet is mounted on in the directory space
+    # of the server.  Users of WEBrick can only access this indirectly via
+    # WEBrick::HTTPServer#mount, WEBrick::HTTPServer#unmount and
+    # WEBrick::HTTPServer#search_servlet
+    class MountTable # :nodoc:
       def initialize
         @tab = Hash.new
         compile

data/lib/webrick/httpservlet.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # httpservlet.rb -- HTTPServlet Utility File
 #

data/lib/webrick/httpservlet/abstract.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # httpservlet.rb -- HTTPServlet Module
 #
@@ -54,7 +55,7 @@ module WEBrick
     # Servlets can be configured via initialize.  The first argument is the
     # HTTP server the servlet is being initialized for.
     #
-    #  class Configureable < Simple
+    #  class Configurable < Simple
     #    def initialize server, color, size
     #      super server
     #      @color = color

data/lib/webrick/httpservlet/cgi_runner.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # cgi_runner.rb -- CGI launcher.
 #

data/lib/webrick/httpservlet/cgihandler.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # cgihandler.rb -- CGIHandler Class
 #
@@ -16,9 +17,20 @@ require 'webrick/httpservlet/abstract'
 module WEBrick
   module HTTPServlet
+    ##
+    # Servlet for handling CGI scripts
+    #
+    # Example:
+    #
+    #  server.mount('/cgi/my_script', WEBrick::HTTPServlet::CGIHandler,
+    #               '/path/to/my_script')
     class CGIHandler < AbstractServlet
-      Ruby = RbConfig.ruby
-      CGIRunner = "\"#{Ruby}\" \"#{WEBrick::Config::LIBDIR}/httpservlet/cgi_runner.rb\""
+      Ruby = RbConfig.ruby # :nodoc:
+      CGIRunner = "\"#{Ruby}\" \"#{WEBrick::Config::LIBDIR}/httpservlet/cgi_runner.rb\"" # :nodoc:
+      ##
+      # Creates a new CGI script servlet for the script at +name+
       def initialize(server, name)
         super(server, name)
@@ -27,10 +39,9 @@ module WEBrick
         @cgicmd = "#{CGIRunner} #{server[:CGIInterpreter]}"
       end
-      def do_GET(req, res)
-        data = nil
-        status = -1
+      # :stopdoc:
+      def do_GET(req, res)
         cgi_in = IO::popen(@cgicmd, "wb")
         cgi_out = Tempfile.new("webrick.cgiout.", @tempdir, mode: IO::BINARY)
         cgi_out.set_encoding("ASCII-8BIT")
@@ -41,6 +52,7 @@ module WEBrick
           meta = req.meta_vars
           meta["SCRIPT_FILENAME"] = @script_filename
           meta["PATH"] = @config[:CGIPathEnv]
+          meta.delete("HTTP_PROXY")
           if /mswin|bccwin|mingw/ =~ RUBY_PLATFORM
             meta["SystemRoot"] = ENV["SystemRoot"]
           end
@@ -102,6 +114,8 @@ module WEBrick
         res.body = body
       end
       alias do_POST do_GET
+      # :startdoc:
     end
   end

data/lib/webrick/httpservlet/erbhandler.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # erbhandler.rb -- ERBHandler Class
 #
@@ -56,7 +57,7 @@ module WEBrick
           res.body = evaluate(ERB.new(data), req, res)
           res['content-type'] ||=
             HTTPUtils::mime_type(@script_filename, @config[:MimeTypes])
-        rescue StandardError => ex
+        rescue StandardError
           raise
         rescue Exception => ex
           @logger.error(ex)

data/lib/webrick/httpservlet/filehandler.rb CHANGED

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # filehandler.rb -- FileHandler Module
 #
@@ -18,12 +19,29 @@ require 'webrick/httpstatus'
 module WEBrick
   module HTTPServlet
+    ##
+    # Servlet for serving a single file.  You probably want to use the
+    # FileHandler servlet instead as it handles directories and fancy indexes.
+    #
+    # Example:
+    #
+    #   server.mount('/my_page.txt', WEBrick::HTTPServlet::DefaultFileHandler,
+    #                '/path/to/my_page.txt')
+    #
+    # This servlet handles If-Modified-Since and Range requests.
     class DefaultFileHandler < AbstractServlet
+      ##
+      # Creates a DefaultFileHandler instance for the file at +local_path+.
       def initialize(server, local_path)
         super(server, local_path)
         @local_path = local_path
       end
+      # :stopdoc:
       def do_GET(req, res)
         st = File::stat(@local_path)
         mtime = st.mtime
@@ -123,13 +141,21 @@ module WEBrick
         last = filesize - 1 if last >= filesize
         return first, last
       end
+      # :startdoc:
     end
     ##
-    # Serves files from a directory
+    # Serves a directory including fancy indexing and a variety of other
+    # options.
+    #
+    # Example:
+    #
+    #   server.mount('/assets', WEBrick::HTTPServlet::FileHandler,
+    #                '/path/to/assets')
     class FileHandler < AbstractServlet
-      HandlerTable = Hash.new
+      HandlerTable = Hash.new # :nodoc:
       ##
       # Allow custom handling of requests for files with +suffix+ by class
@@ -150,19 +176,8 @@ module WEBrick
       # Creates a FileHandler servlet on +server+ that serves files starting
       # at directory +root+
       #
-      # If +options+ is a Hash the following keys are allowed:
-      #
-      # :AcceptableLanguages:: Array of languages allowed for accept-language
-      # :DirectoryCallback:: Allows preprocessing of directory requests
-      # :FancyIndexing:: If true, show an index for directories
-      # :FileCallback:: Allows preprocessing of file requests
-      # :HandlerCallback:: Allows preprocessing of requests
-      # :HandlerTable:: Maps file suffixes to file handlers.
-      #                 DefaultFileHandler is used by default but any servlet
-      #                 can be used.
-      # :NondisclosureName:: Do not show files matching this array of globs
-      # :UserDir:: Directory inside ~user to serve content from for /~user
-      #            requests.  Only works if mounted on /
+      # +options+ may be a Hash containing keys from
+      # WEBrick::Config::FileHandler or +true+ or +false+.
       #
       # If +options+ is true or false then +:FancyIndexing+ is enabled or
       # disabled respectively.
@@ -177,6 +192,8 @@ module WEBrick
         @options = default.dup.update(options)
       end
+      # :stopdoc:
       def service(req, res)
         # if this class is mounted on "/" and /~username is requested.
         # we're going to override path informations before invoking service.
@@ -409,11 +426,18 @@ module WEBrick
         }
         list.compact!
-        if    d0 = req.query["N"]; idx = 0
-        elsif d0 = req.query["M"]; idx = 1
-        elsif d0 = req.query["S"]; idx = 2
-        else  d0 = "A"           ; idx = 0
+        query = req.query
+        d0 = nil
+        idx = nil
+        %w[N M S].each_with_index do |q, i|
+          if d = query.delete(q)
+            idx ||= i
+            d0 ||= d
+          end
         end
+        d0 ||= "A"
+        idx ||= 0
         d1 = (d0 == "A") ? "D" : "A"
         if d0 == "A"
@@ -422,38 +446,66 @@ module WEBrick
           list.sort!{|a,b| b[idx] <=> a[idx] }
         end
-        res['content-type'] = "text/html"
+        namewidth = query["NameWidth"]
+        if namewidth == "*"
+          namewidth = nil
+        elsif !namewidth or (namewidth = namewidth.to_i) < 2
+          namewidth = 25
+        end
+        query = query.inject('') {|s, (k, v)| s << '&' << HTMLUtils::escape("#{k}=#{v}")}
+        type = "text/html"
+        case enc = Encoding.find('filesystem')
+        when Encoding::US_ASCII, Encoding::ASCII_8BIT
+        else
+          type << "; charset=\"#{enc.name}\""
+        end
+        res['content-type'] = type
+        title = "Index of #{HTMLUtils::escape(req.path)}"
         res.body = <<-_end_of_html_
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <HTML>
-  <HEAD><TITLE>Index of #{HTMLUtils::escape(req.path)}</TITLE></HEAD>
+  <HEAD>
+    <TITLE>#{title}</TITLE>
+    <style type="text/css">
+    <!--
+    .name, .mtime { text-align: left; }
+    .size { text-align: right; }
+    td { text-overflow: ellipsis; white-space: nowrap; overflow: hidden; }
+    table { border-collapse: collapse; }
+    tr th { border-bottom: 2px groove; }
+    //-->
+    </style>
+  </HEAD>
   <BODY>
-    <H1>Index of #{HTMLUtils::escape(req.path)}</H1>
+    <H1>#{title}</H1>
         _end_of_html_
-        res.body << "<PRE>\n"
-        res.body << " <A HREF=\"?N=#{d1}\">Name</A>                          "
-        res.body << "<A HREF=\"?M=#{d1}\">Last modified</A>         "
-        res.body << "<A HREF=\"?S=#{d1}\">Size</A>\n"
-        res.body << "<HR>\n"
+        res.body << "<TABLE width=\"100%\"><THEAD><TR>\n"
+        res.body << "<TH class=\"name\"><A HREF=\"?N=#{d1}#{query}\">Name</A></TH>"
+        res.body << "<TH class=\"mtime\"><A HREF=\"?M=#{d1}#{query}\">Last modified</A></TH>"
+        res.body << "<TH class=\"size\"><A HREF=\"?S=#{d1}#{query}\">Size</A></TH>\n"
+        res.body << "</TR></THEAD>\n"
+        res.body << "<TBODY>\n"
+        query.sub!(/\A&/, '?')
         list.unshift [ "..", File::mtime(local_path+"/.."), -1 ]
         list.each{ |name, time, size|
           if name == ".."
             dname = "Parent Directory"
-          elsif name.bytesize > 25
-            dname = name.sub(/^(.{23})(?:.*)/, '\1..')
+          elsif namewidth and name.size > namewidth
+            dname = name[0...(namewidth - 2)] << '..'
           else
             dname = name
           end
-          s =  " <A HREF=\"#{HTTPUtils::escape(name)}\">#{HTMLUtils::escape(dname)}</A>"
-          s << " " * (30 - dname.bytesize)
-          s << (time ? time.strftime("%Y/%m/%d %H:%M      ") : " " * 22)
-          s << (size >= 0 ? size.to_s : "-") << "\n"
+          s =  "<TR><TD class=\"name\"><A HREF=\"#{HTTPUtils::escape(name)}#{query if name.end_with?('/')}\">#{HTMLUtils::escape(dname)}</A></TD>"
+          s << "<TD class=\"mtime\">" << (time ? time.strftime("%Y/%m/%d %H:%M") : "") << "</TD>"
+          s << "<TD class=\"size\">" << (size >= 0 ? size.to_s : "-") << "</TD></TR>\n"
           res.body << s
         }
-        res.body << "</PRE><HR>"
+        res.body << "</TBODY></TABLE>"
+        res.body << "<HR>"
         res.body << <<-_end_of_html_
     <ADDRESS>
@@ -465,6 +517,7 @@ module WEBrick
         _end_of_html_
       end
+      # :startdoc:
     end
   end
 end