Changeset 4113

Timestamp:

Jan 31, 2008, 11:21:59 AM (15 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #913: Plug-in JAR paths should support paths relative to the plugins.dir setting in base.config

Location:

trunk/src/core/net/sf/basedb/core

Files:

• DataFileType.java (modified) (6 diffs)
• Install.java (modified) (1 diff)
• JobAgentSettings.java (modified) (1 diff)
• PluginDefinition.java (modified) (5 diffs)
• Update.java (modified) (3 diffs)

trunk/src/core/net/sf/basedb/core/DataFileType.java

@@ -519 +519 @@
   public String getValidatorJarPath()
   {
-    return getData().getValidatorJarPath();
+    return PluginDefinition.convertToAbsolute(getData().getValidatorJarPath());
   }
   
@@ -533 +533 @@
   {
     checkPermission(Permission.WRITE);
+    validatorJarPath = PluginDefinition.convertToRelative(validatorJarPath);
     getData().setValidatorJarPath(StringUtil.setNullableString(validatorJarPath, 
       "validatorJarPath", MAX_JARPATH_LENGTH));
@@ -546 +547 @@
   public DataFileValidator getValidator()
   {
-    String validatorClass = getData().getValidatorClass();
+    String validatorClass = getValidatorClass();
     if (validatorClass == null) return null;
     DataFileValidator validator = null;
@@ -596 +597 @@
   public String getMetadataReaderJarPath()
   {
-    return getData().getMetadataReaderJarPath();
+    return PluginDefinition.convertToAbsolute(getData().getMetadataReaderJarPath());
   }
   
@@ -610 +611 @@
   {
     checkPermission(Permission.WRITE);
+    metadataReaderJarPath = PluginDefinition.convertToRelative(metadataReaderJarPath);
     getData().setMetadataReaderJarPath(StringUtil.setNullableString(metadataReaderJarPath, 
       "metadataReaderJarPath", MAX_JARPATH_LENGTH));
@@ -622 +624 @@
   public DataFileMetadataReader getMetadataReader()
   {
-    String readerClass = getData().getMetadataReaderClass();
+    String readerClass = getMetadataReaderClass();
     if (readerClass == null) return null;
     DataFileMetadataReader reader = null;
     try
     {
-      String jarPath = getValidatorJarPath();
+      String jarPath = getMetadataReaderJarPath();
       ClassLoader loader = jarPath == null ? null : JarClassLoader.getInstance(jarPath);
       reader = (DataFileMetadataReader)ClassUtil.checkAndLoadClass(

trunk/src/core/net/sf/basedb/core/Install.java

@@ -107 +107 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(50).intValue();
+  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(51).intValue();
   
   public static synchronized void createTables(boolean update, final ProgressReporter progress)

trunk/src/core/net/sf/basedb/core/JobAgentSettings.java

@@ -222 +222 @@
     if (jarPath == null)
     {
-      jarPath = data.getPluginDefinition().getJarPath();
+      jarPath = PluginDefinition.convertToAbsolute(data.getPluginDefinition().getJarPath());
     }
     return jarPath;

trunk/src/core/net/sf/basedb/core/PluginDefinition.java

@@ -122 +122 @@
   public static final int MAX_URL_LENGTH = PluginDefinitionData.MAX_URL_LENGTH;
 
+  /**
+    Convert a plug-in path to a path relative to the <code>plugins.dir</code>
+    setting in <code>base.config</code>. If no plug-in directory has been
+    specified or if the path is null nothing is done. If the given path is 
+    a subpath to the <code>plugins.dir</code> path the common path is replaced
+    with <code>%plugins.dir%</code> For example:
+    <pre class="code>"
+path          = /usr/local/base/plugins/myplugin.jar
+plugins.dir   = /usr/local/base/plugins
+relative path = %plugins.dir%/myplugin.jar
+</pre>
+
+    @param path The absolute path
+    @return The relative path
+    @since 2.6
+    @see #convertToAbsolute(String)
+  */
+  public static String convertToRelative(String path)
+  {
+    if (path == null) return null;
+    String pluginsDir = Config.getString("plugins.dir");
+    if (pluginsDir == null) return path;
+    if (path.startsWith(pluginsDir))
+    {
+      path = "%plugins.dir%" + path.substring(pluginsDir.length());
+    }
+    return path;
+  }
+  
+  /**
+    Convert a relative plug-in path to an absolute path. This is the
+    reverse of the {@link #convertToRelative(String)} method.
+  
+    @param path The relative path
+    @return The absolute path
+    @since 2.6
+  */
+  public static String convertToAbsolute(String path)
+  {
+    if (path == null) return path;
+    String pluginsDir = Config.getString("plugins.dir");
+    if (pluginsDir == null) return path;
+    if (path.startsWith("%plugins.dir%"))
+    {
+      path = pluginsDir + path.substring("%plugins.dir%".length());
+    }
+    return path;
+  }
+  
   /**
     Create a new <code>PluginDefinition</code> item.
@@ -551 +600 @@
   public String getJarPath()
   {
-    return getData().getJarPath();
+    return convertToAbsolute(getData().getJarPath());
   }
   /**
@@ -559 +608 @@
     throws InvalidDataException
   {
-    getData().setJarPath(StringUtil.setNullableString(jarPath, "jarPath", MAX_JARPATH_LENGTH));
+    getData().setJarPath(StringUtil.setNullableString(convertToRelative(jarPath), 
+        "jarPath", MAX_JARPATH_LENGTH));
   }
   
@@ -1058 +1108 @@
   {
     checkPermission(Permission.USE);
-    return newInstance(getData().getJarPath(), getData().getClassName(), false);
+    return newInstance(getJarPath(), getClassName(), false);
   }
 
@@ -1065 +1115 @@
   {
     checkPermission(Permission.USE);
-    return newInstance(jarPath == null ? getData().getJarPath() : jarPath, getData().getClassName(), false);
+    return newInstance(jarPath == null ? getJarPath() : jarPath, getClassName(), false);
   }
   

trunk/src/core/net/sf/basedb/core/Update.java

@@ -584 +584 @@
     </td>
   </tr>
+  <tr>
+    <td>51</td>
+    <td>
+      External plug-in paths should be relative to the plugins.dir setting
+      in base.config. The update loads all PluginDefinitions with a JAR path
+      and convert the path with {@link PluginDefinition#convertToRelative(String)}.
+    </td>
+  </tr>
   
   </table>
@@ -828 +836 @@
         if (progress != null) progress.display((int)(49*progress_factor), "Updating schema version: " + schemaVersion + " -> 50...");
         schemaVersion = setSchemaVersionInTransaction(session, 50);
+      }
+      
+      if (schemaVersion < 51)
+      {
+        if (progress != null) progress.display((int)(50*progress_factor), "--Updating schema version: " + schemaVersion + " -> 51...");
+        schemaVersion = updateToSchemaVersion51(session);
       }
       
@@ -2072 +2086 @@
     return schemaVersion;
   } 
+  
+  /**
+    Change all plug-ins with an absolute JAR path to relative 
+    paths.
+    
+    @return The new schema version (=51)
+  */
+  private static int updateToSchemaVersion51(org.hibernate.Session session)
+    throws BaseException
+  {
+    final int schemaVersion = 51;
+    org.hibernate.Transaction tx = null;
+    try
+    {
+      tx = HibernateUtil.newTransaction(session);
+      
+      // Change property values
+      org.hibernate.Query query = HibernateUtil.createQuery(session, 
+        "SELECT pd FROM PluginDefinitionData pd WHERE NOT pd.jarPath IS NULL");
+      List<PluginDefinitionData> plugins = 
+        HibernateUtil.loadList(PluginDefinitionData.class, query, null);
+      
+      for (PluginDefinitionData pd : plugins)
+      {
+        pd.setJarPath(PluginDefinition.convertToRelative(pd.getJarPath()));
+      }
+      
+      // Update the schema version number
+      setSchemaVersion(session, schemaVersion);
+  
+      // Commit the changes
+      HibernateUtil.commit(tx);
+      log.info("updateToSchemaVersion51: OK");
+    }
+    catch (BaseException ex)
+    {
+      if (tx != null) HibernateUtil.rollback(tx); 
+      log.error("updateToSchemaVersion51: FAILED", ex);
+      throw ex;
+    }
+    return schemaVersion;
+  }
   
   /**