WiX Toolsetによるインストーラのひな形

インストーラの話題をしたところなので、WiX ToolsetでWindows Installer(.msi)を作るためのMyテンプレートなどを一つ。

ディレクトリ構成は次のような感じで。

build.bat
hoge.wxs
MyInstallDirDlg.wxs
MyExitDialog.wxs
MyUI_InstallDir.wxs
banner.bmp
dialog.bmp
src/
- hoge.exe
- hoge.dat
- readme.txt

WiX Toolsetをダウンロードしてパスを通し、上のディレクトリ構成でbuild.batを実行するとoutput/DISK1の中にインストーラが出力されます。

build.bat

ビルドするためのバッチファイルです。出力ディレクトリの作成、wxsのコンパイル、wixobjのリンクを行います。

mkdir output
mkdir output\DISK1

candle hoge.wxs -o output/hoge.wixobj
candle MyExitDialog.wxs -o output/MyExitDialog.wixobj
candle MyInstallDirDlg.wxs -o output/MyInstallDirDlg.wixobj
candle MyUI_InstallDir.wxs -o output/MyUI_InstallDir.wixobj

light output/hoge.wixobj ^
  output/MyExitDialog.wixobj ^
  output/MyInstallDirDlg.wixobj ^
  output/MyUI_InstallDir.wixobj ^
  -ext WixUIExtension ^
  -ext WixUtilExtension ^
  -o output/DISK1/hoge.msi ^
  -pdbout output/hoge.wixpdb ^
  -cultures:ja-jp

hoge.wxs

メインとなるソースファイルです。

{YOUR-GUID}のところは全て個別のGUIDを生成して置き換えてください。

ファイル先頭ではプリプロセッサ変数を定義しています。この変数の値によって、生成されるmsiが色々変わるようになってます。

<!– Files –>と書いてある部分はheatで生成しても良いと思います。

<?xml version="1.0" encoding="utf-8"?>

<?define ProductName = "製品名" ?>
<?define Manufacturer = "製造者" ?>
<?define SrcDir = "$(sys.CURRENTDIR)src\" ?>
<?define MainExeFileName = "hoge.exe" ?>
<?define ReadmeFileName = "readme.txt" ?>
<?define UseCustomUI = "yes" ?>
<?define AppRegKey = "Software\$(var.Manufacturer)\$(var.ProductName)" ?>
<?define Compressed = "no" ?>

