/**
* 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.geronimo.mavenplugins.car;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.jar.JarFile;
import java.util.zip.ZipEntry;
import org.apache.geronimo.kernel.osgi.ConfigurationActivator;
import org.apache.geronimo.system.osgi.BootActivator;
import org.apache.maven.archiver.MavenArchiveConfiguration;
import org.apache.maven.archiver.MavenArchiver;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.model.License;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.codehaus.plexus.archiver.ArchiverException;
import org.codehaus.plexus.archiver.UnArchiver;
import org.codehaus.plexus.archiver.jar.JarArchiver;
import org.codehaus.plexus.archiver.jar.JarArchiver.FilesetManifestConfig;
import org.codehaus.plexus.archiver.manager.ArchiverManager;
import org.codehaus.plexus.archiver.manager.NoSuchArchiverException;
import org.codehaus.plexus.util.FileUtils;
import org.osgi.framework.Constants;
/**
* Jar up a packaged plugin
*
* @goal archive-car
* @requiresDependencyResolution runtime
*
* @version $Rev: 942436 $ $Date: 2010-05-08 14:23:24 -0400 (Sat, 08 May 2010) $
*/
public class ArchiveCarMojo
extends AbstractCarMojo
{
/**
* The maven archive configuration to use.
*
* See <a href="http://maven.apache.org/ref/current/maven-archiver/apidocs/org/apache/maven/archiver/MavenArchiveConfiguration.html">the Javadocs for MavenArchiveConfiguration</a>.
*
* @parameter
*/
private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();
/**
* The Jar archiver.
*
* @component role="org.codehaus.plexus.archiver.Archiver" roleHint="jar"
* @required
* @readonly
*/
private JarArchiver jarArchiver = null;
/**
* The Jar archiver.
*
* @component role="org.codehaus.plexus.archiver.manager.ArchiverManager"
* @required
* @readonly
*/
private ArchiverManager archiverManager = null;
/**
* The module base directory.
*
* @parameter expression="${project.basedir}"
* @required
* @readonly
*/
private File baseDirectory = null;
/**
* Directory containing the generated archive.
*
* @parameter expression="${project.build.directory}"
* @required
*/
private File outputDirectory = null;
/**
* Directory containing the classes/resources.
*
* @parameter expression="${project.build.outputDirectory}"
* @required
*/
private File classesDirectory = null;
/**
* Name of the generated archive.
*
* @parameter expression="${project.build.finalName}"
* @required
*/
private String finalName = null;
/**
* The Geronimo repository where modules will be packaged up from.
*
* @parameter expression="${project.build.directory}/repository"
* @required
*/
private File targetRepository = null;
/**
* The location where the properties mapping will be generated.
*
* <p>
* Probably don't want to change this.
* </p>
*
* @parameter expression="${project.build.directory}/explicit-versions.properties"
*/
private File explicitResolutionProperties = null;
/**
* An array of {@link org.apache.geronimo.mavenplugins.car.ClasspathElement} objects which will be used to construct the
* Class-Path entry of the manifest.
*
* This is needed to allow per-element prefixes to be added, which the standard Maven archiver
* does not provide.
*
* @parameter
*/
private ClasspathElement[] classpath = null;
/**
* The default prefix to be applied to all elements of the <tt>classpath</tt> which
* do not provide a prefix.
*
* @parameter
*/
private String classpathPrefix = null;
/**
* Location of resources directory for additional content to include in the car.
*
* @parameter expression="${project.build.directory}/resources"
*/
private File resourcesDir;
/**
* whether this is a boot bundle (starts kernel, and the config) or a normal plugin bundle.
* @parameter
*/
private boolean boot;
/**
* Additional instructions that will get processed to adjust the manifest header. Currently,
* only the Import-Package instruction is recognized.
* @parameter
*/
private Map instructions;
//
// Mojo
//
public void execute() throws MojoExecutionException, MojoFailureException {
getDependencies(project, false);
// Build the archive
File archive = createArchive();
// Attach the generated archive for install/deploy
project.getArtifact().setFile(archive);
}
private File getArtifactInRepositoryDir() {
//
// HACK: Generate the filename in the repo... really should delegate this to the repo impl
//
File dir = new File(targetRepository, project.getGroupId().replace('.', '/'));
dir = new File(dir, project.getArtifactId());
dir = new File(dir, project.getVersion());
dir = new File(dir, project.getArtifactId() + "-" + project.getVersion() + ".car");
return dir;
}
/**
* Generates the configuration archive.
*/
private File createArchive() throws MojoExecutionException {
File archiveFile = getArchiveFile(outputDirectory, finalName, null);
GeronimoArchiver archiver = new GeronimoArchiver(archiverManager);
archiver.setArchiver(jarArchiver);
archiver.setOutputFile(archiveFile);
try {
// Incldue the generated artifact contents
File artifactDirectory = getArtifactInRepositoryDir();
if (artifactDirectory.exists()) {
archiver.addArchivedFileSet(artifactDirectory);
}
// Include the optional classes.resources
if (classesDirectory.isDirectory()) {
archiver.getArchiver().addDirectory(classesDirectory);
}
if (resourcesDir.isDirectory()) {
archiver.getArchiver().addDirectory(resourcesDir);
}
//
// HACK: Include legal files here for sanity
//
//
// NOTE: Would be nice to share this with the copy-legal-files mojo
//
String[] includes = {
"LICENSE.txt",
"LICENSE",
"NOTICE.txt",
"NOTICE",
"DISCLAIMER.txt",
"DISCLAIMER"
};
archiver.getArchiver().addDirectory(baseDirectory, "META-INF/", includes, new String[0]);
//For no plan car, do nothing
if (artifactDirectory.exists()) {
JarFile includedJarFile = new JarFile(getArtifactInRepositoryDir());
if (includedJarFile.getEntry("META-INF/MANIFEST.MF") != null) {
FilesetManifestConfig mergeFilesetManifestConfig = new FilesetManifestConfig();
mergeFilesetManifestConfig.setValue("merge");
archiver.getArchiver().setFilesetmanifest(mergeFilesetManifestConfig);
} else {
//File configFile = new File(new File(getArtifactInRepositoryDir(), "META-INF"), "imports.txt");
ZipEntry importTxtEntry = includedJarFile.getEntry("META-INFO/imports.txt");
if (importTxtEntry != null) {
StringBuilder imports = new StringBuilder("org.apache.geronimo.kernel.osgi,");
if (boot) {
archive.addManifestEntry(Constants.BUNDLE_ACTIVATOR, BootActivator.class.getName());
imports.append("org.apache.geronimo.system.osgi,");
} else {
archive.addManifestEntry(Constants.BUNDLE_ACTIVATOR, ConfigurationActivator.class.getName());
}
archive.addManifestEntry(Constants.BUNDLE_NAME, project.getName());
archive.addManifestEntry(Constants.BUNDLE_VENDOR, project.getOrganization().getName());
ArtifactVersion version = project.getArtifact().getSelectedVersion();
String versionString = "" + version.getMajorVersion() + "." + version.getMinorVersion() + "." + version.getIncrementalVersion();
if (version.getQualifier() != null) {
versionString += "." + version.getQualifier();
}
archive.addManifestEntry(Constants.BUNDLE_VERSION, versionString);
archive.addManifestEntry(Constants.BUNDLE_MANIFESTVERSION, "2");
archive.addManifestEntry(Constants.BUNDLE_DESCRIPTION, project.getDescription());
// NB, no constant for this one
archive.addManifestEntry("Bundle-License", ((License) project.getLicenses().get(0)).getUrl());
archive.addManifestEntry(Constants.BUNDLE_DOCURL, project.getUrl());
archive.addManifestEntry(Constants.BUNDLE_SYMBOLICNAME, project.getGroupId() + "." + project.getArtifactId());
Reader in = new InputStreamReader(includedJarFile.getInputStream(importTxtEntry));
char[] buf = new char[1024];
try {
int i;
while ((i = in.read(buf)) > 0) {
imports.append(buf, 0, i);
}
} finally {
in.close();
}
// do we have any additional processing directives?
if (instructions != null) {
String explicitImports = (String) instructions.get(Constants.IMPORT_PACKAGE);
// if there is an Import-Package instructions, then add these imports to the
// list
if (explicitImports != null) {
// if specified on multiple lines, remove the line-ends.
explicitImports = explicitImports.replaceAll("[\r\n]", "");
imports.append(',');
imports.append(explicitImports);
}
String requiredBundles = (String) instructions.get(Constants.REQUIRE_BUNDLE);
if (requiredBundles != null) {
requiredBundles = requiredBundles.replaceAll("[\r\n]", "");
archive.addManifestEntry(Constants.REQUIRE_BUNDLE, requiredBundles);
}
}
archive.addManifestEntry(Constants.IMPORT_PACKAGE, imports.toString());
archive.addManifestEntry(Constants.DYNAMICIMPORT_PACKAGE, "*");
}
}
}
archiver.createArchive(project, archive);
return archiveFile;
} catch (Exception e) {
throw new MojoExecutionException("Failed to create archive", e);
} finally {
archiver.cleanup();
}
}
private static class GeronimoArchiver extends MavenArchiver {
private ArchiverManager archiverManager;
private List<File> tmpDirs = new ArrayList<File>();
public GeronimoArchiver(ArchiverManager archiverManager) {
this.archiverManager = archiverManager;
}
public void addArchivedFileSet(File archiveFile) throws ArchiverException {
UnArchiver unArchiver;
try {
unArchiver = archiverManager.getUnArchiver(archiveFile);
} catch (NoSuchArchiverException e) {
throw new ArchiverException(
"Error adding archived file-set. UnArchiver not found for: " + archiveFile,
e);
}
File tempDir = FileUtils.createTempFile("archived-file-set.", ".tmp", null);
tempDir.mkdirs();
tmpDirs.add(tempDir);
unArchiver.setSourceFile(archiveFile);
unArchiver.setDestDirectory(tempDir);
try {
unArchiver.extract();
} catch (IOException e) {
throw new ArchiverException("Error adding archived file-set. Failed to extract: "
+ archiveFile, e);
}
getArchiver().addDirectory(tempDir, null, null, null);
}
public void cleanup() {
for (File dir : tmpDirs) {
try {
FileUtils.deleteDirectory(dir);
} catch (IOException e) {
e.printStackTrace();
}
}
tmpDirs.clear();
}
}
}