/*
 * JBoss, Home of Professional Open Source
 * Copyright 2012, Red Hat Middleware LLC, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed 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.jboss.shrinkwrap.resolver.impl.maven.util;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.net.URISyntaxException;
import java.net.URL;

Simple shared utility to convert URL instances to File representation 
Author:
Andrew Lee Rubinger/**
 * Simple shared utility to convert {@link URL} instances to {@link File} representation
 *
 * @author <a href="mailto:alr@jboss.org">Andrew Lee Rubinger</a>
 */
public enum FileUtil {

    INSTANCE;

    
Creates a File representation from the given path in the specified ClassLoader 
Params:
path – A path
cl – A ClassLoader
Returns:
A File representation from the given path in the specified ClassLoader/**
     * Creates a {@link File} representation from the given path in the specified {@link ClassLoader}
     *
     * @param path A path
     * @param cl A {@link ClassLoader}
     * @return A {@link File} representation from the given path in the specified {@link ClassLoader}
     */
    public File fileFromClassLoaderResource(final String path, final ClassLoader cl) {
        assert path != null && path.length() > 0 : "path must be specified";
        assert cl != null : "ClassLoader is required";
        final URL url = cl.getResource(path);
        Validate.notNull(url, path + " doesn't exist or can't be accessed on from " + cl);
        // Safe file conversion adapted via: http://weblogs.java.net/blog/kohsuke/archive/2007/04/how_to_convert.html
        File file = null;
        try {
            file = new File(url.toURI());
            Validate.readable(file, "Should be readable");
        } catch (final IllegalArgumentException iae) {
            try {
                file = new File(url.getPath());
                Validate.readable(file, "Should be readable");
            } catch (final RuntimeException re) {
                file = null;
                // We'll deal with this later
            }
        } catch (final URISyntaxException e) {
            try {
                file = new File(url.getPath());
            } catch (final RuntimeException re) {
                // We'll deal with this later
                file = null;
            }
        }
        // Likely at this point we could obtain the resource, but it's nested in a JAR where we can't get it as a File,
        // so..
        if (file == null) {
            // Copy and retrieve from a tmp file
            try {
                final String localResourcePath = this.getLocalResourcePathFromResourceName(path, cl);
                file = new File(localResourcePath);
            } catch (final RuntimeException re) {
                // OK, give up
                throw new IllegalArgumentException("Resource + " + path + " in " + cl + " points to " + url.toString()
                        + ", and cannot be resolved as a " + File.class.getName());
            }
        }
        return file;
    }

    
Gets a resource from the TCCL and returns its name as resource in classpath.
Params:
resourceName – Is the name of the resource in the classpath
cl – A ClassLoader
Throws:
IllegalArgumentException – 
if resourceName doesn't exist in the classpath or privileges are not granted
Returns:
the file path for resourceName @see URL.getFile()/**
     * Gets a resource from the TCCL and returns its name as resource in classpath.
     *
     * @param resourceName Is the name of the resource in the classpath
     * @param cl A {@link ClassLoader}
     * @return the file path for resourceName @see {@link java.net.URL#getFile()}
     * @throws IllegalArgumentException
     * if resourceName doesn't exist in the classpath or privileges are not granted
     */
    private String getLocalResourcePathFromResourceName(final String resourceName, final ClassLoader cl) {
        final URL resourceUrl = cl.getResource(resourceName);
        Validate.notNull(resourceUrl, resourceName + " doesn't exist or can't be accessed on classpath");

        try {
            File localResource = temporaryFile(resourceName);
            localResource.deleteOnExit();
            IOUtil.copyWithClose(resourceUrl.openStream(), new FileOutputStream(localResource));
            return localResource.getAbsolutePath();
        } catch (IOException e) {
            throw new IllegalArgumentException("Unable to open resource name specified by " + resourceName, e);
        }

    }

    private File temporaryFile(final String resourceName) throws IOException {
        File tmpDir = new File(SecurityActions.getProperty("java.io.tmpdir"));

        Validate.writeableDirectory(tmpDir.getAbsolutePath(),
                "Unable to access temporary directory at " + tmpDir.getAbsolutePath());

        File localResource = File.createTempFile(resourceName.replace("/", "-").replace("\\", "-")
                .replace(File.pathSeparator, "-").replaceAll("\\s", "-"), ".tmp", tmpDir);
        localResource.deleteOnExit();
        return localResource;
    }
}