DOBON.NET プログラミング道: .NET Framework, VB.NET, C#, Visual Basic, Visual Studio, インストーラ, ...

• カスタム動作エディタの使い方
  • 簡単な例
  • アプリケーションフォルダにスクリプトを配置しない
  • カスタム動作の4つのノードとその詳細
  • EXE、DLLのカスタムアクション
  • Installerクラス
  • Installerクラスを使ったカスタムアクションの詳細
  • カスタム動作にデータを渡す
  • エラーを発生させる
• この記事への評価、コメント、トラックバック

カスタム動作エディタの使い方

デプロイメントプロジェクトのカスタム動作エディタを使って、作成するWindows Installerパッケージで使用するカスタムアクションを指定することができます。カスタムアクションとは、Windows Installerだけの機能では実現が難しい動作をEXE、DLL、スクリプト等を使って行うものです。

簡単な例

早速ですが、まずはカスタムアクションがどのようなものか、簡単な例を見てみましょう。ここでは、VBScriptを使用することにします。

はじめにカスタムアクションで使用するスクリプトを作成します。ここでは次のようなごく簡単なスクリプトを作成し、"action.vbs"という名前で保存します。メッセージボックスを表示し、「こんにちは」と表示するだけのスクリプトです。

[VBScript]
MsgBox "こんにちは"

まずは、この"action.vbs"をデプロイメントプロジェクトに追加します。ソリューションエクスプローラでプロジェクトを右クリックし、メニューの[追加]-[ファイル]で追加できます。

次に「カスタム動作エディタ」を開き、スクリプトを追加します。カスタム動作を開くには、ソリューションエクスプローラでプロジェクトを右クリックし、メニューの[表示]-[カスタム動作]を選択します。

カスタム動作エディタには4つのノードがありますが、これらの説明は後に回し、ここでは「インストール」ノードにカスタムアクションを追加します。「インストール」ノードを右クリックし、メニューの[カスタム動作の追加]で表示される「プロジェクトから項目を選択」ダイアログで"action.vbs"を選択し、OKをクリックします。

これでカスタムアクションが追加されました。早速ビルドして試してみましょう。

作成したMSIファイルを実行すると、「（アプリケーション名）をインストールしています」というステップの途中で「こんにちは」というメッセージボックスが表示されるはずです。

アプリケーションフォルダにスクリプトを配置しない

上記の例では、スクリプトファイルがアプリケーションフォルダに配置されます。スクリプトファイルを配置しないようにするには、ソリューションエクスプローラで"action.vbs"を選択し、ExcludeプロパティをTrueにします。

後述しますが、Installerクラスによるカスタムアクションでは、この方法はできません。

カスタム動作の4つのノードとその詳細

カスタム動作エディタには4つのノード「インストール」、「確定」、「ロールバック」、「アンインストール」があります。それぞれが何を意味しているかについては、ヘルプの「カスタム動作エディタ」で説明されています。

この説明を以下に引用させていただきます。

インストール：

このノードの下のカスタム動作は、インストールのインストール フェーズの最後 (すべてのファイルがインストールされた後) に実行されます。

確定：

このノードの下のカスタム動作は、インストールの確定フェーズの最後に実行されます。確定フェーズは、インストール フェーズが問題なく終了すると発生します。

ロールバック：

このノードの下のカスタム動作は、インストールのロールバック フェーズの最後に実行されます。ロールバック フェーズは、インストール中にエラーが発生すると発生します。

アンインストール：

このノードの下のカスタム動作は、インストールのアンインストール フェーズの最後に実行されます。アンインストール フェーズは、アプリケーションがアンインストールされると発生します。

EXE、DLLのカスタムアクション

上記で紹介したようなスクリプト以外に、EXEやDLLファイルをカスタムアクションに使用することもできます。EXEはマネージコードでも構いませんが（注）、DLLはアンマネージコードである必要があります。しかし、Installクラスを使用したカスタムアクションの場合は、DLLでも大丈夫です。ここからは、Installクラスを使った方法を紹介します。

Installerクラス

.NET Frameworkには、「Installer クラス」というクラスが用意されており、これをカスタムアクションに使用することができます。

はじめに、簡単な例から紹介します。

まず、新しいクラスライブラリのプロジェクトを作成します。ここではデプロイメントプロジェクトと同じソリューション内に作成し、名前を「CustomAction」としました。このクラスの参照設定に、「System.Configuration.Install.dll」を追加します（ここではMessageBoxを使用しているため、「System.Windows.Forms.dll」も追加します）。

次に、Installerクラスの派生クラスを作成し、RunInstallerAttribute属性を追加し、Trueにします。さらに、必要に応じてInstall、Commit、Rollback、Uninstallメソッドをオーバーライドします。これらのメソッドは、それぞれ「インストール」、「確定」、「ロールバック」、「アンインストール」の時に呼び出されます。これらのメソッドでは、まずはじめに基本クラスのメソッドを呼び出します。（「インストール コンポーネントの既定のメソッドのオーバーライド」でも説明されています。）

ここでは以下のようなコードでビルドし、DLLファイル「CustomAction.dll」を作成しました。

