Commit 7e077b51 authored by Derek DeMoro's avatar Derek DeMoro Committed by derek

"JM-431" Child plugins can now run in development mode.

git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/branches@2956 b35dd754-fafc-0310-a699-88a17e54d16e
parent 10696f02
...@@ -21,6 +21,7 @@ import java.net.URLClassLoader; ...@@ -21,6 +21,7 @@ import java.net.URLClassLoader;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Iterator; import java.util.Iterator;
import java.util.List; import java.util.List;
import java.util.Collection;
/** /**
* ClassLoader for plugins. It searches the plugin directory for classes * ClassLoader for plugins. It searches the plugin directory for classes
...@@ -81,6 +82,10 @@ class PluginClassLoader { ...@@ -81,6 +82,10 @@ class PluginClassLoader {
} }
} }
public Collection<URL> getURLS(){
return list;
}
/** /**
* Adds a URL to the class loader. The {@link #initialize()} method should be called * Adds a URL to the class loader. The {@link #initialize()} method should be called
* after adding the URL to make the change take effect. * after adding the URL to make the change take effect.
......
...@@ -187,6 +187,7 @@ public class PluginManager { ...@@ -187,6 +187,7 @@ public class PluginManager {
if (plugins.containsKey(parentPlugin)) { if (plugins.containsKey(parentPlugin)) {
pluginLoader = classloaders.get(getPlugin(parentPlugin)); pluginLoader = classloaders.get(getPlugin(parentPlugin));
pluginLoader.addDirectory(pluginDir); pluginLoader.addDirectory(pluginDir);
} }
else { else {
// See if the parent plugin exists but just hasn't been loaded yet. // See if the parent plugin exists but just hasn't been loaded yet.
...@@ -270,6 +271,15 @@ public class PluginManager { ...@@ -270,6 +271,15 @@ public class PluginManager {
String className = pluginXML.selectSingleNode("/plugin/class").getText(); String className = pluginXML.selectSingleNode("/plugin/class").getText();
plugin = (Plugin)pluginLoader.loadClass(className).newInstance(); plugin = (Plugin)pluginLoader.loadClass(className).newInstance();
if(parentPluginNode != null){
String parentPlugin = parentPluginNode.getTextTrim();
// See if the parent is already loaded.
if (plugins.containsKey(parentPlugin)) {
pluginLoader = classloaders.get(getPlugin(parentPlugin));
classloaders.put(plugin, pluginLoader);
}
}
plugin.initializePlugin(this, pluginDir); plugin.initializePlugin(this, pluginDir);
plugins.put(pluginDir.getName(), plugin); plugins.put(pluginDir.getName(), plugin);
pluginDirs.put(plugin, pluginDir); pluginDirs.put(plugin, pluginDir);
...@@ -312,25 +322,30 @@ public class PluginManager { ...@@ -312,25 +322,30 @@ public class PluginManager {
// If there a <adminconsole> section defined, register it. // If there a <adminconsole> section defined, register it.
Element adminElement = (Element)pluginXML.selectSingleNode("/plugin/adminconsole"); Element adminElement = (Element)pluginXML.selectSingleNode("/plugin/adminconsole");
if (adminElement != null) { if (adminElement != null) {
String pluginName = pluginDir.getName();
if(parentPluginNode != null){
pluginName = parentPluginNode.getTextTrim();
}
// If global images are specified, override their URL. // If global images are specified, override their URL.
Element imageEl = (Element)adminElement.selectSingleNode( Element imageEl = (Element)adminElement.selectSingleNode(
"/plugin/adminconsole/global/logo-image"); "/plugin/adminconsole/global/logo-image");
if (imageEl != null) { if (imageEl != null) {
imageEl.setText("plugins/" + pluginDir.getName() + "/" + imageEl.getText()); imageEl.setText("plugins/" + pluginName + "/" + imageEl.getText());
} }
imageEl = (Element)adminElement.selectSingleNode( imageEl = (Element)adminElement.selectSingleNode("/plugin/adminconsole/global/login-image");
"/plugin/adminconsole/global/login-image");
if (imageEl != null) { if (imageEl != null) {
imageEl.setText("plugins/" + pluginDir.getName() + "/" + imageEl.getText()); imageEl.setText("plugins/" + pluginName + "/" + imageEl.getText());
} }
// Modify all the URL's in the XML so that they are passed through // Modify all the URL's in the XML so that they are passed through
// the plugin servlet correctly. // the plugin servlet correctly.
List urls = adminElement.selectNodes("//@url"); List urls = adminElement.selectNodes("//@url");
for (int i = 0; i < urls.size(); i++) { for (int i = 0; i < urls.size(); i++) {
Attribute attr = (Attribute)urls.get(i); Attribute attr = (Attribute)urls.get(i);
attr.setValue("plugins/" + pluginDir.getName() + "/" + attr.getValue()); attr.setValue("plugins/" + pluginName + "/" + attr.getValue());
} }
AdminConsole.addModel(pluginDir.getName(), adminElement); AdminConsole.addModel(pluginName, adminElement);
} }
} }
else { else {
...@@ -481,6 +496,15 @@ public class PluginManager { ...@@ -481,6 +496,15 @@ public class PluginManager {
return getElementValue(plugin, "/plugin/version"); return getElementValue(plugin, "/plugin/version");
} }
/**
* Returns the classloader of a plugin.
* @param plugin the plugin.
* @return the classloader of the plugin.
*/
public PluginClassLoader getPluginClassloader(Plugin plugin){
return classloaders.get(plugin);
}
/** /**
* Returns the value of an element selected via an xpath expression from * Returns the value of an element selected via an xpath expression from
* a Plugin's plugin.xml file. * a Plugin's plugin.xml file.
......
...@@ -27,7 +27,14 @@ import javax.servlet.ServletOutputStream; ...@@ -27,7 +27,14 @@ import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Collection;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
...@@ -38,12 +45,12 @@ import java.util.concurrent.ConcurrentHashMap; ...@@ -38,12 +45,12 @@ import java.util.concurrent.ConcurrentHashMap;
* to plugins. Since plugins can be dynamically loaded and live in a different place * to plugins. Since plugins can be dynamically loaded and live in a different place
* than normal Jive Messenger admin console files, it's not possible to have them * than normal Jive Messenger admin console files, it's not possible to have them
* added to the normal Jive Messenger admin console web app directory.<p> * added to the normal Jive Messenger admin console web app directory.<p>
* * <p/>
* The servlet listens for requests in the form <tt>/plugins/[pluginName]/[JSP File]</tt> * The servlet listens for requests in the form <tt>/plugins/[pluginName]/[JSP File]</tt>
* (e.g. <tt>/plugins/foo/example.jsp</tt>). It also listens for image requests in the * (e.g. <tt>/plugins/foo/example.jsp</tt>). It also listens for image requests in the
* the form <tt>/plugins/[pluginName]/images/*.png|gif</tt> (e.g. * the form <tt>/plugins/[pluginName]/images/*.png|gif</tt> (e.g.
* <tt>/plugins/foo/images/example.gif</tt>).<p> * <tt>/plugins/foo/images/example.gif</tt>).<p>
* * <p/>
* JSP files must be compiled and available via the plugin's class loader. The mapping * JSP files must be compiled and available via the plugin's class loader. The mapping
* between JSP name and servlet class files is defined in [pluginName]/web/web.xml. * between JSP name and servlet class files is defined in [pluginName]/web/web.xml.
* Typically, this file is auto-generated by the JSP compiler when packaging the plugin. * Typically, this file is auto-generated by the JSP compiler when packaging the plugin.
...@@ -68,8 +75,7 @@ public class PluginServlet extends HttpServlet { ...@@ -68,8 +75,7 @@ public class PluginServlet extends HttpServlet {
} }
public void service(HttpServletRequest request, HttpServletResponse response) public void service(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException throws ServletException, IOException {
{
String pathInfo = request.getPathInfo(); String pathInfo = request.getPathInfo();
if (pathInfo == null) { if (pathInfo == null) {
response.setStatus(HttpServletResponse.SC_NOT_FOUND); response.setStatus(HttpServletResponse.SC_NOT_FOUND);
...@@ -214,14 +220,13 @@ public class PluginServlet extends HttpServlet { ...@@ -214,14 +220,13 @@ public class PluginServlet extends HttpServlet {
* servlet is found, a 404 error is returned. * servlet is found, a 404 error is returned.
* *
* @param pathInfo the extra path info. * @param pathInfo the extra path info.
* @param request the request object. * @param request the request object.
* @param response the response object. * @param response the response object.
* @throws ServletException if a servlet exception occurs while handling the request. * @throws ServletException if a servlet exception occurs while handling the request.
* @throws IOException if an IOException occurs while handling the request. * @throws IOException if an IOException occurs while handling the request.
*/ */
private void handleJSP(String pathInfo, HttpServletRequest request, private void handleJSP(String pathInfo, HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException HttpServletResponse response) throws ServletException, IOException {
{
// Strip the starting "/" from the path to find the JSP URL. // Strip the starting "/" from the path to find the JSP URL.
String jspURL = pathInfo.substring(1); String jspURL = pathInfo.substring(1);
...@@ -360,8 +365,7 @@ public class PluginServlet extends HttpServlet { ...@@ -360,8 +365,7 @@ public class PluginServlet extends HttpServlet {
* @return true if this page request was handled; false if the request was not handled. * @return true if this page request was handled; false if the request was not handled.
*/ */
private boolean handleDevJSP(String pathInfo, HttpServletRequest request, private boolean handleDevJSP(String pathInfo, HttpServletRequest request,
HttpServletResponse response) HttpServletResponse response) {
{
String jspURL = pathInfo.substring(1); String jspURL = pathInfo.substring(1);
// Handle pre-existing pages and fail over to pre-compiled pages. // Handle pre-existing pages and fail over to pre-compiled pages.
...@@ -446,29 +450,40 @@ public class PluginServlet extends HttpServlet { ...@@ -446,29 +450,40 @@ public class PluginServlet extends HttpServlet {
* @return the classpath needed to compile a single jsp in a plugin. * @return the classpath needed to compile a single jsp in a plugin.
*/ */
private static String getClasspathForPlugin(Plugin plugin) { private static String getClasspathForPlugin(Plugin plugin) {
StringBuilder builder = new StringBuilder(); final StringBuilder classpath = new StringBuilder();
File pluginDirectory = pluginManager.getPluginDirectory(plugin); File pluginDirectory = pluginManager.getPluginDirectory(plugin);
PluginDevEnvironment env = pluginManager.getDevEnvironment(plugin); PluginDevEnvironment pluginEnv = pluginManager.getDevEnvironment(plugin);
PluginClassLoader pluginClassloader = pluginManager.getPluginClassloader(plugin);
Collection col = pluginClassloader.getURLS();
for (Object aCol : col) {
URL url = (URL)aCol;
File file = new File(url.getFile());
classpath.append(file.getAbsolutePath().toString()).append(";");
}
// Load all jars from lib // Load all jars from lib
File libDirectory = new File(pluginDirectory, "lib"); File libDirectory = new File(pluginDirectory, "lib");
File[] libs = libDirectory.listFiles(); File[] libs = libDirectory.listFiles();
for (int i = 0; i < libs.length; i++) { final int no = libs != null ? libs.length : 0;
for (int i = 0; i < no; i++) {
File libFile = libs[i]; File libFile = libs[i];
builder.append(libFile.getAbsolutePath() + ';'); classpath.append(libFile.getAbsolutePath()).append(';');
} }
File messengerRoot = pluginDirectory.getParentFile().getParentFile().getParentFile(); File messengerRoot = pluginDirectory.getParentFile().getParentFile().getParentFile();
File messengerLib = new File(messengerRoot, "target//lib"); File messengerLib = new File(messengerRoot, "target//lib");
builder.append(messengerLib.getAbsolutePath() + "//servlet.jar;"); classpath.append(messengerLib.getAbsolutePath()).append("//servlet.jar;");
builder.append(messengerLib.getAbsolutePath() + "//messenger.jar;"); classpath.append(messengerLib.getAbsolutePath()).append("//messenger.jar;");
builder.append(messengerLib.getAbsolutePath() + "//jasper-compiler.jar;"); classpath.append(messengerLib.getAbsolutePath()).append("//jasper-compiler.jar;");
builder.append(messengerLib.getAbsolutePath() + "//jasper-runtime.jar;"); classpath.append(messengerLib.getAbsolutePath()).append("//jasper-runtime.jar;");
builder.append(env.getClassesDir().getAbsolutePath() + ";"); classpath.append(pluginEnv.getClassesDir().getAbsolutePath()).append(";");
return builder.toString(); return classpath.toString();
} }
} }
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment