Skip to content

Commit 080f1cc

Browse files
author
Alexey Semenyuk
committedNov 20, 2024
8289771: jpackage: ResourceEditor error when path is overly long on Windows
Reviewed-by: almatvee
1 parent c4c6b1f commit 080f1cc

18 files changed

+500
-97
lines changed
 

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/ExecutableRebrander.java

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2020, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -30,6 +30,7 @@
3030
import java.io.InputStreamReader;
3131
import java.io.Reader;
3232
import java.nio.charset.StandardCharsets;
33+
import java.nio.file.Files;
3334
import java.nio.file.Path;
3435
import java.text.MessageFormat;
3536
import java.util.ArrayList;
@@ -40,6 +41,7 @@
4041
import java.util.ResourceBundle;
4142
import java.util.function.Supplier;
4243
import static jdk.jpackage.internal.OverridableResource.createResource;
44+
import static jdk.jpackage.internal.ShortPathUtils.adjustPath;
4345
import static jdk.jpackage.internal.StandardBundlerParam.APP_NAME;
4446
import static jdk.jpackage.internal.StandardBundlerParam.COPYRIGHT;
4547
import static jdk.jpackage.internal.StandardBundlerParam.DESCRIPTION;
@@ -112,7 +114,7 @@ ExecutableRebrander addAction(UpdateResourceAction action) {
112114
}
113115

114116
private void rebrandExecutable(Map<String, ? super Object> params,
115-
Path target, UpdateResourceAction action) throws IOException {
117+
final Path target, UpdateResourceAction action) throws IOException {
116118
try {
117119
String tempDirectory = TEMP_ROOT.fetchFrom(params)
118120
.toAbsolutePath().toString();
@@ -125,10 +127,11 @@ private void rebrandExecutable(Map<String, ? super Object> params,
125127

126128
target.toFile().setWritable(true, true);
127129

128-
long resourceLock = lockResource(target.toString());
130+
var shortTargetPath = ShortPathUtils.toShortPath(target);
131+
long resourceLock = lockResource(shortTargetPath.orElse(target).toString());
129132
if (resourceLock == 0) {
130133
throw new RuntimeException(MessageFormat.format(
131-
I18N.getString("error.lock-resource"), target));
134+
I18N.getString("error.lock-resource"), shortTargetPath.orElse(target)));
132135
}
133136

134137
final boolean resourceUnlockedSuccess;
@@ -144,6 +147,14 @@ private void rebrandExecutable(Map<String, ? super Object> params,
144147
resourceUnlockedSuccess = true;
145148
} else {
146149
resourceUnlockedSuccess = unlockResource(resourceLock);
150+
if (shortTargetPath.isPresent()) {
151+
// Windows will rename the excuatble in the unlock operation.
152+
// Should restore executable's name.
153+
var tmpPath = target.getParent().resolve(
154+
target.getFileName().toString() + ".restore");
155+
Files.move(shortTargetPath.get(), tmpPath);
156+
Files.move(tmpPath, target);
157+
}
147158
}
148159
}
149160

