cgi-exception 0.1.0 → 0.2.0

data/CHANGES.txt

@@ -0,0 +1,19 @@
+= CHANGES
+
+
+
+== Release 0.2.0 (2008-02-21)
+
+=== Enhancements
+
+* mod_ruby support
+
+* detect whether HTTP header printed or not
+
+* omit lines when Exception backtrace is too long
+
+
+
+== Release 0.1.0
+
+* first public release

data/README.txt

@@ -1,16 +1,21 @@
 = README.txt
 
-Release: 0.1.0
+Release: 0.2.0
 
-copyright(c) 2007 kuwata-lab.com all rights reserved.
+copyright(c) 2007-2008 kuwata-lab.com all rights reserved.
+
+http://rubyforge.org/projects/cgi-exception/
 
 
 == About
 
-'cgi_exception.rb' is a tiny script to show exception raised in your
+'cgi_exception.rb' is a small script to show exception raised in your
 CGI script into browser, like PHP. You don't need to look for error
 messages in Web server's log file.
 
+NOTICE: cig_exception.rb works only with CGI or mod_ruby. It doesn't
+support FastCGI.
+
 
 == Install
 
@@ -19,7 +24,11 @@ with administrator priviledge.
 
 Or, just type 'ruby setup.rb' with administrator priviledge.
 
-Or, copy 'lib/cgi_exception.rb' to proper directory.
+Or, copy 'lib/cgi_exception.rb' to proper directory such as
+'/usr/local/lib/ruby/site_ruby/1.8'.
+
+NOTICE: It is NOT recommended to install by RubyGems, because
+'require "rubygems"' is too heavy for CGI program.
 
 
 == Usage
@@ -37,11 +46,11 @@ local variable 'user' is not initialized.
     #!/usr/bin/env ruby
     require 'cgi'
     require 'cgi_exception'
-    html = "<pp>Hello #{user}!</p>\n"
-    print cgi.header
+    html = "<p>Hello #{user}!</p>\n"
+    print CGI.new.header
     print html
 
