components/dotnet-executable/src/main/java/npanday/executable/compiler/impl/DefaultCompiler.java - npanday - Git at Google

 package npanday.executable.compiler.impl;

 /*
  * 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 com.google.common.base.Function;
 import com.google.common.collect.Interners;
 import com.google.common.collect.Iterables;
 import npanday.ArtifactType;
 import npanday.ArtifactTypeHelper;
 import npanday.PlatformUnsupportedException;
 import npanday.executable.CommandFilter;
 import npanday.executable.ExecutionException;
 import npanday.executable.ExecutionResult;
 import npanday.executable.execution.quoting.CustomSwitchAwareQuotingStrategy;
 import npanday.vendor.Vendor;
 import org.apache.maven.artifact.Artifact;
 import org.codehaus.plexus.util.FileUtils;

 import javax.annotation.Nullable;
 import java.io.File;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Date;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;

 /**
  * A default compiler that can be used in most cases.
  *
  * @author Shane Isbell
  */
 public final class DefaultCompiler
     extends BaseCompiler
 {
     CustomSwitchAwareQuotingStrategy strategy;

     public DefaultCompiler(){
         // TODO: move this to xml-configuration??
         strategy = new CustomSwitchAwareQuotingStrategy();
         strategy.addQuoteNormally("resource");
     }

     @Override
     public ExecutionResult execute() throws ExecutionException, PlatformUnsupportedException
     {
         return super.execute();
     }

     public boolean shouldCompile()
     {
         return compilerContext.shouldCompile();
     }

     public boolean failOnErrorOutput()
     {
         //MONO writes warnings to standard error: this turns off failing builds on warnings for MONO
         // TODO: how do we detected mono compile errors then????
         return !compilerContext.getVendor().equals( Vendor.MONO );
     }

     public List<String> getCommands() throws ExecutionException, PlatformUnsupportedException
     {
         if ( compilerContext == null )
         {
             throw new ExecutionException( "NPANDAY-068-000: Compiler has not been initialized with a context" );
         }
         // references uses directLibraryDependencies for non transitive dependencies
         List<Artifact> references = compilerContext.getDirectLibraryDependencies();
         List<Artifact> modules = compilerContext.getDirectModuleDependencies();

         String artifactFilePath = compilerContext.getArtifact().getAbsolutePath();
         String targetArtifactType = compilerContext.getTargetArtifactType().getTargetCompileType();

         compilerContext.getFrameworkVersion();

         List<String> commands = new ArrayList<String>();

         if(compilerContext.getOutputDirectory() != null)
         {
             File f = new File(compilerContext.getOutputDirectory(), compilerContext.getArtifact().getName());
             artifactFilePath = f.getAbsolutePath();
         }

         if(artifactFilePath!=null && artifactFilePath.toLowerCase().endsWith(".zip"))
         {
         	artifactFilePath = artifactFilePath.substring(0, artifactFilePath.length() - 3) + "dll";
         }

         commands.add( "/out:" + artifactFilePath);


         commands.add( "/target:" + targetArtifactType );
         if ( modules != null && !modules.isEmpty() )
         {
             StringBuffer sb = new StringBuffer();
             for ( Iterator i = modules.iterator(); i.hasNext(); )
             {
                 Artifact artifact = (Artifact) i.next();
                 String path = artifact.getFile().getAbsolutePath();
                 sb.append( path );
                 if ( i.hasNext() )
                 {
                     sb.append( ";" );
                 }
             }
             commands.add( "/addmodule:" + sb.toString() );
         }
         if ( !references.isEmpty() )
         {

             for ( Artifact artifact : references )
             {
                 if (artifact.getFile() == null){
                     throw new ExecutionException( "NPANDAY-155-001: File for " + artifact + " has not been resolved!" );
                 }
                 String path = artifact.getFile().getAbsolutePath();

                 ArtifactType artifactType = ArtifactType.getArtifactTypeForPackagingName(artifact.getType());
                 if(ArtifactTypeHelper.isDotnetAssembly(artifactType))
                 {
                     commands.add( "/reference:" + path );
                 }
             }
         }
         for ( String arg : compilerContext.getEmbeddedResourceArgs() )
         {
             if (logger.isDebugEnabled())
             {
                 logger.debug( "NPANDAY-168-001 add resource: " + arg );
             }

             commands.add( "/resource:" + arg );
         }
         for ( File file : compilerContext.getLinkedResources() )
         {
             commands.add( "/linkresource:" + file.getAbsolutePath() );
         }
         for ( File file : compilerContext.getWin32Resources() )
         {
             commands.add( "/win32res:" + file.getAbsolutePath() );
         }
         if ( compilerContext.getWin32Icon() != null )
         {
             commands.add( "/win32icon:" + compilerContext.getWin32Icon().getAbsolutePath() );
         }

         if ( compilerContext.getVendor().equals( Vendor.MICROSOFT ) )
         {
             commands.add( "/nologo" );
         }

         // TODO: the "built-in" references should be part of the compiler-config.xml
         if ( compilerContext.getVendor().equals( Vendor.MICROSOFT ) &&
             compilerContext.getFrameworkVersion().equals( "3.0" ) )
         {
             String wcfRef = "/reference:" + System.getenv( "SystemRoot" ) +
                 "\\Microsoft.NET\\Framework\\v3.0\\Windows Communication Foundation\\";
             //TODO: This is a hard-coded path: Don't have a registry value either.
             //commands.add( wcfRef + "System.ServiceModel.dll" );
             commands.add( wcfRef + "Microsoft.Transactions.Bridge.dll" );
             commands.add( wcfRef + "Microsoft.Transactions.Bridge.Dtc.dll" );
             commands.add( wcfRef + "System.ServiceModel.Install.dll" );
             commands.add( wcfRef + "System.ServiceModel.WasHosting.dll" );
             //commands.add( wcfRef + "System.Runtime.Serialization.dll" );
             commands.add( wcfRef + "SMDiagnostics.dll" );
         }

         if ( compilerContext.getVendor().equals( Vendor.MICROSOFT ) &&
             compilerContext.getFrameworkVersion().equals( "3.5" ) )
         {
             String wcfRef = "/reference:" + System.getenv( "SystemRoot" ) +
                 "\\Microsoft.NET\\Framework\\v3.5\\";
             //TODO: This is a hard-coded path: Don't have a registry value either.
             commands.add( wcfRef + "Microsoft.Build.Tasks.v3.5.dll" );

             String cfBuildTasks = wcfRef + "Microsoft.CompactFramework.Build.Tasks.dll";
             if (new File( cfBuildTasks ).exists())
             {
                 commands.add( cfBuildTasks );
             }

             commands.add( wcfRef + "Microsoft.Data.Entity.Build.Tasks.dll" );
             commands.add( wcfRef + "Microsoft.VisualC.STLCLR.dll" );
         }

         if (compilerContext.getVendor().equals(Vendor.MICROSOFT) &&
                 (compilerContext.getFrameworkVersion().equals("4.0") ||
                         compilerContext.getFrameworkVersion().equals("4.5") ||
                         compilerContext.getFrameworkVersion().equals("4.5.1"))) {
             String frameworkPath = System.getenv( "SystemRoot" ) + "\\Microsoft.NET\\Framework\\v4.0.30319\\";
             //TODO: This is a hard-coded path: Don't have a registry value either.
             List<String> libraryNames = Arrays.asList("Microsoft.Build.Tasks.v4.0.dll",
                 "Microsoft.Data.Entity.Build.Tasks.dll", "Microsoft.VisualC.STLCLR.dll");
             for (String libraryName : libraryNames)
             {
                 String libraryFullName = frameworkPath + libraryName;
                 if (new File( libraryFullName ).exists())
                 {
                     commands.add( "/reference:" + libraryFullName );
                 }
             }
         }
         if ( compilerContext.getKeyInfo().getKeyFileUri() != null )
         {
             commands.add( "/keyfile:" + compilerContext.getKeyInfo().getKeyFileUri() );
         }
         else if ( compilerContext.getKeyInfo().getKeyContainerName() != null )
         {
             commands.add( "/keycontainer:" + compilerContext.getKeyInfo().getKeyContainerName() );
         }

         if ( compilerContext.getCommands() != null )
         {
             commands.addAll( compilerContext.getCommands() );
         }
         commands.add( "/warnaserror-" );
         //commands.add( "/nowarn" );

         // TODO: should be done through compiler-config.xml !!
         if ( compilerContext.getVendor().equals( Vendor.MONO ) &&
                  "FULL".equals( compilerContext.getTargetProfile() ) )
         {
             commands.add( "/noconfig" );
             commands.add( "/reference:System.Data" );
             commands.add( "/reference:System" );
             commands.add( "/reference:System.Drawing" );
             commands.add( "/reference:System.Messaging" );
             commands.add( "/reference:System.Web.Services" );
             commands.add( "/reference:System.Windows.Forms" );
             commands.add( "/reference:System.Xml" );
             commands.add( "/reference:System.Core" );
             commands.add( "/reference:System.Data.DataSetExtensions" );
             commands.add( "/reference:System.Xml.Linq" );
         }
         if ( !compilerContext.isTestCompile() )
         {
             // TODO: choose a better name for comments-xml and attach as artifact
             commands.add(
                 "/doc:" + new File( compilerContext.getTargetDirectory(), "comments.xml" ).getAbsolutePath() );
         }

         CommandFilter filter = compilerContext.getCommandFilter();

         List<String> filteredCommands = filter.filter( commands );

         String targetDir = ""+compilerContext.getTargetDirectory();

         Set<File> sourceFiles = compilerContext.getSourceFiles();
         if( sourceFiles != null && !sourceFiles.isEmpty() )
         {
             for(File includeSource : sourceFiles )
             {
                 filteredCommands.add(includeSource.getAbsolutePath());
             }
         }
         if ( logger.isDebugEnabled() )
         {
             logger.debug( "commands: " + filteredCommands );
         }
         String responseFilePath = targetDir + File.separator + "responsefile.rsp";

         try
         {
             StringBuilder builder = new StringBuilder();
             for(String command : filteredCommands)
             {
                 builder.append(escapeCmdParams(command) + " ");
             }
             FileUtils.fileWrite(responseFilePath, builder.toString());
         } catch (java.io.IOException e) {
             throw new ExecutionException( "NPANDAY-155-002: Error while creating response file for the commands.", e );
         }
         filteredCommands.clear();
         responseFilePath = "@" + responseFilePath;

         filteredCommands.add( responseFilePath );

         return filteredCommands;
     }

     // escaped to make use of dotnet style of command escapes .
     // Eg. /define:"CONFIG=\"Debug\",DEBUG=-1,TRACE=-1,_MyType=\"Windows\",PLATFORM=\"AnyCPU\""
     private String escapeCmdParams(String param)
     {
         // /resource:"path","more" doesn't work
         return strategy.quoteAndEscape( param, '\"', new char[]{'\"'}, new char[]{' '}, '\\', false);
     }
 }
	package npanday.executable.compiler.impl;

	/*
	* 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 com.google.common.base.Function;
	import com.google.common.collect.Interners;
	import com.google.common.collect.Iterables;
	import npanday.ArtifactType;
	import npanday.ArtifactTypeHelper;
	import npanday.PlatformUnsupportedException;
	import npanday.executable.CommandFilter;
	import npanday.executable.ExecutionException;
	import npanday.executable.ExecutionResult;
	import npanday.executable.execution.quoting.CustomSwitchAwareQuotingStrategy;
	import npanday.vendor.Vendor;
	import org.apache.maven.artifact.Artifact;
	import org.codehaus.plexus.util.FileUtils;

	import javax.annotation.Nullable;
	import java.io.File;
	import java.util.ArrayList;
	import java.util.Arrays;
	import java.util.Date;
	import java.util.Iterator;
	import java.util.List;
	import java.util.Set;

	/**
	* A default compiler that can be used in most cases.
	*
	* @author Shane Isbell
	*/
	public final class DefaultCompiler
	extends BaseCompiler
	{
	CustomSwitchAwareQuotingStrategy strategy;

	public DefaultCompiler(){
	// TODO: move this to xml-configuration??
	strategy = new CustomSwitchAwareQuotingStrategy();
	strategy.addQuoteNormally("resource");
	}

	@Override
	public ExecutionResult execute() throws ExecutionException, PlatformUnsupportedException
	{
	return super.execute();
	}

	public boolean shouldCompile()
	{
	return compilerContext.shouldCompile();
	}

	public boolean failOnErrorOutput()
	{
	//MONO writes warnings to standard error: this turns off failing builds on warnings for MONO
	// TODO: how do we detected mono compile errors then????
	return !compilerContext.getVendor().equals( Vendor.MONO );
	}

	public List<String> getCommands() throws ExecutionException, PlatformUnsupportedException
	{
	if ( compilerContext == null )
	{
	throw new ExecutionException( "NPANDAY-068-000: Compiler has not been initialized with a context" );
	}
	// references uses directLibraryDependencies for non transitive dependencies
	List<Artifact> references = compilerContext.getDirectLibraryDependencies();
	List<Artifact> modules = compilerContext.getDirectModuleDependencies();

	String artifactFilePath = compilerContext.getArtifact().getAbsolutePath();
	String targetArtifactType = compilerContext.getTargetArtifactType().getTargetCompileType();

	compilerContext.getFrameworkVersion();

	List<String> commands = new ArrayList<String>();

	if(compilerContext.getOutputDirectory() != null)
	{
	File f = new File(compilerContext.getOutputDirectory(), compilerContext.getArtifact().getName());
	artifactFilePath = f.getAbsolutePath();
	}

	if(artifactFilePath!=null && artifactFilePath.toLowerCase().endsWith(".zip"))
	{
	artifactFilePath = artifactFilePath.substring(0, artifactFilePath.length() - 3) + "dll";
	}

	commands.add( "/out:" + artifactFilePath);


	commands.add( "/target:" + targetArtifactType );
	if ( modules != null && !modules.isEmpty() )
	{
	StringBuffer sb = new StringBuffer();
	for ( Iterator i = modules.iterator(); i.hasNext(); )
	{
	Artifact artifact = (Artifact) i.next();
	String path = artifact.getFile().getAbsolutePath();
	sb.append( path );
	if ( i.hasNext() )
	{
	sb.append( ";" );
	}
	}
	commands.add( "/addmodule:" + sb.toString() );
	}
	if ( !references.isEmpty() )
	{

	for ( Artifact artifact : references )
	{
	if (artifact.getFile() == null){
	throw new ExecutionException( "NPANDAY-155-001: File for " + artifact + " has not been resolved!" );
	}
	String path = artifact.getFile().getAbsolutePath();

	ArtifactType artifactType = ArtifactType.getArtifactTypeForPackagingName(artifact.getType());
	if(ArtifactTypeHelper.isDotnetAssembly(artifactType))
	{
	commands.add( "/reference:" + path );
	}
	}
	}
	for ( String arg : compilerContext.getEmbeddedResourceArgs() )
	{
	if (logger.isDebugEnabled())
	{
	logger.debug( "NPANDAY-168-001 add resource: " + arg );
	}

	commands.add( "/resource:" + arg );
	}
	for ( File file : compilerContext.getLinkedResources() )
	{
	commands.add( "/linkresource:" + file.getAbsolutePath() );
	}
	for ( File file : compilerContext.getWin32Resources() )
	{
	commands.add( "/win32res:" + file.getAbsolutePath() );
	}
	if ( compilerContext.getWin32Icon() != null )
	{
	commands.add( "/win32icon:" + compilerContext.getWin32Icon().getAbsolutePath() );
	}

	if ( compilerContext.getVendor().equals( Vendor.MICROSOFT ) )
	{
	commands.add( "/nologo" );
	}

	// TODO: the "built-in" references should be part of the compiler-config.xml
	if ( compilerContext.getVendor().equals( Vendor.MICROSOFT ) &&
	compilerContext.getFrameworkVersion().equals( "3.0" ) )
	{
	String wcfRef = "/reference:" + System.getenv( "SystemRoot" ) +
	"\\Microsoft.NET\\Framework\\v3.0\\Windows Communication Foundation\\";
	//TODO: This is a hard-coded path: Don't have a registry value either.
	//commands.add( wcfRef + "System.ServiceModel.dll" );
	commands.add( wcfRef + "Microsoft.Transactions.Bridge.dll" );
	commands.add( wcfRef + "Microsoft.Transactions.Bridge.Dtc.dll" );
	commands.add( wcfRef + "System.ServiceModel.Install.dll" );
	commands.add( wcfRef + "System.ServiceModel.WasHosting.dll" );
	//commands.add( wcfRef + "System.Runtime.Serialization.dll" );
	commands.add( wcfRef + "SMDiagnostics.dll" );
	}

	if ( compilerContext.getVendor().equals( Vendor.MICROSOFT ) &&
	compilerContext.getFrameworkVersion().equals( "3.5" ) )
	{
	String wcfRef = "/reference:" + System.getenv( "SystemRoot" ) +
	"\\Microsoft.NET\\Framework\\v3.5\\";
	//TODO: This is a hard-coded path: Don't have a registry value either.
	commands.add( wcfRef + "Microsoft.Build.Tasks.v3.5.dll" );

	String cfBuildTasks = wcfRef + "Microsoft.CompactFramework.Build.Tasks.dll";
	if (new File( cfBuildTasks ).exists())
	{
	commands.add( cfBuildTasks );
	}

	commands.add( wcfRef + "Microsoft.Data.Entity.Build.Tasks.dll" );
	commands.add( wcfRef + "Microsoft.VisualC.STLCLR.dll" );
	}

	if (compilerContext.getVendor().equals(Vendor.MICROSOFT) &&
	(compilerContext.getFrameworkVersion().equals("4.0") \|\|
	compilerContext.getFrameworkVersion().equals("4.5") \|\|
	compilerContext.getFrameworkVersion().equals("4.5.1"))) {
	String frameworkPath = System.getenv( "SystemRoot" ) + "\\Microsoft.NET\\Framework\\v4.0.30319\\";
	//TODO: This is a hard-coded path: Don't have a registry value either.
	List<String> libraryNames = Arrays.asList("Microsoft.Build.Tasks.v4.0.dll",
	"Microsoft.Data.Entity.Build.Tasks.dll", "Microsoft.VisualC.STLCLR.dll");
	for (String libraryName : libraryNames)
	{
	String libraryFullName = frameworkPath + libraryName;
	if (new File( libraryFullName ).exists())
	{
	commands.add( "/reference:" + libraryFullName );
	}
	}
	}
	if ( compilerContext.getKeyInfo().getKeyFileUri() != null )
	{
	commands.add( "/keyfile:" + compilerContext.getKeyInfo().getKeyFileUri() );
	}
	else if ( compilerContext.getKeyInfo().getKeyContainerName() != null )
	{
	commands.add( "/keycontainer:" + compilerContext.getKeyInfo().getKeyContainerName() );
	}

	if ( compilerContext.getCommands() != null )
	{
	commands.addAll( compilerContext.getCommands() );
	}
	commands.add( "/warnaserror-" );
	//commands.add( "/nowarn" );

	// TODO: should be done through compiler-config.xml !!
	if ( compilerContext.getVendor().equals( Vendor.MONO ) &&
	"FULL".equals( compilerContext.getTargetProfile() ) )
	{
	commands.add( "/noconfig" );
	commands.add( "/reference:System.Data" );
	commands.add( "/reference:System" );
	commands.add( "/reference:System.Drawing" );
	commands.add( "/reference:System.Messaging" );
	commands.add( "/reference:System.Web.Services" );
	commands.add( "/reference:System.Windows.Forms" );
	commands.add( "/reference:System.Xml" );
	commands.add( "/reference:System.Core" );
	commands.add( "/reference:System.Data.DataSetExtensions" );
	commands.add( "/reference:System.Xml.Linq" );
	}
	if ( !compilerContext.isTestCompile() )
	{
	// TODO: choose a better name for comments-xml and attach as artifact
	commands.add(
	"/doc:" + new File( compilerContext.getTargetDirectory(), "comments.xml" ).getAbsolutePath() );
	}

	CommandFilter filter = compilerContext.getCommandFilter();

	List<String> filteredCommands = filter.filter( commands );

	String targetDir = ""+compilerContext.getTargetDirectory();

	Set<File> sourceFiles = compilerContext.getSourceFiles();
	if( sourceFiles != null && !sourceFiles.isEmpty() )
	{
	for(File includeSource : sourceFiles )
	{
	filteredCommands.add(includeSource.getAbsolutePath());
	}
	}
	if ( logger.isDebugEnabled() )
	{
	logger.debug( "commands: " + filteredCommands );
	}
	String responseFilePath = targetDir + File.separator + "responsefile.rsp";

	try
	{
	StringBuilder builder = new StringBuilder();
	for(String command : filteredCommands)
	{
	builder.append(escapeCmdParams(command) + " ");
	}
	FileUtils.fileWrite(responseFilePath, builder.toString());
	} catch (java.io.IOException e) {
	throw new ExecutionException( "NPANDAY-155-002: Error while creating response file for the commands.", e );
	}
	filteredCommands.clear();
	responseFilePath = "@" + responseFilePath;

	filteredCommands.add( responseFilePath );

	return filteredCommands;
	}

	// escaped to make use of dotnet style of command escapes .
	// Eg. /define:"CONFIG=\"Debug\",DEBUG=-1,TRACE=-1,_MyType=\"Windows\",PLATFORM=\"AnyCPU\""
	private String escapeCmdParams(String param)
	{
	// /resource:"path","more" doesn't work
	return strategy.quoteAndEscape( param, '\"', new char[]{'\"'}, new char[]{' '}, '\\', false);
	}
	}