egalite 1.4.0 → 1.5.1

data/README.md

@@ -123,6 +123,18 @@ egaliteには自動でCSRF対策のチェック値を埋め込む機能が付い
 	class Pages < Egalite::CSRFController
 	end
 
+## エラー処理
+
+例外が発生した場合、:error_templateに設定されたHTMLテンプレートを表示します。
+
+このテンプレートには:exception_log_tableが指定されている場合は、記録されたエラーログ番号がlogidとして埋め込まれます。これによりシステムエラー時のユーザからの問い合わせに迅速に対応することができるようになります。
+
+Egalite::UserErrorまたはEgalite::SystemErrorという例外が送出された場合には、その中のmessageがテンプレートにmessageとして埋め込まれます。これにより簡易的にユーザーにエラーメッセージを表示することができます。
+
+UserError例外はエラーログに記録されません。
+
+UserError例外発生時には、テンプレートにusererror => trueが引き渡されます。
+
 ## モジュール
 
 ### キャッシュモジュール
@@ -167,3 +179,14 @@ RDBMSでのテーブル定義は以下の通り。
 
 HTMLテンプレートに記載された文章や画像はm17n.txtに記述するだけで、コントローラーには一切手を加えることなく多言語化が可能です。
 
+## リリースノート
+
+### 1.5
+
+UserErrorとSystemError例外が追加されました。これによりユーザにエラーメッセージを容易に表示できます。
+
+:error_template_fileが追加されました。ファイル名を指定するだけでエラーテンプレートが読み込まれるようになります。
+
+### 1.5.1
+
+Egalite::ErrorLogger.catch_exception(sendmail) {}が追加されました。これを使うと、任意のブロックで発生した例外をキャッチして、管理者へのメール送信やログの出力を行います。重要なエラーが発生する可能性がある場所への利用に適しています。

data/lib/egalite/version.rb

@@ -1,3 +1,3 @@
 module Egalite
-  VERSION = "1.4.0"
+  VERSION = "1.5.1"
 end

data/lib/egalite.rb

@@ -29,6 +29,12 @@ class CriticalError < RuntimeError
 end
 
 module Egalite
+  class UserError < RuntimeError
+    # ユーザーの手順によるエラーを記録する。ログに残らない。
+  end
+  class SystemError < RuntimeError
+    # システムのエラーを記録する。ログに残る。
+  end
 
   module AccessLogger
    @@io = nil
@@ -85,34 +91,59 @@ module Egalite
   module ErrorLogger
    @@table = nil
    @@admin_emails = nil
+   @@email_from = nil
    class <<self
+    def create_table(db, opts = {})
+      table = opts[:table_name] || :logs
+      
+      db.create_table(table) {
+        primary_key :id, :integer, :auto_increment => true
+        column :severity, :varchar
+        column :ipaddress, :varchar
+        column :text, :varchar
+        column :url, :varchar
+        column :md5, :varchar
+        column :created_at, :timestamp
+        column :checked_at, :timestamp
+      }
+    end
     def table=(t)
       @@table=t
     end
     def admin_emails=(t)
       @@admin_emails=t
     end
-    def write(hash)
+    def email_from=(t)
+      @@email_from=t
+    end
+    def write(hash, sendmail = false)
       hash[:md5] = Digest::MD5.hexdigest(hash[:text]) unless hash[:md5]
-      if hash[:severity] == 'critical' and @@admin_emails
+      if (hash[:severity] == 'critical' or sendmail) and @@admin_emails
         Sendmail.send(hash[:text],{
-          :from => 'info@xcream.net',
+          :from => @@email_from || "egalite@example.com",
           :to => @@admin_emails,
-          :subject => 'Critical error at xcream.net'
+          :subject => "Exception report from Egalite framework."
         })
       end
       if @@table
         @@table.insert(hash) rescue nil
       end
     end
-    def write_exception(e, hash)
+    def write_exception(e, hash, sendmail = false)
       severity = 'exception'
       severity = 'security' if e.is_a?(SecurityError)
       severity = 'critical' if e.is_a?(CriticalError)
       
       text = "#{e.to_s}\n#{e.backtrace.join("\n")}"
       
-      ErrorLogger.write({:severity => severity, :text => text}.merge(hash))
+      ErrorLogger.write({:severity => severity, :text => text}.merge(hash),sendmail)
+    end
+    def catch_exception(sendmail = false, hash = {})
+      begin
+        yield
+      rescue Exception => e
+        ErrorLogger.write_exception(e, hash, sendmail)
+      end
     end
    end
   end
@@ -389,12 +420,18 @@ class Handler
     
     @profile_logger = opts[:profile_logger]
     @notfound_template = opts[:notfound_template]
-    @error_template = opts[:error_template]
+    if opts[:error_template_file]
+      @error_template = File.open(opts[:error_template_file]).read
+    else
+      @error_template = opts[:error_template]
+    end
     @admin_emails = opts[:admin_emails]
