Changeset 3733

Timestamp:

Sep 14, 2007, 2:08:01 PM (15 years ago)

Author:

Martin Svensson

Message:

References #364 The functionallity is more or less done. The internal class in PluginInfo? to read jars
needs to be refactored and moved to class JarClassLoader?, also some testing and documentation before this
can be closed.

Location:

trunk

Files:

• src/core/net/sf/basedb/util/PluginConfigInfo.java (modified) (1 diff)
• src/core/net/sf/basedb/util/PluginInfo.java (modified) (6 diffs)
• www/admin/plugindefinitions/auto_install.jsp (modified) (9 diffs)
• www/admin/plugindefinitions/index.jsp (modified) (7 diffs)

trunk/src/core/net/sf/basedb/util/PluginConfigInfo.java

@@ -57 +57 @@
   private String description;
   
+  /**
+    Constructor to create a new instance with information for a plugin configuration.
+      @param pluginClassName The class name of PluginDefinition this configuration belongs to, 
+        see{@link net.sf.basedb.core.PluginConfiguration#getPluginDefinition()}
+      @param configName Name of the plugin configuration, 
+        see{@link net.sf.basedb.core.PluginConfiguration#getName()}
+      @param descr Description about the configuration 
+        see {@link net.sf.basedb.core.PluginConfiguration#getDescription()}
+   */
   public PluginConfigInfo(String pluginClassName, String configName, String descr)
   {

trunk/src/core/net/sf/basedb/util/PluginInfo.java

@@ -81 +81 @@
     about each plugin class in the jar file.
    */
-  private static final String xmlFile = "base-plugins.xml";
-  
-  
+  private static final String xmlFile = "META-INF/base-plugins.xml";
+  
+  /**
+    The path in a jar-file to the file that holds 
+    configurations to import
+   */
+  private static final String configurationImportFile = "META-INF/base-configurations.xml";
   
   /**
@@ -91 +95 @@
       @param minBaseVersion BASE version that the plugin at least requires
       @param about Information about the plugin.
-      @param configurations A list with configurations for this plugin.
+      @param configs A list with configurations for this plugin.
    */
   public PluginInfo (String jarPath, String className, String minBaseVersion, About about, List<PluginConfigInfo> configs)
@@ -108 +112 @@
     {@link net.sf.basedb.core.plugin.Plugin} will not be included in the list but already 
     installed plugins will.
-    @param jarPath The jar file to load the plugin info from. 
-    @returns List with PluginInfo about the plugins that were found in jar file.
+    @param jarFile The jar file to load the plugin info from. 
+    @return List with PluginInfo about the plugins that were found in jar file.
       @throws JDOMException If any error loading the XML-document
       @throws IOException If any error with file reading, eg when 
@@ -131 +135 @@
       //Get the info in base-plugins.xml file.
       //An exception is thrown if the jar file's name is not the same as the xml-file suggest.
-      is = jar.getInputStream(new JarEntry("META-INF/" + xmlFile));
+      is = jar.getInputStream(new JarEntry(xmlFile));
       URL installDtdURL = PluginInfo.class.getResource("/net/sf/basedb/core/dtd/" + dtdFile);
       Element rootElement = XMLUtil.getValidatedXML(is , installDtdURL, null).getRootElement();
@@ -196 +200 @@
     return pluginInfos;
   }
-  //TODO Methods to load new plugins, installed plugins and 
-  //plugins which class already exist but in another jar-file.
   
   /**
@@ -235 +237 @@
   }
   
+  /**
+    Gets information about the configurations that come together with the plugin in the jar.
+      @return A list with information about each plugin configuration.
+   */
   public List<PluginConfigInfo> getConfigurations()
   {
     return configs;
+  }
+  
+  /**
+    The path inside a jar to the xml-file that holds 
+    the pluginconfigurations that can be imported.
+      @return String format path.
+   */
+  public String getConfigurationsPath()
+  {
+    return configurationImportFile;
   }
   

trunk/www/admin/plugindefinitions/auto_install.jsp

@@ -40 +40 @@
   import="net.sf.basedb.core.query.Expressions"
   import="net.sf.basedb.util.FileUtil"
+  import="net.sf.basedb.util.JarClassLoader"
   import="net.sf.basedb.util.PluginInfo"
   import="net.sf.basedb.util.PluginConfigInfo"
@@ -65 +66 @@
   message.append("<b>").append("Class: ").append("</b>");
   message.append(HTML.encodeTags(info.getClassName())).append("<br>");