[VB.NET]
<System.ComponentModel.RunInstaller(True)> _
Public Class Installer1
    Inherits System.Configuration.Install.Installer

    Public Overrides Sub Install( _
        ByVal stateSaver As System.Collections.IDictionary)
        MyBase.Install(stateSaver)

        System.Windows.Forms.MessageBox.Show("Install")
    End Sub

    Public Overrides Sub Commit( _
        ByVal savedState As System.Collections.IDictionary)
        MyBase.Commit(savedState)

        System.Windows.Forms.MessageBox.Show("Commit")
    End Sub

    Public Overrides Sub Rollback( _
        ByVal savedState As System.Collections.IDictionary)
        MyBase.Rollback(savedState)

        System.Windows.Forms.MessageBox.Show("Rollback")
    End Sub

    Public Overrides Sub Uninstall( _
        ByVal savedState As System.Collections.IDictionary)
        MyBase.Uninstall(savedState)

        System.Windows.Forms.MessageBox.Show("Uninstall")
    End Sub
End Class

[C#]
[System.ComponentModel.RunInstaller(true)]
public class Installer1 : System.Configuration.Install.Installer
{
    public override void Install(System.Collections.IDictionary stateSaver)
    {
        base.Install(stateSaver);

        System.Windows.Forms.MessageBox.Show("Install");
    }

    public override void Commit(System.Collections.IDictionary savedState)
    {
        base.Commit(savedState);

        System.Windows.Forms.MessageBox.Show("Commit");
    }

    public override void Rollback(System.Collections.IDictionary savedState)
    {
        base.Rollback(savedState);

        System.Windows.Forms.MessageBox.Show("Rollback");
    }

    public override void Uninstall(System.Collections.IDictionary savedState)
    {
        base.Uninstall(savedState);

        System.Windows.Forms.MessageBox.Show("Uninstall");
    }

}

このカスタムアクションをデプロイメントプロジェクトで使用するためには、先ほどと同じように、作成したDLLをデプロイメントプロジェクトに追加してから（ここでは、「プロジェクト出力」から、「CustomActionプロジェクトのプライマリ出力」を追加しました）、カスタム動作エディタに追加します。ここでは、4つのノードすべてに追加するために、「カスタム動作」のノードを右クリックし、メニューの[カスタム動作の追加]を選び、「CustomActionのプライマリ出力」を選択します。

Installerクラスをカスタムアクションとして使用するには、カスタム動作のInstallerClassプロパティをTrueとする必要がありますが、デフォルトでTrueのため、このままでOKです。

ビルドしてMSIファイルを作成し、実行してみましょう。VBScriptの例と同じように、インストールの最後の方で「Install」と表示され、その後「Commit」と表示されます。また、アンインストール時には、「Uninstall」と表示されます。

Installerクラスを使ったカスタムアクションの詳細

例によってOrcaにより、作成されたMSIファイルの詳細を見てみます。

Installerクラスを使った場合、カスタム動作を一つ追加すると、CustomActionテーブルに2つの列が追加されます。「インストール」ノードに追加されたカスタム動作の場合、例えば、次のような2つの列が追加されます。

Action

_B2459EE5_658C_4EF0_BCE3_810CFFFBC274.uninstall.SetProperty

Type

51

Source

_B2459EE5_658C_4EF0_BCE3_810CFFFBC274.uninstall

Target

/installtype=notransaction /action=uninstall /LogFile= "[#_A367697580D6A572E31AB7AA55DFF20A]" "[VSDFxConfigFile]"

Action

_B2459EE5_658C_4EF0_BCE3_810CFFFBC274.uninstall

Type

1025

Source

InstallUtil

Target

ManagedInstall

まず、Type51のカスタムアクションにより、プロパティが設定されます。次に、Type1025のカスタムアクションにより、InstallUtilのManagedInstall関数が呼び出され、この時に先に設定されたプロパティが引数として渡されます。Type1025は、Type1+msidbCustomActionTypeInScriptですので、埋め込まれたDLLを呼び出すカスタムアクションであることが分かりますが、実際にInstallUtilはBinaryテーブルに埋め込まれています。InstallUtilという名前からInstallUtil.exeが埋め込まれていると思われるかもしれませんが、ここに埋め込まれているのはInstallUtilLib.dllです。

なお、「/LogFile= "[#_A367697580D6A572E31AB7AA55DFF20A]"」の「_A367697580D6A572E31AB7AA55DFF20A」は、Installerクラスのあるファイル（ここでは、CustomAction.dll）のIDであり、先頭に「#」が付いていることから、ファイルのパスを意味していることになります。

これらのカスタムアクションは、InstallExecuteSequenceテーブルで使用されます。もちろん、Type51のカスタムアクションの後で、Type1のカスタムアクションが実行されます。

「インストーラ」ノード以外に追加されたカスタム動作でも同様の列がCustomActionテーブルに追加されます。ただし、「install」の文字列がすべて「commit」「rollback」「uninstall」に置き換わります。また、TypeはVBScriptの例で紹介したのと同じオプションフラッグが付きます。

カスタム動作にデータを渡す

カスタム動作にデータ（文字列）を渡すには、CustomActionDataプロパティを使います。まずは、Installerクラスを使ったときの方法から説明します。

Installerクラスを使ったカスタムアクションにデータを渡すときは、CustomActionDataプロパティに「/name=value」という形式で指定します。ここで「name」は名前で、「value」はその値を示します。複数のデータを渡す場合は、スペース文字で区切ります。つまり、「/name1=value1 /name2=value2」のようにします。valueにスペースが含まれる場合は、"value 1"のように"で囲みます。"で囲まれた文字列の最後が\となるときは、さらに\を付けて、"\\"とします。また、Windows Installerのプロパティを使うときは、[]で囲みます。

Installerクラス内でデータを取得するには、InstallContext.Parametersプロパティを使います。

次に例を示します。まずカスタム動作のCustomActionDataプロパティに

/name=value /dir="[TARGETDIR]\"

と入力します。[TARGETDIR]はインストール先のフォルダのパスを示すWindows Installerのプロパティです。[TARGETDIR]が"で囲まれているのは、[TARGETDIR]にスペースが含まれる可能性があるからで、また最後に\が付いているのは、[TARGETDIR]の最後に\が付くからです。

このデータを取得するために、InstallerクラスのInstallメソッドを次のようにオーバーライドします。

[VB.NET]
Public Overrides Sub Install( _
    ByVal stateSaver As System.Collections.IDictionary)
    MyBase.Install(stateSaver)

    Dim val As String = Me.Context.Parameters("name")
    Dim targetdir As String = Me.Context.Parameters("dir")

    System.Windows.Forms.MessageBox.Show(("name = " + val + _
        vbCrLf + "TARGETDIR = " + targetdir))
End Sub

[C#]
public override void Install(System.Collections.IDictionary stateSaver)
{
    base.Install(stateSaver);

    string val = this.Context.Parameters["name"];
    string targetdir = this.Context.Parameters["dir"];

    System.Windows.Forms.MessageBox.Show("name = " + val +
        "\nTARGETDIR = " + targetdir);
}

変数valは"value"となり、targetにはインストール先のフォルダのパスが入ります。

VBScriptの場合は、CustomActionDataプロパティで指定された文字列をそのままSession.Propertyで取得できます。例えば、CustomActionDataプロパティを「[TARGETDIR]」とした場合、次のようなVBScriptにより、インストール先のフォルダのパスを表示できます。

[VBScript]
Dim val
val = Session.Property("CustomActionData")
MsgBox val

複数のデータを渡すには、独自に区切り文字を決めるしかないようです。

• 参考：
• チュートリアル : カスタム動作にデータを渡す
• CustomActionData プロパティ
• Session.Property Property

エラーを発生させる

Installerクラスを使ったカスタムアクションでエラーを発生させて、インストールが失敗するようにするには、InstallExceptionオブジェクトをスローします。具体例として、次のようなカスタムアクションを試してみましょう。

[VB.NET]
<System.ComponentModel.RunInstaller(True)> _
Public Class Installer1
    Inherits System.Configuration.Install.Installer

    Public Overrides Sub Install( _
        ByVal stateSaver As System.Collections.IDictionary)
        MyBase.Install(stateSaver)

        Throw New System.Configuration.Install.InstallException("テストエラー")
    End Sub

    Public Overrides Sub Rollback( _
        ByVal savedState As System.Collections.IDictionary)
        MyBase.Rollback(savedState)

        System.Windows.Forms.MessageBox.Show("Rollback")
    End Sub
End Class

[C#]
[System.ComponentModel.RunInstaller(true)]
public class Installer1 : System.Configuration.Install.Installer
{
    public override void Install(System.Collections.IDictionary stateSaver)
    {
        base.Install(stateSaver);

        throw new System.Configuration.Install.InstallException("テストエラー");
    }

    public override void Rollback(System.Collections.IDictionary savedState)
    {
        base.Rollback(savedState);

        System.Windows.Forms.MessageBox.Show("Rollback");
    }
}

作成されるMSIファイルを実行すると、「テストエラー」というダイアログが表示され、その後、「Rollback」というメッセージボックスが表示されます。つまり、ロールバックが行われます。

VBScriptではこのようにWindows Installerにエラーを報告し、コールバックすることはできませんが、次のようにしてエラーダイアログを表示することはできます。

[VBScript]
msiMessageTypeError = &H01000000
Set record = Session.Installer.CreateRecord(0)
record.StringData(0) = "テストエラー"
Session.Message msiMessageTypeError, record

• 参考：
• カスタム動作でのエラー処理

カスタム動作に関して、ヘルプにも幾つかの例が載っていますので、参考にしてください。

• チュートリアル : カスタム動作を使用して、インストール中にアセンブリをプリコンパイルする
• チュートリアル : カスタム動作を使用して、インストール中にデータベースを作成する
• チュートリアル : インストール時にアプリケーションを別の XML Web サービスにリダイレクトする

（この記事は、「.NETプログラミング研究」の第57号で紹介したものを基にしています。）