mongrel 0.2.2 → 0.3

data/README

@@ -11,26 +11,31 @@ scream without too many portability issues.
 
 == Status
 
-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 
-other frameworks, adding additional needed features, and improving the concurrency
-and speed.
-
-The current release has samples from "why the lucky stiff" for his Camping
-framework in the examples directory.  Camping is a small micro framework 
-(http://rubyforge.org/projects/camping) which should work with Mongrel if
-you use the subversion source for Camping.
-
-This is also the first release onto the new Mongrel RubyForge project
-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.
+The 0.3 release is the first official release to start supporting Ruby on Rails
+and to have a more complete DirHandler for serving directories of files.   This release
+is actually closer to a full functioning web server than the previous releases.
+
+The Rails support is pretty rough right now, but check out the bin/mongrel_rails file,
+which should be installed into your PATH if you use a gem.  You should be able to
+do the following to run your Rails applications:
+
+  > cd myrailsapp
+  > mongrel_rails 0.0.0.0 3000
+
+And then hit http://localhost:3000/ to see your app.  One thing is that if you have
+a public/index.html file then you'll get that served instead of your Rails application.
+
+People with the daemons gem installed will see that mongrel_rails will go into the
+background.  You can kill it with:
+
+  > kill -TERM `cat log/mongrel-3000.pid`
+
+Where "3000" is whatever port you told it to listen on when you ran it.
+
+The file serving is still a little rough and the redirects might not work well, but
+try it out and tell me about any weird errors.  File uploads will definitely have some
+problems.
+
 
 == Install
 
@@ -43,6 +48,7 @@ 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
@@ -104,12 +110,8 @@ With the core of Mongrel completed I'm now turning to the next set of features
 to make Mongrel useful for hosting web applications in a heavily utilized
 production environment.  Right now I'm looking at:
 
-* Fast static file handling with directory listings.
-* More testing on more platforms.
 * An idea I've had for an insane caching handler which could speed up quite a
 few deployments.
-* General little things most web servers need.
-* A nice management system or interface for controlling mongrel servers.
 
 Overall though the goal of Mongrel is to be just enough HTTP to serve a Ruby
 web application that sits behind a more complete web server.  Everything 
@@ -117,7 +119,7 @@ in the next will focus on actually hosting the major web frameworks for Ruby:
 
 * Camping -- because it's already done (thanks Why).
 * Ruby on Rails -- that's where my bread is buttered right now.
-* Nitro -- George is a nice guy, and Nitro is thread safe.  Might be fun.
+* Nitro -- Nitro folks have already hooked this up and started using it.  Nice.
 * ????? -- Others people might be interested in.
 
 == Contact

data/Rakefile

@@ -9,8 +9,7 @@ include FileUtils
 
 setup_tests
 setup_clean ["ext/http11/Makefile", "pkg", "lib/*.bundle", "ext/http11/*.bundle"]
-setup_rdoc ['README', 'LICENSE', 'COPYING', 'lib/*.rb',
-            'doc/**/*.rdoc', 'ext/http11/http11.c']
+setup_rdoc ['README', 'LICENSE', 'COPYING', 'lib/*.rb', 'doc/**/*.rdoc', 'ext/http11/http11.c']
 
 desc "Does a full compile, test run"
 task :default => [:compile, :test]
@@ -27,4 +26,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.2",  "Zed A. Shaw", summary, [], test_file)
+setup_gem("mongrel", "0.3",  "Zed A. Shaw", summary, ['mongrel_rails'], test_file)

data/bin/mongrel_rails

@@ -0,0 +1,114 @@
+require 'rubygems'
+require 'mongrel'
+require 'cgi'
+begin
+  require 'daemons/daemonize'
+  HAVE_DAEMONS=true
+rescue
+  HAVE_DAEMONS=false
+end
+
+
+class CGIFixed < ::CGI
+  public :env_table
+  attr_reader :options
+  
+  def initialize(params, data, out, *args)
+    @env_table = params
+    @args = *args
+    @input = StringIO.new(data)
+    @out = out
+    @options = {}
+    super(*args)
+  end
+  
+  def header(options = "text/html")
+    if options.class == Hash
+      # passing in a header so need to keep the status around and other options
+      @options = options
+    end
+
+    super(options)
+  end
+
+  def status
+    s = @options["Status"] || @options["status"]
+    s[0 .. s.index(' ')] || "200"
+  end
+
+  def args
+    @args
+  end
+  
+  def env_table
+    @env_table
+  end
+  
+  def stdinput
+    @input
+  end
+  
+  def stdoutput
+    @out
+  end
+end
+
+
+class RailsHandler < Mongrel::HttpHandler
+  def initialize(dir)
+    @files = Mongrel::DirHandler.new(dir,false)
+    @guard = Mutex.new
+  end
+  
+  def process(request, response)
+    # not static, need to talk to rails
+    return if response.socket.closed?
+    
+    if @files.can_serve(request.params["PATH_INFO"])
+      @files.process(request,response)
+    else
+      cgi = CGIFixed.new(request.params, request.body, response.socket)
+      begin
+        
+        @guard.synchronize do
+          # Rails is not thread safe so must be run entirely within synchronize 
+          Dispatcher.dispatch(cgi, ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS, response.body)
+        end
+    
+        response.status = cgi.status
+        response.send_status
+        response.send_body
+      rescue Object => rails_error
+        STDERR.puts "calling Dispatcher.dispatch #{rails_error}"
+        STDERR.puts rails_error.backtrace.join("\n")
+      end
+    end
+  end
+end
+
+
+if ARGV.length != 2
+  STDERR.puts "usage:  mongrel_rails <host> <port>"
+  exit(1)
+end
+
+# store this for later since Daemonize insists on going to the / root
+cwd = Dir.pwd
+
+if HAVE_DAEMONS
+  STDERR.puts "Running Mongrel in the background.  See log/mongrel.log for errors."
+  Daemonize.daemonize(log_file=File.join(cwd,"log","mongrel.log"))
+else
+  STDERR.puts "Unable to daemonize.  Running in foreground.  Use CTRL-C to stop."
+end
+
+# and go back
+Dir.chdir(cwd) do
+  require 'config/environment'
+  open(File.join(cwd,"log/mongrel-#{ARGV[1]}.pid"),"w") {|f| f.write(Process.pid) }
+  h = Mongrel::HttpServer.new(ARGV[0], ARGV[1])
+  h.register("/", RailsHandler.new(File.join(cwd,"public")))
+  h.run
+  
+  h.acceptor.join
+end

data/doc/rdoc/classes/Mongrel.html

@@ -89,6 +89,13 @@ to service web application requests fast as possible.
 
    </div>
 
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">add_mime_type</a>&nbsp;&nbsp;
+      </div>
+    </div>
 
   </div>
 
@@ -141,6 +148,29 @@ href="Mongrel/Const.html">Mongrel::Const</a>.
 
 
     <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="Mongrel.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('Mongrel.src/M000001.html');return false;">
+          <span class="method-name">add_mime_type</span><span class="method-args">(extension, type)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+There is a small number of default mime types for extensions, but this lets
+you add any others you&#8217;ll need when serving content.
+</p>
+        </div>
+      </div>
+
+
+    </div>
 
 
   </div>

data/doc/rdoc/classes/Mongrel.src/M000001.html

@@ -0,0 +1,18 @@
+<?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>
+<head>
+  <title>add_mime_type (Mongrel)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>     <span class="ruby-comment cmt"># File lib/mongrel.rb, line 577</span>
+577:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_mime_type</span>(<span class="ruby-identifier">extension</span>, <span class="ruby-identifier">type</span>)
+578:     <span class="ruby-constant">MIME_TYPES</span>[<span class="ruby-identifier">extension</span>] = <span class="ruby-identifier">type</span>
+579:   <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

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

@@ -230,7 +230,7 @@ DNS resolves. It is only here for completeness for the CGI standard.
           <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.
+href="HttpServer.html#M000014">HttpServer.new</a>(host,port) call.
 
 </td>
         </tr>
@@ -241,7 +241,7 @@ href="HttpServer.html#M000012">HttpServer.new</a>(host,port) call.
           <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.
+href="HttpServer.html#M000014">HttpServer.new</a>(host,port) call.
 
 </td>
         </tr>

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

@@ -103,10 +103,11 @@ than it simply gives a 404.
       <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;
+      <a href="#M000010">can_serve</a>&nbsp;&nbsp;
+      <a href="#M000009">new</a>&nbsp;&nbsp;
+      <a href="#M000013">process</a>&nbsp;&nbsp;
+      <a href="#M000011">send_dir_listing</a>&nbsp;&nbsp;
+      <a href="#M000012">send_file</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -118,9 +119,35 @@ than it simply gives a 404.
     <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">MIME_TYPES</td>
+          <td>=</td>
+          <td class="context-item-value">{       &quot;.css&quot;        =&gt;  &quot;text/css&quot;,       &quot;.gif&quot;        =&gt;  &quot;image/gif&quot;,       &quot;.htm&quot;        =&gt;  &quot;text/html&quot;,       &quot;.html&quot;       =&gt;  &quot;text/html&quot;,       &quot;.jpeg&quot;       =&gt;  &quot;image/jpeg&quot;,       &quot;.jpg&quot;        =&gt;  &quot;image/jpeg&quot;,       &quot;.js&quot;         =&gt;  &quot;text/javascript&quot;,       &quot;.png&quot;        =&gt;  &quot;image/png&quot;,       &quot;.swf&quot;        =&gt;  &quot;application/x-shockwave-flash&quot;,       &quot;.txt&quot;        =&gt;  &quot;text/plain&quot;</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
 
 
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
 
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">path</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
       
 
 
@@ -128,61 +155,97 @@ than it simply gives a 404.
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000008" class="method-detail">
-        <a name="M000008"></a>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></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 href="DirHandler.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000009.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(path, listing_allowed=true, index_html=&quot;index.html&quot;)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+You give it the path to the directory root and an (optional)
+</p>
         </div>
       </div>
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000011" class="method-detail">
-        <a name="M000011"></a>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
 
         <div class="method-heading">
-          <a href="DirHandler.src/M000011.html" target="Code" class="method-signature"
-            onclick="popupCode('DirHandler.src/M000011.html');return false;">
+          <a href="DirHandler.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000010.html');return false;">
+          <span class="method-name">can_serve</span><span class="method-args">(path_info)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Checks if the given path can be served and returns the full path (or nil if
+not).
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+
+        <div class="method-heading">
+          <a href="DirHandler.src/M000013.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000013.html');return false;">
           <span class="method-name">process</span><span class="method-args">(request, response)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+Process the request to either serve a file or a directory listing if
+allowed (based on the listing_allowed paramter to the constructor).
+</p>
         </div>
       </div>
 
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
 
         <div class="method-heading">
-          <a href="DirHandler.src/M000009.html" target="Code" class="method-signature"
-            onclick="popupCode('DirHandler.src/M000009.html');return false;">
+          <a href="DirHandler.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000011.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">
+          <p>
+Returns a simplistic directory listing if they&#8217;re enabled, otherwise
+a 403. Base is the base URI from the REQUEST_URI, dir is the directory to
+serve on the file system (comes from <a
+href="DirHandler.html#M000010">can_serve</a>()), and response is the <a
+href="HttpResponse.html">HttpResponse</a> object to send the results on.
+</p>
         </div>
       </div>
 
-      <div id="method-M000010" class="method-detail">
-        <a name="M000010"></a>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
 
         <div class="method-heading">
-          <a href="DirHandler.src/M000010.html" target="Code" class="method-signature"
-            onclick="popupCode('DirHandler.src/M000010.html');return false;">
+          <a href="DirHandler.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('DirHandler.src/M000012.html');return false;">
           <span class="method-name">send_file</span><span class="method-args">(req, response)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+Sends the contents of a file back to the user. Not terribly efficient since
+it&#8217;s opening and closing the file for each read.
+</p>
         </div>
       </div>