/*
    * 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.comm.hudson.command;
  
  import org.apache.commons.httpclient.HttpClient;
  import org.apache.commons.httpclient.HttpState;
  import org.apache.commons.httpclient.NTCredentials;
  import org.apache.commons.httpclient.auth.AuthScope;
  import org.apache.commons.httpclient.methods.GetMethod;
  import org.apache.commons.httpclient.methods.PostMethod;
  
  import de.smartics.ci.comm.CiSystem;
  import de.smartics.ci.comm.Credentials;
  import de.smartics.ci.comm.ProxyCredentials;
  import de.smartics.ci.comm.ProxyInformation;
  import de.smartics.ci.comm.command.CommandException;
  import de.smartics.ci.comm.command.AbstractLoginCommand;
  import de.smartics.ci.comm.command.LoginCommandException;
  
  /**
   * Implements the login command for a hudson ci server.
   */
  public final class HudsonLoginCommand extends
      AbstractLoginCommand<HudsonLoginCommand>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The credentials used to login.
     */
    private Credentials loginCredentials;
  
    /**
     * The information needed for a proxy.
     */
    private ProxyInformation proxyInformation;
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param loginCredentials the credentials used to login.
     * @param proxyInformation the information needed for a proxy.
     */
    public HudsonLoginCommand(final Credentials loginCredentials,
        final ProxyInformation proxyInformation)
    {
      this.loginCredentials = loginCredentials;
      this.proxyInformation = proxyInformation;
    }
  
    /**
     * Default constructor. Sets credentials and proxyinfo to null;
     */
    public HudsonLoginCommand()
    {
      this(null, null);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    /**
     * Sets the information needed for a proxy.
     *
     * @param proxyInformation the information needed for a proxy.
     */
    public void setProxyInformation(final ProxyInformation proxyInformation)
    {
      this.proxyInformation = proxyInformation;
    }
  
    /**
     * Sets the credentials used to login.
    *
    * @param loginCredentials the credentials used to login.
    */
   public void setLoginCredentials(final Credentials loginCredentials)
   {
     this.loginCredentials = loginCredentials;
   }
 
   // --- business -------------------------------------------------------------
 
   @Override
   public void execute(final CiSystem target) throws LoginCommandException
   {
     handleProxy(target.getClient());
     handleLogin(target);
   }
 
   private void handleProxy(final HttpClient client)
   {
     if (checkIfProxyIsConfigured())
     {
       configureProxybaseInformation(client);
       configureProxyCredentials(client);
     }
   }
 
   private void handleLogin(final CiSystem target) throws LoginCommandException
   {
     final String hostName = target.getUrl();
     final GetMethod method = new GetMethod(buildLoginUrl(hostName));
 
     try
     {
       int statusCode = target.execute(method);
       checkResult(statusCode);
       String location = hostName + "/j_acegi_security_check";
       while (true)
       {
         final PostMethod loginMethod = new PostMethod(location);
         final String userName = loginCredentials.getUserName();
         final String password = loginCredentials.getPassword();
 
         loginMethod.addParameter("j_username", userName);
         loginMethod.addParameter("j_password", password);
 
         loginMethod.addParameter("action", "login");
 
         statusCode = target.execute(loginMethod);
         if (statusCode / ERROR_CATEGORY_DESTINGUISHER == 3)
         {
           location = loginMethod.getResponseHeader("Location").getValue();
           continue;
         }
         checkResult(statusCode);
         break;
       }
     }
     catch (final CommandException e)
     {
       throw new LoginCommandException(
           "Login failed, due to a Hudson failure response. Connecting to': "
               + buildLoginUrl(hostName), e);
     }
   }
 
   private String buildLoginUrl(final String hostName)
   {
     return hostName + "/loginEntry";
   }
 
   private boolean checkIfProxyIsConfigured()
   {
     return proxyInformation != null;
   }
 
   private void configureProxyCredentials(final HttpClient client)
   {
     final HttpState state = new HttpState();
     final AuthScope authScope = new AuthScope(null, -1, AuthScope.ANY_REALM);
     final ProxyCredentials credentials = proxyInformation.getCredentials();
     final String userName = credentials.getUserName();
     final String password = credentials.getPassword();
     final String clientName = credentials.getClientName();
     final String domain = credentials.getDomain();
 
     state.setProxyCredentials(authScope, new NTCredentials(userName, password,
         clientName, domain));
     client.setState(state);
   }
 
   private void configureProxybaseInformation(final HttpClient client)
   {
     final String host = proxyInformation.getHost();
     final int port = proxyInformation.getPort();
     client.getHostConfiguration().setProxy(host, port);
   }
 
   // --- object basics --------------------------------------------------------
 
 }