Changeset 3720

Timestamp:

Sep 12, 2007, 4:01:27 PM (15 years ago)

Author:

Martin Svensson

Message:

References #733. The PluginConfigurationImporter? can now import a selection of configurations in an xml-file.
It is not completely tested yet.

Location:

trunk

Files:

• src/plugins/core/net/sf/basedb/plugins/PluginConfigurationImporter.java (modified) (10 diffs)
• www/images/itemexists.gif (added)

trunk/src/plugins/core/net/sf/basedb/plugins/PluginConfigurationImporter.java

@@ -69 +69 @@
 import java.util.Arrays;
 import java.util.Date;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
@@ -90 +92 @@
     implements InteractivePlugin, AutoDetectingImporter
 { 
+  private static final String COMMAND_SELECT_CONFIGURATIONS = "select_configurations";
+  
   private static final About about = new AboutImpl
   (
@@ -123 +127 @@
     );
   
+  private static final PluginParameter<Boolean> importAllParameter = 
+      new PluginParameter<Boolean>(
+          "importAll",
+          "Import all configurations",
+          "Select if all or only a selection of the configurations in the XML-file should be " +
+          "imported. If FALSE, the configurations " +
+          "is selected in the next window.",
+          new BooleanParameterType(true, true));
+  
   private RequestInformation configureJob;
+  private RequestInformation configureSelection;
   
   // Variables to store the job parameters in.
   private File xmlFile;
   private boolean setPermissions;
+  private boolean importAll;
 
   /*
@@ -157 +172 @@
             Integer.toString(Location.PRIMARY.getValue()), Type.INT)
       );
-    }   
+    } 
+    else if (command.equals(COMMAND_SELECT_CONFIGURATIONS))
+    {
+      requestinformation = getConfiguredSelectionParameters();
+    }
     return requestinformation;
   }
 
+  @SuppressWarnings("unchecked")
   public void configure(GuiContext context, Request request, Response response)
   {
@@ -178 +198 @@
       storeValue(job, request, xmlFileParameter);
       storeValue(job, request, setPermissionsParameter);
-      response.setDone("The job configuration is complete");      
-    }   
+      storeValue(job, request, importAllParameter);
+      if (!(Boolean)request.getParameterValue("importAll"))
+      {
+        response.setContinue(COMMAND_SELECT_CONFIGURATIONS);
+      }
+      else
+      {
+        response.setDone("The job configuration is complete");
+      }
+    }
+    else if (command.equals(COMMAND_SELECT_CONFIGURATIONS))
+    {
+      List<PluginParameter<?>> selectionParameters = getConfiguredSelectionParameters().getParameters(); 
+      List<Throwable> errors = validateRequestParameters (
+          selectionParameters,
+          request
+      );
+      
+      if (errors != null)
+      {
+        response.setError(errors.size() + "invalid parameters were found in the request", errors);
+      }
+      for (PluginParameter p : selectionParameters)
+      {
+        if (request.getParameterValue(p.getName()) != null)
+        {
+          storeValue(job, request, (PluginParameter<Boolean>)p);
+        }
+      }
+      
+      response.setDone("The job configuration is complete");
+    }
   }
 
@@ -216 +266 @@
         xmlFile = (File)job.getValue("xmlfile");
         setPermissions = Boolean.TRUE.equals(job.getValue("setPermissions")); 
+        importAll = job.getValue("importAll") == null ? true : Boolean.TRUE.equals(job.getValue("importAll"));
+        
         is = xmlFile.getDownloadStream(0);        
         boolean importable = isImportable(is);    
@@ -312 +364 @@
       Element rootElement = doc.getRootElement();   
       
+      int parameternumber = 0;
       List configurations = rootElement.getChildren();      
       for (Object obj : configurations)
@@ -320 +373 @@
         String pluginClassName = configuration.getAttributeValue("pluginClassName");
         
-        PluginDefinition pluginDefinition = PluginDefinition.getByClassName(dc, pluginClassName);
-        PluginConfiguration pluginConfig = PluginConfiguration.getNew(dc, pluginDefinition);
-        if (setPermissions)
-        {
-          pluginConfig.setItemKey(pluginDefinition.getItemKey());
-          pluginConfig.setProjectKey(pluginDefinition.getProjectKey());
-        }
-        pluginConfig.setName(name);
-        pluginConfig.setDescription(description);
-        dc.saveItem(pluginConfig);
-        
-        List parameters = configuration.getChildren("parameter");
-        setPluginConf(parameters, pluginConfig);          
+        boolean importConfiguration = !importAll && 
+          job.getValue("configuration"+parameternumber) != null ? Boolean.TRUE.equals(job.getValue("configuration"+parameternumber)) : false;
+        if (importConfiguration || importAll)
+        {
+          PluginDefinition pluginDefinition = PluginDefinition.getByClassName(dc, pluginClassName);
+          PluginConfiguration pluginConfig = PluginConfiguration.getNew(dc, pluginDefinition);
+          if (setPermissions)
+          {
+            pluginConfig.setItemKey(pluginDefinition.getItemKey());
+            pluginConfig.setProjectKey(pluginDefinition.getProjectKey());
+          }
+          pluginConfig.setName(name);
+          pluginConfig.setDescription(description);
+          dc.saveItem(pluginConfig);
+          
+          List parameters = configuration.getChildren("parameter");
+          setPluginConf(parameters, pluginConfig);  
+        }
+        parameternumber++;
       }       
       dc.commit();
@@ -361 +420 @@
       parameters.add(xmlFileParameter);
       parameters.add(setPermissionsParameter);
+      parameters.add(importAllParameter);
       
       configureJob = new RequestInformation
@@ -371 +431 @@
     }
     return configureJob;
+  }
+  
+  private RequestInformation getConfiguredSelectionParameters()
+  {
+    if (configureSelection == null)
+    {
+      Map<String, List<PluginParameter<?>>> configLists = new HashMap<String, List<PluginParameter<?>>>();
+      
+      DbControl dc = null;
+      
+      try
+      {
+        dc = sc.newDbControl();
+        //Get the root element of the XML file
+        String filePath = null;
+        File file = (File)job.getValue("xmlfile");
+        {
+          file = File.getById(dc, file.getId());
+          filePath = file.getPath().toString();
+        }
+        URL dtdURL = PluginConfigurationImporter.class.getResource("/net/sf/basedb/core/dtd/"+dtdFileName);
+        InputStream is = file.getDownloadStream(0);
+        Document doc = XMLUtil.getValidatedXML(is, dtdURL, filePath);
+        is.close();
+        Element rootElement = doc.getRootElement();
+        
+        List<PluginParameter<?>> typeList = null;
+        List configurations = rootElement.getChildren();
+        int parameternumber = 0;
+        for (Object obj : configurations)
+        {
+          Element configElement = (Element)obj;
+          String configName = configElement.getChildText("configname");
+          String description = configElement.getChildText("description");
+          String pluginName = configElement.getAttributeValue("pluginClassName");
+          
+          if (configLists.get(pluginName) == null)
+          {
+            typeList = new ArrayList<PluginParameter<?>>();
+            typeList.add(new PluginParameter<Boolean>
+              (
+                  pluginName, 
+                  pluginName.substring(pluginName.lastIndexOf('.') + 1), 
+                  "Configurations for plugin: " +pluginName, 
+                  null
+              ));
+          }
+          else
+          {
+            typeList = configLists.get(pluginName);
+          }
+          
+          PluginParameter<Boolean> configurationParameter = 
+            new PluginParameter<Boolean>(
+            "configuration"+parameternumber,
+            configName,
+            "Select if configuration should be imported or not. " +
+            "TRUE will include this configuration in the import.\n\n" + description,
+            new BooleanParameterType(null, false)
+          );
+          typeList.add(configurationParameter);
+          configLists.put(pluginName, typeList);
+          parameternumber++;
+        }
+        List<PluginParameter<?>>parameters = new ArrayList<PluginParameter<?>>();
+        for (List<PluginParameter<?>> list : configLists.values())
+        {
+          parameters.addAll(list);
+        }
+        configureSelection = new RequestInformation
+        (
+            COMMAND_SELECT_CONFIGURATIONS,
+            "Select configurations",
+            "Select which plugin-configurations to import",
+            parameters
+        );
+      }
+      catch (Throwable ex)
+      {
+        throw new BaseException(ex);      
+      }
+      finally
+      {
+        if (dc != null)
+        {
+          dc.close();
+        }
+      }
+      
+    }
+    return configureSelection;
   }