wix: add functionality to inject additional Features into installer

This is the last bit required to be able to glue extra configs etc into
the installer.

Differential Revision: https://phab.mercurial-scm.org/D6180

contrib/packaging/hgpackaging/wix.py

@@ -1,321 +1,327 b''
 # wix.py - WiX installer functionality
 #
 # Copyright 2019 Gregory Szorc <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 # no-check-code because Python 3 native.
 
 import os
 import pathlib
 import re
 import subprocess
 import tempfile
 import typing
 import xml.dom.minidom
 
 from .downloads import (
     download_entry,
 )
 from .py2exe import (
     build_py2exe,
 )
 from .util import (
     extract_zip_to_directory,
     sign_with_signtool,
 )
 
 
 SUPPORT_WXS = [
     ('contrib.wxs', r'contrib'),
     ('dist.wxs', r'dist'),
     ('doc.wxs', r'doc'),
     ('help.wxs', r'mercurial\help'),
     ('i18n.wxs', r'i18n'),
     ('locale.wxs', r'mercurial\locale'),
     ('templates.wxs', r'mercurial\templates'),
 ]
 
 
 EXTRA_PACKAGES = {
     'distutils',
     'pygments',
 }
 
 
 def find_version(source_dir: pathlib.Path):
     version_py = source_dir / 'mercurial' / '__version__.py'
 
     with version_py.open('r', encoding='utf-8') as fh:
         source = fh.read().strip()
 
     m = re.search('version = b"(.*)"', source)
     return m.group(1)
 
 
 def normalize_version(version):
     """Normalize Mercurial version string so WiX accepts it.
 
     Version strings have to be numeric X.Y.Z.
     """
 
     if '+' in version:
         version, extra = version.split('+', 1)
     else:
         extra = None
 
     # 4.9rc0
     if version[:-1].endswith('rc'):
         version = version[:-3]
 
     versions = [int(v) for v in version.split('.')]
     while len(versions) < 3:
         versions.append(0)
 
     major, minor, build = versions[:3]
 
     if extra:
         # <commit count>-<hash>+<date>
         build = int(extra.split('-')[0])
 
     return '.'.join('%d' % x for x in (major, minor, build))
 
 
 def ensure_vc90_merge_modules(build_dir):
     x86 = (
         download_entry('vc9-crt-x86-msm', build_dir,
                        local_name='microsoft.vcxx.crt.x86_msm.msm')[0],
         download_entry('vc9-crt-x86-msm-policy', build_dir,
                        local_name='policy.x.xx.microsoft.vcxx.crt.x86_msm.msm')[0]
     )
 
     x64 = (
         download_entry('vc9-crt-x64-msm', build_dir,
                        local_name='microsoft.vcxx.crt.x64_msm.msm')[0],
         download_entry('vc9-crt-x64-msm-policy', build_dir,
                        local_name='policy.x.xx.microsoft.vcxx.crt.x64_msm.msm')[0]
     )
     return {
         'x86': x86,
         'x64': x64,
     }
 
 
 def run_candle(wix, cwd, wxs, source_dir, defines=None):
     args = [
         str(wix / 'candle.exe'),
         '-nologo',
         str(wxs),
         '-dSourceDir=%s' % source_dir,
     ]
 
     if defines:
         args.extend('-d%s=%s' % define for define in sorted(defines.items()))
 
     subprocess.run(args, cwd=str(cwd), check=True)
 
 
 def make_post_build_signing_fn(name, subject_name=None, cert_path=None,
                                cert_password=None, timestamp_url=None):
     """Create a callable that will use signtool to sign hg.exe."""
 
     def post_build_sign(source_dir, build_dir, dist_dir, version):
         description = '%s %s' % (name, version)
 
         sign_with_signtool(dist_dir / 'hg.exe', description,
                            subject_name=subject_name, cert_path=cert_path,
                            cert_password=cert_password,
                            timestamp_url=timestamp_url)
 
     return post_build_sign
 
 
 LIBRARIES_XML = '''
 <?xml version="1.0" encoding="utf-8"?>
 <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
 
   <?include {wix_dir}/guids.wxi ?>
   <?include {wix_dir}/defines.wxi ?>
 
   <Fragment>
     <DirectoryRef Id="INSTALLDIR" FileSource="$(var.SourceDir)">
       <Directory Id="libdir" Name="lib" FileSource="$(var.SourceDir)/lib">
         <Component Id="libOutput" Guid="$(var.lib.guid)" Win64='$(var.IsX64)'>
         </Component>
       </Directory>
     </DirectoryRef>
   </Fragment>
 </Wix>
 '''.lstrip()
 
 
 def make_libraries_xml(wix_dir: pathlib.Path, dist_dir: pathlib.Path):
     """Make XML data for library components WXS."""
     # We can't use ElementTree because it doesn't handle the
     # <?include ?> directives.
     doc = xml.dom.minidom.parseString(
         LIBRARIES_XML.format(wix_dir=str(wix_dir)))
 
     component = doc.getElementsByTagName('Component')[0]
 
     f = doc.createElement('File')
     f.setAttribute('Name', 'library.zip')
     f.setAttribute('KeyPath', 'yes')
     component.appendChild(f)
 
     lib_dir = dist_dir / 'lib'
 
     for p in sorted(lib_dir.iterdir()):
         if not p.name.endswith(('.dll', '.pyd')):
             continue
 
         f = doc.createElement('File')
         f.setAttribute('Name', p.name)
         component.appendChild(f)
 
     return doc.toprettyxml()
 
 
 def build_installer(source_dir: pathlib.Path, python_exe: pathlib.Path,
                     msi_name='mercurial', version=None, post_build_fn=None,
-                    extra_packages_script: typing.Optional[str]=None,
-                    extra_wxs:typing.Optional[typing.Dict[str,str]]=None):
+                    extra_packages_script=None,
+                    extra_wxs:typing.Optional[typing.Dict[str,str]]=None,
+                    extra_features:typing.Optional[typing.List[str]]=None):
     """Build a WiX MSI installer.
 
     ``source_dir`` is the path to the Mercurial source tree to use.
     ``arch`` is the target architecture. either ``x86`` or ``x64``.
     ``python_exe`` is the path to the Python executable to use/bundle.
     ``version`` is the Mercurial version string. If not defined,
     ``mercurial/__version__.py`` will be consulted.
     ``post_build_fn`` is a callable that will be called after building
     Mercurial but before invoking WiX. It can be used to e.g. facilitate
     signing. It is passed the paths to the Mercurial source, build, and
     dist directories and the resolved Mercurial version.
     ``extra_packages_script`` is a command to be run to inject extra packages
     into the py2exe binary. It should stage packages into the virtualenv and
     print a null byte followed by a newline-separated list of packages that
     should be included in the exe.
     ``extra_wxs`` is a dict of {wxs_name: working_dir_for_wxs_build}.
+    ``extra_features`` is a list of additional named Features to include in
+    the build. These must match Feature names in one of the wxs scripts.
     """
     arch = 'x64' if r'\x64' in os.environ.get('LIB', '') else 'x86'
 
     hg_build_dir = source_dir / 'build'
     dist_dir = source_dir / 'dist'
     wix_dir = source_dir / 'contrib' / 'packaging' / 'wix'
 
     requirements_txt = wix_dir / 'requirements.txt'
 
     build_py2exe(source_dir, hg_build_dir,
                  python_exe, 'wix', requirements_txt,
                  extra_packages=EXTRA_PACKAGES,
                  extra_packages_script=extra_packages_script)
 
     version = version or normalize_version(find_version(source_dir))
     print('using version string: %s' % version)
 
     if post_build_fn:
         post_build_fn(source_dir, hg_build_dir, dist_dir, version)
 
     build_dir = hg_build_dir / ('wix-%s' % arch)
 
     build_dir.mkdir(exist_ok=True)
 
     wix_pkg, wix_entry = download_entry('wix', hg_build_dir)
     wix_path = hg_build_dir / ('wix-%s' % wix_entry['version'])
 
     if not wix_path.exists():
         extract_zip_to_directory(wix_pkg, wix_path)
 
     ensure_vc90_merge_modules(hg_build_dir)
 
     source_build_rel = pathlib.Path(os.path.relpath(source_dir, build_dir))
 
     defines = {'Platform': arch}
 
     for wxs, rel_path in SUPPORT_WXS:
         wxs = wix_dir / wxs
         wxs_source_dir = source_dir / rel_path
         run_candle(wix_path, build_dir, wxs, wxs_source_dir, defines=defines)
 
     for source, rel_path in sorted((extra_wxs or {}).items()):
         run_candle(wix_path, build_dir, source, rel_path, defines=defines)
 
     # candle.exe doesn't like when we have an open handle on the file.
     # So use TemporaryDirectory() instead of NamedTemporaryFile().
     with tempfile.TemporaryDirectory() as td:
         td = pathlib.Path(td)
 
         tf = td / 'library.wxs'
         with tf.open('w') as fh:
             fh.write(make_libraries_xml(wix_dir, dist_dir))
 
         run_candle(wix_path, build_dir, tf, dist_dir, defines=defines)
 
     source = wix_dir / 'mercurial.wxs'
     defines['Version'] = version
     defines['Comments'] = 'Installs Mercurial version %s' % version
     defines['VCRedistSrcDir'] = str(hg_build_dir)
