sleipnir-api 0.1.0

data/lib/sleipnir_api/process.rb

@@ -0,0 +1,69 @@
+require "timeout"
+require "win32ole"
+
+require "sleipnir_api/registry"
+
+module SleipnirAPI
+  class Process # :nodoc:
+    class <<self
+
+      include SleipnirAPI::Registry
+
+      @@wbem = nil
+
+      def exist?
+        not query_sleipnir.Count.zero?
+      end
+
+      def create(timeout = 3)
+        exe_path = local_server
+        unless File.exist?(exe_path)
+          raise_create_error "Sleipnir.exe not found `#{exe_path}'"
+        end
+        clazz = wbem.Get("Win32_Process")
+        r = clazz.Create(exe_path, nil, nil, nil)
+        raise_create_error "error=#{r}." unless r.zero?
+        wait_for_launch(timeout)
+      end
+
+      def wait_for_launch(timeout)
+        begin
+          timeout(timeout) {
+            sleep(0.1) until exist?
+          }
+        rescue Timeout::Error
+          raise_create_error("timed out")
+        end
+      end
+
+      def raise_create_error(msg)
+        raise Sleipnir::ProcessError, "Failed to create Sleipnir process: #{msg}."
+      end
+
+      def terminate!(handle)
+        query_sleipnir.each do |obj|
+          obj.Terminate
+        end
+      end
+
+      def query_sleipnir
+        wbem.ExecQuery("select * from Win32_Process where ExecutablePath='%s'" % escape(local_server))
+      end
+
+      def escape(str)
+        str.gsub(/\\/){ "\\\\" }
+      end
+      private :escape
+
+      def wbem
+        unless @@wbem
+          locator = WIN32OLE.new("WbemScripting.SWbemLocator")
+          @@wbem = locator.ConnectServer(".")
+        end
+        @@wbem
+      end
+      private :wbem
+
+    end
+  end
+end

data/lib/sleipnir_api/profile.rb

