fileinstall/src/main/java/org/apache/felix/fileinstall/util/Util.java - onos-felix - Gitiles

 /*
  * 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.felix.fileinstall.util;

 import java.io.IOException;
 import java.io.FileInputStream;
 import java.io.File;
 import java.io.BufferedOutputStream;
 import java.io.FileOutputStream;
 import java.util.Dictionary;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Enumeration;
 import java.util.Set;
 import java.util.Collections;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 import java.util.jar.JarFile;
 import java.util.jar.JarOutputStream;

 import org.osgi.service.log.LogService;
 import org.osgi.framework.ServiceReference;
 import org.osgi.framework.BundleContext;

 public class Util
 {
     private static final String DELIM_START = "${";
     private static final String DELIM_STOP = "}";

     /**
      * Perform substitution on a property set
      *
      * @param properties the property set to perform substitution on
      */
     public static void performSubstitution(Dictionary properties)
     {
         for (Enumeration e = properties.keys(); e.hasMoreElements(); )
         {
             String name = (String) e.nextElement();
             Object value = properties.get(name);
             properties.put(name,
                 value instanceof String
                     ? Util.substVars((String) value, name, null, properties)
                     : value);
         }
     }

     /**
      * <p>
      * This method performs property variable substitution on the
      * specified value. If the specified value contains the syntax
      * <tt>${&lt;prop-name&gt;}</tt>, where <tt>&lt;prop-name&gt;</tt>
      * refers to either a configuration property or a system property,
      * then the corresponding property value is substituted for the variable
      * placeholder. Multiple variable placeholders may exist in the
      * specified value as well as nested variable placeholders, which
      * are substituted from inner most to outer most. Configuration
      * properties override system properties.
      * </p>
      * @param val The string on which to perform property substitution.
      * @param currentKey The key of the property being evaluated used to
      *        detect cycles.
      * @param cycleMap Map of variable references used to detect nested cycles.
      * @param configProps Set of configuration properties.
      * @return The value of the specified string after system property substitution.
      * @throws IllegalArgumentException If there was a syntax error in the
      *         property placeholder syntax or a recursive variable reference.
      **/
     public static String substVars(String val, String currentKey, Map cycleMap, Dictionary configProps)
         throws IllegalArgumentException
     {
         if (cycleMap == null)
         {
             cycleMap = new HashMap();
         }

         // Put the current key in the cycle map.
         cycleMap.put(currentKey, currentKey);

         // Assume we have a value that is something like:
         // "leading ${foo.${bar}} middle ${baz} trailing"

         // Find the first ending '}' variable delimiter, which
         // will correspond to the first deepest nested variable
         // placeholder.
         int stopDelim = val.indexOf(DELIM_STOP);

         // Find the matching starting "${" variable delimiter
         // by looping until we find a start delimiter that is
         // greater than the stop delimiter we have found.
         int startDelim = val.indexOf(DELIM_START);
         while (stopDelim >= 0)
         {
             int idx = val.indexOf(DELIM_START, startDelim + DELIM_START.length());
             if ((idx < 0) || (idx > stopDelim))
             {
                 break;
             }
             else if (idx < stopDelim)
             {
                 startDelim = idx;
             }
         }

         // If we do not have a start or stop delimiter, then just
         // return the existing value.
         if ((startDelim < 0) || (stopDelim < 0))
         {
             return val;
         }

         // At this point, we have found a variable placeholder so
         // we must perform a variable substitution on it.
         // Using the start and stop delimiter indices, extract
         // the first, deepest nested variable placeholder.
         String variable = val.substring(startDelim + DELIM_START.length(), stopDelim);

         // Verify that this is not a recursive variable reference.
         if (cycleMap.get(variable) != null)
         {
             throw new IllegalArgumentException("recursive variable reference: " + variable);
         }

         // Get the value of the deepest nested variable placeholder.
         // Try to configuration properties first.
         String substValue = (String) ((configProps != null) ? configProps.get(variable) : null);
         if (substValue == null)
         {
             // Ignore unknown property values.
             substValue = System.getProperty(variable, "");
         }

         // Remove the found variable from the cycle map, since
         // it may appear more than once in the value and we don't
         // want such situations to appear as a recursive reference.
         cycleMap.remove(variable);

         // Append the leading characters, the substituted value of
         // the variable, and the trailing characters to get the new
         // value.
         val = val.substring(0, startDelim) + substValue + val.substring(stopDelim + DELIM_STOP.length(), val.length());

         // Now perform substitution again, since there could still
         // be substitutions to make.
         val = substVars(val, currentKey, cycleMap, configProps);

         // Return the value.
         return val;
     }

     /**
      * Log a message and optional throwable. If there is a log service we use
      * it, otherwise we log to the console
      *
      * @param message
      *            The message to log
      * @param e
      *            The throwable to log
      */
     public static void log(BundleContext context, long debug, String message, Throwable e)
     {
         LogService log = getLogService(context);
         if (log == null)
         {
             System.out.println(message + (e == null ? "" : ": " + e));
             if (debug > 0 && e != null)
             {
                 e.printStackTrace(System.out);
             }
         }
         else
         {
             if (e != null)
             {
                 log.log(LogService.LOG_ERROR, message, e);
                 if (debug > 0 && e != null)
                 {
                     e.printStackTrace();
                 }
             }
             else
             {
                 log.log(LogService.LOG_INFO, message);
             }
         }
     }

     /**
      * Answer the Log Service
      *
      * @return
      */
     private static LogService getLogService(BundleContext context)
     {
         ServiceReference ref = context.getServiceReference(LogService.class.getName());
         if (ref != null)
         {
             LogService log = (LogService) context.getService(ref);
             return log;
         }
         return null;
     }

     /**
      * Jar up a directory
      *
      * @param directory
      * @param zipName
      * @throws IOException
      */
     public static void jarDir(File directory, File zipName) throws IOException {
         // create a ZipOutputStream to zip the data to
         JarOutputStream zos = new JarOutputStream(new BufferedOutputStream(new FileOutputStream(zipName)));
         String path = "";
         File manFile = new File(directory, JarFile.MANIFEST_NAME);
         if (manFile.exists()) {
             byte[] readBuffer = new byte[8192];
             FileInputStream fis = new FileInputStream(manFile);
             try {
                 ZipEntry anEntry = new ZipEntry(JarFile.MANIFEST_NAME);
                 zos.putNextEntry(anEntry);
                 int bytesIn = fis.read(readBuffer);
                 while (bytesIn != -1) {
                     zos.write(readBuffer, 0, bytesIn);
                     bytesIn = fis.read(readBuffer);
                 }
             } finally {
                 fis.close();
             }
             zos.closeEntry();
         }
         zipDir(directory, zos, path, Collections.singleton(JarFile.MANIFEST_NAME));
         // close the stream
         zos.close();
     }

     /**
      * Zip up a directory path
      * @param directory
      * @param zos
      * @param path
      * @param exclusions
      * @throws IOException
      */
     public static void zipDir(File directory, ZipOutputStream zos, String path, Set/* <String> */ exclusions) throws IOException {
         // get a listing of the directory content
         File[] dirList = directory.listFiles();
         byte[] readBuffer = new byte[8192];
         int bytesIn = 0;
         // loop through dirList, and zip the files
         for (int i = 0; i < dirList.length; i++) {
             File f = dirList[i];
             if (f.isDirectory()) {
                 zipDir(f, zos, path + f.getName() + "/", exclusions);
                 continue;
             }
             String entry = path + f.getName();
             if (!exclusions.contains(entry)) {
                 FileInputStream fis = new FileInputStream(f);
                 try {
                     ZipEntry anEntry = new ZipEntry(entry);
                     zos.putNextEntry(anEntry);
                     bytesIn = fis.read(readBuffer);
                     while (bytesIn != -1) {
                         zos.write(readBuffer, 0, bytesIn);
                         bytesIn = fis.read(readBuffer);
                     }
                 } finally {
                     fis.close();
                 }
             }
         }
     }

     /**
      * Return the latest time at which this file or any child if the file denotes
      * a directory has been modified
      *
      * @param file file or directory to check
      * @return the latest modification time
      */
     public static long getLastModified(File file)
     {
         if (file.isFile())
         {
             return file.lastModified();
         }
         else if (file.isDirectory())
         {
             File[] children = file.listFiles();
             long lastModified = 0;
             for (int i = 0; i < children.length; i++)
             {
                 lastModified = Math.max(lastModified, getLastModified(children[i]));
             }
             return lastModified;
         }
         else
         {
             return 0;
         }
     }

 }
	/*
	* 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.felix.fileinstall.util;

	import java.io.IOException;
	import java.io.FileInputStream;
	import java.io.File;
	import java.io.BufferedOutputStream;
	import java.io.FileOutputStream;
	import java.util.Dictionary;
	import java.util.HashMap;
	import java.util.Map;
	import java.util.Enumeration;
	import java.util.Set;
	import java.util.Collections;
	import java.util.zip.ZipEntry;
	import java.util.zip.ZipOutputStream;
	import java.util.jar.JarFile;
	import java.util.jar.JarOutputStream;

	import org.osgi.service.log.LogService;
	import org.osgi.framework.ServiceReference;
	import org.osgi.framework.BundleContext;

	public class Util
	{
	private static final String DELIM_START = "${";
	private static final String DELIM_STOP = "}";

	/**
	* Perform substitution on a property set
	*
	* @param properties the property set to perform substitution on
	*/
	public static void performSubstitution(Dictionary properties)
	{
	for (Enumeration e = properties.keys(); e.hasMoreElements(); )
	{
	String name = (String) e.nextElement();
	Object value = properties.get(name);
	properties.put(name,
	value instanceof String
	? Util.substVars((String) value, name, null, properties)
	: value);
	}
	}

	/**
	* <p>
	* This method performs property variable substitution on the
	* specified value. If the specified value contains the syntax
	* <tt>${<prop-name>}</tt>, where <tt><prop-name></tt>
	* refers to either a configuration property or a system property,
	* then the corresponding property value is substituted for the variable
	* placeholder. Multiple variable placeholders may exist in the
	* specified value as well as nested variable placeholders, which
	* are substituted from inner most to outer most. Configuration
	* properties override system properties.
	* </p>
	* @param val The string on which to perform property substitution.
	* @param currentKey The key of the property being evaluated used to
	* detect cycles.
	* @param cycleMap Map of variable references used to detect nested cycles.
	* @param configProps Set of configuration properties.
	* @return The value of the specified string after system property substitution.
	* @throws IllegalArgumentException If there was a syntax error in the
	* property placeholder syntax or a recursive variable reference.
	**/
	public static String substVars(String val, String currentKey, Map cycleMap, Dictionary configProps)
	throws IllegalArgumentException
	{
	if (cycleMap == null)
	{
	cycleMap = new HashMap();
	}

	// Put the current key in the cycle map.
	cycleMap.put(currentKey, currentKey);

	// Assume we have a value that is something like:
	// "leading ${foo.${bar}} middle ${baz} trailing"

	// Find the first ending '}' variable delimiter, which
	// will correspond to the first deepest nested variable
	// placeholder.
	int stopDelim = val.indexOf(DELIM_STOP);

	// Find the matching starting "${" variable delimiter
	// by looping until we find a start delimiter that is
	// greater than the stop delimiter we have found.
	int startDelim = val.indexOf(DELIM_START);
	while (stopDelim >= 0)
	{
	int idx = val.indexOf(DELIM_START, startDelim + DELIM_START.length());
	if ((idx < 0) \|\| (idx > stopDelim))
	{
	break;
	}
	else if (idx < stopDelim)
	{
	startDelim = idx;
	}
	}

	// If we do not have a start or stop delimiter, then just
	// return the existing value.
	if ((startDelim < 0) \|\| (stopDelim < 0))
	{
	return val;
	}

	// At this point, we have found a variable placeholder so
	// we must perform a variable substitution on it.
	// Using the start and stop delimiter indices, extract
	// the first, deepest nested variable placeholder.
	String variable = val.substring(startDelim + DELIM_START.length(), stopDelim);

	// Verify that this is not a recursive variable reference.
	if (cycleMap.get(variable) != null)
	{
	throw new IllegalArgumentException("recursive variable reference: " + variable);
	}

	// Get the value of the deepest nested variable placeholder.
	// Try to configuration properties first.
	String substValue = (String) ((configProps != null) ? configProps.get(variable) : null);
	if (substValue == null)
	{
	// Ignore unknown property values.
	substValue = System.getProperty(variable, "");
	}

	// Remove the found variable from the cycle map, since
	// it may appear more than once in the value and we don't
	// want such situations to appear as a recursive reference.
	cycleMap.remove(variable);

	// Append the leading characters, the substituted value of
	// the variable, and the trailing characters to get the new
	// value.
	val = val.substring(0, startDelim) + substValue + val.substring(stopDelim + DELIM_STOP.length(), val.length());

	// Now perform substitution again, since there could still
	// be substitutions to make.
	val = substVars(val, currentKey, cycleMap, configProps);

	// Return the value.
	return val;
	}

	/**
	* Log a message and optional throwable. If there is a log service we use
	* it, otherwise we log to the console
	*
	* @param message
	* The message to log
	* @param e
	* The throwable to log
	*/
	public static void log(BundleContext context, long debug, String message, Throwable e)
	{
	LogService log = getLogService(context);
	if (log == null)
	{
	System.out.println(message + (e == null ? "" : ": " + e));
	if (debug > 0 && e != null)
	{
	e.printStackTrace(System.out);
	}
	}
	else
	{
	if (e != null)
	{
	log.log(LogService.LOG_ERROR, message, e);
	if (debug > 0 && e != null)
	{
	e.printStackTrace();
	}
	}
	else
	{
	log.log(LogService.LOG_INFO, message);
	}
	}
	}

	/**
	* Answer the Log Service
	*
	* @return
	*/
	private static LogService getLogService(BundleContext context)
	{
	ServiceReference ref = context.getServiceReference(LogService.class.getName());
	if (ref != null)
	{
	LogService log = (LogService) context.getService(ref);
	return log;
	}
	return null;
	}

	/**
	* Jar up a directory
	*
	* @param directory
	* @param zipName
	* @throws IOException
	*/
	public static void jarDir(File directory, File zipName) throws IOException {
	// create a ZipOutputStream to zip the data to
	JarOutputStream zos = new JarOutputStream(new BufferedOutputStream(new FileOutputStream(zipName)));
	String path = "";
	File manFile = new File(directory, JarFile.MANIFEST_NAME);
	if (manFile.exists()) {
	byte[] readBuffer = new byte[8192];
	FileInputStream fis = new FileInputStream(manFile);
	try {
	ZipEntry anEntry = new ZipEntry(JarFile.MANIFEST_NAME);
	zos.putNextEntry(anEntry);
	int bytesIn = fis.read(readBuffer);
	while (bytesIn != -1) {
	zos.write(readBuffer, 0, bytesIn);
	bytesIn = fis.read(readBuffer);
	}
	} finally {
	fis.close();
	}
	zos.closeEntry();
	}
	zipDir(directory, zos, path, Collections.singleton(JarFile.MANIFEST_NAME));
	// close the stream
	zos.close();
	}

	/**
	* Zip up a directory path
	* @param directory
	* @param zos
	* @param path
	* @param exclusions
	* @throws IOException
	*/
	public static void zipDir(File directory, ZipOutputStream zos, String path, Set/* <String> */ exclusions) throws IOException {
	// get a listing of the directory content
	File[] dirList = directory.listFiles();
	byte[] readBuffer = new byte[8192];
	int bytesIn = 0;
	// loop through dirList, and zip the files
	for (int i = 0; i < dirList.length; i++) {
	File f = dirList[i];
	if (f.isDirectory()) {
	zipDir(f, zos, path + f.getName() + "/", exclusions);
	continue;
	}
	String entry = path + f.getName();
	if (!exclusions.contains(entry)) {
	FileInputStream fis = new FileInputStream(f);
	try {
	ZipEntry anEntry = new ZipEntry(entry);
	zos.putNextEntry(anEntry);
	bytesIn = fis.read(readBuffer);
	while (bytesIn != -1) {
	zos.write(readBuffer, 0, bytesIn);
	bytesIn = fis.read(readBuffer);
	}
	} finally {
	fis.close();
	}
	}
	}
	}

	/**
	* Return the latest time at which this file or any child if the file denotes
	* a directory has been modified
	*
	* @param file file or directory to check
	* @return the latest modification time
	*/
	public static long getLastModified(File file)
	{
	if (file.isFile())
	{
	return file.lastModified();
	}
	else if (file.isDirectory())
	{
	File[] children = file.listFiles();
	long lastModified = 0;
	for (int i = 0; i < children.length; i++)
	{
	lastModified = Math.max(lastModified, getLastModified(children[i]));
	}
	return lastModified;
	}
	else
	{
	return 0;
	}
	}

	}