package org.apache.maven.plugins.jlink;
   
   /*
    * 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.
   */
  
  import java.io.File;
  import java.io.IOException;
  import java.io.PrintStream;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Map;
  import java.util.Map.Entry;
  
  import org.apache.maven.artifact.Artifact;
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.maven.plugin.MojoFailureException;
  import org.apache.maven.plugins.annotations.Component;
  import org.apache.maven.plugins.annotations.LifecyclePhase;
  import org.apache.maven.plugins.annotations.Mojo;
  import org.apache.maven.plugins.annotations.Parameter;
  import org.apache.maven.plugins.annotations.ResolutionScope;
  import org.apache.maven.project.MavenProject;
  import org.apache.maven.shared.utils.StringUtils;
  import org.apache.maven.shared.utils.logging.MessageUtils;
  import org.apache.maven.toolchain.Toolchain;
  import org.apache.maven.toolchain.java.DefaultJavaToolChain;
  import org.codehaus.plexus.archiver.Archiver;
  import org.codehaus.plexus.archiver.ArchiverException;
  import org.codehaus.plexus.archiver.zip.ZipArchiver;
  import org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor;
  import org.codehaus.plexus.languages.java.jpms.LocationManager;
  import org.codehaus.plexus.languages.java.jpms.ResolvePathsRequest;
  import org.codehaus.plexus.languages.java.jpms.ResolvePathsResult;
  import org.codehaus.plexus.languages.java.jpms.ResolvePathsResult.ModuleNameSource;
  import org.codehaus.plexus.util.FileUtils;
  import org.codehaus.plexus.util.cli.Commandline;
  
  /**
   * The JLink goal is intended to create a Java Run Time Image file based on
   * <a href="http://openjdk.java.net/jeps/282">http://openjdk.java.net/jeps/282</a>,
   * <a href="http://openjdk.java.net/jeps/220">http://openjdk.java.net/jeps/220</a>.
   * 
   * @author Karl Heinz Marbaise <a href="mailto:khmarbaise@apache.org">khmarbaise@apache.org</a>
   */
  // CHECKSTYLE_OFF: LineLength
  @Mojo( name = "jlink", requiresDependencyCollection = ResolutionScope.RUNTIME, defaultPhase = LifecyclePhase.PACKAGE, requiresProject = true )
  // CHECKSTYLE_ON: LineLength
  public class JLinkMojo
      extends AbstractJLinkMojo
  {
      private static final String JMODS = "jmods";
  
      private List<String> classpathElements;
  
      private List<String> modulepathElements;
  
      private Map<String, JavaModuleDescriptor> pathElements;
  
      @Component
      private LocationManager locationManager;
  
      /**
       * <p>
       * Specify the requirements for this jdk toolchain. This overrules the toolchain selected by the
       * maven-toolchain-plugin.
       * </p>
       * <strong>note:</strong> requires at least Maven 3.3.1
       */
      @Parameter
      private Map<String, String> jdkToolchain;
  
      /**
       * This is intended to strip debug information out. The command line equivalent of <code>jlink</code> is:
       * <code>-G, --strip-debug</code> strip debug information.
       */
      @Parameter( defaultValue = "false" )
      private boolean stripDebug;
  
      /**
       * Here you can define the compression of the resources being used. The command line equivalent is:
       * <code>-c, --compress=level&gt;</code>. The valid values for the level are: <code>0, 1, 2</code>.
      */
     @Parameter
     private Integer compression;
 
     /**
      * Limit the universe of observable modules. The following gives an example of the configuration which can be used
      * in the <code>pom.xml</code> file.
      * 
      * <pre>
      *   &lt;limitModules&gt;
      *     &lt;limitModule&gt;mod1&lt;/limitModule&gt;
      *     &lt;limitModule&gt;xyz&lt;/limitModule&gt;
      *     .
      *     .
      *   &lt;/limitModules&gt;
      * </pre>
      * 
      * This configuration is the equivalent of the command line option:
      * <code>--limit-modules &lt;mod&gt;[,&lt;mod&gt;...]</code>
      */
     @Parameter
     private List<String> limitModules;
 
     /**
      * <p>
      * Usually this is not necessary, cause this is handled automatically by the given dependencies.
      * </p>
      * <p>
      * By using the --add-modules you can define the root modules to be resolved. The configuration in
      * <code>pom.xml</code> file can look like this:
      * </p>
      * 
      * <pre>
      * &lt;addModules&gt;
      *   &lt;addModule&gt;mod1&lt;/addModule&gt;
      *   &lt;addModule&gt;first&lt;/addModule&gt;
      *   .
      *   .
      * &lt;/addModules&gt;
      * </pre>
      * 
      * The command line equivalent for jlink is: <code>--add-modules &lt;mod&gt;[,&lt;mod&gt;...]</code>.
      */
     @Parameter
     private List<String> addModules;
 
     /**
      * Define the plugin module path to be used. There can be defined multiple entries separated by either {@code ;} or
      * {@code :}. The jlink command line equivalent is: <code>--plugin-module-path &lt;modulepath&gt;</code>
      */
     @Parameter
     private String pluginModulePath;
 
     /**
      * The output directory for the resulting Run Time Image. The created Run Time Image is stored in non compressed
      * form. This will later being packaged into a <code>zip</code> file. <code>--output &lt;path&gt;</code>
      */
     // TODO: is this a good final location?
     @Parameter( defaultValue = "${project.build.directory}/maven-jlink", required = true, readonly = true )
     private File outputDirectoryImage;
 
     @Parameter( defaultValue = "${project.build.directory}", required = true, readonly = true )
     private File outputDirectory;
 
     /**
      * The byte order of the generated Java Run Time image. <code>--endian &lt;little|big&gt;</code>. If the endian is
      * not given the default is: <code>native</code>.
      */
     // TODO: Should we define either little or big as default? or should we left as it.
     @Parameter
     private String endian;
 
     private List<String> modulePaths;
 
     /**
      * Add the option <code>--bind-services</code> or not.
      */
     @Parameter( defaultValue = "false" )
     private boolean bindServices;
 
     /**
      * You can disable a plugin by using this option. <code>--disable-plugin pluginName</code>.
      */
     @Parameter
     private String disablePlugin;
 
     /**
      * <code>--ignore-signing-information</code>
      */
     @Parameter( defaultValue = "false" )
     private boolean ignoreSigningInformation;
 
     /**
      * This will suppress to have an <code>includes</code> directory in the resulting Java Run Time Image. The JLink
      * command line equivalent is: <code>--no-header-files</code>
      */
     @Parameter( defaultValue = "false" )
     private boolean noHeaderFiles;
 
     /**
      * This will suppress to have the <code>man</code> directory in the resulting Java Run Time Image. The JLink command
      * line equivalent is: <code>--no-man-pages</code>
      */
     @Parameter( defaultValue = "false" )
     private boolean noManPages;
 
     /**
      * Suggest providers that implement the given service types from the module path.
      * 
      * <pre>
      * &lt;suggestProviders&gt;
      *   &lt;suggestProvider&gt;name-a&lt;/suggestProvider&gt;
      *   &lt;suggestProvider&gt;name-b&lt;/suggestProvider&gt;
      *   .
      *   .
      * &lt;/suggestProviders&gt;
      * </pre>
      * 
      * The jlink command linke equivalent: <code>--suggest-providers [&lt;name&gt;,...]</code>
      */
     @Parameter
     private List<String> suggestProviders;
 
     /**
      * This will turn on verbose mode. The jlink command line equivalent is: <code>--verbose</code>
      */
     @Parameter( defaultValue = "false" )
     private boolean verbose;
 
     /**
      * The JAR archiver needed for archiving the environments.
      */
     @Component( role = Archiver.class, hint = "zip" )
     private ZipArchiver zipArchiver;
 
     /**
      * Name of the generated ZIP file in the <code>target</code> directory. 
      * This will not change the name of the installed/deployed file.
      */
     @Parameter( defaultValue = "${project.build.finalName}", readonly = true )
     private String finalName;
 
     public void execute()
         throws MojoExecutionException, MojoFailureException
     {
 
         String jLinkExec = getExecutable();
 
         getLog().info( "Toolchain in maven-jlink-plugin: jlink [ " + jLinkExec + " ]" );
 
         // TODO: Find a more better and cleaner way?
         File jLinkExecuteable = new File( jLinkExec );
 
         // Really Hacky...do we have a better solution to find the jmods directory of the JDK?
         File jLinkParent = jLinkExecuteable.getParentFile().getParentFile();
         File jmodsFolder = new File( jLinkParent, JMODS );
 
         getLog().debug( " Parent: " + jLinkParent.getAbsolutePath() );
         getLog().debug( " jmodsFolder: " + jmodsFolder.getAbsolutePath() );
 
         failIfParametersAreNotInTheirValidValueRanges();
 
         ifOutputDirectoryExistsDelteIt();
 
         preparePaths();
 
         getLog().info( "The following dependencies will be linked into the runtime image:" );
 
         this.addModules = new ArrayList<>();
         this.modulePaths = new ArrayList<>();
         for ( Entry<String, JavaModuleDescriptor> item : pathElements.entrySet() )
         {
             // Isn't there a better solution?
             if ( item.getValue() == null )
             {
                 String message = "The given dependency " + item.getKey()
                     + " does not have a module-info.java file. So it can't be linked.";
                 getLog().error( message );
                 throw new MojoFailureException( message );
             }
             getLog().debug( "pathElements Item:" + item.getKey() + " v:" + item.getValue().name() );
             getLog().info( " -> module: " + item.getValue().name() + " ( " + item.getKey() + " )" );
             // We use the real module name and not the artifact Id...
             this.addModules.add( item.getValue().name() );
             this.modulePaths.add( item.getKey() );
         }
         // The jmods directory of the JDK
         this.modulePaths.add( jmodsFolder.getAbsolutePath() );
 
         Commandline cmd;
         try
         {
             cmd = createJLinkCommandLine();
         }
         catch ( IOException e )
         {
             throw new MojoExecutionException( e.getMessage() );
         }
         cmd.setExecutable( jLinkExec );
 
         executeCommand( cmd, outputDirectoryImage );
 
         File createZipArchiveFromImage = createZipArchiveFromImage( outputDirectory, outputDirectoryImage );
 
         if ( projectHasAlreadySetAnArtifact() )
         {
             throw new MojoExecutionException( "You have to use a classifier "
                 + "to attach supplemental artifacts to the project instead of replacing them." );
         }
 
         getProject().getArtifact().setFile( createZipArchiveFromImage );
     }
 
     private List<File> getCompileClasspathElements( MavenProject project )
     {
         List<File> list = new ArrayList<File>( project.getArtifacts().size() + 1 );
 
         for ( Artifact a : project.getArtifacts() )
         {
             list.add( a.getFile() );
         }
         return list;
     }
 
     private void preparePaths()
     {
         // For now only allow named modules. Once we can create a graph with ASM we can specify exactly the modules
         // and we can detect if auto modules are used. In that case, MavenProject.setFile() should not be used, so
         // you cannot depend on this project and so it won't be distributed.
 
         modulepathElements = new ArrayList<String>();
         classpathElements = new ArrayList<String>();
         pathElements = new LinkedHashMap<String, JavaModuleDescriptor>();
 
         ResolvePathsResult<File> resolvePathsResult;
         try
         {
             Collection<File> dependencyArtifacts = getCompileClasspathElements( getProject() );
 
             ResolvePathsRequest<File> request = ResolvePathsRequest.withFiles( dependencyArtifacts );
 
             Toolchain toolchain = getToolchain();
             if ( toolchain != null && toolchain instanceof DefaultJavaToolChain )
             {
                 request.setJdkHome( new File( ( (DefaultJavaToolChain) toolchain ).getJavaHome() ) );
             }
 
             resolvePathsResult = locationManager.resolvePaths( request );
 
             JavaModuleDescriptor moduleDescriptor = resolvePathsResult.getMainModuleDescriptor();
 
             for ( Map.Entry<File, ModuleNameSource> entry : resolvePathsResult.getModulepathElements().entrySet() )
             {
                 if ( ModuleNameSource.FILENAME.equals( entry.getValue() ) )
                 {
                     final String message = "Required filename-based automodules detected. "
                         + "Please don't publish this project to a public artifact repository!";
 
                     if ( moduleDescriptor.exports().isEmpty() )
                     {
                         // application
                         getLog().info( message );
                     }
                     else
                     {
                         // library
                         writeBoxedWarning( message );
                     }
                     break;
                 }
             }
 
             for ( Map.Entry<File, JavaModuleDescriptor> entry : resolvePathsResult.getPathElements().entrySet() )
             {
                 pathElements.put( entry.getKey().getPath(), entry.getValue() );
             }
 
             for ( File file : resolvePathsResult.getClasspathElements() )
             {
                 classpathElements.add( file.getPath() );
             }
 
             for ( File file : resolvePathsResult.getModulepathElements().keySet() )
             {
                 modulepathElements.add( file.getPath() );
             }
         }
         catch ( IOException e )
         {
             getLog().warn( e.getMessage() );
         }
     }
 
     private String getExecutable()
         throws MojoFailureException
     {
         String jLinkExec;
         try
         {
             jLinkExec = getJLinkExecutable();
         }
         catch ( IOException e )
         {
             throw new MojoFailureException( "Unable to find jlink command: " + e.getMessage(), e );
         }
         return jLinkExec;
     }
 
     private boolean projectHasAlreadySetAnArtifact()
     {
         if ( getProject().getArtifact().getFile() != null )
         {
             return getProject().getArtifact().getFile().isFile();
         }
         else
         {
             return false;
         }
     }
 
     private File createZipArchiveFromImage( File outputDirectory, File outputDirectoryImage )
         throws MojoExecutionException
     {
         zipArchiver.addDirectory( outputDirectoryImage );
 
         File resultArchive = getArchiveFile( outputDirectory, finalName, null, "zip" );
 
         zipArchiver.setDestFile( resultArchive );
         try
         {
             zipArchiver.createArchive();
         }
         catch ( ArchiverException e )
         {
             getLog().error( e.getMessage(), e );
             throw new MojoExecutionException( e.getMessage(), e );
         }
         catch ( IOException e )
         {
             getLog().error( e.getMessage(), e );
             throw new MojoExecutionException( e.getMessage(), e );
         }
 
         return resultArchive;
 
     }
 
     private void failIfParametersAreNotInTheirValidValueRanges()
         throws MojoFailureException
     {
         if ( compression != null && ( compression < 0 || compression > 2 ) )
         {
             String message =
                 "The given compression parameters " + compression + " is not in the valid value range from 0..2";
             getLog().error( message );
             throw new MojoFailureException( message );
         }
 
         if ( endian != null && ( !"big".equals( endian ) || !"little".equals( endian ) ) )
         {
             String message = "The given endian parameter " + endian
                 + " does not contain one of the following values: 'little' or 'big'.";
             getLog().error( message );
             throw new MojoFailureException( message );
         }
     }
 
     private void ifOutputDirectoryExistsDelteIt()
         throws MojoExecutionException
     {
         if ( outputDirectoryImage.exists() )
         {
             // Delete the output folder of JLink before we start
             // otherwise JLink will fail with a message "Error: directory already exists: ..."
             try
             {
                 getLog().debug( "Deleting existing " + outputDirectoryImage.getAbsolutePath() );
                 FileUtils.forceDelete( outputDirectoryImage );
             }
             catch ( IOException e )
             {
                 getLog().error( "IOException", e );
                 throw new MojoExecutionException( "Failure during deletion of " + outputDirectoryImage.getAbsolutePath()
                     + " occured." );
             }
         }
     }
 
     private Commandline createJLinkCommandLine()
         throws IOException
     {
         File file = new File( outputDirectoryImage.getParentFile(), "jlinkArgs" );
         if ( !getLog().isDebugEnabled() )
         {
             file.deleteOnExit();
         }
         file.getParentFile().mkdirs();
         file.createNewFile();
 
         PrintStream argsFile = new PrintStream( file );
 
         if ( stripDebug )
         {
             argsFile.println( "--strip-debug" );
         }
 
         if ( bindServices )
         {
             argsFile.println( "--bind-services" );
         }
 
         if ( endian != null )
         {
             argsFile.println( "--endians" );
             argsFile.println( endian );
         }
         if ( ignoreSigningInformation )
         {
             argsFile.println( "--ignore-signing-information" );
         }
         if ( compression != null )
         {
             argsFile.println( "--compression" );
             argsFile.println( compression );
         }
 
         if ( disablePlugin != null )
         {
             argsFile.println( "--disable-plugin" );
             argsFile.append( '"' ).append( disablePlugin ).println( '"' );
 
         }
         if ( modulePaths != null )
         {
             //@formatter:off
             argsFile.println( "--module-path" );
             argsFile
               .append( '"' )
               .append( getPlatformDependSeparateList( modulePaths )
                          .replace( "\\", "\\\\" ) 
                      ).println( '"' );
             //@formatter:off
         }
 
         if ( noHeaderFiles )
         {
             argsFile.println( "--no-header-files" );
         }
 
         if ( noManPages )
         {
             argsFile.println( "--no-man-pages" );
         }
 
         if ( hasSuggestProviders() )
         {
             argsFile.println( "--suggest-providers" );
             String sb = getCommaSeparatedList( suggestProviders );
             argsFile.println( sb );
         }
 
         if ( hasLimitModules() )
         {
             argsFile.println( "--limit-modules" );
             String sb = getCommaSeparatedList( limitModules );
             argsFile.println( sb );
         }
 
         if ( hasModules() )
         {
             argsFile.println( "--add-modules" );
             // This must be name of the module and *NOT* the name of the
             // file! Can we somehow pre check this information to fail early?
             String sb = getCommaSeparatedList( addModules );
             argsFile.append( '"' ).append( sb.replace( "\\", "\\\\" ) ).println( '"' );
         }
 
         if ( pluginModulePath != null )
         {
             argsFile.println( "--plugin-module-path" );
             StringBuilder sb = convertSeparatedModulePathToPlatformSeparatedModulePath( pluginModulePath );
             argsFile.append( '"' ).append( sb.toString().replace( "\\", "\\\\" ) ).println( '"' );
         }
 
         if ( outputDirectory != null )
         {
             argsFile.println( "--output" );
             argsFile.println( outputDirectoryImage );
         }
 
         if ( verbose )
         {
             argsFile.println( "--verbose" );
         }
         argsFile.close();
 
         Commandline cmd = new Commandline();
         cmd.createArg().setValue( '@' + file.getAbsolutePath() );
 
         return cmd;
     }
 
     private boolean hasSuggestProviders()
     {
         return suggestProviders != null && !suggestProviders.isEmpty();
     }
 
     private boolean hasLimitModules()
     {
         return limitModules != null && !limitModules.isEmpty();
     }
 
     private boolean hasModules()
     {
         return addModules != null && !addModules.isEmpty();
     }
     
     private void writeBoxedWarning( String message )
     {
         String line = StringUtils.repeat( "*", message.length() + 4 );
         getLog().warn( line );
         getLog().warn( "* " + MessageUtils.buffer().strong( message )  + " *" );
         getLog().warn( line );
     }
     
 }