Changeset 6595

Timestamp:

Nov 14, 2014, 11:22:40 AM (8 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1889: Allow extensions to be installed in disabled state

Location:

trunk

Files:

• doc/src/docbook/developer/extensions.xml (modified) (1 diff)
• src/core/net/sf/basedb/util/extensions/manager/processor/RegisterExtensionsProcessor.java (modified) (5 diffs)

trunk/doc/src/docbook/developer/extensions.xml

@@ -335 +335 @@
           new values in the extension's <sgmltag class="starttag">about</sgmltag>
           tag.
+        </para>
+      </tip>
+      
+      <tip>
+        <title>Start out in disabled state</title>
+        
+        <para>
+          The <sgmltag class="starttag">about</sgmltag> tag can be used to specify
+          that an extension should start out in disabled state. This can be useful
+          if there are multiple variants of an extension or if some extensions
+          are considered "advanced mode" and only should be enabled after some
+          serious thinking. To use this feature, simply set <code>&lt;about disabled="1"&gt;</code>
+          in the XML file.
         </para>
       </tip>

trunk/src/core/net/sf/basedb/util/extensions/manager/processor/RegisterExtensionsProcessor.java

@@ -28 +28 @@
 import java.util.List;
 
+import net.sf.basedb.core.plugin.About;
 import net.sf.basedb.util.FileUtil;
+import net.sf.basedb.util.Values;
+import net.sf.basedb.util.extensions.ExtendedAbout;
 import net.sf.basedb.util.extensions.Extension;
 import net.sf.basedb.util.extensions.ExtensionPoint;
@@ -40 +43 @@
 import net.sf.basedb.util.extensions.manager.ProcessResults;
 import net.sf.basedb.util.extensions.manager.ExtensionsFile.WriteableExtensionsFile;
+import net.sf.basedb.util.extensions.manager.Settings;
 import net.sf.basedb.util.extensions.manager.filter.ValidAndNewOrModifiedFilter;
 import net.sf.basedb.util.extensions.xml.XmlLoader;
@@ -339 +343 @@
       {
         wFile.open();
-        int num = registerExtensions(data, registry, forceUpdate || xtFile.wasModified());
+        int num = registerExtensions(data, manager, forceUpdate || xtFile.wasModified());
         if (num > 0 && results != null)
         {
@@ -444 +448 @@
   }
   
-  private int registerExtensions(FileData data, Registry registry, boolean forceUpdate)
+  private int registerExtensions(FileData data, ExtensionsManager manager, boolean forceUpdateOrModified)
     throws IOException
   {
     int numRegistered = 0;
+    Registry registry = manager.getRegistry();
+    Settings settings = manager.getSettings();
     for (Extension<?> ext : data.extensions)
     {
-      if (forceUpdate || !registry.extensionIsRegistered(ext.getId()))
+      boolean isNew = !registry.extensionIsRegistered(ext.getId());
+      if (forceUpdateOrModified || isNew)
       {
         log.debug("Registering extension: " + ext);
@@ -459 +466 @@
         registry.registerExtension(ext, data.writeableFile.getExtensionsFile().getClassLoader());
         numRegistered++;
+        // Check disabled="*" attribute for new extensions
+        // isNew==true also at server startup, so we must also check 'forceUpdate'
+        // since it is set when installing (forceUpdateOrModified is also set for modified files)
+        if (isNew && forceUpdate)
+        {
+          // Check if disabled="1" is set in <about>
+          About about = ext.getAbout();
+          if (about instanceof ExtendedAbout)
+          {
+            boolean disable = Values.getBoolean(((ExtendedAbout)ext.getAbout()).getAttribute("disabled"));
+            settings.enableExtension(ext.getId(), !disable);
+          }
+        }
       }
     }