+    if extra_features:
+        assert all(';' not in f for f in extra_features)
+        defines['MercurialExtraFeatures'] = ';'.join(extra_features)
 
     run_candle(wix_path, build_dir, source, source_build_rel, defines=defines)
 
     msi_path = source_dir / 'dist' / (
         '%s-%s-%s.msi' % (msi_name, version, arch))
 
     args = [
         str(wix_path / 'light.exe'),
         '-nologo',
         '-ext', 'WixUIExtension',
         '-sw1076',
         '-spdb',
         '-o', str(msi_path),
     ]
 
     for source, rel_path in SUPPORT_WXS:
         assert source.endswith('.wxs')
         args.append(str(build_dir / ('%s.wixobj' % source[:-4])))
 
     for source, rel_path in sorted((extra_wxs or {}).items()):
         assert source.endswith('.wxs')
         source = os.path.basename(source)
         args.append(str(build_dir / ('%s.wixobj' % source[:-4])))
 
     args.extend([
         str(build_dir / 'library.wixobj'),
         str(build_dir / 'mercurial.wixobj'),
     ])
 
     subprocess.run(args, cwd=str(source_dir), check=True)
 
     print('%s created' % msi_path)
 
     return {
         'msi_path': msi_path,
     }
 
 
 def build_signed_installer(source_dir: pathlib.Path, python_exe: pathlib.Path,
                            name: str, version=None, subject_name=None,
                            cert_path=None, cert_password=None,
                            timestamp_url=None, extra_packages_script=None,
-                           extra_wxs=None):
+                           extra_wxs=None, extra_features=None):
     """Build an installer with signed executables."""
 
     post_build_fn = make_post_build_signing_fn(
         name,
         subject_name=subject_name,
         cert_path=cert_path,
         cert_password=cert_password,
         timestamp_url=timestamp_url)
 
     info = build_installer(source_dir, python_exe=python_exe,
                            msi_name=name.lower(), version=version,
                            post_build_fn=post_build_fn,
                            extra_packages_script=extra_packages_script,
-                           extra_wxs=extra_wxs)
+                           extra_wxs=extra_wxs, extra_features=extra_features)
 
     description = '%s %s' % (name, version)
 
     sign_with_signtool(info['msi_path'], description,
                        subject_name=subject_name, cert_path=cert_path,
                        cert_password=cert_password, timestamp_url=timestamp_url)

