package net.sourceforge.tuned; import java.io.BufferedInputStream; import java.io.File; import java.io.FileFilter; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.io.Reader; import java.io.StringWriter; import java.nio.ByteBuffer; import java.nio.channels.FileChannel; import java.nio.charset.Charset; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.Iterator; import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.SortedMap; import java.util.TreeMap; import java.util.regex.Matcher; import java.util.regex.Pattern; import javax.xml.transform.OutputKeys; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerException; import javax.xml.transform.TransformerFactory; import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stream.StreamResult; import org.w3c.dom.Document; import com.ibm.icu.text.CharsetDetector; import com.ibm.icu.text.CharsetMatch; public final class FileUtilities { public static File moveRename(File source, File destination) throws IOException { // resolve destination destination = resolveDestination(source, destination); if (source.isDirectory()) { // move folder moveFolderIO(source, destination); } else { // move file try { moveFileNIO2(source, destination); } catch (LinkageError e) { moveFileIO(source, destination); } } return destination; } private static void moveFileNIO2(File source, File destination) throws IOException { java.nio.file.Files.move(source.toPath(), destination.toPath()); } private static void moveFileIO(File source, File destination) throws IOException { // use "copy and delete" as fallback if standard rename fails org.apache.commons.io.FileUtils.moveFile(source, destination); } private static void moveFolderIO(File source, File destination) throws IOException { // use "copy and delete" as fallback if standard move/rename fails org.apache.commons.io.FileUtils.moveDirectory(source, destination); } public static File copyAs(File source, File destination) throws IOException { // resolve destination destination = resolveDestination(source, destination); if (source.isDirectory()) { // copy folder org.apache.commons.io.FileUtils.copyDirectory(source, destination); } else { // copy file org.apache.commons.io.FileUtils.copyFile(source, destination); } return destination; } public static File resolveDestination(File source, File destination) throws IOException { // resolve destination if (!destination.isAbsolute()) { // same folder, different name destination = new File(source.getParentFile(), destination.getPath()); } // make sure we that we can create the destination folder structure File destinationFolder = destination.getParentFile(); // create parent folder if necessary if (!destinationFolder.isDirectory() && !destinationFolder.mkdirs()) { throw new IOException("Failed to create folder: " + destinationFolder); } return destination; } public static byte[] readFile(File source) throws IOException { InputStream in = new FileInputStream(source); try { byte[] data = new byte[(int) source.length()]; int position = 0; int read = 0; while (position < data.length && (read = in.read(data, position, data.length - position)) >= 0) { position += read; } return data; } finally { in.close(); } } public static String readAll(Reader source) throws IOException { StringBuilder text = new StringBuilder(); char[] buffer = new char[2048]; int read = 0; while ((read = source.read(buffer)) >= 0) { text.append(buffer, 0, read); } return text.toString(); } public static void writeFile(ByteBuffer data, File destination) throws IOException { FileChannel fileChannel = new FileOutputStream(destination).getChannel(); try { fileChannel.write(data); } finally { fileChannel.close(); } } public static Reader createTextReader(File file) throws IOException { CharsetDetector detector = new CharsetDetector(); detector.setDeclaredEncoding("UTF-8"); // small boost for UTF-8 as default encoding detector.setText(new BufferedInputStream(new FileInputStream(file))); CharsetMatch charset = detector.detect(); if (charset != null) return charset.getReader(); // assume UTF-8 by default return new InputStreamReader(new FileInputStream(file), "UTF-8"); } public static String getText(ByteBuffer data) throws IOException { CharsetDetector detector = new CharsetDetector(); detector.setDeclaredEncoding("UTF-8"); // small boost for UTF-8 as default encoding detector.setText(new ByteBufferInputStream(data)); CharsetMatch charset = detector.detect(); if (charset != null) { try { return charset.getString(); } catch (RuntimeException e) { throw new IOException("Failed to read text", e); } } // assume UTF-8 by default return Charset.forName("UTF-8").decode(data).toString(); } /** * Pattern used for matching file extensions. * * e.g. "file.txt" -> match "txt", ".hidden" -> no match */ public static final Pattern EXTENSION = Pattern.compile("(?<=.[.])\\p{Alnum}+$"); public static String getExtension(File file) { if (file.isDirectory()) return null; return getExtension(file.getName()); } public static String getExtension(String name) { Matcher matcher = EXTENSION.matcher(name); if (matcher.find()) { // extension without leading '.' return matcher.group(); } // no extension return null; } public static boolean hasExtension(File file, String... extensions) { // avoid native call for speed, if possible return hasExtension(file.getName(), extensions) && !file.isDirectory(); } public static boolean hasExtension(String filename, String... extensions) { String extension = getExtension(filename); for (String value : extensions) { if ((extension == null && value == null) || (extension != null && extension.equalsIgnoreCase(value))) return true; } return false; } public static String getNameWithoutExtension(String name) { Matcher matcher = EXTENSION.matcher(name); if (matcher.find()) { return name.substring(0, matcher.start() - 1); } // no extension, return given name return name; } public static String getName(File file) { if (file.isDirectory()) return getFolderName(file); return getNameWithoutExtension(file.getName()); } public static String getFolderName(File file) { String name = file.getName(); if (!name.isEmpty()) return name; // file might be a drive (only has a path, but no name) return file.toString(); } public static boolean isDerived(File derivate, File prime) { return isDerived(getName(derivate), prime); } public static boolean isDerived(String derivate, File prime) { String base = getName(prime).trim().toLowerCase(); derivate = derivate.trim().toLowerCase(); return derivate.startsWith(base); } public static boolean isDerivedByExtension(File derivate, File prime) { return isDerivedByExtension(getName(derivate), prime); } public static boolean isDerivedByExtension(String derivate, File prime) { String base = getName(prime).trim().toLowerCase(); derivate = derivate.trim().toLowerCase(); if (derivate.equals(base)) return true; while (derivate.length() > base.length() && getExtension(derivate) != null) { derivate = getNameWithoutExtension(derivate); if (derivate.equals(base)) return true; } return false; } public static boolean containsOnly(Iterable files, FileFilter filter) { for (File file : files) { if (!filter.accept(file)) return false; } return true; } public static List filter(Iterable files, FileFilter... filters) { List accepted = new ArrayList(); for (File file : files) { for (FileFilter filter : filters) { if (filter.accept(file)) { accepted.add(file); break; } } } return accepted; } public static FileFilter not(FileFilter filter) { return new NotFileFilter(filter); } public static List flatten(Iterable roots, int maxDepth, boolean listHiddenFiles) { List files = new ArrayList(); // unfold/flatten file tree for (File root : roots) { if (root.isDirectory()) { listFiles(root, 0, files, maxDepth, listHiddenFiles); } else { files.add(root); } } return files; } public static List listPath(File file) { LinkedList nodes = new LinkedList(); for (File node = file; node != null; node = node.getParentFile()) { nodes.addFirst(node); } return nodes; } public static List listFiles(Iterable folders, int maxDepth, boolean listHiddenFiles) { List files = new ArrayList(); // collect files from directory tree for (File folder : folders) { listFiles(folder, 0, files, maxDepth, listHiddenFiles); } return files; } private static void listFiles(File folder, int depth, List files, int maxDepth, boolean listHiddenFiles) { if (depth > maxDepth) return; for (File file : folder.listFiles()) { if (!listHiddenFiles && file.isHidden()) // ignore hidden files continue; if (file.isDirectory()) { listFiles(file, depth + 1, files, maxDepth, listHiddenFiles); } else { files.add(file); } } } public static SortedMap> mapByFolder(Iterable files) { SortedMap> map = new TreeMap>(); for (File file : files) { File key = file.getParentFile(); if (key == null) { throw new IllegalArgumentException("Parent is null: " + file); } List valueList = map.get(key); if (valueList == null) { valueList = new ArrayList(); map.put(key, valueList); } valueList.add(file); } return map; } public static Map> mapByExtension(Iterable files) { Map> map = new HashMap>(); for (File file : files) { String key = getExtension(file); if (key != null) { key = key.toLowerCase(); } List valueList = map.get(key); if (valueList == null) { valueList = new ArrayList(); map.put(key, valueList); } valueList.add(file); } return map; } /** * Invalid file name characters: \, /, :, *, ?, ", <, >, |, \r and \n */ public static final Pattern ILLEGAL_CHARACTERS = Pattern.compile("[\\\\/:*?\"<>|\\r\\n]"); /** * Strip file name of invalid characters * * @param filename original filename * @return valid file name stripped of invalid characters */ public static String validateFileName(CharSequence filename) { // strip invalid characters from file name return ILLEGAL_CHARACTERS.matcher(filename).replaceAll(""); } public static boolean isInvalidFileName(CharSequence filename) { // check if file name contains any illegal characters return ILLEGAL_CHARACTERS.matcher(filename).find(); } public static File validateFileName(File file) { // windows drives (e.g. c:, d:, etc.) are never invalid because name will be an empty string if (!isInvalidFileName(file.getName())) return file; // validate file name only return new File(file.getParentFile(), validateFileName(file.getName())); } public static File validateFilePath(File path) { Iterator nodes = listPath(path).iterator(); // initialize with root node, keep original root object if possible (so we don't loose the drive on windows) File validatedPath = validateFileName(nodes.next()); // validate the rest of the path while (nodes.hasNext()) { validatedPath = new File(validatedPath, validateFileName(nodes.next().getName())); } return validatedPath; } public static boolean isInvalidFilePath(File path) { // check if file name contains any illegal characters for (File node = path; node != null; node = node.getParentFile()) { if (isInvalidFileName(node.getName())) return true; } return false; } public static String normalizePathSeparators(String path) { return path.replace('\\', '/'); } public static String replacePathSeparators(CharSequence path) { return replacePathSeparators(path, " "); } public static String replacePathSeparators(CharSequence path, String replacement) { return Pattern.compile("\\s*[\\\\/]+\\s*").matcher(path).replaceAll(replacement); } public static String getXmlString(Document dom) throws TransformerException { Transformer tr = TransformerFactory.newInstance().newTransformer(); tr.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes"); tr.setOutputProperty(OutputKeys.INDENT, "yes"); //create string from dom StringWriter buffer = new StringWriter(); tr.transform(new DOMSource(dom), new StreamResult(buffer)); return buffer.toString(); } public static final long KILO = 1024; public static final long MEGA = KILO * 1024; public static final long GIGA = MEGA * 1024; public static String formatSize(long size) { if (size >= MEGA) return String.format("%,d MB", size / MEGA); else if (size >= KILO) return String.format("%,d KB", size / KILO); else return String.format("%,d Byte", size); } public static final FileFilter FOLDERS = new FileFilter() { @Override public boolean accept(File file) { return file.isDirectory(); } }; public static final FileFilter FILES = new FileFilter() { @Override public boolean accept(File file) { return file.isFile(); } }; public static final FileFilter TEMPORARY = new FileFilter() { private final String tmpdir = System.getProperty("java.io.tmpdir"); @Override public boolean accept(File file) { return file.getAbsolutePath().startsWith(tmpdir); } }; public static class ParentFilter implements FileFilter { private final File folder; public ParentFilter(File folder) { this.folder = folder; } @Override public boolean accept(File file) { return listPath(file).contains(folder); } } public static class ExtensionFileFilter implements FileFilter { private final String[] extensions; public ExtensionFileFilter(String... extensions) { this.extensions = extensions; } public ExtensionFileFilter(Collection extensions) { this.extensions = extensions.toArray(new String[0]); } @Override public boolean accept(File file) { return hasExtension(file, extensions); } public boolean accept(String name) { return hasExtension(name, extensions); } public boolean acceptExtension(String extension) { for (String other : extensions) { if (other.equalsIgnoreCase(extension)) return true; } return false; } public String extension() { return extensions[0]; } public String[] extensions() { return extensions.clone(); } } public static class NotFileFilter implements FileFilter { public FileFilter filter; public NotFileFilter(FileFilter filter) { this.filter = filter; } @Override public boolean accept(File file) { return !filter.accept(file); } } /** * Dummy constructor to prevent instantiation. */ private FileUtilities() { throw new UnsupportedOperationException(); } }