@@ -0,0 +1,332 @@
+require "sleipnir_api/util"
+
+module SleipnirAPI
+
+  #
+  # このクラスは Sleipnir の COM オブジェクト (Sleipnir.API) の wrapper クラスです。
+  # Sleipnir の ini ファイルを操作する API を定義しています。
+  #
+  # このオブジェクトは SleipnirAPI::Sleipnir#profile で取得します。
+  #
+  # 例:
+  #
+  #   pnir = SleipnirAPI.new
+  #   ini = pnir.profile
+  #
+  #   # デフォルト値
+  #   ini.write_string("section", "key", "foobar")
+  #   ini.get_string("section", "key")                              #=> "foobar"
+  #   ini.delete("section", "key")
+  #   ini.get_string("section", "key", :default => "default value") #=> "default value"
+  #
+  #   # 暗号化
+  #   ini.write_string("section", "key", "foobar", :cipher => true)
+  #   ini.get_string("section", "key")                              #=> "tF4DxDH)[uUu"
+  #   ini.get_string("section", "key", :cipher => true)             #=> "foobar"
+  #
+  #   # ファイル名指定
+  #   count = ini.get_int("Proxy", "Count", :ini => "proxy.ini")
+  #   (0...count).each do |i|
+  #     p ini.get_string("Proxy", "Proxy#{i}_Title", :ini => "proxy.ini")
+  #   end
+  #
+  class Profile
+    include SleipnirAPI::Util
+
+    # SleipnirAPI::Sleipnir object
+    attr_reader :sleipnir
+
+    def initialize(sleipnir)
+      @sleipnir = sleipnir
+    end
+
+    #
+    # call-seq:
+    #   get_string(section, key)
+    #   get_string(section, key, :default => "default value")
+    #   get_string(section, key, :cipher => true)
+    #   get_string(section, key, :cipher => true, :default => "default value")
+    #   get_string(section, key, :ini => ini_filename)
+    #   get_string(section, key, :ini => ini_filename, :default => "default value")
+    #
+    # string 型データを読み込みます。
+    #
+    # * <tt>:ini</tt> キーワード引数で、データを読み込む ini ファイルを指定できます。
+    #   * デフォルトは <ini_dir>\script.ini です。
+    #   * <tt>:ini</tt> に相対パスを指定した場合、SleipnirAPI::Sleipnir#user_path からの
+    #     相対パスと見なします。
+    # * <tt>:cipher</tt> に true を指定すると暗号化されたデータを複合化して読み込みます。
+    # * <tt>:default</tt> でキーが存在しないときに返す値を指定できます。
+    # * <tt>:ini</tt> と <tt>:cipher</tt> は同時には指定できません。
+    #   同時に指定した場合 <tt>:cipher</tt> は無視されます。
+    #
+    def get_string(section, key, opts = nil)
+      opts ||= {}
+      if opts[:ini]
+        api.GetProfileStringEx(section, key, opts[:default], expand_user_path(opts[:ini]))
+      elsif opts[:cipher]
+        api.GetProfileStringCipher(section, key, opts[:default])
+      else
+        api.GetProfileString(section, key, opts[:default])
+      end
+    end
+
+    #
+    # call-seq:
+    #   get_int(section, key)
+    #   get_int(section, key, :default => -1)
+    #   get_int(section, key, :cipher => true)
+    #   get_int(section, key, :cipher => true, :default => -1)
+    #   get_int(section, key, :ini => ini_filename)
+    #   get_int(section, key, :ini => ini_filename, :default => -1)
+    #
+    # int 型データを読み込みます。
+    # 詳細は get_string を参照してください。
+    #
+    def get_int(section, key, opts = nil)
+      opts ||= {}
+      if opts[:ini]
+        api.GetProfileIntEx(section, key, opts[:default], expand_user_path(opts[:ini]))
+      elsif opts[:cipher]
+        api.GetProfileIntCipher(section, key, opts[:default])
+      else
+        api.GetProfileInt(section, key, opts[:default])
+      end
+    end
+
+    #
+    # call-seq:
+    #   write_string(section, key, data)
+    #   write_string(section, key, data, :cipher => true)
+    #
+    # <ini_dir>\script.ini に string 型データを書き込みます。
+    #
+    # * <tt>:cipher</tt> に true を指定すると暗号化してデータを書き込みます。
+    #
+    def write_string(section, key, data, opts = nil)
+      opts ||= {}
+      if opts[:cipher]
+        api.WriteProfileStringCipher(section, key, data)
+      else
+        api.WriteProfileString(section, key, data)
+      end
+    end
+
+    #
+    # call-seq:
+    #   write_int(section, key, data)
+    #   write_int(section, key, data, :cipher => true)
+    #
+    # <ini_dir>\script.ini に int 型データを書き込みます。
+    #
+    # * <tt>:cipher</tt> に true を指定すると暗号化してデータを書き込みます。
+    #
+    def write_int(section, key, data, opts = nil)
+      opts ||= {}
+      if opts[:cipher]
+        api.WriteProfileIntCipher(section, key, data)
+      else
+        api.WriteProfileInt(section, key, data)
+      end
+    end
+
+    # <ini_dir>\script.ini から指定されたキーを削除します。
+    def delete(section, key)
+      api.DeleteProfileKey(section, key)
+    end
+
+    # <ini_dir> から expand_path します。
+    def expand_user_path(ini)
+      File.expand_path(ini, sleipnir.user_path)
+    end
+
+    # <ini_dir>\script.ini のパスを返します。
+    def script_ini
+      expand_user_path("script.ini")
+    end
+
+  end
+end
+
+
+__END__
+──────────────────────────────────
+[void] WriteProfileInt(string strSection, string strKey, long nData)
+──────────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini に long 型データを書き込む。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+　nData:      データ
+
+[戻り値]
+　なし
+
+
+──────────────────────────────────────
+[void] WriteProfileString(string strSection, string strKey, string strData)
+──────────────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini に string 型データを書き込む。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+　strData:    データ
+
+[戻り値]
+　なし
+
+
+───────────────────────────────────
+[long] GetProfileInt(string strSection, string strKey, long nDefault)
+───────────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini から long 型データを読み込む。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+　nDefault:   キーが存在しないときに返される値
+
+[戻り値]
+　データ
+
+
+───────────────────────────────────────
+[string] GetProfileString(string strSection, string strKey, string strDefault)
+───────────────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini から string 型データを読み込む。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+　strDefault: キーが存在しないときに返される値
+
+[戻り値]
+　データ
+
+
+─────────────────────────────────────
+[void] WriteProfileIntCipher(string strSection, string strKey, long nData)
+─────────────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini に long 型データを暗号化して書き込む。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+　nData:      データ
+
+[戻り値]
+　なし
+
+
+─────────────────────────────────
+[void] WriteProfileStringCipher(string strSection, string strKey,
+                                string strData)
+─────────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini に string 型データを暗号化して書き込む。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+　strData:    データ
+
+[戻り値]
+　なし
+
+
+──────────────────────────────────────
+[long] GetProfileIntCipher(string strSection, string strKey, long nDefault)
+──────────────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini から暗号化された long 型データを読み込む。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+　nDefault:   キーが存在しないときに返される値
+
+[戻り値]
+　データ
+
+
+─────────────────────────────────
+[string] GetProfileStringCipher(string strSection, string strKey,
+                                string strDefault)
+─────────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini から暗号化された string 型データを読み込む。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+　strDefault: キーが存在しないときに返される値
+
+[戻り値]
+　データ
+
+
+────────────────────────────────────
+[long] GetProfileIntEx(string strSection, string strKey, long nDefault,
+                       string strFileName)
+────────────────────────────────────
+
+[説明]
+　strFileName で指定される INI ファイルから long 型データを読み込む。
+
+[引数]
+　strSection:  セクション
+　strKey:      キー
+　nDefault:    キーが存在しないときに返される値
+　strFileName: 設定を読み込むファイル
+
+[戻り値]
+　データ
+
+
+─────────────────────────────────
+[string] GetProfileStringEx(string strSection, string strKey,
+                            string strDefault, string strFileName)
+─────────────────────────────────
+
+[説明]
+　strFileName で指定される INI ファイルから string 型データを読み込む。一部のフ
+　ァイルでは "" で囲まれた文字列が返されることがあります。
+
+[引数]
+　strSection:  セクション
+　strKey:      キー
+　strDefault:  キーが存在しないときに返される値
+　strFileName: 設定を読み込むファイル
+
+[戻り値]
+　データ
+
+─────────────────────────────
+[void] DeleteProfileKey(string strSection, string strKey)
+─────────────────────────────
+
+[説明]
+　<ini_dir>\script.ini から任意のキーを削除する。
+
+[引数]
+　strSection: セクション
+　strKey:     キー
+
+[戻り値]
+　なし
+