<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
  <Product Id="{YOUR-GUID}"
           UpgradeCode="{YOUR-GUID}"
           Name="$(var.ProductName)"
           Manufacturer="$(var.Manufacturer)"
           Version="1.0.0.0"
           Language="1041" Codepage="932">
    <Package InstallerVersion="200" Compressed="$(var.Compressed)" />

    <?if $(var.Compressed)="yes" ?>
    <MediaTemplate EmbedCab="yes" />
    <?else ?>
    <Media Id="1" DiskPrompt="DISK1" />
    <Property Id="DiskPrompt" Value="インストールディスク [1]" />
    <?endif ?>

    <Icon Id="MainIcon" SourceFile="$(var.SrcDir)$(var.MainExeFileName)" />
    <Property Id="ARPPRODUCTICON" Value="MainIcon" />

    <!-- Directory Structure -->
    <Directory Id="TARGETDIR" Name="SourceDir">
      <!-- INSTALLDIR -->
      <Directory Id="ProgramFilesFolder" Name="ProgramFiles">
        <Directory Id="ProgramFilesManufacturer" Name="$(var.Manufacturer)">
          <Directory Id="INSTALLDIR" Name="$(var.ProductName)">
          </Directory>
        </Directory>
      </Directory>
      <!-- Start Menu -->
      <Directory Id="ProgramMenuFolder" Name="Programs">
        <Directory Id="AppStartMenuDir" Name="$(var.Manufacturer) $(var.ProductName)">
        </Directory>
      </Directory>
      <!-- Desktop -->
      <Directory Id="DesktopFolder" Name="Desktop">
      </Directory>
    </Directory>

    <!-- Feature -->
    <Feature Id="EssentialFeature" Level="1">
      <ComponentGroupRef Id="EssentialFiles" />
      <ComponentRef Id="EssentialRegistries" />
      <ComponentRef Id="EssentialShortcuts" />
      <ComponentRef Id="EssentialDesktopShortcut" />
    </Feature>

    <!-- Files -->
    <ComponentGroup Id="EssentialFiles" Directory="INSTALLDIR">
      <Component Id="file0001" Guid="{YOUR-GUID}">
        <File Id="file0001" KeyPath="yes" Source="$(var.SrcDir)$(var.MainExeFileName)" />
      </Component>
      <Component Id="file0002" Guid="{YOUR-GUID}">
        <File Id="file0002" KeyPath="yes" Source="$(var.SrcDir)hoge.dat" />
      </Component>
      <Component Id="file0003" Guid="{YOUR-GUID}">
        <File Id="file0003" KeyPath="yes" Source="$(var.SrcDir)$(var.ReadmeFileName)" />
      </Component>
    </ComponentGroup>

    <!-- Shortcuts -->
    <DirectoryRef Id="AppStartMenuDir">
      <Component Id="EssentialShortcuts" Guid="{YOUR-GUID}">
        <RegistryValue Root="HKCU" Key="$(var.AppRegKey)" Name="InstalledStartMenuShortcut" Type="integer" Value="1" KeyPath="yes" />
        <RemoveFolder Id="AppStartMenuDir" On="uninstall" />
        <Shortcut Id="startMenuShortcut0001" Name="$(var.ProductName)" Target="[INSTALLDIR]$(var.MainExeFileName)" WorkingDirectory="INSTALLDIR" />
      </Component>
    </DirectoryRef>
    <Property Id="INSTALLDESKTOPSHORTCUT" Value="1" />
    <DirectoryRef Id="DesktopFolder">
      <Component Id="EssentialDesktopShortcut" Guid="{YOUR-GUID}">
        <Condition>INSTALLDESKTOPSHORTCUT</Condition>
        <RegistryValue Root="HKCU" Key="$(var.AppRegKey)" Name="InstalledDesktopShortcut" Type="integer" Value="1" KeyPath="yes" />
        <Shortcut Id="desktopShortcut0001" Name="$(var.ProductName)" Target="[INSTALLDIR]$(var.MainExeFileName)" WorkingDirectory="INSTALLDIR" />
      </Component>
    </DirectoryRef>

    <!-- Registries -->
    <DirectoryRef Id="INSTALLDIR">
      <Component Id="EssentialRegistries" Guid="{YOUR-GUID}">
        <RegistryKey Root="HKCU" Key="$(var.AppRegKey)" ForceCreateOnInstall="yes" ForceDeleteOnUninstall="yes">
          <RegistryValue Type="string" Name="InstalledPath" Value="[INSTALLDIR]" KeyPath="yes" />
        </RegistryKey>
      </Component>
    </DirectoryRef>

    <!-- User Interface -->
    <!-- UI: Install Directory -->
    <Property Id="WIXUI_INSTALLDIR" Value="INSTALLDIR" />

    <!-- UI: Bitmap -->
    <WixVariable Id="WixUIBannerBmp" Value="banner.bmp" /><!-- 493x58 -->
    <WixVariable Id="WixUIDialogBmp" Value="dialog.bmp" /><!-- 493x312 -->

    <?if $(var.UseCustomUI) = "yes" ?>
      <UIRef Id="MyUI_InstallDir" />
      <!-- UI: Run application after installed (for MyUI_InstallDir) -->
      <?if $(var.MainExeFileName) And $(var.MainExeFileName)!="" ?>
        <Property Id="MYUI_EXITDIALOGOPTIONALCHECKBOXTEXT" Value="プログラムを実行する" />
        <Property Id="MYUI_EXITDIALOGOPTIONALCHECKBOX" Value="1" />
        <CustomAction Id="LaunchApplication" Directory="INSTALLDIR" ExeCommand="[INSTALLDIR]$(var.MainExeFileName)" Return="asyncNoWait" />
        <UI>
          <Publish Dialog="MyExitDialog" Control="Finish" Event="DoAction" Value="LaunchApplication">MYUI_EXITDIALOGOPTIONALCHECKBOX = 1 and NOT Installed</Publish>
        </UI>
      <?endif ?>
      <?if $(var.ReadmeFileName) And $(var.ReadmeFileName)!="" ?>
        <Property Id="MYUI_EXITDIALOGOPTIONALCHECKBOXTEXT2" Value="Readmeを開く" />
        <Property Id="MYUI_EXITDIALOGOPTIONALCHECKBOX2" Value="1" />
        <Property Id="WixShellExecTarget" Value="[INSTALLDIR]$(var.ReadmeFileName)" />
        <CustomAction Id="LaunchReadme" BinaryKey="WixCA" DllEntry="WixShellExec" Impersonate="yes" />
        <UI>
          <Publish Dialog="MyExitDialog" Control="Finish" Event="DoAction" Value="LaunchReadme">MYUI_EXITDIALOGOPTIONALCHECKBOX2 = 1 and NOT Installed</Publish>
        </UI>
      <?endif ?>
      <!-- UI: Skip license (for MyUI_InstallDir) -->
      <UI>
        <Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="MyInstallDirDlg">1</Publish>
        <Publish Dialog="MyInstallDirDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg">1</Publish>
      </UI>

    <?else ?>

      <UIRef Id="WixUI_InstallDir" />
      <!-- UI: Run application after installed (for WixUI_InstallDir) -->
      <Property Id="WIXUI_EXITDIALOGOPTIONALCHECKBOXTEXT" Value="プログラムを実行する" />
      <Property Id="WIXUI_EXITDIALOGOPTIONALCHECKBOX" Value="1" />
      <CustomAction Id="LaunchApplication" Directory="INSTALLDIR" ExeCommand="[INSTALLDIR]$(var.MainExeFileName)" Return="asyncNoWait" />
      <UI>
        <Publish Dialog="ExitDialog" Control="Finish" Event="DoAction" Value="LaunchApplication">WIXUI_EXITDIALOGOPTIONALCHECKBOX = 1 and NOT Installed</Publish>
      </UI>
      <!-- UI: Skip license (for WixUI_InstallDir) -->
      <UI>
        <Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="InstallDirDlg">1</Publish>
        <Publish Dialog="InstallDirDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg">1</Publish>
      </UI>
    <?endif ?>


  </Product>
