Moved general purpose stuff into util, renamed utils->util

2014-04-16 14:32:56 +02:00
parent e58156b7ee
commit 6843e746bc
208 changed files with 656 additions and 629 deletions
@@ -0,0 +1,130 @@
+package mightypork.util.files.zip;
+
+
+import java.io.BufferedOutputStream;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.HashSet;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
+
+import mightypork.util.files.FileUtils;
+import mightypork.util.logging.Log;
+
+
+/**
+ * Class for building a zip file
+ * 
+ * @author MightyPork
+ */
+public class ZipBuilder {
+	
+	private final ZipOutputStream out;
+	private final HashSet<String> included = new HashSet<>();
+	
+	
+	/**
+	 * @param target target zip file
+	 * @throws IOException if the file is directory or cannot be created
+	 */
+	public ZipBuilder(File target) throws IOException {
+		
+		if (!target.getParentFile().mkdirs()) throw new IOException("Could not create output directory.");
+		
+		final FileOutputStream dest = new FileOutputStream(target);
+		out = new ZipOutputStream(new BufferedOutputStream(dest));
+	}
+	
+	
+	/**
+	 * Add stream to a path
+	 * 
+	 * @param path path
+	 * @param in stream
+	 * @throws IOException
+	 */
+	public void addStream(String path, InputStream in) throws IOException
+	{
+		path = preparePath(path);
+		if (included.contains(path)) {
+			Log.f3("Zip already contains file " + path + ", skipping.");
+			return; // ignore
+		}
+		included.add(path);
+		
+		out.putNextEntry(new ZipEntry(path));
+		
+		FileUtils.copyStream(in, out);
+	}
+	
+	
+	/**
+	 * Add string as a file
+	 * 
+	 * @param path path
+	 * @param text text to write
+	 * @throws IOException
+	 */
+	public void addString(String path, String text) throws IOException
+	{
+		path = preparePath(path);
+		if (included.contains(path)) return; // ignore
+		included.add(path);
+		
+		out.putNextEntry(new ZipEntry(path));
+		
+		try (InputStream in = FileUtils.stringToStream(text)) {
+			FileUtils.copyStream(in, out);
+		}
+	}
+	
+	
+	/**
+	 * Add resource obtained via FileUtils.getResource()
+	 * 
+	 * @param path path
+	 * @param resPath resource path
+	 * @throws IOException
+	 */
+	public void addResource(String path, String resPath) throws IOException
+	{
+		path = preparePath(path);
+		if (included.contains(path)) return; // ignore
+		included.add(path);
+		
+		out.putNextEntry(new ZipEntry(path));
+		
+		try (InputStream in = FileUtils.getResource(resPath)) {
+			FileUtils.copyStream(in, out);
+		}
+	}
+	
+	
+	/**
+	 * Normalize path
+	 * 
+	 * @param path original path
+	 * @return normalized path
+	 */
+	private static String preparePath(String path)
+	{
+		path = path.replace("\\", "/");
+		
+		if (path.charAt(0) == '/') path = path.substring(1);
+		
+		return path;
+	}
+	
+	
+	/**
+	 * Close the zip stream
+	 * 
+	 * @throws IOException
+	 */
+	public void close() throws IOException
+	{
+		out.close();
+	}
+}
@@ -0,0 +1,179 @@
+package mightypork.util.files.zip;
+
+
+import java.io.*;
+import java.util.ArrayList;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipFile;
+
+import mightypork.util.files.FileUtils;
+import mightypork.util.logging.Log;
+import mightypork.util.string.validation.StringFilter;
+
+
+/**
+ * Utilities for manipulating zip files
+ * 
+ * @author MightyPork
+ */
+public class ZipUtils {
+	
+	private static final int BUFFER_SIZE = 2048;
+	
+	
+	/**
+	 * Extract zip file to target directory
+	 * 
+	 * @param file zip file
+	 * @param outputDir target directory
+	 * @param filter string filter (will be used to test entry names (paths))
+	 * @return list of entries extracted (paths)
+	 * @throws IOException
+	 */
+	public static List<String> extractZip(File file, File outputDir, StringFilter filter) throws IOException
+	{
+		try (ZipFile zip = new ZipFile(file)) {
+			return extractZip(zip, outputDir, filter);
+		}
+	}
+	
+	
+	/**
+	 * Extract zip file to target directory
+	 * 
+	 * @param zip open zip file
+	 * @param outputDir target directory
+	 * @param filter string filter (will be used to test entry names (paths))
+	 * @return list of entries extracted (paths)
+	 * @throws IOException if the file)s) cannot be created
+	 */
+	public static List<String> extractZip(ZipFile zip, File outputDir, StringFilter filter) throws IOException
+	{
+		final ArrayList<String> files = new ArrayList<>();
+		
+		if (!outputDir.mkdirs()) throw new IOException("Could not create output directory.");
+		
+		final Enumeration<? extends ZipEntry> zipFileEntries = zip.entries();
+		
+		// process each entry
+		while (zipFileEntries.hasMoreElements()) {
+			final ZipEntry entry = zipFileEntries.nextElement();
+			
+			// parse filename and path
+			final String entryPath = entry.getName();
+			final File destFile = new File(outputDir, entryPath);
+			final File destinationParent = destFile.getParentFile();
+			
+			if (entry.isDirectory() || (filter != null && !filter.accept(entryPath))) continue;
+			
+			// make sure directories exist
+			if (!destinationParent.mkdirs()) throw new IOException("Could not create directory.");
+			
+			if (!entry.isDirectory()) {
+				extractZipEntry(zip, entry, destFile);
+				files.add(entryPath);
+			}
+		}
+		
+		return files;
+	}
+	
+	
+	/**
+	 * Read zip entries and add their paths to a list
+	 * 
+	 * @param zipFile open zip file
+	 * @return list of entry names
+	 * @throws IOException on error
+	 */
+	public static List<String> listZip(File zipFile) throws IOException
+	{
+		try (ZipFile zip = new ZipFile(zipFile)) {
+			return listZip(zip);
+		}
+	}
+	
+	
+	/**
+	 * Read zip entries and add their paths to a list
+	 * 
+	 * @param zip open zip file
+	 * @return list of entry names
+	 * @throws IOException on error
+	 */
+	public static List<String> listZip(ZipFile zip) throws IOException
+	{
+		final ArrayList<String> files = new ArrayList<>();
+		
+		final Enumeration<? extends ZipEntry> zipFileEntries = zip.entries();
+		
+		// process each entry
+		while (zipFileEntries.hasMoreElements()) {
+			final ZipEntry entry = zipFileEntries.nextElement();
+			
+			if (!entry.isDirectory()) {
+				files.add(entry.getName());
+			}
+		}
+		
+		return files;
+	}
+	
+	
+	/**
+	 * Extract one zip entry to target file
+	 * 
+	 * @param zip open zip file
+	 * @param entry entry from the zip file
+	 * @param destFile destination file ((NOT directory!)
+	 * @throws IOException on error
+	 */
+	public static void extractZipEntry(ZipFile zip, ZipEntry entry, File destFile) throws IOException
+	{
+		if (!destFile.getParentFile().mkdirs()) throw new IOException("Could not create output directory.");
+		
+		try (InputStream in = zip.getInputStream(entry); BufferedInputStream is = new BufferedInputStream(in); FileOutputStream fos = new FileOutputStream(destFile); BufferedOutputStream dest = new BufferedOutputStream(fos, BUFFER_SIZE)) {
+			
+			FileUtils.copyStream(is, dest);
+		}
+	}
+	
+	
+	/**
+	 * Load zip entry to String
+	 * 
+	 * @param zip open zip file
+	 * @param entry entry from the zip file
+	 * @return loaded string
+	 * @throws IOException on error
+	 */
+	public static String zipEntryToString(ZipFile zip, ZipEntry entry) throws IOException
+	{
+		BufferedInputStream is = null;
+		try {
+			is = new BufferedInputStream(zip.getInputStream(entry));
+			final String s = FileUtils.streamToString(is);
+			return s;
+		} finally {
+			try {
+				if (is != null) is.close();
+			} catch (final IOException e) {
+				// ignore
+			}
+		}
+	}
+	
+	
+	public static boolean entryExists(File selectedFile, String string)
+	{
+		try (ZipFile zf = new ZipFile(selectedFile)) {
+			return zf.getEntry(string) != null;
+		} catch (final IOException | RuntimeException e) {
+			Log.w("Error reading zip.", e);
+			return false;
+		}
+		
+	}
+}