data/lib/sleipnir_api/registry.rb

@@ -0,0 +1,30 @@
+require "win32/registry"
+
+require "sleipnir_api/win32api"
+
+module SleipnirAPI
+  module Registry # :nodoc:
+    include SleipnirAPI::Win32API
+    extend SleipnirAPI::Win32API
+
+    PROG_ID = "Sleipnir.API"
+
+    module_function
+
+    # Sleipnir.API �� CLSID ��Ԃ��܂��B
+    def clsid
+      reg_read_s(Win32::Registry::HKEY_CLASSES_ROOT, "#{PROG_ID}\\CLSID", nil)
+    end
+
+    # Sleipnir.exe �̃p�X��Ԃ��܂��B
+    def local_server
+      get_long_path_name(
+        reg_read_s(Win32::Registry::HKEY_CLASSES_ROOT, "CLSID\\#{clsid}\\LocalServer32", nil))
+    end
+
+    def reg_read_s(root, key, name) #:nodoc:
+      Win32::Registry.open(root, key) {|reg| reg.read_s(name) }
+    end
+
+  end
+end

data/lib/sleipnir_api/security.rb

@@ -0,0 +1,263 @@
+require "sleipnir_api/util"
+
+module SleipnirAPI
+
+  #
+  # このクラスは Sleipnir の COM オブジェクト (Sleipnir.API) の wrapper クラスです。
+  # Sleipnir のタブ毎のセキュリティ設定を操作する API を定義しています。
+  #
+  # * このオブジェクトは SleipnirAPI::Tab#security で取得します。
+  # * このクラスは Enumerable を include しています。
+  #
+  # セキュリティ設定はハッシュ、シンボル、属性などでアクセスできます。
+  #
+  # 例:
+  #
+  #   pnir = SleipnirAPI.connect
+  #   tab = pnir.active_tab
+  #
+  #   # セキュリティ設定の取得 (すべて同じ意味)
+  #   tab.security.javascript.enable?
+  #   tab.security[:javascript].enable?
+  #   tab.security.enable?(:javascript)
+  #   tab.security.to_hash[:javascript]
+  #
+  #   # セキュリティ設定の更新 (すべて同じ意味)
+  #   tab.security.javascript.enable!
+  #   tab.security(:javascript).enable!
+  #   tab.security.set_security(:javascript => true)
+  #
+  #   # Enumerable method
+  #   tab.security.find_all{|e| e.disable? }
+  #
+  class Security
+    include Enumerable
+    include SleipnirAPI::Util
+
+    #
+    # このクラスは Sleipnir のセキュリティ設定項目をあらわします。
+    #
+    # このオブジェクトは SleipnirAPI::Security の属性から取得します。
+    #
+    class Config
+
+      attr_reader :name
+
+      def initialize(security, name)
+        @security = security
+        @name = name
+      end
+
+      # このセキュリティ設定が有効なら true を返します。
+      def enable?
+        @security.enable?(@name)
+      end
+
+      # このセキュリティ設定が無効なら true を返します。
+      def disable?
+        @security.disable?(@name)
+      end
+
+      # このセキュリティ設定の有効・無効を切り替えます。
+      #
+      # * <tt>enable</tt> が true なら有効にします。
+      # * <tt>enable</tt> が false なら無効にします。
+      #
+      # 複数のセキュリティ設定を更新する場合は、
+      # このメソッドを利用せず SleipnirAPI::Security#set_security を利用して
+      # 一括設定してください。
+      def enable=(enable)
+        @security.set_security(@name => enable)
+      end
+
+      # このセキュリティ設定を有効にします。
+      #
+      # 複数のセキュリティ設定を更新する場合は、
+      # このメソッドを利用せず SleipnirAPI::Security#set_security を利用して
+      # 一括設定してください。
+      def enable!
+        self.enable = true
+      end
+
+      # このセキュリティ設定を無効にします。
+      #
+      # 複数のセキュリティ設定を更新する場合は、
+      # このメソッドを利用せず SleipnirAPI::Security#set_security を利用して
+      # 一括設定してください。
+      def disable!
+        self.enable = false
+      end
+
+      def inspect
+        "#<%s:0x%x %s=%s>" % [self.class, self.object_id << 1, @name, enable?]
+      end
+      alias to_s inspect
+
+    end
+
+    NAME2API = [
+      [:javascript,       :IsJavaScriptEnabled],
+      [:java,             :IsJavaEnabled],
+      [:run_activex,      :IsRunActiveXEnabled],
+      [:download_activex, :IsDownloadActiveXEnabled],
+      [:picture,          :IsPictureEnabled],
+      [:sound,            :IsSoundEnabled],
+      [:video,            :IsVideoEnabled],
+    ]
+
+    # 「JavaScript の実行」をあらわす SleipnirAPI::Security::Config
+    attr_reader :javascript
+
+    # 「Java の実行」をあらわす SleipnirAPI::Security::Config
+    attr_reader :java
+
+    # 「ActiveX の実行」をあらわす SleipnirAPI::Security::Config
+    attr_reader :run_activex
+
+    # 「ActiveX のダウンロード」をあらわす SleipnirAPI::Security::Config
+    attr_reader :download_activex
+
+    # 「画像の再生」をあらわす SleipnirAPI::Security::Config
+    attr_reader :picture
+
+    # 「サウンドの再生」をあらわす SleipnirAPI::Security::Config
+    attr_reader :sound
+
+    # 「ビデオの再生」をあらわす SleipnirAPI::Security::Config
+    attr_reader :video
+
+    def initialize(tab)
+      @tab = tab
+      keys.each do |name|
+        instance_variable_set("@#{name}", Config.new(self, name))
+      end
+    end
+
+    # セキュリティ設定の名前 (シンボル) を配列で返します。
+    #
+    # この名前は #[], #set_security, #enable?, #disable? に指定できます。
+    #
+    #   pnir.active_tab.security.keys
+    #   #=> [:javascript, :java, :run_activex, :download_activex, :picture, :sound, :video]
+    #
+    def keys
+      NAME2API.map{|e| e.first }
+    end
+
+    # 指定された名前のセキュリティ設定を取得します。
+    #
+    # 以下の値を指定可能です。不正な値を指定した場合は nil を返します。
+    #
+    # * <tt>:javascript</tt>
+    # * <tt>:java</tt>
+    # * <tt>:run_activex</tt>
+    # * <tt>:download_activex</tt>
+    # * <tt>:picture</tt>
+    # * <tt>:sound</tt>
+    # * <tt>:video</tt>
+    #
+    # 取得できる値は同名の attribute と同じです。
+    #
+    #   tab = pnir.active_tab
+    #   tab.security[:javascript] #=> #<SleipnirAPI::Security::Config:0x2995190 javascript=true>
+    #   tab.security.javascript   #=> #<SleipnirAPI::Security::Config:0x2995190 javascript=true>
+    #
+    def [](name)
+      if keys.include?(name)
+        instance_variable_get("@#{name}")
+      end
+    end
+
+    # call-seq:
+    #   each {|security_config| ... }
+    #
+    # すべてのセキュリティ設定を走査します。
+    #
+    # block の引数には SleipnirAPI::Security::Config オブジェクトが渡されます。
+    def each(&block)
+      keys.map{|e| self[e] }.each(&block)
+    end
+
+    # call-seq:
+    #   set_security(:javascript => true_or_false,
+    #                :java => true_or_false,
+    #                :run_activex => true_or_false,
+    #                :download_activex => true_or_false,
+    #                :picture => true_or_false,
+    #                :sound => true_or_false,
+    #                :video => true_or_false)
+    #
+    # セキュリティ設定をハッシュで指定して更新します。
+    def set_security(opts)
+      security = to_hash
+      security.update(opts)
+      api.SetSecurity(@tab.id, *(keys.map{|e| security[e] }))
+    end
+    alias update set_security
+
+    # セキュリティ設定をハッシュで取得します。
+    def get_security
+      NAME2API.inject({}) do |h, pair|
+        h[pair[0]] = api.__send__(pair[1], @tab.id)
+        h
+      end
+    end
+    alias to_hash get_security
+
+    # 指定された名前のセキュリティ設定が有効なら true を返します。
+    def enable?(name)
+      api.__send__(NAME2API.assoc(name.to_sym)[1], @tab.id)
+    end
+
+    # 指定された名前のセキュリティ設定が無効なら true を返します。
+    def disable?(name)
+      not enable?(name)
+    end
+
+    def inspect
+      "#<%s:0x%x %s>" % [self.class, self.object_id << 1, to_hash.inspect ]
+    end
+    alias to_s inspect
+
+    # SleipnirAPI::Sleipnir object
+    def sleipnir
+      @tab.sleipnir
+    end
+
+  end
+end
+
+
+__END__
+──────────────────────────────────────
+[void] SetSecurity(long id, BOOL bJavaScript, BOOL bJava, BOOL bRunActiveX,
+                   BOOL bDownloadActiveX, BOOL bPicture, BOOL bSound,
+                   BOOL bVideo)
+──────────────────────────────────────
+
+[説明]
+　ドキュメントのセキュリティを設定する。
+
+[引数]
+　id:   ドキュメント固有の ID
+　各値: 各セキュリティ
+
+
+────────────────────
+[BOOL] IsJavaScriptEnabled(long id)
+[BOOL] IsJavaEnabled(long id)
+[BOOL] IsRunActiveXEnabled(long id)
+[BOOL] IsDownloadActiveXEnabled(long id)
+[BOOL] IsPictureEnabled(long id)
+[BOOL] IsSoundEnabled(long id)
+[BOOL] IsVideoEnabled(long id)
+────────────────────
+
+[説明]
+　ドキュメントのセキュリティを取得する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　有効ならば true