cgi-exception 0.2.0 → 0.3.0

data/CHANGES.txt

@@ -1,6 +1,18 @@
 = CHANGES
 
 
+== Release 0.3.0 (2008-07-19)
+
+=== Enhancements
+
+* Re-writed entirely
+
+* EditorKicker support to invoke TextMate or Emacs automatically
+  when an error raised.
+
+* Add example script for FastCGI
+
+
 
 == Release 0.2.0 (2008-02-21)
 

data/README.txt

@@ -1,20 +1,24 @@
 = README.txt
 
-Release: 0.2.0
-
-copyright(c) 2007-2008 kuwata-lab.com all rights reserved.
+Release: 0.3.0
 
+http://cgi-exception.rubyforge.org/
 http://rubyforge.org/projects/cgi-exception/
 
 
 == About
 
-'cgi_exception.rb' is a small script to show exception raised in your
+CGI-Exception 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.
+In addition, CGI-Exception supports EditorKicker which is a pretty
+tool to invoke your favorite editor and open errored file when an
+exception raised on your script.
+See http://editorkicker.rubyforge.org/ for details.
+
+NOTICE: CGI-Exception supports CGI and mod_ruby, and it is easy
+to use it in FastCGI (see blow for detail).
 
 
 == Install
@@ -27,8 +31,10 @@ Or, just type 'ruby setup.rb' with administrator priviledge.
 Or, copy 'lib/cgi_exception.rb' to proper directory such as
 '/usr/local/lib/ruby/site_ruby/1.8'.
 
+It is recommended to install EditorKicker as well as CGI-Exception.
+
 NOTICE: It is NOT recommended to install by RubyGems, because
-'require "rubygems"' is too heavy for CGI program.
+'require "rubygems"' is too heavy operation for CGI program.
 
 
 == Usage
@@ -37,25 +43,56 @@ All you have to do is to require 'cgi_exception'.
 If you do so and exception raised, what and where exception raised will
 be shown in browser.
 
+In addition, if you installed and required EditorKicker, TextMate or
+Emacs will be invoked automatically when you got exceptions.
+See README of EditorKicker for details.
+
 
 == Example
 
-For example, the following code will raise exception at line 4, because
+For example, the following code will raise exception at line 5, because
 local variable 'user' is not initialized.
 
-    #!/usr/bin/env ruby
-    require 'cgi'
-    require 'cgi_exception'
-    html = "<p>Hello #{user}!</p>\n"
-    print CGI.new.header
-    print html
+    1:  #!/usr/bin/env ruby
+    2:  require 'cgi'
+    3:  require 'cgi_exception'
+    4:  require 'editor_kicker' if ENV['SERVER_NAME'] == 'localhost'
+    5:  print CGI.new.header('text/html')
+    6:  print "  <h1>Example</h1>\n"
+    7:  print "  <p>Hello #{user}</p>\n"   # ERROR!
+    8:  print "  <p>unreachable</p>\n"
 
 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'