contrib/packaging/wix/build.py

@@ -1,76 +1,81 b''
 #!/usr/bin/env python3
 # Copyright 2019 Gregory Szorc <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 # no-check-code because Python 3 native.
 
 """Code to build Mercurial WiX installer."""
 
 import argparse
 import os
 import pathlib
 import sys
 
 
 if __name__ == '__main__':
     parser = argparse.ArgumentParser()
 
     parser.add_argument('--name',
                         help='Application name',
                         default='Mercurial')
     parser.add_argument('--python',
                         help='Path to Python executable to use',
                         required=True)
     parser.add_argument('--sign-sn',
                         help='Subject name (or fragment thereof) of certificate '
                              'to use for signing')
     parser.add_argument('--sign-cert',
                         help='Path to certificate to use for signing')
     parser.add_argument('--sign-password',
                         help='Password for signing certificate')
     parser.add_argument('--sign-timestamp-url',
                         help='URL of timestamp server to use for signing')
     parser.add_argument('--version',
                         help='Version string to use')
     parser.add_argument('--extra-packages-script',
                         help=('Script to execute to include extra packages in '
                               'py2exe binary.'))
     parser.add_argument('--extra-wxs',
                         help='CSV of path_to_wxs_file=working_dir_for_wxs_file')
+    parser.add_argument('--extra-features',
+                        help=('CSV of extra feature names to include '
+                              'in the installer from the extra wxs files'))
 
     args = parser.parse_args()
 
     here = pathlib.Path(os.path.abspath(os.path.dirname(__file__)))
     source_dir = here.parent.parent.parent
 
     sys.path.insert(0, str(source_dir / 'contrib' / 'packaging'))
 
     from hgpackaging.wix import (
         build_installer,
         build_signed_installer,
     )
 
     fn = build_installer
     kwargs = {
         'source_dir': source_dir,
         'python_exe': pathlib.Path(args.python),
         'version': args.version,
     }
 
     if args.extra_packages_script:
         kwargs['extra_packages_script'] = args.extra_packages_script
     if args.extra_wxs:
         kwargs['extra_wxs'] = dict(
             thing.split("=") for thing in args.extra_wxs.split(','))
