mongrel 0.3.5 → 0.3.6

data/lib/mongrel/cgi.rb

@@ -0,0 +1,147 @@
+require 'cgi'
+
+module Mongrel
+    # The beginning of a complete wrapper around Mongrel's internal HTTP processing
+  # system but maintaining the original Ruby CGI module.  Use this only as a crutch
+  # to get existing CGI based systems working.  It should handle everything, but please
+  # notify me if you see special warnings.  This work is still very alpha so I need 
+  # testers to help work out the various corner cases.
+  class CGIWrapper < ::CGI
+    public :env_table
+    attr_reader :options
+
+    # these are stripped out of any keys passed to CGIWrapper.header function
+    REMOVED_KEYS = [ "nph","status","server","connection","type",
+                     "charset","length","language","expires"]
+
+    # Takes an HttpRequest and HttpResponse object, plus any additional arguments
+    # normally passed to CGI.  These are used internally to create a wrapper around
+    # the real CGI while maintaining Mongrel's view of the world.
+    def initialize(request, response, *args)
+      @request = request
+      @response = response
+      @args = *args
+      @input = StringIO.new(request.body)
+      @head = {}
+      @out_called = false
+      super(*args)
+    end
+    
+    # The header is typically called to send back the header.  In our case we
+    # collect it into a hash for later usage.
+    #
+    # nph -- Mostly ignored.  It'll output the date.
+    # connection -- Completely ignored.  Why is CGI doing this?
+    # length -- Ignored since Mongrel figures this out from what you write to output.
+    # 
+    def header(options = "text/html")
+      # if they pass in a string then just write the Content-Type
+      if options.class == String
+        @head['Content-Type'] = options unless @head['Content-Type']
+      else
+        # convert the given options into what Mongrel wants
+        @head['Content-Type'] = options['type'] || "text/html"
+        @head['Content-Type'] += "; charset=" + options['charset'] if options.has_key? "charset" if options['charset']
+        
+        # setup date only if they use nph
+        @head['Date'] = CGI::rfc1123_date(Time.now) if options['nph']
+
+        # setup the server to use the default or what they set
+        @head['Server'] = options['server'] || env_table['SERVER_SOFTWARE']
+
+        # remaining possible options they can give
+        @head['Status'] = options['status'] if options['status']
+        @head['Content-Language'] = options['language'] if options['language']
+        @head['Expires'] = options['expires'] if options['expires']
+
+        # drop the keys we don't want anymore
+        REMOVED_KEYS.each {|k| options.delete(k) }
+
+        # finally just convert the rest raw (which puts 'cookie' directly)
+        # 'cookie' is translated later as we write the header out
+        options.each{|k,v| @head[k] = v}
+      end
+
+      # doing this fakes out the cgi library to think the headers are empty
+      # we then do the real headers in the out function call later
+      ""
+    end
+
+    # Takes any 'cookie' setting and sends it over the Mongrel header,
+    # then removes the setting from the options. If cookie is an 
+    # Array or Hash then it sends those on with .to_s, otherwise
+    # it just calls .to_s on it and hopefully your "cookie" can
+    # write itself correctly.
+    def send_cookies(to)
+      # convert the cookies based on the myriad of possible ways to set a cookie
+      if @head['cookie']
+        cookie = @head['cookie']
+        case cookie
+        when Array
+          cookie.each {|c| to['Set-Cookie'] = c.to_s }
+        when Hash
+          cookie.each_value {|c| to['Set-Cookie'] = c.to_s}
+        else
+          to['Set-Cookie'] = options['cookie'].to_s
+        end
+        
+        @head.delete('cookie')
+
+        # @output_cookies seems to never be used, but we'll process it just in case
+        @output_cookies.each {|c| to['Set-Cookie'] = c.to_s } if @output_cookies
+      end
+    end
+    
+    # The dumb thing is people can call header or this or both and in any order.
+    # So, we just reuse header and then finalize the HttpResponse the right way.
+    # Status is taken from the various options and converted to what Mongrel needs
+    # via the CGIWrapper.status function.
+    def out(options = "text/html")
+      return if @out_called  # don't do this more than once
+
+      header(options)
+
+      @response.start status do |head, out|
+        send_cookies(head)
+        
+        @head.each {|k,v| head[k] = v}
+        out.write(yield || "")
+      end
+    end
+    
+    # Computes the status once, but lazily so that people who call header twice
+    # don't get penalized.  Because CGI insists on including the options status 
+    # message in the status we have to do a bit of parsing.
+    def status
+      if not @status
+        stat = @head["Status"]
+        stat = stat.split(' ')[0] if stat
+
+        @status = stat || "200"
+      end
+
+      @status
+    end
+
+    # Used to wrap the normal args variable used inside CGI.
+    def args
+      @args
+    end
+    
+    # Used to wrap the normal env_table variable used inside CGI.
+    def env_table
+      @request.params
+    end
+    
+    # Used to wrap the normal stdinput variable used inside CGI.
+    def stdinput
+      @input
+    end
+    
+    # The stdoutput should be completely bypassed but we'll drop a warning just in case
+    def stdoutput
+      STDERR.puts "WARNING: Your program is doing something not expected.  Please tell Zed that stdoutput was used and what software you are running.  Thanks."
+      @response.body
+    end    
+  end
+end

