Java tutorial
/** * Copyright (c) 2000-2005 Liferay, LLC. All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ package com.liferay.util; import java.io.BufferedReader; import java.io.BufferedWriter; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.FileFilter; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.FileReader; import java.io.FileWriter; import java.io.IOException; import java.io.Reader; import java.math.BigDecimal; import java.math.MathContext; import java.nio.channels.FileChannel; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.Properties; import org.apache.commons.io.FileUtils; import org.apache.commons.io.filefilter.TrueFileFilter; import com.dotmarketing.util.Config; import com.dotmarketing.util.Logger; import com.liferay.util.jna.JNALibrary; /** * <a href="FileUtil.java.html"><b><i>View Source</i></b></a> * * @author Brian Wing Shun Chan * @version $Revision: 1.13 $ * */ public class FileUtil { //http://jira.dotmarketing.net/browse/DOTCMS-2178 final static long KILO_BYTE = 1024; final static long MEGA_BYTE = 1024 * 1024; final static long GIGA_BYTE = 1024 * 1024 * 1024; final static long TERA_BYTE = 1024 * 1024 * 1024 * 1024; public static void copyDirectory(String sourceDirName, String destinationDirName, boolean hardLinks) { copyDirectory(new File(sourceDirName), new File(destinationDirName), hardLinks); } public static void copyDirectory(String sourceDirName, String destinationDirName) { copyDirectory(new File(sourceDirName), new File(destinationDirName)); } public static void copyDirectory(String sourceDirName, String destinationDirName, FileFilter filter) { copyDirectory(new File(sourceDirName), new File(destinationDirName), true, filter); } public static void copyDirectory(File source, File destination, boolean hardLinks) { copyDirectory(source, destination, hardLinks, null); } public static void copyDirectory(File source, File destination, boolean hardLinks, FileFilter filter) { if (source.exists() && source.isDirectory()) { if (!destination.exists()) { destination.mkdirs(); } File[] fileArray = filter != null ? source.listFiles(filter) : source.listFiles(); for (int i = 0; i < fileArray.length; i++) { if (fileArray[i].getName().endsWith("xml")) { String name = fileArray[i].getName(); Logger.info(FileUtil.class, "copy " + name); } if (fileArray[i].isDirectory()) { copyDirectory(fileArray[i], new File(destination.getPath() + File.separator + fileArray[i].getName()), hardLinks, filter); } else { copyFile(fileArray[i], new File(destination.getPath() + File.separator + fileArray[i].getName()), hardLinks); } } } } public static void copyDirectory(File source, File destination) { copyDirectory(source, destination, Config.getBooleanProperty("CONTENT_VERSION_HARD_LINK", true)); } public static void copyFile(String sourceFileName, String destinationFileName) { copyFile(new File(sourceFileName), new File(destinationFileName)); } public static void copyFile(File source, File destination) { copyFile(source, destination, Config.getBooleanProperty("CONTENT_VERSION_HARD_LINK", true)); } public static void copyFile(File source, File destination, boolean hardLinks) { if (!source.exists()) { return; } if (hardLinks && !Config.getBooleanProperty("CONTENT_VERSION_HARD_LINK", true)) { hardLinks = false; } if ((destination.getParentFile() != null) && (!destination.getParentFile().exists())) { destination.getParentFile().mkdirs(); } if (hardLinks) { // I think we need to be sure to unlink first if (destination.exists()) { JNALibrary.unlink(destination.getAbsolutePath()); } try { JNALibrary.link(source.getAbsolutePath(), destination.getAbsolutePath()); // setting this means we will try again if we cannot hard link if (!destination.exists()) { hardLinks = false; } } catch (IOException e) { Logger.error(FileUtil.class, "Can't create hardLink. source: " + source.getAbsolutePath() + ", destination: " + destination.getAbsolutePath()); // setting this means we will try again if we cannot hard link hardLinks = false; } } if (!hardLinks) { try { FileChannel srcChannel = new FileInputStream(source).getChannel(); FileChannel dstChannel = new FileOutputStream(destination).getChannel(); dstChannel.transferFrom(srcChannel, 0, srcChannel.size()); srcChannel.close(); dstChannel.close(); } catch (IOException ioe) { Logger.error(FileUtil.class, ioe.getMessage(), ioe); } } } public static void copyFileLazy(String source, String destination) throws IOException { String oldContent = null; try { oldContent = FileUtil.read(source); } catch (FileNotFoundException fnfe) { return; } String newContent = null; try { newContent = FileUtil.read(destination); } catch (FileNotFoundException fnfe) { } if (oldContent == null || !oldContent.equals(newContent)) { FileUtil.copyFile(source, destination); } } public static void deltree(String directory) { deltree(new File(directory)); } public static void deltree(File directory, boolean deleteTopDir) { if (directory.exists() && directory.isDirectory()) { File[] fileArray = directory.listFiles(); for (int i = 0; i < fileArray.length; i++) { if (fileArray[i].isDirectory()) { deltree(fileArray[i]); } else { fileArray[i].delete(); } } if (deleteTopDir) directory.delete(); } else { if (directory.exists()) { directory.delete(); } } } public static void deltree(File directory) { deltree(directory, true); } public static byte[] getBytes(File file) throws IOException { if (file == null || !file.exists()) { return null; } ByteArrayOutputStream out = new ByteArrayOutputStream(); FileInputStream in = new FileInputStream(file); int c = in.read(); while (c != -1) { out.write(c); c = in.read(); } in.close(); out.close(); return out.toByteArray(); } public static String getPath(String fullFileName) { int pos = fullFileName.lastIndexOf("/"); if (pos == -1) { pos = fullFileName.lastIndexOf("\\"); } String shortFileName = fullFileName.substring(0, pos); if (Validator.isNull(shortFileName)) { return "/"; } return shortFileName; } public static String getShortFileName(String fullFileName) { int pos = fullFileName.lastIndexOf("/"); if (pos == -1) { pos = fullFileName.lastIndexOf("\\"); } String shortFileName = fullFileName.substring(pos + 1, fullFileName.length()); return shortFileName; } public static boolean exists(String fileName) { File file = new File(fileName); return file.exists(); } public static String[] listDirs(String fileName) throws IOException { return listDirs(new File(fileName)); } public static String[] listDirs(File file) throws IOException { List dirs = new ArrayList(); File[] fileArray = file.listFiles(); for (int i = 0; i < fileArray.length; i++) { if (fileArray[i].isDirectory()) { dirs.add(fileArray[i].getName()); } } return (String[]) dirs.toArray(new String[0]); } public static String[] listFiles(String fileName) throws IOException { return listFiles(new File(fileName)); } public static String[] listFiles(String fileName, Boolean includeSubDirs) throws IOException { return listFiles(new File(fileName), includeSubDirs); } public static boolean containsParentFolder(File file, File[] folders) { for (File folder : Arrays.asList(folders)) { if (file.getParent().equalsIgnoreCase(folder.getPath())) { return true; } } return false; } public static String[] listFiles(File dir) throws IOException { return listFiles(dir, false); } public static File[] listFileHandles(String fileName, Boolean includeSubDirs) throws IOException { return listFileHandles(new File(fileName), includeSubDirs); } public static File[] listFileHandles(File dir, Boolean includeSubDirs) throws IOException { FileFilter fileFilter = new FileFilter() { public boolean accept(File file) { return file.isDirectory(); } }; File[] subFolders = dir.listFiles(fileFilter); List<File> files = new ArrayList<File>(); List<File> fileArray = new ArrayList<File>( FileUtils.listFiles(dir, TrueFileFilter.INSTANCE, includeSubDirs ? TrueFileFilter.INSTANCE : null)); for (File file : fileArray) { if (file.isFile()) { if (includeSubDirs && containsParentFolder(file, subFolders)) { files.add(file); } else { files.add(file); } } } return (File[]) files.toArray(new File[0]); } public static String[] listFiles(File dir, Boolean includeSubDirs) throws IOException { FileFilter fileFilter = new FileFilter() { public boolean accept(File file) { return file.isDirectory(); } }; File[] subFolders = dir.listFiles(fileFilter); List<String> files = new ArrayList<String>(); List<File> fileArray = new ArrayList<File>( FileUtils.listFiles(dir, TrueFileFilter.INSTANCE, includeSubDirs ? TrueFileFilter.INSTANCE : null)); for (File file : fileArray) { if (file.isFile()) { if (includeSubDirs && containsParentFolder(file, subFolders)) { files.add(file.getParentFile().getName() + File.separator + file.getName()); } else { files.add(file.getName()); } } } return (String[]) files.toArray(new String[0]); } public static void mkdirs(String pathName) { File file = new File(pathName); file.mkdirs(); } public static boolean move(String sourceFileName, String destinationFileName) { return move(new File(sourceFileName), new File(destinationFileName)); } public static boolean move(File source, File destination) { if (!source.exists()) { return false; } destination.delete(); boolean success = source.renameTo(destination); // if the rename fails, copy if (!success) { copyFile(source, destination); success = source.delete(); } return success; } public static String read(String fileName) throws IOException { return read(new File(fileName)); } public static String read(File file) throws IOException { BufferedReader br = new BufferedReader(new FileReader(file)); StringBuffer sb = new StringBuffer(); String line = null; while ((line = br.readLine()) != null) { sb.append(line).append('\n'); } br.close(); return sb.toString().trim(); } public static File[] sortFiles(File[] files) { Arrays.sort(files, new FileComparator()); List directoryList = new ArrayList(); List fileList = new ArrayList(); for (int i = 0; i < files.length; i++) { if (files[i].isDirectory()) { directoryList.add(files[i]); } else { fileList.add(files[i]); } } directoryList.addAll(fileList); return (File[]) directoryList.toArray(new File[0]); } public static String replaceSeparator(String fileName) { return StringUtil.replace(fileName, '\\', "/"); } public static List toList(Reader reader) { List list = new ArrayList(); try { BufferedReader br = new BufferedReader(reader); StringBuffer sb = new StringBuffer(); String line = null; while ((line = br.readLine()) != null) { list.add(line); } br.close(); } catch (IOException ioe) { } return list; } public static List toList(String fileName) { try { return toList(new FileReader(fileName)); } catch (IOException ioe) { return new ArrayList(); } } public static Properties toProperties(FileInputStream fis) { Properties props = new Properties(); try { props.load(fis); } catch (IOException ioe) { } return props; } public static Properties toProperties(String fileName) { try { return toProperties(new FileInputStream(fileName)); } catch (IOException ioe) { return new Properties(); } } public static void write(File file, String s) throws IOException { if (file.getParent() != null) { mkdirs(file.getParent()); } BufferedWriter bw = new BufferedWriter(new FileWriter(file)); bw.flush(); bw.write(s); bw.close(); } public static void write(String fileName, String s) throws IOException { write(new File(fileName), s); } public static void write(String pathName, String fileName, String s) throws IOException { write(new File(pathName, fileName), s); } // http://jira.dotmarketing.net/browse/DOTCMS-2178 public static String getsize(File fileName) { String finalVal; long filesize = fileName.length(); BigDecimal size = new BigDecimal(filesize); BigDecimal byteVal = null; BigDecimal changedByteVal = null; finalVal = ""; if (filesize <= 0) { finalVal = ""; } else if (filesize < MEGA_BYTE) { byteVal = new BigDecimal(KILO_BYTE); if (size != null) { changedByteVal = size.divide(byteVal, MathContext.UNLIMITED); finalVal = Long.toString(Math.round(Math.ceil(changedByteVal.doubleValue()))) + " KB"; } } else if (filesize < GIGA_BYTE) { byteVal = new BigDecimal(MEGA_BYTE); if (size != null) { changedByteVal = size.divide(byteVal, MathContext.UNLIMITED); finalVal = Long.toString(Math.round(Math.ceil(changedByteVal.doubleValue()))) + " MB"; } } else if (filesize < TERA_BYTE) { byteVal = new BigDecimal(GIGA_BYTE); if (size != null) { changedByteVal = size.divide(byteVal, MathContext.UNLIMITED); finalVal = Long.toString(Math.round(Math.ceil(changedByteVal.doubleValue()))) + " GB"; } } else { byteVal = new BigDecimal(TERA_BYTE); if (size != null) { changedByteVal = size.divide(byteVal, MathContext.UNLIMITED); finalVal = Long.toString(Math.round(Math.ceil(changedByteVal.doubleValue()))) + " TB"; } } return finalVal; } /** * Recursively walk a directory tree and return a List of all * Files found; the List is sorted using File.compareTo(). * * @param aStartingDir is a valid directory, which can be read. */ static public List<File> listFilesRecursively(File aStartingDir) throws FileNotFoundException { return listFilesRecursively(aStartingDir, null); } /** * Recursively walk a directory tree and return a List of all * Files found; the List is sorted using File.compareTo(). * * @param aStartingDir is a valid directory, which can be read. */ static public List<File> listFilesRecursively(File aStartingDir, FileFilter filter) throws FileNotFoundException { validateDirectory(aStartingDir); List<File> result = getFileListingNoSort(aStartingDir, filter); Collections.sort(result); return result; } // PRIVATE // static private List<File> getFileListingNoSort(File aStartingDir, FileFilter filter) throws FileNotFoundException { List<File> result = new ArrayList<File>(); File[] filesAndDirs = null; if (filter != null) { filesAndDirs = aStartingDir.listFiles(filter); } else { filesAndDirs = aStartingDir.listFiles(); } List<File> filesDirs = Arrays.asList(filesAndDirs); for (File file : filesDirs) { result.add(file); //always add, even if directory if (!file.isFile()) { //must be a directory //recursive call! List<File> deeperList = getFileListingNoSort(file, filter); result.addAll(deeperList); } } return result; } /** * Directory is valid if it exists, does not represent a file, and can be read. */ static private void validateDirectory(File aDirectory) throws FileNotFoundException { if (aDirectory == null) { throw new IllegalArgumentException("Directory should not be null."); } if (!aDirectory.exists()) { throw new FileNotFoundException("Directory does not exist: " + aDirectory); } if (!aDirectory.isDirectory()) { throw new IllegalArgumentException("Is not a directory: " + aDirectory); } if (!aDirectory.canRead()) { throw new IllegalArgumentException("Directory cannot be read: " + aDirectory); } } }