X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2FTempFiles.java;fp=src%2Fbe%2Fnikiroo%2Futils%2FTempFiles.java;h=b54f0bc3e7ae5642cb9e3c8a135ac656eed4dee9;hp=0000000000000000000000000000000000000000;hb=d46b7b96f94e88a776bcd2dfd756549ffb300cc9;hpb=c9994f27667bc421bcd448d39e55774fddf5c431

diff --git a/src/be/nikiroo/utils/TempFiles.java b/src/be/nikiroo/utils/TempFiles.java
new file mode 100644
index 0000000..b54f0bc
--- /dev/null
+++ b/src/be/nikiroo/utils/TempFiles.java
@@ -0,0 +1,187 @@
+package be.nikiroo.utils;
+
+import java.io.Closeable;
+import java.io.File;
+import java.io.IOException;
+
+/**
+ * A small utility class to generate auto-delete temporary files in a
+ * centralised location.
+ * 
+ * @author niki
+ */
+public class TempFiles implements Closeable {
+	/**
+	 * Root directory of this instance, owned by it, where all temporary files
+	 * must reside.
+	 */
+	protected File root;
+
+	/**
+	 * Create a new {@link TempFiles} -- each instance is separate and have a
+	 * dedicated sub-directory in a shared temporary root.
+	 * <p>
+	 * The whole repository will be deleted on close (if you fail to call it,
+	 * the program will <b>try</b> to call it on JVM termination).
+	 * 
+	 * @param name
+	 *            the instance name (will be <b>part</b> of the final directory
+	 *            name)
+	 * 
+	 * @throws IOException
+	 *             in case of I/O error
+	 */
+	public TempFiles(String name) throws IOException {
+		this(null, name);
+	}
+
+	/**
+	 * Create a new {@link TempFiles} -- each instance is separate and have a
+	 * dedicated sub-directory in a given temporary root.
+	 * <p>
+	 * The whole repository will be deleted on close (if you fail to call it,
+	 * the program will <b>try</b> to call it on JVM termination).
+	 * <p>
+	 * Be careful, this instance will <b>own</b> the given root directory, and
+	 * will most probably delete all its files.
+	 * 
+	 * @param base
+	 *            the root base directory to use for all the temporary files of
+	 *            this instance (if NULL, will be the default temporary
+	 *            directory of the OS)
+	 * @param name
+	 *            the instance name (will be <b>part</b> of the final directory
+	 *            name)
+	 * 
+	 * @throws IOException
+	 *             in case of I/O error
+	 */
+	public TempFiles(File base, String name) throws IOException {
+		if (base == null) {
+			base = File.createTempFile(".temp", "");
+		}
+
+		root = base;
+
+		if (root.exists()) {
+			IOUtils.deltree(root, true);
+		}
+
+		root = new File(root.getParentFile(), ".temp");
+		root.mkdir();
+		if (!root.exists()) {
+			throw new IOException("Cannot create root directory: " + root);
+		}
+
+		root.deleteOnExit();
+
+		root = createTempFile(name);
+		IOUtils.deltree(root, true);
+
+		root.mkdir();
+		if (!root.exists()) {
+			throw new IOException("Cannot create root subdirectory: " + root);
+		}
+	}
+
+	/**
+	 * Create an auto-delete temporary file.
+	 * 
+	 * @param name
+	 *            a base for the final filename (only a <b>part</b> of said
+	 *            filename)
+	 * 
+	 * @return the newly created file
+	 * 
+	 * @throws IOException
+	 *             in case of I/O errors
+	 */
+	public synchronized File createTempFile(String name) throws IOException {
+		name += "_";
+		while (name.length() < 3) {
+			name += "_";
+		}
+
+		while (true) {
+			File tmp = File.createTempFile(name, "");
+			IOUtils.deltree(tmp, true);
+
+			File test = new File(root, tmp.getName());
+			if (!test.exists()) {
+				test.createNewFile();
+				if (!test.exists()) {
+					throw new IOException(
+							"Cannot create temporary file: " + test);
+				}
+
+				test.deleteOnExit();
+				return test;
+			}
+		}
+	}
+
+	/**
+	 * Create an auto-delete temporary directory.
+	 * <p>
+	 * Note that creating 2 temporary directories with the same name will result
+	 * in two <b>different</b> directories, even if the final name is the same
+	 * (the absolute path will be different).
+	 * 
+	 * @param name
+	 *            the actual directory name (not path)
+	 * 
+	 * @return the newly created file
+	 * 
+	 * @throws IOException
+	 *             in case of I/O errors, or if the name was a path instead of a
+	 *             name
+	 */
+	public synchronized File createTempDir(String name) throws IOException {
+		File localRoot = createTempFile(name);
+		IOUtils.deltree(localRoot, true);
+
+		localRoot.mkdir();
+		if (!localRoot.exists()) {
+			throw new IOException("Cannot create subdirectory: " + localRoot);
+		}
+
+		File dir = new File(localRoot, name);
+		if (!dir.getName().equals(name)) {
+			throw new IOException(
+					"Cannot create temporary directory with a path, only names are allowed: "
+							+ dir);
+		}
+
+		dir.mkdir();
+		dir.deleteOnExit();
+
+		if (!dir.exists()) {
+			throw new IOException("Cannot create subdirectory: " + dir);
+		}
+
+		return dir;
+	}
+
+	@Override
+	public synchronized void close() throws IOException {
+		File root = this.root;
+		this.root = null;
+
+		if (root != null) {
+			IOUtils.deltree(root);
+
+			// Since we allocate temp directories from a base point,
+			// try and remove that base point
+			root.getParentFile().delete(); // (only works if empty)
+		}
+	}
+
+	@Override
+	protected void finalize() throws Throwable {
+		try {
+			close();
+		} finally {
+			super.finalize();
+		}
+	}
+}