-You'll see the following message in your browser if you access the abobe
+You'll see the following message in your browser if you access the above
 CGI script.
 
     /var/www/cgi-bin/foo.cgi:4: undefined local variable or method `user'
@@ -55,4 +64,4 @@ public domain
 
 == Author
 
-makoto kuwata <kwa(at)kuwata-lab.com>
+makoto kuwata <kwa.at.kuwata-lab.com>

data/lib/cgi_exception.rb

@@ -1,25 +1,105 @@
 ##
-## $Rev: 1 $
-## $Release: 0.1.0 $
-## copyright(c) 2007 kuwata-lab.com all rights reserved.
+## $Rev: 7 $
+## $Release: 0.2.0 $
+## copyright(c) 2007-2008 kuwata-lab.com all rights reserved.
 ## License: public domain
 ##
 
+## escape HTML characters
 def _esc_html(s)
   s.to_s.gsub(/&/,'&amp;').gsub(/</,'&lt;').gsub(/>/,'&gt;').gsub(/"/,'&quot;')
 end
 
-def _print_stack_trace(ex, out=$stderr, header="Content-Type: text/html\r\n")
-  out ||= $stderr
-  out << header << "\r\n" if header
+## print exception in HTML format
+def _print_exception(ex)
   arr = ex.backtrace
-  out << "<pre style=\"color:#CC0000\">"
-  out << "<b>#{_esc_html arr[0]}: #{_esc_html ex.message} (#{ex.class.name})</b>\n"
-  arr[1..-1].each {|s| out << "        from #{_esc_html s}\n" }
-  out << "</pre>"
+  print "<pre style=\"color:#CC0000\">"
+  print "<b>#{_esc_html arr[0]}: #{_esc_html ex.message} (#{ex.class.name})</b>\n"
+  block = proc {|s| print "        from #{_esc_html s}\n" }
+  max = 20
+  if arr.length <= max
+    arr[1..-1].each(&block)
+  else
+    n = 5
+    arr[1..(max-n)].each(&block)
+    print "           ...\n"
+    arr[-n..-1].each(&block)
+  end
+  print "</pre>"
 end
 
-at_exit do
-  _print_stack_trace($!, $stdout) if $!
+## print HTTP header (for CGI program)
+def _print_http_header_for_cgi()
+  print "Status: 500 Internal Error\r\n"
+  print "Content-Type: text/html\r\n"
+  print "X-CGI-Exception: 0.2.0\r\n"
+  print "\r\n"
 end
 
+## print HTTP header (for mod_ruby)
+def _print_http_header_for_modruby()
+  request = Apache::request
+  request.status = 500
+  request.status_line = '500 Internal Error'
+  request.content_type = 'text/html'
+  request.headers_out['X-CGI-Exception'] = '0.2.0'
+  request.send_http_header
+end
+
+if defined?(MOD_RUBY)
+
+  def _print_http_header()   # don't use alias
+    _print_http_header_for_modruby()
+  end
+
+  class ::Apache::RubyRun  # :nodoc:
+    ## if 'alias _handler_orig handler' statement is evaluated
+    ## more than twice, handler() will cause stack over flow.
+    unless self.method_defined?(:_handler_orig)
+      alias _handler_orig handler
+    end
+    ## override handler() to catch and exception it to browser
+    def handler(r)
+      return _handler_orig(r)
+    rescue Exception => ex
+      _print_http_header()
+      _print_exception(ex)
+      #raise ex
+      $stderr.write "#{ex.backtrace[0]}: #{ex.message} (#{ex.class.name})\n"
+      return ::Apache::OK
+    end
+    ## original
+    #def handler(r)
+    #  status = check_request(r)
+    #  return status if status != OK
+    #  filename = setup(r)
+    #  load(filename, true)
+    #  return OK
+    #end
+  end
+
+else
+
+  def _print_http_header()    # don't use alias
+    _print_http_header_for_cgi()
+  end
+
+  ## override $stdout.write() to detect whether HTTP header printed or not
+  class << $stdout
+    def write(*args)
+      $_header_printed = true
+      super(*args)
+    end
+  end
+
+  $_header_printed = false
+
+  ## when process exit, print exception if exception raised
+  at_exit do
+    if $!
+      _print_http_header() unless $_header_printed
+      _print_exception($!)
+    end
+  end
+
+end

data/test/test_cgi_exception.rb

@@ -0,0 +1,163 @@
+###
+### $Rev: 7 $
+### $Release: 0.2.0 $
+### copyright(c) 2007-2008 kuwata-lab.com all rights reserved.
+###
+
+require 'test/unit'
+LIBDIR = File.dirname(__FILE__) + '/../lib'
+
+
+class CGIExceptionTest < Test::Unit::TestCase
+
+
+  def _test
+    @name = (name() =~ /^test_(.*)\(.*\)$/) && $1
+    filename = (@filename ||= "#{@name}.rb")
+    begin
+      #preamble = "$: << #{LIBDIR.inspect}\n"
+      #File.open(filename, 'w') {|f| f << preamble << @script }
+      #output = `ruby #{filename} 2>/dev/null`
+      File.open(filename, 'w') {|f| f << @script }
+      command = "ruby -I #{LIBDIR} #{filename} 2>/dev/null"
+      output = `#{command}`
+      expected = @expected
+      expected = @expected2 if @expected2 && @expected2 == output
+      assert_equal(expected, output)
+    ensure
+      File.unlink(filename) if File.exist?(filename) unless $DEBUG
+    end
+  end
+
+
+  def test_when_no_header_printed
+    @script = <<'END'
+require 'cgi_exception'
+def build_html
+  return "<p>Hello #{name}</p>"
+end
+html = build_html
+print "Content-Type: text/html\r\n"
+print html
+END
+    @expected = <<END
+Status: 500 Internal Error\r
+Content-Type: text/html\r
+X-CGI-Exception: 0.2.0\r
+\r
+<pre style="color:#CC0000"><b>when_no_header_printed.rb:3:in `build_html': undefined local variable or method `name' for main:Object (NameError)</b>
+        from when_no_header_printed.rb:5
+</pre>
+END
+    @expected.chomp!
+    _test
+  end
+
+
+  def test_when_header_already_printed
+    @script = <<'END'
+require 'cgi_exception'
+def build_html
+  return "<p>Hello #{name}</p>"
+end
+print "Content-Type: text/html\r\n"
+print "\r\n"
+print "<html>\n"
+print build_html
+print "</html>\n"
+END
+    @expected = <<END
+Content-Type: text/html\r
+\r
+<html>
+<pre style="color:#CC0000"><b>when_header_already_printed.rb:3:in `build_html': undefined local variable or method `name' for main:Object (NameError)</b>
+        from when_header_already_printed.rb:8
+</pre>
+END
+    @expected.chomp!
+    _test
+  end
+
+
+  def test_when_error_backtrace_is_too_long
+    @script = <<'END'
+require 'cgi_exception'
+def build_html
+  return f(100).to_s
+end
+def f(n)
+  return n + g(n-1)
+end
+def g(n)
+  return n + f(n-1)
+end
+html = build_html()
+print "Content-Type: text/html\r\n"
+print "\r\n"
+print html
+END
+    @expected = <<END
+Status: 500 Internal Error\r
+Content-Type: text/html\r
+X-CGI-Exception: 0.2.0\r
+\r
+<pre style="color:#CC0000"><b>when_error_backtrace_is_too_long.rb:6:in `f': stack level too deep (SystemStackError)</b>
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+           ...
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:3:in `build_html'
+        from when_error_backtrace_is_too_long.rb:11
+</pre>
+END
+    @expected.chomp!
+    @expected2 = <<END
+Status: 500 Internal Error\r
+Content-Type: text/html\r
+X-CGI-Exception: 0.2.0\r
+\r
+<pre style="color:#CC0000"><b>when_error_backtrace_is_too_long.rb:9:in `g': stack level too deep (SystemStackError)</b>
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+           ...
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:9:in `g'
+        from when_error_backtrace_is_too_long.rb:6:in `f'
+        from when_error_backtrace_is_too_long.rb:3:in `build_html'
+        from when_error_backtrace_is_too_long.rb:11
+</pre>
+END
+    @expected2.chomp!
+    _test
+  end
+
+
+end

