cgialt 0.0.1

data/README.txt

@@ -0,0 +1,137 @@
+= README.txt
+
+Release: 0.0.1
+
+copyright(c) 2007 kuwata-lab.com all rights reserved.
+
+
+==  About
+
+'CGIAlt' is an alternative library of standard 'cgi.rb'.
+It is written in pure Ruby but works faster than 'cgi.rb'.
+
+
+== Features
+
+* Compatible with 'cgi.rb'.
+* Faster and more lightweight than 'cgi.rb'.
+* Available to install with CGIExt (which is a re-implementation of 'cgi.rb'
+  in C extension).
+
+
+==  Install
+
+Download cgialt-0.0.1.tar.gz and install it according to the following:
+
+    $ tar xzf cgialt-0.0.1.tar.gz
+    $ cd cgialt-0.0.1/
+    $ ruby setup.rb config
+    $ ruby setup.rb setup
+    $ sudo ruby setup.rb install
+
+Or if you have installed RubyGems, you can install CGIAlt by 'gem' command.
+
+    $ sudo gem install cgialt
+
+It is recommended not to use RubyGems if you have to develop CGI program
+because loading RubyGems is very heavy-weight for CGI program.
+
+
+==  Usage
+
+All you have to do is to require 'cgialt' instead of 'cgi', and you can use
+CGI class which is compatible with 'cgi.rb'.
+
+   require 'rubygems'   # if you have installed with RubyGems
+   require 'cgialt'
+
+If you want to replace original 'cgi.rb' entirely by 'cgialt',
+create 'cgi.rb' which requires 'cgialt' under proper directory such as
+'/usr/local/lib/ruby/site_ruby/1.8'.
+
+   $ sudo echo 'require "cgialt"' > /usr/local/lib/ruby/site_ruby/1.8/cgi.rb
+
+When $DEBUG is true or ENV['DEBUG'] is set, CGIAlt prints release number
+to $stderr when loaded.
+
+   $ DEBUG=1 ruby -e 'require "cgi"'
+   *** CGIAlt: release 0.0.1
+
+
+== Benchmark
+
+Try 'bench.rb' included in CGIAlt archive.
+The following is an example of benchmark.
+
+    ## cgi.rb
+    $ ruby -s bench.rb -N=1000
+    *** 1000 times                         user    system     total       real
+    ruby -e 'nil'                        0.0900    0.8300   11.5400 (  11.9631)
+    ruby -e 'require "cgi"'              0.1000    1.2400   24.7000 (  25.2709)
+    
+    *** 100000 times                       user    system     total       real
+    CGI#new (simple)                    20.3100    0.0300   20.3400 (  20.3770)
+    CGI#new (complex)                   26.5800    0.0400   26.6200 (  26.6604)
+    
+    *** 1000000 times                      user    system     total       real
+    CGI#header (simple)                 12.6700    0.0100   12.6800 (  12.7137)
+    CGI#header (complex)                43.4600    0.0600   43.5200 (  43.5749)
+
+    ## CGIAlt
+    $ ruby -s bench.rb -N=1000 -cgialt
+    *** CGIAlt: release 0.0.0
+    *** 1000 times                         user    system     total       real
+    ruby -e 'nil'                        0.0900    0.8000   11.5900 (  12.0581)
+    ruby -e 'require "cgi"'              0.1000    1.2300   19.4800 (  20.0621)
+    
+    *** 100000 times                       user    system     total       real
+    CGI#new (simple)                    14.5000    0.0300   14.5300 (  14.5594)
+    CGI#new (complex)                   20.0700    0.0300   20.1000 (  20.1356)
+    
+    *** 1000000 times                      user    system     total       real
+    CGI#header (simple)                  6.0400    0.0100    6.0500 (   6.0553)
+    CGI#header (complex)                36.2200    0.0400   36.2600 (  36.3138)
+
+It is good thing for performance to install CGIExt as well as CGIAlt.
+The following is an benchmark example of using both CGIAlt and CGIExt.
+
+    ## CGIAlt and CGIExt
+    $ ruby -s bench.rb -N=1000 -cgialt -cgiext
+    *** CGIAlt: release 0.0.0
+    *** 1000 times                         user    system     total       real
+    ruby -e 'nil'                        0.0900    0.8100   11.6600 (  12.1769)
+    ruby -e 'require "cgi","cgiext"'     0.1000    1.2100   20.8400 (  21.5575)
+    
+    *** 100000 times                       user    system     total       real
+    CGI#new (simple)                    12.4200    0.0400   12.4600 (  12.5207)
+    CGI#new (complex)                   13.1600    0.0300   13.1900 (  13.2443)
+    
+    *** 1000000 times                      user    system     total       real
+    CGI#header (simple)                  6.0300    0.0100    6.0400 (   6.0651)
+    CGI#header (complex)                36.5400    0.0800   36.6200 (  37.0642)
+
+The following is a summary of above benchmark results.
+
+     Table 1. summary of benchmark
+                                          cgi.rb      CGIAlt   CGIAlt+CGIExt
+     -----------------------------------------------------------------------
+     require "cgi"         (x1000)         13.16        7.89         9.18
+     CGI#new (simple)      (x100000)       20.34       14.53        12.46
+     CGI#new (comple)      (x100000)       26.62       20.10        13.19
+     CGI#header (simple)   (x1000000)      12.68        6.05         6.04
+     CGI#header (complex)  (x1000000)      43.52       36.26        36.62
+
+
+== License
+
+Ruby's license
+
+
+== Authoer
+
+makoto kuwata <kwa(at)kuwata-lab.com>
+
+
+== Bug reports
+
+If you have bugs or questions, report them to kwa(at)kuwata-lab.com.

