46680
|
1 |
/*
|
|
2 |
* Copyright (c) 2016, 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 |
package org.graalvm.compiler.debug;
|
|
24 |
|
47798
|
25 |
import java.io.File;
|
46680
|
26 |
import java.io.IOException;
|
47798
|
27 |
import java.nio.file.FileAlreadyExistsException;
|
|
28 |
import java.nio.file.Files;
|
46680
|
29 |
import java.nio.file.InvalidPathException;
|
|
30 |
import java.nio.file.Path;
|
|
31 |
import java.nio.file.Paths;
|
|
32 |
|
|
33 |
import org.graalvm.compiler.options.OptionKey;
|
|
34 |
import org.graalvm.compiler.options.OptionValues;
|
|
35 |
|
|
36 |
/**
|
|
37 |
* Miscellaneous methods for modifying and generating file system paths.
|
|
38 |
*/
|
|
39 |
public class PathUtilities {
|
|
40 |
|
|
41 |
/**
|
|
42 |
* Gets a value based on {@code name} that can be passed to {@link Paths#get(String, String...)}
|
|
43 |
* without causing an {@link InvalidPathException}.
|
|
44 |
*
|
|
45 |
* @return {@code name} with all characters invalid for the current file system replaced by
|
|
46 |
* {@code '_'}
|
|
47 |
*/
|
|
48 |
public static String sanitizeFileName(String name) {
|
|
49 |
try {
|
47798
|
50 |
Path path = Paths.get(name);
|
|
51 |
if (path.getNameCount() == 0) {
|
|
52 |
return name;
|
|
53 |
}
|
46680
|
54 |
} catch (InvalidPathException e) {
|
|
55 |
// fall through
|
|
56 |
}
|
|
57 |
StringBuilder buf = new StringBuilder(name.length());
|
|
58 |
for (int i = 0; i < name.length(); i++) {
|
|
59 |
char c = name.charAt(i);
|
47798
|
60 |
if (c != File.separatorChar && c != ' ' && !Character.isISOControl(c)) {
|
|
61 |
try {
|
|
62 |
Paths.get(String.valueOf(c));
|
|
63 |
buf.append(c);
|
|
64 |
continue;
|
|
65 |
} catch (InvalidPathException e) {
|
|
66 |
}
|
46680
|
67 |
}
|
47798
|
68 |
buf.append('_');
|
46680
|
69 |
}
|
|
70 |
return buf.toString();
|
|
71 |
}
|
47798
|
72 |
|
|
73 |
/**
|
|
74 |
* A maximum file name length supported by most file systems. There is no platform independent
|
|
75 |
* way to get this in Java.
|
|
76 |
*/
|
|
77 |
private static final int MAX_FILE_NAME_LENGTH = 255;
|
|
78 |
|
|
79 |
private static final String ELLIPSIS = "...";
|
|
80 |
|
|
81 |
static Path createUnique(OptionValues options, OptionKey<String> baseNameOption, String id, String label, String ext, boolean createDirectory) throws IOException {
|
|
82 |
String uniqueTag = "";
|
|
83 |
int dumpCounter = 1;
|
|
84 |
String prefix;
|
|
85 |
if (id == null) {
|
|
86 |
prefix = baseNameOption.getValue(options);
|
|
87 |
int slash = prefix.lastIndexOf(File.separatorChar);
|
|
88 |
prefix = prefix.substring(slash + 1);
|
|
89 |
} else {
|
|
90 |
prefix = id;
|
|
91 |
}
|
|
92 |
for (;;) {
|
|
93 |
int fileNameLengthWithoutLabel = uniqueTag.length() + ext.length() + prefix.length() + "[]".length();
|
|
94 |
int labelLengthLimit = MAX_FILE_NAME_LENGTH - fileNameLengthWithoutLabel;
|
|
95 |
String fileName;
|
|
96 |
if (labelLengthLimit < ELLIPSIS.length()) {
|
|
97 |
// This means `id` is very long
|
|
98 |
String suffix = uniqueTag + ext;
|
|
99 |
int idLengthLimit = Math.min(MAX_FILE_NAME_LENGTH - suffix.length(), prefix.length());
|
|
100 |
fileName = sanitizeFileName(prefix.substring(0, idLengthLimit) + suffix);
|
|
101 |
} else {
|
|
102 |
if (label == null) {
|
|
103 |
fileName = sanitizeFileName(prefix + uniqueTag + ext);
|
|
104 |
} else {
|
|
105 |
String adjustedLabel = label;
|
|
106 |
if (label.length() > labelLengthLimit) {
|
|
107 |
adjustedLabel = label.substring(0, labelLengthLimit - ELLIPSIS.length()) + ELLIPSIS;
|
|
108 |
}
|
|
109 |
fileName = sanitizeFileName(prefix + '[' + adjustedLabel + ']' + uniqueTag + ext);
|
|
110 |
}
|
|
111 |
}
|
|
112 |
Path dumpDir = DebugOptions.getDumpDirectory(options);
|
|
113 |
Path result = Paths.get(dumpDir.toString(), fileName);
|
|
114 |
try {
|
|
115 |
if (createDirectory) {
|
|
116 |
return Files.createDirectory(result);
|
|
117 |
} else {
|
|
118 |
return Files.createFile(result);
|
|
119 |
}
|
|
120 |
} catch (FileAlreadyExistsException e) {
|
|
121 |
uniqueTag = "_" + dumpCounter++;
|
|
122 |
}
|
|
123 |
}
|
|
124 |
}
|
|
125 |
|
46680
|
126 |
}
|