| #!/usr/bin/env python3 |
| # SPDX-License-Identifier: Apache-2.0 |
| # Copyright 2017-2021 The Meson development team |
| |
| ''' |
| This script is for generating MSI packages |
| for Windows users. |
| ''' |
| |
| import subprocess |
| import shutil |
| import uuid |
| import sys |
| import os |
| from glob import glob |
| import xml.etree.ElementTree as ET |
| |
| sys.path.append(os.getcwd()) |
| from mesonbuild import coredata |
| |
| # Elementtree does not support CDATA. So hack it. |
| WINVER_CHECK = 'Installed OR (VersionNT64 > 602)>' |
| |
| def gen_guid(): |
| ''' |
| Generate guid |
| ''' |
| return str(uuid.uuid4()).upper() |
| |
| class Node: |
| ''' |
| Node to hold path and directory values |
| ''' |
| |
| def __init__(self, dirs, files): |
| self.check_dirs(dirs) |
| self.check_files(files) |
| self.dirs = dirs |
| self.files = files |
| |
| @staticmethod |
| def check_dirs(dirs): |
| ''' |
| Check to see if directory is instance of list |
| ''' |
| assert isinstance(dirs, list) |
| |
| @staticmethod |
| def check_files(files): |
| ''' |
| Check to see if files is instance of list |
| ''' |
| assert isinstance(files, list) |
| |
| |
| class PackageGenerator: |
| ''' |
| Package generator for MSI packages |
| ''' |
| |
| def __init__(self): |
| self.product_name = 'Meson Build System' |
| self.manufacturer = 'The Meson Development Team' |
| self.version = coredata.version.replace('dev', '') |
| self.root = None |
| self.guid = '*' |
| self.update_guid = '141527EE-E28A-4D14-97A4-92E6075D28B2' |
| self.main_xml = 'meson.wxs' |
| self.main_o = 'meson.wixobj' |
| self.final_output = f'meson-{self.version}-64.msi' |
| self.staging_dirs = ['dist', 'dist2'] |
| self.progfile_dir = 'ProgramFiles64Folder' |
| redist_globs = ['C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community\\VC\\Redist\\MSVC\\v*\\MergeModules\\Microsoft_VC142_CRT_x64.msm', |
| 'C:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\VC\\Redist\\MSVC\\v*\\MergeModules\\Microsoft_VC143_CRT_x64.msm'] |
| redist_path = None |
| for g in redist_globs: |
| trials = glob(g) |
| if len(trials) > 1: |
| sys.exit('MSM glob matched multiple entries:' + '\n'.join(trials)) |
| if len(trials) == 1: |
| redist_path = trials[0] |
| break |
| if redist_path is None: |
| sys.exit('No MSMs found.') |
| self.redist_path = redist_path |
| self.component_num = 0 |
| self.feature_properties = { |
| self.staging_dirs[0]: { |
| 'Id': 'MainProgram', |
| 'Title': 'Meson', |
| 'Description': 'Meson executables', |
| 'Level': '1', |
| 'AllowAbsent': 'no', |
| }, |
| self.staging_dirs[1]: { |
| 'Id': 'NinjaProgram', |
| 'Title': 'Ninja', |
| 'Description': 'Ninja build tool', |
| 'Level': '1', |
| } |
| } |
| self.feature_components = {} |
| for s_d in self.staging_dirs: |
| self.feature_components[s_d] = [] |
| |
| def build_dist(self): |
| ''' |
| Build dist file from PyInstaller info |
| ''' |
| for sdir in self.staging_dirs: |
| if os.path.exists(sdir): |
| shutil.rmtree(sdir) |
| main_stage, ninja_stage = self.staging_dirs |
| |
| pyinstaller = shutil.which('pyinstaller') |
| if not pyinstaller: |
| print("ERROR: This script requires pyinstaller.") |
| sys.exit(1) |
| |
| pyinstaller_tmpdir = 'pyinst-tmp' |
| if os.path.exists(pyinstaller_tmpdir): |
| shutil.rmtree(pyinstaller_tmpdir) |
| pyinst_cmd = [pyinstaller, |
| '--clean', |
| '--additional-hooks-dir=packaging', |
| '--distpath', |
| pyinstaller_tmpdir] |
| pyinst_cmd += ['meson.py'] |
| subprocess.check_call(pyinst_cmd) |
| shutil.move(pyinstaller_tmpdir + '/meson', main_stage) |
| self.del_infodirs(main_stage) |
| if not os.path.exists(os.path.join(main_stage, 'meson.exe')): |
| sys.exit('Meson exe missing from staging dir.') |
| os.mkdir(ninja_stage) |
| shutil.copy(shutil.which('ninja'), ninja_stage) |
| if not os.path.exists(os.path.join(ninja_stage, 'ninja.exe')): |
| sys.exit('Ninja exe missing from staging dir.') |
| |
| def del_infodirs(self, dirname): |
| # Starting with 3.9.something there are some |
| # extra metadatadirs that have a hyphen in their |
| # file names. This is a forbidden character in WiX |
| # filenames so delete them. |
| for d in glob(os.path.join(dirname, '*-info')): |
| shutil.rmtree(d) |
| |
| def generate_files(self): |
| ''' |
| Generate package files for MSI installer package |
| ''' |
| self.root = ET.Element('Wix', { |
| 'xmlns': 'http://wixtoolset.org/schemas/v4/wxs', |
| 'xmlns:ui': 'http://wixtoolset.org/schemas/v4/wxs/ui' |
| }) |
| |
| package = ET.SubElement(self.root, 'Package', { |
| 'Name': self.product_name, |
| 'Manufacturer': 'The Meson Development Team', |
| 'UpgradeCode': self.update_guid, |
| 'Language': '1033', |
| 'Codepage': '1252', |
| 'Version': self.version, |
| }) |
| |
| ET.SubElement(package, 'SummaryInformation', { |
| 'Keywords': 'Installer', |
| 'Description': f'Meson {self.version} installer', |
| 'Manufacturer': 'The Meson Development Team', |
| }) |
| |
| ET.SubElement(package, |
| 'Launch', |
| {'Message': 'This application is only supported on Windows 10 or higher.', |
| 'Condition': 'X'*len(WINVER_CHECK)}) |
| |
| ET.SubElement(package, 'MajorUpgrade', |
| {'DowngradeErrorMessage': |
| 'A newer version of Meson is already installed.'}) |
| |
| ET.SubElement(package, 'Media', { |
| 'Id': '1', |
| 'Cabinet': 'meson.cab', |
| 'EmbedCab': 'yes', |
| }) |
| targetdir = ET.SubElement(package, 'StandardDirectory', { |
| 'Id': 'ProgramFiles64Folder', |
| }) |
| installdir = ET.SubElement(targetdir, 'Directory', { |
| 'Id': 'INSTALLDIR', |
| 'Name': 'Meson', |
| }) |
| ET.SubElement(installdir, 'Merge', { |
| 'Id': 'VCRedist', |
| 'SourceFile': self.redist_path, |
| 'DiskId': '1', |
| 'Language': '0', |
| }) |
| |
| ET.SubElement(package, 'ui:WixUI', { |
| 'Id': 'WixUI_FeatureTree', |
| }) |
| for s_d in self.staging_dirs: |
| assert os.path.isdir(s_d) |
| top_feature = ET.SubElement(package, 'Feature', { |
| 'Id': 'Complete', |
| 'Title': 'Meson ' + self.version, |
| 'Description': 'The complete package', |
| 'Display': 'expand', |
| 'Level': '1', |
| 'ConfigurableDirectory': 'INSTALLDIR', |
| }) |
| for s_d in self.staging_dirs: |
| nodes = {} |
| for root, dirs, files in os.walk(s_d): |
| cur_node = Node(dirs, files) |
| nodes[root] = cur_node |
| self.create_xml(nodes, s_d, installdir, s_d) |
| self.build_features(top_feature, s_d) |
| vcredist_feature = ET.SubElement(top_feature, 'Feature', { |
| 'Id': 'VCRedist', |
| 'Title': 'Visual C++ runtime', |
| 'AllowAdvertise': 'no', |
| 'Display': 'hidden', |
| 'Level': '1', |
| }) |
| ET.SubElement(vcredist_feature, 'MergeRef', {'Id': 'VCRedist'}) |
| ET.ElementTree(self.root).write(self.main_xml, encoding='utf-8', xml_declaration=True) |
| # ElementTree cannot do pretty-printing, so do it manually |
| import xml.dom.minidom |
| doc = xml.dom.minidom.parse(self.main_xml) |
| with open(self.main_xml, 'w') as open_file: |
| open_file.write(doc.toprettyxml()) |
| # One last fix, add CDATA. |
| with open(self.main_xml) as open_file: |
| data = open_file.read() |
| data = data.replace('X'*len(WINVER_CHECK), WINVER_CHECK) |
| with open(self.main_xml, 'w') as open_file: |
| open_file.write(data) |
| |
| def build_features(self, top_feature, staging_dir): |
| ''' |
| Generate build features |
| ''' |
| feature = ET.SubElement(top_feature, 'Feature', self.feature_properties[staging_dir]) |
| for component_id in self.feature_components[staging_dir]: |
| ET.SubElement(feature, 'ComponentRef', { |
| 'Id': component_id, |
| }) |
| |
| def create_xml(self, nodes, current_dir, parent_xml_node, staging_dir): |
| ''' |
| Create XML file |
| ''' |
| cur_node = nodes[current_dir] |
| if cur_node.files: |
| component_id = f'ApplicationFiles{self.component_num}' |
| comp_xml_node = ET.SubElement(parent_xml_node, 'Component', { |
| 'Id': component_id, |
| 'Bitness': 'always64', |
| 'Guid': gen_guid(), |
| }) |
| self.feature_components[staging_dir].append(component_id) |
| if self.component_num == 0: |
| ET.SubElement(comp_xml_node, 'Environment', { |
| 'Id': 'Environment', |
| 'Name': 'PATH', |
| 'Part': 'last', |
| 'System': 'yes', |
| 'Action': 'set', |
| 'Value': '[INSTALLDIR]', |
| }) |
| self.component_num += 1 |
| for f_node in cur_node.files: |
| file_id = os.path.join(current_dir, f_node).replace('\\', '_').replace('#', '_').replace('-', '_') |
| ET.SubElement(comp_xml_node, 'File', { |
| 'Id': file_id, |
| 'Name': f_node, |
| 'Source': os.path.join(current_dir, f_node), |
| }) |
| |
| for dirname in cur_node.dirs: |
| dir_id = os.path.join(current_dir, dirname).replace('\\', '_').replace('/', '_').replace('-', '_') |
| dir_node = ET.SubElement(parent_xml_node, 'Directory', { |
| 'Id': dir_id, |
| 'Name': dirname, |
| }) |
| self.create_xml(nodes, os.path.join(current_dir, dirname), dir_node, staging_dir) |
| |
| def build_package(self): |
| ''' |
| Generate the Meson build MSI package. |
| ''' |
| subprocess.check_call(['wix', |
| 'build', |
| '-bindvariable', 'WixUILicenseRtf=packaging\\License.rtf', |
| '-ext', 'WixToolset.UI.wixext', |
| '-culture', 'en-us', |
| '-arch', 'x64', |
| '-o', |
| self.final_output, |
| self.main_xml, |
| ]) |
| |
| |
| def install_wix(): |
| subprocess.check_call(['dotnet', |
| 'nuget', |
| 'add', |
| 'source', |
| 'https://api.nuget.org/v3/index.json']) |
| subprocess.check_call(['dotnet', |
| 'tool', |
| 'install', |
| '--global', |
| 'wix']) |
| subprocess.check_call(['wix', |
| 'extension', |
| 'add', |
| 'WixToolset.UI.wixext', |
| ]) |
| |
| if __name__ == '__main__': |
| if not os.path.exists('meson.py'): |
| sys.exit(print('Run me in the top level source dir.')) |
| if not shutil.which('wix'): |
| install_wix() |
| subprocess.check_call(['pip', 'install', '--upgrade', 'pyinstaller']) |
| |
| p = PackageGenerator() |
| p.build_dist() |
| p.generate_files() |
| p.build_package() |