@@ -236,6 +247,7 @@ private static void validateValueAndPut(
236247

237248
private static void iconSwapWrapper(long resourceLock,
238249
String iconTarget) {
250+
iconTarget = adjustPath(iconTarget);
239251
if (iconSwap(resourceLock, iconTarget) != 0) {
240252
throw new RuntimeException(MessageFormat.format(I18N.getString(
241253
"error.icon-swap"), iconTarget));

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/ShortPathUtils.java

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
/*
2+
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
package jdk.jpackage.internal;
26+
27+
import java.nio.file.Files;
28+
import java.nio.file.Path;
29+
import java.text.MessageFormat;
30+
import java.util.Objects;
31+
import java.util.Optional;
32+
33+
34+
@SuppressWarnings("restricted")
35+
final class ShortPathUtils {
36+
static String adjustPath(String path) {
37+
return toShortPath(path).orElse(path);
38+
}
39+
40+
static Path adjustPath(Path path) {
41+
return toShortPath(path).orElse(path);
42+
}
43+
44+
static Optional<String> toShortPath(String path) {
45+
Objects.requireNonNull(path);
46+
return toShortPath(Path.of(path)).map(Path::toString);
47+
}
48+
49+
static Optional<Path> toShortPath(Path path) {
50+
if (!Files.exists(path)) {
51+
throw new IllegalArgumentException(String.format("[%s] path does not exist", path));
52+
}
53+
54+
var normPath = path.normalize().toAbsolutePath().toString();
55+
if (normPath.length() > MAX_PATH) {
56+
return Optional.of(Path.of(getShortPathWrapper(normPath)));
57+
} else {
58+
return Optional.empty();
59+
}
60+
}
61+
62+
private static String getShortPathWrapper(final String longPath) {
63+
String effectivePath;
64+
if (!longPath.startsWith(LONG_PATH_PREFIX)) {
65+
effectivePath = LONG_PATH_PREFIX + longPath;
66+
} else {
67+
effectivePath = longPath;
68+
}
69+
70+
return Optional.ofNullable(getShortPath(effectivePath)).orElseThrow(
71+
() -> new ShortPathException(MessageFormat.format(I18N.getString(
72+
"error.short-path-conv-fail"), effectivePath)));
73+
}
74+
75+
static final class ShortPathException extends RuntimeException {
76+
77+
ShortPathException(String msg) {
78+
super(msg);
79+
}
80+
81+
private static final long serialVersionUID = 1L;
82+
}
83+
84+
private static native String getShortPath(String longPath);
85+
86+
private static final int MAX_PATH = 240;
87+
// See https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getshortpathnamew
88+
private static final String LONG_PATH_PREFIX = "\\\\?\\";
89+
90+
static {
91+
System.loadLibrary("jpackage");
92+
}
93+
}

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/WinMsiBundler.java

+10-8
Original file line numberDiff line numberDiff line change
@@ -526,9 +526,10 @@ private Path buildMSI(Map<String, ? super Object> params,
526526
"message.preparing-msi-config"), msiOut.toAbsolutePath()
527527
.toString()));
528528

529-
WixPipeline wixPipeline = new WixPipeline()
530-
.setToolset(wixToolset)
531-
.setWixObjDir(TEMP_ROOT.fetchFrom(params).resolve("wixobj"))
529+
var wixObjDir = TEMP_ROOT.fetchFrom(params).resolve("wixobj");
530+
531+
var wixPipeline = WixPipeline.build()
532+
.setWixObjDir(wixObjDir)
532533
.setWorkDir(WIN_APP_IMAGE.fetchFrom(params))
533534
.addSource(CONFIG_ROOT.fetchFrom(params).resolve("main.wxs"),
534535
wixVars);
@@ -605,13 +606,13 @@ private Path buildMSI(Map<String, ? super Object> params,
605606
// Cultures from custom files and a single primary Culture are
606607
// included into "-cultures" list
607608
for (var wxl : primaryWxlFiles) {
608-
wixPipeline.addLightOptions("-loc", wxl.toAbsolutePath().normalize().toString());
609+
wixPipeline.addLightOptions("-loc", wxl.toString());
609610
}
610611

611612
List<String> cultures = new ArrayList<>();
612613
for (var wxl : customWxlFiles) {
613614
wxl = configDir.resolve(wxl.getFileName());
614-
wixPipeline.addLightOptions("-loc", wxl.toAbsolutePath().normalize().toString());
615+
wixPipeline.addLightOptions("-loc", wxl.toString());
615616
cultures.add(getCultureFromWxlFile(wxl));
616617
}
617618

@@ -638,7 +639,8 @@ private Path buildMSI(Map<String, ? super Object> params,
638639
}
639640
}
640641

641-
wixPipeline.buildMsi(msiOut.toAbsolutePath());
642+
Files.createDirectories(wixObjDir);
643+
wixPipeline.create(wixToolset).buildMsi(msiOut.toAbsolutePath());
642644

643645
return msiOut;
644646
}
@@ -678,14 +680,14 @@ private static String getCultureFromWxlFile(Path wxlPath) throws IOException {
678680
if (nodes.getLength() != 1) {
679681
throw new IOException(MessageFormat.format(I18N.getString(
680682
"error.extract-culture-from-wix-l10n-file"),
681-
wxlPath.toAbsolutePath()));
683+
wxlPath.toAbsolutePath().normalize()));
682684
}
683685

684686
return nodes.item(0).getNodeValue();
685687
} catch (XPathExpressionException | ParserConfigurationException
686688
| SAXException ex) {
687689
throw new IOException(MessageFormat.format(I18N.getString(
688-
"error.read-wix-l10n-file"), wxlPath.toAbsolutePath()), ex);
690+
"error.read-wix-l10n-file"), wxlPath.toAbsolutePath().normalize()), ex);
689691
}
690692
}
691693

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/WixFragmentBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ List<String> getLoggableWixFeatures() {
7474
return List.of();
7575
}
7676

77-
void configureWixPipeline(WixPipeline wixPipeline) {
77+
void configureWixPipeline(WixPipeline.Builder wixPipeline) {
7878
wixPipeline.addSource(configRoot.resolve(outputFileName),
7979
Optional.ofNullable(wixVariables).map(WixVariables::getValues).orElse(
8080
null));

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/WixPipeline.java

+112-47
Original file line numberDiff line numberDiff line change
@@ -29,65 +29,130 @@
2929
import java.nio.file.Path;
3030
import java.util.ArrayList;
3131
import java.util.Collections;
32+
import java.util.HashMap;
3233
import java.util.List;
3334
import java.util.Map;
3435
import java.util.Objects;
3536
import java.util.Optional;
37+
import java.util.Set;
3638
import java.util.function.Function;
39+
import java.util.function.UnaryOperator;
3740
import java.util.stream.Collectors;
3841
import java.util.stream.Stream;
42+
import static jdk.jpackage.internal.ShortPathUtils.adjustPath;
3943
import jdk.jpackage.internal.util.PathUtils;
4044

4145
/**
4246
* WiX pipeline. Compiles and links WiX sources.
4347
*/
44-
public class WixPipeline {
45-
WixPipeline() {
46-
sources = new ArrayList<>();
47-
lightOptions = new ArrayList<>();
48-
}
48+
final class WixPipeline {
4949

50-
WixPipeline setToolset(WixToolset v) {
51-
toolset = v;
52-
return this;
53-
}
50+
static final class Builder {
51+
Builder() {
52+
}
5453

55-
WixPipeline setWixVariables(Map<String, String> v) {
56-
wixVariables = v;
57-
return this;
58-
}
54+
WixPipeline create(WixToolset toolset) {
55+
Objects.requireNonNull(toolset);
56+
Objects.requireNonNull(workDir);
57+
Objects.requireNonNull(wixObjDir);
58+
if (sources.isEmpty()) {
59+
throw new IllegalArgumentException("no sources");
60+
}
5961

60-
WixPipeline setWixObjDir(Path v) {
61-
wixObjDir = v;
62-
return this;
63-
}
62+
final var absWorkDir = workDir.normalize().toAbsolutePath();
63+
64+
final UnaryOperator<Path> normalizePath = path -> {
65+
return path.normalize().toAbsolutePath();
66+
};
67+
68+
final var absObjWorkDir = normalizePath.apply(wixObjDir);
69+
70+
var relSources = sources.stream().map(source -> {
71+
return source.overridePath(normalizePath.apply(source.path));
72+
}).toList();
73+
74+
return new WixPipeline(toolset, adjustPath(absWorkDir), absObjWorkDir,
75+
wixVariables, mapLightOptions(normalizePath), relSources);
76+
}
77+
78+
Builder setWixObjDir(Path v) {
79+
wixObjDir = v;
80+
return this;
81+
}
82+
83+
Builder setWorkDir(Path v) {
84+
workDir = v;
85+
return this;
86+
}
87+
88+
Builder setWixVariables(Map<String, String> v) {
89+
wixVariables.clear();
90+
wixVariables.putAll(v);
91+
return this;
92+
}
93+
94+
Builder addSource(Path source, Map<String, String> wixVariables) {
95+
sources.add(new WixSource(source, wixVariables));
96+
return this;
97+
}
98+
99+
Builder addLightOptions(String ... v) {
100+
lightOptions.addAll(List.of(v));
101+
return this;
102+
}
64103

65-
WixPipeline setWorkDir(Path v) {
66-
workDir = v;
67-
return this;
104+
private List<String> mapLightOptions(UnaryOperator<Path> normalizePath) {
105+
var pathOptions = Set.of("-b", "-loc");
106+
List<String> reply = new ArrayList<>();
107+
boolean convPath = false;
108+
for (var opt : lightOptions) {
109+
if (convPath) {
110+
opt = normalizePath.apply(Path.of(opt)).toString();
111+
convPath = false;
112+
} else if (pathOptions.contains(opt)) {
113+
convPath = true;
114+
}
115+
reply.add(opt);
116+
}
117+
return reply;
118+
}
119+
120+
private Path workDir;
121+
private Path wixObjDir;
122+
private final Map<String, String> wixVariables = new HashMap<>();
123+
private final List<String> lightOptions = new ArrayList<>();
124+
private final List<WixSource> sources = new ArrayList<>();
68125
}
69126

70-
WixPipeline addSource(Path source, Map<String, String> wixVariables) {
71-
WixSource entry = new WixSource();
72-
entry.source = source;
73-
entry.variables = wixVariables;
74-
sources.add(entry);
75-
return this;
127+
static Builder build() {
128+
return new Builder();
76129
}
77130

78-
WixPipeline addLightOptions(String ... v) {
79-
lightOptions.addAll(List.of(v));
80-
return this;
131+
private WixPipeline(WixToolset toolset, Path workDir, Path wixObjDir,
132+
Map<String, String> wixVariables, List<String> lightOptions,
133+
List<WixSource> sources) {
134+
this.toolset = toolset;
135+
this.workDir = workDir;
136+
this.wixObjDir = wixObjDir;
137+
this.wixVariables = wixVariables;
138+
this.lightOptions = lightOptions;
139+
this.sources = sources;
81140
}
82141

83142
void buildMsi(Path msi) throws IOException {
84143
Objects.requireNonNull(workDir);
85144

145+
// Use short path to the output msi to workaround
146+
// WiX limitations of handling long paths.
147+
var transientMsi = wixObjDir.resolve("a.msi");
148+
86149
switch (toolset.getType()) {
87-
case Wix3 -> buildMsiWix3(msi);
88-
case Wix4 -> buildMsiWix4(msi);
150+
case Wix3 -> buildMsiWix3(transientMsi);
151+
case Wix4 -> buildMsiWix4(transientMsi);
89152
default -> throw new IllegalArgumentException();
90153
}
154+
155+
IOUtils.copyFile(workDir.resolve(transientMsi), msi);
91156
}
92157

93158
private void addWixVariblesToCommandLine(
@@ -141,7 +206,7 @@ private void buildMsiWix4(Path msi) throws IOException {
141206
"build",
142207
"-nologo",
143208
"-pdbtype", "none",
144-
"-intermediatefolder", wixObjDir.toAbsolutePath().toString(),
209+
"-intermediatefolder", wixObjDir.toString(),
145210
"-ext", "WixToolset.Util.wixext",
146211
"-arch", WixFragmentBuilder.is64Bit() ? "x64" : "x86"
147212
));
@@ -151,7 +216,7 @@ private void buildMsiWix4(Path msi) throws IOException {
151216
addWixVariblesToCommandLine(mergedSrcWixVars, cmdline);
152217

153218
cmdline.addAll(sources.stream().map(wixSource -> {
154-
return wixSource.source.toAbsolutePath().toString();
219+
return wixSource.path.toString();
155220
}).toList());
156221

157222
cmdline.addAll(List.of("-out", msi.toString()));
@@ -182,15 +247,15 @@ private void buildMsiWix3(Path msi) throws IOException {
182247

183248
private Path compileWix3(WixSource wixSource) throws IOException {
184249
Path wixObj = wixObjDir.toAbsolutePath().resolve(PathUtils.replaceSuffix(
185-
IOUtils.getFileName(wixSource.source), ".wixobj"));
250+
wixSource.path.getFileName(), ".wixobj"));
186251

187252
List<String> cmdline = new ArrayList<>(List.of(
188253
toolset.getToolPath(WixTool.Candle3).toString(),
189254
"-nologo",
190-
wixSource.source.toAbsolutePath().toString(),
255+
wixSource.path.toString(),
191256
"-ext", "WixUtilExtension",
192257
"-arch", WixFragmentBuilder.is64Bit() ? "x64" : "x86",
193-
"-out", wixObj.toAbsolutePath().toString()
258+
"-out", wixObj.toString()
194259
));
195260

196261
addWixVariblesToCommandLine(wixSource.variables, cmdline);
@@ -201,19 +266,19 @@ private Path compileWix3(WixSource wixSource) throws IOException {
201266
}
202267

203268
private void execute(List<String> cmdline) throws IOException {
204-
Executor.of(new ProcessBuilder(cmdline).directory(workDir.toFile())).
205-
executeExpectSuccess();
269+
Executor.of(new ProcessBuilder(cmdline).directory(workDir.toFile())).executeExpectSuccess();
206270
}
207271

208-
private static final class WixSource {
209-
Path source;
210-
Map<String, String> variables;
272+
private record WixSource(Path path, Map<String, String> variables) {
273+
WixSource overridePath(Path path) {
274+
return new WixSource(path, variables);
275+
}
211276
}
212277

213-
private WixToolset toolset;
214-
private Map<String, String> wixVariables;
215-
private List<String> lightOptions;
216-
private Path wixObjDir;
217-
private Path workDir;
218-
private List<WixSource> sources;
278+
private final WixToolset toolset;
279+
private final Map<String, String> wixVariables;
280+
private final List<String> lightOptions;
281+
private final Path wixObjDir;
282+
private final Path workDir;
283+
private final List<WixSource> sources;
219284
}

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/WixUiFragmentBuilder.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ void initFromParams(Map<String, ? super Object> params) {
9797
}
9898

9999
@Override
100-
void configureWixPipeline(WixPipeline wixPipeline) {
100+
void configureWixPipeline(WixPipeline.Builder wixPipeline) {
101101
super.configureWixPipeline(wixPipeline);
102102

103103
if (withShortcutPromptDlg || withInstallDirChooserDlg || withLicenseDlg) {
@@ -518,7 +518,7 @@ private final class CustomDialog {
518518
wxsFileName), wxsFileName);
519519
}
520520

521-
void addToWixPipeline(WixPipeline wixPipeline) {
521+
void addToWixPipeline(WixPipeline.Builder wixPipeline) {
522522
wixPipeline.addSource(getConfigRoot().toAbsolutePath().resolve(
523523
wxsFileName), wixVariables.getValues());
524524
}

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/resources/WinResources.properties

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ error.lock-resource=Failed to lock: {0}
5656
error.unlock-resource=Failed to unlock: {0}
5757
error.read-wix-l10n-file=Failed to parse {0} file
5858
error.extract-culture-from-wix-l10n-file=Failed to read value of culture from {0} file
59+
error.short-path-conv-fail=Failed to get short version of "{0}" path
5960

6061
message.icon-not-ico=The specified icon "{0}" is not an ICO file and will not be used. The default icon will be used in it's place.
6162
message.potential.windows.defender.issue=Warning: Windows Defender may prevent jpackage from functioning. If there is an issue, it can be addressed by either disabling realtime monitoring, or adding an exclusion for the directory "{0}".

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/resources/WinResources_de.properties

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ error.lock-resource=Sperren nicht erfolgreich: {0}
5656
error.unlock-resource=Aufheben der Sperre nicht erfolgreich: {0}
5757
error.read-wix-l10n-file=Datei {0} konnte nicht geparst werden
5858
error.extract-culture-from-wix-l10n-file=Kulturwert konnte nicht aus Datei {0} gelesen werden
59+
error.short-path-conv-fail=Failed to get short version of "{0}" path
5960

6061
message.icon-not-ico=Das angegebene Symbol "{0}" ist keine ICO-Datei und wird nicht verwendet. Stattdessen wird das Standardsymbol verwendet.
6162
message.potential.windows.defender.issue=Warnung: Windows Defender verhindert eventuell die korrekte Ausführung von jpackage. Wenn ein Problem auftritt, deaktivieren Sie das Echtzeitmonitoring, oder fügen Sie einen Ausschluss für das Verzeichnis "{0}" hinzu.

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/resources/WinResources_ja.properties

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ error.lock-resource=ロックに失敗しました: {0}
5656
error.unlock-resource=ロック解除に失敗しました: {0}
5757
error.read-wix-l10n-file={0}ファイルの解析に失敗しました
5858
error.extract-culture-from-wix-l10n-file={0}ファイルからのカルチャの値の読取りに失敗しました
59+
error.short-path-conv-fail=Failed to get short version of "{0}" path
5960

6061
message.icon-not-ico=指定したアイコン"{0}"はICOファイルではなく、使用されません。デフォルト・アイコンがその位置に使用されます。
6162
message.potential.windows.defender.issue=警告: Windows Defenderが原因でjpackageが機能しないことがあります。問題が発生した場合は、リアルタイム・モニタリングを無効にするか、ディレクトリ"{0}"の除外を追加することにより、問題に対処できます。

‎src/jdk.jpackage/windows/classes/jdk/jpackage/internal/resources/WinResources_zh_CN.properties

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ error.lock-resource=无法锁定：{0}
5656
error.unlock-resource=无法解锁：{0}
5757
error.read-wix-l10n-file=无法解析 {0} 文件
5858
error.extract-culture-from-wix-l10n-file=无法从 {0} 文件读取文化值
59+
error.short-path-conv-fail=Failed to get short version of "{0}" path
5960

6061
message.icon-not-ico=指定的图标 "{0}" 不是 ICO 文件, 不会使用。将使用默认图标代替。
6162
message.potential.windows.defender.issue=警告：Windows Defender 可能会阻止 jpackage 正常工作。如果存在问题，可以通过禁用实时监视或者为目录 "{0}" 添加排除项来解决。

‎src/jdk.jpackage/windows/native/common/WinFileUtils.cpp

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2020, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -668,4 +668,23 @@ tstring stripExeSuffix(const tstring& path) {
668668
return path.substr(0, pos);
669669
}
670670

671+
tstring toShortPath(const tstring& path) {
672+
const DWORD len = GetShortPathName(path.c_str(), nullptr, 0);
673+
if (0 == len) {
674+
JP_THROW(SysError(tstrings::any() << "GetShortPathName("
675+
<< path << ") failed", GetShortPathName));
676+
}
677+
678+
std::vector<TCHAR> buf;
679+
buf.resize(len);
680+
const DWORD copied = GetShortPathName(path.c_str(), buf.data(),
681+
static_cast<DWORD>(buf.size()));
682+
if (copied != buf.size() - 1) {
683+
JP_THROW(SysError(tstrings::any() << "GetShortPathName("
684+
<< path << ") failed", GetShortPathName));
685+
}
686+
687+
return tstring(buf.data(), buf.size() - 1);
688+
}
689+
671690
} // namespace FileUtils

‎src/jdk.jpackage/windows/native/common/WinFileUtils.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2020, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -315,6 +315,8 @@ namespace FileUtils {
315315
std::ofstream tmp;
316316
tstring dstPath;
317317
};
318+
319+
tstring toShortPath(const tstring& path);
318320
} // FileUtils
319321

320322
#endif // WINFILEUTILS_H

‎src/jdk.jpackage/windows/native/libjpackage/jpackage.cpp

+23
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525

2626
#include "ResourceEditor.h"
2727
#include "ErrorHandling.h"
28+
#include "FileUtils.h"
29+
#include "WinFileUtils.h"
2830
#include "IconSwap.h"
2931
#include "VersionInfo.h"
3032
#include "JniUtils.h"
@@ -162,4 +164,25 @@ extern "C" {
162164
return 1;
163165
}
164166

167+
/*
168+
* Class: jdk_jpackage_internal_ShortPathUtils
169+
* Method: getShortPath
170+
* Signature: (Ljava/lang/String;)Ljava/lang/String;
171+
*/
172+
JNIEXPORT jstring JNICALL
173+
Java_jdk_jpackage_internal_ShortPathUtils_getShortPath(
174+
JNIEnv *pEnv, jclass c, jstring jLongPath) {
175+
176+
JP_TRY;
177+
178+
const std::wstring longPath = jni::toUnicodeString(pEnv, jLongPath);
179+
std::wstring shortPath = FileUtils::toShortPath(longPath);
180+
181+
return jni::toJString(pEnv, shortPath);
182+
183+
JP_CATCH_ALL;
184+
185+
return NULL;
186+
}
187+
165188
} // extern "C"

‎test/jdk/tools/jpackage/helpers/jdk/jpackage/test/Executor.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public static Executor of(String... cmdline) {
5353

5454
public Executor() {
5555
saveOutputType = new HashSet<>(Set.of(SaveOutputType.NONE));
56-
removePath = false;
56+
removePathEnvVar = false;
5757
}
5858

5959
public Executor setExecutable(String v) {
@@ -85,8 +85,8 @@ public Executor setExecutable(JavaTool v) {
8585
return setExecutable(v.getPath());
8686
}
8787

88-
public Executor setRemovePath(boolean value) {
89-
removePath = value;
88+
public Executor setRemovePathEnvVar(boolean value) {
89+
removePathEnvVar = value;
9090
return this;
9191
}
9292

@@ -348,7 +348,7 @@ private Result runExecutable() throws IOException, InterruptedException {
348348
builder.directory(directory.toFile());
349349
sb.append(String.format("; in directory [%s]", directory));
350350
}
351-
if (removePath) {
351+
if (removePathEnvVar) {
352352
// run this with cleared Path in Environment
353353
TKit.trace("Clearing PATH in environment");
354354
builder.environment().remove("PATH");
@@ -478,7 +478,7 @@ private static void trace(String msg) {
478478
private Path executable;
479479
private Set<SaveOutputType> saveOutputType;
480480
private Path directory;
481-
private boolean removePath;
481+
private boolean removePathEnvVar;
482482
private String winTmpDir = null;
483483

484484
private static enum SaveOutputType {

‎test/jdk/tools/jpackage/helpers/jdk/jpackage/test/HelloApp.java

+15-6
Original file line numberDiff line numberDiff line change
@@ -354,12 +354,12 @@ public static final class AppOutputVerifier {
354354

355355
if (TKit.isWindows()) {
356356
// When running app launchers on Windows, clear users environment (JDK-8254920)
357-
removePath(true);
357+
removePathEnvVar(true);
358358
}
359359
}
360360

361-
public AppOutputVerifier removePath(boolean v) {
362-
removePath = v;
361+
public AppOutputVerifier removePathEnvVar(boolean v) {
362+
removePathEnvVar = v;
363363
return this;
364364
}
365365

@@ -455,26 +455,35 @@ private Executor getExecutor(String...args) {
455455
Path outputFile = TKit.workDir().resolve(OUTPUT_FILENAME);
456456
ThrowingFunction.toFunction(Files::deleteIfExists).apply(outputFile);
457457

458-
final Path executablePath;
458+
Path executablePath;
459459
if (launcherPath.isAbsolute()) {
460460
executablePath = launcherPath;
461461
} else {
462462
// Make sure path to executable is relative to the current directory.
463463
executablePath = Path.of(".").resolve(launcherPath.normalize());
464464
}
465465

466+
if (TKit.isWindows()) {
467+
var absExecutablePath = executablePath.toAbsolutePath().normalize();
468+
var shortPath = WindowsHelper.toShortPath(absExecutablePath);
469+
if (shortPath.isPresent()) {
470+
TKit.trace(String.format("Will run [%s] as [%s]", executablePath, shortPath.get()));
471+
executablePath = shortPath.get();
472+
}
473+
}
474+
466475
final List<String> launcherArgs = List.of(args);
467476
return new Executor()
468477
.setDirectory(outputFile.getParent())
469478
.saveOutput(saveOutput)
470479
.dumpOutput()
471-
.setRemovePath(removePath)
480+
.setRemovePathEnvVar(removePathEnvVar)
472481
.setExecutable(executablePath)
473482
.addArguments(launcherArgs);
474483
}
475484

476485
private boolean launcherNoExit;
477-
private boolean removePath;
486+
private boolean removePathEnvVar;
478487
private boolean saveOutput;
479488
private final Path launcherPath;
480489
private Path outputFilePath;

‎test/jdk/tools/jpackage/helpers/jdk/jpackage/test/WindowsHelper.java

+83-2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
package jdk.jpackage.test;
2424

2525
import java.io.IOException;
26+
import java.lang.reflect.Method;
2627
import java.nio.file.Files;
2728
import java.nio.file.Path;
2829
import java.util.HashMap;
@@ -36,7 +37,9 @@
3637
import java.util.regex.Pattern;
3738
import java.util.stream.Collectors;
3839
import java.util.stream.Stream;
40+
import static jdk.jpackage.internal.util.function.ExceptionBox.rethrowUnchecked;
3941
import jdk.jpackage.internal.util.function.ThrowingRunnable;
42+
import static jdk.jpackage.internal.util.function.ThrowingSupplier.toSupplier;
4043
import jdk.jpackage.test.PackageTest.PackageHandlers;
4144

4245
public class WindowsHelper {
@@ -94,8 +97,9 @@ private static void runMsiexecWithRetries(Executor misexec) {
9497
static PackageHandlers createMsiPackageHandlers() {
9598
BiConsumer<JPackageCommand, Boolean> installMsi = (cmd, install) -> {
9699
cmd.verifyIsOfType(PackageType.WIN_MSI);
100+
var msiPath = TransientMsi.create(cmd).path();
97101
runMsiexecWithRetries(Executor.of("msiexec", "/qn", "/norestart",
98-
install ? "/i" : "/x").addArgument(cmd.outputBundle().normalize()));
102+
install ? "/i" : "/x").addArgument(msiPath));
99103
};
100104

101105
PackageHandlers msi = new PackageHandlers();
@@ -112,6 +116,8 @@ static PackageHandlers createMsiPackageHandlers() {
112116
TKit.removeRootFromAbsolutePath(
113117
getInstallationRootDirectory(cmd)));
114118

119+
final Path msiPath = TransientMsi.create(cmd).path();
120+
115121
// Put msiexec in .bat file because can't pass value of TARGETDIR
116122
// property containing spaces through ProcessBuilder properly.
117123
// Set folder permissions to allow msiexec unpack msi bundle.
@@ -121,7 +127,7 @@ static PackageHandlers createMsiPackageHandlers() {
121127
String.join(" ", List.of(
122128
"msiexec",
123129
"/a",
124-
String.format("\"%s\"", cmd.outputBundle().normalize()),
130+
String.format("\"%s\"", msiPath),
125131
"/qn",
126132
String.format("TARGETDIR=\"%s\"",
127133
unpackDir.toAbsolutePath().normalize())))));
@@ -155,6 +161,49 @@ static PackageHandlers createMsiPackageHandlers() {
155161
return msi;
156162
}
157163

164+
record TransientMsi(Path path) {
165+
static TransientMsi create(JPackageCommand cmd) {
166+
var outputMsiPath = cmd.outputBundle().normalize();
167+
if (isPathTooLong(outputMsiPath)) {
168+
return toSupplier(() -> {
169+
var transientMsiPath = TKit.createTempDirectory("msi-copy").resolve("a.msi").normalize();
170+
TKit.trace(String.format("Copy [%s] to [%s]", outputMsiPath, transientMsiPath));
171+
Files.copy(outputMsiPath, transientMsiPath);
172+
return new TransientMsi(transientMsiPath);
173+
}).get();
174+
} else {
175+
return new TransientMsi(outputMsiPath);
176+
}
177+
}
178+
}
179+
180+
public enum WixType {
181+
WIX3,
182+
WIX4
183+
}
184+
185+
public static WixType getWixTypeFromVerboseJPackageOutput(Executor.Result result) {
186+
return result.getOutput().stream().map(str -> {
187+
if (str.contains("[light.exe]")) {
188+
return WixType.WIX3;
189+
} else if (str.contains("[wix.exe]")) {
190+
return WixType.WIX4;
191+
} else {
192+
return null;
193+
}
194+
}).filter(Objects::nonNull).reduce((a, b) -> {
195+
throw new IllegalArgumentException("Invalid input: multiple invocations of WiX tools");
196+
}).orElseThrow(() -> new IllegalArgumentException("Invalid input: no invocations of WiX tools"));
197+
}
198+
199+
static Optional<Path> toShortPath(Path path) {
200+
if (isPathTooLong(path)) {
201+
return Optional.of(ShortPathUtils.toShortPath(path));
202+
} else {
203+
return Optional.empty();
204+
}
205+
}
206+
158207
static PackageHandlers createExePackageHandlers() {
159208
BiConsumer<JPackageCommand, Boolean> installExe = (cmd, install) -> {
160209
cmd.verifyIsOfType(PackageType.WIN_EXE);
@@ -303,6 +352,10 @@ private static boolean isUserLocalInstall(JPackageCommand cmd) {
303352
return cmd.hasArgument("--win-per-user-install");
304353
}
305354

355+
private static boolean isPathTooLong(Path path) {
356+
return path.toString().length() > WIN_MAX_PATH;
357+
}
358+
306359
private static class DesktopIntegrationVerifier {
307360

308361
DesktopIntegrationVerifier(JPackageCommand cmd, String launcherName) {
@@ -525,6 +578,32 @@ private static String queryRegistryValueCache(String keyPath,
525578
return value;
526579
}
527580

581+
private static final class ShortPathUtils {
582+
private ShortPathUtils() {
583+
try {
584+
var shortPathUtilsClass = Class.forName("jdk.jpackage.internal.ShortPathUtils");
585+
586+
getShortPathWrapper = shortPathUtilsClass.getDeclaredMethod(
587+
"getShortPathWrapper", String.class);
588+
// Note: this reflection call requires
589+
// --add-opens jdk.jpackage/jdk.jpackage.internal=ALL-UNNAMED
590+
getShortPathWrapper.setAccessible(true);
591+
} catch (ClassNotFoundException | NoSuchMethodException
592+
| SecurityException ex) {
593+
throw rethrowUnchecked(ex);
594+
}
595+
}
596+
597+
static Path toShortPath(Path path) {
598+
return Path.of(toSupplier(() -> (String) INSTANCE.getShortPathWrapper.invoke(
599+
null, path.toString())).get());
600+
}
601+
602+
private final Method getShortPathWrapper;
603+
604+
private static final ShortPathUtils INSTANCE = new ShortPathUtils();
605+
}
606+
528607
static final Set<Path> CRITICAL_RUNTIME_FILES = Set.of(Path.of(
529608
"bin\\server\\jvm.dll"));
530609

@@ -540,4 +619,6 @@ private static String queryRegistryValueCache(String keyPath,
540619
private static final String USER_SHELL_FOLDERS_REGKEY = "HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Shell Folders";
541620

542621
private static final Map<String, String> REGISTRY_VALUES = new HashMap<>();
622+
623+
private static final int WIN_MAX_PATH = 260;
543624
}

‎test/jdk/tools/jpackage/windows/WinL10nTest.java

+26-20
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@
3535
import java.util.stream.Collectors;
3636
import java.util.stream.Stream;
3737
import jdk.jpackage.test.Executor;
38+
import static jdk.jpackage.test.WindowsHelper.WixType.WIX3;
39+
import static jdk.jpackage.test.WindowsHelper.getWixTypeFromVerboseJPackageOutput;
3840

3941
/*
4042
* @test
@@ -109,13 +111,13 @@ public static List<Object[]> data() {
109111
});
110112
}
111113

112-
private static Stream<String> getBuildCommandLine(Executor.Result result) {
114+
private static Stream<String> getWixCommandLine(Executor.Result result) {
113115
return result.getOutput().stream().filter(createToolCommandLinePredicate("light").or(
114116
createToolCommandLinePredicate("wix")));
115117
}
116118

117119
private static boolean isWix3(Executor.Result result) {
118-
return result.getOutput().stream().anyMatch(createToolCommandLinePredicate("light"));
120+
return getWixTypeFromVerboseJPackageOutput(result) == WIX3;
119121
}
120122

121123
private final static Predicate<String> createToolCommandLinePredicate(String wixToolName) {
@@ -127,10 +129,10 @@ private final static Predicate<String> createToolCommandLinePredicate(String wix
127129
};
128130
}
129131

130-
private static List<TKit.TextStreamVerifier> createDefaultL10nFilesLocVerifiers(Path tempDir) {
132+
private static List<TKit.TextStreamVerifier> createDefaultL10nFilesLocVerifiers(Path wixSrcDir) {
131133
return Arrays.stream(DEFAULT_L10N_FILES).map(loc ->
132-
TKit.assertTextStream("-loc " + tempDir.resolve(
133-
String.format("config/MsiInstallerStrings_%s.wxl", loc)).normalize()))
134+
TKit.assertTextStream("-loc " + wixSrcDir.resolve(
135+
String.format("MsiInstallerStrings_%s.wxl", loc))))
134136
.toList();
135137
}
136138

@@ -183,16 +185,20 @@ public void test() throws IOException {
183185
cmd.addArguments("--temp", tempDir);
184186
})
185187
.addBundleVerifier((cmd, result) -> {
188+
final List<String> wixCmdline = getWixCommandLine(result).toList();
189+
190+
final var isWix3 = isWix3(result);
191+
186192
if (expectedCultures != null) {
187193
String expected;
188-
if (isWix3(result)) {
194+
if (isWix3) {
189195
expected = "-cultures:" + String.join(";", expectedCultures);
190196
} else {
191197
expected = Stream.of(expectedCultures).map(culture -> {
192198
return String.join(" ", "-culture", culture);
193199
}).collect(Collectors.joining(" "));
194200
}
195-
TKit.assertTextStream(expected).apply(getBuildCommandLine(result));
201+
TKit.assertTextStream(expected).apply(wixCmdline.stream());
196202
}
197203

198204
if (expectedErrorMessage != null) {
@@ -201,25 +207,27 @@ public void test() throws IOException {
201207
}
202208

203209
if (wxlFileInitializers != null) {
204-
var wixSrcDir = Path.of(cmd.getArgumentValue("--temp")).resolve("config");
210+
var wixSrcDir = Path.of(cmd.getArgumentValue("--temp")).resolve(
211+
"config").normalize().toAbsolutePath();
205212

206213
if (allWxlFilesValid) {
207214
for (var v : wxlFileInitializers) {
208215
if (!v.name.startsWith("MsiInstallerStrings_")) {
209-
v.createCmdOutputVerifier(wixSrcDir).apply(getBuildCommandLine(result));
216+
v.createCmdOutputVerifier(wixSrcDir).apply(wixCmdline.stream());
210217
}
211218
}
212-
var tempDir = Path.of(cmd.getArgumentValue("--temp")).toAbsolutePath();
213-
for (var v : createDefaultL10nFilesLocVerifiers(tempDir)) {
214-
v.apply(getBuildCommandLine(result));
219+
220+
for (var v : createDefaultL10nFilesLocVerifiers(wixSrcDir)) {
221+
v.apply(wixCmdline.stream());
215222
}
216223
} else {
217224
Stream.of(wxlFileInitializers)
218225
.filter(Predicate.not(WixFileInitializer::isValid))
219226
.forEach(v -> v.createCmdOutputVerifier(
220227
wixSrcDir).apply(result.getOutput().stream()));
221-
TKit.assertFalse(getBuildCommandLine(result).findAny().isPresent(),
222-
"Check light.exe was not invoked");
228+
TKit.assertTrue(wixCmdline.stream().findAny().isEmpty(),
229+
String.format("Check %s.exe was not invoked",
230+
isWix3 ? "light" : "wix"));
223231
}
224232
}
225233
});
@@ -276,10 +284,9 @@ boolean isValid() {
276284
}
277285

278286
@Override
279-
TKit.TextStreamVerifier createCmdOutputVerifier(Path root) {
287+
TKit.TextStreamVerifier createCmdOutputVerifier(Path wixSrcDir) {
280288
return TKit.assertTextStream(String.format(
281-
"Failed to parse %s file",
282-
root.resolve("b.wxl").toAbsolutePath()));
289+
"Failed to parse %s file", wixSrcDir.resolve("b.wxl")));
283290
}
284291
};
285292
}
@@ -297,9 +304,8 @@ void apply(Path root) throws IOException {
297304
+ "\" xmlns=\"http://schemas.microsoft.com/wix/2006/localization\" Codepage=\"1252\"/>"));
298305
}
299306

300-
TKit.TextStreamVerifier createCmdOutputVerifier(Path root) {
301-
return TKit.assertTextStream(
302-
"-loc " + root.resolve(name).toAbsolutePath().normalize());
307+
TKit.TextStreamVerifier createCmdOutputVerifier(Path wixSrcDir) {
308+
return TKit.assertTextStream("-loc " + wixSrcDir.resolve(name));
303309
}
304310

305311
boolean isValid() {

‎test/jdk/tools/jpackage/windows/WinLongPathTest.java

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
/*
2+
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
import java.io.IOException;
25+
import java.nio.file.Files;
26+
import java.nio.file.Path;
27+
import java.util.ArrayList;
28+
import java.util.List;
29+
import jdk.jpackage.test.Annotations.Parameters;
30+
import jdk.jpackage.test.PackageTest;
31+
import jdk.jpackage.test.PackageType;
32+
import jdk.jpackage.test.Annotations.Test;
33+
import jdk.jpackage.test.JPackageCommand;
34+
import jdk.jpackage.test.RunnablePackageTest.Action;
35+
import jdk.jpackage.test.TKit;
36+
37+
/*
38+
/* @test
39+
* @bug 8289771
40+
* @summary jpackage with long paths on windows
41+
* @library /test/jdk/tools/jpackage/helpers
42+
* @key jpackagePlatformPackage
43+
* @build jdk.jpackage.test.*
44+
* @requires (os.family == "windows")
45+
* @compile WinLongPathTest.java
46+
* @run main/othervm/timeout=540 -Xmx512m jdk.jpackage.test.Main
47+
* --jpt-space-subst=*
48+
* --jpt-exclude=WinLongPathTest(false,*--temp)
49+
* --jpt-run=WinLongPathTest
50+
*/
51+
52+
public record WinLongPathTest(Boolean appImage, String optionName) {
53+
54+
@Parameters
55+
public static List<Object[]> input() {
56+
List<Object[]> data = new ArrayList<>();
57+
for (var appImage : List.of(Boolean.TRUE, Boolean.FALSE)) {
58+
for (var option : List.of("--dest", "--temp")) {
59+
data.add(new Object[]{appImage, option});
60+
}
61+
}
62+
return data;
63+
}
64+
65+
@Test
66+
public void test() throws IOException {
67+
if (appImage) {
68+
var cmd = JPackageCommand.helloAppImage();
69+
setOptionLongPath(cmd, optionName);
70+
cmd.executeAndAssertHelloAppImageCreated();
71+
} else {
72+
new PackageTest()
73+
.forTypes(PackageType.WINDOWS)
74+
.configureHelloApp()
75+
.addInitializer(cmd -> setOptionLongPath(cmd, optionName))
76+
.run(Action.CREATE_AND_UNPACK);
77+
}
78+
}
79+
80+
private static void setOptionLongPath(JPackageCommand cmd, String option) throws IOException {
81+
var root = TKit.createTempDirectory("long-path");
82+
// 261 characters in total, which alone is above the 260 threshold
83+
var longPath = root.resolve(Path.of("a".repeat(80), "b".repeat(90), "c".repeat(91)));
84+
Files.createDirectories(longPath);
85+
cmd.setArgumentValue(option, longPath);
86+
}
87+
}

0 commit comments

Comments
 (0)
Please sign in to comment.