metadata

@@ -1,48 +1,57 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: cgi-exception
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-12-24 00:00:00 +09:00
-summary: Utility to display what and where exception raised in CGI script
-require_paths: 
-- lib
-email: 
-homepage: http://cgi-exception.rubyforge.org/
-rubyforge_project: 
-description: cgi-exception.rb is a tiny utility to display what and where exception raised in CGI script just like PHP. You don't need to look for error message in web server's log file.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - makoto kuwata
-files: 
-- lib/cgi_exception.rb
-- README.txt
-- setup.rb
-test_files: []
-
-rdoc_options: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
-extra_rdoc_files: []
+date: 2008-02-22 00:00:00 +09:00
+default_executable: 
+dependencies: []
 
+description: cgi-exception.rb is a tiny utility to display what and at where exception raised in CGI script just like PHP. You don't need to look for error message in web server's log file.
+email: kwa@kuwata-lab.com
 executables: []
 
 extensions: []
 
+extra_rdoc_files: []
+
+files: 
+- lib/cgi_exception.rb
+- test/test_cgi_exception.rb
+- README.txt
+- CHANGES.txt
+- setup.rb
+has_rdoc: false
+homepage: http://cgi-exception.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: cgi-exception
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Utility to display what and at where exception raised in CGI script
+test_files: []