data/lib/mongrel/handlers.rb

@@ -0,0 +1,180 @@
+
+module Mongrel
+
+  # You implement your application handler with this.  It's very light giving
+  # just the minimum necessary for you to handle a request and shoot back 
+  # a response.  Look at the HttpRequest and HttpResponse objects for how
+  # to use them.
+  class HttpHandler
+    def process(request, response)
+    end
+  end
+
+
+  # The server normally returns a 404 response if an unknown URI is requested, but it
+  # also returns a lame empty message.  This lets you do a 404 response
+  # with a custom message for special URIs.
+  class Error404Handler < HttpHandler
+
+    # Sets the message to return.  This is constructed once for the handler
+    # so it's pretty efficient.
+    def initialize(msg)
+      @response = Const::ERROR_404_RESPONSE + msg
+    end
+    
+    # Just kicks back the standard 404 response with your special message.
+    def process(request, response)
+      response.socket.write(@response)
+    end
+
+  end
+
+
+  # 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.
+  #
+  # It does a simple protection against going outside it'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't
+  # than it simply gives a 404.
+  class DirHandler < HttpHandler
+    MIME_TYPES = {
+      ".css"        =>  "text/css",
+      ".gif"        =>  "image/gif",
+      ".htm"        =>  "text/html",
+      ".html"       =>  "text/html",
+      ".jpeg"       =>  "image/jpeg",
+      ".jpg"        =>  "image/jpeg",
+      ".js"         =>  "text/javascript",
+      ".png"        =>  "image/png",
+      ".swf"        =>  "application/x-shockwave-flash",
+      ".txt"        =>  "text/plain"
+    }
+
+
+    attr_reader :path
+
+    # You give it the path to the directory root and an (optional) 
+    def initialize(path, listing_allowed=true, index_html="index.html")
+      @path = File.expand_path(path)
+      @listing_allowed=listing_allowed
+      @index_html = index_html
+    end
+
+    # Checks if the given path can be served and returns the full path (or nil if not).
+    def can_serve(path_info)
+      req = File.expand_path(File.join(@path,path_info), @path)
+
+      if req.index(@path) == 0 and File.exist? req
+        # it exists and it's in the right location
+        if File.directory? req
+          # the request is for a directory
+          index = File.join(req, @index_html)
+          if File.exist? index
+            # serve the index
+            return index
+          elsif @listing_allowed
+            # serve the directory
+            req
+          else
+            # do not serve anything
+            return nil
+          end
+        else
+          # it's a file and it's there
+          return req
+        end
+      else
+        # does not exist or isn't in the right spot
+        return nil
+      end
+    end
+
+
+    # Returns a simplistic directory listing if they'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 can_serve()), and response is the HttpResponse
+    # object to send the results on.
+    def send_dir_listing(base, dir, response)
+      # take off any trailing / so the links come out right
+      base.chop! if base[-1] == "/"[-1]
+
+      if @listing_allowed
+        response.start(200) do |head,out|
+          head['Content-Type'] = "text/html"
+          out << "<html><head><title>Directory Listing</title></head><body>"
+          Dir.entries(dir).each do |child|
+            next if child == "."
+
+            if child == ".."
+              out << "<a href=\"#{base}/#{child}\">Up to parent..</a><br/>"
+            else
+              out << "<a href=\"#{base}/#{child}\">#{child}</a><br/>"
+            end
+          end
+          out << "</body></html>"
+        end
+      else
+        response.start(403) do |head,out|
+          out.write("Directory listings not allowed")
+        end
+      end
+    end
+
+    
+    # Sends the contents of a file back to the user. Not terribly efficient since it's
+    # opening and closing the file for each read.
+    def send_file(req, response)
+      response.start(200) do |head,out|
+        # set the mime type from our map based on the ending
+        dot_at = req.rindex(".")
+        if dot_at
+          ext = req[dot_at .. -1]
+          if MIME_TYPES[ext]
+            head['Content-Type'] = MIME_TYPES[ext]
+          end
+        end
+
+        open(req, "rb") do |f|
+          out.write(f.read)
+        end
+      end
+    end
+
+
+    # Process the request to either serve a file or a directory listing
+    # if allowed (based on the listing_allowed paramter to the constructor).
+    def process(request, response)
+      req = can_serve request.params['PATH_INFO']
+      if not req
+        # not found, return a 404
+        response.start(404) do |head,out|
+          out << "File not found"
+        end
+      else
+        begin
+          if File.directory? req
+            send_dir_listing(request.params["REQUEST_URI"],req, response)
+          else
+            send_file(req, response)
+          end
+        rescue => details
+          response.reset
+          response.start(403) do |head,out|
+            out << "Error accessing file: #{details}"
+            out << details.backtrace.join("\n")
+          end
+        end
+      end
+    end
+
+    # There is a small number of default mime types for extensions, but
+    # this lets you add any others you'll need when serving content.
+    def DirHandler::add_mime_type(extension, type)
+      MIME_TYPES[extension] = type
+    end
+
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: mongrel
 version: !ruby/object:Gem::Version 