data/bench.rb

@@ -0,0 +1,245 @@
+##
+## $Rev: 30 $
+## $Release: 0.0.1 $
+## copyright(c) 2007 kuwata-lab.com all rights reserved.
+##
+
+##
+## usage: ruby -s bench.rb [-cgialt] [-cgiext] [-rubygems] [-N=1000]
+##
+
+begin
+  require($cgialt ? 'cgialt' : 'cgi')
+rescue LoadError
+  begin
+    $:.unshift 'lib'
+    require($cgialt ? 'cgialt' : 'cgi')
+    $rubylib = 'lib'
+  rescue LoadError
+    require 'rubygems'
+    require($cgialt ? 'cgialt' : 'cgi')
+    $rubygems = true
+  end
+end
+
+require 'benchmark'
+require 'cgiext' if $cgiext
+require 'rubygems' if $profile
+require 'ruby-prof' if $profile
+
+if defined?(CGI::RELEASE)
+  puts "*** CGIAlt: release #{CGI::RELEASE}"
+end
+
+$N = ($N || 1000).to_i
+
+
+class BenchmarkApplication
+
+
+  QUERY_STRING = 'id=123&name=John+Smith&passwd=%40h%3D%7E%2F%5E%24%2F'
+  #COOKIE_STRING = "name1=val1&val2&val3; name2=val2&%26%3C%3E%22;_session_id=abcdefg0123456789"
+  COOKIE_STRING = '_session_id=e15eb25e3d8f3d51814024aab7ccbca0; dbx-pagemeta=grabit:0-|1-|2-|3-|4-|5-|6-|7-&advancedstuff:0-; dbx-postmeta=grabit:0+|1+|2+|3+|4+|5+|6+&advancedstuff:0-|1-|2-'
+  #COOKIE_STRING = "name1=val1&val2&val3"
+  SCRIPT_NAME  = '/cgi-bin/app/example/command.cgi'
+
+  def initialize
+    @request_method = 'GET'
+    @query_string = QUERY_STRING
+    @cookie_string = COOKIE_STRING
+    @script_name = SCRIPT_NAME
+  end
+
+  def setup
+    ENV['REQUEST_METHOD'] = @request_method
+    ENV['QUERY_STRING']   = @query_string
+    ENV['HTTP_COOKIE']    = @cookie_string
+    ENV['SCRIPT_NAME']    = @script_name
+  end
+
+
+  def bench_invoke_ruby(ntimes)
+    (ntimes/10).times do
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+      `ruby -e 'nil'`
+    end
+  end
+
+  def self._def_bench_require(*names)
+    if names.empty?
+      method = 'bench_invoke_ruby'
+      statement = 'nil'
+    else
+      method = "bench_require_" + names.join('_')
+      statement = names.collect{|name| "require \"#{name}\""}.join('; ')
+    end
+    statement = "$:.unshift \"#{$rubylib}\"; " + statement if $rubylib
+    command_opt = $rubygems ? '-rubygems' : ''
+    s = ''
+    s   << %Q|def #{method}(ntimes)\n|
+    s   << %Q|  (ntimes / 10).times do\n|
+    10.times do
+      s << %Q|    `ruby #{command_opt} -e '#{statement}'`\n|
+    end
+    s   << %Q|  end\n|
+    s   << %Q|end\n|
+    return s
+  end
+
+  eval self._def_bench_require()
+  eval self._def_bench_require('cgi')
+  eval self._def_bench_require('cgi',    'cgiext')
+  eval self._def_bench_require('cgialt')
+  eval self._def_bench_require('cgialt', 'cgiext')
+
+  def bench_cgi_new_simple(ntimes)
+    ENV['QUERY_STRING'] = ''
+    ENV['COOKIE_STRING'] = ''
+    (ntimes / 10).times do
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+    end
+  end
+
+  def bench_cgi_new_complex(ntimes)
+    ENV['QUERY_STRING'] =  @query_string
+    ENV['COOKIE_STRING'] = @cookie_string
+    (ntimes / 10).times do
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+      CGI.new
+    end
+  end
+
+  def bench_cgi_header_simple(ntimes)
+    cgi = CGI.new
+    (ntimes / 10).times do
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+      cgi.header("text/html; charset=utf8")
+    end
+    return cgi.header("text/html; charset=utf8")
+  end
+
+  def bench_cgi_header_complex(ntimes)
+    cgi = CGI.new
+    options = {
+      'type'     => 'text/xhtml',
+      'charset'  => 'utf8',
+      'length'   => 1024,
+      'status'   => 'REDIRECT',
+      'location' => 'http://www.example.com/',
+      'server'   => 'webrick',
+      'language' => 'ja',
+      'Cache-Control' => 'none',
+    }
+    (ntimes / 10).times do
+      cgi.header(options)
+      cgi.header(options)
+      cgi.header(options)
+      cgi.header(options)
+      cgi.header(options)
+      cgi.header(options)
+      cgi.header(options)
+      cgi.header(options)
+      cgi.header(options)
+      cgi.header(options)
+    end
+    return cgi.header(options)
+  end
+
+
+
+  def execute
+
+    method = "bench_require_#{$cgialt ? 'cgialt' : 'cgi'}#{$cgiext ? '_cgiext' : ''}"
+    libname = "#{$cgialt ? 'cgialt' : 'cgi'}#{$cgiext ? '","cgiext': ''}"
+    cmdopt = $rubygems ? '-rubygems ' : ''
+    data = [
+      [ 1,
+        [ :bench_invoke_ruby, "ruby #{cmdopt}-e 'nil'" ],
+        [ method.intern, "ruby #{cmdopt}-e 'require \"#{libname}\"'" ],
+      ],
+      [ 100,
+        [ :bench_cgi_new_simple,  'CGI#new (simple)' ],
+        [ :bench_cgi_new_complex, 'CGI#new (complex)' ],
+      ],
+      [ 1000,
+        [ :bench_cgi_header_simple,  'CGI#header (simple)'  ],
+        [ :bench_cgi_header_complex, 'CGI#header (complex)' ],
+      ],
+    ]
+
+    nl = ''
+    data.each do |list|
+      factor = list.shift
+      ntimes = factor * $N
+      s = "#{ntimes} times"
+      s << ' ' * (32 - s.length)
+      header = "*** %s      user   system    total      real\n" % s
+      format = "%8.3u %8.3y %8.3t %8.3r\n"
+      print nl
+      nl = "\n"
+      Benchmark.benchmark(header, 38, format) do |job|
+        list.each do |method, title|
+          self.setup()
+          output = nil
+          if $profile
+            result = RubyProf.profile do
+              job.report(title) do
+                output = self.__send__(method, ntimes)
+              end
+            end
+            outfile = $o || "profile_#{method.to_s.sub(/bench_cgi_/,'')}.html"
+            RubyProf::GraphHtmlPrinter.new(result).print(output='')
+            File.open(outfile, 'w') {|f| f.write(output) }
+          else
+            job.report(title) do
+              output = self.__send__(method, ntimes)
+            end
+          end
+          if $DEBUG
+            #puts "*** debug: "
+            output.each {|line| p line }
+          end
+        end
+      end
+    end
+  end
+
+end
+
+
+if $0 == __FILE__
+  BenchmarkApplication.new.execute
+end