+    if args.extra_features:
+        kwargs['extra_features'] = args.extra_features.split(',')
 
     if args.sign_sn or args.sign_cert:
         fn = build_signed_installer
         kwargs['name'] = args.name
         kwargs['subject_name'] = args.sign_sn
         kwargs['cert_path'] = args.sign_cert
         kwargs['cert_password'] = args.sign_password
         kwargs['timestamp_url'] = args.sign_timestamp_url
 
     fn(**kwargs)

contrib/packaging/wix/mercurial.wxs

@@ -1,162 +1,167 b''
 <?xml version='1.0' encoding='windows-1252'?>
 <Wix xmlns='http://schemas.microsoft.com/wix/2006/wi'>
 
   <!-- Copyright 2010 Steve Borho <[e-mail]>
 
   This software may be used and distributed according to the terms of the
   GNU General Public License version 2 or any later version. -->
 
   <?include guids.wxi ?>
   <?include defines.wxi ?>
 
   <?if $(var.Platform) = "x64" ?>
     <?define PFolder = ProgramFiles64Folder ?>
   <?else?>
     <?define PFolder = ProgramFilesFolder ?>
   <?endif?>
 
   <Product Id='*'
     Name='Mercurial $(var.Version) ($(var.Platform))'
     UpgradeCode='$(var.ProductUpgradeCode)'
     Language='1033' Codepage='1252' Version='$(var.Version)'
     Manufacturer='Matt Mackall and others'>
 
     <Package Id='*'
       Keywords='Installer'
       Description="Mercurial distributed SCM (version $(var.Version))"
       Comments='$(var.Comments)'
       Platform='$(var.Platform)'
       Manufacturer='Matt Mackall and others'
       InstallerVersion='300' Languages='1033' Compressed='yes' SummaryCodepage='1252' />
 
     <Media Id='1' Cabinet='mercurial.cab' EmbedCab='yes' DiskPrompt='CD-ROM #1'
            CompressionLevel='high' />
     <Property Id='DiskPrompt' Value="Mercurial $(var.Version) Installation [1]" />
 
     <Condition Message='Mercurial MSI installers require Windows XP or higher'>
         VersionNT >= 501
     </Condition>
 
     <Property Id="INSTALLDIR">
       <ComponentSearch Id='SearchForMainExecutableComponent'
                        Guid='$(var.ComponentMainExecutableGUID)' />
     </Property>
 
     <!--Property Id='ARPCOMMENTS'>any comments</Property-->
     <Property Id='ARPCONTACT'>[e-mail]</Property>
     <Property Id='ARPHELPLINK'>https://mercurial-scm.org/wiki/</Property>
     <Property Id='ARPURLINFOABOUT'>https://mercurial-scm.org/about/</Property>
     <Property Id='ARPURLUPDATEINFO'>https://mercurial-scm.org/downloads/</Property>
     <Property Id='ARPHELPTELEPHONE'>https://mercurial-scm.org/wiki/Support</Property>
     <Property Id='ARPPRODUCTICON'>hgIcon.ico</Property>
 
     <Property Id='INSTALLEDMERCURIALPRODUCTS' Secure='yes'></Property>
     <Property Id='REINSTALLMODE'>amus</Property>
 
     <!--Auto-accept the license page-->
     <Property Id='LicenseAccepted'>1</Property>
 
     <Directory Id='TARGETDIR' Name='SourceDir'>
       <Directory Id='$(var.PFolder)' Name='PFiles'>
         <Directory Id='INSTALLDIR' Name='Mercurial'>
           <Component Id='MainExecutable' Guid='$(var.ComponentMainExecutableGUID)' Win64='$(var.IsX64)'>
             <File Id='hgEXE' Name='hg.exe' Source='dist\hg.exe' KeyPath='yes' />
             <Environment Id="Environment" Name="PATH" Part="last" System="yes"
                          Permanent="no" Value="[INSTALLDIR]" Action="set" />
           </Component>
           <Component Id='ReadMe' Guid='$(var.ReadMe.guid)' Win64='$(var.IsX64)'>
               <File Id='ReadMe' Name='ReadMe.html' Source='contrib\win32\ReadMe.html'
                     KeyPath='yes'/>
           </Component>
           <Component Id='COPYING' Guid='$(var.COPYING.guid)' Win64='$(var.IsX64)'>
             <File Id='COPYING' Name='COPYING.rtf' Source='contrib\packaging\wix\COPYING.rtf'
                   KeyPath='yes'/>
           </Component>
 
           <Directory Id='HGRCD' Name='hgrc.d'>
             <Component Id='mercurial.rc' Guid='$(var.mercurial.rc.guid)' Win64='$(var.IsX64)'>
               <File Id='mercurial.rc' Name='Mercurial.rc' Source='contrib\win32\mercurial.ini'
                     ReadOnly='yes' KeyPath='yes'/>
             </Component>
             <Component Id='mergetools.rc' Guid='$(var.mergetools.rc.guid)' Win64='$(var.IsX64)'>
               <File Id='mergetools.rc' Name='MergeTools.rc' Source='mercurial\default.d\mergetools.rc'
                     ReadOnly='yes' KeyPath='yes'/>
             </Component>
           </Directory>
 
         </Directory>
       </Directory>
 
       <Directory Id="ProgramMenuFolder" Name="Programs">
         <Directory Id="ProgramMenuDir" Name="Mercurial $(var.Version)">
           <Component Id="ProgramMenuDir" Guid="$(var.ProgramMenuDir.guid)" Win64='$(var.IsX64)'>
             <RemoveFolder Id='ProgramMenuDir' On='uninstall' />
             <RegistryValue Root='HKCU' Key='Software\Mercurial\InstallDir' Type='string'
                            Value='[INSTALLDIR]' KeyPath='yes' />
             <Shortcut Id='UrlShortcut' Directory='ProgramMenuDir' Name='Mercurial Web Site'
                       Target='[ARPHELPLINK]' Icon="hgIcon.ico" IconIndex='0' />
           </Component>
         </Directory>
       </Directory>
 
       <?if $(var.Platform) = "x86" ?>
         <Merge Id='VCRuntime' DiskId='1' Language='1033'
               SourceFile='$(var.VCRedistSrcDir)\microsoft.vcxx.crt.x86_msm.msm' />
         <Merge Id='VCRuntimePolicy' DiskId='1' Language='1033'
               SourceFile='$(var.VCRedistSrcDir)\policy.x.xx.microsoft.vcxx.crt.x86_msm.msm' />
       <?else?>
         <Merge Id='VCRuntime' DiskId='1' Language='1033'
               SourceFile='$(var.VCRedistSrcDir)\microsoft.vcxx.crt.x64_msm.msm' />
         <Merge Id='VCRuntimePolicy' DiskId='1' Language='1033'
               SourceFile='$(var.VCRedistSrcDir)\policy.x.xx.microsoft.vcxx.crt.x64_msm.msm' />
       <?endif?>
     </Directory>
 
     <Feature Id='Complete' Title='Mercurial' Description='The complete package'
         Display='expand' Level='1' ConfigurableDirectory='INSTALLDIR' >
       <Feature Id='MainProgram' Title='Program' Description='Mercurial command line app'
              Level='1' Absent='disallow' >
         <ComponentRef Id='MainExecutable' />
         <ComponentRef Id='distOutput' />
         <ComponentRef Id='libOutput' />
         <ComponentRef Id='ProgramMenuDir' />
         <ComponentRef Id='ReadMe' />
         <ComponentRef Id='COPYING' />
         <ComponentRef Id='mercurial.rc' />
         <ComponentRef Id='mergetools.rc' />
         <ComponentGroupRef Id='helpFolder' />
         <ComponentGroupRef Id='templatesFolder' />
         <MergeRef Id='VCRuntime' />
         <MergeRef Id='VCRuntimePolicy' />
       </Feature>
