mongrel 0.2.1 → 0.2.2

data/README

@@ -11,7 +11,7 @@ scream without too many portability issues.
 
 == Status
 
-The 0.2.1 release of Mongrel features an HTTP core server that is the fastest possible
+The 0.2.2 release of Mongrel features an HTTP core server that is the fastest possible
 thing I could get without using something other than Ruby.  It features a few bug fixes,
 but mostly just a change to the Mongrel::HttpResponse class to make it more feature 
 complete.  The remaining development will be spent getting Mongrel to work with 
@@ -28,6 +28,9 @@ page found at http://rubyforge.org/projects/mongrel/ thanks to Tom Copland.
 I'll be looking to automate management of this, but feel free to use
 rubyforge to post feature requests, bugs, and join the mailing list.
 
+Finally, it now supports all CGI parameters that don't cause a performance hit,
+and it has a Mongrel::DirHandler which can serve files out of a directory and
+do (optional) directory listings.
 
 == Install
 
@@ -40,7 +43,6 @@ who can build it for you.
 
 Finally, the source includes a setup.rb for those who hate RubyGems.
 
-
 == Usage
 
 The examples/simpletest.rb file has the following code as the simplest
@@ -59,6 +61,7 @@ example:
 
  h = Mongrel::HttpServer.new("0.0.0.0", "3000")
  h.register("/test", SimpleHandler.new)
+ h.register("/files", DirHandler.new("."))
  h.run.join
 
 If you run this and access port 3000 with a browser it will say
@@ -66,6 +69,11 @@ If you run this and access port 3000 with a browser it will say
 give a simple 404.  Check out the Mongrel::Error404Handler for a 
 basic way to give a more complex 404 message.
 
+This also shows the DirHandler with directory listings.  This is still
+rough but it should work for basic hosting.  *File extension to mime
+type mapping is missing though.*
+
+
 == Speed
 
 The 0.2.1 release probably consists of the most effort I've ever put into 

data/Rakefile

@@ -27,4 +27,4 @@ setup_extension("http11", "http11")
 
 summary = "An experimental fast simple web server for Ruby."
 test_file = "test/test_ws.rb"
-setup_gem("mongrel", "0.2.1",  "Zed A. Shaw", summary, [], test_file)
+setup_gem("mongrel", "0.2.2",  "Zed A. Shaw", summary, [], test_file)

data/doc/rdoc/classes/Mongrel.html

@@ -100,7 +100,9 @@ to service web application requests fast as possible.
     <div id="class-list">
       <h3 class="section-bar">Classes and Modules</h3>
 
-      Class <a href="Mongrel/Error404Handler.html" class="link">Mongrel::Error404Handler</a><br />
+      Module <a href="Mongrel/Const.html" class="link">Mongrel::Const</a><br />
+Class <a href="Mongrel/DirHandler.html" class="link">Mongrel::DirHandler</a><br />
+Class <a href="Mongrel/Error404Handler.html" class="link">Mongrel::Error404Handler</a><br />
 Class <a href="Mongrel/HeaderOut.html" class="link">Mongrel::HeaderOut</a><br />
 Class <a href="Mongrel/HttpHandler.html" class="link">Mongrel::HttpHandler</a><br />
 Class <a href="Mongrel/HttpParser.html" class="link">Mongrel::HttpParser</a><br />
