/*
    * 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;
  
  import java.io.StringReader;
  import java.io.StringWriter;
  
  import javax.xml.transform.OutputKeys;
  import javax.xml.transform.Source;
  import javax.xml.transform.Transformer;
  import javax.xml.transform.TransformerFactory;
  import javax.xml.transform.stream.StreamResult;
  import javax.xml.transform.stream.StreamSource;
  
  import org.apache.commons.lang.StringUtils;
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.xml.serializer.OutputPropertiesFactory;
  
  import de.smartics.ci.comm.CiController;
  import de.smartics.ci.comm.CiSystem;
  import de.smartics.ci.comm.Credentials;
  import de.smartics.ci.comm.LogLevel;
  import de.smartics.ci.comm.hudson.HudsonCiSystemFactory;
  import de.smartics.ci.config.load.LoaderPlan;
  import de.smartics.ci.config.load.LoaderPlanLoader;
  import de.smartics.ci.config.maven.MavenConfig;
  
  /**
   * Utilities for hudson.
   */
  public final class HudsonUtils
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    private HudsonUtils()
    {
  
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * Helper that creates the contoller.
     *
     * @param ciHost the host to which the controller si connected to.
     * @param logLevel the loglevel to use.
     * @return the ci controller to controll a ci system.
     */
    public static CiController createController(final String ciHost,
        final LogLevel logLevel)
    {
      final CiSystem system = new CiSystem(ciHost);
      final CiController controller =
          HudsonCiSystemFactory.createCiController(system, logLevel);
      return controller;
    }
  
    /**
     * Helper that determines the job name to use.
     *
     * @param plan the current plan.
     * @return the job name to use.
     */
    public static String determineJobName(final LoaderPlan plan)
    {
      final String jobNameMainPart =
         plan.getMavenConfig().getPom().getArtifactId();
     final String jobNameDiscriminator = determineDiscriminator(plan);
     return calculateJobName(jobNameMainPart, jobNameDiscriminator);
   }
 
   static String calculateJobName(final String jobNameMainPart,
       final String jobNameDiscriminator)
   {
     if (StringUtils.isBlank(jobNameDiscriminator))
     {
       return jobNameMainPart;
     }
     else
     {
       return jobNameMainPart + "-" + jobNameDiscriminator;
     }
   }
 
   static String determineDiscriminator(final LoaderPlan plan)
   {
     final String id = plan.getId();
     if ("default".equalsIgnoreCase(id))
     {
       return "";
     }
     else
     {
       return id;
     }
   }
 
   /**
    * Helper that checks if the loader plans and the configured ci-config shall
    * be used, or if a manual configuration has been made.
    *
    * @param jobName the jobName to use.
    * @param jobConfigFile the config file.
    * @return if there is a manual configuration.
    */
   public static boolean checkForManualConfiguration(final String jobName,
       final String jobConfigFile)
   {
     return !StringUtils.isBlank(jobName) || !StringUtils.isBlank(jobConfigFile);
   }
 
   /**
    * Helper that checks if a proxy is configured.
    *
    * @param proxyId the id of the proxy as it is used in the maven settings.xml.
    * @param proxyDomain the proxy domain.
    * @param proxyClientName the client name.
    * @return true if a proxy is configured.
    */
   public static boolean checkIfProxyIsConfigured(final String proxyId,
       final String proxyDomain, final String proxyClientName)
   {
     if (StringUtils.isBlank(proxyId) || StringUtils.isBlank(proxyDomain)
         || StringUtils.isBlank(proxyClientName))
     {
       return false;
     }
     return true;
   }
 
   /**
    * Helper that applys the login credentials to the controller.
    *
    * @param ciServer the ci server that has stored the credentials.
    * @param controller the controller that needs the credentials.
    * @throws MojoExecutionException when the ci server throws an exception.
    */
   public static void applyLoginCredentials(final CiServer ciServer,
       final CiController controller) throws MojoExecutionException
   {
     final Credentials loginCredentials =
         new Credentials(ciServer.getUsername(), ciServer.getPassword());
     controller.setLoginCredentials(loginCredentials);
   }
 
   /**
    * Helper that checks if a config file is specified.
    *
    * @param jobConfigFile the configFile.
    * @return true if the config file is not null.
    */
   public static boolean checkIfHudsonJobConfigFileIsSpecified(
       final String jobConfigFile)
   {
     return !StringUtils.isBlank(jobConfigFile);
   }
 
   /**
    * Helper that creates a loder.
    *
    * @param mavenConfig the mavenconfig.
    * @return a loader plan loader.
    */
   public static LoaderPlanLoader createLoaderPlanLoader(
       final MavenConfig mavenConfig)
   {
     final LoaderPlanLoader loader = new LoaderPlanLoader(mavenConfig);
     return loader;
   }
 
   /**
    * Helper that prettyfies the xml output.
    *
    * @param input the input that sahll be pretified.
    * @param indent the indent.
    * @return the pretified output.
    * @throws MojoExecutionException when thrown.
    */
   public static String prettyFormat(final String input, final int indent)
     throws MojoExecutionException
   {
     try
     {
       final Source xmlInput = new StreamSource(new StringReader(input));
       final StringWriter stringWriter = new StringWriter();
       final StreamResult xmlOutput = new StreamResult(stringWriter);
       final TransformerFactory transformerFactory =
           TransformerFactory.newInstance();
       final Transformer transformer = transformerFactory.newTransformer();
       transformer.setOutputProperty(OutputKeys.INDENT, "yes");
       transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
       transformer.setOutputProperty(
           OutputPropertiesFactory.S_KEY_INDENT_AMOUNT, String.valueOf(indent));
       transformer.transform(xmlInput, xmlOutput);
       return xmlOutput.getWriter().toString();
     }
     catch (final Exception e)
     {
       throw new MojoExecutionException("Error formatting config-string.", e);
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }