* symlink using relative link targets if possible but default to absolute paths for cross-volume absolute symlinks if necessary

source/net/sourceforge/filebot/StandardRenameAction.java

@@ -1,13 +1,10 @@
-
 package net.sourceforge.filebot;
 
-
 import java.io.File;
 import java.io.IOException;
 
 import net.sourceforge.tuned.FileUtilities;
 
-
 public enum StandardRenameAction implements RenameAction {
 
 	MOVE {
@@ -35,7 +32,7 @@ public enum StandardRenameAction implements RenameAction {
 			// move file and the create a symlink to the new location via NIO.2
 			try {
 				java.nio.file.Files.move(from.toPath(), destionation.toPath());
-				java.nio.file.Files.createSymbolicLink(from.toPath(), destionation.toPath());
+				FileUtilities.createRelativeSymlink(from, destionation, true);
 			} catch (LinkageError e) {
 				throw new Exception("Unsupported Operation: move, createSymbolicLink");
 			}
@@ -52,12 +49,10 @@ public enum StandardRenameAction implements RenameAction {
 
 			// create symlink via NIO.2
 			try {
-				java.nio.file.Files.createSymbolicLink(destionation.toPath(), from.toPath());
+				return FileUtilities.createRelativeSymlink(destionation, from, true);
 			} catch (LinkageError e) {
 				throw new Exception("Unsupported Operation: createSymbolicLink");
 			}
-			
-			return destionation;
 		}
 	},
 
@@ -117,7 +112,6 @@ public enum StandardRenameAction implements RenameAction {
 		}
 	}
 
-	
 	public static StandardRenameAction forName(String action) {
 		for (StandardRenameAction it : values()) {
 			if (it.name().equalsIgnoreCase(action))

source/net/sourceforge/tuned/FileUtilities.java

@@ -1,7 +1,5 @@
-
 package net.sourceforge.tuned;
 
-
 import java.io.BufferedInputStream;
 import java.io.File;
 import java.io.FileFilter;
@@ -40,7 +38,6 @@ 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 {
@@ -62,7 +59,6 @@ public final class FileUtilities {
 		return destination;
 	}
 
-	
 	public static File copyAs(File source, File destination) throws IOException {
 		// resolve destination
 		destination = resolveDestination(source, destination, true);
@@ -82,7 +78,6 @@ public final class FileUtilities {
 		return destination;
 	}
 
-	
 	public static File resolveDestination(File source, File destination, boolean mkdirs) throws IOException {
 		// resolve destination
 		if (!destination.isAbsolute()) {
@@ -101,13 +96,24 @@ public final class FileUtilities {
 		return destination;
 	}
 
+	public static File createRelativeSymlink(File link, File target, boolean relativize) throws IOException {
+		if (relativize) {
+			try {
+				target = link.getParentFile().toPath().relativize(target.toPath()).toFile();
+			} catch (Throwable e) {
+				// unable to relativize link target
+			}
+		}
+
+		// create symlink via NIO.2
+		return java.nio.file.Files.createSymbolicLink(link.toPath(), target.toPath()).toFile();
+	}
 
 	public static boolean delete(File file) {
 		// delete files or files
 		return org.apache.commons.io.FileUtils.deleteQuietly(file);
 	}
 
-	
 	public static byte[] readFile(File source) throws IOException {
 		InputStream in = new FileInputStream(source);
 
@@ -132,7 +138,6 @@ public final class FileUtilities {
 		}
 	}
 
-	
 	public static String readAll(Reader source) throws IOException {
 		StringBuilder text = new StringBuilder();
 		char[] buffer = new char[2048];
@@ -145,7 +150,6 @@ public final class FileUtilities {
 		return text.toString();
 	}
 
-	
 	public static void writeFile(ByteBuffer data, File destination) throws IOException {
 		FileChannel fileChannel = new FileOutputStream(destination).getChannel();
 
@@ -156,7 +160,6 @@ public final class FileUtilities {
 		}
 	}
 
-	
 	public static Reader createTextReader(File file) throws IOException {
 		CharsetDetector detector = new CharsetDetector();
 		detector.setDeclaredEncoding("UTF-8"); // small boost for UTF-8 as default encoding
@@ -170,7 +173,6 @@ public final class FileUtilities {
 		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
@@ -197,7 +199,6 @@ public final class FileUtilities {
 	public static final Pattern EXTENSION = Pattern.compile("(?<=.[.])\\p{Alnum}+$");
 	public static final String UNC_PREFIX = "\\\\";
 
-	
 	public static String getExtension(File file) {
 		if (file.isDirectory())
 			return null;
@@ -205,7 +206,6 @@ public final class FileUtilities {
 		return getExtension(file.getName());
 	}
 
-	
 	public static String getExtension(String name) {
 		Matcher matcher = EXTENSION.matcher(name);
 
@@ -218,13 +218,11 @@ public final class FileUtilities {
 		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) {
 		for (String it : extensions) {
 			if (filename.length() - it.length() >= 2 && filename.charAt(filename.length() - it.length() - 1) == '.') {
@@ -238,7 +236,6 @@ public final class FileUtilities {
 		return false;
 	}
 
-	
 	public static String getNameWithoutExtension(String name) {
 		Matcher matcher = EXTENSION.matcher(name);
 
@@ -250,7 +247,6 @@ public final class FileUtilities {
 		return name;
 	}
 
-	
 	public static String getName(File file) {
 		if (file.getName().isEmpty() || UNC_PREFIX.equals(file.getParent()))
 			return getFolderName(file);
@@ -258,7 +254,6 @@ public final class FileUtilities {
 		return getNameWithoutExtension(file.getName());
 	}
 
-	
 	public static String getFolderName(File file) {
 		if (UNC_PREFIX.equals(file.getParent()))
 			return file.toString();
@@ -270,24 +265,20 @@ public final class FileUtilities {
 		return replacePathSeparators(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();
@@ -305,7 +296,6 @@ public final class FileUtilities {
 		return false;
 	}
 
-	
 	public static boolean containsOnly(Collection<File> files, FileFilter filter) {
 		if (files.isEmpty()) {
 			return false;
@@ -317,7 +307,6 @@ public final class FileUtilities {
 		return true;
 	}
 
-	
 	public static List<File> filter(Iterable<File> files, FileFilter... filters) {
 		List<File> accepted = new ArrayList<File>();
 
@@ -333,12 +322,10 @@ public final class FileUtilities {
 		return accepted;
 	}
 
-	
 	public static FileFilter not(FileFilter filter) {
 		return new NotFileFilter(filter);
 	}
 
-	
 	public static List<File> flatten(Iterable<File> roots, int maxDepth, boolean listHiddenFiles) {
 		List<File> files = new ArrayList<File>();
 
@@ -354,12 +341,10 @@ public final class FileUtilities {
 		return files;
 	}
 
-	
 	public static List<File> listPath(File file) {
 		return listPathTail(file, Integer.MAX_VALUE);
 	}
 
-	
 	public static List<File> listPathTail(File file, int tailSize) {
 		LinkedList<File> nodes = new LinkedList<File>();
 
@@ -371,7 +356,6 @@ public final class FileUtilities {
 		return nodes;
 	}
 
-	
 	public static File getRelativePathTail(File file, int tailSize) {
 		File f = null;
 		for (File it : listPathTail(file, tailSize)) {
@@ -382,7 +366,6 @@ public final class FileUtilities {
 		return f;
 	}
 
-	
 	public static List<File> listFiles(Iterable<File> folders, int maxDepth, boolean listHiddenFiles) {
 		List<File> files = new ArrayList<File>();
 
@@ -394,7 +377,6 @@ public final class FileUtilities {
 		return files;
 	}
 
-	
 	private static void listFiles(File folder, int depth, List<File> files, int maxDepth, boolean listHiddenFiles) {
 		if (depth > maxDepth)
 			return;
@@ -411,7 +393,6 @@ public final class FileUtilities {
 		}
 	}
 
-	
 	public static SortedMap<File, List<File>> mapByFolder(Iterable<File> files) {
 		SortedMap<File, List<File>> map = new TreeMap<File, List<File>>();
 
@@ -433,7 +414,6 @@ public final class FileUtilities {
 		return map;
 	}
 
-	
 	public static Map<String, List<File>> mapByExtension(Iterable<File> files) {
 		Map<String, List<File>> map = new HashMap<String, List<File>>();
 
@@ -460,11 +440,11 @@ public final class FileUtilities {
 	 */
 	public static final Pattern ILLEGAL_CHARACTERS = Pattern.compile("[\\\\/:*?\"<>|\\r\\n]|[. ]+$");
 
-	
 	/**
 	 * Strip file name of invalid characters
 	 * 
-	 * @param filename original filename
+	 * @param filename
+	 *            original filename
 	 * @return valid file name stripped of invalid characters
 	 */
 	public static String validateFileName(CharSequence filename) {
@@ -472,13 +452,11 @@ public final class FileUtilities {
 		return ILLEGAL_CHARACTERS.matcher(filename).replaceAll("").trim();
 	}
 
-	
 	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()))
@@ -488,7 +466,6 @@ public final class FileUtilities {
 		return new File(file.getParentFile(), validateFileName(file.getName()));
 	}
 
-	
 	public static File validateFilePath(File path) {
 		Iterator<File> nodes = listPath(path).iterator();
 
@@ -503,7 +480,6 @@ public final class FileUtilities {
 		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()) {
@@ -514,7 +490,6 @@ public final class FileUtilities {
 		return false;
 	}
 
-	
 	public static String normalizePathSeparators(String path) {
 		// special handling for UNC paths
 		if (path.startsWith(UNC_PREFIX) && path.length() > 2) {
@@ -523,17 +498,14 @@ public final class FileUtilities {
 		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");
@@ -549,7 +521,6 @@ public final class FileUtilities {
 	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);
@@ -579,57 +550,47 @@ public final class FileUtilities {
 
 		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<String> 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))
@@ -639,35 +600,29 @@ public final class FileUtilities {
 			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.
 	 */