+    @email_from = opts[:email_from]
     @exception_log_table = opts[:exception_log_table]
     if @exception_log_table
       Egalite::ErrorLogger.table = db[@exception_log_table]
       Egalite::ErrorLogger.admin_emails = @admin_emails
+      Egalite::ErrorLogger.email_from = @email_from
     end
   end
 
@@ -704,7 +741,7 @@ class Handler
       begin
         # write error log
         logid = nil
-        if @exception_log_table
+        if @exception_log_table and not e.is_a?(UserError)
           logid = ErrorLogger.write_exception(e,{:ipaddress => req.ip, :url => req.url})
         end
         
@@ -715,6 +752,8 @@ class Handler
           values[:logid] = logid if logid
           values[:exception] = e.to_s
           values[:backtrace] = e.backtrace
+          values[:message] = e.message if e.is_a?(UserError) or e.is_a?(SystemError)
+          values[:usererror] = true if e.is_a?(UserError)
           html = @template_engine.new.handleTemplate(@error_template.dup,values)
           res = [500, {"Content-type"=>"text/html; charset=utf-8"}, [html]]
         else

data/test/error_template.html

@@ -0,0 +1,16 @@
+<html>
+<body>
+<p>
+logid: &=logid;
+</p>
+<p>
+message: &=message;
+</p>
+<p>
+<if name='usererror'>
+this is usererror
+</if>
+</p>
+</body>
+</html>
+

data/test/test_errorlogger.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH << File.dirname(__FILE__)
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..')
+
+require 'rubygems'
+require 'test/unit'
+require 'lib/egalite'
+
+require 'rack'
+require 'rack/multipart'
+require 'rack/test'
+
+require 'setup'
+
+class ErrorLoggerController < Egalite::Controller
+  def foo
+    Egalite::ErrorLogger.catch_exception(true) {
+      raise "piyolog"
+    }
+    "hoge"
+  end
+end
+
+class T_ErrorLogger < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    db = Sequel.sqlite
+    @db = db
+    Egalite::ErrorLogger.create_table(db)
+    Egalite::Handler.new({
+      :admin_emails => "to@example.com",
+      :email_from => "from@example.com",
+      :exception_log_table => :logs,
+      :db => db,
+    })
+  end
+  def test_errortemplate
+    Sendmail.mock = true
+    get "/error/logger/foo"
+    assert last_response.ok?
+    assert_equal "hoge", last_response.body
+    assert_equal "from@example.com", Sendmail.lastmail[1]
+    assert_match /piyolog/, Sendmail.lastmail[0]
+    assert_match /piyolog/, @db[:logs].first[:text]
+  end
+end

data/test/test_errortemplate.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH << File.dirname(__FILE__)
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..')
+
+require 'rubygems'
+require 'test/unit'
+require 'lib/egalite'
+
+require 'rack'
+require 'rack/multipart'
+require 'rack/test'
+
+require 'setup'
+
+class ErrorTemplateController < Egalite::Controller
+  def foo
+    raise Egalite::UserError.new("UserError")
+  end
+end
+
+class T_ErrorTemplate < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Egalite::Handler.new(
+      :error_template_file => "test/error_template.html"
+    )
+  end
+  def test_errortemplate
+    $raise_exception = false
+    get "/error/template/foo"
+    assert_match /message: UserError/, last_response.body
+    assert_match /this is usererror/, last_response.body
+    $raise_exception = true
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: egalite
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 1
   prerelease: 
   segments: 
   - 1
-  - 4
-  - 0
-  version: 1.4.0
+  - 5
+  - 1
+  version: 1.5.1
 platform: ruby
 authors: 
 - Shunichi Arai
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-09-24 00:00:00 Z
+date: 2015-01-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -117,6 +117,7 @@ files:
 - test/cache.html
 - test/cache_cache.html
 - test/cache_nocache.html
+- test/error_template.html
 - test/french.html
 - test/french_msg.html
 - test/m17n.txt
@@ -131,6 +132,8 @@ files:
 - test/test_cache.rb
 - test/test_csrf.rb
 - test/test_errorconsole.rb
+- test/test_errorlogger.rb
+- test/test_errortemplate.rb
 - test/test_handler.rb
 - test/test_helper.rb
 - test/test_keitai.rb
@@ -177,6 +180,7 @@ test_files:
 - test/cache.html
 - test/cache_cache.html
 - test/cache_nocache.html
+- test/error_template.html
 - test/french.html
 - test/french_msg.html
 - test/m17n.txt
@@ -191,6 +195,8 @@ test_files:
 - test/test_cache.rb
 - test/test_csrf.rb
 - test/test_errorconsole.rb
+- test/test_errorlogger.rb
+- test/test_errortemplate.rb
 - test/test_handler.rb
 - test/test_helper.rb
 - test/test_keitai.rb