@@ -120,6 +122,14 @@ Class <a href="Mongrel/URIClassifier.html" class="link">Mongrel::URIClassifier</
           <td class="context-item-name">HTTP_STATUS_CODES</td>
           <td>=</td>
           <td class="context-item-value">{       100  =&gt; 'Continue',      101  =&gt; 'Switching Protocols',      200  =&gt; 'OK',      201  =&gt; 'Created',      202  =&gt; 'Accepted',      203  =&gt; 'Non-Authoritative Information',      204  =&gt; 'No Content',      205  =&gt; 'Reset Content',      206  =&gt; 'Partial Content',      300  =&gt; 'Multiple Choices',      301  =&gt; 'Moved Permanently',      302  =&gt; 'Moved Temporarily',      303  =&gt; 'See Other',      304  =&gt; 'Not Modified',      305  =&gt; 'Use Proxy',      400  =&gt; 'Bad Request',      401  =&gt; 'Unauthorized',      402  =&gt; 'Payment Required',      403  =&gt; 'Forbidden',      404  =&gt; 'Not Found',      405  =&gt; 'Method Not Allowed',      406  =&gt; 'Not Acceptable',      407  =&gt; 'Proxy Authentication Required',      408  =&gt; 'Request Time-out',      409  =&gt; 'Conflict',      410  =&gt; 'Gone',      411  =&gt; 'Length Required',      412  =&gt; 'Precondition Failed',      413  =&gt; 'Request Entity Too Large',      414  =&gt; 'Request-URI Too Large',      415  =&gt; 'Unsupported Media Type',      500  =&gt; 'Internal Server Error',      501  =&gt; 'Not Implemented',      502  =&gt; 'Bad Gateway',      503  =&gt; 'Service Unavailable',      504  =&gt; 'Gateway Time-out',      505  =&gt; 'HTTP Version not supported'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Every standard HTTP code mapped to the appropriate message. These are used
+so frequently that they are placed directly in <a
+href="Mongrel.html">Mongrel</a> for easy access rather than <a
+href="Mongrel/Const.html">Mongrel::Const</a>.
+
+</td>
         </tr>
         </table>
       </div>

data/doc/rdoc/classes/Mongrel/Const.html

@@ -0,0 +1,342 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Mongrel::Const</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Mongrel::Const</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/mongrel_rb.html">
+                lib/mongrel.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Frequently used constants when constructing requests or responses. Many
+times the constant just refers to a string with the same contents. Using
+these constants gave about a 3% to 10% performance improvement over using
+the strings directly. Symbols did not really improve things much compared
+to constants.
+</p>
+<p>
+While <a href="../Mongrel.html">Mongrel</a> does try to emulate the CGI/1.2
+protocol, it does not use the REMOTE_IDENT, REMOTE_USER, or REMOTE_HOST
+parameters since those are either a security problem or too taxing on
+performance.
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">PATH_INFO</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;PATH_INFO&quot;</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+This is the part of the path after the SCRIPT_NAME. <a
+href="URIClassifier.html">URIClassifier</a> will determine this.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SCRIPT_NAME</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;SCRIPT_NAME&quot;</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+This is the intial part that your handler is identified as by <a
+href="URIClassifier.html">URIClassifier</a>.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">REQUEST_URI</td>
+          <td>=</td>
+          <td class="context-item-value">'REQUEST_URI'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+The original URI requested by the client. Passed to <a
+href="URIClassifier.html">URIClassifier</a> to build PATH_INFO and
+SCRIPT_NAME.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">CONTENT_LENGTH</td>
+          <td>=</td>
+          <td class="context-item-value">'CONTENT_LENGTH'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Content length (also available as HTTP_CONTENT_LENGTH).
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">HTTP_CONTENT_LENGTH</td>
+          <td>=</td>
+          <td class="context-item-value">'HTTP_CONTENT_LENGTH'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Content length (also available as CONTENT_LENGTH).
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">CONTENT_TYPE</td>
+          <td>=</td>
+          <td class="context-item-value">'CONTENT_TYPE'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Content type (also available as HTTP_CONTENT_TYPE).
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">HTTP_CONTENT_TYPE</td>
+          <td>=</td>
+          <td class="context-item-value">'HTTP_CONTENT_TYPE'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Content type (also available as CONTENT_TYPE).
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">GATEWAY_INTERFACE</td>
+          <td>=</td>
+          <td class="context-item-value">'GATEWAY_INTERFACE'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Gateway interface key in the <a href="HttpRequest.html">HttpRequest</a>
+parameters.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">GATEWAY_INTERFACE_VALUE</td>
+          <td>=</td>
+          <td class="context-item-value">'CGI/1.2'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+We claim to support CGI/1.2.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">REMOTE_ADDR</td>
+          <td>=</td>
+          <td class="context-item-value">'REMOTE_ADDR'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Hosts remote IP address. <a href="../Mongrel.html">Mongrel</a> does not do
+DNS resolves since that slows processing down considerably.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">REMOTE_HOST</td>
+          <td>=</td>
+          <td class="context-item-value">'REMOTE_HOST'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+This is not given since <a href="../Mongrel.html">Mongrel</a> does not do
+DNS resolves. It is only here for completeness for the CGI standard.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SERVER_NAME</td>
+          <td>=</td>
+          <td class="context-item-value">'SERVER_NAME'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+The name/host of our server as given by the <a
+href="HttpServer.html#M000012">HttpServer.new</a>(host,port) call.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SERVER_PORT</td>
+          <td>=</td>
+          <td class="context-item-value">'SERVER_PORT'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+The port of our server as given by the <a
+href="HttpServer.html#M000012">HttpServer.new</a>(host,port) call.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SERVER_PROTOCOL</td>
+          <td>=</td>
+          <td class="context-item-value">'SERVER_PROTOCOL'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Official server protocol key in the <a
+href="HttpRequest.html">HttpRequest</a> parameters.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SERVER_PROTOCOL_VALUE</td>
+          <td>=</td>
+          <td class="context-item-value">'HTTP/1.1'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+<a href="../Mongrel.html">Mongrel</a> claims to support HTTP/1.1.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SERVER_SOFTWARE</td>
+          <td>=</td>
+          <td class="context-item-value">'SERVER_SOFTWARE'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+The actual server software being used (it&#8217;s <a
+href="../Mongrel.html">Mongrel</a> man).
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">MONGREL_VERSION</td>
+          <td>=</td>
+          <td class="context-item-value">'Mongrel 0.2.2'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Current <a href="../Mongrel.html">Mongrel</a> version (used for
+SERVER_SOFTWARE and other response headers).
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">ERROR_404_RESPONSE</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;HTTP/1.1 404 Not Found\r\nConnection: close\r\nServer: #{MONGREL_VERSION}\r\n\r\nNOT FOUND&quot;</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+The standard empty 404 response for bad requests. Use Error4040Handler for
+custom stuff.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">ERROR_503_RESPONSE</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;HTTP/1.1 503 Service Unavailable\r\n\r\nBUSY&quot;</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+A common header for indicating the server is too busy. Not used yet.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">CHUNK_SIZE</td>
+          <td>=</td>
+          <td class="context-item-value">(16 * 1024)</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+The basic max request size we&#8217;ll try to read.
+
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/rdoc/classes/Mongrel/DirHandler.html

@@ -0,0 +1,201 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Mongrel::DirHandler</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Mongrel::DirHandler</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/mongrel_rb.html">
+                lib/mongrel.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="HttpHandler.html">
+                HttpHandler
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Serves the contents of a directory. You give it the path to the root where
+the files are located, and it tries to find the files based on the
+PATH_INFO inside the directory. If the requested path is a directory then
+it returns a simple directory listing.
+</p>
+<p>
+It does a simple protection against going outside it&#8217;s root path by
+converting all paths to an absolute expanded path, and then making sure
+that the final expanded path includes the root path. If it doesn&#8217;t
+than it simply gives a 404.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000008">new</a>&nbsp;&nbsp;
+      <a href="#M000011">process</a>&nbsp;&nbsp;
+      <a href="#M000009">send_dir_listing</a>&nbsp;&nbsp;
+      <a href="#M000010">send_file</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="DirHandler.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000008.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(path, listing_allowed=true)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+
+        <div class="method-heading">
+          <a href="DirHandler.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000011.html');return false;">
+          <span class="method-name">process</span><span class="method-args">(request, response)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="DirHandler.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000009.html');return false;">
+          <span class="method-name">send_dir_listing</span><span class="method-args">(base, dir, response)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+
+        <div class="method-heading">
+          <a href="DirHandler.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000010.html');return false;">
+          <span class="method-name">send_file</span><span class="method-args">(req, response)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>