data/lib/cgialt.rb

@@ -0,0 +1,43 @@
+# 
+# cgi.rb - cgi support library
+# 
+# Copyright (C) 2000  Network Applied Communication Laboratory, Inc.
+# 
+# Copyright (C) 2000  Information-technology Promotion Agency, Japan
+#
+# Author: Wakou Aoyama <wakou@ruby-lang.org>
+#
+# Documentation: Wakou Aoyama (RDoc'd and embellished by William Webber) 
+# 
+# == Overview
+#
+# The Common Gateway Interface (CGI) is a simple protocol
+# for passing an HTTP request from a web server to a
+# standalone program, and returning the output to the web
+# browser.  Basically, a CGI program is called with the
+# parameters of the request passed in either in the
+# environment (GET) or via $stdin (POST), and everything
+# it prints to $stdout is returned to the client.
+# 
+# This file holds the +CGI+ class.  This class provides
+# functionality for retrieving HTTP request parameters,
+# managing cookies, and generating HTML output.  See the
+# class documentation for more details and examples of use.
+#
+# The file cgi/session.rb provides session management
+# functionality; see that file for more details.
+#
+# See http://www.w3.org/CGI/ for more information on the CGI
+# protocol.
+
+class CGI
+  RELEASE = ('$Release: 0.0.1 $' =~ /[.\d]+/) && $&
+  if $DEBUG || ENV['DEBUG']
+    $stderr.puts "*** CGIAlt: release #{RELEASE}"
+  end
+end
+
+require 'cgialt/util'
+require 'cgialt/cookie'
+require 'cgialt/core'
+#require 'cgialt/html'   # loaded by core only when CGI.new(type) and type != nil