-  version: 0.3.5
-date: 2006-02-18 00:00:00 -05:00
+  version: 0.3.6
+date: 2006-02-22 00:00:00 -05:00
 summary: A small fast HTTP library and server that runs Rails, Camping, and Nitro apps.
 require_paths: 
 - lib
@@ -35,6 +35,8 @@ files:
 - Rakefile
 - setup.rb
 - bin/mongrel_rails
+- bin/mongrel_rails_service
+- bin/mongrel_rails_svc
 - doc/rdoc/classes
 - doc/rdoc/created.rid
 - doc/rdoc/files
@@ -50,17 +52,9 @@ files:
 - doc/rdoc/classes/PluginFactory.html
 - doc/rdoc/classes/PluginFactory.src
 - doc/rdoc/classes/FactoryError.src/M000001.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src
 - doc/rdoc/classes/Mongrel/Const.html
-- doc/rdoc/classes/Mongrel/DirHandler.html
-- doc/rdoc/classes/Mongrel/DirHandler.src
-- doc/rdoc/classes/Mongrel/Error404Handler.html
-- doc/rdoc/classes/Mongrel/Error404Handler.src
 - doc/rdoc/classes/Mongrel/HeaderOut.html
 - doc/rdoc/classes/Mongrel/HeaderOut.src
-- doc/rdoc/classes/Mongrel/HttpHandler.html
-- doc/rdoc/classes/Mongrel/HttpHandler.src
 - doc/rdoc/classes/Mongrel/HttpParser.html
 - doc/rdoc/classes/Mongrel/HttpParser.src
 - doc/rdoc/classes/Mongrel/HttpRequest.html
@@ -69,28 +63,11 @@ files:
 - doc/rdoc/classes/Mongrel/HttpResponse.src
 - doc/rdoc/classes/Mongrel/HttpServer.html
 - doc/rdoc/classes/Mongrel/HttpServer.src
+- doc/rdoc/classes/Mongrel/StopServer.html
 - doc/rdoc/classes/Mongrel/URIClassifier.html
 - doc/rdoc/classes/Mongrel/URIClassifier.src
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000047.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000048.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000049.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000050.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000051.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000052.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000053.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000054.html
-- doc/rdoc/classes/Mongrel/CGIWrapper.src/M000055.html
-- doc/rdoc/classes/Mongrel/DirHandler.src/M000022.html
-- doc/rdoc/classes/Mongrel/DirHandler.src/M000023.html
-- doc/rdoc/classes/Mongrel/DirHandler.src/M000024.html
-- doc/rdoc/classes/Mongrel/DirHandler.src/M000025.html
-- doc/rdoc/classes/Mongrel/DirHandler.src/M000026.html
-- doc/rdoc/classes/Mongrel/DirHandler.src/M000027.html
-- doc/rdoc/classes/Mongrel/Error404Handler.src/M000056.html
-- doc/rdoc/classes/Mongrel/Error404Handler.src/M000057.html
-- doc/rdoc/classes/Mongrel/HeaderOut.src/M000033.html
-- doc/rdoc/classes/Mongrel/HeaderOut.src/M000034.html
-- doc/rdoc/classes/Mongrel/HttpHandler.src/M000039.html
+- doc/rdoc/classes/Mongrel/HeaderOut.src/M000028.html
+- doc/rdoc/classes/Mongrel/HeaderOut.src/M000029.html
 - doc/rdoc/classes/Mongrel/HttpParser.src/M000015.html
 - doc/rdoc/classes/Mongrel/HttpParser.src/M000016.html
 - doc/rdoc/classes/Mongrel/HttpParser.src/M000017.html
