rack-ketai 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+tools/tmp

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Yuichi Takeuchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,122 @@
+= rack-ketai: A Rack Middleware for Japanese mobile-phones
+
+== rack-ketaiとは
+携帯電話向けサイトを構築する際に役立ちそうな機能を提供する（ことが目標の）ミドルウェアです。
+
+* 携帯電話キャリア判別
+* 端末名の取得
+* ユーザID、端末IDの取得
+* ディスプレイ情報（サイズ、色数）の取得
+* Cookie使用の可否
+* キャッシュサイズの取得
+* IPアドレス帯域の正当性チェック
+* 入出力文字コード変換（DoCoMo、auのみ）
+* 絵文字キャリア間変換
+* PCでの絵文字表示（TypePadの絵文字使用）
+
+テスト環境もまともにないので、万年αテスト中です。自己責任で、よくテストを行ってご利用下さい。
+
+== 使えそうなRubyのバージョン
+適当テストを通ったバージョンです。
+
+CRuby 1.8.5, 1.8.6, 1.8.7, 1.9.1
+
+JRuby 1.4.0
+
+== 使用例
+
+=== 携帯電話の識別
+  require 'rubygems'
+  require 'sinatra'
+
+  require 'rack/ketai'
+  use Rack::Ketai
+
+  get '/' do
+    case request.env['rack.ketai']
+    when Rack::Ketai::Carrier::Docomo
+      "こんにちは、DoCoMo世界！"
+    when Rack::Ketai::Carrier::Au
+      "こんにちは、Au世界！"
+    when Rack::Ketai::Carrier::Softbank
+      "こんにちは、Softbank世界！"
+    else
+      "こんにちは、その他の世界！"
+    end
+  end
+
+単に携帯電話でのアクセスか識別するのであれば、<tt>#mobile?</tt>を使います。
+  env['rack.ketai'].mobile?
+
+互換性のため、携帯電話からのアクセスでないときには、特異メソッド<tt>#mobile? => false</tt>を定義した<tt>nil</tt>が設定されます。
+
+=== 端末名の取得
+  env['rack.ketai'].name # => "SO903i"
+
+=== ユーザID、端末IDの取得
+各キャリアの利用者の識別に関する情報の扱いを一元化します。
+これにより、携帯サイトでのユーザ認証等が容易になります。（後述のIPアドレス帯域チェックと併用すること）
+  ketai = env['rack.ketai']
+  ketai.subscriberid  # ユーザID：iモードID or FOMAカード製造番号/EZ番号/x-jphone-uid
+  ketai.deviceid      # 端末ID：端末製造番号(DoCoMo)/端末シリアル(SoftbankMobile)
+  ketai.ident         # ユーザか端末を識別する情報（ユーザID or 端末製造番号）
+
+=== ディスプレイ情報の取得
+環境変数もしくは http://ke-tai.org/ で公開されている携帯端末スペック一覧のデータから縦横ピクセル数及び色数を取得できます。
+  ketai = env['rack.ketai']
+  display = ketai.display
+  display.colors # 色数 取得できなければ nil
+  display.width  # 横サイズ 取得できなければ nil
+  display.height # 縦サイズ 取得できなければ nil
+
+=== Cookie使用の可否
+DoCoMoの場合はiモードブラウザ2.0、SoftBankは現行の全機種、auも全機種（WAP1.0端末はSSL通信時利用不可）っぽいのでそれを判別してくれます。（できるだけ...）
+  if env['rack.ketai'].supports_cookie?
+    # Cookie 使用可能
+  else
+    # Cookie 使用不可
+  end
+
+=== キャッシュサイズの取得
+環境変数や端末名からブラウザのキャッシュサイズ（Bytes）を取得します。取得できない場合は、それっぽい最小の値を返します。
+  env['rack.ketai'].cache_size # => 100000 (100KB)
+
+=== IPアドレス帯域の正当性チェック
+ユーザのアクセス元のIPアドレスがキャリアが公開するアドレス帯に含まれているか確認できます。
+ユーザID等の偽装防止等に役立ちます。
+  ketai = env['rack.ketai']
+  unless ketai.mobile? && ketai.valid_addr?
+    # 携帯からのアクセスでない
+  end
+
+=== 入出力文字コード変換
+DoCoMoまたはauの携帯電話との通信でShift_JISを使うようになります。
+Content-typeも便宜書き換えます。
+
+=== 絵文字キャリア間変換
+入力された絵文字を、emoji4unicodeによる変換テーブルを元に [e:XXX] という文字列に置き換えます。
+（XXX はemoji4unicodeによる絵文字のID）
+文字列に置き換えるようにしたのは、PCからの絵文字の入力・表示への対応を容易にするためです。
+出力時にキャリアに応じた絵文字コードに変換します。
+
+なお、文字コード変換及び絵文字変換を行いたくない場合は、<tt>:disable_filter</tt>オプションを設定します。
+  use Rack::Ketai, :disable_filter => true
+
+=== PCでの絵文字表示
+SixApartが公開している絵文字アイコン画像を別途ダウンロード・配置し、簡単なコードを追加することで携帯キャリア以外でのアクセスの際に絵文字画像を表示できます。
+
+TypePadの絵文字アイコン画像と、携帯コンテンツ表示モジュールをフリー（自由）ライセンスで公開
+http://start.typepad.jp/typecast/
+
+絵文字アイコンをダウンロードし、public/images/emoticons/*.gif に配置した場合の例
+  use Rack::Static, :urls => ['/images'], :root => 'public'
+  use Rack::Ketai, :emoticons_path => '/images/emoticons'
+  run MyApp.new
+
+=== 作者
+
+Copyright 2009-2010 (c) Yuichi Takeuchi, under MIT License
+
+Yuichi Takeuchi <mizincogrammer@gmail.com>
+
+http://d.hatena.ne.jp/mizincogrammer

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack/ketai/carrier/abstract.rb

@@ -0,0 +1,263 @@
+# -*- coding: utf-8 -*-
+require 'tempfile'
+require 'singleton'
+require 'nkf'
+require 'rack/request'
+require 'stringio'
+require 'ipaddr'
+
+unless IPAddr.instance_methods.include?("to_range")
+  class IPAddr
+
+    def coerce_other(other)
+      case other
+      when IPAddr
+        other
+      when String
+        self.class.new(other)
+      else
+        self.class.new(other, @family)
+      end
+    end
+
+    # Returns the successor to the ipaddr.
+    def succ
+      return self.clone.set(@addr + 1, @family)
+    end
+    
+    # Compares the ipaddr with another.
+    def <=>(other)
+      other = coerce_other(other)
+      
+      return nil if other.family != @family
+      
+      return @addr <=> other.to_i
+    end
+    include Comparable
+    
+    def to_range
+      begin_addr = (@addr & @mask_addr)
+      
+      case @family
+      when Socket::AF_INET
+        end_addr = (@addr | (IN4MASK ^ @mask_addr))
+      when Socket::AF_INET6
+        end_addr = (@addr | (IN6MASK ^ @mask_addr))
+      else
+        raise "unsupported address family"
+      end
+      return clone.set(begin_addr, @family)..clone.set(end_addr, @family)
+    end
+    
+  end
+end
+
+module Rack::Ketai::Carrier
+  class Abstract
+
+    class << self
+      def filters
+        []
+      end
+
+      def valid_addr?(remote_addr)
+        cidrs = nil
+        begin
+          cidrs = self::CIDRS
+        rescue NameError
+          return nil
+        end
+        remote = IPAddr.new(remote_addr)
+        cidrs.any?{ |cidr| cidr.include?(remote) }
+      end
+      alias :valid_ip? :valid_addr?
+    end
+
+    def initialize(env)
+      @env = env
+    end
+    
+    USER_AGENT_REGEXP = nil
+
+    def filtering(env, options = { }, &block)
+      env = options[:disable_filter] ? env : filters(options).inject(env) { |env, filter| filter.inbound(env) }
+      ret = block.call(env)
+      ret[2] = ret[2].body if ret[2].is_a?(Rack::Response)
+      options[:disable_filter] ? ret : filters(options).reverse.inject(ret) { |r, filter| filter.outbound(*r) }
+    end
+
+    def filters(options = { })
+      self.class.filters.collect do |klass|
+        klass.new(options)
+      end
+    end
+    
+    # 携帯端末か
+    def mobile?
+      false
+    end
+
+    # サブスクライバID
+    # 契約者毎にユニーク
+    def subscriberid
+      nil
+    end
+
+    # デバイスID
+    # 端末毎にユニーク
+    def deviceid
+      nil
+    end
+    
+    # 識別情報
+    def ident
+      subscriberid || deviceid
+    end
+
+    # 機種名（略名）
+    def name
+      nil
+    end
+
+    # ディスプレイ情報
+    def display
+      Rack::Ketai::Display.new
+    end
+
+    # キャリアのIPアドレス帯を利用しているか
+    def valid_addr?
+      self.class.valid_ip? @env['HTTP_X_FORWARDED_FOR'] || @env['REMOTE_ADDR']
+    end
+    alias :valid_ip? :valid_addr?
+
+    # キャッシュサイズ
+    def cache_size
+      nil
+    end
+
+    # Cookieのサポート
+    def supports_cookie?
+      false
+    end
+  end
+end
+
+class Rack::Ketai::Carrier::Abstract
+  class Filter
+
+    def initialize(options = { })
+      @options = options.clone
+    end
+    
+    def inbound(env)
+      apply_incoming?(env) ? to_internal(env) : env
+    end
+    
+    def outbound(status, headers, body)
+      apply_outgoing?(status, headers, body) ? to_external(status, headers, body) : [status, headers, body]
+    end
+
+    private
+    def to_internal(env)
+      env
+    end
+    
+    def to_external(status, headers, body)
+      if headers['Content-Type']
+        case headers['Content-Type']
+        when /charset=[\w\-]+/i
+          headers['Content-Type'].sub!(/charset=[\w\-]+/, 'charset=utf-8')
+        else
+          headers['Content-Type'] << "; charset=utf-8"
+        end
+      end
+      [status, headers, body]
+    end
+    
+    def full_apply(*argv, &proc)
+      argv.each do |obj|
+        deep_apply(obj, &proc)
+      end
+    end
+    
+    def deep_apply(obj, &proc)
+      case obj
+      when Hash
+        obj.each_pair do |key, value|
+          obj[key] = deep_apply(value, &proc)
+        end
+        obj
+      when Array
+        obj.collect!{ |value| deep_apply(value, &proc)}
+      when NilClass, TrueClass, FalseClass, Tempfile, StringIO
+        obj
+      else
+        proc.call(obj)
+      end
+    end
+
+    def apply_incoming?(env); true; end
+    def apply_outgoing?(status, headers, body)
+      headers['Content-Type'] !~ /^(.+?)(?:;|$)/
+      [nil, "text/html", "application/xhtml+xml"].include?($1)
+    end
+
+  end
+
+  
+  class SjisFilter < Filter
+
+    private
+    def to_internal(env)
+      request = Rack::Request.new(env)
+      
+      # 最低でも1回呼んでないと query_string, form_hash等が未設定
+      request.params
+
+      # 同一オブジェクトが両方に入ってたりして二重にかかることがあるので
+      converted_objects = []
+      converter = lambda { |value|
+        unless converted_objects.include?(value)
+          value = NKF.nkf('-m0 -x -Sw', value)
+          converted_objects << value
+        end
+        value
+      }
+
+      full_apply(request.env["rack.request.query_hash"],
+                 request.env["rack.request.form_hash"],
+                 &converter)
+
+      request.env
+    end
+    
+    def to_external(status, headers, body)
+      if body.is_a?(Array)
+        body = body.collect do |str|
+          NKF.nkf('-m0 -x -Ws', str)
+        end
+      else
+        body = NKF.nkf('-m0 -x -Ws', body)
+      end
+
+      if headers['Content-Type']
+        case headers['Content-Type']
+        when /charset=[\w\-]+/i
+          headers['Content-Type'].sub!(/charset=[\w\-]+/, 'charset=shift_jis')
+        else
+          headers['Content-Type'] << "; charset=shift_jis"
+        end
+      end
+
+      content = (body.is_a?(Array) ? body[0] : body).to_s
+      headers['Content-Length'] = (content.respond_to?(:bytesize) ? content.bytesize : content.size).to_s if headers.member?('Content-Length')
+    
+      [status, headers, body]
+    end
+    
+  end
+
+end
+
+require 'rack/ketai/carrier/emoji/emojidata'
+

data/lib/rack/ketai/carrier/au.rb

@@ -0,0 +1,153 @@
+# -*- coding: utf-8 -*-
+require 'scanf'
+
+module Rack
+  module Ketai
+    module Carrier
+      class Au < Abstract
+        autoload :CIDRS, 'rack/ketai/carrier/cidrs/au'
+        autoload :SPECS, 'rack/ketai/carrier/specs/au'
+        
+        USER_AGENT_REGEXP = /^(?:KDDI|UP.Browser\/.+?)-(.+?) /
+  
+        class Filter < ::Rack::Ketai::Carrier::Abstract::SjisFilter
+
+          # 絵文字コード -> 絵文字ID 対応表から、絵文字コード検出用の正規表現をつくる
+          # 複数の絵文字の組み合わせのものを前におくことで
+          # そっちを優先的にマッチさせる
+          def Filter.sjis_regexp
+            @sjis_regexp ||=
+              if RUBY_VERSION >= '1.9.1'
+                codes = EMOJI_TO_EMOJIID.keys.sort_by{ |codes| - codes.size }.collect{ |sjis| Regexp.escape(sjis)}
+                Regexp.new(codes.join('|'), nil)
+              else
+                codes = EMOJI_TO_EMOJIID.keys.sort_by{ |codes| - codes.size }.collect{ |sjis| Regexp.escape(sjis, 's') }
+                Regexp.new(codes.join('|'), nil, 's')
+              end
+          end
+
+          private
+          def to_internal(env)
+            # au SJISバイナリ -> 絵文字ID表記
+            request = Rack::Request.new(env)
+            
+            request.params  # 最低でも1回呼んでないと query_stringが未設定
+            
+            converter = lambda do |value|
+              value.force_encoding('Shift_JIS') if value.respond_to?(:force_encoding)
+              value.gsub(Filter.sjis_regexp) do |match|
+                format("[e:%03X]", EMOJI_TO_EMOJIID[match])
+              end
+            end
+            deep_apply(request.env["rack.request.query_hash"], &converter)
+            deep_apply(request.env["rack.request.form_hash"], &converter)
+            
+            # 文字コード変換
+            super(request.env)
+          end
+          
+          def to_external(status, headers, body)
+            status, headers, body = super
+            
+            return [status, headers, body] unless body[0]
+            
+            body = body.collect do |str|
+              str.gsub(/\[e:([0-9A-F]{3})\]/) do |match|
+                emojiid = $1.scanf('%X').first
+                sjis = EMOJIID_TO_EMOJI[emojiid]
+                if sjis
+                  # 絵文字があるので差替え
+                  sjis
+                else
+                  # 絵文字がないので代替文字列
+                  emoji_data = EMOJI_DATA[emojiid]
+                  NKF.nkf('-Ws', (emoji_data[:fallback] || emoji_data[:name] || '〓'))
+                end
+              end
+            end
+            
+            content = (body.is_a?(Array) ? body[0] : body).to_s
+            headers['Content-Length'] = (content.respond_to?(:bytesize) ? content.bytesize : content.size).to_s if headers.member?('Content-Length')
+            
+            [status, headers, body]
+          end
+        end
+        
+        class << self
+          def filters
+            super | [Rack::Ketai::Carrier::Au::Filter]
+          end
+        end
+
+        def mobile?
+          true
+        end
+
+        def subscriberid
+          ezno
+        end
+
+        def ezno
+          @ezno ||= @env['HTTP_X_UP_SUBNO'].to_s =~ /^(\w{14}_\w{2}\.ezweb\.ne\.jp)$/ && $1
+        end
+
+        def name
+          # UAの最初の - の後ろが略称
+          @name ||= @env['HTTP_USER_AGENT'] =~ /^[^\-]+\-(\w+)/ && $1
+        end
+
+        def display
+          return @display if @display
+          width = height = colors = nil
+          if @env['HTTP_X_UP_DEVCAP_SCREENPIXELS'].to_s =~ /(\d+),(\d+)/
+            width = $1.to_i
+            height = $2.to_i
+          end
+          width ||= spec[5]
+          height ||= spec[6]
+          
+          color_depth = (@env['HTTP_X_UP_DEVCAP_SCREENDEPTH'].to_s =~ /^(\d+)/ && $1).to_i
+          colors = color_depth > 0 ? 2 ** color_depth : spec[7]
+
+          @display = Rack::Ketai::Display.new(:colors => colors,
+                                              :width => width,
+                                              :height => height)
+        end
+
+        # Cookie対応
+        # 全機種対応（GW側で保持）
+        # SSL接続時はWAP2.0ブラウザ搭載端末でのみ端末に保持したCookieを送出
+        # http://www.au.kddi.com/ezfactory/tec/spec/cookie.html
+        def supports_cookie?
+          is_wap1? && use_ssl? ? false : true
+        end
+
+        # キャッシュサイズ
+        # HTTP_X_UP_DEVCAP_MAX_PDU に入ってくる…が一部古い携帯は入らないらしい
+        def cache_size
+          @cache_size ||= (val = @env['HTTP_X_UP_DEVCAP_MAX_PDU'].to_i) > 0 ? val : 8220
+        end
+
+        private
+        def spec
+          @spec ||= SPECS[name] || []
+        end
+
+        def use_ssl?
+          @env['HTTPS'].to_s.downcase == 'on' || @env['X_FORWARDED_PROTO'] == 'https'
+        end
+
+        # WAP1ブラウザではKDDIからはじまらない
+        def is_wap1?
+          @env['HTTP_USER_AGENT'] !~ /^KDDI\-/
+        end
+
+      end
+    end
+  end
+end
+
+# 変換テーブル読み込み
+require 'rack/ketai/carrier/emoji/ausjisstrtoemojiid'
+
+

data/lib/rack/ketai/carrier/cidrs/au.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+# http://www.au.kddi.com/ezfactory/tec/spec/ezsava_ip.html
+# 2010.6.22時点
+
+Rack::Ketai::Carrier::Au::CIDRS = %w(
+210.230.128.224/28
+121.111.227.160/27
+61.117.1.0/28
+219.108.158.0/27
+219.125.146.0/28
+61.117.2.32/29
+61.117.2.40/29
+219.108.158.40/29
+219.125.148.0/25
+222.5.63.0/25
+222.5.63.128/25
+222.5.62.128/25
+59.135.38.128/25
+219.108.157.0/25
+219.125.145.0/25
+121.111.231.0/25
+121.111.227.0/25
+118.152.214.192/26
+118.159.131.0/25
+118.159.133.0/25
+118.159.132.160/27
+111.86.142.0/26
+111.86.141.64/26
+111.86.141.128/26
+111.86.141.192/26
+118.159.133.19/26
+).collect{ |cidr| IPAddr.new(cidr) }

data/lib/rack/ketai/carrier/cidrs/docomo.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+# http://www.nttdocomo.co.jp/service/imode/make/content/ip/index.html
+# 2010.4.19時点
+
+Rack::Ketai::Carrier::Docomo::CIDRS = %w(
+210.153.84.0/24
+210.136.161.0/24
+210.153.86.0/24
+124.146.174.0/24
+124.146.175.0/24
+202.229.176.0/24
+202.229.177.0/24
+202.229.178.0/24
+).collect{ |cidr| IPAddr.new(cidr) }

data/lib/rack/ketai/carrier/cidrs/softbank.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+# http://creation.mb.softbank.jp/web/web_ip.html
+# 2010.4.19時点
+
+Rack::Ketai::Carrier::Softbank::CIDRS = %w(
+123.108.237.0/27
+202.253.96.224/27
+210.146.7.192/26
+210.175.1.128/25
+).collect{ |cidr| IPAddr.new(cidr) }