+  
+  message.append("<b>").append("Version: ").append("</b>");
+  message.append(HTML.encodeTags(info.getAbout().getVersion())).append("<br>");
   
   message.append("<b>").append("Works with: ").append("</b>");
@@ -148 +152 @@
           {
             
-            if (cnf[i].value == 'yes')
+            if (cnf[i].value == '1')
             {
               cnf.selectedIndex = i;
@@ -167 +171 @@
           {
             
-            if (cnf[i].value == 'no')
+            if (cnf[i].value == '0')
             {
               cnf.selectedIndex = i;
@@ -183 +187 @@
       var pluginList = document.getElementById('setplugin.' + pluginId);
       var pluginOption = pluginList[pluginList.selectedIndex].value;
-      if ( (configOption == 'yes' && !pluginExists && pluginOption == '') ||
-        (configOption == 'no' && pluginOption == 'plugin+confs') )
+      if ( (configOption == '1' && !pluginExists && pluginOption == '') ||
+        (configOption == '0' && pluginOption == 'plugin+confs') )
       {
         for (var i=0; i<pluginList.length;i++)
@@ -239 +243 @@
               boolean hasConfigs = cnfInfos != null && !cnfInfos.isEmpty();
               boolean classExists = true;
-              boolean jarExists = true;
+              boolean jarExists = false;
               PluginDefinition pd = null;
               try
@@ -308 +312 @@
                   <input type="hidden" name="<%=info.getClassName()%>.jarExists" value="<%=jarExists%>">
                   <base:icon image="<%=classExists&&!jarExists ? "itemexists.gif" : "" %>" 
-                    tooltip="Plugin from another jar-file but with the same class-name is installed"
+                    tooltip="The plugin is loaded from a different jar-file"
                   />
                   <base:icon image="<%=classExists&&jarExists ? "hasvalues.gif" : "" %>" 
@@ -370 +374 @@
                       <select id="setconfig.<%=plugin%>.<%=cnf%>" name="<%=info.getClassName()%>.<%=cnfInfo.getName()%>"
                         onChange="setPluginOnChange(<%=plugin%>, this, <%=classExists%>)">
-                        <option value="no" title="Configuration will not be imported">no</option>
-                        <option value="yes" title="Configuration will be imported">yes</option>
+                        <option value="0" title="Configuration will not be imported">no</option>
+                        <option value="1" title="Configuration will be imported">yes</option>
                       </select>
                       <base:icon image="<%=isDublicate ? "warning.gif" : ""%>" tooltip="Plugin already has a configuration with this name"/>
@@ -386 +390 @@
           &nbsp;<i><base:icon image="warning.gif" /> = dublicate configuration</i><br>
           &nbsp;<i><base:icon image="hasvalues.gif" /> = plugin already installed</i><br>
-          &nbsp;<i><base:icon image="itemexists.gif" /> = installed using a different jar-file</i><br>
+          &nbsp;<i><base:icon image="itemexists.gif" /> = exists in a different jar-file,<br> 
+            installing will change the jar path.</i><br>
         </div>
       </t:tab>

trunk/www/admin/plugindefinitions/index.jsp

@@ -49 +49 @@
   import="net.sf.basedb.util.FileUtil"
   import="net.sf.basedb.util.PluginInfo"
+  import="net.sf.basedb.util.PluginConfigInfo"
   import="net.sf.basedb.util.RemovableUtil"
   import="net.sf.basedb.util.ShareableUtil"
@@ -58 +59 @@
   import="net.sf.basedb.util.Values"
   import="net.sf.basedb.clients.web.util.HTML"
+  import="net.sf.basedb.plugins.PluginConfigurationImporter"
   import="java.util.Enumeration"
   import="java.util.Set"
+  import="java.util.HashMap"
   import="java.util.HashSet"
   import="java.util.List"
@@ -133 +136 @@
     ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, pageContext, defaultContext);
     cc.setId(0);
-    if (Application.getNonCorePluginDirectory() == null)
-    {
-      redirect = editPage;
-    }
-    else
+    
+    //Go directly to manually installation if plugin directory isn't specified in base.config, plugin directory doesn't exists or 
+    //  no jar files were found in that directory.
+    if (Application.getNonCorePluginDirectory() != null  &&  Application.getNonCorePluginDirectory().exists() &&
+        !FileUtil.findFiles(Application.getNonCorePluginDirectory(), null, "jar", true ).isEmpty())
     {
       String pluginPath = Application.getNonCorePluginDirectory().getPath();
       redirect = "select_installation_type.jsp?ID="+ID+"&plugin_path="+pluginPath;
     }
+    else
+    {
+      redirect = editPage;
+    }
   }
   else if("InstallationType".equals(cmd))
@@ -159 +166 @@
   else if("LoadPlugins".equals(cmd))
   {
-    //Loads plugins from jars that have been selected in auto_installer.jsp
+    //Loads and install plugins that have been selected in auto_installer.jsp
     ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, defaultContext);
     dc = sc.newDbControl();
@@ -165 +172 @@
     List<PluginInfo> pluginInfos = new ArrayList<PluginInfo>();
     List<java.io.File> jarFiles = FileUtil.findFiles(pluginDir, null, "jar", true);
+    StringBuilder notInstalledPlugins = new StringBuilder();
     
+    //Get information about all plugins in jar-files that were found.
     for (java.io.File file : jarFiles)
     {
       pluginInfos.addAll(PluginInfo.loadFromJar(file));
     }
+    //Load selected plugins.
     for (PluginInfo info : pluginInfos)
     {
       String selectedOption = request.getParameter(info.getJarPath() + "." + info.getClassName());
-      if (selectedOption == null) selectedOption = "";
-      StringBuilder installedPlugins = new StringBuilder();
-      StringBuilder notInstalledPlugins = new StringBuilder();
+      if (selectedOption == null) selectedOption = "";      
       boolean classExists = Values.getBoolean(request.getParameter(info.getClassName()+".classExists"));
+      boolean jarExists = Values.getBoolean(request.getParameter(info.getClassName()+".jarExists"));
       int usePermissions = Values.getInt(request.getParameter("use_permissions"));
-      if (selectedOption.equals("plugin") || selectedOption.equals("plugin+configurations"))
+      if (selectedOption.equals("plugin") || selectedOption.equals("plugin+confs"))
       {
+        //The plugin doesn't exists
         if (!classExists)
         {
@@ -189 +199 @@
           catch(BaseException bex)
           {
-            notInstalledPlugins.append("Could notinstall: " + 
+            notInstalledPlugins.append("Could not install: " + 
                 info.getClassName() + " in jar:" + info.getJarPath() + "\n");
           }
           if (pd != null)
           {
-            installedPlugins.append("Installed :" + pd.getClassName() + "\n");
             dc.saveItem(pd);
             pd.setTrusted(Values.getBoolean(request.getParameter("trusted")));
@@ -202 +211 @@
           }
         }
+        //The plugin exists but in a different jar, this will change the plugin's jarpath
+        else if (classExists && !jarExists)
+        {
+          try 
+          {
+            PluginDefinition pd = PluginDefinition.getByClassName(dc, info.getClassName());
+            pd.loadPluginInformation(info.getJarPath(), info.getClassName(), usePermissions == 2);
+          }
+          catch(BaseException bex)
+          {
+            notInstalledPlugins.append("Could not update the jarpath for plugin: " + info.getClassName());
+          }
+        }
+      }     
+    }
+    dc.commit();
+    
+    //Import selected configurations for each plugin in pluginInfos
+    dc = sc.newDbControl();
+    for (PluginInfo info : pluginInfos)
+    {
+      List<PluginConfigInfo> configInfos = info.getConfigurations();
+      if (configInfos != null && configInfos.size() > 0)
+      {
+        HashMap<Integer, Boolean> configurations = new HashMap<Integer, Boolean>();
+        int configurationNumber = 0;
+        for (PluginConfigInfo cnfInfo : configInfos)
+        {
+          Boolean toImport = Values.getBoolean(request.getParameter(info.getClassName() + "." + cnfInfo.getName()));
+          configurations.put(configurationNumber, toImport);
+          configurationNumber++;
+        }
+        try 
+        {
+          PluginConfigurationImporter configImporter = new PluginConfigurationImporter();
+          configImporter.init(sc, null, null);
+          configImporter.importPluginConfigurationsFromJar(info.getJarPath(), info.getConfigurationsPath(), configurations, false, true );
+        }
+        catch (Throwable th)
+        {
+          notInstalledPlugins.append("Could not import configurations: " + th.getMessage() + "\n");
+        }
       }
     }
-    dc.commit();
-    cc.removeObject("item");
+    message = notInstalledPlugins.length() > 0 ? 
+        notInstalledPlugins.toString() : "All selected plugins and configurations were installed";
   }
   else if ("UpdateItem".equals(cmd))