-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
GFileUtils.java
428 lines (381 loc) · 13.9 KB
/
GFileUtils.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
/*
* Copyright 2010 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.util;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;
import org.gradle.api.UncheckedIOException;
import org.gradle.internal.IoActions;
import org.gradle.internal.deprecation.DeprecationLogger;
import org.gradle.util.internal.CollectionUtils;
import org.gradle.util.internal.LimitedDescription;
import javax.annotation.Nullable;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.attribute.FileTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.zip.Checksum;
/**
* This class is only here to maintain binary compatibility with existing plugins.
* <p>
* Plugins should prefer java.io, java.nio or external packages over this class.
*
* @deprecated Will be removed in Gradle 9.0.
*/
@Deprecated
public class GFileUtils {
private static void logDeprecation() {
DeprecationLogger.deprecateType(GFileUtils.class)
.willBeRemovedInGradle9()
.withUpgradeGuideSection(7, "org_gradle_util_reports_deprecations")
.nagUser();
}
public GFileUtils() {
logDeprecation();
}
public static FileInputStream openInputStream(File file) {
logDeprecation();
try {
return FileUtils.openInputStream(file);
} catch (IOException e) {
throw new RuntimeException("Problems opening file input stream for file: " + file, e);
}
}
/**
* Ensures that the given file (or directory) is marked as modified. If the file
* (or directory) does not exist, a new file is created.
*/
public static void touch(File file) {
logDeprecation();
try {
if (!file.createNewFile()) {
touchExistingInternal(file);
}
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
/**
* Ensures that the given file (or directory) is marked as modified. The file
* (or directory) must exist.
*/
public static void touchExisting(File file) {
logDeprecation();
touchExistingInternal(file);
}
private static void touchExistingInternal(File file) {
try {
Files.setLastModifiedTime(file.toPath(), FileTime.fromMillis(System.currentTimeMillis()));
} catch (IOException e) {
if (file.isFile() && file.length() == 0) {
// On Linux, users cannot touch files they don't own but have write access to
// because the JDK uses futimes() instead of futimens() [note the 'n'!]
// see https://github.com/gradle/gradle/issues/7873
touchFileByWritingEmptyByteArray(file);
} else {
throw new UncheckedIOException("Could not update timestamp for " + file, e);
}
}
}
private static void touchFileByWritingEmptyByteArray(File file) {
FileOutputStream out = null;
try {
out = new FileOutputStream(file);
out.write(ArrayUtils.EMPTY_BYTE_ARRAY);
} catch (IOException e) {
throw new UncheckedIOException("Could not update timestamp for " + file, e);
} finally {
IoActions.closeQuietly(out);
}
}
public static void moveFile(File source, File destination) {
logDeprecation();
moveFileInternal(source, destination);
}
private static void moveFileInternal(File source, File destination) {
try {
FileUtils.moveFile(source, destination);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public static void moveExistingFile(File source, File destination) {
logDeprecation();
boolean rename = source.renameTo(destination);
if (!rename) {
moveFileInternal(source, destination);
}
}
/**
* If the destination file exists, then this method will overwrite it.
*
* @see FileUtils#copyFile(File, File)
*/
public static void copyFile(File source, File destination) {
logDeprecation();
try {
FileUtils.copyFile(source, destination);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public static void copyDirectory(File source, File destination) {
logDeprecation();
try {
FileUtils.copyDirectory(source, destination);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public static void moveDirectory(File source, File destination) {
logDeprecation();
moveDirectoryInternal(source, destination);
}
private static void moveDirectoryInternal(File source, File destination) {
try {
FileUtils.moveDirectory(source, destination);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public static void moveExistingDirectory(File source, File destination) {
logDeprecation();
boolean rename = source.renameTo(destination);
if (!rename) {
moveDirectory(source, destination);
}
}
public static String readFile(File file) {
return readFile(file, Charset.defaultCharset().name());
}
public static String readFile(File file, String encoding) {
logDeprecation();
try {
return FileUtils.readFileToString(file, encoding);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
/**
* Reads and returns file contents. If some exception is triggered the method returns information about this exception.
* Useful for including file contents in debug trace / exception messages.
*
* @param file to read
* @return content of the file or the problem description in case file cannot be read.
*/
public static String readFileQuietly(File file) {
try {
return readFile(file);
} catch (Exception e) {
return "Unable to read file '" + file + "' due to: " + e.toString();
}
}
public static void writeFile(String content, File destination) {
writeFile(content, destination, Charset.defaultCharset().name());
}
public static void writeFile(String content, File destination, String encoding) {
logDeprecation();
try {
FileUtils.writeStringToFile(destination, content, encoding);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public static Collection<File> listFiles(File directory, String[] extensions, boolean recursive) {
logDeprecation();
return FileUtils.listFiles(directory, extensions, recursive);
}
public static List<String> toPaths(Collection<File> files) {
logDeprecation();
List<String> paths = new ArrayList<String>();
for (File file : files) {
paths.add(file.getAbsolutePath());
}
return paths;
}
public static void copyURLToFile(URL source, File destination) {
logDeprecation();
try {
FileUtils.copyURLToFile(source, destination);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public static void deleteDirectory(File directory) {
logDeprecation();
try {
FileUtils.deleteDirectory(directory);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public static boolean deleteQuietly(@Nullable File file) {
logDeprecation();
return FileUtils.deleteQuietly(file);
}
/**
* Tail reading exception.
*/
@Deprecated
public static class TailReadingException extends RuntimeException {
public TailReadingException(Throwable throwable) {
this(throwable, true);
}
private TailReadingException(Throwable throwable, boolean logDeprecation) {
super(throwable);
if (logDeprecation) {
logDeprecation();
}
}
}
/**
* Returns the tail of a file.
*
* @param file to read from tail
* @param maxLines max lines to read
* @return tail content
* @throws org.gradle.util.GFileUtils.TailReadingException when reading failed
*/
public static String tail(File file, int maxLines) throws TailReadingException {
logDeprecation();
BufferedReader reader = null;
FileReader fileReader = null;
try {
fileReader = new FileReader(file);
reader = new BufferedReader(fileReader);
LimitedDescription description = new LimitedDescription(maxLines);
String line = reader.readLine();
while (line != null) {
description.append(line);
line = reader.readLine();
}
return description.toString();
} catch (Exception e) {
throw new TailReadingException(e, false);
} finally {
IoActions.closeQuietly(fileReader);
IoActions.closeQuietly(reader);
}
}
public static void forceDelete(File file) {
logDeprecation();
try {
FileUtils.forceDelete(file);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public static Checksum checksum(File file, Checksum checksum) {
logDeprecation();
try {
return FileUtils.checksum(file, checksum);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
/**
* Makes the parent directory of the file, and any non existent parents.
*
* @param child The file to create the parent dir for
* @return The parent dir file
* @see #mkdirs(java.io.File)
*/
public static File parentMkdirs(File child) {
File parent = child.getParentFile();
mkdirs(parent);
return parent;
}
/**
* Like {@link java.io.File#mkdirs()}, except throws an informative error if a dir cannot be created.
*
* @param dir The dir to create, including any non existent parent dirs.
*/
public static void mkdirs(File dir) {
logDeprecation();
dir = dir.getAbsoluteFile();
if (dir.isDirectory()) {
return;
}
if (dir.exists() && !dir.isDirectory()) {
throw new UncheckedIOException(String.format("Cannot create directory '%s' as it already exists, but is not a directory", dir));
}
List<File> toCreate = new LinkedList<File>();
File parent = dir.getParentFile();
while (!parent.exists()) {
toCreate.add(parent);
parent = parent.getParentFile();
}
Collections.reverse(toCreate);
for (File parentDirToCreate : toCreate) {
if (parentDirToCreate.isDirectory()) {
continue;
}
File parentDirToCreateParent = parentDirToCreate.getParentFile();
if (!parentDirToCreateParent.isDirectory()) {
throw new UncheckedIOException(String.format("Cannot create parent directory '%s' when creating directory '%s' as '%s' is not a directory", parentDirToCreate, dir, parentDirToCreateParent));
}
if (!parentDirToCreate.mkdir() && !parentDirToCreate.isDirectory()) {
throw new UncheckedIOException(String.format("Failed to create parent directory '%s' when creating directory '%s'", parentDirToCreate, dir));
}
}
if (!dir.mkdir() && !dir.isDirectory()) {
throw new UncheckedIOException(String.format("Failed to create directory '%s'", dir));
}
}
/**
* Returns the path of target relative to base.
*
* @param target target file or directory
* @param base base directory
* @return the path of target relative to base.
*/
public static String relativePathOf(File target, File base) {
logDeprecation();
String separatorChars = "/" + File.separator;
List<String> basePath = splitAbsolutePathOf(base, separatorChars);
List<String> targetPath = new ArrayList<String>(splitAbsolutePathOf(target, separatorChars));
// Find and remove common prefix
int maxDepth = Math.min(basePath.size(), targetPath.size());
int prefixLen = 0;
while (prefixLen < maxDepth && basePath.get(prefixLen).equals(targetPath.get(prefixLen))) {
prefixLen++;
}
basePath = basePath.subList(prefixLen, basePath.size());
targetPath = targetPath.subList(prefixLen, targetPath.size());
for (int i = 0; i < basePath.size(); i++) {
targetPath.add(0, "..");
}
if (targetPath.isEmpty()) {
return ".";
}
return CollectionUtils.join(File.separator, targetPath);
}
private static List<String> splitAbsolutePathOf(File baseDir, String separatorChars) {
return Arrays.asList(StringUtils.split(baseDir.getAbsolutePath(), separatorChars));
}
}