-
Notifications
You must be signed in to change notification settings - Fork 38
/
FileUtils.java
1988 lines (1760 loc) · 71.1 KB
/
FileUtils.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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package org.codehaus.plexus.util;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.codehaus.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact codehaus@codehaus.org.
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.codehaus.org/>.
*
*/
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.Writer;
import java.net.URL;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;
import java.security.SecureRandom;
import java.text.DecimalFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Random;
import org.codehaus.plexus.util.io.InputStreamFacade;
import org.codehaus.plexus.util.io.URLInputStreamFacade;
/**
* <p>This class provides basic facilities for manipulating files and file paths.</p>
*
* <b>Path-related methods</b>
*
* <p>Methods exist to retrieve the components of a typical file path. For example
* <code>/www/hosted/mysite/index.html</code>, can be broken into:
* <ul>
* <li><code>/www/hosted/mysite/</code> -- retrievable through {@link #getPath}</li>
* <li><code>index.html</code> -- retrievable through {@link #removePath}</li>
* <li><code>/www/hosted/mysite/index</code> -- retrievable through {@link #removeExtension}</li>
* <li><code>html</code> -- retrievable through {@link #getExtension}</li>
* </ul>
* <p>There are also methods to {@link #catPath concatenate two paths}, {@link #resolveFile resolve a path relative to a
* File} and {@link #normalize} a path.</p>
*
* <b>File-related methods</b>
*
* <p>There are methods to create a {@link #toFile File from a URL}, copy a {@link #copyFileToDirectory File to a
* directory}, copy a {@link #copyFile File to another File}, copy a {@link #copyURLToFile URL's contents to a File}, as
* well as methods to {@link #deleteDirectory(File) delete} and {@link #cleanDirectory(File) clean} a directory.</p>
*
* <p>Common {@link java.io.File} manipulation routines.</p>
*
* <p>Taken from the commons-utils repo. Also code from Alexandria's FileUtils. And from Avalon Excalibur's IO. And from
* Ant.</p>
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</A>
* @author <a href="mailto:sanders@codehaus.org">Scott Sanders</a>
* @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
* @author <a href="mailto:Christoph.Reck@dlr.de">Christoph.Reck</a>
* @author <a href="mailto:peter@codehaus.org">Peter Donald</a>
* @author <a href="mailto:jefft@codehaus.org">Jeff Turner</a>
*
*/
public class FileUtils extends BaseFileUtils {
/**
* The number of bytes in a kilobyte.
*/
public static final int ONE_KB = 1024;
/**
* The number of bytes in a megabyte.
*/
public static final int ONE_MB = ONE_KB * ONE_KB;
/**
* The number of bytes in a gigabyte.
*/
public static final int ONE_GB = ONE_KB * ONE_MB;
/**
* The vm file separator
*/
public static String FS = File.separator;
/**
* Non-valid Characters for naming files, folders under Windows: <code>":", "*", "?", "\"", "<", ">", "|"</code>
*
* @see <a href="http://support.microsoft.com/?scid=kb%3Ben-us%3B177506&x=12&y=13">
* http://support.microsoft.com/?scid=kb%3Ben-us%3B177506&x=12&y=13</a>
*/
private static final String[] INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME = {":", "*", "?", "\"", "<", ">", "|"};
/**
* @return the default excludes pattern
* @see DirectoryScanner#DEFAULTEXCLUDES
*/
public static String[] getDefaultExcludes() {
return DirectoryScanner.DEFAULTEXCLUDES;
}
/**
* @return the default excludes pattern as list.
* @see #getDefaultExcludes()
*/
public static List<String> getDefaultExcludesAsList() {
return Arrays.asList(getDefaultExcludes());
}
/**
* @return the default excludes pattern as comma separated string.
* @see DirectoryScanner#DEFAULTEXCLUDES
* @see StringUtils#join(Object[], String)
*/
public static String getDefaultExcludesAsString() {
return StringUtils.join(DirectoryScanner.DEFAULTEXCLUDES, ",");
}
/**
* Returns a human-readable version of the file size (original is in bytes).
*
* @param size The number of bytes.
* @return A human-readable display value (includes units).
*/
public static String byteCountToDisplaySize(int size) {
String displaySize;
if (size / ONE_GB > 0) {
displaySize = String.valueOf(size / ONE_GB) + " GB";
} else if (size / ONE_MB > 0) {
displaySize = String.valueOf(size / ONE_MB) + " MB";
} else if (size / ONE_KB > 0) {
displaySize = String.valueOf(size / ONE_KB) + " KB";
} else {
displaySize = String.valueOf(size) + " bytes";
}
return displaySize;
}
/**
* Returns the directory path portion of a file specification string. Matches the equally named unix command.
*
* @param filename the file path
* @return The directory portion excluding the ending file separator.
*/
public static String dirname(String filename) {
int i = filename.lastIndexOf(File.separator);
return (i >= 0 ? filename.substring(0, i) : "");
}
/**
* Returns the filename portion of a file specification string.
*
* @param filename the file path
* @return The filename string with extension.
*/
public static String filename(String filename) {
int i = filename.lastIndexOf(File.separator);
return (i >= 0 ? filename.substring(i + 1) : filename);
}
/**
* Returns the filename portion of a file specification string. Matches the equally named unix command.
*
* @param filename the file path
* @return The filename string without extension.
*/
public static String basename(String filename) {
return basename(filename, extension(filename));
}
/**
* Returns the filename portion of a file specification string. Matches the equally named unix command.
*
* @param filename the file path
* @param suffix the file suffix
* @return the basename of the file
*/
public static String basename(String filename, String suffix) {
int i = filename.lastIndexOf(File.separator) + 1;
int lastDot = ((suffix != null) && (suffix.length() > 0)) ? filename.lastIndexOf(suffix) : -1;
if (lastDot >= 0) {
return filename.substring(i, lastDot);
} else if (i > 0) {
return filename.substring(i);
} else {
return filename; // else returns all (no path and no extension)
}
}
/**
* Returns the extension portion of a file specification string. This everything after the last dot '.' in the
* filename (NOT including the dot).
*
* @param filename the file path
* @return the extension of the file
*/
public static String extension(String filename) {
// Ensure the last dot is after the last file separator
int lastSep = filename.lastIndexOf(File.separatorChar);
int lastDot;
if (lastSep < 0) {
lastDot = filename.lastIndexOf('.');
} else {
lastDot = filename.substring(lastSep + 1).lastIndexOf('.');
if (lastDot >= 0) {
lastDot += lastSep + 1;
}
}
if (lastDot >= 0 && lastDot > lastSep) {
return filename.substring(lastDot + 1);
}
return "";
}
/**
* Check if a file exits.
*
* @param fileName the file path.
* @return true if file exists.
*/
public static boolean fileExists(String fileName) {
File file = new File(fileName);
return file.exists();
}
/**
* Note: the file content is read with platform encoding.
*
* @param file the file path
* @return the file content using the platform encoding.
* @throws IOException if any
*/
public static String fileRead(String file) throws IOException {
return fileRead(file, null);
}
/**
* @param file the file path
* @param encoding the wanted encoding
* @return the file content using the specified encoding.
* @throws IOException if any
*/
public static String fileRead(String file, String encoding) throws IOException {
return fileRead(Paths.get(file), encoding);
}
/**
* Note: the file content is read with platform encoding
*
* @param file the file path
* @return the file content using the platform encoding.
* @throws IOException if any
*/
public static String fileRead(File file) throws IOException {
return fileRead(file, null);
}
/**
* @param file the file path
* @param encoding the wanted encoding
* @return the file content using the specified encoding.
* @throws IOException if any
*/
public static String fileRead(File file, String encoding) throws IOException {
return fileRead(file.toPath(), encoding);
}
/**
* Appends data to a file. The file will be created if it does not exist. Note: the data is written with platform
* encoding
*
* @param fileName The path of the file to write.
* @param data The content to write to the file.
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(filename, data.getBytes(encoding),
* StandardOpenOption.APPEND, StandardOpenOption.CREATE)}
*/
public static void fileAppend(String fileName, String data) throws IOException {
fileAppend(fileName, null, data);
}
/**
* Appends data to a file. The file will be created if it does not exist.
*
* @param fileName The path of the file to write.
* @param encoding The encoding of the file.
* @param data The content to write to the file.
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(filename, data.getBytes(encoding),
* StandardOpenOption.APPEND, StandardOpenOption.CREATE)}
*/
public static void fileAppend(String fileName, String encoding, String data) throws IOException {
fileAppend(Paths.get(fileName), encoding, data);
}
private static void fileAppend(Path path, String encoding, String data) throws IOException {
fileWrite(path, encoding, data, StandardOpenOption.APPEND, StandardOpenOption.CREATE);
}
/**
* Writes data to a file. The file will be created if it does not exist. Note: the data is written with platform
* encoding
*
* @param fileName The path of the file to write.
* @param data The content to write to the file.
* @throws IOException if any
*/
public static void fileWrite(String fileName, String data) throws IOException {
fileWrite(fileName, null, data);
}
/**
* Writes data to a file. The file will be created if it does not exist.
*
* @param fileName The path of the file to write.
* @param encoding The encoding of the file.
* @param data The content to write to the file.
* @throws IOException if any
*/
public static void fileWrite(String fileName, String encoding, String data) throws IOException {
Path file = (fileName == null) ? null : Paths.get(fileName);
fileWrite(file, encoding, data);
}
/**
* Writes data to a file. The file will be created if it does not exist. Note: the data is written with platform
* encoding
*
* @param file The file to write.
* @param data The content to write to the file.
* @throws IOException if any
* @since 2.0.6
*/
public static void fileWrite(File file, String data) throws IOException {
fileWrite(file, null, data);
}
/**
* Writes data to a file. The file will be created if it does not exist.
*
* @param file The file to write.
* @param encoding The encoding of the file.
* @param data The content to write to the file.
* @throws IOException if any
* @since 2.0.6
*/
public static void fileWrite(File file, String encoding, String data) throws IOException {
fileWrite(file.toPath(), encoding, data);
}
/**
* Deletes a file.
*
* @param fileName The path of the file to delete.
*/
public static void fileDelete(String fileName) {
File file = new File(fileName);
try {
NioFiles.deleteIfExists(file);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
/**
* Waits for NFS to propagate a file creation, imposing a timeout.
*
* @param fileName The path of the file.
* @param seconds The maximum time in seconds to wait.
* @return True if file exists.
*/
public static boolean waitFor(String fileName, int seconds) {
return waitFor(new File(fileName), seconds);
}
/**
* Waits for NFS to propagate a file creation, imposing a timeout.
*
* @param file The file.
* @param seconds The maximum time in seconds to wait.
* @return True if file exists.
*/
public static boolean waitFor(File file, int seconds) {
int timeout = 0;
int tick = 0;
while (!file.exists()) {
if (tick++ >= 10) {
tick = 0;
if (timeout++ > seconds) {
return false;
}
}
try {
Thread.sleep(100);
} catch (InterruptedException ignore) {
// nop
}
}
return true;
}
/**
* Creates a file handle.
*
* @param fileName The path of the file.
* @return A <code>File</code> manager.
*/
public static File getFile(String fileName) {
return new File(fileName);
}
/**
* <p>Given a directory and an array of extensions return an array of compliant files.</p>
*
* <p>TODO Should an ignore list be passed in? TODO Should a recurse flag be passed in?</p>
*
* <p>The given extensions should be like "java" and not like ".java"</p>
*
* @param directory The path of the directory.
* @param extensions an array of expected extensions.
* @return An array of files for the wanted extensions.
*/
public static String[] getFilesFromExtension(String directory, String[] extensions) {
List<String> files = new ArrayList<String>();
File currentDir = new File(directory);
String[] unknownFiles = currentDir.list();
if (unknownFiles == null) {
return new String[0];
}
for (String unknownFile : unknownFiles) {
String currentFileName = directory + System.getProperty("file.separator") + unknownFile;
File currentFile = new File(currentFileName);
if (currentFile.isDirectory()) {
// ignore all CVS directories...
if (currentFile.getName().equals("CVS")) {
continue;
}
// ok... transverse into this directory and get all the files... then combine
// them with the current list.
String[] fetchFiles = getFilesFromExtension(currentFileName, extensions);
files = blendFilesToVector(files, fetchFiles);
} else {
// ok... add the file
String add = currentFile.getAbsolutePath();
if (isValidFile(add, extensions)) {
files.add(add);
}
}
}
// ok... move the Vector into the files list...
return files.toArray(new String[0]);
}
/**
* Private helper method for getFilesFromExtension()
*/
private static List<String> blendFilesToVector(List<String> v, String[] files) {
for (String file : files) {
v.add(file);
}
return v;
}
/**
* Checks to see if a file is of a particular type(s). Note that if the file does not have an extension, an empty
* string ("") is matched for.
*/
private static boolean isValidFile(String file, String[] extensions) {
String extension = extension(file);
if (extension == null) {
extension = "";
}
// ok.. now that we have the "extension" go through the current know
// excepted extensions and determine if this one is OK.
for (String extension1 : extensions) {
if (extension1.equals(extension)) {
return true;
}
}
return false;
}
/**
* Simple way to make a directory
*
* @param dir the directory to create
* @throws IllegalArgumentException if the dir contains illegal Windows characters under Windows OS.
* @see #INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME
*/
public static void mkdir(String dir) {
File file = new File(dir);
if (Os.isFamily(Os.FAMILY_WINDOWS) && !isValidWindowsFileName(file)) {
throw new IllegalArgumentException("The file (" + dir
+ ") cannot contain any of the following characters: \n"
+ StringUtils.join(INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME, " "));
}
if (!file.exists()) {
file.mkdirs();
}
}
/**
* Compare the contents of two files to determine if they are equal or not.
*
* @param file1 the first file
* @param file2 the second file
* @return true if the content of the files are equal or they both don't exist, false otherwise
* @throws IOException if any
*/
public static boolean contentEquals(final File file1, final File file2) throws IOException {
final boolean file1Exists = file1.exists();
if (file1Exists != file2.exists()) {
return false;
}
if (!file1Exists) {
// two not existing files are equal
return true;
}
if (file1.isDirectory() || file2.isDirectory()) {
// don't want to compare directory contents
return false;
}
try (InputStream input1 = Files.newInputStream(file1.toPath());
InputStream input2 = Files.newInputStream(file2.toPath())) {
return IOUtil.contentEquals(input1, input2);
}
}
/**
* Convert from a <code>URL</code> to a <code>File</code>.
*
* @param url File URL.
* @return The equivalent <code>File</code> object, or <code>null</code> if the URL's protocol is not
* <code>file</code>
*/
public static File toFile(final URL url) {
if (url == null || !url.getProtocol().equalsIgnoreCase("file")) {
return null;
}
String filename = url.getFile().replace('/', File.separatorChar);
int pos = -1;
while ((pos = filename.indexOf('%', pos + 1)) >= 0) {
if (pos + 2 < filename.length()) {
String hexStr = filename.substring(pos + 1, pos + 3);
char ch = (char) Integer.parseInt(hexStr, 16);
filename = filename.substring(0, pos) + ch + filename.substring(pos + 3);
}
}
return new File(filename);
}
/**
* Convert the array of Files into a list of URLs.
*
* @param files the array of files
* @return the array of URLs
* @throws IOException if an error occurs
*/
public static URL[] toURLs(final File[] files) throws IOException {
final URL[] urls = new URL[files.length];
for (int i = 0; i < urls.length; i++) {
urls[i] = files[i].toURI().toURL();
}
return urls;
}
/**
* Remove extension from filename. ie
*
* <pre>
* foo.txt --> foo
* a\b\c.jpg --> a\b\c
* a\b\c --> a\b\c
* </pre>
*
* @param filename the path of the file
* @return the filename minus extension
*/
public static String removeExtension(final String filename) {
String ext = extension(filename);
if ("".equals(ext)) {
return filename;
}
final int index = filename.lastIndexOf(ext) - 1;
return filename.substring(0, index);
}
/**
* Get extension from filename. ie
*
* <pre>
* foo.txt --> "txt"
* a\b\c.jpg --> "jpg"
* a\b\c --> ""
* </pre>
*
* @param filename the path of the file
* @return the extension of filename or "" if none
*/
public static String getExtension(final String filename) {
return extension(filename);
}
/**
* Remove path from filename. Equivalent to the unix command <code>basename</code> ie.
*
* <pre>
* a/b/c.txt --> c.txt
* a.txt --> a.txt
* </pre>
*
* @param filepath the path of the file
* @return the filename minus path
*/
public static String removePath(final String filepath) {
return removePath(filepath, File.separatorChar);
}
/**
* Remove path from filename. ie.
*
* <pre>
* a/b/c.txt --> c.txt
* a.txt --> a.txt
* </pre>
*
* @param filepath the path of the file
* @param fileSeparatorChar the file separator character like <b>/</b> on Unix platforms.
* @return the filename minus path
*/
public static String removePath(final String filepath, final char fileSeparatorChar) {
final int index = filepath.lastIndexOf(fileSeparatorChar);
if (-1 == index) {
return filepath;
}
return filepath.substring(index + 1);
}
/**
* Get path from filename. Roughly equivalent to the unix command <code>dirname</code>. ie.
*
* <pre>
* a/b/c.txt --> a/b
* a.txt --> ""
* </pre>
*
* @param filepath the filepath
* @return the filename minus path
*/
public static String getPath(final String filepath) {
return getPath(filepath, File.separatorChar);
}
/**
* Get path from filename. ie.
*
* <pre>
* a/b/c.txt --> a/b
* a.txt --> ""
* </pre>
*
* @param filepath the filepath
* @param fileSeparatorChar the file separator character like <b>/</b> on Unix platforms.
* @return the filename minus path
*/
public static String getPath(final String filepath, final char fileSeparatorChar) {
final int index = filepath.lastIndexOf(fileSeparatorChar);
if (-1 == index) {
return "";
}
return filepath.substring(0, index);
}
/**
* Copy file from source to destination. If <code>destinationDirectory</code> does not exist, it (and any parent
* directories) will be created. If a file <code>source</code> in <code>destinationDirectory</code> exists, it will
* be overwritten.
*
* @param source An existing <code>File</code> to copy.
* @param destinationDirectory A directory to copy <code>source</code> into.
* @throws java.io.FileNotFoundException if <code>source</code> isn't a normal file.
* @throws IllegalArgumentException if <code>destinationDirectory</code> isn't a directory.
* @throws IOException if <code>source</code> does not exist, the file in <code>destinationDirectory</code> cannot
* be written to, or an IO error occurs during copying.
*/
public static void copyFileToDirectory(final String source, final String destinationDirectory) throws IOException {
copyFileToDirectory(new File(source), new File(destinationDirectory));
}
/**
* Copy file from source to destination only if source is newer than the target file. If
* <code>destinationDirectory</code> does not exist, it (and any parent directories) will be created. If a file
* <code>source</code> in <code>destinationDirectory</code> exists, it will be overwritten.
*
* @param source An existing <code>File</code> to copy.
* @param destinationDirectory A directory to copy <code>source</code> into.
* @throws java.io.FileNotFoundException if <code>source</code> isn't a normal file.
* @throws IllegalArgumentException if <code>destinationDirectory</code> isn't a directory.
* @throws IOException if <code>source</code> does not exist, the file in <code>destinationDirectory</code> cannot
* be written to, or an IO error occurs during copying.
*/
public static void copyFileToDirectoryIfModified(final String source, final String destinationDirectory)
throws IOException {
copyFileToDirectoryIfModified(new File(source), new File(destinationDirectory));
}
/**
* Copy file from source to destination. If <code>destinationDirectory</code> does not exist, it (and any parent
* directories) will be created. If a file <code>source</code> in <code>destinationDirectory</code> exists, it will
* be overwritten.
*
* @param source An existing <code>File</code> to copy.
* @param destinationDirectory A directory to copy <code>source</code> into.
* @throws java.io.FileNotFoundException if <code>source</code> isn't a normal file.
* @throws IllegalArgumentException if <code>destinationDirectory</code> isn't a directory.
* @throws IOException if <code>source</code> does not exist, the file in <code>destinationDirectory</code> cannot
* be written to, or an IO error occurs during copying.
*/
public static void copyFileToDirectory(final File source, final File destinationDirectory) throws IOException {
if (destinationDirectory.exists() && !destinationDirectory.isDirectory()) {
throw new IllegalArgumentException("Destination is not a directory");
}
copyFile(source, new File(destinationDirectory, source.getName()));
}
/**
* Copy file from source to destination only if source is newer than the target file. If
* <code>destinationDirectory</code> does not exist, it (and any parent directories) will be created. If a file
* <code>source</code> in <code>destinationDirectory</code> exists, it will be overwritten.
*
* @param source An existing <code>File</code> to copy.
* @param destinationDirectory A directory to copy <code>source</code> into.
* @throws java.io.FileNotFoundException if <code>source</code> isn't a normal file.
* @throws IllegalArgumentException if <code>destinationDirectory</code> isn't a directory.
* @throws IOException if <code>source</code> does not exist, the file in <code>destinationDirectory</code> cannot
* be written to, or an IO error occurs during copying.
*/
public static void copyFileToDirectoryIfModified(final File source, final File destinationDirectory)
throws IOException {
if (destinationDirectory.exists() && !destinationDirectory.isDirectory()) {
throw new IllegalArgumentException("Destination is not a directory");
}
copyFileIfModified(source, new File(destinationDirectory, source.getName()));
}
/**
* Creates a number of directories, as delivered from DirectoryScanner
*
* @param sourceBase The basedir used for the directory scan
* @param dirs The getIncludedDirs from the dirscanner
* @param destination The base dir of the output structure
* @throws IOException io issue
*/
public static void mkDirs(final File sourceBase, String[] dirs, final File destination) throws IOException {
for (String dir : dirs) {
File src = new File(sourceBase, dir);
File dst = new File(destination, dir);
if (NioFiles.isSymbolicLink(src)) {
File target = NioFiles.readSymbolicLink(src);
NioFiles.createSymbolicLink(dst, target);
} else {
dst.mkdirs();
}
}
}
/**
* Copy file from source to destination. The directories up to <code>destination</code> will be created if they
* don't already exist. <code>destination</code> will be overwritten if it already exists.
*
* @param source An existing non-directory <code>File</code> to copy bytes from.
* @param destination A non-directory <code>File</code> to write bytes to (possibly overwriting).
* @throws IOException if <code>source</code> does not exist, <code>destination</code> cannot be written to, or an
* IO error occurs during copying.
* @throws java.io.FileNotFoundException if <code>destination</code> is a directory (use
* {@link #copyFileToDirectory}).
*/
public static void copyFile(final File source, final File destination) throws IOException {
// check source exists
if (!source.exists()) {
final String message = "File " + source + " does not exist";
throw new IOException(message);
}
// check source != destination, see PLXUTILS-10
if (source.getCanonicalPath().equals(destination.getCanonicalPath())) {
// if they are equal, we can exit the method without doing any work
return;
}
mkdirsFor(destination);
doCopyFile(source, destination);
if (source.length() != destination.length()) {
String message = "Failed to copy full contents from " + source + " to " + destination;
throw new IOException(message);
}
}
private static void doCopyFile(File source, File destination) throws IOException {
doCopyFileUsingNewIO(source, destination);
}
private static void doCopyFileUsingNewIO(File source, File destination) throws IOException {
NioFiles.copy(source, destination);
}
/**
* Link file from destination to source. The directories up to <code>destination</code> will be created if they
* don't already exist. <code>destination</code> will be overwritten if it already exists.
*
* @param source An existing non-directory <code>File</code> to link to.
* @param destination A non-directory <code>File</code> becoming the link (possibly overwriting).
* @throws IOException if <code>source</code> does not exist, <code>destination</code> cannot be created, or an
* IO error occurs during linking.
* @throws java.io.FileNotFoundException if <code>destination</code> is a directory (use
* {@link #copyFileToDirectory}).
*/
public static void linkFile(final File source, final File destination) throws IOException {
// check source exists
if (!source.exists()) {
final String message = "File " + source + " does not exist";
throw new IOException(message);
}
// check source != destination, see PLXUTILS-10
if (source.getCanonicalPath().equals(destination.getCanonicalPath())) {
// if they are equal, we can exit the method without doing any work
return;
}
mkdirsFor(destination);
NioFiles.createSymbolicLink(destination, source);
}
/**
* Copy file from source to destination only if source timestamp is later than the destination timestamp. The
* directories up to <code>destination</code> will be created if they don't already exist. <code>destination</code>
* will be overwritten if it already exists.
*
* @param source An existing non-directory <code>File</code> to copy bytes from.
* @param destination A non-directory <code>File</code> to write bytes to (possibly overwriting).
* @return true if no problem occured
* @throws IOException if <code>source</code> does not exist, <code>destination</code> cannot be written to, or an
* IO error occurs during copying.
*/
public static boolean copyFileIfModified(final File source, final File destination) throws IOException {
if (isSourceNewerThanDestination(source, destination)) {
copyFile(source, destination);
return true;
}
return false;
}
/**
* Copies bytes from the URL <code>source</code> to a file <code>destination</code>. The directories up to
* <code>destination</code> will be created if they don't already exist. <code>destination</code> will be
* overwritten if it already exists.
*
* @param source A <code>URL</code> to copy bytes from.
* @param destination A non-directory <code>File</code> to write bytes to (possibly overwriting).
* @throws IOException if
* <ul>
* <li><code>source</code> URL cannot be opened</li>
* <li><code>destination</code> cannot be written to</li>
* <li>an IO error occurs during copying</li>
* </ul>
*/
public static void copyURLToFile(final URL source, final File destination) throws IOException {
copyStreamToFile(new URLInputStreamFacade(source), destination);
}
/**
* Copies bytes from the {@link InputStream} <code>source</code> to a file <code>destination</code>. The directories
* up to <code>destination</code> will be created if they don't already exist. <code>destination</code> will be
* overwritten if it already exists.
*
* @param source An {@link InputStream} to copy bytes from. This stream is guaranteed to be closed.
* @param destination A non-directory <code>File</code> to write bytes to (possibly overwriting).
* @throws IOException if
* <ul>
* <li><code>source</code> URL cannot be opened</li>
* <li><code>destination</code> cannot be written to</li>
* <li>an IO error occurs during copying</li>
* </ul>
*/
public static void copyStreamToFile(final InputStreamFacade source, final File destination) throws IOException {
mkdirsFor(destination);
checkCanWrite(destination);
try (InputStream input = source.getInputStream();
OutputStream output = Files.newOutputStream(destination.toPath())) {
IOUtil.copy(input, output);
}
}
private static void checkCanWrite(File destination) throws IOException {
// make sure we can write to destination
if (destination.exists() && !destination.canWrite()) {
final String message = "Unable to open file " + destination + " for writing.";
throw new IOException(message);
}
}
private static void mkdirsFor(File destination) {
// does destination directory exist ?
File parentFile = destination.getParentFile();
if (parentFile != null && !parentFile.exists()) {
parentFile.mkdirs();
}
}
/**