webrick 1.3.1

data/lib/webrick/utils.rb

@@ -0,0 +1,241 @@
+#
+# utils.rb -- Miscellaneous utilities
+#
+# Author: IPR -- Internet Programming with Ruby -- writers
+# Copyright (c) 2001 TAKAHASHI Masayoshi, GOTOU Yuuzou
+# Copyright (c) 2002 Internet Programming with Ruby writers. All rights
+# reserved.
+#
+# $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
+
+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)
+    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
+    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)
+        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")
+      end
+    end
+    module_function :su
+
+    ##
+    # The server hostname
+    def getservername
+      host = Socket::gethostname
+      begin
+        Socket::gethostbyname(host)[0]
+      rescue
+        host
+      end
+    end
+    module_function :getservername
+
+    ##
+    # 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)
+      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
+      }
+      raise last_error if sockets.empty?
+      return sockets
+    end
+    module_function :create_listeners
+
+    ##
+    # Characters used to generate random strings
+    RAND_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" +
+                 "0123456789" +
+                 "abcdefghijklmnopqrstuvwxyz"
+
+    ##
+    # Generates a random string of length +len+
+    def random_string(len)
+      rand_max = RAND_CHARS.bytesize
+      ret = ""
+      len.times{ ret << RAND_CHARS[rand(rand_max)] }
+      ret
+    end
+    module_function :random_string
+
+    ###########
+
+    require "thread"
+    require "timeout"
+    require "singleton"
+
+    ##
+    # Class used to manage timeout handlers across multiple threads.
+    #
+    # Timeout handlers should be managed by using the class methods which are
+    # synchronized.
+    #
+    #   id = TimeoutHandler.register(10, Timeout::Error)
+    #   begin
+    #     sleep 20
+    #     puts 'foo'
+    #   ensure
+    #     TimeoutHandler.cancel(id)
+    #   end
+    #
+    # will raise Timeout::Error
+    #
+    #   id = TimeoutHandler.register(10, Timeout::Error)
+    #   begin
+    #     sleep 5
+    #     puts 'foo'
+    #   ensure
+    #     TimeoutHandler.cancel(id)
+    #   end
+    #
+    # will print 'foo'
+    #
+    class TimeoutHandler
+      include Singleton
+
+      ##
+      # Mutex used to synchronize access across threads
+      TimeoutMutex = Mutex.new # :nodoc:
+
+      ##
+      # Registers a new timeout handler
+      #
+      # +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)
+        }
+      end
+
+      ##
+      # Cancels the timeout handler +id+
+      def TimeoutHandler.cancel(id)
+        TimeoutMutex.synchronize{
+          instance.cancel(Thread.current, id)
+        }
+      end
+
+      def initialize
+        @timeout_info = Hash.new
+        Thread.start{
+          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
+              }
+            }
+            sleep 0.5
+          end
+        }
+      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
+        }
+      end
+
+      ##
+      # Registers a new timeout handler
+      #
+      # +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
+      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)
+          end
+          return true
+        end
+        return false
+      end
+    end
+
+    ##
+    # Executes the passed block and raises +exception+ if execution takes more
+    # than +seconds+.
+    #
+    # If +seconds+ is zero or nil, simply executes the block
+    def timeout(seconds, exception=Timeout::Error)
+      return yield if seconds.nil? or seconds.zero?
+      # raise ThreadError, "timeout within critical session" if Thread.critical
+      id = TimeoutHandler.register(seconds, exception)
+      begin
+        yield(seconds)
+      ensure
+        TimeoutHandler.cancel(id)
+      end
+    end
+    module_function :timeout
+  end
+end

data/lib/webrick/version.rb

@@ -0,0 +1,13 @@
+#--
+# version.rb -- version and release date
+#
+# Author: IPR -- Internet Programming with Ruby -- writers
+# Copyright (c) 2000 TAKAHASHI Masayoshi, GOTOU YUUZOU
+# Copyright (c) 2003 Internet Programming with Ruby writers. All rights
+# reserved.
+#
+# $IPR: version.rb,v 1.74 2003/07/22 19:20:43 gotoyuzo Exp $
+
+module WEBrick
+  VERSION      = "1.3.1"
+end

data/sample/webrick/demo-app.rb

