/* 
 * ========================================================================
 * 
 * Copyright 2005 Vincent Massol.
 *
 * 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.codehaus.cargo.maven2;

import java.net.Authenticator;
import java.net.PasswordAuthentication;
import java.util.Properties;

/**
 * Holds configuration data for the <code>&lt;proxy&gt;</code> tag used to configure
 * the plugin in the <code>pom.xml</code> file.
 *
 * Note: To be removed once m2 supports configuring custom config POJOs. See MNG-1353 
 *  
 * @version $Id: $
 */
public class Proxy
{
    /**
     * @see #setHost(String)
     */
    private String host;

    /**
     * @see #setPort(int)
     */
    private int port = 80;

    /**
     * @see #setUser(String)
     */
    private String user;

    /**
     * @see #setPassword(String)
     */
    private String password;

    /**
     * @see #setExcludeHosts(String)
     */
    private String excludeHosts = "";

    /**
     * @param host the proxy host
     */
    public final void setHost(String host)
    {
        this.host = host;
    }

    /**
     * @see #setHost(String)
     */
    public final String getHost()
    {
        return this.host;
    }

    /**
     * @param port the proxy port. Default to 80 if not set
     */
    public final void setPort(int port)
    {
        this.port = port;
    }

    /**
     * @see #setPort(int)
     */
    public final int getPort()
    {
        return this.port;
    }

    /**
     * @param user the user for authenticating proxies
     */
    public final void setUser(String user)
    {
        this.user = user;
    }

    /**
     * @see #setUser(String)
     */
    public final String getUser()
    {
        return this.user;
    }

    /**
     * @param password the password for authenticating proxies
     */
    public final void setPassword(String password)
    {
        this.password = password;
    }

    /**
     * @see #setPassword(String)
     */
    public final String getPassword()
    {
        return this.password;
    }

    /**
     * List of hosts which should be connected too directly and not through the proxy server. The
     * value can be a list of hosts, each seperated by a |, and in addition a wildcard character (*)
     * can be used for matching. For example: -Dhttp.nonProxyHosts="*.foo.com|localhost".
     * 
     * @param proxyExcludeHosts list of hosts that do not go through the proxy
     */
    public final void setExcludeHosts(String proxyExcludeHosts)
    {
        this.excludeHosts = proxyExcludeHosts;
    }

    /**
     * @see #setExcludeHosts(String)
     */
    public final String getExcludeHosts()
    {
        return this.excludeHosts;
    }

    /**
     * Set the Java system properties related to proxies.
     */
    public void configure()
    {
        if ((getHost() != null) && (getHost().trim().length() > 0))
        {
            Properties sysprops = System.getProperties();
            String portString = Integer.toString(getPort());

            sysprops.put("http.proxyHost", getHost());
            sysprops.put("http.proxyPort", portString);
            sysprops.put("https.proxyHost", getHost());
            sysprops.put("https.proxyPort", portString);
            sysprops.put("ftp.proxyHost", getHost());
            sysprops.put("ftp.proxyPort", portString);

            if (getExcludeHosts() != null)
            {
                sysprops.put("http.nonProxyHosts", getExcludeHosts());
                sysprops.put("https.nonProxyHosts", getExcludeHosts());
                sysprops.put("ftp.nonProxyHosts", getExcludeHosts());
            }
            if (getUser() != null)
            {
                sysprops.put("http.proxyUser", getUser());
                sysprops.put("http.proxyPassword", getPassword());
                Authenticator.setDefault(new ProxyAuthenticator(getUser(), getPassword()));
            }
        }
    }

    /**
     * Clear all proxy settings.
     */
    public void clear()
    {
        Properties sysprops = System.getProperties();
        sysprops.remove("http.proxyHost");
        sysprops.remove("http.proxyPort");
        sysprops.remove("http.proxyUser");
        sysprops.remove("http.proxyPassword");
        sysprops.remove("https.proxyHost");
        sysprops.remove("https.proxyPort");
        sysprops.remove("ftp.proxyHost");
        sysprops.remove("ftp.proxyPort");
        Authenticator.setDefault(new ProxyAuthenticator("", ""));
    }

    /**
     * Authenticator for the Proxy.
     */
    private static final class ProxyAuthenticator extends Authenticator
    {
        /**
         * Authentication using a username/password.
         */
        private PasswordAuthentication authentication;

        /**
         * @param user the username
         * @param pass the password
         */
        private ProxyAuthenticator(String user, String pass)
        {
            this.authentication = new PasswordAuthentication(user, pass.toCharArray());
        }

        /**
         * @see java.net.Authenticator#getPasswordAuthentication()
         */
        protected PasswordAuthentication getPasswordAuthentication()
        {
            return this.authentication;
        }
    }
}