3657 4393 modular explore plus guestbook

doc/sphinx-guides/source/_static/installation/files/root/external-tools/awesomeTool.json

@@ -1,6 +1,7 @@
 {
   "displayName": "Awesome Tool",
   "description": "The most awesome tool.",
+  "type": "explore",
   "toolUrl": "https://awesometool.com",
   "toolParameters": {
     "queryParameters": [

doc/sphinx-guides/source/_static/installation/files/root/external-tools/dataExplorer.json

@@ -0,0 +1,16 @@
+{
+  "displayName": "Data Explorer",
+  "description": "The Data Explorer provides a GUI which lists the variables in a tabular data file allowing searching, charting and cross tabulation analysis.",
+  "type": "explore",
+  "toolUrl": "https://scholarsportal.github.io/Dataverse-Data-Explorer/",
+  "toolParameters": {
+    "queryParameters": [
+      {
+        "fileId": "{fileId}"
+      },
+      {
+        "siteUrl": "{siteUrl}"
+      }
+    ]
+  }
+}

doc/sphinx-guides/source/installation/external-tools.rst

@@ -13,9 +13,12 @@ External tools must be expressed in an external tool manifest file, a specific J
 
 .. literalinclude:: ../_static/installation/files/root/external-tools/awesomeTool.json
 
+``type`` is required and must be ``explore`` or ``configure``.
+
 In the example above, a mix of required and optional reserved words appear that can be used to insert dynamic values into tools. The supported values are:
 
 - ``{fileId}`` (required) - The Dataverse database ID of a file the external tool has been launched on.
+- ``{siteUrl}`` (optional) - The URL of the Dataverse installation that hosts the file with the fileId above.
 - ``{apiToken}`` (optional) - The Dataverse API token of the user launching the external tool.
 
 Making an External Tool Available in Dataverse

doc/sphinx-guides/source/user/data-exploration/index.rst

@@ -6,6 +6,8 @@
 Data Exploration Guide
 =======================================================
 
+Note that the installation of Dataverse you are using may have additional or different tools configured. Developers interested in creating tools should refer to the :doc:`/installation/external-tools` section of the Installation Guide.
+
 Contents:
 
 .. toctree::

scripts/database/upgrades/upgrade_v4.8.4_to_v4.9.sql

@@ -0,0 +1,3 @@
+ALTER TABLE externaltool ADD COLUMN type character varying(255);
+UPDATE externaltool SET type = 'CONFIGURE';
+ALTER TABLE externaltool ALTER COLUMN type SET NOT NULL;

src/main/java/edu/harvard/iq/dataverse/CustomQuestionResponse.java

@@ -103,5 +103,17 @@ public boolean equals(Object object) {
     public String toString() {
         return "edu.harvard.iq.dvn.core.vdc.CustomQuestionResponse[ id=" + id + " ]";
     }
+
+    @Transient private String validationMessage;
+
+    public String getValidationMessage() {
+        return validationMessage;
+    }
+
+    public void setValidationMessage(String validationMessage) {
+        this.validationMessage = validationMessage;
+    }
+
+
 }
 

src/main/java/edu/harvard/iq/dataverse/DatasetPage.java

@@ -89,6 +89,7 @@
 import edu.harvard.iq.dataverse.externaltools.ExternalTool;
 import edu.harvard.iq.dataverse.externaltools.ExternalToolServiceBean;
 import edu.harvard.iq.dataverse.export.SchemaDotOrgExporter;
+import edu.harvard.iq.dataverse.externaltools.ExternalToolHandler;
 import java.util.Collections;
 
 import javax.faces.event.AjaxBehaviorEvent;
@@ -256,6 +257,7 @@ public enum DisplayMode {
 
     List<ExternalTool> allTools = new ArrayList<>();
     Map<Long,List<ExternalTool>> queriedFileTools = new HashMap<>(); 
+    Map<Long, List<ExternalToolHandler>> externalToolHandlersByFileId = new HashMap<>();
 
     public Boolean isHasRsyncScript() {
         return hasRsyncScript;
@@ -1431,6 +1433,7 @@ private String init(boolean initFull) {
                 // populate MapLayerMetadata
                 this.loadMapLayerMetadataLookup();  // A DataFile may have a related MapLayerMetadata object
                 this.guestbookResponse = guestbookResponseService.initGuestbookResponseForFragment(dataset, null, session);
+                this.getFileDownloadHelper().setGuestbookResponse(guestbookResponse);
                 logger.fine("Checking if rsync support is enabled.");
                 if (DataCaptureModuleUtil.rsyncSupportEnabled(settingsWrapper.getValueForKey(SettingsServiceBean.Key.UploadMethods))) {
                     try {
@@ -4049,13 +4052,38 @@ public List<ExternalTool> getExternalToolsForDataFile(Long fileId) {
 
         DataFile dataFile = datafileService.find(fileId);         
         fileTools = externalToolService.findExternalToolsByFile(allTools, dataFile);
+        // TODO: Do we even need "configure" tools right now? Should we delete all this code?
+        List<ExternalTool> onlyConfigureTools = new ArrayList<>();
+        for (ExternalTool fileTool : fileTools) {
+            if (ExternalTool.Type.CONFIGURE.equals(fileTool.getType())) {
+                onlyConfigureTools.add(fileTool);
+            }
+        }
+        fileTools = onlyConfigureTools;
 
         queriedFileTools.put(fileId, fileTools); //add externalTools to map so we don't have to do the lifting again
 
         return fileTools;    
     }
-
 
+    public List<ExternalToolHandler> getExternalToolHandlersForDataFile(Long fileId) {
+        List<ExternalToolHandler> externalToolHandlers = externalToolHandlersByFileId.get(fileId);
+        if (externalToolHandlers != null) { //if already queried before and added to list
+            return externalToolHandlers;
+        }
+        DataFile dataFile = datafileService.find(fileId);
+        externalToolHandlers = new ArrayList<>();
+        for (ExternalTool externalTool : allTools) {
+            if (ExternalTool.Type.EXPLORE.equals(externalTool.getType())) {
+                if (dataFile.isTabularData()) {
+                    // TODO: What about the API Token? Data Explorer doesn't need it but TwoRavens will if it's made into an external tool.
+                    externalToolHandlers.add(new ExternalToolHandler(externalTool, dataFile, null));
+                }
+            }
+        }
+        externalToolHandlersByFileId.put(fileId, externalToolHandlers); //add externalTools to map so we don't have to do the lifting again
+        return externalToolHandlers;
+    }
 
     Boolean thisLatestReleasedVersion = null;