</Wix>

MyInstallDirDlg.wxs

インストール先を指定するダイアログを定義するファイルです。

WiXのソースに含まれているファイル(src/ext/UIExtension/InstallDirDlg.wxs)をコピーして一部を改編しました。改編点は次の通りです。

DialogのIdをInstallDirDlgからMyInstallDirDlgへ変更しました。
「デスクトップにショートカットを作成する」チェックボックスを追加しました。

<?xml version="1.0" encoding="UTF-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
   <Fragment>
       <UI>
           <Dialog Id="MyInstallDirDlg" Width="370" Height="270" Title="!(loc.InstallDirDlg_Title)">
               <Control Id="Next" Type="PushButton" X="236" Y="243" Width="56" Height="17" Default="yes" Text="!(loc.WixUINext)" />
               <Control Id="Back" Type="PushButton" X="180" Y="243" Width="56" Height="17" Text="!(loc.WixUIBack)" />
               <Control Id="Cancel" Type="PushButton" X="304" Y="243" Width="56" Height="17" Cancel="yes" Text="!(loc.WixUICancel)">
                   <Publish Event="SpawnDialog" Value="CancelDlg">1</Publish>
               </Control>

               <Control Id="Description" Type="Text" X="25" Y="23" Width="280" Height="15" Transparent="yes" NoPrefix="yes" Text="!(loc.InstallDirDlgDescription)" />
               <Control Id="Title" Type="Text" X="15" Y="6" Width="200" Height="15" Transparent="yes" NoPrefix="yes" Text="!(loc.InstallDirDlgTitle)" />
               <Control Id="BannerBitmap" Type="Bitmap" X="0" Y="0" Width="370" Height="44" TabSkip="no" Text="!(loc.InstallDirDlgBannerBitmap)" />
               <Control Id="BannerLine" Type="Line" X="0" Y="44" Width="370" Height="0" />
               <Control Id="BottomLine" Type="Line" X="0" Y="234" Width="370" Height="0" />

               <Control Id="FolderLabel" Type="Text" X="20" Y="60" Width="290" Height="30" NoPrefix="yes" Text="!(loc.InstallDirDlgFolderLabel)" />
               <Control Id="Folder" Type="PathEdit" X="20" Y="100" Width="320" Height="18" Property="WIXUI_INSTALLDIR" Indirect="yes" />
               <Control Id="ChangeFolder" Type="PushButton" X="20" Y="120" Width="56" Height="17" Text="!(loc.InstallDirDlgChange)" />

               <!-- Begin MyUI -->
               <Control Id="DesktopShortcutCheckBox" Type="CheckBox" X="20" Y="160" Width="290" Height="17" Property="INSTALLDESKTOPSHORTCUT" CheckBoxValue="1" Text="デスクトップにショートカットを作成する。" />
               <!-- End MyUI -->
           </Dialog>
       </UI>
   </Fragment>
</Wix>

MyExitDialog.wxs

インストールが終了したときに表示するダイアログを定義するファイルです。

WiXのソースに含まれているファイル(src/ext/UIExtension/ExitDialog.wxs)をコピーして一部を改編しました。改編点は次の通りです。

