package org.apache.openejb.maven.plugin;
/*
* 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 org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.repository.ArtifactRepositoryPolicy;
import org.apache.maven.artifact.repository.DefaultArtifactRepository;
import org.apache.maven.artifact.repository.layout.DefaultRepositoryLayout;
import org.apache.maven.artifact.resolver.ArtifactResolver;
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.Parameter;
import org.apache.maven.settings.Settings;
import org.apache.openejb.config.RemoteServer;
import org.apache.openejb.loader.Files;
import org.apache.openejb.loader.IO;
import org.apache.openejb.loader.Zips;
import org.apache.openejb.util.OpenEjbVersion;
import org.apache.tomee.util.InstallationEnrichers;
import org.apache.tomee.util.QuickServerXmlParser;
import org.apache.tomee.util.SimpleTomEEFormatter;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.FilenameFilter;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.CountDownLatch;
import java.util.logging.SimpleFormatter;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import static org.apache.maven.artifact.Artifact.SCOPE_COMPILE;
import static org.apache.maven.artifact.repository.ArtifactRepositoryPolicy.CHECKSUM_POLICY_WARN;
import static org.apache.maven.artifact.repository.ArtifactRepositoryPolicy.UPDATE_POLICY_DAILY;
import static org.apache.maven.artifact.repository.ArtifactRepositoryPolicy.UPDATE_POLICY_NEVER;
import static org.apache.maven.artifact.versioning.VersionRange.createFromVersion;
import static org.apache.openejb.util.JarExtractor.delete;
import static org.codehaus.plexus.util.FileUtils.deleteDirectory;
import static org.codehaus.plexus.util.IOUtil.close;
import static org.codehaus.plexus.util.IOUtil.copy;
public abstract class AbstractTomEEMojo extends AbstractAddressMojo {
// if we get let say > 5 patterns like it we should create a LocationAnalyzer
// for < 5 patterns it should be fine
private static final String NAME_STR = "?name=";
private static final String UNZIP_PREFIX = "unzip:";
private static final String REMOVE_PREFIX = "remove:";
@Component
protected ArtifactFactory factory;
@Component
protected ArtifactResolver resolver;
@Parameter(defaultValue = "${localRepository}", readonly = true)
protected ArtifactRepository local;
@Parameter(defaultValue = "${project.remoteArtifactRepositories}", readonly = true)
protected List<ArtifactRepository> remoteRepos;
@Parameter(property = "tomee-plugin.skipCurrentProject", defaultValue = "false")
protected boolean skipCurrentProject;
@Parameter(property = "tomee-plugin.version", defaultValue = "-1")
protected String tomeeVersion;
@Parameter(property = "tomee-plugin.groupId", defaultValue = "org.apache.openejb")
protected String tomeeGroupId;
@Parameter(property = "tomee-plugin.artifactId", defaultValue = "apache-tomee")
protected String tomeeArtifactId;
/**
* while tar.gz is not managed it is readonly
*/
@Parameter(property = "tomee-plugin.type", defaultValue = "zip", readonly = true)
protected String tomeeType;
@Parameter(property = "tomee-plugin.apache-repos", defaultValue = "snapshots")
protected String apacheRepos;
@Parameter(property = "tomee-plugin.classifier", defaultValue = "webprofile")
protected String tomeeClassifier;
@Parameter(property = "tomee-plugin.shutdown", defaultValue = "8005")
protected int tomeeShutdownPort = 8005;
@Parameter(property = "tomee-plugin.ajp", defaultValue = "8009")
protected int tomeeAjpPort = 8009;
@Parameter(property = "tomee-plugin.https")
protected Integer tomeeHttpsPort;
@Parameter(property = "tomee-plugin.args")
protected String args;
@Parameter(property = "tomee-plugin.debug", defaultValue = "false")
protected boolean debug;
@Parameter(property = "tomee-plugin.simple-log", defaultValue = "false")
protected boolean simpleLog;
@Parameter(property = "tomee-plugin.debugPort", defaultValue = "5005")
protected int debugPort;
@Parameter(defaultValue = "${project.build.directory}/apache-tomee")
protected File catalinaBase;
/**
* relative to tomee.base.
*/
@Parameter(defaultValue = "webapps")
protected String webappDir;
/**
* relative to tomee.base.
*/
@Parameter(defaultValue = "apps")
protected String appDir;
/**
* relative to tomee.base.
*/
@Parameter(defaultValue = "lib")
protected String libDir;
@Parameter(property = "tomee-plugin.conf", defaultValue = "${project.basedir}/src/main/tomee/conf")
protected File config;
@Parameter(property = "tomee-plugin.bin", defaultValue = "${project.basedir}/src/main/tomee/bin")
protected File bin;
@Parameter(property = "tomee-plugin.lib", defaultValue = "${project.basedir}/src/main/tomee/lib")
protected File lib;
@Parameter
protected Map<String, String> systemVariables;
@Parameter(property = "tomee-plugin.quick-session", defaultValue = "true")
private boolean quickSession;
@Parameter(property = "tomee-plugin.force-reloadable", defaultValue = "false")
protected boolean forceReloadable;
/**
* supported formats:
* --> groupId:artifactId:version...
* --> unzip:groupId:artifactId:version...
* --> remove:prefix (often prefix = artifactId)
*/
@Parameter
protected List<String> libs;
@Parameter
protected List<String> webapps;
@Parameter
protected List<String> apps;
@Parameter(defaultValue = "${project.build.directory}/${project.build.finalName}.${project.packaging}")
protected File warFile;
@Parameter(property = "tomee-plugin.remove-default-webapps", defaultValue = "true")
protected boolean removeDefaultWebapps;
@Parameter(property = "tomee-plugin.deploy-openejb-internal-application", defaultValue = "false")
protected boolean deployOpenEjbApplication;
@Parameter(property = "tomee-plugin.remove-tomee-webapps", defaultValue = "false")
protected boolean removeTomeeWebapp;
@Parameter(defaultValue = "${project.packaging}", readonly = true)
protected String packaging;
@Parameter(property = "tomee-plugin.keep-server-xml", defaultValue = "false")
protected boolean keepServerXmlAsthis;
/**
* The current user system settings for use in Maven.
*/
@Parameter(defaultValue = "${settings}", readonly = true)
protected Settings settings;
protected File deployedFile = null;
private String additionalCp = null;
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
if ("-1".equals(tomeeVersion)) {
final String version = OpenEjbVersion.get().getVersion();
tomeeVersion = "1" + version.substring(1, version.length());
}
unzip(resolve(), catalinaBase);
if (removeDefaultWebapps) { // do it first to let add other war
removeDefaultWebapps(removeTomeeWebapp);
}
copyLibs(libs, new File(catalinaBase, libDir), "jar");
copyLibs(webapps, new File(catalinaBase, webappDir), "war"); // TODO: manage custom context ?context=foo
copyLibs(apps, new File(catalinaBase, appDir), "jar");
overrideConf(config);
overrideConf(lib);
final Collection<File> copied = overrideConf(bin);
for (File copy : copied) {
if (copy.getName().endsWith(".bat") || copy.getName().endsWith(".sh")) {
if (!copy.setExecutable(true)) {
getLog().warn("can't make " + copy.getPath() + " executable");
}
}
}
if (simpleLog) {
additionalCp = activateSimpleLog();
}
if (!keepServerXmlAsthis) {
overrideAddresses();
}
if (!skipCurrentProject) {
copyWar();
}
run();
}
private String activateSimpleLog() {
// adding SimpleTomEEFormatter to the classpath
final String cp = InstallationEnrichers.addOneLineFormatter(catalinaBase);
// replacing java.util.logging.SimpleFormatter by SimpleTomEEFormatter
final File loggingProperties = new File(catalinaBase, "conf/logging.properties");
if (loggingProperties.exists() && !new File(config, "conf/logging.properties").exists()) {
try {
final String content = IO.slurp(loggingProperties)
.replace(SimpleFormatter.class.getName(), SimpleTomEEFormatter.class.getName());
final FileWriter writer = new FileWriter(loggingProperties);
try {
writer.write(content);
} finally {
IO.close(writer);
}
} catch (Exception e) {
getLog().error("Can't set SimpleTomEEFormatter", e);
return null;
}
return cp;
}
return null;
}
private void removeDefaultWebapps(final boolean removeTomee) {
final File webapps = new File(catalinaBase, webappDir);
if (webapps.isDirectory()) {
final File[] files = webapps.listFiles();
if (null != files) for (File webapp : files) {
final String name = webapp.getName();
if (webapp.isDirectory() && (removeTomee || !name.equals("tomee"))) {
try {
deleteDirectory(webapp);
} catch (IOException ignored) {
// no-op
}
}
}
}
getLog().info("Removed not mandatory default webapps");
}
private void copyLibs(final List<String> files, final File destParent, final String defaultType) {
if (files == null || files.isEmpty()) {
return;
}
if (!destParent.exists() && !destParent.mkdirs()) {
getLog().warn("can't create '" + destParent.getPath() + "'");
}
for (String file : files) {
updateLib(file, destParent, defaultType);
}
}
private void updateLib(final String rawLib, final File destParent, final String defaultType) {
InputStream is = null;
OutputStream os = null;
// special hook to get more info
String lib = rawLib;
String extractedName = null;
if (lib.contains(NAME_STR)) {
lib = lib.substring(0, rawLib.indexOf(NAME_STR));
extractedName = rawLib.substring(rawLib.indexOf(NAME_STR) + NAME_STR.length(), rawLib.length());
if (!extractedName.endsWith(".jar") && !extractedName.endsWith(".war") && !extractedName.endsWith(".ear")) {
extractedName = extractedName + "." + defaultType;
}
}
boolean unzip = false;
if (lib.startsWith(UNZIP_PREFIX)) {
lib = lib.substring(UNZIP_PREFIX.length());
unzip = true;
}
if (lib.startsWith(REMOVE_PREFIX)) {
final String prefix = lib.substring(REMOVE_PREFIX.length());
final File[] files = destParent.listFiles(new FilenameFilter() {
@Override
public boolean accept(final File dir, final String name) {
return name.startsWith(prefix);
}
});
if (files != null) {
for (File file : files) {
if (!IO.delete(file)) {
file.deleteOnExit();
}
getLog().info("Deleted " + file.getPath());
}
}
} else {
final String[] infos = lib.split(":");
final String classifier;
final String type;
if (infos.length < 3) {
throw new TomEEException("format for librairies should be <groupId>:<artifactId>:<version>[:<type>[:<classifier>]]");
}
if (infos.length >= 4) {
type = infos[3];
} else {
type = defaultType;
}
if (infos.length == 5) {
classifier = infos[4];
} else {
classifier = null;
}
try {
final Artifact artifact = factory.createDependencyArtifact(infos[0], infos[1], createFromVersion(infos[2]), type, classifier, SCOPE_COMPILE);
resolver.resolve(artifact, remoteRepos, local);
final File file = artifact.getFile();
if (!unzip) {
final File dest;
if (extractedName == null) {
dest = new File(destParent, file.getName());
} else {
dest = new File(destParent, extractedName);
}
is = new BufferedInputStream(new FileInputStream(file));
os = new BufferedOutputStream(new FileOutputStream(dest));
copy(is, os);
getLog().info("Copied '" + lib + "' in '" + dest.getAbsolutePath());
} else {
Zips.unzip(file, destParent, true);
getLog().info("Unzipped '" + lib + "' in '" + destParent.getAbsolutePath());
}
} catch (Exception e) {
getLog().error(e.getMessage(), e);
throw new TomEEException(e.getMessage(), e);
} finally {
close(is);
close(os);
}
}
}
private void copyWar() {
if ("pom".equals(packaging)) {
return;
}
final boolean war = "war".equals(packaging);
final String name = warFile.getName();
final File out;
if (war) {
out = new File(catalinaBase, webappDir + "/" + name);
} else {
final File parent = new File(catalinaBase, appDir);
if (!parent.exists() && !parent.mkdirs()) {
getLog().warn("can't create '" + parent.getPath() + "'");
}
out = new File(parent, name);
}
delete(out);
if (out.exists() && !out.isDirectory()) {
final String dir = name.substring(0, name.lastIndexOf('.'));
final File unpacked;
if (war) {
unpacked = new File(catalinaBase, webappDir + "/" + dir);
} else {
unpacked = new File(catalinaBase, appDir + "/" + dir);
}
delete(unpacked);
}
if (warFile.exists() && warFile.isDirectory()) {
try {
IO.copyDirectory(warFile, out);
} catch (IOException e) {
throw new TomEEException(e.getMessage(), e);
}
} else if (warFile.exists()) {
InputStream is = null;
OutputStream os = null;
try {
is = new FileInputStream(warFile);
os = new FileOutputStream(out);
copy(is, os);
getLog().info("Installed '" + warFile.getAbsolutePath() + "' in " + out.getAbsolutePath());
} catch (Exception e) {
throw new TomEEException(e.getMessage(), e);
} finally {
close(is);
close(os);
}
} else {
getLog().warn("'" + warFile + "' doesn't exist, ignoring (maybe run mvn package before this plugin)");
}
deployedFile = out;
}
private void overrideAddresses() {
final File serverXml = new File(catalinaBase, "conf/server.xml");
final QuickServerXmlParser parser = QuickServerXmlParser.parse(serverXml);
String value = read(serverXml);
if (tomeeHttpsPort != null && tomeeHttpsPort > 0 && parser.value("HTTPS", null) == null) {
// ensure connector is not commented
value = value.replace("<Service name=\"Catalina\">", "<Service name=\"Catalina\">\n"
+ " <Connector port=\"" + tomeeHttpsPort + "\" protocol=\"HTTP/1.1\" SSLEnabled=\"true\"\n" +
" scheme=\"https\" secure=\"true\"\n" +
" clientAuth=\"false\" sslProtocol=\"TLS\" />\n");
}
if (tomeeHttpsPort == null) {
// avoid NPE
tomeeHttpsPort = 8443;
}
FileWriter writer = null;
try {
writer = new FileWriter(serverXml);
writer.write(value
.replace(parser.http(), Integer.toString(tomeeHttpPort))
.replace(parser.https(), Integer.toString(tomeeHttpsPort))
.replace(parser.ajp(), Integer.toString(tomeeAjpPort))
.replace(parser.stop(), Integer.toString(tomeeShutdownPort))
.replace(parser.host(), tomeeHost)
.replace(parser.appBase(), webappDir));
} catch (IOException e) {
throw new TomEEException(e.getMessage(), e);
} finally {
close(writer);
}
}
private static String read(File file) {
FileInputStream in = null;
try {
in = new FileInputStream(file);
final StringBuilder sb = new StringBuilder();
int i = in.read();
while (i != -1) {
sb.append((char) i);
i = in.read();
}
return sb.toString();
} catch (Exception e) {
throw new TomEEException(e.getMessage(), e);
} finally {
close(in);
}
}
private Collection<File> overrideConf(final File dir) {
if (!dir.exists()) {
return Collections.emptyList();
}
final File[] files = dir.listFiles();
if (files != null) {
final Collection<File> copied = new ArrayList<File>();
for (final File f : files) {
if (f.isHidden()) {
continue;
}
final String file = dir.getName() + "/" + f.getName();
final File destination = new File(catalinaBase, file);
if (f.isDirectory()) {
Files.mkdirs(destination);
try {
IO.copyDirectory(f, destination);
} catch (IOException e) {
throw new TomEEException(e.getMessage(), e);
}
} else {
InputStream in = null;
OutputStream out = null;
try {
in = new FileInputStream(f);
out = new FileOutputStream(destination);
copy(in, out);
copied.add(f);
getLog().info("Override '" + file + "'");
} catch (Exception e) {
throw new TomEEException(e.getMessage(), e);
} finally {
close(in);
close(out);
}
}
}
return copied;
}
return Collections.emptyList();
}
protected void run() {
final String deployOpenEjbAppKey = "openejb.system.apps";
final List<String> strings = new ArrayList<String>();
if (systemVariables != null) {
for (Map.Entry<String, String> entry : systemVariables.entrySet()) {
final String key = entry.getKey();
final String value = entry.getValue();
if (value == null) {
strings.add("-D" + key);
} else if (value.contains(" ")) {
strings.add(String.format("'-D%s=%s'", key, value));
} else {
strings.add(String.format("-D%s=%s", key, value));
}
if (deployOpenEjbAppKey.equals(key)) {
deployOpenEjbApplication = true;
}
}
}
if (quickSession) {
strings.add("-Dopenejb.session.manager=org.apache.tomee.catalina.session.QuickSessionManager");
}
if (!deployOpenEjbApplication) { // true is the default so don't need to set the property
if (args == null || !args.contains("-D" + deployOpenEjbAppKey)) {
strings.add("-D" + deployOpenEjbAppKey + "=false");
}
}
if (args != null) {
strings.addAll(Arrays.asList(args.split(" ")));
}
if (forceReloadable) {
strings.add("-Dtomee.force-reloadable=true");
}
// init env for RemoteServer
System.setProperty("openejb.home", catalinaBase.getAbsolutePath());
if (debug) {
System.setProperty("openejb.server.debug", "true");
System.setProperty("server.debug.port", Integer.toString(debugPort));
}
System.setProperty("server.shutdown.port", Integer.toString(tomeeShutdownPort));
final RemoteServer server = new RemoteServer(getConnectAttempts(), false);
if (additionalCp != null) {
server.setAdditionalClasspath(additionalCp);
}
addShutdownHooks(server); // some shutdown hooks are always added (see UpdatableTomEEMojo)
final CountDownLatch stopCondition;
if (getWaitTomEE()) {
stopCondition = new CountDownLatch(1);
Runtime.getRuntime().addShutdownHook(new Thread() {
@Override
public void run() {
try {
server.stop();
} catch (Exception e) {
// no-op
}
try {
server.getServer().waitFor();
getLog().info("TomEE stopped");
stopCondition.countDown();
} catch (Exception e) {
getLog().error("Can't stop TomEE", e);
}
}
});
} else {
stopCondition = null;
strings.add("-Dtomee.noshutdownhook=true");
}
getLog().info("Running '" + getClass().getSimpleName().replace("TomEEMojo", "").toLowerCase(Locale.ENGLISH)
+ "'. Configured TomEE in plugin is " + tomeeHost + ":" + tomeeHttpPort
+ " (plugin shutdown port is " + tomeeShutdownPort + ")");
serverCmd(server, strings);
if (stopCondition != null) {
try {
stopCondition.await();
} catch (InterruptedException e) {
// no-op
}
}
}
protected void serverCmd(final RemoteServer server, final List<String> strings) {
server.start(strings, getCmd(), false);
}
protected void addShutdownHooks(final RemoteServer server) {
// no-op
}
protected int getConnectAttempts() {
return Integer.MAX_VALUE;
}
protected boolean getWaitTomEE() {
return true;
}
protected String cp() {
final boolean unix = !System.getProperty("os.name").toLowerCase().startsWith("win");
final char cpSep;
if (unix) {
cpSep = ':';
} else {
cpSep = ';';
}
return "bin/bootstrap.jar" + cpSep + "bin/tomcat-juli.jar";
}
private File resolve() {
if (!settings.isOffline()) {
try {
if ("snapshots".equals(apacheRepos) || "true".equals(apacheRepos)) {
remoteRepos.add(new DefaultArtifactRepository("apache", "https://repository.apache.org/content/repositories/snapshots/",
new DefaultRepositoryLayout(),
new ArtifactRepositoryPolicy(true, UPDATE_POLICY_DAILY, CHECKSUM_POLICY_WARN),
new ArtifactRepositoryPolicy(false, UPDATE_POLICY_NEVER, CHECKSUM_POLICY_WARN)));
} else {
try {
new URI(apacheRepos); // to check it is a uri
remoteRepos.add(new DefaultArtifactRepository("additional-repo-tomee-mvn-plugin", apacheRepos,
new DefaultRepositoryLayout(),
new ArtifactRepositoryPolicy(true, UPDATE_POLICY_DAILY, CHECKSUM_POLICY_WARN),
new ArtifactRepositoryPolicy(true, UPDATE_POLICY_NEVER, CHECKSUM_POLICY_WARN)));
} catch (URISyntaxException e) {
// ignored, use classical repos
}
}
} catch (UnsupportedOperationException uoe) {
// can happen if remoterepos is unmodifiable (possible in complex builds)
// no-op
}
} else if (remoteRepos != null && remoteRepos.isEmpty()) {
remoteRepos = new ArrayList<ArtifactRepository>();
}
try {
final Artifact artifact = factory.createDependencyArtifact(tomeeGroupId, tomeeArtifactId, createFromVersion(tomeeVersion), tomeeType, tomeeClassifier, SCOPE_COMPILE);
resolver.resolve(artifact, remoteRepos, local);
return artifact.getFile();
} catch (Exception e) {
getLog().error(e.getMessage(), e);
throw new TomEEException(e.getMessage(), e);
}
}
private void unzip(File mvnTomEE, File catalinaBase) {
ZipFile in = null;
try {
in = new ZipFile(mvnTomEE);
final Enumeration<? extends ZipEntry> entries = in.entries();
while (entries.hasMoreElements()) {
final ZipEntry entry = entries.nextElement();
String name = entry.getName();
if (name.startsWith("apache-tomee-")) {
int idx = name.indexOf("/");
if (idx < 0) {
idx = name.indexOf(File.separator);
}
if (idx < 0) {
continue;
}
name = name.substring(idx + 1);
}
final File dest = new File(catalinaBase.getAbsolutePath(), name);
if (!dest.exists()) {
final File parent = dest.getParentFile();
parent.mkdirs();
parent.setWritable(true);
parent.setReadable(true);
}
if (entry.isDirectory()) {
dest.mkdir();
} else {
final FileOutputStream fos = new FileOutputStream(dest);
try {
copy(in.getInputStream(entry), fos);
} catch (IOException e) {
// ignored
}
close(fos);
dest.setReadable(true);
if (dest.getName().endsWith(".sh")) {
dest.setExecutable(true);
}
}
}
final FileWriter writer = new FileWriter(new File(catalinaBase, "conf/tomee.xml"));
writer.write("<?xml version=\"1.0\"?>\n" +
"<tomee>\n" +
" <Deployments dir=\"apps\" />\n" +
"</tomee>\n");
writer.close();
new File(catalinaBase, "apps").mkdirs();
getLog().info("TomEE was unzipped in '" + catalinaBase.getAbsolutePath() + "'");
} catch (Exception e) {
throw new TomEEException(e.getMessage(), e);
} finally {
if (in != null) {
try {
in.close();
} catch (IOException e) {
// no-op
}
}
}
}
public abstract String getCmd();
}