@@ -0,0 +1,66 @@
+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

@@ -0,0 +1,12 @@
+#!/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

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

data/sample/webrick/demo-urlencoded.cgi

@@ -0,0 +1,12 @@
+#!/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, "application/x-www-form-urlencoded")
+cgi.start

data/sample/webrick/hello.cgi

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require "webrick/cgi"
+
+class HelloCGI < WEBrick::CGI
+  def do_GET(req, res)
+    res["content-type"] = "text/plain"
+    res.body = "Hello, world.\n"
+  end
+end
+
+HelloCGI.new.start

data/sample/webrick/hello.rb

@@ -0,0 +1,8 @@
+require "webrick"
+
+class HelloServlet < WEBrick::HTTPServlet::AbstractServlet
+  def do_GET(req, res)
+    res["content-type"] = "text/plain"
+    res.body = "Hello, world.\n"
+  end
+end

data/sample/webrick/httpd.rb

@@ -0,0 +1,23 @@
+require "webrick"
+
+httpd = WEBrick::HTTPServer.new(
+  :DocumentRoot => File::dirname(__FILE__),
+  :Port         => 10080,
+  :Logger       => WEBrick::Log.new($stderr, WEBrick::Log::DEBUG),
+  :AccessLog    => [
+    [ $stderr, WEBrick::AccessLog::COMMON_LOG_FORMAT  ],
+    [ $stderr, WEBrick::AccessLog::REFERER_LOG_FORMAT ],
+    [ $stderr, WEBrick::AccessLog::AGENT_LOG_FORMAT   ],
+  ],
+  :CGIPathEnv   => ENV["PATH"]   # PATH environment variable for CGI.
+)
+
+require "./hello"
+httpd.mount("/hello", HelloServlet)
+
+require "./demo-servlet"
+httpd.mount("/urlencoded", DemoServlet, "application/x-www-form-urlencoded")
+httpd.mount("/multipart", DemoServlet, "multipart/form-data")
+
+trap(:INT){ httpd.shutdown }
+httpd.start

data/sample/webrick/httpproxy.rb

@@ -0,0 +1,25 @@
+require "webrick"
+require "webrick/httpproxy"
+
+# The :ProxyContentHandler proc will be invoked before sending a response to
+# the User-Agent.  You can inspect the pair of request and response messages
+# (or edit the response message if necessary).
+
+pch = Proc.new{|req, res|
+  p [ req.request_line, res.status_line ]
+}
+
+def upstream_proxy
+  if prx = ENV["http_proxy"]
+    return URI.parse(prx)
+  end
+  return nil
+end
+
+httpd = WEBrick::HTTPProxyServer.new(
+  :Port     => 10080,
+  :ProxyContentHandler => pch,
+  :ProxyURI => upstream_proxy
+)
+Signal.trap(:INT){ httpd.shutdown }
+httpd.start

data/sample/webrick/httpsd.rb

@@ -0,0 +1,33 @@
+require "webrick"
+require "webrick/https"
+
+hostname = WEBrick::Utils::getservername
+subject = [["O", "ruby-lang.org"], ["OU", "sample"], ["CN", hostname]]
+comment = "Comment for self-signed certificate"
+
+httpd = WEBrick::HTTPServer.new(
+  :DocumentRoot   => File::dirname(__FILE__),
+  :Port           => 10443,
+  :SSLEnable      => true,
+
+  # Specify key pair and server certificate.
+  # :SSLPrivateKey  => OpenSSL::PKey::RSA.new(File.read("server.key")),
+  # :SSLCertificate => OpenSSL::X509::Certificate.new(File.read("server.crt")),
+
+  # specify the following SSL options if you want to use auto
+  # generated self-signed certificate.
+  :SSLCertName    => subject,
+  :SSLComment     => comment,
+
+  :CGIPathEnv     => ENV["PATH"]  # PATH environment variable for CGI.
+)
+
+require "./hello"
+httpd.mount("/hello", HelloServlet)
+
+require "./demo-servlet"
+httpd.mount("/urlencoded", DemoServlet, "application/x-www-form-urlencoded")
+httpd.mount("/multipart", DemoServlet, "multipart/form-data")
+
+trap(:INT){ httpd.shutdown }
+httpd.start