+      <?if $(var.MercurialExtraFeatures)?>
+        <?foreach EXTRAFEAT in $(var.MercurialExtraFeatures)?>
+          <FeatureRef Id="$(var.EXTRAFEAT)" />
+        <?endforeach?>
+      <?endif?>
       <Feature Id='Locales' Title='Translations' Description='Translations' Level='1'>
         <ComponentGroupRef Id='localeFolder' />
         <ComponentRef Id='i18nFolder' />
       </Feature>
       <Feature Id='Documentation' Title='Documentation' Description='HTML man pages' Level='1'>
         <ComponentGroupRef Id='docFolder' />
       </Feature>
       <Feature Id='Misc' Title='Miscellaneous' Description='Contributed scripts' Level='1'>
         <ComponentGroupRef Id='contribFolder' />
       </Feature>
     </Feature>
 
     <UIRef Id="WixUI_FeatureTree" />
     <UIRef Id="WixUI_ErrorProgressText" />
 
     <WixVariable Id="WixUILicenseRtf" Value="contrib\packaging\wix\COPYING.rtf" />
 
     <Icon Id="hgIcon.ico" SourceFile="contrib/win32/mercurial.ico" />
 
     <Upgrade Id='$(var.ProductUpgradeCode)'>
       <UpgradeVersion
         IncludeMinimum='yes' Minimum='0.0.0' IncludeMaximum='no' OnlyDetect='no'
         Property='INSTALLEDMERCURIALPRODUCTS' />
     </Upgrade>
 
     <InstallExecuteSequence>
       <RemoveExistingProducts After='InstallInitialize'/>
     </InstallExecuteSequence>
 
   </Product>
 </Wix>