1 files changed, 42 insertions, 37 deletions

diff --git a/lib/xmlrpc/httpserver.rb b/lib/xmlrpc/httpserver.rb
index dd0d7417c1..9afb5fd5ec 100644
--- a/lib/xmlrpc/httpserver.rb
+++ b/lib/xmlrpc/httpserver.rb
@@ -1,3 +1,7 @@
+#
+# Implements a simple HTTP-server by using John W. Small's (jsmall@laser.net) 
+# ruby-generic-server.
+# 
 # Copyright (C) 2001, 2002, 2003 by Michael Neumann (mneumann@ntecs.de)
 #
 # $Id$
@@ -6,14 +10,12 @@
 
 require "gserver"
 
-# Implements a simple HTTP-server by using John W. Small's (jsmall@laser.net)
-# ruby-generic-server: GServer.
 class HttpServer < GServer
 
   ##
-  # +handle_obj+ specifies the object, that receives calls from +request_handler+
-  # and +ip_auth_handler+
-  def initialize(handle_obj, port = 8080, host = DEFAULT_HOST, maxConnections = 4,
+  # handle_obj specifies the object, that receives calls to request_handler
+  # and ip_auth_handler 
+  def initialize(handle_obj, port = 8080, host = DEFAULT_HOST, maxConnections = 4, 
                  stdlog = $stdout, audit = true, debug = true)
     @handler = handle_obj
     super(port, host, maxConnections, stdlog, audit, debug)
@@ -21,16 +23,19 @@ class HttpServer < GServer
 
 private
 
+  # Constants -----------------------------------------------
+  
   CRLF        = "\r\n"
   HTTP_PROTO  = "HTTP/1.0"
   SERVER_NAME = "HttpServer (Ruby #{RUBY_VERSION})"
 
-  # Default header for the server name
   DEFAULT_HEADER = {
     "Server" => SERVER_NAME
   }
 
-  # Mapping of status codes and error messages
+  ##
+  # Mapping of status code and error message
+  #
   StatusCodeMapping = {
     200 => "OK",
     400 => "Bad Request",
@@ -40,26 +45,28 @@ private
     500 => "Internal Server Error"
   }
 
+  # Classes -------------------------------------------------
+  
   class Request
     attr_reader :data, :header, :method, :path, :proto
-
+    
     def initialize(data, method=nil, path=nil, proto=nil)
       @header, @data = Table.new, data
       @method, @path, @proto = method, path, proto
     end
-
+    
     def content_length
       len = @header['Content-Length']
       return nil if len.nil?
-      return len.to_i
+      return len.to_i 
     end
-
+    
   end
-
+  
   class Response
     attr_reader   :header
     attr_accessor :body, :status, :status_message
-
+    
     def initialize(status=200)
       @status = status
       @status_message = nil
@@ -67,12 +74,15 @@ private
     end
   end
 
-  # A case-insensitive Hash class for HTTP header
+
+  ##
+  # a case-insensitive Hash class for HTTP header
+  #
   class Table
     include Enumerable
 
     def initialize(hash={})
-      @hash = hash
+      @hash = hash 
       update(hash)
     end
 
@@ -93,17 +103,17 @@ private
       @hash.each {|k,v| yield k.capitalize, v }
     end
 
-    # Output the Hash table for the HTTP header
     def writeTo(port)
       each { |k,v| port << "#{k}: #{v}" << CRLF }
     end
   end # class Table
 
 
-  # Generates a Hash with the HTTP headers
-  def http_header(header=nil) # :doc:
+  # Helper Methods ------------------------------------------
+
+  def http_header(header=nil)
     new_header = Table.new(DEFAULT_HEADER)
-    new_header.update(header) unless header.nil?
+    new_header.update(header) unless header.nil? 
 
     new_header["Connection"] = "close"
     new_header["Date"]       = http_date(Time.now)
@@ -111,16 +121,13 @@ private
     new_header
   end
 
-  # Returns a string which represents the time as rfc1123-date of HTTP-date
-  def http_date( aTime ) # :doc:
+  def http_date( aTime )
     aTime.gmtime.strftime( "%a, %d %b %Y %H:%M:%S GMT" )
   end
 
-  # Returns a string which includes the status code message as,
-  # http headers, and body for the response.
-  def http_resp(status_code, status_message=nil, header=nil, body=nil) # :doc:
+  def http_resp(status_code, status_message=nil, header=nil, body=nil)
     status_message ||= StatusCodeMapping[status_code]
-
+    
     str = ""
     str << "#{HTTP_PROTO} #{status_code} #{status_message}" << CRLF
     http_header(header).writeTo(str)
@@ -129,11 +136,9 @@ private
     str
   end
 
-  # Handles the HTTP request and writes the response back to the client, +io+.
-  #
-  # If an Exception is raised while handling the request, the client will receive
-  # a 500 "Internal Server Error" message.
-  def serve(io) # :doc:
+  # Main Serve Loop -----------------------------------------
+  
+  def serve(io)  
     # perform IP authentification
     unless @handler.ip_auth_handler(io)
       io << http_resp(403, "Forbidden")
@@ -144,28 +149,28 @@ private
     if io.gets =~ /^(\S+)\s+(\S+)\s+(\S+)/
       request = Request.new(io, $1, $2, $3)
     else
-      io << http_resp(400, "Bad Request")
+      io << http_resp(400, "Bad Request") 
       return
     end
-
+     
     # parse HTTP headers
     while (line=io.gets) !~ /^(\n|\r)/
       if line =~ /^([\w-]+):\s*(.*)$/
-        request.header[$1] = $2.strip
+	request.header[$1] = $2.strip
       end
     end
 
-    io.binmode
+    io.binmode    
     response = Response.new
 
     # execute request handler
     @handler.request_handler(request, response)
-
+   
     # write response back to the client
     io << http_resp(response.status, response.status_message,
-                    response.header, response.body)
+                    response.header, response.body) 
 
-  rescue Exception
+  rescue Exception => e
     io << http_resp(500, "Internal Server Error")
   end