/*
    * Copyright 2012 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.ci.maven.mojo;
  
  import java.util.List;
  
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.maven.settings.Proxy;
  
  import de.smartics.ci.comm.CiController;
  import de.smartics.ci.comm.ProxyCredentials;
  import de.smartics.ci.comm.ProxyInformation;
  import de.smartics.ci.comm.command.LoginCommandException;
  import de.smartics.ci.maven.HudsonUtils;
  import de.smartics.ci.maven.ProxyConfiguration;
  
  /**
   * Hudson CI mojo.
   */
  public abstract class AbstractProxyEnabledHudsonCiMojo extends
  AbstractConfigChoiceHudsonCiMojo
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The id of the proxy entry in the settings to declare which proxy shall be
     * used to connect to the ci server.
     *
     * @parameter expression="${hudson-maven-plugin.proxyId}"
     * @since 1.0
     */
    protected String proxyId;
  
    /**
     * The proxy Windows-NT domain name that must be used to get access through
     * the proxy.
     *
     * @parameter expression="${hudson-maven-plugin.proxyDomain}"
     * @since 1.0
     */
    private String proxyDomain;
  
    /**
     * The client name that shall be used to connect to the proxy.
     *
     * @parameter expression="${hudson-maven-plugin.proxyClientName}"
     * @since 1.0
     */
    private String proxyClientName;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * {@inheritDoc}
     *
     * @see de.smartics.ci.maven.mojo.AbstractHudsonCiMojo#handleLogin(de.smartics.ci.comm.CiController)
     */
    protected void handleLogin(final CiController controller)
      throws LoginCommandException, MojoExecutionException
    {
      applyProxyInformation(controller);
      super.handleLogin(controller);
    }
  
    /**
     * Apply the proxy configuration to the controller.
     *
     * @param controller the controller that connect to the ci server.
     * @throws MojoExecutionException when the proxy configuration is invalid.
     */
   protected final void applyProxyInformation(final CiController controller)
     throws MojoExecutionException
   {
     if (HudsonUtils.checkIfProxyIsConfigured(this.proxyId, this.proxyDomain,
         this.proxyClientName))
     {
       final ProxyConfiguration proxyConfig = getProxyConfiguration();
       if (proxyConfig != null)
       {
         final ProxyInformation proxy =
             new ProxyInformation(proxyConfig.getHost(), proxyConfig.getPort());
         final ProxyCredentials proxyCredentials =
             new ProxyCredentials(proxyConfig.getUserName(),
                 proxyConfig.getPassword(), proxyConfig.getClientName(),
                 proxyConfig.getDomain());
         proxy.setCredentials(proxyCredentials);
         controller.setProxyInformation(proxy);
       }
     }
   }
 
   /**
    * Returns the maven proxy configuration.
    *
    * @return the proxy information.
    * @throws MojoExecutionException when the proxy is configured in the mojo,
    *           but no proxy with the given proxyId can be found in the
    *           settings.xml.
    */
   protected final ProxyConfiguration getProxyConfiguration()
     throws MojoExecutionException
   {
     final Proxy configuredProxy = fetchProxyFromSettings();
     final ProxyConfiguration proxyConfiguration = new ProxyConfiguration();
     final String proxyId = configuredProxy.getId();
     proxyConfiguration.setId(proxyId);
     proxyConfiguration.setHost(configuredProxy.getHost());
     proxyConfiguration.setPort(configuredProxy.getPort());
     proxyConfiguration.setPassword(configuredProxy.getPassword());
     proxyConfiguration.setUserName(configuredProxy.getUsername());
     proxyConfiguration.setClientName(this.proxyClientName);
     proxyConfiguration.setDomain(this.proxyDomain);
     return proxyConfiguration;
   }
 
   private Proxy fetchProxyFromSettings() throws MojoExecutionException
   {
     final List<Proxy> proxies = settings.getProxies();
     Proxy configuredProxy = null;
     for (final Proxy proxy : proxies)
     {
       final String currentProxyId = proxy.getId();
       if (this.proxyId.equals(currentProxyId))
       {
         configuredProxy = proxy;
       }
     }
     if (configuredProxy == null)
     {
       throw new MojoExecutionException(
           "Proxy is configured, but in the settings.xml there is no porxy-entry for proxy with id: "
               + this.proxyId);
     }
     return configuredProxy;
   }
 
   // --- object basics --------------------------------------------------------
 
 }