DialogのIdをExitDialogからMyExitDialogへ変更しました。
チェックボックスを二つ表示できるようにしました。アプリの起動用とreadmeの表示用です。なお、チェックボックスのText=をそのまま使うと背景がグレーになって見た目が悪いので、チェックボックスを最小限のサイズで表示して、その横に新たにテキストを配置することで背景が透過するようにしています。副作用として、テキスト部分を押してもチェックボックスが反応しなくなってしまいますが、そこは妥協しています(InstallShieldが作るmsiも同じことをしているせいで押しにくい)。

<?xml version="1.0" encoding="UTF-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
   <Fragment>
       <UI>
           <Dialog Id="MyExitDialog" Width="370" Height="270" Title="!(loc.ExitDialog_Title)">
               <Control Id="Finish" Type="PushButton" X="236" Y="243" Width="56" Height="17" Default="yes" Cancel="yes" Text="!(loc.WixUIFinish)" />
               <Control Id="Cancel" Type="PushButton" X="304" Y="243" Width="56" Height="17" Disabled="yes" Text="!(loc.WixUICancel)" />
               <Control Id="Bitmap" Type="Bitmap" X="0" Y="0" Width="370" Height="234" TabSkip="no" Text="!(loc.ExitDialogBitmap)" />
               <Control Id="Back" Type="PushButton" X="180" Y="243" Width="56" Height="17" Disabled="yes" Text="!(loc.WixUIBack)" />
               <Control Id="BottomLine" Type="Line" X="0" Y="234" Width="370" Height="0" />
               <Control Id="Description" Type="Text" X="135" Y="70" Width="220" Height="40" Transparent="yes" NoPrefix="yes" Text="!(loc.ExitDialogDescription)" />
               <Control Id="Title" Type="Text" X="135" Y="20" Width="220" Height="60" Transparent="yes" NoPrefix="yes" Text="!(loc.ExitDialogTitle)" />

               <!-- Begin MyUI -->
               <Control Id="OptionalText" Type="Text" X="135" Y="110" Width="220" Height="80" Transparent="yes" NoPrefix="yes" Hidden="yes" Text="[MYUI_EXITDIALOGOPTIONALTEXT]">
                   <Condition Action="show">MYUI_EXITDIALOGOPTIONALTEXT AND NOT Installed</Condition>
               </Control>
               <Control Id="OptionalCheckBox" Type="CheckBox" X="150" Y="150" Width="10" Height="9" Hidden="yes" Property="MYUI_EXITDIALOGOPTIONALCHECKBOX" CheckBoxValue="1">
                   <Condition Action="show">MYUI_EXITDIALOGOPTIONALCHECKBOXTEXT AND NOT Installed</Condition>
               </Control>
               <Control Id="OptionalCheckBoxText" Type="Text" X="165" Y="150" Width="200" Height="13" Transparent="yes" Hidden="yes" Text="[MYUI_EXITDIALOGOPTIONALCHECKBOXTEXT]">
                   <Condition Action="show">MYUI_EXITDIALOGOPTIONALCHECKBOXTEXT AND NOT Installed</Condition>
               </Control>
               <Control Id="OptionalCheckBox2" Type="CheckBox" X="150" Y="180" Width="10" Height="9" Hidden="yes" Property="MYUI_EXITDIALOGOPTIONALCHECKBOX2" CheckBoxValue="1">
                   <Condition Action="show">MYUI_EXITDIALOGOPTIONALCHECKBOXTEXT2 AND NOT Installed</Condition>
               </Control>
               <Control Id="OptionalCheckText2" Type="Text" X="165" Y="180" Width="200" Height="13" Transparent="yes" Hidden="yes" Text="[MYUI_EXITDIALOGOPTIONALCHECKBOXTEXT2]">
                   <Condition Action="show">MYUI_EXITDIALOGOPTIONALCHECKBOXTEXT2 AND NOT Installed</Condition>
               </Control>
               <!-- End MyUI -->
           </Dialog>

           <InstallUISequence>
               <Show Dialog="MyExitDialog" OnExit="success" Overridable="yes" />
           </InstallUISequence>

           <AdminUISequence>
               <Show Dialog="MyExitDialog" OnExit="success" Overridable="yes" />
           </AdminUISequence>
       </UI>
   </Fragment>
</Wix>

MyUI_InstallDir.wxs

UIの流れを定義するファイルです。

WiXのソースに含まれているファイル(src/ext/UIExtension/WixUI_InstallDir.wxs)をコピーして一部を改編しました。上で改編したダイアログを使うように、一部のダイアログIdにMyを付加しました。

