src/jdk.jpackage/windows/classes/jdk/jpackage/internal/WixTool.java
author herrick
Wed, 23 Oct 2019 10:37:54 -0400
branchJDK-8200758-branch
changeset 58762 0fe62353385b
parent 58696 61c44899b4eb
child 58890 6539ad1d90aa
permissions -rw-r--r--
8232281: jpackage is not always reporting an error when no main class specified Reviewed-by: asemenyuk, asemenuk
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     1
/*
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     2
 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     4
 *
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    10
 *
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    15
 * accompanied this code).
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    16
 *
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    20
 *
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    23
 * questions.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    24
 */
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    25
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    26
package jdk.jpackage.internal;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    27
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    28
import java.io.IOException;
58762
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
    29
import java.nio.file.*;
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    30
import java.text.MessageFormat;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    31
import java.util.*;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    32
import java.util.function.Supplier;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    33
import java.util.stream.Collectors;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    34
import java.util.stream.Stream;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    35
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    36
/**
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    37
 * WiX tool.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    38
 */
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    39
public enum WixTool {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    40
    Candle, Light;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    41
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    42
    static final class ToolInfo {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    43
        ToolInfo(Path path, String version) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    44
            this.path = path;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    45
            this.version = new DottedVersion(version);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    46
        }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    47
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    48
        final Path path;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    49
        final DottedVersion version;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    50
    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    51
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    52
    static Map<WixTool, ToolInfo> toolset() throws ConfigException {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    53
        Map<WixTool, ToolInfo> toolset = new HashMap<>();
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    54
        for (var tool : values()) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    55
            toolset.put(tool, tool.find());
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    56
        }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    57
        return toolset;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    58
    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    59
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    60
    ToolInfo find() throws ConfigException {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    61
        final Path toolFileName = IOUtils.addSuffix(
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    62
                Path.of(name().toLowerCase()), ".exe");
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    63
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    64
        String[] version = new String[1];
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    65
        ConfigException reason = createToolValidator(toolFileName, version).get();
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    66
        if (version[0] != null) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    67
            if (reason == null) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    68
                // Found in PATH.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    69
                return new ToolInfo(toolFileName, version[0]);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    70
            }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    71
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    72
            // Found in PATH, but something went wrong.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    73
            throw reason;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    74
        }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    75
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    76
        for (var dir : findWixInstallDirs()) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    77
            Path path = dir.resolve(toolFileName);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    78
            if (path.toFile().exists()) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    79
                reason = createToolValidator(path, version).get();
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    80
                if (reason != null) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    81
                    throw reason;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    82
                }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    83
                return new ToolInfo(path, version[0]);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    84
            }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    85
        }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    86
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    87
        throw reason;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    88
    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    89
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    90
    private static Supplier<ConfigException> createToolValidator(Path toolPath,
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    91
            String[] versionCtnr) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    92
        return new ToolValidator(toolPath)
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    93
                .setCommandLine("/?")
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    94
                .setMinimalVersion(MINIMAL_VERSION)
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    95
                .setToolNotFoundErrorHandler(
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    96
                        (name, ex) -> new ConfigException(
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    97
                                I18N.getString("error.no-wix-tools"),
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    98
                                I18N.getString("error.no-wix-tools.advice")))
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
    99
                .setToolOldVersionErrorHandler(
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   100
                        (name, version) -> new ConfigException(
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   101
                                MessageFormat.format(I18N.getString(
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   102
                                        "message.wrong-tool-version"), name,
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   103
                                        version, MINIMAL_VERSION),
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   104
                                I18N.getString("error.no-wix-tools.advice")))
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   105
                .setVersionParser(output -> {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   106
                    versionCtnr[0] = "";
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   107
                    String firstLineOfOutput = output.findFirst().orElse("");
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   108
                    int separatorIdx = firstLineOfOutput.lastIndexOf(' ');
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   109
                    if (separatorIdx == -1) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   110
                        return null;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   111
                    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   112
                    versionCtnr[0] = firstLineOfOutput.substring(separatorIdx + 1);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   113
                    return versionCtnr[0];
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   114
                })::validate;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   115
    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   116
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   117
    private final static String MINIMAL_VERSION = "3.0";
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   118
58762
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   119
    static Path getSystemDir(String envVar, String knownDir) {
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   120
        return Optional
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   121
                .ofNullable(getEnvVariableAsPath(envVar))
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   122
                .orElseGet(() -> Optional
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   123
                        .ofNullable(getEnvVariableAsPath("SystemDrive"))
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   124
                        .orElseGet(() -> Path.of("C:")).resolve(knownDir));
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   125
    }
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   126
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   127
    private static Path getEnvVariableAsPath(String envVar) {
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   128
        String path = System.getenv(envVar);
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   129
        if (path != null) {
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   130
            try {
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   131
                return Path.of(path);
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   132
            } catch (InvalidPathException ex) {
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   133
                Log.error(MessageFormat.format(I18N.getString(
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   134
                        "error.invalid-envvar"), envVar));
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   135
                return null;
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   136
            }
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   137
        }
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   138
        return null;
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   139
    }
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   140
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   141
    private static List<Path> findWixInstallDirs() {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   142
        PathMatcher wixInstallDirMatcher = FileSystems.getDefault().getPathMatcher(
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   143
                "glob:WiX Toolset v*");
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   144
58762
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   145
        Path programFiles = getSystemDir("ProgramFiles", "Program Files");
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   146
        Path programFilesX86 = getSystemDir("ProgramFiles(X86)",
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   147
                "Program Files (x86)");
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   148
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   149
        // Returns list of WiX install directories ordered by WiX version number.
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   150
        // Newer versions go first.
58762
0fe62353385b 8232281: jpackage is not always reporting an error when no main class specified
herrick
parents: 58696
diff changeset
   151
        return Stream.of(programFiles, programFilesX86).map(path -> {
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   152
            List<Path> result;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   153
            try (var paths = Files.walk(path, 1)) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   154
                result = paths.collect(Collectors.toList());
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   155
            } catch (IOException ex) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   156
                Log.verbose(ex);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   157
                result = Collections.emptyList();
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   158
            }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   159
            return result;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   160
        }).flatMap(List::stream)
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   161
        .filter(path -> wixInstallDirMatcher.matches(path.getFileName()))
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   162
        .sorted(Comparator.comparing(Path::getFileName).reversed())
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   163
        .map(path -> path.resolve("bin"))
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   164
        .collect(Collectors.toList());
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   165
    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents:
diff changeset
   166
}