+    /var/www/cgi-bin/foo.cgi:7: undefined local variable or method `user'
     for main:Object (NameError)
 
+If you are using FastCGI, try the following code:
+
+    #!/usr/bin/env ruby
+    require 'cgi'
+    require 'fcgi'
+    require 'cgi_exception'
+    
+    FCGI.each do |cgi|
+      begin
+        print cgi.header('text/html')
+        print "  <h1>Example</h1>\n"
+        print "  <p>Hello #{user}</p>\n"   # ERROR!
+        print "  <p>unreachable</p>\n"
+      rescue Exception => ex
+        CGIExceptionPrinter.new(false).handle(ex)
+        ## invoke Emacs automatically only when on localhost
+        if cgi.env_table['SERVER_NAME'] == 'localhost'
+          require 'editor_kicker'
+          ENV['EDITOR_KICKER'] = \
+            "emacsclient -n -s /tmp/emacs501/server +%s '%s'"
+          EditorKicker.handle(ex)
+        end
+      end
+    end
+
 
 == License
 
@@ -64,4 +101,6 @@ public domain
 
 == Author
 
-makoto kuwata <kwa.at.kuwata-lab.com>
+makoto kuwata <kwa(at)kuwata-lab.com>
+
+copyright(c) 2007-2008 kuwata-lab.com all rights reserved.

data/cgi-exception.gemspec

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby
+
+###
+### $Rev: 17 $
+### $Release: 0.3.0 $
+### copyright(c) 2007-2008 kuwata-lab.com all rights reserved.
+###
+
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+  ## package information
+  s.name        = "cgi-exception"
+  s.author      = "makoto kuwata"
+  s.email       = "kwa(at)kuwata-lab.com"
+  s.rubyforge_project = 'cgi-exception'
+  s.version     = "0.3.0"
+  s.platform    = Gem::Platform::RUBY
+  s.homepage    = "http://cgi-exception.rubyforge.org/"
+  s.summary     = "Utility to display what and at where exception raised in CGI script"
+  s.description = <<-'END'
+  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.
+  END
+
+  ## files
+  files = []
+  files += Dir.glob('lib/**/*.rb')
+  files += Dir.glob('test/**/*.rb')
+  files += %W[README.txt CHANGES.txt setup.rb #{s.name}.gemspec]
+  s.files       = files
+end
+
+# Quick fix for Ruby 1.8.3 / YAML bug   (thanks to Ross Bamford)
+if (RUBY_VERSION == '1.8.3')
+  def spec.to_yaml
+    out = super
+    out = '--- ' + out unless out =~ /^---/
+    out
+  end
+end
+
+if $0 == __FILE__
+  Gem::manage_gems
+  Gem::Builder.new(spec).build
+end

data/lib/cgi_exception.rb

@@ -1,57 +1,82 @@
 ##
-## $Rev: 7 $
-## $Release: 0.2.0 $
+## $Rev: 16 $
+## $Release: 0.3.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
+class CGIExceptionPrinter
 
-## print exception in HTML format
-def _print_exception(ex)
-  arr = ex.backtrace
-  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)
+  def initialize(skip_header=false, out=$stdout)
+    @skip_header = skip_header
+    @out = out
   end
-  print "</pre>"
-end
 
-## 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
+  attr_accessor :skip_header, :out
+
+  ## escape HTML characters
+  def escape_html(s)
+    s.to_s.gsub(/&/,'&amp;').gsub(/</,'&lt;').gsub(/>/,'&gt;').gsub(/"/,'&quot;')
+  end
+
+  alias h escape_html
+
+  ## print http header
+  def print_header()
+    @out.print "Status: 500 Internal Error\r\n"
+    @out.print "Content-Type: text/html\r\n"
+    @out.print "X-CGI-Exception: 0.3.0\r\n"
+    @out.print "\r\n"
+  end
+
+  ## print exception in HTML format
+  def print_exception(ex)
+    arr = ex.backtrace
+    @out.print "<pre style=\"color:#CC0000\">"
+    @out.print "<b>#{h(arr[0])}: #{h(ex.message)} (#{h(ex.class.name)})</b>\n"
+    block = proc {|s| @out.print "        from #{h(s)}\n" }
+    max = 20
+    if arr.length <= max
+      arr[1..-1].each(&block)
+    else
+      n = 5
+      arr[1..(max-n)].each(&block)
+      @out.print "           ...\n"
+      arr[-n..-1].each(&block)
+    end
+    @out.print "</pre>"
+  end
+
+  def handle(exception)
+    print_header() unless @skip_header
+    print_exception(exception)
+  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()
+class ModRubyExceptionPrinter < CGIExceptionPrinter
+
+  ## print HTTP header (for mod_ruby)
+  def print_header
+    request = Apache::request
+    request.status = 500
+    request.status_line = '500 Internal Error'
+    request.content_type = 'text/html'
+    request.headers_out['X-CGI-Exception'] = '0.3.0'
+    request.send_http_header
+  end
+
+  def print_exception(ex)
+    super
+    $stderr.write "#{ex.backtrace[0]}: #{ex.message} (#{ex.class.name})\n"
   end
 
+end
+
+
+if defined?(MOD_RUBY)
+
   class ::Apache::RubyRun  # :nodoc:
     ## if 'alias _handler_orig handler' statement is evaluated
     ## more than twice, handler() will cause stack over flow.
@@ -59,13 +84,15 @@ if defined?(MOD_RUBY)
       alias _handler_orig handler
     end
     ## override handler() to catch and exception it to browser
-    def handler(r)
-      return _handler_orig(r)
+    def handler(request)
+      return _handler_orig(request)
     rescue Exception => ex
-      _print_http_header()
-      _print_exception(ex)
+      #Apache.request.set_cgi_env unless ENV.key?("GATEWAY_INTERFACE")
+      ModRubyExceptionPrinter.new().handle(ex)
+      if defined?(EditorKicker)
+        EditorKicker.handle(ex) #if ENV['EDITOR_KICKER']
+      end
       #raise ex
-      $stderr.write "#{ex.backtrace[0]}: #{ex.message} (#{ex.class.name})\n"
       return ::Apache::OK
     end
     ## original
@@ -80,9 +107,7 @@ if defined?(MOD_RUBY)
 
 else
 
-  def _print_http_header()    # don't use alias
-    _print_http_header_for_cgi()
-  end
+  $_header_printed = false
 
   ## override $stdout.write() to detect whether HTTP header printed or not
   class << $stdout
@@ -92,13 +117,14 @@ else
     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($!)
+      ex = $!
+      CGIExceptionPrinter.new($_header_printed).handle(ex)
+      if defined?(EditorKicker)
+        EditorKicker.handle(ex) #if ENV['EDITOR_KICKER']
+      end
     end
   end
 

data/test/test_cgi_exception.rb

@@ -1,6 +1,6 @@
 ###
 ### $Rev: 7 $
-### $Release: 0.2.0 $
+### $Release: 0.3.0 $
 ### copyright(c) 2007-2008 kuwata-lab.com all rights reserved.
 ###
 
@@ -43,7 +43,7 @@ END
     @expected = <<END
 Status: 500 Internal Error\r
 Content-Type: text/html\r
-X-CGI-Exception: 0.2.0\r
+X-CGI-Exception: 0.3.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
@@ -99,7 +99,7 @@ END
     @expected = <<END
 Status: 500 Internal Error\r
 Content-Type: text/html\r
-X-CGI-Exception: 0.2.0\r
+X-CGI-Exception: 0.3.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'
@@ -129,7 +129,7 @@ END
     @expected2 = <<END
 Status: 500 Internal Error\r
 Content-Type: text/html\r
-X-CGI-Exception: 0.2.0\r
+X-CGI-Exception: 0.3.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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cgi-exception
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - makoto kuwata
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-22 00:00:00 +09:00
+date: 2008-07-19 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
+email: kwa(at)kuwata-lab.com
 executables: []
 
 extensions: []
@@ -27,6 +27,7 @@ files:
 - README.txt
 - CHANGES.txt
 - setup.rb
+- cgi-exception.gemspec
 has_rdoc: false
 homepage: http://cgi-exception.rubyforge.org/
 post_install_message: 
@@ -49,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: cgi-exception
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Utility to display what and at where exception raised in CGI script