com.kamomileware.maven.plugin.opencms.util.OpenCmsShellStarter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencms-cli-maven-plugin Show documentation
Allows operative execution via OpenCmsCommand interface.
The newest version!
package com.kamomileware.maven.plugin.opencms.util;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.codehaus.classworlds.ClassRealm;
import org.codehaus.classworlds.ClassWorld;
import org.codehaus.classworlds.DuplicateRealmException;
import org.codehaus.classworlds.NoSuchRealmException;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.net.MalformedURLException;

/**
 * Convenience class for executing scripts in a OpenCms instance
 * @author jagarcia
 */
public class OpenCmsShellStarter {
	private static final String DIR_LIB = "lib";
	private static final String REALM_CHILD_OC_NAME = "servletLib_and_OpenCms";
  private static final String REALM_PLUGIN_NAME = "opencms.cli.maven.plugin";
	private static final String METHOD_START = "start";

	private static final Class[] start_parameters = new Class[] { FileInputStream.class };
	private static final ClassWorld world = new ClassWorld();

	private static Log log;

	/**
   * @param openCmsWebDir opencms web application directory
   * @param appServerBaseDir application server base directory (${catalina.home})
   * @param openCmsServeltMapping mapping for the opencms servlet
   * @param openCmsWebappName opencms webapp name
   * @param log logger to output the process log
   * @param installScript script to execute in the shell
   * @throws MojoExecutionException error in execution or configuration
	 */
	public static void executeOpenCmsScript(File openCmsWebDir, File appServerBaseDir, String openCmsServeltMapping,
			String openCmsWebappName, Log log, File installScript) throws MojoExecutionException {
		// recoge la definición de la clase shell de OpenCms
    Class cmsShellClazz = getOpenCmsClass(openCmsWebDir, appServerBaseDir, "org.opencms.main.CmsShell");
    Class cmsShellCommand = getOpenCmsClass(openCmsWebDir, appServerBaseDir, "org.opencms.main.I_CmsShellCommands");
        FileInputStream fileInputStream=null;
        try {
      Constructor cmsShellContructor = cmsShellClazz.getConstructor(String.class, String.class, String.class, String.class, cmsShellCommand);
            Object shell = cmsShellContructor.newInstance(openCmsWebDir.toString(), openCmsServeltMapping, openCmsWebappName, "opencms/> ", null);
            Method startShell = cmsShellClazz.getDeclaredMethod(METHOD_START, start_parameters);
            fileInputStream = new FileInputStream(installScript);
            startShell.invoke(shell, fileInputStream);
		} catch (Exception e) {
			// errores en la reflexión -- problema de versiones
			throw new MojoExecutionException("Error durante la invocación del script OpenCms", e);
		} finally {
            if(fileInputStream!=null) {
                try {
                    fileInputStream.close();
                } catch (IOException e) {
                    log.warn(e);
                }
            }
        }
    }

	/**
   * @param openCmsWebDir    directorio base de OpenCms
   * @param appServerBaseDir directorio padre de la biblioteca de del servidor de aplicaciones
   * @param className the name to look for
	 * @return la definición de la clase buscada
	 * @throws MojoExecutionException
	 */
  static protected Class getOpenCmsClass(File openCmsWebDir, File appServerBaseDir, String className) throws MojoExecutionException {
		// create the classes realms for OpenCms
		getOrCreateClassRealm(REALM_PLUGIN_NAME);
		ClassRealm ocRealm = getOrCreateClassRealm(REALM_CHILD_OC_NAME, REALM_PLUGIN_NAME);
		try {
			// make the child realm the ContextClassLoader
			Thread.currentThread().setContextClassLoader(ocRealm.getClassLoader());
			// create shell class definition from the realm
      return ocRealm.loadClass(className);
		} catch (ClassNotFoundException e) {
			File appServerLibDir = new File(appServerBaseDir, DIR_LIB);
			if (!appServerLibDir.exists())
				throw new MojoExecutionException("Server library dir does not exist! Check appServerBaseDir property: " + appServerBaseDir);

			File opencmsLibDir = new File(openCmsWebDir, DIR_LIB);
			if (!opencmsLibDir.exists())
				throw new MojoExecutionException("OpenCms library dir does not exist! Check openCmsBaseDir property " + openCmsWebDir);

			// add all the jars we just downloaded to the new child realm
			if(log!=null){
				log.info("Cargando bibliotecas de servidor desde " + appServerLibDir);
			}
			loadJarInClassRealm(ocRealm, appServerLibDir);

			if(log!=null){
				log.info("Cargando bibliotecas de OpenCms desde " + opencmsLibDir);
			}
			loadJarInClassRealm(ocRealm, opencmsLibDir);

			try {
        return ocRealm.loadClass(className);
			} catch (ClassNotFoundException e1) {
				throw new MojoExecutionException("No se encuentra la clase \"org.opencms.main.CmsShell\"", e1);
			}
		}
	}

	private static void loadJarInClassRealm(ClassRealm ocRealm, File appServerLibDir) {
		for (File jar : appServerLibDir.listFiles()) {
			try {
				ocRealm.addConstituent(jar.toURI().toURL());
			} catch (MalformedURLException e) { // nunca ocurre
			}
		}
	}

	private static ClassRealm getOrCreateClassRealm(String classLoaderName) throws MojoExecutionException {
		return getOrCreateClassRealm(classLoaderName, null);
	}

	private static ClassRealm getOrCreateClassRealm(String classRealmName, String parentClassRealmName) throws MojoExecutionException {
		try {
			// lookup
			if (existsRealm(classRealmName)) {
				return world.getRealm(classRealmName);
			}
			// creation
			if (existsRealm(parentClassRealmName)) {
				return world.getRealm(parentClassRealmName).createChildRealm(classRealmName);
			} else {
				return world.newRealm(classRealmName, Thread.currentThread().getContextClassLoader());
			}
		} catch (NoSuchRealmException e) {
			throw new MojoExecutionException("Error inicializando los Classloaders ", e);
		} catch (DuplicateRealmException e1) {
			throw new MojoExecutionException("Error inicializando los Classloaders ", e1);
		}
	}

	@SuppressWarnings("unchecked")
	private static ClassRealm findRealm(String realmName) {
		for (ClassRealm realm : ((Iterable) (world.getRealms()))) {
			if (realm.getId().equals(realmName)) {
				return realm;
			}
		}
		return null;
	}

	private static boolean existsRealm(String realmName) {
		return realmName != null && findRealm(realmName) != null;
	}

	public static void setLog(Log log) {
		OpenCmsShellStarter.log = log;
	}
}