com.simpligility.maven.plugins.android.common.NativeHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-maven-plugin Show documentation
Show all versions of android-maven-plugin Show documentation
Maven Plugin for Android Development
package com.simpligility.maven.plugins.android.common;
import com.google.common.io.PatternFilenameFilter;
import com.simpligility.maven.plugins.android.AbstractAndroidMojo;
import com.simpligility.maven.plugins.android.AndroidNdk;
import com.simpligility.maven.plugins.android.phase09package.ApklibMojo;
import org.apache.commons.io.FileUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.resolver.filter.AndArtifactFilter;
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.artifact.resolver.filter.ExcludesArtifactFilter;
import org.apache.maven.artifact.resolver.filter.OrArtifactFilter;
import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Exclusion;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
import org.apache.maven.shared.dependency.graph.DependencyNode;
import org.apache.maven.shared.dependency.graph.traversal.CollectingDependencyNodeVisitor;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FilenameFilter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Scanner;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static com.simpligility.maven.plugins.android.common.AndroidExtension.AAR;
import static com.simpligility.maven.plugins.android.common.AndroidExtension.APKLIB;
/**
* @author Johan Lindquist
*/
public class NativeHelper
{
public static final int NDK_REQUIRED_VERSION = 7;
private MavenProject project;
private DependencyGraphBuilder dependencyGraphBuilder;
private Log log;
public NativeHelper( MavenProject project, DependencyGraphBuilder dependencyGraphBuilder, Log log )
{
this.project = project;
this.dependencyGraphBuilder = dependencyGraphBuilder;
this.log = log;
}
public static boolean hasStaticNativeLibraryArtifact( Set resolveNativeLibraryArtifacts,
File unpackDirectory,
String ndkArchitecture )
{
for ( Artifact resolveNativeLibraryArtifact : resolveNativeLibraryArtifacts )
{
if ( Const.ArtifactType.NATIVE_IMPLEMENTATION_ARCHIVE.equals( resolveNativeLibraryArtifact.getType() ) )
{
return true;
}
if ( APKLIB.equals( resolveNativeLibraryArtifact.getType() ) )
{
File[] aFiles = listNativeFiles( resolveNativeLibraryArtifact, unpackDirectory,
ndkArchitecture, true );
if ( aFiles != null && aFiles.length > 0 )
{
return true;
}
}
}
return false;
}
public static boolean hasSharedNativeLibraryArtifact( Set resolveNativeLibraryArtifacts,
File unpackDirectory,
String ndkArchitecture )
{
for ( Artifact resolveNativeLibraryArtifact : resolveNativeLibraryArtifacts )
{
if ( Const.ArtifactType.NATIVE_SYMBOL_OBJECT.equals( resolveNativeLibraryArtifact.getType() ) )
{
return true;
}
if ( APKLIB.equals( resolveNativeLibraryArtifact.getType() ) )
{
File[] soFiles = listNativeFiles( resolveNativeLibraryArtifact, unpackDirectory,
ndkArchitecture, false );
if ( soFiles != null && soFiles.length > 0 )
{
return true;
}
}
}
return false;
}
public static File[] listNativeFiles( Artifact a, File unpackDirectory,
final String ndkArchitecture, final boolean staticLibrary )
{
File libsFolder = new File(
AbstractAndroidMojo.getLibraryUnpackDirectory( unpackDirectory, a ),
ApklibMojo.NATIVE_LIBRARIES_FOLDER + File.separator + ndkArchitecture );
if ( libsFolder.exists() )
{
return libsFolder.listFiles( new FilenameFilter()
{
public boolean accept( final File dir, final String name )
{
return name.startsWith( "lib" ) && name.endsWith( ( staticLibrary ? ".a" : ".so" ) );
}
} );
}
return null;
}
public Set getNativeDependenciesArtifacts(
AbstractAndroidMojo mojo, File unpackDirectory, boolean sharedLibraries )
throws MojoExecutionException
{
log.debug( "Finding native dependencies. UnpackFolder=" + unpackDirectory + " shared=" + sharedLibraries );
final Set filteredArtifacts = new LinkedHashSet();
final Set allArtifacts = new LinkedHashSet();
// Add all dependent artifacts declared in the pom file
// Note: The result of project.getDependencyArtifacts() can be an UnmodifiableSet so we
// have created our own above and add to that.
allArtifacts.addAll( project.getDependencyArtifacts() );
// Add all transitive artifacts as well
// this allows armeabi classifier -> apklib -> apklib -> apk chaining to only include armeabi in APK
allArtifacts.addAll( project.getArtifacts() );
for ( Artifact artifact : allArtifacts )
{
final boolean isNativeLibrary = isNativeLibrary( sharedLibraries, artifact.getType() );
log.debug( "Checking artifact : " + artifact );
// A null value in the scope indicates that the artifact has been attached
// as part of a previous build step (NDK mojo)
if ( isNativeLibrary && artifact.getScope() == null )
{
// Including attached artifact
log.debug( "Including attached artifact: " + artifact + ". Artifact scope is not set." );
filteredArtifacts.add( artifact );
}
else
{
if ( isNativeLibrary && (
Artifact.SCOPE_COMPILE.equals( artifact.getScope() ) || Artifact.SCOPE_RUNTIME
.equals( artifact.getScope() ) ) )
{
log.debug( "Including attached artifact: " + artifact + ". Artifact scope is Compile or Runtime." );
filteredArtifacts.add( artifact );
}
else
{
final String type = artifact.getType();
if ( APKLIB.equals( type ) || AAR.equals( type ) )
{
// Check if the artifact contains a libs folder - if so, include it in the list
final File libsFolder;
if ( mojo != null )
{
libsFolder = mojo.getUnpackedLibNativesFolder( artifact );
}
else
{
// This is used from NativeHelperTest since we have no AbstractAndroidMojo there
libsFolder = new File(
AbstractAndroidMojo.getLibraryUnpackDirectory( unpackDirectory, artifact ),
AAR.equals( type ) ? "jni" : "libs" );
}
if ( !libsFolder.exists() )
{
log.debug( "Skipping " + libsFolder.getAbsolutePath() + " for native artifacts" );
continue;
}
if ( !libsFolder.isDirectory() )
{
continue;
}
log.debug( "Checking " + libsFolder.getAbsolutePath() + " for native artifacts" );
// make sure we ignore libs folders that only contain JARs
// The regular expression filters out all file paths ending with '.jar' or '.JAR',
// so all native libs remain
if ( libsFolder.list( new PatternFilenameFilter( "^.*(? 0 )
{
log.debug( "Including attached artifact: " + artifact + ". Artifact is "
+ artifact.getType() );
filteredArtifacts.add( artifact );
}
}
else if ( ! "jar".equals( type ) )
{
log.debug( "Not checking " + type + " for native artifacts" );
}
}
}
}
Set transitiveArtifacts = processTransitiveDependencies( project.getDependencies(), sharedLibraries );
filteredArtifacts.addAll( transitiveArtifacts );
return filteredArtifacts;
}
private boolean isNativeLibrary( boolean sharedLibraries, String artifactType )
{
return ( sharedLibraries
? Const.ArtifactType.NATIVE_SYMBOL_OBJECT.equals( artifactType )
: Const.ArtifactType.NATIVE_IMPLEMENTATION_ARCHIVE.equals( artifactType )
);
}
private Set processTransitiveDependencies( List dependencies, boolean sharedLibraries )
throws MojoExecutionException
{
final Set transitiveArtifacts = new LinkedHashSet();
for ( Dependency dependency : dependencies )
{
if ( ! Artifact.SCOPE_PROVIDED.equals( dependency.getScope() ) && ! dependency.isOptional() )
{
final Set transArtifactsFor = processTransitiveDependencies( dependency, sharedLibraries );
log.debug( "Found transitive dependencies for : " + dependency + " transDeps : " + transArtifactsFor );
transitiveArtifacts.addAll( transArtifactsFor );
}
}
return transitiveArtifacts;
}
private Set processTransitiveDependencies( Dependency dependency, boolean sharedLibraries )
throws MojoExecutionException
{
try
{
final Set artifacts = new LinkedHashSet();
final List exclusionPatterns = new ArrayList();
if ( dependency.getExclusions() != null && ! dependency.getExclusions().isEmpty() )
{
for ( final Exclusion exclusion : dependency.getExclusions() )
{
exclusionPatterns.add( exclusion.getGroupId() + ":" + exclusion.getArtifactId() );
}
}
final ArtifactFilter optionalFilter = new ArtifactFilter()
{
@Override
public boolean include( Artifact artifact )
{
return !artifact.isOptional();
}
};
final AndArtifactFilter filter = new AndArtifactFilter();
filter.add( new ExcludesArtifactFilter( exclusionPatterns ) );
filter.add( new OrArtifactFilter( Arrays.asList( new ScopeArtifactFilter( "compile" ),
new ScopeArtifactFilter( "runtime" ),
new ScopeArtifactFilter( "test" ) ) ) );
filter.add( optionalFilter );
final DependencyNode node = dependencyGraphBuilder.buildDependencyGraph( project, filter );
final CollectingDependencyNodeVisitor collectingVisitor = new CollectingDependencyNodeVisitor();
node.accept( collectingVisitor );
final List dependencies = collectingVisitor.getNodes();
for ( final DependencyNode dep : dependencies )
{
final boolean isNativeLibrary = isNativeLibrary( sharedLibraries, dep.getArtifact().getType() );
if ( isNativeLibrary )
{
artifacts.add( dep.getArtifact() );
}
}
return artifacts;
}
catch ( Exception e )
{
throw new MojoExecutionException( "Error while processing transitive dependencies", e );
}
}
public static void validateNDKVersion( File ndkHomeDir ) throws MojoExecutionException
{
final File ndkVersionFile = new File( ndkHomeDir, "RELEASE.TXT" );
if ( ! ndkVersionFile.exists() )
{
throw new MojoExecutionException(
"Could not locate RELEASE.TXT in the Android NDK base directory '" + ndkHomeDir.getAbsolutePath()
+ "'. Please verify your setup! " + AndroidNdk.PROPER_NDK_HOME_DIRECTORY_MESSAGE );
}
try
{
String versionStr = FileUtils.readFileToString( ndkVersionFile );
validateNDKVersion( NDK_REQUIRED_VERSION, versionStr );
}
catch ( Exception e )
{
throw new MojoExecutionException( "Error while extracting NDK version from '"
+ ndkVersionFile.getAbsolutePath() + "'. Please verify your setup! "
+ AndroidNdk.PROPER_NDK_HOME_DIRECTORY_MESSAGE );
}
}
public static void validateNDKVersion( int desiredVersion, String versionStr ) throws MojoExecutionException
{
int version = 0;
if ( versionStr != null )
{
versionStr = versionStr.trim();
Pattern pattern = Pattern.compile( "[r]([0-9]{1,3})([a-z]{0,1}).*" );
Matcher m = pattern.matcher( versionStr );
if ( m.matches() )
{
final String group = m.group( 1 );
version = Integer.parseInt( group );
}
}
if ( version < desiredVersion )
{
throw new MojoExecutionException( "You are running an old NDK (version " + versionStr + "), please update "
+ "to at least r'" + desiredVersion + "' or later" );
}
}
public static String[] getAppAbi( File applicationMakefile )
{
Scanner scanner = null;
try
{
if ( applicationMakefile != null && applicationMakefile.exists() )
{
scanner = new Scanner( applicationMakefile );
while ( scanner.hasNextLine( ) )
{
String line = scanner.nextLine().trim();
if ( line.startsWith( "APP_ABI" ) )
{
return line.substring( line.indexOf( ":=" ) + 2 ).trim().split( " " );
}
}
}
}
catch ( FileNotFoundException e )
{
// do nothing
}
finally
{
if ( scanner != null )
{
scanner.close();
}
}
return null;
}
/** Extracts, if embedded correctly, the artifacts architecture from its classifier. The format of the
* classifier, if including the architecture is <architecture>-<classifier>. If no
* architecture is embedded in the classifier, 'armeabi' will be returned.
*
*
* @param artifact The artifact to retrieve the classifier from.
* @param defaultArchitecture The architecture to return if can't be resolved from the classifier
* @return The retrieved architecture, or defaulArchitecture if not resolveable
*/
public static String extractArchitectureFromArtifact( Artifact artifact, final String defaultArchitecture )
{
String classifier = artifact.getClassifier();
if ( classifier != null )
{
//
// We loop backwards to catch the case where the classifier is
// potentially armeabi-v7a - this collides with armeabi if looping
// through this loop in the other direction
//
for ( int i = AndroidNdk.NDK_ARCHITECTURES.length - 1; i >= 0; i-- )
{
String ndkArchitecture = AndroidNdk.NDK_ARCHITECTURES[i];
if ( classifier.startsWith( ndkArchitecture ) )
{
return ndkArchitecture;
}
}
}
// Default case is to return the default architecture
return defaultArchitecture;
}
/** Attempts to extract, from various sources, the applicable list of NDK architectures to support
* as part of the build.
*
*
* It retrieves the list from the following places:
*
* - ndkArchitecture parameter
* - projects Application.mk - currently only a single architecture is supported by this method
*
*
*
* @param ndkArchitectures Space separated list of architectures. This may be from configuration or otherwise
* @param applicationMakefile The makefile (Application.mk) to retrieve the list from.
* @param basedir Directory the build is running from (to resolve files)
*
* @return List of architectures to be supported by build.
*
* @throws MojoExecutionException
*/
public static String[] getNdkArchitectures( final String ndkArchitectures, final String applicationMakefile,
final File basedir )
throws MojoExecutionException
{
// if there is a specified ndk architecture, return it
if ( ndkArchitectures != null )
{
return ndkArchitectures.split( " " );
}
// if there is no application makefile specified, let's use the default one
String applicationMakefileToUse = applicationMakefile;
if ( applicationMakefileToUse == null )
{
applicationMakefileToUse = "jni/Application.mk";
}
// now let's see if the application file exists
File appMK = new File( basedir, applicationMakefileToUse );
if ( appMK.exists() )
{
String[] foundNdkArchitectures = getAppAbi( appMK );
if ( foundNdkArchitectures != null )
{
return foundNdkArchitectures;
}
}
// return a default ndk architecture
return new String[] { "armeabi" };
}
/** Helper method for determining whether the specified architecture is a match for the
* artifact using its classifier. When used for architecture matching, the classifier must be
* formed by <architecture>-<classifier>.
* If the artifact is legacy and defines no valid architecture, the artifact architecture will
* default to armeabi.
*
* @param ndkArchitecture Architecture to check for match
* @param artifact Artifact to check the classifier match for
* @return True if the architecture matches, otherwise false
*/
public static boolean artifactHasHardwareArchitecture( Artifact artifact, String ndkArchitecture,
String defaultArchitecture )
{
return Const.ArtifactType.NATIVE_SYMBOL_OBJECT.equals( artifact.getType() )
&& ndkArchitecture.equals( extractArchitectureFromArtifact( artifact, defaultArchitecture ) );
}
}