<?xml version="1.0" encoding="UTF-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
   <Fragment>
       <UI Id="MyUI_InstallDir">
           <TextStyle Id="WixUI_Font_Normal" FaceName="Tahoma" Size="8" />
           <TextStyle Id="WixUI_Font_Bigger" FaceName="Tahoma" Size="12" />
           <TextStyle Id="WixUI_Font_Title" FaceName="Tahoma" Size="9" Bold="yes" />

           <Property Id="DefaultUIFont" Value="WixUI_Font_Normal" />
           <Property Id="WixUI_Mode" Value="InstallDir" />

           <DialogRef Id="BrowseDlg" />
           <DialogRef Id="DiskCostDlg" />
           <DialogRef Id="ErrorDlg" />
           <DialogRef Id="FatalError" />
           <DialogRef Id="FilesInUse" />
           <DialogRef Id="MsiRMFilesInUse" />
           <DialogRef Id="PrepareDlg" />
           <DialogRef Id="ProgressDlg" />
           <DialogRef Id="ResumeDlg" />
           <DialogRef Id="UserExit" />
           
           <Publish Dialog="BrowseDlg" Control="OK" Event="DoAction" Value="WixUIValidatePath" Order="3">1</Publish>
           <Publish Dialog="BrowseDlg" Control="OK" Event="SpawnDialog" Value="InvalidDirDlg" Order="4"><![CDATA[WIXUI_INSTALLDIR_VALID<>"1"]]></Publish>

           <Publish Dialog="MyExitDialog" Control="Finish" Event="EndDialog" Value="Return" Order="999">1</Publish>

           <Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="LicenseAgreementDlg">NOT Installed</Publish>
           <Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="VerifyReadyDlg">Installed AND PATCH</Publish>

           <Publish Dialog="LicenseAgreementDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg">1</Publish>
           <Publish Dialog="LicenseAgreementDlg" Control="Next" Event="NewDialog" Value="MyInstallDirDlg">LicenseAccepted = "1"</Publish>

           <Publish Dialog="MyInstallDirDlg" Control="Back" Event="NewDialog" Value="LicenseAgreementDlg">1</Publish>
           <Publish Dialog="MyInstallDirDlg" Control="Next" Event="SetTargetPath" Value="[WIXUI_INSTALLDIR]" Order="1">1</Publish>
           <Publish Dialog="MyInstallDirDlg" Control="Next" Event="DoAction" Value="WixUIValidatePath" Order="2">NOT WIXUI_DONTVALIDATEPATH</Publish>
           <Publish Dialog="MyInstallDirDlg" Control="Next" Event="SpawnDialog" Value="InvalidDirDlg" Order="3"><![CDATA[NOT WIXUI_DONTVALIDATEPATH AND WIXUI_INSTALLDIR_VALID<>"1"]]></Publish>
           <Publish Dialog="MyInstallDirDlg" Control="Next" Event="NewDialog" Value="VerifyReadyDlg" Order="4">WIXUI_DONTVALIDATEPATH OR WIXUI_INSTALLDIR_VALID="1"</Publish>
           <Publish Dialog="MyInstallDirDlg" Control="ChangeFolder" Property="_BrowseProperty" Value="[WIXUI_INSTALLDIR]" Order="1">1</Publish>
           <Publish Dialog="MyInstallDirDlg" Control="ChangeFolder" Event="SpawnDialog" Value="BrowseDlg" Order="2">1</Publish>
           
           <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="MyInstallDirDlg" Order="1">NOT Installed</Publish>
           <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="MaintenanceTypeDlg" Order="2">Installed AND NOT PATCH</Publish>
           <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg" Order="2">Installed AND PATCH</Publish>

           <Publish Dialog="MaintenanceWelcomeDlg" Control="Next" Event="NewDialog" Value="MaintenanceTypeDlg">1</Publish>

           <Publish Dialog="MaintenanceTypeDlg" Control="RepairButton" Event="NewDialog" Value="VerifyReadyDlg">1</Publish>
           <Publish Dialog="MaintenanceTypeDlg" Control="RemoveButton" Event="NewDialog" Value="VerifyReadyDlg">1</Publish>
           <Publish Dialog="MaintenanceTypeDlg" Control="Back" Event="NewDialog" Value="MaintenanceWelcomeDlg">1</Publish>

           <Property Id="ARPNOMODIFY" Value="1" />
       </UI>

       <UIRef Id="WixUI_Common" />
   </Fragment>
</Wix>

ソース一式

ソース一式は github/simple_wix_template に置いてあります。