data/lib/cgialt/cookie.rb

@@ -0,0 +1,245 @@
+##
+## copyright(c) 2007 kuwata-lab.com all rights reserved.
+##
+## Copyright (C) 2000  Network Applied Communication Laboratory, Inc.
+##
+## Copyright (C) 2000  Information-technology Promotion Agency, Japan
+##
+## Original Author: Wakou Aoyama <wakou@ruby-lang.org>
+##
+## Documentation: Wakou Aoyama (RDoc'd and embellished by William Webber)
+##
+
+class CGI
+
+  #*** original
+  #*require "delegate"
+  #***
+
+  # Class representing an HTTP cookie.
+  #
+  # In addition to its specific fields and methods, a Cookie instance
+  # is a delegator to the array of its values.
+  #
+  # See RFC 2965.
+  #
+  # == Examples of use
+  #   cookie1 = CGI::Cookie::new("name", "value1", "value2", ...)
+  #   cookie1 = CGI::Cookie::new("name" => "name", "value" => "value")
+  #   cookie1 = CGI::Cookie::new('name'    => 'name',
+  #                              'value'   => ['value1', 'value2', ...],
+  #                              'path'    => 'path',   # optional
+  #                              'domain'  => 'domain', # optional
+  #                              'expires' => Time.now, # optional
+  #                              'secure'  => true      # optional
+  #                             )
+  # 
+  #   cgi.out("cookie" => [cookie1, cookie2]) { "string" }
+  # 
+  #   name    = cookie1.name
+  #   values  = cookie1.value
+  #   path    = cookie1.path
+  #   domain  = cookie1.domain
+  #   expires = cookie1.expires
+  #   secure  = cookie1.secure
+  # 
+  #   cookie1.name    = 'name'
+  #   cookie1.value   = ['value1', 'value2', ...]
+  #   cookie1.path    = 'path'
+  #   cookie1.domain  = 'domain'
+  #   cookie1.expires = Time.now + 30
+  #   cookie1.secure  = true
+  class Cookie   ## DelegateClass(Array) is too high cost!
+  #*** original
+  #*class Cookie < DelegateClass(Array)
+  #*** /original
+
+    # Create a new CGI::Cookie object.
+    #
+    # The contents of the cookie can be specified as a +name+ and one
+    # or more +value+ arguments.  Alternatively, the contents can
+    # be specified as a single hash argument.  The possible keywords of
+    # this hash are as follows:
+    #
+    # name:: the name of the cookie.  Required.
+    # value:: the cookie's value or list of values.
+    # path:: the path for which this cookie applies.  Defaults to the
+    #        base directory of the CGI script.
+    # domain:: the domain for which this cookie applies.
+    # expires:: the time at which this cookie expires, as a +Time+ object.
+    # secure:: whether this cookie is a secure cookie or not (default to
+    #          false).  Secure cookies are only transmitted to HTTPS 
+    #          servers.
+    #
+    # These keywords correspond to attributes of the cookie object.
+    def initialize(name='', *value)
+      rexp = %r|\A.*/|
+      if name.is_a?(String)
+        @name = name
+        @value = value  # value is an Array
+        @path = rexp.match(ENV['SCRIPT_NAME']) ? $& : ''
+        @secure = false
+      else
+        options = name
+        @name  = options['name']  or raise ArgumentError, "`name' required"
+        @value = Array(options['value'])
+        @path  = options['path'] || (rexp.match(ENV['SCRIPT_NAME']) ? $& : '')  # simple support for IE
+        @domain  = options['domain']
+        @expires = options['expires']
+        @secure  = options['secure'] == true
+      end
+      #super(@value)
+    end
+    #*** original
+    #*def initialize(name = "", *value)
+    #*  options = if name.kind_of?(String)
+    #*              { "name" => name, "value" => value }
+    #*            else
+    #*              name
+    #*            end
+    #*  unless options.has_key?("name")
+    #*    raise ArgumentError, "`name' required"
+    #*  end
+    #*
+    #*  @name = options["name"]
+    #*  @value = Array(options["value"])
+    #*  # simple support for IE
+    #*  if options["path"]
+    #*    @path = options["path"]
+    #*  else
+    #*    %r|^(.*/)|.match(ENV["SCRIPT_NAME"])
+    #*    @path = ($1 or "")
+    #*  end
+    #*  @domain = options["domain"]
+    #*  @expires = options["expires"]
+    #*  @secure = options["secure"] == true ? true : false
+    #*
+    #*  super(@value)
+    #*end
+    #*** /original
+
+    attr_accessor :name, :value, :path, :domain, :expires
+    attr_reader :secure
+    #*** original
+    #*attr_accessor("name", "value", "path", "domain", "expires")
+    #*attr_reader("secure")
+    #*** original
+
+    # Set whether the Cookie is a secure cookie or not.
+    #
+    # +val+ must be a boolean.
+    def secure=(val)
+      @secure = val if val == true or val == false
+      @secure
+    end
+
+    # Convert the Cookie to its string representation.
+    def to_s
+      val = @value.is_a?(String) ? CGI.escape(@value) \
+                                 : @value.collect{|v| CGI.escape(v) }.join('&')
+      buf = "#{CGI.escape(@name)}=#{val}"
+      buf << "; domain=#{@domain}" if @domain
+      buf << "; path=#{@path}"     if @path
+      buf << "; expires=#{CGI.rfc1123_date(@expires)}" if @expires
+      buf << "; secure"            if @secure == true
+      return buf
+    end
+    #*** original
+    #*def to_s
+    #*  buf = ""
+    #*  buf += @name + '='
+    #*
+    #*  if @value.kind_of?(String)
+    #*    buf += CGI::escape(@value)
+    #*  else
+    #*    buf += @value.collect{|v| CGI::escape(v) }.join("&")
+    #*  end
+    #*
+    #*  if @domain
+    #*    buf += '; domain=' + @domain
+    #*  end
+    #*
+    #*  if @path
+    #*    buf += '; path=' + @path
+    #*  end
+    #*
+    #*  if @expires
+    #*    buf += '; expires=' + CGI::rfc1123_date(@expires)
+    #*  end
+    #*
+    #*  if @secure == true
+    #*    buf += '; secure'
+    #*  end
+    #*
+    #*  buf
+    #*end
+    #*** /original
+
+    ## define methods instead of DelegateClass(Array)
+    include Enumerable  ##:nodoc:
+    def [](*args)  ##:nodoc:
+      @value[*args]
+    end
+    def []=(index, value)  ##:nodoc:
+      @value[index] = value
+    end
+    def each(&block)  ##:nodoc:
+      @value.each(&block)
+    end
+    def method_missing(m, *args)  ##:nodoc:
+      @value.respond_to?(m) ? @value.__send__(m, *args) : super
+    end
+    def respond_to?(m)  ##:nodoc:
+      super(m) || @value.respond_to?(m)
+    end
+    #def inspect;  @value.inspect;  end
+    #def ==(arg);  @value == arg;  end
+    #def ===(arg);  @value === arg;  end
+
+  end # class Cookie
+
+
+  # Parse a raw cookie string into a hash of cookie-name=>Cookie
+  # pairs.
+  #
+  #   cookies = CGI::Cookie::parse("raw_cookie_string")
+  #     # { "name1" => cookie1, "name2" => cookie2, ... }
+  #
+  def Cookie::parse(raw_cookie)
+    cookies = Hash.new([])
+    return cookies if !raw_cookie || raw_cookie.empty?
+    for pairs in raw_cookie.split(/[;,]\s?/)
+      name, value = pairs.split('=', 2)
+      next unless name && value
+      name = CGI.unescape(name)
+      values = value.split('&').collect{|v| CGI.unescape(v) }
+      if cookies.has_key?(name)
+        cookies[name].value.concat(values)
+      else
+        cookies[name] = self.new(name, *values)
+      end
+    end
+    return cookies
+  end
+  #*** original
+  #*def Cookie::parse(raw_cookie)
+  #*  cookies = Hash.new([])
+  #*  return cookies unless raw_cookie
+  #*
+  #*  raw_cookie.split(/[;,]\s?/).each do |pairs|
+  #*    name, values = pairs.split('=',2)
+  #*    next unless name and values
+  #*    name = CGI::unescape(name)
+  #*    values ||= ""
+  #*    values = values.split('&').collect{|v| CGI::unescape(v) }
+  #*    if cookies.has_key?(name)
+  #*      values = cookies[name].value + values
+  #*    end
+  #*    cookies[name] = Cookie::new({ "name" => name, "value" => values })
+  #*  end
+  #*
+  #*  cookies
+  #*end
+  #*** /original
+
+end