/*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you 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.apache.maven.plugin.ide;

 import java.io.File;

 import java.io.IOException;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import org.apache.maven.artifact.Artifact;

 import org.apache.maven.artifact.factory.ArtifactFactory;

 import org.apache.maven.artifact.repository.ArtifactRepository;

 import org.apache.maven.artifact.resolver.ArtifactNotFoundException;

 import org.apache.maven.artifact.resolver.ArtifactResolutionException;

 import org.apache.maven.artifact.resolver.ArtifactResolver;

 import org.apache.maven.model.Dependency;

 import org.apache.maven.model.Plugin;

 import org.apache.maven.model.PluginExecution;

 import org.apache.maven.plugin.MojoExecutionException;

 import org.apache.maven.plugin.logging.Log;

 import org.apache.maven.project.MavenProject;

 import org.codehaus.plexus.util.StringUtils;

 import org.codehaus.plexus.util.xml.Xpp3Dom;

 /**

  * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>

  * @author <a href="mailto:fgiust@users.sourceforge.net">Fabrizio Giustina</a>

  * @version $Id: IdeUtils.java 628794 2008-02-18 16:09:11Z aheritier $

  */

 public class IdeUtils

 {

     public static final String JAVA_1_1 = "1.1";

     public static final String JAVA_1_2 = "1.2";

     public static final String JAVA_1_3 = "1.3";

     public static final String JAVA_1_4 = "1.4";

     public static final String JAVA_5_0 = "5.0";

     public static final String JAVA_6_0 = "6.0";

     public static final String PROJECT_NAME_DEFAULT_TEMPLATE = "[artifactId]";

     public static final String PROJECT_NAME_WITH_VERSION_TEMPLATE = "[artifactId]-[version]";

     public static final String PROJECT_NAME_WITH_GROUP_TEMPLATE = "[groupId].[artifactId]";

     public static final String PROJECT_NAME_WITH_GROUP_AND_VERSION_TEMPLATE = "[groupId].[artifactId]-[version]";

     /**

      * compiler plugin id.

      */

     private static final String ARTIFACT_MAVEN_COMPILER_PLUGIN = "maven-compiler-plugin"; //$NON-NLS-1$

     /**

      * 'source' property for maven-compiler-plugin.

      */

     private static final String PROPERTY_SOURCE = "source"; //$NON-NLS-1$

     /**

      * 'target' property for maven-compiler-plugin.

      */

     private static final String PROPERTY_TARGET = "target"; //$NON-NLS-1$

     public static String getCanonicalPath( File file )

         throws MojoExecutionException

     {

         try

         {

             return file.getCanonicalPath();

         }

         catch ( IOException e )

         {

             throw new MojoExecutionException( Messages.getString( "cantcanonicalize", file //$NON-NLS-1$

             .getAbsolutePath() ), e );

         }

     }

     /**

      * Returns a compiler plugin settings, considering also settings altered in plugin executions .

      * 

      * @param project maven project

      * @return option value (may be null)

      */

     public static String getCompilerPluginSetting( MavenProject project, String optionName )

     {

         String value = findCompilerPluginSettingInPlugins( project.getModel().getBuild().getPlugins(), optionName );

         if ( value == null && project.getModel().getBuild().getPluginManagement() != null )

         {

             value =

                 findCompilerPluginSettingInPlugins( project.getModel().getBuild().getPluginManagement().getPlugins(),

                                                     optionName );

         }

         return value;

     }

     /**

      * Returns the source version configured for the compiler plugin. Returns the minimum version required to compile

      * both standard and test sources, if settings are different.

      * 

      * @param project maven project

      * @return java source version

      */

     public static String getCompilerSourceVersion( MavenProject project )

     {

         return IdeUtils.getCompilerPluginSetting( project, PROPERTY_SOURCE );

     }

     /**

      * Returns the target version configured for the compiler plugin. Returns the minimum version required to compile

      * both standard and test sources, if settings are different.

      * 

      * @param project maven project

      * @return java target version

      */

     public static String getCompilerTargetVersion( MavenProject project )

     {

         return IdeUtils.getCompilerPluginSetting( project, PROPERTY_TARGET );

     }

     // /**

     // * Extracts the version of the first matching dependency in the given list.

     // *

     // * @param artifactIds artifact names to compare against for extracting version

     // * @param dependencies Collection of dependencies for our project

     // * @param len expected length of the version sub-string

     // * @return

     // */

     // public static String getDependencyVersion( String[] artifactIds, List dependencies, int len )

     // {

     // for ( int j = 0; j < artifactIds.length; j++ )

     // {

     // String id = artifactIds[j];

     // for ( Iterator itr = dependencies.iterator(); itr.hasNext(); )

     // {

     // Dependency dependency = (Dependency) itr.next();

     // if ( id.equals( dependency.getArtifactId() ) )

     // {

     // return StringUtils.substring( dependency.getVersion(), 0, len );

     // }

     // }

     // }

     // return null;

     // }

     /**

      * Extracts the version of the first matching artifact in the given list.

      * 

      * @param artifactIds artifact names to compare against for extracting version

      * @param artifacts Set of artifacts for our project

      * @param len expected length of the version sub-string

      * @return

      */

     public static String getArtifactVersion( String[] artifactIds, List dependencies, int len )

     {

         for ( int j = 0; j < artifactIds.length; j++ )

         {

             String id = artifactIds[j];

             Iterator depIter = dependencies.iterator();

             while ( depIter.hasNext() )

             {

                 Dependency dep = (Dependency) depIter.next();

                 if ( id.equals( dep.getArtifactId() ) )

                 {

                     return StringUtils.substring( dep.getVersion(), 0, len );

                 }

             }

         }

         return null;

     }

     /**

      * Search for a configuration setting of an other plugin for a configuration setting.

      * 

      * @todo there should be a better way to do this

      * @param project the current maven project to get the configuration from.

      * @param pluginId the group id and artifact id of the plugin to search for

      * @param optionName the option to get from the configuration

      * @param defaultValue the default value if the configuration was not found

      * @return the value of the option configured in the plugin configuration

      */

     public static String getPluginSetting( MavenProject project, String pluginId, String optionName, String defaultValue )

     {

         Xpp3Dom dom = getPluginConfigurationDom( project, pluginId );

         if ( dom != null && dom.getChild( optionName ) != null )

         {

             return dom.getChild( optionName ).getValue();

         }

         return defaultValue;

     }

     /**

      * Search for the configuration Xpp3 dom of an other plugin.

      * 

      * @todo there should be a better way to do this

      * @param project the current maven project to get the configuration from.

      * @param pluginId the group id and artifact id of the plugin to search for

      * @return the value of the option configured in the plugin configuration

      */

     public static Xpp3Dom getPluginConfigurationDom( MavenProject project, String pluginId )

     {

         Plugin plugin = (org.apache.maven.model.Plugin) project.getBuild().getPluginsAsMap().get( pluginId );

         if ( plugin != null )

         {

             return (Xpp3Dom) plugin.getConfiguration();

         }

         return null;

     }

     /**

      * Search for the configuration Xpp3 dom of an other plugin.

      * 

      * @todo there should be a better way to do this

      * @param project the current maven project to get the configuration from.

      * @param artifactId the artifact id of the plugin to search for

      * @return the value of the option configured in the plugin configuration

      */

     public static Xpp3Dom[] getPluginConfigurationDom( MavenProject project, String artifactId,

                                                        String[] subConfiguration )

     {

         ArrayList configurationDomList = new ArrayList();

         Xpp3Dom configuration = getPluginConfigurationDom( project, artifactId );

         if ( configuration != null )

         {

             configurationDomList.add( configuration );

             for ( int index = 0; !configurationDomList.isEmpty() && subConfiguration != null &&

                 index < subConfiguration.length; index++ )

             {

                 ArrayList newConfigurationDomList = new ArrayList();

                 for ( Iterator childElement = configurationDomList.iterator(); childElement.hasNext(); )

                 {

                     Xpp3Dom child = (Xpp3Dom) childElement.next();

                     Xpp3Dom[] deeperChild = child.getChildren( subConfiguration[index] );

                     for ( int deeperIndex = 0; deeperIndex < deeperChild.length; deeperIndex++ )

                     {

                         if ( deeperChild[deeperIndex] != null )

                         {

                             newConfigurationDomList.add( deeperChild[deeperIndex] );

                         }

                     }

                 }

                 configurationDomList = newConfigurationDomList;

             }

         }

         return (Xpp3Dom[]) configurationDomList.toArray( new Xpp3Dom[configurationDomList.size()] );

     }

     /**

      * Use {@link IdeDependency#getEclipseProjectName()} instead.

      */

     protected static String getProjectName( String template, IdeDependency dep )

     {

         return getProjectName( template, dep.getGroupId(), dep.getArtifactId(), dep.getVersion() );

     }

     /**

      * Use the project name template to create an eclipse project.

      * 

      * @param template Template for the project name

      * @param artifact the artifact to create the project name for

      * @return the created ide project name

      */

     public static String getProjectName( String template, Artifact artifact )

     {

         return getProjectName( template, artifact.getGroupId(), artifact.getArtifactId(), artifact.getVersion() );

     }

     public static String getProjectName( String template, MavenProject project )

     {

         return getProjectName( template, project.getGroupId(), project.getArtifactId(), project.getVersion() );

     }

     private static String getProjectName( IdeDependency dep, boolean addVersionToProjectName )

     {

         return getProjectName( addVersionToProjectName ? PROJECT_NAME_WITH_VERSION_TEMPLATE

                         : PROJECT_NAME_DEFAULT_TEMPLATE, dep );

     }

     public static String getProjectName( MavenProject project, boolean addVersionToProjectName )

     {

         return getProjectName( addVersionToProjectName ? PROJECT_NAME_WITH_VERSION_TEMPLATE

                         : PROJECT_NAME_DEFAULT_TEMPLATE, project );

     }

     public static Artifact resolveArtifactWithClassifier( String groupId, String artifactId, String version,

                                                           String depClassifier, String inClassifier,

                                                           ArtifactRepository localRepository,

                                                           ArtifactResolver artifactResolver,

                                                           ArtifactFactory artifactFactory, List remoteRepos, Log log )

     {

         String type = null;

         // the "sources" classifier maps to the "java-source" type

         if ( "sources".equals( inClassifier ) )

         {

             type = "java-source";

         }

         else

         {

             type = inClassifier;

         }

         String finalClassifier = null;

         if ( depClassifier == null )

         {

             finalClassifier = inClassifier;

         }

         else if ( "sources".equals( inClassifier ) && "tests".equals( depClassifier ) )

         {

             // MECLIPSE-151 - if the dependency is a test, get the correct classifier for it. (ignore for javadocs)

             finalClassifier = "test-sources";

         }

         else

         {

             finalClassifier = depClassifier + "-" + inClassifier;

         }

         Artifact resolvedArtifact =

             artifactFactory.createArtifactWithClassifier( groupId, artifactId, version, type, finalClassifier );

         try

         {

             artifactResolver.resolve( resolvedArtifact, remoteRepos, localRepository );

         }

         catch ( ArtifactNotFoundException e )

         {

             // ignore, the jar has not been found

         }

         catch ( ArtifactResolutionException e )

         {

             String message =

                 Messages.getString( "errorresolving", new Object[] { finalClassifier, resolvedArtifact.getId(),

                     e.getMessage() } );

             log.warn( message );

         }

         return resolvedArtifact;

     }

     public static String resolveJavaVersion( MavenProject project )

     {

         String version = IdeUtils.getCompilerTargetVersion( project );

         if ( version == null )

         {

             version = IdeUtils.getCompilerSourceVersion( project );

         }

         if ( "1.5".equals( version ) ) //$NON-NLS-1$ 

         {

             version = IdeUtils.JAVA_5_0;// see MECLIPSE-47 eclipse only accept 5.0 as a valid version

         }

         else if ( "1.6".equals( version ) ) //$NON-NLS-1$ 

         {

             version = IdeUtils.JAVA_6_0;

         }

         else if ( version != null && version.length() == 1 )

         {

             version = version + ".0";// 5->5.0 6->6.0 7->7.0 //$NON-NLS-1$

         }

         return version == null ? IdeUtils.JAVA_1_4 : version;

     }

     public static String toRelativeAndFixSeparator( File basedir, File fileToAdd, boolean replaceSlashesWithDashes )

         throws MojoExecutionException

     {

         if ( !fileToAdd.isAbsolute() )

         {

             fileToAdd = new File( basedir, fileToAdd.getPath() );

         }

         String basedirpath;

         String absolutePath;

         basedirpath = getCanonicalPath( basedir );

         absolutePath = getCanonicalPath( fileToAdd );

         String relative;

         if ( absolutePath.equals( basedirpath ) )

         {

             relative = "."; //$NON-NLS-1$

         }

         else if ( absolutePath.startsWith( basedirpath ) )

         {

             relative = absolutePath.substring( basedirpath.length() + 1 );

         }

         else

         {

             relative = absolutePath;

         }

         relative = StringUtils.replace( relative, '\\', '/' );

         if ( replaceSlashesWithDashes )

         {

             relative = StringUtils.replace( relative, '/', '-' );

             relative = StringUtils.replace( relative, ':', '-' ); // remove ":" for absolute paths in windows

         }

         return relative;

     }

     /**

      * Returns a compiler plugin settings from a list of plugins .

      * 

      * @param project maven project

      * @return option value (may be null)

      */

     private static String findCompilerPluginSettingInPlugins( List plugins, String optionName )

     {

         String value = null;

         for ( Iterator it = plugins.iterator(); it.hasNext(); )

         {

             Plugin plugin = (Plugin) it.next();

             if ( plugin.getArtifactId().equals( ARTIFACT_MAVEN_COMPILER_PLUGIN ) )

             {

                 Xpp3Dom o = (Xpp3Dom) plugin.getConfiguration();

                 // this is the default setting

                 if ( o != null && o.getChild( optionName ) != null )

                 {

                     value = o.getChild( optionName ).getValue();

                 }

                 List executions = plugin.getExecutions();

                 // a different source/target version can be configured for test sources compilation

                 for ( Iterator iter = executions.iterator(); iter.hasNext(); )

                 {

                     PluginExecution execution = (PluginExecution) iter.next();

                     o = (Xpp3Dom) execution.getConfiguration();

                     if ( o != null && o.getChild( optionName ) != null )

                     {

                         value = o.getChild( optionName ).getValue();

                     }

                 }

             }

         }

         return value;

     }

     private static String getProjectName( String template, String groupId, String artifactId, String version )

     {

         String s = template;

         s = s.replaceAll( "\\[groupId\\]", groupId );

         s = s.replaceAll( "\\[artifactId\\]", artifactId );

         s = s.replaceAll( "\\[version\\]", version );

         return s;

     }

     private IdeUtils()

     {

         // don't instantiate

     }

 }