@@ -98,23 +75,24 @@ files:
 - doc/rdoc/classes/Mongrel/HttpParser.src/M000019.html
 - doc/rdoc/classes/Mongrel/HttpParser.src/M000020.html
 - doc/rdoc/classes/Mongrel/HttpParser.src/M000021.html
-- doc/rdoc/classes/Mongrel/HttpRequest.src/M000058.html
+- doc/rdoc/classes/Mongrel/HttpRequest.src/M000041.html
+- doc/rdoc/classes/Mongrel/HttpResponse.src/M000034.html
+- doc/rdoc/classes/Mongrel/HttpResponse.src/M000035.html
+- doc/rdoc/classes/Mongrel/HttpResponse.src/M000036.html
+- doc/rdoc/classes/Mongrel/HttpResponse.src/M000037.html
+- doc/rdoc/classes/Mongrel/HttpResponse.src/M000038.html
+- doc/rdoc/classes/Mongrel/HttpResponse.src/M000039.html
 - doc/rdoc/classes/Mongrel/HttpResponse.src/M000040.html
-- doc/rdoc/classes/Mongrel/HttpResponse.src/M000041.html
-- doc/rdoc/classes/Mongrel/HttpResponse.src/M000042.html
-- doc/rdoc/classes/Mongrel/HttpResponse.src/M000043.html
-- doc/rdoc/classes/Mongrel/HttpResponse.src/M000044.html
-- doc/rdoc/classes/Mongrel/HttpResponse.src/M000045.html
-- doc/rdoc/classes/Mongrel/HttpResponse.src/M000046.html
-- doc/rdoc/classes/Mongrel/HttpServer.src/M000028.html
-- doc/rdoc/classes/Mongrel/HttpServer.src/M000029.html
-- doc/rdoc/classes/Mongrel/HttpServer.src/M000030.html
-- doc/rdoc/classes/Mongrel/HttpServer.src/M000031.html
-- doc/rdoc/classes/Mongrel/HttpServer.src/M000032.html
-- doc/rdoc/classes/Mongrel/URIClassifier.src/M000035.html
-- doc/rdoc/classes/Mongrel/URIClassifier.src/M000036.html
-- doc/rdoc/classes/Mongrel/URIClassifier.src/M000037.html
-- doc/rdoc/classes/Mongrel/URIClassifier.src/M000038.html
+- doc/rdoc/classes/Mongrel/HttpServer.src/M000022.html
+- doc/rdoc/classes/Mongrel/HttpServer.src/M000023.html
+- doc/rdoc/classes/Mongrel/HttpServer.src/M000024.html
+- doc/rdoc/classes/Mongrel/HttpServer.src/M000025.html
+- doc/rdoc/classes/Mongrel/HttpServer.src/M000026.html
+- doc/rdoc/classes/Mongrel/HttpServer.src/M000027.html
+- doc/rdoc/classes/Mongrel/URIClassifier.src/M000030.html
+- doc/rdoc/classes/Mongrel/URIClassifier.src/M000031.html
+- doc/rdoc/classes/Mongrel/URIClassifier.src/M000032.html
+- doc/rdoc/classes/Mongrel/URIClassifier.src/M000033.html
 - doc/rdoc/classes/PluginFactory.src/M000002.html
 - doc/rdoc/classes/PluginFactory.src/M000003.html
 - doc/rdoc/classes/PluginFactory.src/M000004.html
@@ -144,8 +122,10 @@ files:
 - lib/mongrel
 - lib/mongrel.rb
 - lib/pluginfactory.rb
+- lib/mongrel/cgi.rb
 - lib/mongrel/command
 - lib/mongrel/command.rb
+- lib/mongrel/handlers.rb
 - ext/http11/ext_help.h
 - ext/http11/http11_parser.h
 - ext/http11/tst.h
@@ -158,6 +138,8 @@ files:
 - ext/http11/tst_insert.c
 - ext/http11/tst_search.c
 - ext/http11/extconf.rb
+- examples/mongrel_simple_ctrl.rb
+- examples/mongrel_simple_service.rb
 - examples/simpletest.rb
 - examples/webrick_compare.rb
 - examples/camping/blog.rb