Merge pull request #11467 from IQSS/11448-api-endpoint-for-analytics-html

Feature Request: API endpoint for analytics.html

Author: ofahimIQSS

doc/release-notes/11448-api-endpoint-for-analytics-html.md

@@ -0,0 +1,5 @@
+### Feature Request: API endpoint for analytics.html
+
+New API to get the analytics.html from settings for SPA (Also can be used to get homePage, header, footer, style, and logo)
+
+See also [the guides](https://dataverse-guide--11359.org.readthedocs.build/en/11359/installation/config.html#web-analytics-code), #11448.

doc/sphinx-guides/source/api/native-api.rst

@@ -5836,6 +5836,34 @@ The fully expanded example above (without environment variables) looks like this
 
   curl "https://demo.dataverse.org/api/info/exportFormats"
 
+Get Customization File Contents
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Customization API is used to retrieve the analytics-code.html as well as other customization file contents.
+
+See also :ref:`web-analytics-code` in the Configuration section of the Installation Guide and :ref:`Branding Your Installation`
+
+The Content-Type returned in the header is based on the media type of the file being returned (example: analytics-code.html returns "text/html; charset=UTF-8"
+
+Valid types are "homePage", "header", "footer", "style", "analytics", and "logo".
+
+A curl example getting the analytics-code
+
+.. code-block:: bash
+
+  export SERVER_URL=https://demo.dataverse.org
+  export TYPE=analytics
+
+  curl -X GET "$SERVER_URL/api/info/settings/customization/$TYPE"
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl -X GET "https://demo.dataverse.org/api/info/settings/customization/analytics"
+
+.. _customization-analytics:
+
 .. _metadata-blocks-api:
 
 Metadata Blocks

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

@@ -14,6 +14,8 @@
 import java.io.PrintWriter;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.logging.Logger;
+
 import jakarta.servlet.ServletException;
 import jakarta.servlet.annotation.WebServlet;
 import jakarta.servlet.http.HttpServlet;
@@ -22,14 +24,16 @@
 import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
 import jakarta.ejb.EJB;
 import org.apache.commons.io.IOUtils;
+import org.apache.tika.Tika;
 
 /**
  *
  * @author skraffmi
  */
 @WebServlet(name = "CustomizationFilesServlet", urlPatterns = {"/CustomizationFilesServlet"})
 public class CustomizationFilesServlet extends HttpServlet {
-    
+    private static final Logger logger = Logger.getLogger(CustomizationFilesServlet.class.getCanonicalName());
+
     @EJB
     SettingsServiceBean settingsService;
 
@@ -45,7 +49,7 @@ public class CustomizationFilesServlet extends HttpServlet {
      */
     protected void processRequest(HttpServletRequest request, HttpServletResponse response)
             throws ServletException, IOException {
-        response.setContentType("text/html;charset=UTF-8");               
+        response.setContentType(request.getContentType());
 
         String customFileType = request.getParameter("customFileType");
         String filePath = getFilePath(customFileType);
@@ -56,6 +60,13 @@ protected void processRequest(HttpServletRequest request, HttpServletResponse re
         try {
             File fileIn = physicalPath.toFile();
             if (fileIn != null) {
+                Tika tika = new Tika();
+                try {
+                    String mimeType = tika.detect(fileIn);
+                    response.setContentType(mimeType);
+                } catch (Exception e) {
+                    logger.info("Error getting MIME Type for " + filePath + " : " + e.getMessage());
+                }
                 inputStream = new FileInputStream(fileIn);
 
                 in = new BufferedReader(new InputStreamReader(inputStream));

src/main/java/edu/harvard/iq/dataverse/api/Info.java

@@ -1,21 +1,16 @@
 package edu.harvard.iq.dataverse.api;
 
-import java.io.FileInputStream;
-import java.io.InputStream;
-import java.net.URL;
-import java.nio.charset.StandardCharsets;
-import java.util.Arrays;
-import java.util.List;
-import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import jakarta.ws.rs.Produces;
-import org.apache.commons.io.IOUtils;
+import edu.harvard.iq.dataverse.customization.CustomizationConstants;
+import jakarta.ws.rs.*;
+import jakarta.ws.rs.client.Client;
+import jakarta.ws.rs.client.ClientBuilder;
+import jakarta.ws.rs.client.WebTarget;
 
 import edu.harvard.iq.dataverse.export.ExportService;
 import edu.harvard.iq.dataverse.settings.JvmSettings;
 import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
-import edu.harvard.iq.dataverse.util.BundleUtil;
 import edu.harvard.iq.dataverse.util.SystemConfig;
 import io.gdcc.spi.export.Exporter;
 import io.gdcc.spi.export.ExportException;
@@ -24,9 +19,6 @@
 import jakarta.json.Json;
 import jakarta.json.JsonObjectBuilder;
 import jakarta.json.JsonValue;
-import jakarta.ws.rs.GET;
-import jakarta.ws.rs.Path;
-import jakarta.ws.rs.QueryParam;
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
 import org.eclipse.microprofile.openapi.annotations.Operation;
@@ -139,6 +131,26 @@ public Response getExportFormats() {
         return ok(responseModel);
     }
 
+    @GET
+    @Path("settings/customization/{customizationFileType}")
+    public Response getCustomizationFile(@PathParam("customizationFileType") String customizationFileType) {
+        String type = customizationFileType != null ? customizationFileType.toLowerCase() : "";
+        if (!CustomizationConstants.validTypes.contains(type)) {
+            return badRequest("Customization type unknown or missing. Must be one of the following: " + CustomizationConstants.validTypes);
+        }
+        Client client = ClientBuilder.newClient();
+        WebTarget endpoint = client.target("http://localhost:8080/CustomizationFilesServlet");
+        Response response = endpoint.queryParam("customFileType", type)
+                .request(MediaType.MEDIA_TYPE_WILDCARD)
+                .get();
+
+        if (response.getLength() < 1) {
+            return notFound(type + " not found.");
+        } else {
+            return response;
+        }
+    }
+
     private Response getSettingResponseByKey(SettingsServiceBean.Key key) {
         String setting = settingsService.getValueForKey(key);
         if (setting != null) {

src/main/java/edu/harvard/iq/dataverse/customization/CustomizationConstants.java

@@ -5,6 +5,8 @@
  */
 package edu.harvard.iq.dataverse.customization;
 
+import java.util.List;
+
 /**
  *
  * @author rmp553
@@ -23,5 +25,5 @@ public class CustomizationConstants {
 
     public static String fileTypeLogo = "logo";
 
-
+    public static List<String> validTypes = List.of(fileTypeHomePage, fileTypeHeader, fileTypeFooter, fileTypeStyle, fileTypeAnalytics, fileTypeLogo);
 } // end CustomizationConstants

src/test/java/edu/harvard/iq/dataverse/api/CustomizationIT.java

@@ -0,0 +1,79 @@
+package edu.harvard.iq.dataverse.api;
+
+import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
+import io.restassured.response.Response;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+import static org.hamcrest.CoreMatchers.*;
+
+public class CustomizationIT {
+
+    static String docroot;
+    @BeforeAll
+    public static void setup() {
+        // setup docroot for running test either in docker or in Jenkins
+        if (Files.exists(Paths.get("docker-dev-volumes"))) {
+            docroot = "./appserver/glassfish/domains/domain1/docroot/";
+        } else {
+            docroot = "../docroot/";
+        }
+    }
+    @AfterEach
+    public void after() {
+        UtilIT.deleteSetting(SettingsServiceBean.Key.WebAnalyticsCode);
+    }
+
+    @Test
+    public void testGetCustomAnalytics() {
+        String setting = docroot + "index.html";
+        UtilIT.setSetting(SettingsServiceBean.Key.WebAnalyticsCode, setting).prettyPrint();
+
+        Response getResponse = UtilIT.getCustomizationFile("analytics");
+        getResponse.then().assertThat()
+                .statusCode(200)
+                .body(containsString("<!doctype html>"));
+
+        assert (getResponse.getHeaders().get("Content-Type").getValue().startsWith("text/html"));
+
+        UtilIT.deleteSetting(SettingsServiceBean.Key.WebAnalyticsCode).prettyPrint();
+
+        getResponse = UtilIT.getCustomizationFile("analytics");
+        getResponse.then().assertThat()
+                .statusCode(404)
+                .body(containsString("not found."));
+    }
+
+    @Test
+    public void testGetCustomLogo() {
+        String setting = docroot + "img/logo.png";
+        UtilIT.setSetting(SettingsServiceBean.Key.LogoCustomizationFile, setting).prettyPrint();
+
+        Response getResponse = UtilIT.getCustomizationFile("logo");
+        getResponse.then().assertThat()
+                .statusCode(200)
+                .body(containsString("PNG"));
+
+        assert (getResponse.getHeaders().get("Content-Type").getValue().startsWith("image/png"));
+
+        UtilIT.deleteSetting(SettingsServiceBean.Key.LogoCustomizationFile).prettyPrint();
+
+        getResponse = UtilIT.getCustomizationFile("logo");
+        getResponse.prettyPrint();
+        getResponse.then().assertThat()
+                .statusCode(404)
+                .body(containsString("not found."));
+    }
+
+    @Test
+    public void testGetCustomUnknown() {
+        Response getResponse = UtilIT.getCustomizationFile("unknownType");
+        getResponse.then().assertThat()
+                .statusCode(400)
+                .body(containsString("Customization type unknown or missing. Must be one of the following: [homePage, header"));
+    }
+}

src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

@@ -4961,6 +4961,15 @@ public static Response updateDatasetFilesMetadata(String datasetIdOrPersistentId
                 .post("/api/datasets/" + idInPath + "/files/metadata" + optionalQueryParam);
     }
 
+    public static Response getCustomizationFile(String fileType) {
+        RequestSpecification requestSpec = given();
+
+        Response resp = requestSpec.contentType("text/html; charset=UTF-8")
+                .get("/api/info/settings/customization/" + fileType);
+
+        return resp;
+    }
+
     static Response getUserSelectableRoles(String apiToken) {
         return given()
                 .header(API_TOKEN_HTTP_HEADER, apiToken)

tests/integration-tests.txt

@@ -1 +1 @@
-DataversesIT,DatasetsIT,SwordIT,AdminIT,BuiltinUsersIT,UsersIT,UtilIT,ConfirmEmailIT,FileMetadataIT,FilesIT,SearchIT,InReviewWorkflowIT,HarvestingServerIT,HarvestingClientsIT,MoveIT,MakeDataCountApiIT,FileTypeDetectionIT,EditDDIIT,ExternalToolsIT,AccessIT,DuplicateFilesIT,DownloadFilesIT,LinkIT,DeleteUsersIT,DeactivateUsersIT,AuxiliaryFilesIT,InvalidCharactersIT,LicensesIT,NotificationsIT,BagIT,MetadataBlocksIT,NetcdfIT,SignpostingIT,FitsIT,LogoutIT,DataRetrieverApiIT,ProvIT,S3AccessIT,OpenApiIT,InfoIT,DatasetFieldsIT,SavedSearchIT,DatasetTypesIT,DataverseFeaturedItemsIT,SendFeedbackApiIT
+DataversesIT,DatasetsIT,SwordIT,AdminIT,BuiltinUsersIT,UsersIT,UtilIT,ConfirmEmailIT,FileMetadataIT,FilesIT,SearchIT,InReviewWorkflowIT,HarvestingServerIT,HarvestingClientsIT,MoveIT,MakeDataCountApiIT,FileTypeDetectionIT,EditDDIIT,ExternalToolsIT,AccessIT,DuplicateFilesIT,DownloadFilesIT,LinkIT,DeleteUsersIT,DeactivateUsersIT,AuxiliaryFilesIT,InvalidCharactersIT,LicensesIT,NotificationsIT,BagIT,MetadataBlocksIT,NetcdfIT,SignpostingIT,FitsIT,LogoutIT,DataRetrieverApiIT,ProvIT,S3AccessIT,OpenApiIT,InfoIT,DatasetFieldsIT,SavedSearchIT,DatasetTypesIT,DataverseFeaturedItemsIT,SendFeedbackApiIT,CustomizationIT