core/src/main/java/org/apache/oozie/util/IOUtils.java - oozie - Git at Google

 /**
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 package org.apache.oozie.util;

 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStream;
 import java.io.Reader;
 import java.io.Writer;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.io.Closeable;
 import java.nio.charset.StandardCharsets;
 import java.util.Objects;
 import java.util.zip.ZipOutputStream;
 import java.util.zip.ZipEntry;
 import java.util.jar.JarOutputStream;
 import java.util.jar.Manifest;

 /**
  * IO Utility methods.
  */
 public abstract class IOUtils {

     /**
      * Delete recursively a local directory.
      *
      * @param file directory to delete.
      * @throws IOException thrown if the directory could not be deleted.
      */
     public static void delete(File file) throws IOException {
         Objects.requireNonNull(file, "file cannot be null");
         if (file.getAbsolutePath().length() < 5) {
             throw new RuntimeException(XLog.format("Path[{0}] is too short, not deleting", file.getAbsolutePath()));
         }
         if (file.exists()) {
             if (file.isDirectory()) {
                 File[] children = file.listFiles();
                 if (children != null) {
                     for (File child : children) {
                         delete(child);
                     }
                 }
             }
             if (!file.delete()) {
                 throw new RuntimeException(XLog.format("Could not delete path[{0}]", file.getAbsolutePath()));
             }
         }
     }

     /**
      * Return a reader as string. <p>
      *
      * @param reader reader to read into a string.
      * @param maxLen max content length allowed, if -1 there is no limit.
      * @return the reader content.
      * @throws IOException thrown if the resource could not be read.
      */
     public static String getReaderAsString(Reader reader, int maxLen) throws IOException {
         Objects.requireNonNull(reader, "reader cannot be null");
         StringBuffer sb = new StringBuffer();
         char[] buffer = new char[2048];
         int read;
         int count = 0;
         while ((read = reader.read(buffer)) > -1) {
             count += read;
             if (maxLen > -1 && count > maxLen) {
                 throw new IllegalArgumentException(XLog.format("stream exceeds limit [{0}]", maxLen));
             }
             sb.append(buffer, 0, read);
         }
         reader.close();
         return sb.toString();
     }


     /**
      * Return a classpath resource as a stream. <p>
      *
      * @param path classpath for the resource.
      * @param maxLen max content length allowed.
      * @return the stream for the resource.
      * @throws IOException thrown if the resource could not be read.
      */
     public static InputStream getResourceAsStream(String path, int maxLen) throws IOException {
         ParamChecker.notEmpty(path, "path");
         InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(path);
         if (is == null) {
             throw new IllegalArgumentException(XLog.format("resource [{0}] not found", path));
         }
         return is;
     }

     /**
      * Return a classpath resource as a reader. <p> It is assumed that the resource is a text resource.
      *
      * @param path classpath for the resource.
      * @param maxLen max content length allowed.
      * @return the reader for the resource.
      * @throws IOException thrown if the resource could not be read.
      */
     public static Reader getResourceAsReader(String path, int maxLen) throws IOException {
         return new InputStreamReader(getResourceAsStream(path, maxLen), StandardCharsets.UTF_8);
     }

     /**
      * Return a classpath resource as string. <p> It is assumed that the resource is a text resource.
      *
      * @param path classpath for the resource.
      * @param maxLen max content length allowed.
      * @return the resource content.
      * @throws IOException thrown if the resource could not be read.
      */
     public static String getResourceAsString(String path, int maxLen) throws IOException {
         ParamChecker.notEmpty(path, "path");
         InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(path);
         if (is == null) {
             throw new IllegalArgumentException(XLog.format("resource [{0}] not found", path));
         }
         Reader reader = new InputStreamReader(is, StandardCharsets.UTF_8);
         return getReaderAsString(reader, maxLen);
     }

     /**
      * Copies an inputstream into an output stream.
      *
      * @param is inputstream to copy from.
      * @param os outputstream to  copy to.
      * @throws IOException thrown if the copy failed.
      */
     public static void copyStream(InputStream is, OutputStream os) throws IOException {
         Objects.requireNonNull(is, "is cannot be null");
         Objects.requireNonNull(os, "os cannot be null");
         byte[] buffer = new byte[4096];
         int read;
         while ((read = is.read(buffer)) > -1) {
             os.write(buffer, 0, read);
         }
         os.close();
         is.close();
     }

     /**
      * Copies an char input stream into an char output stream.
      *
      * @param reader reader to copy from.
      * @param writer writer to  copy to.
      * @throws IOException thrown if the copy failed.
      */
     public static void copyCharStream(Reader reader, Writer writer) throws IOException {
         Objects.requireNonNull(reader, "reader cannot be null");
         Objects.requireNonNull(writer, "writer cannot be null");
         char[] buffer = new char[4096];
         int read;
         while ((read = reader.read(buffer)) > -1) {
             writer.write(buffer, 0, read);
         }
         writer.close();
         reader.close();
     }

     /**
      * Zips a local directory, recursively, into a ZIP stream.
      *
      * @param dir directory to ZIP.
      * @param relativePath basePath in the ZIP for the files, normally "/".
      * @param zos the ZIP output stream to ZIP the directory.
      * @throws java.io.IOException thrown if the directory could not be zipped.
      */
     public static void zipDir(File dir, String relativePath, ZipOutputStream zos) throws IOException {
         zipDir(dir, relativePath, zos, true);
         zos.close();
     }

     private static void zipDir(File dir, String relativePath, ZipOutputStream zos, boolean start) throws IOException {
         String[] dirList = dir.list();

         if (dirList != null) {
             for (String aDirList : dirList) {
                 File f = new File(dir, aDirList);
                 if (!f.isHidden()) {
                     if (f.isDirectory()) {
                         if (!start) {
                             ZipEntry dirEntry = new ZipEntry(relativePath + f.getName() + "/");
                             zos.putNextEntry(dirEntry);
                             zos.closeEntry();
                         }
                         String filePath = f.getPath();
                         File file = new File(filePath);
                         zipDir(file, relativePath + f.getName() + "/", zos, false);
                     }
                     else {
                         ZipEntry anEntry = new ZipEntry(relativePath + f.getName());
                         zos.putNextEntry(anEntry);
                         InputStream is = new FileInputStream(f);
                         byte[] arr = new byte[4096];
                         int read = is.read(arr);
                         while (read > -1) {
                             zos.write(arr, 0, read);
                             read = is.read(arr);
                         }
                         is.close();
                         zos.closeEntry();
                     }
                 }
             }
         }
     }

     /**
      * Creates a JAR file with the specified classes.
      *
      * @param baseDir local directory to create the JAR file, the staging 'classes' directory is created in there.
      * @param jarName JAR file name, including extesion.
      * @param classes classes to add to the JAR.
      * @return an absolute File to the created JAR file.
      * @throws java.io.IOException thrown if the JAR file could not be created.
      */
     public static File createJar(File baseDir, String jarName, Class... classes) throws IOException {
         File classesDir = new File(baseDir, "classes");
         for (Class clazz : classes) {
             String classPath = clazz.getName().replace(".", "/") + ".class";
             String classFileName = classPath;
             if (classPath.lastIndexOf("/") > -1) {
                 classFileName = classPath.substring(classPath.lastIndexOf("/") + 1);
             }
             String packagePath = new File(classPath).getParent();
             File dir = new File(classesDir, packagePath);
             if (!dir.exists()) {
                 if (!dir.mkdirs()) {
                     throw new IOException(XLog.format("could not create dir [{0}]", dir));
                 }
             }
             InputStream is = getResourceAsStream(classPath, -1);
             OutputStream os = new FileOutputStream(new File(dir, classFileName));
             copyStream(is, os);
         }
         File jar = new File(baseDir, jarName);
         File jarDir = jar.getParentFile();
         if (!jarDir.exists()) {
             if (!jarDir.mkdirs()) {
                 throw new IOException(XLog.format("could not create dir [{0}]", jarDir));
             }
         }
         JarOutputStream zos = new JarOutputStream(new FileOutputStream(jar), new Manifest());
         zipDir(classesDir, "", zos);
         return jar;
     }

     /**
      * Close a list of resources. <p> Any thrown exceptions are suppressed.
      * @param objects list of objects to close
      */
     public static void closeSafely(Closeable... objects) {
         for (Closeable object : objects) {
             try {
                 if (null != object) {
                     object.close();
                 }
             } catch (Throwable th) {
                 // ignore
             }
         }
     }
 }
	/**
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you under the Apache License, Version 2.0 (the
	* "License"); you may not use this file except in compliance
	* with the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	package org.apache.oozie.util;

	import java.io.IOException;
	import java.io.InputStream;
	import java.io.InputStreamReader;
	import java.io.OutputStream;
	import java.io.Reader;
	import java.io.Writer;
	import java.io.File;
	import java.io.FileInputStream;
	import java.io.FileOutputStream;
	import java.io.Closeable;
	import java.nio.charset.StandardCharsets;
	import java.util.Objects;
	import java.util.zip.ZipOutputStream;
	import java.util.zip.ZipEntry;
	import java.util.jar.JarOutputStream;
	import java.util.jar.Manifest;

	/**
	* IO Utility methods.
	*/
	public abstract class IOUtils {

	/**
	* Delete recursively a local directory.
	*
	* @param file directory to delete.
	* @throws IOException thrown if the directory could not be deleted.
	*/
	public static void delete(File file) throws IOException {
	Objects.requireNonNull(file, "file cannot be null");
	if (file.getAbsolutePath().length() < 5) {
	throw new RuntimeException(XLog.format("Path[{0}] is too short, not deleting", file.getAbsolutePath()));
	}
	if (file.exists()) {
	if (file.isDirectory()) {
	File[] children = file.listFiles();
	if (children != null) {
	for (File child : children) {
	delete(child);
	}
	}
	}
	if (!file.delete()) {
	throw new RuntimeException(XLog.format("Could not delete path[{0}]", file.getAbsolutePath()));
	}
	}
	}

	/**
	* Return a reader as string. <p>
	*
	* @param reader reader to read into a string.
	* @param maxLen max content length allowed, if -1 there is no limit.
	* @return the reader content.
	* @throws IOException thrown if the resource could not be read.
	*/
	public static String getReaderAsString(Reader reader, int maxLen) throws IOException {
	Objects.requireNonNull(reader, "reader cannot be null");
	StringBuffer sb = new StringBuffer();
	char[] buffer = new char[2048];
	int read;
	int count = 0;
	while ((read = reader.read(buffer)) > -1) {
	count += read;
	if (maxLen > -1 && count > maxLen) {
	throw new IllegalArgumentException(XLog.format("stream exceeds limit [{0}]", maxLen));
	}
	sb.append(buffer, 0, read);
	}
	reader.close();
	return sb.toString();
	}


	/**
	* Return a classpath resource as a stream. <p>
	*
	* @param path classpath for the resource.
	* @param maxLen max content length allowed.
	* @return the stream for the resource.
	* @throws IOException thrown if the resource could not be read.
	*/
	public static InputStream getResourceAsStream(String path, int maxLen) throws IOException {
	ParamChecker.notEmpty(path, "path");
	InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(path);
	if (is == null) {
	throw new IllegalArgumentException(XLog.format("resource [{0}] not found", path));
	}
	return is;
	}

	/**
	* Return a classpath resource as a reader. <p> It is assumed that the resource is a text resource.
	*
	* @param path classpath for the resource.
	* @param maxLen max content length allowed.
	* @return the reader for the resource.
	* @throws IOException thrown if the resource could not be read.
	*/
	public static Reader getResourceAsReader(String path, int maxLen) throws IOException {
	return new InputStreamReader(getResourceAsStream(path, maxLen), StandardCharsets.UTF_8);
	}

	/**
	* Return a classpath resource as string. <p> It is assumed that the resource is a text resource.
	*
	* @param path classpath for the resource.
	* @param maxLen max content length allowed.
	* @return the resource content.
	* @throws IOException thrown if the resource could not be read.
	*/
	public static String getResourceAsString(String path, int maxLen) throws IOException {
	ParamChecker.notEmpty(path, "path");
	InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(path);
	if (is == null) {
	throw new IllegalArgumentException(XLog.format("resource [{0}] not found", path));
	}
	Reader reader = new InputStreamReader(is, StandardCharsets.UTF_8);
	return getReaderAsString(reader, maxLen);
	}

	/**
	* Copies an inputstream into an output stream.
	*
	* @param is inputstream to copy from.
	* @param os outputstream to copy to.
	* @throws IOException thrown if the copy failed.
	*/
	public static void copyStream(InputStream is, OutputStream os) throws IOException {
	Objects.requireNonNull(is, "is cannot be null");
	Objects.requireNonNull(os, "os cannot be null");
	byte[] buffer = new byte[4096];
	int read;
	while ((read = is.read(buffer)) > -1) {
	os.write(buffer, 0, read);
	}
	os.close();
	is.close();
	}

	/**
	* Copies an char input stream into an char output stream.
	*
	* @param reader reader to copy from.
	* @param writer writer to copy to.
	* @throws IOException thrown if the copy failed.
	*/
	public static void copyCharStream(Reader reader, Writer writer) throws IOException {
	Objects.requireNonNull(reader, "reader cannot be null");
	Objects.requireNonNull(writer, "writer cannot be null");
	char[] buffer = new char[4096];
	int read;
	while ((read = reader.read(buffer)) > -1) {
	writer.write(buffer, 0, read);
	}
	writer.close();
	reader.close();
	}

	/**
	* Zips a local directory, recursively, into a ZIP stream.
	*
	* @param dir directory to ZIP.
	* @param relativePath basePath in the ZIP for the files, normally "/".
	* @param zos the ZIP output stream to ZIP the directory.
	* @throws java.io.IOException thrown if the directory could not be zipped.
	*/
	public static void zipDir(File dir, String relativePath, ZipOutputStream zos) throws IOException {
	zipDir(dir, relativePath, zos, true);
	zos.close();
	}

	private static void zipDir(File dir, String relativePath, ZipOutputStream zos, boolean start) throws IOException {
	String[] dirList = dir.list();

	if (dirList != null) {
	for (String aDirList : dirList) {
	File f = new File(dir, aDirList);
	if (!f.isHidden()) {
	if (f.isDirectory()) {
	if (!start) {
	ZipEntry dirEntry = new ZipEntry(relativePath + f.getName() + "/");
	zos.putNextEntry(dirEntry);
	zos.closeEntry();
	}
	String filePath = f.getPath();
	File file = new File(filePath);
	zipDir(file, relativePath + f.getName() + "/", zos, false);
	}
	else {
	ZipEntry anEntry = new ZipEntry(relativePath + f.getName());
	zos.putNextEntry(anEntry);
	InputStream is = new FileInputStream(f);
	byte[] arr = new byte[4096];
	int read = is.read(arr);
	while (read > -1) {
	zos.write(arr, 0, read);
	read = is.read(arr);
	}
	is.close();
	zos.closeEntry();
	}
	}
	}
	}
	}

	/**
	* Creates a JAR file with the specified classes.
	*
	* @param baseDir local directory to create the JAR file, the staging 'classes' directory is created in there.
	* @param jarName JAR file name, including extesion.
	* @param classes classes to add to the JAR.
	* @return an absolute File to the created JAR file.
	* @throws java.io.IOException thrown if the JAR file could not be created.
	*/
	public static File createJar(File baseDir, String jarName, Class... classes) throws IOException {
	File classesDir = new File(baseDir, "classes");
	for (Class clazz : classes) {
	String classPath = clazz.getName().replace(".", "/") + ".class";
	String classFileName = classPath;
	if (classPath.lastIndexOf("/") > -1) {
	classFileName = classPath.substring(classPath.lastIndexOf("/") + 1);
	}
	String packagePath = new File(classPath).getParent();
	File dir = new File(classesDir, packagePath);
	if (!dir.exists()) {
	if (!dir.mkdirs()) {
	throw new IOException(XLog.format("could not create dir [{0}]", dir));
	}
	}
	InputStream is = getResourceAsStream(classPath, -1);
	OutputStream os = new FileOutputStream(new File(dir, classFileName));
	copyStream(is, os);
	}
	File jar = new File(baseDir, jarName);
	File jarDir = jar.getParentFile();
	if (!jarDir.exists()) {
	if (!jarDir.mkdirs()) {
	throw new IOException(XLog.format("could not create dir [{0}]", jarDir));
	}
	}
	JarOutputStream zos = new JarOutputStream(new FileOutputStream(jar), new Manifest());
	zipDir(classesDir, "", zos);
	return jar;
	}

	/**
	* Close a list of resources. <p> Any thrown exceptions are suppressed.
	* @param objects list of objects to close
	*/
	public static void closeSafely(Closeable... objects) {
	for (Closeable object : objects) {
	try {
	if (null != object) {
	object.close();
	}
	} catch (Throwable th) {
	// ignore
	}
	}
	}
	}