"use strict";
|
Object.defineProperty(exports, "__esModule", { value: true });
|
const bluebird_lst_1 = require("bluebird-lst");
|
const builder_util_1 = require("builder-util");
|
const builder_util_runtime_1 = require("builder-util-runtime");
|
const binDownload_1 = require("../binDownload");
|
const fs_1 = require("builder-util/out/fs");
|
const crypto_1 = require("crypto");
|
const ejs = require("ejs");
|
const promises_1 = require("fs/promises");
|
const lazy_val_1 = require("lazy-val");
|
const path = require("path");
|
const core_1 = require("../core");
|
const CommonWindowsInstallerConfiguration_1 = require("../options/CommonWindowsInstallerConfiguration");
|
const platformPackager_1 = require("../platformPackager");
|
const pathManager_1 = require("../util/pathManager");
|
const vm_1 = require("../vm/vm");
|
const WineVm_1 = require("../vm/WineVm");
|
const targetUtil_1 = require("./targetUtil");
|
const ELECTRON_BUILDER_UPGRADE_CODE_NS_UUID = builder_util_runtime_1.UUID.parse("d752fe43-5d44-44d5-9fc9-6dd1bf19d5cc");
|
const ROOT_DIR_ID = "APPLICATIONFOLDER";
|
const projectTemplate = new lazy_val_1.Lazy(async () => {
|
const template = (await promises_1.readFile(path.join(pathManager_1.getTemplatePath("msi"), "template.xml"), "utf8"))
|
.replace(/{{/g, "<%")
|
.replace(/}}/g, "%>")
|
.replace(/\${([^}]+)}/g, "<%=$1%>");
|
return ejs.compile(template);
|
});
|
// WiX doesn't support Mono, so, dontnet462 is required to be installed for wine (preinstalled in our bundled wine)
|
class MsiTarget extends core_1.Target {
|
constructor(packager, outDir) {
|
super("msi");
|
this.packager = packager;
|
this.outDir = outDir;
|
this.vm = process.platform === "win32" ? new vm_1.VmManager() : new WineVm_1.WineVmManager();
|
this.options = builder_util_1.deepAssign(this.packager.platformSpecificBuildOptions, this.packager.config.msi);
|
}
|
/**
|
* A product-specific string that can be used in an [MSI Identifier](https://docs.microsoft.com/en-us/windows/win32/msi/identifier).
|
*/
|
get productMsiIdPrefix() {
|
const sanitizedId = this.packager.appInfo.productFilename.replace(/[^\w.]/g, "").replace(/^[^A-Za-z_]+/, "");
|
return sanitizedId.length > 0 ? sanitizedId : "App" + this.upgradeCode.replace(/-/g, "");
|
}
|
get iconId() {
|
return `${this.productMsiIdPrefix}Icon.exe`;
|
}
|
get upgradeCode() {
|
return (this.options.upgradeCode || builder_util_runtime_1.UUID.v5(this.packager.appInfo.id, ELECTRON_BUILDER_UPGRADE_CODE_NS_UUID)).toUpperCase();
|
}
|
async build(appOutDir, arch) {
|
const packager = this.packager;
|
const artifactName = packager.expandArtifactBeautyNamePattern(this.options, "msi", arch);
|
const artifactPath = path.join(this.outDir, artifactName);
|
await packager.info.callArtifactBuildStarted({
|
targetPresentableName: "MSI",
|
file: artifactPath,
|
arch,
|
});
|
const stageDir = await targetUtil_1.createStageDir(this, packager, arch);
|
const vm = this.vm;
|
const commonOptions = CommonWindowsInstallerConfiguration_1.getEffectiveOptions(this.options, this.packager);
|
const projectFile = stageDir.getTempFile("project.wxs");
|
const objectFiles = ["project.wixobj"];
|
await promises_1.writeFile(projectFile, await this.writeManifest(appOutDir, arch, commonOptions));
|
await packager.info.callMsiProjectCreated(projectFile);
|
// noinspection SpellCheckingInspection
|
const vendorPath = await binDownload_1.getBinFromUrl("wix", "4.0.0.5512.2", "/X5poahdCc3199Vt6AP7gluTlT1nxi9cbbHhZhCMEu+ngyP1LiBMn+oZX7QAZVaKeBMc2SjVp7fJqNLqsUnPNQ==");
|
// noinspection SpellCheckingInspection
|
const candleArgs = ["-arch", arch === builder_util_1.Arch.ia32 ? "x86" : arch === builder_util_1.Arch.arm64 ? "arm64" : "x64", `-dappDir=${vm.toVmFile(appOutDir)}`].concat(this.getCommonWixArgs());
|
candleArgs.push("project.wxs");
|
await vm.exec(vm.toVmFile(path.join(vendorPath, "candle.exe")), candleArgs, {
|
cwd: stageDir.dir,
|
});
|
await this.light(objectFiles, vm, artifactPath, appOutDir, vendorPath, stageDir.dir);
|
await stageDir.cleanup();
|
await packager.sign(artifactPath);
|
await packager.info.callArtifactBuildCompleted({
|
file: artifactPath,
|
packager,
|
arch,
|
safeArtifactName: packager.computeSafeArtifactName(artifactName, "msi"),
|
target: this,
|
isWriteUpdateInfo: false,
|
});
|
}
|
async light(objectFiles, vm, artifactPath, appOutDir, vendorPath, tempDir) {
|
// noinspection SpellCheckingInspection
|
const lightArgs = [
|
"-out",
|
vm.toVmFile(artifactPath),
|
"-v",
|
// https://github.com/wixtoolset/issues/issues/5169
|
"-spdb",
|
// https://sourceforge.net/p/wix/bugs/2405/
|
// error LGHT1076 : ICE61: This product should remove only older versions of itself. The Maximum version is not less than the current product. (1.1.0.42 1.1.0.42)
|
"-sw1076",
|
`-dappDir=${vm.toVmFile(appOutDir)}`,
|
// "-dcl:high",
|
].concat(this.getCommonWixArgs());
|
// http://windows-installer-xml-wix-toolset.687559.n2.nabble.com/Build-3-5-2229-0-give-me-the-following-error-error-LGHT0216-An-unexpected-Win32-exception-with-errorn-td5707443.html
|
if (process.platform !== "win32") {
|
// noinspection SpellCheckingInspection
|
lightArgs.push("-sval");
|
}
|
if (this.options.oneClick === false) {
|
lightArgs.push("-ext", "WixUIExtension");
|
}
|
// objectFiles - only filenames, we set current directory to our temp stage dir
|
lightArgs.push(...objectFiles);
|
await vm.exec(vm.toVmFile(path.join(vendorPath, "light.exe")), lightArgs, {
|
cwd: tempDir,
|
});
|
}
|
getCommonWixArgs() {
|
const args = ["-pedantic"];
|
if (this.options.warningsAsErrors !== false) {
|
args.push("-wx");
|
}
|
if (this.options.additionalWixArgs != null) {
|
args.push(...this.options.additionalWixArgs);
|
}
|
return args;
|
}
|
async writeManifest(appOutDir, arch, commonOptions) {
|
const appInfo = this.packager.appInfo;
|
const { files, dirs } = await this.computeFileDeclaration(appOutDir);
|
const companyName = appInfo.companyName;
|
if (!companyName) {
|
builder_util_1.log.warn(`Manufacturer is not set for MSI — please set "author" in the package.json`);
|
}
|
const compression = this.packager.compression;
|
const options = this.options;
|
const iconPath = await this.packager.getIconPath();
|
return (await projectTemplate.value)({
|
...commonOptions,
|
isCreateDesktopShortcut: commonOptions.isCreateDesktopShortcut !== CommonWindowsInstallerConfiguration_1.DesktopShortcutCreationPolicy.NEVER,
|
isRunAfterFinish: options.runAfterFinish !== false,
|
iconPath: iconPath == null ? null : this.vm.toVmFile(iconPath),
|
iconId: this.iconId,
|
compressionLevel: compression === "store" ? "none" : "high",
|
version: appInfo.getVersionInWeirdWindowsForm(),
|
productName: appInfo.productName,
|
upgradeCode: this.upgradeCode,
|
manufacturer: companyName || appInfo.productName,
|
appDescription: appInfo.description,
|
// https://stackoverflow.com/questions/1929038/compilation-error-ice80-the-64bitcomponent-uses-32bitdirectory
|
programFilesId: arch === builder_util_1.Arch.x64 ? "ProgramFiles64Folder" : "ProgramFilesFolder",
|
// wix in the name because special wix format can be used in the name
|
installationDirectoryWixName: targetUtil_1.getWindowsInstallationDirName(appInfo, commonOptions.isAssisted || commonOptions.isPerMachine === true),
|
dirs,
|
files,
|
});
|
}
|
async computeFileDeclaration(appOutDir) {
|
const appInfo = this.packager.appInfo;
|
let isRootDirAddedToRemoveTable = false;
|
const dirNames = new Set();
|
const dirs = [];
|
const fileSpace = " ".repeat(6);
|
const commonOptions = CommonWindowsInstallerConfiguration_1.getEffectiveOptions(this.options, this.packager);
|
const files = await bluebird_lst_1.default.map(fs_1.walk(appOutDir), file => {
|
const packagePath = file.substring(appOutDir.length + 1);
|
const lastSlash = packagePath.lastIndexOf(path.sep);
|
const fileName = lastSlash > 0 ? packagePath.substring(lastSlash + 1) : packagePath;
|
let directoryId = null;
|
let dirName = "";
|
// Wix Directory.FileSource doesn't work - https://stackoverflow.com/questions/21519388/wix-filesource-confusion
|
if (lastSlash > 0) {
|
// This Name attribute may also define multiple directories using the inline directory syntax.
|
// For example, "ProgramFilesFolder:\My Company\My Product\bin" would create a reference to a Directory element with Id="ProgramFilesFolder" then create directories named "My Company" then "My Product" then "bin" nested beneath each other.
|
// This syntax is a shortcut to defining each directory in an individual Directory element.
|
dirName = packagePath.substring(0, lastSlash);
|
// https://github.com/electron-userland/electron-builder/issues/3027
|
directoryId = "d" + crypto_1.createHash("md5").update(dirName).digest("base64").replace(/\//g, "_").replace(/\+/g, ".").replace(/=+$/, "");
|
if (!dirNames.has(dirName)) {
|
dirNames.add(dirName);
|
dirs.push(`<Directory Id="${directoryId}" Name="${ROOT_DIR_ID}:\\${dirName.replace(/\//g, "\\")}\\"/>`);
|
}
|
}
|
else if (!isRootDirAddedToRemoveTable) {
|
isRootDirAddedToRemoveTable = true;
|
}
|
// since RegistryValue can be part of Component, *** *** *** *** *** *** *** *** *** wix cannot auto generate guid
|
// https://stackoverflow.com/questions/1405100/change-my-component-guid-in-wix
|
let result = `<Component${directoryId === null ? "" : ` Directory="${directoryId}"`}>`;
|
result += `\n${fileSpace} <File Name="${xmlAttr(fileName)}" Source="$(var.appDir)${path.sep}${xmlAttr(packagePath)}" ReadOnly="yes" KeyPath="yes"`;
|
const isMainExecutable = packagePath === `${appInfo.productFilename}.exe`;
|
if (isMainExecutable) {
|
result += ' Id="mainExecutable"';
|
}
|
else if (directoryId === null) {
|
result += ` Id="${path.basename(packagePath)}_f"`;
|
}
|
const isCreateDesktopShortcut = commonOptions.isCreateDesktopShortcut !== CommonWindowsInstallerConfiguration_1.DesktopShortcutCreationPolicy.NEVER;
|
if (isMainExecutable && (isCreateDesktopShortcut || commonOptions.isCreateStartMenuShortcut)) {
|
result += `>\n`;
|
const shortcutName = commonOptions.shortcutName;
|
if (isCreateDesktopShortcut) {
|
result += `${fileSpace} <Shortcut Id="desktopShortcut" Directory="DesktopFolder" Name="${xmlAttr(shortcutName)}" WorkingDirectory="APPLICATIONFOLDER" Advertise="yes" Icon="${this.iconId}"/>\n`;
|
}
|
const hasMenuCategory = commonOptions.menuCategory != null;
|
const startMenuShortcutDirectoryId = hasMenuCategory ? "AppProgramMenuDir" : "ProgramMenuFolder";
|
if (commonOptions.isCreateStartMenuShortcut) {
|
if (hasMenuCategory) {
|
dirs.push(`<Directory Id="${startMenuShortcutDirectoryId}" Name="ProgramMenuFolder:\\${commonOptions.menuCategory}\\"/>`);
|
}
|
result += `${fileSpace} <Shortcut Id="startMenuShortcut" Directory="${startMenuShortcutDirectoryId}" Name="${xmlAttr(shortcutName)}" WorkingDirectory="APPLICATIONFOLDER" Advertise="yes" Icon="${this.iconId}">\n`;
|
result += `${fileSpace} <ShortcutProperty Key="System.AppUserModel.ID" Value="${xmlAttr(this.packager.appInfo.id)}"/>\n`;
|
result += `${fileSpace} </Shortcut>\n`;
|
}
|
result += `${fileSpace}</File>`;
|
if (hasMenuCategory) {
|
result += `<RemoveFolder Id="${startMenuShortcutDirectoryId}" Directory="${startMenuShortcutDirectoryId}" On="uninstall"/>\n`;
|
}
|
}
|
else {
|
result += `/>`;
|
}
|
const fileAssociations = this.packager.fileAssociations;
|
if (isMainExecutable && fileAssociations.length !== 0) {
|
for (const item of fileAssociations) {
|
const extensions = builder_util_1.asArray(item.ext).map(platformPackager_1.normalizeExt);
|
for (const ext of extensions) {
|
result += `${fileSpace} <ProgId Id="${this.productMsiIdPrefix}.${ext}" Advertise="yes" Icon="${this.iconId}" ${item.description ? `Description="${item.description}"` : ""}>\n`;
|
result += `${fileSpace} <Extension Id="${ext}" Advertise="yes">\n`;
|
result += `${fileSpace} <Verb Id="open" Command="Open with ${xmlAttr(this.packager.appInfo.productName)}" Argument=""%1""/>\n`;
|
result += `${fileSpace} </Extension>\n`;
|
result += `${fileSpace} </ProgId>\n`;
|
}
|
}
|
}
|
return `${result}\n${fileSpace}</Component>`;
|
});
|
return { dirs: listToString(dirs, 2), files: listToString(files, 3) };
|
}
|
}
|
exports.default = MsiTarget;
|
function listToString(list, indentLevel) {
|
const space = " ".repeat(indentLevel * 2);
|
return list.join(`\n${space}`);
|
}
|
function xmlAttr(str) {
|
return str.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">").replace(/"/g, """).replace(/'/g, "'");
|
}
|
//# sourceMappingURL=MsiTarget.js.map
|
